VirtualBox.xidl@ 35761

Last change on this file since 35761 was 35761, checked in by vboxsync, 14 years ago
Main, frontends: proper description for maximal number of NICs per VM
Property svn:eol-style set to `native`
File size: 610.0 KB

Line
1	<?xml version="1.0" ?>
2
3	<!--
4
5	Copyright (C) 2006-2011 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI
80	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109	</desc>
110
111	<if target="midl">
112	<cpp line="enum {"/>
113	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
114	<cpp line=" kTypeLibraryMinorVersion = 0"/>
115	<cpp line="};"/>
116	</if>
117
118	<if target="xpidl">
119	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
120	<cpp>
121	/* currently, nsISupportsImpl.h lacks the below-like macros */
122
123	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
124	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
125	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
126	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
127
128
129	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
130	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
131	NS_IMPL_THREADSAFE_ADDREF(_class) \
132	NS_IMPL_THREADSAFE_RELEASE(_class) \
133	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
134	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
135	#endif
136
137	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
138	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
139	NS_IMPL_THREADSAFE_ADDREF(_class) \
140	NS_IMPL_THREADSAFE_RELEASE(_class) \
141	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
142	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
143	#endif
144
145	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
146	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
147	NS_IMPL_THREADSAFE_ADDREF(_class) \
148	NS_IMPL_THREADSAFE_RELEASE(_class) \
149	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
150	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
151	#endif
152
153	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
154	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
155	NS_IMPL_THREADSAFE_ADDREF(_class) \
156	NS_IMPL_THREADSAFE_RELEASE(_class) \
157	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
158	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
159	#endif
160
161	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
162	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
163	NS_INTERFACE_MAP_BEGIN(_class) \
164	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
165	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
166	NS_IMPL_QUERY_CLASSINFO(_class) \
167	NS_INTERFACE_MAP_END
168	#endif
169
170	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
171	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
172	_i2, _ic2) \
173	NS_INTERFACE_MAP_BEGIN(_class) \
174	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
175	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
176	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
177	NS_IMPL_QUERY_CLASSINFO(_class) \
178	NS_INTERFACE_MAP_END
179	#endif
180
181	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
182	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
183	_i2, _ic2, _i3, _ic3) \
184	NS_INTERFACE_MAP_BEGIN(_class) \
185	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
186	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
187	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
188	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
189	NS_IMPL_QUERY_CLASSINFO(_class) \
190	NS_INTERFACE_MAP_END
191	#endif
192
193	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
194	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
195	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
196
197	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
198	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
199	NS_IMPL_THREADSAFE_ADDREF(_class) \
200	NS_IMPL_THREADSAFE_RELEASE(_class) \
201	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
202	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
203	#endif
204
205	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
206	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
207	_i2, _ic2) \
208	NS_IMPL_THREADSAFE_ADDREF(_class) \
209	NS_IMPL_THREADSAFE_RELEASE(_class) \
210	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2) \
212	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
213	#endif
214
215	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
216	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
217	_i2, _ic2, _i3, _ic3) \
218	NS_IMPL_THREADSAFE_ADDREF(_class) \
219	NS_IMPL_THREADSAFE_RELEASE(_class) \
220	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
221	_i2, _ic2, _i3, _ic3) \
222	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
223	#endif
224
225	</cpp>
226	</if>
227
228	<library
229	name="VirtualBox"
230	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
231	version="1.3"
232	desc="VirtualBox Type Library"
233	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
234	supportsErrorInfo="yes"
235	>
236
237
238	<!--
239	// COM result codes for VirtualBox
240	/////////////////////////////////////////////////////////////////////////
241	-->
242
243	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
244	<desc>
245	This section describes all VirtualBox-specific COM result codes that may
246	be returned by methods of VirtualBox COM interfaces in addition to
247	standard COM result codes.
248
249	Note that along with the result code, every VirtualBox method returns
250	extended error information through the IVirtualBoxErrorInfo interface on
251	failure. This interface is a preferred way to present the error to the end
252	user because it contains a human readable description of the error. Raw
253	result codes, both standard and described in this section, are intended to
254	be used by programs to analyze the reason of a failure and select an
255	appropriate course of action without involving the end user (for example,
256	retry the operation later or make a different call).
257
258	The standard COM result codes that may originate from our methods include:
259
260	<table>
261	<tr><td>E_INVALIDARG</td>
262	<td>
263	Returned when the value of the method's argument is not within the range
264	of valid values. This should not be confused with situations when the
265	value is within the range but simply doesn't suit the current object
266	state and there is a possibility that it will be accepted later (in such
267	cases VirtualBox-specific codes are returned, for example,
268	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
269	</td>
270	</tr>
271	<tr><td>E_POINTER</td>
272	<td>
273	Returned if a memory pointer for the output argument is invalid (for
274	example, @c null). Note that when pointers representing input
275	arguments (such 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="Future" value="99999">
484	<desc>Settings version greater than "1.11", written by a future VirtualBox version.</desc>
485	</const>
486	</enum>
487
488	<enum
489	name="AccessMode"
490	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
491	>
492	<desc>
493	Access mode for opening files.
494	</desc>
495
496	<const name="ReadOnly" value="1"/>
497	<const name="ReadWrite" value="2"/>
498	</enum>
499
500	<enum
501	name="MachineState"
502	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
503	>
504	<desc>
505	Virtual machine execution state.
506
507	This enumeration represents possible values of the <link
508	to="IMachine::state"/> attribute.
509
510	Below is the basic virtual machine state diagram. It shows how the state
511	changes during virtual machine execution. The text in square braces shows
512	a method of the IConsole interface that performs the given state
513	transition.
514
515	<pre>
516	+---------[powerDown()] <- Stuck <--[failure]-+
517	V \|
518	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
519	\| \| \| \| V \|
520	\| Aborted -----+ +--> Running --[pause()]--> Paused
521	\| \| ^ \| ^ \|
522	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
523	\| ^ \| \| \| \|
524	\| \| +-----------------------------------------+-\|-------------------+ +
525	\| \| \| \| \|
526	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
527	\| \| \| \|
528	\| +-------- Saving <--------[saveState()]<----------+---------------------+
529	\| \| \|
530	+-------------- Stopping -------[powerDown()]<----------+---------------------+
531	</pre>
532
533	Note that states to the right from PoweredOff, Aborted and Saved in the
534	above diagram are called <i>online VM states</i>. These states
535	represent the virtual machine which is being executed in a dedicated
536	process (usually with a GUI window attached to it where you can see the
537	activity of the virtual machine and interact with it). There are two
538	special pseudo-states, FirstOnline and LastOnline, that can be used in
539	relational expressions to detect if the given machine state is online or
540	not:
541
542	<pre>
543	if (machine.GetState() >= MachineState_FirstOnline &&
544	machine.GetState() <= MachineState_LastOnline)
545	{
546	...the machine is being executed...
547	}
548	</pre>
549
550	When the virtual machine is in one of the online VM states (that is, being
551	executed), only a few machine settings can be modified. Methods working
552	with such settings contain an explicit note about that. An attempt to
553	change any oter setting or perform a modifying operation during this time
554	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
555
556	All online states except Running, Paused and Stuck are transitional: they
557	represent temporary conditions of the virtual machine that will last as
558	long as the operation that initiated such a condition.
559
560	The Stuck state is a special case. It means that execution of the machine
561	has reached the "Guru Meditation" condition. This condition indicates an
562	internal VMM (virtual machine manager) failure which may happen as a
563	result of either an unhandled low-level virtual hardware exception or one
564	of the recompiler exceptions (such as the <i>too-many-traps</i>
565	condition).
566
567	Note also that any online VM state may transit to the Aborted state. This
568	happens if the process that is executing the virtual machine terminates
569	unexpectedly (for example, crashes). Other than that, the Aborted state is
570	equivalent to PoweredOff.
571
572	There are also a few additional state diagrams that do not deal with
573	virtual machine execution and therefore are shown separately. The states
574	shown on these diagrams are called <i>offline VM states</i> (this includes
575	PoweredOff, Aborted and Saved too).
576
577	The first diagram shows what happens when a lengthy setup operation is
578	being executed (such as <link to="IMachine::attachDevice"/>).
579
580	<pre>
581	+----------------------------------(same state as before the call)------+
582	\| \|
583	+-> PoweredOff --+ \|
584	\| \| \|
585	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
586	\| \|
587	+-> Saved -------+
588	</pre>
589
590	The next two diagrams demonstrate the process of taking a snapshot of a
591	powered off virtual machine, restoring the state to that as of a snapshot
592	or deleting a snapshot, respectively.
593
594	<pre>
595	+----------------------------------(same state as before the call)------+
596	\| \|
597	+-> PoweredOff --+ \|
598	\| +-->[takeSnapshot()] -------------------> Saving ------+
599	+-> Aborted -----+
600
601	+-> PoweredOff --+
602	\| \|
603	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
604	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
605	+-> Saved -------+ \|
606	\| \|
607	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
608	</pre>
609
610	Note that the Saving state is present in both the offline state group and
611	online state group. Currently, the only way to determine what group is
612	assumed in a particular case is to remember the previous machine state: if
613	it was Running or Paused, then Saving is an online state, otherwise it is
614	an offline state. This inconsistency may be removed in one of the future
615	versions of VirtualBox by adding a new state.
616
617	<note internal="yes">
618	For whoever decides to touch this enum: In order to keep the
619	comparisons involving FirstOnline and LastOnline pseudo-states valid,
620	the numeric values of these states must be correspondingly updated if
621	needed: for any online VM state, the condition
622	<tt>FirstOnline <= state <= LastOnline</tt> must be
623	@c true. The same relates to transient states for which
624	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
625	@c true.
626	</note>
627	</desc>
628
629	<const name="Null" value="0">
630	<desc>Null value (never used by the API).</desc>
631	</const>
632	<const name="PoweredOff" value="1">
633	<desc>
634	The machine is not running and has no saved execution state; it has
635	either never been started or been shut down successfully.
636	</desc>
637	</const>
638	<const name="Saved" value="2">
639	<desc>
640	The machine is not currently running, but the execution state of the machine
641	has been saved to an external file when it was running, from where
642	it can be resumed.
643	</desc>
644	</const>
645	<const name="Teleported" value="3">
646	<desc>
647	The machine was teleported to a different host (or process) and then
648	powered off. Take care when powering it on again may corrupt resources
649	it shares with the teleportation target (e.g. disk and network).
650	</desc>
651	</const>
652	<const name="Aborted" value="4">
653	<desc>
654	The process running the machine has terminated abnormally. This may
655	indicate a crash of the VM process in host execution context, or
656	the VM process has been terminated externally.
657	</desc>
658	</const>
659	<const name="Running" value="5">
660	<desc>
661	The machine is currently being executed.
662	<note internal="yes">
663	For whoever decides to touch this enum: In order to keep the
664	comparisons in the old source code valid, this state must immediately
665	precede the Paused state.
666	TODO: Lift this spectacularly wonderful restriction.
667	</note>
668	</desc>
669	</const>
670	<const name="Paused" value="6">
671	<desc>
672	Execution of the machine has been paused.
673	<note internal="yes">
674	For whoever decides to touch this enum: In order to keep the
675	comparisons in the old source code valid, this state must immediately
676	follow the Running state.
677	TODO: Lift this spectacularly wonderful restriction.
678	</note>
679	</desc>
680	</const>
681	<const name="Stuck" value="7">
682	<desc>
683	Execution of the machine has reached the "Guru Meditation"
684	condition. This indicates a severe error in the hypervisor itself.
685	<note internal="yes">
686	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
687	"Guru", perhaps? Or are there some other VMM states that are
688	intended to be lumped in here as well?
689	</note>
690	</desc>
691	</const>
692	<const name="Teleporting" value="8">
693	<desc>
694	The machine is about to be teleported to a different host or process.
695	It is possible to pause a machine in this state, but it will go to the
696	@c TeleportingPausedVM state and it will not be
697	possible to resume it again unless the teleportation fails.
698	</desc>
699	</const>
700	<const name="LiveSnapshotting" value="9">
701	<desc>
702	A live snapshot is being taken. The machine is running normally, but
703	some of the runtime configuration options are inaccessible. Also, if
704	paused while in this state it will transition to
705	@c Saving and it will not be resume the
706	execution until the snapshot operation has completed.
707	</desc>
708	</const>
709	<const name="Starting" value="10">
710	<desc>
711	Machine is being started after powering it on from a
712	zero execution state.
713	</desc>
714	</const>
715	<const name="Stopping" value="11">
716	<desc>
717	Machine is being normally stopped powering it off, or after the guest OS
718	has initiated a shutdown sequence.
719	</desc>
720	</const>
721	<const name="Saving" value="12">
722	<desc>
723	Machine is saving its execution state to a file, or an online
724	snapshot of the machine is being taken.
725	</desc>
726	</const>
727	<const name="Restoring" value="13">
728	<desc>
729	Execution state of the machine is being restored from a file
730	after powering it on from the saved execution state.
731	</desc>
732	</const>
733	<const name="TeleportingPausedVM" value="14">
734	<desc>
735	The machine is being teleported to another host or process, but it is
736	not running. This is the paused variant of the
737	@c state.
738	</desc>
739	</const>
740	<const name="TeleportingIn" value="15">
741	<desc>
742	Teleporting the machine state in from another host or process.
743	</desc>
744	</const>
745	<const name="FaultTolerantSyncing" value="16">
746	<desc>
747	The machine is being synced with a fault tolerant VM running elsewhere.
748	</desc>
749	</const>
750	<const name="DeletingSnapshotOnline" value="17">
751	<desc>
752	Like @c DeletingSnapshot, but the merging of media is ongoing in
753	the background while the machine is running.
754	</desc>
755	</const>
756	<const name="DeletingSnapshotPaused" value="18">
757	<desc>
758	Like @c DeletingSnapshotOnline, but the machine was paused when the
759	merging of differencing media was started.
760	</desc>
761	</const>
762	<const name="RestoringSnapshot" value="19">
763	<desc>
764	A machine snapshot is being restored; this typically does not take long.
765	</desc>
766	</const>
767	<const name="DeletingSnapshot" value="20">
768	<desc>
769	A machine snapshot is being deleted; this can take a long time since this
770	may require merging differencing media. This value indicates that the
771	machine is not running while the snapshot is being deleted.
772	</desc>
773	</const>
774	<const name="SettingUp" value="21">
775	<desc>
776	Lengthy setup operation is in progress.
777	</desc>
778	</const>
779
780	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
781	<desc>
782	Pseudo-state: first online state (for use in relational expressions).
783	</desc>
784	</const>
785	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
786	<desc>
787	Pseudo-state: last online state (for use in relational expressions).
788	</desc>
789	</const>
790
791	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
792	<desc>
793	Pseudo-state: first transient state (for use in relational expressions).
794	</desc>
795	</const>
796	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
797	<desc>
798	Pseudo-state: last transient state (for use in relational expressions).
799	</desc>
800	</const>
801
802	</enum>
803
804	<enum
805	name="SessionState"
806	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
807	>
808	<desc>
809	Session state. This enumeration represents possible values of
810	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
811	attributes.
812	</desc>
813
814	<const name="Null" value="0">
815	<desc>Null value (never used by the API).</desc>
816	</const>
817	<const name="Unlocked" value="1">
818	<desc>
819	In <link to="IMachine::sessionState"/>, this means that the machine
820	is not locked for any sessions.
821
822	In <link to="ISession::state"/>, this means that no machine is
823	currently locked for this session.
824	</desc>
825	</const>
826	<const name="Locked" value="2">
827	<desc>
828	In <link to="IMachine::sessionState"/>, this means that the machine
829	is currently locked for a session, whose process identifier can
830	then be found in the <link to="IMachine::sessionPid" /> attribute.
831
832	In <link to="ISession::state"/>, this means that a machine is
833	currently locked for this session, and the mutable machine object
834	can be found in the <link to="ISession::machine"/> attribute
835	(see <link to="IMachine::lockMachine" /> for details).
836	</desc>
837	</const>
838	<const name="Spawning" value="3">
839	<desc>
840	A new process is being spawned for the machine as a result of
841	<link to="IMachine::launchVMProcess"/> call. This state also occurs
842	as a short transient state during an <link to="IMachine::lockMachine"/>
843	call.
844	</desc>
845	</const>
846	<const name="Unlocking" value="4">
847	<desc>
848	The session is being unlocked.
849	</desc>
850	</const>
851	</enum>
852
853	<enum
854	name="CPUPropertyType"
855	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
856	>
857	<desc>
858	Virtual CPU property type. This enumeration represents possible values of the
859	IMachine get- and setCPUProperty methods.
860	</desc>
861	<const name="Null" value="0">
862	<desc>Null value (never used by the API).</desc>
863	</const>
864	<const name="PAE" value="1">
865	<desc>
866	This setting determines whether VirtualBox will expose the Physical Address
867	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
868	is not available, it will not be reported.
869	</desc>
870	</const>
871	<const name="Synthetic" value="2">
872	<desc>
873	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
874	teleporting between host systems that differ significantly.
875	</desc>
876	</const>
877	</enum>
878
879
880	<enum
881	name="HWVirtExPropertyType"
882	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
883	>
884	<desc>
885	Hardware virtualization property type. This enumeration represents possible values
886	for the <link to="IMachine::getHWVirtExProperty"/> and
887	<link to="IMachine::setHWVirtExProperty"/> methods.
888	</desc>
889	<const name="Null" value="0">
890	<desc>Null value (never used by the API).</desc>
891	</const>
892	<const name="Enabled" value="1">
893	<desc>
894	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
895	such extensions are not available, they will not be used.
896	</desc>
897	</const>
898	<const name="Exclusive" value="2">
899	<desc>
900	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
901	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
902	feature of the host. To share these with other hypervisors, you must disable this property.
903	</desc>
904	</const>
905	<const name="VPID" value="3">
906	<desc>
907	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
908	</desc>
909	</const>
910	<const name="NestedPaging" value="4">
911	<desc>
912	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
913	</desc>
914	</const>
915	<const name="LargePages" value="5">
916	<desc>
917	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
918	</desc>
919	</const>
920	<const name="Force" value="6">
921	<desc>
922	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
923	not set, there will be an automatic fallback to software virtualization.
924	</desc>
925	</const>
926	</enum>
927
928	<enum
929	name="FaultToleranceState"
930	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
931	>
932	<desc>
933	Used with <link to="IMachine::faultToleranceState" />.
934	</desc>
935	<const name="Inactive" value="1">
936	<desc>No fault tolerance enabled.</desc>
937	</const>
938	<const name="Master" value="2">
939	<desc>Fault tolerant master VM.</desc>
940	</const>
941	<const name="Standby" value="3">
942	<desc>Fault tolerant standby VM.</desc>
943	</const>
944	</enum>
945
946	<enum
947	name="LockType"
948	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
949	>
950	<desc>
951	Used with <link to="IMachine::lockMachine" />.
952	</desc>
953	<const name="Write" value="2">
954	<desc>Lock the machine for writing.</desc>
955	</const>
956	<const name="Shared" value="1">
957	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
958	</const>
959	</enum>
960
961	<enum
962	name="SessionType"
963	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
964	>
965	<desc>
966	Session type. This enumeration represents possible values of the
967	<link to="ISession::type"/> attribute.
968	</desc>
969
970	<const name="Null" value="0">
971	<desc>Null value (never used by the API).</desc>
972	</const>
973	<const name="WriteLock" value="1">
974	<desc>
975	Session has acquired an exclusive write lock on a machine
976	using <link to="IMachine::lockMachine"/>.
977	</desc>
978	</const>
979	<const name="Remote" value="2">
980	<desc>
981	Session has launched a VM process using
982	<link to="IMachine::launchVMProcess"/>
983	</desc>
984	</const>
985	<const name="Shared" value="3">
986	<desc>
987	Session has obtained a link to another session using
988	<link to="IMachine::lockMachine"/>
989	</desc>
990	</const>
991	</enum>
992
993	<enum
994	name="DeviceType"
995	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
996	>
997	<desc>
998	Device type.
999	</desc>
1000	<const name="Null" value="0">
1001	<desc>
1002	Null value, may also mean "no device" (not allowed for
1003	<link to="IConsole::getDeviceActivity"/>).
1004	</desc>
1005	</const>
1006	<const name="Floppy" value="1">
1007	<desc>Floppy device.</desc>
1008	</const>
1009	<const name="DVD" value="2">
1010	<desc>CD/DVD-ROM device.</desc>
1011	</const>
1012	<const name="HardDisk" value="3">
1013	<desc>Hard disk device.</desc>
1014	</const>
1015	<const name="Network" value="4">
1016	<desc>Network device.</desc>
1017	</const>
1018	<const name="USB" value="5">
1019	<desc>USB device.</desc>
1020	</const>
1021	<const name="SharedFolder" value="6">
1022	<desc>Shared folder device.</desc>
1023	</const>
1024	</enum>
1025
1026	<enum
1027	name="DeviceActivity"
1028	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1029	>
1030	<desc>
1031	Device activity for <link to="IConsole::getDeviceActivity"/>.
1032	</desc>
1033
1034	<const name="Null" value="0"/>
1035	<const name="Idle" value="1"/>
1036	<const name="Reading" value="2"/>
1037	<const name="Writing" value="3"/>
1038	</enum>
1039
1040	<enum
1041	name="ClipboardMode"
1042	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1043	>
1044	<desc>
1045	Host-Guest clipboard interchange mode.
1046	</desc>
1047
1048	<const name="Disabled" value="0"/>
1049	<const name="HostToGuest" value="1"/>
1050	<const name="GuestToHost" value="2"/>
1051	<const name="Bidirectional" value="3"/>
1052	</enum>
1053
1054	<enum
1055	name="Scope"
1056	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1057	>
1058	<desc>
1059	Scope of the operation.
1060
1061	A generic enumeration used in various methods to define the action or
1062	argument scope.
1063	</desc>
1064
1065	<const name="Global" value="0"/>
1066	<const name="Machine" value="1"/>
1067	<const name="Session" value="2"/>
1068	</enum>
1069
1070	<enum
1071	name="BIOSBootMenuMode"
1072	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1073	>
1074	<desc>
1075	BIOS boot menu mode.
1076	</desc>
1077
1078	<const name="Disabled" value="0"/>
1079	<const name="MenuOnly" value="1"/>
1080	<const name="MessageAndMenu" value="2"/>
1081	</enum>
1082
1083	<enum
1084	name="ProcessorFeature"
1085	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1086	>
1087	<desc>
1088	CPU features.
1089	</desc>
1090
1091	<const name="HWVirtEx" value="0"/>
1092	<const name="PAE" value="1"/>
1093	<const name="LongMode" value="2"/>
1094	<const name="NestedPaging" value="3"/>
1095	</enum>
1096
1097	<enum
1098	name="FirmwareType"
1099	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1100	>
1101	<desc>
1102	Firmware type.
1103	</desc>
1104	<const name="BIOS" value="1">
1105	<desc>BIOS Firmware.</desc>
1106	</const>
1107	<const name="EFI" value="2">
1108	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1109	</const>
1110	<const name="EFI32" value="3">
1111	<desc>Efi firmware, 32-bit.</desc>
1112	</const>
1113	<const name="EFI64" value="4">
1114	<desc>Efi firmware, 64-bit.</desc>
1115	</const>
1116	<const name="EFIDUAL" value="5">
1117	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1118	</const>
1119	</enum>
1120
1121	<enum
1122	name="PointingHidType"
1123	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1124	>
1125	<desc>
1126	Type of pointing device used in a virtual machine.
1127	</desc>
1128	<const name="None" value="1">
1129	<desc>No mouse.</desc>
1130	</const>
1131	<const name="PS2Mouse" value="2">
1132	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1133	</const>
1134	<const name="USBMouse" value="3">
1135	<desc>USB mouse (relative pointer).</desc>
1136	</const>
1137	<const name="USBTablet" value="4">
1138	<desc>USB tablet (absolute pointer).</desc>
1139	</const>
1140	<const name="ComboMouse" value="5">
1141	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1142	Using of such device can have negative performance implications. </desc>
1143	</const>
1144	</enum>
1145
1146	<enum
1147	name="KeyboardHidType"
1148	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1149	>
1150	<desc>
1151	Type of keyboard device used in a virtual machine.
1152	</desc>
1153	<const name="None" value="1">
1154	<desc>No keyboard.</desc>
1155	</const>
1156	<const name="PS2Keyboard" value="2">
1157	<desc>PS/2 keyboard.</desc>
1158	</const>
1159	<const name="USBKeyboard" value="3">
1160	<desc>USB keyboard.</desc>
1161	</const>
1162	<const name="ComboKeyboard" value="4">
1163	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1164	Using of such device can have negative performance implications. </desc>
1165	</const>
1166	</enum>
1167
1168	<!--
1169	// IVirtualBoxErrorInfo
1170	/////////////////////////////////////////////////////////////////////////
1171	-->
1172
1173	<interface
1174	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1175	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1176	supportsErrorInfo="no"
1177	wsmap="managed"
1178	>
1179	<desc>
1180	The IVirtualBoxErrorInfo interface represents extended error information.
1181
1182	Extended error information can be set by VirtualBox components after
1183	unsuccessful or partially successful method invocation. This information
1184	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1185	and then shown to the client in addition to the plain 32-bit result code.
1186
1187	In MS COM, this interface extends the IErrorInfo interface,
1188	in XPCOM, it extends the nsIException interface. In both cases,
1189	it provides a set of common attributes to retrieve error
1190	information.
1191
1192	Sometimes invocation of some component's method may involve methods of
1193	other components that may also fail (independently of this method's
1194	failure), or a series of non-fatal errors may precede a fatal error that
1195	causes method failure. In cases like that, it may be desirable to preserve
1196	information about all errors happened during method invocation and deliver
1197	it to the caller. The <link to="#next"/> attribute is intended
1198	specifically for this purpose and allows to represent a chain of errors
1199	through a single IVirtualBoxErrorInfo object set after method invocation.
1200
1201	Note that errors are stored to a chain in the reverse order, i.e. the
1202	initial error object you query right after method invocation is the last
1203	error set by the callee, the object it points to in the @a next attribute
1204	is the previous error and so on, up to the first error (which is the last
1205	in the chain).
1206	</desc>
1207
1208	<attribute name="resultCode" type="long" readonly="yes">
1209	<desc>
1210	Result code of the error.
1211	Usually, it will be the same as the result code returned
1212	by the method that provided this error information, but not
1213	always. For example, on Win32, CoCreateInstance() will most
1214	likely return E_NOINTERFACE upon unsuccessful component
1215	instantiation attempt, but not the value the component factory
1216	returned. Value is typed 'long', not 'result',
1217	to make interface usable from scripting languages.
1218	<note>
1219	In MS COM, there is no equivalent.
1220	In XPCOM, it is the same as nsIException::result.
1221	</note>
1222	</desc>
1223	</attribute>
1224
1225	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1226	<desc>
1227	UUID of the interface that defined the error.
1228	<note>
1229	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1230	data type.
1231	In XPCOM, there is no equivalent.
1232	</note>
1233	</desc>
1234	</attribute>
1235
1236	<attribute name="component" type="wstring" readonly="yes">
1237	<desc>
1238	Name of the component that generated the error.
1239	<note>
1240	In MS COM, it is the same as IErrorInfo::GetSource.
1241	In XPCOM, there is no equivalent.
1242	</note>
1243	</desc>
1244	</attribute>
1245
1246	<attribute name="text" type="wstring" readonly="yes">
1247	<desc>
1248	Text description of the error.
1249	<note>
1250	In MS COM, it is the same as IErrorInfo::GetDescription.
1251	In XPCOM, it is the same as nsIException::message.
1252	</note>
1253	</desc>
1254	</attribute>
1255
1256	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1257	<desc>
1258	Next error object if there is any, or @c null otherwise.
1259	<note>
1260	In MS COM, there is no equivalent.
1261	In XPCOM, it is the same as nsIException::inner.
1262	</note>
1263	</desc>
1264	</attribute>
1265
1266	</interface>
1267
1268	<!--
1269	// IVirtualBox
1270	/////////////////////////////////////////////////////////////////////////
1271	-->
1272
1273	<interface
1274	name="IDHCPServer" extends="$unknown"
1275	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1276	wsmap="managed"
1277	>
1278	<desc>
1279	The IDHCPServer interface represents the vbox dhcp server configuration.
1280
1281	To enumerate all the dhcp servers on the host, use the
1282	<link to="IVirtualBox::DHCPServers"/> attribute.
1283	</desc>
1284
1285	<attribute name="enabled" type="boolean">
1286	<desc>
1287	specifies if the dhcp server is enabled
1288	</desc>
1289	</attribute>
1290
1291	<attribute name="IPAddress" type="wstring" readonly="yes">
1292	<desc>
1293	specifies server IP
1294	</desc>
1295	</attribute>
1296
1297	<attribute name="networkMask" type="wstring" readonly="yes">
1298	<desc>
1299	specifies server network mask
1300	</desc>
1301	</attribute>
1302
1303	<attribute name="networkName" type="wstring" readonly="yes">
1304	<desc>
1305	specifies internal network name the server is used for
1306	</desc>
1307	</attribute>
1308
1309	<attribute name="lowerIP" type="wstring" readonly="yes">
1310	<desc>
1311	specifies from IP address in server address range
1312	</desc>
1313	</attribute>
1314
1315	<attribute name="upperIP" type="wstring" readonly="yes">
1316	<desc>
1317	specifies to IP address in server address range
1318	</desc>
1319	</attribute>
1320
1321	<method name="setConfiguration">
1322	<desc>
1323	configures the server
1324	<result name="E_INVALIDARG">
1325	invalid configuration supplied
1326	</result>
1327	</desc>
1328	<param name="IPAddress" type="wstring" dir="in">
1329	<desc>
1330	server IP address
1331	</desc>
1332	</param>
1333	<param name="networkMask" type="wstring" dir="in">
1334	<desc>
1335	server network mask
1336	</desc>
1337	</param>
1338	<param name="FromIPAddress" type="wstring" dir="in">
1339	<desc>
1340	server From IP address for address range
1341	</desc>
1342	</param>
1343	<param name="ToIPAddress" type="wstring" dir="in">
1344	<desc>
1345	server To IP address for address range
1346	</desc>
1347	</param>
1348	</method>
1349
1350	<method name="start">
1351	<desc>
1352	Starts DHCP server process.
1353	<result name="E_FAIL">
1354	Failed to start the process.
1355	</result>
1356	</desc>
1357	<param name="networkName" type="wstring" dir="in">
1358	<desc>
1359	Name of internal network DHCP server should attach to.
1360	</desc>
1361	</param>
1362	<param name="trunkName" type="wstring" dir="in">
1363	<desc>
1364	Name of internal network trunk.
1365	</desc>
1366	</param>
1367	<param name="trunkType" type="wstring" dir="in">
1368	<desc>
1369	Type of internal network trunk.
1370	</desc>
1371	</param>
1372	</method>
1373
1374	<method name="stop">
1375	<desc>
1376	Stops DHCP server process.
1377	<result name="E_FAIL">
1378	Failed to stop the process.
1379	</result>
1380	</desc>
1381	</method>
1382	</interface>
1383
1384	<interface
1385	name="IVirtualBox" extends="$unknown"
1386	uuid="d2de270c-1d4b-4c9e-843f-bbb9b47269ff"
1387	wsmap="managed"
1388	>
1389	<desc>
1390	The IVirtualBox interface represents the main interface exposed by the
1391	product that provides virtual machine management.
1392
1393	An instance of IVirtualBox is required for the product to do anything
1394	useful. Even though the interface does not expose this, internally,
1395	IVirtualBox is implemented as a singleton and actually lives in the
1396	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1397	IVirtualBox can track the state of all virtual machines on a particular
1398	host, regardless of which frontend started them.
1399
1400	To enumerate all the virtual machines on the host, use the
1401	<link to="IVirtualBox::machines"/> attribute.
1402	</desc>
1403
1404	<attribute name="version" type="wstring" readonly="yes">
1405	<desc>
1406	A string representing the version number of the product. The
1407	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1408	last number represents the build number and will frequently change.
1409	</desc>
1410	</attribute>
1411
1412	<attribute name="revision" type="unsigned long" readonly="yes">
1413	<desc>
1414	The internal build revision number of the product.
1415	</desc>
1416	</attribute>
1417
1418	<attribute name="packageType" type="wstring" readonly="yes">
1419	<desc>
1420	A string representing the package type of this product. The
1421	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1422	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1423	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1424	this.
1425	</desc>
1426	</attribute>
1427
1428	<attribute name="homeFolder" type="wstring" readonly="yes">
1429	<desc>
1430	Full path to the directory where the global settings file,
1431	<tt>VirtualBox.xml</tt>, is stored.
1432
1433	In this version of VirtualBox, the value of this property is
1434	always <tt><user_dir>/.VirtualBox</tt> (where
1435	<tt><user_dir></tt> is the path to the user directory,
1436	as determined by the host OS), and cannot be changed.
1437
1438	This path is also used as the base to resolve relative paths in
1439	places where relative paths are allowed (unless otherwise
1440	expressly indicated).
1441	</desc>
1442	</attribute>
1443
1444	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1445	<desc>
1446	Full name of the global settings file.
1447	The value of this property corresponds to the value of
1448	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1449	</desc>
1450	</attribute>
1451
1452	<attribute name="host" type="IHost" readonly="yes">
1453	<desc>Associated host object.</desc>
1454	</attribute>
1455
1456	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1457	<desc>Associated system information object.</desc>
1458	</attribute>
1459
1460	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1461	<desc>
1462	Array of machine objects registered within this VirtualBox instance.
1463	</desc>
1464	</attribute>
1465
1466	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1467	<desc>
1468	Array of medium objects known to this VirtualBox installation.
1469
1470	This array contains only base media. All differencing
1471	media of the given base medium can be enumerated using
1472	<link to="IMedium::children"/>.
1473	</desc>
1474	</attribute>
1475
1476	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1477	<desc>
1478	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1479	</desc>
1480	</attribute>
1481
1482	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1483	<desc>
1484	Array of floppy image objects currently in use by this VirtualBox instance.
1485	</desc>
1486	</attribute>
1487
1488	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1489
1490	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1491
1492	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1493	<desc>
1494	Collection of global shared folders. Global shared folders are
1495	available to all virtual machines.
1496
1497	New shared folders are added to the collection using
1498	<link to="#createSharedFolder"/>. Existing shared folders can be
1499	removed using <link to="#removeSharedFolder"/>.
1500
1501	<note>
1502	In the current version of the product, global shared folders are not
1503	implemented and therefore this collection is always empty.
1504	</note>
1505	</desc>
1506	</attribute>
1507
1508	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1509	<desc>
1510	Associated performance collector object.
1511	</desc>
1512	</attribute>
1513
1514	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1515	<desc>
1516	DHCP servers.
1517	</desc>
1518	</attribute>
1519
1520	<attribute name="eventSource" type="IEventSource" readonly="yes">
1521	<desc>
1522	Event source for VirtualBox events.
1523	</desc>
1524	</attribute>
1525
1526	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1527	<desc>
1528	The extension pack manager.
1529	</desc>
1530	</attribute>
1531
1532
1533	<method name="composeMachineFilename">
1534	<desc>
1535	Returns a recommended full path of the settings file name for a new virtual
1536	machine.
1537
1538	This API serves two purposes:
1539
1540	<ul>
1541	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1542	for the @a settingsFile argument there, which means that API should use
1543	a recommended default file name.</li>
1544
1545	<li>It can be called manually by a client software before creating a machine,
1546	e.g. if that client wants to pre-create the machine directory to create
1547	virtual hard disks in that directory together with the new machine
1548	settings file. In that case, the file name should be stripped from the
1549	full settings file path returned by this function to obtain the
1550	machine directory.</li>
1551	</ul>
1552
1553	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1554	details about the machine name.
1555
1556	If @a baseFolder is a @c null or empty string (which is recommended), the
1557	default machine settings folder
1558	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1559	a base folder for the created machine, resulting in a file name like
1560	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1561	will be used.
1562
1563	This method does not access the host disks. In particular, it does not check
1564	for whether a machine of this name already exists.
1565	</desc>
1566	<param name="name" type="wstring" dir="in">
1567	<desc>Suggested machine name.</desc>
1568	</param>
1569	<param name="baseFolder" type="wstring" dir="in">
1570	<desc>Base machine folder (optional).</desc>
1571	</param>
1572	<param name="file" type="wstring" dir="return">
1573	<desc>Fully qualified path where the machine would be created.</desc>
1574	</param>
1575	</method>
1576
1577	<method name="createMachine">
1578	<desc>
1579	Creates a new virtual machine by creating a machine settings file at
1580	the given location.
1581
1582	VirtualBox machine settings files use a custom XML dialect. Starting
1583	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1584	and machine files can be created at arbitrary locations.
1585
1586	However, it is is recommended that machines be created in the default
1587	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1588	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1589	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1590	is called automatically to have such a recommended name composed based
1591	on the machine name given in the @a name argument.
1592
1593	If the resulting settings file already exists, this method will fail,
1594	unless @a forceOverwrite is set.
1595
1596	The new machine is created unregistered, with the initial configuration
1597	set according to the specified guest OS type. A typical sequence of
1598	actions to create a new virtual machine is as follows:
1599
1600	<ol>
1601	<li>
1602	Call this method to have a new machine created. The returned machine
1603	object will be "mutable" allowing to change any machine property.
1604	</li>
1605
1606	<li>
1607	Configure the machine using the appropriate attributes and methods.
1608	</li>
1609
1610	<li>
1611	Call <link to="IMachine::saveSettings" /> to write the settings
1612	to the machine's XML settings file. The configuration of the newly
1613	created machine will not be saved to disk until this method is
1614	called.
1615	</li>
1616
1617	<li>
1618	Call <link to="#registerMachine" /> to add the machine to the list
1619	of machines known to VirtualBox.
1620	</li>
1621	</ol>
1622
1623	The specified guest OS type identifier must match an ID of one of known
1624	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1625	array.
1626
1627	Optionally, you may specify an UUID of to assign to the created machine.
1628	However, this is not recommended and you should normally pass an empty
1629	(@c null) UUID to this method so that a new UUID will be automatically
1630	generated for every created machine. You can use UUID
1631	00000000-0000-0000-0000-000000000000 as @c null value.
1632
1633	<note>
1634	There is no way to change the name of the settings file or
1635	subfolder of the created machine directly.
1636	</note>
1637
1638	<result name="VBOX_E_OBJECT_NOT_FOUND">
1639	@a osTypeId is invalid.
1640	</result>
1641	<result name="VBOX_E_FILE_ERROR">
1642	Resulting settings file name is invalid or the settings file already
1643	exists or could not be created due to an I/O error.
1644	</result>
1645	<result name="E_INVALIDARG">
1646	@a name is empty or @c null.
1647	</result>
1648	</desc>
1649
1650	<param name="settingsFile" type="wstring" dir="in">
1651	<desc>Fully qualified path where the settings file should be created,
1652	or NULL for a default folder and file based on the @a name argument
1653	(see <link to="#composeMachineFilename" />).</desc>
1654	</param>
1655	<param name="name" type="wstring" dir="in">
1656	<desc>Machine name.</desc>
1657	</param>
1658	<param name="osTypeId" type="wstring" dir="in">
1659	<desc>Guest OS Type ID.</desc>
1660	</param>
1661	<param name="id" type="uuid" mod="string" dir="in">
1662	<desc>Machine UUID (optional).</desc>
1663	</param>
1664	<param name="forceOverwrite" type="boolean" dir="in">
1665	<desc>If true, an existing machine settings file will be overwritten.</desc>
1666	</param>
1667	<param name="machine" type="IMachine" dir="return">
1668	<desc>Created machine object.</desc>
1669	</param>
1670	</method>
1671
1672	<method name="openMachine">
1673	<desc>
1674	Opens a virtual machine from the existing settings file.
1675	The opened machine remains unregistered until you call
1676	<link to="#registerMachine"/>.
1677
1678	The specified settings file name must be fully qualified.
1679	The file must exist and be a valid machine XML settings file
1680	whose contents will be used to construct the machine object.
1681
1682	<result name="VBOX_E_FILE_ERROR">
1683	Settings file name invalid, not found or sharing violation.
1684	</result>
1685	</desc>
1686	<param name="settingsFile" type="wstring" dir="in">
1687	<desc>
1688	Name of the machine settings file.
1689	</desc>
1690	</param>
1691	<param name="machine" type="IMachine" dir="return">
1692	<desc>Opened machine object.</desc>
1693	</param>
1694	<note>
1695	<link to="IMachine::settingsModified"/> will return
1696	@c false for the created machine, until any of machine settings
1697	are changed.
1698	</note>
1699	</method>
1700
1701	<method name="registerMachine">
1702	<desc>
1703
1704	Registers the machine previously created using
1705	<link to="#createMachine"/> or opened using
1706	<link to="#openMachine"/> within this VirtualBox installation. After
1707	successful method invocation, the
1708	<link to="IMachineRegisteredEvent"/> event is fired.
1709
1710	<note>
1711	This method implicitly calls <link to="IMachine::saveSettings"/>
1712	to save all current machine settings before registering it.
1713	</note>
1714
1715	<result name="VBOX_E_OBJECT_NOT_FOUND">
1716	No matching virtual machine found.
1717	</result>
1718	<result name="VBOX_E_INVALID_OBJECT_STATE">
1719	Virtual machine was not created within this VirtualBox instance.
1720	</result>
1721
1722	</desc>
1723	<param name="machine" type="IMachine" dir="in"/>
1724	</method>
1725
1726	<method name="findMachine">
1727	<desc>
1728	Attempts to find a virtual machine given its name or UUID.
1729
1730	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1731	cannot safely be determined.</note>
1732
1733	<result name="VBOX_E_OBJECT_NOT_FOUND">
1734	Could not find registered machine matching @a nameOrId.
1735	</result>
1736
1737	</desc>
1738	<param name="nameOrId" type="wstring" dir="in">
1739	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1740	</param>
1741	<param name="machine" type="IMachine" dir="return">
1742	<desc>Machine object, if found.</desc>
1743	</param>
1744	</method>
1745
1746	<method name="createAppliance">
1747	<desc>
1748	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1749	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1750	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1751	</desc>
1752	<param name="appliance" type="IAppliance" dir="return">
1753	<desc>New appliance.</desc>
1754	</param>
1755	</method>
1756
1757	<method name="createHardDisk">
1758	<desc>
1759	Creates a new base medium object that will use the given storage
1760	format and location for medium data.
1761
1762	Note that the actual storage unit is not created by this method. In
1763	order to do it, and before you are able to attach the created medium
1764	to virtual machines, you must call one of the following methods to
1765	allocate a format-specific storage unit at the specified location:
1766	<ul>
1767	<li><link to="IMedium::createBaseStorage"/></li>
1768	<li><link to="IMedium::createDiffStorage"/></li>
1769	</ul>
1770
1771	Some medium attributes, such as <link to="IMedium::id"/>, may
1772	remain uninitialized until the medium storage unit is successfully
1773	created by one of the above methods.
1774
1775	After the storage unit is successfully created, it will be
1776	accessible through the <link to="#findMedium"/> method and can
1777	be found in the <link to="#hardDisks"/> array.
1778
1779	The list of all storage formats supported by this VirtualBox
1780	installation can be obtained using
1781	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1782	attribute is empty or @c null then the default storage format
1783	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1784	be used for creating a storage unit of the medium.
1785
1786	Note that the format of the location string is storage format specific.
1787	See <link to="IMedium::location"/> and IMedium for more details.
1788
1789	<result name="VBOX_E_OBJECT_NOT_FOUND">
1790	@a format identifier is invalid. See
1791	<link to="ISystemProperties::mediumFormats"/>.
1792	</result>
1793	<result name="VBOX_E_FILE_ERROR">
1794	@a location is a not valid file name (for file-based formats only).
1795	</result>
1796	</desc>
1797	<param name="format" type="wstring" dir="in">
1798	<desc>
1799	Identifier of the storage format to use for the new medium.
1800	</desc>
1801	</param>
1802	<param name="location" type="wstring" dir="in">
1803	<desc>
1804	Location of the storage unit for the new medium.
1805	</desc>
1806	</param>
1807	<param name="medium" type="IMedium" dir="return">
1808	<desc>Created medium object.</desc>
1809	</param>
1810	</method>
1811
1812	<method name="openMedium">
1813	<desc>
1814	Opens a medium from an existing storage location.
1815
1816	Once a medium has been opened, it can be passed to other VirtualBox
1817	methods, in particular to <link to="IMachine::attachDevice" />.
1818
1819	Depending on the given device type, the file at the storage location
1820	must be in one of the media formats understood by VirtualBox:
1821
1822	<ul>
1823	<li>With a "HardDisk" device type, the file must be a hard disk image
1824	in one of the formats supported by VirtualBox (see
1825	<link to="ISystemProperties::mediumFormats" />).
1826	After this method succeeds, if the medium is a base medium, it
1827	will be added to the <link to="#hardDisks"/> array attribute. </li>
1828	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1829	After this method succeeds, the medium will be added to the
1830	<link to="#DVDImages"/> array attribute.</li>
1831	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1832	After this method succeeds, the medium will be added to the
1833	<link to="#floppyImages"/> array attribute.</li>
1834	</ul>
1835
1836	After having been opened, the medium can be found by the <link to="#findMedium"/>
1837	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1838
1839	The UUID of the newly opened medium will either be retrieved from the
1840	storage location, if the format supports it (e.g. for hard disk images),
1841	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1842	If for some reason you need to change the medium's UUID, use
1843	<link to="IMedium::setIDs" />.
1844
1845	If a differencing hard disk medium is to be opened by this method, the
1846	operation will succeed only if its parent medium and all ancestors,
1847	if any, are already known to this VirtualBox installation (for example,
1848	were opened by this method before).
1849
1850	This method attempts to guess the storage format of the specified medium
1851	by reading medium data at the specified location.
1852
1853	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1854	the image is opened for read/write access and must have according permissions,
1855	as VirtualBox may actually write status information into the disk's metadata
1856	sections.
1857
1858	Note that write access is required for all typical hard disk usage in VirtualBox,
1859	since VirtualBox may need to write metadata such as a UUID into the image.
1860	The only exception is opening a source image temporarily for copying and
1861	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1862	again soon.
1863
1864	The format of the location string is storage format specific. See
1865	<link to="IMedium::location"/> and IMedium for more details.
1866
1867	Prior to VirtualBox 4.0, opening a medium added it to a global media
1868	registry in the VirtualBox.xml file, which was shared between all machines
1869	and made transporting machines and their media from one host to another
1870	difficult.
1871
1872	Starting with VirtualBox 4.0, media are only added to a registry when
1873	they are attached to a machine. Machines created with VirtualBox 4.0
1874	or later can have their own media registry. As a result, a medium attached
1875	to such a machine will be remembered in that machine's XML settings file.
1876	Media attached to older machines will continue to be added to the global
1877	registry.
1878
1879	<result name="VBOX_E_FILE_ERROR">
1880	Invalid medium storage file location or could not find the medium
1881	at the specified location.
1882	</result>
1883	<result name="VBOX_E_IPRT_ERROR">
1884	Could not get medium storage format.
1885	</result>
1886	<result name="E_INVALIDARG">
1887	Invalid medium storage format.
1888	</result>
1889	<result name="VBOX_E_INVALID_OBJECT_STATE">
1890	Medium has already been added to a media registry.
1891	</result>
1892	</desc>
1893	<param name="location" type="wstring" dir="in">
1894	<desc>
1895	Location of the storage unit that contains medium data in one of
1896	the supported storage formats.
1897	</desc>
1898	</param>
1899	<param name="deviceType" type="DeviceType" dir="in">
1900	<desc>
1901	Must be one of "HardDisk", "DVD" or "Floppy".
1902	</desc>
1903	</param>
1904	<param name="accessMode" type="AccessMode" dir="in">
1905	<desc>Whether to open the image in read/write or read-only mode. For
1906	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1907	</param>
1908	<param name="medium" type="IMedium" dir="return">
1909	<desc>Opened medium object.</desc>
1910	</param>
1911	</method>
1912
1913	<method name="findMedium">
1914	<desc>
1915	Returns a medium of the given type that uses the given fully qualified
1916	location or UUID to store medium data.
1917
1918	The given medium must be known to this VirtualBox installation, i.e.
1919	it must be previously created by <link to="#createHardDisk"/> or opened
1920	by <link to="#openMedium"/>.
1921
1922	The search is done by comparing the value of the @a location argument to
1923	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1924	attributes of each known medium.
1925
1926	On case sensitive file systems, a case sensitive comparison is performed,
1927	otherwise the case of symbols in the file path is ignored.
1928
1929	<result name="VBOX_E_OBJECT_NOT_FOUND">
1930	No medium object matching @a location found.
1931	</result>
1932	</desc>
1933	<param name="location" type="wstring" dir="in">
1934	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1935	</param>
1936	<param name="type" type="DeviceType" dir="in">
1937	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1938	</param>
1939	<param name="medium" type="IMedium" dir="return">
1940	<desc>Medium object, if found.</desc>
1941	</param>
1942	</method>
1943
1944	<method name="getGuestOSType">
1945	<desc>
1946	Returns an object describing the specified guest OS type.
1947
1948	The requested guest OS type is specified using a string which is a
1949	mnemonic identifier of the guest operating system, such as
1950	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1951	particular virtual machine can be read or set using the
1952	<link to="IMachine::OSTypeId"/> attribute.
1953
1954	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1955	available guest OS type objects. Each object has an
1956	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1957	the guest OS this object describes.
1958
1959	<result name="E_INVALIDARG">
1960	@a id is not a valid Guest OS type.
1961	</result>
1962
1963	</desc>
1964	<param name="id" type="uuid" mod="string" dir="in">
1965	<desc>Guest OS type ID string.</desc>
1966	</param>
1967	<param name="type" type="IGuestOSType" dir="return">
1968	<desc>Guest OS type object.</desc>
1969	</param>
1970	</method>
1971
1972	<method name="createSharedFolder">
1973	<desc>
1974	Creates a new global shared folder by associating the given logical
1975	name with the given host path, adds it to the collection of shared
1976	folders and starts sharing it. Refer to the description of
1977	<link to="ISharedFolder"/> to read more about logical names.
1978	<note>
1979	In the current implementation, this operation is not
1980	implemented.
1981	</note>
1982	</desc>
1983	<param name="name" type="wstring" dir="in">
1984	<desc>Unique logical name of the shared folder.</desc>
1985	</param>
1986	<param name="hostPath" type="wstring" dir="in">
1987	<desc>Full path to the shared folder in the host file system.</desc>
1988	</param>
1989	<param name="writable" type="boolean" dir="in">
1990	<desc>Whether the share is writable or readonly</desc>
1991	</param>
1992	<param name="automount" type="boolean" dir="in">
1993	<desc>Whether the share gets automatically mounted by the guest
1994	or not.</desc>
1995	</param>
1996	</method>
1997
1998	<method name="removeSharedFolder">
1999	<desc>
2000	Removes the global shared folder with the given name previously
2001	created by <link to="#createSharedFolder"/> from the collection of
2002	shared folders and stops sharing it.
2003	<note>
2004	In the current implementation, this operation is not
2005	implemented.
2006	</note>
2007	</desc>
2008	<param name="name" type="wstring" dir="in">
2009	<desc>Logical name of the shared folder to remove.</desc>
2010	</param>
2011	</method>
2012
2013	<method name="getExtraDataKeys">
2014	<desc>
2015	Returns an array representing the global extra data keys which currently
2016	have values defined.
2017	</desc>
2018	<param name="value" type="wstring" dir="return" safearray="yes">
2019	<desc>Array of extra data keys.</desc>
2020	</param>
2021	</method>
2022
2023	<method name="getExtraData">
2024	<desc>
2025	Returns associated global extra data.
2026
2027	If the requested data @a key does not exist, this function will
2028	succeed and return an empty string in the @a value argument.
2029
2030	<result name="VBOX_E_FILE_ERROR">
2031	Settings file not accessible.
2032	</result>
2033	<result name="VBOX_E_XML_ERROR">
2034	Could not parse the settings file.
2035	</result>
2036
2037	</desc>
2038	<param name="key" type="wstring" dir="in">
2039	<desc>Name of the data key to get.</desc>
2040	</param>
2041	<param name="value" type="wstring" dir="return">
2042	<desc>Value of the requested data key.</desc>
2043	</param>
2044	</method>
2045
2046	<method name="setExtraData">
2047	<desc>
2048	Sets associated global extra data.
2049
2050	If you pass @c null or empty string as a key @a value, the given @a key
2051	will be deleted.
2052
2053	<note>
2054	Before performing the actual data change, this method will ask all
2055	registered event listener using the
2056	<link to="IExtraDataCanChangeEvent"/>
2057	notification for a permission. If one of the listeners refuses the
2058	new value, the change will not be performed.
2059	</note>
2060	<note>
2061	On success, the
2062	<link to="IExtraDataChangedEvent"/> notification
2063	is called to inform all registered listeners about a successful data
2064	change.
2065	</note>
2066
2067	<result name="VBOX_E_FILE_ERROR">
2068	Settings file not accessible.
2069	</result>
2070	<result name="VBOX_E_XML_ERROR">
2071	Could not parse the settings file.
2072	</result>
2073	<result name="E_ACCESSDENIED">
2074	Modification request refused.
2075	</result>
2076
2077	</desc>
2078	<param name="key" type="wstring" dir="in">
2079	<desc>Name of the data key to set.</desc>
2080	</param>
2081	<param name="value" type="wstring" dir="in">
2082	<desc>Value to assign to the key.</desc>
2083	</param>
2084	</method>
2085
2086	<!--method name="createDHCPServerForInterface">
2087	<desc>
2088	Creates a dhcp server settings to be used for the given interface
2089	<result name="E_INVALIDARG">
2090	Host network interface @a name already exists.
2091	</result>
2092	</desc>
2093	<param name="interface" type="IHostNetworkInterface" dir="in">
2094	<desc>Network Interface</desc>
2095	</param>
2096	<param name="server" type="IDHCPServer" dir="out">
2097	<desc>Dhcp server settings</desc>
2098	</param>
2099	</method-->
2100
2101	<method name="createDHCPServer">
2102	<desc>
2103	Creates a dhcp server settings to be used for the given internal network name
2104	<result name="E_INVALIDARG">
2105	Host network interface @a name already exists.
2106	</result>
2107	</desc>
2108	<param name="name" type="wstring" dir="in">
2109	<desc>server name</desc>
2110	</param>
2111	<param name="server" type="IDHCPServer" dir="return">
2112	<desc>Dhcp server settings</desc>
2113	</param>
2114	</method>
2115
2116	<method name="findDHCPServerByNetworkName">
2117	<desc>
2118	Searches a dhcp server settings to be used for the given internal network name
2119	<result name="E_INVALIDARG">
2120	Host network interface @a name already exists.
2121	</result>
2122
2123	</desc>
2124	<param name="name" type="wstring" dir="in">
2125	<desc>server name</desc>
2126	</param>
2127	<param name="server" type="IDHCPServer" dir="return">
2128	<desc>Dhcp server settings</desc>
2129	</param>
2130	</method>
2131
2132	<!--method name="findDHCPServerForInterface">
2133	<desc>
2134	Searches a dhcp server settings to be used for the given interface
2135	<result name="E_INVALIDARG">
2136	Host network interface @a name already exists.
2137	</result>
2138	</desc>
2139	<param name="interface" type="IHostNetworkInterface" dir="in">
2140	<desc>Network Interface</desc>
2141	</param>
2142	<param name="server" type="IDHCPServer" dir="out">
2143	<desc>Dhcp server settings</desc>
2144	</param>
2145	</method-->
2146
2147	<method name="removeDHCPServer">
2148	<desc>
2149	Removes the dhcp server settings
2150	<result name="E_INVALIDARG">
2151	Host network interface @a name already exists.
2152	</result>
2153	</desc>
2154	<param name="server" type="IDHCPServer" dir="in">
2155	<desc>Dhcp server settings to be removed</desc>
2156	</param>
2157	</method>
2158
2159
2160	<method name="checkFirmwarePresent">
2161	<desc>
2162	Check if this VirtualBox installation has a firmware
2163	of the given type available, either system-wide or per-user.
2164	Optionally, this may return a hint where this firmware can be
2165	downloaded from.
2166	</desc>
2167	<param name="firmwareType" type="FirmwareType" dir="in">
2168	<desc>
2169	Type of firmware to check.
2170	</desc>
2171	</param>
2172	<param name="version" type="wstring" dir="in">
2173	<desc>Expected version number, usually empty string (presently ignored).</desc>
2174	</param>
2175
2176	<param name="url" type="wstring" dir="out">
2177	<desc>
2178	Suggested URL to download this firmware from.
2179	</desc>
2180	</param>
2181
2182	<param name="file" type="wstring" dir="out">
2183	<desc>
2184	Filename of firmware, only valid if result == TRUE.
2185	</desc>
2186	</param>
2187
2188	<param name="result" type="boolean" dir="return">
2189	<desc>If firmware of this type and version is available.</desc>
2190	</param>
2191	</method>
2192
2193	</interface>
2194
2195	<!--
2196	// IVFSExplorer
2197	/////////////////////////////////////////////////////////////////////////
2198	-->
2199
2200	<enum
2201	name="VFSType"
2202	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2203	>
2204	<desc>
2205	Virtual file systems supported by VFSExplorer.
2206	</desc>
2207
2208	<const name="File" value="1" />
2209	<const name="Cloud" value="2" />
2210	<const name="S3" value="3" />
2211	<const name="WebDav" value="4" />
2212	</enum>
2213
2214	<enum
2215	name="VFSFileType"
2216	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2217	>
2218	<desc>
2219	File types known by VFSExplorer.
2220	</desc>
2221
2222	<const name="Unknown" value="1" />
2223	<const name="Fifo" value="2" />
2224	<const name="DevChar" value="3" />
2225	<const name="Directory" value="4" />
2226	<const name="DevBlock" value="5" />
2227	<const name="File" value="6" />
2228	<const name="SymLink" value="7" />
2229	<const name="Socket" value="8" />
2230	<const name="WhiteOut" value="9" />
2231	</enum>
2232
2233	<interface
2234	name="IVFSExplorer" extends="$unknown"
2235	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2236	wsmap="managed"
2237	>
2238	<desc>
2239	The VFSExplorer interface unifies access to different file system
2240	types. This includes local file systems as well remote file systems like
2241	S3. For a list of supported types see <link to="VFSType" />.
2242	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2243	</desc>
2244
2245	<attribute name="path" type="wstring" readonly="yes">
2246	<desc>Returns the current path in the virtual file system.</desc>
2247	</attribute>
2248
2249	<attribute name="type" type="VFSType" readonly="yes">
2250	<desc>Returns the file system type which is currently in use.</desc>
2251	</attribute>
2252
2253	<method name="update">
2254	<desc>Updates the internal list of files/directories from the
2255	current directory level. Use <link to="#entryList" /> to get the full list
2256	after a call to this method.</desc>
2257
2258	<param name="aProgress" type="IProgress" dir="return">
2259	<desc>Progress object to track the operation completion.</desc>
2260	</param>
2261	</method>
2262
2263	<method name="cd">
2264	<desc>Change the current directory level.</desc>
2265
2266	<param name="aDir" type="wstring" dir="in">
2267	<desc>The name of the directory to go in.</desc>
2268	</param>
2269
2270	<param name="aProgress" type="IProgress" dir="return">
2271	<desc>Progress object to track the operation completion.</desc>
2272	</param>
2273	</method>
2274
2275	<method name="cdUp">
2276	<desc>Go one directory upwards from the current directory level.</desc>
2277
2278	<param name="aProgress" type="IProgress" dir="return">
2279	<desc>Progress object to track the operation completion.</desc>
2280	</param>
2281	</method>
2282
2283	<method name="entryList">
2284	<desc>Returns a list of files/directories after a call to <link
2285	to="#update" />. The user is responsible for keeping this internal
2286	list up do date.</desc>
2287
2288	<param name="aNames" type="wstring" safearray="yes" dir="out">
2289	<desc>The list of names for the entries.</desc>
2290	</param>
2291
2292	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2293	<desc>The list of types for the entries.</desc>
2294	</param>
2295
2296	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2297	<desc>The list of sizes (in bytes) for the entries.</desc>
2298	</param>
2299
2300	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2301	<desc>The list of file modes (in octal form) for the entries.</desc>
2302	</param>
2303	</method>
2304
2305	<method name="exists">
2306	<desc>Checks if the given file list exists in the current directory
2307	level.</desc>
2308
2309	<param name="aNames" type="wstring" safearray="yes" dir="in">
2310	<desc>The names to check.</desc>
2311	</param>
2312
2313	<param name="aExists" type="wstring" safearray="yes" dir="return">
2314	<desc>The names which exist.</desc>
2315	</param>
2316	</method>
2317
2318	<method name="remove">
2319	<desc>Deletes the given files in the current directory level.</desc>
2320
2321	<param name="aNames" type="wstring" safearray="yes" dir="in">
2322	<desc>The names to remove.</desc>
2323	</param>
2324
2325	<param name="aProgress" type="IProgress" dir="return">
2326	<desc>Progress object to track the operation completion.</desc>
2327	</param>
2328	</method>
2329
2330	</interface>
2331
2332	<!--
2333	// IAppliance
2334	/////////////////////////////////////////////////////////////////////////
2335	-->
2336
2337	<interface
2338	name="IAppliance" extends="$unknown"
2339	uuid="7b148032-4124-4f46-b56a-b48ac1273f5a"
2340	wsmap="managed"
2341	>
2342	<desc>
2343	Represents a platform-independent appliance in OVF format. An instance of this is returned
2344	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2345	virtual machines within an appliance with VirtualBox.
2346
2347	The OVF standard suggests two different physical file formats:
2348
2349	<ol>
2350	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2351	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2352	this descriptor file references other files such as disk images, as OVF appliances typically
2353	do, those additional files must be in the same directory as the descriptor file.</li>
2354
2355	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2356	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2357	files and optionally other files.
2358
2359	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2360	be added with a later version.</li>
2361	</ol>
2362
2363	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2364	<link to="IMachine" /> involves the following sequence of API calls:
2365
2366	<ol>
2367	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2368	</li>
2369
2370	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2371	would like to import. So long as this file is syntactically valid, this will succeed
2372	and fill the appliance object with the parsed data from the OVF file.
2373	</li>
2374
2375	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2376	contents of the IAppliance attributes accordingly. These can be inspected by a
2377	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2378	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2379	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2380	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2381	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2382	The GUI can then give the user the option to confirm and/or change these suggestions.
2383	</li>
2384
2385	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2386	virtual system (machine) to override the suggestions made by the interpret() routine.
2387	</li>
2388
2389	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2390	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2391	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2392	can be found in the <link to="#machines" /> array attribute.
2393	</li>
2394	</ol>
2395
2396	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2397
2398	<ol>
2399	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2400	an empty IAppliance object.
2401	</li>
2402
2403	<li>For each machine you would like to export, call <link to="IMachine::export" />
2404	with the IAppliance object you just created. Each such call creates one instance of
2405	<link to="IVirtualSystemDescription" /> inside the appliance.
2406	</li>
2407
2408	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2409	virtual system (machine) to override the suggestions made by the export() routine.
2410	</li>
2411
2412	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2413	file written.</li>
2414	</ol>
2415
2416	</desc>
2417
2418	<attribute name="path" type="wstring" readonly="yes">
2419	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2420	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2421	<link to="#write" /> (for export).
2422	This attribute is empty until one of these methods has been called.
2423	</desc>
2424	</attribute>
2425
2426	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2427	<desc>
2428	Array of virtual disk definitions. One such description exists for each
2429	disk definition in the OVF; each string array item represents one such piece of
2430	disk information, with the information fields separated by tab (\t) characters.
2431
2432	The caller should be prepared for additional fields being appended to
2433	this string in future versions of VirtualBox and therefore check for
2434	the number of tabs in the strings returned.
2435
2436	In the current version, the following eight fields are returned per string
2437	in the array:
2438
2439	<ol>
2440	<li>Disk ID (unique string identifier given to disk)</li>
2441
2442	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2443
2444	<li>Populated size (optional unsigned integer indicating the current size of the
2445	disk; can be approximate; -1 if unspecified)</li>
2446
2447	<li>Format (string identifying the disk format, typically
2448	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2449
2450	<li>Reference (where to find the disk image, typically a file name; if empty,
2451	then the disk should be created on import)</li>
2452
2453	<li>Image size (optional unsigned integer indicating the size of the image,
2454	which need not necessarily be the same as the values specified above, since
2455	the image may be compressed or sparse; -1 if not specified)</li>
2456
2457	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2458	presently unsupported and always -1)</li>
2459
2460	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2461	</ol>
2462	</desc>
2463	</attribute>
2464
2465	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2466	<desc> Array of virtual system descriptions. One such description is created
2467	for each virtual system (machine) found in the OVF.
2468	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2469	(for export) has been called.
2470	</desc>
2471	</attribute>
2472
2473	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2474	<desc>
2475	Contains the UUIDs of the machines created from the information in this appliances. This is only
2476	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2477	succeeded.
2478	</desc>
2479	</attribute>
2480
2481	<method name="read">
2482	<desc>
2483	Reads an OVF file into the appliance object.
2484
2485	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2486	mere fact that this method returns successfully does not mean that VirtualBox supports all
2487	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2488	</desc>
2489	<param name="file" type="wstring" dir="in">
2490	<desc>
2491	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2492	on whether the appliance is distributed as a set of files or as a single file, respectively).
2493	</desc>
2494	</param>
2495	<param name="aProgress" type="IProgress" dir="return">
2496	<desc>Progress object to track the operation completion.</desc>
2497	</param>
2498	</method>
2499
2500	<method name="interpret">
2501	<desc>
2502	Interprets the OVF data that was read when the appliance was constructed. After
2503	calling this method, one can inspect the
2504	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2505	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2506	the appliance.
2507
2508	Calling this method is the second step of importing an appliance into VirtualBox;
2509	see <link to="IAppliance" /> for an overview.
2510
2511	After calling this method, one should call <link to="#getWarnings" /> to find out
2512	if problems were encountered during the processing which might later lead to
2513	errors.
2514	</desc>
2515	</method>
2516
2517	<method name="importMachines">
2518	<desc>
2519	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2520	and other interfaces that match the information contained in the appliance as
2521	closely as possible, as represented by the import instructions in the
2522	<link to="#virtualSystemDescriptions" /> array.
2523
2524	Calling this method is the final step of importing an appliance into VirtualBox;
2525	see <link to="IAppliance" /> for an overview.
2526
2527	Since importing the appliance will most probably involve copying and converting
2528	disk images, which can take a long time, this method operates asynchronously and
2529	returns an IProgress object to allow the caller to monitor the progress.
2530
2531	After the import succeeded, the UUIDs of the IMachine instances created can be
2532	retrieved from the <link to="#machines" /> array attribute.
2533	</desc>
2534
2535	<param name="aProgress" type="IProgress" dir="return">
2536	<desc>Progress object to track the operation completion.</desc>
2537	</param>
2538	</method>
2539
2540	<method name="createVFSExplorer">
2541	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2542
2543	<param name="aUri" type="wstring" dir="in">
2544	<desc>The URI describing the file system to use.</desc>
2545	</param>
2546
2547	<param name="aExplorer" type="IVFSExplorer" dir="return">
2548	<desc></desc>
2549	</param>
2550	</method>
2551
2552	<method name="write">
2553	<desc>
2554	Writes the contents of the appliance exports into a new OVF file.
2555
2556	Calling this method is the final step of exporting an appliance from VirtualBox;
2557	see <link to="IAppliance" /> for an overview.
2558
2559	Since exporting the appliance will most probably involve copying and converting
2560	disk images, which can take a long time, this method operates asynchronously and
2561	returns an IProgress object to allow the caller to monitor the progress.
2562	</desc>
2563	<param name="format" type="wstring" dir="in">
2564	<desc>
2565	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2566	future versions of VirtualBox may support additional formats.
2567	</desc>
2568	</param>
2569	<param name="manifest" type="boolean" dir="in">
2570	<desc>
2571	Indicate if the optional manifest file (.mf) should be written. The manifest file
2572	is used for integrity checks prior import.
2573	</desc>
2574	</param>
2575	<param name="path" type="wstring" dir="in">
2576	<desc>
2577	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2578	on whether the appliance is distributed as a set of files or as a single file, respectively).
2579	</desc>
2580	</param>
2581	<param name="progress" type="IProgress" dir="return">
2582	<desc>Progress object to track the operation completion.</desc>
2583	</param>
2584	</method>
2585
2586	<method name="getWarnings">
2587	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2588
2589	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2590	<desc></desc>
2591	</param>
2592	</method>
2593
2594	</interface>
2595
2596	<enum
2597	name="VirtualSystemDescriptionType"
2598	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
2599	>
2600	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2601	a configuration value.</desc>
2602
2603	<const name="Ignore" value="1" />
2604	<const name="OS" value="2" />
2605	<const name="Name" value="3" />
2606	<const name="Product" value="4" />
2607	<const name="Vendor" value="5" />
2608	<const name="Version" value="6" />
2609	<const name="ProductUrl" value="7" />
2610	<const name="VendorUrl" value="8" />
2611	<const name="Description" value="9" />
2612	<const name="License" value="10" />
2613	<const name="Miscellaneous" value="11" />
2614	<const name="CPU" value="12" />
2615	<const name="Memory" value="13" />
2616	<const name="HardDiskControllerIDE" value="14" />
2617	<const name="HardDiskControllerSATA" value="15" />
2618	<const name="HardDiskControllerSCSI" value="16" />
2619	<const name="HardDiskControllerSAS" value="17" />
2620	<const name="HardDiskImage" value="18" />
2621	<const name="Floppy" value="19" />
2622	<const name="CDROM" value="20" />
2623	<const name="NetworkAdapter" value="21" />
2624	<const name="USBController" value="22" />
2625	<const name="SoundCard" value="23" />
2626
2627	</enum>
2628
2629	<enum
2630	name="VirtualSystemDescriptionValueType"
2631	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2632	>
2633	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2634	type to fetch.</desc>
2635
2636	<const name="Reference" value="1" />
2637	<const name="Original" value="2" />
2638	<const name="Auto" value="3" />
2639	<const name="ExtraConfig" value="4" />
2640
2641	</enum>
2642
2643	<interface
2644	name="IVirtualSystemDescription" extends="$unknown"
2645	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2646	wsmap="managed"
2647	>
2648
2649	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2650	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2651	<link to="IAppliance::interpret" /> has been called, that array contains information
2652	about how the virtual systems described in the OVF should best be imported into
2653	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2654	import an OVF into VirtualBox.
2655	</desc>
2656
2657	<attribute name="count" type="unsigned long" readonly="yes">
2658	<desc>Return the number of virtual system description entries.</desc>
2659	</attribute>
2660
2661	<method name="getDescription">
2662	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2663	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2664
2665	The list below identifies the value sets that are possible depending on the
2666	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2667	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2668	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2669	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2670	the @a aExtraConfigValues[] array item may also be used.
2671
2672	<ul>
2673	<li>
2674	"OS": the guest operating system type. There must be exactly one such array item on import. The
2675	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2676	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2677	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2678	</li>
2679	<li>
2680	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2681	if none is present on import, then an automatic name will be created from the operating system
2682	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2683	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2684	<link to="IMachine" /> name that does not exist yet.
2685	</li>
2686	<li>
2687	"Description": an arbitrary description.
2688	</li>
2689	<li>
2690	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2691	code to display such a license for agreement; the Main API does not enforce any such policy.
2692	</li>
2693	<li>
2694	Miscellaneous: reserved for future use.
2695	</li>
2696	<li>
2697	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2698	</li>
2699	<li>
2700	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2701	is present on import, then VirtualBox will set a meaningful default based on the operating system
2702	type.
2703	</li>
2704	<li>
2705	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2706	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2707	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2708	writes into the OVF.
2709	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2710	type can use to specify which hard disk controller a virtual disk should be connected to.
2711	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2712	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2713	its virtual machines supports four channels (primary master, primary slave, secondary master,
2714	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2715	</li>
2716	<li>
2717	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2718	has no value in @a aOvfValues[] or @a aVBoxValues[].
2719	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2720	</li>
2721	<li>
2722	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2723	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2724	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2725	whereas VirtualBox considers it a class of storage controllers of its own; see
2726	<link to="StorageControllerType" />).
2727	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2728	</li>
2729	<li>
2730	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2731	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2732
2733	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2734	a path since the image file should be in the same location as the OVF file itself), whereas the
2735	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2736	hard disk image. This means that on import the image will be copied and converted from the
2737	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2738
2739	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2740	format: "controller=<index>;channel=<c>"
2741	In this string, <index> must be an integer specifying the hard disk controller to connect
2742	the image to. That number must be the index of an array item with one of the hard disk controller
2743	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2744	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2745	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2746	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2747	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2748	</li>
2749	<li>
2750	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2751	attachment information as with "HardDiskImage" items.
2752	</li>
2753	<li>
2754	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2755	attachment information as with "HardDiskImage" items.
2756	</li>
2757	<li>
2758	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2759	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2760	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2761	</li>
2762	<li>
2763	"USBController": a USB controller. There can be at most one such item. If and only if such an
2764	item ispresent, USB support will be enabled for the new virtual machine.
2765	</li>
2766	<li>
2767	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2768	present, sound support will be enabled for the new virtual machine. Note that the virtual
2769	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2770	may be different from the virtual soundcard expected by the appliance.
2771	</li>
2772	</ul>
2773
2774	</desc>
2775
2776	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2777	<desc></desc>
2778	</param>
2779
2780	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2781	<desc></desc>
2782	</param>
2783
2784	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2785	<desc></desc>
2786	</param>
2787
2788	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2789	<desc></desc>
2790	</param>
2791
2792	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2793	<desc></desc>
2794	</param>
2795
2796	</method>
2797
2798	<method name="getDescriptionByType">
2799	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2800	should be returned.</desc>
2801
2802	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2803	<desc></desc>
2804	</param>
2805
2806	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2807	<desc></desc>
2808	</param>
2809
2810	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2811	<desc></desc>
2812	</param>
2813
2814	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2815	<desc></desc>
2816	</param>
2817
2818	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2819	<desc></desc>
2820	</param>
2821
2822	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2823	<desc></desc>
2824	</param>
2825
2826	</method>
2827
2828	<method name="getValuesByType">
2829	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2830	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2831	values.</desc>
2832
2833	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2834	<desc></desc>
2835	</param>
2836
2837	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2838	<desc></desc>
2839	</param>
2840
2841	<param name="aValues" type="wstring" dir="return" safearray="yes">
2842	<desc></desc>
2843	</param>
2844
2845	</method>
2846
2847	<method name="setFinalValues">
2848	<desc>
2849	This method allows the appliance's user to change the configuration for the virtual
2850	system descriptions. For each array item returned from <link to="#getDescription" />,
2851	you must pass in one boolean value and one configuration value.
2852
2853	Each item in the boolean array determines whether the particular configuration item
2854	should be enabled.
2855	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2856	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2857	and SoundCard.
2858
2859	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2860	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
2861	the configuration remains unchanged. Please see the documentation for getDescription()
2862	for valid configuration values for the individual array item types. If the
2863	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2864	</desc>
2865
2866	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2867	<desc></desc>
2868	</param>
2869
2870	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2871	<desc></desc>
2872	</param>
2873
2874	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2875	<desc></desc>
2876	</param>
2877	</method>
2878
2879	<method name="addDescription">
2880	<desc>
2881	This method adds an additional description entry to the stack of already
2882	available descriptions for this virtual system. This is handy for writing
2883	values which aren't directly supported by VirtualBox. One example would
2884	be the License type of <link to="VirtualSystemDescriptionType" />.
2885	</desc>
2886
2887	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2888	<desc></desc>
2889	</param>
2890
2891	<param name="aVBoxValue" type="wstring" dir="in">
2892	<desc></desc>
2893	</param>
2894
2895	<param name="aExtraConfigValue" type="wstring" dir="in">
2896	<desc></desc>
2897	</param>
2898	</method>
2899	</interface>
2900
2901
2902	<!--
2903	// IMachine
2904	/////////////////////////////////////////////////////////////////////////
2905	-->
2906
2907	<interface
2908	name="IInternalMachineControl" extends="$unknown"
2909	uuid="8e723ab0-812c-5662-dd8e-7ebc89637acf"
2910	internal="yes"
2911	wsmap="suppress"
2912	>
2913	<method name="setRemoveSavedStateFile">
2914	<desc>
2915	Updates the flag whether the saved state file is removed on a
2916	machine state change from Saved to PoweredOff.
2917	</desc>
2918	<param name="aRemove" type="boolean" dir="in"/>
2919	</method>
2920
2921	<method name="updateState">
2922	<desc>
2923	Updates the VM state.
2924	<note>
2925	This operation will also update the settings file with the correct
2926	information about the saved state file and delete this file from disk
2927	when appropriate.
2928	</note>
2929	</desc>
2930	<param name="state" type="MachineState" dir="in"/>
2931	</method>
2932
2933	<method name="getIPCId">
2934	<param name="id" type="wstring" dir="return"/>
2935	</method>
2936
2937	<method name="beginPowerUp">
2938	<desc>
2939	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2940	gives it the progress object that should be part of any pending
2941	<link to="IMachine::launchVMProcess"/> operations. The progress
2942	object may be called back to reflect an early cancelation, so some care
2943	have to be taken with respect to any cancelation callbacks. The console
2944	object will call <link to="IInternalMachineControl::endPowerUp"/>
2945	to signal the completion of the progress object.
2946	</desc>
2947	<param name="aProgress" type="IProgress" dir="in" />
2948	</method>
2949
2950	<method name="endPowerUp">
2951	<desc>
2952	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
2953	This method may query status information from the progress object it
2954	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
2955	it over to any in-progress <link to="IMachine::launchVMProcess"/>
2956	call in order to complete that progress object.
2957	</desc>
2958	<param name="result" type="long" dir="in"/>
2959	</method>
2960
2961	<method name="beginPoweringDown">
2962	<desc>
2963	Called by the VM process to inform the server it wants to
2964	stop the VM execution and power down.
2965	</desc>
2966	<param name="progress" type="IProgress" dir="out">
2967	<desc>
2968	Progress object created by VBoxSVC to wait until
2969	the VM is powered down.
2970	</desc>
2971	</param>
2972	</method>
2973
2974	<method name="endPoweringDown">
2975	<desc>
2976	Called by the VM process to inform the server that powering
2977	down previously requested by #beginPoweringDown is either
2978	successfully finished or there was a failure.
2979
2980	<result name="VBOX_E_FILE_ERROR">
2981	Settings file not accessible.
2982	</result>
2983	<result name="VBOX_E_XML_ERROR">
2984	Could not parse the settings file.
2985	</result>
2986
2987	</desc>
2988
2989	<param name="result" type="long" dir="in">
2990	<desc>@c S_OK to indicate success.
2991	</desc>
2992	</param>
2993	<param name="errMsg" type="wstring" dir="in">
2994	<desc>@c human readable error message in case of failure.
2995	</desc>
2996	</param>
2997	</method>
2998
2999	<method name="runUSBDeviceFilters">
3000	<desc>
3001	Asks the server to run USB devices filters of the associated
3002	machine against the given USB device and tell if there is
3003	a match.
3004	<note>
3005	Intended to be used only for remote USB devices. Local
3006	ones don't require to call this method (this is done
3007	implicitly by the Host and USBProxyService).
3008	</note>
3009	</desc>
3010	<param name="device" type="IUSBDevice" dir="in"/>
3011	<param name="matched" type="boolean" dir="out"/>
3012	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3013	</method>
3014
3015	<method name="captureUSBDevice">
3016	<desc>
3017	Requests a capture of the given host USB device.
3018	When the request is completed, the VM process will
3019	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3020	notification.
3021	</desc>
3022	<param name="id" type="uuid" mod="string" dir="in"/>
3023	</method>
3024
3025	<method name="detachUSBDevice">
3026	<desc>
3027	Notification that a VM is going to detach (@a done = @c false) or has
3028	already detached (@a done = @c true) the given USB device.
3029	When the @a done = @c true request is completed, the VM process will
3030	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3031	notification.
3032	<note>
3033	In the @a done = @c true case, the server must run its own filters
3034	and filters of all VMs but this one on the detached device
3035	as if it were just attached to the host computer.
3036	</note>
3037	</desc>
3038	<param name="id" type="uuid" mod="string" dir="in"/>
3039	<param name="done" type="boolean" dir="in"/>
3040	</method>
3041
3042	<method name="autoCaptureUSBDevices">
3043	<desc>
3044	Requests a capture all matching USB devices attached to the host.
3045	When the request is completed, the VM process will
3046	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3047	notification per every captured device.
3048	</desc>
3049	</method>
3050
3051	<method name="detachAllUSBDevices">
3052	<desc>
3053	Notification that a VM that is being powered down. The done
3054	parameter indicates whether which stage of the power down
3055	we're at. When @a done = @c false the VM is announcing its
3056	intentions, while when @a done = @c true the VM is reporting
3057	what it has done.
3058	<note>
3059	In the @a done = @c true case, the server must run its own filters
3060	and filters of all VMs but this one on all detach devices as
3061	if they were just attached to the host computer.
3062	</note>
3063	</desc>
3064	<param name="done" type="boolean" dir="in"/>
3065	</method>
3066
3067	<method name="onSessionEnd">
3068	<desc>
3069	Triggered by the given session object when the session is about
3070	to close normally.
3071	</desc>
3072	<param name="session" type="ISession" dir="in">
3073	<desc>Session that is being closed</desc>
3074	</param>
3075	<param name="progress" type="IProgress" dir="return">
3076	<desc>
3077	Used to wait until the corresponding machine is actually
3078	dissociated from the given session on the server.
3079	Returned only when this session is a direct one.
3080	</desc>
3081	</param>
3082	</method>
3083
3084	<method name="beginSavingState">
3085	<desc>
3086	Called by the VM process to inform the server it wants to
3087	save the current state and stop the VM execution.
3088	</desc>
3089	<param name="progress" type="IProgress" dir="out">
3090	<desc>
3091	Progress object created by VBoxSVC to wait until
3092	the state is saved.
3093	</desc>
3094	</param>
3095	<param name="stateFilePath" type="wstring" dir="out">
3096	<desc>
3097	File path the VM process must save the execution state to.
3098	</desc>
3099	</param>
3100	</method>
3101
3102	<method name="endSavingState">
3103	<desc>
3104	Called by the VM process to inform the server that saving
3105	the state previously requested by #beginSavingState is either
3106	successfully finished or there was a failure.
3107
3108	<result name="VBOX_E_FILE_ERROR">
3109	Settings file not accessible.
3110	</result>
3111	<result name="VBOX_E_XML_ERROR">
3112	Could not parse the settings file.
3113	</result>
3114
3115	</desc>
3116
3117	<param name="result" type="long" dir="in">
3118	<desc>@c S_OK to indicate success.
3119	</desc>
3120	</param>
3121	<param name="errMsg" type="wstring" dir="in">
3122	<desc>@c human readable error message in case of failure.
3123	</desc>
3124	</param>
3125	</method>
3126
3127	<method name="adoptSavedState">
3128	<desc>
3129	Gets called by IConsole::adoptSavedState.
3130	<result name="VBOX_E_FILE_ERROR">
3131	Invalid saved state file path.
3132	</result>
3133	</desc>
3134	<param name="savedStateFile" type="wstring" dir="in">
3135	<desc>Path to the saved state file to adopt.</desc>
3136	</param>
3137	</method>
3138
3139	<method name="beginTakingSnapshot">
3140	<desc>
3141	Called from the VM process to request from the server to perform the
3142	server-side actions of creating a snapshot (creating differencing images
3143	and the snapshot object).
3144
3145	<result name="VBOX_E_FILE_ERROR">
3146	Settings file not accessible.
3147	</result>
3148	<result name="VBOX_E_XML_ERROR">
3149	Could not parse the settings file.
3150	</result>
3151	</desc>
3152	<param name="initiator" type="IConsole" dir="in">
3153	<desc>The console object that initiated this call.</desc>
3154	</param>
3155	<param name="name" type="wstring" dir="in">
3156	<desc>Snapshot name.</desc>
3157	</param>
3158	<param name="description" type="wstring" dir="in">
3159	<desc>Snapshot description.</desc>
3160	</param>
3161	<param name="consoleProgress" type="IProgress" dir="in">
3162	<desc>
3163	Progress object created by the VM process tracking the
3164	snapshot's progress. This has the following sub-operations:
3165	<ul>
3166	<li>setting up (weight 1);</li>
3167	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3168	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3169	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3170	<li>finishing up (weight 1)</li>
3171	</ul>
3172	</desc>
3173	</param>
3174	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3175	<desc>
3176	Whether this is an online snapshot (i.e. the machine is running).
3177	</desc>
3178	</param>
3179	<param name="stateFilePath" type="wstring" dir="out">
3180	<desc>
3181	File path the VM process must save the execution state to.
3182	</desc>
3183	</param>
3184	</method>
3185
3186	<method name="endTakingSnapshot">
3187	<desc>
3188	Called by the VM process to inform the server that the snapshot
3189	previously requested by #beginTakingSnapshot is either
3190	successfully taken or there was a failure.
3191	</desc>
3192
3193	<param name="success" type="boolean" dir="in">
3194	<desc>@c true to indicate success and @c false otherwise</desc>
3195	</param>
3196	</method>
3197
3198	<method name="deleteSnapshot">
3199	<desc>
3200	Gets called by IConsole::deleteSnapshot.
3201	<result name="VBOX_E_INVALID_OBJECT_STATE">
3202	Snapshot has more than one child snapshot.
3203	</result>
3204	</desc>
3205	<param name="initiator" type="IConsole" dir="in">
3206	<desc>The console object that initiated this call.</desc>
3207	</param>
3208	<param name="id" type="uuid" mod="string" dir="in">
3209	<desc>UUID of the snapshot to delete.</desc>
3210	</param>
3211	<param name="machineState" type="MachineState" dir="out">
3212	<desc>New machine state after this operation is started.</desc>
3213	</param>
3214	<param name="progress" type="IProgress" dir="return">
3215	<desc>Progress object to track the operation completion.</desc>
3216	</param>
3217	</method>
3218
3219	<method name="finishOnlineMergeMedium">
3220	<desc>
3221	Gets called by IConsole::onlineMergeMedium.
3222	</desc>
3223	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3224	<desc>The medium attachment which needs to be cleaned up.</desc>
3225	</param>
3226	<param name="source" type="IMedium" dir="in">
3227	<desc>Merge source medium.</desc>
3228	</param>
3229	<param name="target" type="IMedium" dir="in">
3230	<desc>Merge target medium.</desc>
3231	</param>
3232	<param name="mergeForward" type="boolean" dir="in">
3233	<desc>Merge direction.</desc>
3234	</param>
3235	<param name="parentForTarget" type="IMedium" dir="in">
3236	<desc>For forward merges: new parent for target medium.</desc>
3237	</param>
3238	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3239	<desc>For backward merges: list of media which need their parent UUID
3240	updated.</desc>
3241	</param>
3242	</method>
3243
3244	<method name="restoreSnapshot">
3245	<desc>
3246	Gets called by IConsole::RestoreSnapshot.
3247	</desc>
3248	<param name="initiator" type="IConsole" dir="in">
3249	<desc>The console object that initiated this call.</desc>
3250	</param>
3251	<param name="snapshot" type="ISnapshot" dir="in">
3252	<desc>The snapshot to restore the VM state from.</desc>
3253	</param>
3254	<param name="machineState" type="MachineState" dir="out">
3255	<desc>New machine state after this operation is started.</desc>
3256	</param>
3257	<param name="progress" type="IProgress" dir="return">
3258	<desc>Progress object to track the operation completion.</desc>
3259	</param>
3260	</method>
3261
3262	<method name="pullGuestProperties">
3263	<desc>
3264	Get the list of the guest properties matching a set of patterns along
3265	with their values, time stamps and flags and give responsibility for
3266	managing properties to the console.
3267	</desc>
3268	<param name="name" type="wstring" dir="out" safearray="yes">
3269	<desc>
3270	The names of the properties returned.
3271	</desc>
3272	</param>
3273	<param name="value" type="wstring" dir="out" safearray="yes">
3274	<desc>
3275	The values of the properties returned. The array entries match the
3276	corresponding entries in the @a name array.
3277	</desc>
3278	</param>
3279	<param name="timestamp" type="long long" dir="out" safearray="yes">
3280	<desc>
3281	The time stamps of the properties returned. The array entries match
3282	the corresponding entries in the @a name array.
3283	</desc>
3284	</param>
3285	<param name="flags" type="wstring" dir="out" safearray="yes">
3286	<desc>
3287	The flags of the properties returned. The array entries match the
3288	corresponding entries in the @a name array.
3289	</desc>
3290	</param>
3291	</method>
3292
3293	<method name="pushGuestProperty">
3294	<desc>
3295	Update a single guest property in IMachine.
3296	</desc>
3297	<param name="name" type="wstring" dir="in">
3298	<desc>
3299	The name of the property to be updated.
3300	</desc>
3301	</param>
3302	<param name="value" type="wstring" dir="in">
3303	<desc>
3304	The value of the property.
3305	</desc>
3306	</param>
3307	<param name="timestamp" type="long long" dir="in">
3308	<desc>
3309	The timestamp of the property.
3310	</desc>
3311	</param>
3312	<param name="flags" type="wstring" dir="in">
3313	<desc>
3314	The flags of the property.
3315	</desc>
3316	</param>
3317	</method>
3318
3319	<method name="lockMedia">
3320	<desc>
3321	Locks all media attached to the machine for writing and parents of
3322	attached differencing media (if any) for reading. This operation is
3323	atomic so that if it fails no media is actually locked.
3324
3325	This method is intended to be called when the machine is in Starting or
3326	Restoring state. The locked media will be automatically unlocked when
3327	the machine is powered off or crashed.
3328	</desc>
3329	</method>
3330	<method name="unlockMedia">
3331	<desc>
3332	Unlocks all media previously locked using
3333	<link to="IInternalMachineControl::lockMedia"/>.
3334
3335	This method is intended to be used with teleportation so that it is
3336	possible to teleport between processes on the same machine.
3337	</desc>
3338	</method>
3339	</interface>
3340
3341	<interface
3342	name="IBIOSSettings" extends="$unknown"
3343	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3344	wsmap="managed"
3345	>
3346	<desc>
3347	The IBIOSSettings interface represents BIOS settings of the virtual
3348	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3349	</desc>
3350	<attribute name="logoFadeIn" type="boolean">
3351	<desc>Fade in flag for BIOS logo animation.</desc>
3352	</attribute>
3353
3354	<attribute name="logoFadeOut" type="boolean">
3355	<desc>Fade out flag for BIOS logo animation.</desc>
3356	</attribute>
3357
3358	<attribute name="logoDisplayTime" type="unsigned long">
3359	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3360	</attribute>
3361
3362	<attribute name="logoImagePath" type="wstring">
3363	<desc>
3364	Local file system path for external BIOS splash image. Empty string
3365	means the default image is shown on boot.
3366	</desc>
3367	</attribute>
3368
3369	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3370	<desc>Mode of the BIOS boot device menu.</desc>
3371	</attribute>
3372
3373	<attribute name="ACPIEnabled" type="boolean">
3374	<desc>ACPI support flag.</desc>
3375	</attribute>
3376
3377	<attribute name="IOAPICEnabled" type="boolean">
3378	<desc>
3379	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3380	and support IRQs above 15.
3381	</desc>
3382	</attribute>
3383
3384	<attribute name="timeOffset" type="long long">
3385	<desc>
3386	Offset in milliseconds from the host system time. This allows for
3387	guests running with a different system date/time than the host.
3388	It is equivalent to setting the system date/time in the BIOS except
3389	it is not an absolute value but a relative one. Guest Additions
3390	time synchronization honors this offset.
3391	</desc>
3392	</attribute>
3393
3394	<attribute name="PXEDebugEnabled" type="boolean">
3395	<desc>
3396	PXE debug logging flag. If set, VirtualBox will write extensive
3397	PXE trace information to the release log.
3398	</desc>
3399	</attribute>
3400
3401	</interface>
3402
3403	<enum
3404	name="CleanupMode"
3405	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3406	>
3407	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3408	</desc>
3409	<const name="UnregisterOnly" value="1">
3410	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3411	</const>
3412	<const name="DetachAllReturnNone" value="2">
3413	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3414	</const>
3415	<const name="DetachAllReturnHardDisksOnly" value="3">
3416	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removeable media.</desc>
3417	</const>
3418	<const name="Full" value="4">
3419	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3420	</const>
3421	</enum>
3422
3423	<interface
3424	name="IPciAddress" extends="$unknown"
3425	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3426	wsmap="struct"
3427	>
3428
3429	<desc>
3430	Address on the PCI bus.
3431	</desc>
3432
3433	<attribute name="bus" type="short">
3434	<desc>
3435	Bus number.
3436	</desc>
3437	</attribute>
3438
3439	<attribute name="device" type="short">
3440	<desc>
3441	Device number.
3442	</desc>
3443	</attribute>
3444
3445	<attribute name="devFunction" type="short">
3446	<desc>
3447	Device function number.
3448	</desc>
3449	</attribute>
3450
3451	<method name="asLong">
3452	<desc>
3453	Convert PCI address into long.
3454	</desc>
3455	<param name="result" type="long" dir="return" />
3456	</method>
3457
3458	<method name="fromLong">
3459	<desc>
3460	Make PCI address from long.
3461	</desc>
3462	<param name="number" type="long" dir="in" />
3463	</method>
3464	</interface>
3465
3466	<interface
3467	name="IPciDeviceAttachment" extends="$unknown"
3468	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3469	wsmap="struct"
3470	>
3471
3472	<desc>
3473	Information about PCI attachments.
3474	</desc>
3475
3476	<attribute name="name" type="wstring" readonly="yes">
3477	<desc>
3478	Device name.
3479	</desc>
3480	</attribute>
3481
3482	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3483	<desc>
3484	If this is physical or virtual device.
3485	</desc>
3486	</attribute>
3487
3488	<attribute name="hostAddress" type="long" readonly="yes">
3489	<desc>
3490	Address of device on the host, applicable only to host devices.
3491	</desc>
3492	</attribute>
3493
3494	<attribute name="guestAddress" type="long" readonly="yes">
3495	<desc>
3496	Address of device on the guest.
3497	</desc>
3498	</attribute>
3499
3500	</interface>
3501
3502
3503	<interface
3504	name="IMachine" extends="$unknown"
3505	uuid="662c175e-a69d-40b8-a77a-1d719d0ab062"
3506	wsmap="managed"
3507	>
3508	<desc>
3509	The IMachine interface represents a virtual machine, or guest, created
3510	in VirtualBox.
3511
3512	This interface is used in two contexts. First of all, a collection of
3513	objects implementing this interface is stored in the
3514	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3515	machines that are currently registered with this VirtualBox
3516	installation. Also, once a session has been opened for the given virtual
3517	machine (e.g. the virtual machine is running), the machine object
3518	associated with the open session can be queried from the session object;
3519	see <link to="ISession"/> for details.
3520
3521	The main role of this interface is to expose the settings of the virtual
3522	machine and provide methods to change various aspects of the virtual
3523	machine's configuration. For machine objects stored in the
3524	<link to="IVirtualBox::machines"/> collection, all attributes are
3525	read-only unless explicitly stated otherwise in individual attribute
3526	and method descriptions.
3527
3528	In order to change a machine setting, a session for this machine must be
3529	opened using one of the <link to="IMachine::lockMachine" /> or
3530	<link to="IMachine::launchVMProcess"/> methods. After the
3531	machine has been successfully locked for a session, a mutable machine object
3532	needs to be queried from the session object and then the desired settings
3533	changes can be applied to the returned object using IMachine attributes and
3534	methods. See the <link to="ISession"/> interface description for more
3535	information about sessions.
3536
3537	Note that IMachine does not provide methods to control virtual machine
3538	execution (such as start the machine, or power it down) -- these methods
3539	are grouped in a separate interface called <link to="IConsole" />.
3540
3541	<see>ISession, IConsole</see>
3542	</desc>
3543
3544	<attribute name="parent" type="IVirtualBox" readonly="yes">
3545	<desc>Associated parent object.</desc>
3546	</attribute>
3547
3548	<attribute name="accessible" type="boolean" readonly="yes">
3549	<desc>
3550	Whether this virtual machine is currently accessible or not.
3551
3552	A machine is always deemed accessible unless it is registered <i>and</i>
3553	its settings file cannot be read or parsed (either because the file itself
3554	is unavailable or has invalid XML contents).
3555
3556	Every time this property is read, the accessibility state of
3557	this machine is re-evaluated. If the returned value is @c false,
3558	the <link to="#accessError"/> property may be used to get the
3559	detailed error information describing the reason of
3560	inaccessibility, including XML error messages.
3561
3562	When the machine is inaccessible, only the following properties
3563	can be used on it:
3564	<ul>
3565	<li><link to="#parent"/></li>
3566	<li><link to="#id"/></li>
3567	<li><link to="#settingsFilePath"/></li>
3568	<li><link to="#accessible"/></li>
3569	<li><link to="#accessError"/></li>
3570	</ul>
3571
3572	An attempt to access any other property or method will return
3573	an error.
3574
3575	The only possible action you can perform on an inaccessible
3576	machine is to unregister it using the
3577	<link to="IMachine::unregister"/> call (or, to check
3578	for the accessibility state once more by querying this
3579	property).
3580
3581	<note>
3582	In the current implementation, once this property returns
3583	@c true, the machine will never become inaccessible
3584	later, even if its settings file cannot be successfully
3585	read/written any more (at least, until the VirtualBox
3586	server is restarted). This limitation may be removed in
3587	future releases.
3588	</note>
3589	</desc>
3590	</attribute>
3591
3592	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3593	<desc>
3594	Error information describing the reason of machine
3595	inaccessibility.
3596
3597	Reading this property is only valid after the last call to
3598	<link to="#accessible"/> returned @c false (i.e. the
3599	machine is currently inaccessible). Otherwise, a @c null
3600	IVirtualBoxErrorInfo object will be returned.
3601	</desc>
3602	</attribute>
3603
3604	<attribute name="name" type="wstring">
3605	<desc>
3606	Name of the virtual machine.
3607
3608	Besides being used for human-readable identification purposes
3609	everywhere in VirtualBox, the virtual machine name is also used
3610	as a name of the machine's settings file and as a name of the
3611	subdirectory this settings file resides in. Thus, every time you
3612	change the value of this property, the settings file will be
3613	renamed once you call <link to="#saveSettings"/> to confirm the
3614	change. The containing subdirectory will be also renamed, but
3615	only if it has exactly the same name as the settings file
3616	itself prior to changing this property (for backward compatibility
3617	with previous API releases). The above implies the following
3618	limitations:
3619	<ul>
3620	<li>The machine name cannot be empty.</li>
3621	<li>The machine name can contain only characters that are valid
3622	file name characters according to the rules of the file
3623	system used to store VirtualBox configuration.</li>
3624	<li>You cannot have two or more machines with the same name
3625	if they use the same subdirectory for storing the machine
3626	settings files.</li>
3627	<li>You cannot change the name of the machine if it is running,
3628	or if any file in the directory containing the settings file
3629	is being used by another running machine or by any other
3630	process in the host operating system at a time when
3631	<link to="#saveSettings"/> is called.
3632	</li>
3633	</ul>
3634	If any of the above limitations are hit, <link to="#saveSettings"/>
3635	will return an appropriate error message explaining the exact
3636	reason and the changes you made to this machine will not be saved.
3637
3638	Starting with VirtualBox 4.0, a “.vbox” extension of the settings
3639	file is recommended, but not enforced. (Previous versions always
3640	used a generic ".xml" extension.)
3641	</desc>
3642	</attribute>
3643
3644	<attribute name="description" type="wstring">
3645	<desc>
3646	Description of the virtual machine.
3647
3648	The description attribute can contain any text and is
3649	typically used to describe the hardware and software
3650	configuration of the virtual machine in detail (i.e. network
3651	settings, versions of the installed software and so on).
3652	</desc>
3653	</attribute>
3654
3655	<attribute name="id" type="uuid" mod="string" readonly="yes">
3656	<desc>UUID of the virtual machine.</desc>
3657	</attribute>
3658
3659	<attribute name="OSTypeId" type="wstring">
3660	<desc>
3661	User-defined identifier of the Guest OS type.
3662	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3663	an IGuestOSType object representing details about the given
3664	Guest OS type.
3665	<note>
3666	This value may differ from the value returned by
3667	<link to="IGuest::OSTypeId"/> if Guest Additions are
3668	installed to the guest OS.
3669	</note>
3670	</desc>
3671	</attribute>
3672
3673	<attribute name="HardwareVersion" type="wstring">
3674	<desc>Hardware version identifier. Internal use only for now.</desc>
3675	</attribute>
3676
3677	<attribute name="hardwareUUID" type="uuid" mod="string">
3678	<desc>
3679	The UUID presented to the guest via memory tables, hardware and guest
3680	properties. For most VMs this is the same as the @a id, but for VMs
3681	which have been cloned or teleported it may be the same as the source
3682	VM. This latter is because the guest shouldn't notice that it was
3683	cloned or teleported.
3684	</desc>
3685	</attribute>
3686
3687	<attribute name="CPUCount" type="unsigned long">
3688	<desc>Number of virtual CPUs in the VM.</desc>
3689	</attribute>
3690
3691	<attribute name="CPUHotPlugEnabled" type="boolean">
3692	<desc>
3693	This setting determines whether VirtualBox allows CPU
3694	hotplugging for this machine.</desc>
3695	</attribute>
3696
3697	<attribute name="CPUExecutionCap" type="unsigned long">
3698	<desc>
3699	Means to limit the number of CPU cycles a guest can use. The unit
3700	is percentage of host CPU cycles per second. The valid range
3701	is 1 - 100. 100 (the default) implies no limit.
3702	</desc>
3703	</attribute>
3704
3705	<attribute name="memorySize" type="unsigned long">
3706	<desc>System memory size in megabytes.</desc>
3707	</attribute>
3708
3709	<attribute name="memoryBalloonSize" type="unsigned long">
3710	<desc>Memory balloon size in megabytes.</desc>
3711	</attribute>
3712
3713	<attribute name="PageFusionEnabled" type="boolean">
3714	<desc>
3715	This setting determines whether VirtualBox allows page
3716	fusion for this machine (64 bits host only).
3717	</desc>
3718	</attribute>
3719
3720	<attribute name="VRAMSize" type="unsigned long">
3721	<desc>Video memory size in megabytes.</desc>
3722	</attribute>
3723
3724	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3725	<desc>
3726	This setting determines whether VirtualBox allows this machine to make
3727	use of the 3D graphics support available on the host.</desc>
3728	</attribute>
3729
3730	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3731	<desc>
3732	This setting determines whether VirtualBox allows this machine to make
3733	use of the 2D video acceleration support available on the host.</desc>
3734	</attribute>
3735
3736	<attribute name="monitorCount" type="unsigned long">
3737	<desc>
3738	Number of virtual monitors.
3739	<note>
3740	Only effective on Windows XP and later guests with
3741	Guest Additions installed.
3742	</note>
3743	</desc>
3744	</attribute>
3745
3746	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3747	<desc>Object containing all BIOS settings.</desc>
3748	</attribute>
3749
3750	<attribute name="firmwareType" type="FirmwareType">
3751	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3752	bootstrap in this VM.</desc>
3753	</attribute>
3754
3755	<attribute name="pointingHidType" type="PointingHidType">
3756	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3757	The default is typically "PS2Mouse" but can vary depending on the
3758	requirements of the guest operating system.</desc>
3759	</attribute>
3760
3761	<attribute name="keyboardHidType" type="KeyboardHidType">
3762	<desc>Type of keyboard HID used in this VM.
3763	The default is typically "PS2Keyboard" but can vary depending on the
3764	requirements of the guest operating system.</desc>
3765	</attribute>
3766
3767	<attribute name="hpetEnabled" type="boolean">
3768	<desc>This attribute controls if High Precision Event Timer (HPET) is
3769	enabled in this VM. Use this property if you want to provide guests
3770	with additional time source, or if guest requires HPET to function correctly.
3771	Default is false.</desc>
3772	</attribute>
3773
3774	<attribute name="chipsetType" type="ChipsetType">
3775	<desc>Chipset type used in this VM.</desc>
3776	</attribute>
3777
3778	<attribute name="snapshotFolder" type="wstring">
3779	<desc>
3780	Full path to the directory used to store snapshot data
3781	(differencing media and saved state files) of this machine.
3782
3783	The initial value of this property is
3784	<tt><</tt><link to="#settingsFilePath">
3785	path_to_settings_file</link><tt>>/<</tt>
3786	<link to="#id">machine_uuid</link>
3787	<tt>></tt>.
3788
3789	Currently, it is an error to try to change this property on
3790	a machine that has snapshots (because this would require to
3791	move possibly large files to a different location).
3792	A separate method will be available for this purpose later.
3793
3794	<note>
3795	Setting this property to @c null or to an empty string will restore
3796	the initial value.
3797	</note>
3798	<note>
3799	When setting this property, the specified path can be
3800	absolute (full path) or relative to the directory where the
3801	<link to="#settingsFilePath">machine settings file</link>
3802	is located. When reading this property, a full path is
3803	always returned.
3804	</note>
3805	<note>
3806	The specified path may not exist, it will be created
3807	when necessary.
3808	</note>
3809	</desc>
3810	</attribute>
3811
3812	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3813	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3814	</attribute>
3815
3816	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3817	<desc>Array of media attached to this machine.</desc>
3818	</attribute>
3819
3820	<attribute name="USBController" type="IUSBController" readonly="yes">
3821	<desc>
3822	Associated USB controller object.
3823
3824	<note>
3825	If USB functionality is not available in the given edition of
3826	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3827	</note>
3828	</desc>
3829	</attribute>
3830
3831	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3832	<desc>Associated audio adapter, always present.</desc>
3833	</attribute>
3834
3835	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3836	<desc>Array of storage controllers attached to this machine.</desc>
3837	</attribute>
3838
3839	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3840	<desc>
3841	Full name of the file containing machine settings data.
3842	</desc>
3843	</attribute>
3844
3845	<attribute name="settingsModified" type="boolean" readonly="yes">
3846	<desc>
3847	Whether the settings of this machine have been modified
3848	(but neither yet saved nor discarded).
3849	<note>
3850	Reading this property is only valid on instances returned
3851	by <link to="ISession::machine"/> and on new machines
3852	created by <link to="IVirtualBox::createMachine"/> or opened
3853	by <link to="IVirtualBox::openMachine"/> but not
3854	yet registered, or on unregistered machines after calling
3855	<link to="IMachine::unregister"/>. For all other
3856	cases, the settings can never be modified.
3857	</note>
3858	<note>
3859	For newly created unregistered machines, the value of this
3860	property is always @c true until <link to="#saveSettings"/>
3861	is called (no matter if any machine settings have been
3862	changed after the creation or not). For opened machines
3863	the value is set to @c false (and then follows to normal rules).
3864	</note>
3865	</desc>
3866	</attribute>
3867
3868	<attribute name="sessionState" type="SessionState" readonly="yes">
3869	<desc>Current session state for this machine.</desc>
3870	</attribute>
3871
3872	<attribute name="sessionType" type="wstring" readonly="yes">
3873	<desc>
3874	Type of the session. If <link to="#sessionState"/> is
3875	Spawning or Locked, this attribute contains the
3876	same value as passed to the
3877	<link to="IMachine::launchVMProcess"/> method in the
3878	@a type parameter. If the session was used with
3879	<link to="IMachine::lockMachine" />, or if
3880	<link to="#sessionState"/> is SessionClosed, the value of this
3881	attribute is an empty string.
3882	</desc>
3883	</attribute>
3884
3885	<attribute name="sessionPid" type="unsigned long" readonly="yes">
3886	<desc>
3887	Identifier of the session process. This attribute contains the
3888	platform-dependent identifier of the process whose session was
3889	used with <link to="IMachine::lockMachine" /> call. The returned
3890	value is only valid if <link to="#sessionState"/> is Locked or
3891	Unlocking by the time this property is read.
3892	</desc>
3893	</attribute>
3894
3895	<attribute name="state" type="MachineState" readonly="yes">
3896	<desc>Current execution state of this machine.</desc>
3897	</attribute>
3898
3899	<attribute name="lastStateChange" type="long long" readonly="yes">
3900	<desc>
3901	Time stamp of the last execution state change,
3902	in milliseconds since 1970-01-01 UTC.
3903	</desc>
3904	</attribute>
3905
3906	<attribute name="stateFilePath" type="wstring" readonly="yes">
3907	<desc>
3908	Full path to the file that stores the execution state of
3909	the machine when it is in the <link to="MachineState_Saved"/> state.
3910	<note>
3911	When the machine is not in the Saved state, this attribute is
3912	an empty string.
3913	</note>
3914	</desc>
3915	</attribute>
3916
3917	<attribute name="logFolder" type="wstring" readonly="yes">
3918	<desc>
3919	Full path to the folder that stores a set of rotated log files
3920	recorded during machine execution. The most recent log file is
3921	named <tt>VBox.log</tt>, the previous log file is
3922	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
3923	in the current version).
3924	</desc>
3925	</attribute>
3926
3927	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
3928	<desc>
3929	Current snapshot of this machine. This is @c null if the machine
3930	currently has no snapshots. If it is not @c null, then it was
3931	set by one of <link to="IConsole::takeSnapshot" />,
3932	<link to="IConsole::deleteSnapshot" />
3933	or <link to="IConsole::restoreSnapshot" />, depending on which
3934	was called last. See <link to="ISnapshot"/> for details.
3935	</desc>
3936	</attribute>
3937
3938	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
3939	<desc>
3940	Number of snapshots taken on this machine. Zero means the
3941	machine doesn't have any snapshots.
3942	</desc>
3943	</attribute>
3944
3945	<attribute name="currentStateModified" type="boolean" readonly="yes">
3946	<desc>
3947	Returns @c true if the current state of the machine is not
3948	identical to the state stored in the current snapshot.
3949
3950	The current state is identical to the current snapshot only
3951	directly after one of the following calls are made:
3952
3953	<ul>
3954	<li><link to="IConsole::restoreSnapshot"/>
3955	</li>
3956	<li><link to="IConsole::takeSnapshot"/> (issued on a
3957	"powered off" or "saved" machine, for which
3958	<link to="#settingsModified"/> returns @c false)
3959	</li>
3960	</ul>
3961
3962	The current state remains identical until one of the following
3963	happens:
3964	<ul>
3965	<li>settings of the machine are changed</li>
3966	<li>the saved state is deleted</li>
3967	<li>the current snapshot is deleted</li>
3968	<li>an attempt to execute the machine is made</li>
3969	</ul>
3970
3971	<note>
3972	For machines that don't have snapshots, this property is
3973	always @c false.
3974	</note>
3975	</desc>
3976	</attribute>
3977
3978	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
3979	<desc>
3980	Collection of shared folders for this machine (permanent shared
3981	folders). These folders are shared automatically at machine startup
3982	and available only to the guest OS installed within this machine.
3983
3984	New shared folders are added to the collection using
3985	<link to="#createSharedFolder"/>. Existing shared folders can be
3986	removed using <link to="#removeSharedFolder"/>.
3987	</desc>
3988	</attribute>
3989
3990	<attribute name="clipboardMode" type="ClipboardMode">
3991	<desc>
3992	Synchronization mode between the host OS clipboard
3993	and the guest OS clipboard.
3994	</desc>
3995	</attribute>
3996
3997	<attribute name="guestPropertyNotificationPatterns" type="wstring">
3998	<desc>
3999	A comma-separated list of simple glob patterns. Changes to guest
4000	properties whose name matches one of the patterns will generate an
4001	<link to="IGuestPropertyChangedEvent"/> signal.
4002	</desc>
4003	</attribute>
4004
4005	<attribute name="teleporterEnabled" type="boolean">
4006	<desc>
4007	When set to @a true, the virtual machine becomes a target teleporter
4008	the next time it is powered on. This can only set to @a true when the
4009	VM is in the @a PoweredOff or @a Aborted state.
4010
4011	<!-- This property is automatically set to @a false when the VM is powered
4012	on. (bird: This doesn't work yet ) -->
4013	</desc>
4014	</attribute>
4015
4016	<attribute name="teleporterPort" type="unsigned long">
4017	<desc>
4018	The TCP port the target teleporter will listen for incoming
4019	teleportations on.
4020
4021	0 means the port is automatically selected upon power on. The actual
4022	value can be read from this property while the machine is waiting for
4023	incoming teleportations.
4024	</desc>
4025	</attribute>
4026
4027	<attribute name="teleporterAddress" type="wstring">
4028	<desc>
4029	The address the target teleporter will listen on. If set to an empty
4030	string, it will listen on all addresses.
4031	</desc>
4032	</attribute>
4033
4034	<attribute name="teleporterPassword" type="wstring">
4035	<desc>
4036	The password to check for on the target teleporter. This is just a
4037	very basic measure to prevent simple hacks and operators accidentally
4038	beaming a virtual machine to the wrong place.
4039	</desc>
4040	</attribute>
4041
4042	<attribute name="faultToleranceState" type="FaultToleranceState">
4043	<desc>
4044	Fault tolerance state; disabled, source or target.
4045	This property can be changed at any time. If you change it for a running
4046	VM, then the fault tolerance address and port must be set beforehand.
4047	</desc>
4048	</attribute>
4049
4050	<attribute name="faultTolerancePort" type="unsigned long">
4051	<desc>
4052	The TCP port the fault tolerance source or target will use for
4053	communication.
4054	</desc>
4055	</attribute>
4056
4057	<attribute name="faultToleranceAddress" type="wstring">
4058	<desc>
4059	The address the fault tolerance source or target.
4060	</desc>
4061	</attribute>
4062
4063	<attribute name="faultTolerancePassword" type="wstring">
4064	<desc>
4065	The password to check for on the standby VM. This is just a
4066	very basic measure to prevent simple hacks and operators accidentally
4067	choosing the wrong standby VM.
4068	</desc>
4069	</attribute>
4070
4071	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4072	<desc>
4073	The interval in ms used for syncing the state between source and target.
4074	</desc>
4075	</attribute>
4076
4077	<attribute name="RTCUseUTC" type="boolean">
4078	<desc>
4079	When set to @a true, the RTC device of the virtual machine will run
4080	in UTC time, otherwise in local time. Especially Unix guests prefer
4081	the time in UTC.
4082	</desc>
4083	</attribute>
4084
4085	<attribute name="ioCacheEnabled" type="boolean">
4086	<desc>
4087	When set to @a true, the builtin I/O cache of the virtual machine
4088	will be enabled.
4089	</desc>
4090	</attribute>
4091
4092	<attribute name="ioCacheSize" type="unsigned long">
4093	<desc>
4094	Maximum size of the I/O cache in MB.
4095	</desc>
4096	</attribute>
4097
4098	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4099	<desc>
4100	Bandwidth control manager.
4101	</desc>
4102	</attribute>
4103
4104	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4105	<desc>Array of PCI devices assigned to this machine, to get list of all PCI devices
4106	attached to the machine use IConsole::attachedPciDevices attribute, as
4107	this attribute is intended to list only devices additional to what
4108	described in virtual hardware config. Usually, this list keeps host's
4109	physical devices assigned to the particular machine.
4110	</desc>
4111	</attribute>
4112
4113	<method name="lockMachine">
4114	<desc>
4115	Locks the machine for the given session to enable the caller
4116	to make changes to the machine or start the VM or control
4117	VM execution.
4118
4119	There are two ways to lock a machine for such uses:
4120
4121	<ul>
4122	<li>If you want to make changes to the machine settings,
4123	you must obtain an exclusive write lock on the machine
4124	by setting @a lockType to @c Write.
4125
4126	This will only succeed if no other process has locked
4127	the machine to prevent conflicting changes. Only after
4128	an exclusive write lock has been obtained using this method, one
4129	can change all VM settings or execute the VM in the process
4130	space of the session object. (Note that the latter is only of
4131	interest if you actually want to write a new front-end for
4132	virtual machines; but this API gets called internally by
4133	the existing front-ends such as VBoxHeadless and the VirtualBox
4134	GUI to acquire a write lock on the machine that they are running.)
4135
4136	On success, write-locking the machine for a session creates
4137	a second copy of the IMachine object. It is this second object
4138	upon which changes can be made; in VirtualBox terminology, the
4139	second copy is "mutable". It is only this second, mutable machine
4140	object upon which you can call methods that change the
4141	machine state. After having called this method, you can
4142	obtain this second, mutable machine object using the
4143	<link to="ISession::machine" /> attribute.
4144	</li>
4145	<li>If you only want to check the machine state or control
4146	machine execution without actually changing machine
4147	settings (e.g. to get access to VM statistics or take
4148	a snapshot or save the machine state), then set the
4149	@a lockType argument to @c Shared.
4150
4151	If no other session has obtained a lock, you will obtain an
4152	exclusive write lock as described above. However, if another
4153	session has already obtained such a lock, then a link to that
4154	existing session will be established which allows you
4155	to control that existing session.
4156
4157	To find out which type of lock was obtained, you can
4158	inspect <link to="ISession::type" />, which will have been
4159	set to either @c WriteLock or @c Shared.
4160	</li>
4161	</ul>
4162
4163	In either case, you can get access to the <link to="IConsole" />
4164	object which controls VM execution.
4165
4166	Also in all of the above cases, one must always call
4167	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4168	the machine's state will eventually be set to "Aborted".
4169
4170	To change settings on a machine, the following sequence is typically
4171	performed:
4172
4173	<ol>
4174	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4175
4176	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4177
4178	<li>Change the settings of the machine by invoking IMachine methods.</li>
4179
4180	<li>Call <link to="IMachine::saveSettings" />.</li>
4181
4182	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4183	</ol>
4184
4185	<result name="E_UNEXPECTED">
4186	Virtual machine not registered.
4187	</result>
4188	<result name="E_ACCESSDENIED">
4189	Process not started by OpenRemoteSession.
4190	</result>
4191	<result name="VBOX_E_INVALID_OBJECT_STATE">
4192	Session already open or being opened.
4193	</result>
4194	<result name="VBOX_E_VM_ERROR">
4195	Failed to assign machine to session.
4196	</result>
4197	</desc>
4198	<param name="session" type="ISession" dir="in">
4199	<desc>
4200	Session object for which the machine will be locked.
4201	</desc>
4202	</param>
4203	<param name="lockType" type="LockType" dir="in">
4204	<desc>
4205	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4206	If set to @c Shared, then either acquire an exclusive write lock or establish
4207	a link to an existing session.
4208	</desc>
4209	</param>
4210	</method>
4211
4212	<method name="launchVMProcess">
4213	<desc>
4214	Spawns a new process that will execute the virtual machine and obtains a shared
4215	lock on the machine for the calling session.
4216
4217	If launching the VM succeeds, the new VM process will create its own session
4218	and write-lock the machine for it, preventing conflicting changes from other
4219	processes. If the machine is already locked (because it is already running or
4220	because another session has a write lock), launching the VM process will therefore
4221	fail. Reversely, future attempts to obtain a write lock will also fail while the
4222	machine is running.
4223
4224	The caller's session object remains separate from the session opened by the new
4225	VM process. It receives its own <link to="IConsole" /> object which can be used
4226	to control machine execution, but it cannot be used to change all VM settings
4227	which would be available after a <link to="#lockMachine" /> call.
4228
4229	The caller must eventually release the session's shared lock by calling
4230	<link to="ISession::unlockMachine" /> on the local session object once this call
4231	has returned. However, the session's state (see <link to="ISession::state" />)
4232	will not return to "Unlocked" until the remote session has also unlocked
4233	the machine (i.e. the machine has stopped running).
4234
4235	Launching a VM process can take some time (a new VM is started in a new process,
4236	for which memory and other resources need to be set up). Because of this,
4237	an <link to="IProgress" /> object is returned to allow the caller to wait
4238	for this asynchronous operation to be completed. Until then, the caller's
4239	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4240	and <link to="ISession::console" /> attributes cannot be accessed.
4241	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4242	similar calls to wait for completion. Completion is signalled when the VM
4243	is powered on. If launching the VM fails, error messages can be queried
4244	via the progress object, if available.
4245
4246	The progress object will have at least 2 sub-operations. The first
4247	operation covers the period up to the new VM process calls powerUp.
4248	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4249	progress object. Because <link to="IConsole::powerUp"/> may require
4250	some extra sub-operations, the <link to="IProgress::operationCount"/>
4251	may change at the completion of operation.
4252
4253	For details on the teleportation progress operation, see
4254	<link to="IConsole::powerUp"/>.
4255
4256	The @a environment argument is a string containing definitions of
4257	environment variables in the following format:
4258	@code
4259	NAME[=VALUE]\n
4260	NAME[=VALUE]\n
4261	...
4262	@endcode
4263	where <tt>\\n</tt> is the new line character. These environment
4264	variables will be appended to the environment of the VirtualBox server
4265	process. If an environment variable exists both in the server process
4266	and in this list, the value from this list takes precedence over the
4267	server's variable. If the value of the environment variable is
4268	omitted, this variable will be removed from the resulting environment.
4269	If the environment string is @c null or empty, the server environment
4270	is inherited by the started process as is.
4271
4272	<result name="E_UNEXPECTED">
4273	Virtual machine not registered.
4274	</result>
4275	<result name="E_INVALIDARG">
4276	Invalid session type @a type.
4277	</result>
4278	<result name="VBOX_E_OBJECT_NOT_FOUND">
4279	No machine matching @a machineId found.
4280	</result>
4281	<result name="VBOX_E_INVALID_OBJECT_STATE">
4282	Session already open or being opened.
4283	</result>
4284	<result name="VBOX_E_IPRT_ERROR">
4285	Launching process for machine failed.
4286	</result>
4287	<result name="VBOX_E_VM_ERROR">
4288	Failed to assign machine to session.
4289	</result>
4290	</desc>
4291	<param name="session" type="ISession" dir="in">
4292	<desc>
4293	Client session object to which the VM process will be connected (this
4294	must be in "Unlocked" state).
4295	</desc>
4296	</param>
4297	<param name="type" type="wstring" dir="in">
4298	<desc>
4299	Front-end to use for the new VM process. The following are currently supported:
4300	<ul>
4301	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4302	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4303	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4304	</ul>
4305	</desc>
4306	</param>
4307	<param name="environment" type="wstring" dir="in">
4308	<desc>
4309	Environment to pass to the VM process.
4310	</desc>
4311	</param>
4312	<param name="progress" type="IProgress" dir="return">
4313	<desc>Progress object to track the operation completion.</desc>
4314	</param>
4315	</method>
4316
4317	<method name="setBootOrder">
4318	<desc>
4319	Puts the given device to the specified position in
4320	the boot order.
4321
4322	To indicate that no device is associated with the given position,
4323	<link to="DeviceType_Null"/> should be used.
4324
4325	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4326
4327	<result name="E_INVALIDARG">
4328	Boot @a position out of range.
4329	</result>
4330	<result name="E_NOTIMPL">
4331	Booting from USB @a device currently not supported.
4332	</result>
4333
4334	</desc>
4335	<param name="position" type="unsigned long" dir="in">
4336	<desc>
4337	Position in the boot order (@c 1 to the total number of
4338	devices the machine can boot from, as returned by
4339	<link to="ISystemProperties::maxBootPosition"/>).
4340	</desc>
4341	</param>
4342	<param name="device" type="DeviceType" dir="in">
4343	<desc>
4344	The type of the device used to boot at the given position.
4345	</desc>
4346	</param>
4347	</method>
4348
4349	<method name="getBootOrder" const="yes">
4350	<desc>
4351	Returns the device type that occupies the specified
4352	position in the boot order.
4353
4354	@todo [remove?]
4355	If the machine can have more than one device of the returned type
4356	(such as hard disks), then a separate method should be used to
4357	retrieve the individual device that occupies the given position.
4358
4359	If here are no devices at the given position, then
4360	<link to="DeviceType_Null"/> is returned.
4361
4362	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4363
4364	<result name="E_INVALIDARG">
4365	Boot @a position out of range.
4366	</result>
4367
4368	</desc>
4369	<param name="position" type="unsigned long" dir="in">
4370	<desc>
4371	Position in the boot order (@c 1 to the total number of
4372	devices the machine can boot from, as returned by
4373	<link to="ISystemProperties::maxBootPosition"/>).
4374	</desc>
4375	</param>
4376	<param name="device" type="DeviceType" dir="return">
4377	<desc>
4378	Device at the given position.
4379	</desc>
4380	</param>
4381	</method>
4382
4383	<method name="attachDevice">
4384	<desc>
4385	Attaches a device and optionally mounts a medium to the given storage
4386	controller (<link to="IStorageController" />, identified by @a name),
4387	at the indicated port and device.
4388
4389	This method is intended for managing storage devices in general while a
4390	machine is powered off. It can be used to attach and detach fixed
4391	and removeable media. The following kind of media can be attached
4392	to a machine:
4393
4394	<ul>
4395	<li>For fixed and removable media, you can pass in a medium that was
4396	previously opened using <link to="IVirtualBox::openMedium" />.
4397	</li>
4398
4399	<li>Only for storage devices supporting removable media (such as
4400	DVDs and floppies), you can also specify a null pointer to
4401	indicate an empty drive or one of the medium objects listed
4402	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4403	arrays to indicate a host drive.
4404	For removeable devices, you can also use <link to="IMachine::mountMedium"/>
4405	to change the media while the machine is running.
4406	</li>
4407	</ul>
4408
4409	In a VM's default configuration of virtual machines, the secondary
4410	master of the IDE controller is used for a CD/DVD drive.
4411
4412	After calling this returns successfully, a new instance of
4413	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4414	attachments (see <link to="IMachine::mediumAttachments"/>).
4415
4416	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4417	information about attaching media.
4418
4419	The specified device slot must not have a device attached to it,
4420	or this method will fail.
4421
4422	<note>
4423	You cannot attach a device to a newly created machine until
4424	this machine's settings are saved to disk using
4425	<link to="#saveSettings"/>.
4426	</note>
4427	<note>
4428	If the medium is being attached indirectly, a new differencing medium
4429	will implicitly be created for it and attached instead. If the
4430	changes made to the machine settings (including this indirect
4431	attachment) are later cancelled using <link to="#discardSettings"/>,
4432	this implicitly created differencing medium will implicitly
4433	be deleted.
4434	</note>
4435
4436	<result name="E_INVALIDARG">
4437	SATA device, SATA port, IDE port or IDE slot out of range, or
4438	file or UUID not found.
4439	</result>
4440	<result name="VBOX_E_INVALID_OBJECT_STATE">
4441	Machine must be registered before media can be attached.
4442	</result>
4443	<result name="VBOX_E_INVALID_VM_STATE">
4444	Invalid machine state.
4445	</result>
4446	<result name="VBOX_E_OBJECT_IN_USE">
4447	A medium is already attached to this or another virtual machine.
4448	</result>
4449
4450	</desc>
4451	<param name="name" type="wstring" dir="in">
4452	<desc>Name of the storage controller to attach the device to.</desc>
4453	</param>
4454	<param name="controllerPort" type="long" dir="in">
4455	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4456	the primary controller and 1 specifies the secondary controller.
4457	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4458	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4459	</param>
4460	<param name="device" type="long" dir="in">
4461	<desc>Device slot in the given port to attach the device to. This is only
4462	relevant for IDE controllers, for which 0 specifies the master device and
4463	1 specifies the slave device. For all other controller types, this must
4464	be 0.</desc>
4465	</param>
4466	<param name="type" type="DeviceType" dir="in">
4467	<desc>Device type of the attached device. For media opened by
4468	<link to="IVirtualBox::openMedium" />, this must match the device type
4469	specified there.</desc>
4470	</param>
4471	<param name="medium" type="IMedium" dir="in">
4472	<desc>Medium to mount or NULL for an empty drive.</desc>
4473	</param>
4474	</method>
4475
4476	<method name="detachDevice">
4477	<desc>
4478	Detaches the device attached to a device slot of the specified bus.
4479
4480	Detaching the device from the virtual machine is deferred. This means
4481	that the medium remains associated with the machine when this method
4482	returns and gets actually de-associated only after a successful
4483	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4484	for more detailed information about attaching media.
4485
4486	<note>
4487	You cannot detach a device from a running machine.
4488	</note>
4489	<note>
4490	Detaching differencing media implicitly created by <link
4491	to="#attachDevice"/> for the indirect attachment using this
4492	method will <b>not</b> implicitly delete them. The
4493	<link to="IMedium::deleteStorage"/> operation should be
4494	explicitly performed by the caller after the medium is successfully
4495	detached and the settings are saved with
4496	<link to="#saveSettings"/>, if it is the desired action.
4497	</note>
4498
4499	<result name="VBOX_E_INVALID_VM_STATE">
4500	Attempt to detach medium from a running virtual machine.
4501	</result>
4502	<result name="VBOX_E_OBJECT_NOT_FOUND">
4503	No medium attached to given slot/bus.
4504	</result>
4505	<result name="VBOX_E_NOT_SUPPORTED">
4506	Medium format does not support storage deletion.
4507	</result>
4508
4509	</desc>
4510	<param name="name" type="wstring" dir="in">
4511	<desc>Name of the storage controller to detach the medium from.</desc>
4512	</param>
4513	<param name="controllerPort" type="long" dir="in">
4514	<desc>Port number to detach the medium from.</desc>
4515	</param>
4516	<param name="device" type="long" dir="in">
4517	<desc>Device slot number to detach the medium from.</desc>
4518	</param>
4519	</method>
4520
4521	<method name="passthroughDevice">
4522	<desc>
4523	Sets the passthrough mode of an existing DVD device. Changing the
4524	setting while the VM is running is forbidden. The setting is only used
4525	if at VM start the device is configured as a host DVD drive, in all
4526	other cases it is ignored. The device must already exist; see
4527	<link to="IMachine::attachDevice"/> for how to attach a new device.
4528
4529	The @a controllerPort and @a device parameters specify the device slot and
4530	have have the same meaning as with <link to="IMachine::attachDevice" />.
4531
4532	<result name="E_INVALIDARG">
4533	SATA device, SATA port, IDE port or IDE slot out of range.
4534	</result>
4535	<result name="VBOX_E_INVALID_OBJECT_STATE">
4536	Attempt to modify an unregistered virtual machine.
4537	</result>
4538	<result name="VBOX_E_INVALID_VM_STATE">
4539	Invalid machine state.
4540	</result>
4541
4542	</desc>
4543	<param name="name" type="wstring" dir="in">
4544	<desc>Name of the storage controller.</desc>
4545	</param>
4546	<param name="controllerPort" type="long" dir="in">
4547	<desc>Storage controller port.</desc>
4548	</param>
4549	<param name="device" type="long" dir="in">
4550	<desc>Device slot in the given port.</desc>
4551	</param>
4552	<param name="passthrough" type="boolean" dir="in">
4553	<desc>New value for the passthrough setting.</desc>
4554	</param>
4555	</method>
4556
4557	<method name="setBandwidthGroupForDevice">
4558	<desc>
4559	Sets the passthrough mode of an existing DVD device. Changing the
4560	setting while the VM is running is forbidden. The setting is only used
4561	if at VM start the device is configured as a host DVD drive, in all
4562	other cases it is ignored. The device must already exist; see
4563	<link to="IMachine::attachDevice"/> for how to attach a new device.
4564
4565	The @a controllerPort and @a device parameters specify the device slot and
4566	have have the same meaning as with <link to="IMachine::attachDevice" />.
4567
4568	<result name="E_INVALIDARG">
4569	SATA device, SATA port, IDE port or IDE slot out of range.
4570	</result>
4571	<result name="VBOX_E_INVALID_OBJECT_STATE">
4572	Attempt to modify an unregistered virtual machine.
4573	</result>
4574	<result name="VBOX_E_INVALID_VM_STATE">
4575	Invalid machine state.
4576	</result>
4577
4578	</desc>
4579	<param name="name" type="wstring" dir="in">
4580	<desc>Name of the storage controller.</desc>
4581	</param>
4582	<param name="controllerPort" type="long" dir="in">
4583	<desc>Storage controller port.</desc>
4584	</param>
4585	<param name="device" type="long" dir="in">
4586	<desc>Device slot in the given port.</desc>
4587	</param>
4588	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4589	<desc>New value for the bandwidth group or NULL for no group.</desc>
4590	</param>
4591	</method>
4592
4593	<method name="mountMedium">
4594	<desc>
4595	Mounts a medium (<link to="IMedium" />, identified
4596	by the given UUID @a id) to the given storage controller
4597	(<link to="IStorageController" />, identified by @a name),
4598	at the indicated port and device. The device must already exist;
4599	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4600
4601	This method is intended only for managing removable media, where the
4602	device is fixed but media is changeable at runtime (such as DVDs
4603	and floppies). It cannot be used for fixed media such as hard disks.
4604
4605	The @a controllerPort and @a device parameters specify the device slot and
4606	have have the same meaning as with <link to="IMachine::attachDevice" />.
4607
4608	The specified device slot can have a medium mounted, which will be
4609	unmounted first. Specifying a zero UUID (or an empty string) for
4610	@a medium does just an unmount.
4611
4612	See <link to="IMedium"/> for more detailed information about
4613	attaching media.
4614
4615	<result name="E_INVALIDARG">
4616	SATA device, SATA port, IDE port or IDE slot out of range.
4617	</result>
4618	<result name="VBOX_E_INVALID_OBJECT_STATE">
4619	Attempt to attach medium to an unregistered virtual machine.
4620	</result>
4621	<result name="VBOX_E_INVALID_VM_STATE">
4622	Invalid machine state.
4623	</result>
4624	<result name="VBOX_E_OBJECT_IN_USE">
4625	Medium already attached to this or another virtual machine.
4626	</result>
4627
4628	</desc>
4629	<param name="name" type="wstring" dir="in">
4630	<desc>Name of the storage controller to attach the medium to.</desc>
4631	</param>
4632	<param name="controllerPort" type="long" dir="in">
4633	<desc>Port to attach the medium to.</desc>
4634	</param>
4635	<param name="device" type="long" dir="in">
4636	<desc>Device slot in the given port to attach the medium to.</desc>
4637	</param>
4638	<param name="medium" type="IMedium" dir="in">
4639	<desc>Medium to mount or NULL for an empty drive.</desc>
4640	</param>
4641	<param name="force" type="boolean" dir="in">
4642	<desc>Allows to force unmount/mount of a medium which is locked by
4643	the device slot in the given port to attach the medium to.</desc>
4644	</param>
4645	</method>
4646
4647	<method name="getMedium" const="yes">
4648	<desc>
4649	Returns the virtual medium attached to a device slot of the specified
4650	bus.
4651
4652	Note that if the medium was indirectly attached by
4653	<link to="#mountMedium"/> to the given device slot then this
4654	method will return not the same object as passed to the
4655	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4656	more detailed information about mounting a medium.
4657
4658	<result name="VBOX_E_OBJECT_NOT_FOUND">
4659	No medium attached to given slot/bus.
4660	</result>
4661
4662	</desc>
4663	<param name="name" type="wstring" dir="in">
4664	<desc>Name of the storage controller the medium is attached to.</desc>
4665	</param>
4666	<param name="controllerPort" type="long" dir="in">
4667	<desc>Port to query.</desc>
4668	</param>
4669	<param name="device" type="long" dir="in">
4670	<desc>Device slot in the given port to query.</desc>
4671	</param>
4672	<param name="medium" type="IMedium" dir="return">
4673	<desc>Attached medium object.</desc>
4674	</param>
4675	</method>
4676
4677	<method name="getMediumAttachmentsOfController" const="yes">
4678	<desc>
4679	Returns an array of medium attachments which are attached to the
4680	the controller with the given name.
4681
4682	<result name="VBOX_E_OBJECT_NOT_FOUND">
4683	A storage controller with given name doesn't exist.
4684	</result>
4685	</desc>
4686	<param name="name" type="wstring" dir="in"/>
4687	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4688	</method>
4689
4690	<method name="getMediumAttachment" const="yes">
4691	<desc>
4692	Returns a medium attachment which corresponds to the controller with
4693	the given name, on the given port and device slot.
4694
4695	<result name="VBOX_E_OBJECT_NOT_FOUND">
4696	No attachment exists for the given controller/port/device combination.
4697	</result>
4698	</desc>
4699	<param name="name" type="wstring" dir="in"/>
4700	<param name="controllerPort" type="long" dir="in"/>
4701	<param name="device" type="long" dir="in"/>
4702	<param name="attachment" type="IMediumAttachment" dir="return"/>
4703	</method>
4704
4705	<method name="attachHostPciDevice">
4706	<desc>
4707	Attaches host PCI device with the given (host) PCI address to the
4708	PCI bus of the virtual machine. Please note, that this operation
4709	is two phase, as real attachment will happen when VM will start,
4710	and most information will be delivered as IHostPciDevicePlugEvent
4711	on IVirtualBox event source.
4712	<note>
4713	Not yet implemented.
4714	</note>
4715
4716	<see>IHostPciDevicePlugEvent</see>
4717
4718	<result name="VBOX_E_INVALID_VM_STATE">
4719	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4720	</result>
4721	<result name="VBOX_E_PDM_ERROR">
4722	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4723	</result>
4724	<result name="VBOX_E_NOT_SUPPORTED">
4725	Hardware or host OS doesn't allow PCI device passthrought.
4726	</result>
4727	</desc>
4728	<param name="hostAddress" type="long" dir="in">
4729	<desc>Address of the host PCI device.</desc>
4730	</param>
4731	<param name="desiredGuestAddress" type="long" dir="in">
4732	<desc>Desired position of this device on guest PCI bus.</desc>
4733	</param>
4734	<param name="tryToUnbind" type="boolean" dir="in">
4735	<desc>If VMM shall try to unbind existing drivers from the
4736	device before attaching it to the guest.</desc>
4737	</param>
4738	</method>
4739
4740	<method name="detachHostPciDevice">
4741	<desc>
4742	Detach host PCI device from the virtual machine.
4743	Also HostPciDevicePlugEvent on IVirtualBox event source
4744	will be delivered. As currently we don't support hot device
4745	unplug, IHostPciDevicePlugEvent event is delivered immediately.
4746
4747	<note>
4748	Not yet implemented.
4749	</note>
4750
4751	<see>IHostPciDevicePlugEvent</see>
4752
4753	<result name="VBOX_E_INVALID_VM_STATE">
4754	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4755	</result>
4756	<result name="VBOX_E_OBJECT_NOT_FOUND">
4757	This host device is not attached to this machine.
4758	</result>
4759	<result name="VBOX_E_PDM_ERROR">
4760	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4761	</result>
4762	<result name="VBOX_E_NOT_SUPPORTED">
4763	Hardware or host OS doesn't allow PCI device passthrought.
4764	</result>
4765	</desc>
4766	<param name="hostAddress" type="long" dir="in">
4767	<desc>Address of the host PCI device.</desc>
4768	</param>
4769	</method>
4770
4771	<method name="getNetworkAdapter" const="yes">
4772	<desc>
4773	Returns the network adapter associated with the given slot.
4774	Slots are numbered sequentially, starting with zero. The total
4775	number of adapters per machine is defined by the
4776	<link to="ISystemProperties::networkAdapterCount"/> property,
4777	so the maximum slot number is one less than that property's value.
4778
4779	<result name="E_INVALIDARG">
4780	Invalid @a slot number.
4781	</result>
4782
4783	</desc>
4784	<param name="slot" type="unsigned long" dir="in"/>
4785	<param name="adapter" type="INetworkAdapter" dir="return"/>
4786	</method>
4787
4788	<method name="addStorageController">
4789	<desc>
4790	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4791	machine and returns it as an instance of
4792	<link to="IStorageController" />.
4793
4794	@a name identifies the controller for subsequent calls such as
4795	<link to="#getStorageControllerByName" />,
4796	<link to="#getStorageControllerByInstance" />,
4797	<link to="#removeStorageController" />,
4798	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4799
4800	After the controller has been added, you can set its exact
4801	type by setting the <link to="IStorageController::controllerType" />.
4802
4803	<result name="VBOX_E_OBJECT_IN_USE">
4804	A storage controller with given name exists already.
4805	</result>
4806	<result name="E_INVALIDARG">
4807	Invalid @a controllerType.
4808	</result>
4809	</desc>
4810	<param name="name" type="wstring" dir="in"/>
4811	<param name="connectionType" type="StorageBus" dir="in"/>
4812	<param name="controller" type="IStorageController" dir="return"/>
4813	</method>
4814
4815	<method name="getStorageControllerByName" const="yes">
4816	<desc>
4817	Returns a storage controller with the given name.
4818
4819	<result name="VBOX_E_OBJECT_NOT_FOUND">
4820	A storage controller with given name doesn't exist.
4821	</result>
4822	</desc>
4823	<param name="name" type="wstring" dir="in"/>
4824	<param name="storageController" type="IStorageController" dir="return"/>
4825	</method>
4826
4827	<method name="getStorageControllerByInstance" const="yes">
4828	<desc>
4829	Returns a storage controller with the given instance number.
4830
4831	<result name="VBOX_E_OBJECT_NOT_FOUND">
4832	A storage controller with given instance number doesn't exist.
4833	</result>
4834	</desc>
4835	<param name="instance" type="unsigned long" dir="in"/>
4836	<param name="storageController" type="IStorageController" dir="return"/>
4837	</method>
4838
4839	<method name="removeStorageController">
4840	<desc>
4841	Removes a storage controller from the machine.
4842
4843	<result name="VBOX_E_OBJECT_NOT_FOUND">
4844	A storage controller with given name doesn't exist.
4845	</result>
4846	</desc>
4847	<param name="name" type="wstring" dir="in"/>
4848	</method>
4849
4850	<method name="setStorageControllerBootable">
4851	<desc>
4852	Sets the bootable flag of the storage controller with the given name.
4853
4854	<result name="VBOX_E_OBJECT_NOT_FOUND">
4855	A storage controller with given name doesn't exist.
4856	</result>
4857	<result name="VBOX_E_OBJECT_IN_USE">
4858	Another storage controller is marked as bootable already.
4859	</result>
4860	</desc>
4861	<param name="name" type="wstring" dir="in"/>
4862	<param name="bootable" type="boolean" dir="in"/>
4863	</method>
4864
4865	<method name="getSerialPort" const="yes">
4866	<desc>
4867	Returns the serial port associated with the given slot.
4868	Slots are numbered sequentially, starting with zero. The total
4869	number of serial ports per machine is defined by the
4870	<link to="ISystemProperties::serialPortCount"/> property,
4871	so the maximum slot number is one less than that property's value.
4872
4873	<result name="E_INVALIDARG">
4874	Invalid @a slot number.
4875	</result>
4876
4877	</desc>
4878	<param name="slot" type="unsigned long" dir="in"/>
4879	<param name="port" type="ISerialPort" dir="return"/>
4880	</method>
4881
4882	<method name="getParallelPort" const="yes">
4883	<desc>
4884	Returns the parallel port associated with the given slot.
4885	Slots are numbered sequentially, starting with zero. The total
4886	number of parallel ports per machine is defined by the
4887	<link to="ISystemProperties::parallelPortCount"/> property,
4888	so the maximum slot number is one less than that property's value.
4889
4890	<result name="E_INVALIDARG">
4891	Invalid @a slot number.
4892	</result>
4893
4894	</desc>
4895	<param name="slot" type="unsigned long" dir="in"/>
4896	<param name="port" type="IParallelPort" dir="return"/>
4897	</method>
4898
4899	<method name="getExtraDataKeys">
4900	<desc>
4901	Returns an array representing the machine-specific extra data keys
4902	which currently have values defined.
4903	</desc>
4904	<param name="value" type="wstring" dir="return" safearray="yes">
4905	<desc>Array of extra data keys.</desc>
4906	</param>
4907	</method>
4908
4909	<method name="getExtraData">
4910	<desc>
4911	Returns associated machine-specific extra data.
4912
4913	If the requested data @a key does not exist, this function will
4914	succeed and return an empty string in the @a value argument.
4915
4916	<result name="VBOX_E_FILE_ERROR">
4917	Settings file not accessible.
4918	</result>
4919	<result name="VBOX_E_XML_ERROR">
4920	Could not parse the settings file.
4921	</result>
4922
4923	</desc>
4924	<param name="key" type="wstring" dir="in">
4925	<desc>Name of the data key to get.</desc>
4926	</param>
4927	<param name="value" type="wstring" dir="return">
4928	<desc>Value of the requested data key.</desc>
4929	</param>
4930	</method>
4931
4932	<method name="setExtraData">
4933	<desc>
4934	Sets associated machine-specific extra data.
4935
4936	If you pass @c null or an empty string as a key @a value, the given
4937	@a key will be deleted.
4938
4939	<note>
4940	Before performing the actual data change, this method will ask all
4941	registered listeners using the
4942	<link to="IExtraDataCanChangeEvent"/>
4943	notification for a permission. If one of the listeners refuses the
4944	new value, the change will not be performed.
4945	</note>
4946	<note>
4947	On success, the
4948	<link to="IExtraDataChangedEvent"/> notification
4949	is called to inform all registered listeners about a successful data
4950	change.
4951	</note>
4952	<note>
4953	This method can be called outside the machine session and therefore
4954	it's a caller's responsibility to handle possible race conditions
4955	when several clients change the same key at the same time.
4956	</note>
4957
4958	<result name="VBOX_E_FILE_ERROR">
4959	Settings file not accessible.
4960	</result>
4961	<result name="VBOX_E_XML_ERROR">
4962	Could not parse the settings file.
4963	</result>
4964
4965	</desc>
4966	<param name="key" type="wstring" dir="in">
4967	<desc>Name of the data key to set.</desc>
4968	</param>
4969	<param name="value" type="wstring" dir="in">
4970	<desc>Value to assign to the key.</desc>
4971	</param>
4972	</method>
4973
4974	<method name="getCPUProperty" const="yes">
4975	<desc>
4976	Returns the virtual CPU boolean value of the specified property.
4977
4978	<result name="E_INVALIDARG">
4979	Invalid property.
4980	</result>
4981
4982	</desc>
4983	<param name="property" type="CPUPropertyType" dir="in">
4984	<desc>
4985	Property type to query.
4986	</desc>
4987	</param>
4988	<param name="value" type="boolean" dir="return">
4989	<desc>
4990	Property value.
4991	</desc>
4992	</param>
4993	</method>
4994
4995	<method name="setCPUProperty">
4996	<desc>
4997	Sets the virtual CPU boolean value of the specified property.
4998
4999	<result name="E_INVALIDARG">
5000	Invalid property.
5001	</result>
5002
5003	</desc>
5004	<param name="property" type="CPUPropertyType" dir="in">
5005	<desc>
5006	Property type to query.
5007	</desc>
5008	</param>
5009	<param name="value" type="boolean" dir="in">
5010	<desc>
5011	Property value.
5012	</desc>
5013	</param>
5014	</method>
5015
5016	<method name="getCPUIDLeaf" const="yes">
5017	<desc>
5018	Returns the virtual CPU cpuid information for the specified leaf.
5019
5020	Currently supported index values for cpuid:
5021	Standard CPUID leafs: 0 - 0xA
5022	Extended CPUID leafs: 0x80000000 - 0x8000000A
5023
5024	See the Intel and AMD programmer's manuals for detailed information
5025	about the cpuid instruction and its leafs.
5026	<result name="E_INVALIDARG">
5027	Invalid id.
5028	</result>
5029
5030	</desc>
5031	<param name="id" type="unsigned long" dir="in">
5032	<desc>
5033	CPUID leaf index.
5034	</desc>
5035	</param>
5036	<param name="valEax" type="unsigned long" dir="out">
5037	<desc>
5038	CPUID leaf value for register eax.
5039	</desc>
5040	</param>
5041	<param name="valEbx" type="unsigned long" dir="out">
5042	<desc>
5043	CPUID leaf value for register ebx.
5044	</desc>
5045	</param>
5046	<param name="valEcx" type="unsigned long" dir="out">
5047	<desc>
5048	CPUID leaf value for register ecx.
5049	</desc>
5050	</param>
5051	<param name="valEdx" type="unsigned long" dir="out">
5052	<desc>
5053	CPUID leaf value for register edx.
5054	</desc>
5055	</param>
5056	</method>
5057
5058	<method name="setCPUIDLeaf">
5059	<desc>
5060	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5061	are not passed unmodified. VirtualBox clears features that it doesn't support.
5062
5063	Currently supported index values for cpuid:
5064	Standard CPUID leafs: 0 - 0xA
5065	Extended CPUID leafs: 0x80000000 - 0x8000000A
5066
5067	See the Intel and AMD programmer's manuals for detailed information
5068	about the cpuid instruction and its leafs.
5069
5070	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5071	random crashes inside VMs.
5072	<result name="E_INVALIDARG">
5073	Invalid id.
5074	</result>
5075
5076	</desc>
5077	<param name="id" type="unsigned long" dir="in">
5078	<desc>
5079	CPUID leaf index.
5080	</desc>
5081	</param>
5082	<param name="valEax" type="unsigned long" dir="in">
5083	<desc>
5084	CPUID leaf value for register eax.
5085	</desc>
5086	</param>
5087	<param name="valEbx" type="unsigned long" dir="in">
5088	<desc>
5089	CPUID leaf value for register ebx.
5090	</desc>
5091	</param>
5092	<param name="valEcx" type="unsigned long" dir="in">
5093	<desc>
5094	CPUID leaf value for register ecx.
5095	</desc>
5096	</param>
5097	<param name="valEdx" type="unsigned long" dir="in">
5098	<desc>
5099	CPUID leaf value for register edx.
5100	</desc>
5101	</param>
5102	</method>
5103
5104	<method name="removeCPUIDLeaf">
5105	<desc>
5106	Removes the virtual CPU cpuid leaf for the specified index
5107
5108	<result name="E_INVALIDARG">
5109	Invalid id.
5110	</result>
5111
5112	</desc>
5113	<param name="id" type="unsigned long" dir="in">
5114	<desc>
5115	CPUID leaf index.
5116	</desc>
5117	</param>
5118	</method>
5119
5120	<method name="removeAllCPUIDLeaves">
5121	<desc>
5122	Removes all the virtual CPU cpuid leaves
5123	</desc>
5124	</method>
5125
5126	<method name="getHWVirtExProperty" const="yes">
5127	<desc>
5128	Returns the value of the specified hardware virtualization boolean property.
5129
5130	<result name="E_INVALIDARG">
5131	Invalid property.
5132	</result>
5133
5134	</desc>
5135	<param name="property" type="HWVirtExPropertyType" dir="in">
5136	<desc>
5137	Property type to query.
5138	</desc>
5139	</param>
5140	<param name="value" type="boolean" dir="return">
5141	<desc>
5142	Property value.
5143	</desc>
5144	</param>
5145	</method>
5146
5147	<method name="setHWVirtExProperty">
5148	<desc>
5149	Sets a new value for the specified hardware virtualization boolean property.
5150
5151	<result name="E_INVALIDARG">
5152	Invalid property.
5153	</result>
5154
5155	</desc>
5156	<param name="property" type="HWVirtExPropertyType" dir="in">
5157	<desc>
5158	Property type to set.
5159	</desc>
5160	</param>
5161	<param name="value" type="boolean" dir="in">
5162	<desc>
5163	New property value.
5164	</desc>
5165	</param>
5166	</method>
5167
5168	<method name="saveSettings">
5169	<desc>
5170	Saves any changes to machine settings made since the session
5171	has been opened or a new machine has been created, or since the
5172	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5173	For registered machines, new settings become visible to all
5174	other VirtualBox clients after successful invocation of this
5175	method.
5176	<note>
5177	The method sends <link to="IMachineDataChangedEvent"/>
5178	notification event after the configuration has been successfully
5179	saved (only for registered machines).
5180	</note>
5181	<note>
5182	Calling this method is only valid on instances returned
5183	by <link to="ISession::machine"/> and on new machines
5184	created by <link to="IVirtualBox::createMachine"/> but not
5185	yet registered, or on unregistered machines after calling
5186	<link to="IMachine::unregister"/>.
5187	</note>
5188
5189	<result name="VBOX_E_FILE_ERROR">
5190	Settings file not accessible.
5191	</result>
5192	<result name="VBOX_E_XML_ERROR">
5193	Could not parse the settings file.
5194	</result>
5195	<result name="E_ACCESSDENIED">
5196	Modification request refused.
5197	</result>
5198
5199	</desc>
5200	</method>
5201
5202	<method name="discardSettings">
5203	<desc>
5204	Discards any changes to the machine settings made since the session
5205	has been opened or since the last call to <link to="#saveSettings"/>
5206	or <link to="#discardSettings"/>.
5207	<note>
5208	Calling this method is only valid on instances returned
5209	by <link to="ISession::machine"/> and on new machines
5210	created by <link to="IVirtualBox::createMachine"/> or
5211	opened by <link to="IVirtualBox::openMachine"/> but not
5212	yet registered, or on unregistered machines after calling
5213	<link to="IMachine::unregister"/>.
5214	</note>
5215
5216	<result name="VBOX_E_INVALID_VM_STATE">
5217	Virtual machine is not mutable.
5218	</result>
5219
5220	</desc>
5221	</method>
5222
5223	<method name="unregister">
5224	<desc>
5225	Unregisters the machine, which must have been previously registered using
5226	<link to="IVirtualBox::registerMachine"/>, and optionally do additional
5227	cleanup before the machine is unregistered.
5228
5229	This method does not delete any files. It only changes the machine configuration and
5230	the list of registered machines in the VirtualBox object. To delete the files which
5231	belonged to the machine, including the XML file of the machine itself, call
5232	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5233	from this method.
5234
5235	How thoroughly this method cleans up the machine configuration before unregistering
5236	the machine depends on the @a cleanupMode argument.
5237
5238	<ul>
5239	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5240	cleanup will be performed. The call will fail if the machine is in "Saved" state
5241	or has any snapshots or any media attached (see <link to="IMediumAttachment" />.
5242	It is the responsibility of the caller to delete all such configuration in this mode.
5243	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5244	which it replaces.</li>
5245	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5246	state or if it has snapshots or media attached. All media attached to the current machine
5247	state or in snapshots will be detached. No medium objects will be returned; all of the
5248	machine's media will remain open.</li>
5249	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5250	except that all the hard disk medium objects which were detached from the machine will
5251	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5252	API for closing and deletion.</li>
5253	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5254	that all media will be returned in the array, including removeable media like DVDs and
5255	floppies. This might be useful if the user wants to inspect in detail which media were
5256	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5257	in that case because users will typically want to preserve ISO and RAW image files.</li>
5258	</ul>
5259
5260	This API does not verify whether the media files returned in the array are still
5261	attached to other machines (i.e. shared between several machines). If such a shared
5262	image is passed to <link to="#delete" /> however, closing the image will fail there
5263	and the image will be silently skipped.
5264
5265	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5266	resulting IMedia array to <link to="#delete"/>. This way, the machine is completely
5267	deleted with all its saved states and hard disk images, but images for removeable
5268	drives (such as ISO and RAW files) will remain on disk.
5269
5270	The call will fail if the machine is currently locked (see <link to="ISession" />).
5271	It implicitly calls <link to="#saveSettings"/> to save all current machine settings
5272	before unregistering it.
5273
5274	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5275	is fired.
5276
5277	<note>
5278	If the given machine is inaccessible (see <link to="#accessible"/>), it
5279	will be unregistered and fully uninitialized right afterwards. As a result,
5280	the returned machine object will be unusable and an attempt to call
5281	<b>any</b> method will return the "Object not ready" error.
5282	</note>
5283
5284	<result name="VBOX_E_INVALID_OBJECT_STATE">
5285	Machine is currently locked for a session.
5286	</result>
5287	</desc>
5288
5289	<param name="cleanupMode" type="CleanupMode" dir="in">
5290	<desc>How to clean up after the machine has been unregistered.</desc>
5291	</param>
5292	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5293	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5294	</param>
5295	</method>
5296
5297	<method name="delete">
5298	<desc>
5299	Deletes the files associated with this machine from disk. If medium objects are passed
5300	in with the @a aMedia argument, they are closed and, if closing was successful, their
5301	storage files are deleted as well. For convenience, this array of media files can be
5302	the same as the one returned from a previous <link to="#unregister" /> call.
5303
5304	This method must only be called on machines which are either write-locked (i.e. on instances
5305	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5306	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5307	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5308
5309	The following files will be deleted by this method:
5310	<ul>
5311	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5312	argument other than "UnregisterOnly", this will delete all saved state files that
5313	the machine had in use; possibly one if the machine was in "Saved" state and one
5314	for each online snapshot that the machine had.</li>
5315	<li>On each medium object passed in the @a aMedia array, this will call
5316	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5317	medium's storage on disk. Since the close() call will fail if the medium is still
5318	in use, e.g. because it is still attached to a second machine; in that case the
5319	storage will not be deleted.</li>
5320	<li>Finally, the machine's own XML file will be deleted.</li>
5321	</ul>
5322
5323	Since deleting large disk image files can be a time-consuming I/O operation, this
5324	method operates asynchronously and returns an IProgress object to allow the caller
5325	to monitor the progress. There will be one sub-operation for each file that is
5326	being deleted (saved state or medium storage file).
5327
5328	<note>
5329	<link to="#settingsModified"/> will return @c true after this
5330	method successfully returns.
5331	</note>
5332
5333	<result name="VBOX_E_INVALID_VM_STATE">
5334	Machine is registered but not write-locked.
5335	</result>
5336	<result name="VBOX_E_IPRT_ERROR">
5337	Could not delete the settings file.
5338	</result>
5339	</desc>
5340	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5341	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5342	</param>
5343	<param name="aProgress" type="IProgress" dir="return">
5344	<desc>Progress object to track the operation completion.</desc>
5345	</param>
5346	</method>
5347
5348	<method name="export">
5349	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5350	steps required to export VirtualBox machines to OVF.
5351	</desc>
5352
5353	<param name="aAppliance" type="IAppliance" dir="in">
5354	<desc>Appliance to export this machine to.</desc>
5355	</param>
5356	<param name="location" type="wstring" dir="in">
5357	<desc>The target location.</desc>
5358	</param>
5359	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5360	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5361	</param>
5362	</method >
5363
5364	<method name="findSnapshot">
5365	<desc>
5366	Returns a snapshot of this machine with the given name or UUID.
5367
5368	Returns a snapshot of this machine with the given UUID.
5369	A @c null argument can be used to obtain the first snapshot
5370	taken on this machine. To traverse the whole tree of snapshots
5371	starting from the root, inspect the root snapshot's
5372	<link to="ISnapshot::children" /> attribute and recurse over those children.
5373
5374	<result name="VBOX_E_OBJECT_NOT_FOUND">
5375	Virtual machine has no snapshots or snapshot not found.
5376	</result>
5377
5378	</desc>
5379	<param name="nameOrId" type="wstring" dir="in">
5380	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5381	</param>
5382	<param name="snapshot" type="ISnapshot" dir="return">
5383	<desc>Snapshot object with the given name.</desc>
5384	</param>
5385	</method>
5386
5387	<method name="createSharedFolder">
5388	<desc>
5389	Creates a new permanent shared folder by associating the given logical
5390	name with the given host path, adds it to the collection of shared
5391	folders and starts sharing it. Refer to the description of
5392	<link to="ISharedFolder"/> to read more about logical names.
5393
5394	<result name="VBOX_E_OBJECT_IN_USE">
5395	Shared folder already exists.
5396	</result>
5397	<result name="VBOX_E_FILE_ERROR">
5398	Shared folder @a hostPath not accessible.
5399	</result>
5400
5401	</desc>
5402	<param name="name" type="wstring" dir="in">
5403	<desc>Unique logical name of the shared folder.</desc>
5404	</param>
5405	<param name="hostPath" type="wstring" dir="in">
5406	<desc>Full path to the shared folder in the host file system.</desc>
5407	</param>
5408	<param name="writable" type="boolean" dir="in">
5409	<desc>Whether the share is writable or readonly.</desc>
5410	</param>
5411	<param name="automount" type="boolean" dir="in">
5412	<desc>Whether the share gets automatically mounted by the guest
5413	or not.</desc>
5414	</param>
5415	</method>
5416
5417	<method name="removeSharedFolder">
5418	<desc>
5419	Removes the permanent shared folder with the given name previously
5420	created by <link to="#createSharedFolder"/> from the collection of
5421	shared folders and stops sharing it.
5422
5423	<result name="VBOX_E_INVALID_VM_STATE">
5424	Virtual machine is not mutable.
5425	</result>
5426	<result name="VBOX_E_OBJECT_NOT_FOUND">
5427	Shared folder @a name does not exist.
5428	</result>
5429
5430	</desc>
5431	<param name="name" type="wstring" dir="in">
5432	<desc>Logical name of the shared folder to remove.</desc>
5433	</param>
5434	</method>
5435
5436	<method name="canShowConsoleWindow">
5437	<desc>
5438	Returns @c true if the VM console process can activate the
5439	console window and bring it to foreground on the desktop of
5440	the host PC.
5441	<note>
5442	This method will fail if a session for this machine is not
5443	currently open.
5444	</note>
5445
5446	<result name="VBOX_E_INVALID_VM_STATE">
5447	Machine session is not open.
5448	</result>
5449
5450	</desc>
5451	<param name="canShow" type="boolean" dir="return">
5452	<desc>
5453	@c true if the console window can be shown and @c false otherwise.
5454	</desc>
5455	</param>
5456	</method>
5457
5458	<method name="showConsoleWindow">
5459	<desc>
5460	Activates the console window and brings it to foreground on
5461	the desktop of the host PC. Many modern window managers on
5462	many platforms implement some sort of focus stealing
5463	prevention logic, so that it may be impossible to activate
5464	a window without the help of the currently active
5465	application. In this case, this method will return a non-zero
5466	identifier that represents the top-level window of the VM
5467	console process. The caller, if it represents a currently
5468	active process, is responsible to use this identifier (in a
5469	platform-dependent manner) to perform actual window
5470	activation.
5471	<note>
5472	This method will fail if a session for this machine is not
5473	currently open.
5474	</note>
5475
5476	<result name="VBOX_E_INVALID_VM_STATE">
5477	Machine session is not open.
5478	</result>
5479
5480	</desc>
5481	<param name="winId" type="long long" dir="return">
5482	<desc>
5483	Platform-dependent identifier of the top-level VM console
5484	window, or zero if this method has performed all actions
5485	necessary to implement the <i>show window</i> semantics for
5486	the given platform and/or VirtualBox front-end.
5487	</desc>
5488	</param>
5489	</method>
5490
5491	<method name="getGuestProperty" const="yes">
5492	<desc>
5493	Reads an entry from the machine's guest property store.
5494
5495	<result name="VBOX_E_INVALID_VM_STATE">
5496	Machine session is not open.
5497	</result>
5498
5499	</desc>
5500	<param name="name" type="wstring" dir="in">
5501	<desc>
5502	The name of the property to read.
5503	</desc>
5504	</param>
5505	<param name="value" type="wstring" dir="out">
5506	<desc>
5507	The value of the property. If the property does not exist then this
5508	will be empty.
5509	</desc>
5510	</param>
5511	<param name="timestamp" type="long long" dir="out">
5512	<desc>
5513	The time at which the property was last modified, as seen by the
5514	server process.
5515	</desc>
5516	</param>
5517	<param name="flags" type="wstring" dir="out">
5518	<desc>
5519	Additional property parameters, passed as a comma-separated list of
5520	"name=value" type entries.
5521	</desc>
5522	</param>
5523	</method>
5524
5525	<method name="getGuestPropertyValue" const="yes">
5526	<desc>
5527	Reads a value from the machine's guest property store.
5528
5529	<result name="VBOX_E_INVALID_VM_STATE">
5530	Machine session is not open.
5531	</result>
5532
5533	</desc>
5534	<param name="property" type="wstring" dir="in">
5535	<desc>
5536	The name of the property to read.
5537	</desc>
5538	</param>
5539	<param name="value" type="wstring" dir="return">
5540	<desc>
5541	The value of the property. If the property does not exist then this
5542	will be empty.
5543	</desc>
5544	</param>
5545	</method>
5546
5547	<method name="getGuestPropertyTimestamp" const="yes">
5548	<desc>
5549	Reads a property timestamp from the machine's guest property store.
5550
5551	<result name="VBOX_E_INVALID_VM_STATE">
5552	Machine session is not open.
5553	</result>
5554
5555	</desc>
5556	<param name="property" type="wstring" dir="in">
5557	<desc>
5558	The name of the property to read.
5559	</desc>
5560	</param>
5561	<param name="value" type="long long" dir="return">
5562	<desc>
5563	The timestamp. If the property does not exist then this will be
5564	empty.
5565	</desc>
5566	</param>
5567	</method>
5568
5569	<method name="setGuestProperty">
5570	<desc>
5571	Sets, changes or deletes an entry in the machine's guest property
5572	store.
5573
5574	<result name="E_ACCESSDENIED">
5575	Property cannot be changed.
5576	</result>
5577	<result name="E_INVALIDARG">
5578	Invalid @a flags.
5579	</result>
5580	<result name="VBOX_E_INVALID_VM_STATE">
5581	Virtual machine is not mutable or session not open.
5582	</result>
5583	<result name="VBOX_E_INVALID_OBJECT_STATE">
5584	Cannot set transient property when machine not running.
5585	</result>
5586
5587	</desc>
5588	<param name="property" type="wstring" dir="in">
5589	<desc>
5590	The name of the property to set, change or delete.
5591	</desc>
5592	</param>
5593	<param name="value" type="wstring" dir="in">
5594	<desc>
5595	The new value of the property to set, change or delete. If the
5596	property does not yet exist and value is non-empty, it will be
5597	created. If the value is @c null or empty, the property will be
5598	deleted if it exists.
5599	</desc>
5600	</param>
5601	<param name="flags" type="wstring" dir="in">
5602	<desc>
5603	Additional property parameters, passed as a comma-separated list of
5604	"name=value" type entries.
5605	</desc>
5606	</param>
5607	</method>
5608
5609	<method name="setGuestPropertyValue">
5610	<desc>
5611	Sets, changes or deletes a value in the machine's guest property
5612	store. The flags field will be left unchanged or created empty for a
5613	new property.
5614
5615	<result name="E_ACCESSDENIED">
5616	Property cannot be changed.
5617	</result>
5618	<result name="VBOX_E_INVALID_VM_STATE">
5619	Virtual machine is not mutable or session not open.
5620	</result>
5621	<result name="VBOX_E_INVALID_OBJECT_STATE">
5622	Cannot set transient property when machine not running.
5623	</result>
5624	</desc>
5625
5626	<param name="property" type="wstring" dir="in">
5627	<desc>
5628	The name of the property to set, change or delete.
5629	</desc>
5630	</param>
5631	<param name="value" type="wstring" dir="in">
5632	<desc>
5633	The new value of the property to set, change or delete. If the
5634	property does not yet exist and value is non-empty, it will be
5635	created. If the value is @c null or empty, the property will be
5636	deleted if it exists.
5637	</desc>
5638	</param>
5639	</method>
5640
5641	<method name="enumerateGuestProperties">
5642	<desc>
5643	Return a list of the guest properties matching a set of patterns along
5644	with their values, time stamps and flags.
5645	</desc>
5646	<param name="patterns" type="wstring" dir="in">
5647	<desc>
5648	The patterns to match the properties against, separated by '\|'
5649	characters. If this is empty or @c null, all properties will match.
5650	</desc>
5651	</param>
5652	<param name="name" type="wstring" dir="out" safearray="yes">
5653	<desc>
5654	The names of the properties returned.
5655	</desc>
5656	</param>
5657	<param name="value" type="wstring" dir="out" safearray="yes">
5658	<desc>
5659	The values of the properties returned. The array entries match the
5660	corresponding entries in the @a name array.
5661	</desc>
5662	</param>
5663	<param name="timestamp" type="long long" dir="out" safearray="yes">
5664	<desc>
5665	The time stamps of the properties returned. The array entries match
5666	the corresponding entries in the @a name array.
5667	</desc>
5668	</param>
5669	<param name="flags" type="wstring" dir="out" safearray="yes">
5670	<desc>
5671	The flags of the properties returned. The array entries match the
5672	corresponding entries in the @a name array.
5673	</desc>
5674	</param>
5675	</method>
5676
5677	<method name="querySavedGuestSize">
5678	<desc>
5679	Returns the guest dimensions from the saved state.
5680	</desc>
5681	<param name="screenId" type="unsigned long" dir="in">
5682	<desc>
5683	Saved guest screen to query info from.
5684	</desc>
5685	</param>
5686	<param name="width" type="unsigned long" dir="out">
5687	<desc>
5688	Guest width at the time of the saved state was taken.
5689	</desc>
5690	</param>
5691	<param name="height" type="unsigned long" dir="out">
5692	<desc>
5693	Guest height at the time of the saved state was taken.
5694	</desc>
5695	</param>
5696	</method>
5697
5698	<method name="querySavedThumbnailSize">
5699	<desc>
5700	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5701	</desc>
5702	<param name="screenId" type="unsigned long" dir="in">
5703	<desc>
5704	Saved guest screen to query info from.
5705	</desc>
5706	</param>
5707	<param name="size" type="unsigned long" dir="out">
5708	<desc>
5709	Size of buffer required to store the bitmap.
5710	</desc>
5711	</param>
5712	<param name="width" type="unsigned long" dir="out">
5713	<desc>
5714	Bitmap width.
5715	</desc>
5716	</param>
5717	<param name="height" type="unsigned long" dir="out">
5718	<desc>
5719	Bitmap height.
5720	</desc>
5721	</param>
5722	</method>
5723
5724	<method name="readSavedThumbnailToArray">
5725	<desc>
5726	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5727	</desc>
5728	<param name="screenId" type="unsigned long" dir="in">
5729	<desc>
5730	Saved guest screen to read from.
5731	</desc>
5732	</param>
5733	<param name="BGR" type="boolean" dir="in">
5734	<desc>
5735	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5736	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5737	</desc>
5738	</param>
5739	<param name="width" type="unsigned long" dir="out">
5740	<desc>
5741	Bitmap width.
5742	</desc>
5743	</param>
5744	<param name="height" type="unsigned long" dir="out">
5745	<desc>
5746	Bitmap height.
5747	</desc>
5748	</param>
5749	<param name="data" type="octet" safearray="yes" dir="return">
5750	<desc>
5751	Array with resulting bitmap data.
5752	</desc>
5753	</param>
5754	</method>
5755
5756	<method name="readSavedThumbnailPNGToArray">
5757	<desc>
5758	Thumbnail in PNG format is retrieved to an array of bytes.
5759	</desc>
5760	<param name="screenId" type="unsigned long" dir="in">
5761	<desc>
5762	Saved guest screen to read from.
5763	</desc>
5764	</param>
5765	<param name="width" type="unsigned long" dir="out">
5766	<desc>
5767	Image width.
5768	</desc>
5769	</param>
5770	<param name="height" type="unsigned long" dir="out">
5771	<desc>
5772	Image height.
5773	</desc>
5774	</param>
5775	<param name="data" type="octet" dir="return" safearray="yes">
5776	<desc>
5777	Array with resulting PNG data.
5778	</desc>
5779	</param>
5780	</method>
5781
5782	<method name="querySavedScreenshotPNGSize">
5783	<desc>
5784	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5785	</desc>
5786	<param name="screenId" type="unsigned long" dir="in">
5787	<desc>
5788	Saved guest screen to query info from.
5789	</desc>
5790	</param>
5791	<param name="size" type="unsigned long" dir="out">
5792	<desc>
5793	Size of buffer required to store the PNG binary data.
5794	</desc>
5795	</param>
5796	<param name="width" type="unsigned long" dir="out">
5797	<desc>
5798	Image width.
5799	</desc>
5800	</param>
5801	<param name="height" type="unsigned long" dir="out">
5802	<desc>
5803	Image height.
5804	</desc>
5805	</param>
5806	</method>
5807
5808	<method name="readSavedScreenshotPNGToArray">
5809	<desc>
5810	Screenshot in PNG format is retrieved to an array of bytes.
5811	</desc>
5812	<param name="screenId" type="unsigned long" dir="in">
5813	<desc>
5814	Saved guest screen to read from.
5815	</desc>
5816	</param>
5817	<param name="width" type="unsigned long" dir="out">
5818	<desc>
5819	Image width.
5820	</desc>
5821	</param>
5822	<param name="height" type="unsigned long" dir="out">
5823	<desc>
5824	Image height.
5825	</desc>
5826	</param>
5827	<param name="data" type="octet" dir="return" safearray="yes">
5828	<desc>
5829	Array with resulting PNG data.
5830	</desc>
5831	</param>
5832	</method>
5833
5834	<method name="hotPlugCPU">
5835	<desc>
5836	Plugs a CPU into the machine.
5837	</desc>
5838	<param name="cpu" type="unsigned long" dir="in">
5839	<desc>
5840	The CPU id to insert.
5841	</desc>
5842	</param>
5843	</method>
5844
5845	<method name="hotUnplugCPU">
5846	<desc>
5847	Removes a CPU from the machine.
5848	</desc>
5849	<param name="cpu" type="unsigned long" dir="in">
5850	<desc>
5851	The CPU id to remove.
5852	</desc>
5853	</param>
5854	</method>
5855
5856	<method name="getCPUStatus">
5857	<desc>
5858	Returns the current status of the given CPU.
5859	</desc>
5860	<param name="cpu" type="unsigned long" dir="in">
5861	<desc>
5862	The CPU id to check for.
5863	</desc>
5864	</param>
5865	<param name="attached" type="boolean" dir="return">
5866	<desc>
5867	Status of the CPU.
5868	</desc>
5869	</param>
5870	</method>
5871
5872	<method name="queryLogFilename">
5873	<desc>
5874	Queries for the VM log file name of an given index. Returns an empty
5875	string if a log file with that index doesn't exists.
5876	</desc>
5877	<param name="idx" type="unsigned long" dir="in">
5878	<desc>
5879	Which log file name to query. 0=current log file.
5880	</desc>
5881	</param>
5882	<param name="filename" type="wstring" dir="return">
5883	<desc>
5884	On return the full path to the log file or an empty string on error.
5885	</desc>
5886	</param>
5887	</method>
5888
5889	<method name="readLog">
5890	<desc>
5891	Reads the VM log file. The chunk size is limited, so even if you
5892	ask for a big piece there might be less data returned.
5893	</desc>
5894	<param name="idx" type="unsigned long" dir="in">
5895	<desc>
5896	Which log file to read. 0=current log file.
5897	</desc>
5898	</param>
5899	<param name="offset" type="long long" dir="in">
5900	<desc>
5901	Offset in the log file.
5902	</desc>
5903	</param>
5904	<param name="size" type="long long" dir="in">
5905	<desc>
5906	Chunk size to read in the log file.
5907	</desc>
5908	</param>
5909	<param name="data" type="octet" dir="return" safearray="yes">
5910	<desc>
5911	Data read from the log file. A data size of 0 means end of file
5912	if the requested chunk size was not 0. This is the unprocessed
5913	file data, i.e. the line ending style depends on the platform of
5914	the system the server is running on.
5915	</desc>
5916	</param>
5917	</method>
5918	</interface>
5919
5920	<!--
5921	// IConsole
5922	/////////////////////////////////////////////////////////////////////////
5923	-->
5924
5925	<interface
5926	name="IVRDEServerInfo" extends="$unknown"
5927	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
5928	wsmap="struct"
5929	>
5930	<desc>
5931	Contains information about the remote desktop (VRDE) server capabilities and status.
5932	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
5933	</desc>
5934
5935	<attribute name="active" type="boolean" readonly="yes">
5936	<desc>
5937	Whether the remote desktop connection is active.
5938	</desc>
5939	</attribute>
5940
5941	<attribute name="port" type="long" readonly="yes">
5942	<desc>
5943	VRDE server port number. If this property is equal to <tt>0</tt>, then
5944	the VRDE server failed to start, usually because there are no free IP
5945	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
5946	server has not yet been started.
5947	</desc>
5948	</attribute>
5949
5950	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5951	<desc>
5952	How many times a client connected.
5953	</desc>
5954	</attribute>
5955
5956	<attribute name="beginTime" type="long long" readonly="yes">
5957	<desc>
5958	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5959	</desc>
5960	</attribute>
5961
5962	<attribute name="endTime" type="long long" readonly="yes">
5963	<desc>
5964	When the last connection was terminated or the current time, if
5965	connection is still active, in milliseconds since 1970-01-01 UTC.
5966	</desc>
5967	</attribute>
5968
5969	<attribute name="bytesSent" type="long long" readonly="yes">
5970	<desc>
5971	How many bytes were sent in last or current, if still active, connection.
5972	</desc>
5973	</attribute>
5974
5975	<attribute name="bytesSentTotal" type="long long" readonly="yes">
5976	<desc>
5977	How many bytes were sent in all connections.
5978	</desc>
5979	</attribute>
5980
5981	<attribute name="bytesReceived" type="long long" readonly="yes">
5982	<desc>
5983	How many bytes were received in last or current, if still active, connection.
5984	</desc>
5985	</attribute>
5986
5987	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
5988	<desc>
5989	How many bytes were received in all connections.
5990	</desc>
5991	</attribute>
5992
5993	<attribute name="user" type="wstring" readonly="yes">
5994	<desc>
5995	Login user name supplied by the client.
5996	</desc>
5997	</attribute>
5998
5999	<attribute name="domain" type="wstring" readonly="yes">
6000	<desc>
6001	Login domain name supplied by the client.
6002	</desc>
6003	</attribute>
6004
6005	<attribute name="clientName" type="wstring" readonly="yes">
6006	<desc>
6007	The client name supplied by the client.
6008	</desc>
6009	</attribute>
6010
6011	<attribute name="clientIP" type="wstring" readonly="yes">
6012	<desc>
6013	The IP address of the client.
6014	</desc>
6015	</attribute>
6016
6017	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6018	<desc>
6019	The client software version number.
6020	</desc>
6021	</attribute>
6022
6023	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6024	<desc>
6025	Public key exchange method used when connection was established.
6026	Values: 0 - RDP4 public key exchange scheme.
6027	1 - X509 certificates were sent to client.
6028	</desc>
6029	</attribute>
6030
6031	</interface>
6032
6033	<interface
6034	name="IConsole" extends="$unknown"
6035	uuid="515e8e8d-f932-4d8e-9f32-79a52aead882"
6036	wsmap="managed"
6037	>
6038	<desc>
6039	The IConsole interface represents an interface to control virtual
6040	machine execution.
6041
6042	A console object gets created when a machine has been locked for a
6043	particular session (client process) using <link to="IMachine::lockMachine" />
6044	or <link to="IMachine::launchVMProcess"/>. The console object can
6045	then be found in the session's <link to="ISession::console" /> attribute.
6046
6047	Methods of the IConsole interface allow the caller to query the current
6048	virtual machine execution state, pause the machine or power it down, save
6049	the machine state or take a snapshot, attach and detach removable media
6050	and so on.
6051
6052	<see>ISession</see>
6053	</desc>
6054
6055	<attribute name="machine" type="IMachine" readonly="yes">
6056	<desc>
6057	Machine object for this console session.
6058	<note>
6059	This is a convenience property, it has the same value as
6060	<link to="ISession::machine"/> of the corresponding session
6061	object.
6062	</note>
6063	</desc>
6064	</attribute>
6065
6066	<attribute name="state" type="MachineState" readonly="yes">
6067	<desc>
6068	Current execution state of the machine.
6069	<note>
6070	This property always returns the same value as the corresponding
6071	property of the IMachine object for this console session.
6072	For the process that owns (executes) the VM, this is the
6073	preferable way of querying the VM state, because no IPC
6074	calls are made.
6075	</note>
6076	</desc>
6077	</attribute>
6078
6079	<attribute name="guest" type="IGuest" readonly="yes">
6080	<desc>Guest object.</desc>
6081	</attribute>
6082
6083	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6084	<desc>
6085	Virtual keyboard object.
6086	<note>
6087	If the machine is not running, any attempt to use
6088	the returned object will result in an error.
6089	</note>
6090	</desc>
6091	</attribute>
6092
6093	<attribute name="mouse" type="IMouse" readonly="yes">
6094	<desc>
6095	Virtual mouse object.
6096	<note>
6097	If the machine is not running, any attempt to use
6098	the returned object will result in an error.
6099	</note>
6100	</desc>
6101	</attribute>
6102
6103	<attribute name="display" type="IDisplay" readonly="yes">
6104	<desc>Virtual display object.
6105	<note>
6106	If the machine is not running, any attempt to use
6107	the returned object will result in an error.
6108	</note>
6109	</desc>
6110	</attribute>
6111
6112	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6113	<desc>Debugging interface.</desc>
6114	</attribute>
6115
6116	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6117	<desc>
6118	Collection of USB devices currently attached to the virtual
6119	USB controller.
6120	<note>
6121	The collection is empty if the machine is not running.
6122	</note>
6123	</desc>
6124	</attribute>
6125
6126	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6127	<desc>
6128	List of USB devices currently attached to the remote VRDE client.
6129	Once a new device is physically attached to the remote host computer,
6130	it appears in this list and remains there until detached.
6131	</desc>
6132	</attribute>
6133
6134	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6135	<desc>
6136	Collection of shared folders for the current session. These folders
6137	are called transient shared folders because they are available to the
6138	guest OS running inside the associated virtual machine only for the
6139	duration of the session (as opposed to
6140	<link to="IMachine::sharedFolders"/> which represent permanent shared
6141	folders). When the session is closed (e.g. the machine is powered down),
6142	these folders are automatically discarded.
6143
6144	New shared folders are added to the collection using
6145	<link to="#createSharedFolder"/>. Existing shared folders can be
6146	removed using <link to="#removeSharedFolder"/>.
6147	</desc>
6148	</attribute>
6149
6150	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6151	<desc>
6152	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6153	</desc>
6154	</attribute>
6155
6156	<attribute name="eventSource" type="IEventSource" readonly="yes">
6157	<desc>
6158	Event source for console events.
6159	</desc>
6160	</attribute>
6161
6162	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6163	<desc>Array of PCI devices attached to this machine.</desc>
6164	</attribute>
6165
6166	<method name="powerUp">
6167	<desc>
6168	Starts the virtual machine execution using the current machine
6169	state (that is, its current execution state, current settings and
6170	current storage devices).
6171
6172	<note>
6173	This method is only useful for front-ends that want to actually
6174	execute virtual machines in their own process (like the VirtualBox
6175	or VBoxSDL front-ends). Unless you are intending to write such a
6176	front-end, do not call this method. If you simply want to
6177	start virtual machine execution using one of the existing front-ends
6178	(for example the VirtualBox GUI or headless server), use
6179	<link to="IMachine::launchVMProcess"/> instead; these
6180	front-ends will power up the machine automatically for you.
6181	</note>
6182
6183	If the machine is powered off or aborted, the execution will
6184	start from the beginning (as if the real hardware were just
6185	powered on).
6186
6187	If the machine is in the <link to="MachineState_Saved"/> state,
6188	it will continue its execution the point where the state has
6189	been saved.
6190
6191	If the machine <link to="IMachine::teleporterEnabled"/> property is
6192	enabled on the machine being powered up, the machine will wait for an
6193	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6194	state. The returned progress object will have at least three
6195	operations where the last three are defined as: (1) powering up and
6196	starting TCP server, (2) waiting for incoming teleportations, and
6197	(3) perform teleportation. These operations will be reflected as the
6198	last three operations of the progress objected returned by
6199	<link to="IMachine::launchVMProcess"/> as well.
6200
6201	<see>#saveState</see>
6202
6203	<result name="VBOX_E_INVALID_VM_STATE">
6204	Virtual machine already running.
6205	</result>
6206	<result name="VBOX_E_HOST_ERROR">
6207	Host interface does not exist or name not set.
6208	</result>
6209	<result name="VBOX_E_FILE_ERROR">
6210	Invalid saved state file.
6211	</result>
6212	</desc>
6213	<param name="progress" type="IProgress" dir="return">
6214	<desc>Progress object to track the operation completion.</desc>
6215	</param>
6216	</method>
6217
6218	<method name="powerUpPaused">
6219	<desc>
6220	Identical to powerUp except that the VM will enter the
6221	<link to="MachineState_Paused"/> state, instead of
6222	<link to="MachineState_Running"/>.
6223
6224	<see>#powerUp</see>
6225	<result name="VBOX_E_INVALID_VM_STATE">
6226	Virtual machine already running.
6227	</result>
6228	<result name="VBOX_E_HOST_ERROR">
6229	Host interface does not exist or name not set.
6230	</result>
6231	<result name="VBOX_E_FILE_ERROR">
6232	Invalid saved state file.
6233	</result>
6234	</desc>
6235	<param name="progress" type="IProgress" dir="return">
6236	<desc>Progress object to track the operation completion.</desc>
6237	</param>
6238	</method>
6239
6240	<method name="powerDown">
6241	<desc>
6242	Initiates the power down procedure to stop the virtual machine
6243	execution.
6244
6245	The completion of the power down procedure is tracked using the returned
6246	IProgress object. After the operation is complete, the machine will go
6247	to the PoweredOff state.
6248	<result name="VBOX_E_INVALID_VM_STATE">
6249	Virtual machine must be Running, Paused or Stuck to be powered down.
6250	</result>
6251	</desc>
6252	<param name="progress" type="IProgress" dir="return">
6253	<desc>Progress object to track the operation completion.</desc>
6254	</param>
6255	</method>
6256
6257	<method name="reset">
6258	<desc>Resets the virtual machine.
6259	<result name="VBOX_E_INVALID_VM_STATE">
6260	Virtual machine not in Running state.
6261	</result>
6262	<result name="VBOX_E_VM_ERROR">
6263	Virtual machine error in reset operation.
6264	</result>
6265	</desc>
6266	</method>
6267
6268	<method name="pause">
6269	<desc>Pauses the virtual machine execution.
6270	<result name="VBOX_E_INVALID_VM_STATE">
6271	Virtual machine not in Running state.
6272	</result>
6273	<result name="VBOX_E_VM_ERROR">
6274	Virtual machine error in suspend operation.
6275	</result>
6276	</desc>
6277	</method>
6278
6279	<method name="resume">
6280	<desc>Resumes the virtual machine execution.
6281	<result name="VBOX_E_INVALID_VM_STATE">
6282	Virtual machine not in Paused state.
6283	</result>
6284	<result name="VBOX_E_VM_ERROR">
6285	Virtual machine error in resume operation.
6286	</result>
6287	</desc>
6288	</method>
6289
6290	<method name="powerButton">
6291	<desc>Sends the ACPI power button event to the guest.
6292	<result name="VBOX_E_INVALID_VM_STATE">
6293	Virtual machine not in Running state.
6294	</result>
6295	<result name="VBOX_E_PDM_ERROR">
6296	Controlled power off failed.
6297	</result>
6298	</desc>
6299	</method>
6300
6301	<method name="sleepButton">
6302	<desc>Sends the ACPI sleep button event to the guest.
6303	<result name="VBOX_E_INVALID_VM_STATE">
6304	Virtual machine not in Running state.
6305	</result>
6306	<result name="VBOX_E_PDM_ERROR">
6307	Sending sleep button event failed.
6308	</result>
6309	</desc>
6310	</method>
6311
6312	<method name="getPowerButtonHandled">
6313	<desc>Checks if the last power button event was handled by guest.
6314	<result name="VBOX_E_PDM_ERROR">
6315	Checking if the event was handled by the guest OS failed.
6316	</result>
6317	</desc>
6318	<param name="handled" type="boolean" dir="return"/>
6319	</method>
6320
6321	<method name="getGuestEnteredACPIMode">
6322	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6323	G1 (sleeping). If this method returns @c false, the guest will
6324	most likely not respond to external ACPI events.
6325	<result name="VBOX_E_INVALID_VM_STATE">
6326	Virtual machine not in Running state.
6327	</result>
6328	</desc>
6329	<param name="entered" type="boolean" dir="return"/>
6330	</method>
6331
6332	<method name="saveState">
6333	<desc>
6334	Saves the current execution state of a running virtual machine
6335	and stops its execution.
6336
6337	After this operation completes, the machine will go to the
6338	Saved state. Next time it is powered up, this state will
6339	be restored and the machine will continue its execution from
6340	the place where it was saved.
6341
6342	This operation differs from taking a snapshot to the effect
6343	that it doesn't create new differencing media. Also, once
6344	the machine is powered up from the state saved using this method,
6345	the saved state is deleted, so it will be impossible to return
6346	to this state later.
6347
6348	<note>
6349	On success, this method implicitly calls
6350	<link to="IMachine::saveSettings"/> to save all current machine
6351	settings (including runtime changes to the DVD medium, etc.).
6352	Together with the impossibility to change any VM settings when it is
6353	in the Saved state, this guarantees adequate hardware
6354	configuration of the machine when it is restored from the saved
6355	state file.
6356	</note>
6357
6358	<note>
6359	The machine must be in the Running or Paused state, otherwise
6360	the operation will fail.
6361	</note>
6362	<result name="VBOX_E_INVALID_VM_STATE">
6363	Virtual machine state neither Running nor Paused.
6364	</result>
6365	<result name="VBOX_E_FILE_ERROR">
6366	Failed to create directory for saved state file.
6367	</result>
6368
6369	<see><link to="#takeSnapshot"/></see>
6370	</desc>
6371	<param name="progress" type="IProgress" dir="return">
6372	<desc>Progress object to track the operation completion.</desc>
6373	</param>
6374	</method>
6375
6376	<method name="adoptSavedState">
6377	<desc>
6378	Associates the given saved state file to the virtual machine.
6379
6380	On success, the machine will go to the Saved state. Next time it is
6381	powered up, it will be restored from the adopted saved state and
6382	continue execution from the place where the saved state file was
6383	created.
6384
6385	The specified saved state file path may be absolute or relative to the
6386	folder the VM normally saves the state to (usually,
6387	<link to="IMachine::snapshotFolder"/>).
6388
6389	<note>
6390	It's a caller's responsibility to make sure the given saved state
6391	file is compatible with the settings of this virtual machine that
6392	represent its virtual hardware (memory size, storage disk configuration
6393	etc.). If there is a mismatch, the behavior of the virtual machine
6394	is undefined.
6395	</note>
6396	<result name="VBOX_E_INVALID_VM_STATE">
6397	Virtual machine state neither PoweredOff nor Aborted.
6398	</result>
6399	</desc>
6400	<param name="savedStateFile" type="wstring" dir="in">
6401	<desc>Path to the saved state file to adopt.</desc>
6402	</param>
6403	</method>
6404
6405	<method name="discardSavedState">
6406	<desc>
6407	Forcibly resets the machine to "Powered Off" state if it is
6408	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6409	Next time the machine is powered up, a clean boot will occur.
6410	<note>
6411	This operation is equivalent to resetting or powering off
6412	the machine without doing a proper shutdown of the guest
6413	operating system; as with resetting a running phyiscal
6414	computer, it can can lead to data loss.
6415	</note>
6416	If @a fRemoveFile is @c true, the file in the machine directory
6417	into which the machine state was saved is also deleted. If
6418	this is @c false, then the state can be recovered and later
6419	re-inserted into a machine using <link to="#adoptSavedState" />.
6420	The location of the file can be found in the
6421	<link to="IMachine::stateFilePath" /> attribute.
6422	<result name="VBOX_E_INVALID_VM_STATE">
6423	Virtual machine not in state Saved.
6424	</result>
6425	</desc>
6426	<param name="fRemoveFile" type="boolean" dir="in" >
6427	<desc>Whether to also remove the saved state file.</desc>
6428	</param>
6429	</method>
6430
6431	<method name="getDeviceActivity">
6432	<desc>
6433	Gets the current activity type of a given device or device group.
6434	<result name="E_INVALIDARG">
6435	Invalid device type.
6436	</result>
6437	</desc>
6438	<param name="type" type="DeviceType" dir="in"/>
6439	<param name="activity" type="DeviceActivity" dir="return"/>
6440	</method>
6441
6442	<method name="attachUSBDevice">
6443	<desc>
6444	Attaches a host USB device with the given UUID to the
6445	USB controller of the virtual machine.
6446
6447	The device needs to be in one of the following states:
6448	<link to="USBDeviceState_Busy"/>,
6449	<link to="USBDeviceState_Available"/> or
6450	<link to="USBDeviceState_Held"/>,
6451	otherwise an error is immediately returned.
6452
6453	When the device state is
6454	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6455	be returned if the host computer refuses to release it for some reason.
6456
6457	<see>IUSBController::deviceFilters, USBDeviceState</see>
6458	<result name="VBOX_E_INVALID_VM_STATE">
6459	Virtual machine state neither Running nor Paused.
6460	</result>
6461	<result name="VBOX_E_PDM_ERROR">
6462	Virtual machine does not have a USB controller.
6463	</result>
6464	</desc>
6465	<param name="id" type="uuid" mod="string" dir="in">
6466	<desc>UUID of the host USB device to attach.</desc>
6467	</param>
6468	</method>
6469
6470	<method name="detachUSBDevice">
6471	<desc>
6472	Detaches an USB device with the given UUID from the USB controller
6473	of the virtual machine.
6474
6475	After this method succeeds, the VirtualBox server re-initiates
6476	all USB filters as if the device were just physically attached
6477	to the host, but filters of this machine are ignored to avoid
6478	a possible automatic re-attachment.
6479
6480	<see>IUSBController::deviceFilters, USBDeviceState</see>
6481
6482	<result name="VBOX_E_PDM_ERROR">
6483	Virtual machine does not have a USB controller.
6484	</result>
6485	<result name="E_INVALIDARG">
6486	USB device not attached to this virtual machine.
6487	</result>
6488	</desc>
6489	<param name="id" type="uuid" mod="string" dir="in">
6490	<desc>UUID of the USB device to detach.</desc>
6491	</param>
6492	<param name="device" type="IUSBDevice" dir="return">
6493	<desc>Detached USB device.</desc>
6494	</param>
6495	</method>
6496
6497	<method name="findUSBDeviceByAddress">
6498	<desc>
6499	Searches for a USB device with the given host address.
6500
6501	<result name="VBOX_E_OBJECT_NOT_FOUND">
6502	Given @c name does not correspond to any USB device.
6503	</result>
6504
6505	<see>IUSBDevice::address</see>
6506	</desc>
6507	<param name="name" type="wstring" dir="in">
6508	<desc>
6509	Address of the USB device (as assigned by the host) to
6510	search for.
6511	</desc>
6512	</param>
6513	<param name="device" type="IUSBDevice" dir="return">
6514	<desc>Found USB device object.</desc>
6515	</param>
6516	</method>
6517
6518	<method name="findUSBDeviceById">
6519	<desc>
6520	Searches for a USB device with the given UUID.
6521
6522	<result name="VBOX_E_OBJECT_NOT_FOUND">
6523	Given @c id does not correspond to any USB device.
6524	</result>
6525
6526	<see>IUSBDevice::id</see>
6527	</desc>
6528	<param name="id" type="uuid" mod="string" dir="in">
6529	<desc>UUID of the USB device to search for.</desc>
6530	</param>
6531	<param name="device" type="IUSBDevice" dir="return">
6532	<desc>Found USB device object.</desc>
6533	</param>
6534	</method>
6535
6536	<method name="createSharedFolder">
6537	<desc>
6538	Creates a transient new shared folder by associating the given logical
6539	name with the given host path, adds it to the collection of shared
6540	folders and starts sharing it. Refer to the description of
6541	<link to="ISharedFolder"/> to read more about logical names.
6542
6543	<result name="VBOX_E_INVALID_VM_STATE">
6544	Virtual machine in Saved state or currently changing state.
6545	</result>
6546	<result name="VBOX_E_FILE_ERROR">
6547	Shared folder already exists or not accessible.
6548	</result>
6549	</desc>
6550	<param name="name" type="wstring" dir="in">
6551	<desc>Unique logical name of the shared folder.</desc>
6552	</param>
6553	<param name="hostPath" type="wstring" dir="in">
6554	<desc>Full path to the shared folder in the host file system.</desc>
6555	</param>
6556	<param name="writable" type="boolean" dir="in">
6557	<desc>Whether the share is writable or readonly</desc>
6558	</param>
6559	<param name="automount" type="boolean" dir="in">
6560	<desc>Whether the share gets automatically mounted by the guest
6561	or not.</desc>
6562	</param>
6563	</method>
6564
6565	<method name="removeSharedFolder">
6566	<desc>
6567	Removes a transient shared folder with the given name previously
6568	created by <link to="#createSharedFolder"/> from the collection of
6569	shared folders and stops sharing it.
6570	<result name="VBOX_E_INVALID_VM_STATE">
6571	Virtual machine in Saved state or currently changing state.
6572	</result>
6573	<result name="VBOX_E_FILE_ERROR">
6574	Shared folder does not exists.
6575	</result>
6576	</desc>
6577	<param name="name" type="wstring" dir="in">
6578	<desc>Logical name of the shared folder to remove.</desc>
6579	</param>
6580	</method>
6581
6582	<method name="takeSnapshot">
6583	<desc>
6584	Saves the current execution state
6585	and all settings of the machine and creates differencing images
6586	for all normal (non-independent) media.
6587	See <link to="ISnapshot" /> for an introduction to snapshots.
6588
6589	This method can be called for a PoweredOff, Saved (see
6590	<link to="#saveState"/>), Running or
6591	Paused virtual machine. When the machine is PoweredOff, an
6592	offline snapshot is created. When the machine is Running a live
6593	snapshot is created, and an online snapshot is is created when Paused.
6594
6595	The taken snapshot is always based on the
6596	<link to="IMachine::currentSnapshot">current snapshot</link>
6597	of the associated virtual machine and becomes a new current snapshot.
6598
6599	<note>
6600	This method implicitly calls <link to="IMachine::saveSettings"/> to
6601	save all current machine settings before taking an offline snapshot.
6602	</note>
6603
6604	<result name="VBOX_E_INVALID_VM_STATE">
6605	Virtual machine currently changing state.
6606	</result>
6607	</desc>
6608	<param name="name" type="wstring" dir="in">
6609	<desc>Short name for the snapshot.</desc>
6610	</param>
6611	<param name="description" type="wstring" dir="in">
6612	<desc>Optional description of the snapshot.</desc>
6613	</param>
6614	<param name="progress" type="IProgress" dir="return">
6615	<desc>Progress object to track the operation completion.</desc>
6616	</param>
6617	</method>
6618
6619	<method name="deleteSnapshot">
6620	<desc>
6621	Starts deleting the specified snapshot asynchronously.
6622	See <link to="ISnapshot" /> for an introduction to snapshots.
6623
6624	The execution state and settings of the associated machine stored in
6625	the snapshot will be deleted. The contents of all differencing media of
6626	this snapshot will be merged with the contents of their dependent child
6627	media to keep the medium chain valid (in other words, all changes
6628	represented by media being deleted will be propagated to their child
6629	medium). After that, this snapshot's differencing medium will be
6630	deleted. The parent of this snapshot will become a new parent for all
6631	its child snapshots.
6632
6633	If the deleted snapshot is the current one, its parent snapshot will
6634	become a new current snapshot. The current machine state is not directly
6635	affected in this case, except that currently attached differencing
6636	media based on media of the deleted snapshot will be also merged as
6637	described above.
6638
6639	If the deleted snapshot is the first or current snapshot, then the
6640	respective IMachine attributes will be adjusted. Deleting the current
6641	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6642	to make all current machine settings permanent.
6643
6644	Deleting a snapshot has the following preconditions:
6645
6646	<ul>
6647	<li>Child media of all normal media of the deleted snapshot
6648	must be accessible (see <link to="IMedium::state"/>) for this
6649	operation to succeed. In particular, this means that all virtual
6650	machines whose media are directly or indirectly based on the
6651	media of deleted snapshot must be powered off.</li>
6652
6653	<li>You cannot delete the snapshot if a medium attached to it has
6654	more than once child medium (differencing images) because otherwise
6655	merging would be impossible. This might be the case if there is
6656	more than one child snapshot or differencing images were created
6657	for other reason (e.g. implicitly because of multiple machine
6658	attachments).</li>
6659	</ul>
6660
6661
6662	The virtual machine's <link to="IMachine::state">state</link> is
6663	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6664	"DeletingSnapshotPaused" while this operation is in progress.
6665
6666	<note>
6667	Merging medium contents can be very time and disk space
6668	consuming, if these media are big in size and have many
6669	children. However, if the snapshot being deleted is the last
6670	(head) snapshot on the branch, the operation will be rather
6671	quick.
6672	</note>
6673	<result name="VBOX_E_INVALID_VM_STATE">
6674	The running virtual machine prevents deleting this snapshot. This
6675	happens only in very specific situations, usually snapshots can be
6676	deleted without trouble while a VM is running. The error message
6677	text explains the reason for the failure.
6678	</result>
6679	</desc>
6680	<param name="id" type="uuid" mod="string" dir="in">
6681	<desc>UUID of the snapshot to delete.</desc>
6682	</param>
6683	<param name="progress" type="IProgress" dir="return">
6684	<desc>Progress object to track the operation completion.</desc>
6685	</param>
6686	</method>
6687
6688	<method name="restoreSnapshot">
6689	<desc>
6690	Starts resetting the machine's current state to the state contained
6691	in the given snapshot, asynchronously. All current settings of the
6692	machine will be reset and changes stored in differencing media
6693	will be lost.
6694	See <link to="ISnapshot" /> for an introduction to snapshots.
6695
6696	After this operation is successfully completed, new empty differencing
6697	media are created for all normal media of the machine.
6698
6699	If the given snapshot is an online snapshot, the machine will go to
6700	the <link to="MachineState_Saved"> saved state</link>, so that the
6701	next time it is powered on, the execution state will be restored
6702	from the state of the snapshot.
6703
6704	<note>
6705	The machine must not be running, otherwise the operation will fail.
6706	</note>
6707
6708	<note>
6709	If the machine state is <link to="MachineState_Saved">Saved</link>
6710	prior to this operation, the saved state file will be implicitly
6711	deleted (as if <link to="IConsole::discardSavedState"/> were
6712	called).
6713	</note>
6714
6715	<result name="VBOX_E_INVALID_VM_STATE">
6716	Virtual machine is running.
6717	</result>
6718	</desc>
6719	<param name="snapshot" type="ISnapshot" dir="in">
6720	<desc>The snapshot to restore the VM state from.</desc>
6721	</param>
6722	<param name="progress" type="IProgress" dir="return">
6723	<desc>Progress object to track the operation completion.</desc>
6724	</param>
6725	</method>
6726
6727	<method name="teleport">
6728	<desc>
6729	Teleport the VM to a different host machine or process.
6730
6731	TODO explain the details.
6732
6733	<result name="VBOX_E_INVALID_VM_STATE">
6734	Virtual machine not running or paused.
6735	</result>
6736	</desc>
6737	<param name="hostname" type="wstring" dir="in">
6738	<desc>The name or IP of the host to teleport to.</desc>
6739	</param>
6740	<param name="tcpport" type="unsigned long" dir="in">
6741	<desc>The TCP port to connect to (1..65535).</desc>
6742	</param>
6743	<param name="password" type="wstring" dir="in">
6744	<desc>The password.</desc>
6745	</param>
6746	<param name="maxDowntime" type="unsigned long" dir="in">
6747	<desc>
6748	The maximum allowed downtime given as milliseconds. 0 is not a valid
6749	value. Recommended value: 250 ms.
6750
6751	The higher the value is, the greater the chance for a successful
6752	teleportation. A small value may easily result in the teleportation
6753	process taking hours and eventually fail.
6754
6755	<note>
6756	The current implementation treats this a guideline, not as an
6757	absolute rule.
6758	</note>
6759	</desc>
6760	</param>
6761	<param name="progress" type="IProgress" dir="return">
6762	<desc>Progress object to track the operation completion.</desc>
6763	</param>
6764	</method>
6765
6766	</interface>
6767
6768	<!--
6769	// IHost
6770	/////////////////////////////////////////////////////////////////////////
6771	-->
6772
6773	<enum
6774	name="HostNetworkInterfaceMediumType"
6775	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6776	>
6777	<desc>
6778	Type of encapsulation. Ethernet encapsulation includes both wired and
6779	wireless Ethernet connections.
6780	<see>IHostNetworkInterface</see>
6781	</desc>
6782
6783	<const name="Unknown" value="0">
6784	<desc>
6785	The type of interface cannot be determined.
6786	</desc>
6787	</const>
6788	<const name="Ethernet" value="1">
6789	<desc>
6790	Ethernet frame encapsulation.
6791	</desc>
6792	</const>
6793	<const name="PPP" value="2">
6794	<desc>
6795	Point-to-point protocol encapsulation.
6796	</desc>
6797	</const>
6798	<const name="SLIP" value="3">
6799	<desc>
6800	Serial line IP encapsulation.
6801	</desc>
6802	</const>
6803	</enum>
6804
6805	<enum
6806	name="HostNetworkInterfaceStatus"
6807	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6808	>
6809	<desc>
6810	Current status of the interface.
6811	<see>IHostNetworkInterface</see>
6812	</desc>
6813
6814	<const name="Unknown" value="0">
6815	<desc>
6816	The state of interface cannot be determined.
6817	</desc>
6818	</const>
6819	<const name="Up" value="1">
6820	<desc>
6821	The interface is fully operational.
6822	</desc>
6823	</const>
6824	<const name="Down" value="2">
6825	<desc>
6826	The interface is not functioning.
6827	</desc>
6828	</const>
6829	</enum>
6830
6831	<enum
6832	name="HostNetworkInterfaceType"
6833	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6834	>
6835	<desc>
6836	Network interface type.
6837	</desc>
6838	<const name="Bridged" value="1"/>
6839	<const name="HostOnly" value="2"/>
6840	</enum>
6841
6842	<interface
6843	name="IHostNetworkInterface" extends="$unknown"
6844	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6845	wsmap="managed"
6846	>
6847	<desc>
6848	Represents one of host's network interfaces. IP V6 address and network
6849	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6850	separated by colons.
6851	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6852	</desc>
6853	<attribute name="name" type="wstring" readonly="yes">
6854	<desc>Returns the host network interface name.</desc>
6855	</attribute>
6856
6857	<attribute name="id" type="uuid" mod="string" readonly="yes">
6858	<desc>Returns the interface UUID.</desc>
6859	</attribute>
6860
6861	<attribute name="networkName" type="wstring" readonly="yes">
6862	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6863	</attribute>
6864
6865	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6866	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6867	</attribute>
6868
6869	<attribute name="IPAddress" type="wstring" readonly="yes">
6870	<desc>Returns the IP V4 address of the interface.</desc>
6871	</attribute>
6872
6873	<attribute name="networkMask" type="wstring" readonly="yes">
6874	<desc>Returns the network mask of the interface.</desc>
6875	</attribute>
6876
6877	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6878	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6879	</attribute>
6880
6881	<attribute name="IPV6Address" type="wstring" readonly="yes">
6882	<desc>Returns the IP V6 address of the interface.</desc>
6883	</attribute>
6884
6885	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6886	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6887	</attribute>
6888
6889	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6890	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6891	</attribute>
6892
6893	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6894	<desc>Type of protocol encapsulation used.</desc>
6895	</attribute>
6896
6897	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6898	<desc>Status of the interface.</desc>
6899	</attribute>
6900
6901	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6902	<desc>specifies the host interface type.</desc>
6903	</attribute>
6904
6905	<method name="enableStaticIpConfig">
6906	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6907	<param name="IPAddress" type="wstring" dir="in">
6908	<desc>
6909	IP address.
6910	</desc>
6911	</param>
6912	<param name="networkMask" type="wstring" dir="in">
6913	<desc>
6914	network mask.
6915	</desc>
6916	</param>
6917	</method>
6918
6919	<method name="enableStaticIpConfigV6">
6920	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6921	<param name="IPV6Address" type="wstring" dir="in">
6922	<desc>
6923	IP address.
6924	</desc>
6925	</param>
6926	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6927	<desc>
6928	network mask.
6929	</desc>
6930	</param>
6931	</method>
6932
6933	<method name="enableDynamicIpConfig">
6934	<desc>enables the dynamic IP configuration.</desc>
6935	</method>
6936
6937	<method name="dhcpRediscover">
6938	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6939	</method>
6940
6941	</interface>
6942
6943	<interface
6944	name="IHost" extends="$unknown"
6945	uuid="35b004f4-7806-4009-bfa8-d1308adba7e5"
6946	wsmap="managed"
6947	>
6948	<desc>
6949	The IHost interface represents the physical machine that this VirtualBox
6950	installation runs on.
6951
6952	An object implementing this interface is returned by the
6953	<link to="IVirtualBox::host" /> attribute. This interface contains
6954	read-only information about the host's physical hardware (such as what
6955	processors and disks are available, what the host operating system is,
6956	and so on) and also allows for manipulating some of the host's hardware,
6957	such as global USB device filters and host interface networking.
6958
6959	</desc>
6960	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6961	<desc>List of DVD drives available on the host.</desc>
6962	</attribute>
6963
6964	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6965	<desc>List of floppy drives available on the host.</desc>
6966	</attribute>
6967
6968	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6969	<desc>
6970	List of USB devices currently attached to the host.
6971	Once a new device is physically attached to the host computer,
6972	it appears in this list and remains there until detached.
6973
6974	<note>
6975	If USB functionality is not available in the given edition of
6976	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6977	</note>
6978	</desc>
6979	</attribute>
6980
6981	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6982	<desc>
6983	List of USB device filters in action.
6984	When a new device is physically attached to the host computer,
6985	filters from this list are applied to it (in order they are stored
6986	in the list). The first matched filter will determine the
6987	<link to="IHostUSBDeviceFilter::action">action</link>
6988	performed on the device.
6989
6990	Unless the device is ignored by these filters, filters of all
6991	currently running virtual machines
6992	(<link to="IUSBController::deviceFilters"/>) are applied to it.
6993
6994	<note>
6995	If USB functionality is not available in the given edition of
6996	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6997	</note>
6998
6999	<see>IHostUSBDeviceFilter, USBDeviceState</see>
7000	</desc>
7001	</attribute>
7002
7003	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7004	<desc>List of host network interfaces currently defined on the host.</desc>
7005	</attribute>
7006
7007	<attribute name="processorCount" type="unsigned long" readonly="yes">
7008	<desc>Number of (logical) CPUs installed in the host system.</desc>
7009	</attribute>
7010
7011	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7012	<desc>Number of (logical) CPUs online in the host system.</desc>
7013	</attribute>
7014
7015	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7016	<desc>Number of physical processor cores installed in the host system.</desc>
7017	</attribute>
7018
7019	<method name="getProcessorSpeed">
7020	<desc>Query the (approximate) maximum speed of a specified host CPU in
7021	Megahertz.
7022	</desc>
7023	<param name="cpuId" type="unsigned long" dir="in">
7024	<desc>
7025	Identifier of the CPU.
7026	</desc>
7027	</param>
7028	<param name="speed" type="unsigned long" dir="return">
7029	<desc>
7030	Speed value. 0 is returned if value is not known or @a cpuId is
7031	invalid.
7032	</desc>
7033	</param>
7034	</method>
7035
7036	<method name="getProcessorFeature">
7037	<desc>Query whether a CPU feature is supported or not.</desc>
7038	<param name="feature" type="ProcessorFeature" dir="in">
7039	<desc>
7040	CPU Feature identifier.
7041	</desc>
7042	</param>
7043	<param name="supported" type="boolean" dir="return">
7044	<desc>
7045	Feature is supported or not.
7046	</desc>
7047	</param>
7048	</method>
7049
7050	<method name="getProcessorDescription">
7051	<desc>Query the model string of a specified host CPU.
7052	</desc>
7053	<param name="cpuId" type="unsigned long" dir="in">
7054	<desc>
7055	Identifier of the CPU.
7056	<note>
7057	The current implementation might not necessarily return the
7058	description for this exact CPU.
7059	</note>
7060	</desc>
7061	</param>
7062	<param name="description" type="wstring" dir="return">
7063	<desc>
7064	Model string. An empty string is returned if value is not known or
7065	@a cpuId is invalid.
7066	</desc>
7067	</param>
7068	</method>
7069
7070	<method name="getProcessorCPUIDLeaf">
7071	<desc>
7072	Returns the CPU cpuid information for the specified leaf.
7073	</desc>
7074	<param name="cpuId" type="unsigned long" dir="in">
7075	<desc>
7076	Identifier of the CPU. The CPU most be online.
7077	<note>
7078	The current implementation might not necessarily return the
7079	description for this exact CPU.
7080	</note>
7081	</desc>
7082	</param>
7083	<param name="leaf" type="unsigned long" dir="in">
7084	<desc>
7085	CPUID leaf index (eax).
7086	</desc>
7087	</param>
7088	<param name="subLeaf" type="unsigned long" dir="in">
7089	<desc>
7090	CPUID leaf sub index (ecx). This currently only applies to cache
7091	information on Intel CPUs. Use 0 if retrieving values for
7092	<link to="IMachine::setCPUIDLeaf"/>.
7093	</desc>
7094	</param>
7095	<param name="valEax" type="unsigned long" dir="out">
7096	<desc>
7097	CPUID leaf value for register eax.
7098	</desc>
7099	</param>
7100	<param name="valEbx" type="unsigned long" dir="out">
7101	<desc>
7102	CPUID leaf value for register ebx.
7103	</desc>
7104	</param>
7105	<param name="valEcx" type="unsigned long" dir="out">
7106	<desc>
7107	CPUID leaf value for register ecx.
7108	</desc>
7109	</param>
7110	<param name="valEdx" type="unsigned long" dir="out">
7111	<desc>
7112	CPUID leaf value for register edx.
7113	</desc>
7114	</param>
7115	</method>
7116
7117	<attribute name="memorySize" type="unsigned long" readonly="yes">
7118	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7119	</attribute>
7120
7121	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7122	<desc>Available system memory in the host system.</desc>
7123	</attribute>
7124
7125	<attribute name="operatingSystem" type="wstring" readonly="yes">
7126	<desc>Name of the host system's operating system.</desc>
7127	</attribute>
7128
7129	<attribute name="OSVersion" type="wstring" readonly="yes">
7130	<desc>Host operating system's version string.</desc>
7131	</attribute>
7132
7133	<attribute name="UTCTime" type="long long" readonly="yes">
7134	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7135	</attribute>
7136
7137	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7138	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7139	</attribute>
7140
7141	<method name="createHostOnlyNetworkInterface">
7142	<desc>
7143	Creates a new adapter for Host Only Networking.
7144	<result name="E_INVALIDARG">
7145	Host network interface @a name already exists.
7146	</result>
7147	</desc>
7148	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7149	<desc>
7150	Created host interface object.
7151	</desc>
7152	</param>
7153	<param name="progress" type="IProgress" dir="return">
7154	<desc>
7155	Progress object to track the operation completion.
7156	</desc>
7157	</param>
7158	</method>
7159
7160	<method name="removeHostOnlyNetworkInterface">
7161	<desc>
7162	Removes the given Host Only Networking interface.
7163	<result name="VBOX_E_OBJECT_NOT_FOUND">
7164	No host network interface matching @a id found.
7165	</result>
7166	</desc>
7167	<param name="id" type="uuid" mod="string" dir="in">
7168	<desc>
7169	Adapter GUID.
7170	</desc>
7171	</param>
7172	<param name="progress" type="IProgress" dir="return">
7173	<desc>
7174	Progress object to track the operation completion.
7175	</desc>
7176	</param>
7177	</method>
7178
7179	<method name="createUSBDeviceFilter">
7180	<desc>
7181	Creates a new USB device filter. All attributes except
7182	the filter name are set to empty (any match),
7183	<i>active</i> is @c false (the filter is not active).
7184
7185	The created filter can be added to the list of filters using
7186	<link to="#insertUSBDeviceFilter"/>.
7187
7188	<see>#USBDeviceFilters</see>
7189	</desc>
7190	<param name="name" type="wstring" dir="in">
7191	<desc>
7192	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7193	</desc>
7194	</param>
7195	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7196	<desc>Created filter object.</desc>
7197	</param>
7198	</method>
7199
7200	<method name="insertUSBDeviceFilter">
7201	<desc>
7202	Inserts the given USB device to the specified position
7203	in the list of filters.
7204
7205	Positions are numbered starting from @c 0. If the specified
7206	position is equal to or greater than the number of elements in
7207	the list, the filter is added at the end of the collection.
7208
7209	<note>
7210	Duplicates are not allowed, so an attempt to insert a
7211	filter already in the list is an error.
7212	</note>
7213	<note>
7214	If USB functionality is not available in the given edition of
7215	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7216	</note>
7217
7218	<see>#USBDeviceFilters</see>
7219
7220	<result name="VBOX_E_INVALID_OBJECT_STATE">
7221	USB device filter is not created within this VirtualBox instance.
7222	</result>
7223	<result name="E_INVALIDARG">
7224	USB device filter already in list.
7225	</result>
7226
7227	</desc>
7228	<param name="position" type="unsigned long" dir="in">
7229	<desc>Position to insert the filter to.</desc>
7230	</param>
7231	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7232	<desc>USB device filter to insert.</desc>
7233	</param>
7234	</method>
7235
7236	<method name="removeUSBDeviceFilter">
7237	<desc>
7238	Removes a USB device filter from the specified position in the
7239	list of filters.
7240
7241	Positions are numbered starting from @c 0. Specifying a
7242	position equal to or greater than the number of elements in
7243	the list will produce an error.
7244
7245	<note>
7246	If USB functionality is not available in the given edition of
7247	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7248	</note>
7249
7250	<see>#USBDeviceFilters</see>
7251
7252	<result name="E_INVALIDARG">
7253	USB device filter list empty or invalid @a position.
7254	</result>
7255
7256	</desc>
7257	<param name="position" type="unsigned long" dir="in">
7258	<desc>Position to remove the filter from.</desc>
7259	</param>
7260	</method>
7261
7262	<method name="findHostDVDDrive">
7263	<desc>
7264	Searches for a host DVD drive with the given @c name.
7265
7266	<result name="VBOX_E_OBJECT_NOT_FOUND">
7267	Given @c name does not correspond to any host drive.
7268	</result>
7269
7270	</desc>
7271	<param name="name" type="wstring" dir="in">
7272	<desc>Name of the host drive to search for</desc>
7273	</param>
7274	<param name="drive" type="IMedium" dir="return">
7275	<desc>Found host drive object</desc>
7276	</param>
7277	</method>
7278
7279	<method name="findHostFloppyDrive">
7280	<desc>
7281	Searches for a host floppy drive with the given @c name.
7282
7283	<result name="VBOX_E_OBJECT_NOT_FOUND">
7284	Given @c name does not correspond to any host floppy drive.
7285	</result>
7286
7287	</desc>
7288	<param name="name" type="wstring" dir="in">
7289	<desc>Name of the host floppy drive to search for</desc>
7290	</param>
7291	<param name="drive" type="IMedium" dir="return">
7292	<desc>Found host floppy drive object</desc>
7293	</param>
7294	</method>
7295
7296	<method name="findHostNetworkInterfaceByName">
7297	<desc>
7298	Searches through all host network interfaces for an interface with
7299	the given @c name.
7300	<note>
7301	The method returns an error if the given @c name does not
7302	correspond to any host network interface.
7303	</note>
7304	</desc>
7305	<param name="name" type="wstring" dir="in">
7306	<desc>Name of the host network interface to search for.</desc>
7307	</param>
7308	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7309	<desc>Found host network interface object.</desc>
7310	</param>
7311	</method>
7312	<method name="findHostNetworkInterfaceById">
7313	<desc>
7314	Searches through all host network interfaces for an interface with
7315	the given GUID.
7316	<note>
7317	The method returns an error if the given GUID does not
7318	correspond to any host network interface.
7319	</note>
7320	</desc>
7321	<param name="id" type="uuid" mod="string" dir="in">
7322	<desc>GUID of the host network interface to search for.</desc>
7323	</param>
7324	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7325	<desc>Found host network interface object.</desc>
7326	</param>
7327	</method>
7328	<method name="findHostNetworkInterfacesOfType">
7329	<desc>
7330	Searches through all host network interfaces and returns a list of interfaces of the specified type
7331	</desc>
7332	<param name="type" type="HostNetworkInterfaceType" dir="in">
7333	<desc>type of the host network interfaces to search for.</desc>
7334	</param>
7335	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7336	<desc>Found host network interface objects.</desc>
7337	</param>
7338	</method>
7339
7340	<method name="findUSBDeviceById">
7341	<desc>
7342	Searches for a USB device with the given UUID.
7343
7344	<result name="VBOX_E_OBJECT_NOT_FOUND">
7345	Given @c id does not correspond to any USB device.
7346	</result>
7347
7348	<see>IHostUSBDevice::id</see>
7349	</desc>
7350	<param name="id" type="uuid" mod="string" dir="in">
7351	<desc>UUID of the USB device to search for.</desc>
7352	</param>
7353	<param name="device" type="IHostUSBDevice" dir="return">
7354	<desc>Found USB device object.</desc>
7355	</param>
7356	</method>
7357
7358	<method name="findUSBDeviceByAddress">
7359	<desc>
7360	Searches for a USB device with the given host address.
7361
7362	<result name="VBOX_E_OBJECT_NOT_FOUND">
7363	Given @c name does not correspond to any USB device.
7364	</result>
7365
7366	<see>IHostUSBDevice::address</see>
7367	</desc>
7368	<param name="name" type="wstring" dir="in">
7369	<desc>
7370	Address of the USB device (as assigned by the host) to
7371	search for.
7372	</desc>
7373	</param>
7374	<param name="device" type="IHostUSBDevice" dir="return">
7375	<desc>Found USB device object.</desc>
7376	</param>
7377	</method>
7378
7379	</interface>
7380
7381	<!--
7382	// ISystemProperties
7383	/////////////////////////////////////////////////////////////////////////
7384	-->
7385
7386	<interface
7387	name="ISystemProperties"
7388	extends="$unknown"
7389	uuid="2f89cdfe-2d10-43d4-b37f-61760f877f29"
7390	wsmap="managed"
7391	>
7392	<desc>
7393	The ISystemProperties interface represents global properties of the given
7394	VirtualBox installation.
7395
7396	These properties define limits and default values for various attributes
7397	and parameters. Most of the properties are read-only, but some can be
7398	changed by a user.
7399	</desc>
7400
7401	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7402	<desc>Minimum guest system memory in Megabytes.</desc>
7403	</attribute>
7404
7405	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7406	<desc>Maximum guest system memory in Megabytes.</desc>
7407	</attribute>
7408
7409	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7410	<desc>Minimum guest video memory in Megabytes.</desc>
7411	</attribute>
7412
7413	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7414	<desc>Maximum guest video memory in Megabytes.</desc>
7415	</attribute>
7416
7417	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7418	<desc>Minimum CPU count.</desc>
7419	</attribute>
7420
7421	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7422	<desc>Maximum CPU count.</desc>
7423	</attribute>
7424
7425	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7426	<desc>Maximum of monitors which could be connected.</desc>
7427	</attribute>
7428
7429	<attribute name="infoVDSize" type="long long" readonly="yes">
7430	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7431	does not reflect the limits of any virtual disk image format.</desc>
7432	</attribute>
7433
7434	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7435	<desc>
7436	Maximum number of serial ports associated with every
7437	<link to="IMachine"/> instance.
7438	</desc>
7439	</attribute>
7440
7441	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7442	<desc>
7443	Maximum number of parallel ports associated with every
7444	<link to="IMachine"/> instance.
7445	</desc>
7446	</attribute>
7447
7448	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7449	<desc>
7450	Maximum device position in the boot order. This value corresponds
7451	to the total number of devices a machine can boot from, to make it
7452	possible to include all possible devices to the boot list.
7453	<see><link to="IMachine::setBootOrder"/></see>
7454	</desc>
7455	</attribute>
7456
7457	<attribute name="defaultMachineFolder" type="wstring">
7458	<desc>
7459	Full path to the default directory used to create new or open
7460	existing machines when a machine settings file name contains no
7461	path.
7462
7463	Starting with VirtualBox 4.0, by default, this attribute contains
7464	the full path of folder named "VirtualBox VMs" in the user's
7465	home directory, which depends on the host platform.
7466
7467	When setting this attribute, a full path must be specified.
7468	Setting this property to @c null or an empty string or the
7469	special value "Machines" (for compatibility reasons) will restore
7470	that default value.
7471
7472	If the folder specified herein does not exist, it will be created
7473	automatically as needed.
7474
7475	<see>
7476	<link to="IVirtualBox::createMachine"/>,
7477	<link to="IVirtualBox::openMachine"/>
7478	</see>
7479	</desc>
7480	</attribute>
7481
7482	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7483	<desc>
7484	List of all medium storage formats supported by this VirtualBox
7485	installation.
7486
7487	Keep in mind that the medium format identifier
7488	(<link to="IMediumFormat::id"/>) used in other API calls like
7489	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7490	medium format is a case-insensitive string. This means that, for
7491	example, all of the following strings:
7492	<pre>
7493	"VDI"
7494	"vdi"
7495	"VdI"</pre>
7496	refer to the same medium format.
7497
7498	Note that the virtual medium framework is backend-based, therefore
7499	the list of supported formats depends on what backends are currently
7500	installed.
7501
7502	<see>
7503	<link to="IMediumFormat"/>,
7504	</see>
7505	</desc>
7506	</attribute>
7507
7508	<attribute name="defaultHardDiskFormat" type="wstring">
7509	<desc>
7510	Identifier of the default medium format used by VirtualBox.
7511
7512	The medium format set by this attribute is used by VirtualBox
7513	when the medium format was not specified explicitly. One example is
7514	<link to="IVirtualBox::createHardDisk"/> with the empty
7515	format argument. A more complex example is implicit creation of
7516	differencing media when taking a snapshot of a virtual machine:
7517	this operation will try to use a format of the parent medium first
7518	and if this format does not support differencing media the default
7519	format specified by this argument will be used.
7520
7521	The list of supported medium formats may be obtained by the
7522	<link to="#mediumFormats"/> call. Note that the default medium
7523	format must have a capability to create differencing media;
7524	otherwise operations that create media implicitly may fail
7525	unexpectedly.
7526
7527	The initial value of this property is <tt>"VDI"</tt> in the current
7528	version of the VirtualBox product, but may change in the future.
7529
7530	<note>
7531	Setting this property to @c null or empty string will restore the
7532	initial value.
7533	</note>
7534
7535	<see>
7536	<link to="#mediumFormats"/>,
7537	<link to="IMediumFormat::id"/>,
7538	<link to="IVirtualBox::createHardDisk"/>
7539	</see>
7540	</desc>
7541	</attribute>
7542
7543	<attribute name="freeDiskSpaceWarning" type="long long">
7544	<desc>Issue a warning if the free disk space is below (or in some disk
7545	intensive operation is expected to go below) the given size in
7546	bytes.</desc>
7547	</attribute>
7548
7549	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7550	<desc>Issue a warning if the free disk space is below (or in some disk
7551	intensive operation is expected to go below) the given percentage.</desc>
7552	</attribute>
7553
7554	<attribute name="freeDiskSpaceError" type="long long">
7555	<desc>Issue an error if the free disk space is below (or in some disk
7556	intensive operation is expected to go below) the given size in
7557	bytes.</desc>
7558	</attribute>
7559
7560	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7561	<desc>Issue an error if the free disk space is below (or in some disk
7562	intensive operation is expected to go below) the given percentage.</desc>
7563	</attribute>
7564
7565	<attribute name="VRDEAuthLibrary" type="wstring">
7566	<desc>
7567	Library that provides authentication for Remote Desktop clients. The library
7568	is used if a virtual machine's authentication type is set to "external"
7569	in the VM RemoteDisplay configuration.
7570
7571	The system library extension (".DLL" or ".so") must be omitted.
7572	A full path can be specified; if not, then the library must reside on the
7573	system's default library path.
7574
7575	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
7576	of that name in one of the default VirtualBox library directories.
7577
7578	For details about VirtualBox authentication libraries and how to implement
7579	them, please refer to the VirtualBox manual.
7580
7581	<note>
7582	Setting this property to @c null or empty string will restore the
7583	initial value.
7584	</note>
7585	</desc>
7586	</attribute>
7587
7588	<attribute name="webServiceAuthLibrary" type="wstring">
7589	<desc>
7590	Library that provides authentication for webservice clients. The library
7591	is used if a virtual machine's authentication type is set to "external"
7592	in the VM RemoteDisplay configuration and will be called from
7593	within the <link to="IWebsessionManager::logon" /> implementation.
7594
7595	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
7596	there is no per-VM setting for this, as the webservice is a global
7597	resource (if it is running). Only for this setting (for the webservice),
7598	setting this value to a literal <tt>"null"</tt> string disables authentication,
7599	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7600	no matter what user name and password are supplied.
7601
7602	The initial value of this property is <tt>"VBoxAuth"</tt>,
7603	meaning that the webservice will use the same authentication
7604	library that is used by default for VRDE (again, see
7605	<link to="ISystemProperties::VRDEAuthLibrary" />).
7606	The format and calling convention of authentication libraries
7607	is the same for the webservice as it is for VRDE.
7608
7609	<note>
7610	Setting this property to @c null or empty string will restore the
7611	initial value.
7612	</note>
7613	</desc>
7614	</attribute>
7615
7616	<attribute name="defaultVRDEExtPack" type="wstring">
7617	<desc>
7618	The name of the extension pack providing the default VRDE.
7619
7620	This attribute is for choosing between multiple extension packs
7621	providing VRDE. If only one is installed, it will automatically be the
7622	default one. The attribute value can be empty if no VRDE extension
7623	pack is installed.
7624
7625	For details about VirtualBox Remote Desktop Extension and how to
7626	implement one, please refer to the VirtualBox SDK.
7627	</desc>
7628	</attribute>
7629
7630	<attribute name="LogHistoryCount" type="unsigned long">
7631	<desc>
7632	This value specifies how many old release log files are kept.
7633	</desc>
7634	</attribute>
7635
7636	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7637	<desc>This value hold the default audio driver for the current
7638	system.</desc>
7639	</attribute>
7640
7641
7642	<method name="getMaxNetworkAdapters">
7643	<desc>
7644	Maximum total number of network adapters associated with every
7645	<link to="IMachine"/> instance.
7646	</desc>
7647
7648	<param name="chipset" type="ChipsetType" dir="in">
7649	<desc>The chipset type to get the value for.</desc>
7650	</param>
7651
7652
7653	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
7654	<desc>The maximum total number of network adapters allowed.</desc>
7655	</param>
7656
7657	</method>
7658
7659	<method name="getMaxNetworkAdaptersOfType">
7660	<desc>
7661	Maximum number of network adapters of a given attachment type,
7662	associated with every <link to="IMachine"/> instance.
7663	</desc>
7664
7665	<param name="chipset" type="ChipsetType" dir="in">
7666	<desc>The chipset type to get the value for.</desc>
7667	</param>
7668
7669	<param name="type" type="NetworkAttachmentType" dir="in">
7670	<desc>Type of attachment.</desc>
7671	</param>
7672
7673	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
7674	<desc>The maximum number of network adapters allowed for
7675	particular chipset and attachment type.</desc>
7676	</param>
7677
7678	</method>
7679
7680
7681	<method name="getMaxDevicesPerPortForStorageBus">
7682	<desc>Returns the maximum number of devices which can be attached to a port
7683	for the given storage bus.</desc>
7684
7685	<param name="bus" type="StorageBus" dir="in">
7686	<desc>The storage bus type to get the value for.</desc>
7687	</param>
7688
7689	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7690	<desc>The maximum number of devices which can be attached to the port for the given
7691	storage bus.</desc>
7692	</param>
7693	</method>
7694
7695	<method name="getMinPortCountForStorageBus">
7696	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7697
7698	<param name="bus" type="StorageBus" dir="in">
7699	<desc>The storage bus type to get the value for.</desc>
7700	</param>
7701
7702	<param name="minPortCount" type="unsigned long" dir="return">
7703	<desc>The minimum number of ports for the given storage bus.</desc>
7704	</param>
7705	</method>
7706
7707	<method name="getMaxPortCountForStorageBus">
7708	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7709
7710	<param name="bus" type="StorageBus" dir="in">
7711	<desc>The storage bus type to get the value for.</desc>
7712	</param>
7713
7714	<param name="maxPortCount" type="unsigned long" dir="return">
7715	<desc>The maximum number of ports for the given storage bus.</desc>
7716	</param>
7717	</method>
7718
7719	<method name="getMaxInstancesOfStorageBus">
7720	<desc>Returns the maximum number of storage bus instances which
7721	can be configured for each VM. This corresponds to the number of
7722	storage controllers one can have. Value may depend on chipset type
7723	used.</desc>
7724
7725	<param name="chipset" type="ChipsetType" dir="in">
7726	<desc>The chipset type to get the value for.</desc>
7727	</param>
7728
7729	<param name="bus" type="StorageBus" dir="in">
7730	<desc>The storage bus type to get the value for.</desc>
7731	</param>
7732
7733	<param name="maxInstances" type="unsigned long" dir="return">
7734	<desc>The maximum number of instances for the given storage bus.</desc>
7735	</param>
7736	</method>
7737
7738	<method name="getDeviceTypesForStorageBus">
7739	<desc>Returns list of all the supported device types
7740	(<link to="DeviceType"/>) for the given type of storage
7741	bus.</desc>
7742
7743	<param name="bus" type="StorageBus" dir="in">
7744	<desc>The storage bus type to get the value for.</desc>
7745	</param>
7746
7747	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7748	<desc>The list of all supported device types for the given storage bus.</desc>
7749	</param>
7750	</method>
7751
7752	<method name="getDefaultIoCacheSettingForStorageController">
7753	<desc>Returns the default I/O cache setting for the
7754	given storage controller</desc>
7755
7756	<param name="controllerType" type="StorageControllerType" dir="in">
7757	<desc>The storage controller to the setting for.</desc>
7758	</param>
7759
7760	<param name="enabled" type="boolean" dir="return">
7761	<desc>Returned flag indicating the default value</desc>
7762	</param>
7763	</method>
7764	</interface>
7765
7766	<!--
7767	// IGuest
7768	/////////////////////////////////////////////////////////////////////////
7769	-->
7770
7771	<interface
7772	name="IGuestOSType" extends="$unknown"
7773	uuid="432c1546-1354-4abf-bf08-878a32a373f5"
7774	wsmap="struct"
7775	>
7776	<desc>
7777	</desc>
7778
7779	<attribute name="familyId" type="wstring" readonly="yes">
7780	<desc>Guest OS family identifier string.</desc>
7781	</attribute>
7782
7783	<attribute name="familyDescription" type="wstring" readonly="yes">
7784	<desc>Human readable description of the guest OS family.</desc>
7785	</attribute>
7786
7787	<attribute name="id" type="wstring" readonly="yes">
7788	<desc>Guest OS identifier string.</desc>
7789	</attribute>
7790
7791	<attribute name="description" type="wstring" readonly="yes">
7792	<desc>Human readable description of the guest OS.</desc>
7793	</attribute>
7794
7795	<attribute name="is64Bit" type="boolean" readonly="yes">
7796	<desc>Returns @c true if the given OS is 64-bit</desc>
7797	</attribute>
7798
7799	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7800	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7801	</attribute>
7802
7803	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7804	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7805	</attribute>
7806
7807	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7808	<desc>Recommended RAM size in Megabytes.</desc>
7809	</attribute>
7810
7811	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7812	<desc>Recommended video RAM size in Megabytes.</desc>
7813	</attribute>
7814
7815	<attribute name="recommendedHDD" type="long long" readonly="yes">
7816	<desc>Recommended hard disk size in bytes.</desc>
7817	</attribute>
7818
7819	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7820	<desc>Returns recommended network adapter for this OS type.</desc>
7821	</attribute>
7822
7823	<attribute name="recommendedPae" type="boolean" readonly="yes">
7824	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7825	</attribute>
7826
7827	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7828	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7829	</attribute>
7830
7831	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7832	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7833	</attribute>
7834
7835	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7836	<desc>Recommended storage controller type for HD drives.</desc>
7837	</attribute>
7838
7839	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7840	<desc>Recommended storage bus type for HD drives.</desc>
7841	</attribute>
7842
7843	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7844	<desc>Recommended firmware type.</desc>
7845	</attribute>
7846
7847	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7848	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7849	</attribute>
7850
7851	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7852	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7853	</attribute>
7854
7855	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7856	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7857	</attribute>
7858
7859	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7860	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7861	</attribute>
7862
7863	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
7864	<desc>Recommended chipset type.</desc>
7865	</attribute>
7866
7867	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
7868	<desc>Recommended audio type.</desc>
7869	</attribute>
7870
7871	</interface>
7872
7873	<enum
7874	name="AdditionsRunLevelType"
7875	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
7876	>
7877	<desc>
7878	Guest Additions run level type.
7879	</desc>
7880
7881	<const name="None" value="0">
7882	<desc>Guest Additions are not loaded.</desc>
7883	</const>
7884	<const name="System" value="1">
7885	<desc>Guest drivers are loaded.</desc>
7886	</const>
7887	<const name="Userland" value="2">
7888	<desc>Common components (such as application services) are loaded.</desc>
7889	</const>
7890	<const name="Desktop" value="3">
7891	<desc>Per-user desktop components are loaded.</desc>
7892	</const>
7893	</enum>
7894
7895	<enum
7896	name="AdditionsUpdateFlag"
7897	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
7898	>
7899	<desc>
7900	Guest Additions update flags.
7901	</desc>
7902
7903	<const name="None" value="0">
7904	<desc>No flag set.</desc>
7905	</const>
7906	<const name="WaitForUpdateStartOnly" value="1">
7907	<desc>Only wait for the update process being started and do not
7908	wait while peforming the actual update.</desc>
7909	</const>
7910	</enum>
7911
7912	<enum
7913	name="ExecuteProcessFlag"
7914	uuid="3258e8a5-ba0c-43d5-86b5-cf91405fddc0"
7915	>
7916	<desc>
7917	Guest process execution flags.
7918	</desc>
7919
7920	<const name="None" value="0">
7921	<desc>No flag set.</desc>
7922	</const>
7923
7924	<const name="WaitForProcessStartOnly" value="1">
7925	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
7926	process itself then uses an infinite timeout.</desc>
7927	</const>
7928
7929	<const name="IgnoreOrphanedProcesses" value="2">
7930	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
7931	</const>
7932
7933	<const name="Hidden" value="4">
7934	<desc>Don't show the started process according to the guest OS guidelines.</desc>
7935	</const>
7936	</enum>
7937
7938	<enum
7939	name="ProcessInputFlag"
7940	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
7941	>
7942	<desc>
7943	Guest process input flags.
7944	</desc>
7945
7946	<const name="None" value="0">
7947	<desc>No flag set.</desc>
7948	</const>
7949	<const name="EndOfFile" value="1">
7950	<desc>End of file (input) reached.</desc>
7951	</const>
7952	</enum>
7953
7954	<enum
7955	name="CopyFileFlag"
7956	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
7957	>
7958	<desc>
7959	Host/Guest copy flags. At the moment none of these flags
7960	are implemented.
7961	</desc>
7962
7963	<const name="None" value="0">
7964	<desc>No flag set.</desc>
7965	</const>
7966
7967	<const name="Recursive" value="1">
7968	<desc>Copy directories recursively.</desc>
7969	</const>
7970
7971	<const name="Update" value="2">
7972	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
7973	</const>
7974
7975	<const name="FollowLinks" value="4">
7976	<desc>Follow symbolic links.</desc>
7977	</const>
7978	</enum>
7979
7980	<enum
7981	name="CreateDirectoryFlag"
7982	uuid="26ff5bdd-c81f-4304-857b-b8be5e3f9cd6"
7983	>
7984	<desc>
7985	Directory creation flags.
7986	</desc>
7987
7988	<const name="None" value="0">
7989	<desc>No flag set.</desc>
7990	</const>
7991
7992	<const name="Parents" value="1">
7993	<desc>No error if existing, make parent directories as needed.</desc>
7994	</const>
7995	</enum>
7996
7997	<interface
7998	name="IGuest" extends="$unknown"
7999	uuid="7ce7e4d8-cdaa-4d83-a0f4-510c8ee70aea"
8000	wsmap="managed"
8001	>
8002	<desc>
8003	The IGuest interface represents information about the operating system
8004	running inside the virtual machine. Used in
8005	<link to="IConsole::guest"/>.
8006
8007	IGuest provides information about the guest operating system, whether
8008	Guest Additions are installed and other OS-specific virtual machine
8009	properties.
8010	</desc>
8011
8012	<attribute name="OSTypeId" type="wstring" readonly="yes">
8013	<desc>
8014	Identifier of the Guest OS type as reported by the Guest
8015	Additions.
8016	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8017	an IGuestOSType object representing details about the given
8018	Guest OS type.
8019	<note>
8020	If Guest Additions are not installed, this value will be
8021	the same as <link to="IMachine::OSTypeId"/>.
8022	</note>
8023	</desc>
8024	</attribute>
8025
8026	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
8027	<desc>
8028	Current run level of the Guest Additions.
8029	</desc>
8030	</attribute>
8031
8032	<attribute name="additionsVersion" type="wstring" readonly="yes">
8033	<desc>
8034	Version of the Guest Additions including the revision (3 decimal numbers
8035	separated by dots + revision number) installed on the guest or empty
8036	when the Additions are not installed.
8037	</desc>
8038	</attribute>
8039
8040	<attribute name="supportsSeamless" type="boolean" readonly="yes">
8041	<desc>
8042	Flag whether seamless guest display rendering (seamless desktop
8043	integration) is supported.
8044	</desc>
8045	</attribute>
8046
8047	<attribute name="supportsGraphics" type="boolean" readonly="yes">
8048	<desc>
8049	Flag whether the guest is in graphics mode. If it is not, then
8050	seamless rendering will not work, resize hints are not immediately
8051	acted on and guest display resizes are probably not initiated by
8052	the guest additions.
8053	</desc>
8054	</attribute>
8055
8056	<attribute name="memoryBalloonSize" type="unsigned long">
8057	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8058	</attribute>
8059
8060	<attribute name="statisticsUpdateInterval" type="unsigned long">
8061	<desc>Interval to update guest statistics in seconds.</desc>
8062	</attribute>
8063
8064	<method name="internalGetStatistics">
8065	<desc>
8066	Internal method; do not use as it might change at any time
8067	</desc>
8068	<param name="cpuUser" type="unsigned long" dir="out">
8069	<desc>Percentage of processor time spent in user mode as seen by the guest</desc>
8070	</param>
8071	<param name="cpuKernel" type="unsigned long" dir="out">
8072	<desc>Percentage of processor time spent in kernel mode as seen by the guest</desc>
8073	</param>
8074	<param name="cpuIdle" type="unsigned long" dir="out">
8075	<desc>Percentage of processor time spent idling as seen by the guest</desc>
8076	</param>
8077	<param name="memTotal" type="unsigned long" dir="out">
8078	<desc>Total amount of physical guest RAM</desc>
8079	</param>
8080	<param name="memFree" type="unsigned long" dir="out">
8081	<desc>Free amount of physical guest RAM</desc>
8082	</param>
8083	<param name="memBalloon" type="unsigned long" dir="out">
8084	<desc>Amount of ballooned physical guest RAM</desc>
8085	</param>
8086	<param name="memShared" type="unsigned long" dir="out">
8087	<desc>Amount of shared physical guest RAM</desc>
8088	</param>
8089	<param name="memCache" type="unsigned long" dir="out">
8090	<desc>Total amount of guest (disk) cache memory</desc>
8091	</param>
8092	<param name="pagedTotal" type="unsigned long" dir="out">
8093	<desc>Total amount of space in the page file</desc>
8094	</param>
8095	<param name="memAllocTotal" type="unsigned long" dir="out">
8096	<desc>Total amount of memory allocated by the hypervisor</desc>
8097	</param>
8098	<param name="memFreeTotal" type="unsigned long" dir="out">
8099	<desc>Total amount of free memory available in the hypervisor</desc>
8100	</param>
8101	<param name="memBalloonTotal" type="unsigned long" dir="out">
8102	<desc>Total amount of memory ballooned by the hypervisor</desc>
8103	</param>
8104	<param name="memSharedTotal" type="unsigned long" dir="out">
8105	<desc>Total amount of shared memory in the hypervisor</desc>
8106	</param>
8107	</method>
8108
8109	<method name="getAdditionsStatus">
8110	<desc>
8111	Retrieve the current status of a certain Guest Additions run level.
8112
8113	<result name="VBOX_E_NOT_SUPPORTED">
8114	Wrong status level specified.
8115	</result>
8116
8117	</desc>
8118	<param name="level" type="AdditionsRunLevelType" dir="in">
8119	<desc>Status level to check</desc>
8120	</param>
8121	<param name="active" type="boolean" dir="return">
8122	<desc>Flag whether the status level has been reached or not</desc>
8123	</param>
8124	</method>
8125
8126	<method name="setCredentials">
8127	<desc>
8128	Store login credentials that can be queried by guest operating
8129	systems with Additions installed. The credentials are transient
8130	to the session and the guest may also choose to erase them. Note
8131	that the caller cannot determine whether the guest operating system
8132	has queried or made use of the credentials.
8133
8134	<result name="VBOX_E_VM_ERROR">
8135	VMM device is not available.
8136	</result>
8137
8138	</desc>
8139	<param name="userName" type="wstring" dir="in">
8140	<desc>User name string, can be empty</desc>
8141	</param>
8142	<param name="password" type="wstring" dir="in">
8143	<desc>Password string, can be empty</desc>
8144	</param>
8145	<param name="domain" type="wstring" dir="in">
8146	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8147	</param>
8148	<param name="allowInteractiveLogon" type="boolean" dir="in">
8149	<desc>
8150	Flag whether the guest should alternatively allow the user to
8151	interactively specify different credentials. This flag might
8152	not be supported by all versions of the Additions.
8153	</desc>
8154	</param>
8155	</method>
8156
8157	<method name="executeProcess">
8158	<desc>
8159	Executes an existing program inside the guest VM.
8160
8161	<result name="VBOX_E_IPRT_ERROR">
8162	Could not execute process.
8163	</result>
8164
8165	</desc>
8166	<param name="execName" type="wstring" dir="in">
8167	<desc>
8168	Full path name of the command to execute on the guest; the
8169	commands has to exists in the guest VM in order to be executed.
8170	</desc>
8171	</param>
8172	<param name="flags" type="unsigned long" dir="in">
8173	<desc>
8174	<link to="ExecuteProcessFlag"/> flags.
8175	</desc>
8176	</param>
8177	<param name="arguments" type="wstring" safearray="yes" dir="in">
8178	<desc>
8179	Array of arguments passed to the execution command.
8180	</desc>
8181	</param>
8182	<param name="environment" type="wstring" safearray="yes" dir="in">
8183	<desc>
8184	Environment variables that can be set while the command is being
8185	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
8186	variable just set its name ("NAME") without a value.
8187	</desc>
8188	</param>
8189	<param name="userName" type="wstring" dir="in">
8190	<desc>
8191	User name under which the command will be executed; has to exist
8192	and have the appropriate rights to execute programs in the VM.
8193	</desc>
8194	</param>
8195	<param name="password" type="wstring" dir="in">
8196	<desc>
8197	Password of the user account specified.
8198	</desc>
8199	</param>
8200	<param name="timeoutMS" type="unsigned long" dir="in">
8201	<desc>
8202	The maximum timeout value (in msec) to wait for finished program
8203	execution. Pass 0 for an infinite timeout.
8204	</desc>
8205	</param>
8206	<param name="pid" type="unsigned long" dir="out">
8207	<desc>
8208	The PID (process ID) of the started command for later reference.
8209	</desc>
8210	</param>
8211	<param name="progress" type="IProgress" dir="return">
8212	<desc>Progress object to track the operation completion.</desc>
8213	</param>
8214	</method>
8215
8216	<method name="getProcessOutput">
8217	<desc>
8218	Retrieves output of a formerly started process.
8219
8220	<result name="VBOX_E_IPRT_ERROR">
8221	Could not retrieve output.
8222	</result>
8223
8224	</desc>
8225	<param name="pid" type="unsigned long" dir="in">
8226	<desc>
8227	Process id returned by earlier executeProcess() call.
8228	</desc>
8229	</param>
8230	<param name="flags" type="unsigned long" dir="in">
8231	<desc>
8232	Flags describing which output to retrieve.
8233	</desc>
8234	</param>
8235	<param name="timeoutMS" type="unsigned long" dir="in">
8236	<desc>
8237	The maximum timeout value (in msec) to wait for output
8238	data. Pass 0 for an infinite timeout.
8239	</desc>
8240	</param>
8241	<param name="size" type="long long" dir="in">
8242	<desc>
8243	Size in bytes to read in the buffer.
8244	</desc>
8245	</param>
8246	<param name="data" type="octet" dir="return" safearray="yes">
8247	<desc>
8248	Buffer for retrieving the actual output. A data size of 0 means end of file
8249	if the requested size was not 0. This is the unprocessed
8250	output data, i.e. the line ending style depends on the platform of
8251	the system the server is running on.
8252	</desc>
8253	</param>
8254	</method>
8255
8256	<method name="getProcessStatus">
8257	<desc>
8258	Retrieves status, exit code and the exit reason of a formerly started process.
8259
8260	<result name="VBOX_E_IPRT_ERROR">
8261	Process with specified PID was not found.
8262	</result>
8263
8264	</desc>
8265	<param name="pid" type="unsigned long" dir="in">
8266	<desc>
8267	Process id returned by earlier executeProcess() call.
8268	</desc>
8269	</param>
8270	<param name="exitcode" type="unsigned long" dir="out">
8271	<desc>
8272	The exit code (if available).
8273	</desc>
8274	</param>
8275	<param name="flags" type="unsigned long" dir="out">
8276	<desc>
8277	Additional flags of process status. Not used at the moment and
8278	must be set to 0.
8279	</desc>
8280	</param>
8281	<param name="reason" type="unsigned long" dir="return">
8282	<desc>
8283	The current process status.
8284	</desc>
8285	</param>
8286	</method>
8287
8288	<method name="copyToGuest">
8289	<desc>
8290	Copies files/directories from host to the guest.
8291
8292	<result name="VBOX_E_IPRT_ERROR">
8293	Error while copying.
8294	</result>
8295
8296	</desc>
8297	<param name="source" type="wstring" dir="in">
8298	<desc>
8299	Source file on the host to copy.
8300	</desc>
8301	</param>
8302	<param name="dest" type="wstring" dir="in">
8303	<desc>
8304	Destination path on the guest.
8305	</desc>
8306	</param>
8307	<param name="userName" type="wstring" dir="in">
8308	<desc>
8309	User name under which the copy command will be executed; the
8310	user has to exist and have the appropriate rights to write to
8311	the destination path.
8312	</desc>
8313	</param>
8314	<param name="password" type="wstring" dir="in">
8315	<desc>
8316	Password of the user account specified.
8317	</desc>
8318	</param>
8319	<param name="flags" type="unsigned long" dir="in">
8320	<desc>
8321	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
8322	</desc>
8323	</param>
8324	<param name="progress" type="IProgress" dir="return">
8325	<desc>Progress object to track the operation completion.</desc>
8326	</param>
8327	</method>
8328
8329	<method name="createDirectory">
8330	<desc>
8331	Creates a directory on the guest.
8332
8333	<result name="VBOX_E_IPRT_ERROR">
8334	Error while creating directory.
8335	</result>
8336
8337	</desc>
8338	<param name="directory" type="wstring" dir="in">
8339	<desc>
8340	Directory to create.
8341	</desc>
8342	</param>
8343	<param name="userName" type="wstring" dir="in">
8344	<desc>
8345	User name under which the directory creation will be executed; the
8346	user has to exist and have the appropriate rights to create the
8347	desired directory.
8348	</desc>
8349	</param>
8350	<param name="password" type="wstring" dir="in">
8351	<desc>
8352	Password of the user account specified.
8353	</desc>
8354	</param>
8355	<param name="mode" type="unsigned long" dir="in">
8356	<desc>
8357	File mode.
8358	</desc>
8359	</param>
8360	<param name="flags" type="unsigned long" dir="in">
8361	<desc>
8362	<link to="CreateDirectoryFlag"/> flags.
8363	</desc>
8364	</param>
8365	<param name="progress" type="IProgress" dir="return">
8366	<desc>Progress object to track the operation completion.</desc>
8367	</param>
8368	</method>
8369
8370	<method name="setProcessInput">
8371	<desc>
8372	Sends input into a formerly started process.
8373
8374	<result name="VBOX_E_IPRT_ERROR">
8375	Could not send input.
8376	</result>
8377
8378	</desc>
8379	<param name="pid" type="unsigned long" dir="in">
8380	<desc>
8381	Process id returned by earlier executeProcess() call.
8382	</desc>
8383	</param>
8384	<param name="flags" type="unsigned long" dir="in">
8385	<desc>
8386	<link to="ProcessInputFlag"/> flags.
8387	</desc>
8388	</param>
8389	<param name="timeoutMS" type="unsigned long" dir="in">
8390	<desc>
8391	The maximum timeout value (in msec) to wait for getting the
8392	data transfered to the guest. Pass 0 for an infinite timeout.
8393	</desc>
8394	</param>
8395	<param name="data" type="octet" dir="in" safearray="yes">
8396	<desc>
8397	Buffer of input data to send to the started process to.
8398	</desc>
8399	</param>
8400	<param name="written" type="unsigned long" dir="return">
8401	<desc>
8402	Number of bytes written.
8403	</desc>
8404	</param>
8405	</method>
8406
8407	<method name="updateGuestAdditions">
8408	<desc>
8409	Updates already installed Guest Additions in a VM
8410	(Windows guests only).
8411
8412	<result name="VBOX_E_IPRT_ERROR">
8413	Error while updating.
8414	</result>
8415
8416	</desc>
8417	<param name="source" type="wstring" dir="in">
8418	<desc>
8419	Path to the Guest Additions .ISO file to use for the upate.
8420	</desc>
8421	</param>
8422	<param name="flags" type="unsigned long" dir="in">
8423	<desc>
8424	<link to="AdditionsUpdateFlag"/> flags.
8425	</desc>
8426	</param>
8427	<param name="progress" type="IProgress" dir="return">
8428	<desc>Progress object to track the operation completion.</desc>
8429	</param>
8430	</method>
8431
8432	</interface>
8433
8434
8435	<!--
8436	// IProgress
8437	/////////////////////////////////////////////////////////////////////////
8438	-->
8439
8440	<interface
8441	name="IProgress" extends="$unknown"
8442	uuid="A163C98F-8635-4AA8-B770-A9941737F3EF"
8443	wsmap="managed"
8444	>
8445	<desc>
8446	The IProgress interface is used to track and control
8447	asynchronous tasks within VirtualBox.
8448
8449	An instance of this is returned every time VirtualBox starts
8450	an asynchronous task (in other words, a separate thread) which
8451	continues to run after a method call returns. For example,
8452	<link to="IConsole::saveState" />, which saves the state of
8453	a running virtual machine, can take a long time to complete.
8454	To be able to display a progress bar, a user interface such as
8455	the VirtualBox graphical user interface can use the IProgress
8456	object returned by that method.
8457
8458	Note that IProgress is a "read-only" interface in the sense
8459	that only the VirtualBox internals behind the Main API can
8460	create and manipulate progress objects, whereas client code
8461	can only use the IProgress object to monitor a task's
8462	progress and, if <link to="#cancelable" /> is @c true,
8463	cancel the task by calling <link to="#cancel" />.
8464
8465	A task represented by IProgress consists of either one or
8466	several sub-operations that run sequentially, one by one (see
8467	<link to="#operation" /> and <link to="#operationCount" />).
8468	Every operation is identified by a number (starting from 0)
8469	and has a separate description.
8470
8471	You can find the individual percentage of completion of the current
8472	operation in <link to="#operationPercent" /> and the
8473	percentage of completion of the task as a whole
8474	in <link to="#percent" />.
8475
8476	Similarly, you can wait for the completion of a particular
8477	operation via <link to="#waitForOperationCompletion" /> or
8478	for the completion of the whole task via
8479	<link to="#waitForCompletion" />.
8480	</desc>
8481
8482	<attribute name="id" type="uuid" mod="string" readonly="yes">
8483	<desc>ID of the task.</desc>
8484	</attribute>
8485
8486	<attribute name="description" type="wstring" readonly="yes">
8487	<desc>Description of the task.</desc>
8488	</attribute>
8489
8490	<attribute name="initiator" type="$unknown" readonly="yes">
8491	<desc>Initiator of the task.</desc>
8492	</attribute>
8493
8494	<attribute name="cancelable" type="boolean" readonly="yes">
8495	<desc>Whether the task can be interrupted.</desc>
8496	</attribute>
8497
8498	<attribute name="percent" type="unsigned long" readonly="yes">
8499	<desc>
8500	Current progress value of the task as a whole, in percent.
8501	This value depends on how many operations are already complete.
8502	Returns 100 if <link to="#completed" /> is @c true.
8503	</desc>
8504	</attribute>
8505
8506	<attribute name="timeRemaining" type="long" readonly="yes">
8507	<desc>
8508	Estimated remaining time until the task completes, in
8509	seconds. Returns 0 once the task has completed; returns -1
8510	if the remaining time cannot be computed, in particular if
8511	the current progress is 0.
8512
8513	Even if a value is returned, the estimate will be unreliable
8514	for low progress values. It will become more reliable as the
8515	task progresses; it is not recommended to display an ETA
8516	before at least 20% of a task have completed.
8517	</desc>
8518	</attribute>
8519
8520	<attribute name="completed" type="boolean" readonly="yes">
8521	<desc>Whether the task has been completed.</desc>
8522	</attribute>
8523
8524	<attribute name="canceled" type="boolean" readonly="yes">
8525	<desc>Whether the task has been canceled.</desc>
8526	</attribute>
8527
8528	<attribute name="resultCode" type="long" readonly="yes">
8529	<desc>
8530	Result code of the progress task.
8531	Valid only if <link to="#completed"/> is @c true.
8532	</desc>
8533	</attribute>
8534
8535	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8536	<desc>
8537	Extended information about the unsuccessful result of the
8538	progress operation. May be @c null if no extended information
8539	is available.
8540	Valid only if <link to="#completed"/> is @c true and
8541	<link to="#resultCode"/> indicates a failure.
8542	</desc>
8543	</attribute>
8544
8545	<attribute name="operationCount" type="unsigned long" readonly="yes">
8546	<desc>
8547	Number of sub-operations this task is divided into.
8548	Every task consists of at least one suboperation.
8549	</desc>
8550	</attribute>
8551
8552	<attribute name="operation" type="unsigned long" readonly="yes">
8553	<desc>Number of the sub-operation being currently executed.</desc>
8554	</attribute>
8555
8556	<attribute name="operationDescription" type="wstring" readonly="yes">
8557	<desc>
8558	Description of the sub-operation being currently executed.
8559	</desc>
8560	</attribute>
8561
8562	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8563	<desc>Progress value of the current sub-operation only, in percent.</desc>
8564	</attribute>
8565
8566	<attribute name="operationWeight" type="unsigned long" readonly="yes">
8567	<desc>Weight value of the current sub-operation only.</desc>
8568	</attribute>
8569
8570	<attribute name="timeout" type="unsigned long">
8571	<desc>
8572	When non-zero, this specifies the number of milliseconds after which
8573	the operation will automatically be canceled. This can only be set on
8574	cancelable objects.
8575	</desc>
8576	</attribute>
8577
8578	<method name="setCurrentOperationProgress">
8579	<desc>Internal method, not to be called externally.</desc>
8580	<param name="percent" type="unsigned long" dir="in" />
8581	</method>
8582	<method name="setNextOperation">
8583	<desc>Internal method, not to be called externally.</desc>
8584	<param name="nextOperationDescription" type="wstring" dir="in" />
8585	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8586	</method>
8587
8588	<method name="waitForCompletion">
8589	<desc>
8590	Waits until the task is done (including all sub-operations)
8591	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8592
8593	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
8594	thread are not processed while waiting. Neglecting event queues may
8595	have dire consequences (degrade performance, resource hogs,
8596	deadlocks, etc.), this is specially so for the main thread on
8597	platforms using XPCOM. Callers are adviced wait for short periods
8598	and service their event queues between calls, or to create a worker
8599	thread to do the waiting.
8600
8601	<result name="VBOX_E_IPRT_ERROR">
8602	Failed to wait for task completion.
8603	</result>
8604	</desc>
8605
8606	<param name="timeout" type="long" dir="in">
8607	<desc>
8608	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8609	</desc>
8610	</param>
8611	</method>
8612
8613	<method name="waitForOperationCompletion">
8614	<desc>
8615	Waits until the given operation is done with a given timeout in
8616	milliseconds; specify -1 for an indefinite wait.
8617
8618	See <link to="#waitForCompletion"> for event queue considerations.</link>
8619
8620	<result name="VBOX_E_IPRT_ERROR">
8621	Failed to wait for operation completion.
8622	</result>
8623
8624	</desc>
8625	<param name="operation" type="unsigned long" dir="in">
8626	<desc>
8627	Number of the operation to wait for.
8628	Must be less than <link to="#operationCount"/>.
8629	</desc>
8630	</param>
8631	<param name="timeout" type="long" dir="in">
8632	<desc>
8633	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8634	</desc>
8635	</param>
8636	</method>
8637
8638	<method name="cancel">
8639	<desc>
8640	Cancels the task.
8641	<note>
8642	If <link to="#cancelable"/> is @c false, then this method will fail.
8643	</note>
8644
8645	<result name="VBOX_E_INVALID_OBJECT_STATE">
8646	Operation cannot be canceled.
8647	</result>
8648
8649	</desc>
8650	</method>
8651
8652	</interface>
8653
8654	<!--
8655	// ISnapshot
8656	/////////////////////////////////////////////////////////////////////////
8657	-->
8658
8659	<interface
8660	name="ISnapshot" extends="$unknown"
8661	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8662	wsmap="managed"
8663	>
8664	<desc>
8665	The ISnapshot interface represents a snapshot of the virtual
8666	machine.
8667
8668	Together with the differencing media that are created
8669	when a snapshot is taken, a machine can be brought back to
8670	the exact state it was in when the snapshot was taken.
8671
8672	The ISnapshot interface has no methods, only attributes; snapshots
8673	are controlled through methods of the <link to="IConsole" /> interface
8674	which also manage the media associated with the snapshot.
8675	The following operations exist:
8676
8677	<ul>
8678	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
8679	by creating new, empty differencing images for the machine's
8680	media and saving the VM settings and (if the VM is running)
8681	the current VM state in the snapshot.
8682
8683	The differencing images will then receive all data written to
8684	the machine's media, while their parent (base) images
8685	remain unmodified after the snapshot has been taken (see
8686	<link to="IMedium" /> for details about differencing images).
8687	This simplifies restoring a machine to the state of a snapshot:
8688	only the differencing images need to be deleted.
8689
8690	The current machine state is not changed by taking a snapshot
8691	except that <link to="IMachine::currentSnapshot" /> is set to
8692	the newly created snapshot, which is also added to the machine's
8693	snapshots tree.
8694	</li>
8695
8696	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
8697	the state of a previous snapshot by deleting the differencing
8698	image of each of the machine's media and setting the machine's
8699	settings and state to the state that was saved in the snapshot (if any).
8700
8701	This destroys the machine's current state. After calling this,
8702	<link to="IMachine::currentSnapshot" /> points to the snapshot
8703	that was restored.
8704	</li>
8705
8706	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
8707	without affecting the current machine state.
8708
8709	This does not change the current machine state, but instead frees the
8710	resources allocated when the snapshot was taken: the settings and machine
8711	state file are deleted (if any), and the snapshot's differencing image for
8712	each of the machine's media gets merged with its parent image.
8713
8714	Neither the current machine state nor other snapshots are affected
8715	by this operation, except that parent media will be modified
8716	to contain the disk data associated with the snapshot being deleted.
8717
8718	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
8719	attribute is set to the current snapshot's parent or NULL if it
8720	has no parent. Otherwise the attribute is unchanged.
8721	</li>
8722	</ul>
8723
8724	Each snapshot contains a copy of virtual machine's settings (hardware
8725	configuration etc.). This copy is contained in an immutable (read-only)
8726	instance of <link to="IMachine" /> which is available from the snapshot's
8727	<link to="#machine" /> attribute. When restoring the snapshot, these
8728	settings are copied back to the original machine.
8729
8730	In addition, if the machine was running when the
8731	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8732	the current VM state is saved in the snapshot (similarly to what happens
8733	when a VM's state is saved). The snapshot is then said to be <i>online</i>
8734	because when restoring it, the VM will be running.
8735
8736	If the machine was in <link to="MachineState_Saved">saved</link> saved,
8737	the snapshot receives a copy of the execution state file
8738	(<link to="IMachine::stateFilePath"/>).
8739
8740	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8741	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8742	it then contains a so-called "zero execution state", representing a
8743	machine that is powered off.
8744	</desc>
8745
8746	<attribute name="id" type="uuid" mod="string" readonly="yes">
8747	<desc>UUID of the snapshot.</desc>
8748	</attribute>
8749
8750	<attribute name="name" type="wstring">
8751	<desc>Short name of the snapshot.
8752	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
8753	be called implicitly.</note>
8754	</desc>
8755	</attribute>
8756
8757	<attribute name="description" type="wstring">
8758	<desc>Optional description of the snapshot.
8759	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
8760	be called implicitly.</note>
8761	</desc>
8762	</attribute>
8763
8764	<attribute name="timeStamp" type="long long" readonly="yes">
8765	<desc>
8766	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8767	</desc>
8768	</attribute>
8769
8770	<attribute name="online" type="boolean" readonly="yes">
8771	<desc>
8772	@c true if this snapshot is an online snapshot and @c false otherwise.
8773
8774	When this attribute is @c true, the
8775	<link to="IMachine::stateFilePath"/> attribute of the
8776	<link to="#machine"/> object associated with this snapshot
8777	will point to the saved state file. Otherwise, it will be
8778	an empty string.
8779	</desc>
8780	</attribute>
8781
8782	<attribute name="machine" type="IMachine" readonly="yes">
8783	<desc>
8784	Virtual machine this snapshot is taken on. This object
8785	stores all settings the machine had when taking this snapshot.
8786	<note>
8787	The returned machine object is immutable, i.e. no
8788	any settings can be changed.
8789	</note>
8790	</desc>
8791	</attribute>
8792
8793	<attribute name="parent" type="ISnapshot" readonly="yes">
8794	<desc>
8795	Parent snapshot (a snapshot this one is based on), or
8796	@c null if the snapshot has no parent (i.e. is the first snapshot).
8797	</desc>
8798	</attribute>
8799
8800	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8801	<desc>
8802	Child snapshots (all snapshots having this one as a parent).
8803	By inspecting this attribute starting with a machine's root snapshot
8804	(which can be obtained by calling <link to="IMachine::findSnapshot" />
8805	with a @c null UUID), a machine's snapshots tree can be iterated over.
8806	</desc>
8807	</attribute>
8808
8809	</interface>
8810
8811
8812	<!--
8813	// IMedium
8814	/////////////////////////////////////////////////////////////////////////
8815	-->
8816
8817	<enum
8818	name="MediumState"
8819	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8820	>
8821	<desc>
8822	Virtual medium state.
8823	<see>IMedium</see>
8824	</desc>
8825
8826	<const name="NotCreated" value="0">
8827	<desc>
8828	Associated medium storage does not exist (either was not created yet or
8829	was deleted).
8830	</desc>
8831	</const>
8832	<const name="Created" value="1">
8833	<desc>
8834	Associated storage exists and accessible; this gets set if the
8835	accessibility check performed by <link to="IMedium::refreshState" />
8836	was successful.
8837	</desc>
8838	</const>
8839	<const name="LockedRead" value="2">
8840	<desc>
8841	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8842	no data modification is possible.
8843	</desc>
8844	</const>
8845	<const name="LockedWrite" value="3">
8846	<desc>
8847	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8848	no concurrent data reading or modification is possible.
8849	</desc>
8850	</const>
8851	<const name="Inaccessible" value="4">
8852	<desc>
8853	Medium accessibility check (see <link to="IMedium::refreshState" />) has
8854	not yet been performed, or else, associated medium storage is not
8855	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8856	is empty, in the second case, it describes the error that occurred.
8857	</desc>
8858	</const>
8859	<const name="Creating" value="5">
8860	<desc>
8861	Associated medium storage is being created.
8862	</desc>
8863	</const>
8864	<const name="Deleting" value="6">
8865	<desc>
8866	Associated medium storage is being deleted.
8867	</desc>
8868	</const>
8869	</enum>
8870
8871	<enum
8872	name="MediumType"
8873	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
8874	>
8875	<desc>
8876	Virtual medium type.
8877	<see>IMedium</see>
8878	</desc>
8879
8880	<const name="Normal" value="0">
8881	<desc>
8882	Normal medium (attached directly or indirectly, preserved
8883	when taking snapshots).
8884	</desc>
8885	</const>
8886	<const name="Immutable" value="1">
8887	<desc>
8888	Immutable medium (attached indirectly, changes are wiped out
8889	the next time the virtual machine is started).
8890	</desc>
8891	</const>
8892	<const name="Writethrough" value="2">
8893	<desc>
8894	Write through medium (attached directly, ignored when
8895	taking snapshots).
8896	</desc>
8897	</const>
8898	<const name="Shareable" value="3">
8899	<desc>
8900	Allow using this medium concurrently by several machines.
8901	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
8902	</desc>
8903	</const>
8904	<const name="Readonly" value="4">
8905	<desc>
8906	A readonly medium, which can of course be used by several machines.
8907	<note>Present and accepted since VirtualBox 4.0.</note>
8908	</desc>
8909	</const>
8910	<const name="MultiAttach" value="5">
8911	<desc>
8912	A medium which is is indirectly attached, so that one base medium can
8913	be used for several VMs which have their own differencing medium to
8914	store their modifications. In some sense a variant of Immutable
8915	with unset AutoReset flag in each differencing medium.
8916	<note>Present and accepted since VirtualBox 4.0.</note>
8917	</desc>
8918	</const>
8919	</enum>
8920
8921	<enum
8922	name="MediumVariant"
8923	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8924	>
8925	<desc>
8926	Virtual medium image variant. More than one flag may be set.
8927	<see>IMedium</see>
8928	</desc>
8929
8930	<const name="Standard" value="0">
8931	<desc>
8932	No particular variant requested, results in using the backend default.
8933	</desc>
8934	</const>
8935	<const name="VmdkSplit2G" value="0x01">
8936	<desc>
8937	VMDK image split in chunks of less than 2GByte.
8938	</desc>
8939	</const>
8940	<const name="VmdkStreamOptimized" value="0x04">
8941	<desc>
8942	VMDK streamOptimized image. Special import/export format which is
8943	read-only/append-only.
8944	</desc>
8945	</const>
8946	<const name="VmdkESX" value="0x08">
8947	<desc>
8948	VMDK format variant used on ESX products.
8949	</desc>
8950	</const>
8951	<const name="Fixed" value="0x10000">
8952	<desc>
8953	Fixed image. Only allowed for base images.
8954	</desc>
8955	</const>
8956	<const name="Diff" value="0x20000">
8957	<desc>
8958	Differencing image. Only allowed for child images.
8959	</desc>
8960	</const>
8961	</enum>
8962
8963	<interface
8964	name="IMediumAttachment" extends="$unknown"
8965	uuid="aa4b4840-934f-454d-9a28-23e8f4235edf"
8966	wsmap="struct"
8967	>
8968	<desc>
8969	The IMediumAttachment interface links storage media to virtual machines.
8970	For each medium (<link to="IMedium"/>) which has been attached to a
8971	storage controller (<link to="IStorageController"/>) of a machine
8972	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
8973	method, one instance of IMediumAttachment is added to the machine's
8974	<link to="IMachine::mediumAttachments"/> array attribute.
8975
8976	Each medium attachment specifies the storage controller as well as a
8977	port and device number and the IMedium instance representing a virtual
8978	hard disk or floppy or DVD image.
8979
8980	For removeable media (DVDs or floppies), there are two additional
8981	options. For one, the IMedium instance can be @c null to represent
8982	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
8983	secondly, the medium can be one of the pseudo-media for host drives
8984	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
8985	</desc>
8986
8987	<attribute name="medium" type="IMedium" readonly="yes">
8988	<desc>Medium object associated with this attachment; it
8989	can be @c null for removable devices.</desc>
8990	</attribute>
8991
8992	<attribute name="controller" type="wstring" readonly="yes">
8993	<desc>Name of the storage controller of this attachment; this
8994	refers to one of the controllers in <link to="IMachine::storageControllers" />
8995	by name.</desc>
8996	</attribute>
8997
8998	<attribute name="port" type="long" readonly="yes">
8999	<desc>Port number of this attachment.
9000	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
9001	</desc>
9002	</attribute>
9003
9004	<attribute name="device" type="long" readonly="yes">
9005	<desc>Device slot number of this attachment.
9006	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
9007	</desc>
9008	</attribute>
9009
9010	<attribute name="type" type="DeviceType" readonly="yes">
9011	<desc>Device type of this attachment.</desc>
9012	</attribute>
9013
9014	<attribute name="passthrough" type="boolean" readonly="yes">
9015	<desc>Pass I/O requests through to a device on the host.</desc>
9016	</attribute>
9017
9018	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
9019	<desc>The bandwidth group this medium attachment is assigned to.</desc>
9020	</attribute>
9021
9022	</interface>
9023
9024	<interface
9025	name="IMedium" extends="$unknown"
9026	uuid="9edda847-1279-4b0a-9af7-9d66251ccc18"
9027	wsmap="managed"
9028	>
9029	<desc>
9030	The IMedium interface represents virtual storage for a machine's
9031	hard disks, CD/DVD or floppy drives. It will typically represent
9032	a disk image on the host, for example a VDI or VMDK file representing
9033	a virtual hard disk, or an ISO or RAW file representing virtual
9034	removable media, but can also point to a network location (e.g.
9035	for iSCSI targets).
9036
9037	Instances of IMedium are connected to virtual machines by way of
9038	medium attachments (see <link to="IMediumAttachment" />), which link
9039	the storage medium to a particular device slot of a storage controller
9040	of the virtual machine.
9041	In the VirtualBox API, virtual storage is therefore always represented
9042	by the following chain of object links:
9043
9044	<ul>
9045	<li><link to="IMachine::storageControllers"/> contains an array of
9046	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
9047	these are instances of <link to="IStorageController"/>).</li>
9048	<li><link to="IMachine::mediumAttachments"/> contains an array of
9049	medium attachments (instances of <link to="IMediumAttachment"/>),
9050	each containing a storage controller from the above array, a
9051	port/device specification, and an instance of IMedium representing
9052	the medium storage (image file).
9053
9054	For removable media, the storage medium is optional; a medium
9055	attachment with no medium represents a CD/DVD or floppy drive
9056	with no medium inserted. By contrast, hard disk attachments
9057	will always have an IMedium object attached.</li>
9058	<li>Each IMedium in turn points to a storage unit (such as a file
9059	on the host computer or a network resource) that holds actual
9060	data. This location is represented by the <link to="#location"/>
9061	attribute.</li>
9062	</ul>
9063
9064	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
9065	new hard disk media can be created with the VirtualBox API using the
9066	<link to="IVirtualBox::createHardDisk"/> method.
9067
9068	CD/DVD and floppy images (ISO and RAW files) are usually created outside
9069	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
9070	type in a regular file.
9071
9072	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
9073	drive; in that case the <link to="#id" /> attribute contains the UUID of
9074	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
9075
9076	<h3>Known media</h3>
9077
9078	When an existing medium is opened and attached to a virtual machine, it
9079	is automatically added to a media registry. If the medium has first
9080	been attached to a machine which was created by VirtualBox 4.0 or later,
9081	it is added to that machine's media registry (in the machine XML settings
9082	file; this way all information about a machine's media attachments is
9083	contained in a single file). For older media attachments (i.e. if the
9084	medium was first attached to a machine which was created with a VirtualBox
9085	version before 4.0), media continue to be registered in the global
9086	VirtualBox settings file, for backwards compatibility.
9087
9088	See <link to="IVirtualBox::openMedium" /> for more information.
9089
9090	All known media can be enumerated using
9091	<link to="IVirtualBox::hardDisks"/>,
9092	<link to="IVirtualBox::DVDImages"/> and
9093	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
9094	quickly found using the <link to="IVirtualBox::findMedium"/> method.
9095
9096	Only known media can be attached to virtual machines.
9097
9098	Removing known media from the media registry is performed when the given
9099	medium is closed using the <link to="#close"/> method or when its
9100	associated storage unit is deleted.
9101
9102	<h3>Accessibility checks</h3>
9103
9104	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
9105	method is called explicitly on a medium. This is done to make the VirtualBox object
9106	ready for serving requests as fast as possible and let the end-user
9107	application decide if it needs to check media accessibility right away or not.
9108
9109	As a result, when VirtualBox starts up (e.g. the VirtualBox
9110	object gets created for the first time), all known media are in the
9111	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
9112	attribute is an empty string because no actual accessibility check has
9113	been made yet.
9114
9115	After calling <link to="#refreshState" />, a medium is considered
9116	<i>accessible</i> if its storage unit can be read. In that case, the
9117	<link to="#state"/> attribute has a value of "Created". If the storage
9118	unit cannot be read (for example, because it is located on a disconnected
9119	network resource, or was accidentally deleted outside VirtualBox),
9120	the medium is considered <i>inaccessible</i>, which is indicated by the
9121	"Inaccessible" state. The exact reason why the medium is inaccessible can be
9122	obtained by reading the <link to="#lastAccessError"/> attribute.
9123
9124	<h3>Medium types</h3>
9125
9126	There are four types of medium behavior (see <link to="MediumType" />):
9127	"normal", "immutable", "writethrough" and "shareable", represented by the
9128	<link to="#type"/> attribute. The type of the medium defines how the
9129	medium is attached to a virtual machine and what happens when a
9130	<link to="ISnapshot">snapshot</link> of the virtual machine with the
9131	attached medium is taken. At the moment DVD and floppy media are always
9132	of type "writethrough".
9133
9134	All media can be also divided in two groups: <i>base</i> media and
9135	<i>differencing</i> media. A base medium contains all sectors of the
9136	medium data in its own storage and therefore can be used independently.
9137	In contrast, a differencing medium is a "delta" to some other medium and
9138	contains only those sectors which differ from that other medium, which is
9139	then called a <i>parent</i>. The differencing medium is said to be
9140	<i>linked to</i> that parent. The parent may be itself a differencing
9141	medium, thus forming a chain of linked media. The last element in that
9142	chain must always be a base medium. Note that several differencing
9143	media may be linked to the same parent medium.
9144
9145	Differencing media can be distinguished from base media by querying the
9146	<link to="#parent"/> attribute: base media do not have parents they would
9147	depend on, so the value of this attribute is always @c null for them.
9148	Using this attribute, it is possible to walk up the medium tree (from the
9149	child medium to its parent). It is also possible to walk down the tree
9150	using the <link to="#children"/> attribute.
9151
9152	Note that the type of all differencing media is "normal"; all other
9153	values are meaningless for them. Base media may be of any type.
9154
9155	<h3>Creating hard disks</h3>
9156
9157	New base hard disks are created using
9158	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
9159	opened using <link to="IVirtualBox::openMedium"/>. Differencing hard
9160	disks are usually implicitly created by VirtualBox when needed but may
9161	also be created explicitly using <link to="#createDiffStorage"/>.
9162
9163	After the hard disk is successfully created (including the storage unit)
9164	or opened, it becomes a known hard disk (remembered in the internal media
9165	registry). Known hard disks can be attached to a virtual machine, accessed
9166	through <link to="IVirtualBox::findMedium"/> or enumerated using the
9167	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
9168
9169	The following methods, besides <link to="IMedium::close"/>,
9170	automatically remove the hard disk from the media registry:
9171	<ul>
9172	<li><link to="#deleteStorage"/></li>
9173	<li><link to="#mergeTo"/></li>
9174	</ul>
9175
9176	If the storage unit of the hard disk is a regular file in the host's
9177	file system then the rules stated in the description of the
9178	<link to="IMedium::location"/> attribute apply when setting its value.
9179
9180	<h4>Automatic composition of the file name part</h4>
9181
9182	Another extension to the <link to="IMedium::location"/> attribute is that
9183	there is a possibility to cause VirtualBox to compose a unique value for
9184	the file name part of the location using the UUID of the hard disk. This
9185	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
9186	e.g. before the storage unit is created, and works as follows. You set the
9187	value of the <link to="IMedium::location"/> attribute to a location
9188	specification which only contains the path specification but not the file
9189	name part and ends with either a forward slash or a backslash character.
9190	In response, VirtualBox will generate a new UUID for the hard disk and
9191	compose the file name using the following pattern:
9192	<pre>
9193	<path>/{<uuid>}.<ext>
9194	</pre>
9195	where <tt><path></tt> is the supplied path specification,
9196	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
9197	is the default extension for the storage format of this hard disk. After
9198	that, you may call any of the methods that create a new hard disk storage
9199	unit and they will use the generated UUID and file name.
9200
9201	<h3>Attaching Hard Disks</h3>
9202
9203	Hard disks are attached to virtual machines using the
9204	<link to="IMachine::attachDevice"/> method and detached using the
9205	<link to="IMachine::detachDevice"/> method. Depending on their
9206	<link to="#type"/>, hard disks are attached either
9207	<i>directly</i> or <i>indirectly</i>.
9208
9209	When a hard disk is being attached directly, it is associated with the
9210	virtual machine and used for hard disk operations when the machine is
9211	running. When a hard disk is being attached indirectly, a new differencing
9212	hard disk linked to it is implicitly created and this differencing hard
9213	disk is associated with the machine and used for hard disk operations.
9214	This also means that if <link to="IMachine::attachDevice"/> performs
9215	a direct attachment then the same hard disk will be returned in response
9216	to the subsequent <link to="IMachine::getMedium"/> call; however if
9217	an indirect attachment is performed then
9218	<link to="IMachine::getMedium"/> will return the implicitly created
9219	differencing hard disk, not the original one passed to <link
9220	to="IMachine::attachDevice"/>. In detail:
9221
9222	<ul>
9223	<li><b>Normal base</b> hard disks that do not have children (i.e.
9224	differencing hard disks linked to them) and that are not already
9225	attached to virtual machines in snapshots are attached <b>directly</b>.
9226	Otherwise, they are attached <b>indirectly</b> because having
9227	dependent children or being part of the snapshot makes it impossible
9228	to modify hard disk contents without breaking the integrity of the
9229	dependent party. The <link to="#readOnly"/> attribute allows to
9230	quickly determine the kind of the attachment for the given hard
9231	disk. Note that if a normal base hard disk is to be indirectly
9232	attached to a virtual machine with snapshots then a special
9233	procedure called <i>smart attachment</i> is performed (see below).</li>
9234	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
9235	they are attached <b>directly</b> if they do not have children and are
9236	not attached to virtual machines in snapshots, and <b>indirectly</b>
9237	otherwise. Note that the smart attachment procedure is never performed
9238	for differencing hard disks.</li>
9239	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
9240	they are designed to be non-writable. If an immutable hard disk is
9241	attached to a virtual machine with snapshots then a special
9242	procedure called smart attachment is performed (see below).</li>
9243	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
9244	also as designed. This also means that writethrough hard disks cannot
9245	have other hard disks linked to them at all.</li>
9246	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
9247	also as designed. This also means that shareable hard disks cannot
9248	have other hard disks linked to them at all. They behave almost
9249	like writethrough hard disks, except that shareable hard disks can
9250	be attached to several virtual machines which are running, allowing
9251	concurrent accesses. You need special cluster software running in
9252	the virtual machines to make use of such disks.</li>
9253	</ul>
9254
9255	Note that the same hard disk, regardless of its type, may be attached to
9256	more than one virtual machine at a time. In this case, the machine that is
9257	started first gains exclusive access to the hard disk and attempts to
9258	start other machines having this hard disk attached will fail until the
9259	first machine is powered down.
9260
9261	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
9262	that the given hard disk remains associated with the given machine after a
9263	successful <link to="IMachine::detachDevice"/> call until
9264	<link to="IMachine::saveSettings"/> is called to save all changes to
9265	machine settings to disk. This deferring is necessary to guarantee that
9266	the hard disk configuration may be restored at any time by a call to
9267	<link to="IMachine::discardSettings"/> before the settings
9268	are saved (committed).
9269
9270	Note that if <link to="IMachine::discardSettings"/> is called after
9271	indirectly attaching some hard disks to the machine but before a call to
9272	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
9273	all differencing hard disks implicitly created by
9274	<link to="IMachine::attachDevice"/> for these indirect attachments.
9275	Such implicitly created hard disks will also be immediately deleted when
9276	detached explicitly using the <link to="IMachine::detachDevice"/>
9277	call if it is made before <link to="IMachine::saveSettings"/>. This
9278	implicit deletion is safe because newly created differencing hard
9279	disks do not contain any user data.
9280
9281	However, keep in mind that detaching differencing hard disks that were
9282	implicitly created by <link to="IMachine::attachDevice"/>
9283	before the last <link to="IMachine::saveSettings"/> call will
9284	<b>not</b> implicitly delete them as they may already contain some data
9285	(for example, as a result of virtual machine execution). If these hard
9286	disks are no more necessary, the caller can always delete them explicitly
9287	using <link to="#deleteStorage"/> after they are actually de-associated
9288	from this machine by the <link to="IMachine::saveSettings"/> call.
9289
9290	<h3>Smart Attachment</h3>
9291
9292	When normal base or immutable hard disks are indirectly attached to a
9293	virtual machine then some additional steps are performed to make sure the
9294	virtual machine will have the most recent "view" of the hard disk being
9295	attached. These steps include walking through the machine's snapshots
9296	starting from the current one and going through ancestors up to the first
9297	snapshot. Hard disks attached to the virtual machine in all
9298	of the encountered snapshots are checked whether they are descendants of
9299	the given normal base or immutable hard disk. The first found child (which
9300	is the differencing hard disk) will be used instead of the normal base or
9301	immutable hard disk as a parent for creating a new differencing hard disk
9302	that will be actually attached to the machine. And only if no descendants
9303	are found or if the virtual machine does not have any snapshots then the
9304	normal base or immutable hard disk will be used itself as a parent for
9305	this differencing hard disk.
9306
9307	It is easier to explain what smart attachment does using the
9308	following example:
9309	<pre>
9310	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9311
9312	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9313	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9314	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9315	Snapshot 4 (none) Snapshot 4 (none)
9316	CurState (none) CurState (D3->D2.vdi)
9317
9318	NOT
9319	...
9320	CurState (D3->B.vdi)
9321	</pre>
9322	The first column is the virtual machine configuration before the base hard
9323	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9324	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9325	mean that the hard disk that is actually attached to the machine is a
9326	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9327	another hard disk, <tt>B.vdi</tt>.
9328
9329	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9330	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9331	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9332	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9333	it cannot be attached directly and needs an indirect attachment (i.e.
9334	implicit creation of a new differencing hard disk). Due to the smart
9335	attachment procedure, the new differencing hard disk
9336	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9337	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9338	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9339	machine.
9340
9341	Note that if there is more than one descendant hard disk of the given base
9342	hard disk found in a snapshot, and there is an exact device, channel and
9343	bus match, then this exact match will be used. Otherwise, the youngest
9344	descendant will be picked up.
9345
9346	There is one more important aspect of the smart attachment procedure which
9347	is not related to snapshots at all. Before walking through the snapshots
9348	as described above, the backup copy of the current list of hard disk
9349	attachment is searched for descendants. This backup copy is created when
9350	the hard disk configuration is changed for the first time after the last
9351	<link to="IMachine::saveSettings"/> call and used by
9352	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9353	changes. When such a descendant is found in this backup copy, it will be
9354	simply re-attached back, without creating a new differencing hard disk for
9355	it. This optimization is necessary to make it possible to re-attach the
9356	base or immutable hard disk to a different bus, channel or device slot
9357	without losing the contents of the differencing hard disk actually
9358	attached to the machine in place of it.
9359	</desc>
9360
9361	<attribute name="id" type="uuid" mod="string" readonly="yes">
9362	<desc>
9363	UUID of the medium. For a newly created medium, this value is a randomly
9364	generated UUID.
9365
9366	<note>
9367	For media in one of MediumState_NotCreated, MediumState_Creating or
9368	MediumState_Deleting states, the value of this property is undefined
9369	and will most likely be an empty UUID.
9370	</note>
9371	</desc>
9372	</attribute>
9373
9374	<attribute name="description" type="wstring">
9375	<desc>
9376	Optional description of the medium. For a newly created medium the value
9377	of this attribute is an empty string.
9378
9379	Medium types that don't support this attribute will return E_NOTIMPL in
9380	attempt to get or set this attribute's value.
9381
9382	<note>
9383	For some storage types, reading this attribute may return an outdated
9384	(last known) value when <link to="#state"/> is <link
9385	to="MediumState_Inaccessible"/> or <link
9386	to="MediumState_LockedWrite"/> because the value of this attribute is
9387	stored within the storage unit itself. Also note that changing the
9388	attribute value is not possible in such case, as well as when the
9389	medium is the <link to="MediumState_LockedRead"/> state.
9390	</note>
9391	</desc>
9392	</attribute>
9393
9394	<attribute name="state" type="MediumState" readonly="yes">
9395	<desc>
9396	Returns the current medium state, which is the last state set by
9397	the accessibility check performed by <link to="#refreshState"/>.
9398	If that method has not yet been called on the medium, the state
9399	is "Inaccessible"; as opposed to truly inaccessible media, the
9400	value of <link to="#lastAccessError"/> will be an empty string in
9401	that case.
9402
9403	<note>As of version 3.1, this no longer performs an accessibility check
9404	automatically; call <link to="#refreshState"/> for that.
9405	</note>
9406	</desc>
9407	</attribute>
9408
9409	<attribute name="variant" type="unsigned long" readonly="yes">
9410	<desc>
9411	Returns the storage format variant information for this medium
9412	as a combination of the flags described at <link to="MediumVariant" />.
9413	Before <link to="#refreshState"/> is called this method returns
9414	an undefined value.
9415	</desc>
9416	</attribute>
9417
9418	<attribute name="location" type="wstring">
9419	<desc>
9420	Location of the storage unit holding medium data.
9421
9422	The format of the location string is medium type specific. For medium
9423	types using regular files in a host's file system, the location
9424	string is the full file name.
9425
9426	Some medium types may support changing the storage unit location by
9427	simply changing the value of this property. If this operation is not
9428	supported, the implementation will return E_NOTIMPL in attempt to set
9429	this attribute's value.
9430
9431	When setting a value of the location attribute which is a regular file
9432	in the host's file system, the given file name may be either relative to
9433	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9434	absolute. Note that if the given location specification does not contain
9435	the file extension part then a proper default extension will be
9436	automatically appended by the implementation depending on the medium type.
9437	</desc>
9438	</attribute>
9439
9440	<attribute name="name" type="wstring" readonly="yes">
9441	<desc>
9442	Name of the storage unit holding medium data.
9443
9444	The returned string is a short version of the <link to="#location"/>
9445	attribute that is suitable for representing the medium in situations
9446	where the full location specification is too long (such as lists
9447	and comboboxes in GUI frontends). This string is also used by frontends
9448	to sort the media list alphabetically when needed.
9449
9450	For example, for locations that are regular files in the host's file
9451	system, the value of this attribute is just the file name (+ extension),
9452	without the path specification.
9453
9454	Note that as opposed to the <link to="#location"/> attribute, the name
9455	attribute will not necessary be unique for a list of media of the
9456	given type and format.
9457	</desc>
9458	</attribute>
9459
9460	<attribute name="deviceType" type="DeviceType" readonly="yes">
9461	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9462	medium.</desc>
9463	</attribute>
9464
9465	<attribute name="hostDrive" type="boolean" readonly="yes">
9466	<desc>True if this corresponds to a drive on the host.</desc>
9467	</attribute>
9468
9469	<attribute name="size" type="long long" readonly="yes">
9470	<desc>
9471	Physical size of the storage unit used to hold medium data (in bytes).
9472
9473	<note>
9474	For media whose <link to="#state"/> is <link
9475	to="MediumState_Inaccessible"/>, the value of this property is the
9476	last known size. For <link to="MediumState_NotCreated"/> media,
9477	the returned value is zero.
9478	</note>
9479	</desc>
9480	</attribute>
9481
9482	<attribute name="format" type="wstring" readonly="yes">
9483	<desc>
9484	Storage format of this medium.
9485
9486	The value of this attribute is a string that specifies a backend used
9487	to store medium data. The storage format is defined when you create a
9488	new medium or automatically detected when you open an existing medium,
9489	and cannot be changed later.
9490
9491	The list of all storage formats supported by this VirtualBox
9492	installation can be obtained using
9493	<link to="ISystemProperties::mediumFormats"/>.
9494	</desc>
9495	</attribute>
9496
9497	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9498	<desc>
9499	Storage medium format object corresponding to this medium.
9500
9501	The value of this attribute is a reference to the medium format object
9502	that specifies the backend properties used to store medium data. The
9503	storage format is defined when you create a new medium or automatically
9504	detected when you open an existing medium, and cannot be changed later.
9505
9506	<note>@c null is returned if there is no associated medium format
9507	object. This can e.g. happen for medium objects representing host
9508	drives and other special medium objects.</note>
9509	</desc>
9510	</attribute>
9511
9512	<attribute name="type" type="MediumType">
9513	<desc>
9514	Type (role) of this medium.
9515
9516	The following constraints apply when changing the value of this
9517	attribute:
9518	<ul>
9519	<li>If a medium is attached to a virtual machine (either in the
9520	current state or in one of the snapshots), its type cannot be
9521	changed.
9522	</li>
9523	<li>As long as the medium has children, its type cannot be set
9524	to <link to="MediumType_Writethrough"/>.
9525	</li>
9526	<li>The type of all differencing media is
9527	<link to="MediumType_Normal"/> and cannot be changed.
9528	</li>
9529	</ul>
9530
9531	The type of a newly created or opened medium is set to
9532	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9533	which have a type of <link to="MediumType_Writethrough"/>.
9534	</desc>
9535	</attribute>
9536
9537	<attribute name="parent" type="IMedium" readonly="yes">
9538	<desc>
9539	Parent of this medium (the medium this medium is directly based
9540	on).
9541
9542	Only differencing media have parents. For base (non-differencing)
9543	media, @c null is returned.
9544	</desc>
9545	</attribute>
9546
9547	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9548	<desc>
9549	Children of this medium (all differencing media directly based
9550	on this medium). A @c null array is returned if this medium
9551	does not have any children.
9552	</desc>
9553	</attribute>
9554
9555	<attribute name="base" type="IMedium" readonly="yes">
9556	<desc>
9557	Base medium of this medium.
9558
9559	If this is a differencing medium, its base medium is the medium
9560	the given medium branch starts from. For all other types of media, this
9561	property returns the medium object itself (i.e. the same object this
9562	property is read on).
9563	</desc>
9564	</attribute>
9565
9566	<attribute name="readOnly" type="boolean" readonly="yes">
9567	<desc>
9568	Returns @c true if this medium is read-only and @c false otherwise.
9569
9570	A medium is considered to be read-only when its contents cannot be
9571	modified without breaking the integrity of other parties that depend on
9572	this medium such as its child media or snapshots of virtual machines
9573	where this medium is attached to these machines. If there are no
9574	children and no such snapshots then there is no dependency and the
9575	medium is not read-only.
9576
9577	The value of this attribute can be used to determine the kind of the
9578	attachment that will take place when attaching this medium to a
9579	virtual machine. If the value is @c false then the medium will
9580	be attached directly. If the value is @c true then the medium
9581	will be attached indirectly by creating a new differencing child
9582	medium for that. See the interface description for more information.
9583
9584	Note that all <link to="MediumType_Immutable">Immutable</link> media
9585	are always read-only while all
9586	<link to="MediumType_Writethrough">Writethrough</link> media are
9587	always not.
9588
9589	<note>
9590	The read-only condition represented by this attribute is related to
9591	the medium type and usage, not to the current
9592	<link to="IMedium::state">medium state</link> and not to the read-only
9593	state of the storage unit.
9594	</note>
9595	</desc>
9596	</attribute>
9597
9598	<attribute name="logicalSize" type="long long" readonly="yes">
9599	<desc>
9600	Logical size of this medium (in bytes), as reported to the
9601	guest OS running inside the virtual machine this medium is
9602	attached to. The logical size is defined when the medium is created
9603	and cannot be changed later.
9604
9605	<note>
9606	Reading this property on a differencing medium will return the size
9607	of its <link to="#base"/> medium.
9608	</note>
9609	<note>
9610	For media whose state is <link to="#state"/> is <link
9611	to="MediumState_Inaccessible"/>, the value of this property is the
9612	last known logical size. For <link to="MediumState_NotCreated"/>
9613	media, the returned value is zero.
9614	</note>
9615	</desc>
9616	</attribute>
9617
9618	<attribute name="autoReset" type="boolean">
9619	<desc>
9620	Whether this differencing medium will be automatically reset each
9621	time a virtual machine it is attached to is powered up. This
9622	attribute is automatically set to @c true for the last
9623	differencing image of an "immutable" medium (see
9624	<link to="MediumType" />).
9625
9626	See <link to="#reset"/> for more information about resetting
9627	differencing media.
9628
9629	<note>
9630	Reading this property on a base (non-differencing) medium will
9631	always @c false. Changing the value of this property in this
9632	case is not supported.
9633	</note>
9634
9635	<result name="VBOX_E_NOT_SUPPORTED">
9636	This is not a differencing medium (when changing the attribute
9637	value).
9638	</result>
9639	</desc>
9640	</attribute>
9641
9642	<attribute name="lastAccessError" type="wstring" readonly="yes">
9643	<desc>
9644	Text message that represents the result of the last accessibility
9645	check performed by <link to="#refreshState"/>.
9646
9647	An empty string is returned if the last accessibility check
9648	was successful or has not yet been called. As a result, if
9649	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9650	then <link to="#refreshState"/> has yet to be called; this is the
9651	default value of media after VirtualBox initialization.
9652	A non-empty string indicates a failure and should normally describe
9653	a reason of the failure (for example, a file read error).
9654	</desc>
9655	</attribute>
9656
9657	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9658	<desc>
9659	Array of UUIDs of all machines this medium is attached to.
9660
9661	A @c null array is returned if this medium is not attached to any
9662	machine or to any machine's snapshot.
9663
9664	<note>
9665	The returned array will include a machine even if this medium is not
9666	attached to that machine in the current state but attached to it in
9667	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9668	details.
9669	</note>
9670	</desc>
9671	</attribute>
9672
9673	<method name="setIDs">
9674	<desc>
9675	Changes the UUID and parent UUID for a hard disk medium.
9676	</desc>
9677	<param name="setImageId" type="boolean" dir="in">
9678	<desc>
9679	Select whether a new image UUID is set or not.
9680	</desc>
9681	</param>
9682	<param name="imageId" type="uuid" mod="string" dir="in">
9683	<desc>
9684	New UUID for the image. If an empty string is passed, then a new
9685	UUID is automatically created, provided that @a setImageId is @c true.
9686	Specifying a zero UUID is not allowed.
9687	</desc>
9688	</param>
9689	<param name="setParentId" type="boolean" dir="in">
9690	<desc>
9691	Select whether a new parent UUID is set or not.
9692	</desc>
9693	</param>
9694	<param name="parentId" type="uuid" mod="string" dir="in">
9695	<desc>
9696	New parent UUID for the image. If an empty string is passed, then a
9697	new UUID is automatically created, provided @a setParentId is
9698	@c true. A zero UUID is valid.
9699	</desc>
9700	</param>
9701	<result name="E_INVALIDARG">
9702	Invalid parameter combination.
9703	</result>
9704	<result name="VBOX_E_NOT_SUPPORTED">
9705	Medium is not a hard disk medium.
9706	</result>
9707	</method>
9708
9709	<method name="refreshState">
9710	<desc>
9711	If the current medium state (see <link to="MediumState"/>) is one of
9712	"Created", "Inaccessible" or "LockedRead", then this performs an
9713	accessibility check on the medium and sets the value of the <link to="#state"/>
9714	attribute accordingly; that value is also returned for convenience.
9715
9716	For all other state values, this does not perform a refresh but returns
9717	the state only.
9718
9719	The refresh, if performed, may take a long time (several seconds or even
9720	minutes, depending on the storage unit location and format) because it performs an
9721	accessibility check of the storage unit. This check may cause a significant
9722	delay if the storage unit of the given medium is, for example, a file located
9723	on a network share which is not currently accessible due to connectivity
9724	problems. In that case, the call will not return until a timeout
9725	interval defined by the host OS for this operation expires. For this reason,
9726	it is recommended to never read this attribute on the main UI thread to avoid
9727	making the UI unresponsive.
9728
9729	If the last known state of the medium is "Created" and the accessibility
9730	check fails, then the state would be set to "Inaccessible", and
9731	<link to="#lastAccessError"/> may be used to get more details about the
9732	failure. If the state of the medium is "LockedRead", then it remains the
9733	same, and a non-empty value of <link to="#lastAccessError"/> will
9734	indicate a failed accessibility check in this case.
9735
9736	Note that not all medium states are applicable to all medium types.
9737	</desc>
9738	<param name="state" type="MediumState" dir="return">
9739	<desc>
9740	New medium state.
9741	</desc>
9742	</param>
9743	</method>
9744
9745	<method name="getSnapshotIds">
9746	<desc>
9747	Returns an array of UUIDs of all snapshots of the given machine where
9748	this medium is attached to.
9749
9750	If the medium is attached to the machine in the current state, then the
9751	first element in the array will always be the ID of the queried machine
9752	(i.e. the value equal to the @c machineId argument), followed by
9753	snapshot IDs (if any).
9754
9755	If the medium is not attached to the machine in the current state, then
9756	the array will contain only snapshot IDs.
9757
9758	The returned array may be @c null if this medium is not attached
9759	to the given machine at all, neither in the current state nor in one of
9760	the snapshots.
9761	</desc>
9762	<param name="machineId" type="uuid" mod="string" dir="in">
9763	<desc>
9764	UUID of the machine to query.
9765	</desc>
9766	</param>
9767	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9768	<desc>
9769	Array of snapshot UUIDs of the given machine using this medium.
9770	</desc>
9771	</param>
9772	</method>
9773
9774	<method name="lockRead">
9775	<desc>
9776	Locks this medium for reading.
9777
9778	A read lock is shared: many clients can simultaneously lock the
9779	same medium for reading unless it is already locked for writing (see
9780	<link to="#lockWrite"/>) in which case an error is returned.
9781
9782	When the medium is locked for reading, it cannot be modified
9783	from within VirtualBox. This means that any method that changes
9784	the properties of this medium or contents of the storage unit
9785	will return an error (unless explicitly stated otherwise). That
9786	includes an attempt to start a virtual machine that wants to
9787	write to the the medium.
9788
9789	When the virtual machine is started up, it locks for reading all
9790	media it uses in read-only mode. If some medium cannot be locked
9791	for reading, the startup procedure will fail.
9792	A medium is typically locked for reading while it is used by a running
9793	virtual machine but has a depending differencing image that receives
9794	the actual write operations. This way one base medium can have
9795	multiple child differencing images which can be written to
9796	simultaneously. Read-only media such as DVD and floppy images are
9797	also locked for reading only (so they can be in use by multiple
9798	machines simultaneously).
9799
9800	A medium is also locked for reading when it is the source of a
9801	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9802
9803	The medium locked for reading must be unlocked using the <link
9804	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9805	can be nested and must be followed by the same number of paired
9806	<link to="#unlockRead"/> calls.
9807
9808	This method sets the medium state (see <link to="#state"/>) to
9809	"LockedRead" on success. The medium's previous state must be
9810	one of "Created", "Inaccessible" or "LockedRead".
9811
9812	Locking an inaccessible medium is not an error; this method performs
9813	a logical lock that prevents modifications of this medium through
9814	the VirtualBox API, not a physical file-system lock of the underlying
9815	storage unit.
9816
9817	This method returns the current state of the medium
9818	<i>before</i> the operation.
9819
9820	<result name="VBOX_E_INVALID_OBJECT_STATE">
9821	Invalid medium state (e.g. not created, locked, inaccessible,
9822	creating, deleting).
9823	</result>
9824
9825	</desc>
9826	<param name="state" type="MediumState" dir="return">
9827	<desc>
9828	State of the medium after the operation.
9829	</desc>
9830	</param>
9831	</method>
9832
9833	<method name="unlockRead">
9834	<desc>
9835	Cancels the read lock previously set by <link to="#lockRead"/>.
9836
9837	For both success and failure, this method returns the current state
9838	of the medium <i>after</i> the operation.
9839
9840	See <link to="#lockRead"/> for more details.
9841
9842	<result name="VBOX_E_INVALID_OBJECT_STATE">
9843	Medium not locked for reading.
9844	</result>
9845
9846	</desc>
9847	<param name="state" type="MediumState" dir="return">
9848	<desc>
9849	State of the medium after the operation.
9850	</desc>
9851	</param>
9852	</method>
9853
9854	<method name="lockWrite">
9855	<desc>
9856	Locks this medium for writing.
9857
9858	A write lock, as opposed to <link to="#lockRead"/>, is
9859	exclusive: there may be only one client holding a write lock,
9860	and there may be no read locks while the write lock is held.
9861	As a result, read-locking fails if a write lock is held, and
9862	write-locking fails if either a read or another write lock is held.
9863
9864	When a medium is locked for writing, it cannot be modified
9865	from within VirtualBox, and it is not guaranteed that the values
9866	of its properties are up-to-date. Any method that changes the
9867	properties of this medium or contents of the storage unit will
9868	return an error (unless explicitly stated otherwise).
9869
9870	When a virtual machine is started up, it locks for writing all
9871	media it uses to write data to. If any medium could not be locked
9872	for writing, the startup procedure will fail. If a medium has
9873	differencing images, then while the machine is running, only
9874	the last ("leaf") differencing image is locked for writing,
9875	whereas its parents are locked for reading only.
9876
9877	A medium is also locked for writing when it is the target of a
9878	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9879
9880	The medium locked for writing must be unlocked using the <link
9881	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9882
9883	This method sets the medium state (see <link to="#state"/>) to
9884	"LockedWrite" on success. The medium's previous state must be
9885	either "Created" or "Inaccessible".
9886
9887	Locking an inaccessible medium is not an error; this method performs
9888	a logical lock that prevents modifications of this medium through
9889	the VirtualBox API, not a physical file-system lock of the underlying
9890	storage unit.
9891
9892	For both, success and failure, this method returns the current
9893	state of the medium <i>before</i> the operation.
9894
9895	<result name="VBOX_E_INVALID_OBJECT_STATE">
9896	Invalid medium state (e.g. not created, locked, inaccessible,
9897	creating, deleting).
9898	</result>
9899
9900	</desc>
9901	<param name="state" type="MediumState" dir="return">
9902	<desc>
9903	State of the medium after the operation.
9904	</desc>
9905	</param>
9906	</method>
9907
9908	<method name="unlockWrite">
9909	<desc>
9910	Cancels the write lock previously set by <link to="#lockWrite"/>.
9911
9912	For both success and failure, this method returns the current
9913	state of the medium <i>after</i> the operation.
9914
9915	See <link to="#lockWrite"/> for more details.
9916
9917	<result name="VBOX_E_INVALID_OBJECT_STATE">
9918	Medium not locked for writing.
9919	</result>
9920
9921	</desc>
9922	<param name="state" type="MediumState" dir="return">
9923	<desc>
9924	State of the medium after the operation.
9925	</desc>
9926	</param>
9927	</method>
9928
9929	<method name="close">
9930	<desc>
9931	Closes this medium.
9932
9933	The medium must not be attached to any known virtual machine
9934	and must not have any known child media, otherwise the
9935	operation will fail.
9936
9937	When the medium is successfully closed, it is removed from
9938	the list of registered media, but its storage unit is not
9939	deleted. In particular, this means that this medium can
9940	later be opened again using the <link to="IVirtualBox::openMedium"/>
9941	call.
9942
9943	Note that after this method successfully returns, the given medium
9944	object becomes uninitialized. This means that any attempt
9945	to call any of its methods or attributes will fail with the
9946	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9947
9948	<result name="VBOX_E_INVALID_OBJECT_STATE">
9949	Invalid medium state (other than not created, created or
9950	inaccessible).
9951	</result>
9952	<result name="VBOX_E_OBJECT_IN_USE">
9953	Medium attached to virtual machine.
9954	</result>
9955	<result name="VBOX_E_FILE_ERROR">
9956	Settings file not accessible.
9957	</result>
9958	<result name="VBOX_E_XML_ERROR">
9959	Could not parse the settings file.
9960	</result>
9961
9962	</desc>
9963	</method>
9964
9965	<!-- storage methods -->
9966
9967	<method name="getProperty">
9968	<desc>
9969	Returns the value of the custom medium property with the given name.
9970
9971	The list of all properties supported by the given medium format can
9972	be obtained with <link to="IMediumFormat::describeProperties"/>.
9973
9974	Note that if this method returns an empty string in @a value, the
9975	requested property is supported but currently not assigned any value.
9976
9977	<result name="VBOX_E_OBJECT_NOT_FOUND">
9978	Requested property does not exist (not supported by the format).
9979	</result>
9980	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9981	</desc>
9982	<param name="name" type="wstring" dir="in">
9983	<desc>Name of the property to get.</desc>
9984	</param>
9985	<param name="value" type="wstring" dir="return">
9986	<desc>Current property value.</desc>
9987	</param>
9988	</method>
9989
9990	<method name="setProperty">
9991	<desc>
9992	Sets the value of the custom medium property with the given name.
9993
9994	The list of all properties supported by the given medium format can
9995	be obtained with <link to="IMediumFormat::describeProperties"/>.
9996
9997	Note that setting the property value to @c null or an empty string is
9998	equivalent to deleting the existing value. A default value (if it is
9999	defined for this property) will be used by the format backend in this
10000	case.
10001
10002	<result name="VBOX_E_OBJECT_NOT_FOUND">
10003	Requested property does not exist (not supported by the format).
10004	</result>
10005	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10006	</desc>
10007	<param name="name" type="wstring" dir="in">
10008	<desc>Name of the property to set.</desc>
10009	</param>
10010	<param name="value" type="wstring" dir="in">
10011	<desc>Property value to set.</desc>
10012	</param>
10013	</method>
10014
10015	<method name="getProperties">
10016	<desc>
10017	Returns values for a group of properties in one call.
10018
10019	The names of the properties to get are specified using the @a names
10020	argument which is a list of comma-separated property names or
10021	an empty string if all properties are to be returned. Note that currently
10022	the value of this argument is ignored and the method always returns all
10023	existing properties.
10024
10025	The list of all properties supported by the given medium format can
10026	be obtained with <link to="IMediumFormat::describeProperties"/>.
10027
10028	The method returns two arrays, the array of property names corresponding
10029	to the @a names argument and the current values of these properties.
10030	Both arrays have the same number of elements with each elemend at the
10031	given index in the first array corresponds to an element at the same
10032	index in the second array.
10033
10034	Note that for properties that do not have assigned values,
10035	an empty string is returned at the appropriate index in the
10036	@a returnValues array.
10037
10038	</desc>
10039	<param name="names" type="wstring" dir="in">
10040	<desc>
10041	Names of properties to get.
10042	</desc>
10043	</param>
10044	<param name="returnNames" type="wstring" safearray="yes" dir="out">
10045	<desc>Names of returned properties.</desc>
10046	</param>
10047	<param name="returnValues" type="wstring" safearray="yes" dir="return">
10048	<desc>Values of returned properties.</desc>
10049	</param>
10050	</method>
10051
10052	<method name="setProperties">
10053	<desc>
10054	Sets values for a group of properties in one call.
10055
10056	The names of the properties to set are passed in the @a names
10057	array along with the new values for them in the @a values array. Both
10058	arrays have the same number of elements with each elemend at the given
10059	index in the first array corresponding to an element at the same index
10060	in the second array.
10061
10062	If there is at least one property name in @a names that is not valid,
10063	the method will fail before changing the values of any other properties
10064	from the @a names array.
10065
10066	Using this method over <link to="#setProperty"/> is preferred if you
10067	need to set several properties at once since it will result into less
10068	IPC calls.
10069
10070	The list of all properties supported by the given medium format can
10071	be obtained with <link to="IMediumFormat::describeProperties"/>.
10072
10073	Note that setting the property value to @c null or an empty string is
10074	equivalent to deleting the existing value. A default value (if it is
10075	defined for this property) will be used by the format backend in this
10076	case.
10077	</desc>
10078	<param name="names" type="wstring" safearray="yes" dir="in">
10079	<desc>Names of properties to set.</desc>
10080	</param>
10081	<param name="values" type="wstring" safearray="yes" dir="in">
10082	<desc>Values of properties to set.</desc>
10083	</param>
10084	</method>
10085
10086	<!-- storage methods -->
10087
10088	<method name="createBaseStorage">
10089	<desc>
10090	Starts creating a hard disk storage unit (fixed/dynamic, according
10091	to the variant flags) in in the background. The previous storage unit
10092	created for this object, if any, must first be deleted using
10093	<link to="#deleteStorage"/>, otherwise the operation will fail.
10094
10095	Before the operation starts, the medium is placed in
10096	<link to="MediumState_Creating"/> state. If the create operation
10097	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
10098	state.
10099
10100	After the returned progress object reports that the operation has
10101	successfully completed, the medium state will be set to <link
10102	to="MediumState_Created"/>, the medium will be remembered by this
10103	VirtualBox installation and may be attached to virtual machines.
10104
10105	<result name="VBOX_E_NOT_SUPPORTED">
10106	The variant of storage creation operation is not supported. See <link
10107	to="IMediumFormat::capabilities"/>.
10108	</result>
10109	</desc>
10110	<param name="logicalSize" type="long long" dir="in">
10111	<desc>Maximum logical size of the medium in bytes.</desc>
10112	</param>
10113	<param name="variant" type="unsigned long" dir="in">
10114	<desc>Exact image variant which should be created (as a combination of
10115	<link to="MediumVariant" /> flags).</desc>
10116	</param>
10117	<param name="progress" type="IProgress" dir="return">
10118	<desc>Progress object to track the operation completion.</desc>
10119	</param>
10120	</method>
10121
10122	<method name="deleteStorage">
10123	<desc>
10124	Starts deleting the storage unit of this medium.
10125
10126	The medium must not be attached to any known virtual machine and must
10127	not have any known child media, otherwise the operation will fail.
10128	It will also fail if there is no storage unit to delete or if deletion
10129	is already in progress, or if the medium is being in use (locked for
10130	read or for write) or inaccessible. Therefore, the only valid state for
10131	this operation to succeed is <link to="MediumState_Created"/>.
10132
10133	Before the operation starts, the medium is placed in
10134	<link to="MediumState_Deleting"/> state and gets removed from the list
10135	of remembered hard disks (media registry). If the delete operation
10136	fails, the medium will be remembered again and placed back to
10137	<link to="MediumState_Created"/> state.
10138
10139	After the returned progress object reports that the operation is
10140	complete, the medium state will be set to
10141	<link to="MediumState_NotCreated"/> and you will be able to use one of
10142	the storage creation methods to create it again.
10143
10144	<see>#close()</see>
10145
10146	<result name="VBOX_E_OBJECT_IN_USE">
10147	Medium is attached to a virtual machine.
10148	</result>
10149	<result name="VBOX_E_NOT_SUPPORTED">
10150	Storage deletion is not allowed because neither of storage creation
10151	operations are supported. See
10152	<link to="IMediumFormat::capabilities"/>.
10153	</result>
10154
10155	<note>
10156	If the deletion operation fails, it is not guaranteed that the storage
10157	unit still exists. You may check the <link to="IMedium::state"/> value
10158	to answer this question.
10159	</note>
10160	</desc>
10161	<param name="progress" type="IProgress" dir="return">
10162	<desc>Progress object to track the operation completion.</desc>
10163	</param>
10164	</method>
10165
10166	<!-- diff methods -->
10167
10168	<method name="createDiffStorage">
10169	<desc>
10170	Starts creating an empty differencing storage unit based on this
10171	medium in the format and at the location defined by the @a target
10172	argument.
10173
10174	The target medium must be in <link to="MediumState_NotCreated"/>
10175	state (i.e. must not have an existing storage unit). Upon successful
10176	completion, this operation will set the type of the target medium to
10177	<link to="MediumType_Normal"/> and create a storage unit necessary to
10178	represent the differencing medium data in the given format (according
10179	to the storage format of the target object).
10180
10181	After the returned progress object reports that the operation is
10182	successfully complete, the target medium gets remembered by this
10183	VirtualBox installation and may be attached to virtual machines.
10184
10185	<note>
10186	The medium will be set to <link to="MediumState_LockedRead"/>
10187	state for the duration of this operation.
10188	</note>
10189	<result name="VBOX_E_OBJECT_IN_USE">
10190	Medium not in @c NotCreated state.
10191	</result>
10192	</desc>
10193	<param name="target" type="IMedium" dir="in">
10194	<desc>Target medium.</desc>
10195	</param>
10196	<param name="variant" type="unsigned long" dir="in">
10197	<desc>Exact image variant which should be created (as a combination of
10198	<link to="MediumVariant" /> flags).</desc>
10199	</param>
10200	<param name="progress" type="IProgress" dir="return">
10201	<desc>Progress object to track the operation completion.</desc>
10202	</param>
10203	</method>
10204
10205	<method name="mergeTo">
10206	<desc>
10207	Starts merging the contents of this medium and all intermediate
10208	differencing media in the chain to the given target medium.
10209
10210	The target medium must be either a descendant of this medium or
10211	its ancestor (otherwise this method will immediately return a failure).
10212	It follows that there are two logical directions of the merge operation:
10213	from ancestor to descendant (<i>forward merge</i>) and from descendant to
10214	ancestor (<i>backward merge</i>). Let us consider the following medium
10215	chain:
10216
10217	<pre>Base <- Diff_1 <- Diff_2</pre>
10218
10219	Here, calling this method on the <tt>Base</tt> medium object with
10220	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
10221	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
10222	merge. Note that in both cases the contents of the resulting medium
10223	will be the same, the only difference is the medium object that takes
10224	the result of the merge operation. In case of the forward merge in the
10225	above example, the result will be written to <tt>Diff_2</tt>; in case of
10226	the backward merge, the result will be written to <tt>Base</tt>. In
10227	other words, the result of the operation is always stored in the target
10228	medium.
10229
10230	Upon successful operation completion, the storage units of all media in
10231	the chain between this (source) medium and the target medium, including
10232	the source medium itself, will be automatically deleted and the
10233	relevant medium objects (including this medium) will become
10234	uninitialized. This means that any attempt to call any of
10235	their methods or attributes will fail with the
10236	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
10237	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
10238	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
10239	Note that <tt>Diff_2</tt> in this case will become a base medium
10240	itself since it will no longer be based on any other medium.
10241
10242	Considering the above, all of the following conditions must be met in
10243	order for the merge operation to succeed:
10244	<ul>
10245	<li>
10246	Neither this (source) medium nor any intermediate
10247	differencing medium in the chain between it and the target
10248	medium is attached to any virtual machine.
10249	</li>
10250	<li>
10251	Neither the source medium nor the target medium is an
10252	<link to="MediumType_Immutable"/> medium.
10253	</li>
10254	<li>
10255	The part of the medium tree from the source medium to the
10256	target medium is a linear chain, i.e. all medium in this
10257	chain have exactly one child which is the next medium in this
10258	chain. The only exception from this rule is the target medium in
10259	the forward merge operation; it is allowed to have any number of
10260	child media because the merge operation will not change its
10261	logical contents (as it is seen by the guest OS or by children).
10262	</li>
10263	<li>
10264	None of the involved media are in
10265	<link to="MediumState_LockedRead"/> or
10266	<link to="MediumState_LockedWrite"/> state.
10267	</li>
10268	</ul>
10269
10270	<note>
10271	This (source) medium and all intermediates will be placed to <link
10272	to="MediumState_Deleting"/> state and the target medium will be
10273	placed to <link to="MediumState_LockedWrite"/> state and for the
10274	duration of this operation.
10275	</note>
10276	</desc>
10277	<param name="target" type="IMedium" dir="in">
10278	<desc>Target medium.</desc>
10279	</param>
10280	<param name="progress" type="IProgress" dir="return">
10281	<desc>Progress object to track the operation completion.</desc>
10282	</param>
10283	</method>
10284
10285	<!-- clone method -->
10286
10287	<method name="cloneTo">
10288	<desc>
10289	Starts creating a clone of this medium in the format and at the
10290	location defined by the @a target argument.
10291
10292	The target medium must be either in <link to="MediumState_NotCreated"/>
10293	state (i.e. must not have an existing storage unit) or in
10294	<link to="MediumState_Created"/> state (i.e. created and not locked, and
10295	big enough to hold the data or else the copy will be partial). Upon
10296	successful completion, the cloned medium will contain exactly the
10297	same sector data as the medium being cloned, except that in the
10298	first case a new UUID for the clone will be randomly generated, and in
10299	the second case the UUID will remain unchanged.
10300
10301	The @a parent argument defines which medium will be the parent
10302	of the clone. Passing a @c null reference indicates that the clone will
10303	be a base image, i.e. completely independent. It is possible to specify
10304	an arbitrary medium for this parameter, including the parent of the
10305	medium which is being cloned. Even cloning to a child of the source
10306	medium is possible. Note that when cloning to an existing image, the
10307	@a parent irgument is ignored.
10308
10309	After the returned progress object reports that the operation is
10310	successfully complete, the target medium gets remembered by this
10311	VirtualBox installation and may be attached to virtual machines.
10312
10313	<note>
10314	This medium will be placed to <link to="MediumState_LockedRead"/>
10315	state for the duration of this operation.
10316	</note>
10317	<result name="E_NOTIMPL">
10318	The specified cloning variant is not supported at the moment.
10319	</result>
10320	</desc>
10321	<param name="target" type="IMedium" dir="in">
10322	<desc>Target medium.</desc>
10323	</param>
10324	<param name="variant" type="unsigned long" dir="in">
10325	<desc>Exact image variant which should be created (as a combination of
10326	<link to="MediumVariant" /> flags).</desc>
10327	</param>
10328	<param name="parent" type="IMedium" dir="in">
10329	<desc>Parent of the cloned medium.</desc>
10330	</param>
10331	<param name="progress" type="IProgress" dir="return">
10332	<desc>Progress object to track the operation completion.</desc>
10333	</param>
10334	</method>
10335
10336	<!-- other methods -->
10337
10338	<method name="compact">
10339	<desc>
10340	Starts compacting of this medium. This means that the medium is
10341	transformed into a possibly more compact storage representation.
10342	This potentially creates temporary images, which can require a
10343	substantial amount of additional disk space.
10344
10345	This medium will be placed to <link to="MediumState_LockedWrite"/>
10346	state and all its parent media (if any) will be placed to
10347	<link to="MediumState_LockedRead"/> state for the duration of this
10348	operation.
10349
10350	Please note that the results can be either returned straight away,
10351	or later as the result of the background operation via the object
10352	returned via the @a progress parameter.
10353
10354	<result name="VBOX_E_NOT_SUPPORTED">
10355	Medium format does not support compacting (but potentially
10356	needs it).
10357	</result>
10358	</desc>
10359	<param name="progress" type="IProgress" dir="return">
10360	<desc>Progress object to track the operation completion.</desc>
10361	</param>
10362	</method>
10363
10364	<method name="resize">
10365	<desc>
10366	Starts resizing this medium. This means that the nominal size of the
10367	medium is set to the new value. Both increasing and decreasing the
10368	size is possible, and there are no safety checks, since VirtualBox
10369	does not make any assumptions about the medium contents.
10370
10371	Resizing usually needs additional disk space, and possibly also
10372	some temporary disk space. Note that resize does not create a full
10373	temporary copy of the medium, so the additional disk space requirement
10374	is usually much lower than using the clone operation.
10375
10376	This medium will be placed to <link to="MediumState_LockedWrite"/>
10377	state for the duration of this operation.
10378
10379	Please note that the results can be either returned straight away,
10380	or later as the result of the background operation via the object
10381	returned via the @a progress parameter.
10382
10383	<result name="VBOX_E_NOT_SUPPORTED">
10384	Medium format does not support resizing.
10385	</result>
10386	</desc>
10387	<param name="logicalSize" type="long long" dir="in">
10388	<desc>New nominal capacity of the medium in bytes.</desc>
10389	</param>
10390	<param name="progress" type="IProgress" dir="return">
10391	<desc>Progress object to track the operation completion.</desc>
10392	</param>
10393	</method>
10394
10395	<method name="reset">
10396	<desc>
10397	Starts erasing the contents of this differencing medium.
10398
10399	This operation will reset the differencing medium to its initial
10400	state when it does not contain any sector data and any read operation is
10401	redirected to its parent medium. This automatically gets called
10402	during VM power-up for every medium whose <link to="#autoReset" />
10403	attribute is @c true.
10404
10405	The medium will be write-locked for the duration of this operation (see
10406	<link to="#lockWrite" />).
10407
10408	<result name="VBOX_E_NOT_SUPPORTED">
10409	This is not a differencing medium.
10410	</result>
10411	<result name="VBOX_E_INVALID_OBJECT_STATE">
10412	Medium is not in <link to="MediumState_Created"/> or
10413	<link to="MediumState_Inaccessible"/> state.
10414	</result>
10415	</desc>
10416	<param name="progress" type="IProgress" dir="return">
10417	<desc>Progress object to track the operation completion.</desc>
10418	</param>
10419	</method>
10420
10421	</interface>
10422
10423
10424	<!--
10425	// IMediumFormat
10426	/////////////////////////////////////////////////////////////////////////
10427	-->
10428
10429	<enum
10430	name="DataType"
10431	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10432	>
10433	<const name="Int32" value="0"/>
10434	<const name="Int8" value="1"/>
10435	<const name="String" value="2"/>
10436	</enum>
10437
10438	<enum
10439	name="DataFlags"
10440	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10441	>
10442	<const name="None" value="0x00"/>
10443	<const name="Mandatory" value="0x01"/>
10444	<const name="Expert" value="0x02"/>
10445	<const name="Array" value="0x04"/>
10446	<const name="FlagMask" value="0x07"/>
10447	</enum>
10448
10449	<enum
10450	name="MediumFormatCapabilities"
10451	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
10452	>
10453	<desc>
10454	Medium format capability flags.
10455	</desc>
10456
10457	<const name="Uuid" value="0x01">
10458	<desc>
10459	Supports UUIDs as expected by VirtualBox code.
10460	</desc>
10461	</const>
10462
10463	<const name="CreateFixed" value="0x02">
10464	<desc>
10465	Supports creating fixed size images, allocating all space instantly.
10466	</desc>
10467	</const>
10468
10469	<const name="CreateDynamic" value="0x04">
10470	<desc>
10471	Supports creating dynamically growing images, allocating space on
10472	demand.
10473	</desc>
10474	</const>
10475
10476	<const name="CreateSplit2G" value="0x08">
10477	<desc>
10478	Supports creating images split in chunks of a bit less than 2 GBytes.
10479	</desc>
10480	</const>
10481
10482	<const name="Differencing" value="0x10">
10483	<desc>
10484	Supports being used as a format for differencing media (see <link
10485	to="IMedium::createDiffStorage"/>).
10486	</desc>
10487	</const>
10488
10489	<const name="Asynchronous" value="0x20">
10490	<desc>
10491	Supports asynchronous I/O operations for at least some configurations.
10492	</desc>
10493	</const>
10494
10495	<const name="File" value="0x40">
10496	<desc>
10497	The format backend operates on files (the <link to="IMedium::location"/>
10498	attribute of the medium specifies a file used to store medium
10499	data; for a list of supported file extensions see
10500	<link to="IMediumFormat::describeFileExtensions"/>).
10501	</desc>
10502	</const>
10503
10504	<const name="Properties" value="0x80">
10505	<desc>
10506	The format backend uses the property interface to configure the storage
10507	location and properties (the <link to="IMediumFormat::describeProperties"/>
10508	method is used to get access to properties supported by the given medium format).
10509	</desc>
10510	</const>
10511
10512	<const name="TcpNetworking" value="0x100">
10513	<desc>
10514	The format backend uses the TCP networking interface for network access.
10515	</desc>
10516	</const>
10517
10518	<const name="VFS" value="0x200">
10519	<desc>
10520	The format backend supports virtual filesystem functionality.
10521	</desc>
10522	</const>
10523
10524	<const name="CapabilityMask" value="0x3FF"/>
10525	</enum>
10526
10527	<interface
10528	name="IMediumFormat" extends="$unknown"
10529	uuid="4e9a873f-0599-434a-8345-619ef3fb3111"
10530	wsmap="managed"
10531	>
10532	<desc>
10533	The IMediumFormat interface represents a medium format.
10534
10535	Each medium format has an associated backend which is used to handle
10536	media stored in this format. This interface provides information
10537	about the properties of the associated backend.
10538
10539	Each medium format is identified by a string represented by the
10540	<link to="#id"/> attribute. This string is used in calls like
10541	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10542	format.
10543
10544	The list of all supported medium formats can be obtained using
10545	<link to="ISystemProperties::mediumFormats"/>.
10546
10547	<see>IMedium</see>
10548	</desc>
10549
10550	<attribute name="id" type="wstring" readonly="yes">
10551	<desc>
10552	Identifier of this format.
10553
10554	The format identifier is a non-@c null non-empty ASCII string. Note that
10555	this string is case-insensitive. This means that, for example, all of
10556	the following strings:
10557	<pre>
10558	"VDI"
10559	"vdi"
10560	"VdI"</pre>
10561	refer to the same medium format.
10562
10563	This string is used in methods of other interfaces where it is necessary
10564	to specify a medium format, such as
10565	<link to="IVirtualBox::createHardDisk"/>.
10566	</desc>
10567	</attribute>
10568
10569	<attribute name="name" type="wstring" readonly="yes">
10570	<desc>
10571	Human readable description of this format.
10572
10573	Mainly for use in file open dialogs.
10574	</desc>
10575	</attribute>
10576
10577	<attribute name="capabilities" type="unsigned long" readonly="yes">
10578	<desc>
10579	Capabilities of the format as a set of bit flags.
10580
10581	For the meaning of individual capability flags see
10582	<link to="MediumFormatCapabilities"/>.
10583	</desc>
10584	</attribute>
10585
10586	<method name="describeFileExtensions">
10587	<desc>
10588	Returns two arrays describing the supported file extensions.
10589
10590	The first array contains the supported extensions and the seconds one
10591	the type each extension supports. Both have the same size.
10592
10593	Note that some backends do not work on files, so this array may be
10594	empty.
10595
10596	<see>IMediumFormat::capabilities</see>
10597	</desc>
10598	<param name="extensions" type="wstring" safearray="yes" dir="out">
10599	<desc>The array of supported extensions.</desc>
10600	</param>
10601	<param name="type" type="DeviceType" safearray="yes" dir="out">
10602	<desc>The array which indicates the device type for every given extension.</desc>
10603	</param>
10604	</method>
10605
10606	<method name="describeProperties">
10607	<desc>
10608	Returns several arrays describing the properties supported by this
10609	format.
10610
10611	An element with the given index in each array describes one
10612	property. Thus, the number of elements in each returned array is the
10613	same and corresponds to the number of supported properties.
10614
10615	The returned arrays are filled in only if the
10616	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10617	All arguments must be non-@c null.
10618
10619	<see>DataType</see>
10620	<see>DataFlags</see>
10621	</desc>
10622
10623	<param name="names" type="wstring" safearray="yes" dir="out">
10624	<desc>Array of property names.</desc>
10625	</param>
10626	<param name="description" type="wstring" safearray="yes" dir="out">
10627	<desc>Array of property descriptions.</desc>
10628	</param>
10629	<param name="types" type="DataType" safearray="yes" dir="out">
10630	<desc>Array of property types.</desc>
10631	</param>
10632	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10633	<desc>Array of property flags.</desc>
10634	</param>
10635	<param name="defaults" type="wstring" safearray="yes" dir="out">
10636	<desc>Array of default property values.</desc>
10637	</param>
10638	</method>
10639
10640	</interface>
10641
10642
10643	<!--
10644	// IKeyboard
10645	/////////////////////////////////////////////////////////////////////////
10646	-->
10647
10648	<interface
10649	name="IKeyboard" extends="$unknown"
10650	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
10651	wsmap="managed"
10652	>
10653	<desc>
10654	The IKeyboard interface represents the virtual machine's keyboard. Used
10655	in <link to="IConsole::keyboard"/>.
10656
10657	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10658	to the virtual machine.
10659
10660	</desc>
10661	<method name="putScancode">
10662	<desc>Sends a scancode to the keyboard.
10663
10664	<result name="VBOX_E_IPRT_ERROR">
10665	Could not send scan code to virtual keyboard.
10666	</result>
10667
10668	</desc>
10669	<param name="scancode" type="long" dir="in"/>
10670	</method>
10671
10672	<method name="putScancodes">
10673	<desc>Sends an array of scancodes to the keyboard.
10674
10675	<result name="VBOX_E_IPRT_ERROR">
10676	Could not send all scan codes to virtual keyboard.
10677	</result>
10678
10679	</desc>
10680	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10681	<param name="codesStored" type="unsigned long" dir="return"/>
10682	</method>
10683
10684	<method name="putCAD">
10685	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10686	function is nothing special, it is just a convenience function
10687	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10688
10689	<result name="VBOX_E_IPRT_ERROR">
10690	Could not send all scan codes to virtual keyboard.
10691	</result>
10692
10693	</desc>
10694	</method>
10695
10696	<attribute name="eventSource" type="IEventSource" readonly="yes">
10697	<desc>
10698	Event source for keyboard events.
10699	</desc>
10700	</attribute>
10701
10702	</interface>
10703
10704
10705	<!--
10706	// IMouse
10707	/////////////////////////////////////////////////////////////////////////
10708	-->
10709
10710	<enum
10711	name="MouseButtonState"
10712	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10713	>
10714	<desc>
10715	Mouse button state.
10716	</desc>
10717
10718	<const name="LeftButton" value="0x01"/>
10719	<const name="RightButton" value="0x02"/>
10720	<const name="MiddleButton" value="0x04"/>
10721	<const name="WheelUp" value="0x08"/>
10722	<const name="WheelDown" value="0x10"/>
10723	<const name="XButton1" value="0x20"/>
10724	<const name="XButton2" value="0x40"/>
10725	<const name="MouseStateMask" value="0x7F"/>
10726	</enum>
10727
10728	<interface
10729	name="IMouse" extends="$unknown"
10730	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
10731	wsmap="managed"
10732	>
10733	<desc>
10734	The IMouse interface represents the virtual machine's mouse. Used in
10735	<link to="IConsole::mouse"/>.
10736
10737	Through this interface, the virtual machine's virtual mouse can be
10738	controlled.
10739	</desc>
10740
10741	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10742	<desc>
10743	Whether the guest OS supports absolute mouse pointer positioning
10744	or not.
10745	<note>
10746	You can use the <link to="IMouseCapabilityChangedEvent"/>
10747	event to be instantly informed about changes of this attribute
10748	during virtual machine execution.
10749	</note>
10750	<see><link to="#putMouseEventAbsolute"/></see>
10751	</desc>
10752	</attribute>
10753
10754	<attribute name="relativeSupported" type="boolean" readonly="yes">
10755	<desc>
10756	Whether the guest OS supports relative mouse pointer positioning
10757	or not.
10758	<note>
10759	You can use the <link to="IMouseCapabilityChangedEvent"/>
10760	event to be instantly informed about changes of this attribute
10761	during virtual machine execution.
10762	</note>
10763	<see><link to="#putMouseEvent"/></see>
10764	</desc>
10765	</attribute>
10766
10767	<attribute name="needsHostCursor" type="boolean" readonly="yes">
10768	<desc>
10769	Whether the guest OS can currently switch to drawing it's own mouse
10770	cursor on demand.
10771	<note>
10772	You can use the <link to="IMouseCapabilityChangedEvent"/>
10773	event to be instantly informed about changes of this attribute
10774	during virtual machine execution.
10775	</note>
10776	<see><link to="#putMouseEvent"/></see>
10777	</desc>
10778	</attribute>
10779
10780	<method name="putMouseEvent">
10781	<desc>
10782	Initiates a mouse event using relative pointer movements
10783	along x and y axis.
10784
10785	<result name="E_ACCESSDENIED">
10786	Console not powered up.
10787	</result>
10788	<result name="VBOX_E_IPRT_ERROR">
10789	Could not send mouse event to virtual mouse.
10790	</result>
10791
10792	</desc>
10793
10794	<param name="dx" type="long" dir="in">
10795	<desc>
10796	Amount of pixels the mouse should move to the right.
10797	Negative values move the mouse to the left.
10798	</desc>
10799	</param>
10800	<param name="dy" type="long" dir="in">
10801	<desc>
10802	Amount of pixels the mouse should move downwards.
10803	Negative values move the mouse upwards.
10804	</desc>
10805	</param>
10806	<param name="dz" type="long" dir="in">
10807	<desc>
10808	Amount of mouse wheel moves.
10809	Positive values describe clockwise wheel rotations,
10810	negative values describe counterclockwise rotations.
10811	</desc>
10812	</param>
10813	<param name="dw" type="long" dir="in">
10814	<desc>
10815	Amount of horizontal mouse wheel moves.
10816	Positive values describe a movement to the left,
10817	negative values describe a movement to the right.
10818	</desc>
10819	</param>
10820	<param name="buttonState" type="long" dir="in">
10821	<desc>
10822	The current state of mouse buttons. Every bit represents
10823	a mouse button as follows:
10824	<table>
10825	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10826	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10827	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10828	</table>
10829	A value of <tt>1</tt> means the corresponding button is pressed.
10830	otherwise it is released.
10831	</desc>
10832	</param>
10833	</method>
10834
10835	<method name="putMouseEventAbsolute">
10836	<desc>
10837	Positions the mouse pointer using absolute x and y coordinates.
10838	These coordinates are expressed in pixels and
10839	start from <tt>[1,1]</tt> which corresponds to the top left
10840	corner of the virtual display.
10841
10842	<result name="E_ACCESSDENIED">
10843	Console not powered up.
10844	</result>
10845	<result name="VBOX_E_IPRT_ERROR">
10846	Could not send mouse event to virtual mouse.
10847	</result>
10848
10849	<note>
10850	This method will have effect only if absolute mouse
10851	positioning is supported by the guest OS.
10852	</note>
10853
10854	<see><link to="#absoluteSupported"/></see>
10855	</desc>
10856
10857	<param name="x" type="long" dir="in">
10858	<desc>
10859	X coordinate of the pointer in pixels, starting from @c 1.
10860	</desc>
10861	</param>
10862	<param name="y" type="long" dir="in">
10863	<desc>
10864	Y coordinate of the pointer in pixels, starting from @c 1.
10865	</desc>
10866	</param>
10867	<param name="dz" type="long" dir="in">
10868	<desc>
10869	Amount of mouse wheel moves.
10870	Positive values describe clockwise wheel rotations,
10871	negative values describe counterclockwise rotations.
10872	</desc>
10873	</param>
10874	<param name="dw" type="long" dir="in">
10875	<desc>
10876	Amount of horizontal mouse wheel moves.
10877	Positive values describe a movement to the left,
10878	negative values describe a movement to the right.
10879	</desc>
10880	</param>
10881	<param name="buttonState" type="long" dir="in">
10882	<desc>
10883	The current state of mouse buttons. Every bit represents
10884	a mouse button as follows:
10885	<table>
10886	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10887	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10888	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10889	</table>
10890	A value of @c 1 means the corresponding button is pressed.
10891	otherwise it is released.
10892	</desc>
10893	</param>
10894	</method>
10895
10896	<attribute name="eventSource" type="IEventSource" readonly="yes">
10897	<desc>
10898	Event source for mouse events.
10899	</desc>
10900	</attribute>
10901
10902	</interface>
10903
10904	<!--
10905	// IDisplay
10906	/////////////////////////////////////////////////////////////////////////
10907	-->
10908
10909	<enum
10910	name="FramebufferPixelFormat"
10911	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10912	>
10913	<desc>
10914	Format of the video memory buffer. Constants represented by this enum can
10915	be used to test for particular values of <link
10916	to="IFramebuffer::pixelFormat"/>. See also <link
10917	to="IFramebuffer::requestResize"/>.
10918
10919	See also www.fourcc.org for more information about FOURCC pixel formats.
10920	</desc>
10921
10922	<const name="Opaque" value="0">
10923	<desc>
10924	Unknown buffer format (the user may not assume any particular format of
10925	the buffer).
10926	</desc>
10927	</const>
10928	<const name="FOURCC_RGB" value="0x32424752">
10929	<desc>
10930	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10931	bit layout).
10932	</desc>
10933	</const>
10934	</enum>
10935
10936	<interface
10937	name="IFramebuffer" extends="$unknown"
10938	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10939	wsmap="suppress"
10940	>
10941	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10942	<desc>Address of the start byte of the frame buffer.</desc>
10943	</attribute>
10944
10945	<attribute name="width" type="unsigned long" readonly="yes">
10946	<desc>Frame buffer width, in pixels.</desc>
10947	</attribute>
10948
10949	<attribute name="height" type="unsigned long" readonly="yes">
10950	<desc>Frame buffer height, in pixels.</desc>
10951	</attribute>
10952
10953	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10954	<desc>
10955	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10956	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10957	are: 8, 15, 16, 24 and 32.
10958	</desc>
10959	</attribute>
10960
10961	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10962	<desc>
10963	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10964	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10965	size of the scan line must be aligned to 32 bits.
10966	</desc>
10967	</attribute>
10968
10969	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10970	<desc>
10971	Frame buffer pixel format. It's either one of the values defined by <link
10972	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10973	<note>
10974	This attribute must never return <link
10975	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10976	<link to="#address"/> points to must be always known.
10977	</note>
10978	</desc>
10979	</attribute>
10980
10981	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10982	<desc>
10983	Defines whether this frame buffer uses the virtual video card's memory
10984	buffer (guest VRAM) directly or not. See <link
10985	to="IFramebuffer::requestResize"/> for more information.
10986	</desc>
10987	</attribute>
10988
10989	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10990	<desc>
10991	Hint from the frame buffer about how much of the standard
10992	screen height it wants to use for itself. This information is
10993	exposed to the guest through the VESA BIOS and VMMDev interface
10994	so that it can use it for determining its video mode table. It
10995	is not guaranteed that the guest respects the value.
10996	</desc>
10997	</attribute>
10998
10999	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
11000	<desc>
11001	An alpha-blended overlay which is superposed over the frame buffer.
11002	The initial purpose is to allow the display of icons providing
11003	information about the VM state, including disk activity, in front
11004	ends which do not have other means of doing that. The overlay is
11005	designed to controlled exclusively by IDisplay. It has no locking
11006	of its own, and any changes made to it are not guaranteed to be
11007	visible until the affected portion of IFramebuffer is updated. The
11008	overlay can be created lazily the first time it is requested. This
11009	attribute can also return @c null to signal that the overlay is not
11010	implemented.
11011	</desc>
11012	</attribute>
11013
11014	<attribute name="winId" type="long long" readonly="yes">
11015	<desc>
11016	Platform-dependent identifier of the window where context of this
11017	frame buffer is drawn, or zero if there's no such window.
11018	</desc>
11019	</attribute>
11020
11021	<method name="lock">
11022	<desc>
11023	Locks the frame buffer.
11024	Gets called by the IDisplay object where this frame buffer is
11025	bound to.
11026	</desc>
11027	</method>
11028
11029	<method name="unlock">
11030	<desc>
11031	Unlocks the frame buffer.
11032	Gets called by the IDisplay object where this frame buffer is
11033	bound to.
11034	</desc>
11035	</method>
11036
11037	<method name="notifyUpdate">
11038	<desc>
11039	Informs about an update.
11040	Gets called by the display object where this buffer is
11041	registered.
11042	</desc>
11043	<param name="x" type="unsigned long" dir="in"/>
11044	<param name="y" type="unsigned long" dir="in"/>
11045	<param name="width" type="unsigned long" dir="in"/>
11046	<param name="height" type="unsigned long" dir="in"/>
11047	</method>
11048
11049	<method name="requestResize">
11050	<desc>
11051	Requests a size and pixel format change.
11052
11053	There are two modes of working with the video buffer of the virtual
11054	machine. The <i>indirect</i> mode implies that the IFramebuffer
11055	implementation allocates a memory buffer for the requested display mode
11056	and provides it to the virtual machine. In <i>direct</i> mode, the
11057	IFramebuffer implementation uses the memory buffer allocated and owned
11058	by the virtual machine. This buffer represents the video memory of the
11059	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
11060	usually faster because the implementation gets a raw pointer to the
11061	guest VRAM buffer which it can directly use for visualizing the contents
11062	of the virtual display, as opposed to the indirect mode where the
11063	contents of guest VRAM are copied to the memory buffer provided by
11064	the implementation every time a display update occurs.
11065
11066	It is important to note that the direct mode is really fast only when
11067	the implementation uses the given guest VRAM buffer directly, for
11068	example, by blitting it to the window representing the virtual machine's
11069	display, which saves at least one copy operation comparing to the
11070	indirect mode. However, using the guest VRAM buffer directly is not
11071	always possible: the format and the color depth of this buffer may be
11072	not supported by the target window, or it may be unknown (opaque) as in
11073	case of text or non-linear multi-plane VGA video modes. In this case,
11074	the indirect mode (that is always available) should be used as a
11075	fallback: when the guest VRAM contents are copied to the
11076	implementation-provided memory buffer, color and format conversion is
11077	done automatically by the underlying code.
11078
11079	The @a pixelFormat parameter defines whether the direct mode is
11080	available or not. If @a pixelFormat is <link
11081	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
11082	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
11083	@a bytesPerLine parameters must be ignored and the implementation must use
11084	the indirect mode (where it provides its own buffer in one of the
11085	supported formats). In all other cases, @a pixelFormat together with
11086	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
11087	buffer pointed to by the @a VRAM parameter and the implementation is
11088	free to choose which mode to use. To indicate that this frame buffer uses
11089	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
11090	attribute must return @c true and <link to="#address"/> must
11091	return exactly the same address that is passed in the @a VRAM parameter
11092	of this method; otherwise it is assumed that the indirect strategy is
11093	chosen.
11094
11095	The @a width and @a height parameters represent the size of the
11096	requested display mode in both modes. In case of indirect mode, the
11097	provided memory buffer should be big enough to store data of the given
11098	display mode. In case of direct mode, it is guaranteed that the given
11099	@a VRAM buffer contains enough space to represent the display mode of the
11100	given size. Note that this frame buffer's <link to="#width"/> and <link
11101	to="#height"/> attributes must return exactly the same values as
11102	passed to this method after the resize is completed (see below).
11103
11104	The @a finished output parameter determines if the implementation has
11105	finished resizing the frame buffer or not. If, for some reason, the
11106	resize cannot be finished immediately during this call, @a finished
11107	must be set to @c false, and the implementation must call
11108	<link to="IDisplay::resizeCompleted"/> after it has returned from
11109	this method as soon as possible. If @a finished is @c false, the
11110	machine will not call any frame buffer methods until
11111	<link to="IDisplay::resizeCompleted"/> is called.
11112
11113	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
11114	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
11115	this frame buffer must return exactly the same values as specified in the
11116	parameters of this method, after the resize is completed. If the
11117	indirect mode is chosen, these attributes must return values describing
11118	the format of the implementation's own memory buffer <link
11119	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
11120	value must always correlate with <link to="#pixelFormat"/>. Note that
11121	the <link to="#pixelFormat"/> attribute must never return <link
11122	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
11123
11124	<note>
11125	This method is called by the IDisplay object under the
11126	<link to="#lock"/> provided by this IFramebuffer
11127	implementation. If this method returns @c false in @a finished, then
11128	this lock is not released until
11129	<link to="IDisplay::resizeCompleted"/> is called.
11130	</note>
11131	</desc>
11132	<param name="screenId" type="unsigned long" dir="in">
11133	<desc>
11134	Logical screen number. Must be used in the corresponding call to
11135	<link to="IDisplay::resizeCompleted"/> if this call is made.
11136	</desc>
11137	</param>
11138	<param name="pixelFormat" type="unsigned long" dir="in">
11139	<desc>
11140	Pixel format of the memory buffer pointed to by @a VRAM.
11141	See also <link to="FramebufferPixelFormat"/>.
11142	</desc>
11143	</param>
11144	<param name="VRAM" type="octet" mod="ptr" dir="in">
11145	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
11146	</param>
11147	<param name="bitsPerPixel" type="unsigned long" dir="in">
11148	<desc>Color depth, bits per pixel.</desc>
11149	</param>
11150	<param name="bytesPerLine" type="unsigned long" dir="in">
11151	<desc>Size of one scan line, in bytes.</desc>
11152	</param>
11153	<param name="width" type="unsigned long" dir="in">
11154	<desc>Width of the guest display, in pixels.</desc>
11155	</param>
11156	<param name="height" type="unsigned long" dir="in">
11157	<desc>Height of the guest display, in pixels.</desc>
11158	</param>
11159	<param name="finished" type="boolean" dir="return">
11160	<desc>
11161	Can the VM start using the new frame buffer immediately
11162	after this method returns or it should wait for
11163	<link to="IDisplay::resizeCompleted"/>.
11164	</desc>
11165	</param>
11166	</method>
11167
11168	<method name="videoModeSupported">
11169	<desc>
11170	Returns whether the frame buffer implementation is willing to
11171	support a given video mode. In case it is not able to render
11172	the video mode (or for some reason not willing), it should
11173	return @c false. Usually this method is called when the guest
11174	asks the VMM device whether a given video mode is supported
11175	so the information returned is directly exposed to the guest.
11176	It is important that this method returns very quickly.
11177	</desc>
11178	<param name="width" type="unsigned long" dir="in"/>
11179	<param name="height" type="unsigned long" dir="in"/>
11180	<param name="bpp" type="unsigned long" dir="in"/>
11181	<param name="supported" type="boolean" dir="return"/>
11182	</method>
11183
11184	<method name="getVisibleRegion">
11185	<desc>
11186	Returns the visible region of this frame buffer.
11187
11188	If the @a rectangles parameter is @c null then the value of the
11189	@a count parameter is ignored and the number of elements necessary to
11190	describe the current visible region is returned in @a countCopied.
11191
11192	If @a rectangles is not @c null but @a count is less
11193	than the required number of elements to store region data, the method
11194	will report a failure. If @a count is equal or greater than the
11195	required number of elements, then the actual number of elements copied
11196	to the provided array will be returned in @a countCopied.
11197
11198	<note>
11199	The address of the provided array must be in the process space of
11200	this IFramebuffer object.
11201	</note>
11202	<note>
11203	Method not yet implemented.
11204	</note>
11205	</desc>
11206	<param name="rectangles" type="octet" mod="ptr" dir="in">
11207	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
11208	</param>
11209	<param name="count" type="unsigned long" dir="in">
11210	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11211	</param>
11212	<param name="countCopied" type="unsigned long" dir="return">
11213	<desc>Number of elements copied to the @a rectangles array.</desc>
11214	</param>
11215	</method>
11216
11217	<method name="setVisibleRegion">
11218	<desc>
11219	Suggests a new visible region to this frame buffer. This region
11220	represents the area of the VM display which is a union of regions of
11221	all top-level windows of the guest operating system running inside the
11222	VM (if the Guest Additions for this system support this
11223	functionality). This information may be used by the frontends to
11224	implement the seamless desktop integration feature.
11225
11226	<note>
11227	The address of the provided array must be in the process space of
11228	this IFramebuffer object.
11229	</note>
11230	<note>
11231	The IFramebuffer implementation must make a copy of the provided
11232	array of rectangles.
11233	</note>
11234	<note>
11235	Method not yet implemented.
11236	</note>
11237	</desc>
11238	<param name="rectangles" type="octet" mod="ptr" dir="in">
11239	<desc>Pointer to the @c RTRECT array.</desc>
11240	</param>
11241	<param name="count" type="unsigned long" dir="in">
11242	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11243	</param>
11244	</method>
11245
11246	<method name="processVHWACommand">
11247	<desc>
11248	Posts a Video HW Acceleration Command to the frame buffer for processing.
11249	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
11250	are posted from quest to the host to be processed by the host hardware.
11251
11252	<note>
11253	The address of the provided command must be in the process space of
11254	this IFramebuffer object.
11255	</note>
11256	</desc>
11257
11258	<param name="command" type="octet" mod="ptr" dir="in">
11259	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
11260	</param>
11261	</method>
11262
11263	</interface>
11264
11265	<interface
11266	name="IFramebufferOverlay" extends="IFramebuffer"
11267	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
11268	wsmap="suppress"
11269	>
11270	<desc>
11271	The IFramebufferOverlay interface represents an alpha blended overlay
11272	for displaying status icons above an IFramebuffer. It is always created
11273	not visible, so that it must be explicitly shown. It only covers a
11274	portion of the IFramebuffer, determined by its width, height and
11275	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
11276	that order) format, and may be written to directly. Do re-read the
11277	width though, after setting it, as it may be adjusted (increased) to
11278	make it more suitable for the front end.
11279	</desc>
11280	<attribute name="x" type="unsigned long" readonly="yes">
11281	<desc>X position of the overlay, relative to the frame buffer.</desc>
11282	</attribute>
11283
11284	<attribute name="y" type="unsigned long" readonly="yes">
11285	<desc>Y position of the overlay, relative to the frame buffer.</desc>
11286	</attribute>
11287
11288	<attribute name="visible" type="boolean" readonly="no">
11289	<desc>
11290	Whether the overlay is currently visible.
11291	</desc>
11292	</attribute>
11293
11294	<attribute name="alpha" type="unsigned long" readonly="no">
11295	<desc>
11296	The global alpha value for the overlay. This may or may not be
11297	supported by a given front end.
11298	</desc>
11299	</attribute>
11300
11301	<method name="move">
11302	<desc>
11303	Changes the overlay's position relative to the IFramebuffer.
11304	</desc>
11305	<param name="x" type="unsigned long" dir="in"/>
11306	<param name="y" type="unsigned long" dir="in"/>
11307	</method>
11308
11309	</interface>
11310
11311	<interface
11312	name="IDisplay" extends="$unknown"
11313	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
11314	wsmap="managed"
11315	>
11316	<desc>
11317	The IDisplay interface represents the virtual machine's display.
11318
11319	The object implementing this interface is contained in each
11320	<link to="IConsole::display"/> attribute and represents the visual
11321	output of the virtual machine.
11322
11323	The virtual display supports pluggable output targets represented by the
11324	IFramebuffer interface. Examples of the output target are a window on
11325	the host computer or an RDP session's display on a remote computer.
11326	</desc>
11327	<method name="getScreenResolution">
11328	<desc>Queries display width, height and color depth for given screen.</desc>
11329	<param name="screenId" type="unsigned long" dir="in"/>
11330	<param name="width" type="unsigned long" dir="out"/>
11331	<param name="height" type="unsigned long" dir="out"/>
11332	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
11333	</method>
11334
11335	<method name="setFramebuffer">
11336	<desc>
11337	Sets the framebuffer for given screen.
11338	</desc>
11339	<param name="screenId" type="unsigned long" dir="in"/>
11340	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11341	</method>
11342
11343	<method name="getFramebuffer">
11344	<desc>
11345	Queries the framebuffer for given screen.
11346	</desc>
11347	<param name="screenId" type="unsigned long" dir="in"/>
11348	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11349	<param name="xOrigin" type="long" dir="out"/>
11350	<param name="yOrigin" type="long" dir="out"/>
11351	</method>
11352
11353	<method name="setVideoModeHint">
11354	<desc>
11355	Asks VirtualBox to request the given video mode from
11356	the guest. This is just a hint and it cannot be guaranteed
11357	that the requested resolution will be used. Guest Additions
11358	are required for the request to be seen by guests. The caller
11359	should issue the request and wait for a resolution change and
11360	after a timeout retry.
11361
11362	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11363	parameters means that the corresponding values should be taken from the
11364	current video mode (i.e. left unchanged).
11365
11366	If the guest OS supports multi-monitor configuration then the @a display
11367	parameter specifies the number of the guest display to send the hint to:
11368	@c 0 is the primary display, @c 1 is the first secondary and
11369	so on. If the multi-monitor configuration is not supported, @a display
11370	must be @c 0.
11371
11372	<result name="E_INVALIDARG">
11373	The @a display is not associated with any monitor.
11374	</result>
11375
11376	</desc>
11377	<param name="width" type="unsigned long" dir="in"/>
11378	<param name="height" type="unsigned long" dir="in"/>
11379	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11380	<param name="display" type="unsigned long" dir="in"/>
11381	</method>
11382
11383	<method name="setSeamlessMode">
11384	<desc>
11385	Enables or disables seamless guest display rendering (seamless desktop
11386	integration) mode.
11387	<note>
11388	Calling this method has no effect if <link
11389	to="IGuest::supportsSeamless"/> returns @c false.
11390	</note>
11391	</desc>
11392	<param name="enabled" type="boolean" dir="in"/>
11393	</method>
11394
11395	<method name="takeScreenShot">
11396	<desc>
11397	Takes a screen shot of the requested size and copies it to the
11398	32-bpp buffer allocated by the caller and pointed to by @a address.
11399	A pixel consists of 4 bytes in order: B, G, R, 0.
11400
11401	<note>This API can be used only by the COM/XPCOM C++ API as it
11402	requires pointer support. Use <link to="#takeScreenShotToArray" />
11403	with other language bindings.
11404	</note>
11405
11406	<result name="E_NOTIMPL">
11407	Feature not implemented.
11408	</result>
11409	<result name="VBOX_E_IPRT_ERROR">
11410	Could not take a screenshot.
11411	</result>
11412
11413	</desc>
11414	<param name="screenId" type="unsigned long" dir="in"/>
11415	<param name="address" type="octet" mod="ptr" dir="in"/>
11416	<param name="width" type="unsigned long" dir="in"/>
11417	<param name="height" type="unsigned long" dir="in"/>
11418	</method>
11419
11420	<method name="takeScreenShotToArray">
11421	<desc>
11422	Takes a guest screen shot of the requested size and returns it as
11423	an array of bytes in uncompressed 32-bit RGBA format.
11424	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11425
11426	This API is slow, but could be the only option to get guest screenshot
11427	for scriptable languages not allowed to manipulate with addresses
11428	directly.
11429
11430	<result name="E_NOTIMPL">
11431	Feature not implemented.
11432	</result>
11433	<result name="VBOX_E_IPRT_ERROR">
11434	Could not take a screenshot.
11435	</result>
11436	</desc>
11437	<param name="screenId" type="unsigned long" dir="in">
11438	<desc>
11439	Monitor to take screenshot from.
11440	</desc>
11441	</param>
11442	<param name="width" type="unsigned long" dir="in">
11443	<desc>
11444	Desired image width.
11445	</desc>
11446	</param>
11447	<param name="height" type="unsigned long" dir="in">
11448	<desc>
11449	Desired image height.
11450	</desc>
11451	</param>
11452	<param name="screenData" type="octet" dir="return" safearray="yes">
11453	<desc>
11454	Array with resulting screen data.
11455	</desc>
11456	</param>
11457	</method>
11458
11459	<method name="takeScreenShotPNGToArray">
11460	<desc>
11461	Takes a guest screen shot of the requested size and returns it as
11462	PNG image in array.
11463
11464	<result name="E_NOTIMPL">
11465	Feature not implemented.
11466	</result>
11467	<result name="VBOX_E_IPRT_ERROR">
11468	Could not take a screenshot.
11469	</result>
11470	</desc>
11471	<param name="screenId" type="unsigned long" dir="in">
11472	<desc>
11473	Monitor to take the screenshot from.
11474	</desc>
11475	</param>
11476	<param name="width" type="unsigned long" dir="in">
11477	<desc>
11478	Desired image width.
11479	</desc>
11480	</param>
11481	<param name="height" type="unsigned long" dir="in">
11482	<desc>
11483	Desired image height.
11484	</desc>
11485	</param>
11486	<param name="screenData" type="octet" dir="return" safearray="yes">
11487	<desc>
11488	Array with resulting screen data.
11489	</desc>
11490	</param>
11491	</method>
11492
11493	<method name="drawToScreen">
11494	<desc>
11495	Draws a 32-bpp image of the specified size from the given buffer
11496	to the given point on the VM display.
11497
11498	<result name="E_NOTIMPL">
11499	Feature not implemented.
11500	</result>
11501	<result name="VBOX_E_IPRT_ERROR">
11502	Could not draw to screen.
11503	</result>
11504
11505	</desc>
11506	<param name="screenId" type="unsigned long" dir="in">
11507	<desc>
11508	Monitor to take the screenshot from.
11509	</desc>
11510	</param>
11511	<param name="address" type="octet" mod="ptr" dir="in">
11512	<desc>
11513	Address to store the screenshot to
11514	</desc>
11515	</param>
11516	<param name="x" type="unsigned long" dir="in">
11517	<desc>
11518	Relative to the screen top left corner.
11519	</desc>
11520	</param>
11521	<param name="y" type="unsigned long" dir="in">
11522	<desc>
11523	Relative to the screen top left corner.
11524	</desc>
11525	</param>
11526	<param name="width" type="unsigned long" dir="in">
11527	<desc>
11528	Desired image width.
11529	</desc>
11530	</param>
11531	<param name="height" type="unsigned long" dir="in">
11532	<desc>
11533	Desired image height.
11534	</desc>
11535	</param>
11536	</method>
11537
11538	<method name="invalidateAndUpdate">
11539	<desc>
11540	Does a full invalidation of the VM display and instructs the VM
11541	to update it.
11542
11543	<result name="VBOX_E_IPRT_ERROR">
11544	Could not invalidate and update screen.
11545	</result>
11546
11547	</desc>
11548	</method>
11549
11550	<method name="resizeCompleted">
11551	<desc>
11552	Signals that a framebuffer has completed the resize operation.
11553
11554	<result name="VBOX_E_NOT_SUPPORTED">
11555	Operation only valid for external frame buffers.
11556	</result>
11557
11558	</desc>
11559	<param name="screenId" type="unsigned long" dir="in"/>
11560	</method>
11561
11562	<method name="completeVHWACommand">
11563	<desc>
11564	Signals that the Video HW Acceleration command has completed.
11565	</desc>
11566
11567	<param name="command" type="octet" mod="ptr" dir="in">
11568	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11569	</param>
11570	</method>
11571
11572	</interface>
11573
11574	<!--
11575	// INetworkAdapter
11576	/////////////////////////////////////////////////////////////////////////
11577	-->
11578
11579	<enum
11580	name="NetworkAttachmentType"
11581	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11582	>
11583	<desc>
11584	Network attachment type.
11585	</desc>
11586
11587	<const name="Null" value="0">
11588	<desc>Null value, also means "not attached".</desc>
11589	</const>
11590	<const name="NAT" value="1"/>
11591	<const name="Bridged" value="2"/>
11592	<const name="Internal" value="3"/>
11593	<const name="HostOnly" value="4"/>
11594	<const name="VDE" value="5"/>
11595	</enum>
11596
11597	<enum
11598	name="NetworkAdapterType"
11599	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11600	>
11601	<desc>
11602	Network adapter type.
11603	</desc>
11604
11605	<const name="Null" value="0">
11606	<desc>Null value (never used by the API).</desc>
11607	</const>
11608	<const name="Am79C970A" value="1">
11609	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11610	</const>
11611	<const name="Am79C973" value="2">
11612	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11613	</const>
11614	<const name="I82540EM" value="3">
11615	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11616	</const>
11617	<const name="I82543GC" value="4">
11618	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11619	</const>
11620	<const name="I82545EM" value="5">
11621	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11622	</const>
11623	<const name="Virtio" value="6">
11624	<desc>Virtio network device.</desc>
11625	</const>
11626	</enum>
11627
11628	<interface
11629	name="INetworkAdapter" extends="$unknown"
11630	uuid="9bf58a46-c3f7-4f31-80fa-dde9a5dc0b7b"
11631	wsmap="managed"
11632	>
11633	<desc>
11634	Represents a virtual network adapter that is attached to a virtual machine.
11635	Each virtual machine has a fixed number of network adapter slots with one
11636	instance of this attached to each of them. Call
11637	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11638	is attached to a given slot in a given machine.
11639
11640	Each network adapter can be in one of five attachment modes, which are
11641	represented by the <link to="NetworkAttachmentType" /> enumeration;
11642	see the <link to="#attachmentType" /> attribute.
11643	</desc>
11644
11645	<attribute name="adapterType" type="NetworkAdapterType">
11646	<desc>
11647	Type of the virtual network adapter. Depending on this value,
11648	VirtualBox will provide a different virtual network hardware
11649	to the guest.
11650	</desc>
11651	</attribute>
11652
11653	<attribute name="slot" type="unsigned long" readonly="yes">
11654	<desc>
11655	Slot number this adapter is plugged into. Corresponds to
11656	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11657	to obtain this instance.
11658	</desc>
11659	</attribute>
11660
11661	<attribute name="enabled" type="boolean">
11662	<desc>
11663	Flag whether the network adapter is present in the
11664	guest system. If disabled, the virtual guest hardware will
11665	not contain this network adapter. Can only be changed when
11666	the VM is not running.
11667	</desc>
11668	</attribute>
11669
11670	<attribute name="MACAddress" type="wstring">
11671	<desc>
11672	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11673	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11674	</desc>
11675	</attribute>
11676
11677	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11678
11679	<attribute name="hostInterface" type="wstring">
11680	<desc>
11681	Name of the host network interface the VM is attached to.
11682	</desc>
11683	</attribute>
11684
11685	<attribute name="internalNetwork" type="wstring">
11686	<desc>
11687	Name of the internal network the VM is attached to.
11688	</desc>
11689	</attribute>
11690
11691	<attribute name="NATNetwork" type="wstring">
11692	<desc>
11693	Name of the NAT network the VM is attached to.
11694	</desc>
11695	</attribute>
11696
11697	<attribute name="VDENetwork" type="wstring">
11698	<desc>
11699	Name of the VDE switch the VM is attached to.
11700	</desc>
11701	</attribute>
11702
11703	<attribute name="cableConnected" type="boolean">
11704	<desc>
11705	Flag whether the adapter reports the cable as connected or not.
11706	It can be used to report offline situations to a VM.
11707	</desc>
11708	</attribute>
11709
11710	<attribute name="lineSpeed" type="unsigned long">
11711	<desc>
11712	Line speed reported by custom drivers, in units of 1 kbps.
11713	</desc>
11714	</attribute>
11715
11716	<attribute name="traceEnabled" type="boolean">
11717	<desc>
11718	Flag whether network traffic from/to the network card should be traced.
11719	Can only be toggled when the VM is turned off.
11720	</desc>
11721	</attribute>
11722
11723	<attribute name="traceFile" type="wstring">
11724	<desc>
11725	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11726	will be used.
11727	</desc>
11728	</attribute>
11729
11730	<attribute name="natDriver" type="INATEngine" readonly="yes">
11731	<desc>
11732	Points to the NAT engine which handles the network address translation
11733	for this interface. This is active only when the interface actually uses
11734	NAT (see <link to="#attachToNAT" />).
11735	</desc>
11736	</attribute>
11737
11738	<attribute name="bootPriority" type="unsigned long">
11739	<desc>
11740	Network boot priority of the adapter. Priority 1 is highest. If not set,
11741	the priority is considered to be at the lowest possible setting.
11742	</desc>
11743	</attribute>
11744
11745	<attribute name="bandwidthLimit" type="unsigned long">
11746	<desc>
11747	Maximum throughput allowed for this network adapter, in units of 1 mbps.
11748	A zero value means uncapped/unlimited.
11749	</desc>
11750	</attribute>
11751
11752	<method name="attachToNAT">
11753	<desc>
11754	Attach the network adapter to the Network Address Translation (NAT) interface.
11755	</desc>
11756	</method>
11757
11758	<method name="attachToBridgedInterface">
11759	<desc>
11760	Attach the network adapter to a bridged host interface.
11761	</desc>
11762	</method>
11763
11764	<method name="attachToInternalNetwork">
11765	<desc>
11766	Attach the network adapter to an internal network.
11767	</desc>
11768	</method>
11769
11770	<method name="attachToHostOnlyInterface">
11771	<desc>
11772	Attach the network adapter to the host-only network.
11773	</desc>
11774	</method>
11775
11776	<method name="attachToVDE">
11777	<desc>
11778	Attach the network adapter to a VDE network.
11779	</desc>
11780	</method>
11781
11782	<method name="detach">
11783	<desc>
11784	Detach the network adapter
11785	</desc>
11786	</method>
11787	</interface>
11788
11789
11790	<!--
11791	// ISerialPort
11792	/////////////////////////////////////////////////////////////////////////
11793	-->
11794
11795	<enum
11796	name="PortMode"
11797	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11798	>
11799	<desc>
11800	The PortMode enumeration represents possible communication modes for
11801	the virtual serial port device.
11802	</desc>
11803
11804	<const name="Disconnected" value="0">
11805	<desc>Virtual device is not attached to any real host device.</desc>
11806	</const>
11807	<const name="HostPipe" value="1">
11808	<desc>Virtual device is attached to a host pipe.</desc>
11809	</const>
11810	<const name="HostDevice" value="2">
11811	<desc>Virtual device is attached to a host device.</desc>
11812	</const>
11813	<const name="RawFile" value="3">
11814	<desc>Virtual device is attached to a raw file.</desc>
11815	</const>
11816	</enum>
11817
11818	<interface
11819	name="ISerialPort" extends="$unknown"
11820	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11821	wsmap="managed"
11822	>
11823
11824	<desc>
11825	The ISerialPort interface represents the virtual serial port device.
11826
11827	The virtual serial port device acts like an ordinary serial port
11828	inside the virtual machine. This device communicates to the real
11829	serial port hardware in one of two modes: host pipe or host device.
11830
11831	In host pipe mode, the #path attribute specifies the path to the pipe on
11832	the host computer that represents a serial port. The #server attribute
11833	determines if this pipe is created by the virtual machine process at
11834	machine startup or it must already exist before starting machine
11835	execution.
11836
11837	In host device mode, the #path attribute specifies the name of the
11838	serial port device on the host computer.
11839
11840	There is also a third communication mode: the disconnected mode. In this
11841	mode, the guest OS running inside the virtual machine will be able to
11842	detect the serial port, but all port write operations will be discarded
11843	and all port read operations will return no data.
11844
11845	<see>IMachine::getSerialPort</see>
11846	</desc>
11847
11848	<attribute name="slot" type="unsigned long" readonly="yes">
11849	<desc>
11850	Slot number this serial port is plugged into. Corresponds to
11851	the value you pass to <link to="IMachine::getSerialPort"/>
11852	to obtain this instance.
11853	</desc>
11854	</attribute>
11855
11856	<attribute name="enabled" type="boolean">
11857	<desc>
11858	Flag whether the serial port is enabled. If disabled,
11859	the serial port will not be reported to the guest OS.
11860	</desc>
11861	</attribute>
11862
11863	<attribute name="IOBase" type="unsigned long">
11864	<desc>Base I/O address of the serial port.</desc>
11865	</attribute>
11866
11867	<attribute name="IRQ" type="unsigned long">
11868	<desc>IRQ number of the serial port.</desc>
11869	</attribute>
11870
11871	<attribute name="hostMode" type="PortMode">
11872	<desc>
11873	How is this port connected to the host.
11874	<note>
11875	Changing this attribute may fail if the conditions for
11876	<link to="#path"/> are not met.
11877	</note>
11878	</desc>
11879	</attribute>
11880
11881	<attribute name="server" type="boolean">
11882	<desc>
11883	Flag whether this serial port acts as a server (creates a new pipe on
11884	the host) or as a client (uses the existing pipe). This attribute is
11885	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11886	</desc>
11887	</attribute>
11888
11889	<attribute name="path" type="wstring">
11890	<desc>
11891	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11892	PortMode_HostPipe, or the host serial device name when
11893	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11894	cases, setting a @c null or empty string as the attribute's value
11895	is an error. Otherwise, the value of this property is ignored.
11896	</desc>
11897	</attribute>
11898
11899	</interface>
11900
11901	<!--
11902	// IParallelPort
11903	/////////////////////////////////////////////////////////////////////////
11904	-->
11905
11906	<interface
11907	name="IParallelPort" extends="$unknown"
11908	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11909	wsmap="managed"
11910	>
11911
11912	<desc>
11913	The IParallelPort interface represents the virtual parallel port device.
11914
11915	The virtual parallel port device acts like an ordinary parallel port
11916	inside the virtual machine. This device communicates to the real
11917	parallel port hardware using the name of the parallel device on the host
11918	computer specified in the #path attribute.
11919
11920	Each virtual parallel port device is assigned a base I/O address and an
11921	IRQ number that will be reported to the guest operating system and used
11922	to operate the given parallel port from within the virtual machine.
11923
11924	<see>IMachine::getParallelPort</see>
11925	</desc>
11926
11927	<attribute name="slot" type="unsigned long" readonly="yes">
11928	<desc>
11929	Slot number this parallel port is plugged into. Corresponds to
11930	the value you pass to <link to="IMachine::getParallelPort"/>
11931	to obtain this instance.
11932	</desc>
11933	</attribute>
11934
11935	<attribute name="enabled" type="boolean">
11936	<desc>
11937	Flag whether the parallel port is enabled. If disabled,
11938	the parallel port will not be reported to the guest OS.
11939	</desc>
11940	</attribute>
11941
11942	<attribute name="IOBase" type="unsigned long">
11943	<desc>Base I/O address of the parallel port.</desc>
11944	</attribute>
11945
11946	<attribute name="IRQ" type="unsigned long">
11947	<desc>IRQ number of the parallel port.</desc>
11948	</attribute>
11949
11950	<attribute name="path" type="wstring">
11951	<desc>
11952	Host parallel device name. If this parallel port is enabled, setting a
11953	@c null or an empty string as this attribute's value will result into
11954	an error.
11955	</desc>
11956	</attribute>
11957
11958	</interface>
11959
11960
11961	<!--
11962	// IMachineDebugger
11963	/////////////////////////////////////////////////////////////////////////
11964	-->
11965
11966	<interface
11967	name="IMachineDebugger" extends="$unknown"
11968	uuid="1bfd2fa9-0d91-44d3-9515-368dcbb3eb4d"
11969	wsmap="suppress"
11970	>
11971	<method name="dumpGuestCore">
11972	<desc>
11973	Takes a core dump of the guest.
11974
11975	See include/VBox/dbgfcorefmt.h for details on the file format.
11976	</desc>
11977	<param name="filename" type="wstring" dir="in">
11978	<desc>
11979	The name of the output file. The file must not exist.
11980	</desc>
11981	</param>
11982	<param name="compression" type="wstring" dir="in">
11983	<desc>
11984	Reserved for future compression method indicator.
11985	</desc>
11986	</param>
11987	</method>
11988
11989	<method name="dumpHostProcessCore">
11990	<desc>
11991	Takes a core dump of the VM process on the host.
11992
11993	This feature is not implemented in the 4.0.0 release but it may show up
11994	in a dot release.
11995	</desc>
11996	<param name="filename" type="wstring" dir="in">
11997	<desc>
11998	The name of the output file. The file must not exist.
11999	</desc>
12000	</param>
12001	<param name="compression" type="wstring" dir="in">
12002	<desc>
12003	Reserved for future compression method indicator.
12004	</desc>
12005	</param>
12006	</method>
12007
12008	<method name="info">
12009	<desc>
12010	Interfaces with the info dumpers (DBGFInfo).
12011
12012	This feature is not implemented in the 4.0.0 release but it may show up
12013	in a dot release.
12014	</desc>
12015	<param name="name" type="wstring" dir="in">
12016	<desc>
12017	The name of the info item.
12018	</desc>
12019	</param>
12020	<param name="args" type="wstring" dir="in">
12021	<desc>
12022	Arguments to the info dumper.
12023	</desc>
12024	</param>
12025	<param name="info" type="wstring" dir="return">
12026	<desc>
12027	The into string.
12028	</desc>
12029	</param>
12030	</method>
12031
12032	<method name="injectNMI">
12033	<desc>
12034	Inject an NMI into a running VT-x/AMD-V VM.
12035	</desc>
12036	</method>
12037
12038	<method name="modifyLogGroups">
12039	<desc>
12040	Modifies the group settings of the debug logger.
12041
12042	This feature is not implemented in the 4.0.0 release but may show up
12043	in a dot release.
12044	</desc>
12045	<param name="settings" type="wstring" dir="in">
12046	<desc>The group settings string. See iprt/log.h for details.</desc>
12047	</param>
12048	</method>
12049
12050	<method name="modifyLogFlags">
12051	<desc>
12052	Modifies the debug logger flags.
12053
12054	This feature is not implemented in the 4.0.0 release but may show up
12055	in a dot release.
12056	</desc>
12057	<param name="settings" type="wstring" dir="in">
12058	<desc>The flags settings string. See iprt/log.h for details.</desc>
12059	</param>
12060	</method>
12061
12062	<method name="modifyLogDestinations">
12063	<desc>
12064	Modifies the debug logger destinations.
12065
12066	This feature is not implemented in the 4.0.0 release but may show up
12067	in a dot release.
12068	</desc>
12069	<param name="settings" type="wstring" dir="in">
12070	<desc>The destination settings string. See iprt/log.h for details.</desc>
12071	</param>
12072	</method>
12073
12074	<method name="readPhysicalMemory">
12075	<desc>
12076	Reads guest physical memory, no side effects (MMIO++).
12077
12078	This feature is not implemented in the 4.0.0 release but may show up
12079	in a dot release.
12080	</desc>
12081	<param name="address" type="long long" dir="in">
12082	<desc>The guest physical address.</desc>
12083	</param>
12084	<param name="size" type="unsigned long" dir="in">
12085	<desc>The number of bytes to read.</desc>
12086	</param>
12087	<param name="bytes" type="octet" safearray="yes" dir="return">
12088	<desc>The bytes read.</desc>
12089	</param>
12090	</method>
12091
12092	<method name="writePhysicalMemory">
12093	<desc>
12094	Writes guest physical memory, access handles (MMIO++) are ignored.
12095
12096	This feature is not implemented in the 4.0.0 release but may show up
12097	in a dot release.
12098	</desc>
12099	<param name="address" type="long long" dir="in">
12100	<desc>The guest physical address.</desc>
12101	</param>
12102	<param name="size" type="unsigned long" dir="in">
12103	<desc>The number of bytes to read.</desc>
12104	</param>
12105	<param name="bytes" type="octet" safearray="yes" dir="in">
12106	<desc>The bytes to write.</desc>
12107	</param>
12108	</method>
12109
12110	<method name="readVirtualMemory">
12111	<desc>
12112	Reads guest virtual memory, no side effects (MMIO++).
12113
12114	This feature is not implemented in the 4.0.0 release but may show up
12115	in a dot release.
12116	</desc>
12117	<param name="cpuId" type="unsigned long" dir="in">
12118	<desc>The identifier of the Virtual CPU.</desc>
12119	</param>
12120	<param name="address" type="long long" dir="in">
12121	<desc>The guest virtual address.</desc>
12122	</param>
12123	<param name="size" type="unsigned long" dir="in">
12124	<desc>The number of bytes to read.</desc>
12125	</param>
12126	<param name="bytes" type="octet" safearray="yes" dir="return">
12127	<desc>The bytes read.</desc>
12128	</param>
12129	</method>
12130
12131	<method name="writeVirtualMemory">
12132	<desc>
12133	Writes guest virtual memory, access handles (MMIO++) are ignored.
12134
12135	This feature is not implemented in the 4.0.0 release but may show up
12136	in a dot release.
12137	</desc>
12138	<param name="cpuId" type="unsigned long" dir="in">
12139	<desc>The identifier of the Virtual CPU.</desc>
12140	</param>
12141	<param name="address" type="long long" dir="in">
12142	<desc>The guest virtual address.</desc>
12143	</param>
12144	<param name="size" type="unsigned long" dir="in">
12145	<desc>The number of bytes to read.</desc>
12146	</param>
12147	<param name="bytes" type="octet" safearray="yes" dir="in">
12148	<desc>The bytes to write.</desc>
12149	</param>
12150	</method>
12151
12152	<method name="detectOS">
12153	<desc>
12154	Tries to (re-)detect the guest OS kernel.
12155
12156	This feature is not implemented in the 4.0.0 release but may show up
12157	in a dot release.
12158	</desc>
12159	<param name="os" type="wstring" dir="return">
12160	<desc>
12161	The detected OS kernel on success.
12162	</desc>
12163	</param>
12164	</method>
12165
12166	<method name="getRegister">
12167	<desc>
12168	Gets one register.
12169
12170	This feature is not implemented in the 4.0.0 release but may show up
12171	in a dot release.
12172	</desc>
12173	<param name="cpuId" type="unsigned long" dir="in">
12174	<desc>The identifier of the Virtual CPU.</desc>
12175	</param>
12176	<param name="name" type="wstring" dir="in">
12177	<desc>The register name, case is ignored.</desc>
12178	</param>
12179	<param name="value" type="wstring" dir="return">
12180	<desc>
12181	The register value. This is usually a hex value (always 0x prefixed)
12182	but other format may be used for floating point registers (TBD).
12183	</desc>
12184	</param>
12185	</method>
12186
12187	<method name="getRegisters">
12188	<desc>
12189	Gets all the registers for the given CPU.
12190
12191	This feature is not implemented in the 4.0.0 release but may show up
12192	in a dot release.
12193	</desc>
12194	<param name="cpuId" type="unsigned long" dir="in">
12195	<desc>The identifier of the Virtual CPU.</desc>
12196	</param>
12197	<param name="names" type="wstring" dir="out" safearray="yes">
12198	<desc>Array containing the lowercase register names.</desc>
12199	</param>
12200	<param name="values" type="wstring" dir="out" safearray="yes">
12201	<desc>
12202	Array paralell to the names holding the register values as if the
12203	register was returned by <link to="IMachineDebugger::getRegister"/>.
12204	</desc>
12205	</param>
12206	</method>
12207
12208	<method name="setRegister">
12209	<desc>
12210	Gets one register.
12211
12212	This feature is not implemented in the 4.0.0 release but may show up
12213	in a dot release.
12214	</desc>
12215	<param name="cpuId" type="unsigned long" dir="in">
12216	<desc>The identifier of the Virtual CPU.</desc>
12217	</param>
12218	<param name="name" type="wstring" dir="in">
12219	<desc>The register name, case is ignored.</desc>
12220	</param>
12221	<param name="value" type="wstring" dir="in">
12222	<desc>
12223	The new register value. Hexadecimal, decimal and octal formattings
12224	are supported in addition to any special formattings returned by
12225	the getters.
12226	</desc>
12227	</param>
12228	</method>
12229
12230	<method name="setRegisters">
12231	<desc>
12232	Sets zero or more registers atomically.
12233
12234	This feature is not implemented in the 4.0.0 release but may show up
12235	in a dot release.
12236	</desc>
12237	<param name="cpuId" type="unsigned long" dir="in">
12238	<desc>The identifier of the Virtual CPU.</desc>
12239	</param>
12240	<param name="names" type="wstring" dir="in" safearray="yes">
12241	<desc>Array containing the register names, case ignored.</desc>
12242	</param>
12243	<param name="values" type="wstring" dir="in" safearray="yes">
12244	<desc>
12245	Array paralell to the names holding the register values. See
12246	<link to="IMachineDebugger::setRegister"/> for formatting
12247	guidelines.
12248	</desc>
12249	</param>
12250	</method>
12251
12252	<method name="dumpGuestStack">
12253	<desc>
12254	Produce a simple stack dump using the current guest state.
12255
12256	This feature is not implemented in the 4.0.0 release but may show up
12257	in a dot release.
12258	</desc>
12259	<param name="cpuId" type="unsigned long" dir="in">
12260	<desc>The identifier of the Virtual CPU.</desc>
12261	</param>
12262	<param name="stack" type="wstring" dir="return">
12263	<desc>String containing the formatted stack dump.</desc>
12264	</param>
12265	</method>
12266
12267	<method name="resetStats">
12268	<desc>
12269	Reset VM statistics.
12270	</desc>
12271	<param name="pattern" type="wstring" dir="in">
12272	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12273	</param>
12274	</method>
12275
12276	<method name="dumpStats">
12277	<desc>
12278	Dumps VM statistics.
12279	</desc>
12280	<param name="pattern" type="wstring" dir="in">
12281	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12282	</param>
12283	</method>
12284
12285	<method name="getStats">
12286	<desc>
12287	Get the VM statistics in a XMLish format.
12288	</desc>
12289	<param name="pattern" type="wstring" dir="in">
12290	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12291	</param>
12292	<param name="withDescriptions" type="boolean" dir="in">
12293	<desc>Whether to include the descriptions.</desc>
12294	</param>
12295	<param name="stats" type="wstring" dir="out">
12296	<desc>The XML document containing the statistics.</desc>
12297	</param>
12298	</method>
12299
12300	<attribute name="singlestep" type="boolean">
12301	<desc>Switch for enabling singlestepping.</desc>
12302	</attribute>
12303
12304	<attribute name="recompileUser" type="boolean">
12305	<desc>Switch for forcing code recompilation for user mode code.</desc>
12306	</attribute>
12307
12308	<attribute name="recompileSupervisor" type="boolean">
12309	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
12310	</attribute>
12311
12312	<attribute name="PATMEnabled" type="boolean">
12313	<desc>Switch for enabling and disabling the PATM component.</desc>
12314	</attribute>
12315
12316	<attribute name="CSAMEnabled" type="boolean">
12317	<desc>Switch for enabling and disabling the CSAM component.</desc>
12318	</attribute>
12319
12320	<attribute name="logEnabled" type="boolean">
12321	<desc>Switch for enabling and disabling the debug logger.</desc>
12322	</attribute>
12323
12324	<attribute name="logFlags" type="wstring" readonly="yes">
12325	<desc>The debug logger flags.</desc>
12326	</attribute>
12327
12328	<attribute name="logGroups" type="wstring" readonly="yes">
12329	<desc>The debug logger's group settings.</desc>
12330	</attribute>
12331
12332	<attribute name="logDestinations" type="wstring" readonly="yes">
12333	<desc>The debug logger's destination settings.</desc>
12334	</attribute>
12335
12336	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
12337	<desc>
12338	Flag indicating whether the VM is currently making use of CPU hardware
12339	virtualization extensions.
12340	</desc>
12341	</attribute>
12342
12343	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
12344	<desc>
12345	Flag indicating whether the VM is currently making use of the nested paging
12346	CPU hardware virtualization extension.
12347	</desc>
12348	</attribute>
12349
12350	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
12351	<desc>
12352	Flag indicating whether the VM is currently making use of the VPID
12353	VT-x extension.
12354	</desc>
12355	</attribute>
12356
12357	<attribute name="OSName" type="wstring" readonly="yes">
12358	<desc>
12359	Query the guest OS kernel name as detected by the DBGF.
12360
12361	This feature is not implemented in the 4.0.0 release but may show up
12362	in a dot release.
12363	</desc>
12364	</attribute>
12365
12366	<attribute name="OSVersion" type="wstring" readonly="yes">
12367	<desc>
12368	Query the guest OS kernel version string as detected by the DBGF.
12369
12370	This feature is not implemented in the 4.0.0 release but may show up
12371	in a dot release.
12372	</desc>
12373	</attribute>
12374
12375	<attribute name="PAEEnabled" type="boolean" readonly="yes">
12376	<desc>
12377	Flag indicating whether the VM is currently making use of the Physical
12378	Address Extension CPU feature.
12379	</desc>
12380	</attribute>
12381
12382	<attribute name="virtualTimeRate" type="unsigned long">
12383	<desc>
12384	The rate at which the virtual time runs expressed as a percentage.
12385	The accepted range is 2% to 20000%.
12386	</desc>
12387	</attribute>
12388
12389	<attribute name="VM" type="long long" readonly="yes">
12390	<desc>
12391	Gets the VM handle. This is only for internal use while
12392	we carve the details of this interface.
12393	</desc>
12394	</attribute>
12395
12396	</interface>
12397
12398	<!--
12399	// IUSBController
12400	/////////////////////////////////////////////////////////////////////////
12401	-->
12402
12403	<interface
12404	name="IUSBController" extends="$unknown"
12405	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
12406	wsmap="managed"
12407	>
12408	<attribute name="enabled" type="boolean">
12409	<desc>
12410	Flag whether the USB controller is present in the
12411	guest system. If disabled, the virtual guest hardware will
12412	not contain any USB controller. Can only be changed when
12413	the VM is powered off.
12414	</desc>
12415	</attribute>
12416
12417	<attribute name="enabledEhci" type="boolean">
12418	<desc>
12419	Flag whether the USB EHCI controller is present in the
12420	guest system. If disabled, the virtual guest hardware will
12421	not contain a USB EHCI controller. Can only be changed when
12422	the VM is powered off.
12423	</desc>
12424	</attribute>
12425
12426	<attribute name="proxyAvailable" type="boolean" readonly="yes">
12427	<desc>
12428	Flag whether there is an USB proxy available.
12429	</desc>
12430	</attribute>
12431
12432	<attribute name="USBStandard" type="unsigned short" readonly="yes">
12433	<desc>
12434	USB standard version which the controller implements.
12435	This is a BCD which means that the major version is in the
12436	high byte and minor version is in the low byte.
12437	</desc>
12438	</attribute>
12439
12440	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
12441	<desc>
12442	List of USB device filters associated with the machine.
12443
12444	If the machine is currently running, these filters are activated
12445	every time a new (supported) USB device is attached to the host
12446	computer that was not ignored by global filters
12447	(<link to="IHost::USBDeviceFilters"/>).
12448
12449	These filters are also activated when the machine is powered up.
12450	They are run against a list of all currently available USB
12451	devices (in states
12452	<link to="USBDeviceState_Available"/>,
12453	<link to="USBDeviceState_Busy"/>,
12454	<link to="USBDeviceState_Held"/>) that were not previously
12455	ignored by global filters.
12456
12457	If at least one filter matches the USB device in question, this
12458	device is automatically captured (attached to) the virtual USB
12459	controller of this machine.
12460
12461	<see>IUSBDeviceFilter, ::IUSBController</see>
12462	</desc>
12463	</attribute>
12464
12465	<method name="createDeviceFilter">
12466	<desc>
12467	Creates a new USB device filter. All attributes except
12468	the filter name are set to empty (any match),
12469	<i>active</i> is @c false (the filter is not active).
12470
12471	The created filter can then be added to the list of filters using
12472	<link to="#insertDeviceFilter"/>.
12473
12474	<result name="VBOX_E_INVALID_VM_STATE">
12475	The virtual machine is not mutable.
12476	</result>
12477
12478	<see>#deviceFilters</see>
12479	</desc>
12480	<param name="name" type="wstring" dir="in">
12481	<desc>
12482	Filter name. See <link to="IUSBDeviceFilter::name"/>
12483	for more info.
12484	</desc>
12485	</param>
12486	<param name="filter" type="IUSBDeviceFilter" dir="return">
12487	<desc>Created filter object.</desc>
12488	</param>
12489	</method>
12490
12491	<method name="insertDeviceFilter">
12492	<desc>
12493	Inserts the given USB device to the specified position
12494	in the list of filters.
12495
12496	Positions are numbered starting from <tt>0</tt>. If the specified
12497	position is equal to or greater than the number of elements in
12498	the list, the filter is added to the end of the collection.
12499
12500	<note>
12501	Duplicates are not allowed, so an attempt to insert a
12502	filter that is already in the collection, will return an
12503	error.
12504	</note>
12505
12506	<result name="VBOX_E_INVALID_VM_STATE">
12507	Virtual machine is not mutable.
12508	</result>
12509	<result name="E_INVALIDARG">
12510	USB device filter not created within this VirtualBox instance.
12511	</result>
12512	<result name="VBOX_E_INVALID_OBJECT_STATE">
12513	USB device filter already in list.
12514	</result>
12515
12516	<see>#deviceFilters</see>
12517	</desc>
12518	<param name="position" type="unsigned long" dir="in">
12519	<desc>Position to insert the filter to.</desc>
12520	</param>
12521	<param name="filter" type="IUSBDeviceFilter" dir="in">
12522	<desc>USB device filter to insert.</desc>
12523	</param>
12524	</method>
12525
12526	<method name="removeDeviceFilter">
12527	<desc>
12528	Removes a USB device filter from the specified position in the
12529	list of filters.
12530
12531	Positions are numbered starting from <tt>0</tt>. Specifying a
12532	position equal to or greater than the number of elements in
12533	the list will produce an error.
12534
12535	<see>#deviceFilters</see>
12536
12537	<result name="VBOX_E_INVALID_VM_STATE">
12538	Virtual machine is not mutable.
12539	</result>
12540	<result name="E_INVALIDARG">
12541	USB device filter list empty or invalid @a position.
12542	</result>
12543
12544	</desc>
12545	<param name="position" type="unsigned long" dir="in">
12546	<desc>Position to remove the filter from.</desc>
12547	</param>
12548	<param name="filter" type="IUSBDeviceFilter" dir="return">
12549	<desc>Removed USB device filter.</desc>
12550	</param>
12551	</method>
12552
12553	</interface>
12554
12555
12556	<!--
12557	// IUSBDevice
12558	/////////////////////////////////////////////////////////////////////////
12559	-->
12560
12561	<interface
12562	name="IUSBDevice" extends="$unknown"
12563	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
12564	wsmap="managed"
12565	>
12566	<desc>
12567	The IUSBDevice interface represents a virtual USB device attached to the
12568	virtual machine.
12569
12570	A collection of objects implementing this interface is stored in the
12571	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
12572	attached to a running virtual machine's USB controller.
12573	</desc>
12574
12575	<attribute name="id" type="uuid" mod="string" readonly="yes">
12576	<desc>
12577	Unique USB device ID. This ID is built from #vendorId,
12578	#productId, #revision and #serialNumber.
12579	</desc>
12580	</attribute>
12581
12582	<attribute name="vendorId" type="unsigned short" readonly="yes">
12583	<desc>Vendor ID.</desc>
12584	</attribute>
12585
12586	<attribute name="productId" type="unsigned short" readonly="yes">
12587	<desc>Product ID.</desc>
12588	</attribute>
12589
12590	<attribute name="revision" type="unsigned short" readonly="yes">
12591	<desc>
12592	Product revision number. This is a packed BCD represented as
12593	unsigned short. The high byte is the integer part and the low
12594	byte is the decimal.
12595	</desc>
12596	</attribute>
12597
12598	<attribute name="manufacturer" type="wstring" readonly="yes">
12599	<desc>Manufacturer string.</desc>
12600	</attribute>
12601
12602	<attribute name="product" type="wstring" readonly="yes">
12603	<desc>Product string.</desc>
12604	</attribute>
12605
12606	<attribute name="serialNumber" type="wstring" readonly="yes">
12607	<desc>Serial number string.</desc>
12608	</attribute>
12609
12610	<attribute name="address" type="wstring" readonly="yes">
12611	<desc>Host specific address of the device.</desc>
12612	</attribute>
12613
12614	<attribute name="port" type="unsigned short" readonly="yes">
12615	<desc>
12616	Host USB port number the device is physically
12617	connected to.
12618	</desc>
12619	</attribute>
12620
12621	<attribute name="version" type="unsigned short" readonly="yes">
12622	<desc>
12623	The major USB version of the device - 1 or 2.
12624	</desc>
12625	</attribute>
12626
12627	<attribute name="portVersion" type="unsigned short" readonly="yes">
12628	<desc>
12629	The major USB version of the host USB port the device is
12630	physically connected to - 1 or 2. For devices not connected to
12631	anything this will have the same value as the version attribute.
12632	</desc>
12633	</attribute>
12634
12635	<attribute name="remote" type="boolean" readonly="yes">
12636	<desc>
12637	Whether the device is physically connected to a remote VRDE
12638	client or to a local host machine.
12639	</desc>
12640	</attribute>
12641
12642	</interface>
12643
12644
12645	<!--
12646	// IUSBDeviceFilter
12647	/////////////////////////////////////////////////////////////////////////
12648	-->
12649
12650	<interface
12651	name="IUSBDeviceFilter" extends="$unknown"
12652	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
12653	wsmap="managed"
12654	>
12655	<desc>
12656	The IUSBDeviceFilter interface represents an USB device filter used
12657	to perform actions on a group of USB devices.
12658
12659	This type of filters is used by running virtual machines to
12660	automatically capture selected USB devices once they are physically
12661	attached to the host computer.
12662
12663	A USB device is matched to the given device filter if and only if all
12664	attributes of the device match the corresponding attributes of the
12665	filter (that is, attributes are joined together using the logical AND
12666	operation). On the other hand, all together, filters in the list of
12667	filters carry the semantics of the logical OR operation. So if it is
12668	desirable to create a match like "this vendor id OR this product id",
12669	one needs to create two filters and specify "any match" (see below)
12670	for unused attributes.
12671
12672	All filter attributes used for matching are strings. Each string
12673	is an expression representing a set of values of the corresponding
12674	device attribute, that will match the given filter. Currently, the
12675	following filtering expressions are supported:
12676
12677	<ul>
12678	<li><i>Interval filters</i>. Used to specify valid intervals for
12679	integer device attributes (Vendor ID, Product ID and Revision).
12680	The format of the string is:
12681
12682	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
12683
12684	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
12685	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
12686	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
12687	is omitted before a dash (<tt>-</tt>), the minimum possible integer
12688	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
12689	possible integer is assumed.
12690	</li>
12691	<li><i>Boolean filters</i>. Used to specify acceptable values for
12692	boolean device attributes. The format of the string is:
12693
12694	<tt>true\|false\|yes\|no\|0\|1</tt>
12695
12696	</li>
12697	<li><i>Exact match</i>. Used to specify a single value for the given
12698	device attribute. Any string that doesn't start with <tt>int:</tt>
12699	represents the exact match. String device attributes are compared to
12700	this string including case of symbols. Integer attributes are first
12701	converted to a string (see individual filter attributes) and then
12702	compared ignoring case.
12703
12704	</li>
12705	<li><i>Any match</i>. Any value of the corresponding device attribute
12706	will match the given filter. An empty or @c null string is
12707	used to construct this type of filtering expressions.
12708
12709	</li>
12710	</ul>
12711
12712	<note>
12713	On the Windows host platform, interval filters are not currently
12714	available. Also all string filter attributes
12715	(<link to="#manufacturer"/>, <link to="#product"/>,
12716	<link to="#serialNumber"/>) are ignored, so they behave as
12717	<i>any match</i> no matter what string expression is specified.
12718	</note>
12719
12720	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
12721	</desc>
12722
12723	<attribute name="name" type="wstring">
12724	<desc>
12725	Visible name for this filter.
12726	This name is used to visually distinguish one filter from another,
12727	so it can neither be @c null nor an empty string.
12728	</desc>
12729	</attribute>
12730
12731	<attribute name="active" type="boolean">
12732	<desc>Whether this filter active or has been temporarily disabled.</desc>
12733	</attribute>
12734
12735	<attribute name="vendorId" type="wstring">
12736	<desc>
12737	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12738	The string representation for the <i>exact matching</i>
12739	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12740	(including leading zeroes).
12741	</desc>
12742	</attribute>
12743
12744	<attribute name="productId" type="wstring">
12745	<desc>
12746	<link to="IUSBDevice::productId">Product ID</link> filter.
12747	The string representation for the <i>exact matching</i>
12748	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12749	(including leading zeroes).
12750	</desc>
12751	</attribute>
12752
12753	<attribute name="revision" type="wstring">
12754	<desc>
12755	<link to="IUSBDevice::productId">Product revision number</link>
12756	filter. The string representation for the <i>exact matching</i>
12757	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12758	of the integer part of the revision, and <tt>F</tt> is the
12759	decimal digit of its fractional part (including leading and
12760	trailing zeros).
12761	Note that for interval filters, it's best to use the hexadecimal
12762	form, because the revision is stored as a 16 bit packed BCD value;
12763	so the expression <tt>int:0x0100-0x0199</tt> will match any
12764	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12765	</desc>
12766	</attribute>
12767
12768	<attribute name="manufacturer" type="wstring">
12769	<desc>
12770	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12771	</desc>
12772	</attribute>
12773
12774	<attribute name="product" type="wstring">
12775	<desc>
12776	<link to="IUSBDevice::product">Product</link> filter.
12777	</desc>
12778	</attribute>
12779
12780	<attribute name="serialNumber" type="wstring">
12781	<desc>
12782	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12783	</desc>
12784	</attribute>
12785
12786	<attribute name="port" type="wstring">
12787	<desc>
12788	<link to="IUSBDevice::port">Host USB port</link> filter.
12789	</desc>
12790	</attribute>
12791
12792	<attribute name="remote" type="wstring">
12793	<desc>
12794	<link to="IUSBDevice::remote">Remote state</link> filter.
12795	<note>
12796	This filter makes sense only for machine USB filters,
12797	i.e. it is ignored by IHostUSBDeviceFilter objects.
12798	</note>
12799	</desc>
12800	</attribute>
12801
12802	<attribute name="maskedInterfaces" type="unsigned long">
12803	<desc>
12804	This is an advanced option for hiding one or more USB interfaces
12805	from the guest. The value is a bit mask where the bits that are set
12806	means the corresponding USB interface should be hidden, masked off
12807	if you like.
12808	This feature only works on Linux hosts.
12809	</desc>
12810	</attribute>
12811
12812	</interface>
12813
12814
12815	<!--
12816	// IHostUSBDevice
12817	/////////////////////////////////////////////////////////////////////////
12818	-->
12819
12820	<enum
12821	name="USBDeviceState"
12822	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12823	>
12824	<desc>
12825	USB device state. This enumeration represents all possible states
12826	of the USB device physically attached to the host computer regarding
12827	its state on the host computer and availability to guest computers
12828	(all currently running virtual machines).
12829
12830	Once a supported USB device is attached to the host, global USB
12831	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12832	either ignore the device, or put it to USBDeviceState_Held state, or do
12833	nothing. Unless the device is ignored by global filters, filters of all
12834	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12835	activated that can put it to USBDeviceState_Captured state.
12836
12837	If the device was ignored by global filters, or didn't match
12838	any filters at all (including guest ones), it is handled by the host
12839	in a normal way. In this case, the device state is determined by
12840	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12841	or USBDeviceState_Available, depending on the current device usage.
12842
12843	Besides auto-capturing based on filters, the device can be manually
12844	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12845	state is USBDeviceState_Busy, USBDeviceState_Available or
12846	USBDeviceState_Held.
12847
12848	<note>
12849	Due to differences in USB stack implementations in Linux and Win32,
12850	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
12851	only to the Linux version of the product. This also means that (<link
12852	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12853	device state is USBDeviceState_Held.
12854	</note>
12855
12856	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12857	</desc>
12858
12859	<const name="NotSupported" value="0">
12860	<desc>
12861	Not supported by the VirtualBox server, not available to guests.
12862	</desc>
12863	</const>
12864	<const name="Unavailable" value="1">
12865	<desc>
12866	Being used by the host computer exclusively,
12867	not available to guests.
12868	</desc>
12869	</const>
12870	<const name="Busy" value="2">
12871	<desc>
12872	Being used by the host computer, potentially available to guests.
12873	</desc>
12874	</const>
12875	<const name="Available" value="3">
12876	<desc>
12877	Not used by the host computer, available to guests (the host computer
12878	can also start using the device at any time).
12879	</desc>
12880	</const>
12881	<const name="Held" value="4">
12882	<desc>
12883	Held by the VirtualBox server (ignored by the host computer),
12884	available to guests.
12885	</desc>
12886	</const>
12887	<const name="Captured" value="5">
12888	<desc>
12889	Captured by one of the guest computers, not available
12890	to anybody else.
12891	</desc>
12892	</const>
12893	</enum>
12894
12895	<interface
12896	name="IHostUSBDevice" extends="IUSBDevice"
12897	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12898	wsmap="managed"
12899	>
12900	<desc>
12901	The IHostUSBDevice interface represents a physical USB device attached
12902	to the host computer.
12903
12904	Besides properties inherited from IUSBDevice, this interface adds the
12905	<link to="#state"/> property that holds the current state of the USB
12906	device.
12907
12908	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12909	</desc>
12910
12911	<attribute name="state" type="USBDeviceState" readonly="yes">
12912	<desc>
12913	Current state of the device.
12914	</desc>
12915	</attribute>
12916
12917	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12918
12919	</interface>
12920
12921
12922	<!--
12923	// IHostUSBDeviceFilter
12924	/////////////////////////////////////////////////////////////////////////
12925	-->
12926
12927	<enum
12928	name="USBDeviceFilterAction"
12929	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12930	>
12931	<desc>
12932	Actions for host USB device filters.
12933	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12934	</desc>
12935
12936	<const name="Null" value="0">
12937	<desc>Null value (never used by the API).</desc>
12938	</const>
12939	<const name="Ignore" value="1">
12940	<desc>Ignore the matched USB device.</desc>
12941	</const>
12942	<const name="Hold" value="2">
12943	<desc>Hold the matched USB device.</desc>
12944	</const>
12945	</enum>
12946
12947	<interface
12948	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12949	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12950	wsmap="managed"
12951	>
12952	<desc>
12953	The IHostUSBDeviceFilter interface represents a global filter for a
12954	physical USB device used by the host computer. Used indirectly in
12955	<link to="IHost::USBDeviceFilters"/>.
12956
12957	Using filters of this type, the host computer determines the initial
12958	state of the USB device after it is physically attached to the
12959	host's USB controller.
12960
12961	<note>
12962	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
12963	filters, because it makes sense only for
12964	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12965	</note>
12966
12967	<see>IHost::USBDeviceFilters</see>
12968	</desc>
12969
12970	<attribute name="action" type="USBDeviceFilterAction">
12971	<desc>
12972	Action performed by the host when an attached USB device
12973	matches this filter.
12974	</desc>
12975	</attribute>
12976
12977	</interface>
12978
12979	<!--
12980	// IAudioAdapter
12981	/////////////////////////////////////////////////////////////////////////
12982	-->
12983
12984	<enum
12985	name="AudioDriverType"
12986	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12987	>
12988	<desc>
12989	Host audio driver type.
12990	</desc>
12991
12992	<const name="Null" value="0">
12993	<desc>Null value, also means "dummy audio driver".</desc>
12994	</const>
12995	<const name="WinMM" value="1">
12996	<desc>Windows multimedia (Windows hosts only).</desc>
12997	</const>
12998	<const name="OSS" value="2">
12999	<desc>Open Sound System (Linux hosts only).</desc>
13000	</const>
13001	<const name="ALSA" value="3">
13002	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
13003	</const>
13004	<const name="DirectSound" value="4">
13005	<desc>DirectSound (Windows hosts only).</desc>
13006	</const>
13007	<const name="CoreAudio" value="5">
13008	<desc>CoreAudio (Mac hosts only).</desc>
13009	</const>
13010	<const name="MMPM" value="6">
13011	<desc>Reserved for historical reasons.</desc>
13012	</const>
13013	<const name="Pulse" value="7">
13014	<desc>PulseAudio (Linux hosts only).</desc>
13015	</const>
13016	<const name="SolAudio" value="8">
13017	<desc>Solaris audio (Solaris hosts only).</desc>
13018	</const>
13019	</enum>
13020
13021	<enum
13022	name="AudioControllerType"
13023	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
13024	>
13025	<desc>
13026	Virtual audio controller type.
13027	</desc>
13028
13029	<const name="AC97" value="0"/>
13030	<const name="SB16" value="1"/>
13031	<const name="HDA" value="2"/>
13032	</enum>
13033
13034	<interface
13035	name="IAudioAdapter" extends="$unknown"
13036	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
13037	wsmap="managed"
13038	>
13039	<desc>
13040	The IAudioAdapter interface represents the virtual audio adapter of
13041	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
13042	</desc>
13043	<attribute name="enabled" type="boolean">
13044	<desc>
13045	Flag whether the audio adapter is present in the
13046	guest system. If disabled, the virtual guest hardware will
13047	not contain any audio adapter. Can only be changed when
13048	the VM is not running.
13049	</desc>
13050	</attribute>
13051	<attribute name="audioController" type="AudioControllerType">
13052	<desc>
13053	The audio hardware we emulate.
13054	</desc>
13055	</attribute>
13056	<attribute name="audioDriver" type="AudioDriverType">
13057	<desc>
13058	Audio driver the adapter is connected to. This setting
13059	can only be changed when the VM is not running.
13060	</desc>
13061	</attribute>
13062	</interface>
13063
13064	<enum
13065	name="AuthType"
13066	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
13067	>
13068	<desc>
13069	VirtualBox authentication type.
13070	</desc>
13071
13072	<const name="Null" value="0">
13073	<desc>Null value, also means "no authentication".</desc>
13074	</const>
13075	<const name="External" value="1"/>
13076	<const name="Guest" value="2"/>
13077	</enum>
13078
13079	<!--
13080	// IVRDEServer
13081	/////////////////////////////////////////////////////////////////////////
13082	-->
13083
13084	<interface
13085	name="IVRDEServer" extends="$unknown"
13086	uuid="be24e0db-e1d6-4d58-b85b-21053d1511b4"
13087	wsmap="managed"
13088	>
13089	<attribute name="enabled" type="boolean">
13090	<desc>VRDE server status.</desc>
13091	</attribute>
13092
13093	<attribute name="authType" type="AuthType">
13094	<desc>VRDE authentication method.</desc>
13095	</attribute>
13096
13097	<attribute name="authTimeout" type="unsigned long">
13098	<desc>Timeout for guest authentication. Milliseconds.</desc>
13099	</attribute>
13100
13101	<attribute name="allowMultiConnection" type="boolean">
13102	<desc>
13103	Flag whether multiple simultaneous connections to the VM are permitted.
13104	Note that this will be replaced by a more powerful mechanism in the future.
13105	</desc>
13106	</attribute>
13107
13108	<attribute name="reuseSingleConnection" type="boolean">
13109	<desc>
13110	Flag whether the existing connection must be dropped and a new connection
13111	must be established by the VRDE server, when a new client connects in single
13112	connection mode.
13113	</desc>
13114	</attribute>
13115
13116	<attribute name="VRDEExtPack" type="wstring">
13117	<desc>
13118	The name of Extension Pack providing VRDE for this VM. Overrides
13119	<link to="ISystemProperties::defaultVRDEExtPack"/>.
13120	</desc>
13121	</attribute>
13122
13123	<attribute name="AuthLibrary" type="wstring">
13124	<desc>
13125	Library used for authentication of RDP clients by this VM. Overrides
13126	<link to="ISystemProperties::VRDEAuthLibrary"/>.
13127	</desc>
13128	</attribute>
13129
13130	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
13131	<desc>
13132	Array of names of properties, which are supported by this VRDE server.
13133	</desc>
13134	</attribute>
13135
13136	<method name="setVRDEProperty">
13137	<desc>
13138	Sets a VRDE specific property string.
13139
13140	If you pass @c null or empty string as a key @a value, the given @a key
13141	will be deleted.
13142
13143	</desc>
13144	<param name="key" type="wstring" dir="in">
13145	<desc>Name of the key to set.</desc>
13146	</param>
13147	<param name="value" type="wstring" dir="in">
13148	<desc>Value to assign to the key.</desc>
13149	</param>
13150	</method>
13151
13152	<method name="getVRDEProperty">
13153	<desc>
13154	Returns a VRDE specific property string.
13155
13156	If the requested data @a key does not exist, this function will
13157	succeed and return an empty string in the @a value argument.
13158
13159	</desc>
13160	<param name="key" type="wstring" dir="in">
13161	<desc>Name of the key to get.</desc>
13162	</param>
13163	<param name="value" type="wstring" dir="return">
13164	<desc>Value of the requested key.</desc>
13165	</param>
13166	</method>
13167
13168	</interface>
13169
13170
13171	<!--
13172	// ISharedFolder
13173	/////////////////////////////////////////////////////////////////////////
13174	-->
13175
13176	<interface
13177	name="ISharedFolder" extends="$unknown"
13178	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
13179	wsmap="struct"
13180	>
13181	<desc>
13182	The ISharedFolder interface represents a folder in the host computer's
13183	file system accessible from the guest OS running inside a virtual
13184	machine using an associated logical name.
13185
13186	There are three types of shared folders:
13187	<ul>
13188	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
13189	folders available to all virtual machines.</li>
13190	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
13191	VM-specific shared folders available to the given virtual machine at
13192	startup.</li>
13193	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
13194	VM-specific shared folders created in the session context (for
13195	example, when the virtual machine is running) and automatically
13196	discarded when the session is closed (the VM is powered off).</li>
13197	</ul>
13198
13199	Logical names of shared folders must be unique within the given scope
13200	(global, permanent or transient). However, they do not need to be unique
13201	across scopes. In this case, the definition of the shared folder in a
13202	more specific scope takes precedence over definitions in all other
13203	scopes. The order of precedence is (more specific to more general):
13204	<ol>
13205	<li>Transient definitions</li>
13206	<li>Permanent definitions</li>
13207	<li>Global definitions</li>
13208	</ol>
13209
13210	For example, if MyMachine has a shared folder named
13211	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
13212	transient shared folder named <tt>C_DRIVE</tt> (that points
13213	to <tt>C:\\\\WINDOWS</tt>) will change the definition
13214	of <tt>C_DRIVE</tt> in the guest OS so
13215	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
13216	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
13217	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
13218	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
13219	to <tt>C:\\</tt> if it still exists.
13220
13221	Note that permanent and transient shared folders of different machines
13222	are in different name spaces, so they don't overlap and don't need to
13223	have unique logical names.
13224
13225	<note>
13226	Global shared folders are not implemented in the current version of the
13227	product.
13228	</note>
13229	</desc>
13230
13231	<attribute name="name" type="wstring" readonly="yes">
13232	<desc>Logical name of the shared folder.</desc>
13233	</attribute>
13234
13235	<attribute name="hostPath" type="wstring" readonly="yes">
13236	<desc>Full path to the shared folder in the host file system.</desc>
13237	</attribute>
13238
13239	<attribute name="accessible" type="boolean" readonly="yes">
13240	<desc>
13241	Whether the folder defined by the host path is currently
13242	accessible or not.
13243	For example, the folder can be inaccessible if it is placed
13244	on the network share that is not available by the time
13245	this property is read.
13246	</desc>
13247	</attribute>
13248
13249	<attribute name="writable" type="boolean" readonly="yes">
13250	<desc>
13251	Whether the folder defined by the host path is writable or
13252	not.
13253	</desc>
13254	</attribute>
13255
13256	<attribute name="autoMount" type="boolean" readonly="yes">
13257	<desc>
13258	Whether the folder gets automatically mounted by the guest or not.
13259	</desc>
13260	</attribute>
13261
13262	<attribute name="lastAccessError" type="wstring" readonly="yes">
13263	<desc>
13264	Text message that represents the result of the last accessibility
13265	check.
13266
13267	Accessibility checks are performed each time the <link to="#accessible"/>
13268	attribute is read. An empty string is returned if the last
13269	accessibility check was successful. A non-empty string indicates a
13270	failure and should normally describe a reason of the failure (for
13271	example, a file read error).
13272	</desc>
13273	</attribute>
13274
13275	</interface>
13276
13277	<!--
13278	// ISession
13279	/////////////////////////////////////////////////////////////////////////
13280	-->
13281
13282	<interface
13283	name="IInternalSessionControl" extends="$unknown"
13284	uuid="a2fbf834-149d-41da-ae52-0dc3b0f032b3"
13285	internal="yes"
13286	wsmap="suppress"
13287	>
13288	<method name="getPID">
13289	<desc>PID of the process that has created this Session object.
13290	</desc>
13291	<param name="pid" type="unsigned long" dir="return"/>
13292	</method>
13293
13294	<method name="getRemoteConsole">
13295	<desc>
13296	Returns the console object suitable for remote control.
13297
13298	<result name="VBOX_E_INVALID_VM_STATE">
13299	Session state prevents operation.
13300	</result>
13301	<result name="VBOX_E_INVALID_OBJECT_STATE">
13302	Session type prevents operation.
13303	</result>
13304
13305	</desc>
13306	<param name="console" type="IConsole" dir="return"/>
13307	</method>
13308
13309	<method name="assignMachine">
13310	<desc>
13311	Assigns the machine object associated with this direct-type
13312	session or informs the session that it will be a remote one
13313	(if @a machine == @c null).
13314
13315	<result name="VBOX_E_INVALID_VM_STATE">
13316	Session state prevents operation.
13317	</result>
13318	<result name="VBOX_E_INVALID_OBJECT_STATE">
13319	Session type prevents operation.
13320	</result>
13321
13322	</desc>
13323	<param name="machine" type="IMachine" dir="in"/>
13324	</method>
13325
13326	<method name="assignRemoteMachine">
13327	<desc>
13328	Assigns the machine and the (remote) console object associated with
13329	this remote-type session.
13330
13331	<result name="VBOX_E_INVALID_VM_STATE">
13332	Session state prevents operation.
13333	</result>
13334
13335	</desc>
13336	<param name="machine" type="IMachine" dir="in"/>
13337	<param name="console" type="IConsole" dir="in"/>
13338	</method>
13339
13340	<method name="updateMachineState">
13341	<desc>
13342	Updates the machine state in the VM process.
13343	Must be called only in certain cases
13344	(see the method implementation).
13345
13346	<result name="VBOX_E_INVALID_VM_STATE">
13347	Session state prevents operation.
13348	</result>
13349	<result name="VBOX_E_INVALID_OBJECT_STATE">
13350	Session type prevents operation.
13351	</result>
13352
13353	</desc>
13354	<param name="aMachineState" type="MachineState" dir="in"/>
13355	</method>
13356
13357	<method name="uninitialize">
13358	<desc>
13359	Uninitializes (closes) this session. Used by VirtualBox to close
13360	the corresponding remote session when the direct session dies
13361	or gets closed.
13362
13363	<result name="VBOX_E_INVALID_VM_STATE">
13364	Session state prevents operation.
13365	</result>
13366
13367	</desc>
13368	</method>
13369
13370	<method name="onNetworkAdapterChange">
13371	<desc>
13372	Triggered when settings of a network adapter of the
13373	associated virtual machine have changed.
13374
13375	<result name="VBOX_E_INVALID_VM_STATE">
13376	Session state prevents operation.
13377	</result>
13378	<result name="VBOX_E_INVALID_OBJECT_STATE">
13379	Session type prevents operation.
13380	</result>
13381
13382	</desc>
13383	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
13384	<param name="changeAdapter" type="boolean" dir="in"/>
13385	</method>
13386
13387	<method name="onSerialPortChange">
13388	<desc>
13389	Triggered when settings of a serial port of the
13390	associated virtual machine have changed.
13391
13392	<result name="VBOX_E_INVALID_VM_STATE">
13393	Session state prevents operation.
13394	</result>
13395	<result name="VBOX_E_INVALID_OBJECT_STATE">
13396	Session type prevents operation.
13397	</result>
13398
13399	</desc>
13400	<param name="serialPort" type="ISerialPort" dir="in"/>
13401	</method>
13402
13403	<method name="onParallelPortChange">
13404	<desc>
13405	Triggered when settings of a parallel port of the
13406	associated virtual machine have changed.
13407
13408	<result name="VBOX_E_INVALID_VM_STATE">
13409	Session state prevents operation.
13410	</result>
13411	<result name="VBOX_E_INVALID_OBJECT_STATE">
13412	Session type prevents operation.
13413	</result>
13414
13415	</desc>
13416	<param name="parallelPort" type="IParallelPort" dir="in"/>
13417	</method>
13418
13419	<method name="onStorageControllerChange">
13420	<desc>
13421	Triggered when settings of a storage controller of the
13422	associated virtual machine have changed.
13423
13424	<result name="VBOX_E_INVALID_VM_STATE">
13425	Session state prevents operation.
13426	</result>
13427	<result name="VBOX_E_INVALID_OBJECT_STATE">
13428	Session type prevents operation.
13429	</result>
13430
13431	</desc>
13432	</method>
13433
13434	<method name="onMediumChange">
13435	<desc>
13436	Triggered when attached media of the
13437	associated virtual machine have changed.
13438
13439	<result name="VBOX_E_INVALID_VM_STATE">
13440	Session state prevents operation.
13441	</result>
13442	<result name="VBOX_E_INVALID_OBJECT_STATE">
13443	Session type prevents operation.
13444	</result>
13445
13446	</desc>
13447
13448	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
13449	<param name="force" type="boolean" dir="in"/>
13450	</method>
13451
13452	<method name="onCPUChange">
13453	<desc>
13454	Notification when a CPU changes.
13455	</desc>
13456	<param name="cpu" type="unsigned long" dir="in">
13457	<desc>The CPU which changed</desc>
13458	</param>
13459	<param name="add" type="boolean" dir="in">
13460	<desc>Flag whether the CPU was added or removed</desc>
13461	</param>
13462	</method>
13463
13464	<method name="onCPUExecutionCapChange">
13465	<desc>
13466	Notification when the CPU execution cap changes.
13467	</desc>
13468	<param name="executionCap" type="unsigned long" dir="in">
13469	<desc>The new CPU execution cap value. (1-100)</desc>
13470	</param>
13471	</method>
13472
13473	<method name="onVRDEServerChange">
13474	<desc>
13475	Triggered when settings of the VRDE server object of the
13476	associated virtual machine have changed.
13477
13478	<result name="VBOX_E_INVALID_VM_STATE">
13479	Session state prevents operation.
13480	</result>
13481	<result name="VBOX_E_INVALID_OBJECT_STATE">
13482	Session type prevents operation.
13483	</result>
13484
13485	</desc>
13486	<param name="restart" type="boolean" dir="in">
13487	<desc>Flag whether the server must be restarted</desc>
13488	</param>
13489	</method>
13490
13491	<method name="onUSBControllerChange">
13492	<desc>
13493	Triggered when settings of the USB controller object of the
13494	associated virtual machine have changed.
13495
13496	<result name="VBOX_E_INVALID_VM_STATE">
13497	Session state prevents operation.
13498	</result>
13499	<result name="VBOX_E_INVALID_OBJECT_STATE">
13500	Session type prevents operation.
13501	</result>
13502
13503	</desc>
13504	</method>
13505
13506	<method name="onSharedFolderChange">
13507	<desc>
13508	Triggered when a permanent (global or machine) shared folder has been
13509	created or removed.
13510	<note>
13511	We don't pass shared folder parameters in this notification because
13512	the order in which parallel notifications are delivered is not defined,
13513	therefore it could happen that these parameters were outdated by the
13514	time of processing this notification.
13515	</note>
13516
13517	<result name="VBOX_E_INVALID_VM_STATE">
13518	Session state prevents operation.
13519	</result>
13520	<result name="VBOX_E_INVALID_OBJECT_STATE">
13521	Session type prevents operation.
13522	</result>
13523
13524	</desc>
13525	<param name="global" type="boolean" dir="in"/>
13526	</method>
13527
13528	<method name="onUSBDeviceAttach">
13529	<desc>
13530	Triggered when a request to capture a USB device (as a result
13531	of matched USB filters or direct call to
13532	<link to="IConsole::attachUSBDevice"/>) has completed.
13533	A @c null @a error object means success, otherwise it
13534	describes a failure.
13535
13536	<result name="VBOX_E_INVALID_VM_STATE">
13537	Session state prevents operation.
13538	</result>
13539	<result name="VBOX_E_INVALID_OBJECT_STATE">
13540	Session type prevents operation.
13541	</result>
13542
13543	</desc>
13544	<param name="device" type="IUSBDevice" dir="in"/>
13545	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13546	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
13547	</method>
13548
13549	<method name="onUSBDeviceDetach">
13550	<desc>
13551	Triggered when a request to release the USB device (as a result
13552	of machine termination or direct call to
13553	<link to="IConsole::detachUSBDevice"/>) has completed.
13554	A @c null @a error object means success, otherwise it
13555	describes a failure.
13556
13557	<result name="VBOX_E_INVALID_VM_STATE">
13558	Session state prevents operation.
13559	</result>
13560	<result name="VBOX_E_INVALID_OBJECT_STATE">
13561	Session type prevents operation.
13562	</result>
13563
13564	</desc>
13565	<param name="id" type="uuid" mod="string" dir="in"/>
13566	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13567	</method>
13568
13569	<method name="onShowWindow">
13570	<desc>
13571	Called by <link to="IMachine::canShowConsoleWindow"/> and by
13572	<link to="IMachine::showConsoleWindow"/> in order to notify
13573	console listeners
13574	<link to="ICanShowWindowEvent"/>
13575	and <link to="IShowWindowEvent"/>.
13576
13577	<result name="VBOX_E_INVALID_OBJECT_STATE">
13578	Session type prevents operation.
13579	</result>
13580
13581	</desc>
13582	<param name="check" type="boolean" dir="in"/>
13583	<param name="canShow" type="boolean" dir="out"/>
13584	<param name="winId" type="long long" dir="out"/>
13585	</method>
13586
13587	<method name="onBandwidthGroupChange">
13588	<desc>
13589	Notification when one of the bandwidth groups change.
13590	</desc>
13591	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
13592	<desc>The bandwidth group which changed.</desc>
13593	</param>
13594	</method>
13595
13596	<method name="accessGuestProperty">
13597	<desc>
13598	Called by <link to="IMachine::getGuestProperty"/> and by
13599	<link to="IMachine::setGuestProperty"/> in order to read and
13600	modify guest properties.
13601
13602	<result name="VBOX_E_INVALID_VM_STATE">
13603	Machine session is not open.
13604	</result>
13605	<result name="VBOX_E_INVALID_OBJECT_STATE">
13606	Session type is not direct.
13607	</result>
13608
13609	</desc>
13610	<param name="name" type="wstring" dir="in"/>
13611	<param name="value" type="wstring" dir="in"/>
13612	<param name="flags" type="wstring" dir="in"/>
13613	<param name="isSetter" type="boolean" dir="in"/>
13614	<param name="retValue" type="wstring" dir="out"/>
13615	<param name="retTimestamp" type="long long" dir="out"/>
13616	<param name="retFlags" type="wstring" dir="out"/>
13617	</method>
13618
13619	<method name="enumerateGuestProperties">
13620	<desc>
13621	Return a list of the guest properties matching a set of patterns along
13622	with their values, time stamps and flags.
13623
13624	<result name="VBOX_E_INVALID_VM_STATE">
13625	Machine session is not open.
13626	</result>
13627	<result name="VBOX_E_INVALID_OBJECT_STATE">
13628	Session type is not direct.
13629	</result>
13630
13631	</desc>
13632	<param name="patterns" type="wstring" dir="in">
13633	<desc>
13634	The patterns to match the properties against as a comma-separated
13635	string. If this is empty, all properties currently set will be
13636	returned.
13637	</desc>
13638	</param>
13639	<param name="key" type="wstring" dir="out" safearray="yes">
13640	<desc>
13641	The key names of the properties returned.
13642	</desc>
13643	</param>
13644	<param name="value" type="wstring" dir="out" safearray="yes">
13645	<desc>
13646	The values of the properties returned. The array entries match the
13647	corresponding entries in the @a key array.
13648	</desc>
13649	</param>
13650	<param name="timestamp" type="long long" dir="out" safearray="yes">
13651	<desc>
13652	The time stamps of the properties returned. The array entries match
13653	the corresponding entries in the @a key array.
13654	</desc>
13655	</param>
13656	<param name="flags" type="wstring" dir="out" safearray="yes">
13657	<desc>
13658	The flags of the properties returned. The array entries match the
13659	corresponding entries in the @a key array.
13660	</desc>
13661	</param>
13662	</method>
13663
13664	<method name="onlineMergeMedium">
13665	<desc>
13666	Triggers online merging of a hard disk. Used internally when deleting
13667	a snapshot while a VM referring to the same hard disk chain is running.
13668
13669	<result name="VBOX_E_INVALID_VM_STATE">
13670	Machine session is not open.
13671	</result>
13672	<result name="VBOX_E_INVALID_OBJECT_STATE">
13673	Session type is not direct.
13674	</result>
13675
13676	</desc>
13677	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
13678	<desc>The medium attachment to identify the medium chain.</desc>
13679	</param>
13680	<param name="sourceIdx" type="unsigned long" dir="in">
13681	<desc>The index of the source image in the chain.
13682	Redundant, but drastically reduces IPC.</desc>
13683	</param>
13684	<param name="targetIdx" type="unsigned long" dir="in">
13685	<desc>The index of the target image in the chain.
13686	Redundant, but drastically reduces IPC.</desc>
13687	</param>
13688	<param name="source" type="IMedium" dir="in">
13689	<desc>Merge source medium.</desc>
13690	</param>
13691	<param name="target" type="IMedium" dir="in">
13692	<desc>Merge target medium.</desc>
13693	</param>
13694	<param name="mergeForward" type="boolean" dir="in">
13695	<desc>Merge direction.</desc>
13696	</param>
13697	<param name="parentForTarget" type="IMedium" dir="in">
13698	<desc>For forward merges: new parent for target medium.</desc>
13699	</param>
13700	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
13701	<desc>For backward merges: list of media which need their parent UUID
13702	updated.</desc>
13703	</param>
13704	<param name="progress" type="IProgress" dir="in">
13705	<desc>
13706	Progress object for this operation.
13707	</desc>
13708	</param>
13709	</method>
13710
13711	</interface>
13712
13713	<interface
13714	name="ISession" extends="$unknown"
13715	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
13716	wsmap="managed"
13717	>
13718	<desc>
13719	The ISession interface represents a client process and allows for locking
13720	virtual machines (represented by IMachine objects) to prevent conflicting
13721	changes to the machine.
13722
13723	Any caller wishing to manipulate a virtual machine needs to create a session
13724	object first, which lives in its own process space. Such session objects are
13725	then associated with <link to="IMachine" /> objects living in the VirtualBox
13726	server process to coordinate such changes.
13727
13728	There are two typical scenarios in which sessions are used:
13729
13730	<ul>
13731	<li>To alter machine settings or control a running virtual machine, one
13732	needs to lock a machine for a given session (client process) by calling
13733	<link to="IMachine::lockMachine"/>.
13734
13735	Whereas multiple sessions may control a running virtual machine, only
13736	one process can obtain a write lock on the machine to prevent conflicting
13737	changes. A write lock is also needed if a process wants to actually run a
13738	virtual machine in its own context, such as the VirtualBox GUI or
13739	VBoxHeadless front-ends. They must also lock a machine for their own
13740	sessions before they are allowed to power up the virtual machine.
13741
13742	As a result, no machine settings can be altered while another process is
13743	already using it, either because that process is modifying machine settings
13744	or because the machine is running.
13745	</li>
13746	<li>
13747	To start a VM using one of the existing VirtualBox front-ends (e.g. the
13748	VirtualBox GUI or VBoxHeadless), one would use
13749	<link to="IMachine::launchVMProcess"/>, which also takes a session object
13750	as its first parameter. This session then identifies the caller and lets the
13751	caller control the started machine (for example, pause machine execution or
13752	power it down) as well as be notified about machine execution state changes.
13753	</li>
13754	</ul>
13755
13756	How sessions objects are created in a client process depends on whether you use
13757	the Main API via COM or via the webservice:
13758
13759	<ul>
13760	<li>When using the COM API directly, an object of the Session class from the
13761	VirtualBox type library needs to be created. In regular COM C++ client code,
13762	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
13763	This object will then act as a local session object in further calls to open
13764	a session.
13765	</li>
13766
13767	<li>In the webservice, the session manager (IWebsessionManager) instead creates
13768	a session object automatically whenever <link to="IWebsessionManager::logon" />
13769	is called. A managed object reference to that session object can be retrieved by
13770	calling <link to="IWebsessionManager::getSessionObject" />.
13771	</li>
13772	</ul>
13773	</desc>
13774
13775	<attribute name="state" type="SessionState" readonly="yes">
13776	<desc>Current state of this session.</desc>
13777	</attribute>
13778
13779	<attribute name="type" type="SessionType" readonly="yes">
13780	<desc>
13781	Type of this session. The value of this attribute is valid only
13782	if the session currently has a machine locked (i.e. its
13783	<link to="#state" /> is Locked), otherwise an error will be returned.
13784	</desc>
13785	</attribute>
13786
13787	<attribute name="machine" type="IMachine" readonly="yes">
13788	<desc>Machine object associated with this session.</desc>
13789	</attribute>
13790
13791	<attribute name="console" type="IConsole" readonly="yes">
13792	<desc>Console object associated with this session.</desc>
13793	</attribute>
13794
13795	<method name="unlockMachine">
13796	<desc>
13797	Unlocks a machine that was previously locked for the current session.
13798
13799	Calling this method is required every time a machine has been locked
13800	for a particular session using the <link to="IMachine::launchVMProcess" />
13801	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
13802	the machine will be set to <link to="MachineState_Aborted" /> on the
13803	server, and changes made to the machine settings will be lost.
13804
13805	Generally, it is recommended to unlock all machines explicitly
13806	before terminating the application (regardless of the reason for
13807	the termination).
13808
13809	<note>
13810	Do not expect the session state (<link to="ISession::state" />
13811	to return to "Unlocked" immediately after you invoke this method,
13812	particularly if you have started a new VM process. The session
13813	state will automatically return to "Unlocked" once the VM is no
13814	longer executing, which can of course take a very long time.
13815	</note>
13816
13817	<result name="E_UNEXPECTED">
13818	Session is not locked.
13819	</result>
13820
13821	</desc>
13822	</method>
13823
13824	</interface>
13825
13826	<!--
13827	// IStorageController
13828	/////////////////////////////////////////////////////////////////////////
13829	-->
13830
13831	<enum
13832	name="StorageBus"
13833	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
13834	>
13835	<desc>
13836	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
13837	see <link to="IStorageController::bus" />.
13838	</desc>
13839	<const name="Null" value="0">
13840	<desc>@c null value. Never used by the API.</desc>
13841	</const>
13842	<const name="IDE" value="1"/>
13843	<const name="SATA" value="2"/>
13844	<const name="SCSI" value="3"/>
13845	<const name="Floppy" value="4"/>
13846	<const name="SAS" value="5"/>
13847	</enum>
13848
13849	<enum
13850	name="StorageControllerType"
13851	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13852	>
13853	<desc>
13854	The exact variant of storage controller hardware presented
13855	to the guest; see <link to="IStorageController::controllerType" />.
13856	</desc>
13857
13858	<const name="Null" value="0">
13859	<desc>@c null value. Never used by the API.</desc>
13860	</const>
13861	<const name="LsiLogic" value="1">
13862	<desc>A SCSI controller of the LsiLogic variant.</desc>
13863	</const>
13864	<const name="BusLogic" value="2">
13865	<desc>A SCSI controller of the BusLogic variant.</desc>
13866	</const>
13867	<const name="IntelAhci" value="3">
13868	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13869	</const>
13870	<const name="PIIX3" value="4">
13871	<desc>An IDE controller of the PIIX3 variant.</desc>
13872	</const>
13873	<const name="PIIX4" value="5">
13874	<desc>An IDE controller of the PIIX4 variant.</desc>
13875	</const>
13876	<const name="ICH6" value="6">
13877	<desc>An IDE controller of the ICH6 variant.</desc>
13878	</const>
13879	<const name="I82078" value="7">
13880	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
13881	</const>
13882	<const name="LsiLogicSas" value="8">
13883	<desc>A variant of the LsiLogic controller using SAS.</desc>
13884	</const>
13885	</enum>
13886
13887	<enum
13888	name="ChipsetType"
13889	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
13890	>
13891	<desc>
13892	Type of emulated chipset (mostly southbridge).
13893	</desc>
13894
13895	<const name="Null" value="0">
13896	<desc>@c null value. Never used by the API.</desc>
13897	</const>
13898	<const name="PIIX3" value="1">
13899	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
13900	</const>
13901	<const name="ICH9" value="2">
13902	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
13903	</const>
13904	</enum>
13905
13906	<interface
13907	name="IStorageController" extends="$unknown"
13908	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
13909	wsmap="managed"
13910	>
13911	<desc>
13912	Represents a storage controller that is attached to a virtual machine
13913	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
13914	attached to storage controllers in a real computer, virtual drives
13915	(represented by <link to="IMediumAttachment" />) are attached to virtual
13916	storage controllers, represented by this interface.
13917
13918	As opposed to physical hardware, VirtualBox has a very generic concept
13919	of a storage controller, and for purposes of the Main API, all virtual
13920	storage is attached to virtual machines via instances of this interface.
13921	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
13922	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
13923	is used, certain sub-types may be available and can be selected in
13924	<link to="#controllerType" />.
13925
13926	Depending on these settings, the guest operating system might see
13927	significantly different virtual hardware.
13928	</desc>
13929
13930	<attribute name="name" type="wstring" readonly="yes">
13931	<desc>
13932	Name of the storage controller, as originally specified with
13933	<link to="IMachine::addStorageController" />. This then uniquely
13934	identifies this controller with other method calls such as
13935	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
13936	</desc>
13937	</attribute>
13938
13939	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
13940	<desc>
13941	Maximum number of devices which can be attached to one port.
13942	</desc>
13943	</attribute>
13944
13945	<attribute name="minPortCount" type="unsigned long" readonly="yes">
13946	<desc>
13947	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
13948	</desc>
13949	</attribute>
13950
13951	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
13952	<desc>
13953	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
13954	</desc>
13955	</attribute>
13956
13957	<attribute name="instance" type="unsigned long">
13958	<desc>
13959	The instance number of the device in the running VM.
13960	</desc>
13961	</attribute>
13962
13963	<attribute name="portCount" type="unsigned long">
13964	<desc>
13965	The number of currently usable ports on the controller.
13966	The minimum and maximum number of ports for one controller are
13967	stored in <link to="IStorageController::minPortCount"/>
13968	and <link to="IStorageController::maxPortCount"/>.
13969	</desc>
13970	</attribute>
13971
13972	<attribute name="bus" type="StorageBus" readonly="yes">
13973	<desc>
13974	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
13975	</desc>
13976	</attribute>
13977
13978	<attribute name="controllerType" type="StorageControllerType">
13979	<desc>
13980	The exact variant of storage controller hardware presented
13981	to the guest.
13982	Depending on this value, VirtualBox will provide a different
13983	virtual storage controller hardware to the guest.
13984	For SATA, SAS and floppy controllers, only one variant is
13985	available, but for IDE and SCSI, there are several.
13986
13987	For SCSI controllers, the default type is LsiLogic.
13988	</desc>
13989	</attribute>
13990
13991	<attribute name="useHostIOCache" type="boolean">
13992	<desc>
13993	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
13994	caches and use synchronous file APIs on the host. This was the only option in the API before
13995	VirtualBox 3.2 and is still the default for IDE controllers.
13996
13997	If false, the host I/O cache will be disabled for image files attached to this storage controller.
13998	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
13999	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
14000	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
14001	virtual machines are running at the same time to prevent I/O cache related hangs.
14002	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
14003	</desc>
14004	</attribute>
14005
14006	<attribute name="bootable" type="boolean" readonly="yes">
14007	<desc>
14008	Returns whether it is possible to boot from disks attached to this controller.
14009	</desc>
14010	</attribute>
14011
14012	<method name="getIDEEmulationPort">
14013	<desc>
14014	Gets the corresponding port number which is emulated as an IDE device.
14015	Works only with SATA controllers.
14016
14017	<result name="E_INVALIDARG">
14018	The @a devicePosition is not in the range 0 to 3.
14019	</result>
14020	<result name="E_NOTIMPL">
14021	The storage controller type is not SATAIntelAhci.
14022	</result>
14023
14024	</desc>
14025	<param name="devicePosition" type="long" dir="in"/>
14026	<param name="portNumber" type="long" dir="return"/>
14027	</method>
14028
14029	<method name="setIDEEmulationPort">
14030	<desc>
14031	Sets the port number which is emulated as an IDE device.
14032	Works only with SATA controllers.
14033
14034	<result name="E_INVALIDARG">
14035	The @a devicePosition is not in the range 0 to 3 or the
14036	@a portNumber is not in the range 0 to 29.
14037	</result>
14038	<result name="E_NOTIMPL">
14039	The storage controller type is not SATAIntelAhci.
14040	</result>
14041
14042	</desc>
14043	<param name="devicePosition" type="long" dir="in"/>
14044	<param name="portNumber" type="long" dir="in"/>
14045	</method>
14046
14047	</interface>
14048
14049	<if target="wsdl">
14050
14051	<!--
14052	// IManagedObjectRef
14053	/////////////////////////////////////////////////////////////////////////
14054	-->
14055
14056	<interface
14057	name="IManagedObjectRef" extends="$unknown"
14058	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
14059	internal="yes"
14060	wsmap="managed"
14061	wscpp="hardcoded"
14062	>
14063	<desc>
14064	Managed object reference.
14065
14066	Only within the webservice, a managed object reference (which is really
14067	an opaque number) allows a webservice client to address an object
14068	that lives in the address space of the webservice server.
14069
14070	Behind each managed object reference, there is a COM object that lives
14071	in the webservice server's address space. The COM object is not freed
14072	until the managed object reference is released, either by an explicit
14073	call to <link to="IManagedObjectRef::release" /> or by logging off from
14074	the webservice (<link to="IWebsessionManager::logoff" />), which releases
14075	all objects created during the webservice session.
14076
14077	Whenever a method call of the VirtualBox API returns a COM object, the
14078	webservice representation of that method will instead return a
14079	managed object reference, which can then be used to invoke methods
14080	on that object.
14081	</desc>
14082
14083	<method name="getInterfaceName">
14084	<desc>
14085	Returns the name of the interface that this managed object represents,
14086	for example, "IMachine", as a string.
14087	</desc>
14088	<param name="return" type="wstring" dir="return"/>
14089	</method>
14090
14091	<method name="release">
14092	<desc>
14093	Releases this managed object reference and frees the resources that
14094	were allocated for it in the webservice server process. After calling
14095	this method, the identifier of the reference can no longer be used.
14096	</desc>
14097	</method>
14098
14099	</interface>
14100
14101	<!--
14102	// IWebsessionManager
14103	/////////////////////////////////////////////////////////////////////////
14104	-->
14105
14106	<interface
14107	name="IWebsessionManager" extends="$unknown"
14108	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
14109	internal="yes"
14110	wsmap="global"
14111	wscpp="hardcoded"
14112	>
14113	<desc>
14114	Websession manager. This provides essential services
14115	to webservice clients.
14116	</desc>
14117	<method name="logon">
14118	<desc>
14119	Logs a new client onto the webservice and returns a managed object reference to
14120	the IVirtualBox instance, which the client can then use as a basis to further
14121	queries, since all calls to the VirtualBox API are based on the IVirtualBox
14122	interface, in one way or the other.
14123	</desc>
14124	<param name="username" type="wstring" dir="in"/>
14125	<param name="password" type="wstring" dir="in"/>
14126	<param name="return" type="IVirtualBox" dir="return"/>
14127	</method>
14128
14129	<method name="getSessionObject">
14130	<desc>
14131	Returns a managed object reference to the internal ISession object that was created
14132	for this web service session when the client logged on.
14133
14134	<see>ISession</see>
14135	</desc>
14136	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
14137	<param name="return" type="ISession" dir="return"/>
14138	</method>
14139
14140	<method name="logoff">
14141	<desc>
14142	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
14143	and destroys all resources associated with the session (most importantly, all
14144	managed objects created in the server while the session was active).
14145	</desc>
14146	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
14147	</method>
14148
14149	</interface>
14150
14151	</if>
14152
14153	<!--
14154	// IPerformanceCollector & friends
14155	/////////////////////////////////////////////////////////////////////////
14156	-->
14157
14158	<interface
14159	name="IPerformanceMetric" extends="$unknown"
14160	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
14161	>
14162	<desc>
14163	The IPerformanceMetric interface represents parameters of the given
14164	performance metric.
14165	</desc>
14166
14167	<attribute name="metricName" type="wstring" readonly="yes">
14168	<desc>
14169	Name of the metric.
14170	</desc>
14171	</attribute>
14172
14173	<attribute name="object" type="$unknown" readonly="yes">
14174	<desc>
14175	Object this metric belongs to.
14176	</desc>
14177	</attribute>
14178
14179	<attribute name="description" type="wstring" readonly="yes">
14180	<desc>
14181	Textual description of the metric.
14182	</desc>
14183	</attribute>
14184
14185	<attribute name="period" type="unsigned long" readonly="yes">
14186	<desc>
14187	Time interval between samples, measured in seconds.
14188	</desc>
14189	</attribute>
14190
14191	<attribute name="count" type="unsigned long" readonly="yes">
14192	<desc>
14193	Number of recent samples retained by the performance collector for this
14194	metric.
14195
14196	When the collected sample count exceeds this number, older samples
14197	are discarded.
14198	</desc>
14199	</attribute>
14200
14201	<attribute name="unit" type="wstring" readonly="yes">
14202	<desc>
14203	Unit of measurement.
14204	</desc>
14205	</attribute>
14206
14207	<attribute name="minimumValue" type="long" readonly="yes">
14208	<desc>
14209	Minimum possible value of this metric.
14210	</desc>
14211	</attribute>
14212
14213	<attribute name="maximumValue" type="long" readonly="yes">
14214	<desc>
14215	Maximum possible value of this metric.
14216	</desc>
14217	</attribute>
14218	</interface>
14219
14220	<interface
14221	name="IPerformanceCollector" extends="$unknown"
14222	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
14223	wsmap="managed"
14224	>
14225	<desc>
14226	The IPerformanceCollector interface represents a service that collects
14227	and stores performance metrics data.
14228
14229	Performance metrics are associated with objects of interfaces like IHost
14230	and IMachine. Each object has a distinct set of performance metrics. The
14231	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
14232
14233	Metric data is collected at the specified intervals and is retained
14234	internally. The interval and the number of retained samples can be set
14235	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
14236	and collection settings are not persistent, they are discarded as soon as
14237	VBoxSVC process terminates. Moreover, metric settings and data associated
14238	with a particular VM only exist while VM is running. They disappear as
14239	soon as VM shuts down. It is not possible to set up metrics for machines
14240	that are powered off. One needs to start VM first, then set up metric
14241	collection parameters.
14242
14243	Metrics are organized hierarchically, with each level separated by a
14244	slash (/) character. Generally, the scheme for metric names is like this:
14245
14246	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
14247
14248	"Category/Metric" together form the base metric name. A base metric is
14249	the smallest unit for which a sampling interval and the number of
14250	retained samples can be set. Only base metrics can be enabled and
14251	disabled. All sub-metrics are collected when their base metric is
14252	collected. Collected values for any set of sub-metrics can be queried
14253	with <link to="IPerformanceCollector::queryMetricsData" />.
14254
14255	For example "CPU/Load/User:avg" metric name stands for the "CPU"
14256	category, "Load" metric, "User" submetric, "average" aggregate. An
14257	aggregate function is computed over all retained data. Valid aggregate
14258	functions are:
14259
14260	<ul>
14261	<li>avg -- average</li>
14262	<li>min -- minimum</li>
14263	<li>max -- maximum</li>
14264	</ul>
14265
14266	When setting up metric parameters, querying metric data, enabling or
14267	disabling metrics wildcards can be used in metric names to specify a
14268	subset of metrics. For example, to select all CPU-related metrics
14269	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
14270	so on. To query metric values without aggregates <tt>*:</tt> can be used.
14271
14272	The valid names for base metrics are:
14273
14274	<ul>
14275	<li>CPU/Load</li>
14276	<li>CPU/MHz</li>
14277	<li>RAM/Usage</li>
14278	</ul>
14279
14280	The general sequence for collecting and retrieving the metrics is:
14281	<ul>
14282	<li>
14283	Obtain an instance of IPerformanceCollector with
14284	<link to="IVirtualBox::performanceCollector" />
14285	</li>
14286	<li>
14287	Allocate and populate an array with references to objects the metrics
14288	will be collected for. Use references to IHost and IMachine objects.
14289	</li>
14290	<li>
14291	Allocate and populate an array with base metric names the data will
14292	be collected for.
14293	</li>
14294	<li>
14295	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
14296	the metric data will be collected and stored.
14297	</li>
14298	<li>
14299	Wait for the data to get collected.
14300	</li>
14301	<li>
14302	Allocate and populate an array with references to objects the metric
14303	values will be queried for. You can re-use the object array used for
14304	setting base metrics.
14305	</li>
14306	<li>
14307	Allocate and populate an array with metric names the data will be
14308	collected for. Note that metric names differ from base metric names.
14309	</li>
14310	<li>
14311	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
14312	that have been collected so far are returned. Note that the values
14313	are still retained internally and data collection continues.
14314	</li>
14315	</ul>
14316
14317	For an example of usage refer to the following files in VirtualBox SDK:
14318	<ul>
14319	<li>
14320	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
14321	</li>
14322	<li>
14323	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
14324	</li>
14325	</ul>
14326	</desc>
14327
14328	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
14329	<desc>
14330	Array of unique names of metrics.
14331
14332	This array represents all metrics supported by the performance
14333	collector. Individual objects do not necessarily support all of them.
14334	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
14335	list of supported metrics for a particular object.
14336	</desc>
14337	</attribute>
14338
14339	<method name="getMetrics">
14340	<desc>
14341	Returns parameters of specified metrics for a set of objects.
14342	<note>
14343	@c Null metrics array means all metrics. @c Null object array means
14344	all existing objects.
14345	</note>
14346	</desc>
14347	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14348	<desc>
14349	Metric name filter. Currently, only a comma-separated list of metrics
14350	is supported.
14351	</desc>
14352	</param>
14353	<param name="objects" type="$unknown" dir="in" safearray="yes">
14354	<desc>
14355	Set of objects to return metric parameters for.
14356	</desc>
14357	</param>
14358	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
14359	<desc>
14360	Array of returned metric parameters.
14361	</desc>
14362	</param>
14363	</method>
14364
14365	<method name="setupMetrics">
14366	<desc>
14367	Sets parameters of specified base metrics for a set of objects. Returns
14368	an array of <link to="IPerformanceMetric" /> describing the metrics
14369	have been affected.
14370	<note>
14371	@c Null or empty metric name array means all metrics. @c Null or
14372	empty object array means all existing objects. If metric name array
14373	contains a single element and object array contains many, the single
14374	metric name array element is applied to each object array element to
14375	form metric/object pairs.
14376	</note>
14377	</desc>
14378	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14379	<desc>
14380	Metric name filter. Comma-separated list of metrics with wildcard
14381	support.
14382	</desc>
14383	</param>
14384	<param name="objects" type="$unknown" dir="in" safearray="yes">
14385	<desc>
14386	Set of objects to setup metric parameters for.
14387	</desc>
14388	</param>
14389	<param name="period" type="unsigned long" dir="in">
14390	<desc>
14391	Time interval in seconds between two consecutive samples of
14392	performance data.
14393	</desc>
14394	</param>
14395	<param name="count" type="unsigned long" dir="in">
14396	<desc>
14397	Number of samples to retain in performance data history. Older
14398	samples get discarded.
14399	</desc>
14400	</param>
14401	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14402	<desc>
14403	Array of metrics that have been modified by the call to this method.
14404	</desc>
14405	</param>
14406	</method>
14407
14408	<method name="enableMetrics">
14409	<desc>
14410	Turns on collecting specified base metrics. Returns an array of
14411	<link to="IPerformanceMetric" /> describing the metrics have been
14412	affected.
14413	<note>
14414	@c Null or empty metric name array means all metrics. @c Null or
14415	empty object array means all existing objects. If metric name array
14416	contains a single element and object array contains many, the single
14417	metric name array element is applied to each object array element to
14418	form metric/object pairs.
14419	</note>
14420	</desc>
14421	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14422	<desc>
14423	Metric name filter. Comma-separated list of metrics with wildcard
14424	support.
14425	</desc>
14426	</param>
14427	<param name="objects" type="$unknown" dir="in" safearray="yes">
14428	<desc>
14429	Set of objects to enable metrics for.
14430	</desc>
14431	</param>
14432	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14433	<desc>
14434	Array of metrics that have been modified by the call to this method.
14435	</desc>
14436	</param>
14437	</method>
14438
14439	<method name="disableMetrics">
14440	<desc>
14441	Turns off collecting specified base metrics. Returns an array of
14442	<link to="IPerformanceMetric" /> describing the metrics have been
14443	affected.
14444	<note>
14445	@c Null or empty metric name array means all metrics. @c Null or
14446	empty object array means all existing objects. If metric name array
14447	contains a single element and object array contains many, the single
14448	metric name array element is applied to each object array element to
14449	form metric/object pairs.
14450	</note>
14451	</desc>
14452	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14453	<desc>
14454	Metric name filter. Comma-separated list of metrics with wildcard
14455	support.
14456	</desc>
14457	</param>
14458	<param name="objects" type="$unknown" dir="in" safearray="yes">
14459	<desc>
14460	Set of objects to disable metrics for.
14461	</desc>
14462	</param>
14463	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14464	<desc>
14465	Array of metrics that have been modified by the call to this method.
14466	</desc>
14467	</param>
14468	</method>
14469
14470	<method name="queryMetricsData">
14471	<desc>
14472	Queries collected metrics data for a set of objects.
14473
14474	The data itself and related metric information are returned in seven
14475	parallel and one flattened array of arrays. Elements of
14476	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
14477	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
14478	the same index describe one set of values corresponding to a single
14479	metric.
14480
14481	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
14482	start and length of a sub-array is indicated by
14483	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
14484	value for metric <tt>metricNames[i]</tt> is at
14485	<tt>returnData[returnIndices[i]]</tt>.
14486
14487	<note>
14488	@c Null or empty metric name array means all metrics. @c Null or
14489	empty object array means all existing objects. If metric name array
14490	contains a single element and object array contains many, the single
14491	metric name array element is applied to each object array element to
14492	form metric/object pairs.
14493	</note>
14494	<note>
14495	Data collection continues behind the scenes after call to @c
14496	queryMetricsData. The return data can be seen as the snapshot of the
14497	current state at the time of @c queryMetricsData call. The internally
14498	kept metric values are not cleared by the call. This makes possible
14499	querying different subsets of metrics or aggregates with subsequent
14500	calls. If periodic querying is needed it is highly suggested to query
14501	the values with @c interval*count period to avoid confusion. This way
14502	a completely new set of data values will be provided by each query.
14503	</note>
14504	</desc>
14505	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14506	<desc>
14507	Metric name filter. Comma-separated list of metrics with wildcard
14508	support.
14509	</desc>
14510	</param>
14511	<param name="objects" type="$unknown" dir="in" safearray="yes">
14512	<desc>
14513	Set of objects to query metrics for.
14514	</desc>
14515	</param>
14516	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
14517	<desc>
14518	Names of metrics returned in @c returnData.
14519	</desc>
14520	</param>
14521	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
14522	<desc>
14523	Objects associated with metrics returned in @c returnData.
14524	</desc>
14525	</param>
14526	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
14527	<desc>
14528	Units of measurement for each returned metric.
14529	</desc>
14530	</param>
14531	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
14532	<desc>
14533	Divisor that should be applied to return values in order to get
14534	floating point values. For example:
14535	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
14536	will retrieve the floating point value of i-th sample of the first
14537	metric.
14538	</desc>
14539	</param>
14540	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
14541	<desc>
14542	Sequence numbers of the first elements of value sequences of
14543	particular metrics returned in @c returnData. For aggregate metrics
14544	it is the sequence number of the sample the aggregate started
14545	calculation from.
14546	</desc>
14547	</param>
14548	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
14549	<desc>
14550	Indices of the first elements of value sequences of particular
14551	metrics returned in @c returnData.
14552	</desc>
14553	</param>
14554	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
14555	<desc>
14556	Lengths of value sequences of particular metrics.
14557	</desc>
14558	</param>
14559	<param name="returnData" type="long" dir="return" safearray="yes">
14560	<desc>
14561	Flattened array of all metric data containing sequences of values for
14562	each metric.
14563	</desc>
14564	</param>
14565	</method>
14566
14567	</interface>
14568
14569	<enum
14570	name="NATAliasMode"
14571	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
14572	>
14573	<desc></desc>
14574	<const name="AliasLog" value="0x1">
14575	<desc></desc>
14576	</const>
14577	<const name="AliasProxyOnly" value="0x02">
14578	<desc></desc>
14579	</const>
14580	<const name="AliasUseSamePorts" value="0x04">
14581	<desc></desc>
14582	</const>
14583	</enum>
14584
14585	<enum
14586	name="NATProtocol"
14587	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
14588	>
14589	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
14590	<const name="UDP" value="0">
14591	<desc>Port-forwarding uses UDP protocol.</desc>
14592	</const>
14593	<const name="TCP" value="1">
14594	<desc>Port-forwarding uses TCP protocol.</desc>
14595	</const>
14596	</enum>
14597
14598	<interface
14599	name="INATEngine" extends="$unknown"
14600	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
14601	wsmap="managed"
14602	>
14603	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
14604	allows for changing NAT behavior such as port-forwarding rules. This interface is
14605	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
14606	<attribute name="network" type="wstring">
14607	<desc>The network attribute of the NAT engine (the same value is used with built-in
14608	DHCP server to fill corresponding fields of DHCP leases).</desc>
14609	</attribute>
14610	<attribute name="hostIP" type="wstring">
14611	<desc>IP of host interface to bind all opened sockets to.
14612	<note>Changing this does not change binding of port forwarding.</note>
14613	</desc>
14614	</attribute>
14615	<attribute name="tftpPrefix" type="wstring">
14616	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
14617	the corresponding fields of DHCP leases.</desc>
14618	</attribute>
14619	<attribute name="tftpBootFile" type="wstring">
14620	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
14621	the corresponding fields of DHCP leases.</desc>
14622	</attribute>
14623	<attribute name="tftpNextServer" type="wstring">
14624	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
14625	the corresponding fields of DHCP leases.
14626	<note>The preferred form is IPv4 addresses.</note>
14627	</desc>
14628	</attribute>
14629	<attribute name="aliasMode" type="unsigned long">
14630	<desc></desc>
14631	</attribute>
14632	<attribute name="dnsPassDomain" type="boolean">
14633	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
14634	</attribute>
14635	<attribute name="dnsProxy" type="boolean">
14636	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14637	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
14638	</attribute>
14639	<attribute name="dnsUseHostResolver" type="boolean">
14640	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14641	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
14642	</attribute>
14643	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
14644	<desc>Array of NAT port-forwarding rules in string representation, in the following
14645	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
14646	</attribute>
14647	<method name="setNetworkSettings">
14648	<desc>Sets network configuration of the NAT engine.</desc>
14649	<param name="mtu" type="unsigned long" dir="in">
14650	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
14651	</param>
14652	<param name="sockSnd" type="unsigned long" dir="in">
14653	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
14654	</param>
14655	<param name="sockRcv" type="unsigned long" dir="in">
14656	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
14657	</param>
14658	<param name="TcpWndSnd" type="unsigned long" dir="in">
14659	<desc>Initial size of the NAT engine's sending TCP window in bytes when
14660	establishing a new TCP connection.</desc>
14661	</param>
14662	<param name="TcpWndRcv" type="unsigned long" dir="in">
14663	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
14664	establishing a new TCP connection.</desc>
14665	</param>
14666	</method>
14667	<method name="getNetworkSettings">
14668	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
14669	for parameter descriptions.</desc>
14670	<param name="mtu" type="unsigned long" dir="out" />
14671	<param name="sockSnd" type="unsigned long" dir="out" />
14672	<param name="sockRcv" type="unsigned long" dir="out" />
14673	<param name="TcpWndSnd" type="unsigned long" dir="out" />
14674	<param name="TcpWndRcv" type="unsigned long" dir="out" />
14675	</method>
14676	<method name="addRedirect">
14677	<desc>Adds a new NAT port-forwarding rule.</desc>
14678	<param name="name" type="wstring" dir="in">
14679	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
14680	auto-generates one using the other parameters.</desc>
14681	</param>
14682	<param name="proto" type="NATProtocol" dir="in">
14683	<desc>Protocol handled with the rule.</desc>
14684	</param>
14685	<param name="hostIp" type="wstring" dir="in">
14686	<desc>IP of the host interface to which the rule should apply. An empty ip address is
14687	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
14688	</param>
14689	<param name="hostPort" type="unsigned short" dir="in">
14690	<desc>The port number to listen on.</desc>
14691	</param>
14692	<param name="guestIp" type="wstring" dir="in">
14693	<desc>The IP address of the guest which the NAT engine will forward matching packets
14694	to. An empty IP address is acceptable, in which case the NAT engine will forward
14695	packets to the first DHCP lease (x.x.x.15).</desc>
14696	</param>
14697	<param name="guestPort" type="unsigned short" dir="in">
14698	<desc>The port number to forward.</desc>
14699	</param>
14700	</method>
14701	<method name="removeRedirect">
14702	<desc>Removes a port-forwarding rule that was previously registered.</desc>
14703	<param name="name" type="wstring" dir="in">
14704	<desc>The name of the rule to delete.</desc>
14705	</param>
14706	</method>
14707	</interface>
14708
14709	<!--
14710	// IExtPackManager
14711	/////////////////////////////////////////////////////////////////////////
14712	-->
14713
14714	<interface
14715	name="IExtPackPlugIn" extends="$unknown"
14716	uuid="58000040-e718-4746-bbce-4b86d96da461"
14717	wsmap="suppress"
14718	>
14719	<desc>
14720	Interface for keeping information about a plug-in that ships with an
14721	extension pack.
14722	</desc>
14723	<attribute name="name" type="wstring" readonly="yes">
14724	<desc>The plug-in name.</desc>
14725	</attribute>
14726	<attribute name="description" type="wstring" readonly="yes">
14727	<desc>The plug-in description.</desc>
14728	</attribute>
14729	<attribute name="frontend" type="wstring" readonly="yes">
14730	<desc>
14731	The name of the frontend or component name this plug-in plugs into.
14732	</desc>
14733	</attribute>
14734	<attribute name="modulePath" type="wstring" readonly="yes">
14735	<desc> The module path. </desc>
14736	</attribute>
14737	</interface>
14738
14739	<interface
14740	name="IExtPackBase" extends="$unknown"
14741	uuid="5ffb0b64-0ad6-467d-af62-1157e7dc3c99"
14742	wsmap="suppress"
14743	>
14744	<desc>
14745	Interface for querying information about an extension pack as well as
14746	accessing COM objects within it.
14747	</desc>
14748	<attribute name="name" type="wstring" readonly="yes">
14749	<desc>The extension pack name. This is unique.</desc>
14750	</attribute>
14751	<attribute name="description" type="wstring" readonly="yes">
14752	<desc>The extension pack description.</desc>
14753	</attribute>
14754	<attribute name="version" type="wstring" readonly="yes">
14755	<desc>
14756	The extension pack version string. This is on the same form as
14757	other VirtualBox version strings, i.e.: "1.2.3", "1.2.3_BETA1",
14758	"1.2.3-OSE", "1.2.3r45678", "1.2.3r45678-OSE", "1.2.3_BETA1-r45678"
14759	or "1.2.3_BETA1-r45678-OSE"
14760	</desc>
14761	</attribute>
14762	<attribute name="revision" type="unsigned long" readonly="yes">
14763	<desc>The extension pack internal revision number.</desc>
14764	</attribute>
14765	<attribute name="VRDEModule" type="wstring" readonly="yes">
14766	<desc>The name of the VRDE module if the extension pack sports one.</desc>
14767	</attribute>
14768	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
14769	<desc>Plug-ins provided by this extension pack.</desc>
14770	</attribute>
14771	<attribute name="usable" type="boolean" readonly="yes">
14772	<desc>
14773	Indicates whether the extension pack is usable or not.
14774
14775	There are a number of reasons why an extension pack might be unusable,
14776	typical examples would be broken installation/file or that it is
14777	incompatible with the current VirtualBox version.
14778	</desc>
14779	</attribute>
14780	<attribute name="whyUnusable" type="wstring" readonly="yes">
14781	<desc>
14782	String indicating why the extension pack is not usable. This is an
14783	empty string if usable and always a non-empty string if not usable.
14784	</desc>
14785	</attribute>
14786	<attribute name="showLicense" type="boolean" readonly="yes">
14787	<desc>Whether to show the license before installation</desc>
14788	</attribute>
14789	<attribute name="license" type="wstring" readonly="yes">
14790	<desc>
14791	The default HTML license text for the extension pack. Same as
14792	calling <link to="#queryLicense">queryLicense</link> with
14793	preferredLocale and preferredLanguage as empty strings and format set
14794	to html.
14795	</desc>
14796	</attribute>
14797
14798	<method name="queryLicense">
14799	<desc>
14800	Full feature version of the license attribute.
14801	</desc>
14802	<param name="preferredLocale" type="wstring" dir="in">
14803	<desc>
14804	The preferred license locale. Pass an empty string to get the default
14805	license.
14806	</desc>
14807	</param>
14808	<param name="preferredLanguage" type="wstring" dir="in">
14809	<desc>
14810	The preferred license language. Pass an empty string to get the
14811	default language for the locale.
14812	</desc>
14813	</param>
14814	<param name="format" type="wstring" dir="in">
14815	<desc>
14816	The license format: html, rtf or txt. If a license is present there
14817	will always be an HTML of it, the rich text format (RTF) and plain
14818	text (txt) versions are optional. If
14819	</desc>
14820	</param>
14821	<param name="licenseText" type="wstring" dir="return">
14822	<desc>The license text.</desc>
14823	</param>
14824	</method>
14825
14826	</interface>
14827
14828	<interface
14829	name="IExtPack" extends="IExtPackBase"
14830	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
14831	wsmap="suppress"
14832	>
14833	<desc>
14834	Interface for querying information about an extension pack as well as
14835	accessing COM objects within it.
14836	</desc>
14837	<method name="queryObject">
14838	<desc>
14839	Queries the IUnknown interface to an object in the extension pack
14840	main module. This allows plug-ins and others to talk directly to an
14841	extension pack.
14842	</desc>
14843	<param name="objUuid" type="wstring" dir="in">
14844	<desc>The object ID. What exactly this is </desc>
14845	</param>
14846	<param name="returnInterface" type="$unknown" dir="return">
14847	<desc>The queried interface.</desc>
14848	</param>
14849	</method>
14850	</interface>
14851
14852	<interface
14853	name="IExtPackFile" extends="IExtPackBase"
14854	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
14855	wsmap="suppress"
14856	>
14857	<desc>
14858	Extension pack file (aka tarball, .vbox-extpack) representation returned
14859	by IExtPackManager::openExtPackFile. This provides the base extension
14860	pack information with the addition of the file name. It also provides an
14861	alternative to IExtPackManager::install.
14862	</desc>
14863	<attribute name="filePath" type="wstring" readonly="yes">
14864	<desc>
14865	The path to the extension pack file.
14866	</desc>
14867	</attribute>
14868
14869	<method name="install">
14870	<desc>
14871	Install the extension pack.
14872	</desc>
14873	<param name="replace" type="boolean" dir="in">
14874	<desc>
14875	Set this to automatically uninstall any existing extension pack with
14876	the same name as the one being installed.
14877	</desc>
14878	</param>
14879	<param name="displayInfo" type="wstring" dir="in">
14880	<desc>
14881	Platform specific display information. Reserved for future hacks.
14882	</desc>
14883	</param>
14884	<param name="progess" type="IProgress" dir="return">
14885	<desc>
14886	Progress object for the operation.
14887	</desc>
14888	</param>
14889	</method>
14890	</interface>
14891
14892	<interface
14893	name="IExtPackManager" extends="$unknown"
14894	uuid="2451b1ba-ab1c-42fb-b453-c58433bea8c7"
14895	wsmap="suppress"
14896	>
14897	<desc>
14898	Interface for managing VirtualBox Extension Packs.
14899
14900	TODO: Describe extension packs, how they are managed and how to create
14901	one.
14902	</desc>
14903
14904	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
14905	<desc>
14906	List of the installed extension packs.
14907	</desc>
14908	</attribute>
14909
14910	<method name="find">
14911	<desc>
14912	Returns the extension pack with the specified name if found.
14913
14914	<result name="VBOX_E_OBJECT_NOT_FOUND">
14915	No extension pack matching @a name was found.
14916	</result>
14917	</desc>
14918	<param name="name" type="wstring" dir="in">
14919	<desc>The name of the extension pack to locate.</desc>
14920	</param>
14921	<param name="returnData" type="IExtPack" dir="return">
14922	<desc>The extension pack if found.</desc>
14923	</param>
14924	</method>
14925
14926	<method name="openExtPackFile">
14927	<desc>
14928	Attempts to open an extension pack file in preparation for
14929	installation.
14930	</desc>
14931	<param name="path" type="wstring" dir="in">
14932	<desc>The path of the extension pack tarball.</desc>
14933	</param>
14934	<param name="file" type="IExtPackFile" dir="return">
14935	<desc>The interface of the extension pack file object.</desc>
14936	</param>
14937	</method>
14938
14939	<method name="uninstall">
14940	<desc>Uninstalls an extension pack, removing all related files.</desc>
14941	<param name="name" type="wstring" dir="in">
14942	<desc>The name of the extension pack to uninstall.</desc>
14943	</param>
14944	<param name="forcedRemoval" type="boolean" dir="in">
14945	<desc>
14946	Forced removal of the extension pack. This means that the uninstall
14947	hook will not be called.
14948	</desc>
14949	</param>
14950	<param name="displayInfo" type="wstring" dir="in">
14951	<desc>
14952	Platform specific display information. Reserved for future hacks.
14953	</desc>
14954	</param>
14955	<param name="progess" type="IProgress" dir="return">
14956	<desc>
14957	Progress object for the operation.
14958	</desc>
14959	</param>
14960	</method>
14961
14962	<method name="cleanup">
14963	<desc>Cleans up failed installs and uninstalls</desc>
14964	</method>
14965
14966	<method name="QueryAllPlugInsForFrontend">
14967	<desc>
14968	Gets the path to all the plug-in modules for a given frontend.
14969
14970	This is a convenience method that is intended to simplify the plug-in
14971	loading process for a frontend.
14972	</desc>
14973	<param name="frontendName" type="wstring" dir="in">
14974	<desc>The name of the frontend or component.</desc>
14975	</param>
14976	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
14977	<desc>Array containing the plug-in modules (full paths).</desc>
14978	</param>
14979	</method>
14980
14981	<method name="IsExtPackUsable">
14982	<desc>Check if the given extension pack is loaded and usable.</desc>
14983	<param name="name" type="wstring" dir="in">
14984	<desc>The name of the extension pack to check for.</desc>
14985	</param>
14986	<param name="usable" type="boolean" dir="return"/>
14987	</method>
14988
14989	</interface>
14990
14991	<!--
14992	// BandwidthGroupType
14993	/////////////////////////////////////////////////////////////////////////
14994	-->
14995	<enum
14996	name="BandwidthGroupType"
14997	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
14998
14999	<desc>
15000	Type of a bandwidth control group.
15001	</desc>
15002
15003	<const name="Null" value="0">
15004	<desc>
15005	Null type, must be first.
15006	</desc>
15007	</const>
15008
15009	<const name="Disk" value="1">
15010	<desc>
15011	The bandwidth group controls disk I/O.
15012	</desc>
15013	</const>
15014
15015	<const name="Network" value="2">
15016	<desc>
15017	The bandwidth group controls network I/O.
15018	</desc>
15019	</const>
15020
15021	</enum>
15022
15023	<!--
15024	// IBandwidthGroup
15025	/////////////////////////////////////////////////////////////////////////
15026	-->
15027	<interface
15028	name="IBandwidthGroup" extends="$unknown"
15029	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
15030	wsmap="managed"
15031	>
15032	<desc>Represents one bandwidth group.</desc>
15033
15034	<attribute name="name" type="wstring" readonly="yes">
15035	<desc>Name of the group.</desc>
15036	</attribute>
15037
15038	<attribute name="type" type="BandwidthGroupType" readonly="yes">
15039	<desc>Type of the group.</desc>
15040	</attribute>
15041
15042	<attribute name="reference" type="unsigned long" readonly="yes">
15043	<desc>How many devices/medium attachements use this group.</desc>
15044	</attribute>
15045
15046	<attribute name="maxMbPerSec" type="unsigned long">
15047	<desc>The maximum number of MB which can be transfered by all
15048	entities attached to this group during one second.</desc>
15049	</attribute>
15050
15051	</interface>
15052
15053	<!--
15054	// IBandwidthControl
15055	/////////////////////////////////////////////////////////////////////////
15056	-->
15057	<interface
15058	name="IBandwidthControl" extends="$unknown"
15059	uuid="d0a24db0-f756-11df-98cf-0800200c9a66"
15060	wsmap="managed"
15061	>
15062	<desc>
15063	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
15064	This includes network and disk I/O.
15065	</desc>
15066
15067	<attribute name="numGroups" type="unsigned long" readonly="yes">
15068	<desc>
15069	The current number of existing bandwidth groups managed.
15070	</desc>
15071	</attribute>
15072
15073	<method name="CreateBandwidthGroup">
15074	<desc>
15075	Creates a new bandwidth group.
15076	</desc>
15077
15078	<param name="name" type="wstring" dir="in">
15079	<desc>Name of the bandwidth group.</desc>
15080	</param>
15081	<param name="type" type="BandwidthGroupType" dir="in">
15082	<desc>The type of the bandwidth group (network or disk).</desc>
15083	</param>
15084	<param name="maxBytesPerSec" type="unsigned long" dir="in">
15085	<desc>The maximum number of bytes which can be transfered by all
15086	entities attached to this group during one second.</desc>
15087	</param>
15088	</method>
15089
15090	<method name="DeleteBandwidthGroup">
15091	<desc>
15092	Deletes a new bandwidth group.
15093	</desc>
15094
15095	<param name="name" type="wstring" dir="in">
15096	<desc>Name of the bandwidth group to delete.</desc>
15097	</param>
15098	</method>
15099
15100	<method name="GetBandwidthGroup" const="yes">
15101	<desc>
15102	Get a bandwidth group by name.
15103	</desc>
15104
15105	<param name="name" type="wstring" dir="in">
15106	<desc>Name of the bandwidth group to get.</desc>
15107	</param>
15108	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
15109	<desc>Where to store the bandwidth group on success.</desc>
15110	</param>
15111	</method>
15112
15113	<method name="GetAllBandwidthGroups" const="yes">
15114	<desc>
15115	Get all managed bandwidth groups.
15116	</desc>
15117
15118	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
15119	<desc>The array of managed bandwidth groups.</desc>
15120	</param>
15121	</method>
15122	</interface>
15123
15124	<!--
15125	// IVirtualBoxClient
15126	/////////////////////////////////////////////////////////////////////////
15127	-->
15128
15129	<interface
15130	name="IVirtualBoxClient" extends="$unknown"
15131	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
15132	wsmap="suppress"
15133	>
15134	<desc>
15135	Convenience interface for client applications. Treat this as a
15136	singleton, i.e. never create more than one instance of this interface.
15137
15138	At the moment only available for clients of the local API (not usable
15139	via the webservice). Once the session logic is redesigned this might
15140	change.
15141	</desc>
15142
15143	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
15144	<desc>
15145	Reference to the server-side API root object.
15146	</desc>
15147	</attribute>
15148
15149	<attribute name="session" type="ISession" readonly="yes">
15150	<desc>
15151	Create a new session object and return the reference to it.
15152	</desc>
15153	</attribute>
15154
15155	<attribute name="eventSource" type="IEventSource" readonly="yes">
15156	<desc>
15157	Event source for VirtualBoxClient events.
15158	</desc>
15159	</attribute>
15160
15161	</interface>
15162
15163	<!--
15164	// Events
15165	/////////////////////////////////////////////////////////////////////////
15166	-->
15167	<enum
15168	name="VBoxEventType"
15169	uuid="e71c487f-755e-46e9-a476-dd6a5d134597"
15170	>
15171
15172	<desc>
15173	Type of an event.
15174	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15175	</desc>
15176
15177	<const name="Invalid" value="0">
15178	<desc>
15179	Invalid event, must be first.
15180	</desc>
15181	</const>
15182
15183	<const name="Any" value="1">
15184	<desc>
15185	Wildcard for all events.
15186	Events of this type are never delivered, and only used in
15187	registerListener() call to simplify registration.
15188	</desc>
15189	</const>
15190
15191	<const name="Vetoable" value="2">
15192	<desc>
15193	Wildcard for all vetoable events. Events of this type are never delivered, and only
15194	used in registerListener() call to simplify registration.
15195	</desc>
15196	</const>
15197
15198	<const name="MachineEvent" value="3">
15199	<desc>
15200	Wildcard for all machine events. Events of this type are never delivered, and only used in
15201	registerListener() call to simplify registration.
15202	</desc>
15203	</const>
15204
15205	<const name="SnapshotEvent" value="4">
15206	<desc>
15207	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
15208	registerListener() call to simplify registration.
15209	</desc>
15210	</const>
15211
15212	<const name="InputEvent" value="5">
15213	<desc>
15214	Wildcard for all input device (keyboard, mouse) events.
15215	Events of this type are never delivered, and only used in
15216	registerListener() call to simplify registration.
15217	</desc>
15218	</const>
15219
15220	<const name="LastWildcard" value="31">
15221	<desc>
15222	Last wildcard.
15223	</desc>
15224	</const>
15225
15226	<const name="OnMachineStateChanged" value="32">
15227	<desc>
15228	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
15229	</desc>
15230	</const>
15231	<const name="OnMachineDataChanged" value="33">
15232	<desc>
15233	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
15234	</desc>
15235	</const>
15236	<const name="OnExtraDataChanged" value="34">
15237	<desc>
15238	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
15239	</desc>
15240	</const>
15241	<const name="OnExtraDataCanChange" value="35">
15242	<desc>
15243	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
15244	</desc>
15245	</const>
15246	<const name="OnMediumRegistered" value="36">
15247	<desc>
15248	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
15249	</desc>
15250	</const>
15251	<const name="OnMachineRegistered" value="37">
15252	<desc>
15253	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
15254	</desc>
15255	</const>
15256	<const name="OnSessionStateChanged" value="38">
15257	<desc>
15258	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
15259	</desc>
15260	</const>
15261	<const name="OnSnapshotTaken" value="39">
15262	<desc>
15263	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
15264	</desc>
15265	</const>
15266	<const name="OnSnapshotDeleted" value="40">
15267	<desc>
15268	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
15269	</desc>
15270	</const>
15271	<const name="OnSnapshotChanged" value="41">
15272	<desc>
15273	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
15274	</desc>
15275	</const>
15276	<const name="OnGuestPropertyChanged" value="42">
15277	<desc>
15278	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
15279	</desc>
15280	</const>
15281	<!-- Console events -->
15282	<const name="OnMousePointerShapeChanged" value="43">
15283	<desc>
15284	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
15285	</desc>
15286	</const>
15287	<const name="OnMouseCapabilityChanged" value="44">
15288	<desc>
15289	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
15290	</desc>
15291	</const>
15292	<const name="OnKeyboardLedsChanged" value="45">
15293	<desc>
15294	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
15295	</desc>
15296	</const>
15297	<const name="OnStateChanged" value="46">
15298	<desc>
15299	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
15300	</desc>
15301	</const>
15302	<const name="OnAdditionsStateChanged" value="47">
15303	<desc>
15304	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
15305	</desc>
15306	</const>
15307	<const name="OnNetworkAdapterChanged" value="48">
15308	<desc>
15309	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
15310	</desc>
15311	</const>
15312	<const name="OnSerialPortChanged" value="49">
15313	<desc>
15314	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
15315	</desc>
15316	</const>
15317	<const name="OnParallelPortChanged" value="50">
15318	<desc>
15319	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
15320	</desc>
15321	</const>
15322	<const name="OnStorageControllerChanged" value="51">
15323	<desc>
15324	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
15325	</desc>
15326	</const>
15327	<const name="OnMediumChanged" value="52">
15328	<desc>
15329	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
15330	</desc>
15331	</const>
15332	<const name="OnVRDEServerChanged" value="53">
15333	<desc>
15334	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
15335	</desc>
15336	</const>
15337	<const name="OnUSBControllerChanged" value="54">
15338	<desc>
15339	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
15340	</desc>
15341	</const>
15342	<const name="OnUSBDeviceStateChanged" value="55">
15343	<desc>
15344	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
15345	</desc>
15346	</const>
15347	<const name="OnSharedFolderChanged" value="56">
15348	<desc>
15349	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
15350	</desc>
15351	</const>
15352	<const name="OnRuntimeError" value="57">
15353	<desc>
15354	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
15355	</desc>
15356	</const>
15357	<const name="OnCanShowWindow" value="58">
15358	<desc>
15359	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
15360	</desc>
15361	</const>
15362	<const name="OnShowWindow" value="59">
15363	<desc>
15364	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
15365	</desc>
15366	</const>
15367	<const name="OnCPUChanged" value="60">
15368	<desc>
15369	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
15370	</desc>
15371	</const>
15372	<const name="OnVRDEServerInfoChanged" value="61">
15373	<desc>
15374	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
15375	</desc>
15376	</const>
15377	<const name="OnEventSourceChanged" value="62">
15378	<desc>
15379	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
15380	</desc>
15381	</const>
15382	<const name="OnCPUExecutionCapChanged" value="63">
15383	<desc>
15384	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
15385	</desc>
15386	</const>
15387	<const name="OnGuestKeyboard" value="64">
15388	<desc>
15389	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
15390	</desc>
15391	</const>
15392	<const name="OnGuestMouse" value="65">
15393	<desc>
15394	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
15395	</desc>
15396	</const>
15397	<const name="OnNATRedirect" value="66">
15398	<desc>
15399	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
15400	</desc>
15401	</const>
15402	<const name="OnHostPciDevicePlug" value="67">
15403	<desc>
15404	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
15405	</desc>
15406	</const>
15407	<const name="OnVBoxSVCAvailabilityChanged" value="68">
15408	<desc>
15409	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
15410	</desc>
15411	</const>
15412	<const name="OnBandwidthGroupChanged" value="69">
15413	<desc>
15414	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
15415	</desc>
15416	</const>
15417	<const name="OnGuestMonitorChanged" value="70">
15418	<desc>
15419	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
15420	</desc>
15421	</const>
15422
15423	<!-- Last event marker -->
15424	<const name="Last" value="71">
15425	<desc>
15426	Must be last event, used for iterations and structures relying on numerical event values.
15427	</desc>
15428	</const>
15429
15430	</enum>
15431
15432	<interface
15433	name="IEventSource" extends="$unknown"
15434	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
15435	wsmap="managed"
15436	>
15437	<desc>
15438	Event source. Generally, any object which could generate events can be an event source,
15439	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
15440	an event source can work with listeners in either active or passive mode. In active mode it is up to
15441	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
15442	event source keeps track of pending events for each listener and returns available events on demand.
15443
15444	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15445	</desc>
15446
15447	<method name="createListener">
15448	<desc>
15449	Creates a new listener object, useful for passive mode.
15450	</desc>
15451	<param name="listener" type="IEventListener" dir="return"/>
15452	</method>
15453
15454	<method name="createAggregator">
15455	<desc>
15456	Creates an aggregator event source, collecting events from multiple sources.
15457	This way a single listener can listen for events coming from multiple sources,
15458	using a single blocking getEvent() on the returned aggregator.
15459	</desc>
15460	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
15461	<desc>
15462	Subordinate event source this one aggregatres.
15463	</desc>
15464	</param>
15465	<param name="result" type="IEventSource" dir="return"/>
15466	</method>
15467
15468	<method name="registerListener">
15469	<desc>
15470	Register an event listener.
15471
15472	<note>
15473	To avoid system overload, the VirtualBox server process checks if passive event
15474	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
15475	current implementation, if more than 500 pending events are detected for a passive
15476	event listener, it is forcefully unregistered by the system, and further
15477	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
15478	</note>
15479	</desc>
15480	<param name="listener" type="IEventListener" dir="in">
15481	<desc>Listener to register.</desc>
15482	</param>
15483	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
15484	<desc>
15485	Event types listener is interested in. One can use wildcards like -
15486	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
15487	than one event.
15488	</desc>
15489	</param>
15490	<param name="active" type="boolean" dir="in">
15491	<desc>
15492	Which mode this listener is operating in.
15493	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
15494	In passive mode, an internal event queue is created for this this IEventListener.
15495	For each event coming in, it is added to queues for all interested registered passive
15496	listeners. It is then up to the external code to call the listener's
15497	<link to="IEventListener::handleEvent" /> method. When done with an event, the
15498	external code must call <link to="#eventProcessed" />.
15499	</desc>
15500	</param>
15501	</method>
15502
15503	<method name="unregisterListener">
15504	<desc>
15505	Unregister an event listener. If listener is passive, and some waitable events are still
15506	in queue they are marked as processed automatically.
15507	</desc>
15508	<param name="listener" type="IEventListener" dir="in">
15509	<desc>Listener to unregister.</desc>
15510	</param>
15511	</method>
15512
15513	<method name="fireEvent">
15514	<desc>
15515	Fire an event for this source.
15516	</desc>
15517	<param name="event" type="IEvent" dir="in">
15518	<desc>Event to deliver.</desc>
15519	</param>
15520	<param name="timeout" type="long" dir="in">
15521	<desc>
15522	Maximum time to wait for event processing (if event is waitable), in ms;
15523	0 = no wait, -1 = indefinite wait.
15524	</desc>
15525	</param>
15526	<param name="result" type="boolean" dir="return">
15527	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
15528	</param>
15529	</method>
15530
15531	<method name="getEvent">
15532	<desc>
15533	Get events from this peer's event queue (for passive mode). Calling this method
15534	regularly is required for passive event listeners to avoid system overload;
15535	see <link to="IEventSource::registerListener" /> for details.
15536
15537	<result name="VBOX_E_OBJECT_NOT_FOUND">
15538	Listener is not registered, or autounregistered.
15539	</result>
15540	</desc>
15541	<param name="listener" type="IEventListener" dir="in">
15542	<desc>Which listener to get data for.</desc>
15543	</param>
15544	<param name="timeout" type="long" dir="in">
15545	<desc>
15546	Maximum time to wait for events, in ms;
15547	0 = no wait, -1 = indefinite wait.
15548	</desc>
15549	</param>
15550	<param name="event" type="IEvent" dir="return">
15551	<desc>Event retrieved, or null if none available.</desc>
15552	</param>
15553	</method>
15554
15555	<method name="eventProcessed">
15556	<desc>
15557	Must be called for waitable events after a particular listener finished its
15558	event processing. When all listeners of a particular event have called this
15559	method, the system will then call <link to="IEvent::setProcessed" />.
15560	</desc>
15561	<param name="listener" type="IEventListener" dir="in">
15562	<desc>Which listener processed event.</desc>
15563	</param>
15564	<param name="event" type="IEvent" dir="in">
15565	<desc>Which event.</desc>
15566	</param>
15567	</method>
15568
15569	</interface>
15570
15571	<interface
15572	name="IEventListener" extends="$unknown"
15573	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
15574	wsmap="managed"
15575	>
15576	<desc>
15577	Event listener. An event listener can work in either active or passive mode, depending on the way
15578	it was registered.
15579	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15580	</desc>
15581
15582	<method name="handleEvent">
15583	<desc>
15584	Handle event callback for active listeners. It is not called for passive listeners. After
15585	calling handleEvent() on all active listeners and having received acknowledgement from all
15586	passive listeners via IEventSource::eventProcessed(), the event is marked as processed and
15587	IEvent::waitProcessed() will return immediately.
15588	</desc>
15589	<param name="event" type="IEvent" dir="in">
15590	<desc>Event available.</desc>
15591	</param>
15592	</method>
15593
15594	</interface>
15595
15596	<interface
15597	name="IEvent" extends="$unknown"
15598	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
15599	wsmap="managed"
15600	>
15601	<desc>
15602	Abstract parent interface for VirtualBox events. Actual events will typically implement
15603	a more specific interface which derives from this (see below).
15604
15605	<b>Introduction to VirtualBox events</b>
15606
15607	Generally speaking, an event (represented by this interface) signals that something
15608	happened, while an event listener (see <link to="IEventListener" />) represents an
15609	entity that is interested in certain events. In order for this to work with
15610	unidirectional protocols (i.e. web services), the concepts of passive and active
15611	listener are used.
15612
15613	Event consumers can register themselves as listeners, providing an array of
15614	events they are interested in (see <link to="IEventSource::registerListener" />).
15615	When an event triggers, the listener is notified about the event. The exact
15616	mechanism of the notification depends on whether the listener was registered as
15617	an active or passive listener:
15618
15619	<ul>
15620	<li>An active listener is very similar to a callback: it is a function invoked
15621	by the API. As opposed to the callbacks that were used in the API before
15622	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
15623	</li>
15624
15625	<li>Passive listeners are somewhat trickier to implement, but do not require
15626	a client function to be callable, which is not an option with scripting
15627	languages or web service clients. Internally the <link to="IEventSource" />
15628	implementation maintains an event queue for each passive listener, and
15629	newly arrived events are put in this queue. When the listener calls
15630	<link to="IEventSource::getEvent"/>, first element from its internal event
15631	queue is returned. When the client completes processing of an event,
15632	the <link to="IEventSource::eventProcessed" /> function must be called,
15633	acknowledging that the event was processed. It supports implementing
15634	waitable events. On passive listener unregistration, all events from its
15635	queue are auto-acknowledged.
15636	</li>
15637	</ul>
15638
15639	Waitable events are useful in situations where the event generator wants to track
15640	delivery or a party wants to wait until all listeners have completed the event. A
15641	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
15642	listeners might veto a certain action, and thus the event producer has to make
15643	sure that all listeners have processed the event and not vetoed before taking
15644	the action.
15645
15646	A given event may have both passive and active listeners at the same time.
15647
15648	<b>Using events</b>
15649
15650	Any VirtualBox object capable of producing externally visible events provides an
15651	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
15652	This event source object is notified by VirtualBox once something has happened, so
15653	consumers may register event listeners with this event source. To register a listener,
15654	an object implementing the <link to="IEventListener" /> interface must be provided.
15655	For active listeners, such an object is typically created by the consumer, while for
15656	passive listeners <link to="IEventSource::createListener" /> should be used. Please
15657	note that a listener created with @c createListener() must not be used as an active listener.
15658
15659	Once created, the listener must be registered to listen for the desired events
15660	(see <link to="IEventSource::registerListener" />), providing an array of
15661	<link to="VBoxEventType" /> enums. Those elements can either be the individual
15662	event IDs or wildcards matching multiple event IDs.
15663
15664	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
15665	called automatically when the event is triggered, while passive listeners have to call
15666	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
15667	an event processing loop.
15668
15669	The IEvent interface is an abstract parent interface for all such VirtualBox events
15670	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
15671	or the event processing loop is to check the <link to="#type" /> attribute of the event and
15672	then cast to the appropriate specific interface using @c QueryInterface().
15673	</desc>
15674
15675	<attribute name="type" readonly="yes" type="VBoxEventType">
15676	<desc>
15677	Event type.
15678	</desc>
15679	</attribute>
15680
15681	<attribute name="source" readonly="yes" type="IEventSource">
15682	<desc>
15683	Source of this event.
15684	</desc>
15685	</attribute>
15686
15687	<attribute name="waitable" readonly="yes" type="boolean">
15688	<desc>
15689	If we can wait for this event being processed. If false, waitProcessed() returns immediately,
15690	and setProcessed() doesn't make sense. Non-waitable events are generally better performing,
15691	as no additional overhead associated with waitability imposed.
15692	Waitable events are needed when one need to be able to wait for particular event processed,
15693	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
15694	until all consumers confirmed events.
15695	</desc>
15696	</attribute>
15697
15698	<method name="setProcessed">
15699	<desc>
15700	Internal method called by the system when all listeners of a particular event have called
15701	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
15702	</desc>
15703	</method>
15704
15705	<method name="waitProcessed">
15706	<desc>
15707	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
15708	described semantics, for non-waitable returns true immediately.
15709	</desc>
15710	<param name="timeout" type="long" dir="in">
15711	<desc>
15712	Maximum time to wait for event processeing, in ms;
15713	0 = no wait, -1 = indefinite wait.
15714	</desc>
15715	</param>
15716	<param name="result" type="boolean" dir="return">
15717	<desc>If this event was processed before timeout.</desc>
15718	</param>
15719	</method>
15720	</interface>
15721
15722
15723	<interface
15724	name="IReusableEvent" extends="IEvent"
15725	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
15726	wsmap="managed"
15727	>
15728	<desc>Base abstract interface for all reusable events.</desc>
15729
15730	<attribute name="generation" readonly="yes" type="unsigned long">
15731	<desc>Current generation of event, incremented on reuse.</desc>
15732	</attribute>
15733
15734	<method name="reuse">
15735	<desc>
15736	Marks an event as reused, increments 'generation', fields shall no
15737	longer be considered valid.
15738	</desc>
15739	</method>
15740	</interface>
15741
15742	<interface
15743	name="IMachineEvent" extends="IEvent"
15744	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
15745	wsmap="managed" id="MachineEvent"
15746	>
15747	<desc>Base abstract interface for all machine events.</desc>
15748
15749	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
15750	<desc>ID of the machine this event relates to.</desc>
15751	</attribute>
15752
15753	</interface>
15754
15755	<interface
15756	name="IMachineStateChangedEvent" extends="IMachineEvent"
15757	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
15758	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
15759	>
15760	<desc>Machine state change event.</desc>
15761
15762	<attribute name="state" readonly="yes" type="MachineState">
15763	<desc>New execution state.</desc>
15764	</attribute>
15765	</interface>
15766
15767	<interface
15768	name="IMachineDataChangedEvent" extends="IMachineEvent"
15769	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
15770	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
15771	>
15772	<desc>
15773	Any of the settings of the given machine has changed.
15774	</desc>
15775	</interface>
15776
15777	<interface
15778	name="IMediumRegisteredEvent" extends="IEvent"
15779	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
15780	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
15781	>
15782	<desc>
15783	The given medium was registered or unregistered
15784	within this VirtualBox installation.
15785	</desc>
15786
15787	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
15788	<desc>ID of the medium this event relates to.</desc>
15789	</attribute>
15790
15791	<attribute name="mediumType" readonly="yes" type="DeviceType">
15792	<desc>Type of the medium this event relates to.</desc>
15793	</attribute>
15794
15795	<attribute name="registered" type="boolean" readonly="yes">
15796	<desc>
15797	If @c true, the medium was registered, otherwise it was
15798	unregistered.
15799	</desc>
15800	</attribute>
15801	</interface>
15802
15803	<interface
15804	name="IMachineRegisteredEvent" extends="IMachineEvent"
15805	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
15806	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
15807	>
15808	<desc>
15809	The given machine was registered or unregistered
15810	within this VirtualBox installation.
15811	</desc>
15812
15813	<attribute name="registered" type="boolean" readonly="yes">
15814	<desc>
15815	If @c true, the machine was registered, otherwise it was
15816	unregistered.
15817	</desc>
15818	</attribute>
15819	</interface>
15820
15821	<interface
15822	name="ISessionStateChangedEvent" extends="IMachineEvent"
15823	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
15824	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
15825	>
15826	<desc>
15827	The state of the session for the given machine was changed.
15828	<see>IMachine::sessionState</see>
15829	</desc>
15830
15831	<attribute name="state" type="SessionState" readonly="yes">
15832	<desc>
15833	New session state.
15834	</desc>
15835	</attribute>
15836	</interface>
15837
15838	<interface
15839	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
15840	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
15841	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
15842	>
15843	<desc>
15844	Notification when a guest property has changed.
15845	</desc>
15846
15847	<attribute name="name" readonly="yes" type="wstring">
15848	<desc>
15849	The name of the property that has changed.
15850	</desc>
15851	</attribute>
15852
15853	<attribute name="value" readonly="yes" type="wstring">
15854	<desc>
15855	The new property value.
15856	</desc>
15857	</attribute>
15858
15859	<attribute name="flags" readonly="yes" type="wstring">
15860	<desc>
15861	The new property flags.
15862	</desc>
15863	</attribute>
15864
15865	</interface>
15866
15867	<interface
15868	name="ISnapshotEvent" extends="IMachineEvent"
15869	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
15870	wsmap="managed" id="SnapshotEvent"
15871	>
15872	<desc>Base interface for all snapshot events.</desc>
15873
15874	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
15875	<desc>ID of the snapshot this event relates to.</desc>
15876	</attribute>
15877
15878	</interface>
15879
15880	<interface
15881	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
15882	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
15883	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
15884	>
15885	<desc>
15886	A new snapshot of the machine has been taken.
15887	<see>ISnapshot</see>
15888	</desc>
15889	</interface>
15890
15891	<interface
15892	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
15893	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
15894	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
15895	>
15896	<desc>
15897	Snapshot of the given machine has been deleted.
15898
15899	<note>
15900	This notification is delivered <b>after</b> the snapshot
15901	object has been uninitialized on the server (so that any
15902	attempt to call its methods will return an error).
15903	</note>
15904
15905	<see>ISnapshot</see>
15906	</desc>
15907	</interface>
15908
15909	<interface
15910	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
15911	uuid="07541941-8079-447a-a33e-47a69c7980db"
15912	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
15913	>
15914	<desc>
15915	Snapshot properties (name and/or description) have been changed.
15916	<see>ISnapshot</see>
15917	</desc>
15918	</interface>
15919
15920	<interface
15921	name="IMousePointerShapeChangedEvent" extends="IEvent"
15922	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
15923	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
15924	>
15925	<desc>
15926	Notification when the guest mouse pointer shape has
15927	changed. The new shape data is given.
15928	</desc>
15929
15930	<attribute name="visible" type="boolean" readonly="yes">
15931	<desc>
15932	Flag whether the pointer is visible.
15933	</desc>
15934	</attribute>
15935	<attribute name="alpha" type="boolean" readonly="yes">
15936	<desc>
15937	Flag whether the pointer has an alpha channel.
15938	</desc>
15939	</attribute>
15940	<attribute name="xhot" type="unsigned long" readonly="yes">
15941	<desc>
15942	The pointer hot spot X coordinate.
15943	</desc>
15944	</attribute>
15945	<attribute name="yhot" type="unsigned long" readonly="yes">
15946	<desc>
15947	The pointer hot spot Y coordinate.
15948	</desc>
15949	</attribute>
15950	<attribute name="width" type="unsigned long" readonly="yes">
15951	<desc>
15952	Width of the pointer shape in pixels.
15953	</desc>
15954	</attribute>
15955	<attribute name="height" type="unsigned long" readonly="yes">
15956	<desc>
15957	Height of the pointer shape in pixels.
15958	</desc>
15959	</attribute>
15960	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
15961	<desc>
15962	Shape buffer arrays.
15963
15964	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
15965	followed by a 32-bpp XOR (color) mask.
15966
15967	For pointers without alpha channel the XOR mask pixels are 32
15968	bit values: (lsb)BGR0(msb). For pointers with alpha channel
15969	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
15970
15971	An AND mask is used for pointers with alpha channel, so if the
15972	callback does not support alpha, the pointer could be
15973	displayed as a normal color pointer.
15974
15975	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
15976	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
15977	height</tt>. The padding bits at the end of each scanline are
15978	undefined.
15979
15980	The XOR mask follows the AND mask on the next 4-byte aligned
15981	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
15982	Bytes in the gap between the AND and the XOR mask are undefined.
15983	The XOR mask scanlines have no gap between them and the size of
15984	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
15985
15986	<note>
15987	If @a shape is 0, only the pointer visibility is changed.
15988	</note>
15989	</desc>
15990	</attribute>
15991	</interface>
15992
15993	<interface
15994	name="IMouseCapabilityChangedEvent" extends="IEvent"
15995	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
15996	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
15997	>
15998	<desc>
15999	Notification when the mouse capabilities reported by the
16000	guest have changed. The new capabilities are passed.
16001	</desc>
16002	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
16003	<desc>
16004	Supports absolute coordinates.
16005	</desc>
16006	</attribute>
16007	<attribute name="supportsRelative" type="boolean" readonly="yes">
16008	<desc>
16009	Supports relative coordinates.
16010	</desc>
16011	</attribute>
16012	<attribute name="needsHostCursor" type="boolean" readonly="yes">
16013	<desc>
16014	If host cursor is needed.
16015	</desc>
16016	</attribute>
16017	</interface>
16018
16019	<interface
16020	name="IKeyboardLedsChangedEvent" extends="IEvent"
16021	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
16022	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
16023	>
16024	<desc>
16025	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
16026	to alter the state of the keyboard LEDs.
16027	</desc>
16028	<attribute name="numLock" type="boolean" readonly="yes">
16029	<desc>
16030	NumLock status.
16031	</desc>
16032	</attribute>
16033	<attribute name="capsLock" type="boolean" readonly="yes">
16034	<desc>
16035	CapsLock status.
16036	</desc>
16037	</attribute>
16038	<attribute name="scrollLock" type="boolean" readonly="yes">
16039	<desc>
16040	ScrollLock status.
16041	</desc>
16042	</attribute>
16043	</interface>
16044
16045	<interface
16046	name="IStateChangedEvent" extends="IEvent"
16047	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
16048	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
16049	>
16050	<desc>
16051	Notification when the execution state of the machine has changed.
16052	The new state is given.
16053	</desc>
16054	<attribute name="state" type="MachineState" readonly="yes">
16055	<desc>
16056	New machine state.
16057	</desc>
16058	</attribute>
16059	</interface>
16060
16061	<interface
16062	name="IAdditionsStateChangedEvent" extends="IEvent"
16063	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
16064	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
16065	>
16066	<desc>
16067	Notification when a Guest Additions property changes.
16068	Interested callees should query IGuest attributes to
16069	find out what has changed.
16070	</desc>
16071	</interface>
16072
16073	<interface
16074	name="INetworkAdapterChangedEvent" extends="IEvent"
16075	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
16076	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
16077	>
16078	<desc>
16079	Notification when a property of one of the
16080	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
16081	changes. Interested callees should use INetworkAdapter methods and
16082	attributes to find out what has changed.
16083	</desc>
16084	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
16085	<desc>
16086	Network adapter that is subject to change.
16087	</desc>
16088	</attribute>
16089	</interface>
16090
16091	<interface
16092	name="ISerialPortChangedEvent" extends="IEvent"
16093	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
16094	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
16095	>
16096	<desc>
16097	Notification when a property of one of the
16098	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
16099	Interested callees should use ISerialPort methods and attributes
16100	to find out what has changed.
16101	</desc>
16102	<attribute name="serialPort" type="ISerialPort" readonly="yes">
16103	<desc>
16104	Serial port that is subject to change.
16105	</desc>
16106	</attribute>
16107	</interface>
16108
16109	<interface
16110	name="IParallelPortChangedEvent" extends="IEvent"
16111	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
16112	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
16113	>
16114	<desc>
16115	Notification when a property of one of the
16116	virtual <link to="IMachine::getParallelPort">parallel ports</link>
16117	changes. Interested callees should use ISerialPort methods and
16118	attributes to find out what has changed.
16119	</desc>
16120	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
16121	<desc>
16122	Parallel port that is subject to change.
16123	</desc>
16124	</attribute>
16125	</interface>
16126
16127	<interface
16128	name="IStorageControllerChangedEvent" extends="IEvent"
16129	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
16130	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
16131	>
16132	<desc>
16133	Notification when a
16134	<link to="IMachine::mediumAttachments">medium attachment</link>
16135	changes.
16136	</desc>
16137	</interface>
16138
16139	<interface
16140	name="IMediumChangedEvent" extends="IEvent"
16141	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
16142	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
16143	>
16144	<desc>
16145	Notification when a
16146	<link to="IMachine::mediumAttachments">medium attachment</link>
16147	changes.
16148	</desc>
16149	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
16150	<desc>
16151	Medium attachment that is subject to change.
16152	</desc>
16153	</attribute>
16154	</interface>
16155
16156	<interface
16157	name="ICPUChangedEvent" extends="IEvent"
16158	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
16159	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
16160	>
16161	<desc>
16162	Notification when a CPU changes.
16163	</desc>
16164	<attribute name="cpu" type="unsigned long" readonly="yes">
16165	<desc>
16166	The CPU which changed.
16167	</desc>
16168	</attribute>
16169	<attribute name="add" type="boolean" readonly="yes">
16170	<desc>
16171	Flag whether the CPU was added or removed.
16172	</desc>
16173	</attribute>
16174	</interface>
16175
16176	<interface
16177	name="ICPUExecutionCapChangedEvent" extends="IEvent"
16178	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
16179	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
16180	>
16181	<desc>
16182	Notification when the CPU execution cap changes.
16183	</desc>
16184	<attribute name="executionCap" type="unsigned long" readonly="yes">
16185	<desc>
16186	The new CPU execution cap value. (1-100)
16187	</desc>
16188	</attribute>
16189	</interface>
16190
16191	<interface
16192	name="IGuestKeyboardEvent" extends="IEvent"
16193	uuid="88394258-7006-40d4-b339-472ee3801844"
16194	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
16195	>
16196	<desc>
16197	Notification when guest keyboard event happens.
16198	</desc>
16199	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
16200	<desc>
16201	Array of scancodes.
16202	</desc>
16203	</attribute>
16204	</interface>
16205
16206	<interface
16207	name="IGuestMouseEvent" extends="IReusableEvent"
16208	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
16209	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
16210	>
16211	<desc>
16212	Notification when guest mouse event happens.
16213	</desc>
16214
16215	<attribute name="absolute" type="boolean" readonly="yes">
16216	<desc>
16217	If this event is relative or absolute.
16218	</desc>
16219	</attribute>
16220
16221	<attribute name="x" type="long" readonly="yes">
16222	<desc>
16223	New X position, or X delta.
16224	</desc>
16225	</attribute>
16226
16227	<attribute name="y" type="long" readonly="yes">
16228	<desc>
16229	New Y position, or Y delta.
16230	</desc>
16231	</attribute>
16232
16233	<attribute name="z" type="long" readonly="yes">
16234	<desc>
16235	Z delta.
16236	</desc>
16237	</attribute>
16238
16239	<attribute name="w" type="long" readonly="yes">
16240	<desc>
16241	W delta.
16242	</desc>
16243	</attribute>
16244
16245	<attribute name="buttons" type="long" readonly="yes">
16246	<desc>
16247	Button state bitmask.
16248	</desc>
16249	</attribute>
16250
16251	</interface>
16252
16253
16254	<interface
16255	name="IVRDEServerChangedEvent" extends="IEvent"
16256	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
16257	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
16258	>
16259	<desc>
16260	Notification when a property of the
16261	<link to="IMachine::VRDEServer">VRDE server</link> changes.
16262	Interested callees should use IVRDEServer methods and attributes to
16263	find out what has changed.
16264	</desc>
16265	</interface>
16266
16267	<interface
16268	name="IVRDEServerInfoChangedEvent" extends="IEvent"
16269	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
16270	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
16271	>
16272	<desc>
16273	Notification when the status of the VRDE server changes. Interested callees
16274	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
16275	attributes to find out what is the current status.
16276	</desc>
16277	</interface>
16278
16279	<interface
16280	name="IUSBControllerChangedEvent" extends="IEvent"
16281	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
16282	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
16283	>
16284	<desc>
16285	Notification when a property of the virtual
16286	<link to="IMachine::USBController">USB controller</link> changes.
16287	Interested callees should use IUSBController methods and attributes to
16288	find out what has changed.
16289	</desc>
16290	</interface>
16291
16292	<interface
16293	name="IUSBDeviceStateChangedEvent" extends="IEvent"
16294	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
16295	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
16296	>
16297	<desc>
16298	Notification when a USB device is attached to or detached from
16299	the virtual USB controller.
16300
16301	This notification is sent as a result of the indirect
16302	request to attach the device because it matches one of the
16303	machine USB filters, or as a result of the direct request
16304	issued by <link to="IConsole::attachUSBDevice"/> or
16305	<link to="IConsole::detachUSBDevice"/>.
16306
16307	This notification is sent in case of both a succeeded and a
16308	failed request completion. When the request succeeds, the
16309	@a error parameter is @c null, and the given device has been
16310	already added to (when @a attached is @c true) or removed from
16311	(when @a attached is @c false) the collection represented by
16312	<link to="IConsole::USBDevices"/>. On failure, the collection
16313	doesn't change and the @a error parameter represents the error
16314	message describing the failure.
16315	</desc>
16316	<attribute name="device" type="IUSBDevice" readonly="yes">
16317	<desc>
16318	Device that is subject to state change.
16319	</desc>
16320	</attribute>
16321	<attribute name="attached" type="boolean" readonly="yes">
16322	<desc>
16323	@c true if the device was attached and @c false otherwise.
16324	</desc>
16325	</attribute>
16326	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
16327	<desc>
16328	@c null on success or an error message object on failure.
16329	</desc>
16330	</attribute>
16331	</interface>
16332
16333	<interface
16334	name="ISharedFolderChangedEvent" extends="IEvent"
16335	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
16336	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
16337	>
16338	<desc>
16339	Notification when a shared folder is added or removed.
16340	The @a scope argument defines one of three scopes:
16341	<link to="IVirtualBox::sharedFolders">global shared folders</link>
16342	(<link to="Scope_Global">Global</link>),
16343	<link to="IMachine::sharedFolders">permanent shared folders</link> of
16344	the machine (<link to="Scope_Machine">Machine</link>) or <link
16345	to="IConsole::sharedFolders">transient shared folders</link> of the
16346	machine (<link to="Scope_Session">Session</link>). Interested callees
16347	should use query the corresponding collections to find out what has
16348	changed.
16349	</desc>
16350	<attribute name="scope" type="Scope" readonly="yes">
16351	<desc>
16352	Scope of the notification.
16353	</desc>
16354	</attribute>
16355	</interface>
16356
16357	<interface
16358	name="IRuntimeErrorEvent" extends="IEvent"
16359	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
16360	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
16361	>
16362	<desc>
16363	Notification when an error happens during the virtual
16364	machine execution.
16365
16366	There are three kinds of runtime errors:
16367	<ul>
16368	<li><i>fatal</i></li>
16369	<li><i>non-fatal with retry</i></li>
16370	<li><i>non-fatal warnings</i></li>
16371	</ul>
16372
16373	<b>Fatal</b> errors are indicated by the @a fatal parameter set
16374	to @c true. In case of fatal errors, the virtual machine
16375	execution is always paused before calling this notification, and
16376	the notification handler is supposed either to immediately save
16377	the virtual machine state using <link to="IConsole::saveState"/>
16378	or power it off using <link to="IConsole::powerDown"/>.
16379	Resuming the execution can lead to unpredictable results.
16380
16381	<b>Non-fatal</b> errors and warnings are indicated by the
16382	@a fatal parameter set to @c false. If the virtual machine
16383	is in the Paused state by the time the error notification is
16384	received, it means that the user can <i>try to resume</i> the machine
16385	execution after attempting to solve the problem that caused the
16386	error. In this case, the notification handler is supposed
16387	to show an appropriate message to the user (depending on the
16388	value of the @a id parameter) that offers several actions such
16389	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
16390	wants to retry, the notification handler should continue
16391	the machine execution using the <link to="IConsole::resume"/>
16392	call. If the machine execution is not Paused during this
16393	notification, then it means this notification is a <i>warning</i>
16394	(for example, about a fatal condition that can happen very soon);
16395	no immediate action is required from the user, the machine
16396	continues its normal execution.
16397
16398	Note that in either case the notification handler
16399	<b>must not</b> perform any action directly on a thread
16400	where this notification is called. Everything it is allowed to
16401	do is to post a message to another thread that will then talk
16402	to the user and take the corresponding action.
16403
16404	Currently, the following error identifiers are known:
16405	<ul>
16406	<li><tt>"HostMemoryLow"</tt></li>
16407	<li><tt>"HostAudioNotResponding"</tt></li>
16408	<li><tt>"VDIStorageFull"</tt></li>
16409	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
16410	</ul>
16411	</desc>
16412	<attribute name="fatal" type="boolean" readonly="yes">
16413	<desc>
16414	Whether the error is fatal or not.
16415	</desc>
16416	</attribute>
16417	<attribute name="id" type="wstring" readonly="yes">
16418	<desc>
16419	Error identifier.
16420	</desc>
16421	</attribute>
16422	<attribute name="message" type="wstring" readonly="yes">
16423	<desc>
16424	Optional error message.
16425	</desc>
16426	</attribute>
16427	</interface>
16428
16429
16430	<interface
16431	name="IEventSourceChangedEvent" extends="IEvent"
16432	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
16433	waitable="yes"
16434	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
16435	>
16436	<desc>
16437	Notification when an event source state changes (listener added or removed).
16438	</desc>
16439
16440	<attribute name="listener" type="IEventListener" readonly="yes">
16441	<desc>
16442	Event listener which has changed.
16443	</desc>
16444	</attribute>
16445
16446	<attribute name="add" type="boolean" readonly="yes">
16447	<desc>
16448	Flag whether listener was added or removed.
16449	</desc>
16450	</attribute>
16451	</interface>
16452
16453	<interface
16454	name="IExtraDataChangedEvent" extends="IEvent"
16455	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
16456	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
16457	>
16458	<desc>
16459	Notification when machine specific or global extra data
16460	has changed.
16461	</desc>
16462	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
16463	<desc>
16464	ID of the machine this event relates to.
16465	Null for global extra data changes.
16466	</desc>
16467	</attribute>
16468	<attribute name="key" type="wstring" readonly="yes">
16469	<desc>
16470	Extra data key that has changed.
16471	</desc>
16472	</attribute>
16473	<attribute name="value" type="wstring" readonly="yes">
16474	<desc>
16475	Extra data value for the given key.
16476	</desc>
16477	</attribute>
16478	</interface>
16479
16480	<interface
16481	name="IVetoEvent" extends="IEvent"
16482	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
16483	wsmap="managed"
16484	>
16485	<desc>Base abstract interface for veto events.</desc>
16486
16487	<method name="addVeto">
16488	<desc>
16489	Adds a veto on this event.
16490	</desc>
16491	<param name="reason" type="wstring" dir="in">
16492	<desc>
16493	Reason for veto, could be null or empty string.
16494	</desc>
16495	</param>
16496	</method>
16497
16498	<method name="isVetoed">
16499	<desc>
16500	If this event was vetoed.
16501	</desc>
16502	<param name="result" type="boolean" dir="return">
16503	<desc>
16504	Reason for veto.
16505	</desc>
16506	</param>
16507	</method>
16508
16509	<method name="getVetos">
16510	<desc>
16511	Current veto reason list, if size is 0 - no veto.
16512	</desc>
16513	<param name="result" type="wstring" dir="return" safearray="yes">
16514	<desc>
16515	Array of reasons for veto provided by different event handlers.
16516	</desc>
16517	</param>
16518	</method>
16519
16520	</interface>
16521
16522	<interface
16523	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
16524	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
16525	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
16526	waitable="true"
16527	>
16528	<desc>
16529	Notification when someone tries to change extra data for
16530	either the given machine or (if @c null) global extra data.
16531	This gives the chance to veto against changes.
16532	</desc>
16533	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
16534	<desc>
16535	ID of the machine this event relates to.
16536	Null for global extra data changes.
16537	</desc>
16538	</attribute>
16539	<attribute name="key" type="wstring" readonly="yes">
16540	<desc>
16541	Extra data key that has changed.
16542	</desc>
16543	</attribute>
16544	<attribute name="value" type="wstring" readonly="yes">
16545	<desc>
16546	Extra data value for the given key.
16547	</desc>
16548	</attribute>
16549	</interface>
16550
16551	<interface
16552	name="ICanShowWindowEvent" extends="IVetoEvent"
16553	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
16554	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
16555	waitable="true"
16556	>
16557	<desc>
16558	Notification when a call to
16559	<link to="IMachine::canShowConsoleWindow"/> is made by a
16560	front-end to check if a subsequent call to
16561	<link to="IMachine::showConsoleWindow"/> can succeed.
16562
16563	The callee should give an answer appropriate to the current
16564	machine state using event veto. This answer must
16565	remain valid at least until the next
16566	<link to="IConsole::state">machine state</link> change.
16567	</desc>
16568	</interface>
16569
16570	<interface
16571	name="IShowWindowEvent" extends="IEvent"
16572	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
16573	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
16574	waitable="true"
16575	>
16576	<desc>
16577	Notification when a call to
16578	<link to="IMachine::showConsoleWindow"/>
16579	requests the console window to be activated and brought to
16580	foreground on the desktop of the host PC.
16581
16582	This notification should cause the VM console process to
16583	perform the requested action as described above. If it is
16584	impossible to do it at a time of this notification, this
16585	method should return a failure.
16586
16587	Note that many modern window managers on many platforms
16588	implement some sort of focus stealing prevention logic, so
16589	that it may be impossible to activate a window without the
16590	help of the currently active application (which is supposedly
16591	an initiator of this notification). In this case, this method
16592	must return a non-zero identifier that represents the
16593	top-level window of the VM console process. The caller, if it
16594	represents a currently active process, is responsible to use
16595	this identifier (in a platform-dependent manner) to perform
16596	actual window activation.
16597
16598	This method must set @a winId to zero if it has performed all
16599	actions necessary to complete the request and the console
16600	window is now active and in foreground, to indicate that no
16601	further action is required on the caller's side.
16602	</desc>
16603	<attribute name="winId" type="long long">
16604	<desc>
16605	Platform-dependent identifier of the top-level VM console
16606	window, or zero if this method has performed all actions
16607	necessary to implement the <i>show window</i> semantics for
16608	the given platform and/or this VirtualBox front-end.
16609	</desc>
16610	</attribute>
16611	</interface>
16612
16613	<interface
16614	name="INATRedirectEvent" extends="IMachineEvent"
16615	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
16616	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
16617	>
16618	<desc>
16619	Notification when NAT redirect rule added or removed.
16620	</desc>
16621	<attribute name="slot" type="unsigned long" readonly="yes">
16622	<desc>
16623	Adapter which NAT attached to.
16624	</desc>
16625	</attribute>
16626	<attribute name="remove" type="boolean" readonly="yes">
16627	<desc>
16628	Whether rule remove or add.
16629	</desc>
16630	</attribute>
16631	<attribute name="name" type="wstring" readonly="yes">
16632	<desc>
16633	Name of the rule.
16634	</desc>
16635	</attribute>
16636	<attribute name="proto" type="NATProtocol" readonly="yes">
16637	<desc>
16638	Protocol (TCP or UDP) of the redirect rule.
16639	</desc>
16640	</attribute>
16641	<attribute name="hostIp" type="wstring" readonly="yes">
16642	<desc>
16643	Host ip address to bind socket on.
16644	</desc>
16645	</attribute>
16646	<attribute name="hostPort" type="long" readonly="yes">
16647	<desc>
16648	Host port to bind socket on.
16649	</desc>
16650	</attribute>
16651	<attribute name="guestIp" type="wstring" readonly="yes">
16652	<desc>
16653	Guest ip address to redirect to.
16654	</desc>
16655	</attribute>
16656	<attribute name="guestPort" type="long" readonly="yes">
16657	<desc>
16658	Guest port to redirect to.
16659	</desc>
16660	</attribute>
16661	</interface>
16662
16663	<interface
16664	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
16665	waitable="yes"
16666	uuid="9cebfc27-c579-4965-8eb7-d31794cd7dcf"
16667	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
16668	>
16669	<desc>
16670	Notification when host PCI device is plugged/unplugged. Plugging
16671	usually takes place on VM startup, unplug - when
16672	IMachine::DetachHostPciDevice is called.
16673
16674	<see>IMachine::DetachHostPciDevice</see>
16675
16676	</desc>
16677
16678	<attribute name="plugged" type="boolean" readonly="yes">
16679	<desc>
16680	If device successfully plugged or unplugged.
16681	</desc>
16682	</attribute>
16683
16684	<attribute name="success" type="boolean" readonly="yes">
16685	<desc>
16686	If operation was successful, if false - 'message' attribute
16687	may be of interest.
16688	</desc>
16689	</attribute>
16690
16691	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
16692	<desc>
16693	Attachment info for this device.
16694	</desc>
16695	</attribute>
16696
16697	<attribute name="message" type="wstring" readonly="yes">
16698	<desc>
16699	Optional error message.
16700	</desc>
16701	</attribute>
16702
16703	</interface>
16704
16705	<interface
16706	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
16707	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
16708	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
16709	>
16710	<desc>
16711	Notification when VBoxSVC becomes unavailable (due to a crash or similar
16712	unexpected circumstances) or available again.
16713	</desc>
16714
16715	<attribute name="available" type="boolean" readonly="yes">
16716	<desc>
16717	Whether VBoxSVC is available now.
16718	</desc>
16719	</attribute>
16720	</interface>
16721
16722	<interface
16723	name="IBandwidthGroupChangedEvent" extends="IEvent"
16724	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
16725	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
16726	>
16727	<desc>
16728	Notification when one of the bandwidth groups changed
16729	</desc>
16730	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
16731	<desc>
16732	The changed bandwidth group.
16733	</desc>
16734	</attribute>
16735	</interface>
16736
16737	<enum
16738	name="GuestMonitorChangedEventType"
16739	uuid="ef172985-7e36-4297-95be-e46396968d66"
16740	>
16741
16742	<desc>
16743	How the guest monitor has been changed.
16744	</desc>
16745
16746	<const name="Enabled" value="0">
16747	<desc>
16748	The guest monitor has been enabled by the guest.
16749	</desc>
16750	</const>
16751
16752	<const name="Disabled" value="1">
16753	<desc>
16754	The guest monitor has been disabled by the guest.
16755	</desc>
16756	</const>
16757
16758	<const name="NewOrigin" value="2">
16759	<desc>
16760	The guest monitor origin has changed in the guest.
16761	</desc>
16762	</const>
16763	</enum>
16764
16765	<interface
16766	name="IGuestMonitorChangedEvent" extends="IEvent"
16767	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
16768	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
16769	>
16770	<desc>
16771	Notification when the guest enables one of its monitors.
16772	</desc>
16773
16774	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
16775	<desc>
16776	What was changed for this guest monitor.
16777	</desc>
16778	</attribute>
16779
16780	<attribute name="screenId" type="unsigned long" readonly="yes">
16781	<desc>
16782	The monitor which was changed.
16783	</desc>
16784	</attribute>
16785
16786	<attribute name="originX" type="unsigned long" readonly="yes">
16787	<desc>
16788	Physical X origin relative to the primary screen.
16789	Valid for Enabled and NewOrigin.
16790	</desc>
16791	</attribute>
16792
16793	<attribute name="originY" type="unsigned long" readonly="yes">
16794	<desc>
16795	Physical Y origin relative to the primary screen.
16796	Valid for Enabled and NewOrigin.
16797	</desc>
16798	</attribute>
16799
16800	<attribute name="width" type="unsigned long" readonly="yes">
16801	<desc>
16802	Width of the screen.
16803	Valid for Enabled.
16804	</desc>
16805	</attribute>
16806
16807	<attribute name="height" type="unsigned long" readonly="yes">
16808	<desc>
16809	Height of the screen.
16810	Valid for Enabled.
16811	</desc>
16812	</attribute>
16813
16814	</interface>
16815
16816	<module name="VBoxSVC" context="LocalServer">
16817	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
16818	namespace="virtualbox.org">
16819	<interface name="IVirtualBox" default="yes"/>
16820	</class>
16821	</module>
16822
16823	<module name="VBoxC" context="InprocServer" threadingModel="Free">
16824	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
16825	namespace="virtualbox.org">
16826	<interface name="IVirtualBoxClient" default="yes"/>
16827	</class>
16828
16829	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
16830	namespace="virtualbox.org">
16831	<interface name="ISession" default="yes"/>
16832	</class>
16833	</module>
16834
16835	</library>
16836
16837	</idl>
16838
16839	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format