VirtualBox.xidl@ 41925

Last change on this file since 41925 was 41925, checked in by vboxsync, 12 years ago
allow to change the clipboard mode during runtime (API change including 'VBoxManage controlvm' change)
Property svn:eol-style set to `native`
File size: 666.5 KB

Line
1	<?xml version="1.0" encoding="utf-8"?>
2
3	<!--
4
5	Copyright (C) 2006-2012 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI
80	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109	</desc>
110
111	<if target="midl">
112	<cpp line="enum {"/>
113	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
114	<cpp line=" kTypeLibraryMinorVersion = 0"/>
115	<cpp line="};"/>
116	</if>
117
118	<if target="xpidl">
119	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
120	<cpp>
121	/* currently, nsISupportsImpl.h lacks the below-like macros */
122
123	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
124	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
125	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
126	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
127
128
129	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
130	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
131	NS_IMPL_THREADSAFE_ADDREF(_class) \
132	NS_IMPL_THREADSAFE_RELEASE(_class) \
133	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
134	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
135	#endif
136
137	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
138	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
139	NS_IMPL_THREADSAFE_ADDREF(_class) \
140	NS_IMPL_THREADSAFE_RELEASE(_class) \
141	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
142	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
143	#endif
144
145	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
146	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
147	NS_IMPL_THREADSAFE_ADDREF(_class) \
148	NS_IMPL_THREADSAFE_RELEASE(_class) \
149	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
150	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
151	#endif
152
153	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
154	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
155	NS_IMPL_THREADSAFE_ADDREF(_class) \
156	NS_IMPL_THREADSAFE_RELEASE(_class) \
157	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
158	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
159	#endif
160
161	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
162	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
163	NS_INTERFACE_MAP_BEGIN(_class) \
164	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
165	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
166	NS_IMPL_QUERY_CLASSINFO(_class) \
167	NS_INTERFACE_MAP_END
168	#endif
169
170	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
171	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
172	_i2, _ic2) \
173	NS_INTERFACE_MAP_BEGIN(_class) \
174	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
175	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
176	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
177	NS_IMPL_QUERY_CLASSINFO(_class) \
178	NS_INTERFACE_MAP_END
179	#endif
180
181	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
182	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
183	_i2, _ic2, _i3, _ic3) \
184	NS_INTERFACE_MAP_BEGIN(_class) \
185	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
186	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
187	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
188	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
189	NS_IMPL_QUERY_CLASSINFO(_class) \
190	NS_INTERFACE_MAP_END
191	#endif
192
193	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
194	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
195	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
196
197	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
198	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
199	NS_IMPL_THREADSAFE_ADDREF(_class) \
200	NS_IMPL_THREADSAFE_RELEASE(_class) \
201	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
202	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
203	#endif
204
205	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
206	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
207	_i2, _ic2) \
208	NS_IMPL_THREADSAFE_ADDREF(_class) \
209	NS_IMPL_THREADSAFE_RELEASE(_class) \
210	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2) \
212	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
213	#endif
214
215	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
216	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
217	_i2, _ic2, _i3, _ic3) \
218	NS_IMPL_THREADSAFE_ADDREF(_class) \
219	NS_IMPL_THREADSAFE_RELEASE(_class) \
220	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
221	_i2, _ic2, _i3, _ic3) \
222	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
223	#endif
224
225	</cpp>
226	</if>
227
228	<library
229	name="VirtualBox"
230	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
231	version="1.3"
232	desc="VirtualBox Type Library"
233	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
234	supportsErrorInfo="yes"
235	>
236
237
238	<!--
239	// COM result codes for VirtualBox
240	/////////////////////////////////////////////////////////////////////////
241	-->
242
243	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
244	<desc>
245	This section describes all VirtualBox-specific COM result codes that may
246	be returned by methods of VirtualBox COM interfaces in addition to
247	standard COM result codes.
248
249	Note that along with the result code, every VirtualBox method returns
250	extended error information through the IVirtualBoxErrorInfo interface on
251	failure. This interface is a preferred way to present the error to the end
252	user because it contains a human readable description of the error. Raw
253	result codes, both standard and described in this section, are intended to
254	be used by programs to analyze the reason of a failure and select an
255	appropriate course of action without involving the end user (for example,
256	retry the operation later or make a different call).
257
258	The standard COM result codes that may originate from our methods include:
259
260	<table>
261	<tr><td>E_INVALIDARG</td>
262	<td>
263	Returned when the value of the method's argument is not within the range
264	of valid values. This should not be confused with situations when the
265	value is within the range but simply doesn't suit the current object
266	state and there is a possibility that it will be accepted later (in such
267	cases VirtualBox-specific codes are returned, for example,
268	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
269	</td>
270	</tr>
271	<tr><td>E_POINTER</td>
272	<td>
273	Returned if a memory pointer for the output argument is invalid (for
274	example, @c null). When pointers representing input arguments (such
275	as strings) are invalid, E_INVALIDARG is returned.
276	</td>
277	</tr>
278	<tr><td>E_ACCESSDENIED</td>
279	<td>
280	Returned when the called object is not ready. Since the lifetime of a
281	public COM object cannot be fully controlled by the implementation,
282	VirtualBox maintains the readiness state for all objects it creates and
283	returns this code in response to any method call on the object that was
284	deactivated by VirtualBox and is not functioning any more.
285	</td>
286	</tr>
287	<tr><td>E_OUTOFMEMORY</td>
288	<td>
289	Returned when a memory allocation operation fails.
290	</td>
291	</tr>
292	</table>
293	</desc>
294	</descGroup>
295
296	<!--
297	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
298	everything in <result>/<desc> after (and including) the first dot, so express
299	the matter of the error code in the first sentence and keep it short.
300	-->
301
302	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
303	<desc>
304	Object corresponding to the supplied arguments does not exist.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
309	<desc>
310	Current virtual machine state prevents the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
315	<desc>
316	Virtual machine error occurred attempting the operation.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
321	<desc>
322	File not accessible or erroneous file contents.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
327	<desc>
328	Runtime subsystem error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
333	<desc>
334	Pluggable Device Manager error.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
339	<desc>
340	Current object state prohibits operation.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
345	<desc>
346	Host operating system related error.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
351	<desc>
352	Requested operation is not supported.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
357	<desc>
358	Invalid XML found.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
363	<desc>
364	Current session state prohibits operation.
365	</desc>
366	</result>
367
368	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
369	<desc>
370	Object being in use prohibits operation.
371	</desc>
372	</result>
373
374	<!--
375	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
376	everything in <result>/<desc> after (and including) the first dot, so express
377	the matter of the error code in the first sentence and keep it short.
378	-->
379
380	<descGroup/>
381
382	<!--
383	// all common enums
384	/////////////////////////////////////////////////////////////////////////
385	-->
386
387	<enum
388	name="SettingsVersion"
389	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
390	>
391	<desc>
392	Settings version of VirtualBox settings files. This is written to
393	the "version" attribute of the root "VirtualBox" element in the settings
394	file XML and indicates which VirtualBox version wrote the file.
395	</desc>
396
397	<const name="Null" value="0">
398	<desc>Null value, indicates invalid version.</desc>
399	</const>
400	<const name="v1_0" value="1">
401	<desc>Legacy settings version, not currently supported.</desc>
402	</const>
403	<const name="v1_1" value="2">
404	<desc>Legacy settings version, not currently supported.</desc>
405	</const>
406	<const name="v1_2" value="3">
407	<desc>Legacy settings version, not currently supported.</desc>
408	</const>
409	<const name="v1_3pre" value="4">
410	<desc>Legacy settings version, not currently supported.</desc>
411	</const>
412	<const name="v1_3" value="5">
413	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
414	<!--
415	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
416	-->
417	</const>
418	<const name="v1_4" value="6">
419	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
420	<!--
421	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
422	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
423	-->
424	</const>
425	<const name="v1_5" value="7">
426	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
427	<!--
428	2008-09-04: 2.0.0 released
429	2008-11-20: settings version 1.5 introduced
430	2008-12-17: 2.1.0 released
431	Machine changes:
432	guest OS identifiers changed;
433	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
434	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
435	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
436	-->
437	</const>
438	<const name="v1_6" value="8">
439	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
440	<!--
441	2008-12-17: 2.1.0 released
442	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
443	2009-04-08: 2.2.0 released
444	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
445	-->
446	</const>
447	<const name="v1_7" value="9">
448	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
449	<!--
450	2008-12-17: 2.1.0 released
451	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
452	2009-04-08: 2.2.0 released
453	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
454	Machine changes: HardDiskAttachments is now StorageControllers (done)
455	-->
456	</const>
457	<const name="v1_8" value="10">
458	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
459	<!--
460	Machine additions: Display/@accelerate2DVideo (done)
461	-->
462	</const>
463	<const name="v1_9" value="11">
464	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
465	<!--
466	The big storage controller / DVD / Floppy rework (done)
467	-->
468	</const>
469	<const name="v1_10" value="12">
470	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
471	<!--
472	Machine changes: RTC localOrUTC (done)
473	CPU hot-plug support
474	-->
475	</const>
476	<const name="v1_11" value="13">
477	<desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
478	<!--
479	Machine changes: HD Audio controller, per-machine disk registries,
480	/@format attribute for DVD and floppy images.
481	-->
482	</const>
483	<const name="v1_12" value="14">
484	<desc>Settings version "1.12", written by VirtualBox 4.1.x.</desc>
485	<!--
486	Machine changes: raw PCI device attachment;
487	NetworkAdapter changes: bandwidth group.
488	-->
489	</const>
490	<const name="v1_13" value="15">
491	<desc>Settings version "1.13", written by VirtualBox 4.2.x.</desc>
492	<!--
493	Machine changes: tracing config;
494	-->
495	</const>
496
497	<const name="Future" value="99999">
498	<desc>Settings version greater than "1.13", written by a future VirtualBox version.</desc>
499	</const>
500	</enum>
501
502	<enum
503	name="AccessMode"
504	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
505	>
506	<desc>
507	Access mode for opening files.
508	</desc>
509
510	<const name="ReadOnly" value="1"/>
511	<const name="ReadWrite" value="2"/>
512	</enum>
513
514	<enum
515	name="MachineState"
516	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
517	>
518	<desc>
519	Virtual machine execution state.
520
521	This enumeration represents possible values of the <link
522	to="IMachine::state"/> attribute.
523
524	Below is the basic virtual machine state diagram. It shows how the state
525	changes during virtual machine execution. The text in square braces shows
526	a method of the IConsole interface that performs the given state
527	transition.
528
529	<pre>
530	+---------[powerDown()] <- Stuck <--[failure]-+
531	V \|
532	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
533	\| \| \| \| V \|
534	\| Aborted -----+ +--> Running --[pause()]--> Paused
535	\| \| ^ \| ^ \|
536	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
537	\| ^ \| \| \| \|
538	\| \| +-----------------------------------------+-\|-------------------+ +
539	\| \| \| \| \|
540	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
541	\| \| \| \|
542	\| +-------- Saving <--------[saveState()]<----------+---------------------+
543	\| \| \|
544	+-------------- Stopping -------[powerDown()]<----------+---------------------+
545	</pre>
546
547	Note that states to the right from PoweredOff, Aborted and Saved in the
548	above diagram are called <i>online VM states</i>. These states
549	represent the virtual machine which is being executed in a dedicated
550	process (usually with a GUI window attached to it where you can see the
551	activity of the virtual machine and interact with it). There are two
552	special pseudo-states, FirstOnline and LastOnline, that can be used in
553	relational expressions to detect if the given machine state is online or
554	not:
555
556	<pre>
557	if (machine.GetState() >= MachineState_FirstOnline &&
558	machine.GetState() <= MachineState_LastOnline)
559	{
560	...the machine is being executed...
561	}
562	</pre>
563
564	When the virtual machine is in one of the online VM states (that is, being
565	executed), only a few machine settings can be modified. Methods working
566	with such settings contain an explicit note about that. An attempt to
567	change any other setting or perform a modifying operation during this time
568	will result in the @c VBOX_E_INVALID_VM_STATE error.
569
570	All online states except Running, Paused and Stuck are transitional: they
571	represent temporary conditions of the virtual machine that will last as
572	long as the operation that initiated such a condition.
573
574	The Stuck state is a special case. It means that execution of the machine
575	has reached the "Guru Meditation" condition. This condition indicates an
576	internal VMM (virtual machine manager) failure which may happen as a
577	result of either an unhandled low-level virtual hardware exception or one
578	of the recompiler exceptions (such as the <i>too-many-traps</i>
579	condition).
580
581	Note also that any online VM state may transit to the Aborted state. This
582	happens if the process that is executing the virtual machine terminates
583	unexpectedly (for example, crashes). Other than that, the Aborted state is
584	equivalent to PoweredOff.
585
586	There are also a few additional state diagrams that do not deal with
587	virtual machine execution and therefore are shown separately. The states
588	shown on these diagrams are called <i>offline VM states</i> (this includes
589	PoweredOff, Aborted and Saved too).
590
591	The first diagram shows what happens when a lengthy setup operation is
592	being executed (such as <link to="IMachine::attachDevice"/>).
593
594	<pre>
595	+----------------------------------(same state as before the call)------+
596	\| \|
597	+-> PoweredOff --+ \|
598	\| \| \|
599	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
600	\| \|
601	+-> Saved -------+
602	</pre>
603
604	The next two diagrams demonstrate the process of taking a snapshot of a
605	powered off virtual machine, restoring the state to that as of a snapshot
606	or deleting a snapshot, respectively.
607
608	<pre>
609	+----------------------------------(same state as before the call)------+
610	\| \|
611	+-> PoweredOff --+ \|
612	\| +-->[takeSnapshot()] -------------------> Saving ------+
613	+-> Aborted -----+
614
615	+-> PoweredOff --+
616	\| \|
617	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
618	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
619	+-> Saved -------+ \|
620	\| \|
621	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
622	</pre>
623
624	Note that the Saving state is present in both the offline state group and
625	online state group. Currently, the only way to determine what group is
626	assumed in a particular case is to remember the previous machine state: if
627	it was Running or Paused, then Saving is an online state, otherwise it is
628	an offline state. This inconsistency may be removed in one of the future
629	versions of VirtualBox by adding a new state.
630
631	<note internal="yes">
632	For whoever decides to touch this enum: In order to keep the
633	comparisons involving FirstOnline and LastOnline pseudo-states valid,
634	the numeric values of these states must be correspondingly updated if
635	needed: for any online VM state, the condition
636	<tt>FirstOnline <= state <= LastOnline</tt> must be
637	@c true. The same relates to transient states for which
638	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
639	@c true.
640	</note>
641	</desc>
642
643	<const name="Null" value="0">
644	<desc>Null value (never used by the API).</desc>
645	</const>
646	<const name="PoweredOff" value="1">
647	<desc>
648	The machine is not running and has no saved execution state; it has
649	either never been started or been shut down successfully.
650	</desc>
651	</const>
652	<const name="Saved" value="2">
653	<desc>
654	The machine is not currently running, but the execution state of the machine
655	has been saved to an external file when it was running, from where
656	it can be resumed.
657	</desc>
658	</const>
659	<const name="Teleported" value="3">
660	<desc>
661	The machine was teleported to a different host (or process) and then
662	powered off. Take care when powering it on again may corrupt resources
663	it shares with the teleportation target (e.g. disk and network).
664	</desc>
665	</const>
666	<const name="Aborted" value="4">
667	<desc>
668	The process running the machine has terminated abnormally. This may
669	indicate a crash of the VM process in host execution context, or
670	the VM process has been terminated externally.
671	</desc>
672	</const>
673	<const name="Running" value="5">
674	<desc>
675	The machine is currently being executed.
676	<note internal="yes">
677	For whoever decides to touch this enum: In order to keep the
678	comparisons in the old source code valid, this state must immediately
679	precede the Paused state.
680	TODO: Lift this spectacularly wonderful restriction.
681	</note>
682	</desc>
683	</const>
684	<const name="Paused" value="6">
685	<desc>
686	Execution of the machine has been paused.
687	<note internal="yes">
688	For whoever decides to touch this enum: In order to keep the
689	comparisons in the old source code valid, this state must immediately
690	follow the Running state.
691	TODO: Lift this spectacularly wonderful restriction.
692	</note>
693	</desc>
694	</const>
695	<const name="Stuck" value="7">
696	<desc>
697	Execution of the machine has reached the "Guru Meditation"
698	condition. This indicates a severe error in the hypervisor itself.
699	<note internal="yes">
700	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
701	"Guru", perhaps? Or are there some other VMM states that are
702	intended to be lumped in here as well?
703	</note>
704	</desc>
705	</const>
706	<const name="Teleporting" value="8">
707	<desc>
708	The machine is about to be teleported to a different host or process.
709	It is possible to pause a machine in this state, but it will go to the
710	@c TeleportingPausedVM state and it will not be
711	possible to resume it again unless the teleportation fails.
712	</desc>
713	</const>
714	<const name="LiveSnapshotting" value="9">
715	<desc>
716	A live snapshot is being taken. The machine is running normally, but
717	some of the runtime configuration options are inaccessible. Also, if
718	paused while in this state it will transition to
719	@c Saving and it will not be resume the
720	execution until the snapshot operation has completed.
721	</desc>
722	</const>
723	<const name="Starting" value="10">
724	<desc>
725	Machine is being started after powering it on from a
726	zero execution state.
727	</desc>
728	</const>
729	<const name="Stopping" value="11">
730	<desc>
731	Machine is being normally stopped powering it off, or after the guest OS
732	has initiated a shutdown sequence.
733	</desc>
734	</const>
735	<const name="Saving" value="12">
736	<desc>
737	Machine is saving its execution state to a file, or an online
738	snapshot of the machine is being taken.
739	</desc>
740	</const>
741	<const name="Restoring" value="13">
742	<desc>
743	Execution state of the machine is being restored from a file
744	after powering it on from the saved execution state.
745	</desc>
746	</const>
747	<const name="TeleportingPausedVM" value="14">
748	<desc>
749	The machine is being teleported to another host or process, but it is
750	not running. This is the paused variant of the
751	@c state.
752	</desc>
753	</const>
754	<const name="TeleportingIn" value="15">
755	<desc>
756	Teleporting the machine state in from another host or process.
757	</desc>
758	</const>
759	<const name="FaultTolerantSyncing" value="16">
760	<desc>
761	The machine is being synced with a fault tolerant VM running elsewhere.
762	</desc>
763	</const>
764	<const name="DeletingSnapshotOnline" value="17">
765	<desc>
766	Like @c DeletingSnapshot, but the merging of media is ongoing in
767	the background while the machine is running.
768	</desc>
769	</const>
770	<const name="DeletingSnapshotPaused" value="18">
771	<desc>
772	Like @c DeletingSnapshotOnline, but the machine was paused when the
773	merging of differencing media was started.
774	</desc>
775	</const>
776	<const name="RestoringSnapshot" value="19">
777	<desc>
778	A machine snapshot is being restored; this typically does not take long.
779	</desc>
780	</const>
781	<const name="DeletingSnapshot" value="20">
782	<desc>
783	A machine snapshot is being deleted; this can take a long time since this
784	may require merging differencing media. This value indicates that the
785	machine is not running while the snapshot is being deleted.
786	</desc>
787	</const>
788	<const name="SettingUp" value="21">
789	<desc>
790	Lengthy setup operation is in progress.
791	</desc>
792	</const>
793
794	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
795	<desc>
796	Pseudo-state: first online state (for use in relational expressions).
797	</desc>
798	</const>
799	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
800	<desc>
801	Pseudo-state: last online state (for use in relational expressions).
802	</desc>
803	</const>
804
805	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
806	<desc>
807	Pseudo-state: first transient state (for use in relational expressions).
808	</desc>
809	</const>
810	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
811	<desc>
812	Pseudo-state: last transient state (for use in relational expressions).
813	</desc>
814	</const>
815
816	</enum>
817
818	<enum
819	name="SessionState"
820	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
821	>
822	<desc>
823	Session state. This enumeration represents possible values of
824	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
825	attributes.
826	</desc>
827
828	<const name="Null" value="0">
829	<desc>Null value (never used by the API).</desc>
830	</const>
831	<const name="Unlocked" value="1">
832	<desc>
833	In <link to="IMachine::sessionState"/>, this means that the machine
834	is not locked for any sessions.
835
836	In <link to="ISession::state"/>, this means that no machine is
837	currently locked for this session.
838	</desc>
839	</const>
840	<const name="Locked" value="2">
841	<desc>
842	In <link to="IMachine::sessionState"/>, this means that the machine
843	is currently locked for a session, whose process identifier can
844	then be found in the <link to="IMachine::sessionPid" /> attribute.
845
846	In <link to="ISession::state"/>, this means that a machine is
847	currently locked for this session, and the mutable machine object
848	can be found in the <link to="ISession::machine"/> attribute
849	(see <link to="IMachine::lockMachine" /> for details).
850	</desc>
851	</const>
852	<const name="Spawning" value="3">
853	<desc>
854	A new process is being spawned for the machine as a result of
855	<link to="IMachine::launchVMProcess"/> call. This state also occurs
856	as a short transient state during an <link to="IMachine::lockMachine"/>
857	call.
858	</desc>
859	</const>
860	<const name="Unlocking" value="4">
861	<desc>
862	The session is being unlocked.
863	</desc>
864	</const>
865	</enum>
866
867	<enum
868	name="CPUPropertyType"
869	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
870	>
871	<desc>
872	Virtual CPU property type. This enumeration represents possible values of the
873	IMachine get- and setCPUProperty methods.
874	</desc>
875	<const name="Null" value="0">
876	<desc>Null value (never used by the API).</desc>
877	</const>
878	<const name="PAE" value="1">
879	<desc>
880	This setting determines whether VirtualBox will expose the Physical Address
881	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
882	is not available, it will not be reported.
883	</desc>
884	</const>
885	<const name="Synthetic" value="2">
886	<desc>
887	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
888	teleporting between host systems that differ significantly.
889	</desc>
890	</const>
891	</enum>
892
893
894	<enum
895	name="HWVirtExPropertyType"
896	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
897	>
898	<desc>
899	Hardware virtualization property type. This enumeration represents possible values
900	for the <link to="IMachine::getHWVirtExProperty"/> and
901	<link to="IMachine::setHWVirtExProperty"/> methods.
902	</desc>
903	<const name="Null" value="0">
904	<desc>Null value (never used by the API).</desc>
905	</const>
906	<const name="Enabled" value="1">
907	<desc>
908	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
909	such extensions are not available, they will not be used.
910	</desc>
911	</const>
912	<const name="Exclusive" value="2">
913	<desc>
914	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
915	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
916	feature of the host. To share these with other hypervisors, you must disable this property.
917	</desc>
918	</const>
919	<const name="VPID" value="3">
920	<desc>
921	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
922	</desc>
923	</const>
924	<const name="NestedPaging" value="4">
925	<desc>
926	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
927	</desc>
928	</const>
929	<const name="LargePages" value="5">
930	<desc>
931	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
932	</desc>
933	</const>
934	<const name="Force" value="6">
935	<desc>
936	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
937	not set, there will be an automatic fallback to software virtualization.
938	</desc>
939	</const>
940	</enum>
941
942	<enum
943	name="FaultToleranceState"
944	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
945	>
946	<desc>
947	Used with <link to="IMachine::faultToleranceState" />.
948	</desc>
949	<const name="Inactive" value="1">
950	<desc>No fault tolerance enabled.</desc>
951	</const>
952	<const name="Master" value="2">
953	<desc>Fault tolerant master VM.</desc>
954	</const>
955	<const name="Standby" value="3">
956	<desc>Fault tolerant standby VM.</desc>
957	</const>
958	</enum>
959
960	<enum
961	name="LockType"
962	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
963	>
964	<desc>
965	Used with <link to="IMachine::lockMachine" />.
966	</desc>
967	<const name="Write" value="2">
968	<desc>Lock the machine for writing.</desc>
969	</const>
970	<const name="Shared" value="1">
971	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
972	</const>
973	</enum>
974
975	<enum
976	name="SessionType"
977	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
978	>
979	<desc>
980	Session type. This enumeration represents possible values of the
981	<link to="ISession::type"/> attribute.
982	</desc>
983
984	<const name="Null" value="0">
985	<desc>Null value (never used by the API).</desc>
986	</const>
987	<const name="WriteLock" value="1">
988	<desc>
989	Session has acquired an exclusive write lock on a machine
990	using <link to="IMachine::lockMachine"/>.
991	</desc>
992	</const>
993	<const name="Remote" value="2">
994	<desc>
995	Session has launched a VM process using
996	<link to="IMachine::launchVMProcess"/>
997	</desc>
998	</const>
999	<const name="Shared" value="3">
1000	<desc>
1001	Session has obtained a link to another session using
1002	<link to="IMachine::lockMachine"/>
1003	</desc>
1004	</const>
1005	</enum>
1006
1007	<enum
1008	name="DeviceType"
1009	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1010	>
1011	<desc>
1012	Device type.
1013	</desc>
1014	<const name="Null" value="0">
1015	<desc>
1016	Null value, may also mean "no device" (not allowed for
1017	<link to="IConsole::getDeviceActivity"/>).
1018	</desc>
1019	</const>
1020	<const name="Floppy" value="1">
1021	<desc>Floppy device.</desc>
1022	</const>
1023	<const name="DVD" value="2">
1024	<desc>CD/DVD-ROM device.</desc>
1025	</const>
1026	<const name="HardDisk" value="3">
1027	<desc>Hard disk device.</desc>
1028	</const>
1029	<const name="Network" value="4">
1030	<desc>Network device.</desc>
1031	</const>
1032	<const name="USB" value="5">
1033	<desc>USB device.</desc>
1034	</const>
1035	<const name="SharedFolder" value="6">
1036	<desc>Shared folder device.</desc>
1037	</const>
1038	</enum>
1039
1040	<enum
1041	name="DeviceActivity"
1042	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1043	>
1044	<desc>
1045	Device activity for <link to="IConsole::getDeviceActivity"/>.
1046	</desc>
1047
1048	<const name="Null" value="0"/>
1049	<const name="Idle" value="1"/>
1050	<const name="Reading" value="2"/>
1051	<const name="Writing" value="3"/>
1052	</enum>
1053
1054	<enum
1055	name="ClipboardMode"
1056	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1057	>
1058	<desc>
1059	Host-Guest clipboard interchange mode.
1060	</desc>
1061
1062	<const name="Disabled" value="0"/>
1063	<const name="HostToGuest" value="1"/>
1064	<const name="GuestToHost" value="2"/>
1065	<const name="Bidirectional" value="3"/>
1066	</enum>
1067
1068	<enum
1069	name="Scope"
1070	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1071	>
1072	<desc>
1073	Scope of the operation.
1074
1075	A generic enumeration used in various methods to define the action or
1076	argument scope.
1077	</desc>
1078
1079	<const name="Global" value="0"/>
1080	<const name="Machine" value="1"/>
1081	<const name="Session" value="2"/>
1082	</enum>
1083
1084	<enum
1085	name="BIOSBootMenuMode"
1086	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1087	>
1088	<desc>
1089	BIOS boot menu mode.
1090	</desc>
1091
1092	<const name="Disabled" value="0"/>
1093	<const name="MenuOnly" value="1"/>
1094	<const name="MessageAndMenu" value="2"/>
1095	</enum>
1096
1097	<enum
1098	name="ProcessorFeature"
1099	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1100	>
1101	<desc>
1102	CPU features.
1103	</desc>
1104
1105	<const name="HWVirtEx" value="0"/>
1106	<const name="PAE" value="1"/>
1107	<const name="LongMode" value="2"/>
1108	<const name="NestedPaging" value="3"/>
1109	</enum>
1110
1111	<enum
1112	name="FirmwareType"
1113	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1114	>
1115	<desc>
1116	Firmware type.
1117	</desc>
1118	<const name="BIOS" value="1">
1119	<desc>BIOS Firmware.</desc>
1120	</const>
1121	<const name="EFI" value="2">
1122	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1123	</const>
1124	<const name="EFI32" value="3">
1125	<desc>Efi firmware, 32-bit.</desc>
1126	</const>
1127	<const name="EFI64" value="4">
1128	<desc>Efi firmware, 64-bit.</desc>
1129	</const>
1130	<const name="EFIDUAL" value="5">
1131	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1132	</const>
1133	</enum>
1134
1135	<enum
1136	name="PointingHidType"
1137	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1138	>
1139	<desc>
1140	Type of pointing device used in a virtual machine.
1141	</desc>
1142	<const name="None" value="1">
1143	<desc>No mouse.</desc>
1144	</const>
1145	<const name="PS2Mouse" value="2">
1146	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1147	</const>
1148	<const name="USBMouse" value="3">
1149	<desc>USB mouse (relative pointer).</desc>
1150	</const>
1151	<const name="USBTablet" value="4">
1152	<desc>USB tablet (absolute pointer).</desc>
1153	</const>
1154	<const name="ComboMouse" value="5">
1155	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1156	Using of such device can have negative performance implications. </desc>
1157	</const>
1158	</enum>
1159
1160	<enum
1161	name="KeyboardHidType"
1162	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1163	>
1164	<desc>
1165	Type of keyboard device used in a virtual machine.
1166	</desc>
1167	<const name="None" value="1">
1168	<desc>No keyboard.</desc>
1169	</const>
1170	<const name="PS2Keyboard" value="2">
1171	<desc>PS/2 keyboard.</desc>
1172	</const>
1173	<const name="USBKeyboard" value="3">
1174	<desc>USB keyboard.</desc>
1175	</const>
1176	<const name="ComboKeyboard" value="4">
1177	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1178	Using of such device can have negative performance implications. </desc>
1179	</const>
1180	</enum>
1181
1182	<!--
1183	// IVirtualBoxErrorInfo
1184	/////////////////////////////////////////////////////////////////////////
1185	-->
1186
1187	<interface
1188	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1189	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1190	supportsErrorInfo="no"
1191	wsmap="managed"
1192	>
1193	<desc>
1194	The IVirtualBoxErrorInfo interface represents extended error information.
1195
1196	Extended error information can be set by VirtualBox components after
1197	unsuccessful or partially successful method invocation. This information
1198	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1199	and then shown to the client in addition to the plain 32-bit result code.
1200
1201	In MS COM, this interface extends the IErrorInfo interface,
1202	in XPCOM, it extends the nsIException interface. In both cases,
1203	it provides a set of common attributes to retrieve error
1204	information.
1205
1206	Sometimes invocation of some component's method may involve methods of
1207	other components that may also fail (independently of this method's
1208	failure), or a series of non-fatal errors may precede a fatal error that
1209	causes method failure. In cases like that, it may be desirable to preserve
1210	information about all errors happened during method invocation and deliver
1211	it to the caller. The <link to="#next"/> attribute is intended
1212	specifically for this purpose and allows to represent a chain of errors
1213	through a single IVirtualBoxErrorInfo object set after method invocation.
1214
1215	<note>errors are stored to a chain in the reverse order, i.e. the
1216	initial error object you query right after method invocation is the last
1217	error set by the callee, the object it points to in the @a next attribute
1218	is the previous error and so on, up to the first error (which is the last
1219	in the chain).</note>
1220	</desc>
1221
1222	<attribute name="resultCode" type="long" readonly="yes">
1223	<desc>
1224	Result code of the error.
1225	Usually, it will be the same as the result code returned
1226	by the method that provided this error information, but not
1227	always. For example, on Win32, CoCreateInstance() will most
1228	likely return E_NOINTERFACE upon unsuccessful component
1229	instantiation attempt, but not the value the component factory
1230	returned. Value is typed 'long', not 'result',
1231	to make interface usable from scripting languages.
1232	<note>
1233	In MS COM, there is no equivalent.
1234	In XPCOM, it is the same as nsIException::result.
1235	</note>
1236	</desc>
1237	</attribute>
1238
1239	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1240	<desc>
1241	UUID of the interface that defined the error.
1242	<note>
1243	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1244	data type.
1245	In XPCOM, there is no equivalent.
1246	</note>
1247	</desc>
1248	</attribute>
1249
1250	<attribute name="component" type="wstring" readonly="yes">
1251	<desc>
1252	Name of the component that generated the error.
1253	<note>
1254	In MS COM, it is the same as IErrorInfo::GetSource.
1255	In XPCOM, there is no equivalent.
1256	</note>
1257	</desc>
1258	</attribute>
1259
1260	<attribute name="text" type="wstring" readonly="yes">
1261	<desc>
1262	Text description of the error.
1263	<note>
1264	In MS COM, it is the same as IErrorInfo::GetDescription.
1265	In XPCOM, it is the same as nsIException::message.
1266	</note>
1267	</desc>
1268	</attribute>
1269
1270	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1271	<desc>
1272	Next error object if there is any, or @c null otherwise.
1273	<note>
1274	In MS COM, there is no equivalent.
1275	In XPCOM, it is the same as nsIException::inner.
1276	</note>
1277	</desc>
1278	</attribute>
1279
1280	</interface>
1281
1282	<!--
1283	// IVirtualBox
1284	/////////////////////////////////////////////////////////////////////////
1285	-->
1286
1287	<interface
1288	name="IDHCPServer" extends="$unknown"
1289	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1290	wsmap="managed"
1291	>
1292	<desc>
1293	The IDHCPServer interface represents the vbox dhcp server configuration.
1294
1295	To enumerate all the dhcp servers on the host, use the
1296	<link to="IVirtualBox::DHCPServers"/> attribute.
1297	</desc>
1298
1299	<attribute name="enabled" type="boolean">
1300	<desc>
1301	specifies if the dhcp server is enabled
1302	</desc>
1303	</attribute>
1304
1305	<attribute name="IPAddress" type="wstring" readonly="yes">
1306	<desc>
1307	specifies server IP
1308	</desc>
1309	</attribute>
1310
1311	<attribute name="networkMask" type="wstring" readonly="yes">
1312	<desc>
1313	specifies server network mask
1314	</desc>
1315	</attribute>
1316
1317	<attribute name="networkName" type="wstring" readonly="yes">
1318	<desc>
1319	specifies internal network name the server is used for
1320	</desc>
1321	</attribute>
1322
1323	<attribute name="lowerIP" type="wstring" readonly="yes">
1324	<desc>
1325	specifies from IP address in server address range
1326	</desc>
1327	</attribute>
1328
1329	<attribute name="upperIP" type="wstring" readonly="yes">
1330	<desc>
1331	specifies to IP address in server address range
1332	</desc>
1333	</attribute>
1334
1335	<method name="setConfiguration">
1336	<desc>
1337	configures the server
1338	<result name="E_INVALIDARG">
1339	invalid configuration supplied
1340	</result>
1341	</desc>
1342	<param name="IPAddress" type="wstring" dir="in">
1343	<desc>
1344	server IP address
1345	</desc>
1346	</param>
1347	<param name="networkMask" type="wstring" dir="in">
1348	<desc>
1349	server network mask
1350	</desc>
1351	</param>
1352	<param name="FromIPAddress" type="wstring" dir="in">
1353	<desc>
1354	server From IP address for address range
1355	</desc>
1356	</param>
1357	<param name="ToIPAddress" type="wstring" dir="in">
1358	<desc>
1359	server To IP address for address range
1360	</desc>
1361	</param>
1362	</method>
1363
1364	<method name="start">
1365	<desc>
1366	Starts DHCP server process.
1367	<result name="E_FAIL">
1368	Failed to start the process.
1369	</result>
1370	</desc>
1371	<param name="networkName" type="wstring" dir="in">
1372	<desc>
1373	Name of internal network DHCP server should attach to.
1374	</desc>
1375	</param>
1376	<param name="trunkName" type="wstring" dir="in">
1377	<desc>
1378	Name of internal network trunk.
1379	</desc>
1380	</param>
1381	<param name="trunkType" type="wstring" dir="in">
1382	<desc>
1383	Type of internal network trunk.
1384	</desc>
1385	</param>
1386	</method>
1387
1388	<method name="stop">
1389	<desc>
1390	Stops DHCP server process.
1391	<result name="E_FAIL">
1392	Failed to stop the process.
1393	</result>
1394	</desc>
1395	</method>
1396	</interface>
1397
1398	<interface
1399	name="IVirtualBox" extends="$unknown"
1400	uuid="867664ba-41ce-4099-a10d-b7a8e34057c7"
1401	wsmap="managed"
1402	>
1403	<desc>
1404	The IVirtualBox interface represents the main interface exposed by the
1405	product that provides virtual machine management.
1406
1407	An instance of IVirtualBox is required for the product to do anything
1408	useful. Even though the interface does not expose this, internally,
1409	IVirtualBox is implemented as a singleton and actually lives in the
1410	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1411	IVirtualBox can track the state of all virtual machines on a particular
1412	host, regardless of which frontend started them.
1413
1414	To enumerate all the virtual machines on the host, use the
1415	<link to="IVirtualBox::machines"/> attribute.
1416	</desc>
1417
1418	<attribute name="version" type="wstring" readonly="yes">
1419	<desc>
1420	A string representing the version number of the product. The
1421	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1422	last number represents the build number and will frequently change.
1423
1424	This may be followed by a _ALPHA[0-9], _BETA[0-9] or _RC[0-9]* tag
1425	in prerelease builds. Non-Oracle builds may (/shall) also have a
1426	publisher tag, at the end. The publisher tag starts with an underscore
1427	just like the prerelease build type tag.
1428	</desc>
1429	</attribute>
1430
1431	<attribute name="revision" type="unsigned long" readonly="yes">
1432	<desc>
1433	The internal build revision number of the product.
1434	</desc>
1435	</attribute>
1436
1437	<attribute name="packageType" type="wstring" readonly="yes">
1438	<desc>
1439	A string representing the package type of this product. The
1440	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1441	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1442	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1443	this.
1444	</desc>
1445	</attribute>
1446
1447	<attribute name="APIVersion" type="wstring" readonly="yes">
1448	<desc>
1449	A string representing the VirtualBox API version number. The format is
1450	2 integer numbers divided by an underscore (e.g. 1_0). After the
1451	first public release of packages with a particular API version the
1452	API will not be changed in an incompatible way. Note that this
1453	guarantee does not apply to development builds, and also there is no
1454	guarantee that this version is identical to the first two integer
1455	numbers of the package version.
1456	</desc>
1457	</attribute>
1458
1459	<attribute name="homeFolder" type="wstring" readonly="yes">
1460	<desc>
1461	Full path to the directory where the global settings file,
1462	<tt>VirtualBox.xml</tt>, is stored.
1463
1464	In this version of VirtualBox, the value of this property is
1465	always <tt><user_dir>/.VirtualBox</tt> (where
1466	<tt><user_dir></tt> is the path to the user directory,
1467	as determined by the host OS), and cannot be changed.
1468
1469	This path is also used as the base to resolve relative paths in
1470	places where relative paths are allowed (unless otherwise
1471	expressly indicated).
1472	</desc>
1473	</attribute>
1474
1475	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1476	<desc>
1477	Full name of the global settings file.
1478	The value of this property corresponds to the value of
1479	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1480	</desc>
1481	</attribute>
1482
1483	<attribute name="host" type="IHost" readonly="yes">
1484	<desc>Associated host object.</desc>
1485	</attribute>
1486
1487	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1488	<desc>Associated system information object.</desc>
1489	</attribute>
1490
1491	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1492	<desc>
1493	Array of machine objects registered within this VirtualBox instance.
1494	</desc>
1495	</attribute>
1496
1497	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1498	<desc>
1499	Array of medium objects known to this VirtualBox installation.
1500
1501	This array contains only base media. All differencing
1502	media of the given base medium can be enumerated using
1503	<link to="IMedium::children"/>.
1504	</desc>
1505	</attribute>
1506
1507	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1508	<desc>
1509	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1510	</desc>
1511	</attribute>
1512
1513	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1514	<desc>
1515	Array of floppy image objects currently in use by this VirtualBox instance.
1516	</desc>
1517	</attribute>
1518
1519	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1520
1521	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1522
1523	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1524	<desc>
1525	Collection of global shared folders. Global shared folders are
1526	available to all virtual machines.
1527
1528	New shared folders are added to the collection using
1529	<link to="#createSharedFolder"/>. Existing shared folders can be
1530	removed using <link to="#removeSharedFolder"/>.
1531
1532	<note>
1533	In the current version of the product, global shared folders are not
1534	implemented and therefore this collection is always empty.
1535	</note>
1536	</desc>
1537	</attribute>
1538
1539	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1540	<desc>
1541	Associated performance collector object.
1542	</desc>
1543	</attribute>
1544
1545	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1546	<desc>
1547	DHCP servers.
1548	</desc>
1549	</attribute>
1550
1551	<attribute name="eventSource" type="IEventSource" readonly="yes">
1552	<desc>
1553	Event source for VirtualBox events.
1554	</desc>
1555	</attribute>
1556
1557	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1558	<desc>
1559	The extension pack manager.
1560	</desc>
1561	</attribute>
1562
1563
1564	<attribute name="internalNetworks" type="wstring" safearray="yes" readonly="yes">
1565	<desc>
1566	Names of all internal networks.
1567	</desc>
1568	</attribute>
1569
1570	<attribute name="genericNetworkDrivers" type="wstring" safearray="yes" readonly="yes">
1571	<desc>
1572	Names of all generic network drivers.
1573	</desc>
1574	</attribute>
1575
1576	<method name="composeMachineFilename">
1577	<desc>
1578	Returns a recommended full path of the settings file name for a new virtual
1579	machine.
1580
1581	This API serves two purposes:
1582
1583	<ul>
1584	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1585	for the @a settingsFile argument there, which means that API should use
1586	a recommended default file name.</li>
1587
1588	<li>It can be called manually by a client software before creating a machine,
1589	e.g. if that client wants to pre-create the machine directory to create
1590	virtual hard disks in that directory together with the new machine
1591	settings file. In that case, the file name should be stripped from the
1592	full settings file path returned by this function to obtain the
1593	machine directory.</li>
1594	</ul>
1595
1596	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1597	details about the machine name.
1598
1599	If @a baseFolder is a @c null or empty string (which is recommended), the
1600	default machine settings folder
1601	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1602	a base folder for the created machine, resulting in a file name like
1603	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1604	will be used.
1605
1606	This method does not access the host disks. In particular, it does not check
1607	for whether a machine of this name already exists.
1608	</desc>
1609	<param name="name" type="wstring" dir="in">
1610	<desc>Suggested machine name.</desc>
1611	</param>
1612	<param name="baseFolder" type="wstring" dir="in">
1613	<desc>Base machine folder (optional).</desc>
1614	</param>
1615	<param name="file" type="wstring" dir="return">
1616	<desc>Fully qualified path where the machine would be created.</desc>
1617	</param>
1618	</method>
1619
1620	<method name="createMachine">
1621	<desc>
1622	Creates a new virtual machine by creating a machine settings file at
1623	the given location.
1624
1625	VirtualBox machine settings files use a custom XML dialect. Starting
1626	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1627	and machine files can be created at arbitrary locations.
1628
1629	However, it is is recommended that machines be created in the default
1630	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1631	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1632	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1633	is called automatically to have such a recommended name composed based
1634	on the machine name given in the @a name argument.
1635
1636	If the resulting settings file already exists, this method will fail,
1637	unless @a forceOverwrite is set.
1638
1639	The new machine is created unregistered, with the initial configuration
1640	set according to the specified guest OS type. A typical sequence of
1641	actions to create a new virtual machine is as follows:
1642
1643	<ol>
1644	<li>
1645	Call this method to have a new machine created. The returned machine
1646	object will be "mutable" allowing to change any machine property.
1647	</li>
1648
1649	<li>
1650	Configure the machine using the appropriate attributes and methods.
1651	</li>
1652
1653	<li>
1654	Call <link to="IMachine::saveSettings" /> to write the settings
1655	to the machine's XML settings file. The configuration of the newly
1656	created machine will not be saved to disk until this method is
1657	called.
1658	</li>
1659
1660	<li>
1661	Call <link to="#registerMachine" /> to add the machine to the list
1662	of machines known to VirtualBox.
1663	</li>
1664	</ol>
1665
1666	The specified guest OS type identifier must match an ID of one of known
1667	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1668	array.
1669
1670	Optionally, you may specify an UUID of to assign to the created machine.
1671	However, this is not recommended and you should normally pass an empty
1672	(@c null) UUID to this method so that a new UUID will be automatically
1673	generated for every created machine. You can use UUID
1674	00000000-0000-0000-0000-000000000000 as @c null value.
1675
1676	<note>
1677	There is no way to change the name of the settings file or
1678	subfolder of the created machine directly.
1679	</note>
1680
1681	<result name="VBOX_E_OBJECT_NOT_FOUND">
1682	@a osTypeId is invalid.
1683	</result>
1684	<result name="VBOX_E_FILE_ERROR">
1685	Resulting settings file name is invalid or the settings file already
1686	exists or could not be created due to an I/O error.
1687	</result>
1688	<result name="E_INVALIDARG">
1689	@a name is empty or @c null.
1690	</result>
1691	</desc>
1692
1693	<param name="settingsFile" type="wstring" dir="in">
1694	<desc>Fully qualified path where the settings file should be created,
1695	or NULL for a default folder and file based on the @a name argument
1696	(see <link to="#composeMachineFilename" />).</desc>
1697	</param>
1698	<param name="name" type="wstring" dir="in">
1699	<desc>Machine name.</desc>
1700	</param>
1701	<param name="osTypeId" type="wstring" dir="in">
1702	<desc>Guest OS Type ID.</desc>
1703	</param>
1704	<param name="id" type="uuid" mod="string" dir="in">
1705	<desc>Machine UUID (optional).</desc>
1706	</param>
1707	<param name="forceOverwrite" type="boolean" dir="in">
1708	<desc>If true, an existing machine settings file will be overwritten.</desc>
1709	</param>
1710	<param name="machine" type="IMachine" dir="return">
1711	<desc>Created machine object.</desc>
1712	</param>
1713	</method>
1714
1715	<method name="openMachine">
1716	<desc>
1717	Opens a virtual machine from the existing settings file.
1718	The opened machine remains unregistered until you call
1719	<link to="#registerMachine"/>.
1720
1721	The specified settings file name must be fully qualified.
1722	The file must exist and be a valid machine XML settings file
1723	whose contents will be used to construct the machine object.
1724
1725	<result name="VBOX_E_FILE_ERROR">
1726	Settings file name invalid, not found or sharing violation.
1727	</result>
1728	</desc>
1729	<param name="settingsFile" type="wstring" dir="in">
1730	<desc>
1731	Name of the machine settings file.
1732	</desc>
1733	</param>
1734	<param name="machine" type="IMachine" dir="return">
1735	<desc>Opened machine object.</desc>
1736	</param>
1737	<note>
1738	<link to="IMachine::settingsModified"/> will return
1739	@c false for the created machine, until any of machine settings
1740	are changed.
1741	</note>
1742	</method>
1743
1744	<method name="registerMachine">
1745	<desc>
1746
1747	Registers the machine previously created using
1748	<link to="#createMachine"/> or opened using
1749	<link to="#openMachine"/> within this VirtualBox installation. After
1750	successful method invocation, the
1751	<link to="IMachineRegisteredEvent"/> event is fired.
1752
1753	<note>
1754	This method implicitly calls <link to="IMachine::saveSettings"/>
1755	to save all current machine settings before registering it.
1756	</note>
1757
1758	<result name="VBOX_E_OBJECT_NOT_FOUND">
1759	No matching virtual machine found.
1760	</result>
1761	<result name="VBOX_E_INVALID_OBJECT_STATE">
1762	Virtual machine was not created within this VirtualBox instance.
1763	</result>
1764
1765	</desc>
1766	<param name="machine" type="IMachine" dir="in"/>
1767	</method>
1768
1769	<method name="findMachine">
1770	<desc>
1771	Attempts to find a virtual machine given its name or UUID.
1772
1773	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1774	cannot safely be determined.</note>
1775
1776	<result name="VBOX_E_OBJECT_NOT_FOUND">
1777	Could not find registered machine matching @a nameOrId.
1778	</result>
1779
1780	</desc>
1781	<param name="nameOrId" type="wstring" dir="in">
1782	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1783	</param>
1784	<param name="machine" type="IMachine" dir="return">
1785	<desc>Machine object, if found.</desc>
1786	</param>
1787	</method>
1788
1789	<method name="getMachineStates">
1790	<desc>
1791	Gets the state of several machines in a single operation.
1792	</desc>
1793	<param name="machines" type="IMachine" dir="in" safearray="yes">
1794	<desc>Array with the machine references.</desc>
1795	</param>
1796	<param name="states" type="MachineState" dir="return" safearray="yes">
1797	<desc>Machine states, corresponding to the machines.</desc>
1798	</param>
1799	</method>
1800
1801	<method name="createAppliance">
1802	<desc>
1803	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1804	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1805	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1806	</desc>
1807	<param name="appliance" type="IAppliance" dir="return">
1808	<desc>New appliance.</desc>
1809	</param>
1810	</method>
1811
1812	<method name="createHardDisk">
1813	<desc>
1814	Creates a new base medium object that will use the given storage
1815	format and location for medium data.
1816
1817	The actual storage unit is not created by this method. In order to
1818	do it, and before you are able to attach the created medium to
1819	virtual machines, you must call one of the following methods to
1820	allocate a format-specific storage unit at the specified location:
1821	<ul>
1822	<li><link to="IMedium::createBaseStorage"/></li>
1823	<li><link to="IMedium::createDiffStorage"/></li>
1824	</ul>
1825
1826	Some medium attributes, such as <link to="IMedium::id"/>, may
1827	remain uninitialized until the medium storage unit is successfully
1828	created by one of the above methods.
1829
1830	After the storage unit is successfully created, it will be
1831	accessible through the <link to="#openMedium"/> method and can
1832	be found in the <link to="#hardDisks"/> array.
1833
1834	The list of all storage formats supported by this VirtualBox
1835	installation can be obtained using
1836	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1837	attribute is empty or @c null then the default storage format
1838	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1839	be used for creating a storage unit of the medium.
1840
1841	Note that the format of the location string is storage format specific.
1842	See <link to="IMedium::location"/> and IMedium for more details.
1843
1844	<result name="VBOX_E_OBJECT_NOT_FOUND">
1845	@a format identifier is invalid. See
1846	<link to="ISystemProperties::mediumFormats"/>.
1847	</result>
1848	<result name="VBOX_E_FILE_ERROR">
1849	@a location is a not valid file name (for file-based formats only).
1850	</result>
1851	</desc>
1852	<param name="format" type="wstring" dir="in">
1853	<desc>
1854	Identifier of the storage format to use for the new medium.
1855	</desc>
1856	</param>
1857	<param name="location" type="wstring" dir="in">
1858	<desc>
1859	Location of the storage unit for the new medium.
1860	</desc>
1861	</param>
1862	<param name="medium" type="IMedium" dir="return">
1863	<desc>Created medium object.</desc>
1864	</param>
1865	</method>
1866
1867	<method name="openMedium">
1868	<desc>
1869	Finds existing media or opens a medium from an existing storage location.
1870
1871	Once a medium has been opened, it can be passed to other VirtualBox
1872	methods, in particular to <link to="IMachine::attachDevice" />.
1873
1874	Depending on the given device type, the file at the storage location
1875	must be in one of the media formats understood by VirtualBox:
1876
1877	<ul>
1878	<li>With a "HardDisk" device type, the file must be a hard disk image
1879	in one of the formats supported by VirtualBox (see
1880	<link to="ISystemProperties::mediumFormats" />).
1881	After this method succeeds, if the medium is a base medium, it
1882	will be added to the <link to="#hardDisks"/> array attribute. </li>
1883	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1884	After this method succeeds, the medium will be added to the
1885	<link to="#DVDImages"/> array attribute.</li>
1886	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1887	After this method succeeds, the medium will be added to the
1888	<link to="#floppyImages"/> array attribute.</li>
1889	</ul>
1890
1891	After having been opened, the medium can be re-found by this method
1892	and can be attached to virtual machines. See <link to="IMedium" /> for
1893	more details.
1894
1895	The UUID of the newly opened medium will either be retrieved from the
1896	storage location, if the format supports it (e.g. for hard disk images),
1897	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1898	If for some reason you need to change the medium's UUID, use
1899	<link to="IMedium::setIDs" />.
1900
1901	If a differencing hard disk medium is to be opened by this method, the
1902	operation will succeed only if its parent medium and all ancestors,
1903	if any, are already known to this VirtualBox installation (for example,
1904	were opened by this method before).
1905
1906	This method attempts to guess the storage format of the specified medium
1907	by reading medium data at the specified location.
1908
1909	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1910	the image is opened for read/write access and must have according permissions,
1911	as VirtualBox may actually write status information into the disk's metadata
1912	sections.
1913
1914	Note that write access is required for all typical hard disk usage in VirtualBox,
1915	since VirtualBox may need to write metadata such as a UUID into the image.
1916	The only exception is opening a source image temporarily for copying and
1917	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1918	again soon.
1919
1920	The format of the location string is storage format specific. See
1921	<link to="IMedium::location"/> and IMedium for more details.
1922
1923	<result name="VBOX_E_FILE_ERROR">
1924	Invalid medium storage file location or could not find the medium
1925	at the specified location.
1926	</result>
1927	<result name="VBOX_E_IPRT_ERROR">
1928	Could not get medium storage format.
1929	</result>
1930	<result name="E_INVALIDARG">
1931	Invalid medium storage format.
1932	</result>
1933	<result name="VBOX_E_INVALID_OBJECT_STATE">
1934	Medium has already been added to a media registry.
1935	</result>
1936	</desc>
1937	<param name="location" type="wstring" dir="in">
1938	<desc>
1939	Location of the storage unit that contains medium data in one of
1940	the supported storage formats.
1941	</desc>
1942	</param>
1943	<param name="deviceType" type="DeviceType" dir="in">
1944	<desc>
1945	Must be one of "HardDisk", "DVD" or "Floppy".
1946	</desc>
1947	</param>
1948	<param name="accessMode" type="AccessMode" dir="in">
1949	<desc>Whether to open the image in read/write or read-only mode. For
1950	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1951	</param>
1952	<param name="forceNewUuid" type="boolean" dir="in">
1953	<desc>Allows the caller to request a completely new medium UUID for
1954	the image which is to be opened. Useful if one intends to open an exact
1955	copy of a previously opened image, as this would normally fail due to
1956	the duplicate UUID.</desc>
1957	</param>
1958	<param name="medium" type="IMedium" dir="return">
1959	<desc>Opened medium object.</desc>
1960	</param>
1961	</method>
1962
1963	<method name="getGuestOSType">
1964	<desc>
1965	Returns an object describing the specified guest OS type.
1966
1967	The requested guest OS type is specified using a string which is a
1968	mnemonic identifier of the guest operating system, such as
1969	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1970	particular virtual machine can be read or set using the
1971	<link to="IMachine::OSTypeId"/> attribute.
1972
1973	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1974	available guest OS type objects. Each object has an
1975	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1976	the guest OS this object describes.
1977
1978	<result name="E_INVALIDARG">
1979	@a id is not a valid Guest OS type.
1980	</result>
1981
1982	</desc>
1983	<param name="id" type="uuid" mod="string" dir="in">
1984	<desc>Guest OS type ID string.</desc>
1985	</param>
1986	<param name="type" type="IGuestOSType" dir="return">
1987	<desc>Guest OS type object.</desc>
1988	</param>
1989	</method>
1990
1991	<method name="createSharedFolder">
1992	<desc>
1993	Creates a new global shared folder by associating the given logical
1994	name with the given host path, adds it to the collection of shared
1995	folders and starts sharing it. Refer to the description of
1996	<link to="ISharedFolder"/> to read more about logical names.
1997	<note>
1998	In the current implementation, this operation is not
1999	implemented.
2000	</note>
2001	</desc>
2002	<param name="name" type="wstring" dir="in">
2003	<desc>Unique logical name of the shared folder.</desc>
2004	</param>
2005	<param name="hostPath" type="wstring" dir="in">
2006	<desc>Full path to the shared folder in the host file system.</desc>
2007	</param>
2008	<param name="writable" type="boolean" dir="in">
2009	<desc>Whether the share is writable or readonly</desc>
2010	</param>
2011	<param name="automount" type="boolean" dir="in">
2012	<desc>Whether the share gets automatically mounted by the guest
2013	or not.</desc>
2014	</param>
2015	</method>
2016
2017	<method name="removeSharedFolder">
2018	<desc>
2019	Removes the global shared folder with the given name previously
2020	created by <link to="#createSharedFolder"/> from the collection of
2021	shared folders and stops sharing it.
2022	<note>
2023	In the current implementation, this operation is not
2024	implemented.
2025	</note>
2026	</desc>
2027	<param name="name" type="wstring" dir="in">
2028	<desc>Logical name of the shared folder to remove.</desc>
2029	</param>
2030	</method>
2031
2032	<method name="getExtraDataKeys">
2033	<desc>
2034	Returns an array representing the global extra data keys which currently
2035	have values defined.
2036	</desc>
2037	<param name="value" type="wstring" dir="return" safearray="yes">
2038	<desc>Array of extra data keys.</desc>
2039	</param>
2040	</method>
2041
2042	<method name="getExtraData">
2043	<desc>
2044	Returns associated global extra data.
2045
2046	If the requested data @a key does not exist, this function will
2047	succeed and return an empty string in the @a value argument.
2048
2049	<result name="VBOX_E_FILE_ERROR">
2050	Settings file not accessible.
2051	</result>
2052	<result name="VBOX_E_XML_ERROR">
2053	Could not parse the settings file.
2054	</result>
2055
2056	</desc>
2057	<param name="key" type="wstring" dir="in">
2058	<desc>Name of the data key to get.</desc>
2059	</param>
2060	<param name="value" type="wstring" dir="return">
2061	<desc>Value of the requested data key.</desc>
2062	</param>
2063	</method>
2064
2065	<method name="setExtraData">
2066	<desc>
2067	Sets associated global extra data.
2068
2069	If you pass @c null or empty string as a key @a value, the given @a key
2070	will be deleted.
2071
2072	<note>
2073	Before performing the actual data change, this method will ask all
2074	registered event listener using the
2075	<link to="IExtraDataCanChangeEvent"/>
2076	notification for a permission. If one of the listeners refuses the
2077	new value, the change will not be performed.
2078	</note>
2079	<note>
2080	On success, the
2081	<link to="IExtraDataChangedEvent"/> notification
2082	is called to inform all registered listeners about a successful data
2083	change.
2084	</note>
2085
2086	<result name="VBOX_E_FILE_ERROR">
2087	Settings file not accessible.
2088	</result>
2089	<result name="VBOX_E_XML_ERROR">
2090	Could not parse the settings file.
2091	</result>
2092	<result name="E_ACCESSDENIED">
2093	Modification request refused.
2094	</result>
2095
2096	</desc>
2097	<param name="key" type="wstring" dir="in">
2098	<desc>Name of the data key to set.</desc>
2099	</param>
2100	<param name="value" type="wstring" dir="in">
2101	<desc>Value to assign to the key.</desc>
2102	</param>
2103	</method>
2104
2105	<!--method name="createDHCPServerForInterface">
2106	<desc>
2107	Creates a dhcp server settings to be used for the given interface
2108	<result name="E_INVALIDARG">
2109	Host network interface @a name already exists.
2110	</result>
2111	</desc>
2112	<param name="interface" type="IHostNetworkInterface" dir="in">
2113	<desc>Network Interface</desc>
2114	</param>
2115	<param name="server" type="IDHCPServer" dir="out">
2116	<desc>Dhcp server settings</desc>
2117	</param>
2118	</method-->
2119
2120	<method name="createDHCPServer">
2121	<desc>
2122	Creates a dhcp server settings to be used for the given internal network name
2123	<result name="E_INVALIDARG">
2124	Host network interface @a name already exists.
2125	</result>
2126	</desc>
2127	<param name="name" type="wstring" dir="in">
2128	<desc>server name</desc>
2129	</param>
2130	<param name="server" type="IDHCPServer" dir="return">
2131	<desc>Dhcp server settings</desc>
2132	</param>
2133	</method>
2134
2135	<method name="findDHCPServerByNetworkName">
2136	<desc>
2137	Searches a dhcp server settings to be used for the given internal network name
2138	<result name="E_INVALIDARG">
2139	Host network interface @a name already exists.
2140	</result>
2141
2142	</desc>
2143	<param name="name" type="wstring" dir="in">
2144	<desc>server name</desc>
2145	</param>
2146	<param name="server" type="IDHCPServer" dir="return">
2147	<desc>Dhcp server settings</desc>
2148	</param>
2149	</method>
2150
2151	<!--method name="findDHCPServerForInterface">
2152	<desc>
2153	Searches a dhcp server settings to be used for the given interface
2154	<result name="E_INVALIDARG">
2155	Host network interface @a name already exists.
2156	</result>
2157	</desc>
2158	<param name="interface" type="IHostNetworkInterface" dir="in">
2159	<desc>Network Interface</desc>
2160	</param>
2161	<param name="server" type="IDHCPServer" dir="out">
2162	<desc>Dhcp server settings</desc>
2163	</param>
2164	</method-->
2165
2166	<method name="removeDHCPServer">
2167	<desc>
2168	Removes the dhcp server settings
2169	<result name="E_INVALIDARG">
2170	Host network interface @a name already exists.
2171	</result>
2172	</desc>
2173	<param name="server" type="IDHCPServer" dir="in">
2174	<desc>Dhcp server settings to be removed</desc>
2175	</param>
2176	</method>
2177
2178
2179	<method name="checkFirmwarePresent">
2180	<desc>
2181	Check if this VirtualBox installation has a firmware
2182	of the given type available, either system-wide or per-user.
2183	Optionally, this may return a hint where this firmware can be
2184	downloaded from.
2185	</desc>
2186	<param name="firmwareType" type="FirmwareType" dir="in">
2187	<desc>
2188	Type of firmware to check.
2189	</desc>
2190	</param>
2191	<param name="version" type="wstring" dir="in">
2192	<desc>Expected version number, usually empty string (presently ignored).</desc>
2193	</param>
2194
2195	<param name="url" type="wstring" dir="out">
2196	<desc>
2197	Suggested URL to download this firmware from.
2198	</desc>
2199	</param>
2200
2201	<param name="file" type="wstring" dir="out">
2202	<desc>
2203	Filename of firmware, only valid if result == TRUE.
2204	</desc>
2205	</param>
2206
2207	<param name="result" type="boolean" dir="return">
2208	<desc>If firmware of this type and version is available.</desc>
2209	</param>
2210	</method>
2211
2212	</interface>
2213
2214	<!--
2215	// IVFSExplorer
2216	/////////////////////////////////////////////////////////////////////////
2217	-->
2218
2219	<enum
2220	name="VFSType"
2221	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2222	>
2223	<desc>
2224	Virtual file systems supported by VFSExplorer.
2225	</desc>
2226
2227	<const name="File" value="1" />
2228	<const name="Cloud" value="2" />
2229	<const name="S3" value="3" />
2230	<const name="WebDav" value="4" />
2231	</enum>
2232
2233	<enum
2234	name="VFSFileType"
2235	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2236	>
2237	<desc>
2238	File types known by VFSExplorer.
2239	</desc>
2240
2241	<const name="Unknown" value="1" />
2242	<const name="Fifo" value="2" />
2243	<const name="DevChar" value="3" />
2244	<const name="Directory" value="4" />
2245	<const name="DevBlock" value="5" />
2246	<const name="File" value="6" />
2247	<const name="SymLink" value="7" />
2248	<const name="Socket" value="8" />
2249	<const name="WhiteOut" value="9" />
2250	</enum>
2251
2252	<interface
2253	name="IVFSExplorer" extends="$unknown"
2254	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2255	wsmap="managed"
2256	>
2257	<desc>
2258	The VFSExplorer interface unifies access to different file system
2259	types. This includes local file systems as well remote file systems like
2260	S3. For a list of supported types see <link to="VFSType" />.
2261	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2262	</desc>
2263
2264	<attribute name="path" type="wstring" readonly="yes">
2265	<desc>Returns the current path in the virtual file system.</desc>
2266	</attribute>
2267
2268	<attribute name="type" type="VFSType" readonly="yes">
2269	<desc>Returns the file system type which is currently in use.</desc>
2270	</attribute>
2271
2272	<method name="update">
2273	<desc>Updates the internal list of files/directories from the
2274	current directory level. Use <link to="#entryList" /> to get the full list
2275	after a call to this method.</desc>
2276
2277	<param name="aProgress" type="IProgress" dir="return">
2278	<desc>Progress object to track the operation completion.</desc>
2279	</param>
2280	</method>
2281
2282	<method name="cd">
2283	<desc>Change the current directory level.</desc>
2284
2285	<param name="aDir" type="wstring" dir="in">
2286	<desc>The name of the directory to go in.</desc>
2287	</param>
2288
2289	<param name="aProgress" type="IProgress" dir="return">
2290	<desc>Progress object to track the operation completion.</desc>
2291	</param>
2292	</method>
2293
2294	<method name="cdUp">
2295	<desc>Go one directory upwards from the current directory level.</desc>
2296
2297	<param name="aProgress" type="IProgress" dir="return">
2298	<desc>Progress object to track the operation completion.</desc>
2299	</param>
2300	</method>
2301
2302	<method name="entryList">
2303	<desc>Returns a list of files/directories after a call to <link
2304	to="#update" />. The user is responsible for keeping this internal
2305	list up do date.</desc>
2306
2307	<param name="aNames" type="wstring" safearray="yes" dir="out">
2308	<desc>The list of names for the entries.</desc>
2309	</param>
2310
2311	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2312	<desc>The list of types for the entries.</desc>
2313	</param>
2314
2315	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2316	<desc>The list of sizes (in bytes) for the entries.</desc>
2317	</param>
2318
2319	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2320	<desc>The list of file modes (in octal form) for the entries.</desc>
2321	</param>
2322	</method>
2323
2324	<method name="exists">
2325	<desc>Checks if the given file list exists in the current directory
2326	level.</desc>
2327
2328	<param name="aNames" type="wstring" safearray="yes" dir="in">
2329	<desc>The names to check.</desc>
2330	</param>
2331
2332	<param name="aExists" type="wstring" safearray="yes" dir="return">
2333	<desc>The names which exist.</desc>
2334	</param>
2335	</method>
2336
2337	<method name="remove">
2338	<desc>Deletes the given files in the current directory level.</desc>
2339
2340	<param name="aNames" type="wstring" safearray="yes" dir="in">
2341	<desc>The names to remove.</desc>
2342	</param>
2343
2344	<param name="aProgress" type="IProgress" dir="return">
2345	<desc>Progress object to track the operation completion.</desc>
2346	</param>
2347	</method>
2348
2349	</interface>
2350
2351	<enum
2352	name="ImportOptions" extends="$unknown"
2353	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2354	>
2355
2356	<desc>
2357	Import options, used with <link to="IAppliance::importMachines" />.
2358	</desc>
2359
2360	<const name="KeepAllMACs" value="1">
2361	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2362	</const>
2363	<const name="KeepNATMACs" value="2">
2364	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2365	</const>
2366
2367	</enum>
2368
2369
2370	<!--
2371	// IAppliance
2372	/////////////////////////////////////////////////////////////////////////
2373	-->
2374
2375	<interface
2376	name="IAppliance" extends="$unknown"
2377	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2378	wsmap="managed"
2379	>
2380	<desc>
2381	Represents a platform-independent appliance in OVF format. An instance of this is returned
2382	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2383	virtual machines within an appliance with VirtualBox.
2384
2385	The OVF standard suggests two different physical file formats:
2386
2387	<ol>
2388	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2389	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2390	this descriptor file references other files such as disk images, as OVF appliances typically
2391	do, those additional files must be in the same directory as the descriptor file.</li>
2392
2393	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2394	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2395	files and optionally other files.
2396
2397	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2398	be added with a later version.</li>
2399	</ol>
2400
2401	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2402	<link to="IMachine" /> involves the following sequence of API calls:
2403
2404	<ol>
2405	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2406	</li>
2407
2408	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2409	would like to import. So long as this file is syntactically valid, this will succeed
2410	and fill the appliance object with the parsed data from the OVF file.
2411	</li>
2412
2413	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2414	contents of the IAppliance attributes accordingly. These can be inspected by a
2415	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2416	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2417	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2418	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2419	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2420	The GUI can then give the user the option to confirm and/or change these suggestions.
2421	</li>
2422
2423	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2424	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2425	</li>
2426
2427	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2428	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2429	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2430	can be found in the <link to="#machines" /> array attribute.
2431	</li>
2432	</ol>
2433
2434	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2435
2436	<ol>
2437	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2438	an empty IAppliance object.
2439	</li>
2440
2441	<li>For each machine you would like to export, call <link to="IMachine::export" />
2442	with the IAppliance object you just created. Each such call creates one instance of
2443	<link to="IVirtualSystemDescription" /> inside the appliance.
2444	</li>
2445
2446	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2447	virtual system (machine) to override the suggestions made by the <link to="IMachine::export"/> routine.
2448	</li>
2449
2450	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2451	file written.</li>
2452	</ol>
2453
2454	</desc>
2455
2456	<attribute name="path" type="wstring" readonly="yes">
2457	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2458	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2459	<link to="#write" /> (for export).
2460	This attribute is empty until one of these methods has been called.
2461	</desc>
2462	</attribute>
2463
2464	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2465	<desc>
2466	Array of virtual disk definitions. One such description exists for each
2467	disk definition in the OVF; each string array item represents one such piece of
2468	disk information, with the information fields separated by tab (\\t) characters.
2469
2470	The caller should be prepared for additional fields being appended to
2471	this string in future versions of VirtualBox and therefore check for
2472	the number of tabs in the strings returned.
2473
2474	In the current version, the following eight fields are returned per string
2475	in the array:
2476
2477	<ol>
2478	<li>Disk ID (unique string identifier given to disk)</li>
2479
2480	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2481
2482	<li>Populated size (optional unsigned integer indicating the current size of the
2483	disk; can be approximate; -1 if unspecified)</li>
2484
2485	<li>Format (string identifying the disk format, typically
2486	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2487
2488	<li>Reference (where to find the disk image, typically a file name; if empty,
2489	then the disk should be created on import)</li>
2490
2491	<li>Image size (optional unsigned integer indicating the size of the image,
2492	which need not necessarily be the same as the values specified above, since
2493	the image may be compressed or sparse; -1 if not specified)</li>
2494
2495	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2496	presently unsupported and always -1)</li>
2497
2498	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2499	</ol>
2500	</desc>
2501	</attribute>
2502
2503	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2504	<desc> Array of virtual system descriptions. One such description is created
2505	for each virtual system (machine) found in the OVF.
2506	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2507	(for export) has been called.
2508	</desc>
2509	</attribute>
2510
2511	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2512	<desc>
2513	Contains the UUIDs of the machines created from the information in this appliances. This is only
2514	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2515	succeeded.
2516	</desc>
2517	</attribute>
2518
2519	<method name="read">
2520	<desc>
2521	Reads an OVF file into the appliance object.
2522
2523	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2524	mere fact that this method returns successfully does not mean that VirtualBox supports all
2525	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2526	</desc>
2527	<param name="file" type="wstring" dir="in">
2528	<desc>
2529	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2530	on whether the appliance is distributed as a set of files or as a single file, respectively).
2531	</desc>
2532	</param>
2533	<param name="aProgress" type="IProgress" dir="return">
2534	<desc>Progress object to track the operation completion.</desc>
2535	</param>
2536	</method>
2537
2538	<method name="interpret">
2539	<desc>
2540	Interprets the OVF data that was read when the appliance was constructed. After
2541	calling this method, one can inspect the
2542	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2543	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2544	the appliance.
2545
2546	Calling this method is the second step of importing an appliance into VirtualBox;
2547	see <link to="IAppliance" /> for an overview.
2548
2549	After calling this method, one should call <link to="#getWarnings" /> to find out
2550	if problems were encountered during the processing which might later lead to
2551	errors.
2552	</desc>
2553	</method>
2554
2555	<method name="importMachines">
2556	<desc>
2557	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2558	and other interfaces that match the information contained in the appliance as
2559	closely as possible, as represented by the import instructions in the
2560	<link to="#virtualSystemDescriptions" /> array.
2561
2562	Calling this method is the final step of importing an appliance into VirtualBox;
2563	see <link to="IAppliance" /> for an overview.
2564
2565	Since importing the appliance will most probably involve copying and converting
2566	disk images, which can take a long time, this method operates asynchronously and
2567	returns an IProgress object to allow the caller to monitor the progress.
2568
2569	After the import succeeded, the UUIDs of the IMachine instances created can be
2570	retrieved from the <link to="#machines" /> array attribute.
2571	</desc>
2572
2573	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2574	<desc>Options for the importing operation.</desc>
2575	</param>
2576
2577	<param name="aProgress" type="IProgress" dir="return">
2578	<desc>Progress object to track the operation completion.</desc>
2579	</param>
2580	</method>
2581
2582	<method name="createVFSExplorer">
2583	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2584
2585	<param name="aUri" type="wstring" dir="in">
2586	<desc>The URI describing the file system to use.</desc>
2587	</param>
2588
2589	<param name="aExplorer" type="IVFSExplorer" dir="return">
2590	<desc></desc>
2591	</param>
2592	</method>
2593
2594	<method name="write">
2595	<desc>
2596	Writes the contents of the appliance exports into a new OVF file.
2597
2598	Calling this method is the final step of exporting an appliance from VirtualBox;
2599	see <link to="IAppliance" /> for an overview.
2600
2601	Since exporting the appliance will most probably involve copying and converting
2602	disk images, which can take a long time, this method operates asynchronously and
2603	returns an IProgress object to allow the caller to monitor the progress.
2604	</desc>
2605	<param name="format" type="wstring" dir="in">
2606	<desc>
2607	Output format, as a string. Currently supported formats are "ovf-0.9", "ovf-1.0"
2608	and "ovf-2.0"; future versions of VirtualBox may support additional formats.
2609	</desc>
2610	</param>
2611	<param name="manifest" type="boolean" dir="in">
2612	<desc>
2613	Indicate if the optional manifest file (.mf) should be written. The manifest file
2614	is used for integrity checks prior import.
2615	</desc>
2616	</param>
2617	<param name="path" type="wstring" dir="in">
2618	<desc>
2619	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2620	on whether the appliance is distributed as a set of files or as a single file, respectively).
2621	</desc>
2622	</param>
2623	<param name="progress" type="IProgress" dir="return">
2624	<desc>Progress object to track the operation completion.</desc>
2625	</param>
2626	</method>
2627
2628	<method name="getWarnings">
2629	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2630
2631	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2632	<desc></desc>
2633	</param>
2634	</method>
2635
2636	</interface>
2637
2638	<enum
2639	name="VirtualSystemDescriptionType"
2640	uuid="303c0900-a746-4612-8c67-79003e91f459"
2641	>
2642	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2643	a configuration value.</desc>
2644
2645	<const name="Ignore" value="1" />
2646	<const name="OS" value="2" />
2647	<const name="Name" value="3" />
2648	<const name="Product" value="4" />
2649	<const name="Vendor" value="5" />
2650	<const name="Version" value="6" />
2651	<const name="ProductUrl" value="7" />
2652	<const name="VendorUrl" value="8" />
2653	<const name="Description" value="9" />
2654	<const name="License" value="10" />
2655	<const name="Miscellaneous" value="11" />
2656	<const name="CPU" value="12" />
2657	<const name="Memory" value="13" />
2658	<const name="HardDiskControllerIDE" value="14" />
2659	<const name="HardDiskControllerSATA" value="15" />
2660	<const name="HardDiskControllerSCSI" value="16" />
2661	<const name="HardDiskControllerSAS" value="17" />
2662	<const name="HardDiskImage" value="18" />
2663	<const name="Floppy" value="19" />
2664	<const name="CDROM" value="20" />
2665	<const name="NetworkAdapter" value="21" />
2666	<const name="USBController" value="22" />
2667	<const name="SoundCard" value="23" />
2668	<const name="SettingsFile" value="24">
2669	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2670	</const>
2671	</enum>
2672
2673	<enum
2674	name="VirtualSystemDescriptionValueType"
2675	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2676	>
2677	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2678	type to fetch.</desc>
2679
2680	<const name="Reference" value="1" />
2681	<const name="Original" value="2" />
2682	<const name="Auto" value="3" />
2683	<const name="ExtraConfig" value="4" />
2684
2685	</enum>
2686
2687	<interface
2688	name="IVirtualSystemDescription" extends="$unknown"
2689	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2690	wsmap="managed"
2691	>
2692
2693	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2694	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2695	<link to="IAppliance::interpret" /> has been called, that array contains information
2696	about how the virtual systems described in the OVF should best be imported into
2697	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2698	import an OVF into VirtualBox.
2699	</desc>
2700
2701	<attribute name="count" type="unsigned long" readonly="yes">
2702	<desc>Return the number of virtual system description entries.</desc>
2703	</attribute>
2704
2705	<method name="getDescription">
2706	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2707	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2708
2709	The list below identifies the value sets that are possible depending on the
2710	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2711	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2712	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2713	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2714	the @a aExtraConfigValues[] array item may also be used.
2715
2716	<ul>
2717	<li>
2718	"OS": the guest operating system type. There must be exactly one such array item on import. The
2719	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2720	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2721	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2722	</li>
2723	<li>
2724	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2725	if none is present on import, then an automatic name will be created from the operating system
2726	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2727	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2728	<link to="IMachine" /> name that does not exist yet.
2729	</li>
2730	<li>
2731	"Description": an arbitrary description.
2732	</li>
2733	<li>
2734	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2735	code to display such a license for agreement; the Main API does not enforce any such policy.
2736	</li>
2737	<li>
2738	Miscellaneous: reserved for future use.
2739	</li>
2740	<li>
2741	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2742	</li>
2743	<li>
2744	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2745	is present on import, then VirtualBox will set a meaningful default based on the operating system
2746	type.
2747	</li>
2748	<li>
2749	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2750	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2751	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2752	writes into the OVF.
2753	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2754	type can use to specify which hard disk controller a virtual disk should be connected to.
2755	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2756	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2757	its virtual machines supports four channels (primary master, primary slave, secondary master,
2758	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2759	</li>
2760	<li>
2761	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2762	has no value in @a aOvfValues[] or @a aVBoxValues[].
2763	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2764	</li>
2765	<li>
2766	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2767	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2768	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2769	whereas VirtualBox considers it a class of storage controllers of its own; see
2770	<link to="StorageControllerType" />).
2771	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2772	</li>
2773	<li>
2774	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2775	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2776
2777	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2778	a path since the image file should be in the same location as the OVF file itself), whereas the
2779	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2780	hard disk image. This means that on import the image will be copied and converted from the
2781	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2782
2783	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2784	format: "controller=<index>;channel=<c>"
2785	In this string, <index> must be an integer specifying the hard disk controller to connect
2786	the image to. That number must be the index of an array item with one of the hard disk controller
2787	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2788	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2789	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2790	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2791	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2792	</li>
2793	<li>
2794	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2795	attachment information as with "HardDiskImage" items.
2796	</li>
2797	<li>
2798	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2799	attachment information as with "HardDiskImage" items.
2800	</li>
2801	<li>
2802	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2803	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2804	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2805	</li>
2806	<li>
2807	"USBController": a USB controller. There can be at most one such item. If and only if such an
2808	item ispresent, USB support will be enabled for the new virtual machine.
2809	</li>
2810	<li>
2811	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2812	present, sound support will be enabled for the new virtual machine. Note that the virtual
2813	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2814	may be different from the virtual soundcard expected by the appliance.
2815	</li>
2816	</ul>
2817
2818	</desc>
2819
2820	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2821	<desc></desc>
2822	</param>
2823
2824	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2825	<desc></desc>
2826	</param>
2827
2828	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2829	<desc></desc>
2830	</param>
2831
2832	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2833	<desc></desc>
2834	</param>
2835
2836	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2837	<desc></desc>
2838	</param>
2839
2840	</method>
2841
2842	<method name="getDescriptionByType">
2843	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2844	should be returned.</desc>
2845
2846	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2847	<desc></desc>
2848	</param>
2849
2850	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2851	<desc></desc>
2852	</param>
2853
2854	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2855	<desc></desc>
2856	</param>
2857
2858	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2859	<desc></desc>
2860	</param>
2861
2862	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2863	<desc></desc>
2864	</param>
2865
2866	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2867	<desc></desc>
2868	</param>
2869
2870	</method>
2871
2872	<method name="getValuesByType">
2873	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2874	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2875	values.</desc>
2876
2877	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2878	<desc></desc>
2879	</param>
2880
2881	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2882	<desc></desc>
2883	</param>
2884
2885	<param name="aValues" type="wstring" dir="return" safearray="yes">
2886	<desc></desc>
2887	</param>
2888
2889	</method>
2890
2891	<method name="setFinalValues">
2892	<desc>
2893	This method allows the appliance's user to change the configuration for the virtual
2894	system descriptions. For each array item returned from <link to="#getDescription" />,
2895	you must pass in one boolean value and one configuration value.
2896
2897	Each item in the boolean array determines whether the particular configuration item
2898	should be enabled.
2899	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2900	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2901	and SoundCard.
2902
2903	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2904	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
2905	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
2906	for valid configuration values for the individual array item types. If the
2907	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2908	</desc>
2909
2910	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2911	<desc></desc>
2912	</param>
2913
2914	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2915	<desc></desc>
2916	</param>
2917
2918	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2919	<desc></desc>
2920	</param>
2921	</method>
2922
2923	<method name="addDescription">
2924	<desc>
2925	This method adds an additional description entry to the stack of already
2926	available descriptions for this virtual system. This is handy for writing
2927	values which aren't directly supported by VirtualBox. One example would
2928	be the License type of <link to="VirtualSystemDescriptionType" />.
2929	</desc>
2930
2931	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2932	<desc></desc>
2933	</param>
2934
2935	<param name="aVBoxValue" type="wstring" dir="in">
2936	<desc></desc>
2937	</param>
2938
2939	<param name="aExtraConfigValue" type="wstring" dir="in">
2940	<desc></desc>
2941	</param>
2942	</method>
2943	</interface>
2944
2945
2946	<!--
2947	// IMachine
2948	/////////////////////////////////////////////////////////////////////////
2949	-->
2950
2951	<interface
2952	name="IInternalMachineControl" extends="$unknown"
2953	uuid="ec824977-e43f-479c-81c9-ac6cae1423a5"
2954	internal="yes"
2955	wsmap="suppress"
2956	>
2957	<method name="setRemoveSavedStateFile">
2958	<desc>
2959	Updates the flag whether the saved state file is removed on a
2960	machine state change from Saved to PoweredOff.
2961	</desc>
2962	<param name="aRemove" type="boolean" dir="in"/>
2963	</method>
2964
2965	<method name="updateState">
2966	<desc>
2967	Updates the VM state.
2968	<note>
2969	This operation will also update the settings file with the correct
2970	information about the saved state file and delete this file from disk
2971	when appropriate.
2972	</note>
2973	</desc>
2974	<param name="state" type="MachineState" dir="in"/>
2975	</method>
2976
2977	<method name="getIPCId">
2978	<param name="id" type="wstring" dir="return"/>
2979	</method>
2980
2981	<method name="beginPowerUp">
2982	<desc>
2983	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2984	gives it the progress object that should be part of any pending
2985	<link to="IMachine::launchVMProcess"/> operations. The progress
2986	object may be called back to reflect an early cancelation, so some care
2987	have to be taken with respect to any cancelation callbacks. The console
2988	object will call <link to="IInternalMachineControl::endPowerUp"/>
2989	to signal the completion of the progress object.
2990	</desc>
2991	<param name="aProgress" type="IProgress" dir="in" />
2992	</method>
2993
2994	<method name="endPowerUp">
2995	<desc>
2996	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
2997	This method may query status information from the progress object it
2998	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
2999	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3000	call in order to complete that progress object.
3001	</desc>
3002	<param name="result" type="long" dir="in"/>
3003	</method>
3004
3005	<method name="beginPoweringDown">
3006	<desc>
3007	Called by the VM process to inform the server it wants to
3008	stop the VM execution and power down.
3009	</desc>
3010	<param name="progress" type="IProgress" dir="out">
3011	<desc>
3012	Progress object created by VBoxSVC to wait until
3013	the VM is powered down.
3014	</desc>
3015	</param>
3016	</method>
3017
3018	<method name="endPoweringDown">
3019	<desc>
3020	Called by the VM process to inform the server that powering
3021	down previously requested by #beginPoweringDown is either
3022	successfully finished or there was a failure.
3023
3024	<result name="VBOX_E_FILE_ERROR">
3025	Settings file not accessible.
3026	</result>
3027	<result name="VBOX_E_XML_ERROR">
3028	Could not parse the settings file.
3029	</result>
3030
3031	</desc>
3032
3033	<param name="result" type="long" dir="in">
3034	<desc>@c S_OK to indicate success.
3035	</desc>
3036	</param>
3037	<param name="errMsg" type="wstring" dir="in">
3038	<desc>@c human readable error message in case of failure.
3039	</desc>
3040	</param>
3041	</method>
3042
3043	<method name="runUSBDeviceFilters">
3044	<desc>
3045	Asks the server to run USB devices filters of the associated
3046	machine against the given USB device and tell if there is
3047	a match.
3048	<note>
3049	Intended to be used only for remote USB devices. Local
3050	ones don't require to call this method (this is done
3051	implicitly by the Host and USBProxyService).
3052	</note>
3053	</desc>
3054	<param name="device" type="IUSBDevice" dir="in"/>
3055	<param name="matched" type="boolean" dir="out"/>
3056	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3057	</method>
3058
3059	<method name="captureUSBDevice">
3060	<desc>
3061	Requests a capture of the given host USB device.
3062	When the request is completed, the VM process will
3063	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3064	notification.
3065	</desc>
3066	<param name="id" type="uuid" mod="string" dir="in"/>
3067	</method>
3068
3069	<method name="detachUSBDevice">
3070	<desc>
3071	Notification that a VM is going to detach (@a done = @c false) or has
3072	already detached (@a done = @c true) the given USB device.
3073	When the @a done = @c true request is completed, the VM process will
3074	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3075	notification.
3076	<note>
3077	In the @a done = @c true case, the server must run its own filters
3078	and filters of all VMs but this one on the detached device
3079	as if it were just attached to the host computer.
3080	</note>
3081	</desc>
3082	<param name="id" type="uuid" mod="string" dir="in"/>
3083	<param name="done" type="boolean" dir="in"/>
3084	</method>
3085
3086	<method name="autoCaptureUSBDevices">
3087	<desc>
3088	Requests a capture all matching USB devices attached to the host.
3089	When the request is completed, the VM process will
3090	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3091	notification per every captured device.
3092	</desc>
3093	</method>
3094
3095	<method name="detachAllUSBDevices">
3096	<desc>
3097	Notification that a VM that is being powered down. The done
3098	parameter indicates whether which stage of the power down
3099	we're at. When @a done = @c false the VM is announcing its
3100	intentions, while when @a done = @c true the VM is reporting
3101	what it has done.
3102	<note>
3103	In the @a done = @c true case, the server must run its own filters
3104	and filters of all VMs but this one on all detach devices as
3105	if they were just attached to the host computer.
3106	</note>
3107	</desc>
3108	<param name="done" type="boolean" dir="in"/>
3109	</method>
3110
3111	<method name="onSessionEnd">
3112	<desc>
3113	Triggered by the given session object when the session is about
3114	to close normally.
3115	</desc>
3116	<param name="session" type="ISession" dir="in">
3117	<desc>Session that is being closed</desc>
3118	</param>
3119	<param name="progress" type="IProgress" dir="return">
3120	<desc>
3121	Used to wait until the corresponding machine is actually
3122	dissociated from the given session on the server.
3123	Returned only when this session is a direct one.
3124	</desc>
3125	</param>
3126	</method>
3127
3128	<method name="beginSavingState">
3129	<desc>
3130	Called by the VM process to inform the server it wants to
3131	save the current state and stop the VM execution.
3132	</desc>
3133	<param name="progress" type="IProgress" dir="out">
3134	<desc>
3135	Progress object created by VBoxSVC to wait until
3136	the state is saved.
3137	</desc>
3138	</param>
3139	<param name="stateFilePath" type="wstring" dir="out">
3140	<desc>
3141	File path the VM process must save the execution state to.
3142	</desc>
3143	</param>
3144	</method>
3145
3146	<method name="endSavingState">
3147	<desc>
3148	Called by the VM process to inform the server that saving
3149	the state previously requested by #beginSavingState is either
3150	successfully finished or there was a failure.
3151
3152	<result name="VBOX_E_FILE_ERROR">
3153	Settings file not accessible.
3154	</result>
3155	<result name="VBOX_E_XML_ERROR">
3156	Could not parse the settings file.
3157	</result>
3158
3159	</desc>
3160
3161	<param name="result" type="long" dir="in">
3162	<desc>@c S_OK to indicate success.
3163	</desc>
3164	</param>
3165	<param name="errMsg" type="wstring" dir="in">
3166	<desc>@c human readable error message in case of failure.
3167	</desc>
3168	</param>
3169	</method>
3170
3171	<method name="adoptSavedState">
3172	<desc>
3173	Gets called by <link to="IConsole::adoptSavedState"/>.
3174	<result name="VBOX_E_FILE_ERROR">
3175	Invalid saved state file path.
3176	</result>
3177	</desc>
3178	<param name="savedStateFile" type="wstring" dir="in">
3179	<desc>Path to the saved state file to adopt.</desc>
3180	</param>
3181	</method>
3182
3183	<method name="beginTakingSnapshot">
3184	<desc>
3185	Called from the VM process to request from the server to perform the
3186	server-side actions of creating a snapshot (creating differencing images
3187	and the snapshot object).
3188
3189	<result name="VBOX_E_FILE_ERROR">
3190	Settings file not accessible.
3191	</result>
3192	<result name="VBOX_E_XML_ERROR">
3193	Could not parse the settings file.
3194	</result>
3195	</desc>
3196	<param name="initiator" type="IConsole" dir="in">
3197	<desc>The console object that initiated this call.</desc>
3198	</param>
3199	<param name="name" type="wstring" dir="in">
3200	<desc>Snapshot name.</desc>
3201	</param>
3202	<param name="description" type="wstring" dir="in">
3203	<desc>Snapshot description.</desc>
3204	</param>
3205	<param name="consoleProgress" type="IProgress" dir="in">
3206	<desc>
3207	Progress object created by the VM process tracking the
3208	snapshot's progress. This has the following sub-operations:
3209	<ul>
3210	<li>setting up (weight 1);</li>
3211	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3212	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3213	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3214	<li>finishing up (weight 1)</li>
3215	</ul>
3216	</desc>
3217	</param>
3218	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3219	<desc>
3220	Whether this is an online snapshot (i.e. the machine is running).
3221	</desc>
3222	</param>
3223	<param name="stateFilePath" type="wstring" dir="out">
3224	<desc>
3225	File path the VM process must save the execution state to.
3226	</desc>
3227	</param>
3228	</method>
3229
3230	<method name="endTakingSnapshot">
3231	<desc>
3232	Called by the VM process to inform the server that the snapshot
3233	previously requested by #beginTakingSnapshot is either
3234	successfully taken or there was a failure.
3235	</desc>
3236
3237	<param name="success" type="boolean" dir="in">
3238	<desc>@c true to indicate success and @c false otherwise</desc>
3239	</param>
3240	</method>
3241
3242	<method name="deleteSnapshot">
3243	<desc>
3244	Gets called by <link to="IConsole::deleteSnapshot"/>,
3245	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3246	<link to="IConsole::deleteSnapshotRange"/>.
3247	<result name="VBOX_E_INVALID_OBJECT_STATE">
3248	Snapshot has more than one child snapshot. Only possible if the
3249	delete operation does not delete all children or the range does
3250	not meet the linearity condition.
3251	</result>
3252	</desc>
3253	<param name="initiator" type="IConsole" dir="in">
3254	<desc>The console object that initiated this call.</desc>
3255	</param>
3256	<param name="startId" type="uuid" mod="string" dir="in">
3257	<desc>UUID of the first snapshot to delete.</desc>
3258	</param>
3259	<param name="endId" type="uuid" mod="string" dir="in">
3260	<desc>UUID of the last snapshot to delete.</desc>
3261	</param>
3262	<param name="deleteAllChildren" type="boolean" dir="in">
3263	<desc>Whether all children should be deleted.</desc>
3264	</param>
3265	<param name="machineState" type="MachineState" dir="out">
3266	<desc>New machine state after this operation is started.</desc>
3267	</param>
3268	<param name="progress" type="IProgress" dir="return">
3269	<desc>Progress object to track the operation completion.</desc>
3270	</param>
3271	</method>
3272
3273	<method name="finishOnlineMergeMedium">
3274	<desc>
3275	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3276	</desc>
3277	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3278	<desc>The medium attachment which needs to be cleaned up.</desc>
3279	</param>
3280	<param name="source" type="IMedium" dir="in">
3281	<desc>Merge source medium.</desc>
3282	</param>
3283	<param name="target" type="IMedium" dir="in">
3284	<desc>Merge target medium.</desc>
3285	</param>
3286	<param name="mergeForward" type="boolean" dir="in">
3287	<desc>Merge direction.</desc>
3288	</param>
3289	<param name="parentForTarget" type="IMedium" dir="in">
3290	<desc>For forward merges: new parent for target medium.</desc>
3291	</param>
3292	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3293	<desc>For backward merges: list of media which need their parent UUID
3294	updated.</desc>
3295	</param>
3296	</method>
3297
3298	<method name="restoreSnapshot">
3299	<desc>
3300	Gets called by <link to="IConsole::restoreSnapshot"/>.
3301	</desc>
3302	<param name="initiator" type="IConsole" dir="in">
3303	<desc>The console object that initiated this call.</desc>
3304	</param>
3305	<param name="snapshot" type="ISnapshot" dir="in">
3306	<desc>The snapshot to restore the VM state from.</desc>
3307	</param>
3308	<param name="machineState" type="MachineState" dir="out">
3309	<desc>New machine state after this operation is started.</desc>
3310	</param>
3311	<param name="progress" type="IProgress" dir="return">
3312	<desc>Progress object to track the operation completion.</desc>
3313	</param>
3314	</method>
3315
3316	<method name="pullGuestProperties">
3317	<desc>
3318	Get the list of the guest properties matching a set of patterns along
3319	with their values, time stamps and flags and give responsibility for
3320	managing properties to the console.
3321	</desc>
3322	<param name="name" type="wstring" dir="out" safearray="yes">
3323	<desc>
3324	The names of the properties returned.
3325	</desc>
3326	</param>
3327	<param name="value" type="wstring" dir="out" safearray="yes">
3328	<desc>
3329	The values of the properties returned. The array entries match the
3330	corresponding entries in the @a name array.
3331	</desc>
3332	</param>
3333	<param name="timestamp" type="long long" dir="out" safearray="yes">
3334	<desc>
3335	The time stamps of the properties returned. The array entries match
3336	the corresponding entries in the @a name array.
3337	</desc>
3338	</param>
3339	<param name="flags" type="wstring" dir="out" safearray="yes">
3340	<desc>
3341	The flags of the properties returned. The array entries match the
3342	corresponding entries in the @a name array.
3343	</desc>
3344	</param>
3345	</method>
3346
3347	<method name="pushGuestProperty">
3348	<desc>
3349	Update a single guest property in IMachine.
3350	</desc>
3351	<param name="name" type="wstring" dir="in">
3352	<desc>
3353	The name of the property to be updated.
3354	</desc>
3355	</param>
3356	<param name="value" type="wstring" dir="in">
3357	<desc>
3358	The value of the property.
3359	</desc>
3360	</param>
3361	<param name="timestamp" type="long long" dir="in">
3362	<desc>
3363	The timestamp of the property.
3364	</desc>
3365	</param>
3366	<param name="flags" type="wstring" dir="in">
3367	<desc>
3368	The flags of the property.
3369	</desc>
3370	</param>
3371	</method>
3372
3373	<method name="lockMedia">
3374	<desc>
3375	Locks all media attached to the machine for writing and parents of
3376	attached differencing media (if any) for reading. This operation is
3377	atomic so that if it fails no media is actually locked.
3378
3379	This method is intended to be called when the machine is in Starting or
3380	Restoring state. The locked media will be automatically unlocked when
3381	the machine is powered off or crashed.
3382	</desc>
3383	</method>
3384	<method name="unlockMedia">
3385	<desc>
3386	Unlocks all media previously locked using
3387	<link to="IInternalMachineControl::lockMedia"/>.
3388
3389	This method is intended to be used with teleportation so that it is
3390	possible to teleport between processes on the same machine.
3391	</desc>
3392	</method>
3393
3394	<method name="ejectMedium">
3395	<desc>
3396	Tells VBoxSVC that the guest has ejected the medium associated with
3397	the medium attachment.
3398	</desc>
3399	<param name="attachment" type="IMediumAttachment" dir="in">
3400	<desc>
3401	The medium attachment where the eject happened.
3402	</desc>
3403	</param>
3404	<param name="newAttachment" type="IMediumAttachment" dir="return">
3405	<desc>
3406	A new reference to the medium attachment, as the config change can
3407	result in the creation of a new instance.
3408	</desc>
3409	</param>
3410	</method>
3411
3412	<method name="reportGuestStatistics">
3413	<desc>
3414	Passes collected guest statistics to VBoxSVC.
3415	</desc>
3416	<param name="validStats" type="unsigned long" dir="in">
3417	<desc>
3418	Mask defining which parameters are valid. For example: 0x11 means
3419	that cpuIdle and XXX are valid. Other parameters should be ignored.
3420	</desc>
3421	</param>
3422	<param name="cpuUser" type="unsigned long" dir="in">
3423	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
3424	</param>
3425	<param name="cpuKernel" type="unsigned long" dir="in">
3426	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
3427	</param>
3428	<param name="cpuIdle" type="unsigned long" dir="in">
3429	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
3430	</param>
3431	<param name="memTotal" type="unsigned long" dir="in">
3432	<desc>Total amount of physical guest RAM.</desc>
3433	</param>
3434	<param name="memFree" type="unsigned long" dir="in">
3435	<desc>Free amount of physical guest RAM.</desc>
3436	</param>
3437	<param name="memBalloon" type="unsigned long" dir="in">
3438	<desc>Amount of ballooned physical guest RAM.</desc>
3439	</param>
3440	<param name="memShared" type="unsigned long" dir="in">
3441	<desc>Amount of shared physical guest RAM.</desc>
3442	</param>
3443	<param name="memCache" type="unsigned long" dir="in">
3444	<desc>Total amount of guest (disk) cache memory.</desc>
3445	</param>
3446	<param name="pagedTotal" type="unsigned long" dir="in">
3447	<desc>Total amount of space in the page file.</desc>
3448	</param>
3449	<param name="memAllocTotal" type="unsigned long" dir="in">
3450	<desc>Total amount of memory allocated by the hypervisor.</desc>
3451	</param>
3452	<param name="memFreeTotal" type="unsigned long" dir="in">
3453	<desc>Total amount of free memory available in the hypervisor.</desc>
3454	</param>
3455	<param name="memBalloonTotal" type="unsigned long" dir="in">
3456	<desc>Total amount of memory ballooned by the hypervisor.</desc>
3457	</param>
3458	<param name="memSharedTotal" type="unsigned long" dir="in">
3459	<desc>Total amount of shared memory in the hypervisor.</desc>
3460	</param>
3461	</method>
3462	</interface>
3463
3464	<interface
3465	name="IBIOSSettings" extends="$unknown"
3466	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3467	wsmap="managed"
3468	>
3469	<desc>
3470	The IBIOSSettings interface represents BIOS settings of the virtual
3471	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3472	</desc>
3473	<attribute name="logoFadeIn" type="boolean">
3474	<desc>Fade in flag for BIOS logo animation.</desc>
3475	</attribute>
3476
3477	<attribute name="logoFadeOut" type="boolean">
3478	<desc>Fade out flag for BIOS logo animation.</desc>
3479	</attribute>
3480
3481	<attribute name="logoDisplayTime" type="unsigned long">
3482	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3483	</attribute>
3484
3485	<attribute name="logoImagePath" type="wstring">
3486	<desc>
3487	Local file system path for external BIOS splash image. Empty string
3488	means the default image is shown on boot.
3489	</desc>
3490	</attribute>
3491
3492	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3493	<desc>Mode of the BIOS boot device menu.</desc>
3494	</attribute>
3495
3496	<attribute name="ACPIEnabled" type="boolean">
3497	<desc>ACPI support flag.</desc>
3498	</attribute>
3499
3500	<attribute name="IOAPICEnabled" type="boolean">
3501	<desc>
3502	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3503	and support IRQs above 15.
3504	</desc>
3505	</attribute>
3506
3507	<attribute name="timeOffset" type="long long">
3508	<desc>
3509	Offset in milliseconds from the host system time. This allows for
3510	guests running with a different system date/time than the host.
3511	It is equivalent to setting the system date/time in the BIOS except
3512	it is not an absolute value but a relative one. Guest Additions
3513	time synchronization honors this offset.
3514	</desc>
3515	</attribute>
3516
3517	<attribute name="PXEDebugEnabled" type="boolean">
3518	<desc>
3519	PXE debug logging flag. If set, VirtualBox will write extensive
3520	PXE trace information to the release log.
3521	</desc>
3522	</attribute>
3523	</interface>
3524
3525	<enum
3526	name="CleanupMode"
3527	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3528	>
3529	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3530	</desc>
3531	<const name="UnregisterOnly" value="1">
3532	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3533	</const>
3534	<const name="DetachAllReturnNone" value="2">
3535	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3536	</const>
3537	<const name="DetachAllReturnHardDisksOnly" value="3">
3538	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3539	</const>
3540	<const name="Full" value="4">
3541	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3542	</const>
3543	</enum>
3544
3545	<interface
3546	name="IPciAddress" extends="$unknown"
3547	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3548	wsmap="struct"
3549	>
3550
3551	<desc>
3552	Address on the PCI bus.
3553	</desc>
3554
3555	<attribute name="bus" type="short">
3556	<desc>
3557	Bus number.
3558	</desc>
3559	</attribute>
3560
3561	<attribute name="device" type="short">
3562	<desc>
3563	Device number.
3564	</desc>
3565	</attribute>
3566
3567	<attribute name="devFunction" type="short">
3568	<desc>
3569	Device function number.
3570	</desc>
3571	</attribute>
3572
3573	<method name="asLong">
3574	<desc>
3575	Convert PCI address into long.
3576	</desc>
3577	<param name="result" type="long" dir="return" />
3578	</method>
3579
3580	<method name="fromLong">
3581	<desc>
3582	Make PCI address from long.
3583	</desc>
3584	<param name="number" type="long" dir="in" />
3585	</method>
3586	</interface>
3587
3588	<interface
3589	name="IPciDeviceAttachment" extends="$unknown"
3590	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3591	wsmap="struct"
3592	>
3593
3594	<desc>
3595	Information about PCI attachments.
3596	</desc>
3597
3598	<attribute name="name" type="wstring" readonly="yes">
3599	<desc>
3600	Device name.
3601	</desc>
3602	</attribute>
3603
3604	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3605	<desc>
3606	If this is physical or virtual device.
3607	</desc>
3608	</attribute>
3609
3610	<attribute name="hostAddress" type="long" readonly="yes">
3611	<desc>
3612	Address of device on the host, applicable only to host devices.
3613	</desc>
3614	</attribute>
3615
3616	<attribute name="guestAddress" type="long" readonly="yes">
3617	<desc>
3618	Address of device on the guest.
3619	</desc>
3620	</attribute>
3621
3622	</interface>
3623
3624	<enum
3625	name="CloneMode" extends="$unknown"
3626	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3627	>
3628
3629	<desc>
3630	Clone mode, used with <link to="IMachine::cloneTo" />.
3631	</desc>
3632
3633	<const name="MachineState" value="1">
3634	<desc>Clone the state of the selected machine.</desc>
3635	</const>
3636	<const name="MachineAndChildStates" value="2">
3637	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3638	</const>
3639	<const name="AllStates" value="3">
3640	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3641	</const>
3642
3643	</enum>
3644
3645	<enum
3646	name="CloneOptions" extends="$unknown"
3647	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3648	>
3649
3650	<desc>
3651	Clone options, used with <link to="IMachine::cloneTo" />.
3652	</desc>
3653
3654	<const name="Link" value="1">
3655	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3656	</const>
3657	<const name="KeepAllMACs" value="2">
3658	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3659	</const>
3660	<const name="KeepNATMACs" value="3">
3661	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3662	</const>
3663	<const name="KeepDiskNames" value="4">
3664	<desc>Don't change the disk names.</desc>
3665	</const>
3666
3667	</enum>
3668
3669	<enum
3670	name="AutostopType" extends="$unknown"
3671	uuid="6bb96740-cf34-470d-aab2-2cd48ea2e10e"
3672	>
3673
3674	<desc>
3675	Autostop types, used with <link to="IMachine::autostopType" />.
3676	</desc>
3677
3678	<const name="Disabled" value="1">
3679	<desc>Stopping the VM during system shutdown is disabled.</desc>
3680	</const>
3681	<const name="SaveState" value="2">
3682	<desc>The state of the VM will be saved when the system shuts down.</desc>
3683	</const>
3684	<const name="PowerOff" value="3">
3685	<desc>The VM is powered off when the system shuts down.</desc>
3686	</const>
3687	<const name="AcpiShutdown" value="4">
3688	<desc>An ACPI shutdown event is generated.</desc>
3689	</const>
3690
3691	</enum>
3692
3693
3694	<interface
3695	name="IMachine" extends="$unknown"
3696	uuid="d6406544-910e-43b2-a8fb-5528e56ce3b4"
3697	wsmap="managed"
3698	>
3699	<desc>
3700	The IMachine interface represents a virtual machine, or guest, created
3701	in VirtualBox.
3702
3703	This interface is used in two contexts. First of all, a collection of
3704	objects implementing this interface is stored in the
3705	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3706	machines that are currently registered with this VirtualBox
3707	installation. Also, once a session has been opened for the given virtual
3708	machine (e.g. the virtual machine is running), the machine object
3709	associated with the open session can be queried from the session object;
3710	see <link to="ISession"/> for details.
3711
3712	The main role of this interface is to expose the settings of the virtual
3713	machine and provide methods to change various aspects of the virtual
3714	machine's configuration. For machine objects stored in the
3715	<link to="IVirtualBox::machines"/> collection, all attributes are
3716	read-only unless explicitly stated otherwise in individual attribute
3717	and method descriptions.
3718
3719	In order to change a machine setting, a session for this machine must be
3720	opened using one of the <link to="IMachine::lockMachine" /> or
3721	<link to="IMachine::launchVMProcess"/> methods. After the
3722	machine has been successfully locked for a session, a mutable machine object
3723	needs to be queried from the session object and then the desired settings
3724	changes can be applied to the returned object using IMachine attributes and
3725	methods. See the <link to="ISession"/> interface description for more
3726	information about sessions.
3727
3728	Note that IMachine does not provide methods to control virtual machine
3729	execution (such as start the machine, or power it down) -- these methods
3730	are grouped in a separate interface called <link to="IConsole" />.
3731
3732	<see><link to="ISession"/>, <link to="IConsole"/></see>
3733	</desc>
3734
3735	<attribute name="parent" type="IVirtualBox" readonly="yes">
3736	<desc>Associated parent object.</desc>
3737	</attribute>
3738
3739	<attribute name="accessible" type="boolean" readonly="yes">
3740	<desc>
3741	Whether this virtual machine is currently accessible or not.
3742
3743	A machine is always deemed accessible unless it is registered <i>and</i>
3744	its settings file cannot be read or parsed (either because the file itself
3745	is unavailable or has invalid XML contents).
3746
3747	Every time this property is read, the accessibility state of
3748	this machine is re-evaluated. If the returned value is @c false,
3749	the <link to="#accessError"/> property may be used to get the
3750	detailed error information describing the reason of
3751	inaccessibility, including XML error messages.
3752
3753	When the machine is inaccessible, only the following properties
3754	can be used on it:
3755	<ul>
3756	<li><link to="#parent"/></li>
3757	<li><link to="#id"/></li>
3758	<li><link to="#settingsFilePath"/></li>
3759	<li><link to="#accessible"/></li>
3760	<li><link to="#accessError"/></li>
3761	</ul>
3762
3763	An attempt to access any other property or method will return
3764	an error.
3765
3766	The only possible action you can perform on an inaccessible
3767	machine is to unregister it using the
3768	<link to="IMachine::unregister"/> call (or, to check
3769	for the accessibility state once more by querying this
3770	property).
3771
3772	<note>
3773	In the current implementation, once this property returns
3774	@c true, the machine will never become inaccessible
3775	later, even if its settings file cannot be successfully
3776	read/written any more (at least, until the VirtualBox
3777	server is restarted). This limitation may be removed in
3778	future releases.
3779	</note>
3780	</desc>
3781	</attribute>
3782
3783	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3784	<desc>
3785	Error information describing the reason of machine
3786	inaccessibility.
3787
3788	Reading this property is only valid after the last call to
3789	<link to="#accessible"/> returned @c false (i.e. the
3790	machine is currently inaccessible). Otherwise, a @c null
3791	IVirtualBoxErrorInfo object will be returned.
3792	</desc>
3793	</attribute>
3794
3795	<attribute name="name" type="wstring">
3796	<desc>
3797	Name of the virtual machine.
3798
3799	Besides being used for human-readable identification purposes
3800	everywhere in VirtualBox, the virtual machine name is also used
3801	as a name of the machine's settings file and as a name of the
3802	subdirectory this settings file resides in. Thus, every time you
3803	change the value of this property, the settings file will be
3804	renamed once you call <link to="#saveSettings"/> to confirm the
3805	change. The containing subdirectory will be also renamed, but
3806	only if it has exactly the same name as the settings file
3807	itself prior to changing this property (for backward compatibility
3808	with previous API releases). The above implies the following
3809	limitations:
3810	<ul>
3811	<li>The machine name cannot be empty.</li>
3812	<li>The machine name can contain only characters that are valid
3813	file name characters according to the rules of the file
3814	system used to store VirtualBox configuration.</li>
3815	<li>You cannot have two or more machines with the same name
3816	if they use the same subdirectory for storing the machine
3817	settings files.</li>
3818	<li>You cannot change the name of the machine if it is running,
3819	or if any file in the directory containing the settings file
3820	is being used by another running machine or by any other
3821	process in the host operating system at a time when
3822	<link to="#saveSettings"/> is called.
3823	</li>
3824	</ul>
3825	If any of the above limitations are hit, <link to="#saveSettings"/>
3826	will return an appropriate error message explaining the exact
3827	reason and the changes you made to this machine will not be saved.
3828
3829	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
3830	file is recommended, but not enforced. (Previous versions always
3831	used a generic ".xml" extension.)
3832	</desc>
3833	</attribute>
3834
3835	<attribute name="description" type="wstring">
3836	<desc>
3837	Description of the virtual machine.
3838
3839	The description attribute can contain any text and is
3840	typically used to describe the hardware and software
3841	configuration of the virtual machine in detail (i.e. network
3842	settings, versions of the installed software and so on).
3843	</desc>
3844	</attribute>
3845
3846	<attribute name="id" type="uuid" mod="string" readonly="yes">
3847	<desc>UUID of the virtual machine.</desc>
3848	</attribute>
3849
3850	<attribute name="OSTypeId" type="wstring">
3851	<desc>
3852	User-defined identifier of the Guest OS type.
3853	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3854	an IGuestOSType object representing details about the given
3855	Guest OS type.
3856	<note>
3857	This value may differ from the value returned by
3858	<link to="IGuest::OSTypeId"/> if Guest Additions are
3859	installed to the guest OS.
3860	</note>
3861	</desc>
3862	</attribute>
3863
3864	<attribute name="hardwareVersion" type="wstring">
3865	<desc>Hardware version identifier. Internal use only for now.</desc>
3866	</attribute>
3867
3868	<attribute name="hardwareUUID" type="uuid" mod="string">
3869	<desc>
3870	The UUID presented to the guest via memory tables, hardware and guest
3871	properties. For most VMs this is the same as the @a id, but for VMs
3872	which have been cloned or teleported it may be the same as the source
3873	VM. This latter is because the guest shouldn't notice that it was
3874	cloned or teleported.
3875	</desc>
3876	</attribute>
3877
3878	<attribute name="CPUCount" type="unsigned long">
3879	<desc>Number of virtual CPUs in the VM.</desc>
3880	</attribute>
3881
3882	<attribute name="CPUHotPlugEnabled" type="boolean">
3883	<desc>
3884	This setting determines whether VirtualBox allows CPU
3885	hotplugging for this machine.</desc>
3886	</attribute>
3887
3888	<attribute name="CPUExecutionCap" type="unsigned long">
3889	<desc>
3890	Means to limit the number of CPU cycles a guest can use. The unit
3891	is percentage of host CPU cycles per second. The valid range
3892	is 1 - 100. 100 (the default) implies no limit.
3893	</desc>
3894	</attribute>
3895
3896	<attribute name="memorySize" type="unsigned long">
3897	<desc>System memory size in megabytes.</desc>
3898	</attribute>
3899
3900	<attribute name="memoryBalloonSize" type="unsigned long">
3901	<desc>Memory balloon size in megabytes.</desc>
3902	</attribute>
3903
3904	<attribute name="pageFusionEnabled" type="boolean">
3905	<desc>
3906	This setting determines whether VirtualBox allows page
3907	fusion for this machine (64 bits host only).
3908	</desc>
3909	</attribute>
3910
3911	<attribute name="VRAMSize" type="unsigned long">
3912	<desc>Video memory size in megabytes.</desc>
3913	</attribute>
3914
3915	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3916	<desc>
3917	This setting determines whether VirtualBox allows this machine to make
3918	use of the 3D graphics support available on the host.</desc>
3919	</attribute>
3920
3921	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3922	<desc>
3923	This setting determines whether VirtualBox allows this machine to make
3924	use of the 2D video acceleration support available on the host.</desc>
3925	</attribute>
3926
3927	<attribute name="monitorCount" type="unsigned long">
3928	<desc>
3929	Number of virtual monitors.
3930	<note>
3931	Only effective on Windows XP and later guests with
3932	Guest Additions installed.
3933	</note>
3934	</desc>
3935	</attribute>
3936
3937	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3938	<desc>Object containing all BIOS settings.</desc>
3939	</attribute>
3940
3941	<attribute name="firmwareType" type="FirmwareType">
3942	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3943	bootstrap in this VM.</desc>
3944	</attribute>
3945
3946	<attribute name="pointingHidType" type="PointingHidType">
3947	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3948	The default is typically "PS2Mouse" but can vary depending on the
3949	requirements of the guest operating system.</desc>
3950	</attribute>
3951
3952	<attribute name="keyboardHidType" type="KeyboardHidType">
3953	<desc>Type of keyboard HID used in this VM.
3954	The default is typically "PS2Keyboard" but can vary depending on the
3955	requirements of the guest operating system.</desc>
3956	</attribute>
3957
3958	<attribute name="hpetEnabled" type="boolean">
3959	<desc>This attribute controls if High Precision Event Timer (HPET) is
3960	enabled in this VM. Use this property if you want to provide guests
3961	with additional time source, or if guest requires HPET to function correctly.
3962	Default is false.</desc>
3963	</attribute>
3964
3965	<attribute name="chipsetType" type="ChipsetType">
3966	<desc>Chipset type used in this VM.</desc>
3967	</attribute>
3968
3969	<attribute name="snapshotFolder" type="wstring">
3970	<desc>
3971	Full path to the directory used to store snapshot data
3972	(differencing media and saved state files) of this machine.
3973
3974	The initial value of this property is
3975	<tt><</tt><link to="#settingsFilePath">
3976	path_to_settings_file</link><tt>>/<</tt>
3977	<link to="#id">machine_uuid</link>
3978	<tt>></tt>.
3979
3980	Currently, it is an error to try to change this property on
3981	a machine that has snapshots (because this would require to
3982	move possibly large files to a different location).
3983	A separate method will be available for this purpose later.
3984
3985	<note>
3986	Setting this property to @c null or to an empty string will restore
3987	the initial value.
3988	</note>
3989	<note>
3990	When setting this property, the specified path can be
3991	absolute (full path) or relative to the directory where the
3992	<link to="#settingsFilePath">machine settings file</link>
3993	is located. When reading this property, a full path is
3994	always returned.
3995	</note>
3996	<note>
3997	The specified path may not exist, it will be created
3998	when necessary.
3999	</note>
4000	</desc>
4001	</attribute>
4002
4003	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
4004	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
4005	</attribute>
4006
4007	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
4008	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
4009
4010	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4011	<desc>Array of media attached to this machine.</desc>
4012	</attribute>
4013
4014	<attribute name="USBController" type="IUSBController" readonly="yes">
4015	<desc>
4016	Associated USB controller object.
4017
4018	<note>
4019	If USB functionality is not available in the given edition of
4020	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4021	</note>
4022	</desc>
4023	</attribute>
4024
4025	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4026	<desc>Associated audio adapter, always present.</desc>
4027	</attribute>
4028
4029	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4030	<desc>Array of storage controllers attached to this machine.</desc>
4031	</attribute>
4032
4033	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4034	<desc>
4035	Full name of the file containing machine settings data.
4036	</desc>
4037	</attribute>
4038
4039	<attribute name="settingsModified" type="boolean" readonly="yes">
4040	<desc>
4041	Whether the settings of this machine have been modified
4042	(but neither yet saved nor discarded).
4043	<note>
4044	Reading this property is only valid on instances returned
4045	by <link to="ISession::machine"/> and on new machines
4046	created by <link to="IVirtualBox::createMachine"/> or opened
4047	by <link to="IVirtualBox::openMachine"/> but not
4048	yet registered, or on unregistered machines after calling
4049	<link to="IMachine::unregister"/>. For all other
4050	cases, the settings can never be modified.
4051	</note>
4052	<note>
4053	For newly created unregistered machines, the value of this
4054	property is always @c true until <link to="#saveSettings"/>
4055	is called (no matter if any machine settings have been
4056	changed after the creation or not). For opened machines
4057	the value is set to @c false (and then follows to normal rules).
4058	</note>
4059	</desc>
4060	</attribute>
4061
4062	<attribute name="sessionState" type="SessionState" readonly="yes">
4063	<desc>Current session state for this machine.</desc>
4064	</attribute>
4065
4066	<attribute name="sessionType" type="wstring" readonly="yes">
4067	<desc>
4068	Type of the session. If <link to="#sessionState"/> is
4069	Spawning or Locked, this attribute contains the
4070	same value as passed to the
4071	<link to="IMachine::launchVMProcess"/> method in the
4072	@a type parameter. If the session was used with
4073	<link to="IMachine::lockMachine" />, or if
4074	<link to="#sessionState"/> is SessionClosed, the value of this
4075	attribute is an empty string.
4076	</desc>
4077	</attribute>
4078
4079	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4080	<desc>
4081	Identifier of the session process. This attribute contains the
4082	platform-dependent identifier of the process whose session was
4083	used with <link to="IMachine::lockMachine" /> call. The returned
4084	value is only valid if <link to="#sessionState"/> is Locked or
4085	Unlocking by the time this property is read.
4086	</desc>
4087	</attribute>
4088
4089	<attribute name="state" type="MachineState" readonly="yes">
4090	<desc>Current execution state of this machine.</desc>
4091	</attribute>
4092
4093	<attribute name="lastStateChange" type="long long" readonly="yes">
4094	<desc>
4095	Time stamp of the last execution state change,
4096	in milliseconds since 1970-01-01 UTC.
4097	</desc>
4098	</attribute>
4099
4100	<attribute name="stateFilePath" type="wstring" readonly="yes">
4101	<desc>
4102	Full path to the file that stores the execution state of
4103	the machine when it is in the <link to="MachineState_Saved"/> state.
4104	<note>
4105	When the machine is not in the Saved state, this attribute is
4106	an empty string.
4107	</note>
4108	</desc>
4109	</attribute>
4110
4111	<attribute name="logFolder" type="wstring" readonly="yes">
4112	<desc>
4113	Full path to the folder that stores a set of rotated log files
4114	recorded during machine execution. The most recent log file is
4115	named <tt>VBox.log</tt>, the previous log file is
4116	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4117	in the current version).
4118	</desc>
4119	</attribute>
4120
4121	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4122	<desc>
4123	Current snapshot of this machine. This is @c null if the machine
4124	currently has no snapshots. If it is not @c null, then it was
4125	set by one of <link to="IConsole::takeSnapshot" />,
4126	<link to="IConsole::deleteSnapshot" />
4127	or <link to="IConsole::restoreSnapshot" />, depending on which
4128	was called last. See <link to="ISnapshot"/> for details.
4129	</desc>
4130	</attribute>
4131
4132	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4133	<desc>
4134	Number of snapshots taken on this machine. Zero means the
4135	machine doesn't have any snapshots.
4136	</desc>
4137	</attribute>
4138
4139	<attribute name="currentStateModified" type="boolean" readonly="yes">
4140	<desc>
4141	Returns @c true if the current state of the machine is not
4142	identical to the state stored in the current snapshot.
4143
4144	The current state is identical to the current snapshot only
4145	directly after one of the following calls are made:
4146
4147	<ul>
4148	<li><link to="IConsole::restoreSnapshot"/>
4149	</li>
4150	<li><link to="IConsole::takeSnapshot"/> (issued on a
4151	"powered off" or "saved" machine, for which
4152	<link to="#settingsModified"/> returns @c false)
4153	</li>
4154	</ul>
4155
4156	The current state remains identical until one of the following
4157	happens:
4158	<ul>
4159	<li>settings of the machine are changed</li>
4160	<li>the saved state is deleted</li>
4161	<li>the current snapshot is deleted</li>
4162	<li>an attempt to execute the machine is made</li>
4163	</ul>
4164
4165	<note>
4166	For machines that don't have snapshots, this property is
4167	always @c false.
4168	</note>
4169	</desc>
4170	</attribute>
4171
4172	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4173	<desc>
4174	Collection of shared folders for this machine (permanent shared
4175	folders). These folders are shared automatically at machine startup
4176	and available only to the guest OS installed within this machine.
4177
4178	New shared folders are added to the collection using
4179	<link to="#createSharedFolder"/>. Existing shared folders can be
4180	removed using <link to="#removeSharedFolder"/>.
4181	</desc>
4182	</attribute>
4183
4184	<attribute name="clipboardMode" type="ClipboardMode">
4185	<desc>
4186	Synchronization mode between the host OS clipboard
4187	and the guest OS clipboard.
4188	</desc>
4189	</attribute>
4190
4191	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4192	<desc>
4193	A comma-separated list of simple glob patterns. Changes to guest
4194	properties whose name matches one of the patterns will generate an
4195	<link to="IGuestPropertyChangedEvent"/> signal.
4196	</desc>
4197	</attribute>
4198
4199	<attribute name="teleporterEnabled" type="boolean">
4200	<desc>
4201	When set to @a true, the virtual machine becomes a target teleporter
4202	the next time it is powered on. This can only set to @a true when the
4203	VM is in the @a PoweredOff or @a Aborted state.
4204
4205	<!-- This property is automatically set to @a false when the VM is powered
4206	on. (bird: This doesn't work yet ) -->
4207	</desc>
4208	</attribute>
4209
4210	<attribute name="teleporterPort" type="unsigned long">
4211	<desc>
4212	The TCP port the target teleporter will listen for incoming
4213	teleportations on.
4214
4215	0 means the port is automatically selected upon power on. The actual
4216	value can be read from this property while the machine is waiting for
4217	incoming teleportations.
4218	</desc>
4219	</attribute>
4220
4221	<attribute name="teleporterAddress" type="wstring">
4222	<desc>
4223	The address the target teleporter will listen on. If set to an empty
4224	string, it will listen on all addresses.
4225	</desc>
4226	</attribute>
4227
4228	<attribute name="teleporterPassword" type="wstring">
4229	<desc>
4230	The password to check for on the target teleporter. This is just a
4231	very basic measure to prevent simple hacks and operators accidentally
4232	beaming a virtual machine to the wrong place.
4233
4234	Note that you SET a plain text password while reading back a HASHED
4235	password. Setting a hashed password is currently not supported.
4236	</desc>
4237	</attribute>
4238
4239	<attribute name="faultToleranceState" type="FaultToleranceState">
4240	<desc>
4241	Fault tolerance state; disabled, source or target.
4242	This property can be changed at any time. If you change it for a running
4243	VM, then the fault tolerance address and port must be set beforehand.
4244	</desc>
4245	</attribute>
4246
4247	<attribute name="faultTolerancePort" type="unsigned long">
4248	<desc>
4249	The TCP port the fault tolerance source or target will use for
4250	communication.
4251	</desc>
4252	</attribute>
4253
4254	<attribute name="faultToleranceAddress" type="wstring">
4255	<desc>
4256	The address the fault tolerance source or target.
4257	</desc>
4258	</attribute>
4259
4260	<attribute name="faultTolerancePassword" type="wstring">
4261	<desc>
4262	The password to check for on the standby VM. This is just a
4263	very basic measure to prevent simple hacks and operators accidentally
4264	choosing the wrong standby VM.
4265	</desc>
4266	</attribute>
4267
4268	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4269	<desc>
4270	The interval in ms used for syncing the state between source and target.
4271	</desc>
4272	</attribute>
4273
4274	<attribute name="RTCUseUTC" type="boolean">
4275	<desc>
4276	When set to @a true, the RTC device of the virtual machine will run
4277	in UTC time, otherwise in local time. Especially Unix guests prefer
4278	the time in UTC.
4279	</desc>
4280	</attribute>
4281
4282	<attribute name="ioCacheEnabled" type="boolean">
4283	<desc>
4284	When set to @a true, the builtin I/O cache of the virtual machine
4285	will be enabled.
4286	</desc>
4287	</attribute>
4288
4289	<attribute name="ioCacheSize" type="unsigned long">
4290	<desc>
4291	Maximum size of the I/O cache in MB.
4292	</desc>
4293	</attribute>
4294
4295	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4296	<desc>Array of PCI devices assigned to this machine, to get list of all
4297	PCI devices attached to the machine use
4298	<link to="IConsole::attachedPciDevices"/> attribute, as this attribute
4299	is intended to list only devices additional to what described in
4300	virtual hardware config. Usually, this list keeps host's physical
4301	devices assigned to the particular machine.
4302	</desc>
4303	</attribute>
4304
4305	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4306	<desc>
4307	Bandwidth control manager.
4308	</desc>
4309	</attribute>
4310
4311	<attribute name="tracingEnabled" type="boolean">
4312	<desc>
4313	Enables the tracing facility in the VMM (including PDM devices +
4314	drivers). The VMM will consume about 0.5MB of more memory when
4315	enabled and there may be some extra overhead from tracepoints that are
4316	always enabled.
4317	</desc>
4318	</attribute>
4319
4320	<attribute name="tracingConfig" type="wstring">
4321	<desc>
4322	Tracepoint configuration to apply at startup when
4323	<link to="IMachine::tracingEnabled" /> is true. The string specifies
4324	a space separated of tracepoint group names to enable. The special
4325	group 'all' enables all tracepoints. Check DBGFR3TracingConfig for
4326	more details on available tracepoint groups and such.
4327
4328	Note that on hosts supporting DTrace (or similar), a lot of the
4329	tracepoints may be implemented exclusivly as DTrace probes. So, the
4330	effect of the same config may differ between Solaris and Windows for
4331	example.
4332	</desc>
4333	</attribute>
4334
4335	<attribute name="allowTracingToAccessVM" type="boolean">
4336	<desc>
4337	Enables tracepoints in PDM devices and drivers to use the VMCPU or VM
4338	structures when firing off trace points. This is especially useful
4339	with DTrace tracepoints, as it allow you to use the VMCPU or VM pointer
4340	to obtail useful information such as guest register state.
4341
4342	This is disabled by default because devices and drivers normally has no
4343	business accessing the VMCPU or VM structures, and are therefore unable
4344	to get any pointers to these.
4345	</desc>
4346	</attribute>
4347
4348	<attribute name="autostartEnabled" type="boolean">
4349	<desc>
4350	Enables autostart of the VM during system boot.
4351	</desc>
4352	</attribute>
4353
4354	<attribute name="autostartDelay" type="unsigned long">
4355	<desc>
4356	Number of seconds to wait until the VM should be started during system boot.
4357	</desc>
4358	</attribute>
4359
4360	<attribute name="autostopType" type="AutostopType">
4361	<desc>
4362	Action type to do when the system is shutting down.
4363	</desc>
4364	</attribute>
4365
4366	<method name="lockMachine">
4367	<desc>
4368	Locks the machine for the given session to enable the caller
4369	to make changes to the machine or start the VM or control
4370	VM execution.
4371
4372	There are two ways to lock a machine for such uses:
4373
4374	<ul>
4375	<li>If you want to make changes to the machine settings,
4376	you must obtain an exclusive write lock on the machine
4377	by setting @a lockType to @c Write.
4378
4379	This will only succeed if no other process has locked
4380	the machine to prevent conflicting changes. Only after
4381	an exclusive write lock has been obtained using this method, one
4382	can change all VM settings or execute the VM in the process
4383	space of the session object. (Note that the latter is only of
4384	interest if you actually want to write a new front-end for
4385	virtual machines; but this API gets called internally by
4386	the existing front-ends such as VBoxHeadless and the VirtualBox
4387	GUI to acquire a write lock on the machine that they are running.)
4388
4389	On success, write-locking the machine for a session creates
4390	a second copy of the IMachine object. It is this second object
4391	upon which changes can be made; in VirtualBox terminology, the
4392	second copy is "mutable". It is only this second, mutable machine
4393	object upon which you can call methods that change the
4394	machine state. After having called this method, you can
4395	obtain this second, mutable machine object using the
4396	<link to="ISession::machine" /> attribute.
4397	</li>
4398	<li>If you only want to check the machine state or control
4399	machine execution without actually changing machine
4400	settings (e.g. to get access to VM statistics or take
4401	a snapshot or save the machine state), then set the
4402	@a lockType argument to @c Shared.
4403
4404	If no other session has obtained a lock, you will obtain an
4405	exclusive write lock as described above. However, if another
4406	session has already obtained such a lock, then a link to that
4407	existing session will be established which allows you
4408	to control that existing session.
4409
4410	To find out which type of lock was obtained, you can
4411	inspect <link to="ISession::type" />, which will have been
4412	set to either @c WriteLock or @c Shared.
4413	</li>
4414	</ul>
4415
4416	In either case, you can get access to the <link to="IConsole" />
4417	object which controls VM execution.
4418
4419	Also in all of the above cases, one must always call
4420	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4421	the machine's state will eventually be set to "Aborted".
4422
4423	To change settings on a machine, the following sequence is typically
4424	performed:
4425
4426	<ol>
4427	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4428
4429	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4430
4431	<li>Change the settings of the machine by invoking IMachine methods.</li>
4432
4433	<li>Call <link to="IMachine::saveSettings" />.</li>
4434
4435	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4436	</ol>
4437
4438	<result name="E_UNEXPECTED">
4439	Virtual machine not registered.
4440	</result>
4441	<result name="E_ACCESSDENIED">
4442	Process not started by OpenRemoteSession.
4443	</result>
4444	<result name="VBOX_E_INVALID_OBJECT_STATE">
4445	Session already open or being opened.
4446	</result>
4447	<result name="VBOX_E_VM_ERROR">
4448	Failed to assign machine to session.
4449	</result>
4450	</desc>
4451	<param name="session" type="ISession" dir="in">
4452	<desc>
4453	Session object for which the machine will be locked.
4454	</desc>
4455	</param>
4456	<param name="lockType" type="LockType" dir="in">
4457	<desc>
4458	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4459	If set to @c Shared, then either acquire an exclusive write lock or establish
4460	a link to an existing session.
4461	</desc>
4462	</param>
4463	</method>
4464
4465	<method name="launchVMProcess">
4466	<desc>
4467	Spawns a new process that will execute the virtual machine and obtains a shared
4468	lock on the machine for the calling session.
4469
4470	If launching the VM succeeds, the new VM process will create its own session
4471	and write-lock the machine for it, preventing conflicting changes from other
4472	processes. If the machine is already locked (because it is already running or
4473	because another session has a write lock), launching the VM process will therefore
4474	fail. Reversely, future attempts to obtain a write lock will also fail while the
4475	machine is running.
4476
4477	The caller's session object remains separate from the session opened by the new
4478	VM process. It receives its own <link to="IConsole" /> object which can be used
4479	to control machine execution, but it cannot be used to change all VM settings
4480	which would be available after a <link to="#lockMachine" /> call.
4481
4482	The caller must eventually release the session's shared lock by calling
4483	<link to="ISession::unlockMachine" /> on the local session object once this call
4484	has returned. However, the session's state (see <link to="ISession::state" />)
4485	will not return to "Unlocked" until the remote session has also unlocked
4486	the machine (i.e. the machine has stopped running).
4487
4488	Launching a VM process can take some time (a new VM is started in a new process,
4489	for which memory and other resources need to be set up). Because of this,
4490	an <link to="IProgress" /> object is returned to allow the caller to wait
4491	for this asynchronous operation to be completed. Until then, the caller's
4492	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4493	and <link to="ISession::console" /> attributes cannot be accessed.
4494	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4495	similar calls to wait for completion. Completion is signalled when the VM
4496	is powered on. If launching the VM fails, error messages can be queried
4497	via the progress object, if available.
4498
4499	The progress object will have at least 2 sub-operations. The first
4500	operation covers the period up to the new VM process calls powerUp.
4501	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4502	progress object. Because <link to="IConsole::powerUp"/> may require
4503	some extra sub-operations, the <link to="IProgress::operationCount"/>
4504	may change at the completion of operation.
4505
4506	For details on the teleportation progress operation, see
4507	<link to="IConsole::powerUp"/>.
4508
4509	The @a environment argument is a string containing definitions of
4510	environment variables in the following format:
4511	<pre>
4512	NAME[=VALUE]\n
4513	NAME[=VALUE]\n
4514	...
4515	</pre>
4516	where <tt>\\n</tt> is the new line character. These environment
4517	variables will be appended to the environment of the VirtualBox server
4518	process. If an environment variable exists both in the server process
4519	and in this list, the value from this list takes precedence over the
4520	server's variable. If the value of the environment variable is
4521	omitted, this variable will be removed from the resulting environment.
4522	If the environment string is @c null or empty, the server environment
4523	is inherited by the started process as is.
4524
4525	<result name="E_UNEXPECTED">
4526	Virtual machine not registered.
4527	</result>
4528	<result name="E_INVALIDARG">
4529	Invalid session type @a type.
4530	</result>
4531	<result name="VBOX_E_OBJECT_NOT_FOUND">
4532	No machine matching @a machineId found.
4533	</result>
4534	<result name="VBOX_E_INVALID_OBJECT_STATE">
4535	Session already open or being opened.
4536	</result>
4537	<result name="VBOX_E_IPRT_ERROR">
4538	Launching process for machine failed.
4539	</result>
4540	<result name="VBOX_E_VM_ERROR">
4541	Failed to assign machine to session.
4542	</result>
4543	</desc>
4544	<param name="session" type="ISession" dir="in">
4545	<desc>
4546	Client session object to which the VM process will be connected (this
4547	must be in "Unlocked" state).
4548	</desc>
4549	</param>
4550	<param name="type" type="wstring" dir="in">
4551	<desc>
4552	Front-end to use for the new VM process. The following are currently supported:
4553	<ul>
4554	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4555	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4556	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4557	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4558	the currently running VM or session owner. In this case the
4559	@a session parameter may be @c NULL (if it is non-null it isn't
4560	used in any way), and the @a progress return value will be always
4561	NULL. The operation completes immediately.</li>
4562	</ul>
4563	</desc>
4564	</param>
4565	<param name="environment" type="wstring" dir="in">
4566	<desc>
4567	Environment to pass to the VM process.
4568	</desc>
4569	</param>
4570	<param name="progress" type="IProgress" dir="return">
4571	<desc>Progress object to track the operation completion.</desc>
4572	</param>
4573	</method>
4574
4575	<method name="setBootOrder">
4576	<desc>
4577	Puts the given device to the specified position in
4578	the boot order.
4579
4580	To indicate that no device is associated with the given position,
4581	<link to="DeviceType_Null"/> should be used.
4582
4583	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4584
4585	<result name="E_INVALIDARG">
4586	Boot @a position out of range.
4587	</result>
4588	<result name="E_NOTIMPL">
4589	Booting from USB @a device currently not supported.
4590	</result>
4591
4592	</desc>
4593	<param name="position" type="unsigned long" dir="in">
4594	<desc>
4595	Position in the boot order (@c 1 to the total number of
4596	devices the machine can boot from, as returned by
4597	<link to="ISystemProperties::maxBootPosition"/>).
4598	</desc>
4599	</param>
4600	<param name="device" type="DeviceType" dir="in">
4601	<desc>
4602	The type of the device used to boot at the given position.
4603	</desc>
4604	</param>
4605	</method>
4606
4607	<method name="getBootOrder" const="yes">
4608	<desc>
4609	Returns the device type that occupies the specified
4610	position in the boot order.
4611
4612	@todo [remove?]
4613	If the machine can have more than one device of the returned type
4614	(such as hard disks), then a separate method should be used to
4615	retrieve the individual device that occupies the given position.
4616
4617	If here are no devices at the given position, then
4618	<link to="DeviceType_Null"/> is returned.
4619
4620	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4621
4622	<result name="E_INVALIDARG">
4623	Boot @a position out of range.
4624	</result>
4625
4626	</desc>
4627	<param name="position" type="unsigned long" dir="in">
4628	<desc>
4629	Position in the boot order (@c 1 to the total number of
4630	devices the machine can boot from, as returned by
4631	<link to="ISystemProperties::maxBootPosition"/>).
4632	</desc>
4633	</param>
4634	<param name="device" type="DeviceType" dir="return">
4635	<desc>
4636	Device at the given position.
4637	</desc>
4638	</param>
4639	</method>
4640
4641	<method name="attachDevice">
4642	<desc>
4643	Attaches a device and optionally mounts a medium to the given storage
4644	controller (<link to="IStorageController" />, identified by @a name),
4645	at the indicated port and device.
4646
4647	This method is intended for managing storage devices in general while a
4648	machine is powered off. It can be used to attach and detach fixed
4649	and removable media. The following kind of media can be attached
4650	to a machine:
4651
4652	<ul>
4653	<li>For fixed and removable media, you can pass in a medium that was
4654	previously opened using <link to="IVirtualBox::openMedium" />.
4655	</li>
4656
4657	<li>Only for storage devices supporting removable media (such as
4658	DVDs and floppies), you can also specify a null pointer to
4659	indicate an empty drive or one of the medium objects listed
4660	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4661	arrays to indicate a host drive.
4662	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4663	to change the media while the machine is running.
4664	</li>
4665	</ul>
4666
4667	In a VM's default configuration of virtual machines, the secondary
4668	master of the IDE controller is used for a CD/DVD drive.
4669
4670	After calling this returns successfully, a new instance of
4671	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4672	attachments (see <link to="IMachine::mediumAttachments"/>).
4673
4674	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4675	information about attaching media.
4676
4677	The specified device slot must not have a device attached to it,
4678	or this method will fail.
4679
4680	<note>
4681	You cannot attach a device to a newly created machine until
4682	this machine's settings are saved to disk using
4683	<link to="#saveSettings"/>.
4684	</note>
4685	<note>
4686	If the medium is being attached indirectly, a new differencing medium
4687	will implicitly be created for it and attached instead. If the
4688	changes made to the machine settings (including this indirect
4689	attachment) are later cancelled using <link to="#discardSettings"/>,
4690	this implicitly created differencing medium will implicitly
4691	be deleted.
4692	</note>
4693
4694	<result name="E_INVALIDARG">
4695	SATA device, SATA port, IDE port or IDE slot out of range, or
4696	file or UUID not found.
4697	</result>
4698	<result name="VBOX_E_INVALID_OBJECT_STATE">
4699	Machine must be registered before media can be attached.
4700	</result>
4701	<result name="VBOX_E_INVALID_VM_STATE">
4702	Invalid machine state.
4703	</result>
4704	<result name="VBOX_E_OBJECT_IN_USE">
4705	A medium is already attached to this or another virtual machine.
4706	</result>
4707
4708	</desc>
4709	<param name="name" type="wstring" dir="in">
4710	<desc>Name of the storage controller to attach the device to.</desc>
4711	</param>
4712	<param name="controllerPort" type="long" dir="in">
4713	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4714	the primary controller and 1 specifies the secondary controller.
4715	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4716	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4717	</param>
4718	<param name="device" type="long" dir="in">
4719	<desc>Device slot in the given port to attach the device to. This is only
4720	relevant for IDE controllers, for which 0 specifies the master device and
4721	1 specifies the slave device. For all other controller types, this must
4722	be 0.</desc>
4723	</param>
4724	<param name="type" type="DeviceType" dir="in">
4725	<desc>Device type of the attached device. For media opened by
4726	<link to="IVirtualBox::openMedium" />, this must match the device type
4727	specified there.</desc>
4728	</param>
4729	<param name="medium" type="IMedium" dir="in">
4730	<desc>Medium to mount or NULL for an empty drive.</desc>
4731	</param>
4732	</method>
4733
4734	<method name="detachDevice">
4735	<desc>
4736	Detaches the device attached to a device slot of the specified bus.
4737
4738	Detaching the device from the virtual machine is deferred. This means
4739	that the medium remains associated with the machine when this method
4740	returns and gets actually de-associated only after a successful
4741	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4742	for more detailed information about attaching media.
4743
4744	<note>
4745	You cannot detach a device from a running machine.
4746	</note>
4747	<note>
4748	Detaching differencing media implicitly created by <link
4749	to="#attachDevice"/> for the indirect attachment using this
4750	method will <b>not</b> implicitly delete them. The
4751	<link to="IMedium::deleteStorage"/> operation should be
4752	explicitly performed by the caller after the medium is successfully
4753	detached and the settings are saved with
4754	<link to="#saveSettings"/>, if it is the desired action.
4755	</note>
4756
4757	<result name="VBOX_E_INVALID_VM_STATE">
4758	Attempt to detach medium from a running virtual machine.
4759	</result>
4760	<result name="VBOX_E_OBJECT_NOT_FOUND">
4761	No medium attached to given slot/bus.
4762	</result>
4763	<result name="VBOX_E_NOT_SUPPORTED">
4764	Medium format does not support storage deletion.
4765	</result>
4766
4767	</desc>
4768	<param name="name" type="wstring" dir="in">
4769	<desc>Name of the storage controller to detach the medium from.</desc>
4770	</param>
4771	<param name="controllerPort" type="long" dir="in">
4772	<desc>Port number to detach the medium from.</desc>
4773	</param>
4774	<param name="device" type="long" dir="in">
4775	<desc>Device slot number to detach the medium from.</desc>
4776	</param>
4777	</method>
4778
4779	<method name="passthroughDevice">
4780	<desc>
4781	Sets the passthrough mode of an existing DVD device. Changing the
4782	setting while the VM is running is forbidden. The setting is only used
4783	if at VM start the device is configured as a host DVD drive, in all
4784	other cases it is ignored. The device must already exist; see
4785	<link to="IMachine::attachDevice"/> for how to attach a new device.
4786
4787	The @a controllerPort and @a device parameters specify the device slot and
4788	have have the same meaning as with <link to="IMachine::attachDevice" />.
4789
4790	<result name="E_INVALIDARG">
4791	SATA device, SATA port, IDE port or IDE slot out of range.
4792	</result>
4793	<result name="VBOX_E_INVALID_OBJECT_STATE">
4794	Attempt to modify an unregistered virtual machine.
4795	</result>
4796	<result name="VBOX_E_INVALID_VM_STATE">
4797	Invalid machine state.
4798	</result>
4799
4800	</desc>
4801	<param name="name" type="wstring" dir="in">
4802	<desc>Name of the storage controller.</desc>
4803	</param>
4804	<param name="controllerPort" type="long" dir="in">
4805	<desc>Storage controller port.</desc>
4806	</param>
4807	<param name="device" type="long" dir="in">
4808	<desc>Device slot in the given port.</desc>
4809	</param>
4810	<param name="passthrough" type="boolean" dir="in">
4811	<desc>New value for the passthrough setting.</desc>
4812	</param>
4813	</method>
4814
4815	<method name="temporaryEjectDevice">
4816	<desc>
4817	Sets the behavior for guest-triggered medium eject. In some situations
4818	it is desirable that such ejects update the VM configuration, and in
4819	others the eject should keep the VM configuration. The device must
4820	already exist; see <link to="IMachine::attachDevice"/> for how to
4821	attach a new device.
4822
4823	The @a controllerPort and @a device parameters specify the device slot and
4824	have have the same meaning as with <link to="IMachine::attachDevice" />.
4825
4826	<result name="E_INVALIDARG">
4827	SATA device, SATA port, IDE port or IDE slot out of range.
4828	</result>
4829	<result name="VBOX_E_INVALID_OBJECT_STATE">
4830	Attempt to modify an unregistered virtual machine.
4831	</result>
4832	<result name="VBOX_E_INVALID_VM_STATE">
4833	Invalid machine state.
4834	</result>
4835
4836	</desc>
4837	<param name="name" type="wstring" dir="in">
4838	<desc>Name of the storage controller.</desc>
4839	</param>
4840	<param name="controllerPort" type="long" dir="in">
4841	<desc>Storage controller port.</desc>
4842	</param>
4843	<param name="device" type="long" dir="in">
4844	<desc>Device slot in the given port.</desc>
4845	</param>
4846	<param name="temporaryEject" type="boolean" dir="in">
4847	<desc>New value for the eject behavior.</desc>
4848	</param>
4849	</method>
4850
4851	<method name="nonRotationalDevice">
4852	<desc>
4853	Sets a flag in the device information which indicates that the medium
4854	is not based on rotational technology, i.e. that the access times are
4855	more or less independent of the position on the medium. This may or may
4856	not be supported by a particular drive, and is silently ignored in the
4857	latter case. At the moment only hard disks (which is a misnomer in this
4858	context) accept this setting. Changing the setting while the VM is
4859	running is forbidden. The device must already exist; see
4860	<link to="IMachine::attachDevice"/> for how to attach a new device.
4861
4862	The @a controllerPort and @a device parameters specify the device slot and
4863	have have the same meaning as with <link to="IMachine::attachDevice" />.
4864
4865	<result name="E_INVALIDARG">
4866	SATA device, SATA port, IDE port or IDE slot out of range.
4867	</result>
4868	<result name="VBOX_E_INVALID_OBJECT_STATE">
4869	Attempt to modify an unregistered virtual machine.
4870	</result>
4871	<result name="VBOX_E_INVALID_VM_STATE">
4872	Invalid machine state.
4873	</result>
4874
4875	</desc>
4876	<param name="name" type="wstring" dir="in">
4877	<desc>Name of the storage controller.</desc>
4878	</param>
4879	<param name="controllerPort" type="long" dir="in">
4880	<desc>Storage controller port.</desc>
4881	</param>
4882	<param name="device" type="long" dir="in">
4883	<desc>Device slot in the given port.</desc>
4884	</param>
4885	<param name="nonRotational" type="boolean" dir="in">
4886	<desc>New value for the non-rotational device flag.</desc>
4887	</param>
4888	</method>
4889
4890	<method name="setAutoDiscardForDevice">
4891	<desc>
4892	Sets a flag in the device information which indicates that the medium
4893	supports discarding unsused blocks (called trimming for SATA or unmap
4894	for SCSI devices) .This may or may not be supported by a particular drive,
4895	and is silently ignored in the latter case. At the moment only hard disks
4896	(which is a misnomer in this context) accept this setting. Changing the
4897	setting while the VM is running is forbidden. The device must already
4898	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
4899	device.
4900
4901	The @a controllerPort and @a device parameters specify the device slot and
4902	have have the same meaning as with <link to="IMachine::attachDevice" />.
4903
4904	<result name="E_INVALIDARG">
4905	SATA device, SATA port, SCSI port out of range.
4906	</result>
4907	<result name="VBOX_E_INVALID_OBJECT_STATE">
4908	Attempt to modify an unregistered virtual machine.
4909	</result>
4910	<result name="VBOX_E_INVALID_VM_STATE">
4911	Invalid machine state.
4912	</result>
4913
4914	</desc>
4915	<param name="name" type="wstring" dir="in">
4916	<desc>Name of the storage controller.</desc>
4917	</param>
4918	<param name="controllerPort" type="long" dir="in">
4919	<desc>Storage controller port.</desc>
4920	</param>
4921	<param name="device" type="long" dir="in">
4922	<desc>Device slot in the given port.</desc>
4923	</param>
4924	<param name="discard" type="boolean" dir="in">
4925	<desc>New value for the discard device flag.</desc>
4926	</param>
4927	</method>
4928
4929	<method name="setBandwidthGroupForDevice">
4930	<desc>
4931	Sets the bandwidth group of an existing storage device.
4932	The device must already exist; see <link to="IMachine::attachDevice"/>
4933	for how to attach a new device.
4934
4935	The @a controllerPort and @a device parameters specify the device slot and
4936	have have the same meaning as with <link to="IMachine::attachDevice" />.
4937
4938	<result name="E_INVALIDARG">
4939	SATA device, SATA port, IDE port or IDE slot out of range.
4940	</result>
4941	<result name="VBOX_E_INVALID_OBJECT_STATE">
4942	Attempt to modify an unregistered virtual machine.
4943	</result>
4944	<result name="VBOX_E_INVALID_VM_STATE">
4945	Invalid machine state.
4946	</result>
4947
4948	</desc>
4949	<param name="name" type="wstring" dir="in">
4950	<desc>Name of the storage controller.</desc>
4951	</param>
4952	<param name="controllerPort" type="long" dir="in">
4953	<desc>Storage controller port.</desc>
4954	</param>
4955	<param name="device" type="long" dir="in">
4956	<desc>Device slot in the given port.</desc>
4957	</param>
4958	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4959	<desc>New value for the bandwidth group or NULL for no group.</desc>
4960	</param>
4961	</method>
4962
4963	<method name="mountMedium">
4964	<desc>
4965	Mounts a medium (<link to="IMedium" />, identified
4966	by the given UUID @a id) to the given storage controller
4967	(<link to="IStorageController" />, identified by @a name),
4968	at the indicated port and device. The device must already exist;
4969	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4970
4971	This method is intended only for managing removable media, where the
4972	device is fixed but media is changeable at runtime (such as DVDs
4973	and floppies). It cannot be used for fixed media such as hard disks.
4974
4975	The @a controllerPort and @a device parameters specify the device slot and
4976	have have the same meaning as with <link to="IMachine::attachDevice" />.
4977
4978	The specified device slot can have a medium mounted, which will be
4979	unmounted first. Specifying a zero UUID (or an empty string) for
4980	@a medium does just an unmount.
4981
4982	See <link to="IMedium"/> for more detailed information about
4983	attaching media.
4984
4985	<result name="E_INVALIDARG">
4986	SATA device, SATA port, IDE port or IDE slot out of range.
4987	</result>
4988	<result name="VBOX_E_INVALID_OBJECT_STATE">
4989	Attempt to attach medium to an unregistered virtual machine.
4990	</result>
4991	<result name="VBOX_E_INVALID_VM_STATE">
4992	Invalid machine state.
4993	</result>
4994	<result name="VBOX_E_OBJECT_IN_USE">
4995	Medium already attached to this or another virtual machine.
4996	</result>
4997
4998	</desc>
4999	<param name="name" type="wstring" dir="in">
5000	<desc>Name of the storage controller to attach the medium to.</desc>
5001	</param>
5002	<param name="controllerPort" type="long" dir="in">
5003	<desc>Port to attach the medium to.</desc>
5004	</param>
5005	<param name="device" type="long" dir="in">
5006	<desc>Device slot in the given port to attach the medium to.</desc>
5007	</param>
5008	<param name="medium" type="IMedium" dir="in">
5009	<desc>Medium to mount or NULL for an empty drive.</desc>
5010	</param>
5011	<param name="force" type="boolean" dir="in">
5012	<desc>Allows to force unmount/mount of a medium which is locked by
5013	the device slot in the given port to attach the medium to.</desc>
5014	</param>
5015	</method>
5016
5017	<method name="getMedium" const="yes">
5018	<desc>
5019	Returns the virtual medium attached to a device slot of the specified
5020	bus.
5021
5022	Note that if the medium was indirectly attached by
5023	<link to="#mountMedium"/> to the given device slot then this
5024	method will return not the same object as passed to the
5025	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5026	more detailed information about mounting a medium.
5027
5028	<result name="VBOX_E_OBJECT_NOT_FOUND">
5029	No medium attached to given slot/bus.
5030	</result>
5031
5032	</desc>
5033	<param name="name" type="wstring" dir="in">
5034	<desc>Name of the storage controller the medium is attached to.</desc>
5035	</param>
5036	<param name="controllerPort" type="long" dir="in">
5037	<desc>Port to query.</desc>
5038	</param>
5039	<param name="device" type="long" dir="in">
5040	<desc>Device slot in the given port to query.</desc>
5041	</param>
5042	<param name="medium" type="IMedium" dir="return">
5043	<desc>Attached medium object.</desc>
5044	</param>
5045	</method>
5046
5047	<method name="getMediumAttachmentsOfController" const="yes">
5048	<desc>
5049	Returns an array of medium attachments which are attached to the
5050	the controller with the given name.
5051
5052	<result name="VBOX_E_OBJECT_NOT_FOUND">
5053	A storage controller with given name doesn't exist.
5054	</result>
5055	</desc>
5056	<param name="name" type="wstring" dir="in"/>
5057	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5058	</method>
5059
5060	<method name="getMediumAttachment" const="yes">
5061	<desc>
5062	Returns a medium attachment which corresponds to the controller with
5063	the given name, on the given port and device slot.
5064
5065	<result name="VBOX_E_OBJECT_NOT_FOUND">
5066	No attachment exists for the given controller/port/device combination.
5067	</result>
5068	</desc>
5069	<param name="name" type="wstring" dir="in"/>
5070	<param name="controllerPort" type="long" dir="in"/>
5071	<param name="device" type="long" dir="in"/>
5072	<param name="attachment" type="IMediumAttachment" dir="return"/>
5073	</method>
5074
5075	<method name="attachHostPciDevice">
5076	<desc>
5077	Attaches host PCI device with the given (host) PCI address to the
5078	PCI bus of the virtual machine. Please note, that this operation
5079	is two phase, as real attachment will happen when VM will start,
5080	and most information will be delivered as IHostPciDevicePlugEvent
5081	on IVirtualBox event source.
5082
5083	<see><link to="IHostPciDevicePlugEvent"/></see>
5084
5085	<result name="VBOX_E_INVALID_VM_STATE">
5086	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5087	</result>
5088	<result name="VBOX_E_PDM_ERROR">
5089	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5090	</result>
5091	<result name="VBOX_E_NOT_SUPPORTED">
5092	Hardware or host OS doesn't allow PCI device passthrought.
5093	</result>
5094	</desc>
5095	<param name="hostAddress" type="long" dir="in">
5096	<desc>Address of the host PCI device.</desc>
5097	</param>
5098	<param name="desiredGuestAddress" type="long" dir="in">
5099	<desc>Desired position of this device on guest PCI bus.</desc>
5100	</param>
5101	<param name="tryToUnbind" type="boolean" dir="in">
5102	<desc>If VMM shall try to unbind existing drivers from the
5103	device before attaching it to the guest.</desc>
5104	</param>
5105	</method>
5106
5107	<method name="detachHostPciDevice">
5108	<desc>
5109	Detach host PCI device from the virtual machine.
5110	Also HostPciDevicePlugEvent on IVirtualBox event source
5111	will be delivered. As currently we don't support hot device
5112	unplug, IHostPciDevicePlugEvent event is delivered immediately.
5113
5114	<see><link to="IHostPciDevicePlugEvent"/></see>
5115
5116	<result name="VBOX_E_INVALID_VM_STATE">
5117	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5118	</result>
5119	<result name="VBOX_E_OBJECT_NOT_FOUND">
5120	This host device is not attached to this machine.
5121	</result>
5122	<result name="VBOX_E_PDM_ERROR">
5123	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5124	</result>
5125	<result name="VBOX_E_NOT_SUPPORTED">
5126	Hardware or host OS doesn't allow PCI device passthrought.
5127	</result>
5128	</desc>
5129	<param name="hostAddress" type="long" dir="in">
5130	<desc>Address of the host PCI device.</desc>
5131	</param>
5132	</method>
5133
5134	<method name="getNetworkAdapter" const="yes">
5135	<desc>
5136	Returns the network adapter associated with the given slot.
5137	Slots are numbered sequentially, starting with zero. The total
5138	number of adapters per machine is defined by the
5139	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5140	so the maximum slot number is one less than that property's value.
5141
5142	<result name="E_INVALIDARG">
5143	Invalid @a slot number.
5144	</result>
5145
5146	</desc>
5147	<param name="slot" type="unsigned long" dir="in"/>
5148	<param name="adapter" type="INetworkAdapter" dir="return"/>
5149	</method>
5150
5151	<method name="addStorageController">
5152	<desc>
5153	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5154	machine and returns it as an instance of
5155	<link to="IStorageController" />.
5156
5157	@a name identifies the controller for subsequent calls such as
5158	<link to="#getStorageControllerByName" />,
5159	<link to="#getStorageControllerByInstance" />,
5160	<link to="#removeStorageController" />,
5161	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5162
5163	After the controller has been added, you can set its exact
5164	type by setting the <link to="IStorageController::controllerType" />.
5165
5166	<result name="VBOX_E_OBJECT_IN_USE">
5167	A storage controller with given name exists already.
5168	</result>
5169	<result name="E_INVALIDARG">
5170	Invalid @a controllerType.
5171	</result>
5172	</desc>
5173	<param name="name" type="wstring" dir="in"/>
5174	<param name="connectionType" type="StorageBus" dir="in"/>
5175	<param name="controller" type="IStorageController" dir="return"/>
5176	</method>
5177
5178	<method name="getStorageControllerByName" const="yes">
5179	<desc>
5180	Returns a storage controller with the given name.
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	<param name="storageController" type="IStorageController" dir="return"/>
5188	</method>
5189
5190	<method name="getStorageControllerByInstance" const="yes">
5191	<desc>
5192	Returns a storage controller with the given instance number.
5193
5194	<result name="VBOX_E_OBJECT_NOT_FOUND">
5195	A storage controller with given instance number doesn't exist.
5196	</result>
5197	</desc>
5198	<param name="instance" type="unsigned long" dir="in"/>
5199	<param name="storageController" type="IStorageController" dir="return"/>
5200	</method>
5201
5202	<method name="removeStorageController">
5203	<desc>
5204	Removes a storage controller from the machine.
5205
5206	<result name="VBOX_E_OBJECT_NOT_FOUND">
5207	A storage controller with given name doesn't exist.
5208	</result>
5209	</desc>
5210	<param name="name" type="wstring" dir="in"/>
5211	</method>
5212
5213	<method name="setStorageControllerBootable">
5214	<desc>
5215	Sets the bootable flag of the storage controller with the given name.
5216
5217	<result name="VBOX_E_OBJECT_NOT_FOUND">
5218	A storage controller with given name doesn't exist.
5219	</result>
5220	<result name="VBOX_E_OBJECT_IN_USE">
5221	Another storage controller is marked as bootable already.
5222	</result>
5223	</desc>
5224	<param name="name" type="wstring" dir="in"/>
5225	<param name="bootable" type="boolean" dir="in"/>
5226	</method>
5227
5228	<method name="getSerialPort" const="yes">
5229	<desc>
5230	Returns the serial port associated with the given slot.
5231	Slots are numbered sequentially, starting with zero. The total
5232	number of serial ports per machine is defined by the
5233	<link to="ISystemProperties::serialPortCount"/> property,
5234	so the maximum slot number is one less than that property's value.
5235
5236	<result name="E_INVALIDARG">
5237	Invalid @a slot number.
5238	</result>
5239
5240	</desc>
5241	<param name="slot" type="unsigned long" dir="in"/>
5242	<param name="port" type="ISerialPort" dir="return"/>
5243	</method>
5244
5245	<method name="getParallelPort" const="yes">
5246	<desc>
5247	Returns the parallel port associated with the given slot.
5248	Slots are numbered sequentially, starting with zero. The total
5249	number of parallel ports per machine is defined by the
5250	<link to="ISystemProperties::parallelPortCount"/> property,
5251	so the maximum slot number is one less than that property's value.
5252
5253	<result name="E_INVALIDARG">
5254	Invalid @a slot number.
5255	</result>
5256
5257	</desc>
5258	<param name="slot" type="unsigned long" dir="in"/>
5259	<param name="port" type="IParallelPort" dir="return"/>
5260	</method>
5261
5262	<method name="getExtraDataKeys">
5263	<desc>
5264	Returns an array representing the machine-specific extra data keys
5265	which currently have values defined.
5266	</desc>
5267	<param name="value" type="wstring" dir="return" safearray="yes">
5268	<desc>Array of extra data keys.</desc>
5269	</param>
5270	</method>
5271
5272	<method name="getExtraData">
5273	<desc>
5274	Returns associated machine-specific extra data.
5275
5276	If the requested data @a key does not exist, this function will
5277	succeed and return an empty string in the @a value argument.
5278
5279	<result name="VBOX_E_FILE_ERROR">
5280	Settings file not accessible.
5281	</result>
5282	<result name="VBOX_E_XML_ERROR">
5283	Could not parse the settings file.
5284	</result>
5285
5286	</desc>
5287	<param name="key" type="wstring" dir="in">
5288	<desc>Name of the data key to get.</desc>
5289	</param>
5290	<param name="value" type="wstring" dir="return">
5291	<desc>Value of the requested data key.</desc>
5292	</param>
5293	</method>
5294
5295	<method name="setExtraData">
5296	<desc>
5297	Sets associated machine-specific extra data.
5298
5299	If you pass @c null or an empty string as a key @a value, the given
5300	@a key will be deleted.
5301
5302	<note>
5303	Before performing the actual data change, this method will ask all
5304	registered listeners using the
5305	<link to="IExtraDataCanChangeEvent"/>
5306	notification for a permission. If one of the listeners refuses the
5307	new value, the change will not be performed.
5308	</note>
5309	<note>
5310	On success, the
5311	<link to="IExtraDataChangedEvent"/> notification
5312	is called to inform all registered listeners about a successful data
5313	change.
5314	</note>
5315	<note>
5316	This method can be called outside the machine session and therefore
5317	it's a caller's responsibility to handle possible race conditions
5318	when several clients change the same key at the same time.
5319	</note>
5320
5321	<result name="VBOX_E_FILE_ERROR">
5322	Settings file not accessible.
5323	</result>
5324	<result name="VBOX_E_XML_ERROR">
5325	Could not parse the settings file.
5326	</result>
5327
5328	</desc>
5329	<param name="key" type="wstring" dir="in">
5330	<desc>Name of the data key to set.</desc>
5331	</param>
5332	<param name="value" type="wstring" dir="in">
5333	<desc>Value to assign to the key.</desc>
5334	</param>
5335	</method>
5336
5337	<method name="getCPUProperty" const="yes">
5338	<desc>
5339	Returns the virtual CPU boolean value of the specified property.
5340
5341	<result name="E_INVALIDARG">
5342	Invalid property.
5343	</result>
5344
5345	</desc>
5346	<param name="property" type="CPUPropertyType" dir="in">
5347	<desc>
5348	Property type to query.
5349	</desc>
5350	</param>
5351	<param name="value" type="boolean" dir="return">
5352	<desc>
5353	Property value.
5354	</desc>
5355	</param>
5356	</method>
5357
5358	<method name="setCPUProperty">
5359	<desc>
5360	Sets the virtual CPU boolean value of the specified property.
5361
5362	<result name="E_INVALIDARG">
5363	Invalid property.
5364	</result>
5365
5366	</desc>
5367	<param name="property" type="CPUPropertyType" dir="in">
5368	<desc>
5369	Property type to query.
5370	</desc>
5371	</param>
5372	<param name="value" type="boolean" dir="in">
5373	<desc>
5374	Property value.
5375	</desc>
5376	</param>
5377	</method>
5378
5379	<method name="getCPUIDLeaf" const="yes">
5380	<desc>
5381	Returns the virtual CPU cpuid information for the specified leaf.
5382
5383	Currently supported index values for cpuid:
5384	Standard CPUID leafs: 0 - 0xA
5385	Extended CPUID leafs: 0x80000000 - 0x8000000A
5386
5387	See the Intel and AMD programmer's manuals for detailed information
5388	about the cpuid instruction and its leafs.
5389	<result name="E_INVALIDARG">
5390	Invalid id.
5391	</result>
5392
5393	</desc>
5394	<param name="id" type="unsigned long" dir="in">
5395	<desc>
5396	CPUID leaf index.
5397	</desc>
5398	</param>
5399	<param name="valEax" type="unsigned long" dir="out">
5400	<desc>
5401	CPUID leaf value for register eax.
5402	</desc>
5403	</param>
5404	<param name="valEbx" type="unsigned long" dir="out">
5405	<desc>
5406	CPUID leaf value for register ebx.
5407	</desc>
5408	</param>
5409	<param name="valEcx" type="unsigned long" dir="out">
5410	<desc>
5411	CPUID leaf value for register ecx.
5412	</desc>
5413	</param>
5414	<param name="valEdx" type="unsigned long" dir="out">
5415	<desc>
5416	CPUID leaf value for register edx.
5417	</desc>
5418	</param>
5419	</method>
5420
5421	<method name="setCPUIDLeaf">
5422	<desc>
5423	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5424	are not passed unmodified. VirtualBox clears features that it doesn't support.
5425
5426	Currently supported index values for cpuid:
5427	Standard CPUID leafs: 0 - 0xA
5428	Extended CPUID leafs: 0x80000000 - 0x8000000A
5429
5430	See the Intel and AMD programmer's manuals for detailed information
5431	about the cpuid instruction and its leafs.
5432
5433	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5434	random crashes inside VMs.
5435	<result name="E_INVALIDARG">
5436	Invalid id.
5437	</result>
5438
5439	</desc>
5440	<param name="id" type="unsigned long" dir="in">
5441	<desc>
5442	CPUID leaf index.
5443	</desc>
5444	</param>
5445	<param name="valEax" type="unsigned long" dir="in">
5446	<desc>
5447	CPUID leaf value for register eax.
5448	</desc>
5449	</param>
5450	<param name="valEbx" type="unsigned long" dir="in">
5451	<desc>
5452	CPUID leaf value for register ebx.
5453	</desc>
5454	</param>
5455	<param name="valEcx" type="unsigned long" dir="in">
5456	<desc>
5457	CPUID leaf value for register ecx.
5458	</desc>
5459	</param>
5460	<param name="valEdx" type="unsigned long" dir="in">
5461	<desc>
5462	CPUID leaf value for register edx.
5463	</desc>
5464	</param>
5465	</method>
5466
5467	<method name="removeCPUIDLeaf">
5468	<desc>
5469	Removes the virtual CPU cpuid leaf for the specified index
5470
5471	<result name="E_INVALIDARG">
5472	Invalid id.
5473	</result>
5474
5475	</desc>
5476	<param name="id" type="unsigned long" dir="in">
5477	<desc>
5478	CPUID leaf index.
5479	</desc>
5480	</param>
5481	</method>
5482
5483	<method name="removeAllCPUIDLeaves">
5484	<desc>
5485	Removes all the virtual CPU cpuid leaves
5486	</desc>
5487	</method>
5488
5489	<method name="getHWVirtExProperty" const="yes">
5490	<desc>
5491	Returns the value of the specified hardware virtualization boolean property.
5492
5493	<result name="E_INVALIDARG">
5494	Invalid property.
5495	</result>
5496
5497	</desc>
5498	<param name="property" type="HWVirtExPropertyType" dir="in">
5499	<desc>
5500	Property type to query.
5501	</desc>
5502	</param>
5503	<param name="value" type="boolean" dir="return">
5504	<desc>
5505	Property value.
5506	</desc>
5507	</param>
5508	</method>
5509
5510	<method name="setHWVirtExProperty">
5511	<desc>
5512	Sets a new value for the specified hardware virtualization boolean property.
5513
5514	<result name="E_INVALIDARG">
5515	Invalid property.
5516	</result>
5517
5518	</desc>
5519	<param name="property" type="HWVirtExPropertyType" dir="in">
5520	<desc>
5521	Property type to set.
5522	</desc>
5523	</param>
5524	<param name="value" type="boolean" dir="in">
5525	<desc>
5526	New property value.
5527	</desc>
5528	</param>
5529	</method>
5530
5531	<method name="saveSettings">
5532	<desc>
5533	Saves any changes to machine settings made since the session
5534	has been opened or a new machine has been created, or since the
5535	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5536	For registered machines, new settings become visible to all
5537	other VirtualBox clients after successful invocation of this
5538	method.
5539	<note>
5540	The method sends <link to="IMachineDataChangedEvent"/>
5541	notification event after the configuration has been successfully
5542	saved (only for registered machines).
5543	</note>
5544	<note>
5545	Calling this method is only valid on instances returned
5546	by <link to="ISession::machine"/> and on new machines
5547	created by <link to="IVirtualBox::createMachine"/> but not
5548	yet registered, or on unregistered machines after calling
5549	<link to="IMachine::unregister"/>.
5550	</note>
5551
5552	<result name="VBOX_E_FILE_ERROR">
5553	Settings file not accessible.
5554	</result>
5555	<result name="VBOX_E_XML_ERROR">
5556	Could not parse the settings file.
5557	</result>
5558	<result name="E_ACCESSDENIED">
5559	Modification request refused.
5560	</result>
5561
5562	</desc>
5563	</method>
5564
5565	<method name="discardSettings">
5566	<desc>
5567	Discards any changes to the machine settings made since the session
5568	has been opened or since the last call to <link to="#saveSettings"/>
5569	or <link to="#discardSettings"/>.
5570	<note>
5571	Calling this method is only valid on instances returned
5572	by <link to="ISession::machine"/> and on new machines
5573	created by <link to="IVirtualBox::createMachine"/> or
5574	opened by <link to="IVirtualBox::openMachine"/> but not
5575	yet registered, or on unregistered machines after calling
5576	<link to="IMachine::unregister"/>.
5577	</note>
5578
5579	<result name="VBOX_E_INVALID_VM_STATE">
5580	Virtual machine is not mutable.
5581	</result>
5582
5583	</desc>
5584	</method>
5585
5586	<method name="unregister">
5587	<desc>
5588	Unregisters a machine previously registered with
5589	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5590	cleanup before the machine is unregistered.
5591
5592	This method does not delete any files. It only changes the machine configuration and
5593	the list of registered machines in the VirtualBox object. To delete the files which
5594	belonged to the machine, including the XML file of the machine itself, call
5595	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5596	from this method.
5597
5598	How thoroughly this method cleans up the machine configuration before unregistering
5599	the machine depends on the @a cleanupMode argument.
5600
5601	<ul>
5602	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5603	cleanup will be performed. The call will fail if the machine is in "Saved" state
5604	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5605	It is the responsibility of the caller to delete all such configuration in this mode.
5606	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5607	which it replaces.</li>
5608	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5609	state or if it has snapshots or media attached. All media attached to the current machine
5610	state or in snapshots will be detached. No medium objects will be returned;
5611	all of the machine's media will remain open.</li>
5612	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5613	except that all the hard disk medium objects which were detached from the machine will
5614	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5615	API for closing and deletion.</li>
5616	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5617	that all media will be returned in the array, including removable media like DVDs and
5618	floppies. This might be useful if the user wants to inspect in detail which media were
5619	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5620	in that case because users will typically want to preserve ISO and RAW image files.</li>
5621	</ul>
5622
5623	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5624	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5625	deleted with all its saved states and hard disk images, but images for removable
5626	drives (such as ISO and RAW files) will remain on disk.
5627
5628	This API does not verify whether the media files returned in the array are still
5629	attached to other machines (i.e. shared between several machines). If such a shared
5630	image is passed to <link to="#delete" /> however, closing the image will fail there
5631	and the image will be silently skipped.
5632
5633	This API may, however, move media from this machine's media registry to other media
5634	registries (see <link to="IMedium" /> for details on media registries). For machines
5635	created with VirtualBox 4.0 or later, if media from this machine's media registry
5636	are also attached to another machine (shared attachments), each such medium will be
5637	moved to another machine's registry. This is because without this machine's media
5638	registry, the other machine cannot find its media any more and would become inaccessible.
5639
5640	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5641	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
5642	if media are moved to other machines' media registries.
5643
5644	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5645	is fired.
5646
5647	The call will fail if the machine is currently locked (see <link to="ISession" />).
5648
5649	<note>
5650	If the given machine is inaccessible (see <link to="#accessible"/>), it
5651	will be unregistered and fully uninitialized right afterwards. As a result,
5652	the returned machine object will be unusable and an attempt to call
5653	<b>any</b> method will return the "Object not ready" error.
5654	</note>
5655
5656	<result name="VBOX_E_INVALID_OBJECT_STATE">
5657	Machine is currently locked for a session.
5658	</result>
5659	</desc>
5660
5661	<param name="cleanupMode" type="CleanupMode" dir="in">
5662	<desc>How to clean up after the machine has been unregistered.</desc>
5663	</param>
5664	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5665	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5666	</param>
5667	</method>
5668
5669	<method name="delete">
5670	<desc>
5671	Deletes the files associated with this machine from disk. If medium objects are passed
5672	in with the @a aMedia argument, they are closed and, if closing was successful, their
5673	storage files are deleted as well. For convenience, this array of media files can be
5674	the same as the one returned from a previous <link to="#unregister" /> call.
5675
5676	This method must only be called on machines which are either write-locked (i.e. on instances
5677	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5678	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5679	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5680
5681	The following files will be deleted by this method:
5682	<ul>
5683	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5684	argument other than "UnregisterOnly", this will delete all saved state files that
5685	the machine had in use; possibly one if the machine was in "Saved" state and one
5686	for each online snapshot that the machine had.</li>
5687	<li>On each medium object passed in the @a aMedia array, this will call
5688	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5689	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
5690	in use, e.g. because it is still attached to a second machine; in that case the
5691	storage will not be deleted.</li>
5692	<li>Finally, the machine's own XML file will be deleted.</li>
5693	</ul>
5694
5695	Since deleting large disk image files can be a time-consuming I/O operation, this
5696	method operates asynchronously and returns an IProgress object to allow the caller
5697	to monitor the progress. There will be one sub-operation for each file that is
5698	being deleted (saved state or medium storage file).
5699
5700	<note>
5701	<link to="#settingsModified"/> will return @c true after this
5702	method successfully returns.
5703	</note>
5704
5705	<result name="VBOX_E_INVALID_VM_STATE">
5706	Machine is registered but not write-locked.
5707	</result>
5708	<result name="VBOX_E_IPRT_ERROR">
5709	Could not delete the settings file.
5710	</result>
5711	</desc>
5712	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5713	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5714	</param>
5715	<param name="aProgress" type="IProgress" dir="return">
5716	<desc>Progress object to track the operation completion.</desc>
5717	</param>
5718	</method>
5719
5720	<method name="export">
5721	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5722	steps required to export VirtualBox machines to OVF.
5723	</desc>
5724
5725	<param name="aAppliance" type="IAppliance" dir="in">
5726	<desc>Appliance to export this machine to.</desc>
5727	</param>
5728	<param name="location" type="wstring" dir="in">
5729	<desc>The target location.</desc>
5730	</param>
5731	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5732	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5733	</param>
5734	</method >
5735
5736	<method name="findSnapshot">
5737	<desc>
5738	Returns a snapshot of this machine with the given name or UUID.
5739
5740	Returns a snapshot of this machine with the given UUID.
5741	A @c null argument can be used to obtain the first snapshot
5742	taken on this machine. To traverse the whole tree of snapshots
5743	starting from the root, inspect the root snapshot's
5744	<link to="ISnapshot::children" /> attribute and recurse over those children.
5745
5746	<result name="VBOX_E_OBJECT_NOT_FOUND">
5747	Virtual machine has no snapshots or snapshot not found.
5748	</result>
5749
5750	</desc>
5751	<param name="nameOrId" type="wstring" dir="in">
5752	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5753	</param>
5754	<param name="snapshot" type="ISnapshot" dir="return">
5755	<desc>Snapshot object with the given name.</desc>
5756	</param>
5757	</method>
5758
5759	<method name="createSharedFolder">
5760	<desc>
5761	Creates a new permanent shared folder by associating the given logical
5762	name with the given host path, adds it to the collection of shared
5763	folders and starts sharing it. Refer to the description of
5764	<link to="ISharedFolder"/> to read more about logical names.
5765
5766	<result name="VBOX_E_OBJECT_IN_USE">
5767	Shared folder already exists.
5768	</result>
5769	<result name="VBOX_E_FILE_ERROR">
5770	Shared folder @a hostPath not accessible.
5771	</result>
5772
5773	</desc>
5774	<param name="name" type="wstring" dir="in">
5775	<desc>Unique logical name of the shared folder.</desc>
5776	</param>
5777	<param name="hostPath" type="wstring" dir="in">
5778	<desc>Full path to the shared folder in the host file system.</desc>
5779	</param>
5780	<param name="writable" type="boolean" dir="in">
5781	<desc>Whether the share is writable or readonly.</desc>
5782	</param>
5783	<param name="automount" type="boolean" dir="in">
5784	<desc>Whether the share gets automatically mounted by the guest
5785	or not.</desc>
5786	</param>
5787	</method>
5788
5789	<method name="removeSharedFolder">
5790	<desc>
5791	Removes the permanent shared folder with the given name previously
5792	created by <link to="#createSharedFolder"/> from the collection of
5793	shared folders and stops sharing it.
5794
5795	<result name="VBOX_E_INVALID_VM_STATE">
5796	Virtual machine is not mutable.
5797	</result>
5798	<result name="VBOX_E_OBJECT_NOT_FOUND">
5799	Shared folder @a name does not exist.
5800	</result>
5801
5802	</desc>
5803	<param name="name" type="wstring" dir="in">
5804	<desc>Logical name of the shared folder to remove.</desc>
5805	</param>
5806	</method>
5807
5808	<method name="canShowConsoleWindow">
5809	<desc>
5810	Returns @c true if the VM console process can activate the
5811	console window and bring it to foreground on the desktop of
5812	the host PC.
5813	<note>
5814	This method will fail if a session for this machine is not
5815	currently open.
5816	</note>
5817
5818	<result name="VBOX_E_INVALID_VM_STATE">
5819	Machine session is not open.
5820	</result>
5821
5822	</desc>
5823	<param name="canShow" type="boolean" dir="return">
5824	<desc>
5825	@c true if the console window can be shown and @c false otherwise.
5826	</desc>
5827	</param>
5828	</method>
5829
5830	<method name="showConsoleWindow">
5831	<desc>
5832	Activates the console window and brings it to foreground on
5833	the desktop of the host PC. Many modern window managers on
5834	many platforms implement some sort of focus stealing
5835	prevention logic, so that it may be impossible to activate
5836	a window without the help of the currently active
5837	application. In this case, this method will return a non-zero
5838	identifier that represents the top-level window of the VM
5839	console process. The caller, if it represents a currently
5840	active process, is responsible to use this identifier (in a
5841	platform-dependent manner) to perform actual window
5842	activation.
5843	<note>
5844	This method will fail if a session for this machine is not
5845	currently open.
5846	</note>
5847
5848	<result name="VBOX_E_INVALID_VM_STATE">
5849	Machine session is not open.
5850	</result>
5851
5852	</desc>
5853	<param name="winId" type="long long" dir="return">
5854	<desc>
5855	Platform-dependent identifier of the top-level VM console
5856	window, or zero if this method has performed all actions
5857	necessary to implement the <i>show window</i> semantics for
5858	the given platform and/or VirtualBox front-end.
5859	</desc>
5860	</param>
5861	</method>
5862
5863	<method name="getGuestProperty" const="yes">
5864	<desc>
5865	Reads an entry from the machine's guest property store.
5866
5867	<result name="VBOX_E_INVALID_VM_STATE">
5868	Machine session is not open.
5869	</result>
5870
5871	</desc>
5872	<param name="name" type="wstring" dir="in">
5873	<desc>
5874	The name of the property to read.
5875	</desc>
5876	</param>
5877	<param name="value" type="wstring" dir="out">
5878	<desc>
5879	The value of the property. If the property does not exist then this
5880	will be empty.
5881	</desc>
5882	</param>
5883	<param name="timestamp" type="long long" dir="out">
5884	<desc>
5885	The time at which the property was last modified, as seen by the
5886	server process.
5887	</desc>
5888	</param>
5889	<param name="flags" type="wstring" dir="out">
5890	<desc>
5891	Additional property parameters, passed as a comma-separated list of
5892	"name=value" type entries.
5893	</desc>
5894	</param>
5895	</method>
5896
5897	<method name="getGuestPropertyValue" const="yes">
5898	<desc>
5899	Reads a value from the machine's guest property store.
5900
5901	<result name="VBOX_E_INVALID_VM_STATE">
5902	Machine session is not open.
5903	</result>
5904
5905	</desc>
5906	<param name="property" type="wstring" dir="in">
5907	<desc>
5908	The name of the property to read.
5909	</desc>
5910	</param>
5911	<param name="value" type="wstring" dir="return">
5912	<desc>
5913	The value of the property. If the property does not exist then this
5914	will be empty.
5915	</desc>
5916	</param>
5917	</method>
5918
5919	<method name="getGuestPropertyTimestamp" const="yes">
5920	<desc>
5921	Reads a property timestamp from the machine's guest property store.
5922
5923	<result name="VBOX_E_INVALID_VM_STATE">
5924	Machine session is not open.
5925	</result>
5926
5927	</desc>
5928	<param name="property" type="wstring" dir="in">
5929	<desc>
5930	The name of the property to read.
5931	</desc>
5932	</param>
5933	<param name="value" type="long long" dir="return">
5934	<desc>
5935	The timestamp. If the property does not exist then this will be
5936	empty.
5937	</desc>
5938	</param>
5939	</method>
5940
5941	<method name="setGuestProperty">
5942	<desc>
5943	Sets, changes or deletes an entry in the machine's guest property
5944	store.
5945
5946	<result name="E_ACCESSDENIED">
5947	Property cannot be changed.
5948	</result>
5949	<result name="E_INVALIDARG">
5950	Invalid @a flags.
5951	</result>
5952	<result name="VBOX_E_INVALID_VM_STATE">
5953	Virtual machine is not mutable or session not open.
5954	</result>
5955	<result name="VBOX_E_INVALID_OBJECT_STATE">
5956	Cannot set transient property when machine not running.
5957	</result>
5958
5959	</desc>
5960	<param name="property" type="wstring" dir="in">
5961	<desc>
5962	The name of the property to set, change or delete.
5963	</desc>
5964	</param>
5965	<param name="value" type="wstring" dir="in">
5966	<desc>
5967	The new value of the property to set, change or delete. If the
5968	property does not yet exist and value is non-empty, it will be
5969	created. If the value is @c null or empty, the property will be
5970	deleted if it exists.
5971	</desc>
5972	</param>
5973	<param name="flags" type="wstring" dir="in">
5974	<desc>
5975	Additional property parameters, passed as a comma-separated list of
5976	"name=value" type entries.
5977	</desc>
5978	</param>
5979	</method>
5980
5981	<method name="setGuestPropertyValue">
5982	<desc>
5983	Sets, changes or deletes a value in the machine's guest property
5984	store. The flags field will be left unchanged or created empty for a
5985	new property.
5986
5987	<result name="E_ACCESSDENIED">
5988	Property cannot be changed.
5989	</result>
5990	<result name="VBOX_E_INVALID_VM_STATE">
5991	Virtual machine is not mutable or session not open.
5992	</result>
5993	<result name="VBOX_E_INVALID_OBJECT_STATE">
5994	Cannot set transient property when machine not running.
5995	</result>
5996	</desc>
5997
5998	<param name="property" type="wstring" dir="in">
5999	<desc>
6000	The name of the property to set, change or delete.
6001	</desc>
6002	</param>
6003	<param name="value" type="wstring" dir="in">
6004	<desc>
6005	The new value of the property to set, change or delete. If the
6006	property does not yet exist and value is non-empty, it will be
6007	created. If the value is @c null or empty, the property will be
6008	deleted if it exists.
6009	</desc>
6010	</param>
6011	</method>
6012
6013	<method name="deleteGuestProperty" const="yes">
6014	<desc>
6015	Deletes an entry from the machine's guest property store.
6016
6017	<result name="VBOX_E_INVALID_VM_STATE">
6018	Machine session is not open.
6019	</result>
6020
6021	</desc>
6022	<param name="name" type="wstring" dir="in">
6023	<desc>
6024	The name of the property to delete.
6025	</desc>
6026	</param>
6027	</method>
6028
6029	<method name="enumerateGuestProperties" const="yes">
6030	<desc>
6031	Return a list of the guest properties matching a set of patterns along
6032	with their values, time stamps and flags.
6033	</desc>
6034	<param name="patterns" type="wstring" dir="in">
6035	<desc>
6036	The patterns to match the properties against, separated by '\|'
6037	characters. If this is empty or @c null, all properties will match.
6038	</desc>
6039	</param>
6040	<param name="name" type="wstring" dir="out" safearray="yes">
6041	<desc>
6042	The names of the properties returned.
6043	</desc>
6044	</param>
6045	<param name="value" type="wstring" dir="out" safearray="yes">
6046	<desc>
6047	The values of the properties returned. The array entries match the
6048	corresponding entries in the @a name array.
6049	</desc>
6050	</param>
6051	<param name="timestamp" type="long long" dir="out" safearray="yes">
6052	<desc>
6053	The time stamps of the properties returned. The array entries match
6054	the corresponding entries in the @a name array.
6055	</desc>
6056	</param>
6057	<param name="flags" type="wstring" dir="out" safearray="yes">
6058	<desc>
6059	The flags of the properties returned. The array entries match the
6060	corresponding entries in the @a name array.
6061	</desc>
6062	</param>
6063	</method>
6064
6065	<method name="querySavedGuestScreenInfo" const="yes">
6066	<desc>
6067	Returns the guest dimensions from the saved state.
6068	</desc>
6069	<param name="screenId" type="unsigned long" dir="in">
6070	<desc>
6071	Saved guest screen to query info from.
6072	</desc>
6073	</param>
6074	<param name="originX" type="unsigned long" dir="out">
6075	<desc>
6076	The X position of the guest monitor top left corner.
6077	</desc>
6078	</param>
6079	<param name="originY" type="unsigned long" dir="out">
6080	<desc>
6081	The Y position of the guest monitor top left corner.
6082	</desc>
6083	</param>
6084	<param name="width" type="unsigned long" dir="out">
6085	<desc>
6086	Guest width at the time of the saved state was taken.
6087	</desc>
6088	</param>
6089	<param name="height" type="unsigned long" dir="out">
6090	<desc>
6091	Guest height at the time of the saved state was taken.
6092	</desc>
6093	</param>
6094	<param name="enabled" type="boolean" dir="out">
6095	<desc>
6096	Whether the monitor is enabled in the guest.
6097	</desc>
6098	</param>
6099	</method>
6100
6101	<method name="querySavedThumbnailSize">
6102	<desc>
6103	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
6104	</desc>
6105	<param name="screenId" type="unsigned long" dir="in">
6106	<desc>
6107	Saved guest screen to query info from.
6108	</desc>
6109	</param>
6110	<param name="size" type="unsigned long" dir="out">
6111	<desc>
6112	Size of buffer required to store the bitmap.
6113	</desc>
6114	</param>
6115	<param name="width" type="unsigned long" dir="out">
6116	<desc>
6117	Bitmap width.
6118	</desc>
6119	</param>
6120	<param name="height" type="unsigned long" dir="out">
6121	<desc>
6122	Bitmap height.
6123	</desc>
6124	</param>
6125	</method>
6126
6127	<method name="readSavedThumbnailToArray">
6128	<desc>
6129	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
6130	</desc>
6131	<param name="screenId" type="unsigned long" dir="in">
6132	<desc>
6133	Saved guest screen to read from.
6134	</desc>
6135	</param>
6136	<param name="BGR" type="boolean" dir="in">
6137	<desc>
6138	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6139	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
6140	</desc>
6141	</param>
6142	<param name="width" type="unsigned long" dir="out">
6143	<desc>
6144	Bitmap width.
6145	</desc>
6146	</param>
6147	<param name="height" type="unsigned long" dir="out">
6148	<desc>
6149	Bitmap height.
6150	</desc>
6151	</param>
6152	<param name="data" type="octet" safearray="yes" dir="return">
6153	<desc>
6154	Array with resulting bitmap data.
6155	</desc>
6156	</param>
6157	</method>
6158
6159	<method name="readSavedThumbnailPNGToArray">
6160	<desc>
6161	Thumbnail in PNG format is retrieved to an array of bytes.
6162	</desc>
6163	<param name="screenId" type="unsigned long" dir="in">
6164	<desc>
6165	Saved guest screen to read from.
6166	</desc>
6167	</param>
6168	<param name="width" type="unsigned long" dir="out">
6169	<desc>
6170	Image width.
6171	</desc>
6172	</param>
6173	<param name="height" type="unsigned long" dir="out">
6174	<desc>
6175	Image height.
6176	</desc>
6177	</param>
6178	<param name="data" type="octet" dir="return" safearray="yes">
6179	<desc>
6180	Array with resulting PNG data.
6181	</desc>
6182	</param>
6183	</method>
6184
6185	<method name="querySavedScreenshotPNGSize">
6186	<desc>
6187	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6188	</desc>
6189	<param name="screenId" type="unsigned long" dir="in">
6190	<desc>
6191	Saved guest screen to query info from.
6192	</desc>
6193	</param>
6194	<param name="size" type="unsigned long" dir="out">
6195	<desc>
6196	Size of buffer required to store the PNG binary data.
6197	</desc>
6198	</param>
6199	<param name="width" type="unsigned long" dir="out">
6200	<desc>
6201	Image width.
6202	</desc>
6203	</param>
6204	<param name="height" type="unsigned long" dir="out">
6205	<desc>
6206	Image height.
6207	</desc>
6208	</param>
6209	</method>
6210
6211	<method name="readSavedScreenshotPNGToArray">
6212	<desc>
6213	Screenshot in PNG format is retrieved to an array of bytes.
6214	</desc>
6215	<param name="screenId" type="unsigned long" dir="in">
6216	<desc>
6217	Saved guest screen to read from.
6218	</desc>
6219	</param>
6220	<param name="width" type="unsigned long" dir="out">
6221	<desc>
6222	Image width.
6223	</desc>
6224	</param>
6225	<param name="height" type="unsigned long" dir="out">
6226	<desc>
6227	Image height.
6228	</desc>
6229	</param>
6230	<param name="data" type="octet" dir="return" safearray="yes">
6231	<desc>
6232	Array with resulting PNG data.
6233	</desc>
6234	</param>
6235	</method>
6236
6237	<method name="hotPlugCPU">
6238	<desc>
6239	Plugs a CPU into the machine.
6240	</desc>
6241	<param name="cpu" type="unsigned long" dir="in">
6242	<desc>
6243	The CPU id to insert.
6244	</desc>
6245	</param>
6246	</method>
6247
6248	<method name="hotUnplugCPU">
6249	<desc>
6250	Removes a CPU from the machine.
6251	</desc>
6252	<param name="cpu" type="unsigned long" dir="in">
6253	<desc>
6254	The CPU id to remove.
6255	</desc>
6256	</param>
6257	</method>
6258
6259	<method name="getCPUStatus">
6260	<desc>
6261	Returns the current status of the given CPU.
6262	</desc>
6263	<param name="cpu" type="unsigned long" dir="in">
6264	<desc>
6265	The CPU id to check for.
6266	</desc>
6267	</param>
6268	<param name="attached" type="boolean" dir="return">
6269	<desc>
6270	Status of the CPU.
6271	</desc>
6272	</param>
6273	</method>
6274
6275	<method name="queryLogFilename">
6276	<desc>
6277	Queries for the VM log file name of an given index. Returns an empty
6278	string if a log file with that index doesn't exists.
6279	</desc>
6280	<param name="idx" type="unsigned long" dir="in">
6281	<desc>
6282	Which log file name to query. 0=current log file.
6283	</desc>
6284	</param>
6285	<param name="filename" type="wstring" dir="return">
6286	<desc>
6287	On return the full path to the log file or an empty string on error.
6288	</desc>
6289	</param>
6290	</method>
6291
6292	<method name="readLog">
6293	<desc>
6294	Reads the VM log file. The chunk size is limited, so even if you
6295	ask for a big piece there might be less data returned.
6296	</desc>
6297	<param name="idx" type="unsigned long" dir="in">
6298	<desc>
6299	Which log file to read. 0=current log file.
6300	</desc>
6301	</param>
6302	<param name="offset" type="long long" dir="in">
6303	<desc>
6304	Offset in the log file.
6305	</desc>
6306	</param>
6307	<param name="size" type="long long" dir="in">
6308	<desc>
6309	Chunk size to read in the log file.
6310	</desc>
6311	</param>
6312	<param name="data" type="octet" dir="return" safearray="yes">
6313	<desc>
6314	Data read from the log file. A data size of 0 means end of file
6315	if the requested chunk size was not 0. This is the unprocessed
6316	file data, i.e. the line ending style depends on the platform of
6317	the system the server is running on.
6318	</desc>
6319	</param>
6320	</method>
6321
6322	<method name="cloneTo">
6323	<desc>
6324	Creates a clone of this machine, either as a full clone (which means
6325	creating independent copies of the hard disk media, save states and so
6326	on), or as a linked clone (which uses its own differencing media,
6327	sharing the parent media with the source machine).
6328
6329	The target machine object must have been created previously with <link
6330	to="IVirtualBox::createMachine"/>, and all the settings will be
6331	transferred except the VM name and the hardware UUID. You can set the
6332	VM name and the new hardware UUID when creating the target machine. The
6333	network MAC addresses are newly created for all newtwork adapters. You
6334	can change that behaviour with the options parameter. The operation is
6335	performed asynchronously, so the machine object will be not be usable
6336	until the @a progress object signals completion.
6337
6338	<result name="E_INVALIDARG">
6339	@a target is @c null.
6340	</result>
6341	</desc>
6342
6343	<param name="target" type="IMachine" dir="in">
6344	<desc>Target machine object.</desc>
6345	</param>
6346	<param name="mode" type="CloneMode" dir="in">
6347	<desc>Which states should be cloned.</desc>
6348	</param>
6349	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6350	<desc>Options for the cloning operation.</desc>
6351	</param>
6352	<param name="progress" type="IProgress" dir="return">
6353	<desc>Progress object to track the operation completion.</desc>
6354	</param>
6355	</method>
6356
6357	</interface>
6358
6359	<!--
6360	// IConsole
6361	/////////////////////////////////////////////////////////////////////////
6362	-->
6363
6364	<interface
6365	name="IVRDEServerInfo" extends="$unknown"
6366	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6367	wsmap="struct"
6368	>
6369	<desc>
6370	Contains information about the remote desktop (VRDE) server capabilities and status.
6371	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6372	</desc>
6373
6374	<attribute name="active" type="boolean" readonly="yes">
6375	<desc>
6376	Whether the remote desktop connection is active.
6377	</desc>
6378	</attribute>
6379
6380	<attribute name="port" type="long" readonly="yes">
6381	<desc>
6382	VRDE server port number. If this property is equal to <tt>0</tt>, then
6383	the VRDE server failed to start, usually because there are no free IP
6384	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6385	server has not yet been started.
6386	</desc>
6387	</attribute>
6388
6389	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6390	<desc>
6391	How many times a client connected.
6392	</desc>
6393	</attribute>
6394
6395	<attribute name="beginTime" type="long long" readonly="yes">
6396	<desc>
6397	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6398	</desc>
6399	</attribute>
6400
6401	<attribute name="endTime" type="long long" readonly="yes">
6402	<desc>
6403	When the last connection was terminated or the current time, if
6404	connection is still active, in milliseconds since 1970-01-01 UTC.
6405	</desc>
6406	</attribute>
6407
6408	<attribute name="bytesSent" type="long long" readonly="yes">
6409	<desc>
6410	How many bytes were sent in last or current, if still active, connection.
6411	</desc>
6412	</attribute>
6413
6414	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6415	<desc>
6416	How many bytes were sent in all connections.
6417	</desc>
6418	</attribute>
6419
6420	<attribute name="bytesReceived" type="long long" readonly="yes">
6421	<desc>
6422	How many bytes were received in last or current, if still active, connection.
6423	</desc>
6424	</attribute>
6425
6426	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6427	<desc>
6428	How many bytes were received in all connections.
6429	</desc>
6430	</attribute>
6431
6432	<attribute name="user" type="wstring" readonly="yes">
6433	<desc>
6434	Login user name supplied by the client.
6435	</desc>
6436	</attribute>
6437
6438	<attribute name="domain" type="wstring" readonly="yes">
6439	<desc>
6440	Login domain name supplied by the client.
6441	</desc>
6442	</attribute>
6443
6444	<attribute name="clientName" type="wstring" readonly="yes">
6445	<desc>
6446	The client name supplied by the client.
6447	</desc>
6448	</attribute>
6449
6450	<attribute name="clientIP" type="wstring" readonly="yes">
6451	<desc>
6452	The IP address of the client.
6453	</desc>
6454	</attribute>
6455
6456	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6457	<desc>
6458	The client software version number.
6459	</desc>
6460	</attribute>
6461
6462	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6463	<desc>
6464	Public key exchange method used when connection was established.
6465	Values: 0 - RDP4 public key exchange scheme.
6466	1 - X509 certificates were sent to client.
6467	</desc>
6468	</attribute>
6469
6470	</interface>
6471
6472	<interface
6473	name="IConsole" extends="$unknown"
6474	uuid="1968b7d3-e3bf-4ceb-99e0-cb7c913317bb"
6475	wsmap="managed"
6476	>
6477	<desc>
6478	The IConsole interface represents an interface to control virtual
6479	machine execution.
6480
6481	A console object gets created when a machine has been locked for a
6482	particular session (client process) using <link to="IMachine::lockMachine" />
6483	or <link to="IMachine::launchVMProcess"/>. The console object can
6484	then be found in the session's <link to="ISession::console" /> attribute.
6485
6486	Methods of the IConsole interface allow the caller to query the current
6487	virtual machine execution state, pause the machine or power it down, save
6488	the machine state or take a snapshot, attach and detach removable media
6489	and so on.
6490
6491	<see><link to="ISession"/></see>
6492	</desc>
6493
6494	<attribute name="machine" type="IMachine" readonly="yes">
6495	<desc>
6496	Machine object for this console session.
6497	<note>
6498	This is a convenience property, it has the same value as
6499	<link to="ISession::machine"/> of the corresponding session
6500	object.
6501	</note>
6502	</desc>
6503	</attribute>
6504
6505	<attribute name="state" type="MachineState" readonly="yes">
6506	<desc>
6507	Current execution state of the machine.
6508	<note>
6509	This property always returns the same value as the corresponding
6510	property of the IMachine object for this console session.
6511	For the process that owns (executes) the VM, this is the
6512	preferable way of querying the VM state, because no IPC
6513	calls are made.
6514	</note>
6515	</desc>
6516	</attribute>
6517
6518	<attribute name="guest" type="IGuest" readonly="yes">
6519	<desc>Guest object.</desc>
6520	</attribute>
6521
6522	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6523	<desc>
6524	Virtual keyboard object.
6525	<note>
6526	If the machine is not running, any attempt to use
6527	the returned object will result in an error.
6528	</note>
6529	</desc>
6530	</attribute>
6531
6532	<attribute name="mouse" type="IMouse" readonly="yes">
6533	<desc>
6534	Virtual mouse object.
6535	<note>
6536	If the machine is not running, any attempt to use
6537	the returned object will result in an error.
6538	</note>
6539	</desc>
6540	</attribute>
6541
6542	<attribute name="display" type="IDisplay" readonly="yes">
6543	<desc>Virtual display object.
6544	<note>
6545	If the machine is not running, any attempt to use
6546	the returned object will result in an error.
6547	</note>
6548	</desc>
6549	</attribute>
6550
6551	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6552	<desc>Debugging interface.</desc>
6553	</attribute>
6554
6555	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6556	<desc>
6557	Collection of USB devices currently attached to the virtual
6558	USB controller.
6559	<note>
6560	The collection is empty if the machine is not running.
6561	</note>
6562	</desc>
6563	</attribute>
6564
6565	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6566	<desc>
6567	List of USB devices currently attached to the remote VRDE client.
6568	Once a new device is physically attached to the remote host computer,
6569	it appears in this list and remains there until detached.
6570	</desc>
6571	</attribute>
6572
6573	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6574	<desc>
6575	Collection of shared folders for the current session. These folders
6576	are called transient shared folders because they are available to the
6577	guest OS running inside the associated virtual machine only for the
6578	duration of the session (as opposed to
6579	<link to="IMachine::sharedFolders"/> which represent permanent shared
6580	folders). When the session is closed (e.g. the machine is powered down),
6581	these folders are automatically discarded.
6582
6583	New shared folders are added to the collection using
6584	<link to="#createSharedFolder"/>. Existing shared folders can be
6585	removed using <link to="#removeSharedFolder"/>.
6586	</desc>
6587	</attribute>
6588
6589	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6590	<desc>
6591	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6592	</desc>
6593	</attribute>
6594
6595	<attribute name="eventSource" type="IEventSource" readonly="yes">
6596	<desc>
6597	Event source for console events.
6598	</desc>
6599	</attribute>
6600
6601	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6602	<desc>Array of PCI devices attached to this machine.</desc>
6603	</attribute>
6604
6605	<attribute name="useHostClipboard" type="boolean">
6606	<desc>
6607	Whether the guest clipboard should be connected to the host one or
6608	whether it should only be allowed access to the VRDE clipboard. This
6609	setting may not affect existing guest clipboard connections which
6610	are already connected to the host clipboard.
6611	</desc>
6612	</attribute>
6613
6614	<method name="powerUp">
6615	<desc>
6616	Starts the virtual machine execution using the current machine
6617	state (that is, its current execution state, current settings and
6618	current storage devices).
6619
6620	<note>
6621	This method is only useful for front-ends that want to actually
6622	execute virtual machines in their own process (like the VirtualBox
6623	or VBoxSDL front-ends). Unless you are intending to write such a
6624	front-end, do not call this method. If you simply want to
6625	start virtual machine execution using one of the existing front-ends
6626	(for example the VirtualBox GUI or headless server), use
6627	<link to="IMachine::launchVMProcess"/> instead; these
6628	front-ends will power up the machine automatically for you.
6629	</note>
6630
6631	If the machine is powered off or aborted, the execution will
6632	start from the beginning (as if the real hardware were just
6633	powered on).
6634
6635	If the machine is in the <link to="MachineState_Saved"/> state,
6636	it will continue its execution the point where the state has
6637	been saved.
6638
6639	If the machine <link to="IMachine::teleporterEnabled"/> property is
6640	enabled on the machine being powered up, the machine will wait for an
6641	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6642	state. The returned progress object will have at least three
6643	operations where the last three are defined as: (1) powering up and
6644	starting TCP server, (2) waiting for incoming teleportations, and
6645	(3) perform teleportation. These operations will be reflected as the
6646	last three operations of the progress objected returned by
6647	<link to="IMachine::launchVMProcess"/> as well.
6648
6649	<see><link to="#saveState"/></see>
6650
6651	<result name="VBOX_E_INVALID_VM_STATE">
6652	Virtual machine already running.
6653	</result>
6654	<result name="VBOX_E_HOST_ERROR">
6655	Host interface does not exist or name not set.
6656	</result>
6657	<result name="VBOX_E_FILE_ERROR">
6658	Invalid saved state file.
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="powerUpPaused">
6667	<desc>
6668	Identical to powerUp except that the VM will enter the
6669	<link to="MachineState_Paused"/> state, instead of
6670	<link to="MachineState_Running"/>.
6671
6672	<see><link to="#powerUp"/></see>
6673	<result name="VBOX_E_INVALID_VM_STATE">
6674	Virtual machine already running.
6675	</result>
6676	<result name="VBOX_E_HOST_ERROR">
6677	Host interface does not exist or name not set.
6678	</result>
6679	<result name="VBOX_E_FILE_ERROR">
6680	Invalid saved state file.
6681	</result>
6682	</desc>
6683	<param name="progress" type="IProgress" dir="return">
6684	<desc>Progress object to track the operation completion.</desc>
6685	</param>
6686	</method>
6687
6688	<method name="powerDown">
6689	<desc>
6690	Initiates the power down procedure to stop the virtual machine
6691	execution.
6692
6693	The completion of the power down procedure is tracked using the returned
6694	IProgress object. After the operation is complete, the machine will go
6695	to the PoweredOff state.
6696	<result name="VBOX_E_INVALID_VM_STATE">
6697	Virtual machine must be Running, Paused or Stuck to be powered down.
6698	</result>
6699	</desc>
6700	<param name="progress" type="IProgress" dir="return">
6701	<desc>Progress object to track the operation completion.</desc>
6702	</param>
6703	</method>
6704
6705	<method name="reset">
6706	<desc>Resets the virtual machine.
6707	<result name="VBOX_E_INVALID_VM_STATE">
6708	Virtual machine not in Running state.
6709	</result>
6710	<result name="VBOX_E_VM_ERROR">
6711	Virtual machine error in reset operation.
6712	</result>
6713	</desc>
6714	</method>
6715
6716	<method name="pause">
6717	<desc>Pauses the virtual machine execution.
6718	<result name="VBOX_E_INVALID_VM_STATE">
6719	Virtual machine not in Running state.
6720	</result>
6721	<result name="VBOX_E_VM_ERROR">
6722	Virtual machine error in suspend operation.
6723	</result>
6724	</desc>
6725	</method>
6726
6727	<method name="resume">
6728	<desc>Resumes the virtual machine execution.
6729	<result name="VBOX_E_INVALID_VM_STATE">
6730	Virtual machine not in Paused state.
6731	</result>
6732	<result name="VBOX_E_VM_ERROR">
6733	Virtual machine error in resume operation.
6734	</result>
6735	</desc>
6736	</method>
6737
6738	<method name="powerButton">
6739	<desc>Sends the ACPI power button event to the guest.
6740	<result name="VBOX_E_INVALID_VM_STATE">
6741	Virtual machine not in Running state.
6742	</result>
6743	<result name="VBOX_E_PDM_ERROR">
6744	Controlled power off failed.
6745	</result>
6746	</desc>
6747	</method>
6748
6749	<method name="sleepButton">
6750	<desc>Sends the ACPI sleep button event to the guest.
6751	<result name="VBOX_E_INVALID_VM_STATE">
6752	Virtual machine not in Running state.
6753	</result>
6754	<result name="VBOX_E_PDM_ERROR">
6755	Sending sleep button event failed.
6756	</result>
6757	</desc>
6758	</method>
6759
6760	<method name="getPowerButtonHandled">
6761	<desc>Checks if the last power button event was handled by guest.
6762	<result name="VBOX_E_PDM_ERROR">
6763	Checking if the event was handled by the guest OS failed.
6764	</result>
6765	</desc>
6766	<param name="handled" type="boolean" dir="return"/>
6767	</method>
6768
6769	<method name="getGuestEnteredACPIMode">
6770	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6771	G1 (sleeping). If this method returns @c false, the guest will
6772	most likely not respond to external ACPI events.
6773	<result name="VBOX_E_INVALID_VM_STATE">
6774	Virtual machine not in Running state.
6775	</result>
6776	</desc>
6777	<param name="entered" type="boolean" dir="return"/>
6778	</method>
6779
6780	<method name="saveState">
6781	<desc>
6782	Saves the current execution state of a running virtual machine
6783	and stops its execution.
6784
6785	After this operation completes, the machine will go to the
6786	Saved state. Next time it is powered up, this state will
6787	be restored and the machine will continue its execution from
6788	the place where it was saved.
6789
6790	This operation differs from taking a snapshot to the effect
6791	that it doesn't create new differencing media. Also, once
6792	the machine is powered up from the state saved using this method,
6793	the saved state is deleted, so it will be impossible to return
6794	to this state later.
6795
6796	<note>
6797	On success, this method implicitly calls
6798	<link to="IMachine::saveSettings"/> to save all current machine
6799	settings (including runtime changes to the DVD medium, etc.).
6800	Together with the impossibility to change any VM settings when it is
6801	in the Saved state, this guarantees adequate hardware
6802	configuration of the machine when it is restored from the saved
6803	state file.
6804	</note>
6805
6806	<note>
6807	The machine must be in the Running or Paused state, otherwise
6808	the operation will fail.
6809	</note>
6810	<result name="VBOX_E_INVALID_VM_STATE">
6811	Virtual machine state neither Running nor Paused.
6812	</result>
6813	<result name="VBOX_E_FILE_ERROR">
6814	Failed to create directory for saved state file.
6815	</result>
6816
6817	<see><link to="#takeSnapshot"/></see>
6818	</desc>
6819	<param name="progress" type="IProgress" dir="return">
6820	<desc>Progress object to track the operation completion.</desc>
6821	</param>
6822	</method>
6823
6824	<method name="adoptSavedState">
6825	<desc>
6826	Associates the given saved state file to the virtual machine.
6827
6828	On success, the machine will go to the Saved state. Next time it is
6829	powered up, it will be restored from the adopted saved state and
6830	continue execution from the place where the saved state file was
6831	created.
6832
6833	The specified saved state file path may be absolute or relative to the
6834	folder the VM normally saves the state to (usually,
6835	<link to="IMachine::snapshotFolder"/>).
6836
6837	<note>
6838	It's a caller's responsibility to make sure the given saved state
6839	file is compatible with the settings of this virtual machine that
6840	represent its virtual hardware (memory size, storage disk configuration
6841	etc.). If there is a mismatch, the behavior of the virtual machine
6842	is undefined.
6843	</note>
6844	<result name="VBOX_E_INVALID_VM_STATE">
6845	Virtual machine state neither PoweredOff nor Aborted.
6846	</result>
6847	</desc>
6848	<param name="savedStateFile" type="wstring" dir="in">
6849	<desc>Path to the saved state file to adopt.</desc>
6850	</param>
6851	</method>
6852
6853	<method name="discardSavedState">
6854	<desc>
6855	Forcibly resets the machine to "Powered Off" state if it is
6856	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6857	Next time the machine is powered up, a clean boot will occur.
6858	<note>
6859	This operation is equivalent to resetting or powering off
6860	the machine without doing a proper shutdown of the guest
6861	operating system; as with resetting a running phyiscal
6862	computer, it can can lead to data loss.
6863	</note>
6864	If @a fRemoveFile is @c true, the file in the machine directory
6865	into which the machine state was saved is also deleted. If
6866	this is @c false, then the state can be recovered and later
6867	re-inserted into a machine using <link to="#adoptSavedState" />.
6868	The location of the file can be found in the
6869	<link to="IMachine::stateFilePath" /> attribute.
6870	<result name="VBOX_E_INVALID_VM_STATE">
6871	Virtual machine not in state Saved.
6872	</result>
6873	</desc>
6874	<param name="fRemoveFile" type="boolean" dir="in" >
6875	<desc>Whether to also remove the saved state file.</desc>
6876	</param>
6877	</method>
6878
6879	<method name="getDeviceActivity">
6880	<desc>
6881	Gets the current activity type of a given device or device group.
6882	<result name="E_INVALIDARG">
6883	Invalid device type.
6884	</result>
6885	</desc>
6886	<param name="type" type="DeviceType" dir="in"/>
6887	<param name="activity" type="DeviceActivity" dir="return"/>
6888	</method>
6889
6890	<method name="attachUSBDevice">
6891	<desc>
6892	Attaches a host USB device with the given UUID to the
6893	USB controller of the virtual machine.
6894
6895	The device needs to be in one of the following states:
6896	<link to="USBDeviceState_Busy"/>,
6897	<link to="USBDeviceState_Available"/> or
6898	<link to="USBDeviceState_Held"/>,
6899	otherwise an error is immediately returned.
6900
6901	When the device state is
6902	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6903	be returned if the host computer refuses to release it for some reason.
6904
6905	<see><link to="IUSBController::deviceFilters"/>,
6906	<link to="USBDeviceState"/></see>
6907	<result name="VBOX_E_INVALID_VM_STATE">
6908	Virtual machine state neither Running nor Paused.
6909	</result>
6910	<result name="VBOX_E_PDM_ERROR">
6911	Virtual machine does not have a USB controller.
6912	</result>
6913	</desc>
6914	<param name="id" type="uuid" mod="string" dir="in">
6915	<desc>UUID of the host USB device to attach.</desc>
6916	</param>
6917	</method>
6918
6919	<method name="detachUSBDevice">
6920	<desc>
6921	Detaches an USB device with the given UUID from the USB controller
6922	of the virtual machine.
6923
6924	After this method succeeds, the VirtualBox server re-initiates
6925	all USB filters as if the device were just physically attached
6926	to the host, but filters of this machine are ignored to avoid
6927	a possible automatic re-attachment.
6928
6929	<see><link to="IUSBController::deviceFilters"/>,
6930	<link to="USBDeviceState"/></see>
6931
6932	<result name="VBOX_E_PDM_ERROR">
6933	Virtual machine does not have a USB controller.
6934	</result>
6935	<result name="E_INVALIDARG">
6936	USB device not attached to this virtual machine.
6937	</result>
6938	</desc>
6939	<param name="id" type="uuid" mod="string" dir="in">
6940	<desc>UUID of the USB device to detach.</desc>
6941	</param>
6942	<param name="device" type="IUSBDevice" dir="return">
6943	<desc>Detached USB device.</desc>
6944	</param>
6945	</method>
6946
6947	<method name="findUSBDeviceByAddress">
6948	<desc>
6949	Searches for a USB device with the given host address.
6950
6951	<result name="VBOX_E_OBJECT_NOT_FOUND">
6952	Given @c name does not correspond to any USB device.
6953	</result>
6954
6955	<see><link to="IUSBDevice::address"/></see>
6956	</desc>
6957	<param name="name" type="wstring" dir="in">
6958	<desc>
6959	Address of the USB device (as assigned by the host) to
6960	search for.
6961	</desc>
6962	</param>
6963	<param name="device" type="IUSBDevice" dir="return">
6964	<desc>Found USB device object.</desc>
6965	</param>
6966	</method>
6967
6968	<method name="findUSBDeviceById">
6969	<desc>
6970	Searches for a USB device with the given UUID.
6971
6972	<result name="VBOX_E_OBJECT_NOT_FOUND">
6973	Given @c id does not correspond to any USB device.
6974	</result>
6975
6976	<see><link to="IUSBDevice::id"/></see>
6977	</desc>
6978	<param name="id" type="uuid" mod="string" dir="in">
6979	<desc>UUID of the USB device to search for.</desc>
6980	</param>
6981	<param name="device" type="IUSBDevice" dir="return">
6982	<desc>Found USB device object.</desc>
6983	</param>
6984	</method>
6985
6986	<method name="createSharedFolder">
6987	<desc>
6988	Creates a transient new shared folder by associating the given logical
6989	name with the given host path, adds it to the collection of shared
6990	folders and starts sharing it. Refer to the description of
6991	<link to="ISharedFolder"/> to read more about logical names.
6992
6993	<result name="VBOX_E_INVALID_VM_STATE">
6994	Virtual machine in Saved state or currently changing state.
6995	</result>
6996	<result name="VBOX_E_FILE_ERROR">
6997	Shared folder already exists or not accessible.
6998	</result>
6999	</desc>
7000	<param name="name" type="wstring" dir="in">
7001	<desc>Unique logical name of the shared folder.</desc>
7002	</param>
7003	<param name="hostPath" type="wstring" dir="in">
7004	<desc>Full path to the shared folder in the host file system.</desc>
7005	</param>
7006	<param name="writable" type="boolean" dir="in">
7007	<desc>Whether the share is writable or readonly</desc>
7008	</param>
7009	<param name="automount" type="boolean" dir="in">
7010	<desc>Whether the share gets automatically mounted by the guest
7011	or not.</desc>
7012	</param>
7013	</method>
7014
7015	<method name="removeSharedFolder">
7016	<desc>
7017	Removes a transient shared folder with the given name previously
7018	created by <link to="#createSharedFolder"/> from the collection of
7019	shared folders and stops sharing it.
7020	<result name="VBOX_E_INVALID_VM_STATE">
7021	Virtual machine in Saved state or currently changing state.
7022	</result>
7023	<result name="VBOX_E_FILE_ERROR">
7024	Shared folder does not exists.
7025	</result>
7026	</desc>
7027	<param name="name" type="wstring" dir="in">
7028	<desc>Logical name of the shared folder to remove.</desc>
7029	</param>
7030	</method>
7031
7032	<method name="takeSnapshot">
7033	<desc>
7034	Saves the current execution state
7035	and all settings of the machine and creates differencing images
7036	for all normal (non-independent) media.
7037	See <link to="ISnapshot" /> for an introduction to snapshots.
7038
7039	This method can be called for a PoweredOff, Saved (see
7040	<link to="#saveState"/>), Running or
7041	Paused virtual machine. When the machine is PoweredOff, an
7042	offline snapshot is created. When the machine is Running a live
7043	snapshot is created, and an online snapshot is is created when Paused.
7044
7045	The taken snapshot is always based on the
7046	<link to="IMachine::currentSnapshot">current snapshot</link>
7047	of the associated virtual machine and becomes a new current snapshot.
7048
7049	<note>
7050	This method implicitly calls <link to="IMachine::saveSettings"/> to
7051	save all current machine settings before taking an offline snapshot.
7052	</note>
7053
7054	<result name="VBOX_E_INVALID_VM_STATE">
7055	Virtual machine currently changing state.
7056	</result>
7057	</desc>
7058	<param name="name" type="wstring" dir="in">
7059	<desc>Short name for the snapshot.</desc>
7060	</param>
7061	<param name="description" type="wstring" dir="in">
7062	<desc>Optional description of the snapshot.</desc>
7063	</param>
7064	<param name="progress" type="IProgress" dir="return">
7065	<desc>Progress object to track the operation completion.</desc>
7066	</param>
7067	</method>
7068
7069	<method name="deleteSnapshot">
7070	<desc>
7071	Starts deleting the specified snapshot asynchronously.
7072	See <link to="ISnapshot" /> for an introduction to snapshots.
7073
7074	The execution state and settings of the associated machine stored in
7075	the snapshot will be deleted. The contents of all differencing media of
7076	this snapshot will be merged with the contents of their dependent child
7077	media to keep the medium chain valid (in other words, all changes
7078	represented by media being deleted will be propagated to their child
7079	medium). After that, this snapshot's differencing medium will be
7080	deleted. The parent of this snapshot will become a new parent for all
7081	its child snapshots.
7082
7083	If the deleted snapshot is the current one, its parent snapshot will
7084	become a new current snapshot. The current machine state is not directly
7085	affected in this case, except that currently attached differencing
7086	media based on media of the deleted snapshot will be also merged as
7087	described above.
7088
7089	If the deleted snapshot is the first or current snapshot, then the
7090	respective IMachine attributes will be adjusted. Deleting the current
7091	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7092	to make all current machine settings permanent.
7093
7094	Deleting a snapshot has the following preconditions:
7095
7096	<ul>
7097	<li>Child media of all normal media of the deleted snapshot
7098	must be accessible (see <link to="IMedium::state"/>) for this
7099	operation to succeed. If only one running VM refers to all images
7100	which participates in merging the operation can be performed while
7101	the VM is running. Otherwise all virtual machines whose media are
7102	directly or indirectly based on the media of deleted snapshot must
7103	be powered off. In any case, online snapshot deleting usually is
7104	slower than the same operation without any running VM.</li>
7105
7106	<li>You cannot delete the snapshot if a medium attached to it has
7107	more than one child medium (differencing images) because otherwise
7108	merging would be impossible. This might be the case if there is
7109	more than one child snapshot or differencing images were created
7110	for other reason (e.g. implicitly because of multiple machine
7111	attachments).</li>
7112	</ul>
7113
7114	The virtual machine's <link to="IMachine::state">state</link> is
7115	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
7116	"DeletingSnapshotPaused" while this operation is in progress.
7117
7118	<note>
7119	Merging medium contents can be very time and disk space
7120	consuming, if these media are big in size and have many
7121	children. However, if the snapshot being deleted is the last
7122	(head) snapshot on the branch, the operation will be rather
7123	quick.
7124	</note>
7125	<result name="VBOX_E_INVALID_VM_STATE">
7126	The running virtual machine prevents deleting this snapshot. This
7127	happens only in very specific situations, usually snapshots can be
7128	deleted without trouble while a VM is running. The error message
7129	text explains the reason for the failure.
7130	</result>
7131	</desc>
7132	<param name="id" type="uuid" mod="string" dir="in">
7133	<desc>UUID of the snapshot to delete.</desc>
7134	</param>
7135	<param name="progress" type="IProgress" dir="return">
7136	<desc>Progress object to track the operation completion.</desc>
7137	</param>
7138	</method>
7139
7140	<method name="deleteSnapshotAndAllChildren">
7141	<desc>
7142	Starts deleting the specified snapshot and all its children
7143	asynchronously. See <link to="ISnapshot" /> for an introduction to
7144	snapshots. The conditions and many details are the same as with
7145	<link to="#deleteSnapshot"/>.
7146
7147	This operation is very fast if the snapshot subtree does not include
7148	the current state. It is still significantly faster than deleting the
7149	snapshots one by one if the current state is in the subtree and there
7150	are more than one snapshots from current state to the snapshot which
7151	marks the subtree, since it eliminates the incremental image merging.
7152
7153	<note>This API method is right now not implemented!</note>
7154
7155	<result name="VBOX_E_INVALID_VM_STATE">
7156	The running virtual machine prevents deleting this snapshot. This
7157	happens only in very specific situations, usually snapshots can be
7158	deleted without trouble while a VM is running. The error message
7159	text explains the reason for the failure.
7160	</result>
7161	<result name="E_NOTIMPL">
7162	The method is not implemented yet.
7163	</result>
7164	</desc>
7165	<param name="id" type="uuid" mod="string" dir="in">
7166	<desc>UUID of the snapshot to delete, including all its children.</desc>
7167	</param>
7168	<param name="progress" type="IProgress" dir="return">
7169	<desc>Progress object to track the operation completion.</desc>
7170	</param>
7171	</method>
7172
7173	<method name="deleteSnapshotRange">
7174	<desc>
7175	Starts deleting the specified snapshot range. This is limited to
7176	linear snapshot lists, which means there may not be any other child
7177	snapshots other than the direct sequence between the start and end
7178	snapshot. If the start and end snapshot point to the same snapshot this
7179	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7180	<link to="ISnapshot" /> for an introduction to snapshots. The
7181	conditions and many details are the same as with
7182	<link to="#deleteSnapshot"/>.
7183
7184	This operation is generally faster than deleting snapshots one by one
7185	and often also needs less extra disk space before freeing up disk space
7186	by deleting the removed disk images corresponding to the snapshot.
7187
7188	<note>This API method is right now not implemented!</note>
7189
7190	<result name="VBOX_E_INVALID_VM_STATE">
7191	The running virtual machine prevents deleting this snapshot. This
7192	happens only in very specific situations, usually snapshots can be
7193	deleted without trouble while a VM is running. The error message
7194	text explains the reason for the failure.
7195	</result>
7196	<result name="E_NOTIMPL">
7197	The method is not implemented yet.
7198	</result>
7199	</desc>
7200	<param name="startId" type="uuid" mod="string" dir="in">
7201	<desc>UUID of the first snapshot to delete.</desc>
7202	</param>
7203	<param name="endId" type="uuid" mod="string" dir="in">
7204	<desc>UUID of the last snapshot to delete.</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="restoreSnapshot">
7212	<desc>
7213	Starts resetting the machine's current state to the state contained
7214	in the given snapshot, asynchronously. All current settings of the
7215	machine will be reset and changes stored in differencing media
7216	will be lost.
7217	See <link to="ISnapshot" /> for an introduction to snapshots.
7218
7219	After this operation is successfully completed, new empty differencing
7220	media are created for all normal media of the machine.
7221
7222	If the given snapshot is an online snapshot, the machine will go to
7223	the <link to="MachineState_Saved"> saved state</link>, so that the
7224	next time it is powered on, the execution state will be restored
7225	from the state of the snapshot.
7226
7227	<note>
7228	The machine must not be running, otherwise the operation will fail.
7229	</note>
7230
7231	<note>
7232	If the machine state is <link to="MachineState_Saved">Saved</link>
7233	prior to this operation, the saved state file will be implicitly
7234	deleted (as if <link to="IConsole::discardSavedState"/> were
7235	called).
7236	</note>
7237
7238	<result name="VBOX_E_INVALID_VM_STATE">
7239	Virtual machine is running.
7240	</result>
7241	</desc>
7242	<param name="snapshot" type="ISnapshot" dir="in">
7243	<desc>The snapshot to restore the VM state from.</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	<method name="teleport">
7251	<desc>
7252	Teleport the VM to a different host machine or process.
7253
7254	TODO explain the details.
7255
7256	<result name="VBOX_E_INVALID_VM_STATE">
7257	Virtual machine not running or paused.
7258	</result>
7259	</desc>
7260	<param name="hostname" type="wstring" dir="in">
7261	<desc>The name or IP of the host to teleport to.</desc>
7262	</param>
7263	<param name="tcpport" type="unsigned long" dir="in">
7264	<desc>The TCP port to connect to (1..65535).</desc>
7265	</param>
7266	<param name="password" type="wstring" dir="in">
7267	<desc>The password.</desc>
7268	</param>
7269	<param name="maxDowntime" type="unsigned long" dir="in">
7270	<desc>
7271	The maximum allowed downtime given as milliseconds. 0 is not a valid
7272	value. Recommended value: 250 ms.
7273
7274	The higher the value is, the greater the chance for a successful
7275	teleportation. A small value may easily result in the teleportation
7276	process taking hours and eventually fail.
7277
7278	<note>
7279	The current implementation treats this a guideline, not as an
7280	absolute rule.
7281	</note>
7282	</desc>
7283	</param>
7284	<param name="progress" type="IProgress" dir="return">
7285	<desc>Progress object to track the operation completion.</desc>
7286	</param>
7287	</method>
7288
7289	</interface>
7290
7291	<!--
7292	// IHost
7293	/////////////////////////////////////////////////////////////////////////
7294	-->
7295
7296	<enum
7297	name="HostNetworkInterfaceMediumType"
7298	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7299	>
7300	<desc>
7301	Type of encapsulation. Ethernet encapsulation includes both wired and
7302	wireless Ethernet connections.
7303	<see><link to="IHostNetworkInterface"/></see>
7304	</desc>
7305
7306	<const name="Unknown" value="0">
7307	<desc>
7308	The type of interface cannot be determined.
7309	</desc>
7310	</const>
7311	<const name="Ethernet" value="1">
7312	<desc>
7313	Ethernet frame encapsulation.
7314	</desc>
7315	</const>
7316	<const name="PPP" value="2">
7317	<desc>
7318	Point-to-point protocol encapsulation.
7319	</desc>
7320	</const>
7321	<const name="SLIP" value="3">
7322	<desc>
7323	Serial line IP encapsulation.
7324	</desc>
7325	</const>
7326	</enum>
7327
7328	<enum
7329	name="HostNetworkInterfaceStatus"
7330	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7331	>
7332	<desc>
7333	Current status of the interface.
7334	<see><link to="IHostNetworkInterface"/></see>
7335	</desc>
7336
7337	<const name="Unknown" value="0">
7338	<desc>
7339	The state of interface cannot be determined.
7340	</desc>
7341	</const>
7342	<const name="Up" value="1">
7343	<desc>
7344	The interface is fully operational.
7345	</desc>
7346	</const>
7347	<const name="Down" value="2">
7348	<desc>
7349	The interface is not functioning.
7350	</desc>
7351	</const>
7352	</enum>
7353
7354	<enum
7355	name="HostNetworkInterfaceType"
7356	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7357	>
7358	<desc>
7359	Network interface type.
7360	</desc>
7361	<const name="Bridged" value="1"/>
7362	<const name="HostOnly" value="2"/>
7363	</enum>
7364
7365	<interface
7366	name="IHostNetworkInterface" extends="$unknown"
7367	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7368	wsmap="managed"
7369	>
7370	<desc>
7371	Represents one of host's network interfaces. IP V6 address and network
7372	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7373	separated by colons.
7374	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7375	</desc>
7376	<attribute name="name" type="wstring" readonly="yes">
7377	<desc>Returns the host network interface name.</desc>
7378	</attribute>
7379
7380	<attribute name="id" type="uuid" mod="string" readonly="yes">
7381	<desc>Returns the interface UUID.</desc>
7382	</attribute>
7383
7384	<attribute name="networkName" type="wstring" readonly="yes">
7385	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7386	</attribute>
7387
7388	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7389	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7390	</attribute>
7391
7392	<attribute name="IPAddress" type="wstring" readonly="yes">
7393	<desc>Returns the IP V4 address of the interface.</desc>
7394	</attribute>
7395
7396	<attribute name="networkMask" type="wstring" readonly="yes">
7397	<desc>Returns the network mask of the interface.</desc>
7398	</attribute>
7399
7400	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7401	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7402	</attribute>
7403
7404	<attribute name="IPV6Address" type="wstring" readonly="yes">
7405	<desc>Returns the IP V6 address of the interface.</desc>
7406	</attribute>
7407
7408	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7409	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7410	</attribute>
7411
7412	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7413	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7414	</attribute>
7415
7416	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7417	<desc>Type of protocol encapsulation used.</desc>
7418	</attribute>
7419
7420	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7421	<desc>Status of the interface.</desc>
7422	</attribute>
7423
7424	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7425	<desc>specifies the host interface type.</desc>
7426	</attribute>
7427
7428	<method name="enableStaticIpConfig">
7429	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7430	<param name="IPAddress" type="wstring" dir="in">
7431	<desc>
7432	IP address.
7433	</desc>
7434	</param>
7435	<param name="networkMask" type="wstring" dir="in">
7436	<desc>
7437	network mask.
7438	</desc>
7439	</param>
7440	</method>
7441
7442	<method name="enableStaticIpConfigV6">
7443	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7444	<param name="IPV6Address" type="wstring" dir="in">
7445	<desc>
7446	IP address.
7447	</desc>
7448	</param>
7449	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7450	<desc>
7451	network mask.
7452	</desc>
7453	</param>
7454	</method>
7455
7456	<method name="enableDynamicIpConfig">
7457	<desc>enables the dynamic IP configuration.</desc>
7458	</method>
7459
7460	<method name="dhcpRediscover">
7461	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7462	</method>
7463
7464	</interface>
7465
7466	<interface
7467	name="IHost" extends="$unknown"
7468	uuid="dab4a2b8-c735-4f08-94fc-9bec84182e2f"
7469	wsmap="managed"
7470	>
7471	<desc>
7472	The IHost interface represents the physical machine that this VirtualBox
7473	installation runs on.
7474
7475	An object implementing this interface is returned by the
7476	<link to="IVirtualBox::host" /> attribute. This interface contains
7477	read-only information about the host's physical hardware (such as what
7478	processors and disks are available, what the host operating system is,
7479	and so on) and also allows for manipulating some of the host's hardware,
7480	such as global USB device filters and host interface networking.
7481
7482	</desc>
7483	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7484	<desc>List of DVD drives available on the host.</desc>
7485	</attribute>
7486
7487	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7488	<desc>List of floppy drives available on the host.</desc>
7489	</attribute>
7490
7491	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7492	<desc>
7493	List of USB devices currently attached to the host.
7494	Once a new device is physically attached to the host computer,
7495	it appears in this list and remains there until detached.
7496
7497	<note>
7498	If USB functionality is not available in the given edition of
7499	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7500	</note>
7501	</desc>
7502	</attribute>
7503
7504	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7505	<desc>
7506	List of USB device filters in action.
7507	When a new device is physically attached to the host computer,
7508	filters from this list are applied to it (in order they are stored
7509	in the list). The first matched filter will determine the
7510	<link to="IHostUSBDeviceFilter::action">action</link>
7511	performed on the device.
7512
7513	Unless the device is ignored by these filters, filters of all
7514	currently running virtual machines
7515	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7516
7517	<note>
7518	If USB functionality is not available in the given edition of
7519	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7520	</note>
7521
7522	<see><link to="IHostUSBDeviceFilter"/>,
7523	<link to="USBDeviceState"/></see>
7524	</desc>
7525	</attribute>
7526
7527	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7528	<desc>List of host network interfaces currently defined on the host.</desc>
7529	</attribute>
7530
7531	<attribute name="processorCount" type="unsigned long" readonly="yes">
7532	<desc>Number of (logical) CPUs installed in the host system.</desc>
7533	</attribute>
7534
7535	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7536	<desc>Number of (logical) CPUs online in the host system.</desc>
7537	</attribute>
7538
7539	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7540	<desc>Number of physical processor cores installed in the host system.</desc>
7541	</attribute>
7542
7543	<method name="getProcessorSpeed">
7544	<desc>Query the (approximate) maximum speed of a specified host CPU in
7545	Megahertz.
7546	</desc>
7547	<param name="cpuId" type="unsigned long" dir="in">
7548	<desc>
7549	Identifier of the CPU.
7550	</desc>
7551	</param>
7552	<param name="speed" type="unsigned long" dir="return">
7553	<desc>
7554	Speed value. 0 is returned if value is not known or @a cpuId is
7555	invalid.
7556	</desc>
7557	</param>
7558	</method>
7559
7560	<method name="getProcessorFeature">
7561	<desc>Query whether a CPU feature is supported or not.</desc>
7562	<param name="feature" type="ProcessorFeature" dir="in">
7563	<desc>
7564	CPU Feature identifier.
7565	</desc>
7566	</param>
7567	<param name="supported" type="boolean" dir="return">
7568	<desc>
7569	Feature is supported or not.
7570	</desc>
7571	</param>
7572	</method>
7573
7574	<method name="getProcessorDescription">
7575	<desc>Query the model string of a specified host CPU.
7576	</desc>
7577	<param name="cpuId" type="unsigned long" dir="in">
7578	<desc>
7579	Identifier of the CPU.
7580	<note>
7581	The current implementation might not necessarily return the
7582	description for this exact CPU.
7583	</note>
7584	</desc>
7585	</param>
7586	<param name="description" type="wstring" dir="return">
7587	<desc>
7588	Model string. An empty string is returned if value is not known or
7589	@a cpuId is invalid.
7590	</desc>
7591	</param>
7592	</method>
7593
7594	<method name="getProcessorCPUIDLeaf">
7595	<desc>
7596	Returns the CPU cpuid information for the specified leaf.
7597	</desc>
7598	<param name="cpuId" type="unsigned long" dir="in">
7599	<desc>
7600	Identifier of the CPU. The CPU most be online.
7601	<note>
7602	The current implementation might not necessarily return the
7603	description for this exact CPU.
7604	</note>
7605	</desc>
7606	</param>
7607	<param name="leaf" type="unsigned long" dir="in">
7608	<desc>
7609	CPUID leaf index (eax).
7610	</desc>
7611	</param>
7612	<param name="subLeaf" type="unsigned long" dir="in">
7613	<desc>
7614	CPUID leaf sub index (ecx). This currently only applies to cache
7615	information on Intel CPUs. Use 0 if retrieving values for
7616	<link to="IMachine::setCPUIDLeaf"/>.
7617	</desc>
7618	</param>
7619	<param name="valEax" type="unsigned long" dir="out">
7620	<desc>
7621	CPUID leaf value for register eax.
7622	</desc>
7623	</param>
7624	<param name="valEbx" type="unsigned long" dir="out">
7625	<desc>
7626	CPUID leaf value for register ebx.
7627	</desc>
7628	</param>
7629	<param name="valEcx" type="unsigned long" dir="out">
7630	<desc>
7631	CPUID leaf value for register ecx.
7632	</desc>
7633	</param>
7634	<param name="valEdx" type="unsigned long" dir="out">
7635	<desc>
7636	CPUID leaf value for register edx.
7637	</desc>
7638	</param>
7639	</method>
7640
7641	<attribute name="memorySize" type="unsigned long" readonly="yes">
7642	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7643	</attribute>
7644
7645	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7646	<desc>Available system memory in the host system.</desc>
7647	</attribute>
7648
7649	<attribute name="operatingSystem" type="wstring" readonly="yes">
7650	<desc>Name of the host system's operating system.</desc>
7651	</attribute>
7652
7653	<attribute name="OSVersion" type="wstring" readonly="yes">
7654	<desc>Host operating system's version string.</desc>
7655	</attribute>
7656
7657	<attribute name="UTCTime" type="long long" readonly="yes">
7658	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7659	</attribute>
7660
7661	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7662	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7663	</attribute>
7664
7665	<method name="createHostOnlyNetworkInterface">
7666	<desc>
7667	Creates a new adapter for Host Only Networking.
7668	<result name="E_INVALIDARG">
7669	Host network interface @a name already exists.
7670	</result>
7671	</desc>
7672	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7673	<desc>
7674	Created host interface object.
7675	</desc>
7676	</param>
7677	<param name="progress" type="IProgress" dir="return">
7678	<desc>
7679	Progress object to track the operation completion.
7680	</desc>
7681	</param>
7682	</method>
7683
7684	<method name="removeHostOnlyNetworkInterface">
7685	<desc>
7686	Removes the given Host Only Networking interface.
7687	<result name="VBOX_E_OBJECT_NOT_FOUND">
7688	No host network interface matching @a id found.
7689	</result>
7690	</desc>
7691	<param name="id" type="uuid" mod="string" dir="in">
7692	<desc>
7693	Adapter GUID.
7694	</desc>
7695	</param>
7696	<param name="progress" type="IProgress" dir="return">
7697	<desc>
7698	Progress object to track the operation completion.
7699	</desc>
7700	</param>
7701	</method>
7702
7703	<method name="createUSBDeviceFilter">
7704	<desc>
7705	Creates a new USB device filter. All attributes except
7706	the filter name are set to empty (any match),
7707	<i>active</i> is @c false (the filter is not active).
7708
7709	The created filter can be added to the list of filters using
7710	<link to="#insertUSBDeviceFilter"/>.
7711
7712	<see><link to="#USBDeviceFilters"/></see>
7713	</desc>
7714	<param name="name" type="wstring" dir="in">
7715	<desc>
7716	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7717	</desc>
7718	</param>
7719	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7720	<desc>Created filter object.</desc>
7721	</param>
7722	</method>
7723
7724	<method name="insertUSBDeviceFilter">
7725	<desc>
7726	Inserts the given USB device to the specified position
7727	in the list of filters.
7728
7729	Positions are numbered starting from @c 0. If the specified
7730	position is equal to or greater than the number of elements in
7731	the list, the filter is added at the end of the collection.
7732
7733	<note>
7734	Duplicates are not allowed, so an attempt to insert a
7735	filter already in the list is an error.
7736	</note>
7737	<note>
7738	If USB functionality is not available in the given edition of
7739	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7740	</note>
7741
7742	<see><link to="#USBDeviceFilters"/></see>
7743
7744	<result name="VBOX_E_INVALID_OBJECT_STATE">
7745	USB device filter is not created within this VirtualBox instance.
7746	</result>
7747	<result name="E_INVALIDARG">
7748	USB device filter already in list.
7749	</result>
7750
7751	</desc>
7752	<param name="position" type="unsigned long" dir="in">
7753	<desc>Position to insert the filter to.</desc>
7754	</param>
7755	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7756	<desc>USB device filter to insert.</desc>
7757	</param>
7758	</method>
7759
7760	<method name="removeUSBDeviceFilter">
7761	<desc>
7762	Removes a USB device filter from the specified position in the
7763	list of filters.
7764
7765	Positions are numbered starting from @c 0. Specifying a
7766	position equal to or greater than the number of elements in
7767	the list will produce an error.
7768
7769	<note>
7770	If USB functionality is not available in the given edition of
7771	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7772	</note>
7773
7774	<see><link to="#USBDeviceFilters"/></see>
7775
7776	<result name="E_INVALIDARG">
7777	USB device filter list empty or invalid @a position.
7778	</result>
7779
7780	</desc>
7781	<param name="position" type="unsigned long" dir="in">
7782	<desc>Position to remove the filter from.</desc>
7783	</param>
7784	</method>
7785
7786	<method name="findHostDVDDrive">
7787	<desc>
7788	Searches for a host DVD drive with the given @c name.
7789
7790	<result name="VBOX_E_OBJECT_NOT_FOUND">
7791	Given @c name does not correspond to any host drive.
7792	</result>
7793
7794	</desc>
7795	<param name="name" type="wstring" dir="in">
7796	<desc>Name of the host drive to search for</desc>
7797	</param>
7798	<param name="drive" type="IMedium" dir="return">
7799	<desc>Found host drive object</desc>
7800	</param>
7801	</method>
7802
7803	<method name="findHostFloppyDrive">
7804	<desc>
7805	Searches for a host floppy drive with the given @c name.
7806
7807	<result name="VBOX_E_OBJECT_NOT_FOUND">
7808	Given @c name does not correspond to any host floppy drive.
7809	</result>
7810
7811	</desc>
7812	<param name="name" type="wstring" dir="in">
7813	<desc>Name of the host floppy drive to search for</desc>
7814	</param>
7815	<param name="drive" type="IMedium" dir="return">
7816	<desc>Found host floppy drive object</desc>
7817	</param>
7818	</method>
7819
7820	<method name="findHostNetworkInterfaceByName">
7821	<desc>
7822	Searches through all host network interfaces for an interface with
7823	the given @c name.
7824	<note>
7825	The method returns an error if the given @c name does not
7826	correspond to any host network interface.
7827	</note>
7828	</desc>
7829	<param name="name" type="wstring" dir="in">
7830	<desc>Name of the host network interface to search for.</desc>
7831	</param>
7832	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7833	<desc>Found host network interface object.</desc>
7834	</param>
7835	</method>
7836	<method name="findHostNetworkInterfaceById">
7837	<desc>
7838	Searches through all host network interfaces for an interface with
7839	the given GUID.
7840	<note>
7841	The method returns an error if the given GUID does not
7842	correspond to any host network interface.
7843	</note>
7844	</desc>
7845	<param name="id" type="uuid" mod="string" dir="in">
7846	<desc>GUID of the host network interface to search for.</desc>
7847	</param>
7848	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7849	<desc>Found host network interface object.</desc>
7850	</param>
7851	</method>
7852	<method name="findHostNetworkInterfacesOfType">
7853	<desc>
7854	Searches through all host network interfaces and returns a list of interfaces of the specified type
7855	</desc>
7856	<param name="type" type="HostNetworkInterfaceType" dir="in">
7857	<desc>type of the host network interfaces to search for.</desc>
7858	</param>
7859	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7860	<desc>Found host network interface objects.</desc>
7861	</param>
7862	</method>
7863
7864	<method name="findUSBDeviceById">
7865	<desc>
7866	Searches for a USB device with the given UUID.
7867
7868	<result name="VBOX_E_OBJECT_NOT_FOUND">
7869	Given @c id does not correspond to any USB device.
7870	</result>
7871
7872	<see><link to="IUSBDevice::id"/></see>
7873	</desc>
7874	<param name="id" type="uuid" mod="string" dir="in">
7875	<desc>UUID of the USB device to search for.</desc>
7876	</param>
7877	<param name="device" type="IHostUSBDevice" dir="return">
7878	<desc>Found USB device object.</desc>
7879	</param>
7880	</method>
7881
7882	<method name="findUSBDeviceByAddress">
7883	<desc>
7884	Searches for a USB device with the given host address.
7885
7886	<result name="VBOX_E_OBJECT_NOT_FOUND">
7887	Given @c name does not correspond to any USB device.
7888	</result>
7889
7890	<see><link to="IUSBDevice::address"/></see>
7891	</desc>
7892	<param name="name" type="wstring" dir="in">
7893	<desc>
7894	Address of the USB device (as assigned by the host) to
7895	search for.
7896	</desc>
7897	</param>
7898	<param name="device" type="IHostUSBDevice" dir="return">
7899	<desc>Found USB device object.</desc>
7900	</param>
7901	</method>
7902
7903	<method name="generateMACAddress">
7904	<desc>
7905	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
7906	</desc>
7907	<param name="address" type="wstring" dir="return">
7908	<desc>New Ethernet MAC address.</desc>
7909	</param>
7910	</method>
7911
7912	</interface>
7913
7914	<!--
7915	// ISystemProperties
7916	/////////////////////////////////////////////////////////////////////////
7917	-->
7918
7919	<interface
7920	name="ISystemProperties"
7921	extends="$unknown"
7922	uuid="8a0ab9ab-48c1-4d04-954b-4a751413d084"
7923	wsmap="managed"
7924	>
7925	<desc>
7926	The ISystemProperties interface represents global properties of the given
7927	VirtualBox installation.
7928
7929	These properties define limits and default values for various attributes
7930	and parameters. Most of the properties are read-only, but some can be
7931	changed by a user.
7932	</desc>
7933
7934	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7935	<desc>Minimum guest system memory in Megabytes.</desc>
7936	</attribute>
7937
7938	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7939	<desc>Maximum guest system memory in Megabytes.</desc>
7940	</attribute>
7941
7942	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7943	<desc>Minimum guest video memory in Megabytes.</desc>
7944	</attribute>
7945
7946	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7947	<desc>Maximum guest video memory in Megabytes.</desc>
7948	</attribute>
7949
7950	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7951	<desc>Minimum CPU count.</desc>
7952	</attribute>
7953
7954	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7955	<desc>Maximum CPU count.</desc>
7956	</attribute>
7957
7958	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7959	<desc>Maximum of monitors which could be connected.</desc>
7960	</attribute>
7961
7962	<attribute name="infoVDSize" type="long long" readonly="yes">
7963	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7964	does not reflect the limits of any virtual disk image format.</desc>
7965	</attribute>
7966
7967	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7968	<desc>
7969	Maximum number of serial ports associated with every
7970	<link to="IMachine"/> instance.
7971	</desc>
7972	</attribute>
7973
7974	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7975	<desc>
7976	Maximum number of parallel ports associated with every
7977	<link to="IMachine"/> instance.
7978	</desc>
7979	</attribute>
7980
7981	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7982	<desc>
7983	Maximum device position in the boot order. This value corresponds
7984	to the total number of devices a machine can boot from, to make it
7985	possible to include all possible devices to the boot list.
7986	<see><link to="IMachine::setBootOrder"/></see>
7987	</desc>
7988	</attribute>
7989
7990	<attribute name="defaultMachineFolder" type="wstring">
7991	<desc>
7992	Full path to the default directory used to create new or open
7993	existing machines when a machine settings file name contains no
7994	path.
7995
7996	Starting with VirtualBox 4.0, by default, this attribute contains
7997	the full path of folder named "VirtualBox VMs" in the user's
7998	home directory, which depends on the host platform.
7999
8000	When setting this attribute, a full path must be specified.
8001	Setting this property to @c null or an empty string or the
8002	special value "Machines" (for compatibility reasons) will restore
8003	that default value.
8004
8005	If the folder specified herein does not exist, it will be created
8006	automatically as needed.
8007
8008	<see>
8009	<link to="IVirtualBox::createMachine"/>,
8010	<link to="IVirtualBox::openMachine"/>
8011	</see>
8012	</desc>
8013	</attribute>
8014
8015	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
8016	<desc>
8017	List of all medium storage formats supported by this VirtualBox
8018	installation.
8019
8020	Keep in mind that the medium format identifier
8021	(<link to="IMediumFormat::id"/>) used in other API calls like
8022	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
8023	medium format is a case-insensitive string. This means that, for
8024	example, all of the following strings:
8025	<pre>
8026	"VDI"
8027	"vdi"
8028	"VdI"</pre>
8029	refer to the same medium format.
8030
8031	Note that the virtual medium framework is backend-based, therefore
8032	the list of supported formats depends on what backends are currently
8033	installed.
8034
8035	<see><link to="IMediumFormat"/></see>
8036	</desc>
8037	</attribute>
8038
8039	<attribute name="defaultHardDiskFormat" type="wstring">
8040	<desc>
8041	Identifier of the default medium format used by VirtualBox.
8042
8043	The medium format set by this attribute is used by VirtualBox
8044	when the medium format was not specified explicitly. One example is
8045	<link to="IVirtualBox::createHardDisk"/> with the empty
8046	format argument. A more complex example is implicit creation of
8047	differencing media when taking a snapshot of a virtual machine:
8048	this operation will try to use a format of the parent medium first
8049	and if this format does not support differencing media the default
8050	format specified by this argument will be used.
8051
8052	The list of supported medium formats may be obtained by the
8053	<link to="#mediumFormats"/> call. Note that the default medium
8054	format must have a capability to create differencing media;
8055	otherwise operations that create media implicitly may fail
8056	unexpectedly.
8057
8058	The initial value of this property is <tt>"VDI"</tt> in the current
8059	version of the VirtualBox product, but may change in the future.
8060
8061	<note>
8062	Setting this property to @c null or empty string will restore the
8063	initial value.
8064	</note>
8065
8066	<see>
8067	<link to="#mediumFormats"/>,
8068	<link to="IMediumFormat::id"/>,
8069	<link to="IVirtualBox::createHardDisk"/>
8070	</see>
8071	</desc>
8072	</attribute>
8073
8074	<attribute name="freeDiskSpaceWarning" type="long long">
8075	<desc>Issue a warning if the free disk space is below (or in some disk
8076	intensive operation is expected to go below) the given size in
8077	bytes.</desc>
8078	</attribute>
8079
8080	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8081	<desc>Issue a warning if the free disk space is below (or in some disk
8082	intensive operation is expected to go below) the given percentage.</desc>
8083	</attribute>
8084
8085	<attribute name="freeDiskSpaceError" type="long long">
8086	<desc>Issue an error if the free disk space is below (or in some disk
8087	intensive operation is expected to go below) the given size in
8088	bytes.</desc>
8089	</attribute>
8090
8091	<attribute name="freeDiskSpacePercentError" type="unsigned long">
8092	<desc>Issue an error if the free disk space is below (or in some disk
8093	intensive operation is expected to go below) the given percentage.</desc>
8094	</attribute>
8095
8096	<attribute name="VRDEAuthLibrary" type="wstring">
8097	<desc>
8098	Library that provides authentication for Remote Desktop clients. The library
8099	is used if a virtual machine's authentication type is set to "external"
8100	in the VM RemoteDisplay configuration.
8101
8102	The system library extension (".DLL" or ".so") must be omitted.
8103	A full path can be specified; if not, then the library must reside on the
8104	system's default library path.
8105
8106	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
8107	of that name in one of the default VirtualBox library directories.
8108
8109	For details about VirtualBox authentication libraries and how to implement
8110	them, please refer to the VirtualBox manual.
8111
8112	<note>
8113	Setting this property to @c null or empty string will restore the
8114	initial value.
8115	</note>
8116	</desc>
8117	</attribute>
8118
8119	<attribute name="webServiceAuthLibrary" type="wstring">
8120	<desc>
8121	Library that provides authentication for webservice clients. The library
8122	is used if a virtual machine's authentication type is set to "external"
8123	in the VM RemoteDisplay configuration and will be called from
8124	within the <link to="IWebsessionManager::logon" /> implementation.
8125
8126	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
8127	there is no per-VM setting for this, as the webservice is a global
8128	resource (if it is running). Only for this setting (for the webservice),
8129	setting this value to a literal <tt>"null"</tt> string disables authentication,
8130	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8131	no matter what user name and password are supplied.
8132
8133	The initial value of this property is <tt>"VBoxAuth"</tt>,
8134	meaning that the webservice will use the same authentication
8135	library that is used by default for VRDE (again, see
8136	<link to="ISystemProperties::VRDEAuthLibrary" />).
8137	The format and calling convention of authentication libraries
8138	is the same for the webservice as it is for VRDE.
8139
8140	<note>
8141	Setting this property to @c null or empty string will restore the
8142	initial value.
8143	</note>
8144	</desc>
8145	</attribute>
8146
8147	<attribute name="defaultVRDEExtPack" type="wstring">
8148	<desc>
8149	The name of the extension pack providing the default VRDE.
8150
8151	This attribute is for choosing between multiple extension packs
8152	providing VRDE. If only one is installed, it will automatically be the
8153	default one. The attribute value can be empty if no VRDE extension
8154	pack is installed.
8155
8156	For details about VirtualBox Remote Desktop Extension and how to
8157	implement one, please refer to the VirtualBox SDK.
8158	</desc>
8159	</attribute>
8160
8161	<attribute name="logHistoryCount" type="unsigned long">
8162	<desc>
8163	This value specifies how many old release log files are kept.
8164	</desc>
8165	</attribute>
8166
8167	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8168	<desc>This value hold the default audio driver for the current
8169	system.</desc>
8170	</attribute>
8171
8172
8173	<method name="getMaxNetworkAdapters">
8174	<desc>
8175	Maximum total number of network adapters associated with every
8176	<link to="IMachine"/> instance.
8177	</desc>
8178
8179	<param name="chipset" type="ChipsetType" dir="in">
8180	<desc>The chipset type to get the value for.</desc>
8181	</param>
8182
8183
8184	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8185	<desc>The maximum total number of network adapters allowed.</desc>
8186	</param>
8187
8188	</method>
8189
8190	<method name="getMaxNetworkAdaptersOfType">
8191	<desc>
8192	Maximum number of network adapters of a given attachment type,
8193	associated with every <link to="IMachine"/> instance.
8194	</desc>
8195
8196	<param name="chipset" type="ChipsetType" dir="in">
8197	<desc>The chipset type to get the value for.</desc>
8198	</param>
8199
8200	<param name="type" type="NetworkAttachmentType" dir="in">
8201	<desc>Type of attachment.</desc>
8202	</param>
8203
8204	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8205	<desc>The maximum number of network adapters allowed for
8206	particular chipset and attachment type.</desc>
8207	</param>
8208
8209	</method>
8210
8211
8212	<method name="getMaxDevicesPerPortForStorageBus">
8213	<desc>Returns the maximum number of devices which can be attached to a port
8214	for the given storage bus.</desc>
8215
8216	<param name="bus" type="StorageBus" dir="in">
8217	<desc>The storage bus type to get the value for.</desc>
8218	</param>
8219
8220	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8221	<desc>The maximum number of devices which can be attached to the port for the given
8222	storage bus.</desc>
8223	</param>
8224	</method>
8225
8226	<method name="getMinPortCountForStorageBus">
8227	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8228
8229	<param name="bus" type="StorageBus" dir="in">
8230	<desc>The storage bus type to get the value for.</desc>
8231	</param>
8232
8233	<param name="minPortCount" type="unsigned long" dir="return">
8234	<desc>The minimum number of ports for the given storage bus.</desc>
8235	</param>
8236	</method>
8237
8238	<method name="getMaxPortCountForStorageBus">
8239	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8240
8241	<param name="bus" type="StorageBus" dir="in">
8242	<desc>The storage bus type to get the value for.</desc>
8243	</param>
8244
8245	<param name="maxPortCount" type="unsigned long" dir="return">
8246	<desc>The maximum number of ports for the given storage bus.</desc>
8247	</param>
8248	</method>
8249
8250	<method name="getMaxInstancesOfStorageBus">
8251	<desc>Returns the maximum number of storage bus instances which
8252	can be configured for each VM. This corresponds to the number of
8253	storage controllers one can have. Value may depend on chipset type
8254	used.</desc>
8255
8256	<param name="chipset" type="ChipsetType" dir="in">
8257	<desc>The chipset type to get the value for.</desc>
8258	</param>
8259
8260	<param name="bus" type="StorageBus" dir="in">
8261	<desc>The storage bus type to get the value for.</desc>
8262	</param>
8263
8264	<param name="maxInstances" type="unsigned long" dir="return">
8265	<desc>The maximum number of instances for the given storage bus.</desc>
8266	</param>
8267	</method>
8268
8269	<method name="getDeviceTypesForStorageBus">
8270	<desc>Returns list of all the supported device types
8271	(<link to="DeviceType"/>) for the given type of storage
8272	bus.</desc>
8273
8274	<param name="bus" type="StorageBus" dir="in">
8275	<desc>The storage bus type to get the value for.</desc>
8276	</param>
8277
8278	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8279	<desc>The list of all supported device types for the given storage bus.</desc>
8280	</param>
8281	</method>
8282
8283	<method name="getDefaultIoCacheSettingForStorageController">
8284	<desc>Returns the default I/O cache setting for the
8285	given storage controller</desc>
8286
8287	<param name="controllerType" type="StorageControllerType" dir="in">
8288	<desc>The storage controller to the setting for.</desc>
8289	</param>
8290
8291	<param name="enabled" type="boolean" dir="return">
8292	<desc>Returned flag indicating the default value</desc>
8293	</param>
8294	</method>
8295	</interface>
8296
8297	<!--
8298	// IGuest
8299	/////////////////////////////////////////////////////////////////////////
8300	-->
8301
8302	<interface
8303	name="IGuestOSType" extends="$unknown"
8304	uuid="63a03874-e495-41f7-a6dd-48b92fba8355"
8305	wsmap="struct"
8306	>
8307	<desc>
8308	</desc>
8309
8310	<attribute name="familyId" type="wstring" readonly="yes">
8311	<desc>Guest OS family identifier string.</desc>
8312	</attribute>
8313
8314	<attribute name="familyDescription" type="wstring" readonly="yes">
8315	<desc>Human readable description of the guest OS family.</desc>
8316	</attribute>
8317
8318	<attribute name="id" type="wstring" readonly="yes">
8319	<desc>Guest OS identifier string.</desc>
8320	</attribute>
8321
8322	<attribute name="description" type="wstring" readonly="yes">
8323	<desc>Human readable description of the guest OS.</desc>
8324	</attribute>
8325
8326	<attribute name="is64Bit" type="boolean" readonly="yes">
8327	<desc>Returns @c true if the given OS is 64-bit</desc>
8328	</attribute>
8329
8330	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8331	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8332	</attribute>
8333
8334	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8335	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8336	</attribute>
8337
8338	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8339	<desc>Recommended RAM size in Megabytes.</desc>
8340	</attribute>
8341
8342	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8343	<desc>Recommended video RAM size in Megabytes.</desc>
8344	</attribute>
8345
8346	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8347	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8348	</attribute>
8349
8350	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8351	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8352	</attribute>
8353
8354	<attribute name="recommendedHDD" type="long long" readonly="yes">
8355	<desc>Recommended hard disk size in bytes.</desc>
8356	</attribute>
8357
8358	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8359	<desc>Returns recommended network adapter for this OS type.</desc>
8360	</attribute>
8361
8362	<attribute name="recommendedPae" type="boolean" readonly="yes">
8363	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8364	</attribute>
8365
8366	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
8367	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8368	</attribute>
8369
8370	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
8371	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8372	</attribute>
8373
8374	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
8375	<desc>Recommended storage controller type for HD drives.</desc>
8376	</attribute>
8377
8378	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
8379	<desc>Recommended storage bus type for HD drives.</desc>
8380	</attribute>
8381
8382	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8383	<desc>Recommended firmware type.</desc>
8384	</attribute>
8385
8386	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
8387	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8388	</attribute>
8389
8390	<attribute name="recommendedHpet" type="boolean" readonly="yes">
8391	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8392	</attribute>
8393
8394	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
8395	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8396	</attribute>
8397
8398	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
8399	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8400	</attribute>
8401
8402	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8403	<desc>Recommended chipset type.</desc>
8404	</attribute>
8405
8406	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8407	<desc>Recommended audio type.</desc>
8408	</attribute>
8409
8410	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8411	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8412	</attribute>
8413
8414	<attribute name="recommendedUsb" type="boolean" readonly="yes">
8415	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8416	</attribute>
8417
8418	</interface>
8419
8420	<enum
8421	name="AdditionsFacilityType"
8422	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8423	>
8424	<desc>
8425	Guest Additions facility IDs.
8426	</desc>
8427
8428	<const name="None" value="0">
8429	<desc>No/invalid facility.</desc>
8430	</const>
8431	<const name="VBoxGuestDriver" value="20">
8432	<desc>VirtualBox base driver (VBoxGuest).</desc>
8433	</const>
8434	<const name="AutoLogon" value="90">
8435	<desc>Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).</desc>
8436	</const>
8437	<const name="VBoxService" value="100">
8438	<desc>VirtualBox system service (VBoxService).</desc>
8439	</const>
8440	<const name="VBoxTrayClient" value="101">
8441	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8442	</const>
8443	<const name="Seamless" value="1000">
8444	<desc>Seamless guest desktop integration.</desc>
8445	</const>
8446	<const name="Graphics" value="1100">
8447	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8448	are not immediately acted on and guest display resizes are probably not initiated by
8449	the guest additions.
8450	</desc>
8451	</const>
8452	<const name="All" value="2147483646">
8453	<desc>All facilities selected.</desc>
8454	</const>
8455	</enum>
8456
8457	<enum
8458	name="AdditionsFacilityClass"
8459	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8460	>
8461	<desc>
8462	Guest Additions facility classes.
8463	</desc>
8464
8465	<const name="None" value="0">
8466	<desc>No/invalid class.</desc>
8467	</const>
8468	<const name="Driver" value="10">
8469	<desc>Driver.</desc>
8470	</const>
8471	<const name="Service" value="30">
8472	<desc>System service.</desc>
8473	</const>
8474	<const name="Program" value="50">
8475	<desc>Program.</desc>
8476	</const>
8477	<const name="Feature" value="100">
8478	<desc>Feature.</desc>
8479	</const>
8480	<const name="ThirdParty" value="999">
8481	<desc>Third party.</desc>
8482	</const>
8483	<const name="All" value="2147483646">
8484	<desc>All facility classes selected.</desc>
8485	</const>
8486	</enum>
8487
8488	<enum
8489	name="AdditionsFacilityStatus"
8490	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
8491	>
8492	<desc>
8493	Guest Additions facility states.
8494	</desc>
8495
8496	<const name="Inactive" value="0">
8497	<desc>Facility is not active.</desc>
8498	</const>
8499	<const name="Paused" value="1">
8500	<desc>Facility has been paused.</desc>
8501	</const>
8502	<const name="PreInit" value="20">
8503	<desc>Facility is preparing to initialize.</desc>
8504	</const>
8505	<const name="Init" value="30">
8506	<desc>Facility is initializing.</desc>
8507	</const>
8508	<const name="Active" value="50">
8509	<desc>Facility is up and running.</desc>
8510	</const>
8511	<const name="Terminating" value="100">
8512	<desc>Facility is shutting down.</desc>
8513	</const>
8514	<const name="Terminated" value="101">
8515	<desc>Facility successfully shut down.</desc>
8516	</const>
8517	<const name="Failed" value="800">
8518	<desc>Facility failed to start.</desc>
8519	</const>
8520	<const name="Unknown" value="999">
8521	<desc>Facility status is unknown.</desc>
8522	</const>
8523	</enum>
8524
8525	<interface
8526	name="IAdditionsFacility" extends="$unknown"
8527	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
8528	wsmap="struct"
8529	>
8530	<desc>
8531	Structure representing a Guest Additions facility.
8532	</desc>
8533
8534	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
8535	<desc>The class this facility is part of.</desc>
8536	</attribute>
8537
8538	<attribute name="lastUpdated" type="long long" readonly="yes">
8539	<desc>
8540	Time stamp of the last status update,
8541	in milliseconds since 1970-01-01 UTC.
8542	</desc>
8543	</attribute>
8544
8545	<attribute name="name" type="wstring" readonly="yes">
8546	<desc>The facility's friendly name.</desc>
8547	</attribute>
8548
8549	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8550	<desc>The current status.</desc>
8551	</attribute>
8552
8553	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8554	<desc>The facility's type ID.</desc>
8555	</attribute>
8556	</interface>
8557
8558	<enum
8559	name="AdditionsRunLevelType"
8560	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8561	>
8562	<desc>
8563	Guest Additions run level type.
8564	</desc>
8565
8566	<const name="None" value="0">
8567	<desc>Guest Additions are not loaded.</desc>
8568	</const>
8569	<const name="System" value="1">
8570	<desc>Guest drivers are loaded.</desc>
8571	</const>
8572	<const name="Userland" value="2">
8573	<desc>Common components (such as application services) are loaded.</desc>
8574	</const>
8575	<const name="Desktop" value="3">
8576	<desc>Per-user desktop components are loaded.</desc>
8577	</const>
8578	</enum>
8579
8580	<enum
8581	name="AdditionsUpdateFlag"
8582	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8583	>
8584	<desc>
8585	Guest Additions update flags.
8586	</desc>
8587
8588	<const name="None" value="0">
8589	<desc>No flag set.</desc>
8590	</const>
8591	<const name="WaitForUpdateStartOnly" value="1">
8592	<desc>Only wait for the update process being started and do not
8593	wait while peforming the actual update.</desc>
8594	</const>
8595	</enum>
8596
8597	<enum
8598	name="ExecuteProcessFlag"
8599	uuid="1c49b831-b2c7-4a30-97dd-999a2e2cbf90"
8600	>
8601	<desc>
8602	Guest process execution flags.
8603	</desc>
8604
8605	<const name="None" value="0">
8606	<desc>No flag set.</desc>
8607	</const>
8608	<const name="WaitForProcessStartOnly" value="1">
8609	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8610	process itself then uses an infinite timeout.</desc>
8611	</const>
8612	<const name="IgnoreOrphanedProcesses" value="2">
8613	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8614	</const>
8615	<const name="Hidden" value="4">
8616	<desc>Do not show the started process according to the guest OS guidelines.</desc>
8617	</const>
8618	<const name="NoProfile" value="8">
8619	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
8620	</const>
8621	<const name="WaitForStdOut" value="16">
8622	<desc>The guest process waits until all data from stdout is read out.</desc>
8623	</const>
8624	<const name="WaitForStdErr" value="32">
8625	<desc>The guest process waits until all data from stderr is read out.</desc>
8626	</const>
8627	</enum>
8628
8629	<enum
8630	name="ExecuteProcessStatus"
8631	uuid="153768d9-d971-4098-8b5a-c5cb1ab9ea88"
8632	>
8633	<desc>
8634	Guest process execution status.
8635	</desc>
8636	<const name="Undefined" value="0">
8637	<desc>Process is in an undefined state.</desc>
8638	</const>
8639
8640	<const name="Started" value="1">
8641	<desc>Process has been started.</desc>
8642	</const>
8643	<const name="TerminatedNormally" value="2">
8644	<desc>Process terminated normally.</desc>
8645	</const>
8646	<const name="TerminatedSignal" value="3">
8647	<desc>Process terminated via signal.</desc>
8648	</const>
8649	<const name="TerminatedAbnormally" value="4">
8650	<desc>Process terminated abnormally.</desc>
8651	</const>
8652	<const name="TimedOutKilled" value="5">
8653	<desc>Process timed out and was killed.</desc>
8654	</const>
8655	<const name="TimedOutAbnormally" value="6">
8656	<desc>Process timed out and was not killed successfully.</desc>
8657	</const>
8658	<const name="Down" value="7">
8659	<desc>Service/OS is stopping, process was killed.</desc>
8660	</const>
8661	<const name="Error" value="8">
8662	<desc>Something went wrong (error code in flags).</desc>
8663	</const>
8664	</enum>
8665
8666	<enum
8667	name="ProcessInputFlag"
8668	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8669	>
8670	<desc>
8671	Guest process input flags.
8672	</desc>
8673	<const name="None" value="0">
8674	<desc>No flag set.</desc>
8675	</const>
8676	<const name="EndOfFile" value="1">
8677	<desc>End of file (input) reached.</desc>
8678	</const>
8679	</enum>
8680
8681	<enum
8682	name="ProcessOutputFlag"
8683	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
8684	>
8685	<desc>
8686	Guest process output flags for specifying which
8687	type of output to retrieve.
8688	</desc>
8689	<const name="None" value="0">
8690	<desc>No flags set. Get output from stdout.</desc>
8691	</const>
8692	<const name="StdErr" value="1">
8693	<desc>Get output from stderr.</desc>
8694	</const>
8695	</enum>
8696
8697	<enum
8698	name="CopyFileFlag"
8699	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
8700	>
8701	<desc>
8702	Host/Guest copy flags. At the moment none of these flags
8703	are implemented.
8704	</desc>
8705	<const name="None" value="0">
8706	<desc>No flag set.</desc>
8707	</const>
8708	<const name="Recursive" value="1">
8709	<desc>Copy directories recursively.</desc>
8710	</const>
8711	<const name="Update" value="2">
8712	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
8713	</const>
8714	<const name="FollowLinks" value="4">
8715	<desc>Follow symbolic links.</desc>
8716	</const>
8717	</enum>
8718
8719	<enum
8720	name="DirectoryCreateFlag"
8721	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
8722	>
8723	<desc>
8724	Directory creation flags.
8725	</desc>
8726	<const name="None" value="0">
8727	<desc>No flag set.</desc>
8728	</const>
8729	<const name="Parents" value="1">
8730	<desc>No error if existing, make parent directories as needed.</desc>
8731	</const>
8732	</enum>
8733
8734	<enum
8735	name="DragAndDropAction"
8736	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
8737	>
8738	<desc>
8739	Possible actions within an Drag and Drop operation.
8740	</desc>
8741
8742	<const name="Ignore" value="0">
8743	<desc>Do nothing.</desc>
8744	</const>
8745
8746	<const name="Copy" value="1">
8747	<desc>Copy the item to the target.</desc>
8748	</const>
8749
8750	<const name="Move" value="2">
8751	<desc>Move the item to the target.</desc>
8752	</const>
8753
8754	<const name="Link" value="3">
8755	<desc>Link the item from within the target.</desc>
8756	</const>
8757	</enum>
8758
8759	<enum
8760	name="DirectoryOpenFlag"
8761	uuid="fc8f6203-0072-4f34-bd08-0b35e50bf071"
8762	>
8763	<desc>
8764	Directory open flags.
8765	</desc>
8766	<const name="None" value="0">
8767	<desc>No flag set.</desc>
8768	</const>
8769	</enum>
8770
8771	<enum
8772	name="GuestDirEntryType"
8773	uuid="6d19d924-1b77-4fc8-b369-a3b2c85c8241"
8774	>
8775	<desc>
8776	Guest directory entry type.
8777	</desc>
8778	<const name="Unknown" value="0">
8779	<desc>Unknown.</desc>
8780	</const>
8781	<const name="Directory" value="4">
8782	<desc>Regular file.</desc>
8783	</const>
8784	<const name="File" value="10">
8785	<desc>Regular file.</desc>
8786	</const>
8787	<const name="Symlink" value="12">
8788	<desc>Symbolic link.</desc>
8789	</const>
8790	</enum>
8791
8792	<interface
8793	name="IGuestDirEntry" extends="$unknown"
8794	uuid="20a66efc-c2f6-4438-826f-38454c04369e"
8795	wsmap="struct"
8796	>
8797	<desc>
8798	Structure representing a directory entry on the guest OS.
8799	</desc>
8800	<attribute name="nodeId" type="long long" readonly="yes">
8801	<desc>The unique identifier (within the guest's file system) of this file system object.</desc>
8802	</attribute>
8803	<attribute name="name" type="wstring" readonly="yes">
8804	<desc>The filename.</desc>
8805	</attribute>
8806	<attribute name="type" type="GuestDirEntryType" readonly="yes">
8807	<desc>The entry type.</desc>
8808	</attribute>
8809	</interface>
8810
8811	<interface
8812	name="IGuest" extends="$unknown"
8813	uuid="88696240-7411-4fe6-bb5e-ef56fb8a61f3"
8814	wsmap="managed"
8815	>
8816	<desc>
8817	The IGuest interface represents information about the operating system
8818	running inside the virtual machine. Used in
8819	<link to="IConsole::guest"/>.
8820
8821	IGuest provides information about the guest operating system, whether
8822	Guest Additions are installed and other OS-specific virtual machine
8823	properties.
8824	</desc>
8825
8826	<attribute name="OSTypeId" type="wstring" readonly="yes">
8827	<desc>
8828	Identifier of the Guest OS type as reported by the Guest
8829	Additions.
8830	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8831	an IGuestOSType object representing details about the given
8832	Guest OS type.
8833	<note>
8834	If Guest Additions are not installed, this value will be
8835	the same as <link to="IMachine::OSTypeId"/>.
8836	</note>
8837	</desc>
8838	</attribute>
8839
8840	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
8841	<desc>
8842	Current run level of the Guest Additions.
8843	</desc>
8844	</attribute>
8845
8846	<attribute name="additionsVersion" type="wstring" readonly="yes">
8847	<desc>
8848	Version of the Guest Additions in the same format as
8849	<link to="IVirtualBox::version"/>.
8850	</desc>
8851	</attribute>
8852
8853	<attribute name="additionsRevision" type="unsigned long" readonly="yes">
8854	<desc>
8855	The internal build revision number of the additions.
8856
8857	See also <link to="IVirtualBox::revision"/>.
8858	</desc>
8859	</attribute>
8860
8861	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
8862	<desc>
8863	Array of current known facilities. Only returns facilities where a status is known,
8864	e.g. facilities with an unknown status will not be returned.
8865	</desc>
8866	</attribute>
8867
8868	<attribute name="memoryBalloonSize" type="unsigned long">
8869	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8870	</attribute>
8871
8872	<attribute name="statisticsUpdateInterval" type="unsigned long">
8873	<desc>Interval to update guest statistics in seconds.</desc>
8874	</attribute>
8875
8876	<method name="internalGetStatistics">
8877	<desc>
8878	Internal method; do not use as it might change at any time.
8879	</desc>
8880	<param name="cpuUser" type="unsigned long" dir="out">
8881	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
8882	</param>
8883	<param name="cpuKernel" type="unsigned long" dir="out">
8884	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
8885	</param>
8886	<param name="cpuIdle" type="unsigned long" dir="out">
8887	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
8888	</param>
8889	<param name="memTotal" type="unsigned long" dir="out">
8890	<desc>Total amount of physical guest RAM.</desc>
8891	</param>
8892	<param name="memFree" type="unsigned long" dir="out">
8893	<desc>Free amount of physical guest RAM.</desc>
8894	</param>
8895	<param name="memBalloon" type="unsigned long" dir="out">
8896	<desc>Amount of ballooned physical guest RAM.</desc>
8897	</param>
8898	<param name="memShared" type="unsigned long" dir="out">
8899	<desc>Amount of shared physical guest RAM.</desc>
8900	</param>
8901	<param name="memCache" type="unsigned long" dir="out">
8902	<desc>Total amount of guest (disk) cache memory.</desc>
8903	</param>
8904	<param name="pagedTotal" type="unsigned long" dir="out">
8905	<desc>Total amount of space in the page file.</desc>
8906	</param>
8907	<param name="memAllocTotal" type="unsigned long" dir="out">
8908	<desc>Total amount of memory allocated by the hypervisor.</desc>
8909	</param>
8910	<param name="memFreeTotal" type="unsigned long" dir="out">
8911	<desc>Total amount of free memory available in the hypervisor.</desc>
8912	</param>
8913	<param name="memBalloonTotal" type="unsigned long" dir="out">
8914	<desc>Total amount of memory ballooned by the hypervisor.</desc>
8915	</param>
8916	<param name="memSharedTotal" type="unsigned long" dir="out">
8917	<desc>Total amount of shared memory in the hypervisor.</desc>
8918	</param>
8919	</method>
8920
8921	<method name="getFacilityStatus">
8922	<desc>
8923	Get the current status of a Guest Additions facility.
8924	</desc>
8925	<param name="facility" type="AdditionsFacilityType" dir="in">
8926	<desc>Facility to check status for.</desc>
8927	</param>
8928	<param name="timestamp" type="long long" dir="out">
8929	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
8930	</param>
8931	<param name="status" type="AdditionsFacilityStatus" dir="return">
8932	<desc>The current (latest) facility status.</desc>
8933	</param>
8934	</method>
8935
8936	<method name="getAdditionsStatus">
8937	<desc>
8938	Retrieve the current status of a certain Guest Additions run level.
8939
8940	<result name="VBOX_E_NOT_SUPPORTED">
8941	Wrong status level specified.
8942	</result>
8943
8944	</desc>
8945	<param name="level" type="AdditionsRunLevelType" dir="in">
8946	<desc>Status level to check</desc>
8947	</param>
8948	<param name="active" type="boolean" dir="return">
8949	<desc>Flag whether the status level has been reached or not</desc>
8950	</param>
8951	</method>
8952
8953	<method name="setCredentials">
8954	<desc>
8955	Store login credentials that can be queried by guest operating
8956	systems with Additions installed. The credentials are transient
8957	to the session and the guest may also choose to erase them. Note
8958	that the caller cannot determine whether the guest operating system
8959	has queried or made use of the credentials.
8960
8961	<result name="VBOX_E_VM_ERROR">
8962	VMM device is not available.
8963	</result>
8964
8965	</desc>
8966	<param name="userName" type="wstring" dir="in">
8967	<desc>User name string, can be empty</desc>
8968	</param>
8969	<param name="password" type="wstring" dir="in">
8970	<desc>Password string, can be empty</desc>
8971	</param>
8972	<param name="domain" type="wstring" dir="in">
8973	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8974	</param>
8975	<param name="allowInteractiveLogon" type="boolean" dir="in">
8976	<desc>
8977	Flag whether the guest should alternatively allow the user to
8978	interactively specify different credentials. This flag might
8979	not be supported by all versions of the Additions.
8980	</desc>
8981	</param>
8982	</method>
8983
8984	<method name="dragHGEnter">
8985	<desc>
8986	Informs the guest about a Drag and Drop enter event.
8987
8988	This is used in Host - Guest direction.
8989
8990	<result name="VBOX_E_VM_ERROR">
8991	VMM device is not available.
8992	</result>
8993
8994	</desc>
8995	<param name="screenId" type="unsigned long" dir="in">
8996	<desc>The screen id where the Drag and Drop event occured.</desc>
8997	</param>
8998	<param name="y" type="unsigned long" dir="in">
8999	<desc>y-position of the event.</desc>
9000	</param>
9001	<param name="x" type="unsigned long" dir="in">
9002	<desc>x-position of the event.</desc>
9003	</param>
9004	<param name="defaultAction" type="DragAndDropAction" dir="in">
9005	<desc>The default action to use.</desc>
9006	</param>
9007	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
9008	<desc>The actions which are allowed.</desc>
9009	</param>
9010	<param name="formats" type="wstring" dir="in" safearray="yes">
9011	<desc>The supported mime types.</desc>
9012	</param>
9013	<param name="resultAction" type="DragAndDropAction" dir="return">
9014	<desc>The resulting action of this event.</desc>
9015	</param>
9016	</method>
9017
9018	<method name="dragHGMove">
9019	<desc>
9020	Informs the guest about a Drag and Drop move event.
9021
9022	This is used in Host - Guest direction.
9023
9024	<result name="VBOX_E_VM_ERROR">
9025	VMM device is not available.
9026	</result>
9027
9028	</desc>
9029	<param name="screenId" type="unsigned long" dir="in">
9030	<desc>The screen id where the Drag and Drop event occured.</desc>
9031	</param>
9032	<param name="x" type="unsigned long" dir="in">
9033	<desc>x-position of the event.</desc>
9034	</param>
9035	<param name="y" type="unsigned long" dir="in">
9036	<desc>y-position of the event.</desc>
9037	</param>
9038	<param name="defaultAction" type="DragAndDropAction" dir="in">
9039	<desc>The default action to use.</desc>
9040	</param>
9041	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
9042	<desc>The actions which are allowed.</desc>
9043	</param>
9044	<param name="formats" type="wstring" dir="in" safearray="yes">
9045	<desc>The supported mime types.</desc>
9046	</param>
9047	<param name="resultAction" type="DragAndDropAction" dir="return">
9048	<desc>The resulting action of this event.</desc>
9049	</param>
9050	</method>
9051
9052	<method name="dragHGLeave">
9053	<desc>
9054	Informs the guest about a Drag and Drop leave event.
9055
9056	This is used in Host - Guest direction.
9057
9058	<result name="VBOX_E_VM_ERROR">
9059	VMM device is not available.
9060	</result>
9061
9062	</desc>
9063	<param name="screenId" type="unsigned long" dir="in">
9064	<desc>The screen id where the Drag and Drop event occured.</desc>
9065	</param>
9066	</method>
9067
9068	<method name="dragHGDrop">
9069	<desc>
9070	Informs the guest about a drop event.
9071
9072	This is used in Host - Guest direction.
9073
9074	<result name="VBOX_E_VM_ERROR">
9075	VMM device is not available.
9076	</result>
9077
9078	</desc>
9079	<param name="screenId" type="unsigned long" dir="in">
9080	<desc>The screen id where the Drag and Drop event occured.</desc>
9081	</param>
9082	<param name="x" type="unsigned long" dir="in">
9083	<desc>x-position of the event.</desc>
9084	</param>
9085	<param name="y" type="unsigned long" dir="in">
9086	<desc>y-position of the event.</desc>
9087	</param>
9088	<param name="defaultAction" type="DragAndDropAction" dir="in">
9089	<desc>The default action to use.</desc>
9090	</param>
9091	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
9092	<desc>The actions which are allowed.</desc>
9093	</param>
9094	<param name="formats" type="wstring" dir="in" safearray="yes">
9095	<desc>The supported mime types.</desc>
9096	</param>
9097	<param name="format" type="wstring" dir="out">
9098	<desc>The resulting format of this event.</desc>
9099	</param>
9100	<param name="resultAction" type="DragAndDropAction" dir="return">
9101	<desc>The resulting action of this event.</desc>
9102	</param>
9103	</method>
9104
9105	<method name="dragHGPutData">
9106	<desc>
9107	Informs the guest about a drop data event.
9108
9109	This is used in Host - Guest direction.
9110
9111	<result name="VBOX_E_VM_ERROR">
9112	VMM device is not available.
9113	</result>
9114
9115	</desc>
9116	<param name="screenId" type="unsigned long" dir="in">
9117	<desc>The screen id where the Drag and Drop event occured.</desc>
9118	</param>
9119	<param name="format" type="wstring" dir="in">
9120	<desc>The mime type the data is in.</desc>
9121	</param>
9122	<param name="data" type="octet" dir="in" safearray="yes">
9123	<desc>The actual data.</desc>
9124	</param>
9125	<param name="progress" type="IProgress" dir="return">
9126	<desc>Progress object to track the operation completion.</desc>
9127	</param>
9128	</method>
9129
9130	<method name="dragGHPending">
9131	<desc>
9132	Ask the guest if there is any Drag and Drop operation pending in the guest.
9133
9134	If no Drag and Drop operation is pending currently, Ignore is returned.
9135
9136	This is used in Guest - Host direction.
9137
9138	<result name="VBOX_E_VM_ERROR">
9139	VMM device is not available.
9140	</result>
9141
9142	</desc>
9143	<param name="screenId" type="unsigned long" dir="in">
9144	<desc>The screen id where the Drag and Drop event occured.</desc>
9145	</param>
9146	<param name="format" type="wstring" dir="out" safearray="yes">
9147	<desc>On return the supported mime types.</desc>
9148	</param>
9149	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
9150	<desc>On return the actions which are allowed.</desc>
9151	</param>
9152	<param name="defaultAction" type="DragAndDropAction" dir="return">
9153	<desc>On return the default action to use.</desc>
9154	</param>
9155	</method>
9156
9157	<method name="dragGHDropped">
9158	<desc>
9159	Informs the guest that a drop event occured for a pending Drag and Drop event.
9160
9161	This is used in Guest - Host direction.
9162
9163	<result name="VBOX_E_VM_ERROR">
9164	VMM device is not available.
9165	</result>
9166
9167	</desc>
9168
9169	<param name="format" type="wstring" dir="in">
9170	<desc>The mime type the data must be in.</desc>
9171	</param>
9172	<param name="action" type="DragAndDropAction" dir="in">
9173	<desc>The action to use.</desc>
9174	</param>
9175	<param name="progress" type="IProgress" dir="return">
9176	<desc>Progress object to track the operation completion.</desc>
9177	</param>
9178	</method>
9179
9180	<method name="dragGHGetData">
9181	<desc>
9182	Fetch the data of a previously Drag and Drop event from the guest.
9183
9184	This is used in Guest - Host direction.
9185
9186	<result name="VBOX_E_VM_ERROR">
9187	VMM device is not available.
9188	</result>
9189
9190	</desc>
9191
9192	<param name="data" type="octet" safearray="yes" dir="return">
9193	<desc>The actual data.</desc>
9194	</param>
9195	</method>
9196
9197	<method name="executeProcess">
9198	<desc>
9199	Executes an existing program inside the guest VM.
9200
9201	<note>
9202	Starting at VirtualBox 4.1.8 guest process execution by default is limited
9203	to serve up to 25 guest processes at a time. If all 25 guest processes
9204	are still active and running, starting a new guest process will result in an
9205	appropriate error message.
9206
9207	If ExecuteProcessFlag_WaitForStdOut and/or respectively
9208	ExecuteProcessFlag_WaitForStdErr of <link to="ExecuteProcessFlag"/> is
9209	set, the guest process will not exit until all data from the specified
9210	stream(s) is/are read out.
9211
9212	To raise or lower the guest process execution limit, either the guest property
9213	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
9214	command line by specifying "--control-procs-max-kept" needs to be modified.
9215	A restart of the guest OS is required afterwards. To serve unlimited guest
9216	processes, a value of "0" needs to be set (not recommended).
9217	</note>
9218
9219	<result name="VBOX_E_IPRT_ERROR">
9220	Could not execute process.
9221	</result>
9222
9223	</desc>
9224	<param name="execName" type="wstring" dir="in">
9225	<desc>
9226	Full path name of the command to execute on the guest; the
9227	commands has to exists in the guest VM in order to be executed.
9228	</desc>
9229	</param>
9230	<param name="flags" type="unsigned long" dir="in">
9231	<desc>
9232	<link to="ExecuteProcessFlag"/> flags.
9233	</desc>
9234	</param>
9235	<param name="arguments" type="wstring" safearray="yes" dir="in">
9236	<desc>
9237	Array of arguments passed to the execution command.
9238	</desc>
9239	</param>
9240	<param name="environment" type="wstring" safearray="yes" dir="in">
9241	<desc>
9242	Environment variables that can be set while the command is being
9243	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
9244	variable just set its name ("NAME") without a value.
9245	</desc>
9246	</param>
9247	<param name="userName" type="wstring" dir="in">
9248	<desc>
9249	User name under which the command will be executed; has to exist
9250	and have the appropriate rights to execute programs in the VM.
9251	</desc>
9252	</param>
9253	<param name="password" type="wstring" dir="in">
9254	<desc>
9255	Password of the user account specified.
9256	</desc>
9257	</param>
9258	<param name="timeoutMS" type="unsigned long" dir="in">
9259	<desc>
9260	The maximum timeout value (in msec) to wait for finished program
9261	execution. Pass 0 for an infinite timeout.
9262	</desc>
9263	</param>
9264	<param name="pid" type="unsigned long" dir="out">
9265	<desc>
9266	The PID (process ID) of the started command for later reference.
9267	</desc>
9268	</param>
9269	<param name="progress" type="IProgress" dir="return">
9270	<desc>Progress object to track the operation completion.</desc>
9271	</param>
9272	</method>
9273
9274	<method name="getProcessOutput">
9275	<desc>
9276	Retrieves output of a formerly started and running guest process.
9277
9278	<note>
9279	Starting with VirtualBox 4.1.8 this only will return output data
9280	from stdout or stderr if flag ExecuteProcessFlag_WaitForStdOut
9281	and/or respectively ExecuteProcessFlag_WaitForStdErr of
9282	<link to="ExecuteProcessFlag"/> is set in the
9283	former <link to="#executeProcess"/> call for this guest process.
9284	</note>
9285
9286	<result name="VBOX_E_IPRT_ERROR">
9287	Could not retrieve output.
9288	</result>
9289
9290	</desc>
9291	<param name="pid" type="unsigned long" dir="in">
9292	<desc>
9293	Process id returned by earlier <link to="#executeProcess"/> call.
9294	</desc>
9295	</param>
9296	<param name="flags" type="unsigned long" dir="in">
9297	<desc>
9298	<link to="ProcessOutputFlag"/> flags.
9299	</desc>
9300	</param>
9301	<param name="timeoutMS" type="unsigned long" dir="in">
9302	<desc>
9303	The maximum timeout value (in msec) to wait for output
9304	data. Pass 0 for an infinite timeout.
9305	</desc>
9306	</param>
9307	<param name="size" type="long long" dir="in">
9308	<desc>
9309	Size in bytes to read in the buffer.
9310	</desc>
9311	</param>
9312	<param name="data" type="octet" safearray="yes" dir="return">
9313	<desc>
9314	Buffer for retrieving the actual output. A data size of 0 means end of file
9315	if the requested size was not 0. This is the unprocessed
9316	output data, i.e. the line ending style depends on the platform of
9317	the system the server is running on.
9318	</desc>
9319	</param>
9320	</method>
9321
9322	<method name="getProcessStatus">
9323	<desc>
9324	Retrieves status, exit code and the exit reason of a formerly started
9325	guest process. If a guest process exited or got terminated this function
9326	returns its final status and removes this process from the list of
9327	known guest processes for further retrieval.
9328
9329	<result name="VBOX_E_IPRT_ERROR">
9330	Process with specified PID was not found.
9331	</result>
9332
9333	</desc>
9334	<param name="pid" type="unsigned long" dir="in">
9335	<desc>
9336	Process id returned by earlier <link to="#executeProcess"/> call.
9337	</desc>
9338	</param>
9339	<param name="exitcode" type="unsigned long" dir="out">
9340	<desc>
9341	The exit code (if available).
9342	</desc>
9343	</param>
9344	<param name="flags" type="unsigned long" dir="out">
9345	<desc>
9346	Additional flags of process status. Not used at the moment and
9347	must be set to 0.
9348	</desc>
9349	</param>
9350	<param name="reason" type="ExecuteProcessStatus" dir="return">
9351	<desc>
9352	The current process status.
9353	</desc>
9354	</param>
9355	</method>
9356
9357	<method name="copyFromGuest">
9358	<desc>
9359	Copies files/directories from guest to the host.
9360
9361	<result name="VBOX_E_IPRT_ERROR">
9362	Error while copying.
9363	</result>
9364
9365	</desc>
9366	<param name="source" type="wstring" dir="in">
9367	<desc>
9368	Source file on the guest to copy.
9369	</desc>
9370	</param>
9371	<param name="dest" type="wstring" dir="in">
9372	<desc>
9373	Destination path on the host.
9374	</desc>
9375	</param>
9376	<param name="userName" type="wstring" dir="in">
9377	<desc>
9378	User name under which the copy command will be executed; the
9379	user has to exist and have the appropriate rights to read from
9380	the source path.
9381	</desc>
9382	</param>
9383	<param name="password" type="wstring" dir="in">
9384	<desc>
9385	Password of the user account specified.
9386	</desc>
9387	</param>
9388	<param name="flags" type="unsigned long" dir="in">
9389	<desc>
9390	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9391	</desc>
9392	</param>
9393	<param name="progress" type="IProgress" dir="return">
9394	<desc>Progress object to track the operation completion.</desc>
9395	</param>
9396	</method>
9397
9398	<method name="copyToGuest">
9399	<desc>
9400	Copies files/directories from host to the guest.
9401
9402	<result name="VBOX_E_IPRT_ERROR">
9403	Error while copying.
9404	</result>
9405
9406	</desc>
9407	<param name="source" type="wstring" dir="in">
9408	<desc>
9409	Source file on the host to copy.
9410	</desc>
9411	</param>
9412	<param name="dest" type="wstring" dir="in">
9413	<desc>
9414	Destination path on the guest.
9415	</desc>
9416	</param>
9417	<param name="userName" type="wstring" dir="in">
9418	<desc>
9419	User name under which the copy command will be executed; the
9420	user has to exist and have the appropriate rights to write to
9421	the destination path.
9422	</desc>
9423	</param>
9424	<param name="password" type="wstring" dir="in">
9425	<desc>
9426	Password of the user account specified.
9427	</desc>
9428	</param>
9429	<param name="flags" type="unsigned long" dir="in">
9430	<desc>
9431	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9432	</desc>
9433	</param>
9434	<param name="progress" type="IProgress" dir="return">
9435	<desc>Progress object to track the operation completion.</desc>
9436	</param>
9437	</method>
9438
9439	<method name="directoryClose">
9440	<desc>
9441	Closes a formerly opened guest directory.
9442
9443	<result name="VBOX_E_IPRT_ERROR">
9444	Error while closing directory.
9445	</result>
9446
9447	</desc>
9448	<param name="handle" type="unsigned long" dir="in">
9449	<desc>
9450	Handle of opened directory to close.
9451	</desc>
9452	</param>
9453	</method>
9454
9455	<method name="directoryCreate">
9456	<desc>
9457	Creates a directory on the guest.
9458
9459	<result name="VBOX_E_IPRT_ERROR">
9460	Error while creating directory.
9461	</result>
9462
9463	</desc>
9464	<param name="directory" type="wstring" dir="in">
9465	<desc>
9466	Directory to create.
9467	</desc>
9468	</param>
9469	<param name="userName" type="wstring" dir="in">
9470	<desc>
9471	User name under which the directory creation will be executed; the
9472	user has to exist and have the appropriate rights to create the
9473	desired directory.
9474	</desc>
9475	</param>
9476	<param name="password" type="wstring" dir="in">
9477	<desc>
9478	Password of the user account specified.
9479	</desc>
9480	</param>
9481	<param name="mode" type="unsigned long" dir="in">
9482	<desc>
9483	File mode.
9484	</desc>
9485	</param>
9486	<param name="flags" type="unsigned long" dir="in">
9487	<desc>
9488	<link to="DirectoryCreateFlag"/> flags.
9489	</desc>
9490	</param>
9491	</method>
9492
9493	<method name="directoryOpen">
9494	<desc>
9495	Opens a directory on the guest.
9496
9497	<result name="VBOX_E_IPRT_ERROR">
9498	Error while opening / reading directory.
9499	</result>
9500
9501	</desc>
9502	<param name="directory" type="wstring" dir="in">
9503	<desc>
9504	Directory to read.
9505	</desc>
9506	</param>
9507	<param name="filter" type="wstring" dir="in">
9508	<desc>
9509	Directory filter (DOS style wildcards). Set to empty
9510	string if no filter required.
9511	</desc>
9512	</param>
9513	<param name="flags" type="unsigned long" dir="in">
9514	<desc>
9515	<link to="DirectoryOpenFlag"/> flags.
9516	</desc>
9517	</param>
9518	<param name="userName" type="wstring" dir="in">
9519	<desc>
9520	User name under which the directory reading will be performed; the
9521	user has to exist and have the appropriate rights to access / read the
9522	desired directory.
9523	</desc>
9524	</param>
9525	<param name="password" type="wstring" dir="in">
9526	<desc>
9527	Password of the user account specified.
9528	</desc>
9529	</param>
9530	<param name="handle" type="unsigned long" dir="return">
9531	<desc>
9532	Handle of opened directory returned by openDirectory.
9533	</desc>
9534	</param>
9535	</method>
9536
9537	<method name="directoryRead">
9538	<desc>
9539	Reads the next directory entry of an opened guest directory.
9540
9541	<result name="E_ABORT">
9542	When the end of the directory has been reached.
9543	</result>
9544
9545	<result name="VBOX_E_IPRT_ERROR">
9546	Error while opening / reading directory.
9547	</result>
9548
9549	</desc>
9550	<param name="handle" type="unsigned long" dir="in">
9551	<desc>
9552	Handle of opened directory returned by openDirectory.
9553	</desc>
9554	</param>
9555	<param name="entry" type="IGuestDirEntry" dir="return">
9556	<desc>
9557	Information about next directory entry on success.
9558	</desc>
9559	</param>
9560	</method>
9561
9562	<method name="fileExists">
9563	<desc>
9564	Checks if the specified file name exists and is a regular file.
9565
9566	If the file name ends with a slash or backslash, the function assumes
9567	it's a directory and will check if the specified directory exists and
9568	is a regular directory.
9569
9570	<result name="VBOX_E_IPRT_ERROR">
9571	Error while looking up information.
9572	</result>
9573
9574	</desc>
9575	<param name="file" type="wstring" dir="in">
9576	<desc>
9577	Full path of file to check.
9578	</desc>
9579	</param>
9580	<param name="userName" type="wstring" dir="in">
9581	<desc>
9582	User name under which the lookup will be performed; the
9583	user has to exist and have the appropriate rights to access / read the
9584	desired directory.
9585	</desc>
9586	</param>
9587	<param name="password" type="wstring" dir="in">
9588	<desc>
9589	Password of the user account specified.
9590	</desc>
9591	</param>
9592	<param name="exists" type="boolean" dir="return">
9593	<desc>
9594	True if it's a regular file, false if it isn't (or doesn't exist).
9595	</desc>
9596	</param>
9597	</method>
9598
9599	<method name="fileQuerySize">
9600	<desc>
9601	Queries the size of a file, given the path to it.
9602
9603	<result name="VBOX_E_IPRT_ERROR">
9604	Error while looking up information.
9605	</result>
9606
9607	</desc>
9608	<param name="file" type="wstring" dir="in">
9609	<desc>
9610	Full path of file to query file size for.
9611	</desc>
9612	</param>
9613	<param name="userName" type="wstring" dir="in">
9614	<desc>
9615	User name under which the lookup will be performed; the
9616	user has to exist and have the appropriate rights to access / read the
9617	desired directory.
9618	</desc>
9619	</param>
9620	<param name="password" type="wstring" dir="in">
9621	<desc>
9622	Password of the user account specified.
9623	</desc>
9624	</param>
9625	<param name="size" type="long long" dir="return">
9626	<desc>
9627	Size (in bytes) of file specified.
9628	</desc>
9629	</param>
9630	</method>
9631
9632	<method name="setProcessInput">
9633	<desc>
9634	Sends input into a formerly started process.
9635
9636	<result name="VBOX_E_IPRT_ERROR">
9637	Could not send input.
9638	</result>
9639
9640	</desc>
9641	<param name="pid" type="unsigned long" dir="in">
9642	<desc>
9643	Process id returned by earlier <link to="#executeProcess"/> call.
9644	</desc>
9645	</param>
9646	<param name="flags" type="unsigned long" dir="in">
9647	<desc>
9648	<link to="ProcessInputFlag"/> flags.
9649	</desc>
9650	</param>
9651	<param name="timeoutMS" type="unsigned long" dir="in">
9652	<desc>
9653	The maximum timeout value (in msec) to wait for getting the
9654	data transfered to the guest. Pass 0 for an infinite timeout.
9655	</desc>
9656	</param>
9657	<param name="data" type="octet" dir="in" safearray="yes">
9658	<desc>
9659	Buffer of input data to send to the started process to.
9660	</desc>
9661	</param>
9662	<param name="written" type="unsigned long" dir="return">
9663	<desc>
9664	Number of bytes written.
9665	</desc>
9666	</param>
9667	</method>
9668
9669	<method name="updateGuestAdditions">
9670	<desc>
9671	Updates already installed Guest Additions in a VM
9672	(Windows guests only).
9673
9674	<result name="VBOX_E_IPRT_ERROR">
9675	Error while updating.
9676	</result>
9677
9678	</desc>
9679	<param name="source" type="wstring" dir="in">
9680	<desc>
9681	Path to the Guest Additions .ISO file to use for the upate.
9682	</desc>
9683	</param>
9684	<param name="flags" type="unsigned long" dir="in">
9685	<desc>
9686	<link to="AdditionsUpdateFlag"/> flags.
9687	</desc>
9688	</param>
9689	<param name="progress" type="IProgress" dir="return">
9690	<desc>Progress object to track the operation completion.</desc>
9691	</param>
9692	</method>
9693
9694	</interface>
9695
9696
9697	<!--
9698	// IProgress
9699	/////////////////////////////////////////////////////////////////////////
9700	-->
9701
9702	<interface
9703	name="IProgress" extends="$unknown"
9704	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
9705	wsmap="managed"
9706	>
9707	<desc>
9708	The IProgress interface is used to track and control
9709	asynchronous tasks within VirtualBox.
9710
9711	An instance of this is returned every time VirtualBox starts
9712	an asynchronous task (in other words, a separate thread) which
9713	continues to run after a method call returns. For example,
9714	<link to="IConsole::saveState" />, which saves the state of
9715	a running virtual machine, can take a long time to complete.
9716	To be able to display a progress bar, a user interface such as
9717	the VirtualBox graphical user interface can use the IProgress
9718	object returned by that method.
9719
9720	Note that IProgress is a "read-only" interface in the sense
9721	that only the VirtualBox internals behind the Main API can
9722	create and manipulate progress objects, whereas client code
9723	can only use the IProgress object to monitor a task's
9724	progress and, if <link to="#cancelable" /> is @c true,
9725	cancel the task by calling <link to="#cancel" />.
9726
9727	A task represented by IProgress consists of either one or
9728	several sub-operations that run sequentially, one by one (see
9729	<link to="#operation" /> and <link to="#operationCount" />).
9730	Every operation is identified by a number (starting from 0)
9731	and has a separate description.
9732
9733	You can find the individual percentage of completion of the current
9734	operation in <link to="#operationPercent" /> and the
9735	percentage of completion of the task as a whole
9736	in <link to="#percent" />.
9737
9738	Similarly, you can wait for the completion of a particular
9739	operation via <link to="#waitForOperationCompletion" /> or
9740	for the completion of the whole task via
9741	<link to="#waitForCompletion" />.
9742	</desc>
9743
9744	<attribute name="id" type="uuid" mod="string" readonly="yes">
9745	<desc>ID of the task.</desc>
9746	</attribute>
9747
9748	<attribute name="description" type="wstring" readonly="yes">
9749	<desc>Description of the task.</desc>
9750	</attribute>
9751
9752	<attribute name="initiator" type="$unknown" readonly="yes">
9753	<desc>Initiator of the task.</desc>
9754	</attribute>
9755
9756	<attribute name="cancelable" type="boolean" readonly="yes">
9757	<desc>Whether the task can be interrupted.</desc>
9758	</attribute>
9759
9760	<attribute name="percent" type="unsigned long" readonly="yes">
9761	<desc>
9762	Current progress value of the task as a whole, in percent.
9763	This value depends on how many operations are already complete.
9764	Returns 100 if <link to="#completed" /> is @c true.
9765	</desc>
9766	</attribute>
9767
9768	<attribute name="timeRemaining" type="long" readonly="yes">
9769	<desc>
9770	Estimated remaining time until the task completes, in
9771	seconds. Returns 0 once the task has completed; returns -1
9772	if the remaining time cannot be computed, in particular if
9773	the current progress is 0.
9774
9775	Even if a value is returned, the estimate will be unreliable
9776	for low progress values. It will become more reliable as the
9777	task progresses; it is not recommended to display an ETA
9778	before at least 20% of a task have completed.
9779	</desc>
9780	</attribute>
9781
9782	<attribute name="completed" type="boolean" readonly="yes">
9783	<desc>Whether the task has been completed.</desc>
9784	</attribute>
9785
9786	<attribute name="canceled" type="boolean" readonly="yes">
9787	<desc>Whether the task has been canceled.</desc>
9788	</attribute>
9789
9790	<attribute name="resultCode" type="long" readonly="yes">
9791	<desc>
9792	Result code of the progress task.
9793	Valid only if <link to="#completed"/> is @c true.
9794	</desc>
9795	</attribute>
9796
9797	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
9798	<desc>
9799	Extended information about the unsuccessful result of the
9800	progress operation. May be @c null if no extended information
9801	is available.
9802	Valid only if <link to="#completed"/> is @c true and
9803	<link to="#resultCode"/> indicates a failure.
9804	</desc>
9805	</attribute>
9806
9807	<attribute name="operationCount" type="unsigned long" readonly="yes">
9808	<desc>
9809	Number of sub-operations this task is divided into.
9810	Every task consists of at least one suboperation.
9811	</desc>
9812	</attribute>
9813
9814	<attribute name="operation" type="unsigned long" readonly="yes">
9815	<desc>Number of the sub-operation being currently executed.</desc>
9816	</attribute>
9817
9818	<attribute name="operationDescription" type="wstring" readonly="yes">
9819	<desc>
9820	Description of the sub-operation being currently executed.
9821	</desc>
9822	</attribute>
9823
9824	<attribute name="operationPercent" type="unsigned long" readonly="yes">
9825	<desc>Progress value of the current sub-operation only, in percent.</desc>
9826	</attribute>
9827
9828	<attribute name="operationWeight" type="unsigned long" readonly="yes">
9829	<desc>Weight value of the current sub-operation only.</desc>
9830	</attribute>
9831
9832	<attribute name="timeout" type="unsigned long">
9833	<desc>
9834	When non-zero, this specifies the number of milliseconds after which
9835	the operation will automatically be canceled. This can only be set on
9836	cancelable objects.
9837	</desc>
9838	</attribute>
9839
9840	<method name="setCurrentOperationProgress">
9841	<desc>Internal method, not to be called externally.</desc>
9842	<param name="percent" type="unsigned long" dir="in" />
9843	</method>
9844	<method name="setNextOperation">
9845	<desc>Internal method, not to be called externally.</desc>
9846	<param name="nextOperationDescription" type="wstring" dir="in" />
9847	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
9848	</method>
9849
9850	<method name="waitForCompletion">
9851	<desc>
9852	Waits until the task is done (including all sub-operations)
9853	with a given timeout in milliseconds; specify -1 for an indefinite wait.
9854
9855	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
9856	thread are not processed while waiting. Neglecting event queues may
9857	have dire consequences (degrade performance, resource hogs,
9858	deadlocks, etc.), this is specially so for the main thread on
9859	platforms using XPCOM. Callers are adviced wait for short periods
9860	and service their event queues between calls, or to create a worker
9861	thread to do the waiting.
9862
9863	<result name="VBOX_E_IPRT_ERROR">
9864	Failed to wait for task completion.
9865	</result>
9866	</desc>
9867
9868	<param name="timeout" type="long" dir="in">
9869	<desc>
9870	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9871	</desc>
9872	</param>
9873	</method>
9874
9875	<method name="waitForOperationCompletion">
9876	<desc>
9877	Waits until the given operation is done with a given timeout in
9878	milliseconds; specify -1 for an indefinite wait.
9879
9880	See <link to="#waitForCompletion"> for event queue considerations.</link>
9881
9882	<result name="VBOX_E_IPRT_ERROR">
9883	Failed to wait for operation completion.
9884	</result>
9885
9886	</desc>
9887	<param name="operation" type="unsigned long" dir="in">
9888	<desc>
9889	Number of the operation to wait for.
9890	Must be less than <link to="#operationCount"/>.
9891	</desc>
9892	</param>
9893	<param name="timeout" type="long" dir="in">
9894	<desc>
9895	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9896	</desc>
9897	</param>
9898	</method>
9899
9900	<method name="waitForAsyncProgressCompletion">
9901	<desc>
9902	Waits until the other task is completed (including all
9903	sub-operations) and forward all changes from the other progress to
9904	this progress. This means sub-operation number, description, percent
9905	and so on.
9906
9907	You have to take care on setting up at least the same count on
9908	sub-operations in this progress object like there are in the other
9909	progress object.
9910
9911	If the other progress object supports cancel and this object gets any
9912	cancel request (when here enabled as well), it will be forwarded to
9913	the other progress object.
9914
9915	If there is an error in the other progress, this error isn't
9916	automatically transfered to this progress object. So you have to
9917	check any operation error within the other progress object, after
9918	this method returns.
9919	</desc>
9920
9921	<param name="pProgressAsync" type="IProgress" dir="in">
9922	<desc>
9923	The progress object of the asynchrony process.
9924	</desc>
9925	</param>
9926	</method>
9927
9928	<method name="cancel">
9929	<desc>
9930	Cancels the task.
9931	<note>
9932	If <link to="#cancelable"/> is @c false, then this method will fail.
9933	</note>
9934
9935	<result name="VBOX_E_INVALID_OBJECT_STATE">
9936	Operation cannot be canceled.
9937	</result>
9938
9939	</desc>
9940	</method>
9941
9942	</interface>
9943
9944	<!--
9945	// ISnapshot
9946	/////////////////////////////////////////////////////////////////////////
9947	-->
9948
9949	<interface
9950	name="ISnapshot" extends="$unknown"
9951	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
9952	wsmap="managed"
9953	>
9954	<desc>
9955	The ISnapshot interface represents a snapshot of the virtual
9956	machine.
9957
9958	Together with the differencing media that are created
9959	when a snapshot is taken, a machine can be brought back to
9960	the exact state it was in when the snapshot was taken.
9961
9962	The ISnapshot interface has no methods, only attributes; snapshots
9963	are controlled through methods of the <link to="IConsole" /> interface
9964	which also manage the media associated with the snapshot.
9965	The following operations exist:
9966
9967	<ul>
9968	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
9969	by creating new, empty differencing images for the machine's
9970	media and saving the VM settings and (if the VM is running)
9971	the current VM state in the snapshot.
9972
9973	The differencing images will then receive all data written to
9974	the machine's media, while their parent (base) images
9975	remain unmodified after the snapshot has been taken (see
9976	<link to="IMedium" /> for details about differencing images).
9977	This simplifies restoring a machine to the state of a snapshot:
9978	only the differencing images need to be deleted.
9979
9980	The current machine state is not changed by taking a snapshot
9981	except that <link to="IMachine::currentSnapshot" /> is set to
9982	the newly created snapshot, which is also added to the machine's
9983	snapshots tree.
9984	</li>
9985
9986	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
9987	the state of a previous snapshot by deleting the differencing
9988	image of each of the machine's media and setting the machine's
9989	settings and state to the state that was saved in the snapshot (if any).
9990
9991	This destroys the machine's current state. After calling this,
9992	<link to="IMachine::currentSnapshot" /> points to the snapshot
9993	that was restored.
9994	</li>
9995
9996	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
9997	without affecting the current machine state.
9998
9999	This does not change the current machine state, but instead frees the
10000	resources allocated when the snapshot was taken: the settings and machine
10001	state file are deleted (if any), and the snapshot's differencing image for
10002	each of the machine's media gets merged with its parent image.
10003
10004	Neither the current machine state nor other snapshots are affected
10005	by this operation, except that parent media will be modified
10006	to contain the disk data associated with the snapshot being deleted.
10007
10008	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
10009	attribute is set to the current snapshot's parent or NULL if it
10010	has no parent. Otherwise the attribute is unchanged.
10011	</li>
10012	</ul>
10013
10014	Each snapshot contains a copy of virtual machine's settings (hardware
10015	configuration etc.). This copy is contained in an immutable (read-only)
10016	instance of <link to="IMachine" /> which is available from the snapshot's
10017	<link to="#machine" /> attribute. When restoring the snapshot, these
10018	settings are copied back to the original machine.
10019
10020	In addition, if the machine was running when the
10021	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
10022	the current VM state is saved in the snapshot (similarly to what happens
10023	when a VM's state is saved). The snapshot is then said to be <i>online</i>
10024	because when restoring it, the VM will be running.
10025
10026	If the machine was in <link to="MachineState_Saved">saved</link> saved,
10027	the snapshot receives a copy of the execution state file
10028	(<link to="IMachine::stateFilePath"/>).
10029
10030	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
10031	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
10032	it then contains a so-called "zero execution state", representing a
10033	machine that is powered off.
10034	</desc>
10035
10036	<attribute name="id" type="uuid" mod="string" readonly="yes">
10037	<desc>UUID of the snapshot.</desc>
10038	</attribute>
10039
10040	<attribute name="name" type="wstring">
10041	<desc>Short name of the snapshot.
10042	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
10043	be called implicitly.</note>
10044	</desc>
10045	</attribute>
10046
10047	<attribute name="description" type="wstring">
10048	<desc>Optional description of the snapshot.
10049	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
10050	be called implicitly.</note>
10051	</desc>
10052	</attribute>
10053
10054	<attribute name="timeStamp" type="long long" readonly="yes">
10055	<desc>
10056	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
10057	</desc>
10058	</attribute>
10059
10060	<attribute name="online" type="boolean" readonly="yes">
10061	<desc>
10062	@c true if this snapshot is an online snapshot and @c false otherwise.
10063
10064	When this attribute is @c true, the
10065	<link to="IMachine::stateFilePath"/> attribute of the
10066	<link to="#machine"/> object associated with this snapshot
10067	will point to the saved state file. Otherwise, it will be
10068	an empty string.
10069	</desc>
10070	</attribute>
10071
10072	<attribute name="machine" type="IMachine" readonly="yes">
10073	<desc>
10074	Virtual machine this snapshot is taken on. This object
10075	stores all settings the machine had when taking this snapshot.
10076	<note>
10077	The returned machine object is immutable, i.e. no
10078	any settings can be changed.
10079	</note>
10080	</desc>
10081	</attribute>
10082
10083	<attribute name="parent" type="ISnapshot" readonly="yes">
10084	<desc>
10085	Parent snapshot (a snapshot this one is based on), or
10086	@c null if the snapshot has no parent (i.e. is the first snapshot).
10087	</desc>
10088	</attribute>
10089
10090	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
10091	<desc>
10092	Child snapshots (all snapshots having this one as a parent).
10093	By inspecting this attribute starting with a machine's root snapshot
10094	(which can be obtained by calling <link to="IMachine::findSnapshot" />
10095	with a @c null UUID), a machine's snapshots tree can be iterated over.
10096	</desc>
10097	</attribute>
10098
10099	<method name="getChildrenCount" const="yes">
10100	<desc>
10101	Returns the number of direct childrens of this snapshot.
10102	</desc>
10103	<param name="childrenCount" type="unsigned long" dir="return">
10104	<desc>
10105	</desc>
10106	</param>
10107	</method>
10108
10109	</interface>
10110
10111
10112	<!--
10113	// IMedium
10114	/////////////////////////////////////////////////////////////////////////
10115	-->
10116
10117	<enum
10118	name="MediumState"
10119	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
10120	>
10121	<desc>
10122	Virtual medium state.
10123	<see><link to="IMedium"/></see>
10124	</desc>
10125
10126	<const name="NotCreated" value="0">
10127	<desc>
10128	Associated medium storage does not exist (either was not created yet or
10129	was deleted).
10130	</desc>
10131	</const>
10132	<const name="Created" value="1">
10133	<desc>
10134	Associated storage exists and accessible; this gets set if the
10135	accessibility check performed by <link to="IMedium::refreshState" />
10136	was successful.
10137	</desc>
10138	</const>
10139	<const name="LockedRead" value="2">
10140	<desc>
10141	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
10142	no data modification is possible.
10143	</desc>
10144	</const>
10145	<const name="LockedWrite" value="3">
10146	<desc>
10147	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
10148	no concurrent data reading or modification is possible.
10149	</desc>
10150	</const>
10151	<const name="Inaccessible" value="4">
10152	<desc>
10153	Medium accessibility check (see <link to="IMedium::refreshState" />) has
10154	not yet been performed, or else, associated medium storage is not
10155	accessible. In the first case, <link to="IMedium::lastAccessError"/>
10156	is empty, in the second case, it describes the error that occurred.
10157	</desc>
10158	</const>
10159	<const name="Creating" value="5">
10160	<desc>
10161	Associated medium storage is being created.
10162	</desc>
10163	</const>
10164	<const name="Deleting" value="6">
10165	<desc>
10166	Associated medium storage is being deleted.
10167	</desc>
10168	</const>
10169	</enum>
10170
10171	<enum
10172	name="MediumType"
10173	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
10174	>
10175	<desc>
10176	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
10177	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
10178	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
10179	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
10180	</desc>
10181
10182	<const name="Normal" value="0">
10183	<desc>
10184	Normal medium (attached directly or indirectly, preserved
10185	when taking snapshots).
10186	</desc>
10187	</const>
10188	<const name="Immutable" value="1">
10189	<desc>
10190	Immutable medium (attached indirectly, changes are wiped out
10191	the next time the virtual machine is started).
10192	</desc>
10193	</const>
10194	<const name="Writethrough" value="2">
10195	<desc>
10196	Write through medium (attached directly, ignored when
10197	taking snapshots).
10198	</desc>
10199	</const>
10200	<const name="Shareable" value="3">
10201	<desc>
10202	Allow using this medium concurrently by several machines.
10203	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
10204	</desc>
10205	</const>
10206	<const name="Readonly" value="4">
10207	<desc>
10208	A readonly medium, which can of course be used by several machines.
10209	<note>Present and accepted since VirtualBox 4.0.</note>
10210	</desc>
10211	</const>
10212	<const name="MultiAttach" value="5">
10213	<desc>
10214	A medium which is is indirectly attached, so that one base medium can
10215	be used for several VMs which have their own differencing medium to
10216	store their modifications. In some sense a variant of Immutable
10217	with unset AutoReset flag in each differencing medium.
10218	<note>Present and accepted since VirtualBox 4.0.</note>
10219	</desc>
10220	</const>
10221	</enum>
10222
10223	<enum
10224	name="MediumVariant"
10225	uuid="80685b6b-e42f-497d-8271-e77bf3c61ada"
10226	>
10227	<desc>
10228	Virtual medium image variant. More than one flag may be set.
10229	<see><link to="IMedium"/></see>
10230	</desc>
10231
10232	<const name="Standard" value="0">
10233	<desc>
10234	No particular variant requested, results in using the backend default.
10235	</desc>
10236	</const>
10237	<const name="VmdkSplit2G" value="0x01">
10238	<desc>
10239	VMDK image split in chunks of less than 2GByte.
10240	</desc>
10241	</const>
10242	<const name="VmdkRawDisk" value="0x02">
10243	<desc>
10244	VMDK image representing a raw disk.
10245	</desc>
10246	</const>
10247	<const name="VmdkStreamOptimized" value="0x04">
10248	<desc>
10249	VMDK streamOptimized image. Special import/export format which is
10250	read-only/append-only.
10251	</desc>
10252	</const>
10253	<const name="VmdkESX" value="0x08">
10254	<desc>
10255	VMDK format variant used on ESX products.
10256	</desc>
10257	</const>
10258	<const name="Fixed" value="0x10000">
10259	<desc>
10260	Fixed image. Only allowed for base images.
10261	</desc>
10262	</const>
10263	<const name="Diff" value="0x20000">
10264	<desc>
10265	Differencing image. Only allowed for child images.
10266	</desc>
10267	</const>
10268	<const name="NoCreateDir" value="0x40000000">
10269	<desc>
10270	Special flag which suppresses automatic creation of the subdirectory.
10271	Only used when passing the medium variant as an input parameter.
10272	</desc>
10273	</const>
10274	</enum>
10275
10276	<interface
10277	name="IMediumAttachment" extends="$unknown"
10278	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
10279	wsmap="struct"
10280	>
10281	<desc>
10282	The IMediumAttachment interface links storage media to virtual machines.
10283	For each medium (<link to="IMedium"/>) which has been attached to a
10284	storage controller (<link to="IStorageController"/>) of a machine
10285	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
10286	method, one instance of IMediumAttachment is added to the machine's
10287	<link to="IMachine::mediumAttachments"/> array attribute.
10288
10289	Each medium attachment specifies the storage controller as well as a
10290	port and device number and the IMedium instance representing a virtual
10291	hard disk or floppy or DVD image.
10292
10293	For removable media (DVDs or floppies), there are two additional
10294	options. For one, the IMedium instance can be @c null to represent
10295	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
10296	secondly, the medium can be one of the pseudo-media for host drives
10297	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
10298
10299	<h3>Attaching Hard Disks</h3>
10300
10301	Hard disks are attached to virtual machines using the
10302	<link to="IMachine::attachDevice"/> method and detached using the
10303	<link to="IMachine::detachDevice"/> method. Depending on a medium's
10304	type (see <link to="IMedium::type" />), hard disks are attached either
10305	<i>directly</i> or <i>indirectly</i>.
10306
10307	When a hard disk is being attached directly, it is associated with the
10308	virtual machine and used for hard disk operations when the machine is
10309	running. When a hard disk is being attached indirectly, a new differencing
10310	hard disk linked to it is implicitly created and this differencing hard
10311	disk is associated with the machine and used for hard disk operations.
10312	This also means that if <link to="IMachine::attachDevice"/> performs
10313	a direct attachment then the same hard disk will be returned in response
10314	to the subsequent <link to="IMachine::getMedium"/> call; however if
10315	an indirect attachment is performed then
10316	<link to="IMachine::getMedium"/> will return the implicitly created
10317	differencing hard disk, not the original one passed to <link
10318	to="IMachine::attachDevice"/>. In detail:
10319
10320	<ul>
10321	<li><b>Normal base</b> hard disks that do not have children (i.e.
10322	differencing hard disks linked to them) and that are not already
10323	attached to virtual machines in snapshots are attached <b>directly</b>.
10324	Otherwise, they are attached <b>indirectly</b> because having
10325	dependent children or being part of the snapshot makes it impossible
10326	to modify hard disk contents without breaking the integrity of the
10327	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
10328	quickly determine the kind of the attachment for the given hard
10329	disk. Note that if a normal base hard disk is to be indirectly
10330	attached to a virtual machine with snapshots then a special
10331	procedure called <i>smart attachment</i> is performed (see below).</li>
10332	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
10333	they are attached <b>directly</b> if they do not have children and are
10334	not attached to virtual machines in snapshots, and <b>indirectly</b>
10335	otherwise. Note that the smart attachment procedure is never performed
10336	for differencing hard disks.</li>
10337	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
10338	they are designed to be non-writable. If an immutable hard disk is
10339	attached to a virtual machine with snapshots then a special
10340	procedure called smart attachment is performed (see below).</li>
10341	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
10342	also as designed. This also means that writethrough hard disks cannot
10343	have other hard disks linked to them at all.</li>
10344	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
10345	also as designed. This also means that shareable hard disks cannot
10346	have other hard disks linked to them at all. They behave almost
10347	like writethrough hard disks, except that shareable hard disks can
10348	be attached to several virtual machines which are running, allowing
10349	concurrent accesses. You need special cluster software running in
10350	the virtual machines to make use of such disks.</li>
10351	</ul>
10352
10353	Note that the same hard disk, regardless of its type, may be attached to
10354	more than one virtual machine at a time. In this case, the machine that is
10355	started first gains exclusive access to the hard disk and attempts to
10356	start other machines having this hard disk attached will fail until the
10357	first machine is powered down.
10358
10359	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
10360	that the given hard disk remains associated with the given machine after a
10361	successful <link to="IMachine::detachDevice"/> call until
10362	<link to="IMachine::saveSettings"/> is called to save all changes to
10363	machine settings to disk. This deferring is necessary to guarantee that
10364	the hard disk configuration may be restored at any time by a call to
10365	<link to="IMachine::discardSettings"/> before the settings
10366	are saved (committed).
10367
10368	Note that if <link to="IMachine::discardSettings"/> is called after
10369	indirectly attaching some hard disks to the machine but before a call to
10370	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
10371	all differencing hard disks implicitly created by
10372	<link to="IMachine::attachDevice"/> for these indirect attachments.
10373	Such implicitly created hard disks will also be immediately deleted when
10374	detached explicitly using the <link to="IMachine::detachDevice"/>
10375	call if it is made before <link to="IMachine::saveSettings"/>. This
10376	implicit deletion is safe because newly created differencing hard
10377	disks do not contain any user data.
10378
10379	However, keep in mind that detaching differencing hard disks that were
10380	implicitly created by <link to="IMachine::attachDevice"/>
10381	before the last <link to="IMachine::saveSettings"/> call will
10382	<b>not</b> implicitly delete them as they may already contain some data
10383	(for example, as a result of virtual machine execution). If these hard
10384	disks are no more necessary, the caller can always delete them explicitly
10385	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
10386	from this machine by the <link to="IMachine::saveSettings"/> call.
10387
10388	<h3>Smart Attachment</h3>
10389
10390	When normal base or immutable hard disks are indirectly attached to a
10391	virtual machine then some additional steps are performed to make sure the
10392	virtual machine will have the most recent "view" of the hard disk being
10393	attached. These steps include walking through the machine's snapshots
10394	starting from the current one and going through ancestors up to the first
10395	snapshot. Hard disks attached to the virtual machine in all
10396	of the encountered snapshots are checked whether they are descendants of
10397	the given normal base or immutable hard disk. The first found child (which
10398	is the differencing hard disk) will be used instead of the normal base or
10399	immutable hard disk as a parent for creating a new differencing hard disk
10400	that will be actually attached to the machine. And only if no descendants
10401	are found or if the virtual machine does not have any snapshots then the
10402	normal base or immutable hard disk will be used itself as a parent for
10403	this differencing hard disk.
10404
10405	It is easier to explain what smart attachment does using the
10406	following example:
10407	<pre>
10408	BEFORE attaching B.vdi: AFTER attaching B.vdi:
10409
10410	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
10411	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
10412	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
10413	Snapshot 4 (none) Snapshot 4 (none)
10414	CurState (none) CurState (D3->D2.vdi)
10415
10416	NOT
10417	...
10418	CurState (D3->B.vdi)
10419	</pre>
10420	The first column is the virtual machine configuration before the base hard
10421	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
10422	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
10423	mean that the hard disk that is actually attached to the machine is a
10424	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
10425	another hard disk, <tt>B.vdi</tt>.
10426
10427	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
10428	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
10429	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
10430	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
10431	it cannot be attached directly and needs an indirect attachment (i.e.
10432	implicit creation of a new differencing hard disk). Due to the smart
10433	attachment procedure, the new differencing hard disk
10434	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
10435	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
10436	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
10437	machine.
10438
10439	Note that if there is more than one descendant hard disk of the given base
10440	hard disk found in a snapshot, and there is an exact device, channel and
10441	bus match, then this exact match will be used. Otherwise, the youngest
10442	descendant will be picked up.
10443
10444	There is one more important aspect of the smart attachment procedure which
10445	is not related to snapshots at all. Before walking through the snapshots
10446	as described above, the backup copy of the current list of hard disk
10447	attachment is searched for descendants. This backup copy is created when
10448	the hard disk configuration is changed for the first time after the last
10449	<link to="IMachine::saveSettings"/> call and used by
10450	<link to="IMachine::discardSettings"/> to undo the recent hard disk
10451	changes. When such a descendant is found in this backup copy, it will be
10452	simply re-attached back, without creating a new differencing hard disk for
10453	it. This optimization is necessary to make it possible to re-attach the
10454	base or immutable hard disk to a different bus, channel or device slot
10455	without losing the contents of the differencing hard disk actually
10456	attached to the machine in place of it.
10457
10458	</desc>
10459
10460	<attribute name="medium" type="IMedium" readonly="yes">
10461	<desc>Medium object associated with this attachment; it
10462	can be @c null for removable devices.</desc>
10463	</attribute>
10464
10465	<attribute name="controller" type="wstring" readonly="yes">
10466	<desc>Name of the storage controller of this attachment; this
10467	refers to one of the controllers in <link to="IMachine::storageControllers" />
10468	by name.</desc>
10469	</attribute>
10470
10471	<attribute name="port" type="long" readonly="yes">
10472	<desc>Port number of this attachment.
10473	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10474	</desc>
10475	</attribute>
10476
10477	<attribute name="device" type="long" readonly="yes">
10478	<desc>Device slot number of this attachment.
10479	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10480	</desc>
10481	</attribute>
10482
10483	<attribute name="type" type="DeviceType" readonly="yes">
10484	<desc>Device type of this attachment.</desc>
10485	</attribute>
10486
10487	<attribute name="passthrough" type="boolean" readonly="yes">
10488	<desc>Pass I/O requests through to a device on the host.</desc>
10489	</attribute>
10490
10491	<attribute name="temporaryEject" type="boolean" readonly="yes">
10492	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
10493	</attribute>
10494
10495	<attribute name="isEjected" type="boolean" readonly="yes">
10496	<desc>Signals that the removable medium has been ejected. This is not
10497	necessarily equivalent to having a @c null medium association.</desc>
10498	</attribute>
10499
10500	<attribute name="nonRotational" type="boolean" readonly="yes">
10501	<desc>Whether the associated medium is non-rotational.</desc>
10502	</attribute>
10503
10504	<attribute name="discard" type="boolean" readonly="yes">
10505	<desc>Whether the associated medium supports discarding unused blocks.</desc>
10506	</attribute>
10507
10508	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
10509	<desc>The bandwidth group this medium attachment is assigned to.</desc>
10510	</attribute>
10511
10512	</interface>
10513
10514	<interface
10515	name="IMedium" extends="$unknown"
10516	uuid="53f9cc0c-e0fd-40a5-a404-a7a5272082cd"
10517	wsmap="managed"
10518	>
10519	<desc>
10520	The IMedium interface represents virtual storage for a machine's
10521	hard disks, CD/DVD or floppy drives. It will typically represent
10522	a disk image on the host, for example a VDI or VMDK file representing
10523	a virtual hard disk, or an ISO or RAW file representing virtual
10524	removable media, but can also point to a network location (e.g.
10525	for iSCSI targets).
10526
10527	Instances of IMedium are connected to virtual machines by way of medium
10528	attachments, which link the storage medium to a particular device slot
10529	of a storage controller of the virtual machine.
10530	In the VirtualBox API, virtual storage is therefore always represented
10531	by the following chain of object links:
10532
10533	<ul>
10534	<li><link to="IMachine::storageControllers"/> contains an array of
10535	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
10536	these are instances of <link to="IStorageController"/>).</li>
10537	<li><link to="IMachine::mediumAttachments"/> contains an array of
10538	medium attachments (instances of <link to="IMediumAttachment"/>
10539	created by <link to="IMachine::attachDevice" />),
10540	each containing a storage controller from the above array, a
10541	port/device specification, and an instance of IMedium representing
10542	the medium storage (image file).
10543
10544	For removable media, the storage medium is optional; a medium
10545	attachment with no medium represents a CD/DVD or floppy drive
10546	with no medium inserted. By contrast, hard disk attachments
10547	will always have an IMedium object attached.</li>
10548	<li>Each IMedium in turn points to a storage unit (such as a file
10549	on the host computer or a network resource) that holds actual
10550	data. This location is represented by the <link to="#location"/>
10551	attribute.</li>
10552	</ul>
10553
10554	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
10555	new hard disk media can be created with the VirtualBox API using the
10556	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
10557	disks (see below) are usually implicitly created by VirtualBox as
10558	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
10559	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
10560	should be created with external tools and then opened from within VirtualBox.
10561
10562	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
10563	drive. In that case the <link to="#id" /> attribute contains the UUID of
10564	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
10565
10566	<h3>Media registries</h3>
10567
10568	When a medium has been opened or created using one of the aforementioned
10569	APIs, it becomes "known" to VirtualBox. Known media can be attached
10570	to virtual machines and re-found through <link to="IVirtualBox::openMedium"/>.
10571	They also appear in the global
10572	<link to="IVirtualBox::hardDisks" />,
10573	<link to="IVirtualBox::DVDImages" /> and
10574	<link to="IVirtualBox::floppyImages" /> arrays.
10575
10576	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
10577	in the VirtualBox.xml file, which was shared between all machines and made
10578	transporting machines and their media from one host to another difficult.
10579
10580	Starting with VirtualBox 4.0, media are only added to a registry when they are
10581	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
10582	backwards compatibility, which registry a medium is added to depends on which
10583	VirtualBox version created a machine:
10584
10585	<ul>
10586	<li>If the medium has first been attached to a machine which was created by
10587	VirtualBox 4.0 or later, it is added to that machine's media registry in
10588	the machine XML settings file. This way all information about a machine's
10589	media attachments is contained in a single file and can be transported
10590	easily.</li>
10591	<li>For older media attachments (i.e. if the medium was first attached to a
10592	machine which was created with a VirtualBox version before 4.0), media
10593	continue to be registered in the global VirtualBox settings file, for
10594	backwards compatibility.</li>
10595	</ul>
10596
10597	See <link to="IVirtualBox::openMedium" /> for more information.
10598
10599	Media are removed from media registries by the <link to="IMedium::close"/>,
10600	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
10601
10602	<h3>Accessibility checks</h3>
10603
10604	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
10605	method is called explicitly on a medium. This is done to make the VirtualBox object
10606	ready for serving requests as fast as possible and let the end-user
10607	application decide if it needs to check media accessibility right away or not.
10608
10609	As a result, when VirtualBox starts up (e.g. the VirtualBox
10610	object gets created for the first time), all known media are in the
10611	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
10612	attribute is an empty string because no actual accessibility check has
10613	been made yet.
10614
10615	After calling <link to="#refreshState" />, a medium is considered
10616	<i>accessible</i> if its storage unit can be read. In that case, the
10617	<link to="#state"/> attribute has a value of "Created". If the storage
10618	unit cannot be read (for example, because it is located on a disconnected
10619	network resource, or was accidentally deleted outside VirtualBox),
10620	the medium is considered <i>inaccessible</i>, which is indicated by the
10621	"Inaccessible" state. The exact reason why the medium is inaccessible can be
10622	obtained by reading the <link to="#lastAccessError"/> attribute.
10623
10624	<h3>Medium types</h3>
10625
10626	There are five types of medium behavior which are stored in the
10627	<link to="#type"/> attribute (see <link to="MediumType" />) and
10628	which define the medium's behavior with attachments and snapshots.
10629
10630	All media can be also divided in two groups: <i>base</i> media and
10631	<i>differencing</i> media. A base medium contains all sectors of the
10632	medium data in its own storage and therefore can be used independently.
10633	In contrast, a differencing medium is a "delta" to some other medium and
10634	contains only those sectors which differ from that other medium, which is
10635	then called a <i>parent</i>. The differencing medium is said to be
10636	<i>linked to</i> that parent. The parent may be itself a differencing
10637	medium, thus forming a chain of linked media. The last element in that
10638	chain must always be a base medium. Note that several differencing
10639	media may be linked to the same parent medium.
10640
10641	Differencing media can be distinguished from base media by querying the
10642	<link to="#parent"/> attribute: base media do not have parents they would
10643	depend on, so the value of this attribute is always @c null for them.
10644	Using this attribute, it is possible to walk up the medium tree (from the
10645	child medium to its parent). It is also possible to walk down the tree
10646	using the <link to="#children"/> attribute.
10647
10648	Note that the type of all differencing media is "normal"; all other
10649	values are meaningless for them. Base media may be of any type.
10650
10651	<h3>Automatic composition of the file name part</h3>
10652
10653	Another extension to the <link to="IMedium::location"/> attribute is that
10654	there is a possibility to cause VirtualBox to compose a unique value for
10655	the file name part of the location using the UUID of the hard disk. This
10656	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
10657	e.g. before the storage unit is created, and works as follows. You set the
10658	value of the <link to="IMedium::location"/> attribute to a location
10659	specification which only contains the path specification but not the file
10660	name part and ends with either a forward slash or a backslash character.
10661	In response, VirtualBox will generate a new UUID for the hard disk and
10662	compose the file name using the following pattern:
10663	<pre>
10664	<path>/{<uuid>}.<ext>
10665	</pre>
10666	where <tt><path></tt> is the supplied path specification,
10667	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
10668	is the default extension for the storage format of this hard disk. After
10669	that, you may call any of the methods that create a new hard disk storage
10670	unit and they will use the generated UUID and file name.
10671	</desc>
10672
10673	<attribute name="id" type="uuid" mod="string" readonly="yes">
10674	<desc>
10675	UUID of the medium. For a newly created medium, this value is a randomly
10676	generated UUID.
10677
10678	<note>
10679	For media in one of MediumState_NotCreated, MediumState_Creating or
10680	MediumState_Deleting states, the value of this property is undefined
10681	and will most likely be an empty UUID.
10682	</note>
10683	</desc>
10684	</attribute>
10685
10686	<attribute name="description" type="wstring">
10687	<desc>
10688	Optional description of the medium. For a newly created medium the value
10689	of this attribute is an empty string.
10690
10691	Medium types that don't support this attribute will return E_NOTIMPL in
10692	attempt to get or set this attribute's value.
10693
10694	<note>
10695	For some storage types, reading this attribute may return an outdated
10696	(last known) value when <link to="#state"/> is <link
10697	to="MediumState_Inaccessible"/> or <link
10698	to="MediumState_LockedWrite"/> because the value of this attribute is
10699	stored within the storage unit itself. Also note that changing the
10700	attribute value is not possible in such case, as well as when the
10701	medium is the <link to="MediumState_LockedRead"/> state.
10702	</note>
10703	</desc>
10704	</attribute>
10705
10706	<attribute name="state" type="MediumState" readonly="yes">
10707	<desc>
10708	Returns the current medium state, which is the last state set by
10709	the accessibility check performed by <link to="#refreshState"/>.
10710	If that method has not yet been called on the medium, the state
10711	is "Inaccessible"; as opposed to truly inaccessible media, the
10712	value of <link to="#lastAccessError"/> will be an empty string in
10713	that case.
10714
10715	<note>As of version 3.1, this no longer performs an accessibility check
10716	automatically; call <link to="#refreshState"/> for that.
10717	</note>
10718	</desc>
10719	</attribute>
10720
10721	<attribute name="variant" type="unsigned long" readonly="yes">
10722	<desc>
10723	Returns the storage format variant information for this medium
10724	as a combination of the flags described at <link to="MediumVariant" />.
10725	Before <link to="#refreshState"/> is called this method returns
10726	an undefined value.
10727	</desc>
10728	</attribute>
10729
10730	<attribute name="location" type="wstring">
10731	<desc>
10732	Location of the storage unit holding medium data.
10733
10734	The format of the location string is medium type specific. For medium
10735	types using regular files in a host's file system, the location
10736	string is the full file name.
10737
10738	Some medium types may support changing the storage unit location by
10739	simply changing the value of this property. If this operation is not
10740	supported, the implementation will return E_NOTIMPL in attempt to set
10741	this attribute's value.
10742
10743	When setting a value of the location attribute which is a regular file
10744	in the host's file system, the given file name may be either relative to
10745	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
10746	absolute. Note that if the given location specification does not contain
10747	the file extension part then a proper default extension will be
10748	automatically appended by the implementation depending on the medium type.
10749	</desc>
10750	</attribute>
10751
10752	<attribute name="name" type="wstring" readonly="yes">
10753	<desc>
10754	Name of the storage unit holding medium data.
10755
10756	The returned string is a short version of the <link to="#location"/>
10757	attribute that is suitable for representing the medium in situations
10758	where the full location specification is too long (such as lists
10759	and comboboxes in GUI frontends). This string is also used by frontends
10760	to sort the media list alphabetically when needed.
10761
10762	For example, for locations that are regular files in the host's file
10763	system, the value of this attribute is just the file name (+ extension),
10764	without the path specification.
10765
10766	Note that as opposed to the <link to="#location"/> attribute, the name
10767	attribute will not necessary be unique for a list of media of the
10768	given type and format.
10769	</desc>
10770	</attribute>
10771
10772	<attribute name="deviceType" type="DeviceType" readonly="yes">
10773	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
10774	medium.</desc>
10775	</attribute>
10776
10777	<attribute name="hostDrive" type="boolean" readonly="yes">
10778	<desc>True if this corresponds to a drive on the host.</desc>
10779	</attribute>
10780
10781	<attribute name="size" type="long long" readonly="yes">
10782	<desc>
10783	Physical size of the storage unit used to hold medium data (in bytes).
10784
10785	<note>
10786	For media whose <link to="#state"/> is <link
10787	to="MediumState_Inaccessible"/>, the value of this property is the
10788	last known size. For <link to="MediumState_NotCreated"/> media,
10789	the returned value is zero.
10790	</note>
10791	</desc>
10792	</attribute>
10793
10794	<attribute name="format" type="wstring" readonly="yes">
10795	<desc>
10796	Storage format of this medium.
10797
10798	The value of this attribute is a string that specifies a backend used
10799	to store medium data. The storage format is defined when you create a
10800	new medium or automatically detected when you open an existing medium,
10801	and cannot be changed later.
10802
10803	The list of all storage formats supported by this VirtualBox
10804	installation can be obtained using
10805	<link to="ISystemProperties::mediumFormats"/>.
10806	</desc>
10807	</attribute>
10808
10809	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
10810	<desc>
10811	Storage medium format object corresponding to this medium.
10812
10813	The value of this attribute is a reference to the medium format object
10814	that specifies the backend properties used to store medium data. The
10815	storage format is defined when you create a new medium or automatically
10816	detected when you open an existing medium, and cannot be changed later.
10817
10818	<note>@c null is returned if there is no associated medium format
10819	object. This can e.g. happen for medium objects representing host
10820	drives and other special medium objects.</note>
10821	</desc>
10822	</attribute>
10823
10824	<attribute name="type" type="MediumType">
10825	<desc>
10826	Type (role) of this medium.
10827
10828	The following constraints apply when changing the value of this
10829	attribute:
10830	<ul>
10831	<li>If a medium is attached to a virtual machine (either in the
10832	current state or in one of the snapshots), its type cannot be
10833	changed.
10834	</li>
10835	<li>As long as the medium has children, its type cannot be set
10836	to <link to="MediumType_Writethrough"/>.
10837	</li>
10838	<li>The type of all differencing media is
10839	<link to="MediumType_Normal"/> and cannot be changed.
10840	</li>
10841	</ul>
10842
10843	The type of a newly created or opened medium is set to
10844	<link to="MediumType_Normal"/>, except for DVD and floppy media,
10845	which have a type of <link to="MediumType_Writethrough"/>.
10846	</desc>
10847	</attribute>
10848
10849	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
10850	<desc>
10851	Returns which medium types can selected for this medium.
10852
10853	<result name="E_NOTIMPL">
10854	This attribute is not implemented at the moment.
10855	</result>
10856	</desc>
10857	</attribute>
10858
10859	<attribute name="parent" type="IMedium" readonly="yes">
10860	<desc>
10861	Parent of this medium (the medium this medium is directly based
10862	on).
10863
10864	Only differencing media have parents. For base (non-differencing)
10865	media, @c null is returned.
10866	</desc>
10867	</attribute>
10868
10869	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
10870	<desc>
10871	Children of this medium (all differencing media directly based
10872	on this medium). A @c null array is returned if this medium
10873	does not have any children.
10874	</desc>
10875	</attribute>
10876
10877	<attribute name="base" type="IMedium" readonly="yes">
10878	<desc>
10879	Base medium of this medium.
10880
10881	If this is a differencing medium, its base medium is the medium
10882	the given medium branch starts from. For all other types of media, this
10883	property returns the medium object itself (i.e. the same object this
10884	property is read on).
10885	</desc>
10886	</attribute>
10887
10888	<attribute name="readOnly" type="boolean" readonly="yes">
10889	<desc>
10890	Returns @c true if this medium is read-only and @c false otherwise.
10891
10892	A medium is considered to be read-only when its contents cannot be
10893	modified without breaking the integrity of other parties that depend on
10894	this medium such as its child media or snapshots of virtual machines
10895	where this medium is attached to these machines. If there are no
10896	children and no such snapshots then there is no dependency and the
10897	medium is not read-only.
10898
10899	The value of this attribute can be used to determine the kind of the
10900	attachment that will take place when attaching this medium to a
10901	virtual machine. If the value is @c false then the medium will
10902	be attached directly. If the value is @c true then the medium
10903	will be attached indirectly by creating a new differencing child
10904	medium for that. See the interface description for more information.
10905
10906	Note that all <link to="MediumType_Immutable">Immutable</link> media
10907	are always read-only while all
10908	<link to="MediumType_Writethrough">Writethrough</link> media are
10909	always not.
10910
10911	<note>
10912	The read-only condition represented by this attribute is related to
10913	the medium type and usage, not to the current
10914	<link to="IMedium::state">medium state</link> and not to the read-only
10915	state of the storage unit.
10916	</note>
10917	</desc>
10918	</attribute>
10919
10920	<attribute name="logicalSize" type="long long" readonly="yes">
10921	<desc>
10922	Logical size of this medium (in bytes), as reported to the
10923	guest OS running inside the virtual machine this medium is
10924	attached to. The logical size is defined when the medium is created
10925	and cannot be changed later.
10926
10927	<note>
10928	Reading this property on a differencing medium will return the size
10929	of its <link to="#base"/> medium.
10930	</note>
10931	<note>
10932	For media whose state is <link to="#state"/> is <link
10933	to="MediumState_Inaccessible"/>, the value of this property is the
10934	last known logical size. For <link to="MediumState_NotCreated"/>
10935	media, the returned value is zero.
10936	</note>
10937	</desc>
10938	</attribute>
10939
10940	<attribute name="autoReset" type="boolean">
10941	<desc>
10942	Whether this differencing medium will be automatically reset each
10943	time a virtual machine it is attached to is powered up. This
10944	attribute is automatically set to @c true for the last
10945	differencing image of an "immutable" medium (see
10946	<link to="MediumType" />).
10947
10948	See <link to="#reset"/> for more information about resetting
10949	differencing media.
10950
10951	<note>
10952	Reading this property on a base (non-differencing) medium will
10953	always @c false. Changing the value of this property in this
10954	case is not supported.
10955	</note>
10956
10957	<result name="VBOX_E_NOT_SUPPORTED">
10958	This is not a differencing medium (when changing the attribute
10959	value).
10960	</result>
10961	</desc>
10962	</attribute>
10963
10964	<attribute name="lastAccessError" type="wstring" readonly="yes">
10965	<desc>
10966	Text message that represents the result of the last accessibility
10967	check performed by <link to="#refreshState"/>.
10968
10969	An empty string is returned if the last accessibility check
10970	was successful or has not yet been called. As a result, if
10971	<link to="#state" /> is "Inaccessible" and this attribute is empty,
10972	then <link to="#refreshState"/> has yet to be called; this is the
10973	default value of media after VirtualBox initialization.
10974	A non-empty string indicates a failure and should normally describe
10975	a reason of the failure (for example, a file read error).
10976	</desc>
10977	</attribute>
10978
10979	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
10980	<desc>
10981	Array of UUIDs of all machines this medium is attached to.
10982
10983	A @c null array is returned if this medium is not attached to any
10984	machine or to any machine's snapshot.
10985
10986	<note>
10987	The returned array will include a machine even if this medium is not
10988	attached to that machine in the current state but attached to it in
10989	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
10990	details.
10991	</note>
10992	</desc>
10993	</attribute>
10994
10995	<method name="setIDs">
10996	<desc>
10997	Changes the UUID and parent UUID for a hard disk medium.
10998	</desc>
10999	<param name="setImageId" type="boolean" dir="in">
11000	<desc>
11001	Select whether a new image UUID is set or not.
11002	</desc>
11003	</param>
11004	<param name="imageId" type="uuid" mod="string" dir="in">
11005	<desc>
11006	New UUID for the image. If an empty string is passed, then a new
11007	UUID is automatically created, provided that @a setImageId is @c true.
11008	Specifying a zero UUID is not allowed.
11009	</desc>
11010	</param>
11011	<param name="setParentId" type="boolean" dir="in">
11012	<desc>
11013	Select whether a new parent UUID is set or not.
11014	</desc>
11015	</param>
11016	<param name="parentId" type="uuid" mod="string" dir="in">
11017	<desc>
11018	New parent UUID for the image. If an empty string is passed, then a
11019	new UUID is automatically created, provided @a setParentId is
11020	@c true. A zero UUID is valid.
11021	</desc>
11022	</param>
11023	<result name="E_INVALIDARG">
11024	Invalid parameter combination.
11025	</result>
11026	<result name="VBOX_E_NOT_SUPPORTED">
11027	Medium is not a hard disk medium.
11028	</result>
11029	</method>
11030
11031	<method name="refreshState">
11032	<desc>
11033	If the current medium state (see <link to="MediumState"/>) is one of
11034	"Created", "Inaccessible" or "LockedRead", then this performs an
11035	accessibility check on the medium and sets the value of the <link to="#state"/>
11036	attribute accordingly; that value is also returned for convenience.
11037
11038	For all other state values, this does not perform a refresh but returns
11039	the state only.
11040
11041	The refresh, if performed, may take a long time (several seconds or even
11042	minutes, depending on the storage unit location and format) because it performs an
11043	accessibility check of the storage unit. This check may cause a significant
11044	delay if the storage unit of the given medium is, for example, a file located
11045	on a network share which is not currently accessible due to connectivity
11046	problems. In that case, the call will not return until a timeout
11047	interval defined by the host OS for this operation expires. For this reason,
11048	it is recommended to never read this attribute on the main UI thread to avoid
11049	making the UI unresponsive.
11050
11051	If the last known state of the medium is "Created" and the accessibility
11052	check fails, then the state would be set to "Inaccessible", and
11053	<link to="#lastAccessError"/> may be used to get more details about the
11054	failure. If the state of the medium is "LockedRead", then it remains the
11055	same, and a non-empty value of <link to="#lastAccessError"/> will
11056	indicate a failed accessibility check in this case.
11057
11058	Note that not all medium states are applicable to all medium types.
11059	</desc>
11060	<param name="state" type="MediumState" dir="return">
11061	<desc>
11062	New medium state.
11063	</desc>
11064	</param>
11065	</method>
11066
11067	<method name="getSnapshotIds">
11068	<desc>
11069	Returns an array of UUIDs of all snapshots of the given machine where
11070	this medium is attached to.
11071
11072	If the medium is attached to the machine in the current state, then the
11073	first element in the array will always be the ID of the queried machine
11074	(i.e. the value equal to the @c machineId argument), followed by
11075	snapshot IDs (if any).
11076
11077	If the medium is not attached to the machine in the current state, then
11078	the array will contain only snapshot IDs.
11079
11080	The returned array may be @c null if this medium is not attached
11081	to the given machine at all, neither in the current state nor in one of
11082	the snapshots.
11083	</desc>
11084	<param name="machineId" type="uuid" mod="string" dir="in">
11085	<desc>
11086	UUID of the machine to query.
11087	</desc>
11088	</param>
11089	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
11090	<desc>
11091	Array of snapshot UUIDs of the given machine using this medium.
11092	</desc>
11093	</param>
11094	</method>
11095
11096	<method name="lockRead">
11097	<desc>
11098	Locks this medium for reading.
11099
11100	A read lock is shared: many clients can simultaneously lock the
11101	same medium for reading unless it is already locked for writing (see
11102	<link to="#lockWrite"/>) in which case an error is returned.
11103
11104	When the medium is locked for reading, it cannot be modified
11105	from within VirtualBox. This means that any method that changes
11106	the properties of this medium or contents of the storage unit
11107	will return an error (unless explicitly stated otherwise). That
11108	includes an attempt to start a virtual machine that wants to
11109	write to the the medium.
11110
11111	When the virtual machine is started up, it locks for reading all
11112	media it uses in read-only mode. If some medium cannot be locked
11113	for reading, the startup procedure will fail.
11114	A medium is typically locked for reading while it is used by a running
11115	virtual machine but has a depending differencing image that receives
11116	the actual write operations. This way one base medium can have
11117	multiple child differencing images which can be written to
11118	simultaneously. Read-only media such as DVD and floppy images are
11119	also locked for reading only (so they can be in use by multiple
11120	machines simultaneously).
11121
11122	A medium is also locked for reading when it is the source of a
11123	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
11124
11125	The medium locked for reading must be unlocked using the <link
11126	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
11127	can be nested and must be followed by the same number of paired
11128	<link to="#unlockRead"/> calls.
11129
11130	This method sets the medium state (see <link to="#state"/>) to
11131	"LockedRead" on success. The medium's previous state must be
11132	one of "Created", "Inaccessible" or "LockedRead".
11133
11134	Locking an inaccessible medium is not an error; this method performs
11135	a logical lock that prevents modifications of this medium through
11136	the VirtualBox API, not a physical file-system lock of the underlying
11137	storage unit.
11138
11139	This method returns the current state of the medium
11140	<i>before</i> the operation.
11141
11142	<result name="VBOX_E_INVALID_OBJECT_STATE">
11143	Invalid medium state (e.g. not created, locked, inaccessible,
11144	creating, deleting).
11145	</result>
11146
11147	</desc>
11148	<param name="state" type="MediumState" dir="return">
11149	<desc>
11150	State of the medium after the operation.
11151	</desc>
11152	</param>
11153	</method>
11154
11155	<method name="unlockRead">
11156	<desc>
11157	Cancels the read lock previously set by <link to="#lockRead"/>.
11158
11159	For both success and failure, this method returns the current state
11160	of the medium <i>after</i> the operation.
11161
11162	See <link to="#lockRead"/> for more details.
11163
11164	<result name="VBOX_E_INVALID_OBJECT_STATE">
11165	Medium not locked for reading.
11166	</result>
11167
11168	</desc>
11169	<param name="state" type="MediumState" dir="return">
11170	<desc>
11171	State of the medium after the operation.
11172	</desc>
11173	</param>
11174	</method>
11175
11176	<method name="lockWrite">
11177	<desc>
11178	Locks this medium for writing.
11179
11180	A write lock, as opposed to <link to="#lockRead"/>, is
11181	exclusive: there may be only one client holding a write lock,
11182	and there may be no read locks while the write lock is held.
11183	As a result, read-locking fails if a write lock is held, and
11184	write-locking fails if either a read or another write lock is held.
11185
11186	When a medium is locked for writing, it cannot be modified
11187	from within VirtualBox, and it is not guaranteed that the values
11188	of its properties are up-to-date. Any method that changes the
11189	properties of this medium or contents of the storage unit will
11190	return an error (unless explicitly stated otherwise).
11191
11192	When a virtual machine is started up, it locks for writing all
11193	media it uses to write data to. If any medium could not be locked
11194	for writing, the startup procedure will fail. If a medium has
11195	differencing images, then while the machine is running, only
11196	the last ("leaf") differencing image is locked for writing,
11197	whereas its parents are locked for reading only.
11198
11199	A medium is also locked for writing when it is the target of a
11200	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
11201
11202	The medium locked for writing must be unlocked using the <link
11203	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
11204
11205	This method sets the medium state (see <link to="#state"/>) to
11206	"LockedWrite" on success. The medium's previous state must be
11207	either "Created" or "Inaccessible".
11208
11209	Locking an inaccessible medium is not an error; this method performs
11210	a logical lock that prevents modifications of this medium through
11211	the VirtualBox API, not a physical file-system lock of the underlying
11212	storage unit.
11213
11214	For both, success and failure, this method returns the current
11215	state of the medium <i>before</i> the operation.
11216
11217	<result name="VBOX_E_INVALID_OBJECT_STATE">
11218	Invalid medium state (e.g. not created, locked, inaccessible,
11219	creating, deleting).
11220	</result>
11221
11222	</desc>
11223	<param name="state" type="MediumState" dir="return">
11224	<desc>
11225	State of the medium after the operation.
11226	</desc>
11227	</param>
11228	</method>
11229
11230	<method name="unlockWrite">
11231	<desc>
11232	Cancels the write lock previously set by <link to="#lockWrite"/>.
11233
11234	For both success and failure, this method returns the current
11235	state of the medium <i>after</i> the operation.
11236
11237	See <link to="#lockWrite"/> for more details.
11238
11239	<result name="VBOX_E_INVALID_OBJECT_STATE">
11240	Medium not locked for writing.
11241	</result>
11242
11243	</desc>
11244	<param name="state" type="MediumState" dir="return">
11245	<desc>
11246	State of the medium after the operation.
11247	</desc>
11248	</param>
11249	</method>
11250
11251	<method name="close">
11252	<desc>
11253	Closes this medium.
11254
11255	The medium must not be attached to any known virtual machine
11256	and must not have any known child media, otherwise the
11257	operation will fail.
11258
11259	When the medium is successfully closed, it is removed from
11260	the list of registered media, but its storage unit is not
11261	deleted. In particular, this means that this medium can
11262	later be opened again using the <link to="IVirtualBox::openMedium"/>
11263	call.
11264
11265	Note that after this method successfully returns, the given medium
11266	object becomes uninitialized. This means that any attempt
11267	to call any of its methods or attributes will fail with the
11268	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
11269
11270	<result name="VBOX_E_INVALID_OBJECT_STATE">
11271	Invalid medium state (other than not created, created or
11272	inaccessible).
11273	</result>
11274	<result name="VBOX_E_OBJECT_IN_USE">
11275	Medium attached to virtual machine.
11276	</result>
11277	<result name="VBOX_E_FILE_ERROR">
11278	Settings file not accessible.
11279	</result>
11280	<result name="VBOX_E_XML_ERROR">
11281	Could not parse the settings file.
11282	</result>
11283
11284	</desc>
11285	</method>
11286
11287	<!-- property methods -->
11288
11289	<method name="getProperty" const="yes">
11290	<desc>
11291	Returns the value of the custom medium property with the given name.
11292
11293	The list of all properties supported by the given medium format can
11294	be obtained with <link to="IMediumFormat::describeProperties"/>.
11295
11296	<note>If this method returns an empty string in @a value, the requested
11297	property is supported but currently not assigned any value.</note>
11298
11299	<result name="VBOX_E_OBJECT_NOT_FOUND">
11300	Requested property does not exist (not supported by the format).
11301	</result>
11302	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
11303	</desc>
11304	<param name="name" type="wstring" dir="in">
11305	<desc>Name of the property to get.</desc>
11306	</param>
11307	<param name="value" type="wstring" dir="return">
11308	<desc>Current property value.</desc>
11309	</param>
11310	</method>
11311
11312	<method name="setProperty">
11313	<desc>
11314	Sets the value of the custom medium property with the given name.
11315
11316	The list of all properties supported by the given medium format can
11317	be obtained with <link to="IMediumFormat::describeProperties"/>.
11318
11319	<note>Setting the property value to @c null or an empty string is
11320	equivalent to deleting the existing value. A default value (if it is
11321	defined for this property) will be used by the format backend in this
11322	case.</note>
11323
11324	<result name="VBOX_E_OBJECT_NOT_FOUND">
11325	Requested property does not exist (not supported by the format).
11326	</result>
11327	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
11328	</desc>
11329	<param name="name" type="wstring" dir="in">
11330	<desc>Name of the property to set.</desc>
11331	</param>
11332	<param name="value" type="wstring" dir="in">
11333	<desc>Property value to set.</desc>
11334	</param>
11335	</method>
11336
11337	<method name="getProperties" const="yes">
11338	<desc>
11339	Returns values for a group of properties in one call.
11340
11341	The names of the properties to get are specified using the @a names
11342	argument which is a list of comma-separated property names or
11343	an empty string if all properties are to be returned.
11344	<note>Currently the value of this argument is ignored and the method
11345	always returns all existing properties.</note>
11346
11347	The list of all properties supported by the given medium format can
11348	be obtained with <link to="IMediumFormat::describeProperties"/>.
11349
11350	The method returns two arrays, the array of property names corresponding
11351	to the @a names argument and the current values of these properties.
11352	Both arrays have the same number of elements with each element at the
11353	given index in the first array corresponds to an element at the same
11354	index in the second array.
11355
11356	For properties that do not have assigned values, an empty string is
11357	returned at the appropriate index in the @a returnValues array.
11358
11359	</desc>
11360	<param name="names" type="wstring" dir="in">
11361	<desc>
11362	Names of properties to get.
11363	</desc>
11364	</param>
11365	<param name="returnNames" type="wstring" safearray="yes" dir="out">
11366	<desc>Names of returned properties.</desc>
11367	</param>
11368	<param name="returnValues" type="wstring" safearray="yes" dir="return">
11369	<desc>Values of returned properties.</desc>
11370	</param>
11371	</method>
11372
11373	<method name="setProperties">
11374	<desc>
11375	Sets values for a group of properties in one call.
11376
11377	The names of the properties to set are passed in the @a names
11378	array along with the new values for them in the @a values array. Both
11379	arrays have the same number of elements with each element at the given
11380	index in the first array corresponding to an element at the same index
11381	in the second array.
11382
11383	If there is at least one property name in @a names that is not valid,
11384	the method will fail before changing the values of any other properties
11385	from the @a names array.
11386
11387	Using this method over <link to="#setProperty"/> is preferred if you
11388	need to set several properties at once since it is more efficient.
11389
11390	The list of all properties supported by the given medium format can
11391	be obtained with <link to="IMediumFormat::describeProperties"/>.
11392
11393	Setting the property value to @c null or an empty string is equivalent
11394	to deleting the existing value. A default value (if it is defined for
11395	this property) will be used by the format backend in this case.
11396	</desc>
11397	<param name="names" type="wstring" safearray="yes" dir="in">
11398	<desc>Names of properties to set.</desc>
11399	</param>
11400	<param name="values" type="wstring" safearray="yes" dir="in">
11401	<desc>Values of properties to set.</desc>
11402	</param>
11403	</method>
11404
11405	<!-- storage methods -->
11406
11407	<method name="createBaseStorage">
11408	<desc>
11409	Starts creating a hard disk storage unit (fixed/dynamic, according
11410	to the variant flags) in in the background. The previous storage unit
11411	created for this object, if any, must first be deleted using
11412	<link to="#deleteStorage"/>, otherwise the operation will fail.
11413
11414	Before the operation starts, the medium is placed in
11415	<link to="MediumState_Creating"/> state. If the create operation
11416	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
11417	state.
11418
11419	After the returned progress object reports that the operation has
11420	successfully completed, the medium state will be set to <link
11421	to="MediumState_Created"/>, the medium will be remembered by this
11422	VirtualBox installation and may be attached to virtual machines.
11423
11424	<result name="VBOX_E_NOT_SUPPORTED">
11425	The variant of storage creation operation is not supported. See <link
11426	to="IMediumFormat::capabilities"/>.
11427	</result>
11428	</desc>
11429	<param name="logicalSize" type="long long" dir="in">
11430	<desc>Maximum logical size of the medium in bytes.</desc>
11431	</param>
11432	<param name="variant" type="unsigned long" dir="in">
11433	<desc>Exact image variant which should be created (as a combination of
11434	<link to="MediumVariant" /> flags).</desc>
11435	</param>
11436	<param name="progress" type="IProgress" dir="return">
11437	<desc>Progress object to track the operation completion.</desc>
11438	</param>
11439	</method>
11440
11441	<method name="deleteStorage">
11442	<desc>
11443	Starts deleting the storage unit of this medium.
11444
11445	The medium must not be attached to any known virtual machine and must
11446	not have any known child media, otherwise the operation will fail.
11447	It will also fail if there is no storage unit to delete or if deletion
11448	is already in progress, or if the medium is being in use (locked for
11449	read or for write) or inaccessible. Therefore, the only valid state for
11450	this operation to succeed is <link to="MediumState_Created"/>.
11451
11452	Before the operation starts, the medium is placed in
11453	<link to="MediumState_Deleting"/> state and gets removed from the list
11454	of remembered hard disks (media registry). If the delete operation
11455	fails, the medium will be remembered again and placed back to
11456	<link to="MediumState_Created"/> state.
11457
11458	After the returned progress object reports that the operation is
11459	complete, the medium state will be set to
11460	<link to="MediumState_NotCreated"/> and you will be able to use one of
11461	the storage creation methods to create it again.
11462
11463	<see><link to="#close"/></see>
11464
11465	<result name="VBOX_E_OBJECT_IN_USE">
11466	Medium is attached to a virtual machine.
11467	</result>
11468	<result name="VBOX_E_NOT_SUPPORTED">
11469	Storage deletion is not allowed because neither of storage creation
11470	operations are supported. See
11471	<link to="IMediumFormat::capabilities"/>.
11472	</result>
11473
11474	<note>
11475	If the deletion operation fails, it is not guaranteed that the storage
11476	unit still exists. You may check the <link to="IMedium::state"/> value
11477	to answer this question.
11478	</note>
11479	</desc>
11480	<param name="progress" type="IProgress" dir="return">
11481	<desc>Progress object to track the operation completion.</desc>
11482	</param>
11483	</method>
11484
11485	<!-- diff methods -->
11486
11487	<method name="createDiffStorage">
11488	<desc>
11489	Starts creating an empty differencing storage unit based on this
11490	medium in the format and at the location defined by the @a target
11491	argument.
11492
11493	The target medium must be in <link to="MediumState_NotCreated"/>
11494	state (i.e. must not have an existing storage unit). Upon successful
11495	completion, this operation will set the type of the target medium to
11496	<link to="MediumType_Normal"/> and create a storage unit necessary to
11497	represent the differencing medium data in the given format (according
11498	to the storage format of the target object).
11499
11500	After the returned progress object reports that the operation is
11501	successfully complete, the target medium gets remembered by this
11502	VirtualBox installation and may be attached to virtual machines.
11503
11504	<note>
11505	The medium will be set to <link to="MediumState_LockedRead"/>
11506	state for the duration of this operation.
11507	</note>
11508	<result name="VBOX_E_OBJECT_IN_USE">
11509	Medium not in @c NotCreated state.
11510	</result>
11511	</desc>
11512	<param name="target" type="IMedium" dir="in">
11513	<desc>Target medium.</desc>
11514	</param>
11515	<param name="variant" type="unsigned long" dir="in">
11516	<desc>Exact image variant which should be created (as a combination of
11517	<link to="MediumVariant" /> flags).</desc>
11518	</param>
11519	<param name="progress" type="IProgress" dir="return">
11520	<desc>Progress object to track the operation completion.</desc>
11521	</param>
11522	</method>
11523
11524	<method name="mergeTo">
11525	<desc>
11526	Starts merging the contents of this medium and all intermediate
11527	differencing media in the chain to the given target medium.
11528
11529	The target medium must be either a descendant of this medium or
11530	its ancestor (otherwise this method will immediately return a failure).
11531	It follows that there are two logical directions of the merge operation:
11532	from ancestor to descendant (<i>forward merge</i>) and from descendant to
11533	ancestor (<i>backward merge</i>). Let us consider the following medium
11534	chain:
11535
11536	<pre>Base <- Diff_1 <- Diff_2</pre>
11537
11538	Here, calling this method on the <tt>Base</tt> medium object with
11539	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
11540	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
11541	merge. Note that in both cases the contents of the resulting medium
11542	will be the same, the only difference is the medium object that takes
11543	the result of the merge operation. In case of the forward merge in the
11544	above example, the result will be written to <tt>Diff_2</tt>; in case of
11545	the backward merge, the result will be written to <tt>Base</tt>. In
11546	other words, the result of the operation is always stored in the target
11547	medium.
11548
11549	Upon successful operation completion, the storage units of all media in
11550	the chain between this (source) medium and the target medium, including
11551	the source medium itself, will be automatically deleted and the
11552	relevant medium objects (including this medium) will become
11553	uninitialized. This means that any attempt to call any of
11554	their methods or attributes will fail with the
11555	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
11556	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
11557	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
11558	Note that <tt>Diff_2</tt> in this case will become a base medium
11559	itself since it will no longer be based on any other medium.
11560
11561	Considering the above, all of the following conditions must be met in
11562	order for the merge operation to succeed:
11563	<ul>
11564	<li>
11565	Neither this (source) medium nor any intermediate
11566	differencing medium in the chain between it and the target
11567	medium is attached to any virtual machine.
11568	</li>
11569	<li>
11570	Neither the source medium nor the target medium is an
11571	<link to="MediumType_Immutable"/> medium.
11572	</li>
11573	<li>
11574	The part of the medium tree from the source medium to the
11575	target medium is a linear chain, i.e. all medium in this
11576	chain have exactly one child which is the next medium in this
11577	chain. The only exception from this rule is the target medium in
11578	the forward merge operation; it is allowed to have any number of
11579	child media because the merge operation will not change its
11580	logical contents (as it is seen by the guest OS or by children).
11581	</li>
11582	<li>
11583	None of the involved media are in
11584	<link to="MediumState_LockedRead"/> or
11585	<link to="MediumState_LockedWrite"/> state.
11586	</li>
11587	</ul>
11588
11589	<note>
11590	This (source) medium and all intermediates will be placed to <link
11591	to="MediumState_Deleting"/> state and the target medium will be
11592	placed to <link to="MediumState_LockedWrite"/> state and for the
11593	duration of this operation.
11594	</note>
11595	</desc>
11596	<param name="target" type="IMedium" dir="in">
11597	<desc>Target medium.</desc>
11598	</param>
11599	<param name="progress" type="IProgress" dir="return">
11600	<desc>Progress object to track the operation completion.</desc>
11601	</param>
11602	</method>
11603
11604	<!-- clone method -->
11605
11606	<method name="cloneTo">
11607	<desc>
11608	Starts creating a clone of this medium in the format and at the
11609	location defined by the @a target argument.
11610
11611	The target medium must be either in <link to="MediumState_NotCreated"/>
11612	state (i.e. must not have an existing storage unit) or in
11613	<link to="MediumState_Created"/> state (i.e. created and not locked, and
11614	big enough to hold the data or else the copy will be partial). Upon
11615	successful completion, the cloned medium will contain exactly the
11616	same sector data as the medium being cloned, except that in the
11617	first case a new UUID for the clone will be randomly generated, and in
11618	the second case the UUID will remain unchanged.
11619
11620	The @a parent argument defines which medium will be the parent
11621	of the clone. Passing a @c null reference indicates that the clone will
11622	be a base image, i.e. completely independent. It is possible to specify
11623	an arbitrary medium for this parameter, including the parent of the
11624	medium which is being cloned. Even cloning to a child of the source
11625	medium is possible. Note that when cloning to an existing image, the
11626	@a parent argument is ignored.
11627
11628	After the returned progress object reports that the operation is
11629	successfully complete, the target medium gets remembered by this
11630	VirtualBox installation and may be attached to virtual machines.
11631
11632	<note>
11633	This medium will be placed to <link to="MediumState_LockedRead"/>
11634	state for the duration of this operation.
11635	</note>
11636	<result name="E_NOTIMPL">
11637	The specified cloning variant is not supported at the moment.
11638	</result>
11639	</desc>
11640	<param name="target" type="IMedium" dir="in">
11641	<desc>Target medium.</desc>
11642	</param>
11643	<param name="variant" type="unsigned long" dir="in">
11644	<desc>Exact image variant which should be created (as a combination of
11645	<link to="MediumVariant" /> flags).</desc>
11646	</param>
11647	<param name="parent" type="IMedium" dir="in">
11648	<desc>Parent of the cloned medium.</desc>
11649	</param>
11650	<param name="progress" type="IProgress" dir="return">
11651	<desc>Progress object to track the operation completion.</desc>
11652	</param>
11653	</method>
11654
11655	<!-- other methods -->
11656
11657	<method name="compact">
11658	<desc>
11659	Starts compacting of this medium. This means that the medium is
11660	transformed into a possibly more compact storage representation.
11661	This potentially creates temporary images, which can require a
11662	substantial amount of additional disk space.
11663
11664	This medium will be placed to <link to="MediumState_LockedWrite"/>
11665	state and all its parent media (if any) will be placed to
11666	<link to="MediumState_LockedRead"/> state for the duration of this
11667	operation.
11668
11669	Please note that the results can be either returned straight away,
11670	or later as the result of the background operation via the object
11671	returned via the @a progress parameter.
11672
11673	<result name="VBOX_E_NOT_SUPPORTED">
11674	Medium format does not support compacting (but potentially
11675	needs it).
11676	</result>
11677	</desc>
11678	<param name="progress" type="IProgress" dir="return">
11679	<desc>Progress object to track the operation completion.</desc>
11680	</param>
11681	</method>
11682
11683	<method name="resize">
11684	<desc>
11685	Starts resizing this medium. This means that the nominal size of the
11686	medium is set to the new value. Both increasing and decreasing the
11687	size is possible, and there are no safety checks, since VirtualBox
11688	does not make any assumptions about the medium contents.
11689
11690	Resizing usually needs additional disk space, and possibly also
11691	some temporary disk space. Note that resize does not create a full
11692	temporary copy of the medium, so the additional disk space requirement
11693	is usually much lower than using the clone operation.
11694
11695	This medium will be placed to <link to="MediumState_LockedWrite"/>
11696	state for the duration of this operation.
11697
11698	Please note that the results can be either returned straight away,
11699	or later as the result of the background operation via the object
11700	returned via the @a progress parameter.
11701
11702	<result name="VBOX_E_NOT_SUPPORTED">
11703	Medium format does not support resizing.
11704	</result>
11705	</desc>
11706	<param name="logicalSize" type="long long" dir="in">
11707	<desc>New nominal capacity of the medium in bytes.</desc>
11708	</param>
11709	<param name="progress" type="IProgress" dir="return">
11710	<desc>Progress object to track the operation completion.</desc>
11711	</param>
11712	</method>
11713
11714	<method name="reset">
11715	<desc>
11716	Starts erasing the contents of this differencing medium.
11717
11718	This operation will reset the differencing medium to its initial
11719	state when it does not contain any sector data and any read operation is
11720	redirected to its parent medium. This automatically gets called
11721	during VM power-up for every medium whose <link to="#autoReset" />
11722	attribute is @c true.
11723
11724	The medium will be write-locked for the duration of this operation (see
11725	<link to="#lockWrite" />).
11726
11727	<result name="VBOX_E_NOT_SUPPORTED">
11728	This is not a differencing medium.
11729	</result>
11730	<result name="VBOX_E_INVALID_OBJECT_STATE">
11731	Medium is not in <link to="MediumState_Created"/> or
11732	<link to="MediumState_Inaccessible"/> state.
11733	</result>
11734	</desc>
11735	<param name="progress" type="IProgress" dir="return">
11736	<desc>Progress object to track the operation completion.</desc>
11737	</param>
11738	</method>
11739
11740	</interface>
11741
11742
11743	<!--
11744	// IMediumFormat
11745	/////////////////////////////////////////////////////////////////////////
11746	-->
11747
11748	<enum
11749	name="DataType"
11750	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
11751	>
11752	<const name="Int32" value="0"/>
11753	<const name="Int8" value="1"/>
11754	<const name="String" value="2"/>
11755	</enum>
11756
11757	<enum
11758	name="DataFlags"
11759	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
11760	>
11761	<const name="None" value="0x00"/>
11762	<const name="Mandatory" value="0x01"/>
11763	<const name="Expert" value="0x02"/>
11764	<const name="Array" value="0x04"/>
11765	<const name="FlagMask" value="0x07"/>
11766	</enum>
11767
11768	<enum
11769	name="MediumFormatCapabilities"
11770	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
11771	>
11772	<desc>
11773	Medium format capability flags.
11774	</desc>
11775
11776	<const name="Uuid" value="0x01">
11777	<desc>
11778	Supports UUIDs as expected by VirtualBox code.
11779	</desc>
11780	</const>
11781
11782	<const name="CreateFixed" value="0x02">
11783	<desc>
11784	Supports creating fixed size images, allocating all space instantly.
11785	</desc>
11786	</const>
11787
11788	<const name="CreateDynamic" value="0x04">
11789	<desc>
11790	Supports creating dynamically growing images, allocating space on
11791	demand.
11792	</desc>
11793	</const>
11794
11795	<const name="CreateSplit2G" value="0x08">
11796	<desc>
11797	Supports creating images split in chunks of a bit less than 2 GBytes.
11798	</desc>
11799	</const>
11800
11801	<const name="Differencing" value="0x10">
11802	<desc>
11803	Supports being used as a format for differencing media (see <link
11804	to="IMedium::createDiffStorage"/>).
11805	</desc>
11806	</const>
11807
11808	<const name="Asynchronous" value="0x20">
11809	<desc>
11810	Supports asynchronous I/O operations for at least some configurations.
11811	</desc>
11812	</const>
11813
11814	<const name="File" value="0x40">
11815	<desc>
11816	The format backend operates on files (the <link to="IMedium::location"/>
11817	attribute of the medium specifies a file used to store medium
11818	data; for a list of supported file extensions see
11819	<link to="IMediumFormat::describeFileExtensions"/>).
11820	</desc>
11821	</const>
11822
11823	<const name="Properties" value="0x80">
11824	<desc>
11825	The format backend uses the property interface to configure the storage
11826	location and properties (the <link to="IMediumFormat::describeProperties"/>
11827	method is used to get access to properties supported by the given medium format).
11828	</desc>
11829	</const>
11830
11831	<const name="TcpNetworking" value="0x100">
11832	<desc>
11833	The format backend uses the TCP networking interface for network access.
11834	</desc>
11835	</const>
11836
11837	<const name="VFS" value="0x200">
11838	<desc>
11839	The format backend supports virtual filesystem functionality.
11840	</desc>
11841	</const>
11842
11843	<const name="CapabilityMask" value="0x3FF"/>
11844	</enum>
11845
11846	<interface
11847	name="IMediumFormat" extends="$unknown"
11848	uuid="9bd5b655-ea47-4637-99f3-aad0948be35b"
11849	wsmap="managed"
11850	>
11851	<desc>
11852	The IMediumFormat interface represents a medium format.
11853
11854	Each medium format has an associated backend which is used to handle
11855	media stored in this format. This interface provides information
11856	about the properties of the associated backend.
11857
11858	Each medium format is identified by a string represented by the
11859	<link to="#id"/> attribute. This string is used in calls like
11860	<link to="IVirtualBox::createHardDisk"/> to specify the desired
11861	format.
11862
11863	The list of all supported medium formats can be obtained using
11864	<link to="ISystemProperties::mediumFormats"/>.
11865
11866	<see><link to="IMedium"/></see>
11867	</desc>
11868
11869	<attribute name="id" type="wstring" readonly="yes">
11870	<desc>
11871	Identifier of this format.
11872
11873	The format identifier is a non-@c null non-empty ASCII string. Note that
11874	this string is case-insensitive. This means that, for example, all of
11875	the following strings:
11876	<pre>
11877	"VDI"
11878	"vdi"
11879	"VdI"</pre>
11880	refer to the same medium format.
11881
11882	This string is used in methods of other interfaces where it is necessary
11883	to specify a medium format, such as
11884	<link to="IVirtualBox::createHardDisk"/>.
11885	</desc>
11886	</attribute>
11887
11888	<attribute name="name" type="wstring" readonly="yes">
11889	<desc>
11890	Human readable description of this format.
11891
11892	Mainly for use in file open dialogs.
11893	</desc>
11894	</attribute>
11895
11896	<attribute name="capabilities" type="unsigned long" readonly="yes">
11897	<desc>
11898	Capabilities of the format as a set of bit flags.
11899
11900	For the meaning of individual capability flags see
11901	<link to="MediumFormatCapabilities"/>.
11902	</desc>
11903	</attribute>
11904
11905	<method name="describeFileExtensions">
11906	<desc>
11907	Returns two arrays describing the supported file extensions.
11908
11909	The first array contains the supported extensions and the seconds one
11910	the type each extension supports. Both have the same size.
11911
11912	Note that some backends do not work on files, so this array may be
11913	empty.
11914
11915	<see><link to="IMediumFormat::capabilities"/></see>
11916	</desc>
11917	<param name="extensions" type="wstring" safearray="yes" dir="out">
11918	<desc>The array of supported extensions.</desc>
11919	</param>
11920	<param name="type" type="DeviceType" safearray="yes" dir="out">
11921	<desc>The array which indicates the device type for every given extension.</desc>
11922	</param>
11923	</method>
11924
11925	<method name="describeProperties" const="yes">
11926	<desc>
11927	Returns several arrays describing the properties supported by this
11928	format.
11929
11930	An element with the given index in each array describes one
11931	property. Thus, the number of elements in each returned array is the
11932	same and corresponds to the number of supported properties.
11933
11934	The returned arrays are filled in only if the
11935	<link to="MediumFormatCapabilities_Properties"/> flag is set.
11936	All arguments must be non-@c null.
11937
11938	<see><link to="DataType"/>, <link to="DataFlags"/></see>
11939	</desc>
11940
11941	<param name="names" type="wstring" safearray="yes" dir="out">
11942	<desc>Array of property names.</desc>
11943	</param>
11944	<param name="description" type="wstring" safearray="yes" dir="out">
11945	<desc>Array of property descriptions.</desc>
11946	</param>
11947	<param name="types" type="DataType" safearray="yes" dir="out">
11948	<desc>Array of property types.</desc>
11949	</param>
11950	<param name="flags" type="unsigned long" safearray="yes" dir="out">
11951	<desc>Array of property flags.</desc>
11952	</param>
11953	<param name="defaults" type="wstring" safearray="yes" dir="out">
11954	<desc>Array of default property values.</desc>
11955	</param>
11956	</method>
11957
11958	</interface>
11959
11960
11961	<!--
11962	// IKeyboard
11963	/////////////////////////////////////////////////////////////////////////
11964	-->
11965
11966	<interface
11967	name="IKeyboard" extends="$unknown"
11968	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
11969	wsmap="managed"
11970	>
11971	<desc>
11972	The IKeyboard interface represents the virtual machine's keyboard. Used
11973	in <link to="IConsole::keyboard"/>.
11974
11975	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
11976	to the virtual machine.
11977
11978	</desc>
11979	<method name="putScancode">
11980	<desc>Sends a scancode to the keyboard.
11981
11982	<result name="VBOX_E_IPRT_ERROR">
11983	Could not send scan code to virtual keyboard.
11984	</result>
11985
11986	</desc>
11987	<param name="scancode" type="long" dir="in"/>
11988	</method>
11989
11990	<method name="putScancodes">
11991	<desc>Sends an array of scancodes to the keyboard.
11992
11993	<result name="VBOX_E_IPRT_ERROR">
11994	Could not send all scan codes to virtual keyboard.
11995	</result>
11996
11997	</desc>
11998	<param name="scancodes" type="long" dir="in" safearray="yes"/>
11999	<param name="codesStored" type="unsigned long" dir="return"/>
12000	</method>
12001
12002	<method name="putCAD">
12003	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
12004	function is nothing special, it is just a convenience function
12005	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
12006
12007	<result name="VBOX_E_IPRT_ERROR">
12008	Could not send all scan codes to virtual keyboard.
12009	</result>
12010
12011	</desc>
12012	</method>
12013
12014	<attribute name="eventSource" type="IEventSource" readonly="yes">
12015	<desc>
12016	Event source for keyboard events.
12017	</desc>
12018	</attribute>
12019
12020	</interface>
12021
12022
12023	<!--
12024	// IMouse
12025	/////////////////////////////////////////////////////////////////////////
12026	-->
12027
12028	<enum
12029	name="MouseButtonState"
12030	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
12031	>
12032	<desc>
12033	Mouse button state.
12034	</desc>
12035
12036	<const name="LeftButton" value="0x01"/>
12037	<const name="RightButton" value="0x02"/>
12038	<const name="MiddleButton" value="0x04"/>
12039	<const name="WheelUp" value="0x08"/>
12040	<const name="WheelDown" value="0x10"/>
12041	<const name="XButton1" value="0x20"/>
12042	<const name="XButton2" value="0x40"/>
12043	<const name="MouseStateMask" value="0x7F"/>
12044	</enum>
12045
12046	<interface
12047	name="IMouse" extends="$unknown"
12048	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
12049	wsmap="managed"
12050	>
12051	<desc>
12052	The IMouse interface represents the virtual machine's mouse. Used in
12053	<link to="IConsole::mouse"/>.
12054
12055	Through this interface, the virtual machine's virtual mouse can be
12056	controlled.
12057	</desc>
12058
12059	<attribute name="absoluteSupported" type="boolean" readonly="yes">
12060	<desc>
12061	Whether the guest OS supports absolute mouse pointer positioning
12062	or not.
12063	<note>
12064	You can use the <link to="IMouseCapabilityChangedEvent"/>
12065	event to be instantly informed about changes of this attribute
12066	during virtual machine execution.
12067	</note>
12068	<see><link to="#putMouseEventAbsolute"/></see>
12069	</desc>
12070	</attribute>
12071
12072	<attribute name="relativeSupported" type="boolean" readonly="yes">
12073	<desc>
12074	Whether the guest OS supports relative mouse pointer positioning
12075	or not.
12076	<note>
12077	You can use the <link to="IMouseCapabilityChangedEvent"/>
12078	event to be instantly informed about changes of this attribute
12079	during virtual machine execution.
12080	</note>
12081	<see><link to="#putMouseEvent"/></see>
12082	</desc>
12083	</attribute>
12084
12085	<attribute name="needsHostCursor" type="boolean" readonly="yes">
12086	<desc>
12087	Whether the guest OS can currently switch to drawing it's own mouse
12088	cursor on demand.
12089	<note>
12090	You can use the <link to="IMouseCapabilityChangedEvent"/>
12091	event to be instantly informed about changes of this attribute
12092	during virtual machine execution.
12093	</note>
12094	<see><link to="#putMouseEvent"/></see>
12095	</desc>
12096	</attribute>
12097
12098	<method name="putMouseEvent">
12099	<desc>
12100	Initiates a mouse event using relative pointer movements
12101	along x and y axis.
12102
12103	<result name="E_ACCESSDENIED">
12104	Console not powered up.
12105	</result>
12106	<result name="VBOX_E_IPRT_ERROR">
12107	Could not send mouse event to virtual mouse.
12108	</result>
12109
12110	</desc>
12111
12112	<param name="dx" type="long" dir="in">
12113	<desc>
12114	Amount of pixels the mouse should move to the right.
12115	Negative values move the mouse to the left.
12116	</desc>
12117	</param>
12118	<param name="dy" type="long" dir="in">
12119	<desc>
12120	Amount of pixels the mouse should move downwards.
12121	Negative values move the mouse upwards.
12122	</desc>
12123	</param>
12124	<param name="dz" type="long" dir="in">
12125	<desc>
12126	Amount of mouse wheel moves.
12127	Positive values describe clockwise wheel rotations,
12128	negative values describe counterclockwise rotations.
12129	</desc>
12130	</param>
12131	<param name="dw" type="long" dir="in">
12132	<desc>
12133	Amount of horizontal mouse wheel moves.
12134	Positive values describe a movement to the left,
12135	negative values describe a movement to the right.
12136	</desc>
12137	</param>
12138	<param name="buttonState" type="long" dir="in">
12139	<desc>
12140	The current state of mouse buttons. Every bit represents
12141	a mouse button as follows:
12142	<table>
12143	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
12144	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
12145	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
12146	</table>
12147	A value of <tt>1</tt> means the corresponding button is pressed.
12148	otherwise it is released.
12149	</desc>
12150	</param>
12151	</method>
12152
12153	<method name="putMouseEventAbsolute">
12154	<desc>
12155	Positions the mouse pointer using absolute x and y coordinates.
12156	These coordinates are expressed in pixels and
12157	start from <tt>[1,1]</tt> which corresponds to the top left
12158	corner of the virtual display.
12159
12160	<result name="E_ACCESSDENIED">
12161	Console not powered up.
12162	</result>
12163	<result name="VBOX_E_IPRT_ERROR">
12164	Could not send mouse event to virtual mouse.
12165	</result>
12166
12167	<note>
12168	This method will have effect only if absolute mouse
12169	positioning is supported by the guest OS.
12170	</note>
12171
12172	<see><link to="#absoluteSupported"/></see>
12173	</desc>
12174
12175	<param name="x" type="long" dir="in">
12176	<desc>
12177	X coordinate of the pointer in pixels, starting from @c 1.
12178	</desc>
12179	</param>
12180	<param name="y" type="long" dir="in">
12181	<desc>
12182	Y coordinate of the pointer in pixels, starting from @c 1.
12183	</desc>
12184	</param>
12185	<param name="dz" type="long" dir="in">
12186	<desc>
12187	Amount of mouse wheel moves.
12188	Positive values describe clockwise wheel rotations,
12189	negative values describe counterclockwise rotations.
12190	</desc>
12191	</param>
12192	<param name="dw" type="long" dir="in">
12193	<desc>
12194	Amount of horizontal mouse wheel moves.
12195	Positive values describe a movement to the left,
12196	negative values describe a movement to the right.
12197	</desc>
12198	</param>
12199	<param name="buttonState" type="long" dir="in">
12200	<desc>
12201	The current state of mouse buttons. Every bit represents
12202	a mouse button as follows:
12203	<table>
12204	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
12205	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
12206	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
12207	</table>
12208	A value of @c 1 means the corresponding button is pressed.
12209	otherwise it is released.
12210	</desc>
12211	</param>
12212	</method>
12213
12214	<attribute name="eventSource" type="IEventSource" readonly="yes">
12215	<desc>
12216	Event source for mouse events.
12217	</desc>
12218	</attribute>
12219
12220	</interface>
12221
12222	<!--
12223	// IDisplay
12224	/////////////////////////////////////////////////////////////////////////
12225	-->
12226
12227	<enum
12228	name="FramebufferPixelFormat"
12229	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
12230	>
12231	<desc>
12232	Format of the video memory buffer. Constants represented by this enum can
12233	be used to test for particular values of <link
12234	to="IFramebuffer::pixelFormat"/>. See also <link
12235	to="IFramebuffer::requestResize"/>.
12236
12237	See also www.fourcc.org for more information about FOURCC pixel formats.
12238	</desc>
12239
12240	<const name="Opaque" value="0">
12241	<desc>
12242	Unknown buffer format (the user may not assume any particular format of
12243	the buffer).
12244	</desc>
12245	</const>
12246	<const name="FOURCC_RGB" value="0x32424752">
12247	<desc>
12248	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
12249	bit layout).
12250	</desc>
12251	</const>
12252	</enum>
12253
12254	<interface
12255	name="IFramebuffer" extends="$unknown"
12256	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
12257	wsmap="suppress"
12258	>
12259	<attribute name="address" type="octet" mod="ptr" readonly="yes">
12260	<desc>Address of the start byte of the frame buffer.</desc>
12261	</attribute>
12262
12263	<attribute name="width" type="unsigned long" readonly="yes">
12264	<desc>Frame buffer width, in pixels.</desc>
12265	</attribute>
12266
12267	<attribute name="height" type="unsigned long" readonly="yes">
12268	<desc>Frame buffer height, in pixels.</desc>
12269	</attribute>
12270
12271	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
12272	<desc>
12273	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
12274	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
12275	are: 8, 15, 16, 24 and 32.
12276	</desc>
12277	</attribute>
12278
12279	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
12280	<desc>
12281	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
12282	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
12283	size of the scan line must be aligned to 32 bits.
12284	</desc>
12285	</attribute>
12286
12287	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
12288	<desc>
12289	Frame buffer pixel format. It's either one of the values defined by <link
12290	to="FramebufferPixelFormat"/> or a raw FOURCC code.
12291	<note>
12292	This attribute must never return <link
12293	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
12294	<link to="#address"/> points to must be always known.
12295	</note>
12296	</desc>
12297	</attribute>
12298
12299	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
12300	<desc>
12301	Defines whether this frame buffer uses the virtual video card's memory
12302	buffer (guest VRAM) directly or not. See <link
12303	to="IFramebuffer::requestResize"/> for more information.
12304	</desc>
12305	</attribute>
12306
12307	<attribute name="heightReduction" type="unsigned long" readonly="yes">
12308	<desc>
12309	Hint from the frame buffer about how much of the standard
12310	screen height it wants to use for itself. This information is
12311	exposed to the guest through the VESA BIOS and VMMDev interface
12312	so that it can use it for determining its video mode table. It
12313	is not guaranteed that the guest respects the value.
12314	</desc>
12315	</attribute>
12316
12317	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
12318	<desc>
12319	An alpha-blended overlay which is superposed over the frame buffer.
12320	The initial purpose is to allow the display of icons providing
12321	information about the VM state, including disk activity, in front
12322	ends which do not have other means of doing that. The overlay is
12323	designed to controlled exclusively by IDisplay. It has no locking
12324	of its own, and any changes made to it are not guaranteed to be
12325	visible until the affected portion of IFramebuffer is updated. The
12326	overlay can be created lazily the first time it is requested. This
12327	attribute can also return @c null to signal that the overlay is not
12328	implemented.
12329	</desc>
12330	</attribute>
12331
12332	<attribute name="winId" type="long long" readonly="yes">
12333	<desc>
12334	Platform-dependent identifier of the window where context of this
12335	frame buffer is drawn, or zero if there's no such window.
12336	</desc>
12337	</attribute>
12338
12339	<method name="lock">
12340	<desc>
12341	Locks the frame buffer.
12342	Gets called by the IDisplay object where this frame buffer is
12343	bound to.
12344	</desc>
12345	</method>
12346
12347	<method name="unlock">
12348	<desc>
12349	Unlocks the frame buffer.
12350	Gets called by the IDisplay object where this frame buffer is
12351	bound to.
12352	</desc>
12353	</method>
12354
12355	<method name="notifyUpdate">
12356	<desc>
12357	Informs about an update.
12358	Gets called by the display object where this buffer is
12359	registered.
12360	</desc>
12361	<param name="x" type="unsigned long" dir="in"/>
12362	<param name="y" type="unsigned long" dir="in"/>
12363	<param name="width" type="unsigned long" dir="in"/>
12364	<param name="height" type="unsigned long" dir="in"/>
12365	</method>
12366
12367	<method name="requestResize">
12368	<desc>
12369	Requests a size and pixel format change.
12370
12371	There are two modes of working with the video buffer of the virtual
12372	machine. The <i>indirect</i> mode implies that the IFramebuffer
12373	implementation allocates a memory buffer for the requested display mode
12374	and provides it to the virtual machine. In <i>direct</i> mode, the
12375	IFramebuffer implementation uses the memory buffer allocated and owned
12376	by the virtual machine. This buffer represents the video memory of the
12377	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
12378	usually faster because the implementation gets a raw pointer to the
12379	guest VRAM buffer which it can directly use for visualizing the contents
12380	of the virtual display, as opposed to the indirect mode where the
12381	contents of guest VRAM are copied to the memory buffer provided by
12382	the implementation every time a display update occurs.
12383
12384	It is important to note that the direct mode is really fast only when
12385	the implementation uses the given guest VRAM buffer directly, for
12386	example, by blitting it to the window representing the virtual machine's
12387	display, which saves at least one copy operation comparing to the
12388	indirect mode. However, using the guest VRAM buffer directly is not
12389	always possible: the format and the color depth of this buffer may be
12390	not supported by the target window, or it may be unknown (opaque) as in
12391	case of text or non-linear multi-plane VGA video modes. In this case,
12392	the indirect mode (that is always available) should be used as a
12393	fallback: when the guest VRAM contents are copied to the
12394	implementation-provided memory buffer, color and format conversion is
12395	done automatically by the underlying code.
12396
12397	The @a pixelFormat parameter defines whether the direct mode is
12398	available or not. If @a pixelFormat is <link
12399	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
12400	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
12401	@a bytesPerLine parameters must be ignored and the implementation must use
12402	the indirect mode (where it provides its own buffer in one of the
12403	supported formats). In all other cases, @a pixelFormat together with
12404	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
12405	buffer pointed to by the @a VRAM parameter and the implementation is
12406	free to choose which mode to use. To indicate that this frame buffer uses
12407	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
12408	attribute must return @c true and <link to="#address"/> must
12409	return exactly the same address that is passed in the @a VRAM parameter
12410	of this method; otherwise it is assumed that the indirect strategy is
12411	chosen.
12412
12413	The @a width and @a height parameters represent the size of the
12414	requested display mode in both modes. In case of indirect mode, the
12415	provided memory buffer should be big enough to store data of the given
12416	display mode. In case of direct mode, it is guaranteed that the given
12417	@a VRAM buffer contains enough space to represent the display mode of the
12418	given size. Note that this frame buffer's <link to="#width"/> and <link
12419	to="#height"/> attributes must return exactly the same values as
12420	passed to this method after the resize is completed (see below).
12421
12422	The @a finished output parameter determines if the implementation has
12423	finished resizing the frame buffer or not. If, for some reason, the
12424	resize cannot be finished immediately during this call, @a finished
12425	must be set to @c false, and the implementation must call
12426	<link to="IDisplay::resizeCompleted"/> after it has returned from
12427	this method as soon as possible. If @a finished is @c false, the
12428	machine will not call any frame buffer methods until
12429	<link to="IDisplay::resizeCompleted"/> is called.
12430
12431	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
12432	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
12433	this frame buffer must return exactly the same values as specified in the
12434	parameters of this method, after the resize is completed. If the
12435	indirect mode is chosen, these attributes must return values describing
12436	the format of the implementation's own memory buffer <link
12437	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
12438	value must always correlate with <link to="#pixelFormat"/>. Note that
12439	the <link to="#pixelFormat"/> attribute must never return <link
12440	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
12441
12442	<note>
12443	This method is called by the IDisplay object under the
12444	<link to="#lock"/> provided by this IFramebuffer
12445	implementation. If this method returns @c false in @a finished, then
12446	this lock is not released until
12447	<link to="IDisplay::resizeCompleted"/> is called.
12448	</note>
12449	</desc>
12450	<param name="screenId" type="unsigned long" dir="in">
12451	<desc>
12452	Logical screen number. Must be used in the corresponding call to
12453	<link to="IDisplay::resizeCompleted"/> if this call is made.
12454	</desc>
12455	</param>
12456	<param name="pixelFormat" type="unsigned long" dir="in">
12457	<desc>
12458	Pixel format of the memory buffer pointed to by @a VRAM.
12459	See also <link to="FramebufferPixelFormat"/>.
12460	</desc>
12461	</param>
12462	<param name="VRAM" type="octet" mod="ptr" dir="in">
12463	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
12464	</param>
12465	<param name="bitsPerPixel" type="unsigned long" dir="in">
12466	<desc>Color depth, bits per pixel.</desc>
12467	</param>
12468	<param name="bytesPerLine" type="unsigned long" dir="in">
12469	<desc>Size of one scan line, in bytes.</desc>
12470	</param>
12471	<param name="width" type="unsigned long" dir="in">
12472	<desc>Width of the guest display, in pixels.</desc>
12473	</param>
12474	<param name="height" type="unsigned long" dir="in">
12475	<desc>Height of the guest display, in pixels.</desc>
12476	</param>
12477	<param name="finished" type="boolean" dir="return">
12478	<desc>
12479	Can the VM start using the new frame buffer immediately
12480	after this method returns or it should wait for
12481	<link to="IDisplay::resizeCompleted"/>.
12482	</desc>
12483	</param>
12484	</method>
12485
12486	<method name="videoModeSupported">
12487	<desc>
12488	Returns whether the frame buffer implementation is willing to
12489	support a given video mode. In case it is not able to render
12490	the video mode (or for some reason not willing), it should
12491	return @c false. Usually this method is called when the guest
12492	asks the VMM device whether a given video mode is supported
12493	so the information returned is directly exposed to the guest.
12494	It is important that this method returns very quickly.
12495	</desc>
12496	<param name="width" type="unsigned long" dir="in"/>
12497	<param name="height" type="unsigned long" dir="in"/>
12498	<param name="bpp" type="unsigned long" dir="in"/>
12499	<param name="supported" type="boolean" dir="return"/>
12500	</method>
12501
12502	<method name="getVisibleRegion">
12503	<desc>
12504	Returns the visible region of this frame buffer.
12505
12506	If the @a rectangles parameter is @c null then the value of the
12507	@a count parameter is ignored and the number of elements necessary to
12508	describe the current visible region is returned in @a countCopied.
12509
12510	If @a rectangles is not @c null but @a count is less
12511	than the required number of elements to store region data, the method
12512	will report a failure. If @a count is equal or greater than the
12513	required number of elements, then the actual number of elements copied
12514	to the provided array will be returned in @a countCopied.
12515
12516	<note>
12517	The address of the provided array must be in the process space of
12518	this IFramebuffer object.
12519	</note>
12520	<note>
12521	Method not yet implemented.
12522	</note>
12523	</desc>
12524	<param name="rectangles" type="octet" mod="ptr" dir="in">
12525	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
12526	</param>
12527	<param name="count" type="unsigned long" dir="in">
12528	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12529	</param>
12530	<param name="countCopied" type="unsigned long" dir="return">
12531	<desc>Number of elements copied to the @a rectangles array.</desc>
12532	</param>
12533	</method>
12534
12535	<method name="setVisibleRegion">
12536	<desc>
12537	Suggests a new visible region to this frame buffer. This region
12538	represents the area of the VM display which is a union of regions of
12539	all top-level windows of the guest operating system running inside the
12540	VM (if the Guest Additions for this system support this
12541	functionality). This information may be used by the frontends to
12542	implement the seamless desktop integration feature.
12543
12544	<note>
12545	The address of the provided array must be in the process space of
12546	this IFramebuffer object.
12547	</note>
12548	<note>
12549	The IFramebuffer implementation must make a copy of the provided
12550	array of rectangles.
12551	</note>
12552	<note>
12553	Method not yet implemented.
12554	</note>
12555	</desc>
12556	<param name="rectangles" type="octet" mod="ptr" dir="in">
12557	<desc>Pointer to the @c RTRECT array.</desc>
12558	</param>
12559	<param name="count" type="unsigned long" dir="in">
12560	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12561	</param>
12562	</method>
12563
12564	<method name="processVHWACommand">
12565	<desc>
12566	Posts a Video HW Acceleration Command to the frame buffer for processing.
12567	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
12568	are posted from quest to the host to be processed by the host hardware.
12569
12570	<note>
12571	The address of the provided command must be in the process space of
12572	this IFramebuffer object.
12573	</note>
12574	</desc>
12575
12576	<param name="command" type="octet" mod="ptr" dir="in">
12577	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
12578	</param>
12579	</method>
12580
12581	</interface>
12582
12583	<interface
12584	name="IFramebufferOverlay" extends="IFramebuffer"
12585	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
12586	wsmap="suppress"
12587	>
12588	<desc>
12589	The IFramebufferOverlay interface represents an alpha blended overlay
12590	for displaying status icons above an IFramebuffer. It is always created
12591	not visible, so that it must be explicitly shown. It only covers a
12592	portion of the IFramebuffer, determined by its width, height and
12593	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
12594	that order) format, and may be written to directly. Do re-read the
12595	width though, after setting it, as it may be adjusted (increased) to
12596	make it more suitable for the front end.
12597	</desc>
12598	<attribute name="x" type="unsigned long" readonly="yes">
12599	<desc>X position of the overlay, relative to the frame buffer.</desc>
12600	</attribute>
12601
12602	<attribute name="y" type="unsigned long" readonly="yes">
12603	<desc>Y position of the overlay, relative to the frame buffer.</desc>
12604	</attribute>
12605
12606	<attribute name="visible" type="boolean" readonly="no">
12607	<desc>
12608	Whether the overlay is currently visible.
12609	</desc>
12610	</attribute>
12611
12612	<attribute name="alpha" type="unsigned long" readonly="no">
12613	<desc>
12614	The global alpha value for the overlay. This may or may not be
12615	supported by a given front end.
12616	</desc>
12617	</attribute>
12618
12619	<method name="move">
12620	<desc>
12621	Changes the overlay's position relative to the IFramebuffer.
12622	</desc>
12623	<param name="x" type="unsigned long" dir="in"/>
12624	<param name="y" type="unsigned long" dir="in"/>
12625	</method>
12626
12627	</interface>
12628
12629	<interface
12630	name="IDisplay" extends="$unknown"
12631	uuid="4b75c45c-e22e-4b75-b7cd-7ce9a83bb36e"
12632	wsmap="managed"
12633	>
12634	<desc>
12635	The IDisplay interface represents the virtual machine's display.
12636
12637	The object implementing this interface is contained in each
12638	<link to="IConsole::display"/> attribute and represents the visual
12639	output of the virtual machine.
12640
12641	The virtual display supports pluggable output targets represented by the
12642	IFramebuffer interface. Examples of the output target are a window on
12643	the host computer or an RDP session's display on a remote computer.
12644	</desc>
12645	<method name="getScreenResolution">
12646	<desc>Queries display width, height and color depth for given screen.</desc>
12647	<param name="screenId" type="unsigned long" dir="in"/>
12648	<param name="width" type="unsigned long" dir="out"/>
12649	<param name="height" type="unsigned long" dir="out"/>
12650	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
12651	</method>
12652
12653	<method name="setFramebuffer">
12654	<desc>
12655	Sets the framebuffer for given screen.
12656	</desc>
12657	<param name="screenId" type="unsigned long" dir="in"/>
12658	<param name="framebuffer" type="IFramebuffer" dir="in"/>
12659	</method>
12660
12661	<method name="getFramebuffer">
12662	<desc>
12663	Queries the framebuffer for given screen.
12664	</desc>
12665	<param name="screenId" type="unsigned long" dir="in"/>
12666	<param name="framebuffer" type="IFramebuffer" dir="out"/>
12667	<param name="xOrigin" type="long" dir="out"/>
12668	<param name="yOrigin" type="long" dir="out"/>
12669	</method>
12670
12671	<method name="setVideoModeHint">
12672	<desc>
12673	Asks VirtualBox to request the given video mode from
12674	the guest. This is just a hint and it cannot be guaranteed
12675	that the requested resolution will be used. Guest Additions
12676	are required for the request to be seen by guests. The caller
12677	should issue the request and wait for a resolution change and
12678	after a timeout retry.
12679
12680	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
12681	parameters means that the corresponding values should be taken from the
12682	current video mode (i.e. left unchanged).
12683
12684	If the guest OS supports multi-monitor configuration then the @a display
12685	parameter specifies the number of the guest display to send the hint to:
12686	@c 0 is the primary display, @c 1 is the first secondary and
12687	so on. If the multi-monitor configuration is not supported, @a display
12688	must be @c 0.
12689
12690	<result name="E_INVALIDARG">
12691	The @a display is not associated with any monitor.
12692	</result>
12693
12694	</desc>
12695	<param name="width" type="unsigned long" dir="in"/>
12696	<param name="height" type="unsigned long" dir="in"/>
12697	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
12698	<param name="display" type="unsigned long" dir="in"/>
12699	</method>
12700
12701	<method name="setSeamlessMode">
12702	<desc>
12703	Enables or disables seamless guest display rendering (seamless desktop
12704	integration) mode.
12705	<note>
12706	Calling this method has no effect if <link
12707	to="IGuest::getFacilityStatus"/> with facility @c Seamless
12708	does not return @c Active.
12709	</note>
12710	</desc>
12711	<param name="enabled" type="boolean" dir="in"/>
12712	</method>
12713
12714	<method name="takeScreenShot">
12715	<desc>
12716	Takes a screen shot of the requested size and copies it to the
12717	32-bpp buffer allocated by the caller and pointed to by @a address.
12718	A pixel consists of 4 bytes in order: B, G, R, 0.
12719
12720	<note>This API can be used only locally by a VM process through the
12721	COM/XPCOM C++ API as it requires pointer support. It is not
12722	available for scripting langages, Java or any webservice clients.
12723	Unless you are writing a new VM frontend use
12724	<link to="#takeScreenShotToArray" />.
12725	</note>
12726
12727	<result name="E_NOTIMPL">
12728	Feature not implemented.
12729	</result>
12730	<result name="VBOX_E_IPRT_ERROR">
12731	Could not take a screenshot.
12732	</result>
12733
12734	</desc>
12735	<param name="screenId" type="unsigned long" dir="in"/>
12736	<param name="address" type="octet" mod="ptr" dir="in"/>
12737	<param name="width" type="unsigned long" dir="in"/>
12738	<param name="height" type="unsigned long" dir="in"/>
12739	</method>
12740
12741	<method name="takeScreenShotToArray">
12742	<desc>
12743	Takes a guest screen shot of the requested size and returns it as
12744	an array of bytes in uncompressed 32-bit RGBA format.
12745	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
12746
12747	This API is slow, but could be the only option to get guest screenshot
12748	for scriptable languages not allowed to manipulate with addresses
12749	directly.
12750
12751	<result name="E_NOTIMPL">
12752	Feature not implemented.
12753	</result>
12754	<result name="VBOX_E_IPRT_ERROR">
12755	Could not take a screenshot.
12756	</result>
12757	</desc>
12758	<param name="screenId" type="unsigned long" dir="in">
12759	<desc>
12760	Monitor to take screenshot from.
12761	</desc>
12762	</param>
12763	<param name="width" type="unsigned long" dir="in">
12764	<desc>
12765	Desired image width.
12766	</desc>
12767	</param>
12768	<param name="height" type="unsigned long" dir="in">
12769	<desc>
12770	Desired image height.
12771	</desc>
12772	</param>
12773	<param name="screenData" type="octet" dir="return" safearray="yes">
12774	<desc>
12775	Array with resulting screen data.
12776	</desc>
12777	</param>
12778	</method>
12779
12780	<method name="takeScreenShotPNGToArray">
12781	<desc>
12782	Takes a guest screen shot of the requested size and returns it as
12783	PNG image in array.
12784
12785	<result name="E_NOTIMPL">
12786	Feature not implemented.
12787	</result>
12788	<result name="VBOX_E_IPRT_ERROR">
12789	Could not take a screenshot.
12790	</result>
12791	</desc>
12792	<param name="screenId" type="unsigned long" dir="in">
12793	<desc>
12794	Monitor to take the screenshot from.
12795	</desc>
12796	</param>
12797	<param name="width" type="unsigned long" dir="in">
12798	<desc>
12799	Desired image width.
12800	</desc>
12801	</param>
12802	<param name="height" type="unsigned long" dir="in">
12803	<desc>
12804	Desired image height.
12805	</desc>
12806	</param>
12807	<param name="screenData" type="octet" dir="return" safearray="yes">
12808	<desc>
12809	Array with resulting screen data.
12810	</desc>
12811	</param>
12812	</method>
12813
12814	<method name="drawToScreen">
12815	<desc>
12816	Draws a 32-bpp image of the specified size from the given buffer
12817	to the given point on the VM display.
12818
12819	<result name="E_NOTIMPL">
12820	Feature not implemented.
12821	</result>
12822	<result name="VBOX_E_IPRT_ERROR">
12823	Could not draw to screen.
12824	</result>
12825
12826	</desc>
12827	<param name="screenId" type="unsigned long" dir="in">
12828	<desc>
12829	Monitor to take the screenshot from.
12830	</desc>
12831	</param>
12832	<param name="address" type="octet" mod="ptr" dir="in">
12833	<desc>
12834	Address to store the screenshot to
12835	</desc>
12836	</param>
12837	<param name="x" type="unsigned long" dir="in">
12838	<desc>
12839	Relative to the screen top left corner.
12840	</desc>
12841	</param>
12842	<param name="y" type="unsigned long" dir="in">
12843	<desc>
12844	Relative to the screen top left corner.
12845	</desc>
12846	</param>
12847	<param name="width" type="unsigned long" dir="in">
12848	<desc>
12849	Desired image width.
12850	</desc>
12851	</param>
12852	<param name="height" type="unsigned long" dir="in">
12853	<desc>
12854	Desired image height.
12855	</desc>
12856	</param>
12857	</method>
12858
12859	<method name="invalidateAndUpdate">
12860	<desc>
12861	Does a full invalidation of the VM display and instructs the VM
12862	to update it.
12863
12864	<result name="VBOX_E_IPRT_ERROR">
12865	Could not invalidate and update screen.
12866	</result>
12867
12868	</desc>
12869	</method>
12870
12871	<method name="resizeCompleted">
12872	<desc>
12873	Signals that a framebuffer has completed the resize operation.
12874
12875	<result name="VBOX_E_NOT_SUPPORTED">
12876	Operation only valid for external frame buffers.
12877	</result>
12878
12879	</desc>
12880	<param name="screenId" type="unsigned long" dir="in"/>
12881	</method>
12882
12883	<method name="completeVHWACommand">
12884	<desc>
12885	Signals that the Video HW Acceleration command has completed.
12886	</desc>
12887
12888	<param name="command" type="octet" mod="ptr" dir="in">
12889	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
12890	</param>
12891	</method>
12892
12893	<method name="viewportChanged">
12894	<desc>
12895	Signals that framebuffer window viewport has changed.
12896
12897	<result name="E_INVALIDARG">
12898	The specified viewport data is invalid.
12899	</result>
12900
12901	</desc>
12902
12903	<param name="screenId" type="unsigned long" dir="in">
12904	<desc>
12905	Monitor to take the screenshot from.
12906	</desc>
12907	</param>
12908	<param name="x" type="unsigned long" dir="in">
12909	<desc>
12910	Framebuffer x offset.
12911	</desc>
12912	</param>
12913	<param name="y" type="unsigned long" dir="in">
12914	<desc>
12915	Framebuffer y offset.
12916	</desc>
12917	</param>
12918	<param name="width" type="unsigned long" dir="in">
12919	<desc>
12920	Viewport width.
12921	</desc>
12922	</param>
12923	<param name="height" type="unsigned long" dir="in">
12924	<desc>
12925	Viewport height.
12926	</desc>
12927	</param>
12928	</method>
12929	</interface>
12930
12931	<!--
12932	// INetworkAdapter
12933	/////////////////////////////////////////////////////////////////////////
12934	-->
12935
12936	<enum
12937	name="NetworkAttachmentType"
12938	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
12939	>
12940	<desc>
12941	Network attachment type.
12942	</desc>
12943
12944	<const name="Null" value="0">
12945	<desc>Null value, also means "not attached".</desc>
12946	</const>
12947	<const name="NAT" value="1"/>
12948	<const name="Bridged" value="2"/>
12949	<const name="Internal" value="3"/>
12950	<const name="HostOnly" value="4"/>
12951	<const name="Generic" value="5"/>
12952	</enum>
12953
12954	<enum
12955	name="NetworkAdapterType"
12956	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
12957	>
12958	<desc>
12959	Network adapter type.
12960	</desc>
12961
12962	<const name="Null" value="0">
12963	<desc>Null value (never used by the API).</desc>
12964	</const>
12965	<const name="Am79C970A" value="1">
12966	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
12967	</const>
12968	<const name="Am79C973" value="2">
12969	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
12970	</const>
12971	<const name="I82540EM" value="3">
12972	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
12973	</const>
12974	<const name="I82543GC" value="4">
12975	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
12976	</const>
12977	<const name="I82545EM" value="5">
12978	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
12979	</const>
12980	<const name="Virtio" value="6">
12981	<desc>Virtio network device.</desc>
12982	</const>
12983	</enum>
12984
12985	<enum
12986	name="NetworkAdapterPromiscModePolicy"
12987	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
12988	>
12989	<desc>
12990	The promiscuous mode policy of an interface.
12991	</desc>
12992
12993	<const name="Deny" value="1">
12994	<desc>Deny promiscuous mode requests.</desc>
12995	</const>
12996	<const name="AllowNetwork" value="2">
12997	<desc>
12998	Allow promicuous mode, but restrict the scope it to the internal
12999	network so that it only applies to other VMs.
13000	</desc>
13001	</const>
13002	<const name="AllowAll" value="3">
13003	<desc>
13004	Allow promicuous mode, include unrelated traffic going over the wire
13005	and internally on the host.
13006	</desc>
13007	</const>
13008	</enum>
13009
13010	<interface
13011	name="INetworkAdapter" extends="$unknown"
13012	uuid="8b2e705c-0547-4008-b7bc-788757346092"
13013	wsmap="managed"
13014	>
13015	<desc>
13016	Represents a virtual network adapter that is attached to a virtual machine.
13017	Each virtual machine has a fixed number of network adapter slots with one
13018	instance of this attached to each of them. Call
13019	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
13020	is attached to a given slot in a given machine.
13021
13022	Each network adapter can be in one of five attachment modes, which are
13023	represented by the <link to="NetworkAttachmentType" /> enumeration;
13024	see the <link to="#attachmentType" /> attribute.
13025	</desc>
13026
13027	<attribute name="adapterType" type="NetworkAdapterType">
13028	<desc>
13029	Type of the virtual network adapter. Depending on this value,
13030	VirtualBox will provide a different virtual network hardware
13031	to the guest.
13032	</desc>
13033	</attribute>
13034
13035	<attribute name="slot" type="unsigned long" readonly="yes">
13036	<desc>
13037	Slot number this adapter is plugged into. Corresponds to
13038	the value you pass to <link to="IMachine::getNetworkAdapter"/>
13039	to obtain this instance.
13040	</desc>
13041	</attribute>
13042
13043	<attribute name="enabled" type="boolean">
13044	<desc>
13045	Flag whether the network adapter is present in the
13046	guest system. If disabled, the virtual guest hardware will
13047	not contain this network adapter. Can only be changed when
13048	the VM is not running.
13049	</desc>
13050	</attribute>
13051
13052	<attribute name="MACAddress" type="wstring">
13053	<desc>
13054	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
13055	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
13056	</desc>
13057	</attribute>
13058
13059	<attribute name="attachmentType" type="NetworkAttachmentType">
13060	<desc>
13061	Sets/Gets network attachment type of this network adapter.
13062	</desc>
13063	</attribute>
13064
13065	<attribute name="bridgedInterface" type="wstring">
13066	<desc>
13067	Name of the network interface the VM should be bridged to.
13068	</desc>
13069	</attribute>
13070
13071	<attribute name="hostOnlyInterface" type="wstring">
13072	<desc>
13073	Name of the host only network interface the VM is attached to.
13074	</desc>
13075	</attribute>
13076
13077	<attribute name="internalNetwork" type="wstring">
13078	<desc>
13079	Name of the internal network the VM is attached to.
13080	</desc>
13081	</attribute>
13082
13083	<attribute name="NATNetwork" type="wstring">
13084	<desc>
13085	Name of the NAT network the VM is attached to.
13086	</desc>
13087	</attribute>
13088
13089	<attribute name="genericDriver" type="wstring">
13090	<desc>
13091	Name of the driver to use for the "Generic" network attachment type.
13092	</desc>
13093	</attribute>
13094
13095	<attribute name="cableConnected" type="boolean">
13096	<desc>
13097	Flag whether the adapter reports the cable as connected or not.
13098	It can be used to report offline situations to a VM.
13099	</desc>
13100	</attribute>
13101
13102	<attribute name="lineSpeed" type="unsigned long">
13103	<desc>
13104	Line speed reported by custom drivers, in units of 1 kbps.
13105	</desc>
13106	</attribute>
13107
13108	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
13109	<desc>
13110	The promiscuous mode policy of the network adapter when attached to an
13111	internal network, host only network or a bridge.
13112	</desc>
13113	</attribute>
13114
13115	<attribute name="traceEnabled" type="boolean">
13116	<desc>
13117	Flag whether network traffic from/to the network card should be traced.
13118	Can only be toggled when the VM is turned off.
13119	</desc>
13120	</attribute>
13121
13122	<attribute name="traceFile" type="wstring">
13123	<desc>
13124	Filename where a network trace will be stored. If not set, VBox-pid.pcap
13125	will be used.
13126	</desc>
13127	</attribute>
13128
13129	<attribute name="natDriver" type="INATEngine" readonly="yes">
13130	<desc>
13131	Points to the NAT engine which handles the network address translation
13132	for this interface. This is active only when the interface actually uses
13133	NAT.
13134	</desc>
13135	</attribute>
13136
13137	<attribute name="bootPriority" type="unsigned long">
13138	<desc>
13139	Network boot priority of the adapter. Priority 1 is highest. If not set,
13140	the priority is considered to be at the lowest possible setting.
13141	</desc>
13142	</attribute>
13143
13144	<attribute name="bandwidthGroup" type="IBandwidthGroup">
13145	<desc>The bandwidth group this network adapter is assigned to.</desc>
13146	</attribute>
13147
13148	<!-- property methods -->
13149
13150	<method name="getProperty" const="yes">
13151	<desc>
13152	Returns the value of the network attachment property with the given name.
13153
13154	If the requested data @a key does not exist, this function will
13155	succeed and return an empty string in the @a value argument.
13156
13157	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13158	</desc>
13159	<param name="key" type="wstring" dir="in">
13160	<desc>Name of the property to get.</desc>
13161	</param>
13162	<param name="value" type="wstring" dir="return">
13163	<desc>Current property value.</desc>
13164	</param>
13165	</method>
13166
13167	<method name="setProperty">
13168	<desc>
13169	Sets the value of the network attachment property with the given name.
13170
13171	Setting the property value to @c null or an empty string is equivalent
13172	to deleting the existing value.
13173
13174	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13175	</desc>
13176	<param name="key" type="wstring" dir="in">
13177	<desc>Name of the property to set.</desc>
13178	</param>
13179	<param name="value" type="wstring" dir="in">
13180	<desc>Property value to set.</desc>
13181	</param>
13182	</method>
13183
13184	<method name="getProperties" const="yes">
13185	<desc>
13186	Returns values for a group of properties in one call.
13187
13188	The names of the properties to get are specified using the @a names
13189	argument which is a list of comma-separated property names or
13190	an empty string if all properties are to be returned.
13191	<note>Currently the value of this argument is ignored and the method
13192	always returns all existing properties.</note>
13193
13194	The method returns two arrays, the array of property names corresponding
13195	to the @a names argument and the current values of these properties.
13196	Both arrays have the same number of elements with each element at the
13197	given index in the first array corresponds to an element at the same
13198	index in the second array.
13199	</desc>
13200	<param name="names" type="wstring" dir="in">
13201	<desc>
13202	Names of properties to get.
13203	</desc>
13204	</param>
13205	<param name="returnNames" type="wstring" safearray="yes" dir="out">
13206	<desc>Names of returned properties.</desc>
13207	</param>
13208	<param name="returnValues" type="wstring" safearray="yes" dir="return">
13209	<desc>Values of returned properties.</desc>
13210	</param>
13211	</method>
13212
13213	</interface>
13214
13215
13216	<!--
13217	// ISerialPort
13218	/////////////////////////////////////////////////////////////////////////
13219	-->
13220
13221	<enum
13222	name="PortMode"
13223	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
13224	>
13225	<desc>
13226	The PortMode enumeration represents possible communication modes for
13227	the virtual serial port device.
13228	</desc>
13229
13230	<const name="Disconnected" value="0">
13231	<desc>Virtual device is not attached to any real host device.</desc>
13232	</const>
13233	<const name="HostPipe" value="1">
13234	<desc>Virtual device is attached to a host pipe.</desc>
13235	</const>
13236	<const name="HostDevice" value="2">
13237	<desc>Virtual device is attached to a host device.</desc>
13238	</const>
13239	<const name="RawFile" value="3">
13240	<desc>Virtual device is attached to a raw file.</desc>
13241	</const>
13242	</enum>
13243
13244	<interface
13245	name="ISerialPort" extends="$unknown"
13246	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
13247	wsmap="managed"
13248	>
13249
13250	<desc>
13251	The ISerialPort interface represents the virtual serial port device.
13252
13253	The virtual serial port device acts like an ordinary serial port
13254	inside the virtual machine. This device communicates to the real
13255	serial port hardware in one of two modes: host pipe or host device.
13256
13257	In host pipe mode, the #path attribute specifies the path to the pipe on
13258	the host computer that represents a serial port. The #server attribute
13259	determines if this pipe is created by the virtual machine process at
13260	machine startup or it must already exist before starting machine
13261	execution.
13262
13263	In host device mode, the #path attribute specifies the name of the
13264	serial port device on the host computer.
13265
13266	There is also a third communication mode: the disconnected mode. In this
13267	mode, the guest OS running inside the virtual machine will be able to
13268	detect the serial port, but all port write operations will be discarded
13269	and all port read operations will return no data.
13270
13271	<see><link to="IMachine::getSerialPort"/></see>
13272	</desc>
13273
13274	<attribute name="slot" type="unsigned long" readonly="yes">
13275	<desc>
13276	Slot number this serial port is plugged into. Corresponds to
13277	the value you pass to <link to="IMachine::getSerialPort"/>
13278	to obtain this instance.
13279	</desc>
13280	</attribute>
13281
13282	<attribute name="enabled" type="boolean">
13283	<desc>
13284	Flag whether the serial port is enabled. If disabled,
13285	the serial port will not be reported to the guest OS.
13286	</desc>
13287	</attribute>
13288
13289	<attribute name="IOBase" type="unsigned long">
13290	<desc>Base I/O address of the serial port.</desc>
13291	</attribute>
13292
13293	<attribute name="IRQ" type="unsigned long">
13294	<desc>IRQ number of the serial port.</desc>
13295	</attribute>
13296
13297	<attribute name="hostMode" type="PortMode">
13298	<desc>
13299	How is this port connected to the host.
13300	<note>
13301	Changing this attribute may fail if the conditions for
13302	<link to="#path"/> are not met.
13303	</note>
13304	</desc>
13305	</attribute>
13306
13307	<attribute name="server" type="boolean">
13308	<desc>
13309	Flag whether this serial port acts as a server (creates a new pipe on
13310	the host) or as a client (uses the existing pipe). This attribute is
13311	used only when <link to="#hostMode"/> is PortMode_HostPipe.
13312	</desc>
13313	</attribute>
13314
13315	<attribute name="path" type="wstring">
13316	<desc>
13317	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
13318	PortMode_HostPipe, or the host serial device name when
13319	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
13320	cases, setting a @c null or empty string as the attribute's value
13321	is an error. Otherwise, the value of this property is ignored.
13322	</desc>
13323	</attribute>
13324
13325	</interface>
13326
13327	<!--
13328	// IParallelPort
13329	/////////////////////////////////////////////////////////////////////////
13330	-->
13331
13332	<interface
13333	name="IParallelPort" extends="$unknown"
13334	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
13335	wsmap="managed"
13336	>
13337
13338	<desc>
13339	The IParallelPort interface represents the virtual parallel port device.
13340
13341	The virtual parallel port device acts like an ordinary parallel port
13342	inside the virtual machine. This device communicates to the real
13343	parallel port hardware using the name of the parallel device on the host
13344	computer specified in the #path attribute.
13345
13346	Each virtual parallel port device is assigned a base I/O address and an
13347	IRQ number that will be reported to the guest operating system and used
13348	to operate the given parallel port from within the virtual machine.
13349
13350	<see><link to="IMachine::getParallelPort"/></see>
13351	</desc>
13352
13353	<attribute name="slot" type="unsigned long" readonly="yes">
13354	<desc>
13355	Slot number this parallel port is plugged into. Corresponds to
13356	the value you pass to <link to="IMachine::getParallelPort"/>
13357	to obtain this instance.
13358	</desc>
13359	</attribute>
13360
13361	<attribute name="enabled" type="boolean">
13362	<desc>
13363	Flag whether the parallel port is enabled. If disabled,
13364	the parallel port will not be reported to the guest OS.
13365	</desc>
13366	</attribute>
13367
13368	<attribute name="IOBase" type="unsigned long">
13369	<desc>Base I/O address of the parallel port.</desc>
13370	</attribute>
13371
13372	<attribute name="IRQ" type="unsigned long">
13373	<desc>IRQ number of the parallel port.</desc>
13374	</attribute>
13375
13376	<attribute name="path" type="wstring">
13377	<desc>
13378	Host parallel device name. If this parallel port is enabled, setting a
13379	@c null or an empty string as this attribute's value will result in
13380	an error.
13381	</desc>
13382	</attribute>
13383
13384	</interface>
13385
13386
13387	<!--
13388	// IMachineDebugger
13389	/////////////////////////////////////////////////////////////////////////
13390	-->
13391
13392	<interface
13393	name="IMachineDebugger" extends="$unknown"
13394	uuid="a9abbb7c-d678-43b2-bed2-19ec0e32303d"
13395	wsmap="suppress"
13396	>
13397	<method name="dumpGuestCore">
13398	<desc>
13399	Takes a core dump of the guest.
13400
13401	See include/VBox/dbgfcorefmt.h for details on the file format.
13402	</desc>
13403	<param name="filename" type="wstring" dir="in">
13404	<desc>
13405	The name of the output file. The file must not exist.
13406	</desc>
13407	</param>
13408	<param name="compression" type="wstring" dir="in">
13409	<desc>
13410	Reserved for future compression method indicator.
13411	</desc>
13412	</param>
13413	</method>
13414
13415	<method name="dumpHostProcessCore">
13416	<desc>
13417	Takes a core dump of the VM process on the host.
13418
13419	This feature is not implemented in the 4.0.0 release but it may show up
13420	in a dot release.
13421	</desc>
13422	<param name="filename" type="wstring" dir="in">
13423	<desc>
13424	The name of the output file. The file must not exist.
13425	</desc>
13426	</param>
13427	<param name="compression" type="wstring" dir="in">
13428	<desc>
13429	Reserved for future compression method indicator.
13430	</desc>
13431	</param>
13432	</method>
13433
13434	<method name="info">
13435	<desc>
13436	Interfaces with the info dumpers (DBGFInfo).
13437
13438	This feature is not implemented in the 4.0.0 release but it may show up
13439	in a dot release.
13440	</desc>
13441	<param name="name" type="wstring" dir="in">
13442	<desc>
13443	The name of the info item.
13444	</desc>
13445	</param>
13446	<param name="args" type="wstring" dir="in">
13447	<desc>
13448	Arguments to the info dumper.
13449	</desc>
13450	</param>
13451	<param name="info" type="wstring" dir="return">
13452	<desc>
13453	The into string.
13454	</desc>
13455	</param>
13456	</method>
13457
13458	<method name="injectNMI">
13459	<desc>
13460	Inject an NMI into a running VT-x/AMD-V VM.
13461	</desc>
13462	</method>
13463
13464	<method name="modifyLogGroups">
13465	<desc>
13466	Modifies the group settings of the debug or release logger.
13467	</desc>
13468	<param name="settings" type="wstring" dir="in">
13469	<desc>
13470	The group settings string. See iprt/log.h for details. To target the
13471	release logger, prefix the string with "release:".
13472	</desc>
13473	</param>
13474	</method>
13475
13476	<method name="modifyLogFlags">
13477	<desc>
13478	Modifies the debug or release logger flags.
13479	</desc>
13480	<param name="settings" type="wstring" dir="in">
13481	<desc>
13482	The flags settings string. See iprt/log.h for details. To target the
13483	release logger, prefix the string with "release:".
13484	</desc>
13485	</param>
13486	</method>
13487
13488	<method name="modifyLogDestinations">
13489	<desc>
13490	Modifies the debug or release logger destinations.
13491	</desc>
13492	<param name="settings" type="wstring" dir="in">
13493	<desc>
13494	The destination settings string. See iprt/log.h for details. To target the
13495	release logger, prefix the string with "release:".
13496	</desc>
13497	</param>
13498	</method>
13499
13500	<method name="readPhysicalMemory">
13501	<desc>
13502	Reads guest physical memory, no side effects (MMIO++).
13503
13504	This feature is not implemented in the 4.0.0 release but may show up
13505	in a dot release.
13506	</desc>
13507	<param name="address" type="long long" dir="in">
13508	<desc>The guest physical address.</desc>
13509	</param>
13510	<param name="size" type="unsigned long" dir="in">
13511	<desc>The number of bytes to read.</desc>
13512	</param>
13513	<param name="bytes" type="octet" safearray="yes" dir="return">
13514	<desc>The bytes read.</desc>
13515	</param>
13516	</method>
13517
13518	<method name="writePhysicalMemory">
13519	<desc>
13520	Writes guest physical memory, access handles (MMIO++) are ignored.
13521
13522	This feature is not implemented in the 4.0.0 release but may show up
13523	in a dot release.
13524	</desc>
13525	<param name="address" type="long long" dir="in">
13526	<desc>The guest physical address.</desc>
13527	</param>
13528	<param name="size" type="unsigned long" dir="in">
13529	<desc>The number of bytes to read.</desc>
13530	</param>
13531	<param name="bytes" type="octet" safearray="yes" dir="in">
13532	<desc>The bytes to write.</desc>
13533	</param>
13534	</method>
13535
13536	<method name="readVirtualMemory">
13537	<desc>
13538	Reads guest virtual memory, no side effects (MMIO++).
13539
13540	This feature is not implemented in the 4.0.0 release but may show up
13541	in a dot release.
13542	</desc>
13543	<param name="cpuId" type="unsigned long" dir="in">
13544	<desc>The identifier of the Virtual CPU.</desc>
13545	</param>
13546	<param name="address" type="long long" dir="in">
13547	<desc>The guest virtual address.</desc>
13548	</param>
13549	<param name="size" type="unsigned long" dir="in">
13550	<desc>The number of bytes to read.</desc>
13551	</param>
13552	<param name="bytes" type="octet" safearray="yes" dir="return">
13553	<desc>The bytes read.</desc>
13554	</param>
13555	</method>
13556
13557	<method name="writeVirtualMemory">
13558	<desc>
13559	Writes guest virtual memory, access handles (MMIO++) are ignored.
13560
13561	This feature is not implemented in the 4.0.0 release but may show up
13562	in a dot release.
13563	</desc>
13564	<param name="cpuId" type="unsigned long" dir="in">
13565	<desc>The identifier of the Virtual CPU.</desc>
13566	</param>
13567	<param name="address" type="long long" dir="in">
13568	<desc>The guest virtual address.</desc>
13569	</param>
13570	<param name="size" type="unsigned long" dir="in">
13571	<desc>The number of bytes to read.</desc>
13572	</param>
13573	<param name="bytes" type="octet" safearray="yes" dir="in">
13574	<desc>The bytes to write.</desc>
13575	</param>
13576	</method>
13577
13578	<method name="detectOS">
13579	<desc>
13580	Tries to (re-)detect the guest OS kernel.
13581
13582	This feature is not implemented in the 4.0.0 release but may show up
13583	in a dot release.
13584	</desc>
13585	<param name="os" type="wstring" dir="return">
13586	<desc>
13587	The detected OS kernel on success.
13588	</desc>
13589	</param>
13590	</method>
13591
13592	<method name="getRegister">
13593	<desc>
13594	Gets one register.
13595
13596	This feature is not implemented in the 4.0.0 release but may show up
13597	in a dot release.
13598	</desc>
13599	<param name="cpuId" type="unsigned long" dir="in">
13600	<desc>The identifier of the Virtual CPU.</desc>
13601	</param>
13602	<param name="name" type="wstring" dir="in">
13603	<desc>The register name, case is ignored.</desc>
13604	</param>
13605	<param name="value" type="wstring" dir="return">
13606	<desc>
13607	The register value. This is usually a hex value (always 0x prefixed)
13608	but other format may be used for floating point registers (TBD).
13609	</desc>
13610	</param>
13611	</method>
13612
13613	<method name="getRegisters">
13614	<desc>
13615	Gets all the registers for the given CPU.
13616
13617	This feature is not implemented in the 4.0.0 release but may show up
13618	in a dot release.
13619	</desc>
13620	<param name="cpuId" type="unsigned long" dir="in">
13621	<desc>The identifier of the Virtual CPU.</desc>
13622	</param>
13623	<param name="names" type="wstring" dir="out" safearray="yes">
13624	<desc>Array containing the lowercase register names.</desc>
13625	</param>
13626	<param name="values" type="wstring" dir="out" safearray="yes">
13627	<desc>
13628	Array paralell to the names holding the register values as if the
13629	register was returned by <link to="IMachineDebugger::getRegister"/>.
13630	</desc>
13631	</param>
13632	</method>
13633
13634	<method name="setRegister">
13635	<desc>
13636	Gets one register.
13637
13638	This feature is not implemented in the 4.0.0 release but may show up
13639	in a dot release.
13640	</desc>
13641	<param name="cpuId" type="unsigned long" dir="in">
13642	<desc>The identifier of the Virtual CPU.</desc>
13643	</param>
13644	<param name="name" type="wstring" dir="in">
13645	<desc>The register name, case is ignored.</desc>
13646	</param>
13647	<param name="value" type="wstring" dir="in">
13648	<desc>
13649	The new register value. Hexadecimal, decimal and octal formattings
13650	are supported in addition to any special formattings returned by
13651	the getters.
13652	</desc>
13653	</param>
13654	</method>
13655
13656	<method name="setRegisters">
13657	<desc>
13658	Sets zero or more registers atomically.
13659
13660	This feature is not implemented in the 4.0.0 release but may show up
13661	in a dot release.
13662	</desc>
13663	<param name="cpuId" type="unsigned long" dir="in">
13664	<desc>The identifier of the Virtual CPU.</desc>
13665	</param>
13666	<param name="names" type="wstring" dir="in" safearray="yes">
13667	<desc>Array containing the register names, case ignored.</desc>
13668	</param>
13669	<param name="values" type="wstring" dir="in" safearray="yes">
13670	<desc>
13671	Array paralell to the names holding the register values. See
13672	<link to="IMachineDebugger::setRegister"/> for formatting
13673	guidelines.
13674	</desc>
13675	</param>
13676	</method>
13677
13678	<method name="dumpGuestStack">
13679	<desc>
13680	Produce a simple stack dump using the current guest state.
13681
13682	This feature is not implemented in the 4.0.0 release but may show up
13683	in a dot release.
13684	</desc>
13685	<param name="cpuId" type="unsigned long" dir="in">
13686	<desc>The identifier of the Virtual CPU.</desc>
13687	</param>
13688	<param name="stack" type="wstring" dir="return">
13689	<desc>String containing the formatted stack dump.</desc>
13690	</param>
13691	</method>
13692
13693	<method name="resetStats">
13694	<desc>
13695	Reset VM statistics.
13696	</desc>
13697	<param name="pattern" type="wstring" dir="in">
13698	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13699	</param>
13700	</method>
13701
13702	<method name="dumpStats">
13703	<desc>
13704	Dumps VM statistics.
13705	</desc>
13706	<param name="pattern" type="wstring" dir="in">
13707	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13708	</param>
13709	</method>
13710
13711	<method name="getStats">
13712	<desc>
13713	Get the VM statistics in a XMLish format.
13714	</desc>
13715	<param name="pattern" type="wstring" dir="in">
13716	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13717	</param>
13718	<param name="withDescriptions" type="boolean" dir="in">
13719	<desc>Whether to include the descriptions.</desc>
13720	</param>
13721	<param name="stats" type="wstring" dir="out">
13722	<desc>The XML document containing the statistics.</desc>
13723	</param>
13724	</method>
13725
13726	<attribute name="singleStep" type="boolean">
13727	<desc>Switch for enabling single-stepping.</desc>
13728	</attribute>
13729
13730	<attribute name="recompileUser" type="boolean">
13731	<desc>Switch for forcing code recompilation for user mode code.</desc>
13732	</attribute>
13733
13734	<attribute name="recompileSupervisor" type="boolean">
13735	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
13736	</attribute>
13737
13738	<attribute name="PATMEnabled" type="boolean">
13739	<desc>Switch for enabling and disabling the PATM component.</desc>
13740	</attribute>
13741
13742	<attribute name="CSAMEnabled" type="boolean">
13743	<desc>Switch for enabling and disabling the CSAM component.</desc>
13744	</attribute>
13745
13746	<attribute name="logEnabled" type="boolean">
13747	<desc>Switch for enabling and disabling the debug logger.</desc>
13748	</attribute>
13749
13750	<attribute name="logDbgFlags" type="wstring" readonly="yes">
13751	<desc>The debug logger flags.</desc>
13752	</attribute>
13753
13754	<attribute name="logDbgGroups" type="wstring" readonly="yes">
13755	<desc>The debug logger's group settings.</desc>
13756	</attribute>
13757
13758	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
13759	<desc>The debug logger's destination settings.</desc>
13760	</attribute>
13761
13762	<attribute name="logRelFlags" type="wstring" readonly="yes">
13763	<desc>The release logger flags.</desc>
13764	</attribute>
13765
13766	<attribute name="logRelGroups" type="wstring" readonly="yes">
13767	<desc>The release logger's group settings.</desc>
13768	</attribute>
13769
13770	<attribute name="logRelDestinations" type="wstring" readonly="yes">
13771	<desc>The relase logger's destination settings.</desc>
13772	</attribute>
13773
13774	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
13775	<desc>
13776	Flag indicating whether the VM is currently making use of CPU hardware
13777	virtualization extensions.
13778	</desc>
13779	</attribute>
13780
13781	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
13782	<desc>
13783	Flag indicating whether the VM is currently making use of the nested paging
13784	CPU hardware virtualization extension.
13785	</desc>
13786	</attribute>
13787
13788	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
13789	<desc>
13790	Flag indicating whether the VM is currently making use of the VPID
13791	VT-x extension.
13792	</desc>
13793	</attribute>
13794
13795	<attribute name="OSName" type="wstring" readonly="yes">
13796	<desc>
13797	Query the guest OS kernel name as detected by the DBGF.
13798
13799	This feature is not implemented in the 4.0.0 release but may show up
13800	in a dot release.
13801	</desc>
13802	</attribute>
13803
13804	<attribute name="OSVersion" type="wstring" readonly="yes">
13805	<desc>
13806	Query the guest OS kernel version string as detected by the DBGF.
13807
13808	This feature is not implemented in the 4.0.0 release but may show up
13809	in a dot release.
13810	</desc>
13811	</attribute>
13812
13813	<attribute name="PAEEnabled" type="boolean" readonly="yes">
13814	<desc>
13815	Flag indicating whether the VM is currently making use of the Physical
13816	Address Extension CPU feature.
13817	</desc>
13818	</attribute>
13819
13820	<attribute name="virtualTimeRate" type="unsigned long">
13821	<desc>
13822	The rate at which the virtual time runs expressed as a percentage.
13823	The accepted range is 2% to 20000%.
13824	</desc>
13825	</attribute>
13826
13827	<attribute name="VM" type="long long" readonly="yes">
13828	<desc>
13829	Gets the VM handle. This is only for internal use while
13830	we carve the details of this interface.
13831	</desc>
13832	</attribute>
13833
13834	</interface>
13835
13836	<!--
13837	// IUSBController
13838	/////////////////////////////////////////////////////////////////////////
13839	-->
13840
13841	<interface
13842	name="IUSBController" extends="$unknown"
13843	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
13844	wsmap="managed"
13845	>
13846	<attribute name="enabled" type="boolean">
13847	<desc>
13848	Flag whether the USB controller is present in the
13849	guest system. If disabled, the virtual guest hardware will
13850	not contain any USB controller. Can only be changed when
13851	the VM is powered off.
13852	</desc>
13853	</attribute>
13854
13855	<attribute name="enabledEhci" type="boolean">
13856	<desc>
13857	Flag whether the USB EHCI controller is present in the
13858	guest system. If disabled, the virtual guest hardware will
13859	not contain a USB EHCI controller. Can only be changed when
13860	the VM is powered off.
13861	</desc>
13862	</attribute>
13863
13864	<attribute name="proxyAvailable" type="boolean" readonly="yes">
13865	<desc>
13866	Flag whether there is an USB proxy available.
13867	</desc>
13868	</attribute>
13869
13870	<attribute name="USBStandard" type="unsigned short" readonly="yes">
13871	<desc>
13872	USB standard version which the controller implements.
13873	This is a BCD which means that the major version is in the
13874	high byte and minor version is in the low byte.
13875	</desc>
13876	</attribute>
13877
13878	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
13879	<desc>
13880	List of USB device filters associated with the machine.
13881
13882	If the machine is currently running, these filters are activated
13883	every time a new (supported) USB device is attached to the host
13884	computer that was not ignored by global filters
13885	(<link to="IHost::USBDeviceFilters"/>).
13886
13887	These filters are also activated when the machine is powered up.
13888	They are run against a list of all currently available USB
13889	devices (in states
13890	<link to="USBDeviceState_Available"/>,
13891	<link to="USBDeviceState_Busy"/>,
13892	<link to="USBDeviceState_Held"/>) that were not previously
13893	ignored by global filters.
13894
13895	If at least one filter matches the USB device in question, this
13896	device is automatically captured (attached to) the virtual USB
13897	controller of this machine.
13898
13899	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
13900	</desc>
13901	</attribute>
13902
13903	<method name="createDeviceFilter">
13904	<desc>
13905	Creates a new USB device filter. All attributes except
13906	the filter name are set to empty (any match),
13907	<i>active</i> is @c false (the filter is not active).
13908
13909	The created filter can then be added to the list of filters using
13910	<link to="#insertDeviceFilter"/>.
13911
13912	<result name="VBOX_E_INVALID_VM_STATE">
13913	The virtual machine is not mutable.
13914	</result>
13915
13916	<see><link to="#deviceFilters"/></see>
13917	</desc>
13918	<param name="name" type="wstring" dir="in">
13919	<desc>
13920	Filter name. See <link to="IUSBDeviceFilter::name"/>
13921	for more info.
13922	</desc>
13923	</param>
13924	<param name="filter" type="IUSBDeviceFilter" dir="return">
13925	<desc>Created filter object.</desc>
13926	</param>
13927	</method>
13928
13929	<method name="insertDeviceFilter">
13930	<desc>
13931	Inserts the given USB device to the specified position
13932	in the list of filters.
13933
13934	Positions are numbered starting from <tt>0</tt>. If the specified
13935	position is equal to or greater than the number of elements in
13936	the list, the filter is added to the end of the collection.
13937
13938	<note>
13939	Duplicates are not allowed, so an attempt to insert a
13940	filter that is already in the collection, will return an
13941	error.
13942	</note>
13943
13944	<result name="VBOX_E_INVALID_VM_STATE">
13945	Virtual machine is not mutable.
13946	</result>
13947	<result name="E_INVALIDARG">
13948	USB device filter not created within this VirtualBox instance.
13949	</result>
13950	<result name="VBOX_E_INVALID_OBJECT_STATE">
13951	USB device filter already in list.
13952	</result>
13953
13954	<see><link to="#deviceFilters"/></see>
13955	</desc>
13956	<param name="position" type="unsigned long" dir="in">
13957	<desc>Position to insert the filter to.</desc>
13958	</param>
13959	<param name="filter" type="IUSBDeviceFilter" dir="in">
13960	<desc>USB device filter to insert.</desc>
13961	</param>
13962	</method>
13963
13964	<method name="removeDeviceFilter">
13965	<desc>
13966	Removes a USB device filter from the specified position in the
13967	list of filters.
13968
13969	Positions are numbered starting from <tt>0</tt>. Specifying a
13970	position equal to or greater than the number of elements in
13971	the list will produce an error.
13972
13973	<see><link to="#deviceFilters"/></see>
13974
13975	<result name="VBOX_E_INVALID_VM_STATE">
13976	Virtual machine is not mutable.
13977	</result>
13978	<result name="E_INVALIDARG">
13979	USB device filter list empty or invalid @a position.
13980	</result>
13981
13982	</desc>
13983	<param name="position" type="unsigned long" dir="in">
13984	<desc>Position to remove the filter from.</desc>
13985	</param>
13986	<param name="filter" type="IUSBDeviceFilter" dir="return">
13987	<desc>Removed USB device filter.</desc>
13988	</param>
13989	</method>
13990
13991	</interface>
13992
13993
13994	<!--
13995	// IUSBDevice
13996	/////////////////////////////////////////////////////////////////////////
13997	-->
13998
13999	<interface
14000	name="IUSBDevice" extends="$unknown"
14001	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
14002	wsmap="managed"
14003	>
14004	<desc>
14005	The IUSBDevice interface represents a virtual USB device attached to the
14006	virtual machine.
14007
14008	A collection of objects implementing this interface is stored in the
14009	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
14010	attached to a running virtual machine's USB controller.
14011	</desc>
14012
14013	<attribute name="id" type="uuid" mod="string" readonly="yes">
14014	<desc>
14015	Unique USB device ID. This ID is built from #vendorId,
14016	#productId, #revision and #serialNumber.
14017	</desc>
14018	</attribute>
14019
14020	<attribute name="vendorId" type="unsigned short" readonly="yes">
14021	<desc>Vendor ID.</desc>
14022	</attribute>
14023
14024	<attribute name="productId" type="unsigned short" readonly="yes">
14025	<desc>Product ID.</desc>
14026	</attribute>
14027
14028	<attribute name="revision" type="unsigned short" readonly="yes">
14029	<desc>
14030	Product revision number. This is a packed BCD represented as
14031	unsigned short. The high byte is the integer part and the low
14032	byte is the decimal.
14033	</desc>
14034	</attribute>
14035
14036	<attribute name="manufacturer" type="wstring" readonly="yes">
14037	<desc>Manufacturer string.</desc>
14038	</attribute>
14039
14040	<attribute name="product" type="wstring" readonly="yes">
14041	<desc>Product string.</desc>
14042	</attribute>
14043
14044	<attribute name="serialNumber" type="wstring" readonly="yes">
14045	<desc>Serial number string.</desc>
14046	</attribute>
14047
14048	<attribute name="address" type="wstring" readonly="yes">
14049	<desc>Host specific address of the device.</desc>
14050	</attribute>
14051
14052	<attribute name="port" type="unsigned short" readonly="yes">
14053	<desc>
14054	Host USB port number the device is physically
14055	connected to.
14056	</desc>
14057	</attribute>
14058
14059	<attribute name="version" type="unsigned short" readonly="yes">
14060	<desc>
14061	The major USB version of the device - 1 or 2.
14062	</desc>
14063	</attribute>
14064
14065	<attribute name="portVersion" type="unsigned short" readonly="yes">
14066	<desc>
14067	The major USB version of the host USB port the device is
14068	physically connected to - 1 or 2. For devices not connected to
14069	anything this will have the same value as the version attribute.
14070	</desc>
14071	</attribute>
14072
14073	<attribute name="remote" type="boolean" readonly="yes">
14074	<desc>
14075	Whether the device is physically connected to a remote VRDE
14076	client or to a local host machine.
14077	</desc>
14078	</attribute>
14079
14080	</interface>
14081
14082
14083	<!--
14084	// IUSBDeviceFilter
14085	/////////////////////////////////////////////////////////////////////////
14086	-->
14087
14088	<interface
14089	name="IUSBDeviceFilter" extends="$unknown"
14090	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
14091	wsmap="managed"
14092	>
14093	<desc>
14094	The IUSBDeviceFilter interface represents an USB device filter used
14095	to perform actions on a group of USB devices.
14096
14097	This type of filters is used by running virtual machines to
14098	automatically capture selected USB devices once they are physically
14099	attached to the host computer.
14100
14101	A USB device is matched to the given device filter if and only if all
14102	attributes of the device match the corresponding attributes of the
14103	filter (that is, attributes are joined together using the logical AND
14104	operation). On the other hand, all together, filters in the list of
14105	filters carry the semantics of the logical OR operation. So if it is
14106	desirable to create a match like "this vendor id OR this product id",
14107	one needs to create two filters and specify "any match" (see below)
14108	for unused attributes.
14109
14110	All filter attributes used for matching are strings. Each string
14111	is an expression representing a set of values of the corresponding
14112	device attribute, that will match the given filter. Currently, the
14113	following filtering expressions are supported:
14114
14115	<ul>
14116	<li><i>Interval filters</i>. Used to specify valid intervals for
14117	integer device attributes (Vendor ID, Product ID and Revision).
14118	The format of the string is:
14119
14120	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
14121
14122	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
14123	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
14124	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
14125	is omitted before a dash (<tt>-</tt>), the minimum possible integer
14126	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
14127	possible integer is assumed.
14128	</li>
14129	<li><i>Boolean filters</i>. Used to specify acceptable values for
14130	boolean device attributes. The format of the string is:
14131
14132	<tt>true\|false\|yes\|no\|0\|1</tt>
14133
14134	</li>
14135	<li><i>Exact match</i>. Used to specify a single value for the given
14136	device attribute. Any string that doesn't start with <tt>int:</tt>
14137	represents the exact match. String device attributes are compared to
14138	this string including case of symbols. Integer attributes are first
14139	converted to a string (see individual filter attributes) and then
14140	compared ignoring case.
14141
14142	</li>
14143	<li><i>Any match</i>. Any value of the corresponding device attribute
14144	will match the given filter. An empty or @c null string is
14145	used to construct this type of filtering expressions.
14146
14147	</li>
14148	</ul>
14149
14150	<note>
14151	On the Windows host platform, interval filters are not currently
14152	available. Also all string filter attributes
14153	(<link to="#manufacturer"/>, <link to="#product"/>,
14154	<link to="#serialNumber"/>) are ignored, so they behave as
14155	<i>any match</i> no matter what string expression is specified.
14156	</note>
14157
14158	<see><link to="IUSBController::deviceFilters"/>,
14159	<link to="IHostUSBDeviceFilter"/></see>
14160	</desc>
14161
14162	<attribute name="name" type="wstring">
14163	<desc>
14164	Visible name for this filter.
14165	This name is used to visually distinguish one filter from another,
14166	so it can neither be @c null nor an empty string.
14167	</desc>
14168	</attribute>
14169
14170	<attribute name="active" type="boolean">
14171	<desc>Whether this filter active or has been temporarily disabled.</desc>
14172	</attribute>
14173
14174	<attribute name="vendorId" type="wstring">
14175	<desc>
14176	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
14177	The string representation for the <i>exact matching</i>
14178	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
14179	(including leading zeroes).
14180	</desc>
14181	</attribute>
14182
14183	<attribute name="productId" type="wstring">
14184	<desc>
14185	<link to="IUSBDevice::productId">Product ID</link> filter.
14186	The string representation for the <i>exact matching</i>
14187	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
14188	(including leading zeroes).
14189	</desc>
14190	</attribute>
14191
14192	<attribute name="revision" type="wstring">
14193	<desc>
14194	<link to="IUSBDevice::productId">Product revision number</link>
14195	filter. The string representation for the <i>exact matching</i>
14196	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
14197	of the integer part of the revision, and <tt>F</tt> is the
14198	decimal digit of its fractional part (including leading and
14199	trailing zeros).
14200	Note that for interval filters, it's best to use the hexadecimal
14201	form, because the revision is stored as a 16 bit packed BCD value;
14202	so the expression <tt>int:0x0100-0x0199</tt> will match any
14203	revision from <tt>1.0</tt> to <tt>1.99</tt>.
14204	</desc>
14205	</attribute>
14206
14207	<attribute name="manufacturer" type="wstring">
14208	<desc>
14209	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
14210	</desc>
14211	</attribute>
14212
14213	<attribute name="product" type="wstring">
14214	<desc>
14215	<link to="IUSBDevice::product">Product</link> filter.
14216	</desc>
14217	</attribute>
14218
14219	<attribute name="serialNumber" type="wstring">
14220	<desc>
14221	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
14222	</desc>
14223	</attribute>
14224
14225	<attribute name="port" type="wstring">
14226	<desc>
14227	<link to="IUSBDevice::port">Host USB port</link> filter.
14228	</desc>
14229	</attribute>
14230
14231	<attribute name="remote" type="wstring">
14232	<desc>
14233	<link to="IUSBDevice::remote">Remote state</link> filter.
14234	<note>
14235	This filter makes sense only for machine USB filters,
14236	i.e. it is ignored by IHostUSBDeviceFilter objects.
14237	</note>
14238	</desc>
14239	</attribute>
14240
14241	<attribute name="maskedInterfaces" type="unsigned long">
14242	<desc>
14243	This is an advanced option for hiding one or more USB interfaces
14244	from the guest. The value is a bit mask where the bits that are set
14245	means the corresponding USB interface should be hidden, masked off
14246	if you like.
14247	This feature only works on Linux hosts.
14248	</desc>
14249	</attribute>
14250
14251	</interface>
14252
14253
14254	<!--
14255	// IHostUSBDevice
14256	/////////////////////////////////////////////////////////////////////////
14257	-->
14258
14259	<enum
14260	name="USBDeviceState"
14261	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
14262	>
14263	<desc>
14264	USB device state. This enumeration represents all possible states
14265	of the USB device physically attached to the host computer regarding
14266	its state on the host computer and availability to guest computers
14267	(all currently running virtual machines).
14268
14269	Once a supported USB device is attached to the host, global USB
14270	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
14271	either ignore the device, or put it to USBDeviceState_Held state, or do
14272	nothing. Unless the device is ignored by global filters, filters of all
14273	currently running guests (<link to="IUSBController::deviceFilters"/>) are
14274	activated that can put it to USBDeviceState_Captured state.
14275
14276	If the device was ignored by global filters, or didn't match
14277	any filters at all (including guest ones), it is handled by the host
14278	in a normal way. In this case, the device state is determined by
14279	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
14280	or USBDeviceState_Available, depending on the current device usage.
14281
14282	Besides auto-capturing based on filters, the device can be manually
14283	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
14284	state is USBDeviceState_Busy, USBDeviceState_Available or
14285	USBDeviceState_Held.
14286
14287	<note>
14288	Due to differences in USB stack implementations in Linux and Win32,
14289	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
14290	only to the Linux version of the product. This also means that (<link
14291	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
14292	device state is USBDeviceState_Held.
14293	</note>
14294
14295	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
14296	</desc>
14297
14298	<const name="NotSupported" value="0">
14299	<desc>
14300	Not supported by the VirtualBox server, not available to guests.
14301	</desc>
14302	</const>
14303	<const name="Unavailable" value="1">
14304	<desc>
14305	Being used by the host computer exclusively,
14306	not available to guests.
14307	</desc>
14308	</const>
14309	<const name="Busy" value="2">
14310	<desc>
14311	Being used by the host computer, potentially available to guests.
14312	</desc>
14313	</const>
14314	<const name="Available" value="3">
14315	<desc>
14316	Not used by the host computer, available to guests (the host computer
14317	can also start using the device at any time).
14318	</desc>
14319	</const>
14320	<const name="Held" value="4">
14321	<desc>
14322	Held by the VirtualBox server (ignored by the host computer),
14323	available to guests.
14324	</desc>
14325	</const>
14326	<const name="Captured" value="5">
14327	<desc>
14328	Captured by one of the guest computers, not available
14329	to anybody else.
14330	</desc>
14331	</const>
14332	</enum>
14333
14334	<interface
14335	name="IHostUSBDevice" extends="IUSBDevice"
14336	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
14337	wsmap="managed"
14338	>
14339	<desc>
14340	The IHostUSBDevice interface represents a physical USB device attached
14341	to the host computer.
14342
14343	Besides properties inherited from IUSBDevice, this interface adds the
14344	<link to="#state"/> property that holds the current state of the USB
14345	device.
14346
14347	<see><link to="IHost::USBDevices"/>,
14348	<link to="IHost::USBDeviceFilters"/></see>
14349	</desc>
14350
14351	<attribute name="state" type="USBDeviceState" readonly="yes">
14352	<desc>
14353	Current state of the device.
14354	</desc>
14355	</attribute>
14356
14357	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
14358
14359	</interface>
14360
14361
14362	<!--
14363	// IHostUSBDeviceFilter
14364	/////////////////////////////////////////////////////////////////////////
14365	-->
14366
14367	<enum
14368	name="USBDeviceFilterAction"
14369	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
14370	>
14371	<desc>
14372	Actions for host USB device filters.
14373	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
14374	</desc>
14375
14376	<const name="Null" value="0">
14377	<desc>Null value (never used by the API).</desc>
14378	</const>
14379	<const name="Ignore" value="1">
14380	<desc>Ignore the matched USB device.</desc>
14381	</const>
14382	<const name="Hold" value="2">
14383	<desc>Hold the matched USB device.</desc>
14384	</const>
14385	</enum>
14386
14387	<interface
14388	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
14389	uuid="4cc70246-d74a-400f-8222-3900489c0374"
14390	wsmap="managed"
14391	>
14392	<desc>
14393	The IHostUSBDeviceFilter interface represents a global filter for a
14394	physical USB device used by the host computer. Used indirectly in
14395	<link to="IHost::USBDeviceFilters"/>.
14396
14397	Using filters of this type, the host computer determines the initial
14398	state of the USB device after it is physically attached to the
14399	host's USB controller.
14400
14401	<note>
14402	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
14403	filters, because it makes sense only for
14404	<link to="IUSBController::deviceFilters">machine USB filters</link>.
14405	</note>
14406
14407	<see><link to="IHost::USBDeviceFilters"/></see>
14408	</desc>
14409
14410	<attribute name="action" type="USBDeviceFilterAction">
14411	<desc>
14412	Action performed by the host when an attached USB device
14413	matches this filter.
14414	</desc>
14415	</attribute>
14416
14417	</interface>
14418
14419	<!--
14420	// IAudioAdapter
14421	/////////////////////////////////////////////////////////////////////////
14422	-->
14423
14424	<enum
14425	name="AudioDriverType"
14426	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
14427	>
14428	<desc>
14429	Host audio driver type.
14430	</desc>
14431
14432	<const name="Null" value="0">
14433	<desc>Null value, also means "dummy audio driver".</desc>
14434	</const>
14435	<const name="WinMM" value="1">
14436	<desc>Windows multimedia (Windows hosts only).</desc>
14437	</const>
14438	<const name="OSS" value="2">
14439	<desc>Open Sound System (Linux hosts only).</desc>
14440	</const>
14441	<const name="ALSA" value="3">
14442	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
14443	</const>
14444	<const name="DirectSound" value="4">
14445	<desc>DirectSound (Windows hosts only).</desc>
14446	</const>
14447	<const name="CoreAudio" value="5">
14448	<desc>CoreAudio (Mac hosts only).</desc>
14449	</const>
14450	<const name="MMPM" value="6">
14451	<desc>Reserved for historical reasons.</desc>
14452	</const>
14453	<const name="Pulse" value="7">
14454	<desc>PulseAudio (Linux hosts only).</desc>
14455	</const>
14456	<const name="SolAudio" value="8">
14457	<desc>Solaris audio (Solaris hosts only).</desc>
14458	</const>
14459	</enum>
14460
14461	<enum
14462	name="AudioControllerType"
14463	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
14464	>
14465	<desc>
14466	Virtual audio controller type.
14467	</desc>
14468
14469	<const name="AC97" value="0"/>
14470	<const name="SB16" value="1"/>
14471	<const name="HDA" value="2"/>
14472	</enum>
14473
14474	<interface
14475	name="IAudioAdapter" extends="$unknown"
14476	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
14477	wsmap="managed"
14478	>
14479	<desc>
14480	The IAudioAdapter interface represents the virtual audio adapter of
14481	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
14482	</desc>
14483	<attribute name="enabled" type="boolean">
14484	<desc>
14485	Flag whether the audio adapter is present in the
14486	guest system. If disabled, the virtual guest hardware will
14487	not contain any audio adapter. Can only be changed when
14488	the VM is not running.
14489	</desc>
14490	</attribute>
14491	<attribute name="audioController" type="AudioControllerType">
14492	<desc>
14493	The audio hardware we emulate.
14494	</desc>
14495	</attribute>
14496	<attribute name="audioDriver" type="AudioDriverType">
14497	<desc>
14498	Audio driver the adapter is connected to. This setting
14499	can only be changed when the VM is not running.
14500	</desc>
14501	</attribute>
14502	</interface>
14503
14504	<enum
14505	name="AuthType"
14506	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
14507	>
14508	<desc>
14509	VirtualBox authentication type.
14510	</desc>
14511
14512	<const name="Null" value="0">
14513	<desc>Null value, also means "no authentication".</desc>
14514	</const>
14515	<const name="External" value="1"/>
14516	<const name="Guest" value="2"/>
14517	</enum>
14518
14519	<!--
14520	// IVRDEServer
14521	/////////////////////////////////////////////////////////////////////////
14522	-->
14523
14524	<interface
14525	name="IVRDEServer" extends="$unknown"
14526	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
14527	wsmap="managed"
14528	>
14529	<attribute name="enabled" type="boolean">
14530	<desc>VRDE server status.</desc>
14531	</attribute>
14532
14533	<attribute name="authType" type="AuthType">
14534	<desc>VRDE authentication method.</desc>
14535	</attribute>
14536
14537	<attribute name="authTimeout" type="unsigned long">
14538	<desc>Timeout for guest authentication. Milliseconds.</desc>
14539	</attribute>
14540
14541	<attribute name="allowMultiConnection" type="boolean">
14542	<desc>
14543	Flag whether multiple simultaneous connections to the VM are permitted.
14544	Note that this will be replaced by a more powerful mechanism in the future.
14545	</desc>
14546	</attribute>
14547
14548	<attribute name="reuseSingleConnection" type="boolean">
14549	<desc>
14550	Flag whether the existing connection must be dropped and a new connection
14551	must be established by the VRDE server, when a new client connects in single
14552	connection mode.
14553	</desc>
14554	</attribute>
14555
14556	<attribute name="VRDEExtPack" type="wstring">
14557	<desc>
14558	The name of Extension Pack providing VRDE for this VM. Overrides
14559	<link to="ISystemProperties::defaultVRDEExtPack"/>.
14560	</desc>
14561	</attribute>
14562
14563	<attribute name="authLibrary" type="wstring">
14564	<desc>
14565	Library used for authentication of RDP clients by this VM. Overrides
14566	<link to="ISystemProperties::VRDEAuthLibrary"/>.
14567	</desc>
14568	</attribute>
14569
14570	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
14571	<desc>
14572	Array of names of properties, which are supported by this VRDE server.
14573	</desc>
14574	</attribute>
14575
14576	<method name="setVRDEProperty">
14577	<desc>
14578	Sets a VRDE specific property string.
14579
14580	If you pass @c null or empty string as a key @a value, the given @a key
14581	will be deleted.
14582
14583	</desc>
14584	<param name="key" type="wstring" dir="in">
14585	<desc>Name of the key to set.</desc>
14586	</param>
14587	<param name="value" type="wstring" dir="in">
14588	<desc>Value to assign to the key.</desc>
14589	</param>
14590	</method>
14591
14592	<method name="getVRDEProperty" const="yes">
14593	<desc>
14594	Returns a VRDE specific property string.
14595
14596	If the requested data @a key does not exist, this function will
14597	succeed and return an empty string in the @a value argument.
14598
14599	</desc>
14600	<param name="key" type="wstring" dir="in">
14601	<desc>Name of the key to get.</desc>
14602	</param>
14603	<param name="value" type="wstring" dir="return">
14604	<desc>Value of the requested key.</desc>
14605	</param>
14606	</method>
14607
14608	</interface>
14609
14610
14611	<!--
14612	// ISharedFolder
14613	/////////////////////////////////////////////////////////////////////////
14614	-->
14615
14616	<interface
14617	name="ISharedFolder" extends="$unknown"
14618	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
14619	wsmap="struct"
14620	>
14621	<desc>
14622	The ISharedFolder interface represents a folder in the host computer's
14623	file system accessible from the guest OS running inside a virtual
14624	machine using an associated logical name.
14625
14626	There are three types of shared folders:
14627	<ul>
14628	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
14629	folders available to all virtual machines.</li>
14630	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
14631	VM-specific shared folders available to the given virtual machine at
14632	startup.</li>
14633	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
14634	VM-specific shared folders created in the session context (for
14635	example, when the virtual machine is running) and automatically
14636	discarded when the session is closed (the VM is powered off).</li>
14637	</ul>
14638
14639	Logical names of shared folders must be unique within the given scope
14640	(global, permanent or transient). However, they do not need to be unique
14641	across scopes. In this case, the definition of the shared folder in a
14642	more specific scope takes precedence over definitions in all other
14643	scopes. The order of precedence is (more specific to more general):
14644	<ol>
14645	<li>Transient definitions</li>
14646	<li>Permanent definitions</li>
14647	<li>Global definitions</li>
14648	</ol>
14649
14650	For example, if MyMachine has a shared folder named
14651	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
14652	transient shared folder named <tt>C_DRIVE</tt> (that points
14653	to <tt>C:\\\\WINDOWS</tt>) will change the definition
14654	of <tt>C_DRIVE</tt> in the guest OS so
14655	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
14656	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
14657	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
14658	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
14659	to <tt>C:\\</tt> if it still exists.
14660
14661	Note that permanent and transient shared folders of different machines
14662	are in different name spaces, so they don't overlap and don't need to
14663	have unique logical names.
14664
14665	<note>
14666	Global shared folders are not implemented in the current version of the
14667	product.
14668	</note>
14669	</desc>
14670
14671	<attribute name="name" type="wstring" readonly="yes">
14672	<desc>Logical name of the shared folder.</desc>
14673	</attribute>
14674
14675	<attribute name="hostPath" type="wstring" readonly="yes">
14676	<desc>Full path to the shared folder in the host file system.</desc>
14677	</attribute>
14678
14679	<attribute name="accessible" type="boolean" readonly="yes">
14680	<desc>
14681	Whether the folder defined by the host path is currently
14682	accessible or not.
14683	For example, the folder can be inaccessible if it is placed
14684	on the network share that is not available by the time
14685	this property is read.
14686	</desc>
14687	</attribute>
14688
14689	<attribute name="writable" type="boolean" readonly="yes">
14690	<desc>
14691	Whether the folder defined by the host path is writable or
14692	not.
14693	</desc>
14694	</attribute>
14695
14696	<attribute name="autoMount" type="boolean" readonly="yes">
14697	<desc>
14698	Whether the folder gets automatically mounted by the guest or not.
14699	</desc>
14700	</attribute>
14701
14702	<attribute name="lastAccessError" type="wstring" readonly="yes">
14703	<desc>
14704	Text message that represents the result of the last accessibility
14705	check.
14706
14707	Accessibility checks are performed each time the <link to="#accessible"/>
14708	attribute is read. An empty string is returned if the last
14709	accessibility check was successful. A non-empty string indicates a
14710	failure and should normally describe a reason of the failure (for
14711	example, a file read error).
14712	</desc>
14713	</attribute>
14714
14715	</interface>
14716
14717	<!--
14718	// ISession
14719	/////////////////////////////////////////////////////////////////////////
14720	-->
14721
14722	<interface
14723	name="IInternalSessionControl" extends="$unknown"
14724	uuid="9ddb5449-f463-47cb-a717-d6f22da3b3a2"
14725	internal="yes"
14726	wsmap="suppress"
14727	>
14728	<method name="getPID">
14729	<desc>PID of the process that has created this Session object.
14730	</desc>
14731	<param name="pid" type="unsigned long" dir="return"/>
14732	</method>
14733
14734	<method name="getRemoteConsole">
14735	<desc>
14736	Returns the console object suitable for remote control.
14737
14738	<result name="VBOX_E_INVALID_VM_STATE">
14739	Session state prevents operation.
14740	</result>
14741	<result name="VBOX_E_INVALID_OBJECT_STATE">
14742	Session type prevents operation.
14743	</result>
14744
14745	</desc>
14746	<param name="console" type="IConsole" dir="return"/>
14747	</method>
14748
14749	<method name="assignMachine">
14750	<desc>
14751	Assigns the machine object associated with this direct-type
14752	session or informs the session that it will be a remote one
14753	(if @a machine == @c null).
14754
14755	<result name="VBOX_E_INVALID_VM_STATE">
14756	Session state prevents operation.
14757	</result>
14758	<result name="VBOX_E_INVALID_OBJECT_STATE">
14759	Session type prevents operation.
14760	</result>
14761
14762	</desc>
14763	<param name="machine" type="IMachine" dir="in"/>
14764	</method>
14765
14766	<method name="assignRemoteMachine">
14767	<desc>
14768	Assigns the machine and the (remote) console object associated with
14769	this remote-type session.
14770
14771	<result name="VBOX_E_INVALID_VM_STATE">
14772	Session state prevents operation.
14773	</result>
14774
14775	</desc>
14776	<param name="machine" type="IMachine" dir="in"/>
14777	<param name="console" type="IConsole" dir="in"/>
14778	</method>
14779
14780	<method name="updateMachineState">
14781	<desc>
14782	Updates the machine state in the VM process.
14783	Must be called only in certain cases
14784	(see the method implementation).
14785
14786	<result name="VBOX_E_INVALID_VM_STATE">
14787	Session state prevents operation.
14788	</result>
14789	<result name="VBOX_E_INVALID_OBJECT_STATE">
14790	Session type prevents operation.
14791	</result>
14792
14793	</desc>
14794	<param name="aMachineState" type="MachineState" dir="in"/>
14795	</method>
14796
14797	<method name="uninitialize">
14798	<desc>
14799	Uninitializes (closes) this session. Used by VirtualBox to close
14800	the corresponding remote session when the direct session dies
14801	or gets closed.
14802
14803	<result name="VBOX_E_INVALID_VM_STATE">
14804	Session state prevents operation.
14805	</result>
14806
14807	</desc>
14808	</method>
14809
14810	<method name="onNetworkAdapterChange">
14811	<desc>
14812	Triggered when settings of a network adapter of the
14813	associated virtual machine have changed.
14814
14815	<result name="VBOX_E_INVALID_VM_STATE">
14816	Session state prevents operation.
14817	</result>
14818	<result name="VBOX_E_INVALID_OBJECT_STATE">
14819	Session type prevents operation.
14820	</result>
14821
14822	</desc>
14823	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
14824	<param name="changeAdapter" type="boolean" dir="in"/>
14825	</method>
14826
14827	<method name="onSerialPortChange">
14828	<desc>
14829	Triggered when settings of a serial port of the
14830	associated virtual machine have changed.
14831
14832	<result name="VBOX_E_INVALID_VM_STATE">
14833	Session state prevents operation.
14834	</result>
14835	<result name="VBOX_E_INVALID_OBJECT_STATE">
14836	Session type prevents operation.
14837	</result>
14838
14839	</desc>
14840	<param name="serialPort" type="ISerialPort" dir="in"/>
14841	</method>
14842
14843	<method name="onParallelPortChange">
14844	<desc>
14845	Triggered when settings of a parallel port of the
14846	associated virtual machine have changed.
14847
14848	<result name="VBOX_E_INVALID_VM_STATE">
14849	Session state prevents operation.
14850	</result>
14851	<result name="VBOX_E_INVALID_OBJECT_STATE">
14852	Session type prevents operation.
14853	</result>
14854
14855	</desc>
14856	<param name="parallelPort" type="IParallelPort" dir="in"/>
14857	</method>
14858
14859	<method name="onStorageControllerChange">
14860	<desc>
14861	Triggered when settings of a storage controller 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	</method>
14873
14874	<method name="onMediumChange">
14875	<desc>
14876	Triggered when attached media of the
14877	associated virtual machine have changed.
14878
14879	<result name="VBOX_E_INVALID_VM_STATE">
14880	Session state prevents operation.
14881	</result>
14882	<result name="VBOX_E_INVALID_OBJECT_STATE">
14883	Session type prevents operation.
14884	</result>
14885
14886	</desc>
14887
14888	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14889	<desc>The medium attachment which changed.</desc>
14890	</param>
14891	<param name="force" type="boolean" dir="in">
14892	<desc>If the medium change was forced.</desc>
14893	</param>
14894	</method>
14895
14896	<method name="onStorageDeviceChange">
14897	<desc>
14898	Triggered when attached storage devices of the
14899	associated virtual machine have changed.
14900
14901	<result name="VBOX_E_INVALID_VM_STATE">
14902	Session state prevents operation.
14903	</result>
14904	<result name="VBOX_E_INVALID_OBJECT_STATE">
14905	Session type prevents operation.
14906	</result>
14907
14908	</desc>
14909
14910	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14911	<desc>The medium attachment which changed.</desc>
14912	</param>
14913	<param name="remove" type="boolean" dir="in">
14914	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
14915	</param>
14916	</method>
14917
14918	<method name="onClipboardModeChange">
14919	<desc>
14920	Notification when the shared clipboard mode changes.
14921	</desc>
14922	<param name="clipboardMode" type="ClipboardMode" dir="in">
14923	<desc>The new shared clipboard mode.</desc>
14924	</param>
14925	</method>
14926
14927	<method name="onCPUChange">
14928	<desc>
14929	Notification when a CPU changes.
14930	</desc>
14931	<param name="cpu" type="unsigned long" dir="in">
14932	<desc>The CPU which changed</desc>
14933	</param>
14934	<param name="add" type="boolean" dir="in">
14935	<desc>Flag whether the CPU was added or removed</desc>
14936	</param>
14937	</method>
14938
14939	<method name="onCPUExecutionCapChange">
14940	<desc>
14941	Notification when the CPU execution cap changes.
14942	</desc>
14943	<param name="executionCap" type="unsigned long" dir="in">
14944	<desc>The new CPU execution cap value. (1-100)</desc>
14945	</param>
14946	</method>
14947
14948	<method name="onVRDEServerChange">
14949	<desc>
14950	Triggered when settings of the VRDE server object of the
14951	associated virtual machine have changed.
14952
14953	<result name="VBOX_E_INVALID_VM_STATE">
14954	Session state prevents operation.
14955	</result>
14956	<result name="VBOX_E_INVALID_OBJECT_STATE">
14957	Session type prevents operation.
14958	</result>
14959
14960	</desc>
14961	<param name="restart" type="boolean" dir="in">
14962	<desc>Flag whether the server must be restarted</desc>
14963	</param>
14964	</method>
14965
14966	<method name="onUSBControllerChange">
14967	<desc>
14968	Triggered when settings of the USB controller object of the
14969	associated virtual machine have changed.
14970
14971	<result name="VBOX_E_INVALID_VM_STATE">
14972	Session state prevents operation.
14973	</result>
14974	<result name="VBOX_E_INVALID_OBJECT_STATE">
14975	Session type prevents operation.
14976	</result>
14977
14978	</desc>
14979	</method>
14980
14981	<method name="onSharedFolderChange">
14982	<desc>
14983	Triggered when a permanent (global or machine) shared folder has been
14984	created or removed.
14985	<note>
14986	We don't pass shared folder parameters in this notification because
14987	the order in which parallel notifications are delivered is not defined,
14988	therefore it could happen that these parameters were outdated by the
14989	time of processing this notification.
14990	</note>
14991
14992	<result name="VBOX_E_INVALID_VM_STATE">
14993	Session state prevents operation.
14994	</result>
14995	<result name="VBOX_E_INVALID_OBJECT_STATE">
14996	Session type prevents operation.
14997	</result>
14998
14999	</desc>
15000	<param name="global" type="boolean" dir="in"/>
15001	</method>
15002
15003	<method name="onUSBDeviceAttach">
15004	<desc>
15005	Triggered when a request to capture a USB device (as a result
15006	of matched USB filters or direct call to
15007	<link to="IConsole::attachUSBDevice"/>) has completed.
15008	A @c null @a error object means success, otherwise it
15009	describes a failure.
15010
15011	<result name="VBOX_E_INVALID_VM_STATE">
15012	Session state prevents operation.
15013	</result>
15014	<result name="VBOX_E_INVALID_OBJECT_STATE">
15015	Session type prevents operation.
15016	</result>
15017
15018	</desc>
15019	<param name="device" type="IUSBDevice" dir="in"/>
15020	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
15021	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
15022	</method>
15023
15024	<method name="onUSBDeviceDetach">
15025	<desc>
15026	Triggered when a request to release the USB device (as a result
15027	of machine termination or direct call to
15028	<link to="IConsole::detachUSBDevice"/>) has completed.
15029	A @c null @a error object means success, otherwise it
15030	describes a failure.
15031
15032	<result name="VBOX_E_INVALID_VM_STATE">
15033	Session state prevents operation.
15034	</result>
15035	<result name="VBOX_E_INVALID_OBJECT_STATE">
15036	Session type prevents operation.
15037	</result>
15038
15039	</desc>
15040	<param name="id" type="uuid" mod="string" dir="in"/>
15041	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
15042	</method>
15043
15044	<method name="onShowWindow">
15045	<desc>
15046	Called by <link to="IMachine::canShowConsoleWindow"/> and by
15047	<link to="IMachine::showConsoleWindow"/> in order to notify
15048	console listeners
15049	<link to="ICanShowWindowEvent"/>
15050	and <link to="IShowWindowEvent"/>.
15051
15052	<result name="VBOX_E_INVALID_OBJECT_STATE">
15053	Session type prevents operation.
15054	</result>
15055
15056	</desc>
15057	<param name="check" type="boolean" dir="in"/>
15058	<param name="canShow" type="boolean" dir="out"/>
15059	<param name="winId" type="long long" dir="out"/>
15060	</method>
15061
15062	<method name="onBandwidthGroupChange">
15063	<desc>
15064	Notification when one of the bandwidth groups change.
15065	</desc>
15066	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
15067	<desc>The bandwidth group which changed.</desc>
15068	</param>
15069	</method>
15070
15071	<method name="accessGuestProperty">
15072	<desc>
15073	Called by <link to="IMachine::getGuestProperty"/> and by
15074	<link to="IMachine::setGuestProperty"/> in order to read and
15075	modify guest properties.
15076
15077	<result name="VBOX_E_INVALID_VM_STATE">
15078	Machine session is not open.
15079	</result>
15080	<result name="VBOX_E_INVALID_OBJECT_STATE">
15081	Session type is not direct.
15082	</result>
15083
15084	</desc>
15085	<param name="name" type="wstring" dir="in"/>
15086	<param name="value" type="wstring" dir="in"/>
15087	<param name="flags" type="wstring" dir="in"/>
15088	<param name="isSetter" type="boolean" dir="in"/>
15089	<param name="retValue" type="wstring" dir="out"/>
15090	<param name="retTimestamp" type="long long" dir="out"/>
15091	<param name="retFlags" type="wstring" dir="out"/>
15092	</method>
15093
15094	<method name="enumerateGuestProperties" const="yes">
15095	<desc>
15096	Return a list of the guest properties matching a set of patterns along
15097	with their values, time stamps and flags.
15098
15099	<result name="VBOX_E_INVALID_VM_STATE">
15100	Machine session is not open.
15101	</result>
15102	<result name="VBOX_E_INVALID_OBJECT_STATE">
15103	Session type is not direct.
15104	</result>
15105
15106	</desc>
15107	<param name="patterns" type="wstring" dir="in">
15108	<desc>
15109	The patterns to match the properties against as a comma-separated
15110	string. If this is empty, all properties currently set will be
15111	returned.
15112	</desc>
15113	</param>
15114	<param name="key" type="wstring" dir="out" safearray="yes">
15115	<desc>
15116	The key names of the properties returned.
15117	</desc>
15118	</param>
15119	<param name="value" type="wstring" dir="out" safearray="yes">
15120	<desc>
15121	The values of the properties returned. The array entries match the
15122	corresponding entries in the @a key array.
15123	</desc>
15124	</param>
15125	<param name="timestamp" type="long long" dir="out" safearray="yes">
15126	<desc>
15127	The time stamps of the properties returned. The array entries match
15128	the corresponding entries in the @a key array.
15129	</desc>
15130	</param>
15131	<param name="flags" type="wstring" dir="out" safearray="yes">
15132	<desc>
15133	The flags of the properties returned. The array entries match the
15134	corresponding entries in the @a key array.
15135	</desc>
15136	</param>
15137	</method>
15138
15139	<method name="onlineMergeMedium">
15140	<desc>
15141	Triggers online merging of a hard disk. Used internally when deleting
15142	a snapshot while a VM referring to the same hard disk chain is running.
15143
15144	<result name="VBOX_E_INVALID_VM_STATE">
15145	Machine session is not open.
15146	</result>
15147	<result name="VBOX_E_INVALID_OBJECT_STATE">
15148	Session type is not direct.
15149	</result>
15150
15151	</desc>
15152	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
15153	<desc>The medium attachment to identify the medium chain.</desc>
15154	</param>
15155	<param name="sourceIdx" type="unsigned long" dir="in">
15156	<desc>The index of the source image in the chain.
15157	Redundant, but drastically reduces IPC.</desc>
15158	</param>
15159	<param name="targetIdx" type="unsigned long" dir="in">
15160	<desc>The index of the target image in the chain.
15161	Redundant, but drastically reduces IPC.</desc>
15162	</param>
15163	<param name="source" type="IMedium" dir="in">
15164	<desc>Merge source medium.</desc>
15165	</param>
15166	<param name="target" type="IMedium" dir="in">
15167	<desc>Merge target medium.</desc>
15168	</param>
15169	<param name="mergeForward" type="boolean" dir="in">
15170	<desc>Merge direction.</desc>
15171	</param>
15172	<param name="parentForTarget" type="IMedium" dir="in">
15173	<desc>For forward merges: new parent for target medium.</desc>
15174	</param>
15175	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
15176	<desc>For backward merges: list of media which need their parent UUID
15177	updated.</desc>
15178	</param>
15179	<param name="progress" type="IProgress" dir="in">
15180	<desc>
15181	Progress object for this operation.
15182	</desc>
15183	</param>
15184	</method>
15185
15186	<method name="enableVMMStatistics">
15187	<desc>
15188	Enables or disables collection of VMM RAM statistics.
15189
15190	<result name="VBOX_E_INVALID_VM_STATE">
15191	Machine session is not open.
15192	</result>
15193	<result name="VBOX_E_INVALID_OBJECT_STATE">
15194	Session type is not direct.
15195	</result>
15196
15197	</desc>
15198	<param name="enable" type="boolean" dir="in">
15199	<desc>True enables statistics collection.</desc>
15200	</param>
15201	</method>
15202
15203	</interface>
15204
15205	<interface
15206	name="ISession" extends="$unknown"
15207	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
15208	wsmap="managed"
15209	>
15210	<desc>
15211	The ISession interface represents a client process and allows for locking
15212	virtual machines (represented by IMachine objects) to prevent conflicting
15213	changes to the machine.
15214
15215	Any caller wishing to manipulate a virtual machine needs to create a session
15216	object first, which lives in its own process space. Such session objects are
15217	then associated with <link to="IMachine" /> objects living in the VirtualBox
15218	server process to coordinate such changes.
15219
15220	There are two typical scenarios in which sessions are used:
15221
15222	<ul>
15223	<li>To alter machine settings or control a running virtual machine, one
15224	needs to lock a machine for a given session (client process) by calling
15225	<link to="IMachine::lockMachine"/>.
15226
15227	Whereas multiple sessions may control a running virtual machine, only
15228	one process can obtain a write lock on the machine to prevent conflicting
15229	changes. A write lock is also needed if a process wants to actually run a
15230	virtual machine in its own context, such as the VirtualBox GUI or
15231	VBoxHeadless front-ends. They must also lock a machine for their own
15232	sessions before they are allowed to power up the virtual machine.
15233
15234	As a result, no machine settings can be altered while another process is
15235	already using it, either because that process is modifying machine settings
15236	or because the machine is running.
15237	</li>
15238	<li>
15239	To start a VM using one of the existing VirtualBox front-ends (e.g. the
15240	VirtualBox GUI or VBoxHeadless), one would use
15241	<link to="IMachine::launchVMProcess"/>, which also takes a session object
15242	as its first parameter. This session then identifies the caller and lets the
15243	caller control the started machine (for example, pause machine execution or
15244	power it down) as well as be notified about machine execution state changes.
15245	</li>
15246	</ul>
15247
15248	How sessions objects are created in a client process depends on whether you use
15249	the Main API via COM or via the webservice:
15250
15251	<ul>
15252	<li>When using the COM API directly, an object of the Session class from the
15253	VirtualBox type library needs to be created. In regular COM C++ client code,
15254	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
15255	This object will then act as a local session object in further calls to open
15256	a session.
15257	</li>
15258
15259	<li>In the webservice, the session manager (IWebsessionManager) instead creates
15260	a session object automatically whenever <link to="IWebsessionManager::logon" />
15261	is called. A managed object reference to that session object can be retrieved by
15262	calling <link to="IWebsessionManager::getSessionObject" />.
15263	</li>
15264	</ul>
15265	</desc>
15266
15267	<attribute name="state" type="SessionState" readonly="yes">
15268	<desc>Current state of this session.</desc>
15269	</attribute>
15270
15271	<attribute name="type" type="SessionType" readonly="yes">
15272	<desc>
15273	Type of this session. The value of this attribute is valid only
15274	if the session currently has a machine locked (i.e. its
15275	<link to="#state" /> is Locked), otherwise an error will be returned.
15276	</desc>
15277	</attribute>
15278
15279	<attribute name="machine" type="IMachine" readonly="yes">
15280	<desc>Machine object associated with this session.</desc>
15281	</attribute>
15282
15283	<attribute name="console" type="IConsole" readonly="yes">
15284	<desc>Console object associated with this session.</desc>
15285	</attribute>
15286
15287	<method name="unlockMachine">
15288	<desc>
15289	Unlocks a machine that was previously locked for the current session.
15290
15291	Calling this method is required every time a machine has been locked
15292	for a particular session using the <link to="IMachine::launchVMProcess" />
15293	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
15294	the machine will be set to <link to="MachineState_Aborted" /> on the
15295	server, and changes made to the machine settings will be lost.
15296
15297	Generally, it is recommended to unlock all machines explicitly
15298	before terminating the application (regardless of the reason for
15299	the termination).
15300
15301	<note>
15302	Do not expect the session state (<link to="ISession::state" />
15303	to return to "Unlocked" immediately after you invoke this method,
15304	particularly if you have started a new VM process. The session
15305	state will automatically return to "Unlocked" once the VM is no
15306	longer executing, which can of course take a very long time.
15307	</note>
15308
15309	<result name="E_UNEXPECTED">
15310	Session is not locked.
15311	</result>
15312
15313	</desc>
15314	</method>
15315
15316	</interface>
15317
15318	<!--
15319	// IStorageController
15320	/////////////////////////////////////////////////////////////////////////
15321	-->
15322
15323	<enum
15324	name="StorageBus"
15325	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
15326	>
15327	<desc>
15328	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
15329	see <link to="IStorageController::bus" />.
15330	</desc>
15331	<const name="Null" value="0">
15332	<desc>@c null value. Never used by the API.</desc>
15333	</const>
15334	<const name="IDE" value="1"/>
15335	<const name="SATA" value="2"/>
15336	<const name="SCSI" value="3"/>
15337	<const name="Floppy" value="4"/>
15338	<const name="SAS" value="5"/>
15339	</enum>
15340
15341	<enum
15342	name="StorageControllerType"
15343	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
15344	>
15345	<desc>
15346	The exact variant of storage controller hardware presented
15347	to the guest; see <link to="IStorageController::controllerType" />.
15348	</desc>
15349
15350	<const name="Null" value="0">
15351	<desc>@c null value. Never used by the API.</desc>
15352	</const>
15353	<const name="LsiLogic" value="1">
15354	<desc>A SCSI controller of the LsiLogic variant.</desc>
15355	</const>
15356	<const name="BusLogic" value="2">
15357	<desc>A SCSI controller of the BusLogic variant.</desc>
15358	</const>
15359	<const name="IntelAhci" value="3">
15360	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
15361	</const>
15362	<const name="PIIX3" value="4">
15363	<desc>An IDE controller of the PIIX3 variant.</desc>
15364	</const>
15365	<const name="PIIX4" value="5">
15366	<desc>An IDE controller of the PIIX4 variant.</desc>
15367	</const>
15368	<const name="ICH6" value="6">
15369	<desc>An IDE controller of the ICH6 variant.</desc>
15370	</const>
15371	<const name="I82078" value="7">
15372	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
15373	</const>
15374	<const name="LsiLogicSas" value="8">
15375	<desc>A variant of the LsiLogic controller using SAS.</desc>
15376	</const>
15377	</enum>
15378
15379	<enum
15380	name="ChipsetType"
15381	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
15382	>
15383	<desc>
15384	Type of emulated chipset (mostly southbridge).
15385	</desc>
15386
15387	<const name="Null" value="0">
15388	<desc>@c null value. Never used by the API.</desc>
15389	</const>
15390	<const name="PIIX3" value="1">
15391	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
15392	</const>
15393	<const name="ICH9" value="2">
15394	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
15395	</const>
15396	</enum>
15397
15398	<interface
15399	name="IStorageController" extends="$unknown"
15400	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
15401	wsmap="managed"
15402	>
15403	<desc>
15404	Represents a storage controller that is attached to a virtual machine
15405	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
15406	attached to storage controllers in a real computer, virtual drives
15407	(represented by <link to="IMediumAttachment" />) are attached to virtual
15408	storage controllers, represented by this interface.
15409
15410	As opposed to physical hardware, VirtualBox has a very generic concept
15411	of a storage controller, and for purposes of the Main API, all virtual
15412	storage is attached to virtual machines via instances of this interface.
15413	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
15414	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
15415	is used, certain sub-types may be available and can be selected in
15416	<link to="#controllerType" />.
15417
15418	Depending on these settings, the guest operating system might see
15419	significantly different virtual hardware.
15420	</desc>
15421
15422	<attribute name="name" type="wstring" readonly="yes">
15423	<desc>
15424	Name of the storage controller, as originally specified with
15425	<link to="IMachine::addStorageController" />. This then uniquely
15426	identifies this controller with other method calls such as
15427	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
15428	</desc>
15429	</attribute>
15430
15431	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
15432	<desc>
15433	Maximum number of devices which can be attached to one port.
15434	</desc>
15435	</attribute>
15436
15437	<attribute name="minPortCount" type="unsigned long" readonly="yes">
15438	<desc>
15439	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
15440	</desc>
15441	</attribute>
15442
15443	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
15444	<desc>
15445	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
15446	</desc>
15447	</attribute>
15448
15449	<attribute name="instance" type="unsigned long">
15450	<desc>
15451	The instance number of the device in the running VM.
15452	</desc>
15453	</attribute>
15454
15455	<attribute name="portCount" type="unsigned long">
15456	<desc>
15457	The number of currently usable ports on the controller.
15458	The minimum and maximum number of ports for one controller are
15459	stored in <link to="IStorageController::minPortCount"/>
15460	and <link to="IStorageController::maxPortCount"/>.
15461	</desc>
15462	</attribute>
15463
15464	<attribute name="bus" type="StorageBus" readonly="yes">
15465	<desc>
15466	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
15467	</desc>
15468	</attribute>
15469
15470	<attribute name="controllerType" type="StorageControllerType">
15471	<desc>
15472	The exact variant of storage controller hardware presented
15473	to the guest.
15474	Depending on this value, VirtualBox will provide a different
15475	virtual storage controller hardware to the guest.
15476	For SATA, SAS and floppy controllers, only one variant is
15477	available, but for IDE and SCSI, there are several.
15478
15479	For SCSI controllers, the default type is LsiLogic.
15480	</desc>
15481	</attribute>
15482
15483	<attribute name="useHostIOCache" type="boolean">
15484	<desc>
15485	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
15486	caches and use synchronous file APIs on the host. This was the only option in the API before
15487	VirtualBox 3.2 and is still the default for IDE controllers.
15488
15489	If false, the host I/O cache will be disabled for image files attached to this storage controller.
15490	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
15491	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
15492	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
15493	virtual machines are running at the same time to prevent I/O cache related hangs.
15494	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
15495	</desc>
15496	</attribute>
15497
15498	<attribute name="bootable" type="boolean" readonly="yes">
15499	<desc>
15500	Returns whether it is possible to boot from disks attached to this controller.
15501	</desc>
15502	</attribute>
15503
15504	<method name="getIDEEmulationPort">
15505	<desc>
15506	Gets the corresponding port number which is emulated as an IDE device.
15507	Works only with SATA controllers.
15508
15509	<result name="E_INVALIDARG">
15510	The @a devicePosition is not in the range 0 to 3.
15511	</result>
15512	<result name="E_NOTIMPL">
15513	The storage controller type is not SATAIntelAhci.
15514	</result>
15515
15516	</desc>
15517	<param name="devicePosition" type="long" dir="in"/>
15518	<param name="portNumber" type="long" dir="return"/>
15519	</method>
15520
15521	<method name="setIDEEmulationPort">
15522	<desc>
15523	Sets the port number which is emulated as an IDE device.
15524	Works only with SATA controllers.
15525
15526	<result name="E_INVALIDARG">
15527	The @a devicePosition is not in the range 0 to 3 or the
15528	@a portNumber is not in the range 0 to 29.
15529	</result>
15530	<result name="E_NOTIMPL">
15531	The storage controller type is not SATAIntelAhci.
15532	</result>
15533
15534	</desc>
15535	<param name="devicePosition" type="long" dir="in"/>
15536	<param name="portNumber" type="long" dir="in"/>
15537	</method>
15538
15539	</interface>
15540
15541	<if target="wsdl">
15542
15543	<!--
15544	// IManagedObjectRef
15545	/////////////////////////////////////////////////////////////////////////
15546	-->
15547
15548	<interface
15549	name="IManagedObjectRef" extends="$unknown"
15550	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
15551	internal="yes"
15552	wsmap="managed"
15553	wscpp="hardcoded"
15554	>
15555	<desc>
15556	Managed object reference.
15557
15558	Only within the webservice, a managed object reference (which is really
15559	an opaque number) allows a webservice client to address an object
15560	that lives in the address space of the webservice server.
15561
15562	Behind each managed object reference, there is a COM object that lives
15563	in the webservice server's address space. The COM object is not freed
15564	until the managed object reference is released, either by an explicit
15565	call to <link to="IManagedObjectRef::release" /> or by logging off from
15566	the webservice (<link to="IWebsessionManager::logoff" />), which releases
15567	all objects created during the webservice session.
15568
15569	Whenever a method call of the VirtualBox API returns a COM object, the
15570	webservice representation of that method will instead return a
15571	managed object reference, which can then be used to invoke methods
15572	on that object.
15573	</desc>
15574
15575	<method name="getInterfaceName">
15576	<desc>
15577	Returns the name of the interface that this managed object represents,
15578	for example, "IMachine", as a string.
15579	</desc>
15580	<param name="return" type="wstring" dir="return"/>
15581	</method>
15582
15583	<method name="release">
15584	<desc>
15585	Releases this managed object reference and frees the resources that
15586	were allocated for it in the webservice server process. After calling
15587	this method, the identifier of the reference can no longer be used.
15588	</desc>
15589	</method>
15590
15591	</interface>
15592
15593	<!--
15594	// IWebsessionManager
15595	/////////////////////////////////////////////////////////////////////////
15596	-->
15597
15598	<interface
15599	name="IWebsessionManager" extends="$unknown"
15600	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
15601	internal="yes"
15602	wsmap="global"
15603	wscpp="hardcoded"
15604	>
15605	<desc>
15606	Websession manager. This provides essential services
15607	to webservice clients.
15608	</desc>
15609	<method name="logon">
15610	<desc>
15611	Logs a new client onto the webservice and returns a managed object reference to
15612	the IVirtualBox instance, which the client can then use as a basis to further
15613	queries, since all calls to the VirtualBox API are based on the IVirtualBox
15614	interface, in one way or the other.
15615	</desc>
15616	<param name="username" type="wstring" dir="in"/>
15617	<param name="password" type="wstring" dir="in"/>
15618	<param name="return" type="IVirtualBox" dir="return"/>
15619	</method>
15620
15621	<method name="getSessionObject">
15622	<desc>
15623	Returns a managed object reference to the internal ISession object that was created
15624	for this web service session when the client logged on.
15625
15626	<see><link to="ISession"/></see>
15627	</desc>
15628	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15629	<param name="return" type="ISession" dir="return"/>
15630	</method>
15631
15632	<method name="logoff">
15633	<desc>
15634	Logs off the client who has previously logged on with <link to="IWebsessionManager::logon" />
15635	and destroys all resources associated with the session (most importantly, all
15636	managed objects created in the server while the session was active).
15637	</desc>
15638	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15639	</method>
15640
15641	</interface>
15642
15643	</if>
15644
15645	<!--
15646	// IPerformanceCollector & friends
15647	/////////////////////////////////////////////////////////////////////////
15648	-->
15649
15650	<interface
15651	name="IPerformanceMetric" extends="$unknown"
15652	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
15653	>
15654	<desc>
15655	The IPerformanceMetric interface represents parameters of the given
15656	performance metric.
15657	</desc>
15658
15659	<attribute name="metricName" type="wstring" readonly="yes">
15660	<desc>
15661	Name of the metric.
15662	</desc>
15663	</attribute>
15664
15665	<attribute name="object" type="$unknown" readonly="yes">
15666	<desc>
15667	Object this metric belongs to.
15668	</desc>
15669	</attribute>
15670
15671	<attribute name="description" type="wstring" readonly="yes">
15672	<desc>
15673	Textual description of the metric.
15674	</desc>
15675	</attribute>
15676
15677	<attribute name="period" type="unsigned long" readonly="yes">
15678	<desc>
15679	Time interval between samples, measured in seconds.
15680	</desc>
15681	</attribute>
15682
15683	<attribute name="count" type="unsigned long" readonly="yes">
15684	<desc>
15685	Number of recent samples retained by the performance collector for this
15686	metric.
15687
15688	When the collected sample count exceeds this number, older samples
15689	are discarded.
15690	</desc>
15691	</attribute>
15692
15693	<attribute name="unit" type="wstring" readonly="yes">
15694	<desc>
15695	Unit of measurement.
15696	</desc>
15697	</attribute>
15698
15699	<attribute name="minimumValue" type="long" readonly="yes">
15700	<desc>
15701	Minimum possible value of this metric.
15702	</desc>
15703	</attribute>
15704
15705	<attribute name="maximumValue" type="long" readonly="yes">
15706	<desc>
15707	Maximum possible value of this metric.
15708	</desc>
15709	</attribute>
15710	</interface>
15711
15712	<interface
15713	name="IPerformanceCollector" extends="$unknown"
15714	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
15715	wsmap="managed"
15716	>
15717	<desc>
15718	The IPerformanceCollector interface represents a service that collects
15719	and stores performance metrics data.
15720
15721	Performance metrics are associated with objects of interfaces like IHost
15722	and IMachine. Each object has a distinct set of performance metrics. The
15723	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
15724
15725	Metric data is collected at the specified intervals and is retained
15726	internally. The interval and the number of retained samples can be set
15727	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
15728	and collection settings are not persistent, they are discarded as soon as
15729	VBoxSVC process terminates. Moreover, metric settings and data associated
15730	with a particular VM only exist while VM is running. They disappear as
15731	soon as VM shuts down. It is not possible to set up metrics for machines
15732	that are powered off. One needs to start VM first, then set up metric
15733	collection parameters.
15734
15735	Metrics are organized hierarchically, with each level separated by a
15736	slash (/) character. Generally, the scheme for metric names is like this:
15737
15738	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
15739
15740	"Category/Metric" together form the base metric name. A base metric is
15741	the smallest unit for which a sampling interval and the number of
15742	retained samples can be set. Only base metrics can be enabled and
15743	disabled. All sub-metrics are collected when their base metric is
15744	collected. Collected values for any set of sub-metrics can be queried
15745	with <link to="IPerformanceCollector::queryMetricsData" />.
15746
15747	For example "CPU/Load/User:avg" metric name stands for the "CPU"
15748	category, "Load" metric, "User" submetric, "average" aggregate. An
15749	aggregate function is computed over all retained data. Valid aggregate
15750	functions are:
15751
15752	<ul>
15753	<li>avg -- average</li>
15754	<li>min -- minimum</li>
15755	<li>max -- maximum</li>
15756	</ul>
15757
15758	When setting up metric parameters, querying metric data, enabling or
15759	disabling metrics wildcards can be used in metric names to specify a
15760	subset of metrics. For example, to select all CPU-related metrics
15761	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
15762	so on. To query metric values without aggregates <tt>*:</tt> can be used.
15763
15764	The valid names for base metrics are:
15765
15766	<ul>
15767	<li>CPU/Load</li>
15768	<li>CPU/MHz</li>
15769	<li>RAM/Usage</li>
15770	<li>RAM/VMM</li>
15771	</ul>
15772
15773	The general sequence for collecting and retrieving the metrics is:
15774	<ul>
15775	<li>
15776	Obtain an instance of IPerformanceCollector with
15777	<link to="IVirtualBox::performanceCollector" />
15778	</li>
15779	<li>
15780	Allocate and populate an array with references to objects the metrics
15781	will be collected for. Use references to IHost and IMachine objects.
15782	</li>
15783	<li>
15784	Allocate and populate an array with base metric names the data will
15785	be collected for.
15786	</li>
15787	<li>
15788	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
15789	the metric data will be collected and stored.
15790	</li>
15791	<li>
15792	Wait for the data to get collected.
15793	</li>
15794	<li>
15795	Allocate and populate an array with references to objects the metric
15796	values will be queried for. You can re-use the object array used for
15797	setting base metrics.
15798	</li>
15799	<li>
15800	Allocate and populate an array with metric names the data will be
15801	collected for. Note that metric names differ from base metric names.
15802	</li>
15803	<li>
15804	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
15805	that have been collected so far are returned. Note that the values
15806	are still retained internally and data collection continues.
15807	</li>
15808	</ul>
15809
15810	For an example of usage refer to the following files in VirtualBox SDK:
15811	<ul>
15812	<li>
15813	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
15814	</li>
15815	<li>
15816	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
15817	</li>
15818	</ul>
15819	</desc>
15820
15821	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
15822	<desc>
15823	Array of unique names of metrics.
15824
15825	This array represents all metrics supported by the performance
15826	collector. Individual objects do not necessarily support all of them.
15827	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
15828	list of supported metrics for a particular object.
15829	</desc>
15830	</attribute>
15831
15832	<method name="getMetrics">
15833	<desc>
15834	Returns parameters of specified metrics for a set of objects.
15835	<note>
15836	@c Null metrics array means all metrics. @c Null object array means
15837	all existing objects.
15838	</note>
15839	</desc>
15840	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15841	<desc>
15842	Metric name filter. Currently, only a comma-separated list of metrics
15843	is supported.
15844	</desc>
15845	</param>
15846	<param name="objects" type="$unknown" dir="in" safearray="yes">
15847	<desc>
15848	Set of objects to return metric parameters for.
15849	</desc>
15850	</param>
15851	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
15852	<desc>
15853	Array of returned metric parameters.
15854	</desc>
15855	</param>
15856	</method>
15857
15858	<method name="setupMetrics">
15859	<desc>
15860	Sets parameters of specified base metrics for a set of objects. Returns
15861	an array of <link to="IPerformanceMetric" /> describing the metrics
15862	have been affected.
15863	<note>
15864	@c Null or empty metric name array means all metrics. @c Null or
15865	empty object array means all existing objects. If metric name array
15866	contains a single element and object array contains many, the single
15867	metric name array element is applied to each object array element to
15868	form metric/object pairs.
15869	</note>
15870	</desc>
15871	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15872	<desc>
15873	Metric name filter. Comma-separated list of metrics with wildcard
15874	support.
15875	</desc>
15876	</param>
15877	<param name="objects" type="$unknown" dir="in" safearray="yes">
15878	<desc>
15879	Set of objects to setup metric parameters for.
15880	</desc>
15881	</param>
15882	<param name="period" type="unsigned long" dir="in">
15883	<desc>
15884	Time interval in seconds between two consecutive samples of
15885	performance data.
15886	</desc>
15887	</param>
15888	<param name="count" type="unsigned long" dir="in">
15889	<desc>
15890	Number of samples to retain in performance data history. Older
15891	samples get discarded.
15892	</desc>
15893	</param>
15894	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15895	<desc>
15896	Array of metrics that have been modified by the call to this method.
15897	</desc>
15898	</param>
15899	</method>
15900
15901	<method name="enableMetrics">
15902	<desc>
15903	Turns on collecting specified base metrics. Returns an array of
15904	<link to="IPerformanceMetric" /> describing the metrics have been
15905	affected.
15906	<note>
15907	@c Null or empty metric name array means all metrics. @c Null or
15908	empty object array means all existing objects. If metric name array
15909	contains a single element and object array contains many, the single
15910	metric name array element is applied to each object array element to
15911	form metric/object pairs.
15912	</note>
15913	</desc>
15914	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15915	<desc>
15916	Metric name filter. Comma-separated list of metrics with wildcard
15917	support.
15918	</desc>
15919	</param>
15920	<param name="objects" type="$unknown" dir="in" safearray="yes">
15921	<desc>
15922	Set of objects to enable metrics for.
15923	</desc>
15924	</param>
15925	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15926	<desc>
15927	Array of metrics that have been modified by the call to this method.
15928	</desc>
15929	</param>
15930	</method>
15931
15932	<method name="disableMetrics">
15933	<desc>
15934	Turns off collecting specified base metrics. Returns an array of
15935	<link to="IPerformanceMetric" /> describing the metrics have been
15936	affected.
15937	<note>
15938	@c Null or empty metric name array means all metrics. @c Null or
15939	empty object array means all existing objects. If metric name array
15940	contains a single element and object array contains many, the single
15941	metric name array element is applied to each object array element to
15942	form metric/object pairs.
15943	</note>
15944	</desc>
15945	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15946	<desc>
15947	Metric name filter. Comma-separated list of metrics with wildcard
15948	support.
15949	</desc>
15950	</param>
15951	<param name="objects" type="$unknown" dir="in" safearray="yes">
15952	<desc>
15953	Set of objects to disable metrics for.
15954	</desc>
15955	</param>
15956	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15957	<desc>
15958	Array of metrics that have been modified by the call to this method.
15959	</desc>
15960	</param>
15961	</method>
15962
15963	<method name="queryMetricsData">
15964	<desc>
15965	Queries collected metrics data for a set of objects.
15966
15967	The data itself and related metric information are returned in seven
15968	parallel and one flattened array of arrays. Elements of
15969	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
15970	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
15971	the same index describe one set of values corresponding to a single
15972	metric.
15973
15974	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
15975	start and length of a sub-array is indicated by
15976	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
15977	value for metric <tt>metricNames[i]</tt> is at
15978	<tt>returnData[returnIndices[i]]</tt>.
15979
15980	<note>
15981	@c Null or empty metric name array means all metrics. @c Null or
15982	empty object array means all existing objects. If metric name array
15983	contains a single element and object array contains many, the single
15984	metric name array element is applied to each object array element to
15985	form metric/object pairs.
15986	</note>
15987	<note>
15988	Data collection continues behind the scenes after call to @c
15989	queryMetricsData. The return data can be seen as the snapshot of the
15990	current state at the time of @c queryMetricsData call. The internally
15991	kept metric values are not cleared by the call. This makes possible
15992	querying different subsets of metrics or aggregates with subsequent
15993	calls. If periodic querying is needed it is highly suggested to query
15994	the values with @c interval*count period to avoid confusion. This way
15995	a completely new set of data values will be provided by each query.
15996	</note>
15997	</desc>
15998	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15999	<desc>
16000	Metric name filter. Comma-separated list of metrics with wildcard
16001	support.
16002	</desc>
16003	</param>
16004	<param name="objects" type="$unknown" dir="in" safearray="yes">
16005	<desc>
16006	Set of objects to query metrics for.
16007	</desc>
16008	</param>
16009	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
16010	<desc>
16011	Names of metrics returned in @c returnData.
16012	</desc>
16013	</param>
16014	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
16015	<desc>
16016	Objects associated with metrics returned in @c returnData.
16017	</desc>
16018	</param>
16019	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
16020	<desc>
16021	Units of measurement for each returned metric.
16022	</desc>
16023	</param>
16024	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
16025	<desc>
16026	Divisor that should be applied to return values in order to get
16027	floating point values. For example:
16028	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
16029	will retrieve the floating point value of i-th sample of the first
16030	metric.
16031	</desc>
16032	</param>
16033	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
16034	<desc>
16035	Sequence numbers of the first elements of value sequences of
16036	particular metrics returned in @c returnData. For aggregate metrics
16037	it is the sequence number of the sample the aggregate started
16038	calculation from.
16039	</desc>
16040	</param>
16041	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
16042	<desc>
16043	Indices of the first elements of value sequences of particular
16044	metrics returned in @c returnData.
16045	</desc>
16046	</param>
16047	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
16048	<desc>
16049	Lengths of value sequences of particular metrics.
16050	</desc>
16051	</param>
16052	<param name="returnData" type="long" dir="return" safearray="yes">
16053	<desc>
16054	Flattened array of all metric data containing sequences of values for
16055	each metric.
16056	</desc>
16057	</param>
16058	</method>
16059
16060	</interface>
16061
16062	<enum
16063	name="NATAliasMode"
16064	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
16065	>
16066	<desc></desc>
16067	<const name="AliasLog" value="0x1">
16068	<desc></desc>
16069	</const>
16070	<const name="AliasProxyOnly" value="0x02">
16071	<desc></desc>
16072	</const>
16073	<const name="AliasUseSamePorts" value="0x04">
16074	<desc></desc>
16075	</const>
16076	</enum>
16077
16078	<enum
16079	name="NATProtocol"
16080	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
16081	>
16082	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
16083	<const name="UDP" value="0">
16084	<desc>Port-forwarding uses UDP protocol.</desc>
16085	</const>
16086	<const name="TCP" value="1">
16087	<desc>Port-forwarding uses TCP protocol.</desc>
16088	</const>
16089	</enum>
16090
16091	<interface
16092	name="INATEngine" extends="$unknown"
16093	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
16094	wsmap="managed"
16095	>
16096	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
16097	allows for changing NAT behavior such as port-forwarding rules. This interface is
16098	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
16099	<attribute name="network" type="wstring">
16100	<desc>The network attribute of the NAT engine (the same value is used with built-in
16101	DHCP server to fill corresponding fields of DHCP leases).</desc>
16102	</attribute>
16103	<attribute name="hostIP" type="wstring">
16104	<desc>IP of host interface to bind all opened sockets to.
16105	<note>Changing this does not change binding of port forwarding.</note>
16106	</desc>
16107	</attribute>
16108	<attribute name="tftpPrefix" type="wstring">
16109	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
16110	the corresponding fields of DHCP leases.</desc>
16111	</attribute>
16112	<attribute name="tftpBootFile" type="wstring">
16113	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
16114	the corresponding fields of DHCP leases.</desc>
16115	</attribute>
16116	<attribute name="tftpNextServer" type="wstring">
16117	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
16118	the corresponding fields of DHCP leases.
16119	<note>The preferred form is IPv4 addresses.</note>
16120	</desc>
16121	</attribute>
16122	<attribute name="aliasMode" type="unsigned long">
16123	<desc></desc>
16124	</attribute>
16125	<attribute name="dnsPassDomain" type="boolean">
16126	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
16127	</attribute>
16128	<attribute name="dnsProxy" type="boolean">
16129	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
16130	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
16131	</attribute>
16132	<attribute name="dnsUseHostResolver" type="boolean">
16133	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
16134	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
16135	</attribute>
16136	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
16137	<desc>Array of NAT port-forwarding rules in string representation, in the following
16138	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
16139	</attribute>
16140	<method name="setNetworkSettings">
16141	<desc>Sets network configuration of the NAT engine.</desc>
16142	<param name="mtu" type="unsigned long" dir="in">
16143	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
16144	</param>
16145	<param name="sockSnd" type="unsigned long" dir="in">
16146	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
16147	</param>
16148	<param name="sockRcv" type="unsigned long" dir="in">
16149	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
16150	</param>
16151	<param name="TcpWndSnd" type="unsigned long" dir="in">
16152	<desc>Initial size of the NAT engine's sending TCP window in bytes when
16153	establishing a new TCP connection.</desc>
16154	</param>
16155	<param name="TcpWndRcv" type="unsigned long" dir="in">
16156	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
16157	establishing a new TCP connection.</desc>
16158	</param>
16159	</method>
16160	<method name="getNetworkSettings">
16161	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
16162	for parameter descriptions.</desc>
16163	<param name="mtu" type="unsigned long" dir="out" />
16164	<param name="sockSnd" type="unsigned long" dir="out" />
16165	<param name="sockRcv" type="unsigned long" dir="out" />
16166	<param name="TcpWndSnd" type="unsigned long" dir="out" />
16167	<param name="TcpWndRcv" type="unsigned long" dir="out" />
16168	</method>
16169	<method name="addRedirect">
16170	<desc>Adds a new NAT port-forwarding rule.</desc>
16171	<param name="name" type="wstring" dir="in">
16172	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
16173	auto-generates one using the other parameters.</desc>
16174	</param>
16175	<param name="proto" type="NATProtocol" dir="in">
16176	<desc>Protocol handled with the rule.</desc>
16177	</param>
16178	<param name="hostIp" type="wstring" dir="in">
16179	<desc>IP of the host interface to which the rule should apply. An empty ip address is
16180	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
16181	</param>
16182	<param name="hostPort" type="unsigned short" dir="in">
16183	<desc>The port number to listen on.</desc>
16184	</param>
16185	<param name="guestIp" type="wstring" dir="in">
16186	<desc>The IP address of the guest which the NAT engine will forward matching packets
16187	to. An empty IP address is acceptable, in which case the NAT engine will forward
16188	packets to the first DHCP lease (x.x.x.15).</desc>
16189	</param>
16190	<param name="guestPort" type="unsigned short" dir="in">
16191	<desc>The port number to forward.</desc>
16192	</param>
16193	</method>
16194	<method name="removeRedirect">
16195	<desc>Removes a port-forwarding rule that was previously registered.</desc>
16196	<param name="name" type="wstring" dir="in">
16197	<desc>The name of the rule to delete.</desc>
16198	</param>
16199	</method>
16200	</interface>
16201
16202	<!--
16203	// IExtPackManager
16204	/////////////////////////////////////////////////////////////////////////
16205	-->
16206
16207	<interface
16208	name="IExtPackPlugIn" extends="$unknown"
16209	uuid="58000040-e718-4746-bbce-4b86d96da461"
16210	wsmap="suppress"
16211	>
16212	<desc>
16213	Interface for keeping information about a plug-in that ships with an
16214	extension pack.
16215	</desc>
16216	<attribute name="name" type="wstring" readonly="yes">
16217	<desc>The plug-in name.</desc>
16218	</attribute>
16219	<attribute name="description" type="wstring" readonly="yes">
16220	<desc>The plug-in description.</desc>
16221	</attribute>
16222	<attribute name="frontend" type="wstring" readonly="yes">
16223	<desc>
16224	The name of the frontend or component name this plug-in plugs into.
16225	</desc>
16226	</attribute>
16227	<attribute name="modulePath" type="wstring" readonly="yes">
16228	<desc> The module path. </desc>
16229	</attribute>
16230	</interface>
16231
16232	<interface
16233	name="IExtPackBase" extends="$unknown"
16234	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
16235	wsmap="suppress"
16236	>
16237	<desc>
16238	Interface for querying information about an extension pack as well as
16239	accessing COM objects within it.
16240	</desc>
16241	<attribute name="name" type="wstring" readonly="yes">
16242	<desc>The extension pack name. This is unique.</desc>
16243	</attribute>
16244	<attribute name="description" type="wstring" readonly="yes">
16245	<desc>The extension pack description.</desc>
16246	</attribute>
16247	<attribute name="version" type="wstring" readonly="yes">
16248	<desc>
16249	The extension pack version string. This is restricted to the dotted
16250	version number and optionally a build indicator. No tree revision or
16251	tag will be included in the string as those things are available as
16252	separate properties. An optional publisher tag may be present like for
16253	<link to="IVirtualBox::version"/>.
16254
16255	Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
16256	</desc>
16257	</attribute>
16258	<attribute name="revision" type="unsigned long" readonly="yes">
16259	<desc>The extension pack internal revision number.</desc>
16260	</attribute>
16261	<attribute name="edition" type="wstring" readonly="yes">
16262	<desc>
16263	Edition indicator. This is usually empty.
16264
16265	Can for instance be used to help distinguishing between two editions
16266	of the same extension pack where only the license, service contract or
16267	something differs.
16268	</desc>
16269	</attribute>
16270	<attribute name="VRDEModule" type="wstring" readonly="yes">
16271	<desc>The name of the VRDE module if the extension pack sports one.</desc>
16272	</attribute>
16273	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
16274	<desc>Plug-ins provided by this extension pack.</desc>
16275	</attribute>
16276	<attribute name="usable" type="boolean" readonly="yes">
16277	<desc>
16278	Indicates whether the extension pack is usable or not.
16279
16280	There are a number of reasons why an extension pack might be unusable,
16281	typical examples would be broken installation/file or that it is
16282	incompatible with the current VirtualBox version.
16283	</desc>
16284	</attribute>
16285	<attribute name="whyUnusable" type="wstring" readonly="yes">
16286	<desc>
16287	String indicating why the extension pack is not usable. This is an
16288	empty string if usable and always a non-empty string if not usable.
16289	</desc>
16290	</attribute>
16291	<attribute name="showLicense" type="boolean" readonly="yes">
16292	<desc>Whether to show the license before installation</desc>
16293	</attribute>
16294	<attribute name="license" type="wstring" readonly="yes">
16295	<desc>
16296	The default HTML license text for the extension pack. Same as
16297	calling <link to="#queryLicense">queryLicense</link> with
16298	preferredLocale and preferredLanguage as empty strings and format set
16299	to html.
16300	</desc>
16301	</attribute>
16302
16303	<method name="queryLicense">
16304	<desc>
16305	Full feature version of the license attribute.
16306	</desc>
16307	<param name="preferredLocale" type="wstring" dir="in">
16308	<desc>
16309	The preferred license locale. Pass an empty string to get the default
16310	license.
16311	</desc>
16312	</param>
16313	<param name="preferredLanguage" type="wstring" dir="in">
16314	<desc>
16315	The preferred license language. Pass an empty string to get the
16316	default language for the locale.
16317	</desc>
16318	</param>
16319	<param name="format" type="wstring" dir="in">
16320	<desc>
16321	The license format: html, rtf or txt. If a license is present there
16322	will always be an HTML of it, the rich text format (RTF) and plain
16323	text (txt) versions are optional. If
16324	</desc>
16325	</param>
16326	<param name="licenseText" type="wstring" dir="return">
16327	<desc>The license text.</desc>
16328	</param>
16329	</method>
16330
16331	</interface>
16332
16333	<interface
16334	name="IExtPack" extends="IExtPackBase"
16335	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
16336	wsmap="suppress"
16337	>
16338	<desc>
16339	Interface for querying information about an extension pack as well as
16340	accessing COM objects within it.
16341	</desc>
16342	<method name="queryObject">
16343	<desc>
16344	Queries the IUnknown interface to an object in the extension pack
16345	main module. This allows plug-ins and others to talk directly to an
16346	extension pack.
16347	</desc>
16348	<param name="objUuid" type="wstring" dir="in">
16349	<desc>The object ID. What exactly this is </desc>
16350	</param>
16351	<param name="returnInterface" type="$unknown" dir="return">
16352	<desc>The queried interface.</desc>
16353	</param>
16354	</method>
16355	</interface>
16356
16357	<interface
16358	name="IExtPackFile" extends="IExtPackBase"
16359	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
16360	wsmap="suppress"
16361	>
16362	<desc>
16363	Extension pack file (aka tarball, .vbox-extpack) representation returned
16364	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
16365	extension pack information with the addition of the file name.
16366	</desc>
16367	<attribute name="filePath" type="wstring" readonly="yes">
16368	<desc>
16369	The path to the extension pack file.
16370	</desc>
16371	</attribute>
16372
16373	<method name="install">
16374	<desc>
16375	Install the extension pack.
16376	</desc>
16377	<param name="replace" type="boolean" dir="in">
16378	<desc>
16379	Set this to automatically uninstall any existing extension pack with
16380	the same name as the one being installed.
16381	</desc>
16382	</param>
16383	<param name="displayInfo" type="wstring" dir="in">
16384	<desc>
16385	Platform specific display information. Reserved for future hacks.
16386	</desc>
16387	</param>
16388	<param name="progess" type="IProgress" dir="return">
16389	<desc>
16390	Progress object for the operation.
16391	</desc>
16392	</param>
16393	</method>
16394	</interface>
16395
16396	<interface
16397	name="IExtPackManager" extends="$unknown"
16398	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
16399	wsmap="suppress"
16400	>
16401	<desc>
16402	Interface for managing VirtualBox Extension Packs.
16403
16404	TODO: Describe extension packs, how they are managed and how to create
16405	one.
16406	</desc>
16407
16408	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
16409	<desc>
16410	List of the installed extension packs.
16411	</desc>
16412	</attribute>
16413
16414	<method name="find">
16415	<desc>
16416	Returns the extension pack with the specified name if found.
16417
16418	<result name="VBOX_E_OBJECT_NOT_FOUND">
16419	No extension pack matching @a name was found.
16420	</result>
16421	</desc>
16422	<param name="name" type="wstring" dir="in">
16423	<desc>The name of the extension pack to locate.</desc>
16424	</param>
16425	<param name="returnData" type="IExtPack" dir="return">
16426	<desc>The extension pack if found.</desc>
16427	</param>
16428	</method>
16429
16430	<method name="openExtPackFile">
16431	<desc>
16432	Attempts to open an extension pack file in preparation for
16433	installation.
16434	</desc>
16435	<param name="path" type="wstring" dir="in">
16436	<desc>The path of the extension pack tarball. This can optionally be
16437	followed by a "::SHA-256=hex-digit" of the tarball. </desc>
16438	</param>
16439	<param name="file" type="IExtPackFile" dir="return">
16440	<desc>The interface of the extension pack file object.</desc>
16441	</param>
16442	</method>
16443
16444	<method name="uninstall">
16445	<desc>Uninstalls an extension pack, removing all related files.</desc>
16446	<param name="name" type="wstring" dir="in">
16447	<desc>The name of the extension pack to uninstall.</desc>
16448	</param>
16449	<param name="forcedRemoval" type="boolean" dir="in">
16450	<desc>
16451	Forced removal of the extension pack. This means that the uninstall
16452	hook will not be called.
16453	</desc>
16454	</param>
16455	<param name="displayInfo" type="wstring" dir="in">
16456	<desc>
16457	Platform specific display information. Reserved for future hacks.
16458	</desc>
16459	</param>
16460	<param name="progess" type="IProgress" dir="return">
16461	<desc>
16462	Progress object for the operation.
16463	</desc>
16464	</param>
16465	</method>
16466
16467	<method name="cleanup">
16468	<desc>Cleans up failed installs and uninstalls</desc>
16469	</method>
16470
16471	<method name="queryAllPlugInsForFrontend">
16472	<desc>
16473	Gets the path to all the plug-in modules for a given frontend.
16474
16475	This is a convenience method that is intended to simplify the plug-in
16476	loading process for a frontend.
16477	</desc>
16478	<param name="frontendName" type="wstring" dir="in">
16479	<desc>The name of the frontend or component.</desc>
16480	</param>
16481	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
16482	<desc>Array containing the plug-in modules (full paths).</desc>
16483	</param>
16484	</method>
16485
16486	<method name="isExtPackUsable">
16487	<desc>Check if the given extension pack is loaded and usable.</desc>
16488	<param name="name" type="wstring" dir="in">
16489	<desc>The name of the extension pack to check for.</desc>
16490	</param>
16491	<param name="usable" type="boolean" dir="return">
16492	<desc>Is the given extension pack loaded and usable.</desc>
16493	</param>
16494	</method>
16495
16496	</interface>
16497
16498	<!--
16499	// BandwidthGroupType
16500	/////////////////////////////////////////////////////////////////////////
16501	-->
16502	<enum
16503	name="BandwidthGroupType"
16504	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
16505
16506	<desc>
16507	Type of a bandwidth control group.
16508	</desc>
16509
16510	<const name="Null" value="0">
16511	<desc>
16512	Null type, must be first.
16513	</desc>
16514	</const>
16515
16516	<const name="Disk" value="1">
16517	<desc>
16518	The bandwidth group controls disk I/O.
16519	</desc>
16520	</const>
16521
16522	<const name="Network" value="2">
16523	<desc>
16524	The bandwidth group controls network I/O.
16525	</desc>
16526	</const>
16527
16528	</enum>
16529
16530	<!--
16531	// IBandwidthGroup
16532	/////////////////////////////////////////////////////////////////////////
16533	-->
16534	<interface
16535	name="IBandwidthGroup" extends="$unknown"
16536	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
16537	wsmap="managed"
16538	>
16539	<desc>Represents one bandwidth group.</desc>
16540
16541	<attribute name="name" type="wstring" readonly="yes">
16542	<desc>Name of the group.</desc>
16543	</attribute>
16544
16545	<attribute name="type" type="BandwidthGroupType" readonly="yes">
16546	<desc>Type of the group.</desc>
16547	</attribute>
16548
16549	<attribute name="reference" type="unsigned long" readonly="yes">
16550	<desc>How many devices/medium attachements use this group.</desc>
16551	</attribute>
16552
16553	<attribute name="maxBytesPerSec" type="long long">
16554	<desc>The maximum number of bytes which can be transfered by all
16555	entities attached to this group during one second.</desc>
16556	</attribute>
16557
16558	</interface>
16559
16560	<!--
16561	// IBandwidthControl
16562	/////////////////////////////////////////////////////////////////////////
16563	-->
16564	<interface
16565	name="IBandwidthControl" extends="$unknown"
16566	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
16567	wsmap="managed"
16568	>
16569	<desc>
16570	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
16571	This includes network and disk I/O.
16572	</desc>
16573
16574	<attribute name="numGroups" type="unsigned long" readonly="yes">
16575	<desc>
16576	The current number of existing bandwidth groups managed.
16577	</desc>
16578	</attribute>
16579
16580	<method name="createBandwidthGroup">
16581	<desc>
16582	Creates a new bandwidth group.
16583	</desc>
16584
16585	<param name="name" type="wstring" dir="in">
16586	<desc>Name of the bandwidth group.</desc>
16587	</param>
16588	<param name="type" type="BandwidthGroupType" dir="in">
16589	<desc>The type of the bandwidth group (network or disk).</desc>
16590	</param>
16591	<param name="maxBytesPerSec" type="long long" dir="in">
16592	<desc>The maximum number of bytes which can be transfered by all
16593	entities attached to this group during one second.</desc>
16594	</param>
16595	</method>
16596
16597	<method name="deleteBandwidthGroup">
16598	<desc>
16599	Deletes a new bandwidth group.
16600	</desc>
16601
16602	<param name="name" type="wstring" dir="in">
16603	<desc>Name of the bandwidth group to delete.</desc>
16604	</param>
16605	</method>
16606
16607	<method name="getBandwidthGroup" const="yes">
16608	<desc>
16609	Get a bandwidth group by name.
16610	</desc>
16611
16612	<param name="name" type="wstring" dir="in">
16613	<desc>Name of the bandwidth group to get.</desc>
16614	</param>
16615	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
16616	<desc>Where to store the bandwidth group on success.</desc>
16617	</param>
16618	</method>
16619
16620	<method name="getAllBandwidthGroups" const="yes">
16621	<desc>
16622	Get all managed bandwidth groups.
16623	</desc>
16624
16625	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
16626	<desc>The array of managed bandwidth groups.</desc>
16627	</param>
16628	</method>
16629	</interface>
16630
16631	<!--
16632	// IVirtualBoxClient
16633	/////////////////////////////////////////////////////////////////////////
16634	-->
16635
16636	<interface
16637	name="IVirtualBoxClient" extends="$unknown"
16638	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
16639	wsmap="suppress"
16640	>
16641	<desc>
16642	Convenience interface for client applications. Treat this as a
16643	singleton, i.e. never create more than one instance of this interface.
16644
16645	At the moment only available for clients of the local API (not usable
16646	via the webservice). Once the session logic is redesigned this might
16647	change.
16648	</desc>
16649
16650	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
16651	<desc>
16652	Reference to the server-side API root object.
16653	</desc>
16654	</attribute>
16655
16656	<attribute name="session" type="ISession" readonly="yes">
16657	<desc>
16658	Create a new session object and return the reference to it.
16659	</desc>
16660	</attribute>
16661
16662	<attribute name="eventSource" type="IEventSource" readonly="yes">
16663	<desc>
16664	Event source for VirtualBoxClient events.
16665	</desc>
16666	</attribute>
16667
16668	</interface>
16669
16670	<!--
16671	// Events
16672	/////////////////////////////////////////////////////////////////////////
16673	-->
16674	<enum
16675	name="VBoxEventType"
16676	uuid="100cf5c8-7dd4-4600-8d75-636d211479c9"
16677	>
16678
16679	<desc>
16680	Type of an event.
16681	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16682	</desc>
16683
16684	<const name="Invalid" value="0">
16685	<desc>
16686	Invalid event, must be first.
16687	</desc>
16688	</const>
16689
16690	<const name="Any" value="1">
16691	<desc>
16692	Wildcard for all events.
16693	Events of this type are never delivered, and only used in
16694	<link to="IEventSource::registerListener"/> call to simplify registration.
16695	</desc>
16696	</const>
16697
16698	<const name="Vetoable" value="2">
16699	<desc>
16700	Wildcard for all vetoable events. Events of this type are never delivered, and only
16701	used in <link to="IEventSource::registerListener"/> call to simplify registration.
16702	</desc>
16703	</const>
16704
16705	<const name="MachineEvent" value="3">
16706	<desc>
16707	Wildcard for all machine events. Events of this type are never delivered, and only used in
16708	<link to="IEventSource::registerListener"/> call to simplify registration.
16709	</desc>
16710	</const>
16711
16712	<const name="SnapshotEvent" value="4">
16713	<desc>
16714	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
16715	<link to="IEventSource::registerListener"/> call to simplify registration.
16716	</desc>
16717	</const>
16718
16719	<const name="InputEvent" value="5">
16720	<desc>
16721	Wildcard for all input device (keyboard, mouse) events.
16722	Events of this type are never delivered, and only used in
16723	<link to="IEventSource::registerListener"/> call to simplify registration.
16724	</desc>
16725	</const>
16726
16727	<const name="LastWildcard" value="31">
16728	<desc>
16729	Last wildcard.
16730	</desc>
16731	</const>
16732
16733	<const name="OnMachineStateChanged" value="32">
16734	<desc>
16735	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
16736	</desc>
16737	</const>
16738	<const name="OnMachineDataChanged" value="33">
16739	<desc>
16740	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
16741	</desc>
16742	</const>
16743	<const name="OnExtraDataChanged" value="34">
16744	<desc>
16745	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
16746	</desc>
16747	</const>
16748	<const name="OnExtraDataCanChange" value="35">
16749	<desc>
16750	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
16751	</desc>
16752	</const>
16753	<const name="OnMediumRegistered" value="36">
16754	<desc>
16755	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
16756	</desc>
16757	</const>
16758	<const name="OnMachineRegistered" value="37">
16759	<desc>
16760	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
16761	</desc>
16762	</const>
16763	<const name="OnSessionStateChanged" value="38">
16764	<desc>
16765	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
16766	</desc>
16767	</const>
16768	<const name="OnSnapshotTaken" value="39">
16769	<desc>
16770	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
16771	</desc>
16772	</const>
16773	<const name="OnSnapshotDeleted" value="40">
16774	<desc>
16775	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
16776	</desc>
16777	</const>
16778	<const name="OnSnapshotChanged" value="41">
16779	<desc>
16780	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
16781	</desc>
16782	</const>
16783	<const name="OnGuestPropertyChanged" value="42">
16784	<desc>
16785	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
16786	</desc>
16787	</const>
16788	<!-- Console events -->
16789	<const name="OnMousePointerShapeChanged" value="43">
16790	<desc>
16791	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
16792	</desc>
16793	</const>
16794	<const name="OnMouseCapabilityChanged" value="44">
16795	<desc>
16796	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
16797	</desc>
16798	</const>
16799	<const name="OnKeyboardLedsChanged" value="45">
16800	<desc>
16801	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
16802	</desc>
16803	</const>
16804	<const name="OnStateChanged" value="46">
16805	<desc>
16806	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
16807	</desc>
16808	</const>
16809	<const name="OnAdditionsStateChanged" value="47">
16810	<desc>
16811	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
16812	</desc>
16813	</const>
16814	<const name="OnNetworkAdapterChanged" value="48">
16815	<desc>
16816	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
16817	</desc>
16818	</const>
16819	<const name="OnSerialPortChanged" value="49">
16820	<desc>
16821	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
16822	</desc>
16823	</const>
16824	<const name="OnParallelPortChanged" value="50">
16825	<desc>
16826	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
16827	</desc>
16828	</const>
16829	<const name="OnStorageControllerChanged" value="51">
16830	<desc>
16831	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
16832	</desc>
16833	</const>
16834	<const name="OnMediumChanged" value="52">
16835	<desc>
16836	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
16837	</desc>
16838	</const>
16839	<const name="OnVRDEServerChanged" value="53">
16840	<desc>
16841	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
16842	</desc>
16843	</const>
16844	<const name="OnUSBControllerChanged" value="54">
16845	<desc>
16846	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
16847	</desc>
16848	</const>
16849	<const name="OnUSBDeviceStateChanged" value="55">
16850	<desc>
16851	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
16852	</desc>
16853	</const>
16854	<const name="OnSharedFolderChanged" value="56">
16855	<desc>
16856	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
16857	</desc>
16858	</const>
16859	<const name="OnRuntimeError" value="57">
16860	<desc>
16861	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
16862	</desc>
16863	</const>
16864	<const name="OnCanShowWindow" value="58">
16865	<desc>
16866	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
16867	</desc>
16868	</const>
16869	<const name="OnShowWindow" value="59">
16870	<desc>
16871	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
16872	</desc>
16873	</const>
16874	<const name="OnCPUChanged" value="60">
16875	<desc>
16876	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
16877	</desc>
16878	</const>
16879	<const name="OnVRDEServerInfoChanged" value="61">
16880	<desc>
16881	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
16882	</desc>
16883	</const>
16884	<const name="OnEventSourceChanged" value="62">
16885	<desc>
16886	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
16887	</desc>
16888	</const>
16889	<const name="OnCPUExecutionCapChanged" value="63">
16890	<desc>
16891	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
16892	</desc>
16893	</const>
16894	<const name="OnGuestKeyboard" value="64">
16895	<desc>
16896	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
16897	</desc>
16898	</const>
16899	<const name="OnGuestMouse" value="65">
16900	<desc>
16901	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
16902	</desc>
16903	</const>
16904	<const name="OnNATRedirect" value="66">
16905	<desc>
16906	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
16907	</desc>
16908	</const>
16909	<const name="OnHostPciDevicePlug" value="67">
16910	<desc>
16911	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
16912	</desc>
16913	</const>
16914	<const name="OnVBoxSVCAvailabilityChanged" value="68">
16915	<desc>
16916	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
16917	</desc>
16918	</const>
16919	<const name="OnBandwidthGroupChanged" value="69">
16920	<desc>
16921	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
16922	</desc>
16923	</const>
16924	<const name="OnGuestMonitorChanged" value="70">
16925	<desc>
16926	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
16927	</desc>
16928	</const>
16929	<const name="OnStorageDeviceChanged" value="71">
16930	<desc>
16931	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
16932	</desc>
16933	</const>
16934	<const name="OnClipboardModeChanged" value="72">
16935	<desc>
16936	See <link to="IClipboardModeChangedEvent">IClipboardModeChangedEvent</link>.
16937	</desc>
16938	</const>
16939
16940	<!-- Last event marker -->
16941	<const name="Last" value="73">
16942	<desc>
16943	Must be last event, used for iterations and structures relying on numerical event values.
16944	</desc>
16945	</const>
16946
16947	</enum>
16948
16949	<interface
16950	name="IEventSource" extends="$unknown"
16951	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
16952	wsmap="managed"
16953	>
16954	<desc>
16955	Event source. Generally, any object which could generate events can be an event source,
16956	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
16957	an event source can work with listeners in either active or passive mode. In active mode it is up to
16958	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
16959	event source keeps track of pending events for each listener and returns available events on demand.
16960
16961	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16962	</desc>
16963
16964	<method name="createListener">
16965	<desc>
16966	Creates a new listener object, useful for passive mode.
16967	</desc>
16968	<param name="listener" type="IEventListener" dir="return"/>
16969	</method>
16970
16971	<method name="createAggregator">
16972	<desc>
16973	Creates an aggregator event source, collecting events from multiple sources.
16974	This way a single listener can listen for events coming from multiple sources,
16975	using a single blocking <link to="#getEvent"/> on the returned aggregator.
16976	</desc>
16977	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
16978	<desc>
16979	Subordinate event source this one aggregatres.
16980	</desc>
16981	</param>
16982	<param name="result" type="IEventSource" dir="return">
16983	<desc>
16984	Event source aggregating passed sources.
16985	</desc>
16986	</param>
16987	</method>
16988
16989	<method name="registerListener">
16990	<desc>
16991	Register an event listener.
16992
16993	<note>
16994	To avoid system overload, the VirtualBox server process checks if passive event
16995	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
16996	current implementation, if more than 500 pending events are detected for a passive
16997	event listener, it is forcefully unregistered by the system, and further
16998	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
16999	</note>
17000	</desc>
17001	<param name="listener" type="IEventListener" dir="in">
17002	<desc>Listener to register.</desc>
17003	</param>
17004	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
17005	<desc>
17006	Event types listener is interested in. One can use wildcards like -
17007	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
17008	than one event.
17009	</desc>
17010	</param>
17011	<param name="active" type="boolean" dir="in">
17012	<desc>
17013	Which mode this listener is operating in.
17014	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
17015	In passive mode, an internal event queue is created for this this IEventListener.
17016	For each event coming in, it is added to queues for all interested registered passive
17017	listeners. It is then up to the external code to call the listener's
17018	<link to="IEventListener::handleEvent" /> method. When done with an event, the
17019	external code must call <link to="#eventProcessed" />.
17020	</desc>
17021	</param>
17022	</method>
17023
17024	<method name="unregisterListener">
17025	<desc>
17026	Unregister an event listener. If listener is passive, and some waitable events are still
17027	in queue they are marked as processed automatically.
17028	</desc>
17029	<param name="listener" type="IEventListener" dir="in">
17030	<desc>Listener to unregister.</desc>
17031	</param>
17032	</method>
17033
17034	<method name="fireEvent">
17035	<desc>
17036	Fire an event for this source.
17037	</desc>
17038	<param name="event" type="IEvent" dir="in">
17039	<desc>Event to deliver.</desc>
17040	</param>
17041	<param name="timeout" type="long" dir="in">
17042	<desc>
17043	Maximum time to wait for event processing (if event is waitable), in ms;
17044	0 = no wait, -1 = indefinite wait.
17045	</desc>
17046	</param>
17047	<param name="result" type="boolean" dir="return">
17048	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
17049	</param>
17050	</method>
17051
17052	<method name="getEvent">
17053	<desc>
17054	Get events from this peer's event queue (for passive mode). Calling this method
17055	regularly is required for passive event listeners to avoid system overload;
17056	see <link to="IEventSource::registerListener" /> for details.
17057
17058	<result name="VBOX_E_OBJECT_NOT_FOUND">
17059	Listener is not registered, or autounregistered.
17060	</result>
17061	</desc>
17062	<param name="listener" type="IEventListener" dir="in">
17063	<desc>Which listener to get data for.</desc>
17064	</param>
17065	<param name="timeout" type="long" dir="in">
17066	<desc>
17067	Maximum time to wait for events, in ms;
17068	0 = no wait, -1 = indefinite wait.
17069	</desc>
17070	</param>
17071	<param name="event" type="IEvent" dir="return">
17072	<desc>Event retrieved, or null if none available.</desc>
17073	</param>
17074	</method>
17075
17076	<method name="eventProcessed">
17077	<desc>
17078	Must be called for waitable events after a particular listener finished its
17079	event processing. When all listeners of a particular event have called this
17080	method, the system will then call <link to="IEvent::setProcessed" />.
17081	</desc>
17082	<param name="listener" type="IEventListener" dir="in">
17083	<desc>Which listener processed event.</desc>
17084	</param>
17085	<param name="event" type="IEvent" dir="in">
17086	<desc>Which event.</desc>
17087	</param>
17088	</method>
17089
17090	</interface>
17091
17092	<interface
17093	name="IEventListener" extends="$unknown"
17094	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
17095	wsmap="managed"
17096	>
17097	<desc>
17098	Event listener. An event listener can work in either active or passive mode, depending on the way
17099	it was registered.
17100	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
17101	</desc>
17102
17103	<method name="handleEvent">
17104	<desc>
17105	Handle event callback for active listeners. It is not called for
17106	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
17107	and having received acknowledgement from all passive listeners via
17108	<link to="IEventSource::eventProcessed"/>, the event is marked as
17109	processed and <link to="IEvent::waitProcessed"/> will return
17110	immediately.
17111	</desc>
17112	<param name="event" type="IEvent" dir="in">
17113	<desc>Event available.</desc>
17114	</param>
17115	</method>
17116
17117	</interface>
17118
17119	<interface
17120	name="IEvent" extends="$unknown"
17121	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
17122	wsmap="managed"
17123	>
17124	<desc>
17125	Abstract parent interface for VirtualBox events. Actual events will typically implement
17126	a more specific interface which derives from this (see below).
17127
17128	<b>Introduction to VirtualBox events</b>
17129
17130	Generally speaking, an event (represented by this interface) signals that something
17131	happened, while an event listener (see <link to="IEventListener" />) represents an
17132	entity that is interested in certain events. In order for this to work with
17133	unidirectional protocols (i.e. web services), the concepts of passive and active
17134	listener are used.
17135
17136	Event consumers can register themselves as listeners, providing an array of
17137	events they are interested in (see <link to="IEventSource::registerListener" />).
17138	When an event triggers, the listener is notified about the event. The exact
17139	mechanism of the notification depends on whether the listener was registered as
17140	an active or passive listener:
17141
17142	<ul>
17143	<li>An active listener is very similar to a callback: it is a function invoked
17144	by the API. As opposed to the callbacks that were used in the API before
17145	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
17146	</li>
17147
17148	<li>Passive listeners are somewhat trickier to implement, but do not require
17149	a client function to be callable, which is not an option with scripting
17150	languages or web service clients. Internally the <link to="IEventSource" />
17151	implementation maintains an event queue for each passive listener, and
17152	newly arrived events are put in this queue. When the listener calls
17153	<link to="IEventSource::getEvent"/>, first element from its internal event
17154	queue is returned. When the client completes processing of an event,
17155	the <link to="IEventSource::eventProcessed" /> function must be called,
17156	acknowledging that the event was processed. It supports implementing
17157	waitable events. On passive listener unregistration, all events from its
17158	queue are auto-acknowledged.
17159	</li>
17160	</ul>
17161
17162	Waitable events are useful in situations where the event generator wants to track
17163	delivery or a party wants to wait until all listeners have completed the event. A
17164	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
17165	listeners might veto a certain action, and thus the event producer has to make
17166	sure that all listeners have processed the event and not vetoed before taking
17167	the action.
17168
17169	A given event may have both passive and active listeners at the same time.
17170
17171	<b>Using events</b>
17172
17173	Any VirtualBox object capable of producing externally visible events provides an
17174	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
17175	This event source object is notified by VirtualBox once something has happened, so
17176	consumers may register event listeners with this event source. To register a listener,
17177	an object implementing the <link to="IEventListener" /> interface must be provided.
17178	For active listeners, such an object is typically created by the consumer, while for
17179	passive listeners <link to="IEventSource::createListener" /> should be used. Please
17180	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
17181
17182	Once created, the listener must be registered to listen for the desired events
17183	(see <link to="IEventSource::registerListener" />), providing an array of
17184	<link to="VBoxEventType" /> enums. Those elements can either be the individual
17185	event IDs or wildcards matching multiple event IDs.
17186
17187	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
17188	called automatically when the event is triggered, while passive listeners have to call
17189	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
17190	an event processing loop.
17191
17192	The IEvent interface is an abstract parent interface for all such VirtualBox events
17193	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
17194	or the event processing loop is to check the <link to="#type" /> attribute of the event and
17195	then cast to the appropriate specific interface using @c QueryInterface().
17196	</desc>
17197
17198	<attribute name="type" readonly="yes" type="VBoxEventType">
17199	<desc>
17200	Event type.
17201	</desc>
17202	</attribute>
17203
17204	<attribute name="source" readonly="yes" type="IEventSource">
17205	<desc>
17206	Source of this event.
17207	</desc>
17208	</attribute>
17209
17210	<attribute name="waitable" readonly="yes" type="boolean">
17211	<desc>
17212	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
17213	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
17214	as no additional overhead associated with waitability imposed.
17215	Waitable events are needed when one need to be able to wait for particular event processed,
17216	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
17217	until all consumers confirmed events.
17218	</desc>
17219	</attribute>
17220
17221	<method name="setProcessed">
17222	<desc>
17223	Internal method called by the system when all listeners of a particular event have called
17224	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
17225	</desc>
17226	</method>
17227
17228	<method name="waitProcessed">
17229	<desc>
17230	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
17231	described semantics, for non-waitable returns true immediately.
17232	</desc>
17233	<param name="timeout" type="long" dir="in">
17234	<desc>
17235	Maximum time to wait for event processeing, in ms;
17236	0 = no wait, -1 = indefinite wait.
17237	</desc>
17238	</param>
17239	<param name="result" type="boolean" dir="return">
17240	<desc>If this event was processed before timeout.</desc>
17241	</param>
17242	</method>
17243	</interface>
17244
17245
17246	<interface
17247	name="IReusableEvent" extends="IEvent"
17248	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
17249	wsmap="managed"
17250	>
17251	<desc>Base abstract interface for all reusable events.</desc>
17252
17253	<attribute name="generation" readonly="yes" type="unsigned long">
17254	<desc>Current generation of event, incremented on reuse.</desc>
17255	</attribute>
17256
17257	<method name="reuse">
17258	<desc>
17259	Marks an event as reused, increments 'generation', fields shall no
17260	longer be considered valid.
17261	</desc>
17262	</method>
17263	</interface>
17264
17265	<interface
17266	name="IMachineEvent" extends="IEvent"
17267	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
17268	wsmap="managed" id="MachineEvent"
17269	>
17270	<desc>Base abstract interface for all machine events.</desc>
17271
17272	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
17273	<desc>ID of the machine this event relates to.</desc>
17274	</attribute>
17275
17276	</interface>
17277
17278	<interface
17279	name="IMachineStateChangedEvent" extends="IMachineEvent"
17280	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
17281	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
17282	>
17283	<desc>Machine state change event.</desc>
17284
17285	<attribute name="state" readonly="yes" type="MachineState">
17286	<desc>New execution state.</desc>
17287	</attribute>
17288	</interface>
17289
17290	<interface
17291	name="IMachineDataChangedEvent" extends="IMachineEvent"
17292	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
17293	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
17294	>
17295	<desc>
17296	Any of the settings of the given machine has changed.
17297	</desc>
17298
17299	<attribute name="temporary" readonly="yes" type="boolean">
17300	<desc>@c true if the settings change is temporary. All permanent
17301	settings changes will trigger an event, and only temporary settings
17302	changes for running VMs will trigger an event. Note: sending events
17303	for temporary changes is NOT IMPLEMENTED.</desc>
17304	</attribute>
17305	</interface>
17306
17307	<interface
17308	name="IMediumRegisteredEvent" extends="IEvent"
17309	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
17310	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
17311	>
17312	<desc>
17313	The given medium was registered or unregistered
17314	within this VirtualBox installation.
17315	</desc>
17316
17317	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
17318	<desc>ID of the medium this event relates to.</desc>
17319	</attribute>
17320
17321	<attribute name="mediumType" readonly="yes" type="DeviceType">
17322	<desc>Type of the medium this event relates to.</desc>
17323	</attribute>
17324
17325	<attribute name="registered" type="boolean" readonly="yes">
17326	<desc>
17327	If @c true, the medium was registered, otherwise it was
17328	unregistered.
17329	</desc>
17330	</attribute>
17331	</interface>
17332
17333	<interface
17334	name="IMachineRegisteredEvent" extends="IMachineEvent"
17335	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
17336	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
17337	>
17338	<desc>
17339	The given machine was registered or unregistered
17340	within this VirtualBox installation.
17341	</desc>
17342
17343	<attribute name="registered" type="boolean" readonly="yes">
17344	<desc>
17345	If @c true, the machine was registered, otherwise it was
17346	unregistered.
17347	</desc>
17348	</attribute>
17349	</interface>
17350
17351	<interface
17352	name="ISessionStateChangedEvent" extends="IMachineEvent"
17353	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
17354	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
17355	>
17356	<desc>
17357	The state of the session for the given machine was changed.
17358	<see><link to="IMachine::sessionState"/></see>
17359	</desc>
17360
17361	<attribute name="state" type="SessionState" readonly="yes">
17362	<desc>
17363	New session state.
17364	</desc>
17365	</attribute>
17366	</interface>
17367
17368	<interface
17369	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
17370	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
17371	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
17372	>
17373	<desc>
17374	Notification when a guest property has changed.
17375	</desc>
17376
17377	<attribute name="name" readonly="yes" type="wstring">
17378	<desc>
17379	The name of the property that has changed.
17380	</desc>
17381	</attribute>
17382
17383	<attribute name="value" readonly="yes" type="wstring">
17384	<desc>
17385	The new property value.
17386	</desc>
17387	</attribute>
17388
17389	<attribute name="flags" readonly="yes" type="wstring">
17390	<desc>
17391	The new property flags.
17392	</desc>
17393	</attribute>
17394
17395	</interface>
17396
17397	<interface
17398	name="ISnapshotEvent" extends="IMachineEvent"
17399	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
17400	wsmap="managed" id="SnapshotEvent"
17401	>
17402	<desc>Base interface for all snapshot events.</desc>
17403
17404	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
17405	<desc>ID of the snapshot this event relates to.</desc>
17406	</attribute>
17407
17408	</interface>
17409
17410	<interface
17411	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
17412	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
17413	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
17414	>
17415	<desc>
17416	A new snapshot of the machine has been taken.
17417	<see><link to="ISnapshot"/></see>
17418	</desc>
17419	</interface>
17420
17421	<interface
17422	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
17423	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
17424	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
17425	>
17426	<desc>
17427	Snapshot of the given machine has been deleted.
17428
17429	<note>
17430	This notification is delivered <b>after</b> the snapshot
17431	object has been uninitialized on the server (so that any
17432	attempt to call its methods will return an error).
17433	</note>
17434
17435	<see><link to="ISnapshot"/></see>
17436	</desc>
17437	</interface>
17438
17439	<interface
17440	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
17441	uuid="07541941-8079-447a-a33e-47a69c7980db"
17442	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
17443	>
17444	<desc>
17445	Snapshot properties (name and/or description) have been changed.
17446	<see><link to="ISnapshot"/></see>
17447	</desc>
17448	</interface>
17449
17450	<interface
17451	name="IMousePointerShapeChangedEvent" extends="IEvent"
17452	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
17453	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
17454	>
17455	<desc>
17456	Notification when the guest mouse pointer shape has
17457	changed. The new shape data is given.
17458	</desc>
17459
17460	<attribute name="visible" type="boolean" readonly="yes">
17461	<desc>
17462	Flag whether the pointer is visible.
17463	</desc>
17464	</attribute>
17465	<attribute name="alpha" type="boolean" readonly="yes">
17466	<desc>
17467	Flag whether the pointer has an alpha channel.
17468	</desc>
17469	</attribute>
17470	<attribute name="xhot" type="unsigned long" readonly="yes">
17471	<desc>
17472	The pointer hot spot X coordinate.
17473	</desc>
17474	</attribute>
17475	<attribute name="yhot" type="unsigned long" readonly="yes">
17476	<desc>
17477	The pointer hot spot Y coordinate.
17478	</desc>
17479	</attribute>
17480	<attribute name="width" type="unsigned long" readonly="yes">
17481	<desc>
17482	Width of the pointer shape in pixels.
17483	</desc>
17484	</attribute>
17485	<attribute name="height" type="unsigned long" readonly="yes">
17486	<desc>
17487	Height of the pointer shape in pixels.
17488	</desc>
17489	</attribute>
17490	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
17491	<desc>
17492	Shape buffer arrays.
17493
17494	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
17495	followed by a 32-bpp XOR (color) mask.
17496
17497	For pointers without alpha channel the XOR mask pixels are 32
17498	bit values: (lsb)BGR0(msb). For pointers with alpha channel
17499	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
17500
17501	An AND mask is used for pointers with alpha channel, so if the
17502	callback does not support alpha, the pointer could be
17503	displayed as a normal color pointer.
17504
17505	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
17506	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
17507	height</tt>. The padding bits at the end of each scanline are
17508	undefined.
17509
17510	The XOR mask follows the AND mask on the next 4-byte aligned
17511	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
17512	Bytes in the gap between the AND and the XOR mask are undefined.
17513	The XOR mask scanlines have no gap between them and the size of
17514	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
17515
17516	<note>
17517	If @a shape is 0, only the pointer visibility is changed.
17518	</note>
17519	</desc>
17520	</attribute>
17521	</interface>
17522
17523	<interface
17524	name="IMouseCapabilityChangedEvent" extends="IEvent"
17525	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
17526	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
17527	>
17528	<desc>
17529	Notification when the mouse capabilities reported by the
17530	guest have changed. The new capabilities are passed.
17531	</desc>
17532	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
17533	<desc>
17534	Supports absolute coordinates.
17535	</desc>
17536	</attribute>
17537	<attribute name="supportsRelative" type="boolean" readonly="yes">
17538	<desc>
17539	Supports relative coordinates.
17540	</desc>
17541	</attribute>
17542	<attribute name="needsHostCursor" type="boolean" readonly="yes">
17543	<desc>
17544	If host cursor is needed.
17545	</desc>
17546	</attribute>
17547	</interface>
17548
17549	<interface
17550	name="IKeyboardLedsChangedEvent" extends="IEvent"
17551	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
17552	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
17553	>
17554	<desc>
17555	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
17556	to alter the state of the keyboard LEDs.
17557	</desc>
17558	<attribute name="numLock" type="boolean" readonly="yes">
17559	<desc>
17560	NumLock status.
17561	</desc>
17562	</attribute>
17563	<attribute name="capsLock" type="boolean" readonly="yes">
17564	<desc>
17565	CapsLock status.
17566	</desc>
17567	</attribute>
17568	<attribute name="scrollLock" type="boolean" readonly="yes">
17569	<desc>
17570	ScrollLock status.
17571	</desc>
17572	</attribute>
17573	</interface>
17574
17575	<interface
17576	name="IStateChangedEvent" extends="IEvent"
17577	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
17578	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
17579	>
17580	<desc>
17581	Notification when the execution state of the machine has changed.
17582	The new state is given.
17583	</desc>
17584	<attribute name="state" type="MachineState" readonly="yes">
17585	<desc>
17586	New machine state.
17587	</desc>
17588	</attribute>
17589	</interface>
17590
17591	<interface
17592	name="IAdditionsStateChangedEvent" extends="IEvent"
17593	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
17594	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
17595	>
17596	<desc>
17597	Notification when a Guest Additions property changes.
17598	Interested callees should query IGuest attributes to
17599	find out what has changed.
17600	</desc>
17601	</interface>
17602
17603	<interface
17604	name="INetworkAdapterChangedEvent" extends="IEvent"
17605	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
17606	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
17607	>
17608	<desc>
17609	Notification when a property of one of the
17610	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
17611	changes. Interested callees should use INetworkAdapter methods and
17612	attributes to find out what has changed.
17613	</desc>
17614	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
17615	<desc>
17616	Network adapter that is subject to change.
17617	</desc>
17618	</attribute>
17619	</interface>
17620
17621	<interface
17622	name="ISerialPortChangedEvent" extends="IEvent"
17623	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
17624	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
17625	>
17626	<desc>
17627	Notification when a property of one of the
17628	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
17629	Interested callees should use ISerialPort methods and attributes
17630	to find out what has changed.
17631	</desc>
17632	<attribute name="serialPort" type="ISerialPort" readonly="yes">
17633	<desc>
17634	Serial port that is subject to change.
17635	</desc>
17636	</attribute>
17637	</interface>
17638
17639	<interface
17640	name="IParallelPortChangedEvent" extends="IEvent"
17641	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
17642	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
17643	>
17644	<desc>
17645	Notification when a property of one of the
17646	virtual <link to="IMachine::getParallelPort">parallel ports</link>
17647	changes. Interested callees should use ISerialPort methods and
17648	attributes to find out what has changed.
17649	</desc>
17650	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
17651	<desc>
17652	Parallel port that is subject to change.
17653	</desc>
17654	</attribute>
17655	</interface>
17656
17657	<interface
17658	name="IStorageControllerChangedEvent" extends="IEvent"
17659	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
17660	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
17661	>
17662	<desc>
17663	Notification when a
17664	<link to="IMachine::mediumAttachments">medium attachment</link>
17665	changes.
17666	</desc>
17667	</interface>
17668
17669	<interface
17670	name="IMediumChangedEvent" extends="IEvent"
17671	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
17672	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
17673	>
17674	<desc>
17675	Notification when a
17676	<link to="IMachine::mediumAttachments">medium attachment</link>
17677	changes.
17678	</desc>
17679	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
17680	<desc>
17681	Medium attachment that is subject to change.
17682	</desc>
17683	</attribute>
17684	</interface>
17685
17686	<interface
17687	name="IClipboardModeChangedEvent" extends="IEvent"
17688	uuid="cac21692-7997-4595-a731-3a509db604e5"
17689	wsmap="managed" autogen="VBoxEvent" id="OnClipboardModeChanged"
17690	>
17691	<desc>
17692	Notification when the shared clipboard mode changes.
17693	</desc>
17694	<attribute name="clipboardMode" type="ClipboardMode" readonly="yes">
17695	<desc>
17696	The new clipboard mode.
17697	</desc>
17698	</attribute>
17699	</interface>
17700
17701	<interface
17702	name="ICPUChangedEvent" extends="IEvent"
17703	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
17704	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
17705	>
17706	<desc>
17707	Notification when a CPU changes.
17708	</desc>
17709	<attribute name="cpu" type="unsigned long" readonly="yes">
17710	<desc>
17711	The CPU which changed.
17712	</desc>
17713	</attribute>
17714	<attribute name="add" type="boolean" readonly="yes">
17715	<desc>
17716	Flag whether the CPU was added or removed.
17717	</desc>
17718	</attribute>
17719	</interface>
17720
17721	<interface
17722	name="ICPUExecutionCapChangedEvent" extends="IEvent"
17723	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
17724	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
17725	>
17726	<desc>
17727	Notification when the CPU execution cap changes.
17728	</desc>
17729	<attribute name="executionCap" type="unsigned long" readonly="yes">
17730	<desc>
17731	The new CPU execution cap value. (1-100)
17732	</desc>
17733	</attribute>
17734	</interface>
17735
17736	<interface
17737	name="IGuestKeyboardEvent" extends="IEvent"
17738	uuid="88394258-7006-40d4-b339-472ee3801844"
17739	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
17740	>
17741	<desc>
17742	Notification when guest keyboard event happens.
17743	</desc>
17744	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
17745	<desc>
17746	Array of scancodes.
17747	</desc>
17748	</attribute>
17749	</interface>
17750
17751	<interface
17752	name="IGuestMouseEvent" extends="IReusableEvent"
17753	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
17754	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
17755	>
17756	<desc>
17757	Notification when guest mouse event happens.
17758	</desc>
17759
17760	<attribute name="absolute" type="boolean" readonly="yes">
17761	<desc>
17762	If this event is relative or absolute.
17763	</desc>
17764	</attribute>
17765
17766	<attribute name="x" type="long" readonly="yes">
17767	<desc>
17768	New X position, or X delta.
17769	</desc>
17770	</attribute>
17771
17772	<attribute name="y" type="long" readonly="yes">
17773	<desc>
17774	New Y position, or Y delta.
17775	</desc>
17776	</attribute>
17777
17778	<attribute name="z" type="long" readonly="yes">
17779	<desc>
17780	Z delta.
17781	</desc>
17782	</attribute>
17783
17784	<attribute name="w" type="long" readonly="yes">
17785	<desc>
17786	W delta.
17787	</desc>
17788	</attribute>
17789
17790	<attribute name="buttons" type="long" readonly="yes">
17791	<desc>
17792	Button state bitmask.
17793	</desc>
17794	</attribute>
17795
17796	</interface>
17797
17798
17799	<interface
17800	name="IVRDEServerChangedEvent" extends="IEvent"
17801	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
17802	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
17803	>
17804	<desc>
17805	Notification when a property of the
17806	<link to="IMachine::VRDEServer">VRDE server</link> changes.
17807	Interested callees should use IVRDEServer methods and attributes to
17808	find out what has changed.
17809	</desc>
17810	</interface>
17811
17812	<interface
17813	name="IVRDEServerInfoChangedEvent" extends="IEvent"
17814	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
17815	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
17816	>
17817	<desc>
17818	Notification when the status of the VRDE server changes. Interested callees
17819	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
17820	attributes to find out what is the current status.
17821	</desc>
17822	</interface>
17823
17824	<interface
17825	name="IUSBControllerChangedEvent" extends="IEvent"
17826	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
17827	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
17828	>
17829	<desc>
17830	Notification when a property of the virtual
17831	<link to="IMachine::USBController">USB controller</link> changes.
17832	Interested callees should use IUSBController methods and attributes to
17833	find out what has changed.
17834	</desc>
17835	</interface>
17836
17837	<interface
17838	name="IUSBDeviceStateChangedEvent" extends="IEvent"
17839	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
17840	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
17841	>
17842	<desc>
17843	Notification when a USB device is attached to or detached from
17844	the virtual USB controller.
17845
17846	This notification is sent as a result of the indirect
17847	request to attach the device because it matches one of the
17848	machine USB filters, or as a result of the direct request
17849	issued by <link to="IConsole::attachUSBDevice"/> or
17850	<link to="IConsole::detachUSBDevice"/>.
17851
17852	This notification is sent in case of both a succeeded and a
17853	failed request completion. When the request succeeds, the
17854	@a error parameter is @c null, and the given device has been
17855	already added to (when @a attached is @c true) or removed from
17856	(when @a attached is @c false) the collection represented by
17857	<link to="IConsole::USBDevices"/>. On failure, the collection
17858	doesn't change and the @a error parameter represents the error
17859	message describing the failure.
17860	</desc>
17861	<attribute name="device" type="IUSBDevice" readonly="yes">
17862	<desc>
17863	Device that is subject to state change.
17864	</desc>
17865	</attribute>
17866	<attribute name="attached" type="boolean" readonly="yes">
17867	<desc>
17868	@c true if the device was attached and @c false otherwise.
17869	</desc>
17870	</attribute>
17871	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
17872	<desc>
17873	@c null on success or an error message object on failure.
17874	</desc>
17875	</attribute>
17876	</interface>
17877
17878	<interface
17879	name="ISharedFolderChangedEvent" extends="IEvent"
17880	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
17881	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
17882	>
17883	<desc>
17884	Notification when a shared folder is added or removed.
17885	The @a scope argument defines one of three scopes:
17886	<link to="IVirtualBox::sharedFolders">global shared folders</link>
17887	(<link to="Scope_Global">Global</link>),
17888	<link to="IMachine::sharedFolders">permanent shared folders</link> of
17889	the machine (<link to="Scope_Machine">Machine</link>) or <link
17890	to="IConsole::sharedFolders">transient shared folders</link> of the
17891	machine (<link to="Scope_Session">Session</link>). Interested callees
17892	should use query the corresponding collections to find out what has
17893	changed.
17894	</desc>
17895	<attribute name="scope" type="Scope" readonly="yes">
17896	<desc>
17897	Scope of the notification.
17898	</desc>
17899	</attribute>
17900	</interface>
17901
17902	<interface
17903	name="IRuntimeErrorEvent" extends="IEvent"
17904	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
17905	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
17906	>
17907	<desc>
17908	Notification when an error happens during the virtual
17909	machine execution.
17910
17911	There are three kinds of runtime errors:
17912	<ul>
17913	<li><i>fatal</i></li>
17914	<li><i>non-fatal with retry</i></li>
17915	<li><i>non-fatal warnings</i></li>
17916	</ul>
17917
17918	<b>Fatal</b> errors are indicated by the @a fatal parameter set
17919	to @c true. In case of fatal errors, the virtual machine
17920	execution is always paused before calling this notification, and
17921	the notification handler is supposed either to immediately save
17922	the virtual machine state using <link to="IConsole::saveState"/>
17923	or power it off using <link to="IConsole::powerDown"/>.
17924	Resuming the execution can lead to unpredictable results.
17925
17926	<b>Non-fatal</b> errors and warnings are indicated by the
17927	@a fatal parameter set to @c false. If the virtual machine
17928	is in the Paused state by the time the error notification is
17929	received, it means that the user can <i>try to resume</i> the machine
17930	execution after attempting to solve the problem that caused the
17931	error. In this case, the notification handler is supposed
17932	to show an appropriate message to the user (depending on the
17933	value of the @a id parameter) that offers several actions such
17934	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
17935	wants to retry, the notification handler should continue
17936	the machine execution using the <link to="IConsole::resume"/>
17937	call. If the machine execution is not Paused during this
17938	notification, then it means this notification is a <i>warning</i>
17939	(for example, about a fatal condition that can happen very soon);
17940	no immediate action is required from the user, the machine
17941	continues its normal execution.
17942
17943	Note that in either case the notification handler
17944	<b>must not</b> perform any action directly on a thread
17945	where this notification is called. Everything it is allowed to
17946	do is to post a message to another thread that will then talk
17947	to the user and take the corresponding action.
17948
17949	Currently, the following error identifiers are known:
17950	<ul>
17951	<li><tt>"HostMemoryLow"</tt></li>
17952	<li><tt>"HostAudioNotResponding"</tt></li>
17953	<li><tt>"VDIStorageFull"</tt></li>
17954	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
17955	</ul>
17956	</desc>
17957	<attribute name="fatal" type="boolean" readonly="yes">
17958	<desc>
17959	Whether the error is fatal or not.
17960	</desc>
17961	</attribute>
17962	<attribute name="id" type="wstring" readonly="yes">
17963	<desc>
17964	Error identifier.
17965	</desc>
17966	</attribute>
17967	<attribute name="message" type="wstring" readonly="yes">
17968	<desc>
17969	Optional error message.
17970	</desc>
17971	</attribute>
17972	</interface>
17973
17974
17975	<interface
17976	name="IEventSourceChangedEvent" extends="IEvent"
17977	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
17978	waitable="yes"
17979	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
17980	>
17981	<desc>
17982	Notification when an event source state changes (listener added or removed).
17983	</desc>
17984
17985	<attribute name="listener" type="IEventListener" readonly="yes">
17986	<desc>
17987	Event listener which has changed.
17988	</desc>
17989	</attribute>
17990
17991	<attribute name="add" type="boolean" readonly="yes">
17992	<desc>
17993	Flag whether listener was added or removed.
17994	</desc>
17995	</attribute>
17996	</interface>
17997
17998	<interface
17999	name="IExtraDataChangedEvent" extends="IEvent"
18000	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
18001	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
18002	>
18003	<desc>
18004	Notification when machine specific or global extra data
18005	has changed.
18006	</desc>
18007	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
18008	<desc>
18009	ID of the machine this event relates to.
18010	Null for global extra data changes.
18011	</desc>
18012	</attribute>
18013	<attribute name="key" type="wstring" readonly="yes">
18014	<desc>
18015	Extra data key that has changed.
18016	</desc>
18017	</attribute>
18018	<attribute name="value" type="wstring" readonly="yes">
18019	<desc>
18020	Extra data value for the given key.
18021	</desc>
18022	</attribute>
18023	</interface>
18024
18025	<interface
18026	name="IVetoEvent" extends="IEvent"
18027	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
18028	wsmap="managed"
18029	>
18030	<desc>Base abstract interface for veto events.</desc>
18031
18032	<method name="addVeto">
18033	<desc>
18034	Adds a veto on this event.
18035	</desc>
18036	<param name="reason" type="wstring" dir="in">
18037	<desc>
18038	Reason for veto, could be null or empty string.
18039	</desc>
18040	</param>
18041	</method>
18042
18043	<method name="isVetoed">
18044	<desc>
18045	If this event was vetoed.
18046	</desc>
18047	<param name="result" type="boolean" dir="return">
18048	<desc>
18049	Reason for veto.
18050	</desc>
18051	</param>
18052	</method>
18053
18054	<method name="getVetos">
18055	<desc>
18056	Current veto reason list, if size is 0 - no veto.
18057	</desc>
18058	<param name="result" type="wstring" dir="return" safearray="yes">
18059	<desc>
18060	Array of reasons for veto provided by different event handlers.
18061	</desc>
18062	</param>
18063	</method>
18064
18065	</interface>
18066
18067	<interface
18068	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
18069	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
18070	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
18071	waitable="true"
18072	>
18073	<desc>
18074	Notification when someone tries to change extra data for
18075	either the given machine or (if @c null) global extra data.
18076	This gives the chance to veto against changes.
18077	</desc>
18078	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
18079	<desc>
18080	ID of the machine this event relates to.
18081	Null for global extra data changes.
18082	</desc>
18083	</attribute>
18084	<attribute name="key" type="wstring" readonly="yes">
18085	<desc>
18086	Extra data key that has changed.
18087	</desc>
18088	</attribute>
18089	<attribute name="value" type="wstring" readonly="yes">
18090	<desc>
18091	Extra data value for the given key.
18092	</desc>
18093	</attribute>
18094	</interface>
18095
18096	<interface
18097	name="ICanShowWindowEvent" extends="IVetoEvent"
18098	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
18099	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
18100	waitable="true"
18101	>
18102	<desc>
18103	Notification when a call to
18104	<link to="IMachine::canShowConsoleWindow"/> is made by a
18105	front-end to check if a subsequent call to
18106	<link to="IMachine::showConsoleWindow"/> can succeed.
18107
18108	The callee should give an answer appropriate to the current
18109	machine state using event veto. This answer must
18110	remain valid at least until the next
18111	<link to="IConsole::state">machine state</link> change.
18112	</desc>
18113	</interface>
18114
18115	<interface
18116	name="IShowWindowEvent" extends="IEvent"
18117	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
18118	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
18119	waitable="true"
18120	>
18121	<desc>
18122	Notification when a call to
18123	<link to="IMachine::showConsoleWindow"/>
18124	requests the console window to be activated and brought to
18125	foreground on the desktop of the host PC.
18126
18127	This notification should cause the VM console process to
18128	perform the requested action as described above. If it is
18129	impossible to do it at a time of this notification, this
18130	method should return a failure.
18131
18132	Note that many modern window managers on many platforms
18133	implement some sort of focus stealing prevention logic, so
18134	that it may be impossible to activate a window without the
18135	help of the currently active application (which is supposedly
18136	an initiator of this notification). In this case, this method
18137	must return a non-zero identifier that represents the
18138	top-level window of the VM console process. The caller, if it
18139	represents a currently active process, is responsible to use
18140	this identifier (in a platform-dependent manner) to perform
18141	actual window activation.
18142
18143	This method must set @a winId to zero if it has performed all
18144	actions necessary to complete the request and the console
18145	window is now active and in foreground, to indicate that no
18146	further action is required on the caller's side.
18147	</desc>
18148	<attribute name="winId" type="long long">
18149	<desc>
18150	Platform-dependent identifier of the top-level VM console
18151	window, or zero if this method has performed all actions
18152	necessary to implement the <i>show window</i> semantics for
18153	the given platform and/or this VirtualBox front-end.
18154	</desc>
18155	</attribute>
18156	</interface>
18157
18158	<interface
18159	name="INATRedirectEvent" extends="IMachineEvent"
18160	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
18161	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
18162	>
18163	<desc>
18164	Notification when NAT redirect rule added or removed.
18165	</desc>
18166	<attribute name="slot" type="unsigned long" readonly="yes">
18167	<desc>
18168	Adapter which NAT attached to.
18169	</desc>
18170	</attribute>
18171	<attribute name="remove" type="boolean" readonly="yes">
18172	<desc>
18173	Whether rule remove or add.
18174	</desc>
18175	</attribute>
18176	<attribute name="name" type="wstring" readonly="yes">
18177	<desc>
18178	Name of the rule.
18179	</desc>
18180	</attribute>
18181	<attribute name="proto" type="NATProtocol" readonly="yes">
18182	<desc>
18183	Protocol (TCP or UDP) of the redirect rule.
18184	</desc>
18185	</attribute>
18186	<attribute name="hostIp" type="wstring" readonly="yes">
18187	<desc>
18188	Host ip address to bind socket on.
18189	</desc>
18190	</attribute>
18191	<attribute name="hostPort" type="long" readonly="yes">
18192	<desc>
18193	Host port to bind socket on.
18194	</desc>
18195	</attribute>
18196	<attribute name="guestIp" type="wstring" readonly="yes">
18197	<desc>
18198	Guest ip address to redirect to.
18199	</desc>
18200	</attribute>
18201	<attribute name="guestPort" type="long" readonly="yes">
18202	<desc>
18203	Guest port to redirect to.
18204	</desc>
18205	</attribute>
18206	</interface>
18207
18208	<interface
18209	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
18210	waitable="yes"
18211	uuid="9cebfc27-c579-4965-8eb7-d31794cd7dcf"
18212	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
18213	>
18214	<desc>
18215	Notification when host PCI device is plugged/unplugged. Plugging
18216	usually takes place on VM startup, unplug - when
18217	<link to="IMachine::detachHostPciDevice"/> is called.
18218
18219	<see><link to="IMachine::detachHostPciDevice"/></see>
18220
18221	</desc>
18222
18223	<attribute name="plugged" type="boolean" readonly="yes">
18224	<desc>
18225	If device successfully plugged or unplugged.
18226	</desc>
18227	</attribute>
18228
18229	<attribute name="success" type="boolean" readonly="yes">
18230	<desc>
18231	If operation was successful, if false - 'message' attribute
18232	may be of interest.
18233	</desc>
18234	</attribute>
18235
18236	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
18237	<desc>
18238	Attachment info for this device.
18239	</desc>
18240	</attribute>
18241
18242	<attribute name="message" type="wstring" readonly="yes">
18243	<desc>
18244	Optional error message.
18245	</desc>
18246	</attribute>
18247
18248	</interface>
18249
18250	<interface
18251	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
18252	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
18253	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
18254	>
18255	<desc>
18256	Notification when VBoxSVC becomes unavailable (due to a crash or similar
18257	unexpected circumstances) or available again.
18258	</desc>
18259
18260	<attribute name="available" type="boolean" readonly="yes">
18261	<desc>
18262	Whether VBoxSVC is available now.
18263	</desc>
18264	</attribute>
18265	</interface>
18266
18267	<interface
18268	name="IBandwidthGroupChangedEvent" extends="IEvent"
18269	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
18270	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
18271	>
18272	<desc>
18273	Notification when one of the bandwidth groups changed
18274	</desc>
18275	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
18276	<desc>
18277	The changed bandwidth group.
18278	</desc>
18279	</attribute>
18280	</interface>
18281
18282	<enum
18283	name="GuestMonitorChangedEventType"
18284	uuid="ef172985-7e36-4297-95be-e46396968d66"
18285	>
18286
18287	<desc>
18288	How the guest monitor has been changed.
18289	</desc>
18290
18291	<const name="Enabled" value="0">
18292	<desc>
18293	The guest monitor has been enabled by the guest.
18294	</desc>
18295	</const>
18296
18297	<const name="Disabled" value="1">
18298	<desc>
18299	The guest monitor has been disabled by the guest.
18300	</desc>
18301	</const>
18302
18303	<const name="NewOrigin" value="2">
18304	<desc>
18305	The guest monitor origin has changed in the guest.
18306	</desc>
18307	</const>
18308	</enum>
18309
18310	<interface
18311	name="IGuestMonitorChangedEvent" extends="IEvent"
18312	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
18313	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
18314	>
18315	<desc>
18316	Notification when the guest enables one of its monitors.
18317	</desc>
18318
18319	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
18320	<desc>
18321	What was changed for this guest monitor.
18322	</desc>
18323	</attribute>
18324
18325	<attribute name="screenId" type="unsigned long" readonly="yes">
18326	<desc>
18327	The monitor which was changed.
18328	</desc>
18329	</attribute>
18330
18331	<attribute name="originX" type="unsigned long" readonly="yes">
18332	<desc>
18333	Physical X origin relative to the primary screen.
18334	Valid for Enabled and NewOrigin.
18335	</desc>
18336	</attribute>
18337
18338	<attribute name="originY" type="unsigned long" readonly="yes">
18339	<desc>
18340	Physical Y origin relative to the primary screen.
18341	Valid for Enabled and NewOrigin.
18342	</desc>
18343	</attribute>
18344
18345	<attribute name="width" type="unsigned long" readonly="yes">
18346	<desc>
18347	Width of the screen.
18348	Valid for Enabled.
18349	</desc>
18350	</attribute>
18351
18352	<attribute name="height" type="unsigned long" readonly="yes">
18353	<desc>
18354	Height of the screen.
18355	Valid for Enabled.
18356	</desc>
18357	</attribute>
18358
18359	</interface>
18360
18361	<interface
18362	name="IStorageDeviceChangedEvent" extends="IEvent"
18363	uuid="8a5c2dce-e341-49d4-afce-c95979f7d70c"
18364	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
18365	>
18366	<desc>
18367	Notification when a
18368	<link to="IMachine::mediumAttachments">storage device</link>
18369	is attached or removed.
18370	</desc>
18371	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
18372	<desc>
18373	Storage device that is subject to change.
18374	</desc>
18375	</attribute>
18376	<attribute name="removed" type="boolean" readonly="yes">
18377	<desc>
18378	Flag whether the device was removed or added to the VM.
18379	</desc>
18380	</attribute>
18381	</interface>
18382
18383	<module name="VBoxSVC" context="LocalServer">
18384	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
18385	namespace="virtualbox.org">
18386	<interface name="IVirtualBox" default="yes"/>
18387	</class>
18388	</module>
18389
18390	<module name="VBoxC" context="InprocServer" threadingModel="Free">
18391	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
18392	namespace="virtualbox.org">
18393	<interface name="IVirtualBoxClient" default="yes"/>
18394	</class>
18395
18396	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
18397	namespace="virtualbox.org">
18398	<interface name="ISession" default="yes"/>
18399	</class>
18400	</module>
18401
18402	</library>
18403
18404	</idl>
18405
18406	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format