VirtualBox.xidl@ 40685

Last change on this file since 40685 was 40539, checked in by vboxsync, 13 years ago
Main/VirtualBox: new method to get the state of several machines
Property svn:eol-style set to `native`
File size: 664.1 KB

Line
1	<?xml version="1.0" encoding="utf-8"?>
2
3	<!--
4
5	Copyright (C) 2006-2012 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI
80	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109	</desc>
110
111	<if target="midl">
112	<cpp line="enum {"/>
113	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
114	<cpp line=" kTypeLibraryMinorVersion = 0"/>
115	<cpp line="};"/>
116	</if>
117
118	<if target="xpidl">
119	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
120	<cpp>
121	/* currently, nsISupportsImpl.h lacks the below-like macros */
122
123	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
124	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
125	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
126	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
127
128
129	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
130	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
131	NS_IMPL_THREADSAFE_ADDREF(_class) \
132	NS_IMPL_THREADSAFE_RELEASE(_class) \
133	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
134	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
135	#endif
136
137	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
138	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
139	NS_IMPL_THREADSAFE_ADDREF(_class) \
140	NS_IMPL_THREADSAFE_RELEASE(_class) \
141	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
142	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
143	#endif
144
145	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
146	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
147	NS_IMPL_THREADSAFE_ADDREF(_class) \
148	NS_IMPL_THREADSAFE_RELEASE(_class) \
149	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
150	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
151	#endif
152
153	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
154	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
155	NS_IMPL_THREADSAFE_ADDREF(_class) \
156	NS_IMPL_THREADSAFE_RELEASE(_class) \
157	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
158	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
159	#endif
160
161	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
162	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
163	NS_INTERFACE_MAP_BEGIN(_class) \
164	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
165	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
166	NS_IMPL_QUERY_CLASSINFO(_class) \
167	NS_INTERFACE_MAP_END
168	#endif
169
170	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
171	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
172	_i2, _ic2) \
173	NS_INTERFACE_MAP_BEGIN(_class) \
174	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
175	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
176	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
177	NS_IMPL_QUERY_CLASSINFO(_class) \
178	NS_INTERFACE_MAP_END
179	#endif
180
181	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
182	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
183	_i2, _ic2, _i3, _ic3) \
184	NS_INTERFACE_MAP_BEGIN(_class) \
185	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
186	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
187	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
188	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
189	NS_IMPL_QUERY_CLASSINFO(_class) \
190	NS_INTERFACE_MAP_END
191	#endif
192
193	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
194	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
195	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
196
197	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
198	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
199	NS_IMPL_THREADSAFE_ADDREF(_class) \
200	NS_IMPL_THREADSAFE_RELEASE(_class) \
201	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
202	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
203	#endif
204
205	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
206	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
207	_i2, _ic2) \
208	NS_IMPL_THREADSAFE_ADDREF(_class) \
209	NS_IMPL_THREADSAFE_RELEASE(_class) \
210	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2) \
212	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
213	#endif
214
215	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
216	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
217	_i2, _ic2, _i3, _ic3) \
218	NS_IMPL_THREADSAFE_ADDREF(_class) \
219	NS_IMPL_THREADSAFE_RELEASE(_class) \
220	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
221	_i2, _ic2, _i3, _ic3) \
222	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
223	#endif
224
225	</cpp>
226	</if>
227
228	<library
229	name="VirtualBox"
230	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
231	version="1.3"
232	desc="VirtualBox Type Library"
233	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
234	supportsErrorInfo="yes"
235	>
236
237
238	<!--
239	// COM result codes for VirtualBox
240	/////////////////////////////////////////////////////////////////////////
241	-->
242
243	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
244	<desc>
245	This section describes all VirtualBox-specific COM result codes that may
246	be returned by methods of VirtualBox COM interfaces in addition to
247	standard COM result codes.
248
249	Note that along with the result code, every VirtualBox method returns
250	extended error information through the IVirtualBoxErrorInfo interface on
251	failure. This interface is a preferred way to present the error to the end
252	user because it contains a human readable description of the error. Raw
253	result codes, both standard and described in this section, are intended to
254	be used by programs to analyze the reason of a failure and select an
255	appropriate course of action without involving the end user (for example,
256	retry the operation later or make a different call).
257
258	The standard COM result codes that may originate from our methods include:
259
260	<table>
261	<tr><td>E_INVALIDARG</td>
262	<td>
263	Returned when the value of the method's argument is not within the range
264	of valid values. This should not be confused with situations when the
265	value is within the range but simply doesn't suit the current object
266	state and there is a possibility that it will be accepted later (in such
267	cases VirtualBox-specific codes are returned, for example,
268	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
269	</td>
270	</tr>
271	<tr><td>E_POINTER</td>
272	<td>
273	Returned if a memory pointer for the output argument is invalid (for
274	example, @c null). When pointers representing input arguments (such
275	as strings) are invalid, E_INVALIDARG is returned.
276	</td>
277	</tr>
278	<tr><td>E_ACCESSDENIED</td>
279	<td>
280	Returned when the called object is not ready. Since the lifetime of a
281	public COM object cannot be fully controlled by the implementation,
282	VirtualBox maintains the readiness state for all objects it creates and
283	returns this code in response to any method call on the object that was
284	deactivated by VirtualBox and is not functioning any more.
285	</td>
286	</tr>
287	<tr><td>E_OUTOFMEMORY</td>
288	<td>
289	Returned when a memory allocation operation fails.
290	</td>
291	</tr>
292	</table>
293	</desc>
294	</descGroup>
295
296	<!--
297	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
298	everything in <result>/<desc> after (and including) the first dot, so express
299	the matter of the error code in the first sentence and keep it short.
300	-->
301
302	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
303	<desc>
304	Object corresponding to the supplied arguments does not exist.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
309	<desc>
310	Current virtual machine state prevents the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
315	<desc>
316	Virtual machine error occurred attempting the operation.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
321	<desc>
322	File not accessible or erroneous file contents.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
327	<desc>
328	Runtime subsystem error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
333	<desc>
334	Pluggable Device Manager error.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
339	<desc>
340	Current object state prohibits operation.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
345	<desc>
346	Host operating system related error.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
351	<desc>
352	Requested operation is not supported.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
357	<desc>
358	Invalid XML found.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
363	<desc>
364	Current session state prohibits operation.
365	</desc>
366	</result>
367
368	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
369	<desc>
370	Object being in use prohibits operation.
371	</desc>
372	</result>
373
374	<!--
375	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
376	everything in <result>/<desc> after (and including) the first dot, so express
377	the matter of the error code in the first sentence and keep it short.
378	-->
379
380	<descGroup/>
381
382	<!--
383	// all common enums
384	/////////////////////////////////////////////////////////////////////////
385	-->
386
387	<enum
388	name="SettingsVersion"
389	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
390	>
391	<desc>
392	Settings version of VirtualBox settings files. This is written to
393	the "version" attribute of the root "VirtualBox" element in the settings
394	file XML and indicates which VirtualBox version wrote the file.
395	</desc>
396
397	<const name="Null" value="0">
398	<desc>Null value, indicates invalid version.</desc>
399	</const>
400	<const name="v1_0" value="1">
401	<desc>Legacy settings version, not currently supported.</desc>
402	</const>
403	<const name="v1_1" value="2">
404	<desc>Legacy settings version, not currently supported.</desc>
405	</const>
406	<const name="v1_2" value="3">
407	<desc>Legacy settings version, not currently supported.</desc>
408	</const>
409	<const name="v1_3pre" value="4">
410	<desc>Legacy settings version, not currently supported.</desc>
411	</const>
412	<const name="v1_3" value="5">
413	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
414	<!--
415	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
416	-->
417	</const>
418	<const name="v1_4" value="6">
419	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
420	<!--
421	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
422	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
423	-->
424	</const>
425	<const name="v1_5" value="7">
426	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
427	<!--
428	2008-09-04: 2.0.0 released
429	2008-11-20: settings version 1.5 introduced
430	2008-12-17: 2.1.0 released
431	Machine changes:
432	guest OS identifiers changed;
433	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
434	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
435	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
436	-->
437	</const>
438	<const name="v1_6" value="8">
439	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
440	<!--
441	2008-12-17: 2.1.0 released
442	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
443	2009-04-08: 2.2.0 released
444	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
445	-->
446	</const>
447	<const name="v1_7" value="9">
448	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
449	<!--
450	2008-12-17: 2.1.0 released
451	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
452	2009-04-08: 2.2.0 released
453	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
454	Machine changes: HardDiskAttachments is now StorageControllers (done)
455	-->
456	</const>
457	<const name="v1_8" value="10">
458	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
459	<!--
460	Machine additions: Display/@accelerate2DVideo (done)
461	-->
462	</const>
463	<const name="v1_9" value="11">
464	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
465	<!--
466	The big storage controller / DVD / Floppy rework (done)
467	-->
468	</const>
469	<const name="v1_10" value="12">
470	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
471	<!--
472	Machine changes: RTC localOrUTC (done)
473	CPU hot-plug support
474	-->
475	</const>
476	<const name="v1_11" value="13">
477	<desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
478	<!--
479	Machine changes: HD Audio controller, per-machine disk registries,
480	/@format attribute for DVD and floppy images.
481	-->
482	</const>
483	<const name="v1_12" value="14">
484	<desc>Settings version "1.12", written by VirtualBox 4.1.x.</desc>
485	<!--
486	Machine changes: raw PCI device attachment;
487	NetworkAdapter changes: bandwidth group.
488	-->
489	</const>
490	<const name="v1_13" value="15">
491	<desc>Settings version "1.13", written by VirtualBox 4.2.x.</desc>
492	<!--
493	Machine changes: tracing config;
494	-->
495	</const>
496
497	<const name="Future" value="99999">
498	<desc>Settings version greater than "1.13", written by a future VirtualBox version.</desc>
499	</const>
500	</enum>
501
502	<enum
503	name="AccessMode"
504	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
505	>
506	<desc>
507	Access mode for opening files.
508	</desc>
509
510	<const name="ReadOnly" value="1"/>
511	<const name="ReadWrite" value="2"/>
512	</enum>
513
514	<enum
515	name="MachineState"
516	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
517	>
518	<desc>
519	Virtual machine execution state.
520
521	This enumeration represents possible values of the <link
522	to="IMachine::state"/> attribute.
523
524	Below is the basic virtual machine state diagram. It shows how the state
525	changes during virtual machine execution. The text in square braces shows
526	a method of the IConsole interface that performs the given state
527	transition.
528
529	<pre>
530	+---------[powerDown()] <- Stuck <--[failure]-+
531	V \|
532	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
533	\| \| \| \| V \|
534	\| Aborted -----+ +--> Running --[pause()]--> Paused
535	\| \| ^ \| ^ \|
536	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
537	\| ^ \| \| \| \|
538	\| \| +-----------------------------------------+-\|-------------------+ +
539	\| \| \| \| \|
540	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
541	\| \| \| \|
542	\| +-------- Saving <--------[saveState()]<----------+---------------------+
543	\| \| \|
544	+-------------- Stopping -------[powerDown()]<----------+---------------------+
545	</pre>
546
547	Note that states to the right from PoweredOff, Aborted and Saved in the
548	above diagram are called <i>online VM states</i>. These states
549	represent the virtual machine which is being executed in a dedicated
550	process (usually with a GUI window attached to it where you can see the
551	activity of the virtual machine and interact with it). There are two
552	special pseudo-states, FirstOnline and LastOnline, that can be used in
553	relational expressions to detect if the given machine state is online or
554	not:
555
556	<pre>
557	if (machine.GetState() >= MachineState_FirstOnline &&
558	machine.GetState() <= MachineState_LastOnline)
559	{
560	...the machine is being executed...
561	}
562	</pre>
563
564	When the virtual machine is in one of the online VM states (that is, being
565	executed), only a few machine settings can be modified. Methods working
566	with such settings contain an explicit note about that. An attempt to
567	change any other setting or perform a modifying operation during this time
568	will result in the @c VBOX_E_INVALID_VM_STATE error.
569
570	All online states except Running, Paused and Stuck are transitional: they
571	represent temporary conditions of the virtual machine that will last as
572	long as the operation that initiated such a condition.
573
574	The Stuck state is a special case. It means that execution of the machine
575	has reached the "Guru Meditation" condition. This condition indicates an
576	internal VMM (virtual machine manager) failure which may happen as a
577	result of either an unhandled low-level virtual hardware exception or one
578	of the recompiler exceptions (such as the <i>too-many-traps</i>
579	condition).
580
581	Note also that any online VM state may transit to the Aborted state. This
582	happens if the process that is executing the virtual machine terminates
583	unexpectedly (for example, crashes). Other than that, the Aborted state is
584	equivalent to PoweredOff.
585
586	There are also a few additional state diagrams that do not deal with
587	virtual machine execution and therefore are shown separately. The states
588	shown on these diagrams are called <i>offline VM states</i> (this includes
589	PoweredOff, Aborted and Saved too).
590
591	The first diagram shows what happens when a lengthy setup operation is
592	being executed (such as <link to="IMachine::attachDevice"/>).
593
594	<pre>
595	+----------------------------------(same state as before the call)------+
596	\| \|
597	+-> PoweredOff --+ \|
598	\| \| \|
599	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
600	\| \|
601	+-> Saved -------+
602	</pre>
603
604	The next two diagrams demonstrate the process of taking a snapshot of a
605	powered off virtual machine, restoring the state to that as of a snapshot
606	or deleting a snapshot, respectively.
607
608	<pre>
609	+----------------------------------(same state as before the call)------+
610	\| \|
611	+-> PoweredOff --+ \|
612	\| +-->[takeSnapshot()] -------------------> Saving ------+
613	+-> Aborted -----+
614
615	+-> PoweredOff --+
616	\| \|
617	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
618	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
619	+-> Saved -------+ \|
620	\| \|
621	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
622	</pre>
623
624	Note that the Saving state is present in both the offline state group and
625	online state group. Currently, the only way to determine what group is
626	assumed in a particular case is to remember the previous machine state: if
627	it was Running or Paused, then Saving is an online state, otherwise it is
628	an offline state. This inconsistency may be removed in one of the future
629	versions of VirtualBox by adding a new state.
630
631	<note internal="yes">
632	For whoever decides to touch this enum: In order to keep the
633	comparisons involving FirstOnline and LastOnline pseudo-states valid,
634	the numeric values of these states must be correspondingly updated if
635	needed: for any online VM state, the condition
636	<tt>FirstOnline <= state <= LastOnline</tt> must be
637	@c true. The same relates to transient states for which
638	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
639	@c true.
640	</note>
641	</desc>
642
643	<const name="Null" value="0">
644	<desc>Null value (never used by the API).</desc>
645	</const>
646	<const name="PoweredOff" value="1">
647	<desc>
648	The machine is not running and has no saved execution state; it has
649	either never been started or been shut down successfully.
650	</desc>
651	</const>
652	<const name="Saved" value="2">
653	<desc>
654	The machine is not currently running, but the execution state of the machine
655	has been saved to an external file when it was running, from where
656	it can be resumed.
657	</desc>
658	</const>
659	<const name="Teleported" value="3">
660	<desc>
661	The machine was teleported to a different host (or process) and then
662	powered off. Take care when powering it on again may corrupt resources
663	it shares with the teleportation target (e.g. disk and network).
664	</desc>
665	</const>
666	<const name="Aborted" value="4">
667	<desc>
668	The process running the machine has terminated abnormally. This may
669	indicate a crash of the VM process in host execution context, or
670	the VM process has been terminated externally.
671	</desc>
672	</const>
673	<const name="Running" value="5">
674	<desc>
675	The machine is currently being executed.
676	<note internal="yes">
677	For whoever decides to touch this enum: In order to keep the
678	comparisons in the old source code valid, this state must immediately
679	precede the Paused state.
680	TODO: Lift this spectacularly wonderful restriction.
681	</note>
682	</desc>
683	</const>
684	<const name="Paused" value="6">
685	<desc>
686	Execution of the machine has been paused.
687	<note internal="yes">
688	For whoever decides to touch this enum: In order to keep the
689	comparisons in the old source code valid, this state must immediately
690	follow the Running state.
691	TODO: Lift this spectacularly wonderful restriction.
692	</note>
693	</desc>
694	</const>
695	<const name="Stuck" value="7">
696	<desc>
697	Execution of the machine has reached the "Guru Meditation"
698	condition. This indicates a severe error in the hypervisor itself.
699	<note internal="yes">
700	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
701	"Guru", perhaps? Or are there some other VMM states that are
702	intended to be lumped in here as well?
703	</note>
704	</desc>
705	</const>
706	<const name="Teleporting" value="8">
707	<desc>
708	The machine is about to be teleported to a different host or process.
709	It is possible to pause a machine in this state, but it will go to the
710	@c TeleportingPausedVM state and it will not be
711	possible to resume it again unless the teleportation fails.
712	</desc>
713	</const>
714	<const name="LiveSnapshotting" value="9">
715	<desc>
716	A live snapshot is being taken. The machine is running normally, but
717	some of the runtime configuration options are inaccessible. Also, if
718	paused while in this state it will transition to
719	@c Saving and it will not be resume the
720	execution until the snapshot operation has completed.
721	</desc>
722	</const>
723	<const name="Starting" value="10">
724	<desc>
725	Machine is being started after powering it on from a
726	zero execution state.
727	</desc>
728	</const>
729	<const name="Stopping" value="11">
730	<desc>
731	Machine is being normally stopped powering it off, or after the guest OS
732	has initiated a shutdown sequence.
733	</desc>
734	</const>
735	<const name="Saving" value="12">
736	<desc>
737	Machine is saving its execution state to a file, or an online
738	snapshot of the machine is being taken.
739	</desc>
740	</const>
741	<const name="Restoring" value="13">
742	<desc>
743	Execution state of the machine is being restored from a file
744	after powering it on from the saved execution state.
745	</desc>
746	</const>
747	<const name="TeleportingPausedVM" value="14">
748	<desc>
749	The machine is being teleported to another host or process, but it is
750	not running. This is the paused variant of the
751	@c state.
752	</desc>
753	</const>
754	<const name="TeleportingIn" value="15">
755	<desc>
756	Teleporting the machine state in from another host or process.
757	</desc>
758	</const>
759	<const name="FaultTolerantSyncing" value="16">
760	<desc>
761	The machine is being synced with a fault tolerant VM running elsewhere.
762	</desc>
763	</const>
764	<const name="DeletingSnapshotOnline" value="17">
765	<desc>
766	Like @c DeletingSnapshot, but the merging of media is ongoing in
767	the background while the machine is running.
768	</desc>
769	</const>
770	<const name="DeletingSnapshotPaused" value="18">
771	<desc>
772	Like @c DeletingSnapshotOnline, but the machine was paused when the
773	merging of differencing media was started.
774	</desc>
775	</const>
776	<const name="RestoringSnapshot" value="19">
777	<desc>
778	A machine snapshot is being restored; this typically does not take long.
779	</desc>
780	</const>
781	<const name="DeletingSnapshot" value="20">
782	<desc>
783	A machine snapshot is being deleted; this can take a long time since this
784	may require merging differencing media. This value indicates that the
785	machine is not running while the snapshot is being deleted.
786	</desc>
787	</const>
788	<const name="SettingUp" value="21">
789	<desc>
790	Lengthy setup operation is in progress.
791	</desc>
792	</const>
793
794	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
795	<desc>
796	Pseudo-state: first online state (for use in relational expressions).
797	</desc>
798	</const>
799	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
800	<desc>
801	Pseudo-state: last online state (for use in relational expressions).
802	</desc>
803	</const>
804
805	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
806	<desc>
807	Pseudo-state: first transient state (for use in relational expressions).
808	</desc>
809	</const>
810	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
811	<desc>
812	Pseudo-state: last transient state (for use in relational expressions).
813	</desc>
814	</const>
815
816	</enum>
817
818	<enum
819	name="SessionState"
820	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
821	>
822	<desc>
823	Session state. This enumeration represents possible values of
824	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
825	attributes.
826	</desc>
827
828	<const name="Null" value="0">
829	<desc>Null value (never used by the API).</desc>
830	</const>
831	<const name="Unlocked" value="1">
832	<desc>
833	In <link to="IMachine::sessionState"/>, this means that the machine
834	is not locked for any sessions.
835
836	In <link to="ISession::state"/>, this means that no machine is
837	currently locked for this session.
838	</desc>
839	</const>
840	<const name="Locked" value="2">
841	<desc>
842	In <link to="IMachine::sessionState"/>, this means that the machine
843	is currently locked for a session, whose process identifier can
844	then be found in the <link to="IMachine::sessionPid" /> attribute.
845
846	In <link to="ISession::state"/>, this means that a machine is
847	currently locked for this session, and the mutable machine object
848	can be found in the <link to="ISession::machine"/> attribute
849	(see <link to="IMachine::lockMachine" /> for details).
850	</desc>
851	</const>
852	<const name="Spawning" value="3">
853	<desc>
854	A new process is being spawned for the machine as a result of
855	<link to="IMachine::launchVMProcess"/> call. This state also occurs
856	as a short transient state during an <link to="IMachine::lockMachine"/>
857	call.
858	</desc>
859	</const>
860	<const name="Unlocking" value="4">
861	<desc>
862	The session is being unlocked.
863	</desc>
864	</const>
865	</enum>
866
867	<enum
868	name="CPUPropertyType"
869	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
870	>
871	<desc>
872	Virtual CPU property type. This enumeration represents possible values of the
873	IMachine get- and setCPUProperty methods.
874	</desc>
875	<const name="Null" value="0">
876	<desc>Null value (never used by the API).</desc>
877	</const>
878	<const name="PAE" value="1">
879	<desc>
880	This setting determines whether VirtualBox will expose the Physical Address
881	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
882	is not available, it will not be reported.
883	</desc>
884	</const>
885	<const name="Synthetic" value="2">
886	<desc>
887	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
888	teleporting between host systems that differ significantly.
889	</desc>
890	</const>
891	</enum>
892
893
894	<enum
895	name="HWVirtExPropertyType"
896	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
897	>
898	<desc>
899	Hardware virtualization property type. This enumeration represents possible values
900	for the <link to="IMachine::getHWVirtExProperty"/> and
901	<link to="IMachine::setHWVirtExProperty"/> methods.
902	</desc>
903	<const name="Null" value="0">
904	<desc>Null value (never used by the API).</desc>
905	</const>
906	<const name="Enabled" value="1">
907	<desc>
908	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
909	such extensions are not available, they will not be used.
910	</desc>
911	</const>
912	<const name="Exclusive" value="2">
913	<desc>
914	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
915	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
916	feature of the host. To share these with other hypervisors, you must disable this property.
917	</desc>
918	</const>
919	<const name="VPID" value="3">
920	<desc>
921	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
922	</desc>
923	</const>
924	<const name="NestedPaging" value="4">
925	<desc>
926	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
927	</desc>
928	</const>
929	<const name="LargePages" value="5">
930	<desc>
931	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
932	</desc>
933	</const>
934	<const name="Force" value="6">
935	<desc>
936	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
937	not set, there will be an automatic fallback to software virtualization.
938	</desc>
939	</const>
940	</enum>
941
942	<enum
943	name="FaultToleranceState"
944	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
945	>
946	<desc>
947	Used with <link to="IMachine::faultToleranceState" />.
948	</desc>
949	<const name="Inactive" value="1">
950	<desc>No fault tolerance enabled.</desc>
951	</const>
952	<const name="Master" value="2">
953	<desc>Fault tolerant master VM.</desc>
954	</const>
955	<const name="Standby" value="3">
956	<desc>Fault tolerant standby VM.</desc>
957	</const>
958	</enum>
959
960	<enum
961	name="LockType"
962	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
963	>
964	<desc>
965	Used with <link to="IMachine::lockMachine" />.
966	</desc>
967	<const name="Write" value="2">
968	<desc>Lock the machine for writing.</desc>
969	</const>
970	<const name="Shared" value="1">
971	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
972	</const>
973	</enum>
974
975	<enum
976	name="SessionType"
977	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
978	>
979	<desc>
980	Session type. This enumeration represents possible values of the
981	<link to="ISession::type"/> attribute.
982	</desc>
983
984	<const name="Null" value="0">
985	<desc>Null value (never used by the API).</desc>
986	</const>
987	<const name="WriteLock" value="1">
988	<desc>
989	Session has acquired an exclusive write lock on a machine
990	using <link to="IMachine::lockMachine"/>.
991	</desc>
992	</const>
993	<const name="Remote" value="2">
994	<desc>
995	Session has launched a VM process using
996	<link to="IMachine::launchVMProcess"/>
997	</desc>
998	</const>
999	<const name="Shared" value="3">
1000	<desc>
1001	Session has obtained a link to another session using
1002	<link to="IMachine::lockMachine"/>
1003	</desc>
1004	</const>
1005	</enum>
1006
1007	<enum
1008	name="DeviceType"
1009	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1010	>
1011	<desc>
1012	Device type.
1013	</desc>
1014	<const name="Null" value="0">
1015	<desc>
1016	Null value, may also mean "no device" (not allowed for
1017	<link to="IConsole::getDeviceActivity"/>).
1018	</desc>
1019	</const>
1020	<const name="Floppy" value="1">
1021	<desc>Floppy device.</desc>
1022	</const>
1023	<const name="DVD" value="2">
1024	<desc>CD/DVD-ROM device.</desc>
1025	</const>
1026	<const name="HardDisk" value="3">
1027	<desc>Hard disk device.</desc>
1028	</const>
1029	<const name="Network" value="4">
1030	<desc>Network device.</desc>
1031	</const>
1032	<const name="USB" value="5">
1033	<desc>USB device.</desc>
1034	</const>
1035	<const name="SharedFolder" value="6">
1036	<desc>Shared folder device.</desc>
1037	</const>
1038	</enum>
1039
1040	<enum
1041	name="DeviceActivity"
1042	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1043	>
1044	<desc>
1045	Device activity for <link to="IConsole::getDeviceActivity"/>.
1046	</desc>
1047
1048	<const name="Null" value="0"/>
1049	<const name="Idle" value="1"/>
1050	<const name="Reading" value="2"/>
1051	<const name="Writing" value="3"/>
1052	</enum>
1053
1054	<enum
1055	name="ClipboardMode"
1056	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1057	>
1058	<desc>
1059	Host-Guest clipboard interchange mode.
1060	</desc>
1061
1062	<const name="Disabled" value="0"/>
1063	<const name="HostToGuest" value="1"/>
1064	<const name="GuestToHost" value="2"/>
1065	<const name="Bidirectional" value="3"/>
1066	</enum>
1067
1068	<enum
1069	name="Scope"
1070	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1071	>
1072	<desc>
1073	Scope of the operation.
1074
1075	A generic enumeration used in various methods to define the action or
1076	argument scope.
1077	</desc>
1078
1079	<const name="Global" value="0"/>
1080	<const name="Machine" value="1"/>
1081	<const name="Session" value="2"/>
1082	</enum>
1083
1084	<enum
1085	name="BIOSBootMenuMode"
1086	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1087	>
1088	<desc>
1089	BIOS boot menu mode.
1090	</desc>
1091
1092	<const name="Disabled" value="0"/>
1093	<const name="MenuOnly" value="1"/>
1094	<const name="MessageAndMenu" value="2"/>
1095	</enum>
1096
1097	<enum
1098	name="ProcessorFeature"
1099	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1100	>
1101	<desc>
1102	CPU features.
1103	</desc>
1104
1105	<const name="HWVirtEx" value="0"/>
1106	<const name="PAE" value="1"/>
1107	<const name="LongMode" value="2"/>
1108	<const name="NestedPaging" value="3"/>
1109	</enum>
1110
1111	<enum
1112	name="FirmwareType"
1113	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1114	>
1115	<desc>
1116	Firmware type.
1117	</desc>
1118	<const name="BIOS" value="1">
1119	<desc>BIOS Firmware.</desc>
1120	</const>
1121	<const name="EFI" value="2">
1122	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1123	</const>
1124	<const name="EFI32" value="3">
1125	<desc>Efi firmware, 32-bit.</desc>
1126	</const>
1127	<const name="EFI64" value="4">
1128	<desc>Efi firmware, 64-bit.</desc>
1129	</const>
1130	<const name="EFIDUAL" value="5">
1131	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1132	</const>
1133	</enum>
1134
1135	<enum
1136	name="PointingHidType"
1137	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1138	>
1139	<desc>
1140	Type of pointing device used in a virtual machine.
1141	</desc>
1142	<const name="None" value="1">
1143	<desc>No mouse.</desc>
1144	</const>
1145	<const name="PS2Mouse" value="2">
1146	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1147	</const>
1148	<const name="USBMouse" value="3">
1149	<desc>USB mouse (relative pointer).</desc>
1150	</const>
1151	<const name="USBTablet" value="4">
1152	<desc>USB tablet (absolute pointer).</desc>
1153	</const>
1154	<const name="ComboMouse" value="5">
1155	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1156	Using of such device can have negative performance implications. </desc>
1157	</const>
1158	</enum>
1159
1160	<enum
1161	name="KeyboardHidType"
1162	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1163	>
1164	<desc>
1165	Type of keyboard device used in a virtual machine.
1166	</desc>
1167	<const name="None" value="1">
1168	<desc>No keyboard.</desc>
1169	</const>
1170	<const name="PS2Keyboard" value="2">
1171	<desc>PS/2 keyboard.</desc>
1172	</const>
1173	<const name="USBKeyboard" value="3">
1174	<desc>USB keyboard.</desc>
1175	</const>
1176	<const name="ComboKeyboard" value="4">
1177	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1178	Using of such device can have negative performance implications. </desc>
1179	</const>
1180	</enum>
1181
1182	<!--
1183	// IVirtualBoxErrorInfo
1184	/////////////////////////////////////////////////////////////////////////
1185	-->
1186
1187	<interface
1188	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1189	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1190	supportsErrorInfo="no"
1191	wsmap="managed"
1192	>
1193	<desc>
1194	The IVirtualBoxErrorInfo interface represents extended error information.
1195
1196	Extended error information can be set by VirtualBox components after
1197	unsuccessful or partially successful method invocation. This information
1198	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1199	and then shown to the client in addition to the plain 32-bit result code.
1200
1201	In MS COM, this interface extends the IErrorInfo interface,
1202	in XPCOM, it extends the nsIException interface. In both cases,
1203	it provides a set of common attributes to retrieve error
1204	information.
1205
1206	Sometimes invocation of some component's method may involve methods of
1207	other components that may also fail (independently of this method's
1208	failure), or a series of non-fatal errors may precede a fatal error that
1209	causes method failure. In cases like that, it may be desirable to preserve
1210	information about all errors happened during method invocation and deliver
1211	it to the caller. The <link to="#next"/> attribute is intended
1212	specifically for this purpose and allows to represent a chain of errors
1213	through a single IVirtualBoxErrorInfo object set after method invocation.
1214
1215	<note>errors are stored to a chain in the reverse order, i.e. the
1216	initial error object you query right after method invocation is the last
1217	error set by the callee, the object it points to in the @a next attribute
1218	is the previous error and so on, up to the first error (which is the last
1219	in the chain).</note>
1220	</desc>
1221
1222	<attribute name="resultCode" type="long" readonly="yes">
1223	<desc>
1224	Result code of the error.
1225	Usually, it will be the same as the result code returned
1226	by the method that provided this error information, but not
1227	always. For example, on Win32, CoCreateInstance() will most
1228	likely return E_NOINTERFACE upon unsuccessful component
1229	instantiation attempt, but not the value the component factory
1230	returned. Value is typed 'long', not 'result',
1231	to make interface usable from scripting languages.
1232	<note>
1233	In MS COM, there is no equivalent.
1234	In XPCOM, it is the same as nsIException::result.
1235	</note>
1236	</desc>
1237	</attribute>
1238
1239	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1240	<desc>
1241	UUID of the interface that defined the error.
1242	<note>
1243	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1244	data type.
1245	In XPCOM, there is no equivalent.
1246	</note>
1247	</desc>
1248	</attribute>
1249
1250	<attribute name="component" type="wstring" readonly="yes">
1251	<desc>
1252	Name of the component that generated the error.
1253	<note>
1254	In MS COM, it is the same as IErrorInfo::GetSource.
1255	In XPCOM, there is no equivalent.
1256	</note>
1257	</desc>
1258	</attribute>
1259
1260	<attribute name="text" type="wstring" readonly="yes">
1261	<desc>
1262	Text description of the error.
1263	<note>
1264	In MS COM, it is the same as IErrorInfo::GetDescription.
1265	In XPCOM, it is the same as nsIException::message.
1266	</note>
1267	</desc>
1268	</attribute>
1269
1270	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1271	<desc>
1272	Next error object if there is any, or @c null otherwise.
1273	<note>
1274	In MS COM, there is no equivalent.
1275	In XPCOM, it is the same as nsIException::inner.
1276	</note>
1277	</desc>
1278	</attribute>
1279
1280	</interface>
1281
1282	<!--
1283	// IVirtualBox
1284	/////////////////////////////////////////////////////////////////////////
1285	-->
1286
1287	<interface
1288	name="IDHCPServer" extends="$unknown"
1289	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1290	wsmap="managed"
1291	>
1292	<desc>
1293	The IDHCPServer interface represents the vbox dhcp server configuration.
1294
1295	To enumerate all the dhcp servers on the host, use the
1296	<link to="IVirtualBox::DHCPServers"/> attribute.
1297	</desc>
1298
1299	<attribute name="enabled" type="boolean">
1300	<desc>
1301	specifies if the dhcp server is enabled
1302	</desc>
1303	</attribute>
1304
1305	<attribute name="IPAddress" type="wstring" readonly="yes">
1306	<desc>
1307	specifies server IP
1308	</desc>
1309	</attribute>
1310
1311	<attribute name="networkMask" type="wstring" readonly="yes">
1312	<desc>
1313	specifies server network mask
1314	</desc>
1315	</attribute>
1316
1317	<attribute name="networkName" type="wstring" readonly="yes">
1318	<desc>
1319	specifies internal network name the server is used for
1320	</desc>
1321	</attribute>
1322
1323	<attribute name="lowerIP" type="wstring" readonly="yes">
1324	<desc>
1325	specifies from IP address in server address range
1326	</desc>
1327	</attribute>
1328
1329	<attribute name="upperIP" type="wstring" readonly="yes">
1330	<desc>
1331	specifies to IP address in server address range
1332	</desc>
1333	</attribute>
1334
1335	<method name="setConfiguration">
1336	<desc>
1337	configures the server
1338	<result name="E_INVALIDARG">
1339	invalid configuration supplied
1340	</result>
1341	</desc>
1342	<param name="IPAddress" type="wstring" dir="in">
1343	<desc>
1344	server IP address
1345	</desc>
1346	</param>
1347	<param name="networkMask" type="wstring" dir="in">
1348	<desc>
1349	server network mask
1350	</desc>
1351	</param>
1352	<param name="FromIPAddress" type="wstring" dir="in">
1353	<desc>
1354	server From IP address for address range
1355	</desc>
1356	</param>
1357	<param name="ToIPAddress" type="wstring" dir="in">
1358	<desc>
1359	server To IP address for address range
1360	</desc>
1361	</param>
1362	</method>
1363
1364	<method name="start">
1365	<desc>
1366	Starts DHCP server process.
1367	<result name="E_FAIL">
1368	Failed to start the process.
1369	</result>
1370	</desc>
1371	<param name="networkName" type="wstring" dir="in">
1372	<desc>
1373	Name of internal network DHCP server should attach to.
1374	</desc>
1375	</param>
1376	<param name="trunkName" type="wstring" dir="in">
1377	<desc>
1378	Name of internal network trunk.
1379	</desc>
1380	</param>
1381	<param name="trunkType" type="wstring" dir="in">
1382	<desc>
1383	Type of internal network trunk.
1384	</desc>
1385	</param>
1386	</method>
1387
1388	<method name="stop">
1389	<desc>
1390	Stops DHCP server process.
1391	<result name="E_FAIL">
1392	Failed to stop the process.
1393	</result>
1394	</desc>
1395	</method>
1396	</interface>
1397
1398	<interface
1399	name="IVirtualBox" extends="$unknown"
1400	uuid="8bf22775-a3c1-4f81-80d3-138584474fb3"
1401	wsmap="managed"
1402	>
1403	<desc>
1404	The IVirtualBox interface represents the main interface exposed by the
1405	product that provides virtual machine management.
1406
1407	An instance of IVirtualBox is required for the product to do anything
1408	useful. Even though the interface does not expose this, internally,
1409	IVirtualBox is implemented as a singleton and actually lives in the
1410	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1411	IVirtualBox can track the state of all virtual machines on a particular
1412	host, regardless of which frontend started them.
1413
1414	To enumerate all the virtual machines on the host, use the
1415	<link to="IVirtualBox::machines"/> attribute.
1416	</desc>
1417
1418	<attribute name="version" type="wstring" readonly="yes">
1419	<desc>
1420	A string representing the version number of the product. The
1421	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1422	last number represents the build number and will frequently change.
1423
1424	This may be followed by a _ALPHA[0-9], _BETA[0-9] or _RC[0-9]* tag
1425	in prerelease builds. Non-Oracle builds may (/shall) also have a
1426	publisher tag, at the end. The publisher tag starts with an underscore
1427	just like the prerelease build type tag.
1428	</desc>
1429	</attribute>
1430
1431	<attribute name="revision" type="unsigned long" readonly="yes">
1432	<desc>
1433	The internal build revision number of the product.
1434	</desc>
1435	</attribute>
1436
1437	<attribute name="packageType" type="wstring" readonly="yes">
1438	<desc>
1439	A string representing the package type of this product. The
1440	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1441	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1442	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1443	this.
1444	</desc>
1445	</attribute>
1446
1447	<attribute name="APIVersion" type="wstring" readonly="yes">
1448	<desc>
1449	A string representing the VirtualBox API version number. The format is
1450	2 integer numbers divided by an underscore (e.g. 1_0). After the
1451	first public release of packages with a particular API version the
1452	API will not be changed in an incompatible way. Note that this
1453	guarantee does not apply to development builds, and also there is no
1454	guarantee that this version is identical to the first two integer
1455	numbers of the package version.
1456	</desc>
1457	</attribute>
1458
1459	<attribute name="homeFolder" type="wstring" readonly="yes">
1460	<desc>
1461	Full path to the directory where the global settings file,
1462	<tt>VirtualBox.xml</tt>, is stored.
1463
1464	In this version of VirtualBox, the value of this property is
1465	always <tt><user_dir>/.VirtualBox</tt> (where
1466	<tt><user_dir></tt> is the path to the user directory,
1467	as determined by the host OS), and cannot be changed.
1468
1469	This path is also used as the base to resolve relative paths in
1470	places where relative paths are allowed (unless otherwise
1471	expressly indicated).
1472	</desc>
1473	</attribute>
1474
1475	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1476	<desc>
1477	Full name of the global settings file.
1478	The value of this property corresponds to the value of
1479	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1480	</desc>
1481	</attribute>
1482
1483	<attribute name="host" type="IHost" readonly="yes">
1484	<desc>Associated host object.</desc>
1485	</attribute>
1486
1487	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1488	<desc>Associated system information object.</desc>
1489	</attribute>
1490
1491	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1492	<desc>
1493	Array of machine objects registered within this VirtualBox instance.
1494	</desc>
1495	</attribute>
1496
1497	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1498	<desc>
1499	Array of medium objects known to this VirtualBox installation.
1500
1501	This array contains only base media. All differencing
1502	media of the given base medium can be enumerated using
1503	<link to="IMedium::children"/>.
1504	</desc>
1505	</attribute>
1506
1507	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1508	<desc>
1509	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1510	</desc>
1511	</attribute>
1512
1513	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1514	<desc>
1515	Array of floppy image objects currently in use by this VirtualBox instance.
1516	</desc>
1517	</attribute>
1518
1519	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1520
1521	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1522
1523	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1524	<desc>
1525	Collection of global shared folders. Global shared folders are
1526	available to all virtual machines.
1527
1528	New shared folders are added to the collection using
1529	<link to="#createSharedFolder"/>. Existing shared folders can be
1530	removed using <link to="#removeSharedFolder"/>.
1531
1532	<note>
1533	In the current version of the product, global shared folders are not
1534	implemented and therefore this collection is always empty.
1535	</note>
1536	</desc>
1537	</attribute>
1538
1539	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1540	<desc>
1541	Associated performance collector object.
1542	</desc>
1543	</attribute>
1544
1545	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1546	<desc>
1547	DHCP servers.
1548	</desc>
1549	</attribute>
1550
1551	<attribute name="eventSource" type="IEventSource" readonly="yes">
1552	<desc>
1553	Event source for VirtualBox events.
1554	</desc>
1555	</attribute>
1556
1557	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1558	<desc>
1559	The extension pack manager.
1560	</desc>
1561	</attribute>
1562
1563
1564	<attribute name="internalNetworks" type="wstring" safearray="yes" readonly="yes">
1565	<desc>
1566	Names of all internal networks.
1567	</desc>
1568	</attribute>
1569
1570	<attribute name="genericNetworkDrivers" type="wstring" safearray="yes" readonly="yes">
1571	<desc>
1572	Names of all generic network drivers.
1573	</desc>
1574	</attribute>
1575
1576	<method name="composeMachineFilename">
1577	<desc>
1578	Returns a recommended full path of the settings file name for a new virtual
1579	machine.
1580
1581	This API serves two purposes:
1582
1583	<ul>
1584	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1585	for the @a settingsFile argument there, which means that API should use
1586	a recommended default file name.</li>
1587
1588	<li>It can be called manually by a client software before creating a machine,
1589	e.g. if that client wants to pre-create the machine directory to create
1590	virtual hard disks in that directory together with the new machine
1591	settings file. In that case, the file name should be stripped from the
1592	full settings file path returned by this function to obtain the
1593	machine directory.</li>
1594	</ul>
1595
1596	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1597	details about the machine name.
1598
1599	If @a baseFolder is a @c null or empty string (which is recommended), the
1600	default machine settings folder
1601	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1602	a base folder for the created machine, resulting in a file name like
1603	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1604	will be used.
1605
1606	This method does not access the host disks. In particular, it does not check
1607	for whether a machine of this name already exists.
1608	</desc>
1609	<param name="name" type="wstring" dir="in">
1610	<desc>Suggested machine name.</desc>
1611	</param>
1612	<param name="baseFolder" type="wstring" dir="in">
1613	<desc>Base machine folder (optional).</desc>
1614	</param>
1615	<param name="file" type="wstring" dir="return">
1616	<desc>Fully qualified path where the machine would be created.</desc>
1617	</param>
1618	</method>
1619
1620	<method name="createMachine">
1621	<desc>
1622	Creates a new virtual machine by creating a machine settings file at
1623	the given location.
1624
1625	VirtualBox machine settings files use a custom XML dialect. Starting
1626	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1627	and machine files can be created at arbitrary locations.
1628
1629	However, it is is recommended that machines be created in the default
1630	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1631	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1632	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1633	is called automatically to have such a recommended name composed based
1634	on the machine name given in the @a name argument.
1635
1636	If the resulting settings file already exists, this method will fail,
1637	unless @a forceOverwrite is set.
1638
1639	The new machine is created unregistered, with the initial configuration
1640	set according to the specified guest OS type. A typical sequence of
1641	actions to create a new virtual machine is as follows:
1642
1643	<ol>
1644	<li>
1645	Call this method to have a new machine created. The returned machine
1646	object will be "mutable" allowing to change any machine property.
1647	</li>
1648
1649	<li>
1650	Configure the machine using the appropriate attributes and methods.
1651	</li>
1652
1653	<li>
1654	Call <link to="IMachine::saveSettings" /> to write the settings
1655	to the machine's XML settings file. The configuration of the newly
1656	created machine will not be saved to disk until this method is
1657	called.
1658	</li>
1659
1660	<li>
1661	Call <link to="#registerMachine" /> to add the machine to the list
1662	of machines known to VirtualBox.
1663	</li>
1664	</ol>
1665
1666	The specified guest OS type identifier must match an ID of one of known
1667	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1668	array.
1669
1670	Optionally, you may specify an UUID of to assign to the created machine.
1671	However, this is not recommended and you should normally pass an empty
1672	(@c null) UUID to this method so that a new UUID will be automatically
1673	generated for every created machine. You can use UUID
1674	00000000-0000-0000-0000-000000000000 as @c null value.
1675
1676	<note>
1677	There is no way to change the name of the settings file or
1678	subfolder of the created machine directly.
1679	</note>
1680
1681	<result name="VBOX_E_OBJECT_NOT_FOUND">
1682	@a osTypeId is invalid.
1683	</result>
1684	<result name="VBOX_E_FILE_ERROR">
1685	Resulting settings file name is invalid or the settings file already
1686	exists or could not be created due to an I/O error.
1687	</result>
1688	<result name="E_INVALIDARG">
1689	@a name is empty or @c null.
1690	</result>
1691	</desc>
1692
1693	<param name="settingsFile" type="wstring" dir="in">
1694	<desc>Fully qualified path where the settings file should be created,
1695	or NULL for a default folder and file based on the @a name argument
1696	(see <link to="#composeMachineFilename" />).</desc>
1697	</param>
1698	<param name="name" type="wstring" dir="in">
1699	<desc>Machine name.</desc>
1700	</param>
1701	<param name="osTypeId" type="wstring" dir="in">
1702	<desc>Guest OS Type ID.</desc>
1703	</param>
1704	<param name="id" type="uuid" mod="string" dir="in">
1705	<desc>Machine UUID (optional).</desc>
1706	</param>
1707	<param name="forceOverwrite" type="boolean" dir="in">
1708	<desc>If true, an existing machine settings file will be overwritten.</desc>
1709	</param>
1710	<param name="machine" type="IMachine" dir="return">
1711	<desc>Created machine object.</desc>
1712	</param>
1713	</method>
1714
1715	<method name="openMachine">
1716	<desc>
1717	Opens a virtual machine from the existing settings file.
1718	The opened machine remains unregistered until you call
1719	<link to="#registerMachine"/>.
1720
1721	The specified settings file name must be fully qualified.
1722	The file must exist and be a valid machine XML settings file
1723	whose contents will be used to construct the machine object.
1724
1725	<result name="VBOX_E_FILE_ERROR">
1726	Settings file name invalid, not found or sharing violation.
1727	</result>
1728	</desc>
1729	<param name="settingsFile" type="wstring" dir="in">
1730	<desc>
1731	Name of the machine settings file.
1732	</desc>
1733	</param>
1734	<param name="machine" type="IMachine" dir="return">
1735	<desc>Opened machine object.</desc>
1736	</param>
1737	<note>
1738	<link to="IMachine::settingsModified"/> will return
1739	@c false for the created machine, until any of machine settings
1740	are changed.
1741	</note>
1742	</method>
1743
1744	<method name="registerMachine">
1745	<desc>
1746
1747	Registers the machine previously created using
1748	<link to="#createMachine"/> or opened using
1749	<link to="#openMachine"/> within this VirtualBox installation. After
1750	successful method invocation, the
1751	<link to="IMachineRegisteredEvent"/> event is fired.
1752
1753	<note>
1754	This method implicitly calls <link to="IMachine::saveSettings"/>
1755	to save all current machine settings before registering it.
1756	</note>
1757
1758	<result name="VBOX_E_OBJECT_NOT_FOUND">
1759	No matching virtual machine found.
1760	</result>
1761	<result name="VBOX_E_INVALID_OBJECT_STATE">
1762	Virtual machine was not created within this VirtualBox instance.
1763	</result>
1764
1765	</desc>
1766	<param name="machine" type="IMachine" dir="in"/>
1767	</method>
1768
1769	<method name="findMachine">
1770	<desc>
1771	Attempts to find a virtual machine given its name or UUID.
1772
1773	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1774	cannot safely be determined.</note>
1775
1776	<result name="VBOX_E_OBJECT_NOT_FOUND">
1777	Could not find registered machine matching @a nameOrId.
1778	</result>
1779
1780	</desc>
1781	<param name="nameOrId" type="wstring" dir="in">
1782	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1783	</param>
1784	<param name="machine" type="IMachine" dir="return">
1785	<desc>Machine object, if found.</desc>
1786	</param>
1787	</method>
1788
1789	<method name="getMachineStates">
1790	<desc>
1791	Gets the state of several machines in a single operation.
1792	</desc>
1793	<param name="machines" type="IMachine" dir="in" safearray="yes">
1794	<desc>Array with the machine references.</desc>
1795	</param>
1796	<param name="states" type="MachineState" dir="return" safearray="yes">
1797	<desc>Machine states, corresponding to the machines.</desc>
1798	</param>
1799	</method>
1800
1801	<method name="createAppliance">
1802	<desc>
1803	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1804	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1805	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1806	</desc>
1807	<param name="appliance" type="IAppliance" dir="return">
1808	<desc>New appliance.</desc>
1809	</param>
1810	</method>
1811
1812	<method name="createHardDisk">
1813	<desc>
1814	Creates a new base medium object that will use the given storage
1815	format and location for medium data.
1816
1817	The actual storage unit is not created by this method. In order to
1818	do it, and before you are able to attach the created medium to
1819	virtual machines, you must call one of the following methods to
1820	allocate a format-specific storage unit at the specified location:
1821	<ul>
1822	<li><link to="IMedium::createBaseStorage"/></li>
1823	<li><link to="IMedium::createDiffStorage"/></li>
1824	</ul>
1825
1826	Some medium attributes, such as <link to="IMedium::id"/>, may
1827	remain uninitialized until the medium storage unit is successfully
1828	created by one of the above methods.
1829
1830	After the storage unit is successfully created, it will be
1831	accessible through the <link to="#findMedium"/> method and can
1832	be found in the <link to="#hardDisks"/> array.
1833
1834	The list of all storage formats supported by this VirtualBox
1835	installation can be obtained using
1836	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1837	attribute is empty or @c null then the default storage format
1838	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1839	be used for creating a storage unit of the medium.
1840
1841	Note that the format of the location string is storage format specific.
1842	See <link to="IMedium::location"/> and IMedium for more details.
1843
1844	<result name="VBOX_E_OBJECT_NOT_FOUND">
1845	@a format identifier is invalid. See
1846	<link to="ISystemProperties::mediumFormats"/>.
1847	</result>
1848	<result name="VBOX_E_FILE_ERROR">
1849	@a location is a not valid file name (for file-based formats only).
1850	</result>
1851	</desc>
1852	<param name="format" type="wstring" dir="in">
1853	<desc>
1854	Identifier of the storage format to use for the new medium.
1855	</desc>
1856	</param>
1857	<param name="location" type="wstring" dir="in">
1858	<desc>
1859	Location of the storage unit for the new medium.
1860	</desc>
1861	</param>
1862	<param name="medium" type="IMedium" dir="return">
1863	<desc>Created medium object.</desc>
1864	</param>
1865	</method>
1866
1867	<method name="openMedium">
1868	<desc>
1869	Opens a medium from an existing storage location.
1870
1871	Once a medium has been opened, it can be passed to other VirtualBox
1872	methods, in particular to <link to="IMachine::attachDevice" />.
1873
1874	Depending on the given device type, the file at the storage location
1875	must be in one of the media formats understood by VirtualBox:
1876
1877	<ul>
1878	<li>With a "HardDisk" device type, the file must be a hard disk image
1879	in one of the formats supported by VirtualBox (see
1880	<link to="ISystemProperties::mediumFormats" />).
1881	After this method succeeds, if the medium is a base medium, it
1882	will be added to the <link to="#hardDisks"/> array attribute. </li>
1883	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1884	After this method succeeds, the medium will be added to the
1885	<link to="#DVDImages"/> array attribute.</li>
1886	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1887	After this method succeeds, the medium will be added to the
1888	<link to="#floppyImages"/> array attribute.</li>
1889	</ul>
1890
1891	After having been opened, the medium can be found by the <link to="#findMedium"/>
1892	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1893
1894	The UUID of the newly opened medium will either be retrieved from the
1895	storage location, if the format supports it (e.g. for hard disk images),
1896	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1897	If for some reason you need to change the medium's UUID, use
1898	<link to="IMedium::setIDs" />.
1899
1900	If a differencing hard disk medium is to be opened by this method, the
1901	operation will succeed only if its parent medium and all ancestors,
1902	if any, are already known to this VirtualBox installation (for example,
1903	were opened by this method before).
1904
1905	This method attempts to guess the storage format of the specified medium
1906	by reading medium data at the specified location.
1907
1908	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1909	the image is opened for read/write access and must have according permissions,
1910	as VirtualBox may actually write status information into the disk's metadata
1911	sections.
1912
1913	Note that write access is required for all typical hard disk usage in VirtualBox,
1914	since VirtualBox may need to write metadata such as a UUID into the image.
1915	The only exception is opening a source image temporarily for copying and
1916	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1917	again soon.
1918
1919	The format of the location string is storage format specific. See
1920	<link to="IMedium::location"/> and IMedium for more details.
1921
1922	<result name="VBOX_E_FILE_ERROR">
1923	Invalid medium storage file location or could not find the medium
1924	at the specified location.
1925	</result>
1926	<result name="VBOX_E_IPRT_ERROR">
1927	Could not get medium storage format.
1928	</result>
1929	<result name="E_INVALIDARG">
1930	Invalid medium storage format.
1931	</result>
1932	<result name="VBOX_E_INVALID_OBJECT_STATE">
1933	Medium has already been added to a media registry.
1934	</result>
1935	</desc>
1936	<param name="location" type="wstring" dir="in">
1937	<desc>
1938	Location of the storage unit that contains medium data in one of
1939	the supported storage formats.
1940	</desc>
1941	</param>
1942	<param name="deviceType" type="DeviceType" dir="in">
1943	<desc>
1944	Must be one of "HardDisk", "DVD" or "Floppy".
1945	</desc>
1946	</param>
1947	<param name="accessMode" type="AccessMode" dir="in">
1948	<desc>Whether to open the image in read/write or read-only mode. For
1949	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1950	</param>
1951	<param name="forceNewUuid" type="boolean" dir="in">
1952	<desc>Allows the caller to request a completely new medium UUID for
1953	the image which is to be opened. Useful if one intends to open an exact
1954	copy of a previously opened image, as this would normally fail due to
1955	the duplicate UUID.</desc>
1956	</param>
1957	<param name="medium" type="IMedium" dir="return">
1958	<desc>Opened medium object.</desc>
1959	</param>
1960	</method>
1961
1962	<method name="findMedium">
1963	<desc>
1964	Returns a medium of the given type that uses the given fully qualified
1965	location or UUID to store medium data.
1966
1967	The given medium must be known to this VirtualBox installation, i.e.
1968	it must be previously created by <link to="#createHardDisk"/> or opened
1969	by <link to="#openMedium"/>.
1970
1971	The search is done by comparing the value of the @a location argument to
1972	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1973	attributes of each known medium.
1974
1975	On case sensitive file systems, a case sensitive comparison is performed,
1976	otherwise the case of symbols in the file path is ignored.
1977
1978	<result name="VBOX_E_OBJECT_NOT_FOUND">
1979	No medium object matching @a location found.
1980	</result>
1981	</desc>
1982	<param name="location" type="wstring" dir="in">
1983	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1984	</param>
1985	<param name="type" type="DeviceType" dir="in">
1986	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1987	</param>
1988	<param name="medium" type="IMedium" dir="return">
1989	<desc>Medium object, if found.</desc>
1990	</param>
1991	</method>
1992
1993	<method name="getGuestOSType">
1994	<desc>
1995	Returns an object describing the specified guest OS type.
1996
1997	The requested guest OS type is specified using a string which is a
1998	mnemonic identifier of the guest operating system, such as
1999	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2000	particular virtual machine can be read or set using the
2001	<link to="IMachine::OSTypeId"/> attribute.
2002
2003	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2004	available guest OS type objects. Each object has an
2005	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2006	the guest OS this object describes.
2007
2008	<result name="E_INVALIDARG">
2009	@a id is not a valid Guest OS type.
2010	</result>
2011
2012	</desc>
2013	<param name="id" type="uuid" mod="string" dir="in">
2014	<desc>Guest OS type ID string.</desc>
2015	</param>
2016	<param name="type" type="IGuestOSType" dir="return">
2017	<desc>Guest OS type object.</desc>
2018	</param>
2019	</method>
2020
2021	<method name="createSharedFolder">
2022	<desc>
2023	Creates a new global shared folder by associating the given logical
2024	name with the given host path, adds it to the collection of shared
2025	folders and starts sharing it. Refer to the description of
2026	<link to="ISharedFolder"/> to read more about logical names.
2027	<note>
2028	In the current implementation, this operation is not
2029	implemented.
2030	</note>
2031	</desc>
2032	<param name="name" type="wstring" dir="in">
2033	<desc>Unique logical name of the shared folder.</desc>
2034	</param>
2035	<param name="hostPath" type="wstring" dir="in">
2036	<desc>Full path to the shared folder in the host file system.</desc>
2037	</param>
2038	<param name="writable" type="boolean" dir="in">
2039	<desc>Whether the share is writable or readonly</desc>
2040	</param>
2041	<param name="automount" type="boolean" dir="in">
2042	<desc>Whether the share gets automatically mounted by the guest
2043	or not.</desc>
2044	</param>
2045	</method>
2046
2047	<method name="removeSharedFolder">
2048	<desc>
2049	Removes the global shared folder with the given name previously
2050	created by <link to="#createSharedFolder"/> from the collection of
2051	shared folders and stops sharing it.
2052	<note>
2053	In the current implementation, this operation is not
2054	implemented.
2055	</note>
2056	</desc>
2057	<param name="name" type="wstring" dir="in">
2058	<desc>Logical name of the shared folder to remove.</desc>
2059	</param>
2060	</method>
2061
2062	<method name="getExtraDataKeys">
2063	<desc>
2064	Returns an array representing the global extra data keys which currently
2065	have values defined.
2066	</desc>
2067	<param name="value" type="wstring" dir="return" safearray="yes">
2068	<desc>Array of extra data keys.</desc>
2069	</param>
2070	</method>
2071
2072	<method name="getExtraData">
2073	<desc>
2074	Returns associated global extra data.
2075
2076	If the requested data @a key does not exist, this function will
2077	succeed and return an empty string in the @a value argument.
2078
2079	<result name="VBOX_E_FILE_ERROR">
2080	Settings file not accessible.
2081	</result>
2082	<result name="VBOX_E_XML_ERROR">
2083	Could not parse the settings file.
2084	</result>
2085
2086	</desc>
2087	<param name="key" type="wstring" dir="in">
2088	<desc>Name of the data key to get.</desc>
2089	</param>
2090	<param name="value" type="wstring" dir="return">
2091	<desc>Value of the requested data key.</desc>
2092	</param>
2093	</method>
2094
2095	<method name="setExtraData">
2096	<desc>
2097	Sets associated global extra data.
2098
2099	If you pass @c null or empty string as a key @a value, the given @a key
2100	will be deleted.
2101
2102	<note>
2103	Before performing the actual data change, this method will ask all
2104	registered event listener using the
2105	<link to="IExtraDataCanChangeEvent"/>
2106	notification for a permission. If one of the listeners refuses the
2107	new value, the change will not be performed.
2108	</note>
2109	<note>
2110	On success, the
2111	<link to="IExtraDataChangedEvent"/> notification
2112	is called to inform all registered listeners about a successful data
2113	change.
2114	</note>
2115
2116	<result name="VBOX_E_FILE_ERROR">
2117	Settings file not accessible.
2118	</result>
2119	<result name="VBOX_E_XML_ERROR">
2120	Could not parse the settings file.
2121	</result>
2122	<result name="E_ACCESSDENIED">
2123	Modification request refused.
2124	</result>
2125
2126	</desc>
2127	<param name="key" type="wstring" dir="in">
2128	<desc>Name of the data key to set.</desc>
2129	</param>
2130	<param name="value" type="wstring" dir="in">
2131	<desc>Value to assign to the key.</desc>
2132	</param>
2133	</method>
2134
2135	<!--method name="createDHCPServerForInterface">
2136	<desc>
2137	Creates a dhcp server settings to be used for the given interface
2138	<result name="E_INVALIDARG">
2139	Host network interface @a name already exists.
2140	</result>
2141	</desc>
2142	<param name="interface" type="IHostNetworkInterface" dir="in">
2143	<desc>Network Interface</desc>
2144	</param>
2145	<param name="server" type="IDHCPServer" dir="out">
2146	<desc>Dhcp server settings</desc>
2147	</param>
2148	</method-->
2149
2150	<method name="createDHCPServer">
2151	<desc>
2152	Creates a dhcp server settings to be used for the given internal network name
2153	<result name="E_INVALIDARG">
2154	Host network interface @a name already exists.
2155	</result>
2156	</desc>
2157	<param name="name" type="wstring" dir="in">
2158	<desc>server name</desc>
2159	</param>
2160	<param name="server" type="IDHCPServer" dir="return">
2161	<desc>Dhcp server settings</desc>
2162	</param>
2163	</method>
2164
2165	<method name="findDHCPServerByNetworkName">
2166	<desc>
2167	Searches a dhcp server settings to be used for the given internal network name
2168	<result name="E_INVALIDARG">
2169	Host network interface @a name already exists.
2170	</result>
2171
2172	</desc>
2173	<param name="name" type="wstring" dir="in">
2174	<desc>server name</desc>
2175	</param>
2176	<param name="server" type="IDHCPServer" dir="return">
2177	<desc>Dhcp server settings</desc>
2178	</param>
2179	</method>
2180
2181	<!--method name="findDHCPServerForInterface">
2182	<desc>
2183	Searches a dhcp server settings to be used for the given interface
2184	<result name="E_INVALIDARG">
2185	Host network interface @a name already exists.
2186	</result>
2187	</desc>
2188	<param name="interface" type="IHostNetworkInterface" dir="in">
2189	<desc>Network Interface</desc>
2190	</param>
2191	<param name="server" type="IDHCPServer" dir="out">
2192	<desc>Dhcp server settings</desc>
2193	</param>
2194	</method-->
2195
2196	<method name="removeDHCPServer">
2197	<desc>
2198	Removes the dhcp server settings
2199	<result name="E_INVALIDARG">
2200	Host network interface @a name already exists.
2201	</result>
2202	</desc>
2203	<param name="server" type="IDHCPServer" dir="in">
2204	<desc>Dhcp server settings to be removed</desc>
2205	</param>
2206	</method>
2207
2208
2209	<method name="checkFirmwarePresent">
2210	<desc>
2211	Check if this VirtualBox installation has a firmware
2212	of the given type available, either system-wide or per-user.
2213	Optionally, this may return a hint where this firmware can be
2214	downloaded from.
2215	</desc>
2216	<param name="firmwareType" type="FirmwareType" dir="in">
2217	<desc>
2218	Type of firmware to check.
2219	</desc>
2220	</param>
2221	<param name="version" type="wstring" dir="in">
2222	<desc>Expected version number, usually empty string (presently ignored).</desc>
2223	</param>
2224
2225	<param name="url" type="wstring" dir="out">
2226	<desc>
2227	Suggested URL to download this firmware from.
2228	</desc>
2229	</param>
2230
2231	<param name="file" type="wstring" dir="out">
2232	<desc>
2233	Filename of firmware, only valid if result == TRUE.
2234	</desc>
2235	</param>
2236
2237	<param name="result" type="boolean" dir="return">
2238	<desc>If firmware of this type and version is available.</desc>
2239	</param>
2240	</method>
2241
2242	</interface>
2243
2244	<!--
2245	// IVFSExplorer
2246	/////////////////////////////////////////////////////////////////////////
2247	-->
2248
2249	<enum
2250	name="VFSType"
2251	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2252	>
2253	<desc>
2254	Virtual file systems supported by VFSExplorer.
2255	</desc>
2256
2257	<const name="File" value="1" />
2258	<const name="Cloud" value="2" />
2259	<const name="S3" value="3" />
2260	<const name="WebDav" value="4" />
2261	</enum>
2262
2263	<enum
2264	name="VFSFileType"
2265	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2266	>
2267	<desc>
2268	File types known by VFSExplorer.
2269	</desc>
2270
2271	<const name="Unknown" value="1" />
2272	<const name="Fifo" value="2" />
2273	<const name="DevChar" value="3" />
2274	<const name="Directory" value="4" />
2275	<const name="DevBlock" value="5" />
2276	<const name="File" value="6" />
2277	<const name="SymLink" value="7" />
2278	<const name="Socket" value="8" />
2279	<const name="WhiteOut" value="9" />
2280	</enum>
2281
2282	<interface
2283	name="IVFSExplorer" extends="$unknown"
2284	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2285	wsmap="managed"
2286	>
2287	<desc>
2288	The VFSExplorer interface unifies access to different file system
2289	types. This includes local file systems as well remote file systems like
2290	S3. For a list of supported types see <link to="VFSType" />.
2291	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2292	</desc>
2293
2294	<attribute name="path" type="wstring" readonly="yes">
2295	<desc>Returns the current path in the virtual file system.</desc>
2296	</attribute>
2297
2298	<attribute name="type" type="VFSType" readonly="yes">
2299	<desc>Returns the file system type which is currently in use.</desc>
2300	</attribute>
2301
2302	<method name="update">
2303	<desc>Updates the internal list of files/directories from the
2304	current directory level. Use <link to="#entryList" /> to get the full list
2305	after a call to this method.</desc>
2306
2307	<param name="aProgress" type="IProgress" dir="return">
2308	<desc>Progress object to track the operation completion.</desc>
2309	</param>
2310	</method>
2311
2312	<method name="cd">
2313	<desc>Change the current directory level.</desc>
2314
2315	<param name="aDir" type="wstring" dir="in">
2316	<desc>The name of the directory to go in.</desc>
2317	</param>
2318
2319	<param name="aProgress" type="IProgress" dir="return">
2320	<desc>Progress object to track the operation completion.</desc>
2321	</param>
2322	</method>
2323
2324	<method name="cdUp">
2325	<desc>Go one directory upwards from the current directory level.</desc>
2326
2327	<param name="aProgress" type="IProgress" dir="return">
2328	<desc>Progress object to track the operation completion.</desc>
2329	</param>
2330	</method>
2331
2332	<method name="entryList">
2333	<desc>Returns a list of files/directories after a call to <link
2334	to="#update" />. The user is responsible for keeping this internal
2335	list up do date.</desc>
2336
2337	<param name="aNames" type="wstring" safearray="yes" dir="out">
2338	<desc>The list of names for the entries.</desc>
2339	</param>
2340
2341	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2342	<desc>The list of types for the entries.</desc>
2343	</param>
2344
2345	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2346	<desc>The list of sizes (in bytes) for the entries.</desc>
2347	</param>
2348
2349	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2350	<desc>The list of file modes (in octal form) for the entries.</desc>
2351	</param>
2352	</method>
2353
2354	<method name="exists">
2355	<desc>Checks if the given file list exists in the current directory
2356	level.</desc>
2357
2358	<param name="aNames" type="wstring" safearray="yes" dir="in">
2359	<desc>The names to check.</desc>
2360	</param>
2361
2362	<param name="aExists" type="wstring" safearray="yes" dir="return">
2363	<desc>The names which exist.</desc>
2364	</param>
2365	</method>
2366
2367	<method name="remove">
2368	<desc>Deletes the given files in the current directory level.</desc>
2369
2370	<param name="aNames" type="wstring" safearray="yes" dir="in">
2371	<desc>The names to remove.</desc>
2372	</param>
2373
2374	<param name="aProgress" type="IProgress" dir="return">
2375	<desc>Progress object to track the operation completion.</desc>
2376	</param>
2377	</method>
2378
2379	</interface>
2380
2381	<enum
2382	name="ImportOptions" extends="$unknown"
2383	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2384	>
2385
2386	<desc>
2387	Import options, used with <link to="IAppliance::importMachines" />.
2388	</desc>
2389
2390	<const name="KeepAllMACs" value="1">
2391	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2392	</const>
2393	<const name="KeepNATMACs" value="2">
2394	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2395	</const>
2396
2397	</enum>
2398
2399
2400	<!--
2401	// IAppliance
2402	/////////////////////////////////////////////////////////////////////////
2403	-->
2404
2405	<interface
2406	name="IAppliance" extends="$unknown"
2407	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2408	wsmap="managed"
2409	>
2410	<desc>
2411	Represents a platform-independent appliance in OVF format. An instance of this is returned
2412	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2413	virtual machines within an appliance with VirtualBox.
2414
2415	The OVF standard suggests two different physical file formats:
2416
2417	<ol>
2418	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2419	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2420	this descriptor file references other files such as disk images, as OVF appliances typically
2421	do, those additional files must be in the same directory as the descriptor file.</li>
2422
2423	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2424	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2425	files and optionally other files.
2426
2427	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2428	be added with a later version.</li>
2429	</ol>
2430
2431	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2432	<link to="IMachine" /> involves the following sequence of API calls:
2433
2434	<ol>
2435	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2436	</li>
2437
2438	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2439	would like to import. So long as this file is syntactically valid, this will succeed
2440	and fill the appliance object with the parsed data from the OVF file.
2441	</li>
2442
2443	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2444	contents of the IAppliance attributes accordingly. These can be inspected by a
2445	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2446	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2447	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2448	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2449	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2450	The GUI can then give the user the option to confirm and/or change these suggestions.
2451	</li>
2452
2453	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2454	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2455	</li>
2456
2457	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2458	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2459	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2460	can be found in the <link to="#machines" /> array attribute.
2461	</li>
2462	</ol>
2463
2464	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2465
2466	<ol>
2467	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2468	an empty IAppliance object.
2469	</li>
2470
2471	<li>For each machine you would like to export, call <link to="IMachine::export" />
2472	with the IAppliance object you just created. Each such call creates one instance of
2473	<link to="IVirtualSystemDescription" /> inside the appliance.
2474	</li>
2475
2476	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2477	virtual system (machine) to override the suggestions made by the <link to="IMachine::export"/> routine.
2478	</li>
2479
2480	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2481	file written.</li>
2482	</ol>
2483
2484	</desc>
2485
2486	<attribute name="path" type="wstring" readonly="yes">
2487	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2488	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2489	<link to="#write" /> (for export).
2490	This attribute is empty until one of these methods has been called.
2491	</desc>
2492	</attribute>
2493
2494	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2495	<desc>
2496	Array of virtual disk definitions. One such description exists for each
2497	disk definition in the OVF; each string array item represents one such piece of
2498	disk information, with the information fields separated by tab (\\t) characters.
2499
2500	The caller should be prepared for additional fields being appended to
2501	this string in future versions of VirtualBox and therefore check for
2502	the number of tabs in the strings returned.
2503
2504	In the current version, the following eight fields are returned per string
2505	in the array:
2506
2507	<ol>
2508	<li>Disk ID (unique string identifier given to disk)</li>
2509
2510	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2511
2512	<li>Populated size (optional unsigned integer indicating the current size of the
2513	disk; can be approximate; -1 if unspecified)</li>
2514
2515	<li>Format (string identifying the disk format, typically
2516	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2517
2518	<li>Reference (where to find the disk image, typically a file name; if empty,
2519	then the disk should be created on import)</li>
2520
2521	<li>Image size (optional unsigned integer indicating the size of the image,
2522	which need not necessarily be the same as the values specified above, since
2523	the image may be compressed or sparse; -1 if not specified)</li>
2524
2525	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2526	presently unsupported and always -1)</li>
2527
2528	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2529	</ol>
2530	</desc>
2531	</attribute>
2532
2533	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2534	<desc> Array of virtual system descriptions. One such description is created
2535	for each virtual system (machine) found in the OVF.
2536	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2537	(for export) has been called.
2538	</desc>
2539	</attribute>
2540
2541	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2542	<desc>
2543	Contains the UUIDs of the machines created from the information in this appliances. This is only
2544	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2545	succeeded.
2546	</desc>
2547	</attribute>
2548
2549	<method name="read">
2550	<desc>
2551	Reads an OVF file into the appliance object.
2552
2553	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2554	mere fact that this method returns successfully does not mean that VirtualBox supports all
2555	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2556	</desc>
2557	<param name="file" type="wstring" dir="in">
2558	<desc>
2559	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2560	on whether the appliance is distributed as a set of files or as a single file, respectively).
2561	</desc>
2562	</param>
2563	<param name="aProgress" type="IProgress" dir="return">
2564	<desc>Progress object to track the operation completion.</desc>
2565	</param>
2566	</method>
2567
2568	<method name="interpret">
2569	<desc>
2570	Interprets the OVF data that was read when the appliance was constructed. After
2571	calling this method, one can inspect the
2572	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2573	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2574	the appliance.
2575
2576	Calling this method is the second step of importing an appliance into VirtualBox;
2577	see <link to="IAppliance" /> for an overview.
2578
2579	After calling this method, one should call <link to="#getWarnings" /> to find out
2580	if problems were encountered during the processing which might later lead to
2581	errors.
2582	</desc>
2583	</method>
2584
2585	<method name="importMachines">
2586	<desc>
2587	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2588	and other interfaces that match the information contained in the appliance as
2589	closely as possible, as represented by the import instructions in the
2590	<link to="#virtualSystemDescriptions" /> array.
2591
2592	Calling this method is the final step of importing an appliance into VirtualBox;
2593	see <link to="IAppliance" /> for an overview.
2594
2595	Since importing the appliance will most probably involve copying and converting
2596	disk images, which can take a long time, this method operates asynchronously and
2597	returns an IProgress object to allow the caller to monitor the progress.
2598
2599	After the import succeeded, the UUIDs of the IMachine instances created can be
2600	retrieved from the <link to="#machines" /> array attribute.
2601	</desc>
2602
2603	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2604	<desc>Options for the importing operation.</desc>
2605	</param>
2606
2607	<param name="aProgress" type="IProgress" dir="return">
2608	<desc>Progress object to track the operation completion.</desc>
2609	</param>
2610	</method>
2611
2612	<method name="createVFSExplorer">
2613	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2614
2615	<param name="aUri" type="wstring" dir="in">
2616	<desc>The URI describing the file system to use.</desc>
2617	</param>
2618
2619	<param name="aExplorer" type="IVFSExplorer" dir="return">
2620	<desc></desc>
2621	</param>
2622	</method>
2623
2624	<method name="write">
2625	<desc>
2626	Writes the contents of the appliance exports into a new OVF file.
2627
2628	Calling this method is the final step of exporting an appliance from VirtualBox;
2629	see <link to="IAppliance" /> for an overview.
2630
2631	Since exporting the appliance will most probably involve copying and converting
2632	disk images, which can take a long time, this method operates asynchronously and
2633	returns an IProgress object to allow the caller to monitor the progress.
2634	</desc>
2635	<param name="format" type="wstring" dir="in">
2636	<desc>
2637	Output format, as a string. Currently supported formats are "ovf-0.9", "ovf-1.0"
2638	and "ovf-2.0"; future versions of VirtualBox may support additional formats.
2639	</desc>
2640	</param>
2641	<param name="manifest" type="boolean" dir="in">
2642	<desc>
2643	Indicate if the optional manifest file (.mf) should be written. The manifest file
2644	is used for integrity checks prior import.
2645	</desc>
2646	</param>
2647	<param name="path" type="wstring" dir="in">
2648	<desc>
2649	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2650	on whether the appliance is distributed as a set of files or as a single file, respectively).
2651	</desc>
2652	</param>
2653	<param name="progress" type="IProgress" dir="return">
2654	<desc>Progress object to track the operation completion.</desc>
2655	</param>
2656	</method>
2657
2658	<method name="getWarnings">
2659	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2660
2661	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2662	<desc></desc>
2663	</param>
2664	</method>
2665
2666	</interface>
2667
2668	<enum
2669	name="VirtualSystemDescriptionType"
2670	uuid="303c0900-a746-4612-8c67-79003e91f459"
2671	>
2672	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2673	a configuration value.</desc>
2674
2675	<const name="Ignore" value="1" />
2676	<const name="OS" value="2" />
2677	<const name="Name" value="3" />
2678	<const name="Product" value="4" />
2679	<const name="Vendor" value="5" />
2680	<const name="Version" value="6" />
2681	<const name="ProductUrl" value="7" />
2682	<const name="VendorUrl" value="8" />
2683	<const name="Description" value="9" />
2684	<const name="License" value="10" />
2685	<const name="Miscellaneous" value="11" />
2686	<const name="CPU" value="12" />
2687	<const name="Memory" value="13" />
2688	<const name="HardDiskControllerIDE" value="14" />
2689	<const name="HardDiskControllerSATA" value="15" />
2690	<const name="HardDiskControllerSCSI" value="16" />
2691	<const name="HardDiskControllerSAS" value="17" />
2692	<const name="HardDiskImage" value="18" />
2693	<const name="Floppy" value="19" />
2694	<const name="CDROM" value="20" />
2695	<const name="NetworkAdapter" value="21" />
2696	<const name="USBController" value="22" />
2697	<const name="SoundCard" value="23" />
2698	<const name="SettingsFile" value="24">
2699	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2700	</const>
2701	</enum>
2702
2703	<enum
2704	name="VirtualSystemDescriptionValueType"
2705	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2706	>
2707	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2708	type to fetch.</desc>
2709
2710	<const name="Reference" value="1" />
2711	<const name="Original" value="2" />
2712	<const name="Auto" value="3" />
2713	<const name="ExtraConfig" value="4" />
2714
2715	</enum>
2716
2717	<interface
2718	name="IVirtualSystemDescription" extends="$unknown"
2719	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2720	wsmap="managed"
2721	>
2722
2723	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2724	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2725	<link to="IAppliance::interpret" /> has been called, that array contains information
2726	about how the virtual systems described in the OVF should best be imported into
2727	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2728	import an OVF into VirtualBox.
2729	</desc>
2730
2731	<attribute name="count" type="unsigned long" readonly="yes">
2732	<desc>Return the number of virtual system description entries.</desc>
2733	</attribute>
2734
2735	<method name="getDescription">
2736	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2737	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2738
2739	The list below identifies the value sets that are possible depending on the
2740	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2741	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2742	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2743	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2744	the @a aExtraConfigValues[] array item may also be used.
2745
2746	<ul>
2747	<li>
2748	"OS": the guest operating system type. There must be exactly one such array item on import. The
2749	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2750	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2751	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2752	</li>
2753	<li>
2754	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2755	if none is present on import, then an automatic name will be created from the operating system
2756	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2757	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2758	<link to="IMachine" /> name that does not exist yet.
2759	</li>
2760	<li>
2761	"Description": an arbitrary description.
2762	</li>
2763	<li>
2764	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2765	code to display such a license for agreement; the Main API does not enforce any such policy.
2766	</li>
2767	<li>
2768	Miscellaneous: reserved for future use.
2769	</li>
2770	<li>
2771	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2772	</li>
2773	<li>
2774	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2775	is present on import, then VirtualBox will set a meaningful default based on the operating system
2776	type.
2777	</li>
2778	<li>
2779	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2780	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2781	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2782	writes into the OVF.
2783	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2784	type can use to specify which hard disk controller a virtual disk should be connected to.
2785	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2786	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2787	its virtual machines supports four channels (primary master, primary slave, secondary master,
2788	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2789	</li>
2790	<li>
2791	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2792	has no value in @a aOvfValues[] or @a aVBoxValues[].
2793	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2794	</li>
2795	<li>
2796	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2797	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2798	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2799	whereas VirtualBox considers it a class of storage controllers of its own; see
2800	<link to="StorageControllerType" />).
2801	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2802	</li>
2803	<li>
2804	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2805	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2806
2807	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2808	a path since the image file should be in the same location as the OVF file itself), whereas the
2809	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2810	hard disk image. This means that on import the image will be copied and converted from the
2811	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2812
2813	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2814	format: "controller=<index>;channel=<c>"
2815	In this string, <index> must be an integer specifying the hard disk controller to connect
2816	the image to. That number must be the index of an array item with one of the hard disk controller
2817	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2818	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2819	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2820	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2821	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2822	</li>
2823	<li>
2824	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2825	attachment information as with "HardDiskImage" items.
2826	</li>
2827	<li>
2828	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2829	attachment information as with "HardDiskImage" items.
2830	</li>
2831	<li>
2832	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2833	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2834	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2835	</li>
2836	<li>
2837	"USBController": a USB controller. There can be at most one such item. If and only if such an
2838	item ispresent, USB support will be enabled for the new virtual machine.
2839	</li>
2840	<li>
2841	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2842	present, sound support will be enabled for the new virtual machine. Note that the virtual
2843	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2844	may be different from the virtual soundcard expected by the appliance.
2845	</li>
2846	</ul>
2847
2848	</desc>
2849
2850	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2851	<desc></desc>
2852	</param>
2853
2854	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2855	<desc></desc>
2856	</param>
2857
2858	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2859	<desc></desc>
2860	</param>
2861
2862	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2863	<desc></desc>
2864	</param>
2865
2866	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2867	<desc></desc>
2868	</param>
2869
2870	</method>
2871
2872	<method name="getDescriptionByType">
2873	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2874	should be returned.</desc>
2875
2876	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2877	<desc></desc>
2878	</param>
2879
2880	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2881	<desc></desc>
2882	</param>
2883
2884	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2885	<desc></desc>
2886	</param>
2887
2888	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2889	<desc></desc>
2890	</param>
2891
2892	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2893	<desc></desc>
2894	</param>
2895
2896	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2897	<desc></desc>
2898	</param>
2899
2900	</method>
2901
2902	<method name="getValuesByType">
2903	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2904	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2905	values.</desc>
2906
2907	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2908	<desc></desc>
2909	</param>
2910
2911	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2912	<desc></desc>
2913	</param>
2914
2915	<param name="aValues" type="wstring" dir="return" safearray="yes">
2916	<desc></desc>
2917	</param>
2918
2919	</method>
2920
2921	<method name="setFinalValues">
2922	<desc>
2923	This method allows the appliance's user to change the configuration for the virtual
2924	system descriptions. For each array item returned from <link to="#getDescription" />,
2925	you must pass in one boolean value and one configuration value.
2926
2927	Each item in the boolean array determines whether the particular configuration item
2928	should be enabled.
2929	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2930	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2931	and SoundCard.
2932
2933	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2934	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
2935	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
2936	for valid configuration values for the individual array item types. If the
2937	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2938	</desc>
2939
2940	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2941	<desc></desc>
2942	</param>
2943
2944	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2945	<desc></desc>
2946	</param>
2947
2948	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2949	<desc></desc>
2950	</param>
2951	</method>
2952
2953	<method name="addDescription">
2954	<desc>
2955	This method adds an additional description entry to the stack of already
2956	available descriptions for this virtual system. This is handy for writing
2957	values which aren't directly supported by VirtualBox. One example would
2958	be the License type of <link to="VirtualSystemDescriptionType" />.
2959	</desc>
2960
2961	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2962	<desc></desc>
2963	</param>
2964
2965	<param name="aVBoxValue" type="wstring" dir="in">
2966	<desc></desc>
2967	</param>
2968
2969	<param name="aExtraConfigValue" type="wstring" dir="in">
2970	<desc></desc>
2971	</param>
2972	</method>
2973	</interface>
2974
2975
2976	<!--
2977	// IMachine
2978	/////////////////////////////////////////////////////////////////////////
2979	-->
2980
2981	<interface
2982	name="IInternalMachineControl" extends="$unknown"
2983	uuid="ec824977-e43f-479c-81c9-ac6cae1423a5"
2984	internal="yes"
2985	wsmap="suppress"
2986	>
2987	<method name="setRemoveSavedStateFile">
2988	<desc>
2989	Updates the flag whether the saved state file is removed on a
2990	machine state change from Saved to PoweredOff.
2991	</desc>
2992	<param name="aRemove" type="boolean" dir="in"/>
2993	</method>
2994
2995	<method name="updateState">
2996	<desc>
2997	Updates the VM state.
2998	<note>
2999	This operation will also update the settings file with the correct
3000	information about the saved state file and delete this file from disk
3001	when appropriate.
3002	</note>
3003	</desc>
3004	<param name="state" type="MachineState" dir="in"/>
3005	</method>
3006
3007	<method name="getIPCId">
3008	<param name="id" type="wstring" dir="return"/>
3009	</method>
3010
3011	<method name="beginPowerUp">
3012	<desc>
3013	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
3014	gives it the progress object that should be part of any pending
3015	<link to="IMachine::launchVMProcess"/> operations. The progress
3016	object may be called back to reflect an early cancelation, so some care
3017	have to be taken with respect to any cancelation callbacks. The console
3018	object will call <link to="IInternalMachineControl::endPowerUp"/>
3019	to signal the completion of the progress object.
3020	</desc>
3021	<param name="aProgress" type="IProgress" dir="in" />
3022	</method>
3023
3024	<method name="endPowerUp">
3025	<desc>
3026	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3027	This method may query status information from the progress object it
3028	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3029	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3030	call in order to complete that progress object.
3031	</desc>
3032	<param name="result" type="long" dir="in"/>
3033	</method>
3034
3035	<method name="beginPoweringDown">
3036	<desc>
3037	Called by the VM process to inform the server it wants to
3038	stop the VM execution and power down.
3039	</desc>
3040	<param name="progress" type="IProgress" dir="out">
3041	<desc>
3042	Progress object created by VBoxSVC to wait until
3043	the VM is powered down.
3044	</desc>
3045	</param>
3046	</method>
3047
3048	<method name="endPoweringDown">
3049	<desc>
3050	Called by the VM process to inform the server that powering
3051	down previously requested by #beginPoweringDown is either
3052	successfully finished or there was a failure.
3053
3054	<result name="VBOX_E_FILE_ERROR">
3055	Settings file not accessible.
3056	</result>
3057	<result name="VBOX_E_XML_ERROR">
3058	Could not parse the settings file.
3059	</result>
3060
3061	</desc>
3062
3063	<param name="result" type="long" dir="in">
3064	<desc>@c S_OK to indicate success.
3065	</desc>
3066	</param>
3067	<param name="errMsg" type="wstring" dir="in">
3068	<desc>@c human readable error message in case of failure.
3069	</desc>
3070	</param>
3071	</method>
3072
3073	<method name="runUSBDeviceFilters">
3074	<desc>
3075	Asks the server to run USB devices filters of the associated
3076	machine against the given USB device and tell if there is
3077	a match.
3078	<note>
3079	Intended to be used only for remote USB devices. Local
3080	ones don't require to call this method (this is done
3081	implicitly by the Host and USBProxyService).
3082	</note>
3083	</desc>
3084	<param name="device" type="IUSBDevice" dir="in"/>
3085	<param name="matched" type="boolean" dir="out"/>
3086	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3087	</method>
3088
3089	<method name="captureUSBDevice">
3090	<desc>
3091	Requests a capture of the given host USB device.
3092	When the request is completed, the VM process will
3093	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3094	notification.
3095	</desc>
3096	<param name="id" type="uuid" mod="string" dir="in"/>
3097	</method>
3098
3099	<method name="detachUSBDevice">
3100	<desc>
3101	Notification that a VM is going to detach (@a done = @c false) or has
3102	already detached (@a done = @c true) the given USB device.
3103	When the @a done = @c true request is completed, the VM process will
3104	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3105	notification.
3106	<note>
3107	In the @a done = @c true case, the server must run its own filters
3108	and filters of all VMs but this one on the detached device
3109	as if it were just attached to the host computer.
3110	</note>
3111	</desc>
3112	<param name="id" type="uuid" mod="string" dir="in"/>
3113	<param name="done" type="boolean" dir="in"/>
3114	</method>
3115
3116	<method name="autoCaptureUSBDevices">
3117	<desc>
3118	Requests a capture all matching USB devices attached to the host.
3119	When the request is completed, the VM process will
3120	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3121	notification per every captured device.
3122	</desc>
3123	</method>
3124
3125	<method name="detachAllUSBDevices">
3126	<desc>
3127	Notification that a VM that is being powered down. The done
3128	parameter indicates whether which stage of the power down
3129	we're at. When @a done = @c false the VM is announcing its
3130	intentions, while when @a done = @c true the VM is reporting
3131	what it has done.
3132	<note>
3133	In the @a done = @c true case, the server must run its own filters
3134	and filters of all VMs but this one on all detach devices as
3135	if they were just attached to the host computer.
3136	</note>
3137	</desc>
3138	<param name="done" type="boolean" dir="in"/>
3139	</method>
3140
3141	<method name="onSessionEnd">
3142	<desc>
3143	Triggered by the given session object when the session is about
3144	to close normally.
3145	</desc>
3146	<param name="session" type="ISession" dir="in">
3147	<desc>Session that is being closed</desc>
3148	</param>
3149	<param name="progress" type="IProgress" dir="return">
3150	<desc>
3151	Used to wait until the corresponding machine is actually
3152	dissociated from the given session on the server.
3153	Returned only when this session is a direct one.
3154	</desc>
3155	</param>
3156	</method>
3157
3158	<method name="beginSavingState">
3159	<desc>
3160	Called by the VM process to inform the server it wants to
3161	save the current state and stop the VM execution.
3162	</desc>
3163	<param name="progress" type="IProgress" dir="out">
3164	<desc>
3165	Progress object created by VBoxSVC to wait until
3166	the state is saved.
3167	</desc>
3168	</param>
3169	<param name="stateFilePath" type="wstring" dir="out">
3170	<desc>
3171	File path the VM process must save the execution state to.
3172	</desc>
3173	</param>
3174	</method>
3175
3176	<method name="endSavingState">
3177	<desc>
3178	Called by the VM process to inform the server that saving
3179	the state previously requested by #beginSavingState is either
3180	successfully finished or there was a failure.
3181
3182	<result name="VBOX_E_FILE_ERROR">
3183	Settings file not accessible.
3184	</result>
3185	<result name="VBOX_E_XML_ERROR">
3186	Could not parse the settings file.
3187	</result>
3188
3189	</desc>
3190
3191	<param name="result" type="long" dir="in">
3192	<desc>@c S_OK to indicate success.
3193	</desc>
3194	</param>
3195	<param name="errMsg" type="wstring" dir="in">
3196	<desc>@c human readable error message in case of failure.
3197	</desc>
3198	</param>
3199	</method>
3200
3201	<method name="adoptSavedState">
3202	<desc>
3203	Gets called by <link to="IConsole::adoptSavedState"/>.
3204	<result name="VBOX_E_FILE_ERROR">
3205	Invalid saved state file path.
3206	</result>
3207	</desc>
3208	<param name="savedStateFile" type="wstring" dir="in">
3209	<desc>Path to the saved state file to adopt.</desc>
3210	</param>
3211	</method>
3212
3213	<method name="beginTakingSnapshot">
3214	<desc>
3215	Called from the VM process to request from the server to perform the
3216	server-side actions of creating a snapshot (creating differencing images
3217	and the snapshot object).
3218
3219	<result name="VBOX_E_FILE_ERROR">
3220	Settings file not accessible.
3221	</result>
3222	<result name="VBOX_E_XML_ERROR">
3223	Could not parse the settings file.
3224	</result>
3225	</desc>
3226	<param name="initiator" type="IConsole" dir="in">
3227	<desc>The console object that initiated this call.</desc>
3228	</param>
3229	<param name="name" type="wstring" dir="in">
3230	<desc>Snapshot name.</desc>
3231	</param>
3232	<param name="description" type="wstring" dir="in">
3233	<desc>Snapshot description.</desc>
3234	</param>
3235	<param name="consoleProgress" type="IProgress" dir="in">
3236	<desc>
3237	Progress object created by the VM process tracking the
3238	snapshot's progress. This has the following sub-operations:
3239	<ul>
3240	<li>setting up (weight 1);</li>
3241	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3242	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3243	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3244	<li>finishing up (weight 1)</li>
3245	</ul>
3246	</desc>
3247	</param>
3248	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3249	<desc>
3250	Whether this is an online snapshot (i.e. the machine is running).
3251	</desc>
3252	</param>
3253	<param name="stateFilePath" type="wstring" dir="out">
3254	<desc>
3255	File path the VM process must save the execution state to.
3256	</desc>
3257	</param>
3258	</method>
3259
3260	<method name="endTakingSnapshot">
3261	<desc>
3262	Called by the VM process to inform the server that the snapshot
3263	previously requested by #beginTakingSnapshot is either
3264	successfully taken or there was a failure.
3265	</desc>
3266
3267	<param name="success" type="boolean" dir="in">
3268	<desc>@c true to indicate success and @c false otherwise</desc>
3269	</param>
3270	</method>
3271
3272	<method name="deleteSnapshot">
3273	<desc>
3274	Gets called by <link to="IConsole::deleteSnapshot"/>,
3275	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3276	<link to="IConsole::deleteSnapshotRange"/>.
3277	<result name="VBOX_E_INVALID_OBJECT_STATE">
3278	Snapshot has more than one child snapshot. Only possible if the
3279	delete operation does not delete all children or the range does
3280	not meet the linearity condition.
3281	</result>
3282	</desc>
3283	<param name="initiator" type="IConsole" dir="in">
3284	<desc>The console object that initiated this call.</desc>
3285	</param>
3286	<param name="startId" type="uuid" mod="string" dir="in">
3287	<desc>UUID of the first snapshot to delete.</desc>
3288	</param>
3289	<param name="endId" type="uuid" mod="string" dir="in">
3290	<desc>UUID of the last snapshot to delete.</desc>
3291	</param>
3292	<param name="deleteAllChildren" type="boolean" dir="in">
3293	<desc>Whether all children should be deleted.</desc>
3294	</param>
3295	<param name="machineState" type="MachineState" dir="out">
3296	<desc>New machine state after this operation is started.</desc>
3297	</param>
3298	<param name="progress" type="IProgress" dir="return">
3299	<desc>Progress object to track the operation completion.</desc>
3300	</param>
3301	</method>
3302
3303	<method name="finishOnlineMergeMedium">
3304	<desc>
3305	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3306	</desc>
3307	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3308	<desc>The medium attachment which needs to be cleaned up.</desc>
3309	</param>
3310	<param name="source" type="IMedium" dir="in">
3311	<desc>Merge source medium.</desc>
3312	</param>
3313	<param name="target" type="IMedium" dir="in">
3314	<desc>Merge target medium.</desc>
3315	</param>
3316	<param name="mergeForward" type="boolean" dir="in">
3317	<desc>Merge direction.</desc>
3318	</param>
3319	<param name="parentForTarget" type="IMedium" dir="in">
3320	<desc>For forward merges: new parent for target medium.</desc>
3321	</param>
3322	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3323	<desc>For backward merges: list of media which need their parent UUID
3324	updated.</desc>
3325	</param>
3326	</method>
3327
3328	<method name="restoreSnapshot">
3329	<desc>
3330	Gets called by <link to="IConsole::restoreSnapshot"/>.
3331	</desc>
3332	<param name="initiator" type="IConsole" dir="in">
3333	<desc>The console object that initiated this call.</desc>
3334	</param>
3335	<param name="snapshot" type="ISnapshot" dir="in">
3336	<desc>The snapshot to restore the VM state from.</desc>
3337	</param>
3338	<param name="machineState" type="MachineState" dir="out">
3339	<desc>New machine state after this operation is started.</desc>
3340	</param>
3341	<param name="progress" type="IProgress" dir="return">
3342	<desc>Progress object to track the operation completion.</desc>
3343	</param>
3344	</method>
3345
3346	<method name="pullGuestProperties">
3347	<desc>
3348	Get the list of the guest properties matching a set of patterns along
3349	with their values, time stamps and flags and give responsibility for
3350	managing properties to the console.
3351	</desc>
3352	<param name="name" type="wstring" dir="out" safearray="yes">
3353	<desc>
3354	The names of the properties returned.
3355	</desc>
3356	</param>
3357	<param name="value" type="wstring" dir="out" safearray="yes">
3358	<desc>
3359	The values of the properties returned. The array entries match the
3360	corresponding entries in the @a name array.
3361	</desc>
3362	</param>
3363	<param name="timestamp" type="long long" dir="out" safearray="yes">
3364	<desc>
3365	The time stamps of the properties returned. The array entries match
3366	the corresponding entries in the @a name array.
3367	</desc>
3368	</param>
3369	<param name="flags" type="wstring" dir="out" safearray="yes">
3370	<desc>
3371	The flags of the properties returned. The array entries match the
3372	corresponding entries in the @a name array.
3373	</desc>
3374	</param>
3375	</method>
3376
3377	<method name="pushGuestProperty">
3378	<desc>
3379	Update a single guest property in IMachine.
3380	</desc>
3381	<param name="name" type="wstring" dir="in">
3382	<desc>
3383	The name of the property to be updated.
3384	</desc>
3385	</param>
3386	<param name="value" type="wstring" dir="in">
3387	<desc>
3388	The value of the property.
3389	</desc>
3390	</param>
3391	<param name="timestamp" type="long long" dir="in">
3392	<desc>
3393	The timestamp of the property.
3394	</desc>
3395	</param>
3396	<param name="flags" type="wstring" dir="in">
3397	<desc>
3398	The flags of the property.
3399	</desc>
3400	</param>
3401	</method>
3402
3403	<method name="lockMedia">
3404	<desc>
3405	Locks all media attached to the machine for writing and parents of
3406	attached differencing media (if any) for reading. This operation is
3407	atomic so that if it fails no media is actually locked.
3408
3409	This method is intended to be called when the machine is in Starting or
3410	Restoring state. The locked media will be automatically unlocked when
3411	the machine is powered off or crashed.
3412	</desc>
3413	</method>
3414	<method name="unlockMedia">
3415	<desc>
3416	Unlocks all media previously locked using
3417	<link to="IInternalMachineControl::lockMedia"/>.
3418
3419	This method is intended to be used with teleportation so that it is
3420	possible to teleport between processes on the same machine.
3421	</desc>
3422	</method>
3423
3424	<method name="ejectMedium">
3425	<desc>
3426	Tells VBoxSVC that the guest has ejected the medium associated with
3427	the medium attachment.
3428	</desc>
3429	<param name="attachment" type="IMediumAttachment" dir="in">
3430	<desc>
3431	The medium attachment where the eject happened.
3432	</desc>
3433	</param>
3434	<param name="newAttachment" type="IMediumAttachment" dir="return">
3435	<desc>
3436	A new reference to the medium attachment, as the config change can
3437	result in the creation of a new instance.
3438	</desc>
3439	</param>
3440	</method>
3441
3442	<method name="reportGuestStatistics">
3443	<desc>
3444	Passes collected guest statistics to VBoxSVC.
3445	</desc>
3446	<param name="validStats" type="unsigned long" dir="in">
3447	<desc>
3448	Mask defining which parameters are valid. For example: 0x11 means
3449	that cpuIdle and XXX are valid. Other parameters should be ignored.
3450	</desc>
3451	</param>
3452	<param name="cpuUser" type="unsigned long" dir="in">
3453	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
3454	</param>
3455	<param name="cpuKernel" type="unsigned long" dir="in">
3456	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
3457	</param>
3458	<param name="cpuIdle" type="unsigned long" dir="in">
3459	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
3460	</param>
3461	<param name="memTotal" type="unsigned long" dir="in">
3462	<desc>Total amount of physical guest RAM.</desc>
3463	</param>
3464	<param name="memFree" type="unsigned long" dir="in">
3465	<desc>Free amount of physical guest RAM.</desc>
3466	</param>
3467	<param name="memBalloon" type="unsigned long" dir="in">
3468	<desc>Amount of ballooned physical guest RAM.</desc>
3469	</param>
3470	<param name="memShared" type="unsigned long" dir="in">
3471	<desc>Amount of shared physical guest RAM.</desc>
3472	</param>
3473	<param name="memCache" type="unsigned long" dir="in">
3474	<desc>Total amount of guest (disk) cache memory.</desc>
3475	</param>
3476	<param name="pagedTotal" type="unsigned long" dir="in">
3477	<desc>Total amount of space in the page file.</desc>
3478	</param>
3479	<param name="memAllocTotal" type="unsigned long" dir="in">
3480	<desc>Total amount of memory allocated by the hypervisor.</desc>
3481	</param>
3482	<param name="memFreeTotal" type="unsigned long" dir="in">
3483	<desc>Total amount of free memory available in the hypervisor.</desc>
3484	</param>
3485	<param name="memBalloonTotal" type="unsigned long" dir="in">
3486	<desc>Total amount of memory ballooned by the hypervisor.</desc>
3487	</param>
3488	<param name="memSharedTotal" type="unsigned long" dir="in">
3489	<desc>Total amount of shared memory in the hypervisor.</desc>
3490	</param>
3491	</method>
3492	</interface>
3493
3494	<interface
3495	name="IBIOSSettings" extends="$unknown"
3496	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3497	wsmap="managed"
3498	>
3499	<desc>
3500	The IBIOSSettings interface represents BIOS settings of the virtual
3501	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3502	</desc>
3503	<attribute name="logoFadeIn" type="boolean">
3504	<desc>Fade in flag for BIOS logo animation.</desc>
3505	</attribute>
3506
3507	<attribute name="logoFadeOut" type="boolean">
3508	<desc>Fade out flag for BIOS logo animation.</desc>
3509	</attribute>
3510
3511	<attribute name="logoDisplayTime" type="unsigned long">
3512	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3513	</attribute>
3514
3515	<attribute name="logoImagePath" type="wstring">
3516	<desc>
3517	Local file system path for external BIOS splash image. Empty string
3518	means the default image is shown on boot.
3519	</desc>
3520	</attribute>
3521
3522	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3523	<desc>Mode of the BIOS boot device menu.</desc>
3524	</attribute>
3525
3526	<attribute name="ACPIEnabled" type="boolean">
3527	<desc>ACPI support flag.</desc>
3528	</attribute>
3529
3530	<attribute name="IOAPICEnabled" type="boolean">
3531	<desc>
3532	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3533	and support IRQs above 15.
3534	</desc>
3535	</attribute>
3536
3537	<attribute name="timeOffset" type="long long">
3538	<desc>
3539	Offset in milliseconds from the host system time. This allows for
3540	guests running with a different system date/time than the host.
3541	It is equivalent to setting the system date/time in the BIOS except
3542	it is not an absolute value but a relative one. Guest Additions
3543	time synchronization honors this offset.
3544	</desc>
3545	</attribute>
3546
3547	<attribute name="PXEDebugEnabled" type="boolean">
3548	<desc>
3549	PXE debug logging flag. If set, VirtualBox will write extensive
3550	PXE trace information to the release log.
3551	</desc>
3552	</attribute>
3553	</interface>
3554
3555	<enum
3556	name="CleanupMode"
3557	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3558	>
3559	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3560	</desc>
3561	<const name="UnregisterOnly" value="1">
3562	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3563	</const>
3564	<const name="DetachAllReturnNone" value="2">
3565	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3566	</const>
3567	<const name="DetachAllReturnHardDisksOnly" value="3">
3568	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3569	</const>
3570	<const name="Full" value="4">
3571	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3572	</const>
3573	</enum>
3574
3575	<interface
3576	name="IPciAddress" extends="$unknown"
3577	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3578	wsmap="struct"
3579	>
3580
3581	<desc>
3582	Address on the PCI bus.
3583	</desc>
3584
3585	<attribute name="bus" type="short">
3586	<desc>
3587	Bus number.
3588	</desc>
3589	</attribute>
3590
3591	<attribute name="device" type="short">
3592	<desc>
3593	Device number.
3594	</desc>
3595	</attribute>
3596
3597	<attribute name="devFunction" type="short">
3598	<desc>
3599	Device function number.
3600	</desc>
3601	</attribute>
3602
3603	<method name="asLong">
3604	<desc>
3605	Convert PCI address into long.
3606	</desc>
3607	<param name="result" type="long" dir="return" />
3608	</method>
3609
3610	<method name="fromLong">
3611	<desc>
3612	Make PCI address from long.
3613	</desc>
3614	<param name="number" type="long" dir="in" />
3615	</method>
3616	</interface>
3617
3618	<interface
3619	name="IPciDeviceAttachment" extends="$unknown"
3620	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3621	wsmap="struct"
3622	>
3623
3624	<desc>
3625	Information about PCI attachments.
3626	</desc>
3627
3628	<attribute name="name" type="wstring" readonly="yes">
3629	<desc>
3630	Device name.
3631	</desc>
3632	</attribute>
3633
3634	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3635	<desc>
3636	If this is physical or virtual device.
3637	</desc>
3638	</attribute>
3639
3640	<attribute name="hostAddress" type="long" readonly="yes">
3641	<desc>
3642	Address of device on the host, applicable only to host devices.
3643	</desc>
3644	</attribute>
3645
3646	<attribute name="guestAddress" type="long" readonly="yes">
3647	<desc>
3648	Address of device on the guest.
3649	</desc>
3650	</attribute>
3651
3652	</interface>
3653
3654	<enum
3655	name="CloneMode" extends="$unknown"
3656	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3657	>
3658
3659	<desc>
3660	Clone mode, used with <link to="IMachine::cloneTo" />.
3661	</desc>
3662
3663	<const name="MachineState" value="1">
3664	<desc>Clone the state of the selected machine.</desc>
3665	</const>
3666	<const name="MachineAndChildStates" value="2">
3667	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3668	</const>
3669	<const name="AllStates" value="3">
3670	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3671	</const>
3672
3673	</enum>
3674
3675	<enum
3676	name="CloneOptions" extends="$unknown"
3677	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3678	>
3679
3680	<desc>
3681	Clone options, used with <link to="IMachine::cloneTo" />.
3682	</desc>
3683
3684	<const name="Link" value="1">
3685	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3686	</const>
3687	<const name="KeepAllMACs" value="2">
3688	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3689	</const>
3690	<const name="KeepNATMACs" value="3">
3691	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3692	</const>
3693	<const name="KeepDiskNames" value="4">
3694	<desc>Don't change the disk names.</desc>
3695	</const>
3696
3697	</enum>
3698
3699
3700	<interface
3701	name="IMachine" extends="$unknown"
3702	uuid="b0ce140d-02b6-469a-80f5-412ef8e1318e"
3703	wsmap="managed"
3704	>
3705	<desc>
3706	The IMachine interface represents a virtual machine, or guest, created
3707	in VirtualBox.
3708
3709	This interface is used in two contexts. First of all, a collection of
3710	objects implementing this interface is stored in the
3711	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3712	machines that are currently registered with this VirtualBox
3713	installation. Also, once a session has been opened for the given virtual
3714	machine (e.g. the virtual machine is running), the machine object
3715	associated with the open session can be queried from the session object;
3716	see <link to="ISession"/> for details.
3717
3718	The main role of this interface is to expose the settings of the virtual
3719	machine and provide methods to change various aspects of the virtual
3720	machine's configuration. For machine objects stored in the
3721	<link to="IVirtualBox::machines"/> collection, all attributes are
3722	read-only unless explicitly stated otherwise in individual attribute
3723	and method descriptions.
3724
3725	In order to change a machine setting, a session for this machine must be
3726	opened using one of the <link to="IMachine::lockMachine" /> or
3727	<link to="IMachine::launchVMProcess"/> methods. After the
3728	machine has been successfully locked for a session, a mutable machine object
3729	needs to be queried from the session object and then the desired settings
3730	changes can be applied to the returned object using IMachine attributes and
3731	methods. See the <link to="ISession"/> interface description for more
3732	information about sessions.
3733
3734	Note that IMachine does not provide methods to control virtual machine
3735	execution (such as start the machine, or power it down) -- these methods
3736	are grouped in a separate interface called <link to="IConsole" />.
3737
3738	<see><link to="ISession"/>, <link to="IConsole"/></see>
3739	</desc>
3740
3741	<attribute name="parent" type="IVirtualBox" readonly="yes">
3742	<desc>Associated parent object.</desc>
3743	</attribute>
3744
3745	<attribute name="accessible" type="boolean" readonly="yes">
3746	<desc>
3747	Whether this virtual machine is currently accessible or not.
3748
3749	A machine is always deemed accessible unless it is registered <i>and</i>
3750	its settings file cannot be read or parsed (either because the file itself
3751	is unavailable or has invalid XML contents).
3752
3753	Every time this property is read, the accessibility state of
3754	this machine is re-evaluated. If the returned value is @c false,
3755	the <link to="#accessError"/> property may be used to get the
3756	detailed error information describing the reason of
3757	inaccessibility, including XML error messages.
3758
3759	When the machine is inaccessible, only the following properties
3760	can be used on it:
3761	<ul>
3762	<li><link to="#parent"/></li>
3763	<li><link to="#id"/></li>
3764	<li><link to="#settingsFilePath"/></li>
3765	<li><link to="#accessible"/></li>
3766	<li><link to="#accessError"/></li>
3767	</ul>
3768
3769	An attempt to access any other property or method will return
3770	an error.
3771
3772	The only possible action you can perform on an inaccessible
3773	machine is to unregister it using the
3774	<link to="IMachine::unregister"/> call (or, to check
3775	for the accessibility state once more by querying this
3776	property).
3777
3778	<note>
3779	In the current implementation, once this property returns
3780	@c true, the machine will never become inaccessible
3781	later, even if its settings file cannot be successfully
3782	read/written any more (at least, until the VirtualBox
3783	server is restarted). This limitation may be removed in
3784	future releases.
3785	</note>
3786	</desc>
3787	</attribute>
3788
3789	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3790	<desc>
3791	Error information describing the reason of machine
3792	inaccessibility.
3793
3794	Reading this property is only valid after the last call to
3795	<link to="#accessible"/> returned @c false (i.e. the
3796	machine is currently inaccessible). Otherwise, a @c null
3797	IVirtualBoxErrorInfo object will be returned.
3798	</desc>
3799	</attribute>
3800
3801	<attribute name="name" type="wstring">
3802	<desc>
3803	Name of the virtual machine.
3804
3805	Besides being used for human-readable identification purposes
3806	everywhere in VirtualBox, the virtual machine name is also used
3807	as a name of the machine's settings file and as a name of the
3808	subdirectory this settings file resides in. Thus, every time you
3809	change the value of this property, the settings file will be
3810	renamed once you call <link to="#saveSettings"/> to confirm the
3811	change. The containing subdirectory will be also renamed, but
3812	only if it has exactly the same name as the settings file
3813	itself prior to changing this property (for backward compatibility
3814	with previous API releases). The above implies the following
3815	limitations:
3816	<ul>
3817	<li>The machine name cannot be empty.</li>
3818	<li>The machine name can contain only characters that are valid
3819	file name characters according to the rules of the file
3820	system used to store VirtualBox configuration.</li>
3821	<li>You cannot have two or more machines with the same name
3822	if they use the same subdirectory for storing the machine
3823	settings files.</li>
3824	<li>You cannot change the name of the machine if it is running,
3825	or if any file in the directory containing the settings file
3826	is being used by another running machine or by any other
3827	process in the host operating system at a time when
3828	<link to="#saveSettings"/> is called.
3829	</li>
3830	</ul>
3831	If any of the above limitations are hit, <link to="#saveSettings"/>
3832	will return an appropriate error message explaining the exact
3833	reason and the changes you made to this machine will not be saved.
3834
3835	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
3836	file is recommended, but not enforced. (Previous versions always
3837	used a generic ".xml" extension.)
3838	</desc>
3839	</attribute>
3840
3841	<attribute name="description" type="wstring">
3842	<desc>
3843	Description of the virtual machine.
3844
3845	The description attribute can contain any text and is
3846	typically used to describe the hardware and software
3847	configuration of the virtual machine in detail (i.e. network
3848	settings, versions of the installed software and so on).
3849	</desc>
3850	</attribute>
3851
3852	<attribute name="id" type="uuid" mod="string" readonly="yes">
3853	<desc>UUID of the virtual machine.</desc>
3854	</attribute>
3855
3856	<attribute name="OSTypeId" type="wstring">
3857	<desc>
3858	User-defined identifier of the Guest OS type.
3859	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3860	an IGuestOSType object representing details about the given
3861	Guest OS type.
3862	<note>
3863	This value may differ from the value returned by
3864	<link to="IGuest::OSTypeId"/> if Guest Additions are
3865	installed to the guest OS.
3866	</note>
3867	</desc>
3868	</attribute>
3869
3870	<attribute name="hardwareVersion" type="wstring">
3871	<desc>Hardware version identifier. Internal use only for now.</desc>
3872	</attribute>
3873
3874	<attribute name="hardwareUUID" type="uuid" mod="string">
3875	<desc>
3876	The UUID presented to the guest via memory tables, hardware and guest
3877	properties. For most VMs this is the same as the @a id, but for VMs
3878	which have been cloned or teleported it may be the same as the source
3879	VM. This latter is because the guest shouldn't notice that it was
3880	cloned or teleported.
3881	</desc>
3882	</attribute>
3883
3884	<attribute name="CPUCount" type="unsigned long">
3885	<desc>Number of virtual CPUs in the VM.</desc>
3886	</attribute>
3887
3888	<attribute name="CPUHotPlugEnabled" type="boolean">
3889	<desc>
3890	This setting determines whether VirtualBox allows CPU
3891	hotplugging for this machine.</desc>
3892	</attribute>
3893
3894	<attribute name="CPUExecutionCap" type="unsigned long">
3895	<desc>
3896	Means to limit the number of CPU cycles a guest can use. The unit
3897	is percentage of host CPU cycles per second. The valid range
3898	is 1 - 100. 100 (the default) implies no limit.
3899	</desc>
3900	</attribute>
3901
3902	<attribute name="memorySize" type="unsigned long">
3903	<desc>System memory size in megabytes.</desc>
3904	</attribute>
3905
3906	<attribute name="memoryBalloonSize" type="unsigned long">
3907	<desc>Memory balloon size in megabytes.</desc>
3908	</attribute>
3909
3910	<attribute name="pageFusionEnabled" type="boolean">
3911	<desc>
3912	This setting determines whether VirtualBox allows page
3913	fusion for this machine (64 bits host only).
3914	</desc>
3915	</attribute>
3916
3917	<attribute name="VRAMSize" type="unsigned long">
3918	<desc>Video memory size in megabytes.</desc>
3919	</attribute>
3920
3921	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3922	<desc>
3923	This setting determines whether VirtualBox allows this machine to make
3924	use of the 3D graphics support available on the host.</desc>
3925	</attribute>
3926
3927	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3928	<desc>
3929	This setting determines whether VirtualBox allows this machine to make
3930	use of the 2D video acceleration support available on the host.</desc>
3931	</attribute>
3932
3933	<attribute name="monitorCount" type="unsigned long">
3934	<desc>
3935	Number of virtual monitors.
3936	<note>
3937	Only effective on Windows XP and later guests with
3938	Guest Additions installed.
3939	</note>
3940	</desc>
3941	</attribute>
3942
3943	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3944	<desc>Object containing all BIOS settings.</desc>
3945	</attribute>
3946
3947	<attribute name="firmwareType" type="FirmwareType">
3948	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3949	bootstrap in this VM.</desc>
3950	</attribute>
3951
3952	<attribute name="pointingHidType" type="PointingHidType">
3953	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3954	The default is typically "PS2Mouse" but can vary depending on the
3955	requirements of the guest operating system.</desc>
3956	</attribute>
3957
3958	<attribute name="keyboardHidType" type="KeyboardHidType">
3959	<desc>Type of keyboard HID used in this VM.
3960	The default is typically "PS2Keyboard" but can vary depending on the
3961	requirements of the guest operating system.</desc>
3962	</attribute>
3963
3964	<attribute name="hpetEnabled" type="boolean">
3965	<desc>This attribute controls if High Precision Event Timer (HPET) is
3966	enabled in this VM. Use this property if you want to provide guests
3967	with additional time source, or if guest requires HPET to function correctly.
3968	Default is false.</desc>
3969	</attribute>
3970
3971	<attribute name="chipsetType" type="ChipsetType">
3972	<desc>Chipset type used in this VM.</desc>
3973	</attribute>
3974
3975	<attribute name="snapshotFolder" type="wstring">
3976	<desc>
3977	Full path to the directory used to store snapshot data
3978	(differencing media and saved state files) of this machine.
3979
3980	The initial value of this property is
3981	<tt><</tt><link to="#settingsFilePath">
3982	path_to_settings_file</link><tt>>/<</tt>
3983	<link to="#id">machine_uuid</link>
3984	<tt>></tt>.
3985
3986	Currently, it is an error to try to change this property on
3987	a machine that has snapshots (because this would require to
3988	move possibly large files to a different location).
3989	A separate method will be available for this purpose later.
3990
3991	<note>
3992	Setting this property to @c null or to an empty string will restore
3993	the initial value.
3994	</note>
3995	<note>
3996	When setting this property, the specified path can be
3997	absolute (full path) or relative to the directory where the
3998	<link to="#settingsFilePath">machine settings file</link>
3999	is located. When reading this property, a full path is
4000	always returned.
4001	</note>
4002	<note>
4003	The specified path may not exist, it will be created
4004	when necessary.
4005	</note>
4006	</desc>
4007	</attribute>
4008
4009	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
4010	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
4011	</attribute>
4012
4013	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
4014	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
4015
4016	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4017	<desc>Array of media attached to this machine.</desc>
4018	</attribute>
4019
4020	<attribute name="USBController" type="IUSBController" readonly="yes">
4021	<desc>
4022	Associated USB controller object.
4023
4024	<note>
4025	If USB functionality is not available in the given edition of
4026	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4027	</note>
4028	</desc>
4029	</attribute>
4030
4031	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4032	<desc>Associated audio adapter, always present.</desc>
4033	</attribute>
4034
4035	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4036	<desc>Array of storage controllers attached to this machine.</desc>
4037	</attribute>
4038
4039	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4040	<desc>
4041	Full name of the file containing machine settings data.
4042	</desc>
4043	</attribute>
4044
4045	<attribute name="settingsModified" type="boolean" readonly="yes">
4046	<desc>
4047	Whether the settings of this machine have been modified
4048	(but neither yet saved nor discarded).
4049	<note>
4050	Reading this property is only valid on instances returned
4051	by <link to="ISession::machine"/> and on new machines
4052	created by <link to="IVirtualBox::createMachine"/> or opened
4053	by <link to="IVirtualBox::openMachine"/> but not
4054	yet registered, or on unregistered machines after calling
4055	<link to="IMachine::unregister"/>. For all other
4056	cases, the settings can never be modified.
4057	</note>
4058	<note>
4059	For newly created unregistered machines, the value of this
4060	property is always @c true until <link to="#saveSettings"/>
4061	is called (no matter if any machine settings have been
4062	changed after the creation or not). For opened machines
4063	the value is set to @c false (and then follows to normal rules).
4064	</note>
4065	</desc>
4066	</attribute>
4067
4068	<attribute name="sessionState" type="SessionState" readonly="yes">
4069	<desc>Current session state for this machine.</desc>
4070	</attribute>
4071
4072	<attribute name="sessionType" type="wstring" readonly="yes">
4073	<desc>
4074	Type of the session. If <link to="#sessionState"/> is
4075	Spawning or Locked, this attribute contains the
4076	same value as passed to the
4077	<link to="IMachine::launchVMProcess"/> method in the
4078	@a type parameter. If the session was used with
4079	<link to="IMachine::lockMachine" />, or if
4080	<link to="#sessionState"/> is SessionClosed, the value of this
4081	attribute is an empty string.
4082	</desc>
4083	</attribute>
4084
4085	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4086	<desc>
4087	Identifier of the session process. This attribute contains the
4088	platform-dependent identifier of the process whose session was
4089	used with <link to="IMachine::lockMachine" /> call. The returned
4090	value is only valid if <link to="#sessionState"/> is Locked or
4091	Unlocking by the time this property is read.
4092	</desc>
4093	</attribute>
4094
4095	<attribute name="state" type="MachineState" readonly="yes">
4096	<desc>Current execution state of this machine.</desc>
4097	</attribute>
4098
4099	<attribute name="lastStateChange" type="long long" readonly="yes">
4100	<desc>
4101	Time stamp of the last execution state change,
4102	in milliseconds since 1970-01-01 UTC.
4103	</desc>
4104	</attribute>
4105
4106	<attribute name="stateFilePath" type="wstring" readonly="yes">
4107	<desc>
4108	Full path to the file that stores the execution state of
4109	the machine when it is in the <link to="MachineState_Saved"/> state.
4110	<note>
4111	When the machine is not in the Saved state, this attribute is
4112	an empty string.
4113	</note>
4114	</desc>
4115	</attribute>
4116
4117	<attribute name="logFolder" type="wstring" readonly="yes">
4118	<desc>
4119	Full path to the folder that stores a set of rotated log files
4120	recorded during machine execution. The most recent log file is
4121	named <tt>VBox.log</tt>, the previous log file is
4122	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4123	in the current version).
4124	</desc>
4125	</attribute>
4126
4127	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4128	<desc>
4129	Current snapshot of this machine. This is @c null if the machine
4130	currently has no snapshots. If it is not @c null, then it was
4131	set by one of <link to="IConsole::takeSnapshot" />,
4132	<link to="IConsole::deleteSnapshot" />
4133	or <link to="IConsole::restoreSnapshot" />, depending on which
4134	was called last. See <link to="ISnapshot"/> for details.
4135	</desc>
4136	</attribute>
4137
4138	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4139	<desc>
4140	Number of snapshots taken on this machine. Zero means the
4141	machine doesn't have any snapshots.
4142	</desc>
4143	</attribute>
4144
4145	<attribute name="currentStateModified" type="boolean" readonly="yes">
4146	<desc>
4147	Returns @c true if the current state of the machine is not
4148	identical to the state stored in the current snapshot.
4149
4150	The current state is identical to the current snapshot only
4151	directly after one of the following calls are made:
4152
4153	<ul>
4154	<li><link to="IConsole::restoreSnapshot"/>
4155	</li>
4156	<li><link to="IConsole::takeSnapshot"/> (issued on a
4157	"powered off" or "saved" machine, for which
4158	<link to="#settingsModified"/> returns @c false)
4159	</li>
4160	</ul>
4161
4162	The current state remains identical until one of the following
4163	happens:
4164	<ul>
4165	<li>settings of the machine are changed</li>
4166	<li>the saved state is deleted</li>
4167	<li>the current snapshot is deleted</li>
4168	<li>an attempt to execute the machine is made</li>
4169	</ul>
4170
4171	<note>
4172	For machines that don't have snapshots, this property is
4173	always @c false.
4174	</note>
4175	</desc>
4176	</attribute>
4177
4178	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4179	<desc>
4180	Collection of shared folders for this machine (permanent shared
4181	folders). These folders are shared automatically at machine startup
4182	and available only to the guest OS installed within this machine.
4183
4184	New shared folders are added to the collection using
4185	<link to="#createSharedFolder"/>. Existing shared folders can be
4186	removed using <link to="#removeSharedFolder"/>.
4187	</desc>
4188	</attribute>
4189
4190	<attribute name="clipboardMode" type="ClipboardMode">
4191	<desc>
4192	Synchronization mode between the host OS clipboard
4193	and the guest OS clipboard.
4194	</desc>
4195	</attribute>
4196
4197	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4198	<desc>
4199	A comma-separated list of simple glob patterns. Changes to guest
4200	properties whose name matches one of the patterns will generate an
4201	<link to="IGuestPropertyChangedEvent"/> signal.
4202	</desc>
4203	</attribute>
4204
4205	<attribute name="teleporterEnabled" type="boolean">
4206	<desc>
4207	When set to @a true, the virtual machine becomes a target teleporter
4208	the next time it is powered on. This can only set to @a true when the
4209	VM is in the @a PoweredOff or @a Aborted state.
4210
4211	<!-- This property is automatically set to @a false when the VM is powered
4212	on. (bird: This doesn't work yet ) -->
4213	</desc>
4214	</attribute>
4215
4216	<attribute name="teleporterPort" type="unsigned long">
4217	<desc>
4218	The TCP port the target teleporter will listen for incoming
4219	teleportations on.
4220
4221	0 means the port is automatically selected upon power on. The actual
4222	value can be read from this property while the machine is waiting for
4223	incoming teleportations.
4224	</desc>
4225	</attribute>
4226
4227	<attribute name="teleporterAddress" type="wstring">
4228	<desc>
4229	The address the target teleporter will listen on. If set to an empty
4230	string, it will listen on all addresses.
4231	</desc>
4232	</attribute>
4233
4234	<attribute name="teleporterPassword" type="wstring">
4235	<desc>
4236	The password to check for on the target teleporter. This is just a
4237	very basic measure to prevent simple hacks and operators accidentally
4238	beaming a virtual machine to the wrong place.
4239
4240	Note that you SET a plain text password while reading back a HASHED
4241	password. Setting a hashed password is currently not supported.
4242	</desc>
4243	</attribute>
4244
4245	<attribute name="faultToleranceState" type="FaultToleranceState">
4246	<desc>
4247	Fault tolerance state; disabled, source or target.
4248	This property can be changed at any time. If you change it for a running
4249	VM, then the fault tolerance address and port must be set beforehand.
4250	</desc>
4251	</attribute>
4252
4253	<attribute name="faultTolerancePort" type="unsigned long">
4254	<desc>
4255	The TCP port the fault tolerance source or target will use for
4256	communication.
4257	</desc>
4258	</attribute>
4259
4260	<attribute name="faultToleranceAddress" type="wstring">
4261	<desc>
4262	The address the fault tolerance source or target.
4263	</desc>
4264	</attribute>
4265
4266	<attribute name="faultTolerancePassword" type="wstring">
4267	<desc>
4268	The password to check for on the standby VM. This is just a
4269	very basic measure to prevent simple hacks and operators accidentally
4270	choosing the wrong standby VM.
4271	</desc>
4272	</attribute>
4273
4274	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4275	<desc>
4276	The interval in ms used for syncing the state between source and target.
4277	</desc>
4278	</attribute>
4279
4280	<attribute name="RTCUseUTC" type="boolean">
4281	<desc>
4282	When set to @a true, the RTC device of the virtual machine will run
4283	in UTC time, otherwise in local time. Especially Unix guests prefer
4284	the time in UTC.
4285	</desc>
4286	</attribute>
4287
4288	<attribute name="ioCacheEnabled" type="boolean">
4289	<desc>
4290	When set to @a true, the builtin I/O cache of the virtual machine
4291	will be enabled.
4292	</desc>
4293	</attribute>
4294
4295	<attribute name="ioCacheSize" type="unsigned long">
4296	<desc>
4297	Maximum size of the I/O cache in MB.
4298	</desc>
4299	</attribute>
4300
4301	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4302	<desc>Array of PCI devices assigned to this machine, to get list of all
4303	PCI devices attached to the machine use
4304	<link to="IConsole::attachedPciDevices"/> attribute, as this attribute
4305	is intended to list only devices additional to what described in
4306	virtual hardware config. Usually, this list keeps host's physical
4307	devices assigned to the particular machine.
4308	</desc>
4309	</attribute>
4310
4311	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4312	<desc>
4313	Bandwidth control manager.
4314	</desc>
4315	</attribute>
4316
4317	<attribute name="tracingEnabled" type="boolean">
4318	<desc>
4319	Enables the tracing facility in the VMM (including PDM devices +
4320	drivers). The VMM will consume about 0.5MB of more memory when
4321	enabled and there may be some extra overhead from tracepoints that are
4322	always enabled.
4323	</desc>
4324	</attribute>
4325
4326	<attribute name="tracingConfig" type="wstring">
4327	<desc>
4328	Tracepoint configuration to apply at startup when
4329	<link to="IMachine::tracingEnabled" /> is true. The string specifies
4330	a space separated of tracepoint group names to enable. The special
4331	group 'all' enables all tracepoints. Check DBGFR3TracingConfig for
4332	more details on available tracepoint groups and such.
4333
4334	Note that on hosts supporting DTrace (or similar), a lot of the
4335	tracepoints may be implemented exclusivly as DTrace probes. So, the
4336	effect of the same config may differ between Solaris and Windows for
4337	example.
4338	</desc>
4339	</attribute>
4340
4341	<attribute name="allowTracingToAccessVM" type="boolean">
4342	<desc>
4343	Enables tracepoints in PDM devices and drivers to use the VMCPU or VM
4344	structures when firing off trace points. This is especially useful
4345	with DTrace tracepoints, as it allow you to use the VMCPU or VM pointer
4346	to obtail useful information such as guest register state.
4347
4348	This is disabled by default because devices and drivers normally has no
4349	business accessing the VMCPU or VM structures, and are therefore unable
4350	to get any pointers to these.
4351	</desc>
4352	</attribute>
4353
4354	<method name="lockMachine">
4355	<desc>
4356	Locks the machine for the given session to enable the caller
4357	to make changes to the machine or start the VM or control
4358	VM execution.
4359
4360	There are two ways to lock a machine for such uses:
4361
4362	<ul>
4363	<li>If you want to make changes to the machine settings,
4364	you must obtain an exclusive write lock on the machine
4365	by setting @a lockType to @c Write.
4366
4367	This will only succeed if no other process has locked
4368	the machine to prevent conflicting changes. Only after
4369	an exclusive write lock has been obtained using this method, one
4370	can change all VM settings or execute the VM in the process
4371	space of the session object. (Note that the latter is only of
4372	interest if you actually want to write a new front-end for
4373	virtual machines; but this API gets called internally by
4374	the existing front-ends such as VBoxHeadless and the VirtualBox
4375	GUI to acquire a write lock on the machine that they are running.)
4376
4377	On success, write-locking the machine for a session creates
4378	a second copy of the IMachine object. It is this second object
4379	upon which changes can be made; in VirtualBox terminology, the
4380	second copy is "mutable". It is only this second, mutable machine
4381	object upon which you can call methods that change the
4382	machine state. After having called this method, you can
4383	obtain this second, mutable machine object using the
4384	<link to="ISession::machine" /> attribute.
4385	</li>
4386	<li>If you only want to check the machine state or control
4387	machine execution without actually changing machine
4388	settings (e.g. to get access to VM statistics or take
4389	a snapshot or save the machine state), then set the
4390	@a lockType argument to @c Shared.
4391
4392	If no other session has obtained a lock, you will obtain an
4393	exclusive write lock as described above. However, if another
4394	session has already obtained such a lock, then a link to that
4395	existing session will be established which allows you
4396	to control that existing session.
4397
4398	To find out which type of lock was obtained, you can
4399	inspect <link to="ISession::type" />, which will have been
4400	set to either @c WriteLock or @c Shared.
4401	</li>
4402	</ul>
4403
4404	In either case, you can get access to the <link to="IConsole" />
4405	object which controls VM execution.
4406
4407	Also in all of the above cases, one must always call
4408	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4409	the machine's state will eventually be set to "Aborted".
4410
4411	To change settings on a machine, the following sequence is typically
4412	performed:
4413
4414	<ol>
4415	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4416
4417	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4418
4419	<li>Change the settings of the machine by invoking IMachine methods.</li>
4420
4421	<li>Call <link to="IMachine::saveSettings" />.</li>
4422
4423	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4424	</ol>
4425
4426	<result name="E_UNEXPECTED">
4427	Virtual machine not registered.
4428	</result>
4429	<result name="E_ACCESSDENIED">
4430	Process not started by OpenRemoteSession.
4431	</result>
4432	<result name="VBOX_E_INVALID_OBJECT_STATE">
4433	Session already open or being opened.
4434	</result>
4435	<result name="VBOX_E_VM_ERROR">
4436	Failed to assign machine to session.
4437	</result>
4438	</desc>
4439	<param name="session" type="ISession" dir="in">
4440	<desc>
4441	Session object for which the machine will be locked.
4442	</desc>
4443	</param>
4444	<param name="lockType" type="LockType" dir="in">
4445	<desc>
4446	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4447	If set to @c Shared, then either acquire an exclusive write lock or establish
4448	a link to an existing session.
4449	</desc>
4450	</param>
4451	</method>
4452
4453	<method name="launchVMProcess">
4454	<desc>
4455	Spawns a new process that will execute the virtual machine and obtains a shared
4456	lock on the machine for the calling session.
4457
4458	If launching the VM succeeds, the new VM process will create its own session
4459	and write-lock the machine for it, preventing conflicting changes from other
4460	processes. If the machine is already locked (because it is already running or
4461	because another session has a write lock), launching the VM process will therefore
4462	fail. Reversely, future attempts to obtain a write lock will also fail while the
4463	machine is running.
4464
4465	The caller's session object remains separate from the session opened by the new
4466	VM process. It receives its own <link to="IConsole" /> object which can be used
4467	to control machine execution, but it cannot be used to change all VM settings
4468	which would be available after a <link to="#lockMachine" /> call.
4469
4470	The caller must eventually release the session's shared lock by calling
4471	<link to="ISession::unlockMachine" /> on the local session object once this call
4472	has returned. However, the session's state (see <link to="ISession::state" />)
4473	will not return to "Unlocked" until the remote session has also unlocked
4474	the machine (i.e. the machine has stopped running).
4475
4476	Launching a VM process can take some time (a new VM is started in a new process,
4477	for which memory and other resources need to be set up). Because of this,
4478	an <link to="IProgress" /> object is returned to allow the caller to wait
4479	for this asynchronous operation to be completed. Until then, the caller's
4480	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4481	and <link to="ISession::console" /> attributes cannot be accessed.
4482	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4483	similar calls to wait for completion. Completion is signalled when the VM
4484	is powered on. If launching the VM fails, error messages can be queried
4485	via the progress object, if available.
4486
4487	The progress object will have at least 2 sub-operations. The first
4488	operation covers the period up to the new VM process calls powerUp.
4489	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4490	progress object. Because <link to="IConsole::powerUp"/> may require
4491	some extra sub-operations, the <link to="IProgress::operationCount"/>
4492	may change at the completion of operation.
4493
4494	For details on the teleportation progress operation, see
4495	<link to="IConsole::powerUp"/>.
4496
4497	The @a environment argument is a string containing definitions of
4498	environment variables in the following format:
4499	<pre>
4500	NAME[=VALUE]\n
4501	NAME[=VALUE]\n
4502	...
4503	</pre>
4504	where <tt>\\n</tt> is the new line character. These environment
4505	variables will be appended to the environment of the VirtualBox server
4506	process. If an environment variable exists both in the server process
4507	and in this list, the value from this list takes precedence over the
4508	server's variable. If the value of the environment variable is
4509	omitted, this variable will be removed from the resulting environment.
4510	If the environment string is @c null or empty, the server environment
4511	is inherited by the started process as is.
4512
4513	<result name="E_UNEXPECTED">
4514	Virtual machine not registered.
4515	</result>
4516	<result name="E_INVALIDARG">
4517	Invalid session type @a type.
4518	</result>
4519	<result name="VBOX_E_OBJECT_NOT_FOUND">
4520	No machine matching @a machineId found.
4521	</result>
4522	<result name="VBOX_E_INVALID_OBJECT_STATE">
4523	Session already open or being opened.
4524	</result>
4525	<result name="VBOX_E_IPRT_ERROR">
4526	Launching process for machine failed.
4527	</result>
4528	<result name="VBOX_E_VM_ERROR">
4529	Failed to assign machine to session.
4530	</result>
4531	</desc>
4532	<param name="session" type="ISession" dir="in">
4533	<desc>
4534	Client session object to which the VM process will be connected (this
4535	must be in "Unlocked" state).
4536	</desc>
4537	</param>
4538	<param name="type" type="wstring" dir="in">
4539	<desc>
4540	Front-end to use for the new VM process. The following are currently supported:
4541	<ul>
4542	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4543	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4544	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4545	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4546	the currently running VM or session owner. In this case the
4547	@a session parameter may be @c NULL (if it is non-null it isn't
4548	used in any way), and the @a progress return value will be always
4549	NULL. The operation completes immediately.</li>
4550	</ul>
4551	</desc>
4552	</param>
4553	<param name="environment" type="wstring" dir="in">
4554	<desc>
4555	Environment to pass to the VM process.
4556	</desc>
4557	</param>
4558	<param name="progress" type="IProgress" dir="return">
4559	<desc>Progress object to track the operation completion.</desc>
4560	</param>
4561	</method>
4562
4563	<method name="setBootOrder">
4564	<desc>
4565	Puts the given device to the specified position in
4566	the boot order.
4567
4568	To indicate that no device is associated with the given position,
4569	<link to="DeviceType_Null"/> should be used.
4570
4571	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4572
4573	<result name="E_INVALIDARG">
4574	Boot @a position out of range.
4575	</result>
4576	<result name="E_NOTIMPL">
4577	Booting from USB @a device currently not supported.
4578	</result>
4579
4580	</desc>
4581	<param name="position" type="unsigned long" dir="in">
4582	<desc>
4583	Position in the boot order (@c 1 to the total number of
4584	devices the machine can boot from, as returned by
4585	<link to="ISystemProperties::maxBootPosition"/>).
4586	</desc>
4587	</param>
4588	<param name="device" type="DeviceType" dir="in">
4589	<desc>
4590	The type of the device used to boot at the given position.
4591	</desc>
4592	</param>
4593	</method>
4594
4595	<method name="getBootOrder" const="yes">
4596	<desc>
4597	Returns the device type that occupies the specified
4598	position in the boot order.
4599
4600	@todo [remove?]
4601	If the machine can have more than one device of the returned type
4602	(such as hard disks), then a separate method should be used to
4603	retrieve the individual device that occupies the given position.
4604
4605	If here are no devices at the given position, then
4606	<link to="DeviceType_Null"/> is returned.
4607
4608	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4609
4610	<result name="E_INVALIDARG">
4611	Boot @a position out of range.
4612	</result>
4613
4614	</desc>
4615	<param name="position" type="unsigned long" dir="in">
4616	<desc>
4617	Position in the boot order (@c 1 to the total number of
4618	devices the machine can boot from, as returned by
4619	<link to="ISystemProperties::maxBootPosition"/>).
4620	</desc>
4621	</param>
4622	<param name="device" type="DeviceType" dir="return">
4623	<desc>
4624	Device at the given position.
4625	</desc>
4626	</param>
4627	</method>
4628
4629	<method name="attachDevice">
4630	<desc>
4631	Attaches a device and optionally mounts a medium to the given storage
4632	controller (<link to="IStorageController" />, identified by @a name),
4633	at the indicated port and device.
4634
4635	This method is intended for managing storage devices in general while a
4636	machine is powered off. It can be used to attach and detach fixed
4637	and removable media. The following kind of media can be attached
4638	to a machine:
4639
4640	<ul>
4641	<li>For fixed and removable media, you can pass in a medium that was
4642	previously opened using <link to="IVirtualBox::openMedium" />.
4643	</li>
4644
4645	<li>Only for storage devices supporting removable media (such as
4646	DVDs and floppies), you can also specify a null pointer to
4647	indicate an empty drive or one of the medium objects listed
4648	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4649	arrays to indicate a host drive.
4650	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4651	to change the media while the machine is running.
4652	</li>
4653	</ul>
4654
4655	In a VM's default configuration of virtual machines, the secondary
4656	master of the IDE controller is used for a CD/DVD drive.
4657
4658	After calling this returns successfully, a new instance of
4659	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4660	attachments (see <link to="IMachine::mediumAttachments"/>).
4661
4662	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4663	information about attaching media.
4664
4665	The specified device slot must not have a device attached to it,
4666	or this method will fail.
4667
4668	<note>
4669	You cannot attach a device to a newly created machine until
4670	this machine's settings are saved to disk using
4671	<link to="#saveSettings"/>.
4672	</note>
4673	<note>
4674	If the medium is being attached indirectly, a new differencing medium
4675	will implicitly be created for it and attached instead. If the
4676	changes made to the machine settings (including this indirect
4677	attachment) are later cancelled using <link to="#discardSettings"/>,
4678	this implicitly created differencing medium will implicitly
4679	be deleted.
4680	</note>
4681
4682	<result name="E_INVALIDARG">
4683	SATA device, SATA port, IDE port or IDE slot out of range, or
4684	file or UUID not found.
4685	</result>
4686	<result name="VBOX_E_INVALID_OBJECT_STATE">
4687	Machine must be registered before media can be attached.
4688	</result>
4689	<result name="VBOX_E_INVALID_VM_STATE">
4690	Invalid machine state.
4691	</result>
4692	<result name="VBOX_E_OBJECT_IN_USE">
4693	A medium is already attached to this or another virtual machine.
4694	</result>
4695
4696	</desc>
4697	<param name="name" type="wstring" dir="in">
4698	<desc>Name of the storage controller to attach the device to.</desc>
4699	</param>
4700	<param name="controllerPort" type="long" dir="in">
4701	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4702	the primary controller and 1 specifies the secondary controller.
4703	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4704	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4705	</param>
4706	<param name="device" type="long" dir="in">
4707	<desc>Device slot in the given port to attach the device to. This is only
4708	relevant for IDE controllers, for which 0 specifies the master device and
4709	1 specifies the slave device. For all other controller types, this must
4710	be 0.</desc>
4711	</param>
4712	<param name="type" type="DeviceType" dir="in">
4713	<desc>Device type of the attached device. For media opened by
4714	<link to="IVirtualBox::openMedium" />, this must match the device type
4715	specified there.</desc>
4716	</param>
4717	<param name="medium" type="IMedium" dir="in">
4718	<desc>Medium to mount or NULL for an empty drive.</desc>
4719	</param>
4720	</method>
4721
4722	<method name="detachDevice">
4723	<desc>
4724	Detaches the device attached to a device slot of the specified bus.
4725
4726	Detaching the device from the virtual machine is deferred. This means
4727	that the medium remains associated with the machine when this method
4728	returns and gets actually de-associated only after a successful
4729	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4730	for more detailed information about attaching media.
4731
4732	<note>
4733	You cannot detach a device from a running machine.
4734	</note>
4735	<note>
4736	Detaching differencing media implicitly created by <link
4737	to="#attachDevice"/> for the indirect attachment using this
4738	method will <b>not</b> implicitly delete them. The
4739	<link to="IMedium::deleteStorage"/> operation should be
4740	explicitly performed by the caller after the medium is successfully
4741	detached and the settings are saved with
4742	<link to="#saveSettings"/>, if it is the desired action.
4743	</note>
4744
4745	<result name="VBOX_E_INVALID_VM_STATE">
4746	Attempt to detach medium from a running virtual machine.
4747	</result>
4748	<result name="VBOX_E_OBJECT_NOT_FOUND">
4749	No medium attached to given slot/bus.
4750	</result>
4751	<result name="VBOX_E_NOT_SUPPORTED">
4752	Medium format does not support storage deletion.
4753	</result>
4754
4755	</desc>
4756	<param name="name" type="wstring" dir="in">
4757	<desc>Name of the storage controller to detach the medium from.</desc>
4758	</param>
4759	<param name="controllerPort" type="long" dir="in">
4760	<desc>Port number to detach the medium from.</desc>
4761	</param>
4762	<param name="device" type="long" dir="in">
4763	<desc>Device slot number to detach the medium from.</desc>
4764	</param>
4765	</method>
4766
4767	<method name="passthroughDevice">
4768	<desc>
4769	Sets the passthrough mode of an existing DVD device. Changing the
4770	setting while the VM is running is forbidden. The setting is only used
4771	if at VM start the device is configured as a host DVD drive, in all
4772	other cases it is ignored. The device must already exist; see
4773	<link to="IMachine::attachDevice"/> for how to attach a new device.
4774
4775	The @a controllerPort and @a device parameters specify the device slot and
4776	have have the same meaning as with <link to="IMachine::attachDevice" />.
4777
4778	<result name="E_INVALIDARG">
4779	SATA device, SATA port, IDE port or IDE slot out of range.
4780	</result>
4781	<result name="VBOX_E_INVALID_OBJECT_STATE">
4782	Attempt to modify an unregistered virtual machine.
4783	</result>
4784	<result name="VBOX_E_INVALID_VM_STATE">
4785	Invalid machine state.
4786	</result>
4787
4788	</desc>
4789	<param name="name" type="wstring" dir="in">
4790	<desc>Name of the storage controller.</desc>
4791	</param>
4792	<param name="controllerPort" type="long" dir="in">
4793	<desc>Storage controller port.</desc>
4794	</param>
4795	<param name="device" type="long" dir="in">
4796	<desc>Device slot in the given port.</desc>
4797	</param>
4798	<param name="passthrough" type="boolean" dir="in">
4799	<desc>New value for the passthrough setting.</desc>
4800	</param>
4801	</method>
4802
4803	<method name="temporaryEjectDevice">
4804	<desc>
4805	Sets the behavior for guest-triggered medium eject. In some situations
4806	it is desirable that such ejects update the VM configuration, and in
4807	others the eject should keep the VM configuration. The device must
4808	already exist; see <link to="IMachine::attachDevice"/> for how to
4809	attach a new device.
4810
4811	The @a controllerPort and @a device parameters specify the device slot and
4812	have have the same meaning as with <link to="IMachine::attachDevice" />.
4813
4814	<result name="E_INVALIDARG">
4815	SATA device, SATA port, IDE port or IDE slot out of range.
4816	</result>
4817	<result name="VBOX_E_INVALID_OBJECT_STATE">
4818	Attempt to modify an unregistered virtual machine.
4819	</result>
4820	<result name="VBOX_E_INVALID_VM_STATE">
4821	Invalid machine state.
4822	</result>
4823
4824	</desc>
4825	<param name="name" type="wstring" dir="in">
4826	<desc>Name of the storage controller.</desc>
4827	</param>
4828	<param name="controllerPort" type="long" dir="in">
4829	<desc>Storage controller port.</desc>
4830	</param>
4831	<param name="device" type="long" dir="in">
4832	<desc>Device slot in the given port.</desc>
4833	</param>
4834	<param name="temporaryEject" type="boolean" dir="in">
4835	<desc>New value for the eject behavior.</desc>
4836	</param>
4837	</method>
4838
4839	<method name="nonRotationalDevice">
4840	<desc>
4841	Sets a flag in the device information which indicates that the medium
4842	is not based on rotational technology, i.e. that the access times are
4843	more or less independent of the position on the medium. This may or may
4844	not be supported by a particular drive, and is silently ignored in the
4845	latter case. At the moment only hard disks (which is a misnomer in this
4846	context) accept this setting. Changing the setting while the VM is
4847	running is forbidden. The device must already exist; see
4848	<link to="IMachine::attachDevice"/> for how to attach a new device.
4849
4850	The @a controllerPort and @a device parameters specify the device slot and
4851	have have the same meaning as with <link to="IMachine::attachDevice" />.
4852
4853	<result name="E_INVALIDARG">
4854	SATA device, SATA port, IDE port or IDE slot out of range.
4855	</result>
4856	<result name="VBOX_E_INVALID_OBJECT_STATE">
4857	Attempt to modify an unregistered virtual machine.
4858	</result>
4859	<result name="VBOX_E_INVALID_VM_STATE">
4860	Invalid machine state.
4861	</result>
4862
4863	</desc>
4864	<param name="name" type="wstring" dir="in">
4865	<desc>Name of the storage controller.</desc>
4866	</param>
4867	<param name="controllerPort" type="long" dir="in">
4868	<desc>Storage controller port.</desc>
4869	</param>
4870	<param name="device" type="long" dir="in">
4871	<desc>Device slot in the given port.</desc>
4872	</param>
4873	<param name="nonRotational" type="boolean" dir="in">
4874	<desc>New value for the non-rotational device flag.</desc>
4875	</param>
4876	</method>
4877
4878	<method name="setAutoDiscardForDevice">
4879	<desc>
4880	Sets a flag in the device information which indicates that the medium
4881	supports discarding unsused blocks (called trimming for SATA or unmap
4882	for SCSI devices) .This may or may not be supported by a particular drive,
4883	and is silently ignored in the latter case. At the moment only hard disks
4884	(which is a misnomer in this context) accept this setting. Changing the
4885	setting while the VM is running is forbidden. The device must already
4886	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
4887	device.
4888
4889	The @a controllerPort and @a device parameters specify the device slot and
4890	have have the same meaning as with <link to="IMachine::attachDevice" />.
4891
4892	<result name="E_INVALIDARG">
4893	SATA device, SATA port, SCSI port out of range.
4894	</result>
4895	<result name="VBOX_E_INVALID_OBJECT_STATE">
4896	Attempt to modify an unregistered virtual machine.
4897	</result>
4898	<result name="VBOX_E_INVALID_VM_STATE">
4899	Invalid machine state.
4900	</result>
4901
4902	</desc>
4903	<param name="name" type="wstring" dir="in">
4904	<desc>Name of the storage controller.</desc>
4905	</param>
4906	<param name="controllerPort" type="long" dir="in">
4907	<desc>Storage controller port.</desc>
4908	</param>
4909	<param name="device" type="long" dir="in">
4910	<desc>Device slot in the given port.</desc>
4911	</param>
4912	<param name="discard" type="boolean" dir="in">
4913	<desc>New value for the discard device flag.</desc>
4914	</param>
4915	</method>
4916
4917	<method name="setBandwidthGroupForDevice">
4918	<desc>
4919	Sets the bandwidth group of an existing storage device.
4920	The device must already exist; see <link to="IMachine::attachDevice"/>
4921	for how to attach a new device.
4922
4923	The @a controllerPort and @a device parameters specify the device slot and
4924	have have the same meaning as with <link to="IMachine::attachDevice" />.
4925
4926	<result name="E_INVALIDARG">
4927	SATA device, SATA port, IDE port or IDE slot out of range.
4928	</result>
4929	<result name="VBOX_E_INVALID_OBJECT_STATE">
4930	Attempt to modify an unregistered virtual machine.
4931	</result>
4932	<result name="VBOX_E_INVALID_VM_STATE">
4933	Invalid machine state.
4934	</result>
4935
4936	</desc>
4937	<param name="name" type="wstring" dir="in">
4938	<desc>Name of the storage controller.</desc>
4939	</param>
4940	<param name="controllerPort" type="long" dir="in">
4941	<desc>Storage controller port.</desc>
4942	</param>
4943	<param name="device" type="long" dir="in">
4944	<desc>Device slot in the given port.</desc>
4945	</param>
4946	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4947	<desc>New value for the bandwidth group or NULL for no group.</desc>
4948	</param>
4949	</method>
4950
4951	<method name="mountMedium">
4952	<desc>
4953	Mounts a medium (<link to="IMedium" />, identified
4954	by the given UUID @a id) to the given storage controller
4955	(<link to="IStorageController" />, identified by @a name),
4956	at the indicated port and device. The device must already exist;
4957	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4958
4959	This method is intended only for managing removable media, where the
4960	device is fixed but media is changeable at runtime (such as DVDs
4961	and floppies). It cannot be used for fixed media such as hard disks.
4962
4963	The @a controllerPort and @a device parameters specify the device slot and
4964	have have the same meaning as with <link to="IMachine::attachDevice" />.
4965
4966	The specified device slot can have a medium mounted, which will be
4967	unmounted first. Specifying a zero UUID (or an empty string) for
4968	@a medium does just an unmount.
4969
4970	See <link to="IMedium"/> for more detailed information about
4971	attaching media.
4972
4973	<result name="E_INVALIDARG">
4974	SATA device, SATA port, IDE port or IDE slot out of range.
4975	</result>
4976	<result name="VBOX_E_INVALID_OBJECT_STATE">
4977	Attempt to attach medium to an unregistered virtual machine.
4978	</result>
4979	<result name="VBOX_E_INVALID_VM_STATE">
4980	Invalid machine state.
4981	</result>
4982	<result name="VBOX_E_OBJECT_IN_USE">
4983	Medium already attached to this or another virtual machine.
4984	</result>
4985
4986	</desc>
4987	<param name="name" type="wstring" dir="in">
4988	<desc>Name of the storage controller to attach the medium to.</desc>
4989	</param>
4990	<param name="controllerPort" type="long" dir="in">
4991	<desc>Port to attach the medium to.</desc>
4992	</param>
4993	<param name="device" type="long" dir="in">
4994	<desc>Device slot in the given port to attach the medium to.</desc>
4995	</param>
4996	<param name="medium" type="IMedium" dir="in">
4997	<desc>Medium to mount or NULL for an empty drive.</desc>
4998	</param>
4999	<param name="force" type="boolean" dir="in">
5000	<desc>Allows to force unmount/mount of a medium which is locked by
5001	the device slot in the given port to attach the medium to.</desc>
5002	</param>
5003	</method>
5004
5005	<method name="getMedium" const="yes">
5006	<desc>
5007	Returns the virtual medium attached to a device slot of the specified
5008	bus.
5009
5010	Note that if the medium was indirectly attached by
5011	<link to="#mountMedium"/> to the given device slot then this
5012	method will return not the same object as passed to the
5013	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5014	more detailed information about mounting a medium.
5015
5016	<result name="VBOX_E_OBJECT_NOT_FOUND">
5017	No medium attached to given slot/bus.
5018	</result>
5019
5020	</desc>
5021	<param name="name" type="wstring" dir="in">
5022	<desc>Name of the storage controller the medium is attached to.</desc>
5023	</param>
5024	<param name="controllerPort" type="long" dir="in">
5025	<desc>Port to query.</desc>
5026	</param>
5027	<param name="device" type="long" dir="in">
5028	<desc>Device slot in the given port to query.</desc>
5029	</param>
5030	<param name="medium" type="IMedium" dir="return">
5031	<desc>Attached medium object.</desc>
5032	</param>
5033	</method>
5034
5035	<method name="getMediumAttachmentsOfController" const="yes">
5036	<desc>
5037	Returns an array of medium attachments which are attached to the
5038	the controller with the given name.
5039
5040	<result name="VBOX_E_OBJECT_NOT_FOUND">
5041	A storage controller with given name doesn't exist.
5042	</result>
5043	</desc>
5044	<param name="name" type="wstring" dir="in"/>
5045	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5046	</method>
5047
5048	<method name="getMediumAttachment" const="yes">
5049	<desc>
5050	Returns a medium attachment which corresponds to the controller with
5051	the given name, on the given port and device slot.
5052
5053	<result name="VBOX_E_OBJECT_NOT_FOUND">
5054	No attachment exists for the given controller/port/device combination.
5055	</result>
5056	</desc>
5057	<param name="name" type="wstring" dir="in"/>
5058	<param name="controllerPort" type="long" dir="in"/>
5059	<param name="device" type="long" dir="in"/>
5060	<param name="attachment" type="IMediumAttachment" dir="return"/>
5061	</method>
5062
5063	<method name="attachHostPciDevice">
5064	<desc>
5065	Attaches host PCI device with the given (host) PCI address to the
5066	PCI bus of the virtual machine. Please note, that this operation
5067	is two phase, as real attachment will happen when VM will start,
5068	and most information will be delivered as IHostPciDevicePlugEvent
5069	on IVirtualBox event source.
5070
5071	<see><link to="IHostPciDevicePlugEvent"/></see>
5072
5073	<result name="VBOX_E_INVALID_VM_STATE">
5074	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5075	</result>
5076	<result name="VBOX_E_PDM_ERROR">
5077	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5078	</result>
5079	<result name="VBOX_E_NOT_SUPPORTED">
5080	Hardware or host OS doesn't allow PCI device passthrought.
5081	</result>
5082	</desc>
5083	<param name="hostAddress" type="long" dir="in">
5084	<desc>Address of the host PCI device.</desc>
5085	</param>
5086	<param name="desiredGuestAddress" type="long" dir="in">
5087	<desc>Desired position of this device on guest PCI bus.</desc>
5088	</param>
5089	<param name="tryToUnbind" type="boolean" dir="in">
5090	<desc>If VMM shall try to unbind existing drivers from the
5091	device before attaching it to the guest.</desc>
5092	</param>
5093	</method>
5094
5095	<method name="detachHostPciDevice">
5096	<desc>
5097	Detach host PCI device from the virtual machine.
5098	Also HostPciDevicePlugEvent on IVirtualBox event source
5099	will be delivered. As currently we don't support hot device
5100	unplug, IHostPciDevicePlugEvent event is delivered immediately.
5101
5102	<see><link to="IHostPciDevicePlugEvent"/></see>
5103
5104	<result name="VBOX_E_INVALID_VM_STATE">
5105	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5106	</result>
5107	<result name="VBOX_E_OBJECT_NOT_FOUND">
5108	This host device is not attached to this machine.
5109	</result>
5110	<result name="VBOX_E_PDM_ERROR">
5111	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5112	</result>
5113	<result name="VBOX_E_NOT_SUPPORTED">
5114	Hardware or host OS doesn't allow PCI device passthrought.
5115	</result>
5116	</desc>
5117	<param name="hostAddress" type="long" dir="in">
5118	<desc>Address of the host PCI device.</desc>
5119	</param>
5120	</method>
5121
5122	<method name="getNetworkAdapter" const="yes">
5123	<desc>
5124	Returns the network adapter associated with the given slot.
5125	Slots are numbered sequentially, starting with zero. The total
5126	number of adapters per machine is defined by the
5127	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5128	so the maximum slot number is one less than that property's value.
5129
5130	<result name="E_INVALIDARG">
5131	Invalid @a slot number.
5132	</result>
5133
5134	</desc>
5135	<param name="slot" type="unsigned long" dir="in"/>
5136	<param name="adapter" type="INetworkAdapter" dir="return"/>
5137	</method>
5138
5139	<method name="addStorageController">
5140	<desc>
5141	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5142	machine and returns it as an instance of
5143	<link to="IStorageController" />.
5144
5145	@a name identifies the controller for subsequent calls such as
5146	<link to="#getStorageControllerByName" />,
5147	<link to="#getStorageControllerByInstance" />,
5148	<link to="#removeStorageController" />,
5149	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5150
5151	After the controller has been added, you can set its exact
5152	type by setting the <link to="IStorageController::controllerType" />.
5153
5154	<result name="VBOX_E_OBJECT_IN_USE">
5155	A storage controller with given name exists already.
5156	</result>
5157	<result name="E_INVALIDARG">
5158	Invalid @a controllerType.
5159	</result>
5160	</desc>
5161	<param name="name" type="wstring" dir="in"/>
5162	<param name="connectionType" type="StorageBus" dir="in"/>
5163	<param name="controller" type="IStorageController" dir="return"/>
5164	</method>
5165
5166	<method name="getStorageControllerByName" const="yes">
5167	<desc>
5168	Returns a storage controller with the given name.
5169
5170	<result name="VBOX_E_OBJECT_NOT_FOUND">
5171	A storage controller with given name doesn't exist.
5172	</result>
5173	</desc>
5174	<param name="name" type="wstring" dir="in"/>
5175	<param name="storageController" type="IStorageController" dir="return"/>
5176	</method>
5177
5178	<method name="getStorageControllerByInstance" const="yes">
5179	<desc>
5180	Returns a storage controller with the given instance number.
5181
5182	<result name="VBOX_E_OBJECT_NOT_FOUND">
5183	A storage controller with given instance number doesn't exist.
5184	</result>
5185	</desc>
5186	<param name="instance" type="unsigned long" dir="in"/>
5187	<param name="storageController" type="IStorageController" dir="return"/>
5188	</method>
5189
5190	<method name="removeStorageController">
5191	<desc>
5192	Removes a storage controller from the machine.
5193
5194	<result name="VBOX_E_OBJECT_NOT_FOUND">
5195	A storage controller with given name doesn't exist.
5196	</result>
5197	</desc>
5198	<param name="name" type="wstring" dir="in"/>
5199	</method>
5200
5201	<method name="setStorageControllerBootable">
5202	<desc>
5203	Sets the bootable flag of the storage controller with the given name.
5204
5205	<result name="VBOX_E_OBJECT_NOT_FOUND">
5206	A storage controller with given name doesn't exist.
5207	</result>
5208	<result name="VBOX_E_OBJECT_IN_USE">
5209	Another storage controller is marked as bootable already.
5210	</result>
5211	</desc>
5212	<param name="name" type="wstring" dir="in"/>
5213	<param name="bootable" type="boolean" dir="in"/>
5214	</method>
5215
5216	<method name="getSerialPort" const="yes">
5217	<desc>
5218	Returns the serial port associated with the given slot.
5219	Slots are numbered sequentially, starting with zero. The total
5220	number of serial ports per machine is defined by the
5221	<link to="ISystemProperties::serialPortCount"/> property,
5222	so the maximum slot number is one less than that property's value.
5223
5224	<result name="E_INVALIDARG">
5225	Invalid @a slot number.
5226	</result>
5227
5228	</desc>
5229	<param name="slot" type="unsigned long" dir="in"/>
5230	<param name="port" type="ISerialPort" dir="return"/>
5231	</method>
5232
5233	<method name="getParallelPort" const="yes">
5234	<desc>
5235	Returns the parallel port associated with the given slot.
5236	Slots are numbered sequentially, starting with zero. The total
5237	number of parallel ports per machine is defined by the
5238	<link to="ISystemProperties::parallelPortCount"/> property,
5239	so the maximum slot number is one less than that property's value.
5240
5241	<result name="E_INVALIDARG">
5242	Invalid @a slot number.
5243	</result>
5244
5245	</desc>
5246	<param name="slot" type="unsigned long" dir="in"/>
5247	<param name="port" type="IParallelPort" dir="return"/>
5248	</method>
5249
5250	<method name="getExtraDataKeys">
5251	<desc>
5252	Returns an array representing the machine-specific extra data keys
5253	which currently have values defined.
5254	</desc>
5255	<param name="value" type="wstring" dir="return" safearray="yes">
5256	<desc>Array of extra data keys.</desc>
5257	</param>
5258	</method>
5259
5260	<method name="getExtraData">
5261	<desc>
5262	Returns associated machine-specific extra data.
5263
5264	If the requested data @a key does not exist, this function will
5265	succeed and return an empty string in the @a value argument.
5266
5267	<result name="VBOX_E_FILE_ERROR">
5268	Settings file not accessible.
5269	</result>
5270	<result name="VBOX_E_XML_ERROR">
5271	Could not parse the settings file.
5272	</result>
5273
5274	</desc>
5275	<param name="key" type="wstring" dir="in">
5276	<desc>Name of the data key to get.</desc>
5277	</param>
5278	<param name="value" type="wstring" dir="return">
5279	<desc>Value of the requested data key.</desc>
5280	</param>
5281	</method>
5282
5283	<method name="setExtraData">
5284	<desc>
5285	Sets associated machine-specific extra data.
5286
5287	If you pass @c null or an empty string as a key @a value, the given
5288	@a key will be deleted.
5289
5290	<note>
5291	Before performing the actual data change, this method will ask all
5292	registered listeners using the
5293	<link to="IExtraDataCanChangeEvent"/>
5294	notification for a permission. If one of the listeners refuses the
5295	new value, the change will not be performed.
5296	</note>
5297	<note>
5298	On success, the
5299	<link to="IExtraDataChangedEvent"/> notification
5300	is called to inform all registered listeners about a successful data
5301	change.
5302	</note>
5303	<note>
5304	This method can be called outside the machine session and therefore
5305	it's a caller's responsibility to handle possible race conditions
5306	when several clients change the same key at the same time.
5307	</note>
5308
5309	<result name="VBOX_E_FILE_ERROR">
5310	Settings file not accessible.
5311	</result>
5312	<result name="VBOX_E_XML_ERROR">
5313	Could not parse the settings file.
5314	</result>
5315
5316	</desc>
5317	<param name="key" type="wstring" dir="in">
5318	<desc>Name of the data key to set.</desc>
5319	</param>
5320	<param name="value" type="wstring" dir="in">
5321	<desc>Value to assign to the key.</desc>
5322	</param>
5323	</method>
5324
5325	<method name="getCPUProperty" const="yes">
5326	<desc>
5327	Returns the virtual CPU boolean value of the specified property.
5328
5329	<result name="E_INVALIDARG">
5330	Invalid property.
5331	</result>
5332
5333	</desc>
5334	<param name="property" type="CPUPropertyType" dir="in">
5335	<desc>
5336	Property type to query.
5337	</desc>
5338	</param>
5339	<param name="value" type="boolean" dir="return">
5340	<desc>
5341	Property value.
5342	</desc>
5343	</param>
5344	</method>
5345
5346	<method name="setCPUProperty">
5347	<desc>
5348	Sets the virtual CPU boolean value of the specified property.
5349
5350	<result name="E_INVALIDARG">
5351	Invalid property.
5352	</result>
5353
5354	</desc>
5355	<param name="property" type="CPUPropertyType" dir="in">
5356	<desc>
5357	Property type to query.
5358	</desc>
5359	</param>
5360	<param name="value" type="boolean" dir="in">
5361	<desc>
5362	Property value.
5363	</desc>
5364	</param>
5365	</method>
5366
5367	<method name="getCPUIDLeaf" const="yes">
5368	<desc>
5369	Returns the virtual CPU cpuid information for the specified leaf.
5370
5371	Currently supported index values for cpuid:
5372	Standard CPUID leafs: 0 - 0xA
5373	Extended CPUID leafs: 0x80000000 - 0x8000000A
5374
5375	See the Intel and AMD programmer's manuals for detailed information
5376	about the cpuid instruction and its leafs.
5377	<result name="E_INVALIDARG">
5378	Invalid id.
5379	</result>
5380
5381	</desc>
5382	<param name="id" type="unsigned long" dir="in">
5383	<desc>
5384	CPUID leaf index.
5385	</desc>
5386	</param>
5387	<param name="valEax" type="unsigned long" dir="out">
5388	<desc>
5389	CPUID leaf value for register eax.
5390	</desc>
5391	</param>
5392	<param name="valEbx" type="unsigned long" dir="out">
5393	<desc>
5394	CPUID leaf value for register ebx.
5395	</desc>
5396	</param>
5397	<param name="valEcx" type="unsigned long" dir="out">
5398	<desc>
5399	CPUID leaf value for register ecx.
5400	</desc>
5401	</param>
5402	<param name="valEdx" type="unsigned long" dir="out">
5403	<desc>
5404	CPUID leaf value for register edx.
5405	</desc>
5406	</param>
5407	</method>
5408
5409	<method name="setCPUIDLeaf">
5410	<desc>
5411	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5412	are not passed unmodified. VirtualBox clears features that it doesn't support.
5413
5414	Currently supported index values for cpuid:
5415	Standard CPUID leafs: 0 - 0xA
5416	Extended CPUID leafs: 0x80000000 - 0x8000000A
5417
5418	See the Intel and AMD programmer's manuals for detailed information
5419	about the cpuid instruction and its leafs.
5420
5421	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5422	random crashes inside VMs.
5423	<result name="E_INVALIDARG">
5424	Invalid id.
5425	</result>
5426
5427	</desc>
5428	<param name="id" type="unsigned long" dir="in">
5429	<desc>
5430	CPUID leaf index.
5431	</desc>
5432	</param>
5433	<param name="valEax" type="unsigned long" dir="in">
5434	<desc>
5435	CPUID leaf value for register eax.
5436	</desc>
5437	</param>
5438	<param name="valEbx" type="unsigned long" dir="in">
5439	<desc>
5440	CPUID leaf value for register ebx.
5441	</desc>
5442	</param>
5443	<param name="valEcx" type="unsigned long" dir="in">
5444	<desc>
5445	CPUID leaf value for register ecx.
5446	</desc>
5447	</param>
5448	<param name="valEdx" type="unsigned long" dir="in">
5449	<desc>
5450	CPUID leaf value for register edx.
5451	</desc>
5452	</param>
5453	</method>
5454
5455	<method name="removeCPUIDLeaf">
5456	<desc>
5457	Removes the virtual CPU cpuid leaf for the specified index
5458
5459	<result name="E_INVALIDARG">
5460	Invalid id.
5461	</result>
5462
5463	</desc>
5464	<param name="id" type="unsigned long" dir="in">
5465	<desc>
5466	CPUID leaf index.
5467	</desc>
5468	</param>
5469	</method>
5470
5471	<method name="removeAllCPUIDLeaves">
5472	<desc>
5473	Removes all the virtual CPU cpuid leaves
5474	</desc>
5475	</method>
5476
5477	<method name="getHWVirtExProperty" const="yes">
5478	<desc>
5479	Returns the value of the specified hardware virtualization boolean property.
5480
5481	<result name="E_INVALIDARG">
5482	Invalid property.
5483	</result>
5484
5485	</desc>
5486	<param name="property" type="HWVirtExPropertyType" dir="in">
5487	<desc>
5488	Property type to query.
5489	</desc>
5490	</param>
5491	<param name="value" type="boolean" dir="return">
5492	<desc>
5493	Property value.
5494	</desc>
5495	</param>
5496	</method>
5497
5498	<method name="setHWVirtExProperty">
5499	<desc>
5500	Sets a new value for the specified hardware virtualization boolean property.
5501
5502	<result name="E_INVALIDARG">
5503	Invalid property.
5504	</result>
5505
5506	</desc>
5507	<param name="property" type="HWVirtExPropertyType" dir="in">
5508	<desc>
5509	Property type to set.
5510	</desc>
5511	</param>
5512	<param name="value" type="boolean" dir="in">
5513	<desc>
5514	New property value.
5515	</desc>
5516	</param>
5517	</method>
5518
5519	<method name="saveSettings">
5520	<desc>
5521	Saves any changes to machine settings made since the session
5522	has been opened or a new machine has been created, or since the
5523	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5524	For registered machines, new settings become visible to all
5525	other VirtualBox clients after successful invocation of this
5526	method.
5527	<note>
5528	The method sends <link to="IMachineDataChangedEvent"/>
5529	notification event after the configuration has been successfully
5530	saved (only for registered machines).
5531	</note>
5532	<note>
5533	Calling this method is only valid on instances returned
5534	by <link to="ISession::machine"/> and on new machines
5535	created by <link to="IVirtualBox::createMachine"/> but not
5536	yet registered, or on unregistered machines after calling
5537	<link to="IMachine::unregister"/>.
5538	</note>
5539
5540	<result name="VBOX_E_FILE_ERROR">
5541	Settings file not accessible.
5542	</result>
5543	<result name="VBOX_E_XML_ERROR">
5544	Could not parse the settings file.
5545	</result>
5546	<result name="E_ACCESSDENIED">
5547	Modification request refused.
5548	</result>
5549
5550	</desc>
5551	</method>
5552
5553	<method name="discardSettings">
5554	<desc>
5555	Discards any changes to the machine settings made since the session
5556	has been opened or since the last call to <link to="#saveSettings"/>
5557	or <link to="#discardSettings"/>.
5558	<note>
5559	Calling this method is only valid on instances returned
5560	by <link to="ISession::machine"/> and on new machines
5561	created by <link to="IVirtualBox::createMachine"/> or
5562	opened by <link to="IVirtualBox::openMachine"/> but not
5563	yet registered, or on unregistered machines after calling
5564	<link to="IMachine::unregister"/>.
5565	</note>
5566
5567	<result name="VBOX_E_INVALID_VM_STATE">
5568	Virtual machine is not mutable.
5569	</result>
5570
5571	</desc>
5572	</method>
5573
5574	<method name="unregister">
5575	<desc>
5576	Unregisters a machine previously registered with
5577	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5578	cleanup before the machine is unregistered.
5579
5580	This method does not delete any files. It only changes the machine configuration and
5581	the list of registered machines in the VirtualBox object. To delete the files which
5582	belonged to the machine, including the XML file of the machine itself, call
5583	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5584	from this method.
5585
5586	How thoroughly this method cleans up the machine configuration before unregistering
5587	the machine depends on the @a cleanupMode argument.
5588
5589	<ul>
5590	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5591	cleanup will be performed. The call will fail if the machine is in "Saved" state
5592	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5593	It is the responsibility of the caller to delete all such configuration in this mode.
5594	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5595	which it replaces.</li>
5596	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5597	state or if it has snapshots or media attached. All media attached to the current machine
5598	state or in snapshots will be detached. No medium objects will be returned;
5599	all of the machine's media will remain open.</li>
5600	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5601	except that all the hard disk medium objects which were detached from the machine will
5602	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5603	API for closing and deletion.</li>
5604	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5605	that all media will be returned in the array, including removable media like DVDs and
5606	floppies. This might be useful if the user wants to inspect in detail which media were
5607	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5608	in that case because users will typically want to preserve ISO and RAW image files.</li>
5609	</ul>
5610
5611	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5612	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5613	deleted with all its saved states and hard disk images, but images for removable
5614	drives (such as ISO and RAW files) will remain on disk.
5615
5616	This API does not verify whether the media files returned in the array are still
5617	attached to other machines (i.e. shared between several machines). If such a shared
5618	image is passed to <link to="#delete" /> however, closing the image will fail there
5619	and the image will be silently skipped.
5620
5621	This API may, however, move media from this machine's media registry to other media
5622	registries (see <link to="IMedium" /> for details on media registries). For machines
5623	created with VirtualBox 4.0 or later, if media from this machine's media registry
5624	are also attached to another machine (shared attachments), each such medium will be
5625	moved to another machine's registry. This is because without this machine's media
5626	registry, the other machine cannot find its media any more and would become inaccessible.
5627
5628	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5629	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
5630	if media are moved to other machines' media registries.
5631
5632	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5633	is fired.
5634
5635	The call will fail if the machine is currently locked (see <link to="ISession" />).
5636
5637	<note>
5638	If the given machine is inaccessible (see <link to="#accessible"/>), it
5639	will be unregistered and fully uninitialized right afterwards. As a result,
5640	the returned machine object will be unusable and an attempt to call
5641	<b>any</b> method will return the "Object not ready" error.
5642	</note>
5643
5644	<result name="VBOX_E_INVALID_OBJECT_STATE">
5645	Machine is currently locked for a session.
5646	</result>
5647	</desc>
5648
5649	<param name="cleanupMode" type="CleanupMode" dir="in">
5650	<desc>How to clean up after the machine has been unregistered.</desc>
5651	</param>
5652	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5653	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5654	</param>
5655	</method>
5656
5657	<method name="delete">
5658	<desc>
5659	Deletes the files associated with this machine from disk. If medium objects are passed
5660	in with the @a aMedia argument, they are closed and, if closing was successful, their
5661	storage files are deleted as well. For convenience, this array of media files can be
5662	the same as the one returned from a previous <link to="#unregister" /> call.
5663
5664	This method must only be called on machines which are either write-locked (i.e. on instances
5665	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5666	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5667	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5668
5669	The following files will be deleted by this method:
5670	<ul>
5671	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5672	argument other than "UnregisterOnly", this will delete all saved state files that
5673	the machine had in use; possibly one if the machine was in "Saved" state and one
5674	for each online snapshot that the machine had.</li>
5675	<li>On each medium object passed in the @a aMedia array, this will call
5676	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5677	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
5678	in use, e.g. because it is still attached to a second machine; in that case the
5679	storage will not be deleted.</li>
5680	<li>Finally, the machine's own XML file will be deleted.</li>
5681	</ul>
5682
5683	Since deleting large disk image files can be a time-consuming I/O operation, this
5684	method operates asynchronously and returns an IProgress object to allow the caller
5685	to monitor the progress. There will be one sub-operation for each file that is
5686	being deleted (saved state or medium storage file).
5687
5688	<note>
5689	<link to="#settingsModified"/> will return @c true after this
5690	method successfully returns.
5691	</note>
5692
5693	<result name="VBOX_E_INVALID_VM_STATE">
5694	Machine is registered but not write-locked.
5695	</result>
5696	<result name="VBOX_E_IPRT_ERROR">
5697	Could not delete the settings file.
5698	</result>
5699	</desc>
5700	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5701	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5702	</param>
5703	<param name="aProgress" type="IProgress" dir="return">
5704	<desc>Progress object to track the operation completion.</desc>
5705	</param>
5706	</method>
5707
5708	<method name="export">
5709	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5710	steps required to export VirtualBox machines to OVF.
5711	</desc>
5712
5713	<param name="aAppliance" type="IAppliance" dir="in">
5714	<desc>Appliance to export this machine to.</desc>
5715	</param>
5716	<param name="location" type="wstring" dir="in">
5717	<desc>The target location.</desc>
5718	</param>
5719	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5720	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5721	</param>
5722	</method >
5723
5724	<method name="findSnapshot">
5725	<desc>
5726	Returns a snapshot of this machine with the given name or UUID.
5727
5728	Returns a snapshot of this machine with the given UUID.
5729	A @c null argument can be used to obtain the first snapshot
5730	taken on this machine. To traverse the whole tree of snapshots
5731	starting from the root, inspect the root snapshot's
5732	<link to="ISnapshot::children" /> attribute and recurse over those children.
5733
5734	<result name="VBOX_E_OBJECT_NOT_FOUND">
5735	Virtual machine has no snapshots or snapshot not found.
5736	</result>
5737
5738	</desc>
5739	<param name="nameOrId" type="wstring" dir="in">
5740	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5741	</param>
5742	<param name="snapshot" type="ISnapshot" dir="return">
5743	<desc>Snapshot object with the given name.</desc>
5744	</param>
5745	</method>
5746
5747	<method name="createSharedFolder">
5748	<desc>
5749	Creates a new permanent shared folder by associating the given logical
5750	name with the given host path, adds it to the collection of shared
5751	folders and starts sharing it. Refer to the description of
5752	<link to="ISharedFolder"/> to read more about logical names.
5753
5754	<result name="VBOX_E_OBJECT_IN_USE">
5755	Shared folder already exists.
5756	</result>
5757	<result name="VBOX_E_FILE_ERROR">
5758	Shared folder @a hostPath not accessible.
5759	</result>
5760
5761	</desc>
5762	<param name="name" type="wstring" dir="in">
5763	<desc>Unique logical name of the shared folder.</desc>
5764	</param>
5765	<param name="hostPath" type="wstring" dir="in">
5766	<desc>Full path to the shared folder in the host file system.</desc>
5767	</param>
5768	<param name="writable" type="boolean" dir="in">
5769	<desc>Whether the share is writable or readonly.</desc>
5770	</param>
5771	<param name="automount" type="boolean" dir="in">
5772	<desc>Whether the share gets automatically mounted by the guest
5773	or not.</desc>
5774	</param>
5775	</method>
5776
5777	<method name="removeSharedFolder">
5778	<desc>
5779	Removes the permanent shared folder with the given name previously
5780	created by <link to="#createSharedFolder"/> from the collection of
5781	shared folders and stops sharing it.
5782
5783	<result name="VBOX_E_INVALID_VM_STATE">
5784	Virtual machine is not mutable.
5785	</result>
5786	<result name="VBOX_E_OBJECT_NOT_FOUND">
5787	Shared folder @a name does not exist.
5788	</result>
5789
5790	</desc>
5791	<param name="name" type="wstring" dir="in">
5792	<desc>Logical name of the shared folder to remove.</desc>
5793	</param>
5794	</method>
5795
5796	<method name="canShowConsoleWindow">
5797	<desc>
5798	Returns @c true if the VM console process can activate the
5799	console window and bring it to foreground on the desktop of
5800	the host PC.
5801	<note>
5802	This method will fail if a session for this machine is not
5803	currently open.
5804	</note>
5805
5806	<result name="VBOX_E_INVALID_VM_STATE">
5807	Machine session is not open.
5808	</result>
5809
5810	</desc>
5811	<param name="canShow" type="boolean" dir="return">
5812	<desc>
5813	@c true if the console window can be shown and @c false otherwise.
5814	</desc>
5815	</param>
5816	</method>
5817
5818	<method name="showConsoleWindow">
5819	<desc>
5820	Activates the console window and brings it to foreground on
5821	the desktop of the host PC. Many modern window managers on
5822	many platforms implement some sort of focus stealing
5823	prevention logic, so that it may be impossible to activate
5824	a window without the help of the currently active
5825	application. In this case, this method will return a non-zero
5826	identifier that represents the top-level window of the VM
5827	console process. The caller, if it represents a currently
5828	active process, is responsible to use this identifier (in a
5829	platform-dependent manner) to perform actual window
5830	activation.
5831	<note>
5832	This method will fail if a session for this machine is not
5833	currently open.
5834	</note>
5835
5836	<result name="VBOX_E_INVALID_VM_STATE">
5837	Machine session is not open.
5838	</result>
5839
5840	</desc>
5841	<param name="winId" type="long long" dir="return">
5842	<desc>
5843	Platform-dependent identifier of the top-level VM console
5844	window, or zero if this method has performed all actions
5845	necessary to implement the <i>show window</i> semantics for
5846	the given platform and/or VirtualBox front-end.
5847	</desc>
5848	</param>
5849	</method>
5850
5851	<method name="getGuestProperty" const="yes">
5852	<desc>
5853	Reads an entry from the machine's guest property store.
5854
5855	<result name="VBOX_E_INVALID_VM_STATE">
5856	Machine session is not open.
5857	</result>
5858
5859	</desc>
5860	<param name="name" type="wstring" dir="in">
5861	<desc>
5862	The name of the property to read.
5863	</desc>
5864	</param>
5865	<param name="value" type="wstring" dir="out">
5866	<desc>
5867	The value of the property. If the property does not exist then this
5868	will be empty.
5869	</desc>
5870	</param>
5871	<param name="timestamp" type="long long" dir="out">
5872	<desc>
5873	The time at which the property was last modified, as seen by the
5874	server process.
5875	</desc>
5876	</param>
5877	<param name="flags" type="wstring" dir="out">
5878	<desc>
5879	Additional property parameters, passed as a comma-separated list of
5880	"name=value" type entries.
5881	</desc>
5882	</param>
5883	</method>
5884
5885	<method name="getGuestPropertyValue" const="yes">
5886	<desc>
5887	Reads a value from the machine's guest property store.
5888
5889	<result name="VBOX_E_INVALID_VM_STATE">
5890	Machine session is not open.
5891	</result>
5892
5893	</desc>
5894	<param name="property" type="wstring" dir="in">
5895	<desc>
5896	The name of the property to read.
5897	</desc>
5898	</param>
5899	<param name="value" type="wstring" dir="return">
5900	<desc>
5901	The value of the property. If the property does not exist then this
5902	will be empty.
5903	</desc>
5904	</param>
5905	</method>
5906
5907	<method name="getGuestPropertyTimestamp" const="yes">
5908	<desc>
5909	Reads a property timestamp from the machine's guest property store.
5910
5911	<result name="VBOX_E_INVALID_VM_STATE">
5912	Machine session is not open.
5913	</result>
5914
5915	</desc>
5916	<param name="property" type="wstring" dir="in">
5917	<desc>
5918	The name of the property to read.
5919	</desc>
5920	</param>
5921	<param name="value" type="long long" dir="return">
5922	<desc>
5923	The timestamp. If the property does not exist then this will be
5924	empty.
5925	</desc>
5926	</param>
5927	</method>
5928
5929	<method name="setGuestProperty">
5930	<desc>
5931	Sets, changes or deletes an entry in the machine's guest property
5932	store.
5933
5934	<result name="E_ACCESSDENIED">
5935	Property cannot be changed.
5936	</result>
5937	<result name="E_INVALIDARG">
5938	Invalid @a flags.
5939	</result>
5940	<result name="VBOX_E_INVALID_VM_STATE">
5941	Virtual machine is not mutable or session not open.
5942	</result>
5943	<result name="VBOX_E_INVALID_OBJECT_STATE">
5944	Cannot set transient property when machine not running.
5945	</result>
5946
5947	</desc>
5948	<param name="property" type="wstring" dir="in">
5949	<desc>
5950	The name of the property to set, change or delete.
5951	</desc>
5952	</param>
5953	<param name="value" type="wstring" dir="in">
5954	<desc>
5955	The new value of the property to set, change or delete. If the
5956	property does not yet exist and value is non-empty, it will be
5957	created. If the value is @c null or empty, the property will be
5958	deleted if it exists.
5959	</desc>
5960	</param>
5961	<param name="flags" type="wstring" dir="in">
5962	<desc>
5963	Additional property parameters, passed as a comma-separated list of
5964	"name=value" type entries.
5965	</desc>
5966	</param>
5967	</method>
5968
5969	<method name="setGuestPropertyValue">
5970	<desc>
5971	Sets, changes or deletes a value in the machine's guest property
5972	store. The flags field will be left unchanged or created empty for a
5973	new property.
5974
5975	<result name="E_ACCESSDENIED">
5976	Property cannot be changed.
5977	</result>
5978	<result name="VBOX_E_INVALID_VM_STATE">
5979	Virtual machine is not mutable or session not open.
5980	</result>
5981	<result name="VBOX_E_INVALID_OBJECT_STATE">
5982	Cannot set transient property when machine not running.
5983	</result>
5984	</desc>
5985
5986	<param name="property" type="wstring" dir="in">
5987	<desc>
5988	The name of the property to set, change or delete.
5989	</desc>
5990	</param>
5991	<param name="value" type="wstring" dir="in">
5992	<desc>
5993	The new value of the property to set, change or delete. If the
5994	property does not yet exist and value is non-empty, it will be
5995	created. If the value is @c null or empty, the property will be
5996	deleted if it exists.
5997	</desc>
5998	</param>
5999	</method>
6000
6001	<method name="deleteGuestProperty" const="yes">
6002	<desc>
6003	Deletes an entry from the machine's guest property store.
6004
6005	<result name="VBOX_E_INVALID_VM_STATE">
6006	Machine session is not open.
6007	</result>
6008
6009	</desc>
6010	<param name="name" type="wstring" dir="in">
6011	<desc>
6012	The name of the property to delete.
6013	</desc>
6014	</param>
6015	</method>
6016
6017	<method name="enumerateGuestProperties" const="yes">
6018	<desc>
6019	Return a list of the guest properties matching a set of patterns along
6020	with their values, time stamps and flags.
6021	</desc>
6022	<param name="patterns" type="wstring" dir="in">
6023	<desc>
6024	The patterns to match the properties against, separated by '\|'
6025	characters. If this is empty or @c null, all properties will match.
6026	</desc>
6027	</param>
6028	<param name="name" type="wstring" dir="out" safearray="yes">
6029	<desc>
6030	The names of the properties returned.
6031	</desc>
6032	</param>
6033	<param name="value" type="wstring" dir="out" safearray="yes">
6034	<desc>
6035	The values of the properties returned. The array entries match the
6036	corresponding entries in the @a name array.
6037	</desc>
6038	</param>
6039	<param name="timestamp" type="long long" dir="out" safearray="yes">
6040	<desc>
6041	The time stamps of the properties returned. The array entries match
6042	the corresponding entries in the @a name array.
6043	</desc>
6044	</param>
6045	<param name="flags" type="wstring" dir="out" safearray="yes">
6046	<desc>
6047	The flags of the properties returned. The array entries match the
6048	corresponding entries in the @a name array.
6049	</desc>
6050	</param>
6051	</method>
6052
6053	<method name="querySavedGuestSize" const="yes">
6054	<desc>
6055	Returns the guest dimensions from the saved state.
6056	</desc>
6057	<param name="screenId" type="unsigned long" dir="in">
6058	<desc>
6059	Saved guest screen to query info from.
6060	</desc>
6061	</param>
6062	<param name="width" type="unsigned long" dir="out">
6063	<desc>
6064	Guest width at the time of the saved state was taken.
6065	</desc>
6066	</param>
6067	<param name="height" type="unsigned long" dir="out">
6068	<desc>
6069	Guest height at the time of the saved state was taken.
6070	</desc>
6071	</param>
6072	</method>
6073
6074	<method name="querySavedThumbnailSize">
6075	<desc>
6076	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
6077	</desc>
6078	<param name="screenId" type="unsigned long" dir="in">
6079	<desc>
6080	Saved guest screen to query info from.
6081	</desc>
6082	</param>
6083	<param name="size" type="unsigned long" dir="out">
6084	<desc>
6085	Size of buffer required to store the bitmap.
6086	</desc>
6087	</param>
6088	<param name="width" type="unsigned long" dir="out">
6089	<desc>
6090	Bitmap width.
6091	</desc>
6092	</param>
6093	<param name="height" type="unsigned long" dir="out">
6094	<desc>
6095	Bitmap height.
6096	</desc>
6097	</param>
6098	</method>
6099
6100	<method name="readSavedThumbnailToArray">
6101	<desc>
6102	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
6103	</desc>
6104	<param name="screenId" type="unsigned long" dir="in">
6105	<desc>
6106	Saved guest screen to read from.
6107	</desc>
6108	</param>
6109	<param name="BGR" type="boolean" dir="in">
6110	<desc>
6111	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6112	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
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	<param name="data" type="octet" safearray="yes" dir="return">
6126	<desc>
6127	Array with resulting bitmap data.
6128	</desc>
6129	</param>
6130	</method>
6131
6132	<method name="readSavedThumbnailPNGToArray">
6133	<desc>
6134	Thumbnail in PNG format is retrieved to an array of bytes.
6135	</desc>
6136	<param name="screenId" type="unsigned long" dir="in">
6137	<desc>
6138	Saved guest screen to read from.
6139	</desc>
6140	</param>
6141	<param name="width" type="unsigned long" dir="out">
6142	<desc>
6143	Image width.
6144	</desc>
6145	</param>
6146	<param name="height" type="unsigned long" dir="out">
6147	<desc>
6148	Image height.
6149	</desc>
6150	</param>
6151	<param name="data" type="octet" dir="return" safearray="yes">
6152	<desc>
6153	Array with resulting PNG data.
6154	</desc>
6155	</param>
6156	</method>
6157
6158	<method name="querySavedScreenshotPNGSize">
6159	<desc>
6160	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6161	</desc>
6162	<param name="screenId" type="unsigned long" dir="in">
6163	<desc>
6164	Saved guest screen to query info from.
6165	</desc>
6166	</param>
6167	<param name="size" type="unsigned long" dir="out">
6168	<desc>
6169	Size of buffer required to store the PNG binary data.
6170	</desc>
6171	</param>
6172	<param name="width" type="unsigned long" dir="out">
6173	<desc>
6174	Image width.
6175	</desc>
6176	</param>
6177	<param name="height" type="unsigned long" dir="out">
6178	<desc>
6179	Image height.
6180	</desc>
6181	</param>
6182	</method>
6183
6184	<method name="readSavedScreenshotPNGToArray">
6185	<desc>
6186	Screenshot in PNG format is retrieved to an array of bytes.
6187	</desc>
6188	<param name="screenId" type="unsigned long" dir="in">
6189	<desc>
6190	Saved guest screen to read from.
6191	</desc>
6192	</param>
6193	<param name="width" type="unsigned long" dir="out">
6194	<desc>
6195	Image width.
6196	</desc>
6197	</param>
6198	<param name="height" type="unsigned long" dir="out">
6199	<desc>
6200	Image height.
6201	</desc>
6202	</param>
6203	<param name="data" type="octet" dir="return" safearray="yes">
6204	<desc>
6205	Array with resulting PNG data.
6206	</desc>
6207	</param>
6208	</method>
6209
6210	<method name="hotPlugCPU">
6211	<desc>
6212	Plugs a CPU into the machine.
6213	</desc>
6214	<param name="cpu" type="unsigned long" dir="in">
6215	<desc>
6216	The CPU id to insert.
6217	</desc>
6218	</param>
6219	</method>
6220
6221	<method name="hotUnplugCPU">
6222	<desc>
6223	Removes a CPU from the machine.
6224	</desc>
6225	<param name="cpu" type="unsigned long" dir="in">
6226	<desc>
6227	The CPU id to remove.
6228	</desc>
6229	</param>
6230	</method>
6231
6232	<method name="getCPUStatus">
6233	<desc>
6234	Returns the current status of the given CPU.
6235	</desc>
6236	<param name="cpu" type="unsigned long" dir="in">
6237	<desc>
6238	The CPU id to check for.
6239	</desc>
6240	</param>
6241	<param name="attached" type="boolean" dir="return">
6242	<desc>
6243	Status of the CPU.
6244	</desc>
6245	</param>
6246	</method>
6247
6248	<method name="queryLogFilename">
6249	<desc>
6250	Queries for the VM log file name of an given index. Returns an empty
6251	string if a log file with that index doesn't exists.
6252	</desc>
6253	<param name="idx" type="unsigned long" dir="in">
6254	<desc>
6255	Which log file name to query. 0=current log file.
6256	</desc>
6257	</param>
6258	<param name="filename" type="wstring" dir="return">
6259	<desc>
6260	On return the full path to the log file or an empty string on error.
6261	</desc>
6262	</param>
6263	</method>
6264
6265	<method name="readLog">
6266	<desc>
6267	Reads the VM log file. The chunk size is limited, so even if you
6268	ask for a big piece there might be less data returned.
6269	</desc>
6270	<param name="idx" type="unsigned long" dir="in">
6271	<desc>
6272	Which log file to read. 0=current log file.
6273	</desc>
6274	</param>
6275	<param name="offset" type="long long" dir="in">
6276	<desc>
6277	Offset in the log file.
6278	</desc>
6279	</param>
6280	<param name="size" type="long long" dir="in">
6281	<desc>
6282	Chunk size to read in the log file.
6283	</desc>
6284	</param>
6285	<param name="data" type="octet" dir="return" safearray="yes">
6286	<desc>
6287	Data read from the log file. A data size of 0 means end of file
6288	if the requested chunk size was not 0. This is the unprocessed
6289	file data, i.e. the line ending style depends on the platform of
6290	the system the server is running on.
6291	</desc>
6292	</param>
6293	</method>
6294
6295	<method name="cloneTo">
6296	<desc>
6297	Creates a clone of this machine, either as a full clone (which means
6298	creating independent copies of the hard disk media, save states and so
6299	on), or as a linked clone (which uses its own differencing media,
6300	sharing the parent media with the source machine).
6301
6302	The target machine object must have been created previously with <link
6303	to="IVirtualBox::createMachine"/>, and all the settings will be
6304	transferred except the VM name and the hardware UUID. You can set the
6305	VM name and the new hardware UUID when creating the target machine. The
6306	network MAC addresses are newly created for all newtwork adapters. You
6307	can change that behaviour with the options parameter. The operation is
6308	performed asynchronously, so the machine object will be not be usable
6309	until the @a progress object signals completion.
6310
6311	<result name="E_INVALIDARG">
6312	@a target is @c null.
6313	</result>
6314	</desc>
6315
6316	<param name="target" type="IMachine" dir="in">
6317	<desc>Target machine object.</desc>
6318	</param>
6319	<param name="mode" type="CloneMode" dir="in">
6320	<desc>Which states should be cloned.</desc>
6321	</param>
6322	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6323	<desc>Options for the cloning operation.</desc>
6324	</param>
6325	<param name="progress" type="IProgress" dir="return">
6326	<desc>Progress object to track the operation completion.</desc>
6327	</param>
6328	</method>
6329
6330	</interface>
6331
6332	<!--
6333	// IConsole
6334	/////////////////////////////////////////////////////////////////////////
6335	-->
6336
6337	<interface
6338	name="IVRDEServerInfo" extends="$unknown"
6339	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6340	wsmap="struct"
6341	>
6342	<desc>
6343	Contains information about the remote desktop (VRDE) server capabilities and status.
6344	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6345	</desc>
6346
6347	<attribute name="active" type="boolean" readonly="yes">
6348	<desc>
6349	Whether the remote desktop connection is active.
6350	</desc>
6351	</attribute>
6352
6353	<attribute name="port" type="long" readonly="yes">
6354	<desc>
6355	VRDE server port number. If this property is equal to <tt>0</tt>, then
6356	the VRDE server failed to start, usually because there are no free IP
6357	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6358	server has not yet been started.
6359	</desc>
6360	</attribute>
6361
6362	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6363	<desc>
6364	How many times a client connected.
6365	</desc>
6366	</attribute>
6367
6368	<attribute name="beginTime" type="long long" readonly="yes">
6369	<desc>
6370	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6371	</desc>
6372	</attribute>
6373
6374	<attribute name="endTime" type="long long" readonly="yes">
6375	<desc>
6376	When the last connection was terminated or the current time, if
6377	connection is still active, in milliseconds since 1970-01-01 UTC.
6378	</desc>
6379	</attribute>
6380
6381	<attribute name="bytesSent" type="long long" readonly="yes">
6382	<desc>
6383	How many bytes were sent in last or current, if still active, connection.
6384	</desc>
6385	</attribute>
6386
6387	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6388	<desc>
6389	How many bytes were sent in all connections.
6390	</desc>
6391	</attribute>
6392
6393	<attribute name="bytesReceived" type="long long" readonly="yes">
6394	<desc>
6395	How many bytes were received in last or current, if still active, connection.
6396	</desc>
6397	</attribute>
6398
6399	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6400	<desc>
6401	How many bytes were received in all connections.
6402	</desc>
6403	</attribute>
6404
6405	<attribute name="user" type="wstring" readonly="yes">
6406	<desc>
6407	Login user name supplied by the client.
6408	</desc>
6409	</attribute>
6410
6411	<attribute name="domain" type="wstring" readonly="yes">
6412	<desc>
6413	Login domain name supplied by the client.
6414	</desc>
6415	</attribute>
6416
6417	<attribute name="clientName" type="wstring" readonly="yes">
6418	<desc>
6419	The client name supplied by the client.
6420	</desc>
6421	</attribute>
6422
6423	<attribute name="clientIP" type="wstring" readonly="yes">
6424	<desc>
6425	The IP address of the client.
6426	</desc>
6427	</attribute>
6428
6429	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6430	<desc>
6431	The client software version number.
6432	</desc>
6433	</attribute>
6434
6435	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6436	<desc>
6437	Public key exchange method used when connection was established.
6438	Values: 0 - RDP4 public key exchange scheme.
6439	1 - X509 certificates were sent to client.
6440	</desc>
6441	</attribute>
6442
6443	</interface>
6444
6445	<interface
6446	name="IConsole" extends="$unknown"
6447	uuid="1968b7d3-e3bf-4ceb-99e0-cb7c913317bb"
6448	wsmap="managed"
6449	>
6450	<desc>
6451	The IConsole interface represents an interface to control virtual
6452	machine execution.
6453
6454	A console object gets created when a machine has been locked for a
6455	particular session (client process) using <link to="IMachine::lockMachine" />
6456	or <link to="IMachine::launchVMProcess"/>. The console object can
6457	then be found in the session's <link to="ISession::console" /> attribute.
6458
6459	Methods of the IConsole interface allow the caller to query the current
6460	virtual machine execution state, pause the machine or power it down, save
6461	the machine state or take a snapshot, attach and detach removable media
6462	and so on.
6463
6464	<see><link to="ISession"/></see>
6465	</desc>
6466
6467	<attribute name="machine" type="IMachine" readonly="yes">
6468	<desc>
6469	Machine object for this console session.
6470	<note>
6471	This is a convenience property, it has the same value as
6472	<link to="ISession::machine"/> of the corresponding session
6473	object.
6474	</note>
6475	</desc>
6476	</attribute>
6477
6478	<attribute name="state" type="MachineState" readonly="yes">
6479	<desc>
6480	Current execution state of the machine.
6481	<note>
6482	This property always returns the same value as the corresponding
6483	property of the IMachine object for this console session.
6484	For the process that owns (executes) the VM, this is the
6485	preferable way of querying the VM state, because no IPC
6486	calls are made.
6487	</note>
6488	</desc>
6489	</attribute>
6490
6491	<attribute name="guest" type="IGuest" readonly="yes">
6492	<desc>Guest object.</desc>
6493	</attribute>
6494
6495	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6496	<desc>
6497	Virtual keyboard object.
6498	<note>
6499	If the machine is not running, any attempt to use
6500	the returned object will result in an error.
6501	</note>
6502	</desc>
6503	</attribute>
6504
6505	<attribute name="mouse" type="IMouse" readonly="yes">
6506	<desc>
6507	Virtual mouse object.
6508	<note>
6509	If the machine is not running, any attempt to use
6510	the returned object will result in an error.
6511	</note>
6512	</desc>
6513	</attribute>
6514
6515	<attribute name="display" type="IDisplay" readonly="yes">
6516	<desc>Virtual display object.
6517	<note>
6518	If the machine is not running, any attempt to use
6519	the returned object will result in an error.
6520	</note>
6521	</desc>
6522	</attribute>
6523
6524	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6525	<desc>Debugging interface.</desc>
6526	</attribute>
6527
6528	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6529	<desc>
6530	Collection of USB devices currently attached to the virtual
6531	USB controller.
6532	<note>
6533	The collection is empty if the machine is not running.
6534	</note>
6535	</desc>
6536	</attribute>
6537
6538	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6539	<desc>
6540	List of USB devices currently attached to the remote VRDE client.
6541	Once a new device is physically attached to the remote host computer,
6542	it appears in this list and remains there until detached.
6543	</desc>
6544	</attribute>
6545
6546	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6547	<desc>
6548	Collection of shared folders for the current session. These folders
6549	are called transient shared folders because they are available to the
6550	guest OS running inside the associated virtual machine only for the
6551	duration of the session (as opposed to
6552	<link to="IMachine::sharedFolders"/> which represent permanent shared
6553	folders). When the session is closed (e.g. the machine is powered down),
6554	these folders are automatically discarded.
6555
6556	New shared folders are added to the collection using
6557	<link to="#createSharedFolder"/>. Existing shared folders can be
6558	removed using <link to="#removeSharedFolder"/>.
6559	</desc>
6560	</attribute>
6561
6562	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6563	<desc>
6564	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6565	</desc>
6566	</attribute>
6567
6568	<attribute name="eventSource" type="IEventSource" readonly="yes">
6569	<desc>
6570	Event source for console events.
6571	</desc>
6572	</attribute>
6573
6574	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6575	<desc>Array of PCI devices attached to this machine.</desc>
6576	</attribute>
6577
6578	<attribute name="useHostClipboard" type="boolean">
6579	<desc>
6580	Whether the guest clipboard should be connected to the host one or
6581	whether it should only be allowed access to the VRDE clipboard. This
6582	setting may not affect existing guest clipboard connections which
6583	are already connected to the host clipboard.
6584	</desc>
6585	</attribute>
6586
6587	<method name="powerUp">
6588	<desc>
6589	Starts the virtual machine execution using the current machine
6590	state (that is, its current execution state, current settings and
6591	current storage devices).
6592
6593	<note>
6594	This method is only useful for front-ends that want to actually
6595	execute virtual machines in their own process (like the VirtualBox
6596	or VBoxSDL front-ends). Unless you are intending to write such a
6597	front-end, do not call this method. If you simply want to
6598	start virtual machine execution using one of the existing front-ends
6599	(for example the VirtualBox GUI or headless server), use
6600	<link to="IMachine::launchVMProcess"/> instead; these
6601	front-ends will power up the machine automatically for you.
6602	</note>
6603
6604	If the machine is powered off or aborted, the execution will
6605	start from the beginning (as if the real hardware were just
6606	powered on).
6607
6608	If the machine is in the <link to="MachineState_Saved"/> state,
6609	it will continue its execution the point where the state has
6610	been saved.
6611
6612	If the machine <link to="IMachine::teleporterEnabled"/> property is
6613	enabled on the machine being powered up, the machine will wait for an
6614	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6615	state. The returned progress object will have at least three
6616	operations where the last three are defined as: (1) powering up and
6617	starting TCP server, (2) waiting for incoming teleportations, and
6618	(3) perform teleportation. These operations will be reflected as the
6619	last three operations of the progress objected returned by
6620	<link to="IMachine::launchVMProcess"/> as well.
6621
6622	<see><link to="#saveState"/></see>
6623
6624	<result name="VBOX_E_INVALID_VM_STATE">
6625	Virtual machine already running.
6626	</result>
6627	<result name="VBOX_E_HOST_ERROR">
6628	Host interface does not exist or name not set.
6629	</result>
6630	<result name="VBOX_E_FILE_ERROR">
6631	Invalid saved state file.
6632	</result>
6633	</desc>
6634	<param name="progress" type="IProgress" dir="return">
6635	<desc>Progress object to track the operation completion.</desc>
6636	</param>
6637	</method>
6638
6639	<method name="powerUpPaused">
6640	<desc>
6641	Identical to powerUp except that the VM will enter the
6642	<link to="MachineState_Paused"/> state, instead of
6643	<link to="MachineState_Running"/>.
6644
6645	<see><link to="#powerUp"/></see>
6646	<result name="VBOX_E_INVALID_VM_STATE">
6647	Virtual machine already running.
6648	</result>
6649	<result name="VBOX_E_HOST_ERROR">
6650	Host interface does not exist or name not set.
6651	</result>
6652	<result name="VBOX_E_FILE_ERROR">
6653	Invalid saved state file.
6654	</result>
6655	</desc>
6656	<param name="progress" type="IProgress" dir="return">
6657	<desc>Progress object to track the operation completion.</desc>
6658	</param>
6659	</method>
6660
6661	<method name="powerDown">
6662	<desc>
6663	Initiates the power down procedure to stop the virtual machine
6664	execution.
6665
6666	The completion of the power down procedure is tracked using the returned
6667	IProgress object. After the operation is complete, the machine will go
6668	to the PoweredOff state.
6669	<result name="VBOX_E_INVALID_VM_STATE">
6670	Virtual machine must be Running, Paused or Stuck to be powered down.
6671	</result>
6672	</desc>
6673	<param name="progress" type="IProgress" dir="return">
6674	<desc>Progress object to track the operation completion.</desc>
6675	</param>
6676	</method>
6677
6678	<method name="reset">
6679	<desc>Resets the virtual machine.
6680	<result name="VBOX_E_INVALID_VM_STATE">
6681	Virtual machine not in Running state.
6682	</result>
6683	<result name="VBOX_E_VM_ERROR">
6684	Virtual machine error in reset operation.
6685	</result>
6686	</desc>
6687	</method>
6688
6689	<method name="pause">
6690	<desc>Pauses the virtual machine execution.
6691	<result name="VBOX_E_INVALID_VM_STATE">
6692	Virtual machine not in Running state.
6693	</result>
6694	<result name="VBOX_E_VM_ERROR">
6695	Virtual machine error in suspend operation.
6696	</result>
6697	</desc>
6698	</method>
6699
6700	<method name="resume">
6701	<desc>Resumes the virtual machine execution.
6702	<result name="VBOX_E_INVALID_VM_STATE">
6703	Virtual machine not in Paused state.
6704	</result>
6705	<result name="VBOX_E_VM_ERROR">
6706	Virtual machine error in resume operation.
6707	</result>
6708	</desc>
6709	</method>
6710
6711	<method name="powerButton">
6712	<desc>Sends the ACPI power button event to the guest.
6713	<result name="VBOX_E_INVALID_VM_STATE">
6714	Virtual machine not in Running state.
6715	</result>
6716	<result name="VBOX_E_PDM_ERROR">
6717	Controlled power off failed.
6718	</result>
6719	</desc>
6720	</method>
6721
6722	<method name="sleepButton">
6723	<desc>Sends the ACPI sleep button event to the guest.
6724	<result name="VBOX_E_INVALID_VM_STATE">
6725	Virtual machine not in Running state.
6726	</result>
6727	<result name="VBOX_E_PDM_ERROR">
6728	Sending sleep button event failed.
6729	</result>
6730	</desc>
6731	</method>
6732
6733	<method name="getPowerButtonHandled">
6734	<desc>Checks if the last power button event was handled by guest.
6735	<result name="VBOX_E_PDM_ERROR">
6736	Checking if the event was handled by the guest OS failed.
6737	</result>
6738	</desc>
6739	<param name="handled" type="boolean" dir="return"/>
6740	</method>
6741
6742	<method name="getGuestEnteredACPIMode">
6743	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6744	G1 (sleeping). If this method returns @c false, the guest will
6745	most likely not respond to external ACPI events.
6746	<result name="VBOX_E_INVALID_VM_STATE">
6747	Virtual machine not in Running state.
6748	</result>
6749	</desc>
6750	<param name="entered" type="boolean" dir="return"/>
6751	</method>
6752
6753	<method name="saveState">
6754	<desc>
6755	Saves the current execution state of a running virtual machine
6756	and stops its execution.
6757
6758	After this operation completes, the machine will go to the
6759	Saved state. Next time it is powered up, this state will
6760	be restored and the machine will continue its execution from
6761	the place where it was saved.
6762
6763	This operation differs from taking a snapshot to the effect
6764	that it doesn't create new differencing media. Also, once
6765	the machine is powered up from the state saved using this method,
6766	the saved state is deleted, so it will be impossible to return
6767	to this state later.
6768
6769	<note>
6770	On success, this method implicitly calls
6771	<link to="IMachine::saveSettings"/> to save all current machine
6772	settings (including runtime changes to the DVD medium, etc.).
6773	Together with the impossibility to change any VM settings when it is
6774	in the Saved state, this guarantees adequate hardware
6775	configuration of the machine when it is restored from the saved
6776	state file.
6777	</note>
6778
6779	<note>
6780	The machine must be in the Running or Paused state, otherwise
6781	the operation will fail.
6782	</note>
6783	<result name="VBOX_E_INVALID_VM_STATE">
6784	Virtual machine state neither Running nor Paused.
6785	</result>
6786	<result name="VBOX_E_FILE_ERROR">
6787	Failed to create directory for saved state file.
6788	</result>
6789
6790	<see><link to="#takeSnapshot"/></see>
6791	</desc>
6792	<param name="progress" type="IProgress" dir="return">
6793	<desc>Progress object to track the operation completion.</desc>
6794	</param>
6795	</method>
6796
6797	<method name="adoptSavedState">
6798	<desc>
6799	Associates the given saved state file to the virtual machine.
6800
6801	On success, the machine will go to the Saved state. Next time it is
6802	powered up, it will be restored from the adopted saved state and
6803	continue execution from the place where the saved state file was
6804	created.
6805
6806	The specified saved state file path may be absolute or relative to the
6807	folder the VM normally saves the state to (usually,
6808	<link to="IMachine::snapshotFolder"/>).
6809
6810	<note>
6811	It's a caller's responsibility to make sure the given saved state
6812	file is compatible with the settings of this virtual machine that
6813	represent its virtual hardware (memory size, storage disk configuration
6814	etc.). If there is a mismatch, the behavior of the virtual machine
6815	is undefined.
6816	</note>
6817	<result name="VBOX_E_INVALID_VM_STATE">
6818	Virtual machine state neither PoweredOff nor Aborted.
6819	</result>
6820	</desc>
6821	<param name="savedStateFile" type="wstring" dir="in">
6822	<desc>Path to the saved state file to adopt.</desc>
6823	</param>
6824	</method>
6825
6826	<method name="discardSavedState">
6827	<desc>
6828	Forcibly resets the machine to "Powered Off" state if it is
6829	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6830	Next time the machine is powered up, a clean boot will occur.
6831	<note>
6832	This operation is equivalent to resetting or powering off
6833	the machine without doing a proper shutdown of the guest
6834	operating system; as with resetting a running phyiscal
6835	computer, it can can lead to data loss.
6836	</note>
6837	If @a fRemoveFile is @c true, the file in the machine directory
6838	into which the machine state was saved is also deleted. If
6839	this is @c false, then the state can be recovered and later
6840	re-inserted into a machine using <link to="#adoptSavedState" />.
6841	The location of the file can be found in the
6842	<link to="IMachine::stateFilePath" /> attribute.
6843	<result name="VBOX_E_INVALID_VM_STATE">
6844	Virtual machine not in state Saved.
6845	</result>
6846	</desc>
6847	<param name="fRemoveFile" type="boolean" dir="in" >
6848	<desc>Whether to also remove the saved state file.</desc>
6849	</param>
6850	</method>
6851
6852	<method name="getDeviceActivity">
6853	<desc>
6854	Gets the current activity type of a given device or device group.
6855	<result name="E_INVALIDARG">
6856	Invalid device type.
6857	</result>
6858	</desc>
6859	<param name="type" type="DeviceType" dir="in"/>
6860	<param name="activity" type="DeviceActivity" dir="return"/>
6861	</method>
6862
6863	<method name="attachUSBDevice">
6864	<desc>
6865	Attaches a host USB device with the given UUID to the
6866	USB controller of the virtual machine.
6867
6868	The device needs to be in one of the following states:
6869	<link to="USBDeviceState_Busy"/>,
6870	<link to="USBDeviceState_Available"/> or
6871	<link to="USBDeviceState_Held"/>,
6872	otherwise an error is immediately returned.
6873
6874	When the device state is
6875	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6876	be returned if the host computer refuses to release it for some reason.
6877
6878	<see><link to="IUSBController::deviceFilters"/>,
6879	<link to="USBDeviceState"/></see>
6880	<result name="VBOX_E_INVALID_VM_STATE">
6881	Virtual machine state neither Running nor Paused.
6882	</result>
6883	<result name="VBOX_E_PDM_ERROR">
6884	Virtual machine does not have a USB controller.
6885	</result>
6886	</desc>
6887	<param name="id" type="uuid" mod="string" dir="in">
6888	<desc>UUID of the host USB device to attach.</desc>
6889	</param>
6890	</method>
6891
6892	<method name="detachUSBDevice">
6893	<desc>
6894	Detaches an USB device with the given UUID from the USB controller
6895	of the virtual machine.
6896
6897	After this method succeeds, the VirtualBox server re-initiates
6898	all USB filters as if the device were just physically attached
6899	to the host, but filters of this machine are ignored to avoid
6900	a possible automatic re-attachment.
6901
6902	<see><link to="IUSBController::deviceFilters"/>,
6903	<link to="USBDeviceState"/></see>
6904
6905	<result name="VBOX_E_PDM_ERROR">
6906	Virtual machine does not have a USB controller.
6907	</result>
6908	<result name="E_INVALIDARG">
6909	USB device not attached to this virtual machine.
6910	</result>
6911	</desc>
6912	<param name="id" type="uuid" mod="string" dir="in">
6913	<desc>UUID of the USB device to detach.</desc>
6914	</param>
6915	<param name="device" type="IUSBDevice" dir="return">
6916	<desc>Detached USB device.</desc>
6917	</param>
6918	</method>
6919
6920	<method name="findUSBDeviceByAddress">
6921	<desc>
6922	Searches for a USB device with the given host address.
6923
6924	<result name="VBOX_E_OBJECT_NOT_FOUND">
6925	Given @c name does not correspond to any USB device.
6926	</result>
6927
6928	<see><link to="IUSBDevice::address"/></see>
6929	</desc>
6930	<param name="name" type="wstring" dir="in">
6931	<desc>
6932	Address of the USB device (as assigned by the host) to
6933	search for.
6934	</desc>
6935	</param>
6936	<param name="device" type="IUSBDevice" dir="return">
6937	<desc>Found USB device object.</desc>
6938	</param>
6939	</method>
6940
6941	<method name="findUSBDeviceById">
6942	<desc>
6943	Searches for a USB device with the given UUID.
6944
6945	<result name="VBOX_E_OBJECT_NOT_FOUND">
6946	Given @c id does not correspond to any USB device.
6947	</result>
6948
6949	<see><link to="IUSBDevice::id"/></see>
6950	</desc>
6951	<param name="id" type="uuid" mod="string" dir="in">
6952	<desc>UUID of the USB device to search for.</desc>
6953	</param>
6954	<param name="device" type="IUSBDevice" dir="return">
6955	<desc>Found USB device object.</desc>
6956	</param>
6957	</method>
6958
6959	<method name="createSharedFolder">
6960	<desc>
6961	Creates a transient new shared folder by associating the given logical
6962	name with the given host path, adds it to the collection of shared
6963	folders and starts sharing it. Refer to the description of
6964	<link to="ISharedFolder"/> to read more about logical names.
6965
6966	<result name="VBOX_E_INVALID_VM_STATE">
6967	Virtual machine in Saved state or currently changing state.
6968	</result>
6969	<result name="VBOX_E_FILE_ERROR">
6970	Shared folder already exists or not accessible.
6971	</result>
6972	</desc>
6973	<param name="name" type="wstring" dir="in">
6974	<desc>Unique logical name of the shared folder.</desc>
6975	</param>
6976	<param name="hostPath" type="wstring" dir="in">
6977	<desc>Full path to the shared folder in the host file system.</desc>
6978	</param>
6979	<param name="writable" type="boolean" dir="in">
6980	<desc>Whether the share is writable or readonly</desc>
6981	</param>
6982	<param name="automount" type="boolean" dir="in">
6983	<desc>Whether the share gets automatically mounted by the guest
6984	or not.</desc>
6985	</param>
6986	</method>
6987
6988	<method name="removeSharedFolder">
6989	<desc>
6990	Removes a transient shared folder with the given name previously
6991	created by <link to="#createSharedFolder"/> from the collection of
6992	shared folders and stops sharing it.
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 does not exists.
6998	</result>
6999	</desc>
7000	<param name="name" type="wstring" dir="in">
7001	<desc>Logical name of the shared folder to remove.</desc>
7002	</param>
7003	</method>
7004
7005	<method name="takeSnapshot">
7006	<desc>
7007	Saves the current execution state
7008	and all settings of the machine and creates differencing images
7009	for all normal (non-independent) media.
7010	See <link to="ISnapshot" /> for an introduction to snapshots.
7011
7012	This method can be called for a PoweredOff, Saved (see
7013	<link to="#saveState"/>), Running or
7014	Paused virtual machine. When the machine is PoweredOff, an
7015	offline snapshot is created. When the machine is Running a live
7016	snapshot is created, and an online snapshot is is created when Paused.
7017
7018	The taken snapshot is always based on the
7019	<link to="IMachine::currentSnapshot">current snapshot</link>
7020	of the associated virtual machine and becomes a new current snapshot.
7021
7022	<note>
7023	This method implicitly calls <link to="IMachine::saveSettings"/> to
7024	save all current machine settings before taking an offline snapshot.
7025	</note>
7026
7027	<result name="VBOX_E_INVALID_VM_STATE">
7028	Virtual machine currently changing state.
7029	</result>
7030	</desc>
7031	<param name="name" type="wstring" dir="in">
7032	<desc>Short name for the snapshot.</desc>
7033	</param>
7034	<param name="description" type="wstring" dir="in">
7035	<desc>Optional description of the snapshot.</desc>
7036	</param>
7037	<param name="progress" type="IProgress" dir="return">
7038	<desc>Progress object to track the operation completion.</desc>
7039	</param>
7040	</method>
7041
7042	<method name="deleteSnapshot">
7043	<desc>
7044	Starts deleting the specified snapshot asynchronously.
7045	See <link to="ISnapshot" /> for an introduction to snapshots.
7046
7047	The execution state and settings of the associated machine stored in
7048	the snapshot will be deleted. The contents of all differencing media of
7049	this snapshot will be merged with the contents of their dependent child
7050	media to keep the medium chain valid (in other words, all changes
7051	represented by media being deleted will be propagated to their child
7052	medium). After that, this snapshot's differencing medium will be
7053	deleted. The parent of this snapshot will become a new parent for all
7054	its child snapshots.
7055
7056	If the deleted snapshot is the current one, its parent snapshot will
7057	become a new current snapshot. The current machine state is not directly
7058	affected in this case, except that currently attached differencing
7059	media based on media of the deleted snapshot will be also merged as
7060	described above.
7061
7062	If the deleted snapshot is the first or current snapshot, then the
7063	respective IMachine attributes will be adjusted. Deleting the current
7064	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7065	to make all current machine settings permanent.
7066
7067	Deleting a snapshot has the following preconditions:
7068
7069	<ul>
7070	<li>Child media of all normal media of the deleted snapshot
7071	must be accessible (see <link to="IMedium::state"/>) for this
7072	operation to succeed. If only one running VM refers to all images
7073	which participates in merging the operation can be performed while
7074	the VM is running. Otherwise all virtual machines whose media are
7075	directly or indirectly based on the media of deleted snapshot must
7076	be powered off. In any case, online snapshot deleting usually is
7077	slower than the same operation without any running VM.</li>
7078
7079	<li>You cannot delete the snapshot if a medium attached to it has
7080	more than one child medium (differencing images) because otherwise
7081	merging would be impossible. This might be the case if there is
7082	more than one child snapshot or differencing images were created
7083	for other reason (e.g. implicitly because of multiple machine
7084	attachments).</li>
7085	</ul>
7086
7087	The virtual machine's <link to="IMachine::state">state</link> is
7088	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
7089	"DeletingSnapshotPaused" while this operation is in progress.
7090
7091	<note>
7092	Merging medium contents can be very time and disk space
7093	consuming, if these media are big in size and have many
7094	children. However, if the snapshot being deleted is the last
7095	(head) snapshot on the branch, the operation will be rather
7096	quick.
7097	</note>
7098	<result name="VBOX_E_INVALID_VM_STATE">
7099	The running virtual machine prevents deleting this snapshot. This
7100	happens only in very specific situations, usually snapshots can be
7101	deleted without trouble while a VM is running. The error message
7102	text explains the reason for the failure.
7103	</result>
7104	</desc>
7105	<param name="id" type="uuid" mod="string" dir="in">
7106	<desc>UUID of the snapshot to delete.</desc>
7107	</param>
7108	<param name="progress" type="IProgress" dir="return">
7109	<desc>Progress object to track the operation completion.</desc>
7110	</param>
7111	</method>
7112
7113	<method name="deleteSnapshotAndAllChildren">
7114	<desc>
7115	Starts deleting the specified snapshot and all its children
7116	asynchronously. See <link to="ISnapshot" /> for an introduction to
7117	snapshots. The conditions and many details are the same as with
7118	<link to="#deleteSnapshot"/>.
7119
7120	This operation is very fast if the snapshot subtree does not include
7121	the current state. It is still significantly faster than deleting the
7122	snapshots one by one if the current state is in the subtree and there
7123	are more than one snapshots from current state to the snapshot which
7124	marks the subtree, since it eliminates the incremental image merging.
7125
7126	<note>This API method is right now not implemented!</note>
7127
7128	<result name="VBOX_E_INVALID_VM_STATE">
7129	The running virtual machine prevents deleting this snapshot. This
7130	happens only in very specific situations, usually snapshots can be
7131	deleted without trouble while a VM is running. The error message
7132	text explains the reason for the failure.
7133	</result>
7134	<result name="E_NOTIMPL">
7135	The method is not implemented yet.
7136	</result>
7137	</desc>
7138	<param name="id" type="uuid" mod="string" dir="in">
7139	<desc>UUID of the snapshot to delete, including all its children.</desc>
7140	</param>
7141	<param name="progress" type="IProgress" dir="return">
7142	<desc>Progress object to track the operation completion.</desc>
7143	</param>
7144	</method>
7145
7146	<method name="deleteSnapshotRange">
7147	<desc>
7148	Starts deleting the specified snapshot range. This is limited to
7149	linear snapshot lists, which means there may not be any other child
7150	snapshots other than the direct sequence between the start and end
7151	snapshot. If the start and end snapshot point to the same snapshot this
7152	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7153	<link to="ISnapshot" /> for an introduction to snapshots. The
7154	conditions and many details are the same as with
7155	<link to="#deleteSnapshot"/>.
7156
7157	This operation is generally faster than deleting snapshots one by one
7158	and often also needs less extra disk space before freeing up disk space
7159	by deleting the removed disk images corresponding to the snapshot.
7160
7161	<note>This API method is right now not implemented!</note>
7162
7163	<result name="VBOX_E_INVALID_VM_STATE">
7164	The running virtual machine prevents deleting this snapshot. This
7165	happens only in very specific situations, usually snapshots can be
7166	deleted without trouble while a VM is running. The error message
7167	text explains the reason for the failure.
7168	</result>
7169	<result name="E_NOTIMPL">
7170	The method is not implemented yet.
7171	</result>
7172	</desc>
7173	<param name="startId" type="uuid" mod="string" dir="in">
7174	<desc>UUID of the first snapshot to delete.</desc>
7175	</param>
7176	<param name="endId" type="uuid" mod="string" dir="in">
7177	<desc>UUID of the last snapshot to delete.</desc>
7178	</param>
7179	<param name="progress" type="IProgress" dir="return">
7180	<desc>Progress object to track the operation completion.</desc>
7181	</param>
7182	</method>
7183
7184	<method name="restoreSnapshot">
7185	<desc>
7186	Starts resetting the machine's current state to the state contained
7187	in the given snapshot, asynchronously. All current settings of the
7188	machine will be reset and changes stored in differencing media
7189	will be lost.
7190	See <link to="ISnapshot" /> for an introduction to snapshots.
7191
7192	After this operation is successfully completed, new empty differencing
7193	media are created for all normal media of the machine.
7194
7195	If the given snapshot is an online snapshot, the machine will go to
7196	the <link to="MachineState_Saved"> saved state</link>, so that the
7197	next time it is powered on, the execution state will be restored
7198	from the state of the snapshot.
7199
7200	<note>
7201	The machine must not be running, otherwise the operation will fail.
7202	</note>
7203
7204	<note>
7205	If the machine state is <link to="MachineState_Saved">Saved</link>
7206	prior to this operation, the saved state file will be implicitly
7207	deleted (as if <link to="IConsole::discardSavedState"/> were
7208	called).
7209	</note>
7210
7211	<result name="VBOX_E_INVALID_VM_STATE">
7212	Virtual machine is running.
7213	</result>
7214	</desc>
7215	<param name="snapshot" type="ISnapshot" dir="in">
7216	<desc>The snapshot to restore the VM state from.</desc>
7217	</param>
7218	<param name="progress" type="IProgress" dir="return">
7219	<desc>Progress object to track the operation completion.</desc>
7220	</param>
7221	</method>
7222
7223	<method name="teleport">
7224	<desc>
7225	Teleport the VM to a different host machine or process.
7226
7227	TODO explain the details.
7228
7229	<result name="VBOX_E_INVALID_VM_STATE">
7230	Virtual machine not running or paused.
7231	</result>
7232	</desc>
7233	<param name="hostname" type="wstring" dir="in">
7234	<desc>The name or IP of the host to teleport to.</desc>
7235	</param>
7236	<param name="tcpport" type="unsigned long" dir="in">
7237	<desc>The TCP port to connect to (1..65535).</desc>
7238	</param>
7239	<param name="password" type="wstring" dir="in">
7240	<desc>The password.</desc>
7241	</param>
7242	<param name="maxDowntime" type="unsigned long" dir="in">
7243	<desc>
7244	The maximum allowed downtime given as milliseconds. 0 is not a valid
7245	value. Recommended value: 250 ms.
7246
7247	The higher the value is, the greater the chance for a successful
7248	teleportation. A small value may easily result in the teleportation
7249	process taking hours and eventually fail.
7250
7251	<note>
7252	The current implementation treats this a guideline, not as an
7253	absolute rule.
7254	</note>
7255	</desc>
7256	</param>
7257	<param name="progress" type="IProgress" dir="return">
7258	<desc>Progress object to track the operation completion.</desc>
7259	</param>
7260	</method>
7261
7262	</interface>
7263
7264	<!--
7265	// IHost
7266	/////////////////////////////////////////////////////////////////////////
7267	-->
7268
7269	<enum
7270	name="HostNetworkInterfaceMediumType"
7271	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7272	>
7273	<desc>
7274	Type of encapsulation. Ethernet encapsulation includes both wired and
7275	wireless Ethernet connections.
7276	<see><link to="IHostNetworkInterface"/></see>
7277	</desc>
7278
7279	<const name="Unknown" value="0">
7280	<desc>
7281	The type of interface cannot be determined.
7282	</desc>
7283	</const>
7284	<const name="Ethernet" value="1">
7285	<desc>
7286	Ethernet frame encapsulation.
7287	</desc>
7288	</const>
7289	<const name="PPP" value="2">
7290	<desc>
7291	Point-to-point protocol encapsulation.
7292	</desc>
7293	</const>
7294	<const name="SLIP" value="3">
7295	<desc>
7296	Serial line IP encapsulation.
7297	</desc>
7298	</const>
7299	</enum>
7300
7301	<enum
7302	name="HostNetworkInterfaceStatus"
7303	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7304	>
7305	<desc>
7306	Current status of the interface.
7307	<see><link to="IHostNetworkInterface"/></see>
7308	</desc>
7309
7310	<const name="Unknown" value="0">
7311	<desc>
7312	The state of interface cannot be determined.
7313	</desc>
7314	</const>
7315	<const name="Up" value="1">
7316	<desc>
7317	The interface is fully operational.
7318	</desc>
7319	</const>
7320	<const name="Down" value="2">
7321	<desc>
7322	The interface is not functioning.
7323	</desc>
7324	</const>
7325	</enum>
7326
7327	<enum
7328	name="HostNetworkInterfaceType"
7329	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7330	>
7331	<desc>
7332	Network interface type.
7333	</desc>
7334	<const name="Bridged" value="1"/>
7335	<const name="HostOnly" value="2"/>
7336	</enum>
7337
7338	<interface
7339	name="IHostNetworkInterface" extends="$unknown"
7340	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7341	wsmap="managed"
7342	>
7343	<desc>
7344	Represents one of host's network interfaces. IP V6 address and network
7345	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7346	separated by colons.
7347	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7348	</desc>
7349	<attribute name="name" type="wstring" readonly="yes">
7350	<desc>Returns the host network interface name.</desc>
7351	</attribute>
7352
7353	<attribute name="id" type="uuid" mod="string" readonly="yes">
7354	<desc>Returns the interface UUID.</desc>
7355	</attribute>
7356
7357	<attribute name="networkName" type="wstring" readonly="yes">
7358	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7359	</attribute>
7360
7361	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7362	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7363	</attribute>
7364
7365	<attribute name="IPAddress" type="wstring" readonly="yes">
7366	<desc>Returns the IP V4 address of the interface.</desc>
7367	</attribute>
7368
7369	<attribute name="networkMask" type="wstring" readonly="yes">
7370	<desc>Returns the network mask of the interface.</desc>
7371	</attribute>
7372
7373	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7374	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7375	</attribute>
7376
7377	<attribute name="IPV6Address" type="wstring" readonly="yes">
7378	<desc>Returns the IP V6 address of the interface.</desc>
7379	</attribute>
7380
7381	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7382	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7383	</attribute>
7384
7385	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7386	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7387	</attribute>
7388
7389	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7390	<desc>Type of protocol encapsulation used.</desc>
7391	</attribute>
7392
7393	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7394	<desc>Status of the interface.</desc>
7395	</attribute>
7396
7397	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7398	<desc>specifies the host interface type.</desc>
7399	</attribute>
7400
7401	<method name="enableStaticIpConfig">
7402	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7403	<param name="IPAddress" type="wstring" dir="in">
7404	<desc>
7405	IP address.
7406	</desc>
7407	</param>
7408	<param name="networkMask" type="wstring" dir="in">
7409	<desc>
7410	network mask.
7411	</desc>
7412	</param>
7413	</method>
7414
7415	<method name="enableStaticIpConfigV6">
7416	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7417	<param name="IPV6Address" type="wstring" dir="in">
7418	<desc>
7419	IP address.
7420	</desc>
7421	</param>
7422	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7423	<desc>
7424	network mask.
7425	</desc>
7426	</param>
7427	</method>
7428
7429	<method name="enableDynamicIpConfig">
7430	<desc>enables the dynamic IP configuration.</desc>
7431	</method>
7432
7433	<method name="dhcpRediscover">
7434	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7435	</method>
7436
7437	</interface>
7438
7439	<interface
7440	name="IHost" extends="$unknown"
7441	uuid="dab4a2b8-c735-4f08-94fc-9bec84182e2f"
7442	wsmap="managed"
7443	>
7444	<desc>
7445	The IHost interface represents the physical machine that this VirtualBox
7446	installation runs on.
7447
7448	An object implementing this interface is returned by the
7449	<link to="IVirtualBox::host" /> attribute. This interface contains
7450	read-only information about the host's physical hardware (such as what
7451	processors and disks are available, what the host operating system is,
7452	and so on) and also allows for manipulating some of the host's hardware,
7453	such as global USB device filters and host interface networking.
7454
7455	</desc>
7456	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7457	<desc>List of DVD drives available on the host.</desc>
7458	</attribute>
7459
7460	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7461	<desc>List of floppy drives available on the host.</desc>
7462	</attribute>
7463
7464	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7465	<desc>
7466	List of USB devices currently attached to the host.
7467	Once a new device is physically attached to the host computer,
7468	it appears in this list and remains there until detached.
7469
7470	<note>
7471	If USB functionality is not available in the given edition of
7472	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7473	</note>
7474	</desc>
7475	</attribute>
7476
7477	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7478	<desc>
7479	List of USB device filters in action.
7480	When a new device is physically attached to the host computer,
7481	filters from this list are applied to it (in order they are stored
7482	in the list). The first matched filter will determine the
7483	<link to="IHostUSBDeviceFilter::action">action</link>
7484	performed on the device.
7485
7486	Unless the device is ignored by these filters, filters of all
7487	currently running virtual machines
7488	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7489
7490	<note>
7491	If USB functionality is not available in the given edition of
7492	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7493	</note>
7494
7495	<see><link to="IHostUSBDeviceFilter"/>,
7496	<link to="USBDeviceState"/></see>
7497	</desc>
7498	</attribute>
7499
7500	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7501	<desc>List of host network interfaces currently defined on the host.</desc>
7502	</attribute>
7503
7504	<attribute name="processorCount" type="unsigned long" readonly="yes">
7505	<desc>Number of (logical) CPUs installed in the host system.</desc>
7506	</attribute>
7507
7508	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7509	<desc>Number of (logical) CPUs online in the host system.</desc>
7510	</attribute>
7511
7512	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7513	<desc>Number of physical processor cores installed in the host system.</desc>
7514	</attribute>
7515
7516	<method name="getProcessorSpeed">
7517	<desc>Query the (approximate) maximum speed of a specified host CPU in
7518	Megahertz.
7519	</desc>
7520	<param name="cpuId" type="unsigned long" dir="in">
7521	<desc>
7522	Identifier of the CPU.
7523	</desc>
7524	</param>
7525	<param name="speed" type="unsigned long" dir="return">
7526	<desc>
7527	Speed value. 0 is returned if value is not known or @a cpuId is
7528	invalid.
7529	</desc>
7530	</param>
7531	</method>
7532
7533	<method name="getProcessorFeature">
7534	<desc>Query whether a CPU feature is supported or not.</desc>
7535	<param name="feature" type="ProcessorFeature" dir="in">
7536	<desc>
7537	CPU Feature identifier.
7538	</desc>
7539	</param>
7540	<param name="supported" type="boolean" dir="return">
7541	<desc>
7542	Feature is supported or not.
7543	</desc>
7544	</param>
7545	</method>
7546
7547	<method name="getProcessorDescription">
7548	<desc>Query the model string of a specified host CPU.
7549	</desc>
7550	<param name="cpuId" type="unsigned long" dir="in">
7551	<desc>
7552	Identifier of the CPU.
7553	<note>
7554	The current implementation might not necessarily return the
7555	description for this exact CPU.
7556	</note>
7557	</desc>
7558	</param>
7559	<param name="description" type="wstring" dir="return">
7560	<desc>
7561	Model string. An empty string is returned if value is not known or
7562	@a cpuId is invalid.
7563	</desc>
7564	</param>
7565	</method>
7566
7567	<method name="getProcessorCPUIDLeaf">
7568	<desc>
7569	Returns the CPU cpuid information for the specified leaf.
7570	</desc>
7571	<param name="cpuId" type="unsigned long" dir="in">
7572	<desc>
7573	Identifier of the CPU. The CPU most be online.
7574	<note>
7575	The current implementation might not necessarily return the
7576	description for this exact CPU.
7577	</note>
7578	</desc>
7579	</param>
7580	<param name="leaf" type="unsigned long" dir="in">
7581	<desc>
7582	CPUID leaf index (eax).
7583	</desc>
7584	</param>
7585	<param name="subLeaf" type="unsigned long" dir="in">
7586	<desc>
7587	CPUID leaf sub index (ecx). This currently only applies to cache
7588	information on Intel CPUs. Use 0 if retrieving values for
7589	<link to="IMachine::setCPUIDLeaf"/>.
7590	</desc>
7591	</param>
7592	<param name="valEax" type="unsigned long" dir="out">
7593	<desc>
7594	CPUID leaf value for register eax.
7595	</desc>
7596	</param>
7597	<param name="valEbx" type="unsigned long" dir="out">
7598	<desc>
7599	CPUID leaf value for register ebx.
7600	</desc>
7601	</param>
7602	<param name="valEcx" type="unsigned long" dir="out">
7603	<desc>
7604	CPUID leaf value for register ecx.
7605	</desc>
7606	</param>
7607	<param name="valEdx" type="unsigned long" dir="out">
7608	<desc>
7609	CPUID leaf value for register edx.
7610	</desc>
7611	</param>
7612	</method>
7613
7614	<attribute name="memorySize" type="unsigned long" readonly="yes">
7615	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7616	</attribute>
7617
7618	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7619	<desc>Available system memory in the host system.</desc>
7620	</attribute>
7621
7622	<attribute name="operatingSystem" type="wstring" readonly="yes">
7623	<desc>Name of the host system's operating system.</desc>
7624	</attribute>
7625
7626	<attribute name="OSVersion" type="wstring" readonly="yes">
7627	<desc>Host operating system's version string.</desc>
7628	</attribute>
7629
7630	<attribute name="UTCTime" type="long long" readonly="yes">
7631	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7632	</attribute>
7633
7634	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7635	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7636	</attribute>
7637
7638	<method name="createHostOnlyNetworkInterface">
7639	<desc>
7640	Creates a new adapter for Host Only Networking.
7641	<result name="E_INVALIDARG">
7642	Host network interface @a name already exists.
7643	</result>
7644	</desc>
7645	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7646	<desc>
7647	Created host interface object.
7648	</desc>
7649	</param>
7650	<param name="progress" type="IProgress" dir="return">
7651	<desc>
7652	Progress object to track the operation completion.
7653	</desc>
7654	</param>
7655	</method>
7656
7657	<method name="removeHostOnlyNetworkInterface">
7658	<desc>
7659	Removes the given Host Only Networking interface.
7660	<result name="VBOX_E_OBJECT_NOT_FOUND">
7661	No host network interface matching @a id found.
7662	</result>
7663	</desc>
7664	<param name="id" type="uuid" mod="string" dir="in">
7665	<desc>
7666	Adapter GUID.
7667	</desc>
7668	</param>
7669	<param name="progress" type="IProgress" dir="return">
7670	<desc>
7671	Progress object to track the operation completion.
7672	</desc>
7673	</param>
7674	</method>
7675
7676	<method name="createUSBDeviceFilter">
7677	<desc>
7678	Creates a new USB device filter. All attributes except
7679	the filter name are set to empty (any match),
7680	<i>active</i> is @c false (the filter is not active).
7681
7682	The created filter can be added to the list of filters using
7683	<link to="#insertUSBDeviceFilter"/>.
7684
7685	<see><link to="#USBDeviceFilters"/></see>
7686	</desc>
7687	<param name="name" type="wstring" dir="in">
7688	<desc>
7689	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7690	</desc>
7691	</param>
7692	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7693	<desc>Created filter object.</desc>
7694	</param>
7695	</method>
7696
7697	<method name="insertUSBDeviceFilter">
7698	<desc>
7699	Inserts the given USB device to the specified position
7700	in the list of filters.
7701
7702	Positions are numbered starting from @c 0. If the specified
7703	position is equal to or greater than the number of elements in
7704	the list, the filter is added at the end of the collection.
7705
7706	<note>
7707	Duplicates are not allowed, so an attempt to insert a
7708	filter already in the list is an error.
7709	</note>
7710	<note>
7711	If USB functionality is not available in the given edition of
7712	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7713	</note>
7714
7715	<see><link to="#USBDeviceFilters"/></see>
7716
7717	<result name="VBOX_E_INVALID_OBJECT_STATE">
7718	USB device filter is not created within this VirtualBox instance.
7719	</result>
7720	<result name="E_INVALIDARG">
7721	USB device filter already in list.
7722	</result>
7723
7724	</desc>
7725	<param name="position" type="unsigned long" dir="in">
7726	<desc>Position to insert the filter to.</desc>
7727	</param>
7728	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7729	<desc>USB device filter to insert.</desc>
7730	</param>
7731	</method>
7732
7733	<method name="removeUSBDeviceFilter">
7734	<desc>
7735	Removes a USB device filter from the specified position in the
7736	list of filters.
7737
7738	Positions are numbered starting from @c 0. Specifying a
7739	position equal to or greater than the number of elements in
7740	the list will produce an error.
7741
7742	<note>
7743	If USB functionality is not available in the given edition of
7744	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7745	</note>
7746
7747	<see><link to="#USBDeviceFilters"/></see>
7748
7749	<result name="E_INVALIDARG">
7750	USB device filter list empty or invalid @a position.
7751	</result>
7752
7753	</desc>
7754	<param name="position" type="unsigned long" dir="in">
7755	<desc>Position to remove the filter from.</desc>
7756	</param>
7757	</method>
7758
7759	<method name="findHostDVDDrive">
7760	<desc>
7761	Searches for a host DVD drive with the given @c name.
7762
7763	<result name="VBOX_E_OBJECT_NOT_FOUND">
7764	Given @c name does not correspond to any host drive.
7765	</result>
7766
7767	</desc>
7768	<param name="name" type="wstring" dir="in">
7769	<desc>Name of the host drive to search for</desc>
7770	</param>
7771	<param name="drive" type="IMedium" dir="return">
7772	<desc>Found host drive object</desc>
7773	</param>
7774	</method>
7775
7776	<method name="findHostFloppyDrive">
7777	<desc>
7778	Searches for a host floppy drive with the given @c name.
7779
7780	<result name="VBOX_E_OBJECT_NOT_FOUND">
7781	Given @c name does not correspond to any host floppy drive.
7782	</result>
7783
7784	</desc>
7785	<param name="name" type="wstring" dir="in">
7786	<desc>Name of the host floppy drive to search for</desc>
7787	</param>
7788	<param name="drive" type="IMedium" dir="return">
7789	<desc>Found host floppy drive object</desc>
7790	</param>
7791	</method>
7792
7793	<method name="findHostNetworkInterfaceByName">
7794	<desc>
7795	Searches through all host network interfaces for an interface with
7796	the given @c name.
7797	<note>
7798	The method returns an error if the given @c name does not
7799	correspond to any host network interface.
7800	</note>
7801	</desc>
7802	<param name="name" type="wstring" dir="in">
7803	<desc>Name of the host network interface to search for.</desc>
7804	</param>
7805	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7806	<desc>Found host network interface object.</desc>
7807	</param>
7808	</method>
7809	<method name="findHostNetworkInterfaceById">
7810	<desc>
7811	Searches through all host network interfaces for an interface with
7812	the given GUID.
7813	<note>
7814	The method returns an error if the given GUID does not
7815	correspond to any host network interface.
7816	</note>
7817	</desc>
7818	<param name="id" type="uuid" mod="string" dir="in">
7819	<desc>GUID of the host network interface to search for.</desc>
7820	</param>
7821	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7822	<desc>Found host network interface object.</desc>
7823	</param>
7824	</method>
7825	<method name="findHostNetworkInterfacesOfType">
7826	<desc>
7827	Searches through all host network interfaces and returns a list of interfaces of the specified type
7828	</desc>
7829	<param name="type" type="HostNetworkInterfaceType" dir="in">
7830	<desc>type of the host network interfaces to search for.</desc>
7831	</param>
7832	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7833	<desc>Found host network interface objects.</desc>
7834	</param>
7835	</method>
7836
7837	<method name="findUSBDeviceById">
7838	<desc>
7839	Searches for a USB device with the given UUID.
7840
7841	<result name="VBOX_E_OBJECT_NOT_FOUND">
7842	Given @c id does not correspond to any USB device.
7843	</result>
7844
7845	<see><link to="IUSBDevice::id"/></see>
7846	</desc>
7847	<param name="id" type="uuid" mod="string" dir="in">
7848	<desc>UUID of the USB device to search for.</desc>
7849	</param>
7850	<param name="device" type="IHostUSBDevice" dir="return">
7851	<desc>Found USB device object.</desc>
7852	</param>
7853	</method>
7854
7855	<method name="findUSBDeviceByAddress">
7856	<desc>
7857	Searches for a USB device with the given host address.
7858
7859	<result name="VBOX_E_OBJECT_NOT_FOUND">
7860	Given @c name does not correspond to any USB device.
7861	</result>
7862
7863	<see><link to="IUSBDevice::address"/></see>
7864	</desc>
7865	<param name="name" type="wstring" dir="in">
7866	<desc>
7867	Address of the USB device (as assigned by the host) to
7868	search for.
7869	</desc>
7870	</param>
7871	<param name="device" type="IHostUSBDevice" dir="return">
7872	<desc>Found USB device object.</desc>
7873	</param>
7874	</method>
7875
7876	<method name="generateMACAddress">
7877	<desc>
7878	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
7879	</desc>
7880	<param name="address" type="wstring" dir="return">
7881	<desc>New Ethernet MAC address.</desc>
7882	</param>
7883	</method>
7884
7885	</interface>
7886
7887	<!--
7888	// ISystemProperties
7889	/////////////////////////////////////////////////////////////////////////
7890	-->
7891
7892	<interface
7893	name="ISystemProperties"
7894	extends="$unknown"
7895	uuid="8a0ab9ab-48c1-4d04-954b-4a751413d084"
7896	wsmap="managed"
7897	>
7898	<desc>
7899	The ISystemProperties interface represents global properties of the given
7900	VirtualBox installation.
7901
7902	These properties define limits and default values for various attributes
7903	and parameters. Most of the properties are read-only, but some can be
7904	changed by a user.
7905	</desc>
7906
7907	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7908	<desc>Minimum guest system memory in Megabytes.</desc>
7909	</attribute>
7910
7911	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7912	<desc>Maximum guest system memory in Megabytes.</desc>
7913	</attribute>
7914
7915	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7916	<desc>Minimum guest video memory in Megabytes.</desc>
7917	</attribute>
7918
7919	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7920	<desc>Maximum guest video memory in Megabytes.</desc>
7921	</attribute>
7922
7923	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7924	<desc>Minimum CPU count.</desc>
7925	</attribute>
7926
7927	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7928	<desc>Maximum CPU count.</desc>
7929	</attribute>
7930
7931	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7932	<desc>Maximum of monitors which could be connected.</desc>
7933	</attribute>
7934
7935	<attribute name="infoVDSize" type="long long" readonly="yes">
7936	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7937	does not reflect the limits of any virtual disk image format.</desc>
7938	</attribute>
7939
7940	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7941	<desc>
7942	Maximum number of serial ports associated with every
7943	<link to="IMachine"/> instance.
7944	</desc>
7945	</attribute>
7946
7947	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7948	<desc>
7949	Maximum number of parallel ports associated with every
7950	<link to="IMachine"/> instance.
7951	</desc>
7952	</attribute>
7953
7954	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7955	<desc>
7956	Maximum device position in the boot order. This value corresponds
7957	to the total number of devices a machine can boot from, to make it
7958	possible to include all possible devices to the boot list.
7959	<see><link to="IMachine::setBootOrder"/></see>
7960	</desc>
7961	</attribute>
7962
7963	<attribute name="defaultMachineFolder" type="wstring">
7964	<desc>
7965	Full path to the default directory used to create new or open
7966	existing machines when a machine settings file name contains no
7967	path.
7968
7969	Starting with VirtualBox 4.0, by default, this attribute contains
7970	the full path of folder named "VirtualBox VMs" in the user's
7971	home directory, which depends on the host platform.
7972
7973	When setting this attribute, a full path must be specified.
7974	Setting this property to @c null or an empty string or the
7975	special value "Machines" (for compatibility reasons) will restore
7976	that default value.
7977
7978	If the folder specified herein does not exist, it will be created
7979	automatically as needed.
7980
7981	<see>
7982	<link to="IVirtualBox::createMachine"/>,
7983	<link to="IVirtualBox::openMachine"/>
7984	</see>
7985	</desc>
7986	</attribute>
7987
7988	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7989	<desc>
7990	List of all medium storage formats supported by this VirtualBox
7991	installation.
7992
7993	Keep in mind that the medium format identifier
7994	(<link to="IMediumFormat::id"/>) used in other API calls like
7995	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7996	medium format is a case-insensitive string. This means that, for
7997	example, all of the following strings:
7998	<pre>
7999	"VDI"
8000	"vdi"
8001	"VdI"</pre>
8002	refer to the same medium format.
8003
8004	Note that the virtual medium framework is backend-based, therefore
8005	the list of supported formats depends on what backends are currently
8006	installed.
8007
8008	<see><link to="IMediumFormat"/></see>
8009	</desc>
8010	</attribute>
8011
8012	<attribute name="defaultHardDiskFormat" type="wstring">
8013	<desc>
8014	Identifier of the default medium format used by VirtualBox.
8015
8016	The medium format set by this attribute is used by VirtualBox
8017	when the medium format was not specified explicitly. One example is
8018	<link to="IVirtualBox::createHardDisk"/> with the empty
8019	format argument. A more complex example is implicit creation of
8020	differencing media when taking a snapshot of a virtual machine:
8021	this operation will try to use a format of the parent medium first
8022	and if this format does not support differencing media the default
8023	format specified by this argument will be used.
8024
8025	The list of supported medium formats may be obtained by the
8026	<link to="#mediumFormats"/> call. Note that the default medium
8027	format must have a capability to create differencing media;
8028	otherwise operations that create media implicitly may fail
8029	unexpectedly.
8030
8031	The initial value of this property is <tt>"VDI"</tt> in the current
8032	version of the VirtualBox product, but may change in the future.
8033
8034	<note>
8035	Setting this property to @c null or empty string will restore the
8036	initial value.
8037	</note>
8038
8039	<see>
8040	<link to="#mediumFormats"/>,
8041	<link to="IMediumFormat::id"/>,
8042	<link to="IVirtualBox::createHardDisk"/>
8043	</see>
8044	</desc>
8045	</attribute>
8046
8047	<attribute name="freeDiskSpaceWarning" type="long long">
8048	<desc>Issue a warning if the free disk space is below (or in some disk
8049	intensive operation is expected to go below) the given size in
8050	bytes.</desc>
8051	</attribute>
8052
8053	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8054	<desc>Issue a warning if the free disk space is below (or in some disk
8055	intensive operation is expected to go below) the given percentage.</desc>
8056	</attribute>
8057
8058	<attribute name="freeDiskSpaceError" type="long long">
8059	<desc>Issue an error if the free disk space is below (or in some disk
8060	intensive operation is expected to go below) the given size in
8061	bytes.</desc>
8062	</attribute>
8063
8064	<attribute name="freeDiskSpacePercentError" type="unsigned long">
8065	<desc>Issue an error if the free disk space is below (or in some disk
8066	intensive operation is expected to go below) the given percentage.</desc>
8067	</attribute>
8068
8069	<attribute name="VRDEAuthLibrary" type="wstring">
8070	<desc>
8071	Library that provides authentication for Remote Desktop clients. The library
8072	is used if a virtual machine's authentication type is set to "external"
8073	in the VM RemoteDisplay configuration.
8074
8075	The system library extension (".DLL" or ".so") must be omitted.
8076	A full path can be specified; if not, then the library must reside on the
8077	system's default library path.
8078
8079	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
8080	of that name in one of the default VirtualBox library directories.
8081
8082	For details about VirtualBox authentication libraries and how to implement
8083	them, please refer to the VirtualBox manual.
8084
8085	<note>
8086	Setting this property to @c null or empty string will restore the
8087	initial value.
8088	</note>
8089	</desc>
8090	</attribute>
8091
8092	<attribute name="webServiceAuthLibrary" type="wstring">
8093	<desc>
8094	Library that provides authentication for webservice clients. The library
8095	is used if a virtual machine's authentication type is set to "external"
8096	in the VM RemoteDisplay configuration and will be called from
8097	within the <link to="IWebsessionManager::logon" /> implementation.
8098
8099	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
8100	there is no per-VM setting for this, as the webservice is a global
8101	resource (if it is running). Only for this setting (for the webservice),
8102	setting this value to a literal <tt>"null"</tt> string disables authentication,
8103	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8104	no matter what user name and password are supplied.
8105
8106	The initial value of this property is <tt>"VBoxAuth"</tt>,
8107	meaning that the webservice will use the same authentication
8108	library that is used by default for VRDE (again, see
8109	<link to="ISystemProperties::VRDEAuthLibrary" />).
8110	The format and calling convention of authentication libraries
8111	is the same for the webservice as it is for VRDE.
8112
8113	<note>
8114	Setting this property to @c null or empty string will restore the
8115	initial value.
8116	</note>
8117	</desc>
8118	</attribute>
8119
8120	<attribute name="defaultVRDEExtPack" type="wstring">
8121	<desc>
8122	The name of the extension pack providing the default VRDE.
8123
8124	This attribute is for choosing between multiple extension packs
8125	providing VRDE. If only one is installed, it will automatically be the
8126	default one. The attribute value can be empty if no VRDE extension
8127	pack is installed.
8128
8129	For details about VirtualBox Remote Desktop Extension and how to
8130	implement one, please refer to the VirtualBox SDK.
8131	</desc>
8132	</attribute>
8133
8134	<attribute name="logHistoryCount" type="unsigned long">
8135	<desc>
8136	This value specifies how many old release log files are kept.
8137	</desc>
8138	</attribute>
8139
8140	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8141	<desc>This value hold the default audio driver for the current
8142	system.</desc>
8143	</attribute>
8144
8145
8146	<method name="getMaxNetworkAdapters">
8147	<desc>
8148	Maximum total number of network adapters associated with every
8149	<link to="IMachine"/> instance.
8150	</desc>
8151
8152	<param name="chipset" type="ChipsetType" dir="in">
8153	<desc>The chipset type to get the value for.</desc>
8154	</param>
8155
8156
8157	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8158	<desc>The maximum total number of network adapters allowed.</desc>
8159	</param>
8160
8161	</method>
8162
8163	<method name="getMaxNetworkAdaptersOfType">
8164	<desc>
8165	Maximum number of network adapters of a given attachment type,
8166	associated with every <link to="IMachine"/> instance.
8167	</desc>
8168
8169	<param name="chipset" type="ChipsetType" dir="in">
8170	<desc>The chipset type to get the value for.</desc>
8171	</param>
8172
8173	<param name="type" type="NetworkAttachmentType" dir="in">
8174	<desc>Type of attachment.</desc>
8175	</param>
8176
8177	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8178	<desc>The maximum number of network adapters allowed for
8179	particular chipset and attachment type.</desc>
8180	</param>
8181
8182	</method>
8183
8184
8185	<method name="getMaxDevicesPerPortForStorageBus">
8186	<desc>Returns the maximum number of devices which can be attached to a port
8187	for the given storage bus.</desc>
8188
8189	<param name="bus" type="StorageBus" dir="in">
8190	<desc>The storage bus type to get the value for.</desc>
8191	</param>
8192
8193	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8194	<desc>The maximum number of devices which can be attached to the port for the given
8195	storage bus.</desc>
8196	</param>
8197	</method>
8198
8199	<method name="getMinPortCountForStorageBus">
8200	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8201
8202	<param name="bus" type="StorageBus" dir="in">
8203	<desc>The storage bus type to get the value for.</desc>
8204	</param>
8205
8206	<param name="minPortCount" type="unsigned long" dir="return">
8207	<desc>The minimum number of ports for the given storage bus.</desc>
8208	</param>
8209	</method>
8210
8211	<method name="getMaxPortCountForStorageBus">
8212	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8213
8214	<param name="bus" type="StorageBus" dir="in">
8215	<desc>The storage bus type to get the value for.</desc>
8216	</param>
8217
8218	<param name="maxPortCount" type="unsigned long" dir="return">
8219	<desc>The maximum number of ports for the given storage bus.</desc>
8220	</param>
8221	</method>
8222
8223	<method name="getMaxInstancesOfStorageBus">
8224	<desc>Returns the maximum number of storage bus instances which
8225	can be configured for each VM. This corresponds to the number of
8226	storage controllers one can have. Value may depend on chipset type
8227	used.</desc>
8228
8229	<param name="chipset" type="ChipsetType" dir="in">
8230	<desc>The chipset type to get the value for.</desc>
8231	</param>
8232
8233	<param name="bus" type="StorageBus" dir="in">
8234	<desc>The storage bus type to get the value for.</desc>
8235	</param>
8236
8237	<param name="maxInstances" type="unsigned long" dir="return">
8238	<desc>The maximum number of instances for the given storage bus.</desc>
8239	</param>
8240	</method>
8241
8242	<method name="getDeviceTypesForStorageBus">
8243	<desc>Returns list of all the supported device types
8244	(<link to="DeviceType"/>) for the given type of storage
8245	bus.</desc>
8246
8247	<param name="bus" type="StorageBus" dir="in">
8248	<desc>The storage bus type to get the value for.</desc>
8249	</param>
8250
8251	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8252	<desc>The list of all supported device types for the given storage bus.</desc>
8253	</param>
8254	</method>
8255
8256	<method name="getDefaultIoCacheSettingForStorageController">
8257	<desc>Returns the default I/O cache setting for the
8258	given storage controller</desc>
8259
8260	<param name="controllerType" type="StorageControllerType" dir="in">
8261	<desc>The storage controller to the setting for.</desc>
8262	</param>
8263
8264	<param name="enabled" type="boolean" dir="return">
8265	<desc>Returned flag indicating the default value</desc>
8266	</param>
8267	</method>
8268	</interface>
8269
8270	<!--
8271	// IGuest
8272	/////////////////////////////////////////////////////////////////////////
8273	-->
8274
8275	<interface
8276	name="IGuestOSType" extends="$unknown"
8277	uuid="63a03874-e495-41f7-a6dd-48b92fba8355"
8278	wsmap="struct"
8279	>
8280	<desc>
8281	</desc>
8282
8283	<attribute name="familyId" type="wstring" readonly="yes">
8284	<desc>Guest OS family identifier string.</desc>
8285	</attribute>
8286
8287	<attribute name="familyDescription" type="wstring" readonly="yes">
8288	<desc>Human readable description of the guest OS family.</desc>
8289	</attribute>
8290
8291	<attribute name="id" type="wstring" readonly="yes">
8292	<desc>Guest OS identifier string.</desc>
8293	</attribute>
8294
8295	<attribute name="description" type="wstring" readonly="yes">
8296	<desc>Human readable description of the guest OS.</desc>
8297	</attribute>
8298
8299	<attribute name="is64Bit" type="boolean" readonly="yes">
8300	<desc>Returns @c true if the given OS is 64-bit</desc>
8301	</attribute>
8302
8303	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8304	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8305	</attribute>
8306
8307	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8308	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8309	</attribute>
8310
8311	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8312	<desc>Recommended RAM size in Megabytes.</desc>
8313	</attribute>
8314
8315	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8316	<desc>Recommended video RAM size in Megabytes.</desc>
8317	</attribute>
8318
8319	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8320	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8321	</attribute>
8322
8323	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8324	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8325	</attribute>
8326
8327	<attribute name="recommendedHDD" type="long long" readonly="yes">
8328	<desc>Recommended hard disk size in bytes.</desc>
8329	</attribute>
8330
8331	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8332	<desc>Returns recommended network adapter for this OS type.</desc>
8333	</attribute>
8334
8335	<attribute name="recommendedPae" type="boolean" readonly="yes">
8336	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8337	</attribute>
8338
8339	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
8340	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8341	</attribute>
8342
8343	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
8344	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8345	</attribute>
8346
8347	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
8348	<desc>Recommended storage controller type for HD drives.</desc>
8349	</attribute>
8350
8351	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
8352	<desc>Recommended storage bus type for HD drives.</desc>
8353	</attribute>
8354
8355	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8356	<desc>Recommended firmware type.</desc>
8357	</attribute>
8358
8359	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
8360	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8361	</attribute>
8362
8363	<attribute name="recommendedHpet" type="boolean" readonly="yes">
8364	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8365	</attribute>
8366
8367	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
8368	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8369	</attribute>
8370
8371	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
8372	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8373	</attribute>
8374
8375	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8376	<desc>Recommended chipset type.</desc>
8377	</attribute>
8378
8379	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8380	<desc>Recommended audio type.</desc>
8381	</attribute>
8382
8383	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8384	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8385	</attribute>
8386
8387	<attribute name="recommendedUsb" type="boolean" readonly="yes">
8388	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8389	</attribute>
8390
8391	</interface>
8392
8393	<enum
8394	name="AdditionsFacilityType"
8395	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8396	>
8397	<desc>
8398	Guest Additions facility IDs.
8399	</desc>
8400
8401	<const name="None" value="0">
8402	<desc>No/invalid facility.</desc>
8403	</const>
8404	<const name="VBoxGuestDriver" value="20">
8405	<desc>VirtualBox base driver (VBoxGuest).</desc>
8406	</const>
8407	<const name="AutoLogon" value="90">
8408	<desc>Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).</desc>
8409	</const>
8410	<const name="VBoxService" value="100">
8411	<desc>VirtualBox system service (VBoxService).</desc>
8412	</const>
8413	<const name="VBoxTrayClient" value="101">
8414	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8415	</const>
8416	<const name="Seamless" value="1000">
8417	<desc>Seamless guest desktop integration.</desc>
8418	</const>
8419	<const name="Graphics" value="1100">
8420	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8421	are not immediately acted on and guest display resizes are probably not initiated by
8422	the guest additions.
8423	</desc>
8424	</const>
8425	<const name="All" value="2147483646">
8426	<desc>All facilities selected.</desc>
8427	</const>
8428	</enum>
8429
8430	<enum
8431	name="AdditionsFacilityClass"
8432	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8433	>
8434	<desc>
8435	Guest Additions facility classes.
8436	</desc>
8437
8438	<const name="None" value="0">
8439	<desc>No/invalid class.</desc>
8440	</const>
8441	<const name="Driver" value="10">
8442	<desc>Driver.</desc>
8443	</const>
8444	<const name="Service" value="30">
8445	<desc>System service.</desc>
8446	</const>
8447	<const name="Program" value="50">
8448	<desc>Program.</desc>
8449	</const>
8450	<const name="Feature" value="100">
8451	<desc>Feature.</desc>
8452	</const>
8453	<const name="ThirdParty" value="999">
8454	<desc>Third party.</desc>
8455	</const>
8456	<const name="All" value="2147483646">
8457	<desc>All facility classes selected.</desc>
8458	</const>
8459	</enum>
8460
8461	<enum
8462	name="AdditionsFacilityStatus"
8463	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
8464	>
8465	<desc>
8466	Guest Additions facility states.
8467	</desc>
8468
8469	<const name="Inactive" value="0">
8470	<desc>Facility is not active.</desc>
8471	</const>
8472	<const name="Paused" value="1">
8473	<desc>Facility has been paused.</desc>
8474	</const>
8475	<const name="PreInit" value="20">
8476	<desc>Facility is preparing to initialize.</desc>
8477	</const>
8478	<const name="Init" value="30">
8479	<desc>Facility is initializing.</desc>
8480	</const>
8481	<const name="Active" value="50">
8482	<desc>Facility is up and running.</desc>
8483	</const>
8484	<const name="Terminating" value="100">
8485	<desc>Facility is shutting down.</desc>
8486	</const>
8487	<const name="Terminated" value="101">
8488	<desc>Facility successfully shut down.</desc>
8489	</const>
8490	<const name="Failed" value="800">
8491	<desc>Facility failed to start.</desc>
8492	</const>
8493	<const name="Unknown" value="999">
8494	<desc>Facility status is unknown.</desc>
8495	</const>
8496	</enum>
8497
8498	<interface
8499	name="IAdditionsFacility" extends="$unknown"
8500	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
8501	wsmap="struct"
8502	>
8503	<desc>
8504	Structure representing a Guest Additions facility.
8505	</desc>
8506
8507	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
8508	<desc>The class this facility is part of.</desc>
8509	</attribute>
8510
8511	<attribute name="lastUpdated" type="long long" readonly="yes">
8512	<desc>
8513	Time stamp of the last status update,
8514	in milliseconds since 1970-01-01 UTC.
8515	</desc>
8516	</attribute>
8517
8518	<attribute name="name" type="wstring" readonly="yes">
8519	<desc>The facility's friendly name.</desc>
8520	</attribute>
8521
8522	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8523	<desc>The current status.</desc>
8524	</attribute>
8525
8526	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8527	<desc>The facility's type ID.</desc>
8528	</attribute>
8529	</interface>
8530
8531	<enum
8532	name="AdditionsRunLevelType"
8533	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8534	>
8535	<desc>
8536	Guest Additions run level type.
8537	</desc>
8538
8539	<const name="None" value="0">
8540	<desc>Guest Additions are not loaded.</desc>
8541	</const>
8542	<const name="System" value="1">
8543	<desc>Guest drivers are loaded.</desc>
8544	</const>
8545	<const name="Userland" value="2">
8546	<desc>Common components (such as application services) are loaded.</desc>
8547	</const>
8548	<const name="Desktop" value="3">
8549	<desc>Per-user desktop components are loaded.</desc>
8550	</const>
8551	</enum>
8552
8553	<enum
8554	name="AdditionsUpdateFlag"
8555	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8556	>
8557	<desc>
8558	Guest Additions update flags.
8559	</desc>
8560
8561	<const name="None" value="0">
8562	<desc>No flag set.</desc>
8563	</const>
8564	<const name="WaitForUpdateStartOnly" value="1">
8565	<desc>Only wait for the update process being started and do not
8566	wait while peforming the actual update.</desc>
8567	</const>
8568	</enum>
8569
8570	<enum
8571	name="ExecuteProcessFlag"
8572	uuid="1c49b831-b2c7-4a30-97dd-999a2e2cbf90"
8573	>
8574	<desc>
8575	Guest process execution flags.
8576	</desc>
8577
8578	<const name="None" value="0">
8579	<desc>No flag set.</desc>
8580	</const>
8581	<const name="WaitForProcessStartOnly" value="1">
8582	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8583	process itself then uses an infinite timeout.</desc>
8584	</const>
8585	<const name="IgnoreOrphanedProcesses" value="2">
8586	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8587	</const>
8588	<const name="Hidden" value="4">
8589	<desc>Do not show the started process according to the guest OS guidelines.</desc>
8590	</const>
8591	<const name="NoProfile" value="8">
8592	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
8593	</const>
8594	<const name="WaitForStdOut" value="16">
8595	<desc>The guest process waits until all data from stdout is read out.</desc>
8596	</const>
8597	<const name="WaitForStdErr" value="32">
8598	<desc>The guest process waits until all data from stderr is read out.</desc>
8599	</const>
8600	</enum>
8601
8602	<enum
8603	name="ExecuteProcessStatus"
8604	uuid="153768d9-d971-4098-8b5a-c5cb1ab9ea88"
8605	>
8606	<desc>
8607	Guest process execution status.
8608	</desc>
8609	<const name="Undefined" value="0">
8610	<desc>Process is in an undefined state.</desc>
8611	</const>
8612
8613	<const name="Started" value="1">
8614	<desc>Process has been started.</desc>
8615	</const>
8616	<const name="TerminatedNormally" value="2">
8617	<desc>Process terminated normally.</desc>
8618	</const>
8619	<const name="TerminatedSignal" value="3">
8620	<desc>Process terminated via signal.</desc>
8621	</const>
8622	<const name="TerminatedAbnormally" value="4">
8623	<desc>Process terminated abnormally.</desc>
8624	</const>
8625	<const name="TimedOutKilled" value="5">
8626	<desc>Process timed out and was killed.</desc>
8627	</const>
8628	<const name="TimedOutAbnormally" value="6">
8629	<desc>Process timed out and was not killed successfully.</desc>
8630	</const>
8631	<const name="Down" value="7">
8632	<desc>Service/OS is stopping, process was killed.</desc>
8633	</const>
8634	<const name="Error" value="8">
8635	<desc>Something went wrong (error code in flags).</desc>
8636	</const>
8637	</enum>
8638
8639	<enum
8640	name="ProcessInputFlag"
8641	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8642	>
8643	<desc>
8644	Guest process input flags.
8645	</desc>
8646	<const name="None" value="0">
8647	<desc>No flag set.</desc>
8648	</const>
8649	<const name="EndOfFile" value="1">
8650	<desc>End of file (input) reached.</desc>
8651	</const>
8652	</enum>
8653
8654	<enum
8655	name="ProcessOutputFlag"
8656	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
8657	>
8658	<desc>
8659	Guest process output flags for specifying which
8660	type of output to retrieve.
8661	</desc>
8662	<const name="None" value="0">
8663	<desc>No flags set. Get output from stdout.</desc>
8664	</const>
8665	<const name="StdErr" value="1">
8666	<desc>Get output from stderr.</desc>
8667	</const>
8668	</enum>
8669
8670	<enum
8671	name="CopyFileFlag"
8672	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
8673	>
8674	<desc>
8675	Host/Guest copy flags. At the moment none of these flags
8676	are implemented.
8677	</desc>
8678	<const name="None" value="0">
8679	<desc>No flag set.</desc>
8680	</const>
8681	<const name="Recursive" value="1">
8682	<desc>Copy directories recursively.</desc>
8683	</const>
8684	<const name="Update" value="2">
8685	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
8686	</const>
8687	<const name="FollowLinks" value="4">
8688	<desc>Follow symbolic links.</desc>
8689	</const>
8690	</enum>
8691
8692	<enum
8693	name="DirectoryCreateFlag"
8694	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
8695	>
8696	<desc>
8697	Directory creation flags.
8698	</desc>
8699	<const name="None" value="0">
8700	<desc>No flag set.</desc>
8701	</const>
8702	<const name="Parents" value="1">
8703	<desc>No error if existing, make parent directories as needed.</desc>
8704	</const>
8705	</enum>
8706
8707	<enum
8708	name="DragAndDropAction"
8709	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
8710	>
8711	<desc>
8712	Possible actions within an Drag and Drop operation.
8713	</desc>
8714
8715	<const name="Ignore" value="0">
8716	<desc>Do nothing.</desc>
8717	</const>
8718
8719	<const name="Copy" value="1">
8720	<desc>Copy the item to the target.</desc>
8721	</const>
8722
8723	<const name="Move" value="2">
8724	<desc>Move the item to the target.</desc>
8725	</const>
8726
8727	<const name="Link" value="3">
8728	<desc>Link the item from within the target.</desc>
8729	</const>
8730	</enum>
8731
8732	<enum
8733	name="DirectoryOpenFlag"
8734	uuid="fc8f6203-0072-4f34-bd08-0b35e50bf071"
8735	>
8736	<desc>
8737	Directory open flags.
8738	</desc>
8739	<const name="None" value="0">
8740	<desc>No flag set.</desc>
8741	</const>
8742	</enum>
8743
8744	<enum
8745	name="GuestDirEntryType"
8746	uuid="6d19d924-1b77-4fc8-b369-a3b2c85c8241"
8747	>
8748	<desc>
8749	Guest directory entry type.
8750	</desc>
8751	<const name="Unknown" value="0">
8752	<desc>Unknown.</desc>
8753	</const>
8754	<const name="Directory" value="4">
8755	<desc>Regular file.</desc>
8756	</const>
8757	<const name="File" value="10">
8758	<desc>Regular file.</desc>
8759	</const>
8760	<const name="Symlink" value="12">
8761	<desc>Symbolic link.</desc>
8762	</const>
8763	</enum>
8764
8765	<interface
8766	name="IGuestDirEntry" extends="$unknown"
8767	uuid="20a66efc-c2f6-4438-826f-38454c04369e"
8768	wsmap="struct"
8769	>
8770	<desc>
8771	Structure representing a directory entry on the guest OS.
8772	</desc>
8773	<attribute name="nodeId" type="long long" readonly="yes">
8774	<desc>The unique identifier (within the guest's file system) of this file system object.</desc>
8775	</attribute>
8776	<attribute name="name" type="wstring" readonly="yes">
8777	<desc>The filename.</desc>
8778	</attribute>
8779	<attribute name="type" type="GuestDirEntryType" readonly="yes">
8780	<desc>The entry type.</desc>
8781	</attribute>
8782	</interface>
8783
8784	<interface
8785	name="IGuest" extends="$unknown"
8786	uuid="88696240-7411-4fe6-bb5e-ef56fb8a61f3"
8787	wsmap="managed"
8788	>
8789	<desc>
8790	The IGuest interface represents information about the operating system
8791	running inside the virtual machine. Used in
8792	<link to="IConsole::guest"/>.
8793
8794	IGuest provides information about the guest operating system, whether
8795	Guest Additions are installed and other OS-specific virtual machine
8796	properties.
8797	</desc>
8798
8799	<attribute name="OSTypeId" type="wstring" readonly="yes">
8800	<desc>
8801	Identifier of the Guest OS type as reported by the Guest
8802	Additions.
8803	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8804	an IGuestOSType object representing details about the given
8805	Guest OS type.
8806	<note>
8807	If Guest Additions are not installed, this value will be
8808	the same as <link to="IMachine::OSTypeId"/>.
8809	</note>
8810	</desc>
8811	</attribute>
8812
8813	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
8814	<desc>
8815	Current run level of the Guest Additions.
8816	</desc>
8817	</attribute>
8818
8819	<attribute name="additionsVersion" type="wstring" readonly="yes">
8820	<desc>
8821	Version of the Guest Additions in the same format as
8822	<link to="IVirtualBox::version"/>.
8823	</desc>
8824	</attribute>
8825
8826	<attribute name="additionsRevision" type="unsigned long" readonly="yes">
8827	<desc>
8828	The internal build revision number of the additions.
8829
8830	See also <link to="IVirtualBox::revision"/>.
8831	</desc>
8832	</attribute>
8833
8834	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
8835	<desc>
8836	Array of current known facilities. Only returns facilities where a status is known,
8837	e.g. facilities with an unknown status will not be returned.
8838	</desc>
8839	</attribute>
8840
8841	<attribute name="memoryBalloonSize" type="unsigned long">
8842	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8843	</attribute>
8844
8845	<attribute name="statisticsUpdateInterval" type="unsigned long">
8846	<desc>Interval to update guest statistics in seconds.</desc>
8847	</attribute>
8848
8849	<method name="internalGetStatistics">
8850	<desc>
8851	Internal method; do not use as it might change at any time.
8852	</desc>
8853	<param name="cpuUser" type="unsigned long" dir="out">
8854	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
8855	</param>
8856	<param name="cpuKernel" type="unsigned long" dir="out">
8857	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
8858	</param>
8859	<param name="cpuIdle" type="unsigned long" dir="out">
8860	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
8861	</param>
8862	<param name="memTotal" type="unsigned long" dir="out">
8863	<desc>Total amount of physical guest RAM.</desc>
8864	</param>
8865	<param name="memFree" type="unsigned long" dir="out">
8866	<desc>Free amount of physical guest RAM.</desc>
8867	</param>
8868	<param name="memBalloon" type="unsigned long" dir="out">
8869	<desc>Amount of ballooned physical guest RAM.</desc>
8870	</param>
8871	<param name="memShared" type="unsigned long" dir="out">
8872	<desc>Amount of shared physical guest RAM.</desc>
8873	</param>
8874	<param name="memCache" type="unsigned long" dir="out">
8875	<desc>Total amount of guest (disk) cache memory.</desc>
8876	</param>
8877	<param name="pagedTotal" type="unsigned long" dir="out">
8878	<desc>Total amount of space in the page file.</desc>
8879	</param>
8880	<param name="memAllocTotal" type="unsigned long" dir="out">
8881	<desc>Total amount of memory allocated by the hypervisor.</desc>
8882	</param>
8883	<param name="memFreeTotal" type="unsigned long" dir="out">
8884	<desc>Total amount of free memory available in the hypervisor.</desc>
8885	</param>
8886	<param name="memBalloonTotal" type="unsigned long" dir="out">
8887	<desc>Total amount of memory ballooned by the hypervisor.</desc>
8888	</param>
8889	<param name="memSharedTotal" type="unsigned long" dir="out">
8890	<desc>Total amount of shared memory in the hypervisor.</desc>
8891	</param>
8892	</method>
8893
8894	<method name="getFacilityStatus">
8895	<desc>
8896	Get the current status of a Guest Additions facility.
8897	</desc>
8898	<param name="facility" type="AdditionsFacilityType" dir="in">
8899	<desc>Facility to check status for.</desc>
8900	</param>
8901	<param name="timestamp" type="long long" dir="out">
8902	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
8903	</param>
8904	<param name="status" type="AdditionsFacilityStatus" dir="return">
8905	<desc>The current (latest) facility status.</desc>
8906	</param>
8907	</method>
8908
8909	<method name="getAdditionsStatus">
8910	<desc>
8911	Retrieve the current status of a certain Guest Additions run level.
8912
8913	<result name="VBOX_E_NOT_SUPPORTED">
8914	Wrong status level specified.
8915	</result>
8916
8917	</desc>
8918	<param name="level" type="AdditionsRunLevelType" dir="in">
8919	<desc>Status level to check</desc>
8920	</param>
8921	<param name="active" type="boolean" dir="return">
8922	<desc>Flag whether the status level has been reached or not</desc>
8923	</param>
8924	</method>
8925
8926	<method name="setCredentials">
8927	<desc>
8928	Store login credentials that can be queried by guest operating
8929	systems with Additions installed. The credentials are transient
8930	to the session and the guest may also choose to erase them. Note
8931	that the caller cannot determine whether the guest operating system
8932	has queried or made use of the credentials.
8933
8934	<result name="VBOX_E_VM_ERROR">
8935	VMM device is not available.
8936	</result>
8937
8938	</desc>
8939	<param name="userName" type="wstring" dir="in">
8940	<desc>User name string, can be empty</desc>
8941	</param>
8942	<param name="password" type="wstring" dir="in">
8943	<desc>Password string, can be empty</desc>
8944	</param>
8945	<param name="domain" type="wstring" dir="in">
8946	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8947	</param>
8948	<param name="allowInteractiveLogon" type="boolean" dir="in">
8949	<desc>
8950	Flag whether the guest should alternatively allow the user to
8951	interactively specify different credentials. This flag might
8952	not be supported by all versions of the Additions.
8953	</desc>
8954	</param>
8955	</method>
8956
8957	<method name="dragHGEnter">
8958	<desc>
8959	Informs the guest about a Drag and Drop enter event.
8960
8961	This is used in Host - Guest direction.
8962
8963	<result name="VBOX_E_VM_ERROR">
8964	VMM device is not available.
8965	</result>
8966
8967	</desc>
8968	<param name="screenId" type="unsigned long" dir="in">
8969	<desc>The screen id where the Drag and Drop event occured.</desc>
8970	</param>
8971	<param name="y" type="unsigned long" dir="in">
8972	<desc>y-position of the event.</desc>
8973	</param>
8974	<param name="x" type="unsigned long" dir="in">
8975	<desc>x-position of the event.</desc>
8976	</param>
8977	<param name="defaultAction" type="DragAndDropAction" dir="in">
8978	<desc>The default action to use.</desc>
8979	</param>
8980	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
8981	<desc>The actions which are allowed.</desc>
8982	</param>
8983	<param name="formats" type="wstring" dir="in" safearray="yes">
8984	<desc>The supported mime types.</desc>
8985	</param>
8986	<param name="resultAction" type="DragAndDropAction" dir="return">
8987	<desc>The resulting action of this event.</desc>
8988	</param>
8989	</method>
8990
8991	<method name="dragHGMove">
8992	<desc>
8993	Informs the guest about a Drag and Drop move event.
8994
8995	This is used in Host - Guest direction.
8996
8997	<result name="VBOX_E_VM_ERROR">
8998	VMM device is not available.
8999	</result>
9000
9001	</desc>
9002	<param name="screenId" type="unsigned long" dir="in">
9003	<desc>The screen id where the Drag and Drop event occured.</desc>
9004	</param>
9005	<param name="x" type="unsigned long" dir="in">
9006	<desc>x-position of the event.</desc>
9007	</param>
9008	<param name="y" type="unsigned long" dir="in">
9009	<desc>y-position of the event.</desc>
9010	</param>
9011	<param name="defaultAction" type="DragAndDropAction" dir="in">
9012	<desc>The default action to use.</desc>
9013	</param>
9014	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
9015	<desc>The actions which are allowed.</desc>
9016	</param>
9017	<param name="formats" type="wstring" dir="in" safearray="yes">
9018	<desc>The supported mime types.</desc>
9019	</param>
9020	<param name="resultAction" type="DragAndDropAction" dir="return">
9021	<desc>The resulting action of this event.</desc>
9022	</param>
9023	</method>
9024
9025	<method name="dragHGLeave">
9026	<desc>
9027	Informs the guest about a Drag and Drop leave event.
9028
9029	This is used in Host - Guest direction.
9030
9031	<result name="VBOX_E_VM_ERROR">
9032	VMM device is not available.
9033	</result>
9034
9035	</desc>
9036	<param name="screenId" type="unsigned long" dir="in">
9037	<desc>The screen id where the Drag and Drop event occured.</desc>
9038	</param>
9039	</method>
9040
9041	<method name="dragHGDrop">
9042	<desc>
9043	Informs the guest about a drop event.
9044
9045	This is used in Host - Guest direction.
9046
9047	<result name="VBOX_E_VM_ERROR">
9048	VMM device is not available.
9049	</result>
9050
9051	</desc>
9052	<param name="screenId" type="unsigned long" dir="in">
9053	<desc>The screen id where the Drag and Drop event occured.</desc>
9054	</param>
9055	<param name="x" type="unsigned long" dir="in">
9056	<desc>x-position of the event.</desc>
9057	</param>
9058	<param name="y" type="unsigned long" dir="in">
9059	<desc>y-position of the event.</desc>
9060	</param>
9061	<param name="defaultAction" type="DragAndDropAction" dir="in">
9062	<desc>The default action to use.</desc>
9063	</param>
9064	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
9065	<desc>The actions which are allowed.</desc>
9066	</param>
9067	<param name="formats" type="wstring" dir="in" safearray="yes">
9068	<desc>The supported mime types.</desc>
9069	</param>
9070	<param name="format" type="wstring" dir="out">
9071	<desc>The resulting format of this event.</desc>
9072	</param>
9073	<param name="resultAction" type="DragAndDropAction" dir="return">
9074	<desc>The resulting action of this event.</desc>
9075	</param>
9076	</method>
9077
9078	<method name="dragHGPutData">
9079	<desc>
9080	Informs the guest about a drop data event.
9081
9082	This is used in Host - Guest direction.
9083
9084	<result name="VBOX_E_VM_ERROR">
9085	VMM device is not available.
9086	</result>
9087
9088	</desc>
9089	<param name="screenId" type="unsigned long" dir="in">
9090	<desc>The screen id where the Drag and Drop event occured.</desc>
9091	</param>
9092	<param name="format" type="wstring" dir="in">
9093	<desc>The mime type the data is in.</desc>
9094	</param>
9095	<param name="data" type="octet" dir="in" safearray="yes">
9096	<desc>The actual data.</desc>
9097	</param>
9098	<param name="progress" type="IProgress" dir="return">
9099	<desc>Progress object to track the operation completion.</desc>
9100	</param>
9101	</method>
9102
9103	<method name="dragGHPending">
9104	<desc>
9105	Ask the guest if there is any Drag and Drop operation pending in the guest.
9106
9107	If no Drag and Drop operation is pending currently, Ignore is returned.
9108
9109	This is used in Guest - Host 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="out" safearray="yes">
9120	<desc>On return the supported mime types.</desc>
9121	</param>
9122	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
9123	<desc>On return the actions which are allowed.</desc>
9124	</param>
9125	<param name="defaultAction" type="DragAndDropAction" dir="return">
9126	<desc>On return the default action to use.</desc>
9127	</param>
9128	</method>
9129
9130	<method name="dragGHDropped">
9131	<desc>
9132	Informs the guest that a drop event occured for a pending Drag and Drop event.
9133
9134	This is used in Guest - Host direction.
9135
9136	<result name="VBOX_E_VM_ERROR">
9137	VMM device is not available.
9138	</result>
9139
9140	</desc>
9141
9142	<param name="format" type="wstring" dir="in">
9143	<desc>The mime type the data must be in.</desc>
9144	</param>
9145	<param name="action" type="DragAndDropAction" dir="in">
9146	<desc>The action to use.</desc>
9147	</param>
9148	<param name="progress" type="IProgress" dir="return">
9149	<desc>Progress object to track the operation completion.</desc>
9150	</param>
9151	</method>
9152
9153	<method name="dragGHGetData">
9154	<desc>
9155	Fetch the data of a previously Drag and Drop event from the guest.
9156
9157	This is used in Guest - Host direction.
9158
9159	<result name="VBOX_E_VM_ERROR">
9160	VMM device is not available.
9161	</result>
9162
9163	</desc>
9164
9165	<param name="data" type="octet" safearray="yes" dir="return">
9166	<desc>The actual data.</desc>
9167	</param>
9168	</method>
9169
9170	<method name="executeProcess">
9171	<desc>
9172	Executes an existing program inside the guest VM.
9173
9174	<note>
9175	Starting at VirtualBox 4.1.8 guest process execution by default is limited
9176	to serve up to 25 guest processes at a time. If all 25 guest processes
9177	are still active and running, starting a new guest process will result in an
9178	appropriate error message.
9179
9180	If ExecuteProcessFlag_WaitForStdOut and/or respectively
9181	ExecuteProcessFlag_WaitForStdErr of <link to="ExecuteProcessFlag"/> is
9182	set, the guest process will not exit until all data from the specified
9183	stream(s) is/are read out.
9184
9185	To raise or lower the guest process execution limit, either the guest property
9186	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
9187	command line by specifying "--control-procs-max-kept" needs to be modified.
9188	A restart of the guest OS is required afterwards. To serve unlimited guest
9189	processes, a value of "0" needs to be set (not recommended).
9190	</note>
9191
9192	<result name="VBOX_E_IPRT_ERROR">
9193	Could not execute process.
9194	</result>
9195
9196	</desc>
9197	<param name="execName" type="wstring" dir="in">
9198	<desc>
9199	Full path name of the command to execute on the guest; the
9200	commands has to exists in the guest VM in order to be executed.
9201	</desc>
9202	</param>
9203	<param name="flags" type="unsigned long" dir="in">
9204	<desc>
9205	<link to="ExecuteProcessFlag"/> flags.
9206	</desc>
9207	</param>
9208	<param name="arguments" type="wstring" safearray="yes" dir="in">
9209	<desc>
9210	Array of arguments passed to the execution command.
9211	</desc>
9212	</param>
9213	<param name="environment" type="wstring" safearray="yes" dir="in">
9214	<desc>
9215	Environment variables that can be set while the command is being
9216	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
9217	variable just set its name ("NAME") without a value.
9218	</desc>
9219	</param>
9220	<param name="userName" type="wstring" dir="in">
9221	<desc>
9222	User name under which the command will be executed; has to exist
9223	and have the appropriate rights to execute programs in the VM.
9224	</desc>
9225	</param>
9226	<param name="password" type="wstring" dir="in">
9227	<desc>
9228	Password of the user account specified.
9229	</desc>
9230	</param>
9231	<param name="timeoutMS" type="unsigned long" dir="in">
9232	<desc>
9233	The maximum timeout value (in msec) to wait for finished program
9234	execution. Pass 0 for an infinite timeout.
9235	</desc>
9236	</param>
9237	<param name="pid" type="unsigned long" dir="out">
9238	<desc>
9239	The PID (process ID) of the started command for later reference.
9240	</desc>
9241	</param>
9242	<param name="progress" type="IProgress" dir="return">
9243	<desc>Progress object to track the operation completion.</desc>
9244	</param>
9245	</method>
9246
9247	<method name="getProcessOutput">
9248	<desc>
9249	Retrieves output of a formerly started and running guest process.
9250
9251	<note>
9252	Starting with VirtualBox 4.1.8 this only will return output data
9253	from stdout or stderr if flag ExecuteProcessFlag_WaitForStdOut
9254	and/or respectively ExecuteProcessFlag_WaitForStdErr of
9255	<link to="ExecuteProcessFlag"/> is set in the
9256	former <link to="#executeProcess"/> call for this guest process.
9257	</note>
9258
9259	<result name="VBOX_E_IPRT_ERROR">
9260	Could not retrieve output.
9261	</result>
9262
9263	</desc>
9264	<param name="pid" type="unsigned long" dir="in">
9265	<desc>
9266	Process id returned by earlier <link to="#executeProcess"/> call.
9267	</desc>
9268	</param>
9269	<param name="flags" type="unsigned long" dir="in">
9270	<desc>
9271	<link to="ProcessOutputFlag"/> flags.
9272	</desc>
9273	</param>
9274	<param name="timeoutMS" type="unsigned long" dir="in">
9275	<desc>
9276	The maximum timeout value (in msec) to wait for output
9277	data. Pass 0 for an infinite timeout.
9278	</desc>
9279	</param>
9280	<param name="size" type="long long" dir="in">
9281	<desc>
9282	Size in bytes to read in the buffer.
9283	</desc>
9284	</param>
9285	<param name="data" type="octet" safearray="yes" dir="return">
9286	<desc>
9287	Buffer for retrieving the actual output. A data size of 0 means end of file
9288	if the requested size was not 0. This is the unprocessed
9289	output data, i.e. the line ending style depends on the platform of
9290	the system the server is running on.
9291	</desc>
9292	</param>
9293	</method>
9294
9295	<method name="getProcessStatus">
9296	<desc>
9297	Retrieves status, exit code and the exit reason of a formerly started
9298	guest process. If a guest process exited or got terminated this function
9299	returns its final status and removes this process from the list of
9300	known guest processes for further retrieval.
9301
9302	<result name="VBOX_E_IPRT_ERROR">
9303	Process with specified PID was not found.
9304	</result>
9305
9306	</desc>
9307	<param name="pid" type="unsigned long" dir="in">
9308	<desc>
9309	Process id returned by earlier <link to="#executeProcess"/> call.
9310	</desc>
9311	</param>
9312	<param name="exitcode" type="unsigned long" dir="out">
9313	<desc>
9314	The exit code (if available).
9315	</desc>
9316	</param>
9317	<param name="flags" type="unsigned long" dir="out">
9318	<desc>
9319	Additional flags of process status. Not used at the moment and
9320	must be set to 0.
9321	</desc>
9322	</param>
9323	<param name="reason" type="ExecuteProcessStatus" dir="return">
9324	<desc>
9325	The current process status.
9326	</desc>
9327	</param>
9328	</method>
9329
9330	<method name="copyFromGuest">
9331	<desc>
9332	Copies files/directories from guest to the host.
9333
9334	<result name="VBOX_E_IPRT_ERROR">
9335	Error while copying.
9336	</result>
9337
9338	</desc>
9339	<param name="source" type="wstring" dir="in">
9340	<desc>
9341	Source file on the guest to copy.
9342	</desc>
9343	</param>
9344	<param name="dest" type="wstring" dir="in">
9345	<desc>
9346	Destination path on the host.
9347	</desc>
9348	</param>
9349	<param name="userName" type="wstring" dir="in">
9350	<desc>
9351	User name under which the copy command will be executed; the
9352	user has to exist and have the appropriate rights to read from
9353	the source path.
9354	</desc>
9355	</param>
9356	<param name="password" type="wstring" dir="in">
9357	<desc>
9358	Password of the user account specified.
9359	</desc>
9360	</param>
9361	<param name="flags" type="unsigned long" dir="in">
9362	<desc>
9363	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9364	</desc>
9365	</param>
9366	<param name="progress" type="IProgress" dir="return">
9367	<desc>Progress object to track the operation completion.</desc>
9368	</param>
9369	</method>
9370
9371	<method name="copyToGuest">
9372	<desc>
9373	Copies files/directories from host to the guest.
9374
9375	<result name="VBOX_E_IPRT_ERROR">
9376	Error while copying.
9377	</result>
9378
9379	</desc>
9380	<param name="source" type="wstring" dir="in">
9381	<desc>
9382	Source file on the host to copy.
9383	</desc>
9384	</param>
9385	<param name="dest" type="wstring" dir="in">
9386	<desc>
9387	Destination path on the guest.
9388	</desc>
9389	</param>
9390	<param name="userName" type="wstring" dir="in">
9391	<desc>
9392	User name under which the copy command will be executed; the
9393	user has to exist and have the appropriate rights to write to
9394	the destination path.
9395	</desc>
9396	</param>
9397	<param name="password" type="wstring" dir="in">
9398	<desc>
9399	Password of the user account specified.
9400	</desc>
9401	</param>
9402	<param name="flags" type="unsigned long" dir="in">
9403	<desc>
9404	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9405	</desc>
9406	</param>
9407	<param name="progress" type="IProgress" dir="return">
9408	<desc>Progress object to track the operation completion.</desc>
9409	</param>
9410	</method>
9411
9412	<method name="directoryClose">
9413	<desc>
9414	Closes a formerly opened guest directory.
9415
9416	<result name="VBOX_E_IPRT_ERROR">
9417	Error while closing directory.
9418	</result>
9419
9420	</desc>
9421	<param name="handle" type="unsigned long" dir="in">
9422	<desc>
9423	Handle of opened directory to close.
9424	</desc>
9425	</param>
9426	</method>
9427
9428	<method name="directoryCreate">
9429	<desc>
9430	Creates a directory on the guest.
9431
9432	<result name="VBOX_E_IPRT_ERROR">
9433	Error while creating directory.
9434	</result>
9435
9436	</desc>
9437	<param name="directory" type="wstring" dir="in">
9438	<desc>
9439	Directory to create.
9440	</desc>
9441	</param>
9442	<param name="userName" type="wstring" dir="in">
9443	<desc>
9444	User name under which the directory creation will be executed; the
9445	user has to exist and have the appropriate rights to create the
9446	desired directory.
9447	</desc>
9448	</param>
9449	<param name="password" type="wstring" dir="in">
9450	<desc>
9451	Password of the user account specified.
9452	</desc>
9453	</param>
9454	<param name="mode" type="unsigned long" dir="in">
9455	<desc>
9456	File mode.
9457	</desc>
9458	</param>
9459	<param name="flags" type="unsigned long" dir="in">
9460	<desc>
9461	<link to="DirectoryCreateFlag"/> flags.
9462	</desc>
9463	</param>
9464	</method>
9465
9466	<method name="directoryOpen">
9467	<desc>
9468	Opens a directory on the guest.
9469
9470	<result name="VBOX_E_IPRT_ERROR">
9471	Error while opening / reading directory.
9472	</result>
9473
9474	</desc>
9475	<param name="directory" type="wstring" dir="in">
9476	<desc>
9477	Directory to read.
9478	</desc>
9479	</param>
9480	<param name="filter" type="wstring" dir="in">
9481	<desc>
9482	Directory filter (DOS style wildcards). Set to empty
9483	string if no filter required.
9484	</desc>
9485	</param>
9486	<param name="flags" type="unsigned long" dir="in">
9487	<desc>
9488	<link to="DirectoryOpenFlag"/> flags.
9489	</desc>
9490	</param>
9491	<param name="userName" type="wstring" dir="in">
9492	<desc>
9493	User name under which the directory reading will be performed; the
9494	user has to exist and have the appropriate rights to access / read the
9495	desired directory.
9496	</desc>
9497	</param>
9498	<param name="password" type="wstring" dir="in">
9499	<desc>
9500	Password of the user account specified.
9501	</desc>
9502	</param>
9503	<param name="handle" type="unsigned long" dir="return">
9504	<desc>
9505	Handle of opened directory returned by openDirectory.
9506	</desc>
9507	</param>
9508	</method>
9509
9510	<method name="directoryRead">
9511	<desc>
9512	Reads the next directory entry of an opened guest directory.
9513
9514	<result name="E_ABORT">
9515	When the end of the directory has been reached.
9516	</result>
9517
9518	<result name="VBOX_E_IPRT_ERROR">
9519	Error while opening / reading directory.
9520	</result>
9521
9522	</desc>
9523	<param name="handle" type="unsigned long" dir="in">
9524	<desc>
9525	Handle of opened directory returned by openDirectory.
9526	</desc>
9527	</param>
9528	<param name="entry" type="IGuestDirEntry" dir="return">
9529	<desc>
9530	Information about next directory entry on success.
9531	</desc>
9532	</param>
9533	</method>
9534
9535	<method name="fileExists">
9536	<desc>
9537	Checks if the specified file name exists and is a regular file.
9538
9539	If the file name ends with a slash or backslash, the function assumes
9540	it's a directory and will check if the specified directory exists and
9541	is a regular directory.
9542
9543	<result name="VBOX_E_IPRT_ERROR">
9544	Error while looking up information.
9545	</result>
9546
9547	</desc>
9548	<param name="file" type="wstring" dir="in">
9549	<desc>
9550	Full path of file to check.
9551	</desc>
9552	</param>
9553	<param name="userName" type="wstring" dir="in">
9554	<desc>
9555	User name under which the lookup will be performed; the
9556	user has to exist and have the appropriate rights to access / read the
9557	desired directory.
9558	</desc>
9559	</param>
9560	<param name="password" type="wstring" dir="in">
9561	<desc>
9562	Password of the user account specified.
9563	</desc>
9564	</param>
9565	<param name="exists" type="boolean" dir="return">
9566	<desc>
9567	True if it's a regular file, false if it isn't (or doesn't exist).
9568	</desc>
9569	</param>
9570	</method>
9571
9572	<method name="fileQuerySize">
9573	<desc>
9574	Queries the size of a file, given the path to it.
9575
9576	<result name="VBOX_E_IPRT_ERROR">
9577	Error while looking up information.
9578	</result>
9579
9580	</desc>
9581	<param name="file" type="wstring" dir="in">
9582	<desc>
9583	Full path of file to query file size for.
9584	</desc>
9585	</param>
9586	<param name="userName" type="wstring" dir="in">
9587	<desc>
9588	User name under which the lookup will be performed; the
9589	user has to exist and have the appropriate rights to access / read the
9590	desired directory.
9591	</desc>
9592	</param>
9593	<param name="password" type="wstring" dir="in">
9594	<desc>
9595	Password of the user account specified.
9596	</desc>
9597	</param>
9598	<param name="size" type="long long" dir="return">
9599	<desc>
9600	Size (in bytes) of file specified.
9601	</desc>
9602	</param>
9603	</method>
9604
9605	<method name="setProcessInput">
9606	<desc>
9607	Sends input into a formerly started process.
9608
9609	<result name="VBOX_E_IPRT_ERROR">
9610	Could not send input.
9611	</result>
9612
9613	</desc>
9614	<param name="pid" type="unsigned long" dir="in">
9615	<desc>
9616	Process id returned by earlier <link to="#executeProcess"/> call.
9617	</desc>
9618	</param>
9619	<param name="flags" type="unsigned long" dir="in">
9620	<desc>
9621	<link to="ProcessInputFlag"/> flags.
9622	</desc>
9623	</param>
9624	<param name="timeoutMS" type="unsigned long" dir="in">
9625	<desc>
9626	The maximum timeout value (in msec) to wait for getting the
9627	data transfered to the guest. Pass 0 for an infinite timeout.
9628	</desc>
9629	</param>
9630	<param name="data" type="octet" dir="in" safearray="yes">
9631	<desc>
9632	Buffer of input data to send to the started process to.
9633	</desc>
9634	</param>
9635	<param name="written" type="unsigned long" dir="return">
9636	<desc>
9637	Number of bytes written.
9638	</desc>
9639	</param>
9640	</method>
9641
9642	<method name="updateGuestAdditions">
9643	<desc>
9644	Updates already installed Guest Additions in a VM
9645	(Windows guests only).
9646
9647	<result name="VBOX_E_IPRT_ERROR">
9648	Error while updating.
9649	</result>
9650
9651	</desc>
9652	<param name="source" type="wstring" dir="in">
9653	<desc>
9654	Path to the Guest Additions .ISO file to use for the upate.
9655	</desc>
9656	</param>
9657	<param name="flags" type="unsigned long" dir="in">
9658	<desc>
9659	<link to="AdditionsUpdateFlag"/> flags.
9660	</desc>
9661	</param>
9662	<param name="progress" type="IProgress" dir="return">
9663	<desc>Progress object to track the operation completion.</desc>
9664	</param>
9665	</method>
9666
9667	</interface>
9668
9669
9670	<!--
9671	// IProgress
9672	/////////////////////////////////////////////////////////////////////////
9673	-->
9674
9675	<interface
9676	name="IProgress" extends="$unknown"
9677	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
9678	wsmap="managed"
9679	>
9680	<desc>
9681	The IProgress interface is used to track and control
9682	asynchronous tasks within VirtualBox.
9683
9684	An instance of this is returned every time VirtualBox starts
9685	an asynchronous task (in other words, a separate thread) which
9686	continues to run after a method call returns. For example,
9687	<link to="IConsole::saveState" />, which saves the state of
9688	a running virtual machine, can take a long time to complete.
9689	To be able to display a progress bar, a user interface such as
9690	the VirtualBox graphical user interface can use the IProgress
9691	object returned by that method.
9692
9693	Note that IProgress is a "read-only" interface in the sense
9694	that only the VirtualBox internals behind the Main API can
9695	create and manipulate progress objects, whereas client code
9696	can only use the IProgress object to monitor a task's
9697	progress and, if <link to="#cancelable" /> is @c true,
9698	cancel the task by calling <link to="#cancel" />.
9699
9700	A task represented by IProgress consists of either one or
9701	several sub-operations that run sequentially, one by one (see
9702	<link to="#operation" /> and <link to="#operationCount" />).
9703	Every operation is identified by a number (starting from 0)
9704	and has a separate description.
9705
9706	You can find the individual percentage of completion of the current
9707	operation in <link to="#operationPercent" /> and the
9708	percentage of completion of the task as a whole
9709	in <link to="#percent" />.
9710
9711	Similarly, you can wait for the completion of a particular
9712	operation via <link to="#waitForOperationCompletion" /> or
9713	for the completion of the whole task via
9714	<link to="#waitForCompletion" />.
9715	</desc>
9716
9717	<attribute name="id" type="uuid" mod="string" readonly="yes">
9718	<desc>ID of the task.</desc>
9719	</attribute>
9720
9721	<attribute name="description" type="wstring" readonly="yes">
9722	<desc>Description of the task.</desc>
9723	</attribute>
9724
9725	<attribute name="initiator" type="$unknown" readonly="yes">
9726	<desc>Initiator of the task.</desc>
9727	</attribute>
9728
9729	<attribute name="cancelable" type="boolean" readonly="yes">
9730	<desc>Whether the task can be interrupted.</desc>
9731	</attribute>
9732
9733	<attribute name="percent" type="unsigned long" readonly="yes">
9734	<desc>
9735	Current progress value of the task as a whole, in percent.
9736	This value depends on how many operations are already complete.
9737	Returns 100 if <link to="#completed" /> is @c true.
9738	</desc>
9739	</attribute>
9740
9741	<attribute name="timeRemaining" type="long" readonly="yes">
9742	<desc>
9743	Estimated remaining time until the task completes, in
9744	seconds. Returns 0 once the task has completed; returns -1
9745	if the remaining time cannot be computed, in particular if
9746	the current progress is 0.
9747
9748	Even if a value is returned, the estimate will be unreliable
9749	for low progress values. It will become more reliable as the
9750	task progresses; it is not recommended to display an ETA
9751	before at least 20% of a task have completed.
9752	</desc>
9753	</attribute>
9754
9755	<attribute name="completed" type="boolean" readonly="yes">
9756	<desc>Whether the task has been completed.</desc>
9757	</attribute>
9758
9759	<attribute name="canceled" type="boolean" readonly="yes">
9760	<desc>Whether the task has been canceled.</desc>
9761	</attribute>
9762
9763	<attribute name="resultCode" type="long" readonly="yes">
9764	<desc>
9765	Result code of the progress task.
9766	Valid only if <link to="#completed"/> is @c true.
9767	</desc>
9768	</attribute>
9769
9770	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
9771	<desc>
9772	Extended information about the unsuccessful result of the
9773	progress operation. May be @c null if no extended information
9774	is available.
9775	Valid only if <link to="#completed"/> is @c true and
9776	<link to="#resultCode"/> indicates a failure.
9777	</desc>
9778	</attribute>
9779
9780	<attribute name="operationCount" type="unsigned long" readonly="yes">
9781	<desc>
9782	Number of sub-operations this task is divided into.
9783	Every task consists of at least one suboperation.
9784	</desc>
9785	</attribute>
9786
9787	<attribute name="operation" type="unsigned long" readonly="yes">
9788	<desc>Number of the sub-operation being currently executed.</desc>
9789	</attribute>
9790
9791	<attribute name="operationDescription" type="wstring" readonly="yes">
9792	<desc>
9793	Description of the sub-operation being currently executed.
9794	</desc>
9795	</attribute>
9796
9797	<attribute name="operationPercent" type="unsigned long" readonly="yes">
9798	<desc>Progress value of the current sub-operation only, in percent.</desc>
9799	</attribute>
9800
9801	<attribute name="operationWeight" type="unsigned long" readonly="yes">
9802	<desc>Weight value of the current sub-operation only.</desc>
9803	</attribute>
9804
9805	<attribute name="timeout" type="unsigned long">
9806	<desc>
9807	When non-zero, this specifies the number of milliseconds after which
9808	the operation will automatically be canceled. This can only be set on
9809	cancelable objects.
9810	</desc>
9811	</attribute>
9812
9813	<method name="setCurrentOperationProgress">
9814	<desc>Internal method, not to be called externally.</desc>
9815	<param name="percent" type="unsigned long" dir="in" />
9816	</method>
9817	<method name="setNextOperation">
9818	<desc>Internal method, not to be called externally.</desc>
9819	<param name="nextOperationDescription" type="wstring" dir="in" />
9820	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
9821	</method>
9822
9823	<method name="waitForCompletion">
9824	<desc>
9825	Waits until the task is done (including all sub-operations)
9826	with a given timeout in milliseconds; specify -1 for an indefinite wait.
9827
9828	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
9829	thread are not processed while waiting. Neglecting event queues may
9830	have dire consequences (degrade performance, resource hogs,
9831	deadlocks, etc.), this is specially so for the main thread on
9832	platforms using XPCOM. Callers are adviced wait for short periods
9833	and service their event queues between calls, or to create a worker
9834	thread to do the waiting.
9835
9836	<result name="VBOX_E_IPRT_ERROR">
9837	Failed to wait for task completion.
9838	</result>
9839	</desc>
9840
9841	<param name="timeout" type="long" dir="in">
9842	<desc>
9843	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9844	</desc>
9845	</param>
9846	</method>
9847
9848	<method name="waitForOperationCompletion">
9849	<desc>
9850	Waits until the given operation is done with a given timeout in
9851	milliseconds; specify -1 for an indefinite wait.
9852
9853	See <link to="#waitForCompletion"> for event queue considerations.</link>
9854
9855	<result name="VBOX_E_IPRT_ERROR">
9856	Failed to wait for operation completion.
9857	</result>
9858
9859	</desc>
9860	<param name="operation" type="unsigned long" dir="in">
9861	<desc>
9862	Number of the operation to wait for.
9863	Must be less than <link to="#operationCount"/>.
9864	</desc>
9865	</param>
9866	<param name="timeout" type="long" dir="in">
9867	<desc>
9868	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9869	</desc>
9870	</param>
9871	</method>
9872
9873	<method name="waitForAsyncProgressCompletion">
9874	<desc>
9875	Waits until the other task is completed (including all
9876	sub-operations) and forward all changes from the other progress to
9877	this progress. This means sub-operation number, description, percent
9878	and so on.
9879
9880	You have to take care on setting up at least the same count on
9881	sub-operations in this progress object like there are in the other
9882	progress object.
9883
9884	If the other progress object supports cancel and this object gets any
9885	cancel request (when here enabled as well), it will be forwarded to
9886	the other progress object.
9887
9888	If there is an error in the other progress, this error isn't
9889	automatically transfered to this progress object. So you have to
9890	check any operation error within the other progress object, after
9891	this method returns.
9892	</desc>
9893
9894	<param name="pProgressAsync" type="IProgress" dir="in">
9895	<desc>
9896	The progress object of the asynchrony process.
9897	</desc>
9898	</param>
9899	</method>
9900
9901	<method name="cancel">
9902	<desc>
9903	Cancels the task.
9904	<note>
9905	If <link to="#cancelable"/> is @c false, then this method will fail.
9906	</note>
9907
9908	<result name="VBOX_E_INVALID_OBJECT_STATE">
9909	Operation cannot be canceled.
9910	</result>
9911
9912	</desc>
9913	</method>
9914
9915	</interface>
9916
9917	<!--
9918	// ISnapshot
9919	/////////////////////////////////////////////////////////////////////////
9920	-->
9921
9922	<interface
9923	name="ISnapshot" extends="$unknown"
9924	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
9925	wsmap="managed"
9926	>
9927	<desc>
9928	The ISnapshot interface represents a snapshot of the virtual
9929	machine.
9930
9931	Together with the differencing media that are created
9932	when a snapshot is taken, a machine can be brought back to
9933	the exact state it was in when the snapshot was taken.
9934
9935	The ISnapshot interface has no methods, only attributes; snapshots
9936	are controlled through methods of the <link to="IConsole" /> interface
9937	which also manage the media associated with the snapshot.
9938	The following operations exist:
9939
9940	<ul>
9941	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
9942	by creating new, empty differencing images for the machine's
9943	media and saving the VM settings and (if the VM is running)
9944	the current VM state in the snapshot.
9945
9946	The differencing images will then receive all data written to
9947	the machine's media, while their parent (base) images
9948	remain unmodified after the snapshot has been taken (see
9949	<link to="IMedium" /> for details about differencing images).
9950	This simplifies restoring a machine to the state of a snapshot:
9951	only the differencing images need to be deleted.
9952
9953	The current machine state is not changed by taking a snapshot
9954	except that <link to="IMachine::currentSnapshot" /> is set to
9955	the newly created snapshot, which is also added to the machine's
9956	snapshots tree.
9957	</li>
9958
9959	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
9960	the state of a previous snapshot by deleting the differencing
9961	image of each of the machine's media and setting the machine's
9962	settings and state to the state that was saved in the snapshot (if any).
9963
9964	This destroys the machine's current state. After calling this,
9965	<link to="IMachine::currentSnapshot" /> points to the snapshot
9966	that was restored.
9967	</li>
9968
9969	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
9970	without affecting the current machine state.
9971
9972	This does not change the current machine state, but instead frees the
9973	resources allocated when the snapshot was taken: the settings and machine
9974	state file are deleted (if any), and the snapshot's differencing image for
9975	each of the machine's media gets merged with its parent image.
9976
9977	Neither the current machine state nor other snapshots are affected
9978	by this operation, except that parent media will be modified
9979	to contain the disk data associated with the snapshot being deleted.
9980
9981	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
9982	attribute is set to the current snapshot's parent or NULL if it
9983	has no parent. Otherwise the attribute is unchanged.
9984	</li>
9985	</ul>
9986
9987	Each snapshot contains a copy of virtual machine's settings (hardware
9988	configuration etc.). This copy is contained in an immutable (read-only)
9989	instance of <link to="IMachine" /> which is available from the snapshot's
9990	<link to="#machine" /> attribute. When restoring the snapshot, these
9991	settings are copied back to the original machine.
9992
9993	In addition, if the machine was running when the
9994	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
9995	the current VM state is saved in the snapshot (similarly to what happens
9996	when a VM's state is saved). The snapshot is then said to be <i>online</i>
9997	because when restoring it, the VM will be running.
9998
9999	If the machine was in <link to="MachineState_Saved">saved</link> saved,
10000	the snapshot receives a copy of the execution state file
10001	(<link to="IMachine::stateFilePath"/>).
10002
10003	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
10004	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
10005	it then contains a so-called "zero execution state", representing a
10006	machine that is powered off.
10007	</desc>
10008
10009	<attribute name="id" type="uuid" mod="string" readonly="yes">
10010	<desc>UUID of the snapshot.</desc>
10011	</attribute>
10012
10013	<attribute name="name" type="wstring">
10014	<desc>Short name of the snapshot.
10015	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
10016	be called implicitly.</note>
10017	</desc>
10018	</attribute>
10019
10020	<attribute name="description" type="wstring">
10021	<desc>Optional description of the snapshot.
10022	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
10023	be called implicitly.</note>
10024	</desc>
10025	</attribute>
10026
10027	<attribute name="timeStamp" type="long long" readonly="yes">
10028	<desc>
10029	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
10030	</desc>
10031	</attribute>
10032
10033	<attribute name="online" type="boolean" readonly="yes">
10034	<desc>
10035	@c true if this snapshot is an online snapshot and @c false otherwise.
10036
10037	When this attribute is @c true, the
10038	<link to="IMachine::stateFilePath"/> attribute of the
10039	<link to="#machine"/> object associated with this snapshot
10040	will point to the saved state file. Otherwise, it will be
10041	an empty string.
10042	</desc>
10043	</attribute>
10044
10045	<attribute name="machine" type="IMachine" readonly="yes">
10046	<desc>
10047	Virtual machine this snapshot is taken on. This object
10048	stores all settings the machine had when taking this snapshot.
10049	<note>
10050	The returned machine object is immutable, i.e. no
10051	any settings can be changed.
10052	</note>
10053	</desc>
10054	</attribute>
10055
10056	<attribute name="parent" type="ISnapshot" readonly="yes">
10057	<desc>
10058	Parent snapshot (a snapshot this one is based on), or
10059	@c null if the snapshot has no parent (i.e. is the first snapshot).
10060	</desc>
10061	</attribute>
10062
10063	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
10064	<desc>
10065	Child snapshots (all snapshots having this one as a parent).
10066	By inspecting this attribute starting with a machine's root snapshot
10067	(which can be obtained by calling <link to="IMachine::findSnapshot" />
10068	with a @c null UUID), a machine's snapshots tree can be iterated over.
10069	</desc>
10070	</attribute>
10071
10072	<method name="getChildrenCount" const="yes">
10073	<desc>
10074	Returns the number of direct childrens of this snapshot.
10075	</desc>
10076	<param name="childrenCount" type="unsigned long" dir="return">
10077	<desc>
10078	</desc>
10079	</param>
10080	</method>
10081
10082	</interface>
10083
10084
10085	<!--
10086	// IMedium
10087	/////////////////////////////////////////////////////////////////////////
10088	-->
10089
10090	<enum
10091	name="MediumState"
10092	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
10093	>
10094	<desc>
10095	Virtual medium state.
10096	<see><link to="IMedium"/></see>
10097	</desc>
10098
10099	<const name="NotCreated" value="0">
10100	<desc>
10101	Associated medium storage does not exist (either was not created yet or
10102	was deleted).
10103	</desc>
10104	</const>
10105	<const name="Created" value="1">
10106	<desc>
10107	Associated storage exists and accessible; this gets set if the
10108	accessibility check performed by <link to="IMedium::refreshState" />
10109	was successful.
10110	</desc>
10111	</const>
10112	<const name="LockedRead" value="2">
10113	<desc>
10114	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
10115	no data modification is possible.
10116	</desc>
10117	</const>
10118	<const name="LockedWrite" value="3">
10119	<desc>
10120	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
10121	no concurrent data reading or modification is possible.
10122	</desc>
10123	</const>
10124	<const name="Inaccessible" value="4">
10125	<desc>
10126	Medium accessibility check (see <link to="IMedium::refreshState" />) has
10127	not yet been performed, or else, associated medium storage is not
10128	accessible. In the first case, <link to="IMedium::lastAccessError"/>
10129	is empty, in the second case, it describes the error that occurred.
10130	</desc>
10131	</const>
10132	<const name="Creating" value="5">
10133	<desc>
10134	Associated medium storage is being created.
10135	</desc>
10136	</const>
10137	<const name="Deleting" value="6">
10138	<desc>
10139	Associated medium storage is being deleted.
10140	</desc>
10141	</const>
10142	</enum>
10143
10144	<enum
10145	name="MediumType"
10146	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
10147	>
10148	<desc>
10149	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
10150	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
10151	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
10152	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
10153	</desc>
10154
10155	<const name="Normal" value="0">
10156	<desc>
10157	Normal medium (attached directly or indirectly, preserved
10158	when taking snapshots).
10159	</desc>
10160	</const>
10161	<const name="Immutable" value="1">
10162	<desc>
10163	Immutable medium (attached indirectly, changes are wiped out
10164	the next time the virtual machine is started).
10165	</desc>
10166	</const>
10167	<const name="Writethrough" value="2">
10168	<desc>
10169	Write through medium (attached directly, ignored when
10170	taking snapshots).
10171	</desc>
10172	</const>
10173	<const name="Shareable" value="3">
10174	<desc>
10175	Allow using this medium concurrently by several machines.
10176	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
10177	</desc>
10178	</const>
10179	<const name="Readonly" value="4">
10180	<desc>
10181	A readonly medium, which can of course be used by several machines.
10182	<note>Present and accepted since VirtualBox 4.0.</note>
10183	</desc>
10184	</const>
10185	<const name="MultiAttach" value="5">
10186	<desc>
10187	A medium which is is indirectly attached, so that one base medium can
10188	be used for several VMs which have their own differencing medium to
10189	store their modifications. In some sense a variant of Immutable
10190	with unset AutoReset flag in each differencing medium.
10191	<note>Present and accepted since VirtualBox 4.0.</note>
10192	</desc>
10193	</const>
10194	</enum>
10195
10196	<enum
10197	name="MediumVariant"
10198	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
10199	>
10200	<desc>
10201	Virtual medium image variant. More than one flag may be set.
10202	<see><link to="IMedium"/></see>
10203	</desc>
10204
10205	<const name="Standard" value="0">
10206	<desc>
10207	No particular variant requested, results in using the backend default.
10208	</desc>
10209	</const>
10210	<const name="VmdkSplit2G" value="0x01">
10211	<desc>
10212	VMDK image split in chunks of less than 2GByte.
10213	</desc>
10214	</const>
10215	<const name="VmdkStreamOptimized" value="0x04">
10216	<desc>
10217	VMDK streamOptimized image. Special import/export format which is
10218	read-only/append-only.
10219	</desc>
10220	</const>
10221	<const name="VmdkESX" value="0x08">
10222	<desc>
10223	VMDK format variant used on ESX products.
10224	</desc>
10225	</const>
10226	<const name="Fixed" value="0x10000">
10227	<desc>
10228	Fixed image. Only allowed for base images.
10229	</desc>
10230	</const>
10231	<const name="Diff" value="0x20000">
10232	<desc>
10233	Differencing image. Only allowed for child images.
10234	</desc>
10235	</const>
10236	<const name="NoCreateDir" value="0x40000000">
10237	<desc>
10238	Special flag which suppresses automatic creation of the subdirectory.
10239	Only used when passing the medium variant as an input parameter.
10240	</desc>
10241	</const>
10242	</enum>
10243
10244	<interface
10245	name="IMediumAttachment" extends="$unknown"
10246	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
10247	wsmap="struct"
10248	>
10249	<desc>
10250	The IMediumAttachment interface links storage media to virtual machines.
10251	For each medium (<link to="IMedium"/>) which has been attached to a
10252	storage controller (<link to="IStorageController"/>) of a machine
10253	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
10254	method, one instance of IMediumAttachment is added to the machine's
10255	<link to="IMachine::mediumAttachments"/> array attribute.
10256
10257	Each medium attachment specifies the storage controller as well as a
10258	port and device number and the IMedium instance representing a virtual
10259	hard disk or floppy or DVD image.
10260
10261	For removable media (DVDs or floppies), there are two additional
10262	options. For one, the IMedium instance can be @c null to represent
10263	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
10264	secondly, the medium can be one of the pseudo-media for host drives
10265	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
10266
10267	<h3>Attaching Hard Disks</h3>
10268
10269	Hard disks are attached to virtual machines using the
10270	<link to="IMachine::attachDevice"/> method and detached using the
10271	<link to="IMachine::detachDevice"/> method. Depending on a medium's
10272	type (see <link to="IMedium::type" />), hard disks are attached either
10273	<i>directly</i> or <i>indirectly</i>.
10274
10275	When a hard disk is being attached directly, it is associated with the
10276	virtual machine and used for hard disk operations when the machine is
10277	running. When a hard disk is being attached indirectly, a new differencing
10278	hard disk linked to it is implicitly created and this differencing hard
10279	disk is associated with the machine and used for hard disk operations.
10280	This also means that if <link to="IMachine::attachDevice"/> performs
10281	a direct attachment then the same hard disk will be returned in response
10282	to the subsequent <link to="IMachine::getMedium"/> call; however if
10283	an indirect attachment is performed then
10284	<link to="IMachine::getMedium"/> will return the implicitly created
10285	differencing hard disk, not the original one passed to <link
10286	to="IMachine::attachDevice"/>. In detail:
10287
10288	<ul>
10289	<li><b>Normal base</b> hard disks that do not have children (i.e.
10290	differencing hard disks linked to them) and that are not already
10291	attached to virtual machines in snapshots are attached <b>directly</b>.
10292	Otherwise, they are attached <b>indirectly</b> because having
10293	dependent children or being part of the snapshot makes it impossible
10294	to modify hard disk contents without breaking the integrity of the
10295	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
10296	quickly determine the kind of the attachment for the given hard
10297	disk. Note that if a normal base hard disk is to be indirectly
10298	attached to a virtual machine with snapshots then a special
10299	procedure called <i>smart attachment</i> is performed (see below).</li>
10300	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
10301	they are attached <b>directly</b> if they do not have children and are
10302	not attached to virtual machines in snapshots, and <b>indirectly</b>
10303	otherwise. Note that the smart attachment procedure is never performed
10304	for differencing hard disks.</li>
10305	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
10306	they are designed to be non-writable. If an immutable hard disk is
10307	attached to a virtual machine with snapshots then a special
10308	procedure called smart attachment is performed (see below).</li>
10309	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
10310	also as designed. This also means that writethrough hard disks cannot
10311	have other hard disks linked to them at all.</li>
10312	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
10313	also as designed. This also means that shareable hard disks cannot
10314	have other hard disks linked to them at all. They behave almost
10315	like writethrough hard disks, except that shareable hard disks can
10316	be attached to several virtual machines which are running, allowing
10317	concurrent accesses. You need special cluster software running in
10318	the virtual machines to make use of such disks.</li>
10319	</ul>
10320
10321	Note that the same hard disk, regardless of its type, may be attached to
10322	more than one virtual machine at a time. In this case, the machine that is
10323	started first gains exclusive access to the hard disk and attempts to
10324	start other machines having this hard disk attached will fail until the
10325	first machine is powered down.
10326
10327	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
10328	that the given hard disk remains associated with the given machine after a
10329	successful <link to="IMachine::detachDevice"/> call until
10330	<link to="IMachine::saveSettings"/> is called to save all changes to
10331	machine settings to disk. This deferring is necessary to guarantee that
10332	the hard disk configuration may be restored at any time by a call to
10333	<link to="IMachine::discardSettings"/> before the settings
10334	are saved (committed).
10335
10336	Note that if <link to="IMachine::discardSettings"/> is called after
10337	indirectly attaching some hard disks to the machine but before a call to
10338	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
10339	all differencing hard disks implicitly created by
10340	<link to="IMachine::attachDevice"/> for these indirect attachments.
10341	Such implicitly created hard disks will also be immediately deleted when
10342	detached explicitly using the <link to="IMachine::detachDevice"/>
10343	call if it is made before <link to="IMachine::saveSettings"/>. This
10344	implicit deletion is safe because newly created differencing hard
10345	disks do not contain any user data.
10346
10347	However, keep in mind that detaching differencing hard disks that were
10348	implicitly created by <link to="IMachine::attachDevice"/>
10349	before the last <link to="IMachine::saveSettings"/> call will
10350	<b>not</b> implicitly delete them as they may already contain some data
10351	(for example, as a result of virtual machine execution). If these hard
10352	disks are no more necessary, the caller can always delete them explicitly
10353	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
10354	from this machine by the <link to="IMachine::saveSettings"/> call.
10355
10356	<h3>Smart Attachment</h3>
10357
10358	When normal base or immutable hard disks are indirectly attached to a
10359	virtual machine then some additional steps are performed to make sure the
10360	virtual machine will have the most recent "view" of the hard disk being
10361	attached. These steps include walking through the machine's snapshots
10362	starting from the current one and going through ancestors up to the first
10363	snapshot. Hard disks attached to the virtual machine in all
10364	of the encountered snapshots are checked whether they are descendants of
10365	the given normal base or immutable hard disk. The first found child (which
10366	is the differencing hard disk) will be used instead of the normal base or
10367	immutable hard disk as a parent for creating a new differencing hard disk
10368	that will be actually attached to the machine. And only if no descendants
10369	are found or if the virtual machine does not have any snapshots then the
10370	normal base or immutable hard disk will be used itself as a parent for
10371	this differencing hard disk.
10372
10373	It is easier to explain what smart attachment does using the
10374	following example:
10375	<pre>
10376	BEFORE attaching B.vdi: AFTER attaching B.vdi:
10377
10378	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
10379	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
10380	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
10381	Snapshot 4 (none) Snapshot 4 (none)
10382	CurState (none) CurState (D3->D2.vdi)
10383
10384	NOT
10385	...
10386	CurState (D3->B.vdi)
10387	</pre>
10388	The first column is the virtual machine configuration before the base hard
10389	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
10390	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
10391	mean that the hard disk that is actually attached to the machine is a
10392	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
10393	another hard disk, <tt>B.vdi</tt>.
10394
10395	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
10396	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
10397	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
10398	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
10399	it cannot be attached directly and needs an indirect attachment (i.e.
10400	implicit creation of a new differencing hard disk). Due to the smart
10401	attachment procedure, the new differencing hard disk
10402	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
10403	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
10404	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
10405	machine.
10406
10407	Note that if there is more than one descendant hard disk of the given base
10408	hard disk found in a snapshot, and there is an exact device, channel and
10409	bus match, then this exact match will be used. Otherwise, the youngest
10410	descendant will be picked up.
10411
10412	There is one more important aspect of the smart attachment procedure which
10413	is not related to snapshots at all. Before walking through the snapshots
10414	as described above, the backup copy of the current list of hard disk
10415	attachment is searched for descendants. This backup copy is created when
10416	the hard disk configuration is changed for the first time after the last
10417	<link to="IMachine::saveSettings"/> call and used by
10418	<link to="IMachine::discardSettings"/> to undo the recent hard disk
10419	changes. When such a descendant is found in this backup copy, it will be
10420	simply re-attached back, without creating a new differencing hard disk for
10421	it. This optimization is necessary to make it possible to re-attach the
10422	base or immutable hard disk to a different bus, channel or device slot
10423	without losing the contents of the differencing hard disk actually
10424	attached to the machine in place of it.
10425
10426	</desc>
10427
10428	<attribute name="medium" type="IMedium" readonly="yes">
10429	<desc>Medium object associated with this attachment; it
10430	can be @c null for removable devices.</desc>
10431	</attribute>
10432
10433	<attribute name="controller" type="wstring" readonly="yes">
10434	<desc>Name of the storage controller of this attachment; this
10435	refers to one of the controllers in <link to="IMachine::storageControllers" />
10436	by name.</desc>
10437	</attribute>
10438
10439	<attribute name="port" type="long" readonly="yes">
10440	<desc>Port number of this attachment.
10441	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10442	</desc>
10443	</attribute>
10444
10445	<attribute name="device" type="long" readonly="yes">
10446	<desc>Device slot number of this attachment.
10447	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10448	</desc>
10449	</attribute>
10450
10451	<attribute name="type" type="DeviceType" readonly="yes">
10452	<desc>Device type of this attachment.</desc>
10453	</attribute>
10454
10455	<attribute name="passthrough" type="boolean" readonly="yes">
10456	<desc>Pass I/O requests through to a device on the host.</desc>
10457	</attribute>
10458
10459	<attribute name="temporaryEject" type="boolean" readonly="yes">
10460	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
10461	</attribute>
10462
10463	<attribute name="isEjected" type="boolean" readonly="yes">
10464	<desc>Signals that the removable medium has been ejected. This is not
10465	necessarily equivalent to having a @c null medium association.</desc>
10466	</attribute>
10467
10468	<attribute name="nonRotational" type="boolean" readonly="yes">
10469	<desc>Whether the associated medium is non-rotational.</desc>
10470	</attribute>
10471
10472	<attribute name="discard" type="boolean" readonly="yes">
10473	<desc>Whether the associated medium supports discarding unused blocks.</desc>
10474	</attribute>
10475
10476	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
10477	<desc>The bandwidth group this medium attachment is assigned to.</desc>
10478	</attribute>
10479
10480	</interface>
10481
10482	<interface
10483	name="IMedium" extends="$unknown"
10484	uuid="53f9cc0c-e0fd-40a5-a404-a7a5272082cd"
10485	wsmap="managed"
10486	>
10487	<desc>
10488	The IMedium interface represents virtual storage for a machine's
10489	hard disks, CD/DVD or floppy drives. It will typically represent
10490	a disk image on the host, for example a VDI or VMDK file representing
10491	a virtual hard disk, or an ISO or RAW file representing virtual
10492	removable media, but can also point to a network location (e.g.
10493	for iSCSI targets).
10494
10495	Instances of IMedium are connected to virtual machines by way of medium
10496	attachments, which link the storage medium to a particular device slot
10497	of a storage controller of the virtual machine.
10498	In the VirtualBox API, virtual storage is therefore always represented
10499	by the following chain of object links:
10500
10501	<ul>
10502	<li><link to="IMachine::storageControllers"/> contains an array of
10503	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
10504	these are instances of <link to="IStorageController"/>).</li>
10505	<li><link to="IMachine::mediumAttachments"/> contains an array of
10506	medium attachments (instances of <link to="IMediumAttachment"/>
10507	created by <link to="IMachine::attachDevice" />),
10508	each containing a storage controller from the above array, a
10509	port/device specification, and an instance of IMedium representing
10510	the medium storage (image file).
10511
10512	For removable media, the storage medium is optional; a medium
10513	attachment with no medium represents a CD/DVD or floppy drive
10514	with no medium inserted. By contrast, hard disk attachments
10515	will always have an IMedium object attached.</li>
10516	<li>Each IMedium in turn points to a storage unit (such as a file
10517	on the host computer or a network resource) that holds actual
10518	data. This location is represented by the <link to="#location"/>
10519	attribute.</li>
10520	</ul>
10521
10522	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
10523	new hard disk media can be created with the VirtualBox API using the
10524	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
10525	disks (see below) are usually implicitly created by VirtualBox as
10526	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
10527	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
10528	should be created with external tools and then opened from within VirtualBox.
10529
10530	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
10531	drive. In that case the <link to="#id" /> attribute contains the UUID of
10532	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
10533
10534	<h3>Media registries</h3>
10535
10536	When a medium has been opened or created using one of the aforementioned
10537	APIs, it becomes "known" to VirtualBox. Known media can be attached
10538	to virtual machines and accessed through <link to="IVirtualBox::findMedium"/>.
10539	They also appear in the global
10540	<link to="IVirtualBox::hardDisks" />,
10541	<link to="IVirtualBox::DVDImages" /> and
10542	<link to="IVirtualBox::floppyImages" /> arrays.
10543
10544	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
10545	in the VirtualBox.xml file, which was shared between all machines and made
10546	transporting machines and their media from one host to another difficult.
10547
10548	Starting with VirtualBox 4.0, media are only added to a registry when they are
10549	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
10550	backwards compatibility, which registry a medium is added to depends on which
10551	VirtualBox version created a machine:
10552
10553	<ul>
10554	<li>If the medium has first been attached to a machine which was created by
10555	VirtualBox 4.0 or later, it is added to that machine's media registry in
10556	the machine XML settings file. This way all information about a machine's
10557	media attachments is contained in a single file and can be transported
10558	easily.</li>
10559	<li>For older media attachments (i.e. if the medium was first attached to a
10560	machine which was created with a VirtualBox version before 4.0), media
10561	continue to be registered in the global VirtualBox settings file, for
10562	backwards compatibility.</li>
10563	</ul>
10564
10565	See <link to="IVirtualBox::openMedium" /> for more information.
10566
10567	Media are removed from media registries by the <link to="IMedium::close"/>,
10568	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
10569
10570	<h3>Accessibility checks</h3>
10571
10572	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
10573	method is called explicitly on a medium. This is done to make the VirtualBox object
10574	ready for serving requests as fast as possible and let the end-user
10575	application decide if it needs to check media accessibility right away or not.
10576
10577	As a result, when VirtualBox starts up (e.g. the VirtualBox
10578	object gets created for the first time), all known media are in the
10579	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
10580	attribute is an empty string because no actual accessibility check has
10581	been made yet.
10582
10583	After calling <link to="#refreshState" />, a medium is considered
10584	<i>accessible</i> if its storage unit can be read. In that case, the
10585	<link to="#state"/> attribute has a value of "Created". If the storage
10586	unit cannot be read (for example, because it is located on a disconnected
10587	network resource, or was accidentally deleted outside VirtualBox),
10588	the medium is considered <i>inaccessible</i>, which is indicated by the
10589	"Inaccessible" state. The exact reason why the medium is inaccessible can be
10590	obtained by reading the <link to="#lastAccessError"/> attribute.
10591
10592	<h3>Medium types</h3>
10593
10594	There are five types of medium behavior which are stored in the
10595	<link to="#type"/> attribute (see <link to="MediumType" />) and
10596	which define the medium's behavior with attachments and snapshots.
10597
10598	All media can be also divided in two groups: <i>base</i> media and
10599	<i>differencing</i> media. A base medium contains all sectors of the
10600	medium data in its own storage and therefore can be used independently.
10601	In contrast, a differencing medium is a "delta" to some other medium and
10602	contains only those sectors which differ from that other medium, which is
10603	then called a <i>parent</i>. The differencing medium is said to be
10604	<i>linked to</i> that parent. The parent may be itself a differencing
10605	medium, thus forming a chain of linked media. The last element in that
10606	chain must always be a base medium. Note that several differencing
10607	media may be linked to the same parent medium.
10608
10609	Differencing media can be distinguished from base media by querying the
10610	<link to="#parent"/> attribute: base media do not have parents they would
10611	depend on, so the value of this attribute is always @c null for them.
10612	Using this attribute, it is possible to walk up the medium tree (from the
10613	child medium to its parent). It is also possible to walk down the tree
10614	using the <link to="#children"/> attribute.
10615
10616	Note that the type of all differencing media is "normal"; all other
10617	values are meaningless for them. Base media may be of any type.
10618
10619	<h3>Automatic composition of the file name part</h3>
10620
10621	Another extension to the <link to="IMedium::location"/> attribute is that
10622	there is a possibility to cause VirtualBox to compose a unique value for
10623	the file name part of the location using the UUID of the hard disk. This
10624	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
10625	e.g. before the storage unit is created, and works as follows. You set the
10626	value of the <link to="IMedium::location"/> attribute to a location
10627	specification which only contains the path specification but not the file
10628	name part and ends with either a forward slash or a backslash character.
10629	In response, VirtualBox will generate a new UUID for the hard disk and
10630	compose the file name using the following pattern:
10631	<pre>
10632	<path>/{<uuid>}.<ext>
10633	</pre>
10634	where <tt><path></tt> is the supplied path specification,
10635	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
10636	is the default extension for the storage format of this hard disk. After
10637	that, you may call any of the methods that create a new hard disk storage
10638	unit and they will use the generated UUID and file name.
10639	</desc>
10640
10641	<attribute name="id" type="uuid" mod="string" readonly="yes">
10642	<desc>
10643	UUID of the medium. For a newly created medium, this value is a randomly
10644	generated UUID.
10645
10646	<note>
10647	For media in one of MediumState_NotCreated, MediumState_Creating or
10648	MediumState_Deleting states, the value of this property is undefined
10649	and will most likely be an empty UUID.
10650	</note>
10651	</desc>
10652	</attribute>
10653
10654	<attribute name="description" type="wstring">
10655	<desc>
10656	Optional description of the medium. For a newly created medium the value
10657	of this attribute is an empty string.
10658
10659	Medium types that don't support this attribute will return E_NOTIMPL in
10660	attempt to get or set this attribute's value.
10661
10662	<note>
10663	For some storage types, reading this attribute may return an outdated
10664	(last known) value when <link to="#state"/> is <link
10665	to="MediumState_Inaccessible"/> or <link
10666	to="MediumState_LockedWrite"/> because the value of this attribute is
10667	stored within the storage unit itself. Also note that changing the
10668	attribute value is not possible in such case, as well as when the
10669	medium is the <link to="MediumState_LockedRead"/> state.
10670	</note>
10671	</desc>
10672	</attribute>
10673
10674	<attribute name="state" type="MediumState" readonly="yes">
10675	<desc>
10676	Returns the current medium state, which is the last state set by
10677	the accessibility check performed by <link to="#refreshState"/>.
10678	If that method has not yet been called on the medium, the state
10679	is "Inaccessible"; as opposed to truly inaccessible media, the
10680	value of <link to="#lastAccessError"/> will be an empty string in
10681	that case.
10682
10683	<note>As of version 3.1, this no longer performs an accessibility check
10684	automatically; call <link to="#refreshState"/> for that.
10685	</note>
10686	</desc>
10687	</attribute>
10688
10689	<attribute name="variant" type="unsigned long" readonly="yes">
10690	<desc>
10691	Returns the storage format variant information for this medium
10692	as a combination of the flags described at <link to="MediumVariant" />.
10693	Before <link to="#refreshState"/> is called this method returns
10694	an undefined value.
10695	</desc>
10696	</attribute>
10697
10698	<attribute name="location" type="wstring">
10699	<desc>
10700	Location of the storage unit holding medium data.
10701
10702	The format of the location string is medium type specific. For medium
10703	types using regular files in a host's file system, the location
10704	string is the full file name.
10705
10706	Some medium types may support changing the storage unit location by
10707	simply changing the value of this property. If this operation is not
10708	supported, the implementation will return E_NOTIMPL in attempt to set
10709	this attribute's value.
10710
10711	When setting a value of the location attribute which is a regular file
10712	in the host's file system, the given file name may be either relative to
10713	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
10714	absolute. Note that if the given location specification does not contain
10715	the file extension part then a proper default extension will be
10716	automatically appended by the implementation depending on the medium type.
10717	</desc>
10718	</attribute>
10719
10720	<attribute name="name" type="wstring" readonly="yes">
10721	<desc>
10722	Name of the storage unit holding medium data.
10723
10724	The returned string is a short version of the <link to="#location"/>
10725	attribute that is suitable for representing the medium in situations
10726	where the full location specification is too long (such as lists
10727	and comboboxes in GUI frontends). This string is also used by frontends
10728	to sort the media list alphabetically when needed.
10729
10730	For example, for locations that are regular files in the host's file
10731	system, the value of this attribute is just the file name (+ extension),
10732	without the path specification.
10733
10734	Note that as opposed to the <link to="#location"/> attribute, the name
10735	attribute will not necessary be unique for a list of media of the
10736	given type and format.
10737	</desc>
10738	</attribute>
10739
10740	<attribute name="deviceType" type="DeviceType" readonly="yes">
10741	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
10742	medium.</desc>
10743	</attribute>
10744
10745	<attribute name="hostDrive" type="boolean" readonly="yes">
10746	<desc>True if this corresponds to a drive on the host.</desc>
10747	</attribute>
10748
10749	<attribute name="size" type="long long" readonly="yes">
10750	<desc>
10751	Physical size of the storage unit used to hold medium data (in bytes).
10752
10753	<note>
10754	For media whose <link to="#state"/> is <link
10755	to="MediumState_Inaccessible"/>, the value of this property is the
10756	last known size. For <link to="MediumState_NotCreated"/> media,
10757	the returned value is zero.
10758	</note>
10759	</desc>
10760	</attribute>
10761
10762	<attribute name="format" type="wstring" readonly="yes">
10763	<desc>
10764	Storage format of this medium.
10765
10766	The value of this attribute is a string that specifies a backend used
10767	to store medium data. The storage format is defined when you create a
10768	new medium or automatically detected when you open an existing medium,
10769	and cannot be changed later.
10770
10771	The list of all storage formats supported by this VirtualBox
10772	installation can be obtained using
10773	<link to="ISystemProperties::mediumFormats"/>.
10774	</desc>
10775	</attribute>
10776
10777	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
10778	<desc>
10779	Storage medium format object corresponding to this medium.
10780
10781	The value of this attribute is a reference to the medium format object
10782	that specifies the backend properties used to store medium data. The
10783	storage format is defined when you create a new medium or automatically
10784	detected when you open an existing medium, and cannot be changed later.
10785
10786	<note>@c null is returned if there is no associated medium format
10787	object. This can e.g. happen for medium objects representing host
10788	drives and other special medium objects.</note>
10789	</desc>
10790	</attribute>
10791
10792	<attribute name="type" type="MediumType">
10793	<desc>
10794	Type (role) of this medium.
10795
10796	The following constraints apply when changing the value of this
10797	attribute:
10798	<ul>
10799	<li>If a medium is attached to a virtual machine (either in the
10800	current state or in one of the snapshots), its type cannot be
10801	changed.
10802	</li>
10803	<li>As long as the medium has children, its type cannot be set
10804	to <link to="MediumType_Writethrough"/>.
10805	</li>
10806	<li>The type of all differencing media is
10807	<link to="MediumType_Normal"/> and cannot be changed.
10808	</li>
10809	</ul>
10810
10811	The type of a newly created or opened medium is set to
10812	<link to="MediumType_Normal"/>, except for DVD and floppy media,
10813	which have a type of <link to="MediumType_Writethrough"/>.
10814	</desc>
10815	</attribute>
10816
10817	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
10818	<desc>
10819	Returns which medium types can selected for this medium.
10820
10821	<result name="E_NOTIMPL">
10822	This attribute is not implemented at the moment.
10823	</result>
10824	</desc>
10825	</attribute>
10826
10827	<attribute name="parent" type="IMedium" readonly="yes">
10828	<desc>
10829	Parent of this medium (the medium this medium is directly based
10830	on).
10831
10832	Only differencing media have parents. For base (non-differencing)
10833	media, @c null is returned.
10834	</desc>
10835	</attribute>
10836
10837	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
10838	<desc>
10839	Children of this medium (all differencing media directly based
10840	on this medium). A @c null array is returned if this medium
10841	does not have any children.
10842	</desc>
10843	</attribute>
10844
10845	<attribute name="base" type="IMedium" readonly="yes">
10846	<desc>
10847	Base medium of this medium.
10848
10849	If this is a differencing medium, its base medium is the medium
10850	the given medium branch starts from. For all other types of media, this
10851	property returns the medium object itself (i.e. the same object this
10852	property is read on).
10853	</desc>
10854	</attribute>
10855
10856	<attribute name="readOnly" type="boolean" readonly="yes">
10857	<desc>
10858	Returns @c true if this medium is read-only and @c false otherwise.
10859
10860	A medium is considered to be read-only when its contents cannot be
10861	modified without breaking the integrity of other parties that depend on
10862	this medium such as its child media or snapshots of virtual machines
10863	where this medium is attached to these machines. If there are no
10864	children and no such snapshots then there is no dependency and the
10865	medium is not read-only.
10866
10867	The value of this attribute can be used to determine the kind of the
10868	attachment that will take place when attaching this medium to a
10869	virtual machine. If the value is @c false then the medium will
10870	be attached directly. If the value is @c true then the medium
10871	will be attached indirectly by creating a new differencing child
10872	medium for that. See the interface description for more information.
10873
10874	Note that all <link to="MediumType_Immutable">Immutable</link> media
10875	are always read-only while all
10876	<link to="MediumType_Writethrough">Writethrough</link> media are
10877	always not.
10878
10879	<note>
10880	The read-only condition represented by this attribute is related to
10881	the medium type and usage, not to the current
10882	<link to="IMedium::state">medium state</link> and not to the read-only
10883	state of the storage unit.
10884	</note>
10885	</desc>
10886	</attribute>
10887
10888	<attribute name="logicalSize" type="long long" readonly="yes">
10889	<desc>
10890	Logical size of this medium (in bytes), as reported to the
10891	guest OS running inside the virtual machine this medium is
10892	attached to. The logical size is defined when the medium is created
10893	and cannot be changed later.
10894
10895	<note>
10896	Reading this property on a differencing medium will return the size
10897	of its <link to="#base"/> medium.
10898	</note>
10899	<note>
10900	For media whose state is <link to="#state"/> is <link
10901	to="MediumState_Inaccessible"/>, the value of this property is the
10902	last known logical size. For <link to="MediumState_NotCreated"/>
10903	media, the returned value is zero.
10904	</note>
10905	</desc>
10906	</attribute>
10907
10908	<attribute name="autoReset" type="boolean">
10909	<desc>
10910	Whether this differencing medium will be automatically reset each
10911	time a virtual machine it is attached to is powered up. This
10912	attribute is automatically set to @c true for the last
10913	differencing image of an "immutable" medium (see
10914	<link to="MediumType" />).
10915
10916	See <link to="#reset"/> for more information about resetting
10917	differencing media.
10918
10919	<note>
10920	Reading this property on a base (non-differencing) medium will
10921	always @c false. Changing the value of this property in this
10922	case is not supported.
10923	</note>
10924
10925	<result name="VBOX_E_NOT_SUPPORTED">
10926	This is not a differencing medium (when changing the attribute
10927	value).
10928	</result>
10929	</desc>
10930	</attribute>
10931
10932	<attribute name="lastAccessError" type="wstring" readonly="yes">
10933	<desc>
10934	Text message that represents the result of the last accessibility
10935	check performed by <link to="#refreshState"/>.
10936
10937	An empty string is returned if the last accessibility check
10938	was successful or has not yet been called. As a result, if
10939	<link to="#state" /> is "Inaccessible" and this attribute is empty,
10940	then <link to="#refreshState"/> has yet to be called; this is the
10941	default value of media after VirtualBox initialization.
10942	A non-empty string indicates a failure and should normally describe
10943	a reason of the failure (for example, a file read error).
10944	</desc>
10945	</attribute>
10946
10947	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
10948	<desc>
10949	Array of UUIDs of all machines this medium is attached to.
10950
10951	A @c null array is returned if this medium is not attached to any
10952	machine or to any machine's snapshot.
10953
10954	<note>
10955	The returned array will include a machine even if this medium is not
10956	attached to that machine in the current state but attached to it in
10957	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
10958	details.
10959	</note>
10960	</desc>
10961	</attribute>
10962
10963	<method name="setIDs">
10964	<desc>
10965	Changes the UUID and parent UUID for a hard disk medium.
10966	</desc>
10967	<param name="setImageId" type="boolean" dir="in">
10968	<desc>
10969	Select whether a new image UUID is set or not.
10970	</desc>
10971	</param>
10972	<param name="imageId" type="uuid" mod="string" dir="in">
10973	<desc>
10974	New UUID for the image. If an empty string is passed, then a new
10975	UUID is automatically created, provided that @a setImageId is @c true.
10976	Specifying a zero UUID is not allowed.
10977	</desc>
10978	</param>
10979	<param name="setParentId" type="boolean" dir="in">
10980	<desc>
10981	Select whether a new parent UUID is set or not.
10982	</desc>
10983	</param>
10984	<param name="parentId" type="uuid" mod="string" dir="in">
10985	<desc>
10986	New parent UUID for the image. If an empty string is passed, then a
10987	new UUID is automatically created, provided @a setParentId is
10988	@c true. A zero UUID is valid.
10989	</desc>
10990	</param>
10991	<result name="E_INVALIDARG">
10992	Invalid parameter combination.
10993	</result>
10994	<result name="VBOX_E_NOT_SUPPORTED">
10995	Medium is not a hard disk medium.
10996	</result>
10997	</method>
10998
10999	<method name="refreshState">
11000	<desc>
11001	If the current medium state (see <link to="MediumState"/>) is one of
11002	"Created", "Inaccessible" or "LockedRead", then this performs an
11003	accessibility check on the medium and sets the value of the <link to="#state"/>
11004	attribute accordingly; that value is also returned for convenience.
11005
11006	For all other state values, this does not perform a refresh but returns
11007	the state only.
11008
11009	The refresh, if performed, may take a long time (several seconds or even
11010	minutes, depending on the storage unit location and format) because it performs an
11011	accessibility check of the storage unit. This check may cause a significant
11012	delay if the storage unit of the given medium is, for example, a file located
11013	on a network share which is not currently accessible due to connectivity
11014	problems. In that case, the call will not return until a timeout
11015	interval defined by the host OS for this operation expires. For this reason,
11016	it is recommended to never read this attribute on the main UI thread to avoid
11017	making the UI unresponsive.
11018
11019	If the last known state of the medium is "Created" and the accessibility
11020	check fails, then the state would be set to "Inaccessible", and
11021	<link to="#lastAccessError"/> may be used to get more details about the
11022	failure. If the state of the medium is "LockedRead", then it remains the
11023	same, and a non-empty value of <link to="#lastAccessError"/> will
11024	indicate a failed accessibility check in this case.
11025
11026	Note that not all medium states are applicable to all medium types.
11027	</desc>
11028	<param name="state" type="MediumState" dir="return">
11029	<desc>
11030	New medium state.
11031	</desc>
11032	</param>
11033	</method>
11034
11035	<method name="getSnapshotIds">
11036	<desc>
11037	Returns an array of UUIDs of all snapshots of the given machine where
11038	this medium is attached to.
11039
11040	If the medium is attached to the machine in the current state, then the
11041	first element in the array will always be the ID of the queried machine
11042	(i.e. the value equal to the @c machineId argument), followed by
11043	snapshot IDs (if any).
11044
11045	If the medium is not attached to the machine in the current state, then
11046	the array will contain only snapshot IDs.
11047
11048	The returned array may be @c null if this medium is not attached
11049	to the given machine at all, neither in the current state nor in one of
11050	the snapshots.
11051	</desc>
11052	<param name="machineId" type="uuid" mod="string" dir="in">
11053	<desc>
11054	UUID of the machine to query.
11055	</desc>
11056	</param>
11057	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
11058	<desc>
11059	Array of snapshot UUIDs of the given machine using this medium.
11060	</desc>
11061	</param>
11062	</method>
11063
11064	<method name="lockRead">
11065	<desc>
11066	Locks this medium for reading.
11067
11068	A read lock is shared: many clients can simultaneously lock the
11069	same medium for reading unless it is already locked for writing (see
11070	<link to="#lockWrite"/>) in which case an error is returned.
11071
11072	When the medium is locked for reading, it cannot be modified
11073	from within VirtualBox. This means that any method that changes
11074	the properties of this medium or contents of the storage unit
11075	will return an error (unless explicitly stated otherwise). That
11076	includes an attempt to start a virtual machine that wants to
11077	write to the the medium.
11078
11079	When the virtual machine is started up, it locks for reading all
11080	media it uses in read-only mode. If some medium cannot be locked
11081	for reading, the startup procedure will fail.
11082	A medium is typically locked for reading while it is used by a running
11083	virtual machine but has a depending differencing image that receives
11084	the actual write operations. This way one base medium can have
11085	multiple child differencing images which can be written to
11086	simultaneously. Read-only media such as DVD and floppy images are
11087	also locked for reading only (so they can be in use by multiple
11088	machines simultaneously).
11089
11090	A medium is also locked for reading when it is the source of a
11091	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
11092
11093	The medium locked for reading must be unlocked using the <link
11094	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
11095	can be nested and must be followed by the same number of paired
11096	<link to="#unlockRead"/> calls.
11097
11098	This method sets the medium state (see <link to="#state"/>) to
11099	"LockedRead" on success. The medium's previous state must be
11100	one of "Created", "Inaccessible" or "LockedRead".
11101
11102	Locking an inaccessible medium is not an error; this method performs
11103	a logical lock that prevents modifications of this medium through
11104	the VirtualBox API, not a physical file-system lock of the underlying
11105	storage unit.
11106
11107	This method returns the current state of the medium
11108	<i>before</i> the operation.
11109
11110	<result name="VBOX_E_INVALID_OBJECT_STATE">
11111	Invalid medium state (e.g. not created, locked, inaccessible,
11112	creating, deleting).
11113	</result>
11114
11115	</desc>
11116	<param name="state" type="MediumState" dir="return">
11117	<desc>
11118	State of the medium after the operation.
11119	</desc>
11120	</param>
11121	</method>
11122
11123	<method name="unlockRead">
11124	<desc>
11125	Cancels the read lock previously set by <link to="#lockRead"/>.
11126
11127	For both success and failure, this method returns the current state
11128	of the medium <i>after</i> the operation.
11129
11130	See <link to="#lockRead"/> for more details.
11131
11132	<result name="VBOX_E_INVALID_OBJECT_STATE">
11133	Medium not locked for reading.
11134	</result>
11135
11136	</desc>
11137	<param name="state" type="MediumState" dir="return">
11138	<desc>
11139	State of the medium after the operation.
11140	</desc>
11141	</param>
11142	</method>
11143
11144	<method name="lockWrite">
11145	<desc>
11146	Locks this medium for writing.
11147
11148	A write lock, as opposed to <link to="#lockRead"/>, is
11149	exclusive: there may be only one client holding a write lock,
11150	and there may be no read locks while the write lock is held.
11151	As a result, read-locking fails if a write lock is held, and
11152	write-locking fails if either a read or another write lock is held.
11153
11154	When a medium is locked for writing, it cannot be modified
11155	from within VirtualBox, and it is not guaranteed that the values
11156	of its properties are up-to-date. Any method that changes the
11157	properties of this medium or contents of the storage unit will
11158	return an error (unless explicitly stated otherwise).
11159
11160	When a virtual machine is started up, it locks for writing all
11161	media it uses to write data to. If any medium could not be locked
11162	for writing, the startup procedure will fail. If a medium has
11163	differencing images, then while the machine is running, only
11164	the last ("leaf") differencing image is locked for writing,
11165	whereas its parents are locked for reading only.
11166
11167	A medium is also locked for writing when it is the target of a
11168	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
11169
11170	The medium locked for writing must be unlocked using the <link
11171	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
11172
11173	This method sets the medium state (see <link to="#state"/>) to
11174	"LockedWrite" on success. The medium's previous state must be
11175	either "Created" or "Inaccessible".
11176
11177	Locking an inaccessible medium is not an error; this method performs
11178	a logical lock that prevents modifications of this medium through
11179	the VirtualBox API, not a physical file-system lock of the underlying
11180	storage unit.
11181
11182	For both, success and failure, this method returns the current
11183	state of the medium <i>before</i> the operation.
11184
11185	<result name="VBOX_E_INVALID_OBJECT_STATE">
11186	Invalid medium state (e.g. not created, locked, inaccessible,
11187	creating, deleting).
11188	</result>
11189
11190	</desc>
11191	<param name="state" type="MediumState" dir="return">
11192	<desc>
11193	State of the medium after the operation.
11194	</desc>
11195	</param>
11196	</method>
11197
11198	<method name="unlockWrite">
11199	<desc>
11200	Cancels the write lock previously set by <link to="#lockWrite"/>.
11201
11202	For both success and failure, this method returns the current
11203	state of the medium <i>after</i> the operation.
11204
11205	See <link to="#lockWrite"/> for more details.
11206
11207	<result name="VBOX_E_INVALID_OBJECT_STATE">
11208	Medium not locked for writing.
11209	</result>
11210
11211	</desc>
11212	<param name="state" type="MediumState" dir="return">
11213	<desc>
11214	State of the medium after the operation.
11215	</desc>
11216	</param>
11217	</method>
11218
11219	<method name="close">
11220	<desc>
11221	Closes this medium.
11222
11223	The medium must not be attached to any known virtual machine
11224	and must not have any known child media, otherwise the
11225	operation will fail.
11226
11227	When the medium is successfully closed, it is removed from
11228	the list of registered media, but its storage unit is not
11229	deleted. In particular, this means that this medium can
11230	later be opened again using the <link to="IVirtualBox::openMedium"/>
11231	call.
11232
11233	Note that after this method successfully returns, the given medium
11234	object becomes uninitialized. This means that any attempt
11235	to call any of its methods or attributes will fail with the
11236	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
11237
11238	<result name="VBOX_E_INVALID_OBJECT_STATE">
11239	Invalid medium state (other than not created, created or
11240	inaccessible).
11241	</result>
11242	<result name="VBOX_E_OBJECT_IN_USE">
11243	Medium attached to virtual machine.
11244	</result>
11245	<result name="VBOX_E_FILE_ERROR">
11246	Settings file not accessible.
11247	</result>
11248	<result name="VBOX_E_XML_ERROR">
11249	Could not parse the settings file.
11250	</result>
11251
11252	</desc>
11253	</method>
11254
11255	<!-- property methods -->
11256
11257	<method name="getProperty" const="yes">
11258	<desc>
11259	Returns the value of the custom medium property with the given name.
11260
11261	The list of all properties supported by the given medium format can
11262	be obtained with <link to="IMediumFormat::describeProperties"/>.
11263
11264	<note>If this method returns an empty string in @a value, the requested
11265	property is supported but currently not assigned any value.</note>
11266
11267	<result name="VBOX_E_OBJECT_NOT_FOUND">
11268	Requested property does not exist (not supported by the format).
11269	</result>
11270	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
11271	</desc>
11272	<param name="name" type="wstring" dir="in">
11273	<desc>Name of the property to get.</desc>
11274	</param>
11275	<param name="value" type="wstring" dir="return">
11276	<desc>Current property value.</desc>
11277	</param>
11278	</method>
11279
11280	<method name="setProperty">
11281	<desc>
11282	Sets the value of the custom medium property with the given name.
11283
11284	The list of all properties supported by the given medium format can
11285	be obtained with <link to="IMediumFormat::describeProperties"/>.
11286
11287	<note>Setting the property value to @c null or an empty string is
11288	equivalent to deleting the existing value. A default value (if it is
11289	defined for this property) will be used by the format backend in this
11290	case.</note>
11291
11292	<result name="VBOX_E_OBJECT_NOT_FOUND">
11293	Requested property does not exist (not supported by the format).
11294	</result>
11295	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
11296	</desc>
11297	<param name="name" type="wstring" dir="in">
11298	<desc>Name of the property to set.</desc>
11299	</param>
11300	<param name="value" type="wstring" dir="in">
11301	<desc>Property value to set.</desc>
11302	</param>
11303	</method>
11304
11305	<method name="getProperties" const="yes">
11306	<desc>
11307	Returns values for a group of properties in one call.
11308
11309	The names of the properties to get are specified using the @a names
11310	argument which is a list of comma-separated property names or
11311	an empty string if all properties are to be returned.
11312	<note>Currently the value of this argument is ignored and the method
11313	always returns all existing properties.</note>
11314
11315	The list of all properties supported by the given medium format can
11316	be obtained with <link to="IMediumFormat::describeProperties"/>.
11317
11318	The method returns two arrays, the array of property names corresponding
11319	to the @a names argument and the current values of these properties.
11320	Both arrays have the same number of elements with each element at the
11321	given index in the first array corresponds to an element at the same
11322	index in the second array.
11323
11324	For properties that do not have assigned values, an empty string is
11325	returned at the appropriate index in the @a returnValues array.
11326
11327	</desc>
11328	<param name="names" type="wstring" dir="in">
11329	<desc>
11330	Names of properties to get.
11331	</desc>
11332	</param>
11333	<param name="returnNames" type="wstring" safearray="yes" dir="out">
11334	<desc>Names of returned properties.</desc>
11335	</param>
11336	<param name="returnValues" type="wstring" safearray="yes" dir="return">
11337	<desc>Values of returned properties.</desc>
11338	</param>
11339	</method>
11340
11341	<method name="setProperties">
11342	<desc>
11343	Sets values for a group of properties in one call.
11344
11345	The names of the properties to set are passed in the @a names
11346	array along with the new values for them in the @a values array. Both
11347	arrays have the same number of elements with each element at the given
11348	index in the first array corresponding to an element at the same index
11349	in the second array.
11350
11351	If there is at least one property name in @a names that is not valid,
11352	the method will fail before changing the values of any other properties
11353	from the @a names array.
11354
11355	Using this method over <link to="#setProperty"/> is preferred if you
11356	need to set several properties at once since it is more efficient.
11357
11358	The list of all properties supported by the given medium format can
11359	be obtained with <link to="IMediumFormat::describeProperties"/>.
11360
11361	Setting the property value to @c null or an empty string is equivalent
11362	to deleting the existing value. A default value (if it is defined for
11363	this property) will be used by the format backend in this case.
11364	</desc>
11365	<param name="names" type="wstring" safearray="yes" dir="in">
11366	<desc>Names of properties to set.</desc>
11367	</param>
11368	<param name="values" type="wstring" safearray="yes" dir="in">
11369	<desc>Values of properties to set.</desc>
11370	</param>
11371	</method>
11372
11373	<!-- storage methods -->
11374
11375	<method name="createBaseStorage">
11376	<desc>
11377	Starts creating a hard disk storage unit (fixed/dynamic, according
11378	to the variant flags) in in the background. The previous storage unit
11379	created for this object, if any, must first be deleted using
11380	<link to="#deleteStorage"/>, otherwise the operation will fail.
11381
11382	Before the operation starts, the medium is placed in
11383	<link to="MediumState_Creating"/> state. If the create operation
11384	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
11385	state.
11386
11387	After the returned progress object reports that the operation has
11388	successfully completed, the medium state will be set to <link
11389	to="MediumState_Created"/>, the medium will be remembered by this
11390	VirtualBox installation and may be attached to virtual machines.
11391
11392	<result name="VBOX_E_NOT_SUPPORTED">
11393	The variant of storage creation operation is not supported. See <link
11394	to="IMediumFormat::capabilities"/>.
11395	</result>
11396	</desc>
11397	<param name="logicalSize" type="long long" dir="in">
11398	<desc>Maximum logical size of the medium in bytes.</desc>
11399	</param>
11400	<param name="variant" type="unsigned long" dir="in">
11401	<desc>Exact image variant which should be created (as a combination of
11402	<link to="MediumVariant" /> flags).</desc>
11403	</param>
11404	<param name="progress" type="IProgress" dir="return">
11405	<desc>Progress object to track the operation completion.</desc>
11406	</param>
11407	</method>
11408
11409	<method name="deleteStorage">
11410	<desc>
11411	Starts deleting the storage unit of this medium.
11412
11413	The medium must not be attached to any known virtual machine and must
11414	not have any known child media, otherwise the operation will fail.
11415	It will also fail if there is no storage unit to delete or if deletion
11416	is already in progress, or if the medium is being in use (locked for
11417	read or for write) or inaccessible. Therefore, the only valid state for
11418	this operation to succeed is <link to="MediumState_Created"/>.
11419
11420	Before the operation starts, the medium is placed in
11421	<link to="MediumState_Deleting"/> state and gets removed from the list
11422	of remembered hard disks (media registry). If the delete operation
11423	fails, the medium will be remembered again and placed back to
11424	<link to="MediumState_Created"/> state.
11425
11426	After the returned progress object reports that the operation is
11427	complete, the medium state will be set to
11428	<link to="MediumState_NotCreated"/> and you will be able to use one of
11429	the storage creation methods to create it again.
11430
11431	<see><link to="#close"/></see>
11432
11433	<result name="VBOX_E_OBJECT_IN_USE">
11434	Medium is attached to a virtual machine.
11435	</result>
11436	<result name="VBOX_E_NOT_SUPPORTED">
11437	Storage deletion is not allowed because neither of storage creation
11438	operations are supported. See
11439	<link to="IMediumFormat::capabilities"/>.
11440	</result>
11441
11442	<note>
11443	If the deletion operation fails, it is not guaranteed that the storage
11444	unit still exists. You may check the <link to="IMedium::state"/> value
11445	to answer this question.
11446	</note>
11447	</desc>
11448	<param name="progress" type="IProgress" dir="return">
11449	<desc>Progress object to track the operation completion.</desc>
11450	</param>
11451	</method>
11452
11453	<!-- diff methods -->
11454
11455	<method name="createDiffStorage">
11456	<desc>
11457	Starts creating an empty differencing storage unit based on this
11458	medium in the format and at the location defined by the @a target
11459	argument.
11460
11461	The target medium must be in <link to="MediumState_NotCreated"/>
11462	state (i.e. must not have an existing storage unit). Upon successful
11463	completion, this operation will set the type of the target medium to
11464	<link to="MediumType_Normal"/> and create a storage unit necessary to
11465	represent the differencing medium data in the given format (according
11466	to the storage format of the target object).
11467
11468	After the returned progress object reports that the operation is
11469	successfully complete, the target medium gets remembered by this
11470	VirtualBox installation and may be attached to virtual machines.
11471
11472	<note>
11473	The medium will be set to <link to="MediumState_LockedRead"/>
11474	state for the duration of this operation.
11475	</note>
11476	<result name="VBOX_E_OBJECT_IN_USE">
11477	Medium not in @c NotCreated state.
11478	</result>
11479	</desc>
11480	<param name="target" type="IMedium" dir="in">
11481	<desc>Target medium.</desc>
11482	</param>
11483	<param name="variant" type="unsigned long" dir="in">
11484	<desc>Exact image variant which should be created (as a combination of
11485	<link to="MediumVariant" /> flags).</desc>
11486	</param>
11487	<param name="progress" type="IProgress" dir="return">
11488	<desc>Progress object to track the operation completion.</desc>
11489	</param>
11490	</method>
11491
11492	<method name="mergeTo">
11493	<desc>
11494	Starts merging the contents of this medium and all intermediate
11495	differencing media in the chain to the given target medium.
11496
11497	The target medium must be either a descendant of this medium or
11498	its ancestor (otherwise this method will immediately return a failure).
11499	It follows that there are two logical directions of the merge operation:
11500	from ancestor to descendant (<i>forward merge</i>) and from descendant to
11501	ancestor (<i>backward merge</i>). Let us consider the following medium
11502	chain:
11503
11504	<pre>Base <- Diff_1 <- Diff_2</pre>
11505
11506	Here, calling this method on the <tt>Base</tt> medium object with
11507	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
11508	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
11509	merge. Note that in both cases the contents of the resulting medium
11510	will be the same, the only difference is the medium object that takes
11511	the result of the merge operation. In case of the forward merge in the
11512	above example, the result will be written to <tt>Diff_2</tt>; in case of
11513	the backward merge, the result will be written to <tt>Base</tt>. In
11514	other words, the result of the operation is always stored in the target
11515	medium.
11516
11517	Upon successful operation completion, the storage units of all media in
11518	the chain between this (source) medium and the target medium, including
11519	the source medium itself, will be automatically deleted and the
11520	relevant medium objects (including this medium) will become
11521	uninitialized. This means that any attempt to call any of
11522	their methods or attributes will fail with the
11523	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
11524	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
11525	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
11526	Note that <tt>Diff_2</tt> in this case will become a base medium
11527	itself since it will no longer be based on any other medium.
11528
11529	Considering the above, all of the following conditions must be met in
11530	order for the merge operation to succeed:
11531	<ul>
11532	<li>
11533	Neither this (source) medium nor any intermediate
11534	differencing medium in the chain between it and the target
11535	medium is attached to any virtual machine.
11536	</li>
11537	<li>
11538	Neither the source medium nor the target medium is an
11539	<link to="MediumType_Immutable"/> medium.
11540	</li>
11541	<li>
11542	The part of the medium tree from the source medium to the
11543	target medium is a linear chain, i.e. all medium in this
11544	chain have exactly one child which is the next medium in this
11545	chain. The only exception from this rule is the target medium in
11546	the forward merge operation; it is allowed to have any number of
11547	child media because the merge operation will not change its
11548	logical contents (as it is seen by the guest OS or by children).
11549	</li>
11550	<li>
11551	None of the involved media are in
11552	<link to="MediumState_LockedRead"/> or
11553	<link to="MediumState_LockedWrite"/> state.
11554	</li>
11555	</ul>
11556
11557	<note>
11558	This (source) medium and all intermediates will be placed to <link
11559	to="MediumState_Deleting"/> state and the target medium will be
11560	placed to <link to="MediumState_LockedWrite"/> state and for the
11561	duration of this operation.
11562	</note>
11563	</desc>
11564	<param name="target" type="IMedium" dir="in">
11565	<desc>Target medium.</desc>
11566	</param>
11567	<param name="progress" type="IProgress" dir="return">
11568	<desc>Progress object to track the operation completion.</desc>
11569	</param>
11570	</method>
11571
11572	<!-- clone method -->
11573
11574	<method name="cloneTo">
11575	<desc>
11576	Starts creating a clone of this medium in the format and at the
11577	location defined by the @a target argument.
11578
11579	The target medium must be either in <link to="MediumState_NotCreated"/>
11580	state (i.e. must not have an existing storage unit) or in
11581	<link to="MediumState_Created"/> state (i.e. created and not locked, and
11582	big enough to hold the data or else the copy will be partial). Upon
11583	successful completion, the cloned medium will contain exactly the
11584	same sector data as the medium being cloned, except that in the
11585	first case a new UUID for the clone will be randomly generated, and in
11586	the second case the UUID will remain unchanged.
11587
11588	The @a parent argument defines which medium will be the parent
11589	of the clone. Passing a @c null reference indicates that the clone will
11590	be a base image, i.e. completely independent. It is possible to specify
11591	an arbitrary medium for this parameter, including the parent of the
11592	medium which is being cloned. Even cloning to a child of the source
11593	medium is possible. Note that when cloning to an existing image, the
11594	@a parent argument is ignored.
11595
11596	After the returned progress object reports that the operation is
11597	successfully complete, the target medium gets remembered by this
11598	VirtualBox installation and may be attached to virtual machines.
11599
11600	<note>
11601	This medium will be placed to <link to="MediumState_LockedRead"/>
11602	state for the duration of this operation.
11603	</note>
11604	<result name="E_NOTIMPL">
11605	The specified cloning variant is not supported at the moment.
11606	</result>
11607	</desc>
11608	<param name="target" type="IMedium" dir="in">
11609	<desc>Target medium.</desc>
11610	</param>
11611	<param name="variant" type="unsigned long" dir="in">
11612	<desc>Exact image variant which should be created (as a combination of
11613	<link to="MediumVariant" /> flags).</desc>
11614	</param>
11615	<param name="parent" type="IMedium" dir="in">
11616	<desc>Parent of the cloned medium.</desc>
11617	</param>
11618	<param name="progress" type="IProgress" dir="return">
11619	<desc>Progress object to track the operation completion.</desc>
11620	</param>
11621	</method>
11622
11623	<!-- other methods -->
11624
11625	<method name="compact">
11626	<desc>
11627	Starts compacting of this medium. This means that the medium is
11628	transformed into a possibly more compact storage representation.
11629	This potentially creates temporary images, which can require a
11630	substantial amount of additional disk space.
11631
11632	This medium will be placed to <link to="MediumState_LockedWrite"/>
11633	state and all its parent media (if any) will be placed to
11634	<link to="MediumState_LockedRead"/> state for the duration of this
11635	operation.
11636
11637	Please note that the results can be either returned straight away,
11638	or later as the result of the background operation via the object
11639	returned via the @a progress parameter.
11640
11641	<result name="VBOX_E_NOT_SUPPORTED">
11642	Medium format does not support compacting (but potentially
11643	needs it).
11644	</result>
11645	</desc>
11646	<param name="progress" type="IProgress" dir="return">
11647	<desc>Progress object to track the operation completion.</desc>
11648	</param>
11649	</method>
11650
11651	<method name="resize">
11652	<desc>
11653	Starts resizing this medium. This means that the nominal size of the
11654	medium is set to the new value. Both increasing and decreasing the
11655	size is possible, and there are no safety checks, since VirtualBox
11656	does not make any assumptions about the medium contents.
11657
11658	Resizing usually needs additional disk space, and possibly also
11659	some temporary disk space. Note that resize does not create a full
11660	temporary copy of the medium, so the additional disk space requirement
11661	is usually much lower than using the clone operation.
11662
11663	This medium will be placed to <link to="MediumState_LockedWrite"/>
11664	state for the duration of this operation.
11665
11666	Please note that the results can be either returned straight away,
11667	or later as the result of the background operation via the object
11668	returned via the @a progress parameter.
11669
11670	<result name="VBOX_E_NOT_SUPPORTED">
11671	Medium format does not support resizing.
11672	</result>
11673	</desc>
11674	<param name="logicalSize" type="long long" dir="in">
11675	<desc>New nominal capacity of the medium in bytes.</desc>
11676	</param>
11677	<param name="progress" type="IProgress" dir="return">
11678	<desc>Progress object to track the operation completion.</desc>
11679	</param>
11680	</method>
11681
11682	<method name="reset">
11683	<desc>
11684	Starts erasing the contents of this differencing medium.
11685
11686	This operation will reset the differencing medium to its initial
11687	state when it does not contain any sector data and any read operation is
11688	redirected to its parent medium. This automatically gets called
11689	during VM power-up for every medium whose <link to="#autoReset" />
11690	attribute is @c true.
11691
11692	The medium will be write-locked for the duration of this operation (see
11693	<link to="#lockWrite" />).
11694
11695	<result name="VBOX_E_NOT_SUPPORTED">
11696	This is not a differencing medium.
11697	</result>
11698	<result name="VBOX_E_INVALID_OBJECT_STATE">
11699	Medium is not in <link to="MediumState_Created"/> or
11700	<link to="MediumState_Inaccessible"/> state.
11701	</result>
11702	</desc>
11703	<param name="progress" type="IProgress" dir="return">
11704	<desc>Progress object to track the operation completion.</desc>
11705	</param>
11706	</method>
11707
11708	</interface>
11709
11710
11711	<!--
11712	// IMediumFormat
11713	/////////////////////////////////////////////////////////////////////////
11714	-->
11715
11716	<enum
11717	name="DataType"
11718	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
11719	>
11720	<const name="Int32" value="0"/>
11721	<const name="Int8" value="1"/>
11722	<const name="String" value="2"/>
11723	</enum>
11724
11725	<enum
11726	name="DataFlags"
11727	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
11728	>
11729	<const name="None" value="0x00"/>
11730	<const name="Mandatory" value="0x01"/>
11731	<const name="Expert" value="0x02"/>
11732	<const name="Array" value="0x04"/>
11733	<const name="FlagMask" value="0x07"/>
11734	</enum>
11735
11736	<enum
11737	name="MediumFormatCapabilities"
11738	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
11739	>
11740	<desc>
11741	Medium format capability flags.
11742	</desc>
11743
11744	<const name="Uuid" value="0x01">
11745	<desc>
11746	Supports UUIDs as expected by VirtualBox code.
11747	</desc>
11748	</const>
11749
11750	<const name="CreateFixed" value="0x02">
11751	<desc>
11752	Supports creating fixed size images, allocating all space instantly.
11753	</desc>
11754	</const>
11755
11756	<const name="CreateDynamic" value="0x04">
11757	<desc>
11758	Supports creating dynamically growing images, allocating space on
11759	demand.
11760	</desc>
11761	</const>
11762
11763	<const name="CreateSplit2G" value="0x08">
11764	<desc>
11765	Supports creating images split in chunks of a bit less than 2 GBytes.
11766	</desc>
11767	</const>
11768
11769	<const name="Differencing" value="0x10">
11770	<desc>
11771	Supports being used as a format for differencing media (see <link
11772	to="IMedium::createDiffStorage"/>).
11773	</desc>
11774	</const>
11775
11776	<const name="Asynchronous" value="0x20">
11777	<desc>
11778	Supports asynchronous I/O operations for at least some configurations.
11779	</desc>
11780	</const>
11781
11782	<const name="File" value="0x40">
11783	<desc>
11784	The format backend operates on files (the <link to="IMedium::location"/>
11785	attribute of the medium specifies a file used to store medium
11786	data; for a list of supported file extensions see
11787	<link to="IMediumFormat::describeFileExtensions"/>).
11788	</desc>
11789	</const>
11790
11791	<const name="Properties" value="0x80">
11792	<desc>
11793	The format backend uses the property interface to configure the storage
11794	location and properties (the <link to="IMediumFormat::describeProperties"/>
11795	method is used to get access to properties supported by the given medium format).
11796	</desc>
11797	</const>
11798
11799	<const name="TcpNetworking" value="0x100">
11800	<desc>
11801	The format backend uses the TCP networking interface for network access.
11802	</desc>
11803	</const>
11804
11805	<const name="VFS" value="0x200">
11806	<desc>
11807	The format backend supports virtual filesystem functionality.
11808	</desc>
11809	</const>
11810
11811	<const name="CapabilityMask" value="0x3FF"/>
11812	</enum>
11813
11814	<interface
11815	name="IMediumFormat" extends="$unknown"
11816	uuid="9bd5b655-ea47-4637-99f3-aad0948be35b"
11817	wsmap="managed"
11818	>
11819	<desc>
11820	The IMediumFormat interface represents a medium format.
11821
11822	Each medium format has an associated backend which is used to handle
11823	media stored in this format. This interface provides information
11824	about the properties of the associated backend.
11825
11826	Each medium format is identified by a string represented by the
11827	<link to="#id"/> attribute. This string is used in calls like
11828	<link to="IVirtualBox::createHardDisk"/> to specify the desired
11829	format.
11830
11831	The list of all supported medium formats can be obtained using
11832	<link to="ISystemProperties::mediumFormats"/>.
11833
11834	<see><link to="IMedium"/></see>
11835	</desc>
11836
11837	<attribute name="id" type="wstring" readonly="yes">
11838	<desc>
11839	Identifier of this format.
11840
11841	The format identifier is a non-@c null non-empty ASCII string. Note that
11842	this string is case-insensitive. This means that, for example, all of
11843	the following strings:
11844	<pre>
11845	"VDI"
11846	"vdi"
11847	"VdI"</pre>
11848	refer to the same medium format.
11849
11850	This string is used in methods of other interfaces where it is necessary
11851	to specify a medium format, such as
11852	<link to="IVirtualBox::createHardDisk"/>.
11853	</desc>
11854	</attribute>
11855
11856	<attribute name="name" type="wstring" readonly="yes">
11857	<desc>
11858	Human readable description of this format.
11859
11860	Mainly for use in file open dialogs.
11861	</desc>
11862	</attribute>
11863
11864	<attribute name="capabilities" type="unsigned long" readonly="yes">
11865	<desc>
11866	Capabilities of the format as a set of bit flags.
11867
11868	For the meaning of individual capability flags see
11869	<link to="MediumFormatCapabilities"/>.
11870	</desc>
11871	</attribute>
11872
11873	<method name="describeFileExtensions">
11874	<desc>
11875	Returns two arrays describing the supported file extensions.
11876
11877	The first array contains the supported extensions and the seconds one
11878	the type each extension supports. Both have the same size.
11879
11880	Note that some backends do not work on files, so this array may be
11881	empty.
11882
11883	<see><link to="IMediumFormat::capabilities"/></see>
11884	</desc>
11885	<param name="extensions" type="wstring" safearray="yes" dir="out">
11886	<desc>The array of supported extensions.</desc>
11887	</param>
11888	<param name="type" type="DeviceType" safearray="yes" dir="out">
11889	<desc>The array which indicates the device type for every given extension.</desc>
11890	</param>
11891	</method>
11892
11893	<method name="describeProperties" const="yes">
11894	<desc>
11895	Returns several arrays describing the properties supported by this
11896	format.
11897
11898	An element with the given index in each array describes one
11899	property. Thus, the number of elements in each returned array is the
11900	same and corresponds to the number of supported properties.
11901
11902	The returned arrays are filled in only if the
11903	<link to="MediumFormatCapabilities_Properties"/> flag is set.
11904	All arguments must be non-@c null.
11905
11906	<see><link to="DataType"/>, <link to="DataFlags"/></see>
11907	</desc>
11908
11909	<param name="names" type="wstring" safearray="yes" dir="out">
11910	<desc>Array of property names.</desc>
11911	</param>
11912	<param name="description" type="wstring" safearray="yes" dir="out">
11913	<desc>Array of property descriptions.</desc>
11914	</param>
11915	<param name="types" type="DataType" safearray="yes" dir="out">
11916	<desc>Array of property types.</desc>
11917	</param>
11918	<param name="flags" type="unsigned long" safearray="yes" dir="out">
11919	<desc>Array of property flags.</desc>
11920	</param>
11921	<param name="defaults" type="wstring" safearray="yes" dir="out">
11922	<desc>Array of default property values.</desc>
11923	</param>
11924	</method>
11925
11926	</interface>
11927
11928
11929	<!--
11930	// IKeyboard
11931	/////////////////////////////////////////////////////////////////////////
11932	-->
11933
11934	<interface
11935	name="IKeyboard" extends="$unknown"
11936	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
11937	wsmap="managed"
11938	>
11939	<desc>
11940	The IKeyboard interface represents the virtual machine's keyboard. Used
11941	in <link to="IConsole::keyboard"/>.
11942
11943	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
11944	to the virtual machine.
11945
11946	</desc>
11947	<method name="putScancode">
11948	<desc>Sends a scancode to the keyboard.
11949
11950	<result name="VBOX_E_IPRT_ERROR">
11951	Could not send scan code to virtual keyboard.
11952	</result>
11953
11954	</desc>
11955	<param name="scancode" type="long" dir="in"/>
11956	</method>
11957
11958	<method name="putScancodes">
11959	<desc>Sends an array of scancodes to the keyboard.
11960
11961	<result name="VBOX_E_IPRT_ERROR">
11962	Could not send all scan codes to virtual keyboard.
11963	</result>
11964
11965	</desc>
11966	<param name="scancodes" type="long" dir="in" safearray="yes"/>
11967	<param name="codesStored" type="unsigned long" dir="return"/>
11968	</method>
11969
11970	<method name="putCAD">
11971	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
11972	function is nothing special, it is just a convenience function
11973	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
11974
11975	<result name="VBOX_E_IPRT_ERROR">
11976	Could not send all scan codes to virtual keyboard.
11977	</result>
11978
11979	</desc>
11980	</method>
11981
11982	<attribute name="eventSource" type="IEventSource" readonly="yes">
11983	<desc>
11984	Event source for keyboard events.
11985	</desc>
11986	</attribute>
11987
11988	</interface>
11989
11990
11991	<!--
11992	// IMouse
11993	/////////////////////////////////////////////////////////////////////////
11994	-->
11995
11996	<enum
11997	name="MouseButtonState"
11998	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
11999	>
12000	<desc>
12001	Mouse button state.
12002	</desc>
12003
12004	<const name="LeftButton" value="0x01"/>
12005	<const name="RightButton" value="0x02"/>
12006	<const name="MiddleButton" value="0x04"/>
12007	<const name="WheelUp" value="0x08"/>
12008	<const name="WheelDown" value="0x10"/>
12009	<const name="XButton1" value="0x20"/>
12010	<const name="XButton2" value="0x40"/>
12011	<const name="MouseStateMask" value="0x7F"/>
12012	</enum>
12013
12014	<interface
12015	name="IMouse" extends="$unknown"
12016	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
12017	wsmap="managed"
12018	>
12019	<desc>
12020	The IMouse interface represents the virtual machine's mouse. Used in
12021	<link to="IConsole::mouse"/>.
12022
12023	Through this interface, the virtual machine's virtual mouse can be
12024	controlled.
12025	</desc>
12026
12027	<attribute name="absoluteSupported" type="boolean" readonly="yes">
12028	<desc>
12029	Whether the guest OS supports absolute mouse pointer positioning
12030	or not.
12031	<note>
12032	You can use the <link to="IMouseCapabilityChangedEvent"/>
12033	event to be instantly informed about changes of this attribute
12034	during virtual machine execution.
12035	</note>
12036	<see><link to="#putMouseEventAbsolute"/></see>
12037	</desc>
12038	</attribute>
12039
12040	<attribute name="relativeSupported" type="boolean" readonly="yes">
12041	<desc>
12042	Whether the guest OS supports relative mouse pointer positioning
12043	or not.
12044	<note>
12045	You can use the <link to="IMouseCapabilityChangedEvent"/>
12046	event to be instantly informed about changes of this attribute
12047	during virtual machine execution.
12048	</note>
12049	<see><link to="#putMouseEvent"/></see>
12050	</desc>
12051	</attribute>
12052
12053	<attribute name="needsHostCursor" type="boolean" readonly="yes">
12054	<desc>
12055	Whether the guest OS can currently switch to drawing it's own mouse
12056	cursor on demand.
12057	<note>
12058	You can use the <link to="IMouseCapabilityChangedEvent"/>
12059	event to be instantly informed about changes of this attribute
12060	during virtual machine execution.
12061	</note>
12062	<see><link to="#putMouseEvent"/></see>
12063	</desc>
12064	</attribute>
12065
12066	<method name="putMouseEvent">
12067	<desc>
12068	Initiates a mouse event using relative pointer movements
12069	along x and y axis.
12070
12071	<result name="E_ACCESSDENIED">
12072	Console not powered up.
12073	</result>
12074	<result name="VBOX_E_IPRT_ERROR">
12075	Could not send mouse event to virtual mouse.
12076	</result>
12077
12078	</desc>
12079
12080	<param name="dx" type="long" dir="in">
12081	<desc>
12082	Amount of pixels the mouse should move to the right.
12083	Negative values move the mouse to the left.
12084	</desc>
12085	</param>
12086	<param name="dy" type="long" dir="in">
12087	<desc>
12088	Amount of pixels the mouse should move downwards.
12089	Negative values move the mouse upwards.
12090	</desc>
12091	</param>
12092	<param name="dz" type="long" dir="in">
12093	<desc>
12094	Amount of mouse wheel moves.
12095	Positive values describe clockwise wheel rotations,
12096	negative values describe counterclockwise rotations.
12097	</desc>
12098	</param>
12099	<param name="dw" type="long" dir="in">
12100	<desc>
12101	Amount of horizontal mouse wheel moves.
12102	Positive values describe a movement to the left,
12103	negative values describe a movement to the right.
12104	</desc>
12105	</param>
12106	<param name="buttonState" type="long" dir="in">
12107	<desc>
12108	The current state of mouse buttons. Every bit represents
12109	a mouse button as follows:
12110	<table>
12111	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
12112	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
12113	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
12114	</table>
12115	A value of <tt>1</tt> means the corresponding button is pressed.
12116	otherwise it is released.
12117	</desc>
12118	</param>
12119	</method>
12120
12121	<method name="putMouseEventAbsolute">
12122	<desc>
12123	Positions the mouse pointer using absolute x and y coordinates.
12124	These coordinates are expressed in pixels and
12125	start from <tt>[1,1]</tt> which corresponds to the top left
12126	corner of the virtual display.
12127
12128	<result name="E_ACCESSDENIED">
12129	Console not powered up.
12130	</result>
12131	<result name="VBOX_E_IPRT_ERROR">
12132	Could not send mouse event to virtual mouse.
12133	</result>
12134
12135	<note>
12136	This method will have effect only if absolute mouse
12137	positioning is supported by the guest OS.
12138	</note>
12139
12140	<see><link to="#absoluteSupported"/></see>
12141	</desc>
12142
12143	<param name="x" type="long" dir="in">
12144	<desc>
12145	X coordinate of the pointer in pixels, starting from @c 1.
12146	</desc>
12147	</param>
12148	<param name="y" type="long" dir="in">
12149	<desc>
12150	Y coordinate of the pointer in pixels, starting from @c 1.
12151	</desc>
12152	</param>
12153	<param name="dz" type="long" dir="in">
12154	<desc>
12155	Amount of mouse wheel moves.
12156	Positive values describe clockwise wheel rotations,
12157	negative values describe counterclockwise rotations.
12158	</desc>
12159	</param>
12160	<param name="dw" type="long" dir="in">
12161	<desc>
12162	Amount of horizontal mouse wheel moves.
12163	Positive values describe a movement to the left,
12164	negative values describe a movement to the right.
12165	</desc>
12166	</param>
12167	<param name="buttonState" type="long" dir="in">
12168	<desc>
12169	The current state of mouse buttons. Every bit represents
12170	a mouse button as follows:
12171	<table>
12172	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
12173	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
12174	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
12175	</table>
12176	A value of @c 1 means the corresponding button is pressed.
12177	otherwise it is released.
12178	</desc>
12179	</param>
12180	</method>
12181
12182	<attribute name="eventSource" type="IEventSource" readonly="yes">
12183	<desc>
12184	Event source for mouse events.
12185	</desc>
12186	</attribute>
12187
12188	</interface>
12189
12190	<!--
12191	// IDisplay
12192	/////////////////////////////////////////////////////////////////////////
12193	-->
12194
12195	<enum
12196	name="FramebufferPixelFormat"
12197	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
12198	>
12199	<desc>
12200	Format of the video memory buffer. Constants represented by this enum can
12201	be used to test for particular values of <link
12202	to="IFramebuffer::pixelFormat"/>. See also <link
12203	to="IFramebuffer::requestResize"/>.
12204
12205	See also www.fourcc.org for more information about FOURCC pixel formats.
12206	</desc>
12207
12208	<const name="Opaque" value="0">
12209	<desc>
12210	Unknown buffer format (the user may not assume any particular format of
12211	the buffer).
12212	</desc>
12213	</const>
12214	<const name="FOURCC_RGB" value="0x32424752">
12215	<desc>
12216	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
12217	bit layout).
12218	</desc>
12219	</const>
12220	</enum>
12221
12222	<interface
12223	name="IFramebuffer" extends="$unknown"
12224	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
12225	wsmap="suppress"
12226	>
12227	<attribute name="address" type="octet" mod="ptr" readonly="yes">
12228	<desc>Address of the start byte of the frame buffer.</desc>
12229	</attribute>
12230
12231	<attribute name="width" type="unsigned long" readonly="yes">
12232	<desc>Frame buffer width, in pixels.</desc>
12233	</attribute>
12234
12235	<attribute name="height" type="unsigned long" readonly="yes">
12236	<desc>Frame buffer height, in pixels.</desc>
12237	</attribute>
12238
12239	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
12240	<desc>
12241	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
12242	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
12243	are: 8, 15, 16, 24 and 32.
12244	</desc>
12245	</attribute>
12246
12247	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
12248	<desc>
12249	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
12250	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
12251	size of the scan line must be aligned to 32 bits.
12252	</desc>
12253	</attribute>
12254
12255	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
12256	<desc>
12257	Frame buffer pixel format. It's either one of the values defined by <link
12258	to="FramebufferPixelFormat"/> or a raw FOURCC code.
12259	<note>
12260	This attribute must never return <link
12261	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
12262	<link to="#address"/> points to must be always known.
12263	</note>
12264	</desc>
12265	</attribute>
12266
12267	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
12268	<desc>
12269	Defines whether this frame buffer uses the virtual video card's memory
12270	buffer (guest VRAM) directly or not. See <link
12271	to="IFramebuffer::requestResize"/> for more information.
12272	</desc>
12273	</attribute>
12274
12275	<attribute name="heightReduction" type="unsigned long" readonly="yes">
12276	<desc>
12277	Hint from the frame buffer about how much of the standard
12278	screen height it wants to use for itself. This information is
12279	exposed to the guest through the VESA BIOS and VMMDev interface
12280	so that it can use it for determining its video mode table. It
12281	is not guaranteed that the guest respects the value.
12282	</desc>
12283	</attribute>
12284
12285	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
12286	<desc>
12287	An alpha-blended overlay which is superposed over the frame buffer.
12288	The initial purpose is to allow the display of icons providing
12289	information about the VM state, including disk activity, in front
12290	ends which do not have other means of doing that. The overlay is
12291	designed to controlled exclusively by IDisplay. It has no locking
12292	of its own, and any changes made to it are not guaranteed to be
12293	visible until the affected portion of IFramebuffer is updated. The
12294	overlay can be created lazily the first time it is requested. This
12295	attribute can also return @c null to signal that the overlay is not
12296	implemented.
12297	</desc>
12298	</attribute>
12299
12300	<attribute name="winId" type="long long" readonly="yes">
12301	<desc>
12302	Platform-dependent identifier of the window where context of this
12303	frame buffer is drawn, or zero if there's no such window.
12304	</desc>
12305	</attribute>
12306
12307	<method name="lock">
12308	<desc>
12309	Locks the frame buffer.
12310	Gets called by the IDisplay object where this frame buffer is
12311	bound to.
12312	</desc>
12313	</method>
12314
12315	<method name="unlock">
12316	<desc>
12317	Unlocks the frame buffer.
12318	Gets called by the IDisplay object where this frame buffer is
12319	bound to.
12320	</desc>
12321	</method>
12322
12323	<method name="notifyUpdate">
12324	<desc>
12325	Informs about an update.
12326	Gets called by the display object where this buffer is
12327	registered.
12328	</desc>
12329	<param name="x" type="unsigned long" dir="in"/>
12330	<param name="y" type="unsigned long" dir="in"/>
12331	<param name="width" type="unsigned long" dir="in"/>
12332	<param name="height" type="unsigned long" dir="in"/>
12333	</method>
12334
12335	<method name="requestResize">
12336	<desc>
12337	Requests a size and pixel format change.
12338
12339	There are two modes of working with the video buffer of the virtual
12340	machine. The <i>indirect</i> mode implies that the IFramebuffer
12341	implementation allocates a memory buffer for the requested display mode
12342	and provides it to the virtual machine. In <i>direct</i> mode, the
12343	IFramebuffer implementation uses the memory buffer allocated and owned
12344	by the virtual machine. This buffer represents the video memory of the
12345	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
12346	usually faster because the implementation gets a raw pointer to the
12347	guest VRAM buffer which it can directly use for visualizing the contents
12348	of the virtual display, as opposed to the indirect mode where the
12349	contents of guest VRAM are copied to the memory buffer provided by
12350	the implementation every time a display update occurs.
12351
12352	It is important to note that the direct mode is really fast only when
12353	the implementation uses the given guest VRAM buffer directly, for
12354	example, by blitting it to the window representing the virtual machine's
12355	display, which saves at least one copy operation comparing to the
12356	indirect mode. However, using the guest VRAM buffer directly is not
12357	always possible: the format and the color depth of this buffer may be
12358	not supported by the target window, or it may be unknown (opaque) as in
12359	case of text or non-linear multi-plane VGA video modes. In this case,
12360	the indirect mode (that is always available) should be used as a
12361	fallback: when the guest VRAM contents are copied to the
12362	implementation-provided memory buffer, color and format conversion is
12363	done automatically by the underlying code.
12364
12365	The @a pixelFormat parameter defines whether the direct mode is
12366	available or not. If @a pixelFormat is <link
12367	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
12368	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
12369	@a bytesPerLine parameters must be ignored and the implementation must use
12370	the indirect mode (where it provides its own buffer in one of the
12371	supported formats). In all other cases, @a pixelFormat together with
12372	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
12373	buffer pointed to by the @a VRAM parameter and the implementation is
12374	free to choose which mode to use. To indicate that this frame buffer uses
12375	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
12376	attribute must return @c true and <link to="#address"/> must
12377	return exactly the same address that is passed in the @a VRAM parameter
12378	of this method; otherwise it is assumed that the indirect strategy is
12379	chosen.
12380
12381	The @a width and @a height parameters represent the size of the
12382	requested display mode in both modes. In case of indirect mode, the
12383	provided memory buffer should be big enough to store data of the given
12384	display mode. In case of direct mode, it is guaranteed that the given
12385	@a VRAM buffer contains enough space to represent the display mode of the
12386	given size. Note that this frame buffer's <link to="#width"/> and <link
12387	to="#height"/> attributes must return exactly the same values as
12388	passed to this method after the resize is completed (see below).
12389
12390	The @a finished output parameter determines if the implementation has
12391	finished resizing the frame buffer or not. If, for some reason, the
12392	resize cannot be finished immediately during this call, @a finished
12393	must be set to @c false, and the implementation must call
12394	<link to="IDisplay::resizeCompleted"/> after it has returned from
12395	this method as soon as possible. If @a finished is @c false, the
12396	machine will not call any frame buffer methods until
12397	<link to="IDisplay::resizeCompleted"/> is called.
12398
12399	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
12400	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
12401	this frame buffer must return exactly the same values as specified in the
12402	parameters of this method, after the resize is completed. If the
12403	indirect mode is chosen, these attributes must return values describing
12404	the format of the implementation's own memory buffer <link
12405	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
12406	value must always correlate with <link to="#pixelFormat"/>. Note that
12407	the <link to="#pixelFormat"/> attribute must never return <link
12408	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
12409
12410	<note>
12411	This method is called by the IDisplay object under the
12412	<link to="#lock"/> provided by this IFramebuffer
12413	implementation. If this method returns @c false in @a finished, then
12414	this lock is not released until
12415	<link to="IDisplay::resizeCompleted"/> is called.
12416	</note>
12417	</desc>
12418	<param name="screenId" type="unsigned long" dir="in">
12419	<desc>
12420	Logical screen number. Must be used in the corresponding call to
12421	<link to="IDisplay::resizeCompleted"/> if this call is made.
12422	</desc>
12423	</param>
12424	<param name="pixelFormat" type="unsigned long" dir="in">
12425	<desc>
12426	Pixel format of the memory buffer pointed to by @a VRAM.
12427	See also <link to="FramebufferPixelFormat"/>.
12428	</desc>
12429	</param>
12430	<param name="VRAM" type="octet" mod="ptr" dir="in">
12431	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
12432	</param>
12433	<param name="bitsPerPixel" type="unsigned long" dir="in">
12434	<desc>Color depth, bits per pixel.</desc>
12435	</param>
12436	<param name="bytesPerLine" type="unsigned long" dir="in">
12437	<desc>Size of one scan line, in bytes.</desc>
12438	</param>
12439	<param name="width" type="unsigned long" dir="in">
12440	<desc>Width of the guest display, in pixels.</desc>
12441	</param>
12442	<param name="height" type="unsigned long" dir="in">
12443	<desc>Height of the guest display, in pixels.</desc>
12444	</param>
12445	<param name="finished" type="boolean" dir="return">
12446	<desc>
12447	Can the VM start using the new frame buffer immediately
12448	after this method returns or it should wait for
12449	<link to="IDisplay::resizeCompleted"/>.
12450	</desc>
12451	</param>
12452	</method>
12453
12454	<method name="videoModeSupported">
12455	<desc>
12456	Returns whether the frame buffer implementation is willing to
12457	support a given video mode. In case it is not able to render
12458	the video mode (or for some reason not willing), it should
12459	return @c false. Usually this method is called when the guest
12460	asks the VMM device whether a given video mode is supported
12461	so the information returned is directly exposed to the guest.
12462	It is important that this method returns very quickly.
12463	</desc>
12464	<param name="width" type="unsigned long" dir="in"/>
12465	<param name="height" type="unsigned long" dir="in"/>
12466	<param name="bpp" type="unsigned long" dir="in"/>
12467	<param name="supported" type="boolean" dir="return"/>
12468	</method>
12469
12470	<method name="getVisibleRegion">
12471	<desc>
12472	Returns the visible region of this frame buffer.
12473
12474	If the @a rectangles parameter is @c null then the value of the
12475	@a count parameter is ignored and the number of elements necessary to
12476	describe the current visible region is returned in @a countCopied.
12477
12478	If @a rectangles is not @c null but @a count is less
12479	than the required number of elements to store region data, the method
12480	will report a failure. If @a count is equal or greater than the
12481	required number of elements, then the actual number of elements copied
12482	to the provided array will be returned in @a countCopied.
12483
12484	<note>
12485	The address of the provided array must be in the process space of
12486	this IFramebuffer object.
12487	</note>
12488	<note>
12489	Method not yet implemented.
12490	</note>
12491	</desc>
12492	<param name="rectangles" type="octet" mod="ptr" dir="in">
12493	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
12494	</param>
12495	<param name="count" type="unsigned long" dir="in">
12496	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12497	</param>
12498	<param name="countCopied" type="unsigned long" dir="return">
12499	<desc>Number of elements copied to the @a rectangles array.</desc>
12500	</param>
12501	</method>
12502
12503	<method name="setVisibleRegion">
12504	<desc>
12505	Suggests a new visible region to this frame buffer. This region
12506	represents the area of the VM display which is a union of regions of
12507	all top-level windows of the guest operating system running inside the
12508	VM (if the Guest Additions for this system support this
12509	functionality). This information may be used by the frontends to
12510	implement the seamless desktop integration feature.
12511
12512	<note>
12513	The address of the provided array must be in the process space of
12514	this IFramebuffer object.
12515	</note>
12516	<note>
12517	The IFramebuffer implementation must make a copy of the provided
12518	array of rectangles.
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.</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	</method>
12531
12532	<method name="processVHWACommand">
12533	<desc>
12534	Posts a Video HW Acceleration Command to the frame buffer for processing.
12535	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
12536	are posted from quest to the host to be processed by the host hardware.
12537
12538	<note>
12539	The address of the provided command must be in the process space of
12540	this IFramebuffer object.
12541	</note>
12542	</desc>
12543
12544	<param name="command" type="octet" mod="ptr" dir="in">
12545	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
12546	</param>
12547	</method>
12548
12549	</interface>
12550
12551	<interface
12552	name="IFramebufferOverlay" extends="IFramebuffer"
12553	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
12554	wsmap="suppress"
12555	>
12556	<desc>
12557	The IFramebufferOverlay interface represents an alpha blended overlay
12558	for displaying status icons above an IFramebuffer. It is always created
12559	not visible, so that it must be explicitly shown. It only covers a
12560	portion of the IFramebuffer, determined by its width, height and
12561	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
12562	that order) format, and may be written to directly. Do re-read the
12563	width though, after setting it, as it may be adjusted (increased) to
12564	make it more suitable for the front end.
12565	</desc>
12566	<attribute name="x" type="unsigned long" readonly="yes">
12567	<desc>X position of the overlay, relative to the frame buffer.</desc>
12568	</attribute>
12569
12570	<attribute name="y" type="unsigned long" readonly="yes">
12571	<desc>Y position of the overlay, relative to the frame buffer.</desc>
12572	</attribute>
12573
12574	<attribute name="visible" type="boolean" readonly="no">
12575	<desc>
12576	Whether the overlay is currently visible.
12577	</desc>
12578	</attribute>
12579
12580	<attribute name="alpha" type="unsigned long" readonly="no">
12581	<desc>
12582	The global alpha value for the overlay. This may or may not be
12583	supported by a given front end.
12584	</desc>
12585	</attribute>
12586
12587	<method name="move">
12588	<desc>
12589	Changes the overlay's position relative to the IFramebuffer.
12590	</desc>
12591	<param name="x" type="unsigned long" dir="in"/>
12592	<param name="y" type="unsigned long" dir="in"/>
12593	</method>
12594
12595	</interface>
12596
12597	<interface
12598	name="IDisplay" extends="$unknown"
12599	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
12600	wsmap="managed"
12601	>
12602	<desc>
12603	The IDisplay interface represents the virtual machine's display.
12604
12605	The object implementing this interface is contained in each
12606	<link to="IConsole::display"/> attribute and represents the visual
12607	output of the virtual machine.
12608
12609	The virtual display supports pluggable output targets represented by the
12610	IFramebuffer interface. Examples of the output target are a window on
12611	the host computer or an RDP session's display on a remote computer.
12612	</desc>
12613	<method name="getScreenResolution">
12614	<desc>Queries display width, height and color depth for given screen.</desc>
12615	<param name="screenId" type="unsigned long" dir="in"/>
12616	<param name="width" type="unsigned long" dir="out"/>
12617	<param name="height" type="unsigned long" dir="out"/>
12618	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
12619	</method>
12620
12621	<method name="setFramebuffer">
12622	<desc>
12623	Sets the framebuffer for given screen.
12624	</desc>
12625	<param name="screenId" type="unsigned long" dir="in"/>
12626	<param name="framebuffer" type="IFramebuffer" dir="in"/>
12627	</method>
12628
12629	<method name="getFramebuffer">
12630	<desc>
12631	Queries the framebuffer for given screen.
12632	</desc>
12633	<param name="screenId" type="unsigned long" dir="in"/>
12634	<param name="framebuffer" type="IFramebuffer" dir="out"/>
12635	<param name="xOrigin" type="long" dir="out"/>
12636	<param name="yOrigin" type="long" dir="out"/>
12637	</method>
12638
12639	<method name="setVideoModeHint">
12640	<desc>
12641	Asks VirtualBox to request the given video mode from
12642	the guest. This is just a hint and it cannot be guaranteed
12643	that the requested resolution will be used. Guest Additions
12644	are required for the request to be seen by guests. The caller
12645	should issue the request and wait for a resolution change and
12646	after a timeout retry.
12647
12648	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
12649	parameters means that the corresponding values should be taken from the
12650	current video mode (i.e. left unchanged).
12651
12652	If the guest OS supports multi-monitor configuration then the @a display
12653	parameter specifies the number of the guest display to send the hint to:
12654	@c 0 is the primary display, @c 1 is the first secondary and
12655	so on. If the multi-monitor configuration is not supported, @a display
12656	must be @c 0.
12657
12658	<result name="E_INVALIDARG">
12659	The @a display is not associated with any monitor.
12660	</result>
12661
12662	</desc>
12663	<param name="width" type="unsigned long" dir="in"/>
12664	<param name="height" type="unsigned long" dir="in"/>
12665	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
12666	<param name="display" type="unsigned long" dir="in"/>
12667	</method>
12668
12669	<method name="setSeamlessMode">
12670	<desc>
12671	Enables or disables seamless guest display rendering (seamless desktop
12672	integration) mode.
12673	<note>
12674	Calling this method has no effect if <link
12675	to="IGuest::getFacilityStatus"/> with facility @c Seamless
12676	does not return @c Active.
12677	</note>
12678	</desc>
12679	<param name="enabled" type="boolean" dir="in"/>
12680	</method>
12681
12682	<method name="takeScreenShot">
12683	<desc>
12684	Takes a screen shot of the requested size and copies it to the
12685	32-bpp buffer allocated by the caller and pointed to by @a address.
12686	A pixel consists of 4 bytes in order: B, G, R, 0.
12687
12688	<note>This API can be used only locally by a VM process through the
12689	COM/XPCOM C++ API as it requires pointer support. It is not
12690	available for scripting langages, Java or any webservice clients.
12691	Unless you are writing a new VM frontend use
12692	<link to="#takeScreenShotToArray" />.
12693	</note>
12694
12695	<result name="E_NOTIMPL">
12696	Feature not implemented.
12697	</result>
12698	<result name="VBOX_E_IPRT_ERROR">
12699	Could not take a screenshot.
12700	</result>
12701
12702	</desc>
12703	<param name="screenId" type="unsigned long" dir="in"/>
12704	<param name="address" type="octet" mod="ptr" dir="in"/>
12705	<param name="width" type="unsigned long" dir="in"/>
12706	<param name="height" type="unsigned long" dir="in"/>
12707	</method>
12708
12709	<method name="takeScreenShotToArray">
12710	<desc>
12711	Takes a guest screen shot of the requested size and returns it as
12712	an array of bytes in uncompressed 32-bit RGBA format.
12713	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
12714
12715	This API is slow, but could be the only option to get guest screenshot
12716	for scriptable languages not allowed to manipulate with addresses
12717	directly.
12718
12719	<result name="E_NOTIMPL">
12720	Feature not implemented.
12721	</result>
12722	<result name="VBOX_E_IPRT_ERROR">
12723	Could not take a screenshot.
12724	</result>
12725	</desc>
12726	<param name="screenId" type="unsigned long" dir="in">
12727	<desc>
12728	Monitor to take screenshot from.
12729	</desc>
12730	</param>
12731	<param name="width" type="unsigned long" dir="in">
12732	<desc>
12733	Desired image width.
12734	</desc>
12735	</param>
12736	<param name="height" type="unsigned long" dir="in">
12737	<desc>
12738	Desired image height.
12739	</desc>
12740	</param>
12741	<param name="screenData" type="octet" dir="return" safearray="yes">
12742	<desc>
12743	Array with resulting screen data.
12744	</desc>
12745	</param>
12746	</method>
12747
12748	<method name="takeScreenShotPNGToArray">
12749	<desc>
12750	Takes a guest screen shot of the requested size and returns it as
12751	PNG image in array.
12752
12753	<result name="E_NOTIMPL">
12754	Feature not implemented.
12755	</result>
12756	<result name="VBOX_E_IPRT_ERROR">
12757	Could not take a screenshot.
12758	</result>
12759	</desc>
12760	<param name="screenId" type="unsigned long" dir="in">
12761	<desc>
12762	Monitor to take the screenshot from.
12763	</desc>
12764	</param>
12765	<param name="width" type="unsigned long" dir="in">
12766	<desc>
12767	Desired image width.
12768	</desc>
12769	</param>
12770	<param name="height" type="unsigned long" dir="in">
12771	<desc>
12772	Desired image height.
12773	</desc>
12774	</param>
12775	<param name="screenData" type="octet" dir="return" safearray="yes">
12776	<desc>
12777	Array with resulting screen data.
12778	</desc>
12779	</param>
12780	</method>
12781
12782	<method name="drawToScreen">
12783	<desc>
12784	Draws a 32-bpp image of the specified size from the given buffer
12785	to the given point on the VM display.
12786
12787	<result name="E_NOTIMPL">
12788	Feature not implemented.
12789	</result>
12790	<result name="VBOX_E_IPRT_ERROR">
12791	Could not draw to screen.
12792	</result>
12793
12794	</desc>
12795	<param name="screenId" type="unsigned long" dir="in">
12796	<desc>
12797	Monitor to take the screenshot from.
12798	</desc>
12799	</param>
12800	<param name="address" type="octet" mod="ptr" dir="in">
12801	<desc>
12802	Address to store the screenshot to
12803	</desc>
12804	</param>
12805	<param name="x" type="unsigned long" dir="in">
12806	<desc>
12807	Relative to the screen top left corner.
12808	</desc>
12809	</param>
12810	<param name="y" type="unsigned long" dir="in">
12811	<desc>
12812	Relative to the screen top left corner.
12813	</desc>
12814	</param>
12815	<param name="width" type="unsigned long" dir="in">
12816	<desc>
12817	Desired image width.
12818	</desc>
12819	</param>
12820	<param name="height" type="unsigned long" dir="in">
12821	<desc>
12822	Desired image height.
12823	</desc>
12824	</param>
12825	</method>
12826
12827	<method name="invalidateAndUpdate">
12828	<desc>
12829	Does a full invalidation of the VM display and instructs the VM
12830	to update it.
12831
12832	<result name="VBOX_E_IPRT_ERROR">
12833	Could not invalidate and update screen.
12834	</result>
12835
12836	</desc>
12837	</method>
12838
12839	<method name="resizeCompleted">
12840	<desc>
12841	Signals that a framebuffer has completed the resize operation.
12842
12843	<result name="VBOX_E_NOT_SUPPORTED">
12844	Operation only valid for external frame buffers.
12845	</result>
12846
12847	</desc>
12848	<param name="screenId" type="unsigned long" dir="in"/>
12849	</method>
12850
12851	<method name="completeVHWACommand">
12852	<desc>
12853	Signals that the Video HW Acceleration command has completed.
12854	</desc>
12855
12856	<param name="command" type="octet" mod="ptr" dir="in">
12857	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
12858	</param>
12859	</method>
12860
12861	</interface>
12862
12863	<!--
12864	// INetworkAdapter
12865	/////////////////////////////////////////////////////////////////////////
12866	-->
12867
12868	<enum
12869	name="NetworkAttachmentType"
12870	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
12871	>
12872	<desc>
12873	Network attachment type.
12874	</desc>
12875
12876	<const name="Null" value="0">
12877	<desc>Null value, also means "not attached".</desc>
12878	</const>
12879	<const name="NAT" value="1"/>
12880	<const name="Bridged" value="2"/>
12881	<const name="Internal" value="3"/>
12882	<const name="HostOnly" value="4"/>
12883	<const name="Generic" value="5"/>
12884	</enum>
12885
12886	<enum
12887	name="NetworkAdapterType"
12888	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
12889	>
12890	<desc>
12891	Network adapter type.
12892	</desc>
12893
12894	<const name="Null" value="0">
12895	<desc>Null value (never used by the API).</desc>
12896	</const>
12897	<const name="Am79C970A" value="1">
12898	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
12899	</const>
12900	<const name="Am79C973" value="2">
12901	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
12902	</const>
12903	<const name="I82540EM" value="3">
12904	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
12905	</const>
12906	<const name="I82543GC" value="4">
12907	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
12908	</const>
12909	<const name="I82545EM" value="5">
12910	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
12911	</const>
12912	<const name="Virtio" value="6">
12913	<desc>Virtio network device.</desc>
12914	</const>
12915	</enum>
12916
12917	<enum
12918	name="NetworkAdapterPromiscModePolicy"
12919	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
12920	>
12921	<desc>
12922	The promiscuous mode policy of an interface.
12923	</desc>
12924
12925	<const name="Deny" value="1">
12926	<desc>Deny promiscuous mode requests.</desc>
12927	</const>
12928	<const name="AllowNetwork" value="2">
12929	<desc>
12930	Allow promicuous mode, but restrict the scope it to the internal
12931	network so that it only applies to other VMs.
12932	</desc>
12933	</const>
12934	<const name="AllowAll" value="3">
12935	<desc>
12936	Allow promicuous mode, include unrelated traffic going over the wire
12937	and internally on the host.
12938	</desc>
12939	</const>
12940	</enum>
12941
12942	<interface
12943	name="INetworkAdapter" extends="$unknown"
12944	uuid="8b2e705c-0547-4008-b7bc-788757346092"
12945	wsmap="managed"
12946	>
12947	<desc>
12948	Represents a virtual network adapter that is attached to a virtual machine.
12949	Each virtual machine has a fixed number of network adapter slots with one
12950	instance of this attached to each of them. Call
12951	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
12952	is attached to a given slot in a given machine.
12953
12954	Each network adapter can be in one of five attachment modes, which are
12955	represented by the <link to="NetworkAttachmentType" /> enumeration;
12956	see the <link to="#attachmentType" /> attribute.
12957	</desc>
12958
12959	<attribute name="adapterType" type="NetworkAdapterType">
12960	<desc>
12961	Type of the virtual network adapter. Depending on this value,
12962	VirtualBox will provide a different virtual network hardware
12963	to the guest.
12964	</desc>
12965	</attribute>
12966
12967	<attribute name="slot" type="unsigned long" readonly="yes">
12968	<desc>
12969	Slot number this adapter is plugged into. Corresponds to
12970	the value you pass to <link to="IMachine::getNetworkAdapter"/>
12971	to obtain this instance.
12972	</desc>
12973	</attribute>
12974
12975	<attribute name="enabled" type="boolean">
12976	<desc>
12977	Flag whether the network adapter is present in the
12978	guest system. If disabled, the virtual guest hardware will
12979	not contain this network adapter. Can only be changed when
12980	the VM is not running.
12981	</desc>
12982	</attribute>
12983
12984	<attribute name="MACAddress" type="wstring">
12985	<desc>
12986	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
12987	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
12988	</desc>
12989	</attribute>
12990
12991	<attribute name="attachmentType" type="NetworkAttachmentType">
12992	<desc>
12993	Sets/Gets network attachment type of this network adapter.
12994	</desc>
12995	</attribute>
12996
12997	<attribute name="bridgedInterface" type="wstring">
12998	<desc>
12999	Name of the network interface the VM should be bridged to.
13000	</desc>
13001	</attribute>
13002
13003	<attribute name="hostOnlyInterface" type="wstring">
13004	<desc>
13005	Name of the host only network interface the VM is attached to.
13006	</desc>
13007	</attribute>
13008
13009	<attribute name="internalNetwork" type="wstring">
13010	<desc>
13011	Name of the internal network the VM is attached to.
13012	</desc>
13013	</attribute>
13014
13015	<attribute name="NATNetwork" type="wstring">
13016	<desc>
13017	Name of the NAT network the VM is attached to.
13018	</desc>
13019	</attribute>
13020
13021	<attribute name="genericDriver" type="wstring">
13022	<desc>
13023	Name of the driver to use for the "Generic" network attachment type.
13024	</desc>
13025	</attribute>
13026
13027	<attribute name="cableConnected" type="boolean">
13028	<desc>
13029	Flag whether the adapter reports the cable as connected or not.
13030	It can be used to report offline situations to a VM.
13031	</desc>
13032	</attribute>
13033
13034	<attribute name="lineSpeed" type="unsigned long">
13035	<desc>
13036	Line speed reported by custom drivers, in units of 1 kbps.
13037	</desc>
13038	</attribute>
13039
13040	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
13041	<desc>
13042	The promiscuous mode policy of the network adapter when attached to an
13043	internal network, host only network or a bridge.
13044	</desc>
13045	</attribute>
13046
13047	<attribute name="traceEnabled" type="boolean">
13048	<desc>
13049	Flag whether network traffic from/to the network card should be traced.
13050	Can only be toggled when the VM is turned off.
13051	</desc>
13052	</attribute>
13053
13054	<attribute name="traceFile" type="wstring">
13055	<desc>
13056	Filename where a network trace will be stored. If not set, VBox-pid.pcap
13057	will be used.
13058	</desc>
13059	</attribute>
13060
13061	<attribute name="natDriver" type="INATEngine" readonly="yes">
13062	<desc>
13063	Points to the NAT engine which handles the network address translation
13064	for this interface. This is active only when the interface actually uses
13065	NAT.
13066	</desc>
13067	</attribute>
13068
13069	<attribute name="bootPriority" type="unsigned long">
13070	<desc>
13071	Network boot priority of the adapter. Priority 1 is highest. If not set,
13072	the priority is considered to be at the lowest possible setting.
13073	</desc>
13074	</attribute>
13075
13076	<attribute name="bandwidthGroup" type="IBandwidthGroup">
13077	<desc>The bandwidth group this network adapter is assigned to.</desc>
13078	</attribute>
13079
13080	<!-- property methods -->
13081
13082	<method name="getProperty" const="yes">
13083	<desc>
13084	Returns the value of the network attachment property with the given name.
13085
13086	If the requested data @a key does not exist, this function will
13087	succeed and return an empty string in the @a value argument.
13088
13089	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13090	</desc>
13091	<param name="key" type="wstring" dir="in">
13092	<desc>Name of the property to get.</desc>
13093	</param>
13094	<param name="value" type="wstring" dir="return">
13095	<desc>Current property value.</desc>
13096	</param>
13097	</method>
13098
13099	<method name="setProperty">
13100	<desc>
13101	Sets the value of the network attachment property with the given name.
13102
13103	Setting the property value to @c null or an empty string is equivalent
13104	to deleting the existing value.
13105
13106	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13107	</desc>
13108	<param name="key" type="wstring" dir="in">
13109	<desc>Name of the property to set.</desc>
13110	</param>
13111	<param name="value" type="wstring" dir="in">
13112	<desc>Property value to set.</desc>
13113	</param>
13114	</method>
13115
13116	<method name="getProperties" const="yes">
13117	<desc>
13118	Returns values for a group of properties in one call.
13119
13120	The names of the properties to get are specified using the @a names
13121	argument which is a list of comma-separated property names or
13122	an empty string if all properties are to be returned.
13123	<note>Currently the value of this argument is ignored and the method
13124	always returns all existing properties.</note>
13125
13126	The method returns two arrays, the array of property names corresponding
13127	to the @a names argument and the current values of these properties.
13128	Both arrays have the same number of elements with each element at the
13129	given index in the first array corresponds to an element at the same
13130	index in the second array.
13131	</desc>
13132	<param name="names" type="wstring" dir="in">
13133	<desc>
13134	Names of properties to get.
13135	</desc>
13136	</param>
13137	<param name="returnNames" type="wstring" safearray="yes" dir="out">
13138	<desc>Names of returned properties.</desc>
13139	</param>
13140	<param name="returnValues" type="wstring" safearray="yes" dir="return">
13141	<desc>Values of returned properties.</desc>
13142	</param>
13143	</method>
13144
13145	</interface>
13146
13147
13148	<!--
13149	// ISerialPort
13150	/////////////////////////////////////////////////////////////////////////
13151	-->
13152
13153	<enum
13154	name="PortMode"
13155	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
13156	>
13157	<desc>
13158	The PortMode enumeration represents possible communication modes for
13159	the virtual serial port device.
13160	</desc>
13161
13162	<const name="Disconnected" value="0">
13163	<desc>Virtual device is not attached to any real host device.</desc>
13164	</const>
13165	<const name="HostPipe" value="1">
13166	<desc>Virtual device is attached to a host pipe.</desc>
13167	</const>
13168	<const name="HostDevice" value="2">
13169	<desc>Virtual device is attached to a host device.</desc>
13170	</const>
13171	<const name="RawFile" value="3">
13172	<desc>Virtual device is attached to a raw file.</desc>
13173	</const>
13174	</enum>
13175
13176	<interface
13177	name="ISerialPort" extends="$unknown"
13178	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
13179	wsmap="managed"
13180	>
13181
13182	<desc>
13183	The ISerialPort interface represents the virtual serial port device.
13184
13185	The virtual serial port device acts like an ordinary serial port
13186	inside the virtual machine. This device communicates to the real
13187	serial port hardware in one of two modes: host pipe or host device.
13188
13189	In host pipe mode, the #path attribute specifies the path to the pipe on
13190	the host computer that represents a serial port. The #server attribute
13191	determines if this pipe is created by the virtual machine process at
13192	machine startup or it must already exist before starting machine
13193	execution.
13194
13195	In host device mode, the #path attribute specifies the name of the
13196	serial port device on the host computer.
13197
13198	There is also a third communication mode: the disconnected mode. In this
13199	mode, the guest OS running inside the virtual machine will be able to
13200	detect the serial port, but all port write operations will be discarded
13201	and all port read operations will return no data.
13202
13203	<see><link to="IMachine::getSerialPort"/></see>
13204	</desc>
13205
13206	<attribute name="slot" type="unsigned long" readonly="yes">
13207	<desc>
13208	Slot number this serial port is plugged into. Corresponds to
13209	the value you pass to <link to="IMachine::getSerialPort"/>
13210	to obtain this instance.
13211	</desc>
13212	</attribute>
13213
13214	<attribute name="enabled" type="boolean">
13215	<desc>
13216	Flag whether the serial port is enabled. If disabled,
13217	the serial port will not be reported to the guest OS.
13218	</desc>
13219	</attribute>
13220
13221	<attribute name="IOBase" type="unsigned long">
13222	<desc>Base I/O address of the serial port.</desc>
13223	</attribute>
13224
13225	<attribute name="IRQ" type="unsigned long">
13226	<desc>IRQ number of the serial port.</desc>
13227	</attribute>
13228
13229	<attribute name="hostMode" type="PortMode">
13230	<desc>
13231	How is this port connected to the host.
13232	<note>
13233	Changing this attribute may fail if the conditions for
13234	<link to="#path"/> are not met.
13235	</note>
13236	</desc>
13237	</attribute>
13238
13239	<attribute name="server" type="boolean">
13240	<desc>
13241	Flag whether this serial port acts as a server (creates a new pipe on
13242	the host) or as a client (uses the existing pipe). This attribute is
13243	used only when <link to="#hostMode"/> is PortMode_HostPipe.
13244	</desc>
13245	</attribute>
13246
13247	<attribute name="path" type="wstring">
13248	<desc>
13249	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
13250	PortMode_HostPipe, or the host serial device name when
13251	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
13252	cases, setting a @c null or empty string as the attribute's value
13253	is an error. Otherwise, the value of this property is ignored.
13254	</desc>
13255	</attribute>
13256
13257	</interface>
13258
13259	<!--
13260	// IParallelPort
13261	/////////////////////////////////////////////////////////////////////////
13262	-->
13263
13264	<interface
13265	name="IParallelPort" extends="$unknown"
13266	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
13267	wsmap="managed"
13268	>
13269
13270	<desc>
13271	The IParallelPort interface represents the virtual parallel port device.
13272
13273	The virtual parallel port device acts like an ordinary parallel port
13274	inside the virtual machine. This device communicates to the real
13275	parallel port hardware using the name of the parallel device on the host
13276	computer specified in the #path attribute.
13277
13278	Each virtual parallel port device is assigned a base I/O address and an
13279	IRQ number that will be reported to the guest operating system and used
13280	to operate the given parallel port from within the virtual machine.
13281
13282	<see><link to="IMachine::getParallelPort"/></see>
13283	</desc>
13284
13285	<attribute name="slot" type="unsigned long" readonly="yes">
13286	<desc>
13287	Slot number this parallel port is plugged into. Corresponds to
13288	the value you pass to <link to="IMachine::getParallelPort"/>
13289	to obtain this instance.
13290	</desc>
13291	</attribute>
13292
13293	<attribute name="enabled" type="boolean">
13294	<desc>
13295	Flag whether the parallel port is enabled. If disabled,
13296	the parallel port will not be reported to the guest OS.
13297	</desc>
13298	</attribute>
13299
13300	<attribute name="IOBase" type="unsigned long">
13301	<desc>Base I/O address of the parallel port.</desc>
13302	</attribute>
13303
13304	<attribute name="IRQ" type="unsigned long">
13305	<desc>IRQ number of the parallel port.</desc>
13306	</attribute>
13307
13308	<attribute name="path" type="wstring">
13309	<desc>
13310	Host parallel device name. If this parallel port is enabled, setting a
13311	@c null or an empty string as this attribute's value will result in
13312	an error.
13313	</desc>
13314	</attribute>
13315
13316	</interface>
13317
13318
13319	<!--
13320	// IMachineDebugger
13321	/////////////////////////////////////////////////////////////////////////
13322	-->
13323
13324	<interface
13325	name="IMachineDebugger" extends="$unknown"
13326	uuid="a9abbb7c-d678-43b2-bed2-19ec0e32303d"
13327	wsmap="suppress"
13328	>
13329	<method name="dumpGuestCore">
13330	<desc>
13331	Takes a core dump of the guest.
13332
13333	See include/VBox/dbgfcorefmt.h for details on the file format.
13334	</desc>
13335	<param name="filename" type="wstring" dir="in">
13336	<desc>
13337	The name of the output file. The file must not exist.
13338	</desc>
13339	</param>
13340	<param name="compression" type="wstring" dir="in">
13341	<desc>
13342	Reserved for future compression method indicator.
13343	</desc>
13344	</param>
13345	</method>
13346
13347	<method name="dumpHostProcessCore">
13348	<desc>
13349	Takes a core dump of the VM process on the host.
13350
13351	This feature is not implemented in the 4.0.0 release but it may show up
13352	in a dot release.
13353	</desc>
13354	<param name="filename" type="wstring" dir="in">
13355	<desc>
13356	The name of the output file. The file must not exist.
13357	</desc>
13358	</param>
13359	<param name="compression" type="wstring" dir="in">
13360	<desc>
13361	Reserved for future compression method indicator.
13362	</desc>
13363	</param>
13364	</method>
13365
13366	<method name="info">
13367	<desc>
13368	Interfaces with the info dumpers (DBGFInfo).
13369
13370	This feature is not implemented in the 4.0.0 release but it may show up
13371	in a dot release.
13372	</desc>
13373	<param name="name" type="wstring" dir="in">
13374	<desc>
13375	The name of the info item.
13376	</desc>
13377	</param>
13378	<param name="args" type="wstring" dir="in">
13379	<desc>
13380	Arguments to the info dumper.
13381	</desc>
13382	</param>
13383	<param name="info" type="wstring" dir="return">
13384	<desc>
13385	The into string.
13386	</desc>
13387	</param>
13388	</method>
13389
13390	<method name="injectNMI">
13391	<desc>
13392	Inject an NMI into a running VT-x/AMD-V VM.
13393	</desc>
13394	</method>
13395
13396	<method name="modifyLogGroups">
13397	<desc>
13398	Modifies the group settings of the debug or release logger.
13399	</desc>
13400	<param name="settings" type="wstring" dir="in">
13401	<desc>
13402	The group settings string. See iprt/log.h for details. To target the
13403	release logger, prefix the string with "release:".
13404	</desc>
13405	</param>
13406	</method>
13407
13408	<method name="modifyLogFlags">
13409	<desc>
13410	Modifies the debug or release logger flags.
13411	</desc>
13412	<param name="settings" type="wstring" dir="in">
13413	<desc>
13414	The flags settings string. See iprt/log.h for details. To target the
13415	release logger, prefix the string with "release:".
13416	</desc>
13417	</param>
13418	</method>
13419
13420	<method name="modifyLogDestinations">
13421	<desc>
13422	Modifies the debug or release logger destinations.
13423	</desc>
13424	<param name="settings" type="wstring" dir="in">
13425	<desc>
13426	The destination settings string. See iprt/log.h for details. To target the
13427	release logger, prefix the string with "release:".
13428	</desc>
13429	</param>
13430	</method>
13431
13432	<method name="readPhysicalMemory">
13433	<desc>
13434	Reads guest physical memory, no side effects (MMIO++).
13435
13436	This feature is not implemented in the 4.0.0 release but may show up
13437	in a dot release.
13438	</desc>
13439	<param name="address" type="long long" dir="in">
13440	<desc>The guest physical address.</desc>
13441	</param>
13442	<param name="size" type="unsigned long" dir="in">
13443	<desc>The number of bytes to read.</desc>
13444	</param>
13445	<param name="bytes" type="octet" safearray="yes" dir="return">
13446	<desc>The bytes read.</desc>
13447	</param>
13448	</method>
13449
13450	<method name="writePhysicalMemory">
13451	<desc>
13452	Writes guest physical memory, access handles (MMIO++) are ignored.
13453
13454	This feature is not implemented in the 4.0.0 release but may show up
13455	in a dot release.
13456	</desc>
13457	<param name="address" type="long long" dir="in">
13458	<desc>The guest physical address.</desc>
13459	</param>
13460	<param name="size" type="unsigned long" dir="in">
13461	<desc>The number of bytes to read.</desc>
13462	</param>
13463	<param name="bytes" type="octet" safearray="yes" dir="in">
13464	<desc>The bytes to write.</desc>
13465	</param>
13466	</method>
13467
13468	<method name="readVirtualMemory">
13469	<desc>
13470	Reads guest virtual memory, no side effects (MMIO++).
13471
13472	This feature is not implemented in the 4.0.0 release but may show up
13473	in a dot release.
13474	</desc>
13475	<param name="cpuId" type="unsigned long" dir="in">
13476	<desc>The identifier of the Virtual CPU.</desc>
13477	</param>
13478	<param name="address" type="long long" dir="in">
13479	<desc>The guest virtual address.</desc>
13480	</param>
13481	<param name="size" type="unsigned long" dir="in">
13482	<desc>The number of bytes to read.</desc>
13483	</param>
13484	<param name="bytes" type="octet" safearray="yes" dir="return">
13485	<desc>The bytes read.</desc>
13486	</param>
13487	</method>
13488
13489	<method name="writeVirtualMemory">
13490	<desc>
13491	Writes guest virtual memory, access handles (MMIO++) are ignored.
13492
13493	This feature is not implemented in the 4.0.0 release but may show up
13494	in a dot release.
13495	</desc>
13496	<param name="cpuId" type="unsigned long" dir="in">
13497	<desc>The identifier of the Virtual CPU.</desc>
13498	</param>
13499	<param name="address" type="long long" dir="in">
13500	<desc>The guest virtual address.</desc>
13501	</param>
13502	<param name="size" type="unsigned long" dir="in">
13503	<desc>The number of bytes to read.</desc>
13504	</param>
13505	<param name="bytes" type="octet" safearray="yes" dir="in">
13506	<desc>The bytes to write.</desc>
13507	</param>
13508	</method>
13509
13510	<method name="detectOS">
13511	<desc>
13512	Tries to (re-)detect the guest OS kernel.
13513
13514	This feature is not implemented in the 4.0.0 release but may show up
13515	in a dot release.
13516	</desc>
13517	<param name="os" type="wstring" dir="return">
13518	<desc>
13519	The detected OS kernel on success.
13520	</desc>
13521	</param>
13522	</method>
13523
13524	<method name="getRegister">
13525	<desc>
13526	Gets one register.
13527
13528	This feature is not implemented in the 4.0.0 release but may show up
13529	in a dot release.
13530	</desc>
13531	<param name="cpuId" type="unsigned long" dir="in">
13532	<desc>The identifier of the Virtual CPU.</desc>
13533	</param>
13534	<param name="name" type="wstring" dir="in">
13535	<desc>The register name, case is ignored.</desc>
13536	</param>
13537	<param name="value" type="wstring" dir="return">
13538	<desc>
13539	The register value. This is usually a hex value (always 0x prefixed)
13540	but other format may be used for floating point registers (TBD).
13541	</desc>
13542	</param>
13543	</method>
13544
13545	<method name="getRegisters">
13546	<desc>
13547	Gets all the registers for the given CPU.
13548
13549	This feature is not implemented in the 4.0.0 release but may show up
13550	in a dot release.
13551	</desc>
13552	<param name="cpuId" type="unsigned long" dir="in">
13553	<desc>The identifier of the Virtual CPU.</desc>
13554	</param>
13555	<param name="names" type="wstring" dir="out" safearray="yes">
13556	<desc>Array containing the lowercase register names.</desc>
13557	</param>
13558	<param name="values" type="wstring" dir="out" safearray="yes">
13559	<desc>
13560	Array paralell to the names holding the register values as if the
13561	register was returned by <link to="IMachineDebugger::getRegister"/>.
13562	</desc>
13563	</param>
13564	</method>
13565
13566	<method name="setRegister">
13567	<desc>
13568	Gets one register.
13569
13570	This feature is not implemented in the 4.0.0 release but may show up
13571	in a dot release.
13572	</desc>
13573	<param name="cpuId" type="unsigned long" dir="in">
13574	<desc>The identifier of the Virtual CPU.</desc>
13575	</param>
13576	<param name="name" type="wstring" dir="in">
13577	<desc>The register name, case is ignored.</desc>
13578	</param>
13579	<param name="value" type="wstring" dir="in">
13580	<desc>
13581	The new register value. Hexadecimal, decimal and octal formattings
13582	are supported in addition to any special formattings returned by
13583	the getters.
13584	</desc>
13585	</param>
13586	</method>
13587
13588	<method name="setRegisters">
13589	<desc>
13590	Sets zero or more registers atomically.
13591
13592	This feature is not implemented in the 4.0.0 release but may show up
13593	in a dot release.
13594	</desc>
13595	<param name="cpuId" type="unsigned long" dir="in">
13596	<desc>The identifier of the Virtual CPU.</desc>
13597	</param>
13598	<param name="names" type="wstring" dir="in" safearray="yes">
13599	<desc>Array containing the register names, case ignored.</desc>
13600	</param>
13601	<param name="values" type="wstring" dir="in" safearray="yes">
13602	<desc>
13603	Array paralell to the names holding the register values. See
13604	<link to="IMachineDebugger::setRegister"/> for formatting
13605	guidelines.
13606	</desc>
13607	</param>
13608	</method>
13609
13610	<method name="dumpGuestStack">
13611	<desc>
13612	Produce a simple stack dump using the current guest state.
13613
13614	This feature is not implemented in the 4.0.0 release but may show up
13615	in a dot release.
13616	</desc>
13617	<param name="cpuId" type="unsigned long" dir="in">
13618	<desc>The identifier of the Virtual CPU.</desc>
13619	</param>
13620	<param name="stack" type="wstring" dir="return">
13621	<desc>String containing the formatted stack dump.</desc>
13622	</param>
13623	</method>
13624
13625	<method name="resetStats">
13626	<desc>
13627	Reset VM statistics.
13628	</desc>
13629	<param name="pattern" type="wstring" dir="in">
13630	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13631	</param>
13632	</method>
13633
13634	<method name="dumpStats">
13635	<desc>
13636	Dumps VM statistics.
13637	</desc>
13638	<param name="pattern" type="wstring" dir="in">
13639	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13640	</param>
13641	</method>
13642
13643	<method name="getStats">
13644	<desc>
13645	Get the VM statistics in a XMLish format.
13646	</desc>
13647	<param name="pattern" type="wstring" dir="in">
13648	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13649	</param>
13650	<param name="withDescriptions" type="boolean" dir="in">
13651	<desc>Whether to include the descriptions.</desc>
13652	</param>
13653	<param name="stats" type="wstring" dir="out">
13654	<desc>The XML document containing the statistics.</desc>
13655	</param>
13656	</method>
13657
13658	<attribute name="singleStep" type="boolean">
13659	<desc>Switch for enabling single-stepping.</desc>
13660	</attribute>
13661
13662	<attribute name="recompileUser" type="boolean">
13663	<desc>Switch for forcing code recompilation for user mode code.</desc>
13664	</attribute>
13665
13666	<attribute name="recompileSupervisor" type="boolean">
13667	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
13668	</attribute>
13669
13670	<attribute name="PATMEnabled" type="boolean">
13671	<desc>Switch for enabling and disabling the PATM component.</desc>
13672	</attribute>
13673
13674	<attribute name="CSAMEnabled" type="boolean">
13675	<desc>Switch for enabling and disabling the CSAM component.</desc>
13676	</attribute>
13677
13678	<attribute name="logEnabled" type="boolean">
13679	<desc>Switch for enabling and disabling the debug logger.</desc>
13680	</attribute>
13681
13682	<attribute name="logDbgFlags" type="wstring" readonly="yes">
13683	<desc>The debug logger flags.</desc>
13684	</attribute>
13685
13686	<attribute name="logDbgGroups" type="wstring" readonly="yes">
13687	<desc>The debug logger's group settings.</desc>
13688	</attribute>
13689
13690	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
13691	<desc>The debug logger's destination settings.</desc>
13692	</attribute>
13693
13694	<attribute name="logRelFlags" type="wstring" readonly="yes">
13695	<desc>The release logger flags.</desc>
13696	</attribute>
13697
13698	<attribute name="logRelGroups" type="wstring" readonly="yes">
13699	<desc>The release logger's group settings.</desc>
13700	</attribute>
13701
13702	<attribute name="logRelDestinations" type="wstring" readonly="yes">
13703	<desc>The relase logger's destination settings.</desc>
13704	</attribute>
13705
13706	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
13707	<desc>
13708	Flag indicating whether the VM is currently making use of CPU hardware
13709	virtualization extensions.
13710	</desc>
13711	</attribute>
13712
13713	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
13714	<desc>
13715	Flag indicating whether the VM is currently making use of the nested paging
13716	CPU hardware virtualization extension.
13717	</desc>
13718	</attribute>
13719
13720	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
13721	<desc>
13722	Flag indicating whether the VM is currently making use of the VPID
13723	VT-x extension.
13724	</desc>
13725	</attribute>
13726
13727	<attribute name="OSName" type="wstring" readonly="yes">
13728	<desc>
13729	Query the guest OS kernel name as detected by the DBGF.
13730
13731	This feature is not implemented in the 4.0.0 release but may show up
13732	in a dot release.
13733	</desc>
13734	</attribute>
13735
13736	<attribute name="OSVersion" type="wstring" readonly="yes">
13737	<desc>
13738	Query the guest OS kernel version string as detected by the DBGF.
13739
13740	This feature is not implemented in the 4.0.0 release but may show up
13741	in a dot release.
13742	</desc>
13743	</attribute>
13744
13745	<attribute name="PAEEnabled" type="boolean" readonly="yes">
13746	<desc>
13747	Flag indicating whether the VM is currently making use of the Physical
13748	Address Extension CPU feature.
13749	</desc>
13750	</attribute>
13751
13752	<attribute name="virtualTimeRate" type="unsigned long">
13753	<desc>
13754	The rate at which the virtual time runs expressed as a percentage.
13755	The accepted range is 2% to 20000%.
13756	</desc>
13757	</attribute>
13758
13759	<attribute name="VM" type="long long" readonly="yes">
13760	<desc>
13761	Gets the VM handle. This is only for internal use while
13762	we carve the details of this interface.
13763	</desc>
13764	</attribute>
13765
13766	</interface>
13767
13768	<!--
13769	// IUSBController
13770	/////////////////////////////////////////////////////////////////////////
13771	-->
13772
13773	<interface
13774	name="IUSBController" extends="$unknown"
13775	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
13776	wsmap="managed"
13777	>
13778	<attribute name="enabled" type="boolean">
13779	<desc>
13780	Flag whether the USB controller is present in the
13781	guest system. If disabled, the virtual guest hardware will
13782	not contain any USB controller. Can only be changed when
13783	the VM is powered off.
13784	</desc>
13785	</attribute>
13786
13787	<attribute name="enabledEhci" type="boolean">
13788	<desc>
13789	Flag whether the USB EHCI controller is present in the
13790	guest system. If disabled, the virtual guest hardware will
13791	not contain a USB EHCI controller. Can only be changed when
13792	the VM is powered off.
13793	</desc>
13794	</attribute>
13795
13796	<attribute name="proxyAvailable" type="boolean" readonly="yes">
13797	<desc>
13798	Flag whether there is an USB proxy available.
13799	</desc>
13800	</attribute>
13801
13802	<attribute name="USBStandard" type="unsigned short" readonly="yes">
13803	<desc>
13804	USB standard version which the controller implements.
13805	This is a BCD which means that the major version is in the
13806	high byte and minor version is in the low byte.
13807	</desc>
13808	</attribute>
13809
13810	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
13811	<desc>
13812	List of USB device filters associated with the machine.
13813
13814	If the machine is currently running, these filters are activated
13815	every time a new (supported) USB device is attached to the host
13816	computer that was not ignored by global filters
13817	(<link to="IHost::USBDeviceFilters"/>).
13818
13819	These filters are also activated when the machine is powered up.
13820	They are run against a list of all currently available USB
13821	devices (in states
13822	<link to="USBDeviceState_Available"/>,
13823	<link to="USBDeviceState_Busy"/>,
13824	<link to="USBDeviceState_Held"/>) that were not previously
13825	ignored by global filters.
13826
13827	If at least one filter matches the USB device in question, this
13828	device is automatically captured (attached to) the virtual USB
13829	controller of this machine.
13830
13831	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
13832	</desc>
13833	</attribute>
13834
13835	<method name="createDeviceFilter">
13836	<desc>
13837	Creates a new USB device filter. All attributes except
13838	the filter name are set to empty (any match),
13839	<i>active</i> is @c false (the filter is not active).
13840
13841	The created filter can then be added to the list of filters using
13842	<link to="#insertDeviceFilter"/>.
13843
13844	<result name="VBOX_E_INVALID_VM_STATE">
13845	The virtual machine is not mutable.
13846	</result>
13847
13848	<see><link to="#deviceFilters"/></see>
13849	</desc>
13850	<param name="name" type="wstring" dir="in">
13851	<desc>
13852	Filter name. See <link to="IUSBDeviceFilter::name"/>
13853	for more info.
13854	</desc>
13855	</param>
13856	<param name="filter" type="IUSBDeviceFilter" dir="return">
13857	<desc>Created filter object.</desc>
13858	</param>
13859	</method>
13860
13861	<method name="insertDeviceFilter">
13862	<desc>
13863	Inserts the given USB device to the specified position
13864	in the list of filters.
13865
13866	Positions are numbered starting from <tt>0</tt>. If the specified
13867	position is equal to or greater than the number of elements in
13868	the list, the filter is added to the end of the collection.
13869
13870	<note>
13871	Duplicates are not allowed, so an attempt to insert a
13872	filter that is already in the collection, will return an
13873	error.
13874	</note>
13875
13876	<result name="VBOX_E_INVALID_VM_STATE">
13877	Virtual machine is not mutable.
13878	</result>
13879	<result name="E_INVALIDARG">
13880	USB device filter not created within this VirtualBox instance.
13881	</result>
13882	<result name="VBOX_E_INVALID_OBJECT_STATE">
13883	USB device filter already in list.
13884	</result>
13885
13886	<see><link to="#deviceFilters"/></see>
13887	</desc>
13888	<param name="position" type="unsigned long" dir="in">
13889	<desc>Position to insert the filter to.</desc>
13890	</param>
13891	<param name="filter" type="IUSBDeviceFilter" dir="in">
13892	<desc>USB device filter to insert.</desc>
13893	</param>
13894	</method>
13895
13896	<method name="removeDeviceFilter">
13897	<desc>
13898	Removes a USB device filter from the specified position in the
13899	list of filters.
13900
13901	Positions are numbered starting from <tt>0</tt>. Specifying a
13902	position equal to or greater than the number of elements in
13903	the list will produce an error.
13904
13905	<see><link to="#deviceFilters"/></see>
13906
13907	<result name="VBOX_E_INVALID_VM_STATE">
13908	Virtual machine is not mutable.
13909	</result>
13910	<result name="E_INVALIDARG">
13911	USB device filter list empty or invalid @a position.
13912	</result>
13913
13914	</desc>
13915	<param name="position" type="unsigned long" dir="in">
13916	<desc>Position to remove the filter from.</desc>
13917	</param>
13918	<param name="filter" type="IUSBDeviceFilter" dir="return">
13919	<desc>Removed USB device filter.</desc>
13920	</param>
13921	</method>
13922
13923	</interface>
13924
13925
13926	<!--
13927	// IUSBDevice
13928	/////////////////////////////////////////////////////////////////////////
13929	-->
13930
13931	<interface
13932	name="IUSBDevice" extends="$unknown"
13933	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
13934	wsmap="managed"
13935	>
13936	<desc>
13937	The IUSBDevice interface represents a virtual USB device attached to the
13938	virtual machine.
13939
13940	A collection of objects implementing this interface is stored in the
13941	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
13942	attached to a running virtual machine's USB controller.
13943	</desc>
13944
13945	<attribute name="id" type="uuid" mod="string" readonly="yes">
13946	<desc>
13947	Unique USB device ID. This ID is built from #vendorId,
13948	#productId, #revision and #serialNumber.
13949	</desc>
13950	</attribute>
13951
13952	<attribute name="vendorId" type="unsigned short" readonly="yes">
13953	<desc>Vendor ID.</desc>
13954	</attribute>
13955
13956	<attribute name="productId" type="unsigned short" readonly="yes">
13957	<desc>Product ID.</desc>
13958	</attribute>
13959
13960	<attribute name="revision" type="unsigned short" readonly="yes">
13961	<desc>
13962	Product revision number. This is a packed BCD represented as
13963	unsigned short. The high byte is the integer part and the low
13964	byte is the decimal.
13965	</desc>
13966	</attribute>
13967
13968	<attribute name="manufacturer" type="wstring" readonly="yes">
13969	<desc>Manufacturer string.</desc>
13970	</attribute>
13971
13972	<attribute name="product" type="wstring" readonly="yes">
13973	<desc>Product string.</desc>
13974	</attribute>
13975
13976	<attribute name="serialNumber" type="wstring" readonly="yes">
13977	<desc>Serial number string.</desc>
13978	</attribute>
13979
13980	<attribute name="address" type="wstring" readonly="yes">
13981	<desc>Host specific address of the device.</desc>
13982	</attribute>
13983
13984	<attribute name="port" type="unsigned short" readonly="yes">
13985	<desc>
13986	Host USB port number the device is physically
13987	connected to.
13988	</desc>
13989	</attribute>
13990
13991	<attribute name="version" type="unsigned short" readonly="yes">
13992	<desc>
13993	The major USB version of the device - 1 or 2.
13994	</desc>
13995	</attribute>
13996
13997	<attribute name="portVersion" type="unsigned short" readonly="yes">
13998	<desc>
13999	The major USB version of the host USB port the device is
14000	physically connected to - 1 or 2. For devices not connected to
14001	anything this will have the same value as the version attribute.
14002	</desc>
14003	</attribute>
14004
14005	<attribute name="remote" type="boolean" readonly="yes">
14006	<desc>
14007	Whether the device is physically connected to a remote VRDE
14008	client or to a local host machine.
14009	</desc>
14010	</attribute>
14011
14012	</interface>
14013
14014
14015	<!--
14016	// IUSBDeviceFilter
14017	/////////////////////////////////////////////////////////////////////////
14018	-->
14019
14020	<interface
14021	name="IUSBDeviceFilter" extends="$unknown"
14022	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
14023	wsmap="managed"
14024	>
14025	<desc>
14026	The IUSBDeviceFilter interface represents an USB device filter used
14027	to perform actions on a group of USB devices.
14028
14029	This type of filters is used by running virtual machines to
14030	automatically capture selected USB devices once they are physically
14031	attached to the host computer.
14032
14033	A USB device is matched to the given device filter if and only if all
14034	attributes of the device match the corresponding attributes of the
14035	filter (that is, attributes are joined together using the logical AND
14036	operation). On the other hand, all together, filters in the list of
14037	filters carry the semantics of the logical OR operation. So if it is
14038	desirable to create a match like "this vendor id OR this product id",
14039	one needs to create two filters and specify "any match" (see below)
14040	for unused attributes.
14041
14042	All filter attributes used for matching are strings. Each string
14043	is an expression representing a set of values of the corresponding
14044	device attribute, that will match the given filter. Currently, the
14045	following filtering expressions are supported:
14046
14047	<ul>
14048	<li><i>Interval filters</i>. Used to specify valid intervals for
14049	integer device attributes (Vendor ID, Product ID and Revision).
14050	The format of the string is:
14051
14052	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
14053
14054	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
14055	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
14056	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
14057	is omitted before a dash (<tt>-</tt>), the minimum possible integer
14058	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
14059	possible integer is assumed.
14060	</li>
14061	<li><i>Boolean filters</i>. Used to specify acceptable values for
14062	boolean device attributes. The format of the string is:
14063
14064	<tt>true\|false\|yes\|no\|0\|1</tt>
14065
14066	</li>
14067	<li><i>Exact match</i>. Used to specify a single value for the given
14068	device attribute. Any string that doesn't start with <tt>int:</tt>
14069	represents the exact match. String device attributes are compared to
14070	this string including case of symbols. Integer attributes are first
14071	converted to a string (see individual filter attributes) and then
14072	compared ignoring case.
14073
14074	</li>
14075	<li><i>Any match</i>. Any value of the corresponding device attribute
14076	will match the given filter. An empty or @c null string is
14077	used to construct this type of filtering expressions.
14078
14079	</li>
14080	</ul>
14081
14082	<note>
14083	On the Windows host platform, interval filters are not currently
14084	available. Also all string filter attributes
14085	(<link to="#manufacturer"/>, <link to="#product"/>,
14086	<link to="#serialNumber"/>) are ignored, so they behave as
14087	<i>any match</i> no matter what string expression is specified.
14088	</note>
14089
14090	<see><link to="IUSBController::deviceFilters"/>,
14091	<link to="IHostUSBDeviceFilter"/></see>
14092	</desc>
14093
14094	<attribute name="name" type="wstring">
14095	<desc>
14096	Visible name for this filter.
14097	This name is used to visually distinguish one filter from another,
14098	so it can neither be @c null nor an empty string.
14099	</desc>
14100	</attribute>
14101
14102	<attribute name="active" type="boolean">
14103	<desc>Whether this filter active or has been temporarily disabled.</desc>
14104	</attribute>
14105
14106	<attribute name="vendorId" type="wstring">
14107	<desc>
14108	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
14109	The string representation for the <i>exact matching</i>
14110	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
14111	(including leading zeroes).
14112	</desc>
14113	</attribute>
14114
14115	<attribute name="productId" type="wstring">
14116	<desc>
14117	<link to="IUSBDevice::productId">Product ID</link> filter.
14118	The string representation for the <i>exact matching</i>
14119	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
14120	(including leading zeroes).
14121	</desc>
14122	</attribute>
14123
14124	<attribute name="revision" type="wstring">
14125	<desc>
14126	<link to="IUSBDevice::productId">Product revision number</link>
14127	filter. The string representation for the <i>exact matching</i>
14128	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
14129	of the integer part of the revision, and <tt>F</tt> is the
14130	decimal digit of its fractional part (including leading and
14131	trailing zeros).
14132	Note that for interval filters, it's best to use the hexadecimal
14133	form, because the revision is stored as a 16 bit packed BCD value;
14134	so the expression <tt>int:0x0100-0x0199</tt> will match any
14135	revision from <tt>1.0</tt> to <tt>1.99</tt>.
14136	</desc>
14137	</attribute>
14138
14139	<attribute name="manufacturer" type="wstring">
14140	<desc>
14141	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
14142	</desc>
14143	</attribute>
14144
14145	<attribute name="product" type="wstring">
14146	<desc>
14147	<link to="IUSBDevice::product">Product</link> filter.
14148	</desc>
14149	</attribute>
14150
14151	<attribute name="serialNumber" type="wstring">
14152	<desc>
14153	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
14154	</desc>
14155	</attribute>
14156
14157	<attribute name="port" type="wstring">
14158	<desc>
14159	<link to="IUSBDevice::port">Host USB port</link> filter.
14160	</desc>
14161	</attribute>
14162
14163	<attribute name="remote" type="wstring">
14164	<desc>
14165	<link to="IUSBDevice::remote">Remote state</link> filter.
14166	<note>
14167	This filter makes sense only for machine USB filters,
14168	i.e. it is ignored by IHostUSBDeviceFilter objects.
14169	</note>
14170	</desc>
14171	</attribute>
14172
14173	<attribute name="maskedInterfaces" type="unsigned long">
14174	<desc>
14175	This is an advanced option for hiding one or more USB interfaces
14176	from the guest. The value is a bit mask where the bits that are set
14177	means the corresponding USB interface should be hidden, masked off
14178	if you like.
14179	This feature only works on Linux hosts.
14180	</desc>
14181	</attribute>
14182
14183	</interface>
14184
14185
14186	<!--
14187	// IHostUSBDevice
14188	/////////////////////////////////////////////////////////////////////////
14189	-->
14190
14191	<enum
14192	name="USBDeviceState"
14193	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
14194	>
14195	<desc>
14196	USB device state. This enumeration represents all possible states
14197	of the USB device physically attached to the host computer regarding
14198	its state on the host computer and availability to guest computers
14199	(all currently running virtual machines).
14200
14201	Once a supported USB device is attached to the host, global USB
14202	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
14203	either ignore the device, or put it to USBDeviceState_Held state, or do
14204	nothing. Unless the device is ignored by global filters, filters of all
14205	currently running guests (<link to="IUSBController::deviceFilters"/>) are
14206	activated that can put it to USBDeviceState_Captured state.
14207
14208	If the device was ignored by global filters, or didn't match
14209	any filters at all (including guest ones), it is handled by the host
14210	in a normal way. In this case, the device state is determined by
14211	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
14212	or USBDeviceState_Available, depending on the current device usage.
14213
14214	Besides auto-capturing based on filters, the device can be manually
14215	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
14216	state is USBDeviceState_Busy, USBDeviceState_Available or
14217	USBDeviceState_Held.
14218
14219	<note>
14220	Due to differences in USB stack implementations in Linux and Win32,
14221	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
14222	only to the Linux version of the product. This also means that (<link
14223	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
14224	device state is USBDeviceState_Held.
14225	</note>
14226
14227	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
14228	</desc>
14229
14230	<const name="NotSupported" value="0">
14231	<desc>
14232	Not supported by the VirtualBox server, not available to guests.
14233	</desc>
14234	</const>
14235	<const name="Unavailable" value="1">
14236	<desc>
14237	Being used by the host computer exclusively,
14238	not available to guests.
14239	</desc>
14240	</const>
14241	<const name="Busy" value="2">
14242	<desc>
14243	Being used by the host computer, potentially available to guests.
14244	</desc>
14245	</const>
14246	<const name="Available" value="3">
14247	<desc>
14248	Not used by the host computer, available to guests (the host computer
14249	can also start using the device at any time).
14250	</desc>
14251	</const>
14252	<const name="Held" value="4">
14253	<desc>
14254	Held by the VirtualBox server (ignored by the host computer),
14255	available to guests.
14256	</desc>
14257	</const>
14258	<const name="Captured" value="5">
14259	<desc>
14260	Captured by one of the guest computers, not available
14261	to anybody else.
14262	</desc>
14263	</const>
14264	</enum>
14265
14266	<interface
14267	name="IHostUSBDevice" extends="IUSBDevice"
14268	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
14269	wsmap="managed"
14270	>
14271	<desc>
14272	The IHostUSBDevice interface represents a physical USB device attached
14273	to the host computer.
14274
14275	Besides properties inherited from IUSBDevice, this interface adds the
14276	<link to="#state"/> property that holds the current state of the USB
14277	device.
14278
14279	<see><link to="IHost::USBDevices"/>,
14280	<link to="IHost::USBDeviceFilters"/></see>
14281	</desc>
14282
14283	<attribute name="state" type="USBDeviceState" readonly="yes">
14284	<desc>
14285	Current state of the device.
14286	</desc>
14287	</attribute>
14288
14289	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
14290
14291	</interface>
14292
14293
14294	<!--
14295	// IHostUSBDeviceFilter
14296	/////////////////////////////////////////////////////////////////////////
14297	-->
14298
14299	<enum
14300	name="USBDeviceFilterAction"
14301	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
14302	>
14303	<desc>
14304	Actions for host USB device filters.
14305	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
14306	</desc>
14307
14308	<const name="Null" value="0">
14309	<desc>Null value (never used by the API).</desc>
14310	</const>
14311	<const name="Ignore" value="1">
14312	<desc>Ignore the matched USB device.</desc>
14313	</const>
14314	<const name="Hold" value="2">
14315	<desc>Hold the matched USB device.</desc>
14316	</const>
14317	</enum>
14318
14319	<interface
14320	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
14321	uuid="4cc70246-d74a-400f-8222-3900489c0374"
14322	wsmap="managed"
14323	>
14324	<desc>
14325	The IHostUSBDeviceFilter interface represents a global filter for a
14326	physical USB device used by the host computer. Used indirectly in
14327	<link to="IHost::USBDeviceFilters"/>.
14328
14329	Using filters of this type, the host computer determines the initial
14330	state of the USB device after it is physically attached to the
14331	host's USB controller.
14332
14333	<note>
14334	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
14335	filters, because it makes sense only for
14336	<link to="IUSBController::deviceFilters">machine USB filters</link>.
14337	</note>
14338
14339	<see><link to="IHost::USBDeviceFilters"/></see>
14340	</desc>
14341
14342	<attribute name="action" type="USBDeviceFilterAction">
14343	<desc>
14344	Action performed by the host when an attached USB device
14345	matches this filter.
14346	</desc>
14347	</attribute>
14348
14349	</interface>
14350
14351	<!--
14352	// IAudioAdapter
14353	/////////////////////////////////////////////////////////////////////////
14354	-->
14355
14356	<enum
14357	name="AudioDriverType"
14358	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
14359	>
14360	<desc>
14361	Host audio driver type.
14362	</desc>
14363
14364	<const name="Null" value="0">
14365	<desc>Null value, also means "dummy audio driver".</desc>
14366	</const>
14367	<const name="WinMM" value="1">
14368	<desc>Windows multimedia (Windows hosts only).</desc>
14369	</const>
14370	<const name="OSS" value="2">
14371	<desc>Open Sound System (Linux hosts only).</desc>
14372	</const>
14373	<const name="ALSA" value="3">
14374	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
14375	</const>
14376	<const name="DirectSound" value="4">
14377	<desc>DirectSound (Windows hosts only).</desc>
14378	</const>
14379	<const name="CoreAudio" value="5">
14380	<desc>CoreAudio (Mac hosts only).</desc>
14381	</const>
14382	<const name="MMPM" value="6">
14383	<desc>Reserved for historical reasons.</desc>
14384	</const>
14385	<const name="Pulse" value="7">
14386	<desc>PulseAudio (Linux hosts only).</desc>
14387	</const>
14388	<const name="SolAudio" value="8">
14389	<desc>Solaris audio (Solaris hosts only).</desc>
14390	</const>
14391	</enum>
14392
14393	<enum
14394	name="AudioControllerType"
14395	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
14396	>
14397	<desc>
14398	Virtual audio controller type.
14399	</desc>
14400
14401	<const name="AC97" value="0"/>
14402	<const name="SB16" value="1"/>
14403	<const name="HDA" value="2"/>
14404	</enum>
14405
14406	<interface
14407	name="IAudioAdapter" extends="$unknown"
14408	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
14409	wsmap="managed"
14410	>
14411	<desc>
14412	The IAudioAdapter interface represents the virtual audio adapter of
14413	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
14414	</desc>
14415	<attribute name="enabled" type="boolean">
14416	<desc>
14417	Flag whether the audio adapter is present in the
14418	guest system. If disabled, the virtual guest hardware will
14419	not contain any audio adapter. Can only be changed when
14420	the VM is not running.
14421	</desc>
14422	</attribute>
14423	<attribute name="audioController" type="AudioControllerType">
14424	<desc>
14425	The audio hardware we emulate.
14426	</desc>
14427	</attribute>
14428	<attribute name="audioDriver" type="AudioDriverType">
14429	<desc>
14430	Audio driver the adapter is connected to. This setting
14431	can only be changed when the VM is not running.
14432	</desc>
14433	</attribute>
14434	</interface>
14435
14436	<enum
14437	name="AuthType"
14438	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
14439	>
14440	<desc>
14441	VirtualBox authentication type.
14442	</desc>
14443
14444	<const name="Null" value="0">
14445	<desc>Null value, also means "no authentication".</desc>
14446	</const>
14447	<const name="External" value="1"/>
14448	<const name="Guest" value="2"/>
14449	</enum>
14450
14451	<!--
14452	// IVRDEServer
14453	/////////////////////////////////////////////////////////////////////////
14454	-->
14455
14456	<interface
14457	name="IVRDEServer" extends="$unknown"
14458	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
14459	wsmap="managed"
14460	>
14461	<attribute name="enabled" type="boolean">
14462	<desc>VRDE server status.</desc>
14463	</attribute>
14464
14465	<attribute name="authType" type="AuthType">
14466	<desc>VRDE authentication method.</desc>
14467	</attribute>
14468
14469	<attribute name="authTimeout" type="unsigned long">
14470	<desc>Timeout for guest authentication. Milliseconds.</desc>
14471	</attribute>
14472
14473	<attribute name="allowMultiConnection" type="boolean">
14474	<desc>
14475	Flag whether multiple simultaneous connections to the VM are permitted.
14476	Note that this will be replaced by a more powerful mechanism in the future.
14477	</desc>
14478	</attribute>
14479
14480	<attribute name="reuseSingleConnection" type="boolean">
14481	<desc>
14482	Flag whether the existing connection must be dropped and a new connection
14483	must be established by the VRDE server, when a new client connects in single
14484	connection mode.
14485	</desc>
14486	</attribute>
14487
14488	<attribute name="VRDEExtPack" type="wstring">
14489	<desc>
14490	The name of Extension Pack providing VRDE for this VM. Overrides
14491	<link to="ISystemProperties::defaultVRDEExtPack"/>.
14492	</desc>
14493	</attribute>
14494
14495	<attribute name="authLibrary" type="wstring">
14496	<desc>
14497	Library used for authentication of RDP clients by this VM. Overrides
14498	<link to="ISystemProperties::VRDEAuthLibrary"/>.
14499	</desc>
14500	</attribute>
14501
14502	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
14503	<desc>
14504	Array of names of properties, which are supported by this VRDE server.
14505	</desc>
14506	</attribute>
14507
14508	<method name="setVRDEProperty">
14509	<desc>
14510	Sets a VRDE specific property string.
14511
14512	If you pass @c null or empty string as a key @a value, the given @a key
14513	will be deleted.
14514
14515	</desc>
14516	<param name="key" type="wstring" dir="in">
14517	<desc>Name of the key to set.</desc>
14518	</param>
14519	<param name="value" type="wstring" dir="in">
14520	<desc>Value to assign to the key.</desc>
14521	</param>
14522	</method>
14523
14524	<method name="getVRDEProperty" const="yes">
14525	<desc>
14526	Returns a VRDE specific property string.
14527
14528	If the requested data @a key does not exist, this function will
14529	succeed and return an empty string in the @a value argument.
14530
14531	</desc>
14532	<param name="key" type="wstring" dir="in">
14533	<desc>Name of the key to get.</desc>
14534	</param>
14535	<param name="value" type="wstring" dir="return">
14536	<desc>Value of the requested key.</desc>
14537	</param>
14538	</method>
14539
14540	</interface>
14541
14542
14543	<!--
14544	// ISharedFolder
14545	/////////////////////////////////////////////////////////////////////////
14546	-->
14547
14548	<interface
14549	name="ISharedFolder" extends="$unknown"
14550	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
14551	wsmap="struct"
14552	>
14553	<desc>
14554	The ISharedFolder interface represents a folder in the host computer's
14555	file system accessible from the guest OS running inside a virtual
14556	machine using an associated logical name.
14557
14558	There are three types of shared folders:
14559	<ul>
14560	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
14561	folders available to all virtual machines.</li>
14562	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
14563	VM-specific shared folders available to the given virtual machine at
14564	startup.</li>
14565	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
14566	VM-specific shared folders created in the session context (for
14567	example, when the virtual machine is running) and automatically
14568	discarded when the session is closed (the VM is powered off).</li>
14569	</ul>
14570
14571	Logical names of shared folders must be unique within the given scope
14572	(global, permanent or transient). However, they do not need to be unique
14573	across scopes. In this case, the definition of the shared folder in a
14574	more specific scope takes precedence over definitions in all other
14575	scopes. The order of precedence is (more specific to more general):
14576	<ol>
14577	<li>Transient definitions</li>
14578	<li>Permanent definitions</li>
14579	<li>Global definitions</li>
14580	</ol>
14581
14582	For example, if MyMachine has a shared folder named
14583	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
14584	transient shared folder named <tt>C_DRIVE</tt> (that points
14585	to <tt>C:\\\\WINDOWS</tt>) will change the definition
14586	of <tt>C_DRIVE</tt> in the guest OS so
14587	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
14588	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
14589	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
14590	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
14591	to <tt>C:\\</tt> if it still exists.
14592
14593	Note that permanent and transient shared folders of different machines
14594	are in different name spaces, so they don't overlap and don't need to
14595	have unique logical names.
14596
14597	<note>
14598	Global shared folders are not implemented in the current version of the
14599	product.
14600	</note>
14601	</desc>
14602
14603	<attribute name="name" type="wstring" readonly="yes">
14604	<desc>Logical name of the shared folder.</desc>
14605	</attribute>
14606
14607	<attribute name="hostPath" type="wstring" readonly="yes">
14608	<desc>Full path to the shared folder in the host file system.</desc>
14609	</attribute>
14610
14611	<attribute name="accessible" type="boolean" readonly="yes">
14612	<desc>
14613	Whether the folder defined by the host path is currently
14614	accessible or not.
14615	For example, the folder can be inaccessible if it is placed
14616	on the network share that is not available by the time
14617	this property is read.
14618	</desc>
14619	</attribute>
14620
14621	<attribute name="writable" type="boolean" readonly="yes">
14622	<desc>
14623	Whether the folder defined by the host path is writable or
14624	not.
14625	</desc>
14626	</attribute>
14627
14628	<attribute name="autoMount" type="boolean" readonly="yes">
14629	<desc>
14630	Whether the folder gets automatically mounted by the guest or not.
14631	</desc>
14632	</attribute>
14633
14634	<attribute name="lastAccessError" type="wstring" readonly="yes">
14635	<desc>
14636	Text message that represents the result of the last accessibility
14637	check.
14638
14639	Accessibility checks are performed each time the <link to="#accessible"/>
14640	attribute is read. An empty string is returned if the last
14641	accessibility check was successful. A non-empty string indicates a
14642	failure and should normally describe a reason of the failure (for
14643	example, a file read error).
14644	</desc>
14645	</attribute>
14646
14647	</interface>
14648
14649	<!--
14650	// ISession
14651	/////////////////////////////////////////////////////////////////////////
14652	-->
14653
14654	<interface
14655	name="IInternalSessionControl" extends="$unknown"
14656	uuid="c2b4cd5f-d3ce-4dd6-b915-123272163ef5"
14657	internal="yes"
14658	wsmap="suppress"
14659	>
14660	<method name="getPID">
14661	<desc>PID of the process that has created this Session object.
14662	</desc>
14663	<param name="pid" type="unsigned long" dir="return"/>
14664	</method>
14665
14666	<method name="getRemoteConsole">
14667	<desc>
14668	Returns the console object suitable for remote control.
14669
14670	<result name="VBOX_E_INVALID_VM_STATE">
14671	Session state prevents operation.
14672	</result>
14673	<result name="VBOX_E_INVALID_OBJECT_STATE">
14674	Session type prevents operation.
14675	</result>
14676
14677	</desc>
14678	<param name="console" type="IConsole" dir="return"/>
14679	</method>
14680
14681	<method name="assignMachine">
14682	<desc>
14683	Assigns the machine object associated with this direct-type
14684	session or informs the session that it will be a remote one
14685	(if @a machine == @c null).
14686
14687	<result name="VBOX_E_INVALID_VM_STATE">
14688	Session state prevents operation.
14689	</result>
14690	<result name="VBOX_E_INVALID_OBJECT_STATE">
14691	Session type prevents operation.
14692	</result>
14693
14694	</desc>
14695	<param name="machine" type="IMachine" dir="in"/>
14696	</method>
14697
14698	<method name="assignRemoteMachine">
14699	<desc>
14700	Assigns the machine and the (remote) console object associated with
14701	this remote-type session.
14702
14703	<result name="VBOX_E_INVALID_VM_STATE">
14704	Session state prevents operation.
14705	</result>
14706
14707	</desc>
14708	<param name="machine" type="IMachine" dir="in"/>
14709	<param name="console" type="IConsole" dir="in"/>
14710	</method>
14711
14712	<method name="updateMachineState">
14713	<desc>
14714	Updates the machine state in the VM process.
14715	Must be called only in certain cases
14716	(see the method implementation).
14717
14718	<result name="VBOX_E_INVALID_VM_STATE">
14719	Session state prevents operation.
14720	</result>
14721	<result name="VBOX_E_INVALID_OBJECT_STATE">
14722	Session type prevents operation.
14723	</result>
14724
14725	</desc>
14726	<param name="aMachineState" type="MachineState" dir="in"/>
14727	</method>
14728
14729	<method name="uninitialize">
14730	<desc>
14731	Uninitializes (closes) this session. Used by VirtualBox to close
14732	the corresponding remote session when the direct session dies
14733	or gets closed.
14734
14735	<result name="VBOX_E_INVALID_VM_STATE">
14736	Session state prevents operation.
14737	</result>
14738
14739	</desc>
14740	</method>
14741
14742	<method name="onNetworkAdapterChange">
14743	<desc>
14744	Triggered when settings of a network adapter of the
14745	associated virtual machine have changed.
14746
14747	<result name="VBOX_E_INVALID_VM_STATE">
14748	Session state prevents operation.
14749	</result>
14750	<result name="VBOX_E_INVALID_OBJECT_STATE">
14751	Session type prevents operation.
14752	</result>
14753
14754	</desc>
14755	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
14756	<param name="changeAdapter" type="boolean" dir="in"/>
14757	</method>
14758
14759	<method name="onSerialPortChange">
14760	<desc>
14761	Triggered when settings of a serial port of the
14762	associated virtual machine have changed.
14763
14764	<result name="VBOX_E_INVALID_VM_STATE">
14765	Session state prevents operation.
14766	</result>
14767	<result name="VBOX_E_INVALID_OBJECT_STATE">
14768	Session type prevents operation.
14769	</result>
14770
14771	</desc>
14772	<param name="serialPort" type="ISerialPort" dir="in"/>
14773	</method>
14774
14775	<method name="onParallelPortChange">
14776	<desc>
14777	Triggered when settings of a parallel port of the
14778	associated virtual machine have changed.
14779
14780	<result name="VBOX_E_INVALID_VM_STATE">
14781	Session state prevents operation.
14782	</result>
14783	<result name="VBOX_E_INVALID_OBJECT_STATE">
14784	Session type prevents operation.
14785	</result>
14786
14787	</desc>
14788	<param name="parallelPort" type="IParallelPort" dir="in"/>
14789	</method>
14790
14791	<method name="onStorageControllerChange">
14792	<desc>
14793	Triggered when settings of a storage controller of the
14794	associated virtual machine have changed.
14795
14796	<result name="VBOX_E_INVALID_VM_STATE">
14797	Session state prevents operation.
14798	</result>
14799	<result name="VBOX_E_INVALID_OBJECT_STATE">
14800	Session type prevents operation.
14801	</result>
14802
14803	</desc>
14804	</method>
14805
14806	<method name="onMediumChange">
14807	<desc>
14808	Triggered when attached media of the
14809	associated virtual machine have changed.
14810
14811	<result name="VBOX_E_INVALID_VM_STATE">
14812	Session state prevents operation.
14813	</result>
14814	<result name="VBOX_E_INVALID_OBJECT_STATE">
14815	Session type prevents operation.
14816	</result>
14817
14818	</desc>
14819
14820	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14821	<desc>The medium attachment which changed.</desc>
14822	</param>
14823	<param name="force" type="boolean" dir="in">
14824	<desc>If the medium change was forced.</desc>
14825	</param>
14826	</method>
14827
14828	<method name="onStorageDeviceChange">
14829	<desc>
14830	Triggered when attached storage devices of the
14831	associated virtual machine have changed.
14832
14833	<result name="VBOX_E_INVALID_VM_STATE">
14834	Session state prevents operation.
14835	</result>
14836	<result name="VBOX_E_INVALID_OBJECT_STATE">
14837	Session type prevents operation.
14838	</result>
14839
14840	</desc>
14841
14842	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14843	<desc>The medium attachment which changed.</desc>
14844	</param>
14845	<param name="remove" type="boolean" dir="in">
14846	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
14847	</param>
14848	</method>
14849
14850	<method name="onCPUChange">
14851	<desc>
14852	Notification when a CPU changes.
14853	</desc>
14854	<param name="cpu" type="unsigned long" dir="in">
14855	<desc>The CPU which changed</desc>
14856	</param>
14857	<param name="add" type="boolean" dir="in">
14858	<desc>Flag whether the CPU was added or removed</desc>
14859	</param>
14860	</method>
14861
14862	<method name="onCPUExecutionCapChange">
14863	<desc>
14864	Notification when the CPU execution cap changes.
14865	</desc>
14866	<param name="executionCap" type="unsigned long" dir="in">
14867	<desc>The new CPU execution cap value. (1-100)</desc>
14868	</param>
14869	</method>
14870
14871	<method name="onVRDEServerChange">
14872	<desc>
14873	Triggered when settings of the VRDE server object of the
14874	associated virtual machine have changed.
14875
14876	<result name="VBOX_E_INVALID_VM_STATE">
14877	Session state prevents operation.
14878	</result>
14879	<result name="VBOX_E_INVALID_OBJECT_STATE">
14880	Session type prevents operation.
14881	</result>
14882
14883	</desc>
14884	<param name="restart" type="boolean" dir="in">
14885	<desc>Flag whether the server must be restarted</desc>
14886	</param>
14887	</method>
14888
14889	<method name="onUSBControllerChange">
14890	<desc>
14891	Triggered when settings of the USB controller object of the
14892	associated virtual machine have changed.
14893
14894	<result name="VBOX_E_INVALID_VM_STATE">
14895	Session state prevents operation.
14896	</result>
14897	<result name="VBOX_E_INVALID_OBJECT_STATE">
14898	Session type prevents operation.
14899	</result>
14900
14901	</desc>
14902	</method>
14903
14904	<method name="onSharedFolderChange">
14905	<desc>
14906	Triggered when a permanent (global or machine) shared folder has been
14907	created or removed.
14908	<note>
14909	We don't pass shared folder parameters in this notification because
14910	the order in which parallel notifications are delivered is not defined,
14911	therefore it could happen that these parameters were outdated by the
14912	time of processing this notification.
14913	</note>
14914
14915	<result name="VBOX_E_INVALID_VM_STATE">
14916	Session state prevents operation.
14917	</result>
14918	<result name="VBOX_E_INVALID_OBJECT_STATE">
14919	Session type prevents operation.
14920	</result>
14921
14922	</desc>
14923	<param name="global" type="boolean" dir="in"/>
14924	</method>
14925
14926	<method name="onUSBDeviceAttach">
14927	<desc>
14928	Triggered when a request to capture a USB device (as a result
14929	of matched USB filters or direct call to
14930	<link to="IConsole::attachUSBDevice"/>) has completed.
14931	A @c null @a error object means success, otherwise it
14932	describes a failure.
14933
14934	<result name="VBOX_E_INVALID_VM_STATE">
14935	Session state prevents operation.
14936	</result>
14937	<result name="VBOX_E_INVALID_OBJECT_STATE">
14938	Session type prevents operation.
14939	</result>
14940
14941	</desc>
14942	<param name="device" type="IUSBDevice" dir="in"/>
14943	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
14944	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
14945	</method>
14946
14947	<method name="onUSBDeviceDetach">
14948	<desc>
14949	Triggered when a request to release the USB device (as a result
14950	of machine termination or direct call to
14951	<link to="IConsole::detachUSBDevice"/>) has completed.
14952	A @c null @a error object means success, otherwise it
14953	describes a failure.
14954
14955	<result name="VBOX_E_INVALID_VM_STATE">
14956	Session state prevents operation.
14957	</result>
14958	<result name="VBOX_E_INVALID_OBJECT_STATE">
14959	Session type prevents operation.
14960	</result>
14961
14962	</desc>
14963	<param name="id" type="uuid" mod="string" dir="in"/>
14964	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
14965	</method>
14966
14967	<method name="onShowWindow">
14968	<desc>
14969	Called by <link to="IMachine::canShowConsoleWindow"/> and by
14970	<link to="IMachine::showConsoleWindow"/> in order to notify
14971	console listeners
14972	<link to="ICanShowWindowEvent"/>
14973	and <link to="IShowWindowEvent"/>.
14974
14975	<result name="VBOX_E_INVALID_OBJECT_STATE">
14976	Session type prevents operation.
14977	</result>
14978
14979	</desc>
14980	<param name="check" type="boolean" dir="in"/>
14981	<param name="canShow" type="boolean" dir="out"/>
14982	<param name="winId" type="long long" dir="out"/>
14983	</method>
14984
14985	<method name="onBandwidthGroupChange">
14986	<desc>
14987	Notification when one of the bandwidth groups change.
14988	</desc>
14989	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
14990	<desc>The bandwidth group which changed.</desc>
14991	</param>
14992	</method>
14993
14994	<method name="accessGuestProperty">
14995	<desc>
14996	Called by <link to="IMachine::getGuestProperty"/> and by
14997	<link to="IMachine::setGuestProperty"/> in order to read and
14998	modify guest properties.
14999
15000	<result name="VBOX_E_INVALID_VM_STATE">
15001	Machine session is not open.
15002	</result>
15003	<result name="VBOX_E_INVALID_OBJECT_STATE">
15004	Session type is not direct.
15005	</result>
15006
15007	</desc>
15008	<param name="name" type="wstring" dir="in"/>
15009	<param name="value" type="wstring" dir="in"/>
15010	<param name="flags" type="wstring" dir="in"/>
15011	<param name="isSetter" type="boolean" dir="in"/>
15012	<param name="retValue" type="wstring" dir="out"/>
15013	<param name="retTimestamp" type="long long" dir="out"/>
15014	<param name="retFlags" type="wstring" dir="out"/>
15015	</method>
15016
15017	<method name="enumerateGuestProperties" const="yes">
15018	<desc>
15019	Return a list of the guest properties matching a set of patterns along
15020	with their values, time stamps and flags.
15021
15022	<result name="VBOX_E_INVALID_VM_STATE">
15023	Machine session is not open.
15024	</result>
15025	<result name="VBOX_E_INVALID_OBJECT_STATE">
15026	Session type is not direct.
15027	</result>
15028
15029	</desc>
15030	<param name="patterns" type="wstring" dir="in">
15031	<desc>
15032	The patterns to match the properties against as a comma-separated
15033	string. If this is empty, all properties currently set will be
15034	returned.
15035	</desc>
15036	</param>
15037	<param name="key" type="wstring" dir="out" safearray="yes">
15038	<desc>
15039	The key names of the properties returned.
15040	</desc>
15041	</param>
15042	<param name="value" type="wstring" dir="out" safearray="yes">
15043	<desc>
15044	The values of the properties returned. The array entries match the
15045	corresponding entries in the @a key array.
15046	</desc>
15047	</param>
15048	<param name="timestamp" type="long long" dir="out" safearray="yes">
15049	<desc>
15050	The time stamps of the properties returned. The array entries match
15051	the corresponding entries in the @a key array.
15052	</desc>
15053	</param>
15054	<param name="flags" type="wstring" dir="out" safearray="yes">
15055	<desc>
15056	The flags of the properties returned. The array entries match the
15057	corresponding entries in the @a key array.
15058	</desc>
15059	</param>
15060	</method>
15061
15062	<method name="onlineMergeMedium">
15063	<desc>
15064	Triggers online merging of a hard disk. Used internally when deleting
15065	a snapshot while a VM referring to the same hard disk chain is running.
15066
15067	<result name="VBOX_E_INVALID_VM_STATE">
15068	Machine session is not open.
15069	</result>
15070	<result name="VBOX_E_INVALID_OBJECT_STATE">
15071	Session type is not direct.
15072	</result>
15073
15074	</desc>
15075	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
15076	<desc>The medium attachment to identify the medium chain.</desc>
15077	</param>
15078	<param name="sourceIdx" type="unsigned long" dir="in">
15079	<desc>The index of the source image in the chain.
15080	Redundant, but drastically reduces IPC.</desc>
15081	</param>
15082	<param name="targetIdx" type="unsigned long" dir="in">
15083	<desc>The index of the target image in the chain.
15084	Redundant, but drastically reduces IPC.</desc>
15085	</param>
15086	<param name="source" type="IMedium" dir="in">
15087	<desc>Merge source medium.</desc>
15088	</param>
15089	<param name="target" type="IMedium" dir="in">
15090	<desc>Merge target medium.</desc>
15091	</param>
15092	<param name="mergeForward" type="boolean" dir="in">
15093	<desc>Merge direction.</desc>
15094	</param>
15095	<param name="parentForTarget" type="IMedium" dir="in">
15096	<desc>For forward merges: new parent for target medium.</desc>
15097	</param>
15098	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
15099	<desc>For backward merges: list of media which need their parent UUID
15100	updated.</desc>
15101	</param>
15102	<param name="progress" type="IProgress" dir="in">
15103	<desc>
15104	Progress object for this operation.
15105	</desc>
15106	</param>
15107	</method>
15108
15109	<method name="enableVMMStatistics">
15110	<desc>
15111	Enables or disables collection of VMM RAM statistics.
15112
15113	<result name="VBOX_E_INVALID_VM_STATE">
15114	Machine session is not open.
15115	</result>
15116	<result name="VBOX_E_INVALID_OBJECT_STATE">
15117	Session type is not direct.
15118	</result>
15119
15120	</desc>
15121	<param name="enable" type="boolean" dir="in">
15122	<desc>True enables statistics collection.</desc>
15123	</param>
15124	</method>
15125
15126	</interface>
15127
15128	<interface
15129	name="ISession" extends="$unknown"
15130	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
15131	wsmap="managed"
15132	>
15133	<desc>
15134	The ISession interface represents a client process and allows for locking
15135	virtual machines (represented by IMachine objects) to prevent conflicting
15136	changes to the machine.
15137
15138	Any caller wishing to manipulate a virtual machine needs to create a session
15139	object first, which lives in its own process space. Such session objects are
15140	then associated with <link to="IMachine" /> objects living in the VirtualBox
15141	server process to coordinate such changes.
15142
15143	There are two typical scenarios in which sessions are used:
15144
15145	<ul>
15146	<li>To alter machine settings or control a running virtual machine, one
15147	needs to lock a machine for a given session (client process) by calling
15148	<link to="IMachine::lockMachine"/>.
15149
15150	Whereas multiple sessions may control a running virtual machine, only
15151	one process can obtain a write lock on the machine to prevent conflicting
15152	changes. A write lock is also needed if a process wants to actually run a
15153	virtual machine in its own context, such as the VirtualBox GUI or
15154	VBoxHeadless front-ends. They must also lock a machine for their own
15155	sessions before they are allowed to power up the virtual machine.
15156
15157	As a result, no machine settings can be altered while another process is
15158	already using it, either because that process is modifying machine settings
15159	or because the machine is running.
15160	</li>
15161	<li>
15162	To start a VM using one of the existing VirtualBox front-ends (e.g. the
15163	VirtualBox GUI or VBoxHeadless), one would use
15164	<link to="IMachine::launchVMProcess"/>, which also takes a session object
15165	as its first parameter. This session then identifies the caller and lets the
15166	caller control the started machine (for example, pause machine execution or
15167	power it down) as well as be notified about machine execution state changes.
15168	</li>
15169	</ul>
15170
15171	How sessions objects are created in a client process depends on whether you use
15172	the Main API via COM or via the webservice:
15173
15174	<ul>
15175	<li>When using the COM API directly, an object of the Session class from the
15176	VirtualBox type library needs to be created. In regular COM C++ client code,
15177	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
15178	This object will then act as a local session object in further calls to open
15179	a session.
15180	</li>
15181
15182	<li>In the webservice, the session manager (IWebsessionManager) instead creates
15183	a session object automatically whenever <link to="IWebsessionManager::logon" />
15184	is called. A managed object reference to that session object can be retrieved by
15185	calling <link to="IWebsessionManager::getSessionObject" />.
15186	</li>
15187	</ul>
15188	</desc>
15189
15190	<attribute name="state" type="SessionState" readonly="yes">
15191	<desc>Current state of this session.</desc>
15192	</attribute>
15193
15194	<attribute name="type" type="SessionType" readonly="yes">
15195	<desc>
15196	Type of this session. The value of this attribute is valid only
15197	if the session currently has a machine locked (i.e. its
15198	<link to="#state" /> is Locked), otherwise an error will be returned.
15199	</desc>
15200	</attribute>
15201
15202	<attribute name="machine" type="IMachine" readonly="yes">
15203	<desc>Machine object associated with this session.</desc>
15204	</attribute>
15205
15206	<attribute name="console" type="IConsole" readonly="yes">
15207	<desc>Console object associated with this session.</desc>
15208	</attribute>
15209
15210	<method name="unlockMachine">
15211	<desc>
15212	Unlocks a machine that was previously locked for the current session.
15213
15214	Calling this method is required every time a machine has been locked
15215	for a particular session using the <link to="IMachine::launchVMProcess" />
15216	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
15217	the machine will be set to <link to="MachineState_Aborted" /> on the
15218	server, and changes made to the machine settings will be lost.
15219
15220	Generally, it is recommended to unlock all machines explicitly
15221	before terminating the application (regardless of the reason for
15222	the termination).
15223
15224	<note>
15225	Do not expect the session state (<link to="ISession::state" />
15226	to return to "Unlocked" immediately after you invoke this method,
15227	particularly if you have started a new VM process. The session
15228	state will automatically return to "Unlocked" once the VM is no
15229	longer executing, which can of course take a very long time.
15230	</note>
15231
15232	<result name="E_UNEXPECTED">
15233	Session is not locked.
15234	</result>
15235
15236	</desc>
15237	</method>
15238
15239	</interface>
15240
15241	<!--
15242	// IStorageController
15243	/////////////////////////////////////////////////////////////////////////
15244	-->
15245
15246	<enum
15247	name="StorageBus"
15248	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
15249	>
15250	<desc>
15251	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
15252	see <link to="IStorageController::bus" />.
15253	</desc>
15254	<const name="Null" value="0">
15255	<desc>@c null value. Never used by the API.</desc>
15256	</const>
15257	<const name="IDE" value="1"/>
15258	<const name="SATA" value="2"/>
15259	<const name="SCSI" value="3"/>
15260	<const name="Floppy" value="4"/>
15261	<const name="SAS" value="5"/>
15262	</enum>
15263
15264	<enum
15265	name="StorageControllerType"
15266	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
15267	>
15268	<desc>
15269	The exact variant of storage controller hardware presented
15270	to the guest; see <link to="IStorageController::controllerType" />.
15271	</desc>
15272
15273	<const name="Null" value="0">
15274	<desc>@c null value. Never used by the API.</desc>
15275	</const>
15276	<const name="LsiLogic" value="1">
15277	<desc>A SCSI controller of the LsiLogic variant.</desc>
15278	</const>
15279	<const name="BusLogic" value="2">
15280	<desc>A SCSI controller of the BusLogic variant.</desc>
15281	</const>
15282	<const name="IntelAhci" value="3">
15283	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
15284	</const>
15285	<const name="PIIX3" value="4">
15286	<desc>An IDE controller of the PIIX3 variant.</desc>
15287	</const>
15288	<const name="PIIX4" value="5">
15289	<desc>An IDE controller of the PIIX4 variant.</desc>
15290	</const>
15291	<const name="ICH6" value="6">
15292	<desc>An IDE controller of the ICH6 variant.</desc>
15293	</const>
15294	<const name="I82078" value="7">
15295	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
15296	</const>
15297	<const name="LsiLogicSas" value="8">
15298	<desc>A variant of the LsiLogic controller using SAS.</desc>
15299	</const>
15300	</enum>
15301
15302	<enum
15303	name="ChipsetType"
15304	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
15305	>
15306	<desc>
15307	Type of emulated chipset (mostly southbridge).
15308	</desc>
15309
15310	<const name="Null" value="0">
15311	<desc>@c null value. Never used by the API.</desc>
15312	</const>
15313	<const name="PIIX3" value="1">
15314	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
15315	</const>
15316	<const name="ICH9" value="2">
15317	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
15318	</const>
15319	</enum>
15320
15321	<interface
15322	name="IStorageController" extends="$unknown"
15323	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
15324	wsmap="managed"
15325	>
15326	<desc>
15327	Represents a storage controller that is attached to a virtual machine
15328	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
15329	attached to storage controllers in a real computer, virtual drives
15330	(represented by <link to="IMediumAttachment" />) are attached to virtual
15331	storage controllers, represented by this interface.
15332
15333	As opposed to physical hardware, VirtualBox has a very generic concept
15334	of a storage controller, and for purposes of the Main API, all virtual
15335	storage is attached to virtual machines via instances of this interface.
15336	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
15337	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
15338	is used, certain sub-types may be available and can be selected in
15339	<link to="#controllerType" />.
15340
15341	Depending on these settings, the guest operating system might see
15342	significantly different virtual hardware.
15343	</desc>
15344
15345	<attribute name="name" type="wstring" readonly="yes">
15346	<desc>
15347	Name of the storage controller, as originally specified with
15348	<link to="IMachine::addStorageController" />. This then uniquely
15349	identifies this controller with other method calls such as
15350	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
15351	</desc>
15352	</attribute>
15353
15354	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
15355	<desc>
15356	Maximum number of devices which can be attached to one port.
15357	</desc>
15358	</attribute>
15359
15360	<attribute name="minPortCount" type="unsigned long" readonly="yes">
15361	<desc>
15362	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
15363	</desc>
15364	</attribute>
15365
15366	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
15367	<desc>
15368	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
15369	</desc>
15370	</attribute>
15371
15372	<attribute name="instance" type="unsigned long">
15373	<desc>
15374	The instance number of the device in the running VM.
15375	</desc>
15376	</attribute>
15377
15378	<attribute name="portCount" type="unsigned long">
15379	<desc>
15380	The number of currently usable ports on the controller.
15381	The minimum and maximum number of ports for one controller are
15382	stored in <link to="IStorageController::minPortCount"/>
15383	and <link to="IStorageController::maxPortCount"/>.
15384	</desc>
15385	</attribute>
15386
15387	<attribute name="bus" type="StorageBus" readonly="yes">
15388	<desc>
15389	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
15390	</desc>
15391	</attribute>
15392
15393	<attribute name="controllerType" type="StorageControllerType">
15394	<desc>
15395	The exact variant of storage controller hardware presented
15396	to the guest.
15397	Depending on this value, VirtualBox will provide a different
15398	virtual storage controller hardware to the guest.
15399	For SATA, SAS and floppy controllers, only one variant is
15400	available, but for IDE and SCSI, there are several.
15401
15402	For SCSI controllers, the default type is LsiLogic.
15403	</desc>
15404	</attribute>
15405
15406	<attribute name="useHostIOCache" type="boolean">
15407	<desc>
15408	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
15409	caches and use synchronous file APIs on the host. This was the only option in the API before
15410	VirtualBox 3.2 and is still the default for IDE controllers.
15411
15412	If false, the host I/O cache will be disabled for image files attached to this storage controller.
15413	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
15414	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
15415	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
15416	virtual machines are running at the same time to prevent I/O cache related hangs.
15417	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
15418	</desc>
15419	</attribute>
15420
15421	<attribute name="bootable" type="boolean" readonly="yes">
15422	<desc>
15423	Returns whether it is possible to boot from disks attached to this controller.
15424	</desc>
15425	</attribute>
15426
15427	<method name="getIDEEmulationPort">
15428	<desc>
15429	Gets the corresponding port number which is emulated as an IDE device.
15430	Works only with SATA controllers.
15431
15432	<result name="E_INVALIDARG">
15433	The @a devicePosition is not in the range 0 to 3.
15434	</result>
15435	<result name="E_NOTIMPL">
15436	The storage controller type is not SATAIntelAhci.
15437	</result>
15438
15439	</desc>
15440	<param name="devicePosition" type="long" dir="in"/>
15441	<param name="portNumber" type="long" dir="return"/>
15442	</method>
15443
15444	<method name="setIDEEmulationPort">
15445	<desc>
15446	Sets the port number which is emulated as an IDE device.
15447	Works only with SATA controllers.
15448
15449	<result name="E_INVALIDARG">
15450	The @a devicePosition is not in the range 0 to 3 or the
15451	@a portNumber is not in the range 0 to 29.
15452	</result>
15453	<result name="E_NOTIMPL">
15454	The storage controller type is not SATAIntelAhci.
15455	</result>
15456
15457	</desc>
15458	<param name="devicePosition" type="long" dir="in"/>
15459	<param name="portNumber" type="long" dir="in"/>
15460	</method>
15461
15462	</interface>
15463
15464	<if target="wsdl">
15465
15466	<!--
15467	// IManagedObjectRef
15468	/////////////////////////////////////////////////////////////////////////
15469	-->
15470
15471	<interface
15472	name="IManagedObjectRef" extends="$unknown"
15473	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
15474	internal="yes"
15475	wsmap="managed"
15476	wscpp="hardcoded"
15477	>
15478	<desc>
15479	Managed object reference.
15480
15481	Only within the webservice, a managed object reference (which is really
15482	an opaque number) allows a webservice client to address an object
15483	that lives in the address space of the webservice server.
15484
15485	Behind each managed object reference, there is a COM object that lives
15486	in the webservice server's address space. The COM object is not freed
15487	until the managed object reference is released, either by an explicit
15488	call to <link to="IManagedObjectRef::release" /> or by logging off from
15489	the webservice (<link to="IWebsessionManager::logoff" />), which releases
15490	all objects created during the webservice session.
15491
15492	Whenever a method call of the VirtualBox API returns a COM object, the
15493	webservice representation of that method will instead return a
15494	managed object reference, which can then be used to invoke methods
15495	on that object.
15496	</desc>
15497
15498	<method name="getInterfaceName">
15499	<desc>
15500	Returns the name of the interface that this managed object represents,
15501	for example, "IMachine", as a string.
15502	</desc>
15503	<param name="return" type="wstring" dir="return"/>
15504	</method>
15505
15506	<method name="release">
15507	<desc>
15508	Releases this managed object reference and frees the resources that
15509	were allocated for it in the webservice server process. After calling
15510	this method, the identifier of the reference can no longer be used.
15511	</desc>
15512	</method>
15513
15514	</interface>
15515
15516	<!--
15517	// IWebsessionManager
15518	/////////////////////////////////////////////////////////////////////////
15519	-->
15520
15521	<interface
15522	name="IWebsessionManager" extends="$unknown"
15523	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
15524	internal="yes"
15525	wsmap="global"
15526	wscpp="hardcoded"
15527	>
15528	<desc>
15529	Websession manager. This provides essential services
15530	to webservice clients.
15531	</desc>
15532	<method name="logon">
15533	<desc>
15534	Logs a new client onto the webservice and returns a managed object reference to
15535	the IVirtualBox instance, which the client can then use as a basis to further
15536	queries, since all calls to the VirtualBox API are based on the IVirtualBox
15537	interface, in one way or the other.
15538	</desc>
15539	<param name="username" type="wstring" dir="in"/>
15540	<param name="password" type="wstring" dir="in"/>
15541	<param name="return" type="IVirtualBox" dir="return"/>
15542	</method>
15543
15544	<method name="getSessionObject">
15545	<desc>
15546	Returns a managed object reference to the internal ISession object that was created
15547	for this web service session when the client logged on.
15548
15549	<see><link to="ISession"/></see>
15550	</desc>
15551	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15552	<param name="return" type="ISession" dir="return"/>
15553	</method>
15554
15555	<method name="logoff">
15556	<desc>
15557	Logs off the client who has previously logged on with <link to="IWebsessionManager::logon" />
15558	and destroys all resources associated with the session (most importantly, all
15559	managed objects created in the server while the session was active).
15560	</desc>
15561	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15562	</method>
15563
15564	</interface>
15565
15566	</if>
15567
15568	<!--
15569	// IPerformanceCollector & friends
15570	/////////////////////////////////////////////////////////////////////////
15571	-->
15572
15573	<interface
15574	name="IPerformanceMetric" extends="$unknown"
15575	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
15576	>
15577	<desc>
15578	The IPerformanceMetric interface represents parameters of the given
15579	performance metric.
15580	</desc>
15581
15582	<attribute name="metricName" type="wstring" readonly="yes">
15583	<desc>
15584	Name of the metric.
15585	</desc>
15586	</attribute>
15587
15588	<attribute name="object" type="$unknown" readonly="yes">
15589	<desc>
15590	Object this metric belongs to.
15591	</desc>
15592	</attribute>
15593
15594	<attribute name="description" type="wstring" readonly="yes">
15595	<desc>
15596	Textual description of the metric.
15597	</desc>
15598	</attribute>
15599
15600	<attribute name="period" type="unsigned long" readonly="yes">
15601	<desc>
15602	Time interval between samples, measured in seconds.
15603	</desc>
15604	</attribute>
15605
15606	<attribute name="count" type="unsigned long" readonly="yes">
15607	<desc>
15608	Number of recent samples retained by the performance collector for this
15609	metric.
15610
15611	When the collected sample count exceeds this number, older samples
15612	are discarded.
15613	</desc>
15614	</attribute>
15615
15616	<attribute name="unit" type="wstring" readonly="yes">
15617	<desc>
15618	Unit of measurement.
15619	</desc>
15620	</attribute>
15621
15622	<attribute name="minimumValue" type="long" readonly="yes">
15623	<desc>
15624	Minimum possible value of this metric.
15625	</desc>
15626	</attribute>
15627
15628	<attribute name="maximumValue" type="long" readonly="yes">
15629	<desc>
15630	Maximum possible value of this metric.
15631	</desc>
15632	</attribute>
15633	</interface>
15634
15635	<interface
15636	name="IPerformanceCollector" extends="$unknown"
15637	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
15638	wsmap="managed"
15639	>
15640	<desc>
15641	The IPerformanceCollector interface represents a service that collects
15642	and stores performance metrics data.
15643
15644	Performance metrics are associated with objects of interfaces like IHost
15645	and IMachine. Each object has a distinct set of performance metrics. The
15646	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
15647
15648	Metric data is collected at the specified intervals and is retained
15649	internally. The interval and the number of retained samples can be set
15650	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
15651	and collection settings are not persistent, they are discarded as soon as
15652	VBoxSVC process terminates. Moreover, metric settings and data associated
15653	with a particular VM only exist while VM is running. They disappear as
15654	soon as VM shuts down. It is not possible to set up metrics for machines
15655	that are powered off. One needs to start VM first, then set up metric
15656	collection parameters.
15657
15658	Metrics are organized hierarchically, with each level separated by a
15659	slash (/) character. Generally, the scheme for metric names is like this:
15660
15661	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
15662
15663	"Category/Metric" together form the base metric name. A base metric is
15664	the smallest unit for which a sampling interval and the number of
15665	retained samples can be set. Only base metrics can be enabled and
15666	disabled. All sub-metrics are collected when their base metric is
15667	collected. Collected values for any set of sub-metrics can be queried
15668	with <link to="IPerformanceCollector::queryMetricsData" />.
15669
15670	For example "CPU/Load/User:avg" metric name stands for the "CPU"
15671	category, "Load" metric, "User" submetric, "average" aggregate. An
15672	aggregate function is computed over all retained data. Valid aggregate
15673	functions are:
15674
15675	<ul>
15676	<li>avg -- average</li>
15677	<li>min -- minimum</li>
15678	<li>max -- maximum</li>
15679	</ul>
15680
15681	When setting up metric parameters, querying metric data, enabling or
15682	disabling metrics wildcards can be used in metric names to specify a
15683	subset of metrics. For example, to select all CPU-related metrics
15684	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
15685	so on. To query metric values without aggregates <tt>*:</tt> can be used.
15686
15687	The valid names for base metrics are:
15688
15689	<ul>
15690	<li>CPU/Load</li>
15691	<li>CPU/MHz</li>
15692	<li>RAM/Usage</li>
15693	<li>RAM/VMM</li>
15694	</ul>
15695
15696	The general sequence for collecting and retrieving the metrics is:
15697	<ul>
15698	<li>
15699	Obtain an instance of IPerformanceCollector with
15700	<link to="IVirtualBox::performanceCollector" />
15701	</li>
15702	<li>
15703	Allocate and populate an array with references to objects the metrics
15704	will be collected for. Use references to IHost and IMachine objects.
15705	</li>
15706	<li>
15707	Allocate and populate an array with base metric names the data will
15708	be collected for.
15709	</li>
15710	<li>
15711	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
15712	the metric data will be collected and stored.
15713	</li>
15714	<li>
15715	Wait for the data to get collected.
15716	</li>
15717	<li>
15718	Allocate and populate an array with references to objects the metric
15719	values will be queried for. You can re-use the object array used for
15720	setting base metrics.
15721	</li>
15722	<li>
15723	Allocate and populate an array with metric names the data will be
15724	collected for. Note that metric names differ from base metric names.
15725	</li>
15726	<li>
15727	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
15728	that have been collected so far are returned. Note that the values
15729	are still retained internally and data collection continues.
15730	</li>
15731	</ul>
15732
15733	For an example of usage refer to the following files in VirtualBox SDK:
15734	<ul>
15735	<li>
15736	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
15737	</li>
15738	<li>
15739	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
15740	</li>
15741	</ul>
15742	</desc>
15743
15744	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
15745	<desc>
15746	Array of unique names of metrics.
15747
15748	This array represents all metrics supported by the performance
15749	collector. Individual objects do not necessarily support all of them.
15750	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
15751	list of supported metrics for a particular object.
15752	</desc>
15753	</attribute>
15754
15755	<method name="getMetrics">
15756	<desc>
15757	Returns parameters of specified metrics for a set of objects.
15758	<note>
15759	@c Null metrics array means all metrics. @c Null object array means
15760	all existing objects.
15761	</note>
15762	</desc>
15763	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15764	<desc>
15765	Metric name filter. Currently, only a comma-separated list of metrics
15766	is supported.
15767	</desc>
15768	</param>
15769	<param name="objects" type="$unknown" dir="in" safearray="yes">
15770	<desc>
15771	Set of objects to return metric parameters for.
15772	</desc>
15773	</param>
15774	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
15775	<desc>
15776	Array of returned metric parameters.
15777	</desc>
15778	</param>
15779	</method>
15780
15781	<method name="setupMetrics">
15782	<desc>
15783	Sets parameters of specified base metrics for a set of objects. Returns
15784	an array of <link to="IPerformanceMetric" /> describing the metrics
15785	have been affected.
15786	<note>
15787	@c Null or empty metric name array means all metrics. @c Null or
15788	empty object array means all existing objects. If metric name array
15789	contains a single element and object array contains many, the single
15790	metric name array element is applied to each object array element to
15791	form metric/object pairs.
15792	</note>
15793	</desc>
15794	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15795	<desc>
15796	Metric name filter. Comma-separated list of metrics with wildcard
15797	support.
15798	</desc>
15799	</param>
15800	<param name="objects" type="$unknown" dir="in" safearray="yes">
15801	<desc>
15802	Set of objects to setup metric parameters for.
15803	</desc>
15804	</param>
15805	<param name="period" type="unsigned long" dir="in">
15806	<desc>
15807	Time interval in seconds between two consecutive samples of
15808	performance data.
15809	</desc>
15810	</param>
15811	<param name="count" type="unsigned long" dir="in">
15812	<desc>
15813	Number of samples to retain in performance data history. Older
15814	samples get discarded.
15815	</desc>
15816	</param>
15817	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15818	<desc>
15819	Array of metrics that have been modified by the call to this method.
15820	</desc>
15821	</param>
15822	</method>
15823
15824	<method name="enableMetrics">
15825	<desc>
15826	Turns on collecting specified base metrics. Returns an array of
15827	<link to="IPerformanceMetric" /> describing the metrics have been
15828	affected.
15829	<note>
15830	@c Null or empty metric name array means all metrics. @c Null or
15831	empty object array means all existing objects. If metric name array
15832	contains a single element and object array contains many, the single
15833	metric name array element is applied to each object array element to
15834	form metric/object pairs.
15835	</note>
15836	</desc>
15837	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15838	<desc>
15839	Metric name filter. Comma-separated list of metrics with wildcard
15840	support.
15841	</desc>
15842	</param>
15843	<param name="objects" type="$unknown" dir="in" safearray="yes">
15844	<desc>
15845	Set of objects to enable metrics for.
15846	</desc>
15847	</param>
15848	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15849	<desc>
15850	Array of metrics that have been modified by the call to this method.
15851	</desc>
15852	</param>
15853	</method>
15854
15855	<method name="disableMetrics">
15856	<desc>
15857	Turns off collecting specified base metrics. Returns an array of
15858	<link to="IPerformanceMetric" /> describing the metrics have been
15859	affected.
15860	<note>
15861	@c Null or empty metric name array means all metrics. @c Null or
15862	empty object array means all existing objects. If metric name array
15863	contains a single element and object array contains many, the single
15864	metric name array element is applied to each object array element to
15865	form metric/object pairs.
15866	</note>
15867	</desc>
15868	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15869	<desc>
15870	Metric name filter. Comma-separated list of metrics with wildcard
15871	support.
15872	</desc>
15873	</param>
15874	<param name="objects" type="$unknown" dir="in" safearray="yes">
15875	<desc>
15876	Set of objects to disable metrics for.
15877	</desc>
15878	</param>
15879	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15880	<desc>
15881	Array of metrics that have been modified by the call to this method.
15882	</desc>
15883	</param>
15884	</method>
15885
15886	<method name="queryMetricsData">
15887	<desc>
15888	Queries collected metrics data for a set of objects.
15889
15890	The data itself and related metric information are returned in seven
15891	parallel and one flattened array of arrays. Elements of
15892	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
15893	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
15894	the same index describe one set of values corresponding to a single
15895	metric.
15896
15897	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
15898	start and length of a sub-array is indicated by
15899	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
15900	value for metric <tt>metricNames[i]</tt> is at
15901	<tt>returnData[returnIndices[i]]</tt>.
15902
15903	<note>
15904	@c Null or empty metric name array means all metrics. @c Null or
15905	empty object array means all existing objects. If metric name array
15906	contains a single element and object array contains many, the single
15907	metric name array element is applied to each object array element to
15908	form metric/object pairs.
15909	</note>
15910	<note>
15911	Data collection continues behind the scenes after call to @c
15912	queryMetricsData. The return data can be seen as the snapshot of the
15913	current state at the time of @c queryMetricsData call. The internally
15914	kept metric values are not cleared by the call. This makes possible
15915	querying different subsets of metrics or aggregates with subsequent
15916	calls. If periodic querying is needed it is highly suggested to query
15917	the values with @c interval*count period to avoid confusion. This way
15918	a completely new set of data values will be provided by each query.
15919	</note>
15920	</desc>
15921	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15922	<desc>
15923	Metric name filter. Comma-separated list of metrics with wildcard
15924	support.
15925	</desc>
15926	</param>
15927	<param name="objects" type="$unknown" dir="in" safearray="yes">
15928	<desc>
15929	Set of objects to query metrics for.
15930	</desc>
15931	</param>
15932	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
15933	<desc>
15934	Names of metrics returned in @c returnData.
15935	</desc>
15936	</param>
15937	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
15938	<desc>
15939	Objects associated with metrics returned in @c returnData.
15940	</desc>
15941	</param>
15942	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
15943	<desc>
15944	Units of measurement for each returned metric.
15945	</desc>
15946	</param>
15947	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
15948	<desc>
15949	Divisor that should be applied to return values in order to get
15950	floating point values. For example:
15951	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
15952	will retrieve the floating point value of i-th sample of the first
15953	metric.
15954	</desc>
15955	</param>
15956	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
15957	<desc>
15958	Sequence numbers of the first elements of value sequences of
15959	particular metrics returned in @c returnData. For aggregate metrics
15960	it is the sequence number of the sample the aggregate started
15961	calculation from.
15962	</desc>
15963	</param>
15964	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
15965	<desc>
15966	Indices of the first elements of value sequences of particular
15967	metrics returned in @c returnData.
15968	</desc>
15969	</param>
15970	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
15971	<desc>
15972	Lengths of value sequences of particular metrics.
15973	</desc>
15974	</param>
15975	<param name="returnData" type="long" dir="return" safearray="yes">
15976	<desc>
15977	Flattened array of all metric data containing sequences of values for
15978	each metric.
15979	</desc>
15980	</param>
15981	</method>
15982
15983	</interface>
15984
15985	<enum
15986	name="NATAliasMode"
15987	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
15988	>
15989	<desc></desc>
15990	<const name="AliasLog" value="0x1">
15991	<desc></desc>
15992	</const>
15993	<const name="AliasProxyOnly" value="0x02">
15994	<desc></desc>
15995	</const>
15996	<const name="AliasUseSamePorts" value="0x04">
15997	<desc></desc>
15998	</const>
15999	</enum>
16000
16001	<enum
16002	name="NATProtocol"
16003	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
16004	>
16005	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
16006	<const name="UDP" value="0">
16007	<desc>Port-forwarding uses UDP protocol.</desc>
16008	</const>
16009	<const name="TCP" value="1">
16010	<desc>Port-forwarding uses TCP protocol.</desc>
16011	</const>
16012	</enum>
16013
16014	<interface
16015	name="INATEngine" extends="$unknown"
16016	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
16017	wsmap="managed"
16018	>
16019	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
16020	allows for changing NAT behavior such as port-forwarding rules. This interface is
16021	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
16022	<attribute name="network" type="wstring">
16023	<desc>The network attribute of the NAT engine (the same value is used with built-in
16024	DHCP server to fill corresponding fields of DHCP leases).</desc>
16025	</attribute>
16026	<attribute name="hostIP" type="wstring">
16027	<desc>IP of host interface to bind all opened sockets to.
16028	<note>Changing this does not change binding of port forwarding.</note>
16029	</desc>
16030	</attribute>
16031	<attribute name="tftpPrefix" type="wstring">
16032	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
16033	the corresponding fields of DHCP leases.</desc>
16034	</attribute>
16035	<attribute name="tftpBootFile" type="wstring">
16036	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
16037	the corresponding fields of DHCP leases.</desc>
16038	</attribute>
16039	<attribute name="tftpNextServer" type="wstring">
16040	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
16041	the corresponding fields of DHCP leases.
16042	<note>The preferred form is IPv4 addresses.</note>
16043	</desc>
16044	</attribute>
16045	<attribute name="aliasMode" type="unsigned long">
16046	<desc></desc>
16047	</attribute>
16048	<attribute name="dnsPassDomain" type="boolean">
16049	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
16050	</attribute>
16051	<attribute name="dnsProxy" type="boolean">
16052	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
16053	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
16054	</attribute>
16055	<attribute name="dnsUseHostResolver" type="boolean">
16056	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
16057	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
16058	</attribute>
16059	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
16060	<desc>Array of NAT port-forwarding rules in string representation, in the following
16061	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
16062	</attribute>
16063	<method name="setNetworkSettings">
16064	<desc>Sets network configuration of the NAT engine.</desc>
16065	<param name="mtu" type="unsigned long" dir="in">
16066	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
16067	</param>
16068	<param name="sockSnd" type="unsigned long" dir="in">
16069	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
16070	</param>
16071	<param name="sockRcv" type="unsigned long" dir="in">
16072	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
16073	</param>
16074	<param name="TcpWndSnd" type="unsigned long" dir="in">
16075	<desc>Initial size of the NAT engine's sending TCP window in bytes when
16076	establishing a new TCP connection.</desc>
16077	</param>
16078	<param name="TcpWndRcv" type="unsigned long" dir="in">
16079	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
16080	establishing a new TCP connection.</desc>
16081	</param>
16082	</method>
16083	<method name="getNetworkSettings">
16084	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
16085	for parameter descriptions.</desc>
16086	<param name="mtu" type="unsigned long" dir="out" />
16087	<param name="sockSnd" type="unsigned long" dir="out" />
16088	<param name="sockRcv" type="unsigned long" dir="out" />
16089	<param name="TcpWndSnd" type="unsigned long" dir="out" />
16090	<param name="TcpWndRcv" type="unsigned long" dir="out" />
16091	</method>
16092	<method name="addRedirect">
16093	<desc>Adds a new NAT port-forwarding rule.</desc>
16094	<param name="name" type="wstring" dir="in">
16095	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
16096	auto-generates one using the other parameters.</desc>
16097	</param>
16098	<param name="proto" type="NATProtocol" dir="in">
16099	<desc>Protocol handled with the rule.</desc>
16100	</param>
16101	<param name="hostIp" type="wstring" dir="in">
16102	<desc>IP of the host interface to which the rule should apply. An empty ip address is
16103	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
16104	</param>
16105	<param name="hostPort" type="unsigned short" dir="in">
16106	<desc>The port number to listen on.</desc>
16107	</param>
16108	<param name="guestIp" type="wstring" dir="in">
16109	<desc>The IP address of the guest which the NAT engine will forward matching packets
16110	to. An empty IP address is acceptable, in which case the NAT engine will forward
16111	packets to the first DHCP lease (x.x.x.15).</desc>
16112	</param>
16113	<param name="guestPort" type="unsigned short" dir="in">
16114	<desc>The port number to forward.</desc>
16115	</param>
16116	</method>
16117	<method name="removeRedirect">
16118	<desc>Removes a port-forwarding rule that was previously registered.</desc>
16119	<param name="name" type="wstring" dir="in">
16120	<desc>The name of the rule to delete.</desc>
16121	</param>
16122	</method>
16123	</interface>
16124
16125	<!--
16126	// IExtPackManager
16127	/////////////////////////////////////////////////////////////////////////
16128	-->
16129
16130	<interface
16131	name="IExtPackPlugIn" extends="$unknown"
16132	uuid="58000040-e718-4746-bbce-4b86d96da461"
16133	wsmap="suppress"
16134	>
16135	<desc>
16136	Interface for keeping information about a plug-in that ships with an
16137	extension pack.
16138	</desc>
16139	<attribute name="name" type="wstring" readonly="yes">
16140	<desc>The plug-in name.</desc>
16141	</attribute>
16142	<attribute name="description" type="wstring" readonly="yes">
16143	<desc>The plug-in description.</desc>
16144	</attribute>
16145	<attribute name="frontend" type="wstring" readonly="yes">
16146	<desc>
16147	The name of the frontend or component name this plug-in plugs into.
16148	</desc>
16149	</attribute>
16150	<attribute name="modulePath" type="wstring" readonly="yes">
16151	<desc> The module path. </desc>
16152	</attribute>
16153	</interface>
16154
16155	<interface
16156	name="IExtPackBase" extends="$unknown"
16157	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
16158	wsmap="suppress"
16159	>
16160	<desc>
16161	Interface for querying information about an extension pack as well as
16162	accessing COM objects within it.
16163	</desc>
16164	<attribute name="name" type="wstring" readonly="yes">
16165	<desc>The extension pack name. This is unique.</desc>
16166	</attribute>
16167	<attribute name="description" type="wstring" readonly="yes">
16168	<desc>The extension pack description.</desc>
16169	</attribute>
16170	<attribute name="version" type="wstring" readonly="yes">
16171	<desc>
16172	The extension pack version string. This is restricted to the dotted
16173	version number and optionally a build indicator. No tree revision or
16174	tag will be included in the string as those things are available as
16175	separate properties. An optional publisher tag may be present like for
16176	<link to="IVirtualBox::version"/>.
16177
16178	Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
16179	</desc>
16180	</attribute>
16181	<attribute name="revision" type="unsigned long" readonly="yes">
16182	<desc>The extension pack internal revision number.</desc>
16183	</attribute>
16184	<attribute name="edition" type="wstring" readonly="yes">
16185	<desc>
16186	Edition indicator. This is usually empty.
16187
16188	Can for instance be used to help distinguishing between two editions
16189	of the same extension pack where only the license, service contract or
16190	something differs.
16191	</desc>
16192	</attribute>
16193	<attribute name="VRDEModule" type="wstring" readonly="yes">
16194	<desc>The name of the VRDE module if the extension pack sports one.</desc>
16195	</attribute>
16196	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
16197	<desc>Plug-ins provided by this extension pack.</desc>
16198	</attribute>
16199	<attribute name="usable" type="boolean" readonly="yes">
16200	<desc>
16201	Indicates whether the extension pack is usable or not.
16202
16203	There are a number of reasons why an extension pack might be unusable,
16204	typical examples would be broken installation/file or that it is
16205	incompatible with the current VirtualBox version.
16206	</desc>
16207	</attribute>
16208	<attribute name="whyUnusable" type="wstring" readonly="yes">
16209	<desc>
16210	String indicating why the extension pack is not usable. This is an
16211	empty string if usable and always a non-empty string if not usable.
16212	</desc>
16213	</attribute>
16214	<attribute name="showLicense" type="boolean" readonly="yes">
16215	<desc>Whether to show the license before installation</desc>
16216	</attribute>
16217	<attribute name="license" type="wstring" readonly="yes">
16218	<desc>
16219	The default HTML license text for the extension pack. Same as
16220	calling <link to="#queryLicense">queryLicense</link> with
16221	preferredLocale and preferredLanguage as empty strings and format set
16222	to html.
16223	</desc>
16224	</attribute>
16225
16226	<method name="queryLicense">
16227	<desc>
16228	Full feature version of the license attribute.
16229	</desc>
16230	<param name="preferredLocale" type="wstring" dir="in">
16231	<desc>
16232	The preferred license locale. Pass an empty string to get the default
16233	license.
16234	</desc>
16235	</param>
16236	<param name="preferredLanguage" type="wstring" dir="in">
16237	<desc>
16238	The preferred license language. Pass an empty string to get the
16239	default language for the locale.
16240	</desc>
16241	</param>
16242	<param name="format" type="wstring" dir="in">
16243	<desc>
16244	The license format: html, rtf or txt. If a license is present there
16245	will always be an HTML of it, the rich text format (RTF) and plain
16246	text (txt) versions are optional. If
16247	</desc>
16248	</param>
16249	<param name="licenseText" type="wstring" dir="return">
16250	<desc>The license text.</desc>
16251	</param>
16252	</method>
16253
16254	</interface>
16255
16256	<interface
16257	name="IExtPack" extends="IExtPackBase"
16258	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
16259	wsmap="suppress"
16260	>
16261	<desc>
16262	Interface for querying information about an extension pack as well as
16263	accessing COM objects within it.
16264	</desc>
16265	<method name="queryObject">
16266	<desc>
16267	Queries the IUnknown interface to an object in the extension pack
16268	main module. This allows plug-ins and others to talk directly to an
16269	extension pack.
16270	</desc>
16271	<param name="objUuid" type="wstring" dir="in">
16272	<desc>The object ID. What exactly this is </desc>
16273	</param>
16274	<param name="returnInterface" type="$unknown" dir="return">
16275	<desc>The queried interface.</desc>
16276	</param>
16277	</method>
16278	</interface>
16279
16280	<interface
16281	name="IExtPackFile" extends="IExtPackBase"
16282	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
16283	wsmap="suppress"
16284	>
16285	<desc>
16286	Extension pack file (aka tarball, .vbox-extpack) representation returned
16287	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
16288	extension pack information with the addition of the file name.
16289	</desc>
16290	<attribute name="filePath" type="wstring" readonly="yes">
16291	<desc>
16292	The path to the extension pack file.
16293	</desc>
16294	</attribute>
16295
16296	<method name="install">
16297	<desc>
16298	Install the extension pack.
16299	</desc>
16300	<param name="replace" type="boolean" dir="in">
16301	<desc>
16302	Set this to automatically uninstall any existing extension pack with
16303	the same name as the one being installed.
16304	</desc>
16305	</param>
16306	<param name="displayInfo" type="wstring" dir="in">
16307	<desc>
16308	Platform specific display information. Reserved for future hacks.
16309	</desc>
16310	</param>
16311	<param name="progess" type="IProgress" dir="return">
16312	<desc>
16313	Progress object for the operation.
16314	</desc>
16315	</param>
16316	</method>
16317	</interface>
16318
16319	<interface
16320	name="IExtPackManager" extends="$unknown"
16321	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
16322	wsmap="suppress"
16323	>
16324	<desc>
16325	Interface for managing VirtualBox Extension Packs.
16326
16327	TODO: Describe extension packs, how they are managed and how to create
16328	one.
16329	</desc>
16330
16331	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
16332	<desc>
16333	List of the installed extension packs.
16334	</desc>
16335	</attribute>
16336
16337	<method name="find">
16338	<desc>
16339	Returns the extension pack with the specified name if found.
16340
16341	<result name="VBOX_E_OBJECT_NOT_FOUND">
16342	No extension pack matching @a name was found.
16343	</result>
16344	</desc>
16345	<param name="name" type="wstring" dir="in">
16346	<desc>The name of the extension pack to locate.</desc>
16347	</param>
16348	<param name="returnData" type="IExtPack" dir="return">
16349	<desc>The extension pack if found.</desc>
16350	</param>
16351	</method>
16352
16353	<method name="openExtPackFile">
16354	<desc>
16355	Attempts to open an extension pack file in preparation for
16356	installation.
16357	</desc>
16358	<param name="path" type="wstring" dir="in">
16359	<desc>The path of the extension pack tarball. This can optionally be
16360	followed by a "::SHA-256=hex-digit" of the tarball. </desc>
16361	</param>
16362	<param name="file" type="IExtPackFile" dir="return">
16363	<desc>The interface of the extension pack file object.</desc>
16364	</param>
16365	</method>
16366
16367	<method name="uninstall">
16368	<desc>Uninstalls an extension pack, removing all related files.</desc>
16369	<param name="name" type="wstring" dir="in">
16370	<desc>The name of the extension pack to uninstall.</desc>
16371	</param>
16372	<param name="forcedRemoval" type="boolean" dir="in">
16373	<desc>
16374	Forced removal of the extension pack. This means that the uninstall
16375	hook will not be called.
16376	</desc>
16377	</param>
16378	<param name="displayInfo" type="wstring" dir="in">
16379	<desc>
16380	Platform specific display information. Reserved for future hacks.
16381	</desc>
16382	</param>
16383	<param name="progess" type="IProgress" dir="return">
16384	<desc>
16385	Progress object for the operation.
16386	</desc>
16387	</param>
16388	</method>
16389
16390	<method name="cleanup">
16391	<desc>Cleans up failed installs and uninstalls</desc>
16392	</method>
16393
16394	<method name="queryAllPlugInsForFrontend">
16395	<desc>
16396	Gets the path to all the plug-in modules for a given frontend.
16397
16398	This is a convenience method that is intended to simplify the plug-in
16399	loading process for a frontend.
16400	</desc>
16401	<param name="frontendName" type="wstring" dir="in">
16402	<desc>The name of the frontend or component.</desc>
16403	</param>
16404	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
16405	<desc>Array containing the plug-in modules (full paths).</desc>
16406	</param>
16407	</method>
16408
16409	<method name="isExtPackUsable">
16410	<desc>Check if the given extension pack is loaded and usable.</desc>
16411	<param name="name" type="wstring" dir="in">
16412	<desc>The name of the extension pack to check for.</desc>
16413	</param>
16414	<param name="usable" type="boolean" dir="return">
16415	<desc>Is the given extension pack loaded and usable.</desc>
16416	</param>
16417	</method>
16418
16419	</interface>
16420
16421	<!--
16422	// BandwidthGroupType
16423	/////////////////////////////////////////////////////////////////////////
16424	-->
16425	<enum
16426	name="BandwidthGroupType"
16427	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
16428
16429	<desc>
16430	Type of a bandwidth control group.
16431	</desc>
16432
16433	<const name="Null" value="0">
16434	<desc>
16435	Null type, must be first.
16436	</desc>
16437	</const>
16438
16439	<const name="Disk" value="1">
16440	<desc>
16441	The bandwidth group controls disk I/O.
16442	</desc>
16443	</const>
16444
16445	<const name="Network" value="2">
16446	<desc>
16447	The bandwidth group controls network I/O.
16448	</desc>
16449	</const>
16450
16451	</enum>
16452
16453	<!--
16454	// IBandwidthGroup
16455	/////////////////////////////////////////////////////////////////////////
16456	-->
16457	<interface
16458	name="IBandwidthGroup" extends="$unknown"
16459	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
16460	wsmap="managed"
16461	>
16462	<desc>Represents one bandwidth group.</desc>
16463
16464	<attribute name="name" type="wstring" readonly="yes">
16465	<desc>Name of the group.</desc>
16466	</attribute>
16467
16468	<attribute name="type" type="BandwidthGroupType" readonly="yes">
16469	<desc>Type of the group.</desc>
16470	</attribute>
16471
16472	<attribute name="reference" type="unsigned long" readonly="yes">
16473	<desc>How many devices/medium attachements use this group.</desc>
16474	</attribute>
16475
16476	<attribute name="maxMbPerSec" type="unsigned long">
16477	<desc>The maximum number of MBytes which can be transfered by all
16478	entities attached to this group during one second.</desc>
16479	</attribute>
16480
16481	</interface>
16482
16483	<!--
16484	// IBandwidthControl
16485	/////////////////////////////////////////////////////////////////////////
16486	-->
16487	<interface
16488	name="IBandwidthControl" extends="$unknown"
16489	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
16490	wsmap="managed"
16491	>
16492	<desc>
16493	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
16494	This includes network and disk I/O.
16495	</desc>
16496
16497	<attribute name="numGroups" type="unsigned long" readonly="yes">
16498	<desc>
16499	The current number of existing bandwidth groups managed.
16500	</desc>
16501	</attribute>
16502
16503	<method name="createBandwidthGroup">
16504	<desc>
16505	Creates a new bandwidth group.
16506	</desc>
16507
16508	<param name="name" type="wstring" dir="in">
16509	<desc>Name of the bandwidth group.</desc>
16510	</param>
16511	<param name="type" type="BandwidthGroupType" dir="in">
16512	<desc>The type of the bandwidth group (network or disk).</desc>
16513	</param>
16514	<param name="maxMbPerSec" type="unsigned long" dir="in">
16515	<desc>The maximum number of MBytes which can be transfered by all
16516	entities attached to this group during one second.</desc>
16517	</param>
16518	</method>
16519
16520	<method name="deleteBandwidthGroup">
16521	<desc>
16522	Deletes a new bandwidth group.
16523	</desc>
16524
16525	<param name="name" type="wstring" dir="in">
16526	<desc>Name of the bandwidth group to delete.</desc>
16527	</param>
16528	</method>
16529
16530	<method name="getBandwidthGroup" const="yes">
16531	<desc>
16532	Get a bandwidth group by name.
16533	</desc>
16534
16535	<param name="name" type="wstring" dir="in">
16536	<desc>Name of the bandwidth group to get.</desc>
16537	</param>
16538	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
16539	<desc>Where to store the bandwidth group on success.</desc>
16540	</param>
16541	</method>
16542
16543	<method name="getAllBandwidthGroups" const="yes">
16544	<desc>
16545	Get all managed bandwidth groups.
16546	</desc>
16547
16548	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
16549	<desc>The array of managed bandwidth groups.</desc>
16550	</param>
16551	</method>
16552	</interface>
16553
16554	<!--
16555	// IVirtualBoxClient
16556	/////////////////////////////////////////////////////////////////////////
16557	-->
16558
16559	<interface
16560	name="IVirtualBoxClient" extends="$unknown"
16561	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
16562	wsmap="suppress"
16563	>
16564	<desc>
16565	Convenience interface for client applications. Treat this as a
16566	singleton, i.e. never create more than one instance of this interface.
16567
16568	At the moment only available for clients of the local API (not usable
16569	via the webservice). Once the session logic is redesigned this might
16570	change.
16571	</desc>
16572
16573	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
16574	<desc>
16575	Reference to the server-side API root object.
16576	</desc>
16577	</attribute>
16578
16579	<attribute name="session" type="ISession" readonly="yes">
16580	<desc>
16581	Create a new session object and return the reference to it.
16582	</desc>
16583	</attribute>
16584
16585	<attribute name="eventSource" type="IEventSource" readonly="yes">
16586	<desc>
16587	Event source for VirtualBoxClient events.
16588	</desc>
16589	</attribute>
16590
16591	</interface>
16592
16593	<!--
16594	// Events
16595	/////////////////////////////////////////////////////////////////////////
16596	-->
16597	<enum
16598	name="VBoxEventType"
16599	uuid="cce48db6-8561-479d-8d46-1358bab45d4e"
16600	>
16601
16602	<desc>
16603	Type of an event.
16604	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16605	</desc>
16606
16607	<const name="Invalid" value="0">
16608	<desc>
16609	Invalid event, must be first.
16610	</desc>
16611	</const>
16612
16613	<const name="Any" value="1">
16614	<desc>
16615	Wildcard for all events.
16616	Events of this type are never delivered, and only used in
16617	<link to="IEventSource::registerListener"/> call to simplify registration.
16618	</desc>
16619	</const>
16620
16621	<const name="Vetoable" value="2">
16622	<desc>
16623	Wildcard for all vetoable events. Events of this type are never delivered, and only
16624	used in <link to="IEventSource::registerListener"/> call to simplify registration.
16625	</desc>
16626	</const>
16627
16628	<const name="MachineEvent" value="3">
16629	<desc>
16630	Wildcard for all machine events. Events of this type are never delivered, and only used in
16631	<link to="IEventSource::registerListener"/> call to simplify registration.
16632	</desc>
16633	</const>
16634
16635	<const name="SnapshotEvent" value="4">
16636	<desc>
16637	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
16638	<link to="IEventSource::registerListener"/> call to simplify registration.
16639	</desc>
16640	</const>
16641
16642	<const name="InputEvent" value="5">
16643	<desc>
16644	Wildcard for all input device (keyboard, mouse) events.
16645	Events of this type are never delivered, and only used in
16646	<link to="IEventSource::registerListener"/> call to simplify registration.
16647	</desc>
16648	</const>
16649
16650	<const name="LastWildcard" value="31">
16651	<desc>
16652	Last wildcard.
16653	</desc>
16654	</const>
16655
16656	<const name="OnMachineStateChanged" value="32">
16657	<desc>
16658	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
16659	</desc>
16660	</const>
16661	<const name="OnMachineDataChanged" value="33">
16662	<desc>
16663	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
16664	</desc>
16665	</const>
16666	<const name="OnExtraDataChanged" value="34">
16667	<desc>
16668	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
16669	</desc>
16670	</const>
16671	<const name="OnExtraDataCanChange" value="35">
16672	<desc>
16673	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
16674	</desc>
16675	</const>
16676	<const name="OnMediumRegistered" value="36">
16677	<desc>
16678	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
16679	</desc>
16680	</const>
16681	<const name="OnMachineRegistered" value="37">
16682	<desc>
16683	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
16684	</desc>
16685	</const>
16686	<const name="OnSessionStateChanged" value="38">
16687	<desc>
16688	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
16689	</desc>
16690	</const>
16691	<const name="OnSnapshotTaken" value="39">
16692	<desc>
16693	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
16694	</desc>
16695	</const>
16696	<const name="OnSnapshotDeleted" value="40">
16697	<desc>
16698	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
16699	</desc>
16700	</const>
16701	<const name="OnSnapshotChanged" value="41">
16702	<desc>
16703	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
16704	</desc>
16705	</const>
16706	<const name="OnGuestPropertyChanged" value="42">
16707	<desc>
16708	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
16709	</desc>
16710	</const>
16711	<!-- Console events -->
16712	<const name="OnMousePointerShapeChanged" value="43">
16713	<desc>
16714	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
16715	</desc>
16716	</const>
16717	<const name="OnMouseCapabilityChanged" value="44">
16718	<desc>
16719	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
16720	</desc>
16721	</const>
16722	<const name="OnKeyboardLedsChanged" value="45">
16723	<desc>
16724	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
16725	</desc>
16726	</const>
16727	<const name="OnStateChanged" value="46">
16728	<desc>
16729	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
16730	</desc>
16731	</const>
16732	<const name="OnAdditionsStateChanged" value="47">
16733	<desc>
16734	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
16735	</desc>
16736	</const>
16737	<const name="OnNetworkAdapterChanged" value="48">
16738	<desc>
16739	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
16740	</desc>
16741	</const>
16742	<const name="OnSerialPortChanged" value="49">
16743	<desc>
16744	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
16745	</desc>
16746	</const>
16747	<const name="OnParallelPortChanged" value="50">
16748	<desc>
16749	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
16750	</desc>
16751	</const>
16752	<const name="OnStorageControllerChanged" value="51">
16753	<desc>
16754	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
16755	</desc>
16756	</const>
16757	<const name="OnMediumChanged" value="52">
16758	<desc>
16759	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
16760	</desc>
16761	</const>
16762	<const name="OnVRDEServerChanged" value="53">
16763	<desc>
16764	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
16765	</desc>
16766	</const>
16767	<const name="OnUSBControllerChanged" value="54">
16768	<desc>
16769	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
16770	</desc>
16771	</const>
16772	<const name="OnUSBDeviceStateChanged" value="55">
16773	<desc>
16774	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
16775	</desc>
16776	</const>
16777	<const name="OnSharedFolderChanged" value="56">
16778	<desc>
16779	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
16780	</desc>
16781	</const>
16782	<const name="OnRuntimeError" value="57">
16783	<desc>
16784	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
16785	</desc>
16786	</const>
16787	<const name="OnCanShowWindow" value="58">
16788	<desc>
16789	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
16790	</desc>
16791	</const>
16792	<const name="OnShowWindow" value="59">
16793	<desc>
16794	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
16795	</desc>
16796	</const>
16797	<const name="OnCPUChanged" value="60">
16798	<desc>
16799	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
16800	</desc>
16801	</const>
16802	<const name="OnVRDEServerInfoChanged" value="61">
16803	<desc>
16804	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
16805	</desc>
16806	</const>
16807	<const name="OnEventSourceChanged" value="62">
16808	<desc>
16809	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
16810	</desc>
16811	</const>
16812	<const name="OnCPUExecutionCapChanged" value="63">
16813	<desc>
16814	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
16815	</desc>
16816	</const>
16817	<const name="OnGuestKeyboard" value="64">
16818	<desc>
16819	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
16820	</desc>
16821	</const>
16822	<const name="OnGuestMouse" value="65">
16823	<desc>
16824	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
16825	</desc>
16826	</const>
16827	<const name="OnNATRedirect" value="66">
16828	<desc>
16829	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
16830	</desc>
16831	</const>
16832	<const name="OnHostPciDevicePlug" value="67">
16833	<desc>
16834	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
16835	</desc>
16836	</const>
16837	<const name="OnVBoxSVCAvailabilityChanged" value="68">
16838	<desc>
16839	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
16840	</desc>
16841	</const>
16842	<const name="OnBandwidthGroupChanged" value="69">
16843	<desc>
16844	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
16845	</desc>
16846	</const>
16847	<const name="OnGuestMonitorChanged" value="70">
16848	<desc>
16849	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
16850	</desc>
16851	</const>
16852	<const name="OnStorageDeviceChanged" value="71">
16853	<desc>
16854	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
16855	</desc>
16856	</const>
16857
16858	<!-- Last event marker -->
16859	<const name="Last" value="72">
16860	<desc>
16861	Must be last event, used for iterations and structures relying on numerical event values.
16862	</desc>
16863	</const>
16864
16865	</enum>
16866
16867	<interface
16868	name="IEventSource" extends="$unknown"
16869	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
16870	wsmap="managed"
16871	>
16872	<desc>
16873	Event source. Generally, any object which could generate events can be an event source,
16874	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
16875	an event source can work with listeners in either active or passive mode. In active mode it is up to
16876	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
16877	event source keeps track of pending events for each listener and returns available events on demand.
16878
16879	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16880	</desc>
16881
16882	<method name="createListener">
16883	<desc>
16884	Creates a new listener object, useful for passive mode.
16885	</desc>
16886	<param name="listener" type="IEventListener" dir="return"/>
16887	</method>
16888
16889	<method name="createAggregator">
16890	<desc>
16891	Creates an aggregator event source, collecting events from multiple sources.
16892	This way a single listener can listen for events coming from multiple sources,
16893	using a single blocking <link to="#getEvent"/> on the returned aggregator.
16894	</desc>
16895	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
16896	<desc>
16897	Subordinate event source this one aggregatres.
16898	</desc>
16899	</param>
16900	<param name="result" type="IEventSource" dir="return">
16901	<desc>
16902	Event source aggregating passed sources.
16903	</desc>
16904	</param>
16905	</method>
16906
16907	<method name="registerListener">
16908	<desc>
16909	Register an event listener.
16910
16911	<note>
16912	To avoid system overload, the VirtualBox server process checks if passive event
16913	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
16914	current implementation, if more than 500 pending events are detected for a passive
16915	event listener, it is forcefully unregistered by the system, and further
16916	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
16917	</note>
16918	</desc>
16919	<param name="listener" type="IEventListener" dir="in">
16920	<desc>Listener to register.</desc>
16921	</param>
16922	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
16923	<desc>
16924	Event types listener is interested in. One can use wildcards like -
16925	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
16926	than one event.
16927	</desc>
16928	</param>
16929	<param name="active" type="boolean" dir="in">
16930	<desc>
16931	Which mode this listener is operating in.
16932	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
16933	In passive mode, an internal event queue is created for this this IEventListener.
16934	For each event coming in, it is added to queues for all interested registered passive
16935	listeners. It is then up to the external code to call the listener's
16936	<link to="IEventListener::handleEvent" /> method. When done with an event, the
16937	external code must call <link to="#eventProcessed" />.
16938	</desc>
16939	</param>
16940	</method>
16941
16942	<method name="unregisterListener">
16943	<desc>
16944	Unregister an event listener. If listener is passive, and some waitable events are still
16945	in queue they are marked as processed automatically.
16946	</desc>
16947	<param name="listener" type="IEventListener" dir="in">
16948	<desc>Listener to unregister.</desc>
16949	</param>
16950	</method>
16951
16952	<method name="fireEvent">
16953	<desc>
16954	Fire an event for this source.
16955	</desc>
16956	<param name="event" type="IEvent" dir="in">
16957	<desc>Event to deliver.</desc>
16958	</param>
16959	<param name="timeout" type="long" dir="in">
16960	<desc>
16961	Maximum time to wait for event processing (if event is waitable), in ms;
16962	0 = no wait, -1 = indefinite wait.
16963	</desc>
16964	</param>
16965	<param name="result" type="boolean" dir="return">
16966	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
16967	</param>
16968	</method>
16969
16970	<method name="getEvent">
16971	<desc>
16972	Get events from this peer's event queue (for passive mode). Calling this method
16973	regularly is required for passive event listeners to avoid system overload;
16974	see <link to="IEventSource::registerListener" /> for details.
16975
16976	<result name="VBOX_E_OBJECT_NOT_FOUND">
16977	Listener is not registered, or autounregistered.
16978	</result>
16979	</desc>
16980	<param name="listener" type="IEventListener" dir="in">
16981	<desc>Which listener to get data for.</desc>
16982	</param>
16983	<param name="timeout" type="long" dir="in">
16984	<desc>
16985	Maximum time to wait for events, in ms;
16986	0 = no wait, -1 = indefinite wait.
16987	</desc>
16988	</param>
16989	<param name="event" type="IEvent" dir="return">
16990	<desc>Event retrieved, or null if none available.</desc>
16991	</param>
16992	</method>
16993
16994	<method name="eventProcessed">
16995	<desc>
16996	Must be called for waitable events after a particular listener finished its
16997	event processing. When all listeners of a particular event have called this
16998	method, the system will then call <link to="IEvent::setProcessed" />.
16999	</desc>
17000	<param name="listener" type="IEventListener" dir="in">
17001	<desc>Which listener processed event.</desc>
17002	</param>
17003	<param name="event" type="IEvent" dir="in">
17004	<desc>Which event.</desc>
17005	</param>
17006	</method>
17007
17008	</interface>
17009
17010	<interface
17011	name="IEventListener" extends="$unknown"
17012	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
17013	wsmap="managed"
17014	>
17015	<desc>
17016	Event listener. An event listener can work in either active or passive mode, depending on the way
17017	it was registered.
17018	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
17019	</desc>
17020
17021	<method name="handleEvent">
17022	<desc>
17023	Handle event callback for active listeners. It is not called for
17024	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
17025	and having received acknowledgement from all passive listeners via
17026	<link to="IEventSource::eventProcessed"/>, the event is marked as
17027	processed and <link to="IEvent::waitProcessed"/> will return
17028	immediately.
17029	</desc>
17030	<param name="event" type="IEvent" dir="in">
17031	<desc>Event available.</desc>
17032	</param>
17033	</method>
17034
17035	</interface>
17036
17037	<interface
17038	name="IEvent" extends="$unknown"
17039	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
17040	wsmap="managed"
17041	>
17042	<desc>
17043	Abstract parent interface for VirtualBox events. Actual events will typically implement
17044	a more specific interface which derives from this (see below).
17045
17046	<b>Introduction to VirtualBox events</b>
17047
17048	Generally speaking, an event (represented by this interface) signals that something
17049	happened, while an event listener (see <link to="IEventListener" />) represents an
17050	entity that is interested in certain events. In order for this to work with
17051	unidirectional protocols (i.e. web services), the concepts of passive and active
17052	listener are used.
17053
17054	Event consumers can register themselves as listeners, providing an array of
17055	events they are interested in (see <link to="IEventSource::registerListener" />).
17056	When an event triggers, the listener is notified about the event. The exact
17057	mechanism of the notification depends on whether the listener was registered as
17058	an active or passive listener:
17059
17060	<ul>
17061	<li>An active listener is very similar to a callback: it is a function invoked
17062	by the API. As opposed to the callbacks that were used in the API before
17063	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
17064	</li>
17065
17066	<li>Passive listeners are somewhat trickier to implement, but do not require
17067	a client function to be callable, which is not an option with scripting
17068	languages or web service clients. Internally the <link to="IEventSource" />
17069	implementation maintains an event queue for each passive listener, and
17070	newly arrived events are put in this queue. When the listener calls
17071	<link to="IEventSource::getEvent"/>, first element from its internal event
17072	queue is returned. When the client completes processing of an event,
17073	the <link to="IEventSource::eventProcessed" /> function must be called,
17074	acknowledging that the event was processed. It supports implementing
17075	waitable events. On passive listener unregistration, all events from its
17076	queue are auto-acknowledged.
17077	</li>
17078	</ul>
17079
17080	Waitable events are useful in situations where the event generator wants to track
17081	delivery or a party wants to wait until all listeners have completed the event. A
17082	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
17083	listeners might veto a certain action, and thus the event producer has to make
17084	sure that all listeners have processed the event and not vetoed before taking
17085	the action.
17086
17087	A given event may have both passive and active listeners at the same time.
17088
17089	<b>Using events</b>
17090
17091	Any VirtualBox object capable of producing externally visible events provides an
17092	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
17093	This event source object is notified by VirtualBox once something has happened, so
17094	consumers may register event listeners with this event source. To register a listener,
17095	an object implementing the <link to="IEventListener" /> interface must be provided.
17096	For active listeners, such an object is typically created by the consumer, while for
17097	passive listeners <link to="IEventSource::createListener" /> should be used. Please
17098	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
17099
17100	Once created, the listener must be registered to listen for the desired events
17101	(see <link to="IEventSource::registerListener" />), providing an array of
17102	<link to="VBoxEventType" /> enums. Those elements can either be the individual
17103	event IDs or wildcards matching multiple event IDs.
17104
17105	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
17106	called automatically when the event is triggered, while passive listeners have to call
17107	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
17108	an event processing loop.
17109
17110	The IEvent interface is an abstract parent interface for all such VirtualBox events
17111	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
17112	or the event processing loop is to check the <link to="#type" /> attribute of the event and
17113	then cast to the appropriate specific interface using @c QueryInterface().
17114	</desc>
17115
17116	<attribute name="type" readonly="yes" type="VBoxEventType">
17117	<desc>
17118	Event type.
17119	</desc>
17120	</attribute>
17121
17122	<attribute name="source" readonly="yes" type="IEventSource">
17123	<desc>
17124	Source of this event.
17125	</desc>
17126	</attribute>
17127
17128	<attribute name="waitable" readonly="yes" type="boolean">
17129	<desc>
17130	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
17131	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
17132	as no additional overhead associated with waitability imposed.
17133	Waitable events are needed when one need to be able to wait for particular event processed,
17134	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
17135	until all consumers confirmed events.
17136	</desc>
17137	</attribute>
17138
17139	<method name="setProcessed">
17140	<desc>
17141	Internal method called by the system when all listeners of a particular event have called
17142	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
17143	</desc>
17144	</method>
17145
17146	<method name="waitProcessed">
17147	<desc>
17148	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
17149	described semantics, for non-waitable returns true immediately.
17150	</desc>
17151	<param name="timeout" type="long" dir="in">
17152	<desc>
17153	Maximum time to wait for event processeing, in ms;
17154	0 = no wait, -1 = indefinite wait.
17155	</desc>
17156	</param>
17157	<param name="result" type="boolean" dir="return">
17158	<desc>If this event was processed before timeout.</desc>
17159	</param>
17160	</method>
17161	</interface>
17162
17163
17164	<interface
17165	name="IReusableEvent" extends="IEvent"
17166	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
17167	wsmap="managed"
17168	>
17169	<desc>Base abstract interface for all reusable events.</desc>
17170
17171	<attribute name="generation" readonly="yes" type="unsigned long">
17172	<desc>Current generation of event, incremented on reuse.</desc>
17173	</attribute>
17174
17175	<method name="reuse">
17176	<desc>
17177	Marks an event as reused, increments 'generation', fields shall no
17178	longer be considered valid.
17179	</desc>
17180	</method>
17181	</interface>
17182
17183	<interface
17184	name="IMachineEvent" extends="IEvent"
17185	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
17186	wsmap="managed" id="MachineEvent"
17187	>
17188	<desc>Base abstract interface for all machine events.</desc>
17189
17190	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
17191	<desc>ID of the machine this event relates to.</desc>
17192	</attribute>
17193
17194	</interface>
17195
17196	<interface
17197	name="IMachineStateChangedEvent" extends="IMachineEvent"
17198	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
17199	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
17200	>
17201	<desc>Machine state change event.</desc>
17202
17203	<attribute name="state" readonly="yes" type="MachineState">
17204	<desc>New execution state.</desc>
17205	</attribute>
17206	</interface>
17207
17208	<interface
17209	name="IMachineDataChangedEvent" extends="IMachineEvent"
17210	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
17211	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
17212	>
17213	<desc>
17214	Any of the settings of the given machine has changed.
17215	</desc>
17216
17217	<attribute name="temporary" readonly="yes" type="boolean">
17218	<desc>@c true if the settings change is temporary. All permanent
17219	settings changes will trigger an event, and only temporary settings
17220	changes for running VMs will trigger an event. Note: sending events
17221	for temporary changes is NOT IMPLEMENTED.</desc>
17222	</attribute>
17223	</interface>
17224
17225	<interface
17226	name="IMediumRegisteredEvent" extends="IEvent"
17227	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
17228	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
17229	>
17230	<desc>
17231	The given medium was registered or unregistered
17232	within this VirtualBox installation.
17233	</desc>
17234
17235	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
17236	<desc>ID of the medium this event relates to.</desc>
17237	</attribute>
17238
17239	<attribute name="mediumType" readonly="yes" type="DeviceType">
17240	<desc>Type of the medium this event relates to.</desc>
17241	</attribute>
17242
17243	<attribute name="registered" type="boolean" readonly="yes">
17244	<desc>
17245	If @c true, the medium was registered, otherwise it was
17246	unregistered.
17247	</desc>
17248	</attribute>
17249	</interface>
17250
17251	<interface
17252	name="IMachineRegisteredEvent" extends="IMachineEvent"
17253	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
17254	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
17255	>
17256	<desc>
17257	The given machine was registered or unregistered
17258	within this VirtualBox installation.
17259	</desc>
17260
17261	<attribute name="registered" type="boolean" readonly="yes">
17262	<desc>
17263	If @c true, the machine was registered, otherwise it was
17264	unregistered.
17265	</desc>
17266	</attribute>
17267	</interface>
17268
17269	<interface
17270	name="ISessionStateChangedEvent" extends="IMachineEvent"
17271	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
17272	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
17273	>
17274	<desc>
17275	The state of the session for the given machine was changed.
17276	<see><link to="IMachine::sessionState"/></see>
17277	</desc>
17278
17279	<attribute name="state" type="SessionState" readonly="yes">
17280	<desc>
17281	New session state.
17282	</desc>
17283	</attribute>
17284	</interface>
17285
17286	<interface
17287	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
17288	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
17289	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
17290	>
17291	<desc>
17292	Notification when a guest property has changed.
17293	</desc>
17294
17295	<attribute name="name" readonly="yes" type="wstring">
17296	<desc>
17297	The name of the property that has changed.
17298	</desc>
17299	</attribute>
17300
17301	<attribute name="value" readonly="yes" type="wstring">
17302	<desc>
17303	The new property value.
17304	</desc>
17305	</attribute>
17306
17307	<attribute name="flags" readonly="yes" type="wstring">
17308	<desc>
17309	The new property flags.
17310	</desc>
17311	</attribute>
17312
17313	</interface>
17314
17315	<interface
17316	name="ISnapshotEvent" extends="IMachineEvent"
17317	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
17318	wsmap="managed" id="SnapshotEvent"
17319	>
17320	<desc>Base interface for all snapshot events.</desc>
17321
17322	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
17323	<desc>ID of the snapshot this event relates to.</desc>
17324	</attribute>
17325
17326	</interface>
17327
17328	<interface
17329	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
17330	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
17331	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
17332	>
17333	<desc>
17334	A new snapshot of the machine has been taken.
17335	<see><link to="ISnapshot"/></see>
17336	</desc>
17337	</interface>
17338
17339	<interface
17340	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
17341	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
17342	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
17343	>
17344	<desc>
17345	Snapshot of the given machine has been deleted.
17346
17347	<note>
17348	This notification is delivered <b>after</b> the snapshot
17349	object has been uninitialized on the server (so that any
17350	attempt to call its methods will return an error).
17351	</note>
17352
17353	<see><link to="ISnapshot"/></see>
17354	</desc>
17355	</interface>
17356
17357	<interface
17358	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
17359	uuid="07541941-8079-447a-a33e-47a69c7980db"
17360	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
17361	>
17362	<desc>
17363	Snapshot properties (name and/or description) have been changed.
17364	<see><link to="ISnapshot"/></see>
17365	</desc>
17366	</interface>
17367
17368	<interface
17369	name="IMousePointerShapeChangedEvent" extends="IEvent"
17370	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
17371	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
17372	>
17373	<desc>
17374	Notification when the guest mouse pointer shape has
17375	changed. The new shape data is given.
17376	</desc>
17377
17378	<attribute name="visible" type="boolean" readonly="yes">
17379	<desc>
17380	Flag whether the pointer is visible.
17381	</desc>
17382	</attribute>
17383	<attribute name="alpha" type="boolean" readonly="yes">
17384	<desc>
17385	Flag whether the pointer has an alpha channel.
17386	</desc>
17387	</attribute>
17388	<attribute name="xhot" type="unsigned long" readonly="yes">
17389	<desc>
17390	The pointer hot spot X coordinate.
17391	</desc>
17392	</attribute>
17393	<attribute name="yhot" type="unsigned long" readonly="yes">
17394	<desc>
17395	The pointer hot spot Y coordinate.
17396	</desc>
17397	</attribute>
17398	<attribute name="width" type="unsigned long" readonly="yes">
17399	<desc>
17400	Width of the pointer shape in pixels.
17401	</desc>
17402	</attribute>
17403	<attribute name="height" type="unsigned long" readonly="yes">
17404	<desc>
17405	Height of the pointer shape in pixels.
17406	</desc>
17407	</attribute>
17408	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
17409	<desc>
17410	Shape buffer arrays.
17411
17412	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
17413	followed by a 32-bpp XOR (color) mask.
17414
17415	For pointers without alpha channel the XOR mask pixels are 32
17416	bit values: (lsb)BGR0(msb). For pointers with alpha channel
17417	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
17418
17419	An AND mask is used for pointers with alpha channel, so if the
17420	callback does not support alpha, the pointer could be
17421	displayed as a normal color pointer.
17422
17423	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
17424	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
17425	height</tt>. The padding bits at the end of each scanline are
17426	undefined.
17427
17428	The XOR mask follows the AND mask on the next 4-byte aligned
17429	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
17430	Bytes in the gap between the AND and the XOR mask are undefined.
17431	The XOR mask scanlines have no gap between them and the size of
17432	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
17433
17434	<note>
17435	If @a shape is 0, only the pointer visibility is changed.
17436	</note>
17437	</desc>
17438	</attribute>
17439	</interface>
17440
17441	<interface
17442	name="IMouseCapabilityChangedEvent" extends="IEvent"
17443	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
17444	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
17445	>
17446	<desc>
17447	Notification when the mouse capabilities reported by the
17448	guest have changed. The new capabilities are passed.
17449	</desc>
17450	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
17451	<desc>
17452	Supports absolute coordinates.
17453	</desc>
17454	</attribute>
17455	<attribute name="supportsRelative" type="boolean" readonly="yes">
17456	<desc>
17457	Supports relative coordinates.
17458	</desc>
17459	</attribute>
17460	<attribute name="needsHostCursor" type="boolean" readonly="yes">
17461	<desc>
17462	If host cursor is needed.
17463	</desc>
17464	</attribute>
17465	</interface>
17466
17467	<interface
17468	name="IKeyboardLedsChangedEvent" extends="IEvent"
17469	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
17470	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
17471	>
17472	<desc>
17473	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
17474	to alter the state of the keyboard LEDs.
17475	</desc>
17476	<attribute name="numLock" type="boolean" readonly="yes">
17477	<desc>
17478	NumLock status.
17479	</desc>
17480	</attribute>
17481	<attribute name="capsLock" type="boolean" readonly="yes">
17482	<desc>
17483	CapsLock status.
17484	</desc>
17485	</attribute>
17486	<attribute name="scrollLock" type="boolean" readonly="yes">
17487	<desc>
17488	ScrollLock status.
17489	</desc>
17490	</attribute>
17491	</interface>
17492
17493	<interface
17494	name="IStateChangedEvent" extends="IEvent"
17495	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
17496	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
17497	>
17498	<desc>
17499	Notification when the execution state of the machine has changed.
17500	The new state is given.
17501	</desc>
17502	<attribute name="state" type="MachineState" readonly="yes">
17503	<desc>
17504	New machine state.
17505	</desc>
17506	</attribute>
17507	</interface>
17508
17509	<interface
17510	name="IAdditionsStateChangedEvent" extends="IEvent"
17511	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
17512	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
17513	>
17514	<desc>
17515	Notification when a Guest Additions property changes.
17516	Interested callees should query IGuest attributes to
17517	find out what has changed.
17518	</desc>
17519	</interface>
17520
17521	<interface
17522	name="INetworkAdapterChangedEvent" extends="IEvent"
17523	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
17524	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
17525	>
17526	<desc>
17527	Notification when a property of one of the
17528	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
17529	changes. Interested callees should use INetworkAdapter methods and
17530	attributes to find out what has changed.
17531	</desc>
17532	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
17533	<desc>
17534	Network adapter that is subject to change.
17535	</desc>
17536	</attribute>
17537	</interface>
17538
17539	<interface
17540	name="ISerialPortChangedEvent" extends="IEvent"
17541	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
17542	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
17543	>
17544	<desc>
17545	Notification when a property of one of the
17546	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
17547	Interested callees should use ISerialPort methods and attributes
17548	to find out what has changed.
17549	</desc>
17550	<attribute name="serialPort" type="ISerialPort" readonly="yes">
17551	<desc>
17552	Serial port that is subject to change.
17553	</desc>
17554	</attribute>
17555	</interface>
17556
17557	<interface
17558	name="IParallelPortChangedEvent" extends="IEvent"
17559	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
17560	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
17561	>
17562	<desc>
17563	Notification when a property of one of the
17564	virtual <link to="IMachine::getParallelPort">parallel ports</link>
17565	changes. Interested callees should use ISerialPort methods and
17566	attributes to find out what has changed.
17567	</desc>
17568	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
17569	<desc>
17570	Parallel port that is subject to change.
17571	</desc>
17572	</attribute>
17573	</interface>
17574
17575	<interface
17576	name="IStorageControllerChangedEvent" extends="IEvent"
17577	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
17578	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
17579	>
17580	<desc>
17581	Notification when a
17582	<link to="IMachine::mediumAttachments">medium attachment</link>
17583	changes.
17584	</desc>
17585	</interface>
17586
17587	<interface
17588	name="IMediumChangedEvent" extends="IEvent"
17589	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
17590	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
17591	>
17592	<desc>
17593	Notification when a
17594	<link to="IMachine::mediumAttachments">medium attachment</link>
17595	changes.
17596	</desc>
17597	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
17598	<desc>
17599	Medium attachment that is subject to change.
17600	</desc>
17601	</attribute>
17602	</interface>
17603
17604	<interface
17605	name="ICPUChangedEvent" extends="IEvent"
17606	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
17607	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
17608	>
17609	<desc>
17610	Notification when a CPU changes.
17611	</desc>
17612	<attribute name="cpu" type="unsigned long" readonly="yes">
17613	<desc>
17614	The CPU which changed.
17615	</desc>
17616	</attribute>
17617	<attribute name="add" type="boolean" readonly="yes">
17618	<desc>
17619	Flag whether the CPU was added or removed.
17620	</desc>
17621	</attribute>
17622	</interface>
17623
17624	<interface
17625	name="ICPUExecutionCapChangedEvent" extends="IEvent"
17626	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
17627	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
17628	>
17629	<desc>
17630	Notification when the CPU execution cap changes.
17631	</desc>
17632	<attribute name="executionCap" type="unsigned long" readonly="yes">
17633	<desc>
17634	The new CPU execution cap value. (1-100)
17635	</desc>
17636	</attribute>
17637	</interface>
17638
17639	<interface
17640	name="IGuestKeyboardEvent" extends="IEvent"
17641	uuid="88394258-7006-40d4-b339-472ee3801844"
17642	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
17643	>
17644	<desc>
17645	Notification when guest keyboard event happens.
17646	</desc>
17647	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
17648	<desc>
17649	Array of scancodes.
17650	</desc>
17651	</attribute>
17652	</interface>
17653
17654	<interface
17655	name="IGuestMouseEvent" extends="IReusableEvent"
17656	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
17657	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
17658	>
17659	<desc>
17660	Notification when guest mouse event happens.
17661	</desc>
17662
17663	<attribute name="absolute" type="boolean" readonly="yes">
17664	<desc>
17665	If this event is relative or absolute.
17666	</desc>
17667	</attribute>
17668
17669	<attribute name="x" type="long" readonly="yes">
17670	<desc>
17671	New X position, or X delta.
17672	</desc>
17673	</attribute>
17674
17675	<attribute name="y" type="long" readonly="yes">
17676	<desc>
17677	New Y position, or Y delta.
17678	</desc>
17679	</attribute>
17680
17681	<attribute name="z" type="long" readonly="yes">
17682	<desc>
17683	Z delta.
17684	</desc>
17685	</attribute>
17686
17687	<attribute name="w" type="long" readonly="yes">
17688	<desc>
17689	W delta.
17690	</desc>
17691	</attribute>
17692
17693	<attribute name="buttons" type="long" readonly="yes">
17694	<desc>
17695	Button state bitmask.
17696	</desc>
17697	</attribute>
17698
17699	</interface>
17700
17701
17702	<interface
17703	name="IVRDEServerChangedEvent" extends="IEvent"
17704	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
17705	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
17706	>
17707	<desc>
17708	Notification when a property of the
17709	<link to="IMachine::VRDEServer">VRDE server</link> changes.
17710	Interested callees should use IVRDEServer methods and attributes to
17711	find out what has changed.
17712	</desc>
17713	</interface>
17714
17715	<interface
17716	name="IVRDEServerInfoChangedEvent" extends="IEvent"
17717	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
17718	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
17719	>
17720	<desc>
17721	Notification when the status of the VRDE server changes. Interested callees
17722	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
17723	attributes to find out what is the current status.
17724	</desc>
17725	</interface>
17726
17727	<interface
17728	name="IUSBControllerChangedEvent" extends="IEvent"
17729	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
17730	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
17731	>
17732	<desc>
17733	Notification when a property of the virtual
17734	<link to="IMachine::USBController">USB controller</link> changes.
17735	Interested callees should use IUSBController methods and attributes to
17736	find out what has changed.
17737	</desc>
17738	</interface>
17739
17740	<interface
17741	name="IUSBDeviceStateChangedEvent" extends="IEvent"
17742	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
17743	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
17744	>
17745	<desc>
17746	Notification when a USB device is attached to or detached from
17747	the virtual USB controller.
17748
17749	This notification is sent as a result of the indirect
17750	request to attach the device because it matches one of the
17751	machine USB filters, or as a result of the direct request
17752	issued by <link to="IConsole::attachUSBDevice"/> or
17753	<link to="IConsole::detachUSBDevice"/>.
17754
17755	This notification is sent in case of both a succeeded and a
17756	failed request completion. When the request succeeds, the
17757	@a error parameter is @c null, and the given device has been
17758	already added to (when @a attached is @c true) or removed from
17759	(when @a attached is @c false) the collection represented by
17760	<link to="IConsole::USBDevices"/>. On failure, the collection
17761	doesn't change and the @a error parameter represents the error
17762	message describing the failure.
17763	</desc>
17764	<attribute name="device" type="IUSBDevice" readonly="yes">
17765	<desc>
17766	Device that is subject to state change.
17767	</desc>
17768	</attribute>
17769	<attribute name="attached" type="boolean" readonly="yes">
17770	<desc>
17771	@c true if the device was attached and @c false otherwise.
17772	</desc>
17773	</attribute>
17774	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
17775	<desc>
17776	@c null on success or an error message object on failure.
17777	</desc>
17778	</attribute>
17779	</interface>
17780
17781	<interface
17782	name="ISharedFolderChangedEvent" extends="IEvent"
17783	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
17784	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
17785	>
17786	<desc>
17787	Notification when a shared folder is added or removed.
17788	The @a scope argument defines one of three scopes:
17789	<link to="IVirtualBox::sharedFolders">global shared folders</link>
17790	(<link to="Scope_Global">Global</link>),
17791	<link to="IMachine::sharedFolders">permanent shared folders</link> of
17792	the machine (<link to="Scope_Machine">Machine</link>) or <link
17793	to="IConsole::sharedFolders">transient shared folders</link> of the
17794	machine (<link to="Scope_Session">Session</link>). Interested callees
17795	should use query the corresponding collections to find out what has
17796	changed.
17797	</desc>
17798	<attribute name="scope" type="Scope" readonly="yes">
17799	<desc>
17800	Scope of the notification.
17801	</desc>
17802	</attribute>
17803	</interface>
17804
17805	<interface
17806	name="IRuntimeErrorEvent" extends="IEvent"
17807	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
17808	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
17809	>
17810	<desc>
17811	Notification when an error happens during the virtual
17812	machine execution.
17813
17814	There are three kinds of runtime errors:
17815	<ul>
17816	<li><i>fatal</i></li>
17817	<li><i>non-fatal with retry</i></li>
17818	<li><i>non-fatal warnings</i></li>
17819	</ul>
17820
17821	<b>Fatal</b> errors are indicated by the @a fatal parameter set
17822	to @c true. In case of fatal errors, the virtual machine
17823	execution is always paused before calling this notification, and
17824	the notification handler is supposed either to immediately save
17825	the virtual machine state using <link to="IConsole::saveState"/>
17826	or power it off using <link to="IConsole::powerDown"/>.
17827	Resuming the execution can lead to unpredictable results.
17828
17829	<b>Non-fatal</b> errors and warnings are indicated by the
17830	@a fatal parameter set to @c false. If the virtual machine
17831	is in the Paused state by the time the error notification is
17832	received, it means that the user can <i>try to resume</i> the machine
17833	execution after attempting to solve the problem that caused the
17834	error. In this case, the notification handler is supposed
17835	to show an appropriate message to the user (depending on the
17836	value of the @a id parameter) that offers several actions such
17837	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
17838	wants to retry, the notification handler should continue
17839	the machine execution using the <link to="IConsole::resume"/>
17840	call. If the machine execution is not Paused during this
17841	notification, then it means this notification is a <i>warning</i>
17842	(for example, about a fatal condition that can happen very soon);
17843	no immediate action is required from the user, the machine
17844	continues its normal execution.
17845
17846	Note that in either case the notification handler
17847	<b>must not</b> perform any action directly on a thread
17848	where this notification is called. Everything it is allowed to
17849	do is to post a message to another thread that will then talk
17850	to the user and take the corresponding action.
17851
17852	Currently, the following error identifiers are known:
17853	<ul>
17854	<li><tt>"HostMemoryLow"</tt></li>
17855	<li><tt>"HostAudioNotResponding"</tt></li>
17856	<li><tt>"VDIStorageFull"</tt></li>
17857	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
17858	</ul>
17859	</desc>
17860	<attribute name="fatal" type="boolean" readonly="yes">
17861	<desc>
17862	Whether the error is fatal or not.
17863	</desc>
17864	</attribute>
17865	<attribute name="id" type="wstring" readonly="yes">
17866	<desc>
17867	Error identifier.
17868	</desc>
17869	</attribute>
17870	<attribute name="message" type="wstring" readonly="yes">
17871	<desc>
17872	Optional error message.
17873	</desc>
17874	</attribute>
17875	</interface>
17876
17877
17878	<interface
17879	name="IEventSourceChangedEvent" extends="IEvent"
17880	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
17881	waitable="yes"
17882	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
17883	>
17884	<desc>
17885	Notification when an event source state changes (listener added or removed).
17886	</desc>
17887
17888	<attribute name="listener" type="IEventListener" readonly="yes">
17889	<desc>
17890	Event listener which has changed.
17891	</desc>
17892	</attribute>
17893
17894	<attribute name="add" type="boolean" readonly="yes">
17895	<desc>
17896	Flag whether listener was added or removed.
17897	</desc>
17898	</attribute>
17899	</interface>
17900
17901	<interface
17902	name="IExtraDataChangedEvent" extends="IEvent"
17903	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
17904	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
17905	>
17906	<desc>
17907	Notification when machine specific or global extra data
17908	has changed.
17909	</desc>
17910	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
17911	<desc>
17912	ID of the machine this event relates to.
17913	Null for global extra data changes.
17914	</desc>
17915	</attribute>
17916	<attribute name="key" type="wstring" readonly="yes">
17917	<desc>
17918	Extra data key that has changed.
17919	</desc>
17920	</attribute>
17921	<attribute name="value" type="wstring" readonly="yes">
17922	<desc>
17923	Extra data value for the given key.
17924	</desc>
17925	</attribute>
17926	</interface>
17927
17928	<interface
17929	name="IVetoEvent" extends="IEvent"
17930	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
17931	wsmap="managed"
17932	>
17933	<desc>Base abstract interface for veto events.</desc>
17934
17935	<method name="addVeto">
17936	<desc>
17937	Adds a veto on this event.
17938	</desc>
17939	<param name="reason" type="wstring" dir="in">
17940	<desc>
17941	Reason for veto, could be null or empty string.
17942	</desc>
17943	</param>
17944	</method>
17945
17946	<method name="isVetoed">
17947	<desc>
17948	If this event was vetoed.
17949	</desc>
17950	<param name="result" type="boolean" dir="return">
17951	<desc>
17952	Reason for veto.
17953	</desc>
17954	</param>
17955	</method>
17956
17957	<method name="getVetos">
17958	<desc>
17959	Current veto reason list, if size is 0 - no veto.
17960	</desc>
17961	<param name="result" type="wstring" dir="return" safearray="yes">
17962	<desc>
17963	Array of reasons for veto provided by different event handlers.
17964	</desc>
17965	</param>
17966	</method>
17967
17968	</interface>
17969
17970	<interface
17971	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
17972	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
17973	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
17974	waitable="true"
17975	>
17976	<desc>
17977	Notification when someone tries to change extra data for
17978	either the given machine or (if @c null) global extra data.
17979	This gives the chance to veto against changes.
17980	</desc>
17981	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
17982	<desc>
17983	ID of the machine this event relates to.
17984	Null for global extra data changes.
17985	</desc>
17986	</attribute>
17987	<attribute name="key" type="wstring" readonly="yes">
17988	<desc>
17989	Extra data key that has changed.
17990	</desc>
17991	</attribute>
17992	<attribute name="value" type="wstring" readonly="yes">
17993	<desc>
17994	Extra data value for the given key.
17995	</desc>
17996	</attribute>
17997	</interface>
17998
17999	<interface
18000	name="ICanShowWindowEvent" extends="IVetoEvent"
18001	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
18002	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
18003	waitable="true"
18004	>
18005	<desc>
18006	Notification when a call to
18007	<link to="IMachine::canShowConsoleWindow"/> is made by a
18008	front-end to check if a subsequent call to
18009	<link to="IMachine::showConsoleWindow"/> can succeed.
18010
18011	The callee should give an answer appropriate to the current
18012	machine state using event veto. This answer must
18013	remain valid at least until the next
18014	<link to="IConsole::state">machine state</link> change.
18015	</desc>
18016	</interface>
18017
18018	<interface
18019	name="IShowWindowEvent" extends="IEvent"
18020	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
18021	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
18022	waitable="true"
18023	>
18024	<desc>
18025	Notification when a call to
18026	<link to="IMachine::showConsoleWindow"/>
18027	requests the console window to be activated and brought to
18028	foreground on the desktop of the host PC.
18029
18030	This notification should cause the VM console process to
18031	perform the requested action as described above. If it is
18032	impossible to do it at a time of this notification, this
18033	method should return a failure.
18034
18035	Note that many modern window managers on many platforms
18036	implement some sort of focus stealing prevention logic, so
18037	that it may be impossible to activate a window without the
18038	help of the currently active application (which is supposedly
18039	an initiator of this notification). In this case, this method
18040	must return a non-zero identifier that represents the
18041	top-level window of the VM console process. The caller, if it
18042	represents a currently active process, is responsible to use
18043	this identifier (in a platform-dependent manner) to perform
18044	actual window activation.
18045
18046	This method must set @a winId to zero if it has performed all
18047	actions necessary to complete the request and the console
18048	window is now active and in foreground, to indicate that no
18049	further action is required on the caller's side.
18050	</desc>
18051	<attribute name="winId" type="long long">
18052	<desc>
18053	Platform-dependent identifier of the top-level VM console
18054	window, or zero if this method has performed all actions
18055	necessary to implement the <i>show window</i> semantics for
18056	the given platform and/or this VirtualBox front-end.
18057	</desc>
18058	</attribute>
18059	</interface>
18060
18061	<interface
18062	name="INATRedirectEvent" extends="IMachineEvent"
18063	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
18064	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
18065	>
18066	<desc>
18067	Notification when NAT redirect rule added or removed.
18068	</desc>
18069	<attribute name="slot" type="unsigned long" readonly="yes">
18070	<desc>
18071	Adapter which NAT attached to.
18072	</desc>
18073	</attribute>
18074	<attribute name="remove" type="boolean" readonly="yes">
18075	<desc>
18076	Whether rule remove or add.
18077	</desc>
18078	</attribute>
18079	<attribute name="name" type="wstring" readonly="yes">
18080	<desc>
18081	Name of the rule.
18082	</desc>
18083	</attribute>
18084	<attribute name="proto" type="NATProtocol" readonly="yes">
18085	<desc>
18086	Protocol (TCP or UDP) of the redirect rule.
18087	</desc>
18088	</attribute>
18089	<attribute name="hostIp" type="wstring" readonly="yes">
18090	<desc>
18091	Host ip address to bind socket on.
18092	</desc>
18093	</attribute>
18094	<attribute name="hostPort" type="long" readonly="yes">
18095	<desc>
18096	Host port to bind socket on.
18097	</desc>
18098	</attribute>
18099	<attribute name="guestIp" type="wstring" readonly="yes">
18100	<desc>
18101	Guest ip address to redirect to.
18102	</desc>
18103	</attribute>
18104	<attribute name="guestPort" type="long" readonly="yes">
18105	<desc>
18106	Guest port to redirect to.
18107	</desc>
18108	</attribute>
18109	</interface>
18110
18111	<interface
18112	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
18113	waitable="yes"
18114	uuid="9cebfc27-c579-4965-8eb7-d31794cd7dcf"
18115	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
18116	>
18117	<desc>
18118	Notification when host PCI device is plugged/unplugged. Plugging
18119	usually takes place on VM startup, unplug - when
18120	<link to="IMachine::detachHostPciDevice"/> is called.
18121
18122	<see><link to="IMachine::detachHostPciDevice"/></see>
18123
18124	</desc>
18125
18126	<attribute name="plugged" type="boolean" readonly="yes">
18127	<desc>
18128	If device successfully plugged or unplugged.
18129	</desc>
18130	</attribute>
18131
18132	<attribute name="success" type="boolean" readonly="yes">
18133	<desc>
18134	If operation was successful, if false - 'message' attribute
18135	may be of interest.
18136	</desc>
18137	</attribute>
18138
18139	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
18140	<desc>
18141	Attachment info for this device.
18142	</desc>
18143	</attribute>
18144
18145	<attribute name="message" type="wstring" readonly="yes">
18146	<desc>
18147	Optional error message.
18148	</desc>
18149	</attribute>
18150
18151	</interface>
18152
18153	<interface
18154	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
18155	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
18156	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
18157	>
18158	<desc>
18159	Notification when VBoxSVC becomes unavailable (due to a crash or similar
18160	unexpected circumstances) or available again.
18161	</desc>
18162
18163	<attribute name="available" type="boolean" readonly="yes">
18164	<desc>
18165	Whether VBoxSVC is available now.
18166	</desc>
18167	</attribute>
18168	</interface>
18169
18170	<interface
18171	name="IBandwidthGroupChangedEvent" extends="IEvent"
18172	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
18173	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
18174	>
18175	<desc>
18176	Notification when one of the bandwidth groups changed
18177	</desc>
18178	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
18179	<desc>
18180	The changed bandwidth group.
18181	</desc>
18182	</attribute>
18183	</interface>
18184
18185	<enum
18186	name="GuestMonitorChangedEventType"
18187	uuid="ef172985-7e36-4297-95be-e46396968d66"
18188	>
18189
18190	<desc>
18191	How the guest monitor has been changed.
18192	</desc>
18193
18194	<const name="Enabled" value="0">
18195	<desc>
18196	The guest monitor has been enabled by the guest.
18197	</desc>
18198	</const>
18199
18200	<const name="Disabled" value="1">
18201	<desc>
18202	The guest monitor has been disabled by the guest.
18203	</desc>
18204	</const>
18205
18206	<const name="NewOrigin" value="2">
18207	<desc>
18208	The guest monitor origin has changed in the guest.
18209	</desc>
18210	</const>
18211	</enum>
18212
18213	<interface
18214	name="IGuestMonitorChangedEvent" extends="IEvent"
18215	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
18216	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
18217	>
18218	<desc>
18219	Notification when the guest enables one of its monitors.
18220	</desc>
18221
18222	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
18223	<desc>
18224	What was changed for this guest monitor.
18225	</desc>
18226	</attribute>
18227
18228	<attribute name="screenId" type="unsigned long" readonly="yes">
18229	<desc>
18230	The monitor which was changed.
18231	</desc>
18232	</attribute>
18233
18234	<attribute name="originX" type="unsigned long" readonly="yes">
18235	<desc>
18236	Physical X origin relative to the primary screen.
18237	Valid for Enabled and NewOrigin.
18238	</desc>
18239	</attribute>
18240
18241	<attribute name="originY" type="unsigned long" readonly="yes">
18242	<desc>
18243	Physical Y origin relative to the primary screen.
18244	Valid for Enabled and NewOrigin.
18245	</desc>
18246	</attribute>
18247
18248	<attribute name="width" type="unsigned long" readonly="yes">
18249	<desc>
18250	Width of the screen.
18251	Valid for Enabled.
18252	</desc>
18253	</attribute>
18254
18255	<attribute name="height" type="unsigned long" readonly="yes">
18256	<desc>
18257	Height of the screen.
18258	Valid for Enabled.
18259	</desc>
18260	</attribute>
18261
18262	</interface>
18263
18264	<interface
18265	name="IStorageDeviceChangedEvent" extends="IEvent"
18266	uuid="8a5c2dce-e341-49d4-afce-c95979f7d70c"
18267	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
18268	>
18269	<desc>
18270	Notification when a
18271	<link to="IMachine::mediumAttachments">storage device</link>
18272	is attached or removed.
18273	</desc>
18274	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
18275	<desc>
18276	Storage device that is subject to change.
18277	</desc>
18278	</attribute>
18279	<attribute name="removed" type="boolean" readonly="yes">
18280	<desc>
18281	Flag whether the device was removed or added to the VM.
18282	</desc>
18283	</attribute>
18284	</interface>
18285
18286	<module name="VBoxSVC" context="LocalServer">
18287	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
18288	namespace="virtualbox.org">
18289	<interface name="IVirtualBox" default="yes"/>
18290	</class>
18291	</module>
18292
18293	<module name="VBoxC" context="InprocServer" threadingModel="Free">
18294	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
18295	namespace="virtualbox.org">
18296	<interface name="IVirtualBoxClient" default="yes"/>
18297	</class>
18298
18299	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
18300	namespace="virtualbox.org">
18301	<interface name="ISession" default="yes"/>
18302	</class>
18303	</module>
18304
18305	</library>
18306
18307	</idl>
18308
18309	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format