VirtualBox.xidl@ 36679

Last change on this file since 36679 was 36673, checked in by vboxsync, 14 years ago
Main/Machine: add a way to terminate VM processes if they don't respond to the usual requests. Not an API change, just a comment change, and a slight VBoxManage touch up so that one can trigger it.
Property svn:eol-style set to `native`
File size: 617.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="v1_12" value="14">
484	<desc>Settings version "1.12", written by VirtualBox 4.1.x.</desc>
485	<!--
486	Machine changes: raw PCI device attachment;
487	NetworkAdapter changes: bandwidth group.
488	-->
489	</const>
490
491	<const name="Future" value="99999">
492	<desc>Settings version greater than "1.11", written by a future VirtualBox version.</desc>
493	</const>
494	</enum>
495
496	<enum
497	name="AccessMode"
498	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
499	>
500	<desc>
501	Access mode for opening files.
502	</desc>
503
504	<const name="ReadOnly" value="1"/>
505	<const name="ReadWrite" value="2"/>
506	</enum>
507
508	<enum
509	name="MachineState"
510	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
511	>
512	<desc>
513	Virtual machine execution state.
514
515	This enumeration represents possible values of the <link
516	to="IMachine::state"/> attribute.
517
518	Below is the basic virtual machine state diagram. It shows how the state
519	changes during virtual machine execution. The text in square braces shows
520	a method of the IConsole interface that performs the given state
521	transition.
522
523	<pre>
524	+---------[powerDown()] <- Stuck <--[failure]-+
525	V \|
526	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
527	\| \| \| \| V \|
528	\| Aborted -----+ +--> Running --[pause()]--> Paused
529	\| \| ^ \| ^ \|
530	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
531	\| ^ \| \| \| \|
532	\| \| +-----------------------------------------+-\|-------------------+ +
533	\| \| \| \| \|
534	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
535	\| \| \| \|
536	\| +-------- Saving <--------[saveState()]<----------+---------------------+
537	\| \| \|
538	+-------------- Stopping -------[powerDown()]<----------+---------------------+
539	</pre>
540
541	Note that states to the right from PoweredOff, Aborted and Saved in the
542	above diagram are called <i>online VM states</i>. These states
543	represent the virtual machine which is being executed in a dedicated
544	process (usually with a GUI window attached to it where you can see the
545	activity of the virtual machine and interact with it). There are two
546	special pseudo-states, FirstOnline and LastOnline, that can be used in
547	relational expressions to detect if the given machine state is online or
548	not:
549
550	<pre>
551	if (machine.GetState() >= MachineState_FirstOnline &&
552	machine.GetState() <= MachineState_LastOnline)
553	{
554	...the machine is being executed...
555	}
556	</pre>
557
558	When the virtual machine is in one of the online VM states (that is, being
559	executed), only a few machine settings can be modified. Methods working
560	with such settings contain an explicit note about that. An attempt to
561	change any oter setting or perform a modifying operation during this time
562	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
563
564	All online states except Running, Paused and Stuck are transitional: they
565	represent temporary conditions of the virtual machine that will last as
566	long as the operation that initiated such a condition.
567
568	The Stuck state is a special case. It means that execution of the machine
569	has reached the "Guru Meditation" condition. This condition indicates an
570	internal VMM (virtual machine manager) failure which may happen as a
571	result of either an unhandled low-level virtual hardware exception or one
572	of the recompiler exceptions (such as the <i>too-many-traps</i>
573	condition).
574
575	Note also that any online VM state may transit to the Aborted state. This
576	happens if the process that is executing the virtual machine terminates
577	unexpectedly (for example, crashes). Other than that, the Aborted state is
578	equivalent to PoweredOff.
579
580	There are also a few additional state diagrams that do not deal with
581	virtual machine execution and therefore are shown separately. The states
582	shown on these diagrams are called <i>offline VM states</i> (this includes
583	PoweredOff, Aborted and Saved too).
584
585	The first diagram shows what happens when a lengthy setup operation is
586	being executed (such as <link to="IMachine::attachDevice"/>).
587
588	<pre>
589	+----------------------------------(same state as before the call)------+
590	\| \|
591	+-> PoweredOff --+ \|
592	\| \| \|
593	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
594	\| \|
595	+-> Saved -------+
596	</pre>
597
598	The next two diagrams demonstrate the process of taking a snapshot of a
599	powered off virtual machine, restoring the state to that as of a snapshot
600	or deleting a snapshot, respectively.
601
602	<pre>
603	+----------------------------------(same state as before the call)------+
604	\| \|
605	+-> PoweredOff --+ \|
606	\| +-->[takeSnapshot()] -------------------> Saving ------+
607	+-> Aborted -----+
608
609	+-> PoweredOff --+
610	\| \|
611	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
612	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
613	+-> Saved -------+ \|
614	\| \|
615	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
616	</pre>
617
618	Note that the Saving state is present in both the offline state group and
619	online state group. Currently, the only way to determine what group is
620	assumed in a particular case is to remember the previous machine state: if
621	it was Running or Paused, then Saving is an online state, otherwise it is
622	an offline state. This inconsistency may be removed in one of the future
623	versions of VirtualBox by adding a new state.
624
625	<note internal="yes">
626	For whoever decides to touch this enum: In order to keep the
627	comparisons involving FirstOnline and LastOnline pseudo-states valid,
628	the numeric values of these states must be correspondingly updated if
629	needed: for any online VM state, the condition
630	<tt>FirstOnline <= state <= LastOnline</tt> must be
631	@c true. The same relates to transient states for which
632	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
633	@c true.
634	</note>
635	</desc>
636
637	<const name="Null" value="0">
638	<desc>Null value (never used by the API).</desc>
639	</const>
640	<const name="PoweredOff" value="1">
641	<desc>
642	The machine is not running and has no saved execution state; it has
643	either never been started or been shut down successfully.
644	</desc>
645	</const>
646	<const name="Saved" value="2">
647	<desc>
648	The machine is not currently running, but the execution state of the machine
649	has been saved to an external file when it was running, from where
650	it can be resumed.
651	</desc>
652	</const>
653	<const name="Teleported" value="3">
654	<desc>
655	The machine was teleported to a different host (or process) and then
656	powered off. Take care when powering it on again may corrupt resources
657	it shares with the teleportation target (e.g. disk and network).
658	</desc>
659	</const>
660	<const name="Aborted" value="4">
661	<desc>
662	The process running the machine has terminated abnormally. This may
663	indicate a crash of the VM process in host execution context, or
664	the VM process has been terminated externally.
665	</desc>
666	</const>
667	<const name="Running" value="5">
668	<desc>
669	The machine is currently being executed.
670	<note internal="yes">
671	For whoever decides to touch this enum: In order to keep the
672	comparisons in the old source code valid, this state must immediately
673	precede the Paused state.
674	TODO: Lift this spectacularly wonderful restriction.
675	</note>
676	</desc>
677	</const>
678	<const name="Paused" value="6">
679	<desc>
680	Execution of the machine has been paused.
681	<note internal="yes">
682	For whoever decides to touch this enum: In order to keep the
683	comparisons in the old source code valid, this state must immediately
684	follow the Running state.
685	TODO: Lift this spectacularly wonderful restriction.
686	</note>
687	</desc>
688	</const>
689	<const name="Stuck" value="7">
690	<desc>
691	Execution of the machine has reached the "Guru Meditation"
692	condition. This indicates a severe error in the hypervisor itself.
693	<note internal="yes">
694	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
695	"Guru", perhaps? Or are there some other VMM states that are
696	intended to be lumped in here as well?
697	</note>
698	</desc>
699	</const>
700	<const name="Teleporting" value="8">
701	<desc>
702	The machine is about to be teleported to a different host or process.
703	It is possible to pause a machine in this state, but it will go to the
704	@c TeleportingPausedVM state and it will not be
705	possible to resume it again unless the teleportation fails.
706	</desc>
707	</const>
708	<const name="LiveSnapshotting" value="9">
709	<desc>
710	A live snapshot is being taken. The machine is running normally, but
711	some of the runtime configuration options are inaccessible. Also, if
712	paused while in this state it will transition to
713	@c Saving and it will not be resume the
714	execution until the snapshot operation has completed.
715	</desc>
716	</const>
717	<const name="Starting" value="10">
718	<desc>
719	Machine is being started after powering it on from a
720	zero execution state.
721	</desc>
722	</const>
723	<const name="Stopping" value="11">
724	<desc>
725	Machine is being normally stopped powering it off, or after the guest OS
726	has initiated a shutdown sequence.
727	</desc>
728	</const>
729	<const name="Saving" value="12">
730	<desc>
731	Machine is saving its execution state to a file, or an online
732	snapshot of the machine is being taken.
733	</desc>
734	</const>
735	<const name="Restoring" value="13">
736	<desc>
737	Execution state of the machine is being restored from a file
738	after powering it on from the saved execution state.
739	</desc>
740	</const>
741	<const name="TeleportingPausedVM" value="14">
742	<desc>
743	The machine is being teleported to another host or process, but it is
744	not running. This is the paused variant of the
745	@c state.
746	</desc>
747	</const>
748	<const name="TeleportingIn" value="15">
749	<desc>
750	Teleporting the machine state in from another host or process.
751	</desc>
752	</const>
753	<const name="FaultTolerantSyncing" value="16">
754	<desc>
755	The machine is being synced with a fault tolerant VM running elsewhere.
756	</desc>
757	</const>
758	<const name="DeletingSnapshotOnline" value="17">
759	<desc>
760	Like @c DeletingSnapshot, but the merging of media is ongoing in
761	the background while the machine is running.
762	</desc>
763	</const>
764	<const name="DeletingSnapshotPaused" value="18">
765	<desc>
766	Like @c DeletingSnapshotOnline, but the machine was paused when the
767	merging of differencing media was started.
768	</desc>
769	</const>
770	<const name="RestoringSnapshot" value="19">
771	<desc>
772	A machine snapshot is being restored; this typically does not take long.
773	</desc>
774	</const>
775	<const name="DeletingSnapshot" value="20">
776	<desc>
777	A machine snapshot is being deleted; this can take a long time since this
778	may require merging differencing media. This value indicates that the
779	machine is not running while the snapshot is being deleted.
780	</desc>
781	</const>
782	<const name="SettingUp" value="21">
783	<desc>
784	Lengthy setup operation is in progress.
785	</desc>
786	</const>
787
788	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
789	<desc>
790	Pseudo-state: first online state (for use in relational expressions).
791	</desc>
792	</const>
793	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
794	<desc>
795	Pseudo-state: last online state (for use in relational expressions).
796	</desc>
797	</const>
798
799	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
800	<desc>
801	Pseudo-state: first transient state (for use in relational expressions).
802	</desc>
803	</const>
804	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
805	<desc>
806	Pseudo-state: last transient state (for use in relational expressions).
807	</desc>
808	</const>
809
810	</enum>
811
812	<enum
813	name="SessionState"
814	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
815	>
816	<desc>
817	Session state. This enumeration represents possible values of
818	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
819	attributes.
820	</desc>
821
822	<const name="Null" value="0">
823	<desc>Null value (never used by the API).</desc>
824	</const>
825	<const name="Unlocked" value="1">
826	<desc>
827	In <link to="IMachine::sessionState"/>, this means that the machine
828	is not locked for any sessions.
829
830	In <link to="ISession::state"/>, this means that no machine is
831	currently locked for this session.
832	</desc>
833	</const>
834	<const name="Locked" value="2">
835	<desc>
836	In <link to="IMachine::sessionState"/>, this means that the machine
837	is currently locked for a session, whose process identifier can
838	then be found in the <link to="IMachine::sessionPid" /> attribute.
839
840	In <link to="ISession::state"/>, this means that a machine is
841	currently locked for this session, and the mutable machine object
842	can be found in the <link to="ISession::machine"/> attribute
843	(see <link to="IMachine::lockMachine" /> for details).
844	</desc>
845	</const>
846	<const name="Spawning" value="3">
847	<desc>
848	A new process is being spawned for the machine as a result of
849	<link to="IMachine::launchVMProcess"/> call. This state also occurs
850	as a short transient state during an <link to="IMachine::lockMachine"/>
851	call.
852	</desc>
853	</const>
854	<const name="Unlocking" value="4">
855	<desc>
856	The session is being unlocked.
857	</desc>
858	</const>
859	</enum>
860
861	<enum
862	name="CPUPropertyType"
863	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
864	>
865	<desc>
866	Virtual CPU property type. This enumeration represents possible values of the
867	IMachine get- and setCPUProperty methods.
868	</desc>
869	<const name="Null" value="0">
870	<desc>Null value (never used by the API).</desc>
871	</const>
872	<const name="PAE" value="1">
873	<desc>
874	This setting determines whether VirtualBox will expose the Physical Address
875	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
876	is not available, it will not be reported.
877	</desc>
878	</const>
879	<const name="Synthetic" value="2">
880	<desc>
881	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
882	teleporting between host systems that differ significantly.
883	</desc>
884	</const>
885	</enum>
886
887
888	<enum
889	name="HWVirtExPropertyType"
890	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
891	>
892	<desc>
893	Hardware virtualization property type. This enumeration represents possible values
894	for the <link to="IMachine::getHWVirtExProperty"/> and
895	<link to="IMachine::setHWVirtExProperty"/> methods.
896	</desc>
897	<const name="Null" value="0">
898	<desc>Null value (never used by the API).</desc>
899	</const>
900	<const name="Enabled" value="1">
901	<desc>
902	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
903	such extensions are not available, they will not be used.
904	</desc>
905	</const>
906	<const name="Exclusive" value="2">
907	<desc>
908	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
909	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
910	feature of the host. To share these with other hypervisors, you must disable this property.
911	</desc>
912	</const>
913	<const name="VPID" value="3">
914	<desc>
915	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
916	</desc>
917	</const>
918	<const name="NestedPaging" value="4">
919	<desc>
920	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
921	</desc>
922	</const>
923	<const name="LargePages" value="5">
924	<desc>
925	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
926	</desc>
927	</const>
928	<const name="Force" value="6">
929	<desc>
930	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
931	not set, there will be an automatic fallback to software virtualization.
932	</desc>
933	</const>
934	</enum>
935
936	<enum
937	name="FaultToleranceState"
938	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
939	>
940	<desc>
941	Used with <link to="IMachine::faultToleranceState" />.
942	</desc>
943	<const name="Inactive" value="1">
944	<desc>No fault tolerance enabled.</desc>
945	</const>
946	<const name="Master" value="2">
947	<desc>Fault tolerant master VM.</desc>
948	</const>
949	<const name="Standby" value="3">
950	<desc>Fault tolerant standby VM.</desc>
951	</const>
952	</enum>
953
954	<enum
955	name="LockType"
956	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
957	>
958	<desc>
959	Used with <link to="IMachine::lockMachine" />.
960	</desc>
961	<const name="Write" value="2">
962	<desc>Lock the machine for writing.</desc>
963	</const>
964	<const name="Shared" value="1">
965	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
966	</const>
967	</enum>
968
969	<enum
970	name="SessionType"
971	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
972	>
973	<desc>
974	Session type. This enumeration represents possible values of the
975	<link to="ISession::type"/> attribute.
976	</desc>
977
978	<const name="Null" value="0">
979	<desc>Null value (never used by the API).</desc>
980	</const>
981	<const name="WriteLock" value="1">
982	<desc>
983	Session has acquired an exclusive write lock on a machine
984	using <link to="IMachine::lockMachine"/>.
985	</desc>
986	</const>
987	<const name="Remote" value="2">
988	<desc>
989	Session has launched a VM process using
990	<link to="IMachine::launchVMProcess"/>
991	</desc>
992	</const>
993	<const name="Shared" value="3">
994	<desc>
995	Session has obtained a link to another session using
996	<link to="IMachine::lockMachine"/>
997	</desc>
998	</const>
999	</enum>
1000
1001	<enum
1002	name="DeviceType"
1003	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1004	>
1005	<desc>
1006	Device type.
1007	</desc>
1008	<const name="Null" value="0">
1009	<desc>
1010	Null value, may also mean "no device" (not allowed for
1011	<link to="IConsole::getDeviceActivity"/>).
1012	</desc>
1013	</const>
1014	<const name="Floppy" value="1">
1015	<desc>Floppy device.</desc>
1016	</const>
1017	<const name="DVD" value="2">
1018	<desc>CD/DVD-ROM device.</desc>
1019	</const>
1020	<const name="HardDisk" value="3">
1021	<desc>Hard disk device.</desc>
1022	</const>
1023	<const name="Network" value="4">
1024	<desc>Network device.</desc>
1025	</const>
1026	<const name="USB" value="5">
1027	<desc>USB device.</desc>
1028	</const>
1029	<const name="SharedFolder" value="6">
1030	<desc>Shared folder device.</desc>
1031	</const>
1032	</enum>
1033
1034	<enum
1035	name="DeviceActivity"
1036	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1037	>
1038	<desc>
1039	Device activity for <link to="IConsole::getDeviceActivity"/>.
1040	</desc>
1041
1042	<const name="Null" value="0"/>
1043	<const name="Idle" value="1"/>
1044	<const name="Reading" value="2"/>
1045	<const name="Writing" value="3"/>
1046	</enum>
1047
1048	<enum
1049	name="ClipboardMode"
1050	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1051	>
1052	<desc>
1053	Host-Guest clipboard interchange mode.
1054	</desc>
1055
1056	<const name="Disabled" value="0"/>
1057	<const name="HostToGuest" value="1"/>
1058	<const name="GuestToHost" value="2"/>
1059	<const name="Bidirectional" value="3"/>
1060	</enum>
1061
1062	<enum
1063	name="Scope"
1064	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1065	>
1066	<desc>
1067	Scope of the operation.
1068
1069	A generic enumeration used in various methods to define the action or
1070	argument scope.
1071	</desc>
1072
1073	<const name="Global" value="0"/>
1074	<const name="Machine" value="1"/>
1075	<const name="Session" value="2"/>
1076	</enum>
1077
1078	<enum
1079	name="BIOSBootMenuMode"
1080	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1081	>
1082	<desc>
1083	BIOS boot menu mode.
1084	</desc>
1085
1086	<const name="Disabled" value="0"/>
1087	<const name="MenuOnly" value="1"/>
1088	<const name="MessageAndMenu" value="2"/>
1089	</enum>
1090
1091	<enum
1092	name="ProcessorFeature"
1093	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1094	>
1095	<desc>
1096	CPU features.
1097	</desc>
1098
1099	<const name="HWVirtEx" value="0"/>
1100	<const name="PAE" value="1"/>
1101	<const name="LongMode" value="2"/>
1102	<const name="NestedPaging" value="3"/>
1103	</enum>
1104
1105	<enum
1106	name="FirmwareType"
1107	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1108	>
1109	<desc>
1110	Firmware type.
1111	</desc>
1112	<const name="BIOS" value="1">
1113	<desc>BIOS Firmware.</desc>
1114	</const>
1115	<const name="EFI" value="2">
1116	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1117	</const>
1118	<const name="EFI32" value="3">
1119	<desc>Efi firmware, 32-bit.</desc>
1120	</const>
1121	<const name="EFI64" value="4">
1122	<desc>Efi firmware, 64-bit.</desc>
1123	</const>
1124	<const name="EFIDUAL" value="5">
1125	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1126	</const>
1127	</enum>
1128
1129	<enum
1130	name="PointingHidType"
1131	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1132	>
1133	<desc>
1134	Type of pointing device used in a virtual machine.
1135	</desc>
1136	<const name="None" value="1">
1137	<desc>No mouse.</desc>
1138	</const>
1139	<const name="PS2Mouse" value="2">
1140	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1141	</const>
1142	<const name="USBMouse" value="3">
1143	<desc>USB mouse (relative pointer).</desc>
1144	</const>
1145	<const name="USBTablet" value="4">
1146	<desc>USB tablet (absolute pointer).</desc>
1147	</const>
1148	<const name="ComboMouse" value="5">
1149	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1150	Using of such device can have negative performance implications. </desc>
1151	</const>
1152	</enum>
1153
1154	<enum
1155	name="KeyboardHidType"
1156	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1157	>
1158	<desc>
1159	Type of keyboard device used in a virtual machine.
1160	</desc>
1161	<const name="None" value="1">
1162	<desc>No keyboard.</desc>
1163	</const>
1164	<const name="PS2Keyboard" value="2">
1165	<desc>PS/2 keyboard.</desc>
1166	</const>
1167	<const name="USBKeyboard" value="3">
1168	<desc>USB keyboard.</desc>
1169	</const>
1170	<const name="ComboKeyboard" value="4">
1171	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1172	Using of such device can have negative performance implications. </desc>
1173	</const>
1174	</enum>
1175
1176	<!--
1177	// IVirtualBoxErrorInfo
1178	/////////////////////////////////////////////////////////////////////////
1179	-->
1180
1181	<interface
1182	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1183	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1184	supportsErrorInfo="no"
1185	wsmap="managed"
1186	>
1187	<desc>
1188	The IVirtualBoxErrorInfo interface represents extended error information.
1189
1190	Extended error information can be set by VirtualBox components after
1191	unsuccessful or partially successful method invocation. This information
1192	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1193	and then shown to the client in addition to the plain 32-bit result code.
1194
1195	In MS COM, this interface extends the IErrorInfo interface,
1196	in XPCOM, it extends the nsIException interface. In both cases,
1197	it provides a set of common attributes to retrieve error
1198	information.
1199
1200	Sometimes invocation of some component's method may involve methods of
1201	other components that may also fail (independently of this method's
1202	failure), or a series of non-fatal errors may precede a fatal error that
1203	causes method failure. In cases like that, it may be desirable to preserve
1204	information about all errors happened during method invocation and deliver
1205	it to the caller. The <link to="#next"/> attribute is intended
1206	specifically for this purpose and allows to represent a chain of errors
1207	through a single IVirtualBoxErrorInfo object set after method invocation.
1208
1209	Note that errors are stored to a chain in the reverse order, i.e. the
1210	initial error object you query right after method invocation is the last
1211	error set by the callee, the object it points to in the @a next attribute
1212	is the previous error and so on, up to the first error (which is the last
1213	in the chain).
1214	</desc>
1215
1216	<attribute name="resultCode" type="long" readonly="yes">
1217	<desc>
1218	Result code of the error.
1219	Usually, it will be the same as the result code returned
1220	by the method that provided this error information, but not
1221	always. For example, on Win32, CoCreateInstance() will most
1222	likely return E_NOINTERFACE upon unsuccessful component
1223	instantiation attempt, but not the value the component factory
1224	returned. Value is typed 'long', not 'result',
1225	to make interface usable from scripting languages.
1226	<note>
1227	In MS COM, there is no equivalent.
1228	In XPCOM, it is the same as nsIException::result.
1229	</note>
1230	</desc>
1231	</attribute>
1232
1233	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1234	<desc>
1235	UUID of the interface that defined the error.
1236	<note>
1237	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1238	data type.
1239	In XPCOM, there is no equivalent.
1240	</note>
1241	</desc>
1242	</attribute>
1243
1244	<attribute name="component" type="wstring" readonly="yes">
1245	<desc>
1246	Name of the component that generated the error.
1247	<note>
1248	In MS COM, it is the same as IErrorInfo::GetSource.
1249	In XPCOM, there is no equivalent.
1250	</note>
1251	</desc>
1252	</attribute>
1253
1254	<attribute name="text" type="wstring" readonly="yes">
1255	<desc>
1256	Text description of the error.
1257	<note>
1258	In MS COM, it is the same as IErrorInfo::GetDescription.
1259	In XPCOM, it is the same as nsIException::message.
1260	</note>
1261	</desc>
1262	</attribute>
1263
1264	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1265	<desc>
1266	Next error object if there is any, or @c null otherwise.
1267	<note>
1268	In MS COM, there is no equivalent.
1269	In XPCOM, it is the same as nsIException::inner.
1270	</note>
1271	</desc>
1272	</attribute>
1273
1274	</interface>
1275
1276	<!--
1277	// IVirtualBox
1278	/////////////////////////////////////////////////////////////////////////
1279	-->
1280
1281	<interface
1282	name="IDHCPServer" extends="$unknown"
1283	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1284	wsmap="managed"
1285	>
1286	<desc>
1287	The IDHCPServer interface represents the vbox dhcp server configuration.
1288
1289	To enumerate all the dhcp servers on the host, use the
1290	<link to="IVirtualBox::DHCPServers"/> attribute.
1291	</desc>
1292
1293	<attribute name="enabled" type="boolean">
1294	<desc>
1295	specifies if the dhcp server is enabled
1296	</desc>
1297	</attribute>
1298
1299	<attribute name="IPAddress" type="wstring" readonly="yes">
1300	<desc>
1301	specifies server IP
1302	</desc>
1303	</attribute>
1304
1305	<attribute name="networkMask" type="wstring" readonly="yes">
1306	<desc>
1307	specifies server network mask
1308	</desc>
1309	</attribute>
1310
1311	<attribute name="networkName" type="wstring" readonly="yes">
1312	<desc>
1313	specifies internal network name the server is used for
1314	</desc>
1315	</attribute>
1316
1317	<attribute name="lowerIP" type="wstring" readonly="yes">
1318	<desc>
1319	specifies from IP address in server address range
1320	</desc>
1321	</attribute>
1322
1323	<attribute name="upperIP" type="wstring" readonly="yes">
1324	<desc>
1325	specifies to IP address in server address range
1326	</desc>
1327	</attribute>
1328
1329	<method name="setConfiguration">
1330	<desc>
1331	configures the server
1332	<result name="E_INVALIDARG">
1333	invalid configuration supplied
1334	</result>
1335	</desc>
1336	<param name="IPAddress" type="wstring" dir="in">
1337	<desc>
1338	server IP address
1339	</desc>
1340	</param>
1341	<param name="networkMask" type="wstring" dir="in">
1342	<desc>
1343	server network mask
1344	</desc>
1345	</param>
1346	<param name="FromIPAddress" type="wstring" dir="in">
1347	<desc>
1348	server From IP address for address range
1349	</desc>
1350	</param>
1351	<param name="ToIPAddress" type="wstring" dir="in">
1352	<desc>
1353	server To IP address for address range
1354	</desc>
1355	</param>
1356	</method>
1357
1358	<method name="start">
1359	<desc>
1360	Starts DHCP server process.
1361	<result name="E_FAIL">
1362	Failed to start the process.
1363	</result>
1364	</desc>
1365	<param name="networkName" type="wstring" dir="in">
1366	<desc>
1367	Name of internal network DHCP server should attach to.
1368	</desc>
1369	</param>
1370	<param name="trunkName" type="wstring" dir="in">
1371	<desc>
1372	Name of internal network trunk.
1373	</desc>
1374	</param>
1375	<param name="trunkType" type="wstring" dir="in">
1376	<desc>
1377	Type of internal network trunk.
1378	</desc>
1379	</param>
1380	</method>
1381
1382	<method name="stop">
1383	<desc>
1384	Stops DHCP server process.
1385	<result name="E_FAIL">
1386	Failed to stop the process.
1387	</result>
1388	</desc>
1389	</method>
1390	</interface>
1391
1392	<interface
1393	name="IVirtualBox" extends="$unknown"
1394	uuid="d2de270c-1d4b-4c9e-843f-bbb9b47269ff"
1395	wsmap="managed"
1396	>
1397	<desc>
1398	The IVirtualBox interface represents the main interface exposed by the
1399	product that provides virtual machine management.
1400
1401	An instance of IVirtualBox is required for the product to do anything
1402	useful. Even though the interface does not expose this, internally,
1403	IVirtualBox is implemented as a singleton and actually lives in the
1404	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1405	IVirtualBox can track the state of all virtual machines on a particular
1406	host, regardless of which frontend started them.
1407
1408	To enumerate all the virtual machines on the host, use the
1409	<link to="IVirtualBox::machines"/> attribute.
1410	</desc>
1411
1412	<attribute name="version" type="wstring" readonly="yes">
1413	<desc>
1414	A string representing the version number of the product. The
1415	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1416	last number represents the build number and will frequently change.
1417	</desc>
1418	</attribute>
1419
1420	<attribute name="revision" type="unsigned long" readonly="yes">
1421	<desc>
1422	The internal build revision number of the product.
1423	</desc>
1424	</attribute>
1425
1426	<attribute name="packageType" type="wstring" readonly="yes">
1427	<desc>
1428	A string representing the package type of this product. The
1429	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1430	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1431	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1432	this.
1433	</desc>
1434	</attribute>
1435
1436	<attribute name="homeFolder" type="wstring" readonly="yes">
1437	<desc>
1438	Full path to the directory where the global settings file,
1439	<tt>VirtualBox.xml</tt>, is stored.
1440
1441	In this version of VirtualBox, the value of this property is
1442	always <tt><user_dir>/.VirtualBox</tt> (where
1443	<tt><user_dir></tt> is the path to the user directory,
1444	as determined by the host OS), and cannot be changed.
1445
1446	This path is also used as the base to resolve relative paths in
1447	places where relative paths are allowed (unless otherwise
1448	expressly indicated).
1449	</desc>
1450	</attribute>
1451
1452	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1453	<desc>
1454	Full name of the global settings file.
1455	The value of this property corresponds to the value of
1456	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1457	</desc>
1458	</attribute>
1459
1460	<attribute name="host" type="IHost" readonly="yes">
1461	<desc>Associated host object.</desc>
1462	</attribute>
1463
1464	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1465	<desc>Associated system information object.</desc>
1466	</attribute>
1467
1468	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1469	<desc>
1470	Array of machine objects registered within this VirtualBox instance.
1471	</desc>
1472	</attribute>
1473
1474	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1475	<desc>
1476	Array of medium objects known to this VirtualBox installation.
1477
1478	This array contains only base media. All differencing
1479	media of the given base medium can be enumerated using
1480	<link to="IMedium::children"/>.
1481	</desc>
1482	</attribute>
1483
1484	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1485	<desc>
1486	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1487	</desc>
1488	</attribute>
1489
1490	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1491	<desc>
1492	Array of floppy image objects currently in use by this VirtualBox instance.
1493	</desc>
1494	</attribute>
1495
1496	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1497
1498	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1499
1500	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1501	<desc>
1502	Collection of global shared folders. Global shared folders are
1503	available to all virtual machines.
1504
1505	New shared folders are added to the collection using
1506	<link to="#createSharedFolder"/>. Existing shared folders can be
1507	removed using <link to="#removeSharedFolder"/>.
1508
1509	<note>
1510	In the current version of the product, global shared folders are not
1511	implemented and therefore this collection is always empty.
1512	</note>
1513	</desc>
1514	</attribute>
1515
1516	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1517	<desc>
1518	Associated performance collector object.
1519	</desc>
1520	</attribute>
1521
1522	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1523	<desc>
1524	DHCP servers.
1525	</desc>
1526	</attribute>
1527
1528	<attribute name="eventSource" type="IEventSource" readonly="yes">
1529	<desc>
1530	Event source for VirtualBox events.
1531	</desc>
1532	</attribute>
1533
1534	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1535	<desc>
1536	The extension pack manager.
1537	</desc>
1538	</attribute>
1539
1540
1541	<method name="composeMachineFilename">
1542	<desc>
1543	Returns a recommended full path of the settings file name for a new virtual
1544	machine.
1545
1546	This API serves two purposes:
1547
1548	<ul>
1549	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1550	for the @a settingsFile argument there, which means that API should use
1551	a recommended default file name.</li>
1552
1553	<li>It can be called manually by a client software before creating a machine,
1554	e.g. if that client wants to pre-create the machine directory to create
1555	virtual hard disks in that directory together with the new machine
1556	settings file. In that case, the file name should be stripped from the
1557	full settings file path returned by this function to obtain the
1558	machine directory.</li>
1559	</ul>
1560
1561	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1562	details about the machine name.
1563
1564	If @a baseFolder is a @c null or empty string (which is recommended), the
1565	default machine settings folder
1566	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1567	a base folder for the created machine, resulting in a file name like
1568	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1569	will be used.
1570
1571	This method does not access the host disks. In particular, it does not check
1572	for whether a machine of this name already exists.
1573	</desc>
1574	<param name="name" type="wstring" dir="in">
1575	<desc>Suggested machine name.</desc>
1576	</param>
1577	<param name="baseFolder" type="wstring" dir="in">
1578	<desc>Base machine folder (optional).</desc>
1579	</param>
1580	<param name="file" type="wstring" dir="return">
1581	<desc>Fully qualified path where the machine would be created.</desc>
1582	</param>
1583	</method>
1584
1585	<method name="createMachine">
1586	<desc>
1587	Creates a new virtual machine by creating a machine settings file at
1588	the given location.
1589
1590	VirtualBox machine settings files use a custom XML dialect. Starting
1591	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1592	and machine files can be created at arbitrary locations.
1593
1594	However, it is is recommended that machines be created in the default
1595	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1596	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1597	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1598	is called automatically to have such a recommended name composed based
1599	on the machine name given in the @a name argument.
1600
1601	If the resulting settings file already exists, this method will fail,
1602	unless @a forceOverwrite is set.
1603
1604	The new machine is created unregistered, with the initial configuration
1605	set according to the specified guest OS type. A typical sequence of
1606	actions to create a new virtual machine is as follows:
1607
1608	<ol>
1609	<li>
1610	Call this method to have a new machine created. The returned machine
1611	object will be "mutable" allowing to change any machine property.
1612	</li>
1613
1614	<li>
1615	Configure the machine using the appropriate attributes and methods.
1616	</li>
1617
1618	<li>
1619	Call <link to="IMachine::saveSettings" /> to write the settings
1620	to the machine's XML settings file. The configuration of the newly
1621	created machine will not be saved to disk until this method is
1622	called.
1623	</li>
1624
1625	<li>
1626	Call <link to="#registerMachine" /> to add the machine to the list
1627	of machines known to VirtualBox.
1628	</li>
1629	</ol>
1630
1631	The specified guest OS type identifier must match an ID of one of known
1632	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1633	array.
1634
1635	Optionally, you may specify an UUID of to assign to the created machine.
1636	However, this is not recommended and you should normally pass an empty
1637	(@c null) UUID to this method so that a new UUID will be automatically
1638	generated for every created machine. You can use UUID
1639	00000000-0000-0000-0000-000000000000 as @c null value.
1640
1641	<note>
1642	There is no way to change the name of the settings file or
1643	subfolder of the created machine directly.
1644	</note>
1645
1646	<result name="VBOX_E_OBJECT_NOT_FOUND">
1647	@a osTypeId is invalid.
1648	</result>
1649	<result name="VBOX_E_FILE_ERROR">
1650	Resulting settings file name is invalid or the settings file already
1651	exists or could not be created due to an I/O error.
1652	</result>
1653	<result name="E_INVALIDARG">
1654	@a name is empty or @c null.
1655	</result>
1656	</desc>
1657
1658	<param name="settingsFile" type="wstring" dir="in">
1659	<desc>Fully qualified path where the settings file should be created,
1660	or NULL for a default folder and file based on the @a name argument
1661	(see <link to="#composeMachineFilename" />).</desc>
1662	</param>
1663	<param name="name" type="wstring" dir="in">
1664	<desc>Machine name.</desc>
1665	</param>
1666	<param name="osTypeId" type="wstring" dir="in">
1667	<desc>Guest OS Type ID.</desc>
1668	</param>
1669	<param name="id" type="uuid" mod="string" dir="in">
1670	<desc>Machine UUID (optional).</desc>
1671	</param>
1672	<param name="forceOverwrite" type="boolean" dir="in">
1673	<desc>If true, an existing machine settings file will be overwritten.</desc>
1674	</param>
1675	<param name="machine" type="IMachine" dir="return">
1676	<desc>Created machine object.</desc>
1677	</param>
1678	</method>
1679
1680	<method name="openMachine">
1681	<desc>
1682	Opens a virtual machine from the existing settings file.
1683	The opened machine remains unregistered until you call
1684	<link to="#registerMachine"/>.
1685
1686	The specified settings file name must be fully qualified.
1687	The file must exist and be a valid machine XML settings file
1688	whose contents will be used to construct the machine object.
1689
1690	<result name="VBOX_E_FILE_ERROR">
1691	Settings file name invalid, not found or sharing violation.
1692	</result>
1693	</desc>
1694	<param name="settingsFile" type="wstring" dir="in">
1695	<desc>
1696	Name of the machine settings file.
1697	</desc>
1698	</param>
1699	<param name="machine" type="IMachine" dir="return">
1700	<desc>Opened machine object.</desc>
1701	</param>
1702	<note>
1703	<link to="IMachine::settingsModified"/> will return
1704	@c false for the created machine, until any of machine settings
1705	are changed.
1706	</note>
1707	</method>
1708
1709	<method name="registerMachine">
1710	<desc>
1711
1712	Registers the machine previously created using
1713	<link to="#createMachine"/> or opened using
1714	<link to="#openMachine"/> within this VirtualBox installation. After
1715	successful method invocation, the
1716	<link to="IMachineRegisteredEvent"/> event is fired.
1717
1718	<note>
1719	This method implicitly calls <link to="IMachine::saveSettings"/>
1720	to save all current machine settings before registering it.
1721	</note>
1722
1723	<result name="VBOX_E_OBJECT_NOT_FOUND">
1724	No matching virtual machine found.
1725	</result>
1726	<result name="VBOX_E_INVALID_OBJECT_STATE">
1727	Virtual machine was not created within this VirtualBox instance.
1728	</result>
1729
1730	</desc>
1731	<param name="machine" type="IMachine" dir="in"/>
1732	</method>
1733
1734	<method name="findMachine">
1735	<desc>
1736	Attempts to find a virtual machine given its name or UUID.
1737
1738	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1739	cannot safely be determined.</note>
1740
1741	<result name="VBOX_E_OBJECT_NOT_FOUND">
1742	Could not find registered machine matching @a nameOrId.
1743	</result>
1744
1745	</desc>
1746	<param name="nameOrId" type="wstring" dir="in">
1747	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1748	</param>
1749	<param name="machine" type="IMachine" dir="return">
1750	<desc>Machine object, if found.</desc>
1751	</param>
1752	</method>
1753
1754	<method name="createAppliance">
1755	<desc>
1756	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1757	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1758	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1759	</desc>
1760	<param name="appliance" type="IAppliance" dir="return">
1761	<desc>New appliance.</desc>
1762	</param>
1763	</method>
1764
1765	<method name="createHardDisk">
1766	<desc>
1767	Creates a new base medium object that will use the given storage
1768	format and location for medium data.
1769
1770	Note that the actual storage unit is not created by this method. In
1771	order to do it, and before you are able to attach the created medium
1772	to virtual machines, you must call one of the following methods to
1773	allocate a format-specific storage unit at the specified location:
1774	<ul>
1775	<li><link to="IMedium::createBaseStorage"/></li>
1776	<li><link to="IMedium::createDiffStorage"/></li>
1777	</ul>
1778
1779	Some medium attributes, such as <link to="IMedium::id"/>, may
1780	remain uninitialized until the medium storage unit is successfully
1781	created by one of the above methods.
1782
1783	After the storage unit is successfully created, it will be
1784	accessible through the <link to="#findMedium"/> method and can
1785	be found in the <link to="#hardDisks"/> array.
1786
1787	The list of all storage formats supported by this VirtualBox
1788	installation can be obtained using
1789	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1790	attribute is empty or @c null then the default storage format
1791	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1792	be used for creating a storage unit of the medium.
1793
1794	Note that the format of the location string is storage format specific.
1795	See <link to="IMedium::location"/> and IMedium for more details.
1796
1797	<result name="VBOX_E_OBJECT_NOT_FOUND">
1798	@a format identifier is invalid. See
1799	<link to="ISystemProperties::mediumFormats"/>.
1800	</result>
1801	<result name="VBOX_E_FILE_ERROR">
1802	@a location is a not valid file name (for file-based formats only).
1803	</result>
1804	</desc>
1805	<param name="format" type="wstring" dir="in">
1806	<desc>
1807	Identifier of the storage format to use for the new medium.
1808	</desc>
1809	</param>
1810	<param name="location" type="wstring" dir="in">
1811	<desc>
1812	Location of the storage unit for the new medium.
1813	</desc>
1814	</param>
1815	<param name="medium" type="IMedium" dir="return">
1816	<desc>Created medium object.</desc>
1817	</param>
1818	</method>
1819
1820	<method name="openMedium">
1821	<desc>
1822	Opens a medium from an existing storage location.
1823
1824	Once a medium has been opened, it can be passed to other VirtualBox
1825	methods, in particular to <link to="IMachine::attachDevice" />.
1826
1827	Depending on the given device type, the file at the storage location
1828	must be in one of the media formats understood by VirtualBox:
1829
1830	<ul>
1831	<li>With a "HardDisk" device type, the file must be a hard disk image
1832	in one of the formats supported by VirtualBox (see
1833	<link to="ISystemProperties::mediumFormats" />).
1834	After this method succeeds, if the medium is a base medium, it
1835	will be added to the <link to="#hardDisks"/> array attribute. </li>
1836	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1837	After this method succeeds, the medium will be added to the
1838	<link to="#DVDImages"/> array attribute.</li>
1839	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1840	After this method succeeds, the medium will be added to the
1841	<link to="#floppyImages"/> array attribute.</li>
1842	</ul>
1843
1844	After having been opened, the medium can be found by the <link to="#findMedium"/>
1845	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1846
1847	The UUID of the newly opened medium will either be retrieved from the
1848	storage location, if the format supports it (e.g. for hard disk images),
1849	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1850	If for some reason you need to change the medium's UUID, use
1851	<link to="IMedium::setIDs" />.
1852
1853	If a differencing hard disk medium is to be opened by this method, the
1854	operation will succeed only if its parent medium and all ancestors,
1855	if any, are already known to this VirtualBox installation (for example,
1856	were opened by this method before).
1857
1858	This method attempts to guess the storage format of the specified medium
1859	by reading medium data at the specified location.
1860
1861	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1862	the image is opened for read/write access and must have according permissions,
1863	as VirtualBox may actually write status information into the disk's metadata
1864	sections.
1865
1866	Note that write access is required for all typical hard disk usage in VirtualBox,
1867	since VirtualBox may need to write metadata such as a UUID into the image.
1868	The only exception is opening a source image temporarily for copying and
1869	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1870	again soon.
1871
1872	The format of the location string is storage format specific. See
1873	<link to="IMedium::location"/> and IMedium for more details.
1874
1875	<result name="VBOX_E_FILE_ERROR">
1876	Invalid medium storage file location or could not find the medium
1877	at the specified location.
1878	</result>
1879	<result name="VBOX_E_IPRT_ERROR">
1880	Could not get medium storage format.
1881	</result>
1882	<result name="E_INVALIDARG">
1883	Invalid medium storage format.
1884	</result>
1885	<result name="VBOX_E_INVALID_OBJECT_STATE">
1886	Medium has already been added to a media registry.
1887	</result>
1888	</desc>
1889	<param name="location" type="wstring" dir="in">
1890	<desc>
1891	Location of the storage unit that contains medium data in one of
1892	the supported storage formats.
1893	</desc>
1894	</param>
1895	<param name="deviceType" type="DeviceType" dir="in">
1896	<desc>
1897	Must be one of "HardDisk", "DVD" or "Floppy".
1898	</desc>
1899	</param>
1900	<param name="accessMode" type="AccessMode" dir="in">
1901	<desc>Whether to open the image in read/write or read-only mode. For
1902	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1903	</param>
1904	<param name="medium" type="IMedium" dir="return">
1905	<desc>Opened medium object.</desc>
1906	</param>
1907	</method>
1908
1909	<method name="findMedium">
1910	<desc>
1911	Returns a medium of the given type that uses the given fully qualified
1912	location or UUID to store medium data.
1913
1914	The given medium must be known to this VirtualBox installation, i.e.
1915	it must be previously created by <link to="#createHardDisk"/> or opened
1916	by <link to="#openMedium"/>.
1917
1918	The search is done by comparing the value of the @a location argument to
1919	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1920	attributes of each known medium.
1921
1922	On case sensitive file systems, a case sensitive comparison is performed,
1923	otherwise the case of symbols in the file path is ignored.
1924
1925	<result name="VBOX_E_OBJECT_NOT_FOUND">
1926	No medium object matching @a location found.
1927	</result>
1928	</desc>
1929	<param name="location" type="wstring" dir="in">
1930	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1931	</param>
1932	<param name="type" type="DeviceType" dir="in">
1933	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1934	</param>
1935	<param name="medium" type="IMedium" dir="return">
1936	<desc>Medium object, if found.</desc>
1937	</param>
1938	</method>
1939
1940	<method name="getGuestOSType">
1941	<desc>
1942	Returns an object describing the specified guest OS type.
1943
1944	The requested guest OS type is specified using a string which is a
1945	mnemonic identifier of the guest operating system, such as
1946	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1947	particular virtual machine can be read or set using the
1948	<link to="IMachine::OSTypeId"/> attribute.
1949
1950	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1951	available guest OS type objects. Each object has an
1952	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1953	the guest OS this object describes.
1954
1955	<result name="E_INVALIDARG">
1956	@a id is not a valid Guest OS type.
1957	</result>
1958
1959	</desc>
1960	<param name="id" type="uuid" mod="string" dir="in">
1961	<desc>Guest OS type ID string.</desc>
1962	</param>
1963	<param name="type" type="IGuestOSType" dir="return">
1964	<desc>Guest OS type object.</desc>
1965	</param>
1966	</method>
1967
1968	<method name="createSharedFolder">
1969	<desc>
1970	Creates a new global shared folder by associating the given logical
1971	name with the given host path, adds it to the collection of shared
1972	folders and starts sharing it. Refer to the description of
1973	<link to="ISharedFolder"/> to read more about logical names.
1974	<note>
1975	In the current implementation, this operation is not
1976	implemented.
1977	</note>
1978	</desc>
1979	<param name="name" type="wstring" dir="in">
1980	<desc>Unique logical name of the shared folder.</desc>
1981	</param>
1982	<param name="hostPath" type="wstring" dir="in">
1983	<desc>Full path to the shared folder in the host file system.</desc>
1984	</param>
1985	<param name="writable" type="boolean" dir="in">
1986	<desc>Whether the share is writable or readonly</desc>
1987	</param>
1988	<param name="automount" type="boolean" dir="in">
1989	<desc>Whether the share gets automatically mounted by the guest
1990	or not.</desc>
1991	</param>
1992	</method>
1993
1994	<method name="removeSharedFolder">
1995	<desc>
1996	Removes the global shared folder with the given name previously
1997	created by <link to="#createSharedFolder"/> from the collection of
1998	shared folders and stops sharing it.
1999	<note>
2000	In the current implementation, this operation is not
2001	implemented.
2002	</note>
2003	</desc>
2004	<param name="name" type="wstring" dir="in">
2005	<desc>Logical name of the shared folder to remove.</desc>
2006	</param>
2007	</method>
2008
2009	<method name="getExtraDataKeys">
2010	<desc>
2011	Returns an array representing the global extra data keys which currently
2012	have values defined.
2013	</desc>
2014	<param name="value" type="wstring" dir="return" safearray="yes">
2015	<desc>Array of extra data keys.</desc>
2016	</param>
2017	</method>
2018
2019	<method name="getExtraData">
2020	<desc>
2021	Returns associated global extra data.
2022
2023	If the requested data @a key does not exist, this function will
2024	succeed and return an empty string in the @a value argument.
2025
2026	<result name="VBOX_E_FILE_ERROR">
2027	Settings file not accessible.
2028	</result>
2029	<result name="VBOX_E_XML_ERROR">
2030	Could not parse the settings file.
2031	</result>
2032
2033	</desc>
2034	<param name="key" type="wstring" dir="in">
2035	<desc>Name of the data key to get.</desc>
2036	</param>
2037	<param name="value" type="wstring" dir="return">
2038	<desc>Value of the requested data key.</desc>
2039	</param>
2040	</method>
2041
2042	<method name="setExtraData">
2043	<desc>
2044	Sets associated global extra data.
2045
2046	If you pass @c null or empty string as a key @a value, the given @a key
2047	will be deleted.
2048
2049	<note>
2050	Before performing the actual data change, this method will ask all
2051	registered event listener using the
2052	<link to="IExtraDataCanChangeEvent"/>
2053	notification for a permission. If one of the listeners refuses the
2054	new value, the change will not be performed.
2055	</note>
2056	<note>
2057	On success, the
2058	<link to="IExtraDataChangedEvent"/> notification
2059	is called to inform all registered listeners about a successful data
2060	change.
2061	</note>
2062
2063	<result name="VBOX_E_FILE_ERROR">
2064	Settings file not accessible.
2065	</result>
2066	<result name="VBOX_E_XML_ERROR">
2067	Could not parse the settings file.
2068	</result>
2069	<result name="E_ACCESSDENIED">
2070	Modification request refused.
2071	</result>
2072
2073	</desc>
2074	<param name="key" type="wstring" dir="in">
2075	<desc>Name of the data key to set.</desc>
2076	</param>
2077	<param name="value" type="wstring" dir="in">
2078	<desc>Value to assign to the key.</desc>
2079	</param>
2080	</method>
2081
2082	<!--method name="createDHCPServerForInterface">
2083	<desc>
2084	Creates a dhcp server settings to be used for the given interface
2085	<result name="E_INVALIDARG">
2086	Host network interface @a name already exists.
2087	</result>
2088	</desc>
2089	<param name="interface" type="IHostNetworkInterface" dir="in">
2090	<desc>Network Interface</desc>
2091	</param>
2092	<param name="server" type="IDHCPServer" dir="out">
2093	<desc>Dhcp server settings</desc>
2094	</param>
2095	</method-->
2096
2097	<method name="createDHCPServer">
2098	<desc>
2099	Creates a dhcp server settings to be used for the given internal network name
2100	<result name="E_INVALIDARG">
2101	Host network interface @a name already exists.
2102	</result>
2103	</desc>
2104	<param name="name" type="wstring" dir="in">
2105	<desc>server name</desc>
2106	</param>
2107	<param name="server" type="IDHCPServer" dir="return">
2108	<desc>Dhcp server settings</desc>
2109	</param>
2110	</method>
2111
2112	<method name="findDHCPServerByNetworkName">
2113	<desc>
2114	Searches a dhcp server settings to be used for the given internal network name
2115	<result name="E_INVALIDARG">
2116	Host network interface @a name already exists.
2117	</result>
2118
2119	</desc>
2120	<param name="name" type="wstring" dir="in">
2121	<desc>server name</desc>
2122	</param>
2123	<param name="server" type="IDHCPServer" dir="return">
2124	<desc>Dhcp server settings</desc>
2125	</param>
2126	</method>
2127
2128	<!--method name="findDHCPServerForInterface">
2129	<desc>
2130	Searches a dhcp server settings to be used for the given interface
2131	<result name="E_INVALIDARG">
2132	Host network interface @a name already exists.
2133	</result>
2134	</desc>
2135	<param name="interface" type="IHostNetworkInterface" dir="in">
2136	<desc>Network Interface</desc>
2137	</param>
2138	<param name="server" type="IDHCPServer" dir="out">
2139	<desc>Dhcp server settings</desc>
2140	</param>
2141	</method-->
2142
2143	<method name="removeDHCPServer">
2144	<desc>
2145	Removes the dhcp server settings
2146	<result name="E_INVALIDARG">
2147	Host network interface @a name already exists.
2148	</result>
2149	</desc>
2150	<param name="server" type="IDHCPServer" dir="in">
2151	<desc>Dhcp server settings to be removed</desc>
2152	</param>
2153	</method>
2154
2155
2156	<method name="checkFirmwarePresent">
2157	<desc>
2158	Check if this VirtualBox installation has a firmware
2159	of the given type available, either system-wide or per-user.
2160	Optionally, this may return a hint where this firmware can be
2161	downloaded from.
2162	</desc>
2163	<param name="firmwareType" type="FirmwareType" dir="in">
2164	<desc>
2165	Type of firmware to check.
2166	</desc>
2167	</param>
2168	<param name="version" type="wstring" dir="in">
2169	<desc>Expected version number, usually empty string (presently ignored).</desc>
2170	</param>
2171
2172	<param name="url" type="wstring" dir="out">
2173	<desc>
2174	Suggested URL to download this firmware from.
2175	</desc>
2176	</param>
2177
2178	<param name="file" type="wstring" dir="out">
2179	<desc>
2180	Filename of firmware, only valid if result == TRUE.
2181	</desc>
2182	</param>
2183
2184	<param name="result" type="boolean" dir="return">
2185	<desc>If firmware of this type and version is available.</desc>
2186	</param>
2187	</method>
2188
2189	</interface>
2190
2191	<!--
2192	// IVFSExplorer
2193	/////////////////////////////////////////////////////////////////////////
2194	-->
2195
2196	<enum
2197	name="VFSType"
2198	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2199	>
2200	<desc>
2201	Virtual file systems supported by VFSExplorer.
2202	</desc>
2203
2204	<const name="File" value="1" />
2205	<const name="Cloud" value="2" />
2206	<const name="S3" value="3" />
2207	<const name="WebDav" value="4" />
2208	</enum>
2209
2210	<enum
2211	name="VFSFileType"
2212	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2213	>
2214	<desc>
2215	File types known by VFSExplorer.
2216	</desc>
2217
2218	<const name="Unknown" value="1" />
2219	<const name="Fifo" value="2" />
2220	<const name="DevChar" value="3" />
2221	<const name="Directory" value="4" />
2222	<const name="DevBlock" value="5" />
2223	<const name="File" value="6" />
2224	<const name="SymLink" value="7" />
2225	<const name="Socket" value="8" />
2226	<const name="WhiteOut" value="9" />
2227	</enum>
2228
2229	<interface
2230	name="IVFSExplorer" extends="$unknown"
2231	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2232	wsmap="managed"
2233	>
2234	<desc>
2235	The VFSExplorer interface unifies access to different file system
2236	types. This includes local file systems as well remote file systems like
2237	S3. For a list of supported types see <link to="VFSType" />.
2238	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2239	</desc>
2240
2241	<attribute name="path" type="wstring" readonly="yes">
2242	<desc>Returns the current path in the virtual file system.</desc>
2243	</attribute>
2244
2245	<attribute name="type" type="VFSType" readonly="yes">
2246	<desc>Returns the file system type which is currently in use.</desc>
2247	</attribute>
2248
2249	<method name="update">
2250	<desc>Updates the internal list of files/directories from the
2251	current directory level. Use <link to="#entryList" /> to get the full list
2252	after a call to this method.</desc>
2253
2254	<param name="aProgress" type="IProgress" dir="return">
2255	<desc>Progress object to track the operation completion.</desc>
2256	</param>
2257	</method>
2258
2259	<method name="cd">
2260	<desc>Change the current directory level.</desc>
2261
2262	<param name="aDir" type="wstring" dir="in">
2263	<desc>The name of the directory to go in.</desc>
2264	</param>
2265
2266	<param name="aProgress" type="IProgress" dir="return">
2267	<desc>Progress object to track the operation completion.</desc>
2268	</param>
2269	</method>
2270
2271	<method name="cdUp">
2272	<desc>Go one directory upwards from the current directory level.</desc>
2273
2274	<param name="aProgress" type="IProgress" dir="return">
2275	<desc>Progress object to track the operation completion.</desc>
2276	</param>
2277	</method>
2278
2279	<method name="entryList">
2280	<desc>Returns a list of files/directories after a call to <link
2281	to="#update" />. The user is responsible for keeping this internal
2282	list up do date.</desc>
2283
2284	<param name="aNames" type="wstring" safearray="yes" dir="out">
2285	<desc>The list of names for the entries.</desc>
2286	</param>
2287
2288	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2289	<desc>The list of types for the entries.</desc>
2290	</param>
2291
2292	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2293	<desc>The list of sizes (in bytes) for the entries.</desc>
2294	</param>
2295
2296	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2297	<desc>The list of file modes (in octal form) for the entries.</desc>
2298	</param>
2299	</method>
2300
2301	<method name="exists">
2302	<desc>Checks if the given file list exists in the current directory
2303	level.</desc>
2304
2305	<param name="aNames" type="wstring" safearray="yes" dir="in">
2306	<desc>The names to check.</desc>
2307	</param>
2308
2309	<param name="aExists" type="wstring" safearray="yes" dir="return">
2310	<desc>The names which exist.</desc>
2311	</param>
2312	</method>
2313
2314	<method name="remove">
2315	<desc>Deletes the given files in the current directory level.</desc>
2316
2317	<param name="aNames" type="wstring" safearray="yes" dir="in">
2318	<desc>The names to remove.</desc>
2319	</param>
2320
2321	<param name="aProgress" type="IProgress" dir="return">
2322	<desc>Progress object to track the operation completion.</desc>
2323	</param>
2324	</method>
2325
2326	</interface>
2327
2328	<!--
2329	// IAppliance
2330	/////////////////////////////////////////////////////////////////////////
2331	-->
2332
2333	<interface
2334	name="IAppliance" extends="$unknown"
2335	uuid="7b148032-4124-4f46-b56a-b48ac1273f5a"
2336	wsmap="managed"
2337	>
2338	<desc>
2339	Represents a platform-independent appliance in OVF format. An instance of this is returned
2340	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2341	virtual machines within an appliance with VirtualBox.
2342
2343	The OVF standard suggests two different physical file formats:
2344
2345	<ol>
2346	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2347	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2348	this descriptor file references other files such as disk images, as OVF appliances typically
2349	do, those additional files must be in the same directory as the descriptor file.</li>
2350
2351	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2352	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2353	files and optionally other files.
2354
2355	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2356	be added with a later version.</li>
2357	</ol>
2358
2359	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2360	<link to="IMachine" /> involves the following sequence of API calls:
2361
2362	<ol>
2363	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2364	</li>
2365
2366	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2367	would like to import. So long as this file is syntactically valid, this will succeed
2368	and fill the appliance object with the parsed data from the OVF file.
2369	</li>
2370
2371	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2372	contents of the IAppliance attributes accordingly. These can be inspected by a
2373	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2374	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2375	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2376	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2377	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2378	The GUI can then give the user the option to confirm and/or change these suggestions.
2379	</li>
2380
2381	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2382	virtual system (machine) to override the suggestions made by the interpret() routine.
2383	</li>
2384
2385	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2386	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2387	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2388	can be found in the <link to="#machines" /> array attribute.
2389	</li>
2390	</ol>
2391
2392	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2393
2394	<ol>
2395	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2396	an empty IAppliance object.
2397	</li>
2398
2399	<li>For each machine you would like to export, call <link to="IMachine::export" />
2400	with the IAppliance object you just created. Each such call creates one instance of
2401	<link to="IVirtualSystemDescription" /> inside the appliance.
2402	</li>
2403
2404	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2405	virtual system (machine) to override the suggestions made by the export() routine.
2406	</li>
2407
2408	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2409	file written.</li>
2410	</ol>
2411
2412	</desc>
2413
2414	<attribute name="path" type="wstring" readonly="yes">
2415	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2416	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2417	<link to="#write" /> (for export).
2418	This attribute is empty until one of these methods has been called.
2419	</desc>
2420	</attribute>
2421
2422	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2423	<desc>
2424	Array of virtual disk definitions. One such description exists for each
2425	disk definition in the OVF; each string array item represents one such piece of
2426	disk information, with the information fields separated by tab (\\t) characters.
2427
2428	The caller should be prepared for additional fields being appended to
2429	this string in future versions of VirtualBox and therefore check for
2430	the number of tabs in the strings returned.
2431
2432	In the current version, the following eight fields are returned per string
2433	in the array:
2434
2435	<ol>
2436	<li>Disk ID (unique string identifier given to disk)</li>
2437
2438	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2439
2440	<li>Populated size (optional unsigned integer indicating the current size of the
2441	disk; can be approximate; -1 if unspecified)</li>
2442
2443	<li>Format (string identifying the disk format, typically
2444	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2445
2446	<li>Reference (where to find the disk image, typically a file name; if empty,
2447	then the disk should be created on import)</li>
2448
2449	<li>Image size (optional unsigned integer indicating the size of the image,
2450	which need not necessarily be the same as the values specified above, since
2451	the image may be compressed or sparse; -1 if not specified)</li>
2452
2453	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2454	presently unsupported and always -1)</li>
2455
2456	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2457	</ol>
2458	</desc>
2459	</attribute>
2460
2461	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2462	<desc> Array of virtual system descriptions. One such description is created
2463	for each virtual system (machine) found in the OVF.
2464	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2465	(for export) has been called.
2466	</desc>
2467	</attribute>
2468
2469	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2470	<desc>
2471	Contains the UUIDs of the machines created from the information in this appliances. This is only
2472	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2473	succeeded.
2474	</desc>
2475	</attribute>
2476
2477	<method name="read">
2478	<desc>
2479	Reads an OVF file into the appliance object.
2480
2481	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2482	mere fact that this method returns successfully does not mean that VirtualBox supports all
2483	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2484	</desc>
2485	<param name="file" type="wstring" dir="in">
2486	<desc>
2487	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2488	on whether the appliance is distributed as a set of files or as a single file, respectively).
2489	</desc>
2490	</param>
2491	<param name="aProgress" type="IProgress" dir="return">
2492	<desc>Progress object to track the operation completion.</desc>
2493	</param>
2494	</method>
2495
2496	<method name="interpret">
2497	<desc>
2498	Interprets the OVF data that was read when the appliance was constructed. After
2499	calling this method, one can inspect the
2500	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2501	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2502	the appliance.
2503
2504	Calling this method is the second step of importing an appliance into VirtualBox;
2505	see <link to="IAppliance" /> for an overview.
2506
2507	After calling this method, one should call <link to="#getWarnings" /> to find out
2508	if problems were encountered during the processing which might later lead to
2509	errors.
2510	</desc>
2511	</method>
2512
2513	<method name="importMachines">
2514	<desc>
2515	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2516	and other interfaces that match the information contained in the appliance as
2517	closely as possible, as represented by the import instructions in the
2518	<link to="#virtualSystemDescriptions" /> array.
2519
2520	Calling this method is the final step of importing an appliance into VirtualBox;
2521	see <link to="IAppliance" /> for an overview.
2522
2523	Since importing the appliance will most probably involve copying and converting
2524	disk images, which can take a long time, this method operates asynchronously and
2525	returns an IProgress object to allow the caller to monitor the progress.
2526
2527	After the import succeeded, the UUIDs of the IMachine instances created can be
2528	retrieved from the <link to="#machines" /> array attribute.
2529	</desc>
2530
2531	<param name="aProgress" type="IProgress" dir="return">
2532	<desc>Progress object to track the operation completion.</desc>
2533	</param>
2534	</method>
2535
2536	<method name="createVFSExplorer">
2537	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2538
2539	<param name="aUri" type="wstring" dir="in">
2540	<desc>The URI describing the file system to use.</desc>
2541	</param>
2542
2543	<param name="aExplorer" type="IVFSExplorer" dir="return">
2544	<desc></desc>
2545	</param>
2546	</method>
2547
2548	<method name="write">
2549	<desc>
2550	Writes the contents of the appliance exports into a new OVF file.
2551
2552	Calling this method is the final step of exporting an appliance from VirtualBox;
2553	see <link to="IAppliance" /> for an overview.
2554
2555	Since exporting the appliance will most probably involve copying and converting
2556	disk images, which can take a long time, this method operates asynchronously and
2557	returns an IProgress object to allow the caller to monitor the progress.
2558	</desc>
2559	<param name="format" type="wstring" dir="in">
2560	<desc>
2561	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2562	future versions of VirtualBox may support additional formats.
2563	</desc>
2564	</param>
2565	<param name="manifest" type="boolean" dir="in">
2566	<desc>
2567	Indicate if the optional manifest file (.mf) should be written. The manifest file
2568	is used for integrity checks prior import.
2569	</desc>
2570	</param>
2571	<param name="path" type="wstring" dir="in">
2572	<desc>
2573	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2574	on whether the appliance is distributed as a set of files or as a single file, respectively).
2575	</desc>
2576	</param>
2577	<param name="progress" type="IProgress" dir="return">
2578	<desc>Progress object to track the operation completion.</desc>
2579	</param>
2580	</method>
2581
2582	<method name="getWarnings">
2583	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2584
2585	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2586	<desc></desc>
2587	</param>
2588	</method>
2589
2590	</interface>
2591
2592	<enum
2593	name="VirtualSystemDescriptionType"
2594	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
2595	>
2596	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2597	a configuration value.</desc>
2598
2599	<const name="Ignore" value="1" />
2600	<const name="OS" value="2" />
2601	<const name="Name" value="3" />
2602	<const name="Product" value="4" />
2603	<const name="Vendor" value="5" />
2604	<const name="Version" value="6" />
2605	<const name="ProductUrl" value="7" />
2606	<const name="VendorUrl" value="8" />
2607	<const name="Description" value="9" />
2608	<const name="License" value="10" />
2609	<const name="Miscellaneous" value="11" />
2610	<const name="CPU" value="12" />
2611	<const name="Memory" value="13" />
2612	<const name="HardDiskControllerIDE" value="14" />
2613	<const name="HardDiskControllerSATA" value="15" />
2614	<const name="HardDiskControllerSCSI" value="16" />
2615	<const name="HardDiskControllerSAS" value="17" />
2616	<const name="HardDiskImage" value="18" />
2617	<const name="Floppy" value="19" />
2618	<const name="CDROM" value="20" />
2619	<const name="NetworkAdapter" value="21" />
2620	<const name="USBController" value="22" />
2621	<const name="SoundCard" value="23" />
2622
2623	</enum>
2624
2625	<enum
2626	name="VirtualSystemDescriptionValueType"
2627	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2628	>
2629	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2630	type to fetch.</desc>
2631
2632	<const name="Reference" value="1" />
2633	<const name="Original" value="2" />
2634	<const name="Auto" value="3" />
2635	<const name="ExtraConfig" value="4" />
2636
2637	</enum>
2638
2639	<interface
2640	name="IVirtualSystemDescription" extends="$unknown"
2641	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2642	wsmap="managed"
2643	>
2644
2645	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2646	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2647	<link to="IAppliance::interpret" /> has been called, that array contains information
2648	about how the virtual systems described in the OVF should best be imported into
2649	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2650	import an OVF into VirtualBox.
2651	</desc>
2652
2653	<attribute name="count" type="unsigned long" readonly="yes">
2654	<desc>Return the number of virtual system description entries.</desc>
2655	</attribute>
2656
2657	<method name="getDescription">
2658	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2659	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2660
2661	The list below identifies the value sets that are possible depending on the
2662	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2663	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2664	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2665	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2666	the @a aExtraConfigValues[] array item may also be used.
2667
2668	<ul>
2669	<li>
2670	"OS": the guest operating system type. There must be exactly one such array item on import. The
2671	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2672	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2673	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2674	</li>
2675	<li>
2676	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2677	if none is present on import, then an automatic name will be created from the operating system
2678	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2679	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2680	<link to="IMachine" /> name that does not exist yet.
2681	</li>
2682	<li>
2683	"Description": an arbitrary description.
2684	</li>
2685	<li>
2686	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2687	code to display such a license for agreement; the Main API does not enforce any such policy.
2688	</li>
2689	<li>
2690	Miscellaneous: reserved for future use.
2691	</li>
2692	<li>
2693	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2694	</li>
2695	<li>
2696	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2697	is present on import, then VirtualBox will set a meaningful default based on the operating system
2698	type.
2699	</li>
2700	<li>
2701	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2702	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2703	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2704	writes into the OVF.
2705	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2706	type can use to specify which hard disk controller a virtual disk should be connected to.
2707	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2708	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2709	its virtual machines supports four channels (primary master, primary slave, secondary master,
2710	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2711	</li>
2712	<li>
2713	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2714	has no value in @a aOvfValues[] or @a aVBoxValues[].
2715	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2716	</li>
2717	<li>
2718	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2719	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2720	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2721	whereas VirtualBox considers it a class of storage controllers of its own; see
2722	<link to="StorageControllerType" />).
2723	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2724	</li>
2725	<li>
2726	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2727	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2728
2729	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2730	a path since the image file should be in the same location as the OVF file itself), whereas the
2731	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2732	hard disk image. This means that on import the image will be copied and converted from the
2733	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2734
2735	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2736	format: "controller=<index>;channel=<c>"
2737	In this string, <index> must be an integer specifying the hard disk controller to connect
2738	the image to. That number must be the index of an array item with one of the hard disk controller
2739	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2740	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2741	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2742	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2743	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2744	</li>
2745	<li>
2746	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2747	attachment information as with "HardDiskImage" items.
2748	</li>
2749	<li>
2750	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2751	attachment information as with "HardDiskImage" items.
2752	</li>
2753	<li>
2754	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2755	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2756	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2757	</li>
2758	<li>
2759	"USBController": a USB controller. There can be at most one such item. If and only if such an
2760	item ispresent, USB support will be enabled for the new virtual machine.
2761	</li>
2762	<li>
2763	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2764	present, sound support will be enabled for the new virtual machine. Note that the virtual
2765	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2766	may be different from the virtual soundcard expected by the appliance.
2767	</li>
2768	</ul>
2769
2770	</desc>
2771
2772	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2773	<desc></desc>
2774	</param>
2775
2776	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2777	<desc></desc>
2778	</param>
2779
2780	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2781	<desc></desc>
2782	</param>
2783
2784	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2785	<desc></desc>
2786	</param>
2787
2788	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2789	<desc></desc>
2790	</param>
2791
2792	</method>
2793
2794	<method name="getDescriptionByType">
2795	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2796	should be returned.</desc>
2797
2798	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2799	<desc></desc>
2800	</param>
2801
2802	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2803	<desc></desc>
2804	</param>
2805
2806	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2807	<desc></desc>
2808	</param>
2809
2810	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2811	<desc></desc>
2812	</param>
2813
2814	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2815	<desc></desc>
2816	</param>
2817
2818	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2819	<desc></desc>
2820	</param>
2821
2822	</method>
2823
2824	<method name="getValuesByType">
2825	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2826	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2827	values.</desc>
2828
2829	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2830	<desc></desc>
2831	</param>
2832
2833	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2834	<desc></desc>
2835	</param>
2836
2837	<param name="aValues" type="wstring" dir="return" safearray="yes">
2838	<desc></desc>
2839	</param>
2840
2841	</method>
2842
2843	<method name="setFinalValues">
2844	<desc>
2845	This method allows the appliance's user to change the configuration for the virtual
2846	system descriptions. For each array item returned from <link to="#getDescription" />,
2847	you must pass in one boolean value and one configuration value.
2848
2849	Each item in the boolean array determines whether the particular configuration item
2850	should be enabled.
2851	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2852	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2853	and SoundCard.
2854
2855	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2856	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
2857	the configuration remains unchanged. Please see the documentation for getDescription()
2858	for valid configuration values for the individual array item types. If the
2859	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2860	</desc>
2861
2862	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2863	<desc></desc>
2864	</param>
2865
2866	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2867	<desc></desc>
2868	</param>
2869
2870	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2871	<desc></desc>
2872	</param>
2873	</method>
2874
2875	<method name="addDescription">
2876	<desc>
2877	This method adds an additional description entry to the stack of already
2878	available descriptions for this virtual system. This is handy for writing
2879	values which aren't directly supported by VirtualBox. One example would
2880	be the License type of <link to="VirtualSystemDescriptionType" />.
2881	</desc>
2882
2883	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2884	<desc></desc>
2885	</param>
2886
2887	<param name="aVBoxValue" type="wstring" dir="in">
2888	<desc></desc>
2889	</param>
2890
2891	<param name="aExtraConfigValue" type="wstring" dir="in">
2892	<desc></desc>
2893	</param>
2894	</method>
2895	</interface>
2896
2897
2898	<!--
2899	// IMachine
2900	/////////////////////////////////////////////////////////////////////////
2901	-->
2902
2903	<interface
2904	name="IInternalMachineControl" extends="$unknown"
2905	uuid="8e723ab0-812c-5662-dd8e-7ebc89637acf"
2906	internal="yes"
2907	wsmap="suppress"
2908	>
2909	<method name="setRemoveSavedStateFile">
2910	<desc>
2911	Updates the flag whether the saved state file is removed on a
2912	machine state change from Saved to PoweredOff.
2913	</desc>
2914	<param name="aRemove" type="boolean" dir="in"/>
2915	</method>
2916
2917	<method name="updateState">
2918	<desc>
2919	Updates the VM state.
2920	<note>
2921	This operation will also update the settings file with the correct
2922	information about the saved state file and delete this file from disk
2923	when appropriate.
2924	</note>
2925	</desc>
2926	<param name="state" type="MachineState" dir="in"/>
2927	</method>
2928
2929	<method name="getIPCId">
2930	<param name="id" type="wstring" dir="return"/>
2931	</method>
2932
2933	<method name="beginPowerUp">
2934	<desc>
2935	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2936	gives it the progress object that should be part of any pending
2937	<link to="IMachine::launchVMProcess"/> operations. The progress
2938	object may be called back to reflect an early cancelation, so some care
2939	have to be taken with respect to any cancelation callbacks. The console
2940	object will call <link to="IInternalMachineControl::endPowerUp"/>
2941	to signal the completion of the progress object.
2942	</desc>
2943	<param name="aProgress" type="IProgress" dir="in" />
2944	</method>
2945
2946	<method name="endPowerUp">
2947	<desc>
2948	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
2949	This method may query status information from the progress object it
2950	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
2951	it over to any in-progress <link to="IMachine::launchVMProcess"/>
2952	call in order to complete that progress object.
2953	</desc>
2954	<param name="result" type="long" dir="in"/>
2955	</method>
2956
2957	<method name="beginPoweringDown">
2958	<desc>
2959	Called by the VM process to inform the server it wants to
2960	stop the VM execution and power down.
2961	</desc>
2962	<param name="progress" type="IProgress" dir="out">
2963	<desc>
2964	Progress object created by VBoxSVC to wait until
2965	the VM is powered down.
2966	</desc>
2967	</param>
2968	</method>
2969
2970	<method name="endPoweringDown">
2971	<desc>
2972	Called by the VM process to inform the server that powering
2973	down previously requested by #beginPoweringDown is either
2974	successfully finished or there was a failure.
2975
2976	<result name="VBOX_E_FILE_ERROR">
2977	Settings file not accessible.
2978	</result>
2979	<result name="VBOX_E_XML_ERROR">
2980	Could not parse the settings file.
2981	</result>
2982
2983	</desc>
2984
2985	<param name="result" type="long" dir="in">
2986	<desc>@c S_OK to indicate success.
2987	</desc>
2988	</param>
2989	<param name="errMsg" type="wstring" dir="in">
2990	<desc>@c human readable error message in case of failure.
2991	</desc>
2992	</param>
2993	</method>
2994
2995	<method name="runUSBDeviceFilters">
2996	<desc>
2997	Asks the server to run USB devices filters of the associated
2998	machine against the given USB device and tell if there is
2999	a match.
3000	<note>
3001	Intended to be used only for remote USB devices. Local
3002	ones don't require to call this method (this is done
3003	implicitly by the Host and USBProxyService).
3004	</note>
3005	</desc>
3006	<param name="device" type="IUSBDevice" dir="in"/>
3007	<param name="matched" type="boolean" dir="out"/>
3008	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3009	</method>
3010
3011	<method name="captureUSBDevice">
3012	<desc>
3013	Requests a capture of the given host USB device.
3014	When the request is completed, the VM process will
3015	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3016	notification.
3017	</desc>
3018	<param name="id" type="uuid" mod="string" dir="in"/>
3019	</method>
3020
3021	<method name="detachUSBDevice">
3022	<desc>
3023	Notification that a VM is going to detach (@a done = @c false) or has
3024	already detached (@a done = @c true) the given USB device.
3025	When the @a done = @c true request is completed, the VM process will
3026	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3027	notification.
3028	<note>
3029	In the @a done = @c true case, the server must run its own filters
3030	and filters of all VMs but this one on the detached device
3031	as if it were just attached to the host computer.
3032	</note>
3033	</desc>
3034	<param name="id" type="uuid" mod="string" dir="in"/>
3035	<param name="done" type="boolean" dir="in"/>
3036	</method>
3037
3038	<method name="autoCaptureUSBDevices">
3039	<desc>
3040	Requests a capture all matching USB devices attached to the host.
3041	When the request is completed, the VM process will
3042	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3043	notification per every captured device.
3044	</desc>
3045	</method>
3046
3047	<method name="detachAllUSBDevices">
3048	<desc>
3049	Notification that a VM that is being powered down. The done
3050	parameter indicates whether which stage of the power down
3051	we're at. When @a done = @c false the VM is announcing its
3052	intentions, while when @a done = @c true the VM is reporting
3053	what it has done.
3054	<note>
3055	In the @a done = @c true case, the server must run its own filters
3056	and filters of all VMs but this one on all detach devices as
3057	if they were just attached to the host computer.
3058	</note>
3059	</desc>
3060	<param name="done" type="boolean" dir="in"/>
3061	</method>
3062
3063	<method name="onSessionEnd">
3064	<desc>
3065	Triggered by the given session object when the session is about
3066	to close normally.
3067	</desc>
3068	<param name="session" type="ISession" dir="in">
3069	<desc>Session that is being closed</desc>
3070	</param>
3071	<param name="progress" type="IProgress" dir="return">
3072	<desc>
3073	Used to wait until the corresponding machine is actually
3074	dissociated from the given session on the server.
3075	Returned only when this session is a direct one.
3076	</desc>
3077	</param>
3078	</method>
3079
3080	<method name="beginSavingState">
3081	<desc>
3082	Called by the VM process to inform the server it wants to
3083	save the current state and stop the VM execution.
3084	</desc>
3085	<param name="progress" type="IProgress" dir="out">
3086	<desc>
3087	Progress object created by VBoxSVC to wait until
3088	the state is saved.
3089	</desc>
3090	</param>
3091	<param name="stateFilePath" type="wstring" dir="out">
3092	<desc>
3093	File path the VM process must save the execution state to.
3094	</desc>
3095	</param>
3096	</method>
3097
3098	<method name="endSavingState">
3099	<desc>
3100	Called by the VM process to inform the server that saving
3101	the state previously requested by #beginSavingState is either
3102	successfully finished or there was a failure.
3103
3104	<result name="VBOX_E_FILE_ERROR">
3105	Settings file not accessible.
3106	</result>
3107	<result name="VBOX_E_XML_ERROR">
3108	Could not parse the settings file.
3109	</result>
3110
3111	</desc>
3112
3113	<param name="result" type="long" dir="in">
3114	<desc>@c S_OK to indicate success.
3115	</desc>
3116	</param>
3117	<param name="errMsg" type="wstring" dir="in">
3118	<desc>@c human readable error message in case of failure.
3119	</desc>
3120	</param>
3121	</method>
3122
3123	<method name="adoptSavedState">
3124	<desc>
3125	Gets called by IConsole::adoptSavedState.
3126	<result name="VBOX_E_FILE_ERROR">
3127	Invalid saved state file path.
3128	</result>
3129	</desc>
3130	<param name="savedStateFile" type="wstring" dir="in">
3131	<desc>Path to the saved state file to adopt.</desc>
3132	</param>
3133	</method>
3134
3135	<method name="beginTakingSnapshot">
3136	<desc>
3137	Called from the VM process to request from the server to perform the
3138	server-side actions of creating a snapshot (creating differencing images
3139	and the snapshot object).
3140
3141	<result name="VBOX_E_FILE_ERROR">
3142	Settings file not accessible.
3143	</result>
3144	<result name="VBOX_E_XML_ERROR">
3145	Could not parse the settings file.
3146	</result>
3147	</desc>
3148	<param name="initiator" type="IConsole" dir="in">
3149	<desc>The console object that initiated this call.</desc>
3150	</param>
3151	<param name="name" type="wstring" dir="in">
3152	<desc>Snapshot name.</desc>
3153	</param>
3154	<param name="description" type="wstring" dir="in">
3155	<desc>Snapshot description.</desc>
3156	</param>
3157	<param name="consoleProgress" type="IProgress" dir="in">
3158	<desc>
3159	Progress object created by the VM process tracking the
3160	snapshot's progress. This has the following sub-operations:
3161	<ul>
3162	<li>setting up (weight 1);</li>
3163	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3164	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3165	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3166	<li>finishing up (weight 1)</li>
3167	</ul>
3168	</desc>
3169	</param>
3170	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3171	<desc>
3172	Whether this is an online snapshot (i.e. the machine is running).
3173	</desc>
3174	</param>
3175	<param name="stateFilePath" type="wstring" dir="out">
3176	<desc>
3177	File path the VM process must save the execution state to.
3178	</desc>
3179	</param>
3180	</method>
3181
3182	<method name="endTakingSnapshot">
3183	<desc>
3184	Called by the VM process to inform the server that the snapshot
3185	previously requested by #beginTakingSnapshot is either
3186	successfully taken or there was a failure.
3187	</desc>
3188
3189	<param name="success" type="boolean" dir="in">
3190	<desc>@c true to indicate success and @c false otherwise</desc>
3191	</param>
3192	</method>
3193
3194	<method name="deleteSnapshot">
3195	<desc>
3196	Gets called by IConsole::deleteSnapshot.
3197	<result name="VBOX_E_INVALID_OBJECT_STATE">
3198	Snapshot has more than one child snapshot.
3199	</result>
3200	</desc>
3201	<param name="initiator" type="IConsole" dir="in">
3202	<desc>The console object that initiated this call.</desc>
3203	</param>
3204	<param name="id" type="uuid" mod="string" dir="in">
3205	<desc>UUID of the snapshot to delete.</desc>
3206	</param>
3207	<param name="machineState" type="MachineState" dir="out">
3208	<desc>New machine state after this operation is started.</desc>
3209	</param>
3210	<param name="progress" type="IProgress" dir="return">
3211	<desc>Progress object to track the operation completion.</desc>
3212	</param>
3213	</method>
3214
3215	<method name="finishOnlineMergeMedium">
3216	<desc>
3217	Gets called by IConsole::onlineMergeMedium.
3218	</desc>
3219	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3220	<desc>The medium attachment which needs to be cleaned up.</desc>
3221	</param>
3222	<param name="source" type="IMedium" dir="in">
3223	<desc>Merge source medium.</desc>
3224	</param>
3225	<param name="target" type="IMedium" dir="in">
3226	<desc>Merge target medium.</desc>
3227	</param>
3228	<param name="mergeForward" type="boolean" dir="in">
3229	<desc>Merge direction.</desc>
3230	</param>
3231	<param name="parentForTarget" type="IMedium" dir="in">
3232	<desc>For forward merges: new parent for target medium.</desc>
3233	</param>
3234	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3235	<desc>For backward merges: list of media which need their parent UUID
3236	updated.</desc>
3237	</param>
3238	</method>
3239
3240	<method name="restoreSnapshot">
3241	<desc>
3242	Gets called by IConsole::RestoreSnapshot.
3243	</desc>
3244	<param name="initiator" type="IConsole" dir="in">
3245	<desc>The console object that initiated this call.</desc>
3246	</param>
3247	<param name="snapshot" type="ISnapshot" dir="in">
3248	<desc>The snapshot to restore the VM state from.</desc>
3249	</param>
3250	<param name="machineState" type="MachineState" dir="out">
3251	<desc>New machine state after this operation is started.</desc>
3252	</param>
3253	<param name="progress" type="IProgress" dir="return">
3254	<desc>Progress object to track the operation completion.</desc>
3255	</param>
3256	</method>
3257
3258	<method name="pullGuestProperties">
3259	<desc>
3260	Get the list of the guest properties matching a set of patterns along
3261	with their values, time stamps and flags and give responsibility for
3262	managing properties to the console.
3263	</desc>
3264	<param name="name" type="wstring" dir="out" safearray="yes">
3265	<desc>
3266	The names of the properties returned.
3267	</desc>
3268	</param>
3269	<param name="value" type="wstring" dir="out" safearray="yes">
3270	<desc>
3271	The values of the properties returned. The array entries match the
3272	corresponding entries in the @a name array.
3273	</desc>
3274	</param>
3275	<param name="timestamp" type="long long" dir="out" safearray="yes">
3276	<desc>
3277	The time stamps of the properties returned. The array entries match
3278	the corresponding entries in the @a name array.
3279	</desc>
3280	</param>
3281	<param name="flags" type="wstring" dir="out" safearray="yes">
3282	<desc>
3283	The flags of the properties returned. The array entries match the
3284	corresponding entries in the @a name array.
3285	</desc>
3286	</param>
3287	</method>
3288
3289	<method name="pushGuestProperty">
3290	<desc>
3291	Update a single guest property in IMachine.
3292	</desc>
3293	<param name="name" type="wstring" dir="in">
3294	<desc>
3295	The name of the property to be updated.
3296	</desc>
3297	</param>
3298	<param name="value" type="wstring" dir="in">
3299	<desc>
3300	The value of the property.
3301	</desc>
3302	</param>
3303	<param name="timestamp" type="long long" dir="in">
3304	<desc>
3305	The timestamp of the property.
3306	</desc>
3307	</param>
3308	<param name="flags" type="wstring" dir="in">
3309	<desc>
3310	The flags of the property.
3311	</desc>
3312	</param>
3313	</method>
3314
3315	<method name="lockMedia">
3316	<desc>
3317	Locks all media attached to the machine for writing and parents of
3318	attached differencing media (if any) for reading. This operation is
3319	atomic so that if it fails no media is actually locked.
3320
3321	This method is intended to be called when the machine is in Starting or
3322	Restoring state. The locked media will be automatically unlocked when
3323	the machine is powered off or crashed.
3324	</desc>
3325	</method>
3326	<method name="unlockMedia">
3327	<desc>
3328	Unlocks all media previously locked using
3329	<link to="IInternalMachineControl::lockMedia"/>.
3330
3331	This method is intended to be used with teleportation so that it is
3332	possible to teleport between processes on the same machine.
3333	</desc>
3334	</method>
3335	</interface>
3336
3337	<interface
3338	name="IBIOSSettings" extends="$unknown"
3339	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3340	wsmap="managed"
3341	>
3342	<desc>
3343	The IBIOSSettings interface represents BIOS settings of the virtual
3344	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3345	</desc>
3346	<attribute name="logoFadeIn" type="boolean">
3347	<desc>Fade in flag for BIOS logo animation.</desc>
3348	</attribute>
3349
3350	<attribute name="logoFadeOut" type="boolean">
3351	<desc>Fade out flag for BIOS logo animation.</desc>
3352	</attribute>
3353
3354	<attribute name="logoDisplayTime" type="unsigned long">
3355	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3356	</attribute>
3357
3358	<attribute name="logoImagePath" type="wstring">
3359	<desc>
3360	Local file system path for external BIOS splash image. Empty string
3361	means the default image is shown on boot.
3362	</desc>
3363	</attribute>
3364
3365	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3366	<desc>Mode of the BIOS boot device menu.</desc>
3367	</attribute>
3368
3369	<attribute name="ACPIEnabled" type="boolean">
3370	<desc>ACPI support flag.</desc>
3371	</attribute>
3372
3373	<attribute name="IOAPICEnabled" type="boolean">
3374	<desc>
3375	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3376	and support IRQs above 15.
3377	</desc>
3378	</attribute>
3379
3380	<attribute name="timeOffset" type="long long">
3381	<desc>
3382	Offset in milliseconds from the host system time. This allows for
3383	guests running with a different system date/time than the host.
3384	It is equivalent to setting the system date/time in the BIOS except
3385	it is not an absolute value but a relative one. Guest Additions
3386	time synchronization honors this offset.
3387	</desc>
3388	</attribute>
3389
3390	<attribute name="PXEDebugEnabled" type="boolean">
3391	<desc>
3392	PXE debug logging flag. If set, VirtualBox will write extensive
3393	PXE trace information to the release log.
3394	</desc>
3395	</attribute>
3396
3397	</interface>
3398
3399	<enum
3400	name="CleanupMode"
3401	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3402	>
3403	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3404	</desc>
3405	<const name="UnregisterOnly" value="1">
3406	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3407	</const>
3408	<const name="DetachAllReturnNone" value="2">
3409	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3410	</const>
3411	<const name="DetachAllReturnHardDisksOnly" value="3">
3412	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3413	</const>
3414	<const name="Full" value="4">
3415	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3416	</const>
3417	</enum>
3418
3419	<interface
3420	name="IPciAddress" extends="$unknown"
3421	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3422	wsmap="struct"
3423	>
3424
3425	<desc>
3426	Address on the PCI bus.
3427	</desc>
3428
3429	<attribute name="bus" type="short">
3430	<desc>
3431	Bus number.
3432	</desc>
3433	</attribute>
3434
3435	<attribute name="device" type="short">
3436	<desc>
3437	Device number.
3438	</desc>
3439	</attribute>
3440
3441	<attribute name="devFunction" type="short">
3442	<desc>
3443	Device function number.
3444	</desc>
3445	</attribute>
3446
3447	<method name="asLong">
3448	<desc>
3449	Convert PCI address into long.
3450	</desc>
3451	<param name="result" type="long" dir="return" />
3452	</method>
3453
3454	<method name="fromLong">
3455	<desc>
3456	Make PCI address from long.
3457	</desc>
3458	<param name="number" type="long" dir="in" />
3459	</method>
3460	</interface>
3461
3462	<interface
3463	name="IPciDeviceAttachment" extends="$unknown"
3464	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3465	wsmap="struct"
3466	>
3467
3468	<desc>
3469	Information about PCI attachments.
3470	</desc>
3471
3472	<attribute name="name" type="wstring" readonly="yes">
3473	<desc>
3474	Device name.
3475	</desc>
3476	</attribute>
3477
3478	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3479	<desc>
3480	If this is physical or virtual device.
3481	</desc>
3482	</attribute>
3483
3484	<attribute name="hostAddress" type="long" readonly="yes">
3485	<desc>
3486	Address of device on the host, applicable only to host devices.
3487	</desc>
3488	</attribute>
3489
3490	<attribute name="guestAddress" type="long" readonly="yes">
3491	<desc>
3492	Address of device on the guest.
3493	</desc>
3494	</attribute>
3495
3496	</interface>
3497
3498
3499	<interface
3500	name="IMachine" extends="$unknown"
3501	uuid="662c175e-a69d-40b8-a77a-1d719d0ab062"
3502	wsmap="managed"
3503	>
3504	<desc>
3505	The IMachine interface represents a virtual machine, or guest, created
3506	in VirtualBox.
3507
3508	This interface is used in two contexts. First of all, a collection of
3509	objects implementing this interface is stored in the
3510	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3511	machines that are currently registered with this VirtualBox
3512	installation. Also, once a session has been opened for the given virtual
3513	machine (e.g. the virtual machine is running), the machine object
3514	associated with the open session can be queried from the session object;
3515	see <link to="ISession"/> for details.
3516
3517	The main role of this interface is to expose the settings of the virtual
3518	machine and provide methods to change various aspects of the virtual
3519	machine's configuration. For machine objects stored in the
3520	<link to="IVirtualBox::machines"/> collection, all attributes are
3521	read-only unless explicitly stated otherwise in individual attribute
3522	and method descriptions.
3523
3524	In order to change a machine setting, a session for this machine must be
3525	opened using one of the <link to="IMachine::lockMachine" /> or
3526	<link to="IMachine::launchVMProcess"/> methods. After the
3527	machine has been successfully locked for a session, a mutable machine object
3528	needs to be queried from the session object and then the desired settings
3529	changes can be applied to the returned object using IMachine attributes and
3530	methods. See the <link to="ISession"/> interface description for more
3531	information about sessions.
3532
3533	Note that IMachine does not provide methods to control virtual machine
3534	execution (such as start the machine, or power it down) -- these methods
3535	are grouped in a separate interface called <link to="IConsole" />.
3536
3537	<see>ISession, IConsole</see>
3538	</desc>
3539
3540	<attribute name="parent" type="IVirtualBox" readonly="yes">
3541	<desc>Associated parent object.</desc>
3542	</attribute>
3543
3544	<attribute name="accessible" type="boolean" readonly="yes">
3545	<desc>
3546	Whether this virtual machine is currently accessible or not.
3547
3548	A machine is always deemed accessible unless it is registered <i>and</i>
3549	its settings file cannot be read or parsed (either because the file itself
3550	is unavailable or has invalid XML contents).
3551
3552	Every time this property is read, the accessibility state of
3553	this machine is re-evaluated. If the returned value is @c false,
3554	the <link to="#accessError"/> property may be used to get the
3555	detailed error information describing the reason of
3556	inaccessibility, including XML error messages.
3557
3558	When the machine is inaccessible, only the following properties
3559	can be used on it:
3560	<ul>
3561	<li><link to="#parent"/></li>
3562	<li><link to="#id"/></li>
3563	<li><link to="#settingsFilePath"/></li>
3564	<li><link to="#accessible"/></li>
3565	<li><link to="#accessError"/></li>
3566	</ul>
3567
3568	An attempt to access any other property or method will return
3569	an error.
3570
3571	The only possible action you can perform on an inaccessible
3572	machine is to unregister it using the
3573	<link to="IMachine::unregister"/> call (or, to check
3574	for the accessibility state once more by querying this
3575	property).
3576
3577	<note>
3578	In the current implementation, once this property returns
3579	@c true, the machine will never become inaccessible
3580	later, even if its settings file cannot be successfully
3581	read/written any more (at least, until the VirtualBox
3582	server is restarted). This limitation may be removed in
3583	future releases.
3584	</note>
3585	</desc>
3586	</attribute>
3587
3588	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3589	<desc>
3590	Error information describing the reason of machine
3591	inaccessibility.
3592
3593	Reading this property is only valid after the last call to
3594	<link to="#accessible"/> returned @c false (i.e. the
3595	machine is currently inaccessible). Otherwise, a @c null
3596	IVirtualBoxErrorInfo object will be returned.
3597	</desc>
3598	</attribute>
3599
3600	<attribute name="name" type="wstring">
3601	<desc>
3602	Name of the virtual machine.
3603
3604	Besides being used for human-readable identification purposes
3605	everywhere in VirtualBox, the virtual machine name is also used
3606	as a name of the machine's settings file and as a name of the
3607	subdirectory this settings file resides in. Thus, every time you
3608	change the value of this property, the settings file will be
3609	renamed once you call <link to="#saveSettings"/> to confirm the
3610	change. The containing subdirectory will be also renamed, but
3611	only if it has exactly the same name as the settings file
3612	itself prior to changing this property (for backward compatibility
3613	with previous API releases). The above implies the following
3614	limitations:
3615	<ul>
3616	<li>The machine name cannot be empty.</li>
3617	<li>The machine name can contain only characters that are valid
3618	file name characters according to the rules of the file
3619	system used to store VirtualBox configuration.</li>
3620	<li>You cannot have two or more machines with the same name
3621	if they use the same subdirectory for storing the machine
3622	settings files.</li>
3623	<li>You cannot change the name of the machine if it is running,
3624	or if any file in the directory containing the settings file
3625	is being used by another running machine or by any other
3626	process in the host operating system at a time when
3627	<link to="#saveSettings"/> is called.
3628	</li>
3629	</ul>
3630	If any of the above limitations are hit, <link to="#saveSettings"/>
3631	will return an appropriate error message explaining the exact
3632	reason and the changes you made to this machine will not be saved.
3633
3634	Starting with VirtualBox 4.0, a “.vbox” extension of the settings
3635	file is recommended, but not enforced. (Previous versions always
3636	used a generic ".xml" extension.)
3637	</desc>
3638	</attribute>
3639
3640	<attribute name="description" type="wstring">
3641	<desc>
3642	Description of the virtual machine.
3643
3644	The description attribute can contain any text and is
3645	typically used to describe the hardware and software
3646	configuration of the virtual machine in detail (i.e. network
3647	settings, versions of the installed software and so on).
3648	</desc>
3649	</attribute>
3650
3651	<attribute name="id" type="uuid" mod="string" readonly="yes">
3652	<desc>UUID of the virtual machine.</desc>
3653	</attribute>
3654
3655	<attribute name="OSTypeId" type="wstring">
3656	<desc>
3657	User-defined identifier of the Guest OS type.
3658	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3659	an IGuestOSType object representing details about the given
3660	Guest OS type.
3661	<note>
3662	This value may differ from the value returned by
3663	<link to="IGuest::OSTypeId"/> if Guest Additions are
3664	installed to the guest OS.
3665	</note>
3666	</desc>
3667	</attribute>
3668
3669	<attribute name="HardwareVersion" type="wstring">
3670	<desc>Hardware version identifier. Internal use only for now.</desc>
3671	</attribute>
3672
3673	<attribute name="hardwareUUID" type="uuid" mod="string">
3674	<desc>
3675	The UUID presented to the guest via memory tables, hardware and guest
3676	properties. For most VMs this is the same as the @a id, but for VMs
3677	which have been cloned or teleported it may be the same as the source
3678	VM. This latter is because the guest shouldn't notice that it was
3679	cloned or teleported.
3680	</desc>
3681	</attribute>
3682
3683	<attribute name="CPUCount" type="unsigned long">
3684	<desc>Number of virtual CPUs in the VM.</desc>
3685	</attribute>
3686
3687	<attribute name="CPUHotPlugEnabled" type="boolean">
3688	<desc>
3689	This setting determines whether VirtualBox allows CPU
3690	hotplugging for this machine.</desc>
3691	</attribute>
3692
3693	<attribute name="CPUExecutionCap" type="unsigned long">
3694	<desc>
3695	Means to limit the number of CPU cycles a guest can use. The unit
3696	is percentage of host CPU cycles per second. The valid range
3697	is 1 - 100. 100 (the default) implies no limit.
3698	</desc>
3699	</attribute>
3700
3701	<attribute name="memorySize" type="unsigned long">
3702	<desc>System memory size in megabytes.</desc>
3703	</attribute>
3704
3705	<attribute name="memoryBalloonSize" type="unsigned long">
3706	<desc>Memory balloon size in megabytes.</desc>
3707	</attribute>
3708
3709	<attribute name="PageFusionEnabled" type="boolean">
3710	<desc>
3711	This setting determines whether VirtualBox allows page
3712	fusion for this machine (64 bits host only).
3713	</desc>
3714	</attribute>
3715
3716	<attribute name="VRAMSize" type="unsigned long">
3717	<desc>Video memory size in megabytes.</desc>
3718	</attribute>
3719
3720	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3721	<desc>
3722	This setting determines whether VirtualBox allows this machine to make
3723	use of the 3D graphics support available on the host.</desc>
3724	</attribute>
3725
3726	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3727	<desc>
3728	This setting determines whether VirtualBox allows this machine to make
3729	use of the 2D video acceleration support available on the host.</desc>
3730	</attribute>
3731
3732	<attribute name="monitorCount" type="unsigned long">
3733	<desc>
3734	Number of virtual monitors.
3735	<note>
3736	Only effective on Windows XP and later guests with
3737	Guest Additions installed.
3738	</note>
3739	</desc>
3740	</attribute>
3741
3742	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3743	<desc>Object containing all BIOS settings.</desc>
3744	</attribute>
3745
3746	<attribute name="firmwareType" type="FirmwareType">
3747	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3748	bootstrap in this VM.</desc>
3749	</attribute>
3750
3751	<attribute name="pointingHidType" type="PointingHidType">
3752	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3753	The default is typically "PS2Mouse" but can vary depending on the
3754	requirements of the guest operating system.</desc>
3755	</attribute>
3756
3757	<attribute name="keyboardHidType" type="KeyboardHidType">
3758	<desc>Type of keyboard HID used in this VM.
3759	The default is typically "PS2Keyboard" but can vary depending on the
3760	requirements of the guest operating system.</desc>
3761	</attribute>
3762
3763	<attribute name="hpetEnabled" type="boolean">
3764	<desc>This attribute controls if High Precision Event Timer (HPET) is
3765	enabled in this VM. Use this property if you want to provide guests
3766	with additional time source, or if guest requires HPET to function correctly.
3767	Default is false.</desc>
3768	</attribute>
3769
3770	<attribute name="chipsetType" type="ChipsetType">
3771	<desc>Chipset type used in this VM.</desc>
3772	</attribute>
3773
3774	<attribute name="snapshotFolder" type="wstring">
3775	<desc>
3776	Full path to the directory used to store snapshot data
3777	(differencing media and saved state files) of this machine.
3778
3779	The initial value of this property is
3780	<tt><</tt><link to="#settingsFilePath">
3781	path_to_settings_file</link><tt>>/<</tt>
3782	<link to="#id">machine_uuid</link>
3783	<tt>></tt>.
3784
3785	Currently, it is an error to try to change this property on
3786	a machine that has snapshots (because this would require to
3787	move possibly large files to a different location).
3788	A separate method will be available for this purpose later.
3789
3790	<note>
3791	Setting this property to @c null or to an empty string will restore
3792	the initial value.
3793	</note>
3794	<note>
3795	When setting this property, the specified path can be
3796	absolute (full path) or relative to the directory where the
3797	<link to="#settingsFilePath">machine settings file</link>
3798	is located. When reading this property, a full path is
3799	always returned.
3800	</note>
3801	<note>
3802	The specified path may not exist, it will be created
3803	when necessary.
3804	</note>
3805	</desc>
3806	</attribute>
3807
3808	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3809	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3810	</attribute>
3811
3812	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3813	<desc>Array of media attached to this machine.</desc>
3814	</attribute>
3815
3816	<attribute name="USBController" type="IUSBController" readonly="yes">
3817	<desc>
3818	Associated USB controller object.
3819
3820	<note>
3821	If USB functionality is not available in the given edition of
3822	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3823	</note>
3824	</desc>
3825	</attribute>
3826
3827	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3828	<desc>Associated audio adapter, always present.</desc>
3829	</attribute>
3830
3831	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3832	<desc>Array of storage controllers attached to this machine.</desc>
3833	</attribute>
3834
3835	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3836	<desc>
3837	Full name of the file containing machine settings data.
3838	</desc>
3839	</attribute>
3840
3841	<attribute name="settingsModified" type="boolean" readonly="yes">
3842	<desc>
3843	Whether the settings of this machine have been modified
3844	(but neither yet saved nor discarded).
3845	<note>
3846	Reading this property is only valid on instances returned
3847	by <link to="ISession::machine"/> and on new machines
3848	created by <link to="IVirtualBox::createMachine"/> or opened
3849	by <link to="IVirtualBox::openMachine"/> but not
3850	yet registered, or on unregistered machines after calling
3851	<link to="IMachine::unregister"/>. For all other
3852	cases, the settings can never be modified.
3853	</note>
3854	<note>
3855	For newly created unregistered machines, the value of this
3856	property is always @c true until <link to="#saveSettings"/>
3857	is called (no matter if any machine settings have been
3858	changed after the creation or not). For opened machines
3859	the value is set to @c false (and then follows to normal rules).
3860	</note>
3861	</desc>
3862	</attribute>
3863
3864	<attribute name="sessionState" type="SessionState" readonly="yes">
3865	<desc>Current session state for this machine.</desc>
3866	</attribute>
3867
3868	<attribute name="sessionType" type="wstring" readonly="yes">
3869	<desc>
3870	Type of the session. If <link to="#sessionState"/> is
3871	Spawning or Locked, this attribute contains the
3872	same value as passed to the
3873	<link to="IMachine::launchVMProcess"/> method in the
3874	@a type parameter. If the session was used with
3875	<link to="IMachine::lockMachine" />, or if
3876	<link to="#sessionState"/> is SessionClosed, the value of this
3877	attribute is an empty string.
3878	</desc>
3879	</attribute>
3880
3881	<attribute name="sessionPid" type="unsigned long" readonly="yes">
3882	<desc>
3883	Identifier of the session process. This attribute contains the
3884	platform-dependent identifier of the process whose session was
3885	used with <link to="IMachine::lockMachine" /> call. The returned
3886	value is only valid if <link to="#sessionState"/> is Locked or
3887	Unlocking by the time this property is read.
3888	</desc>
3889	</attribute>
3890
3891	<attribute name="state" type="MachineState" readonly="yes">
3892	<desc>Current execution state of this machine.</desc>
3893	</attribute>
3894
3895	<attribute name="lastStateChange" type="long long" readonly="yes">
3896	<desc>
3897	Time stamp of the last execution state change,
3898	in milliseconds since 1970-01-01 UTC.
3899	</desc>
3900	</attribute>
3901
3902	<attribute name="stateFilePath" type="wstring" readonly="yes">
3903	<desc>
3904	Full path to the file that stores the execution state of
3905	the machine when it is in the <link to="MachineState_Saved"/> state.
3906	<note>
3907	When the machine is not in the Saved state, this attribute is
3908	an empty string.
3909	</note>
3910	</desc>
3911	</attribute>
3912
3913	<attribute name="logFolder" type="wstring" readonly="yes">
3914	<desc>
3915	Full path to the folder that stores a set of rotated log files
3916	recorded during machine execution. The most recent log file is
3917	named <tt>VBox.log</tt>, the previous log file is
3918	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
3919	in the current version).
3920	</desc>
3921	</attribute>
3922
3923	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
3924	<desc>
3925	Current snapshot of this machine. This is @c null if the machine
3926	currently has no snapshots. If it is not @c null, then it was
3927	set by one of <link to="IConsole::takeSnapshot" />,
3928	<link to="IConsole::deleteSnapshot" />
3929	or <link to="IConsole::restoreSnapshot" />, depending on which
3930	was called last. See <link to="ISnapshot"/> for details.
3931	</desc>
3932	</attribute>
3933
3934	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
3935	<desc>
3936	Number of snapshots taken on this machine. Zero means the
3937	machine doesn't have any snapshots.
3938	</desc>
3939	</attribute>
3940
3941	<attribute name="currentStateModified" type="boolean" readonly="yes">
3942	<desc>
3943	Returns @c true if the current state of the machine is not
3944	identical to the state stored in the current snapshot.
3945
3946	The current state is identical to the current snapshot only
3947	directly after one of the following calls are made:
3948
3949	<ul>
3950	<li><link to="IConsole::restoreSnapshot"/>
3951	</li>
3952	<li><link to="IConsole::takeSnapshot"/> (issued on a
3953	"powered off" or "saved" machine, for which
3954	<link to="#settingsModified"/> returns @c false)
3955	</li>
3956	</ul>
3957
3958	The current state remains identical until one of the following
3959	happens:
3960	<ul>
3961	<li>settings of the machine are changed</li>
3962	<li>the saved state is deleted</li>
3963	<li>the current snapshot is deleted</li>
3964	<li>an attempt to execute the machine is made</li>
3965	</ul>
3966
3967	<note>
3968	For machines that don't have snapshots, this property is
3969	always @c false.
3970	</note>
3971	</desc>
3972	</attribute>
3973
3974	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
3975	<desc>
3976	Collection of shared folders for this machine (permanent shared
3977	folders). These folders are shared automatically at machine startup
3978	and available only to the guest OS installed within this machine.
3979
3980	New shared folders are added to the collection using
3981	<link to="#createSharedFolder"/>. Existing shared folders can be
3982	removed using <link to="#removeSharedFolder"/>.
3983	</desc>
3984	</attribute>
3985
3986	<attribute name="clipboardMode" type="ClipboardMode">
3987	<desc>
3988	Synchronization mode between the host OS clipboard
3989	and the guest OS clipboard.
3990	</desc>
3991	</attribute>
3992
3993	<attribute name="guestPropertyNotificationPatterns" type="wstring">
3994	<desc>
3995	A comma-separated list of simple glob patterns. Changes to guest
3996	properties whose name matches one of the patterns will generate an
3997	<link to="IGuestPropertyChangedEvent"/> signal.
3998	</desc>
3999	</attribute>
4000
4001	<attribute name="teleporterEnabled" type="boolean">
4002	<desc>
4003	When set to @a true, the virtual machine becomes a target teleporter
4004	the next time it is powered on. This can only set to @a true when the
4005	VM is in the @a PoweredOff or @a Aborted state.
4006
4007	<!-- This property is automatically set to @a false when the VM is powered
4008	on. (bird: This doesn't work yet ) -->
4009	</desc>
4010	</attribute>
4011
4012	<attribute name="teleporterPort" type="unsigned long">
4013	<desc>
4014	The TCP port the target teleporter will listen for incoming
4015	teleportations on.
4016
4017	0 means the port is automatically selected upon power on. The actual
4018	value can be read from this property while the machine is waiting for
4019	incoming teleportations.
4020	</desc>
4021	</attribute>
4022
4023	<attribute name="teleporterAddress" type="wstring">
4024	<desc>
4025	The address the target teleporter will listen on. If set to an empty
4026	string, it will listen on all addresses.
4027	</desc>
4028	</attribute>
4029
4030	<attribute name="teleporterPassword" type="wstring">
4031	<desc>
4032	The password to check for on the target teleporter. This is just a
4033	very basic measure to prevent simple hacks and operators accidentally
4034	beaming a virtual machine to the wrong place.
4035	</desc>
4036	</attribute>
4037
4038	<attribute name="faultToleranceState" type="FaultToleranceState">
4039	<desc>
4040	Fault tolerance state; disabled, source or target.
4041	This property can be changed at any time. If you change it for a running
4042	VM, then the fault tolerance address and port must be set beforehand.
4043	</desc>
4044	</attribute>
4045
4046	<attribute name="faultTolerancePort" type="unsigned long">
4047	<desc>
4048	The TCP port the fault tolerance source or target will use for
4049	communication.
4050	</desc>
4051	</attribute>
4052
4053	<attribute name="faultToleranceAddress" type="wstring">
4054	<desc>
4055	The address the fault tolerance source or target.
4056	</desc>
4057	</attribute>
4058
4059	<attribute name="faultTolerancePassword" type="wstring">
4060	<desc>
4061	The password to check for on the standby VM. This is just a
4062	very basic measure to prevent simple hacks and operators accidentally
4063	choosing the wrong standby VM.
4064	</desc>
4065	</attribute>
4066
4067	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4068	<desc>
4069	The interval in ms used for syncing the state between source and target.
4070	</desc>
4071	</attribute>
4072
4073	<attribute name="RTCUseUTC" type="boolean">
4074	<desc>
4075	When set to @a true, the RTC device of the virtual machine will run
4076	in UTC time, otherwise in local time. Especially Unix guests prefer
4077	the time in UTC.
4078	</desc>
4079	</attribute>
4080
4081	<attribute name="ioCacheEnabled" type="boolean">
4082	<desc>
4083	When set to @a true, the builtin I/O cache of the virtual machine
4084	will be enabled.
4085	</desc>
4086	</attribute>
4087
4088	<attribute name="ioCacheSize" type="unsigned long">
4089	<desc>
4090	Maximum size of the I/O cache in MB.
4091	</desc>
4092	</attribute>
4093
4094	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4095	<desc>
4096	Bandwidth control manager.
4097	</desc>
4098	</attribute>
4099
4100	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4101	<desc>Array of PCI devices assigned to this machine, to get list of all PCI devices
4102	attached to the machine use IConsole::attachedPciDevices attribute, as
4103	this attribute is intended to list only devices additional to what
4104	described in virtual hardware config. Usually, this list keeps host's
4105	physical devices assigned to the particular machine.
4106	</desc>
4107	</attribute>
4108
4109	<method name="lockMachine">
4110	<desc>
4111	Locks the machine for the given session to enable the caller
4112	to make changes to the machine or start the VM or control
4113	VM execution.
4114
4115	There are two ways to lock a machine for such uses:
4116
4117	<ul>
4118	<li>If you want to make changes to the machine settings,
4119	you must obtain an exclusive write lock on the machine
4120	by setting @a lockType to @c Write.
4121
4122	This will only succeed if no other process has locked
4123	the machine to prevent conflicting changes. Only after
4124	an exclusive write lock has been obtained using this method, one
4125	can change all VM settings or execute the VM in the process
4126	space of the session object. (Note that the latter is only of
4127	interest if you actually want to write a new front-end for
4128	virtual machines; but this API gets called internally by
4129	the existing front-ends such as VBoxHeadless and the VirtualBox
4130	GUI to acquire a write lock on the machine that they are running.)
4131
4132	On success, write-locking the machine for a session creates
4133	a second copy of the IMachine object. It is this second object
4134	upon which changes can be made; in VirtualBox terminology, the
4135	second copy is "mutable". It is only this second, mutable machine
4136	object upon which you can call methods that change the
4137	machine state. After having called this method, you can
4138	obtain this second, mutable machine object using the
4139	<link to="ISession::machine" /> attribute.
4140	</li>
4141	<li>If you only want to check the machine state or control
4142	machine execution without actually changing machine
4143	settings (e.g. to get access to VM statistics or take
4144	a snapshot or save the machine state), then set the
4145	@a lockType argument to @c Shared.
4146
4147	If no other session has obtained a lock, you will obtain an
4148	exclusive write lock as described above. However, if another
4149	session has already obtained such a lock, then a link to that
4150	existing session will be established which allows you
4151	to control that existing session.
4152
4153	To find out which type of lock was obtained, you can
4154	inspect <link to="ISession::type" />, which will have been
4155	set to either @c WriteLock or @c Shared.
4156	</li>
4157	</ul>
4158
4159	In either case, you can get access to the <link to="IConsole" />
4160	object which controls VM execution.
4161
4162	Also in all of the above cases, one must always call
4163	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4164	the machine's state will eventually be set to "Aborted".
4165
4166	To change settings on a machine, the following sequence is typically
4167	performed:
4168
4169	<ol>
4170	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4171
4172	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4173
4174	<li>Change the settings of the machine by invoking IMachine methods.</li>
4175
4176	<li>Call <link to="IMachine::saveSettings" />.</li>
4177
4178	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4179	</ol>
4180
4181	<result name="E_UNEXPECTED">
4182	Virtual machine not registered.
4183	</result>
4184	<result name="E_ACCESSDENIED">
4185	Process not started by OpenRemoteSession.
4186	</result>
4187	<result name="VBOX_E_INVALID_OBJECT_STATE">
4188	Session already open or being opened.
4189	</result>
4190	<result name="VBOX_E_VM_ERROR">
4191	Failed to assign machine to session.
4192	</result>
4193	</desc>
4194	<param name="session" type="ISession" dir="in">
4195	<desc>
4196	Session object for which the machine will be locked.
4197	</desc>
4198	</param>
4199	<param name="lockType" type="LockType" dir="in">
4200	<desc>
4201	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4202	If set to @c Shared, then either acquire an exclusive write lock or establish
4203	a link to an existing session.
4204	</desc>
4205	</param>
4206	</method>
4207
4208	<method name="launchVMProcess">
4209	<desc>
4210	Spawns a new process that will execute the virtual machine and obtains a shared
4211	lock on the machine for the calling session.
4212
4213	If launching the VM succeeds, the new VM process will create its own session
4214	and write-lock the machine for it, preventing conflicting changes from other
4215	processes. If the machine is already locked (because it is already running or
4216	because another session has a write lock), launching the VM process will therefore
4217	fail. Reversely, future attempts to obtain a write lock will also fail while the
4218	machine is running.
4219
4220	The caller's session object remains separate from the session opened by the new
4221	VM process. It receives its own <link to="IConsole" /> object which can be used
4222	to control machine execution, but it cannot be used to change all VM settings
4223	which would be available after a <link to="#lockMachine" /> call.
4224
4225	The caller must eventually release the session's shared lock by calling
4226	<link to="ISession::unlockMachine" /> on the local session object once this call
4227	has returned. However, the session's state (see <link to="ISession::state" />)
4228	will not return to "Unlocked" until the remote session has also unlocked
4229	the machine (i.e. the machine has stopped running).
4230
4231	Launching a VM process can take some time (a new VM is started in a new process,
4232	for which memory and other resources need to be set up). Because of this,
4233	an <link to="IProgress" /> object is returned to allow the caller to wait
4234	for this asynchronous operation to be completed. Until then, the caller's
4235	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4236	and <link to="ISession::console" /> attributes cannot be accessed.
4237	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4238	similar calls to wait for completion. Completion is signalled when the VM
4239	is powered on. If launching the VM fails, error messages can be queried
4240	via the progress object, if available.
4241
4242	The progress object will have at least 2 sub-operations. The first
4243	operation covers the period up to the new VM process calls powerUp.
4244	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4245	progress object. Because <link to="IConsole::powerUp"/> may require
4246	some extra sub-operations, the <link to="IProgress::operationCount"/>
4247	may change at the completion of operation.
4248
4249	For details on the teleportation progress operation, see
4250	<link to="IConsole::powerUp"/>.
4251
4252	The @a environment argument is a string containing definitions of
4253	environment variables in the following format:
4254	@code
4255	NAME[=VALUE]\n
4256	NAME[=VALUE]\n
4257	...
4258	@endcode
4259	where <tt>\\n</tt> is the new line character. These environment
4260	variables will be appended to the environment of the VirtualBox server
4261	process. If an environment variable exists both in the server process
4262	and in this list, the value from this list takes precedence over the
4263	server's variable. If the value of the environment variable is
4264	omitted, this variable will be removed from the resulting environment.
4265	If the environment string is @c null or empty, the server environment
4266	is inherited by the started process as is.
4267
4268	<result name="E_UNEXPECTED">
4269	Virtual machine not registered.
4270	</result>
4271	<result name="E_INVALIDARG">
4272	Invalid session type @a type.
4273	</result>
4274	<result name="VBOX_E_OBJECT_NOT_FOUND">
4275	No machine matching @a machineId found.
4276	</result>
4277	<result name="VBOX_E_INVALID_OBJECT_STATE">
4278	Session already open or being opened.
4279	</result>
4280	<result name="VBOX_E_IPRT_ERROR">
4281	Launching process for machine failed.
4282	</result>
4283	<result name="VBOX_E_VM_ERROR">
4284	Failed to assign machine to session.
4285	</result>
4286	</desc>
4287	<param name="session" type="ISession" dir="in">
4288	<desc>
4289	Client session object to which the VM process will be connected (this
4290	must be in "Unlocked" state).
4291	</desc>
4292	</param>
4293	<param name="type" type="wstring" dir="in">
4294	<desc>
4295	Front-end to use for the new VM process. The following are currently supported:
4296	<ul>
4297	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4298	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4299	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4300	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4301	the currently running VM or session owner. In this case the
4302	@a session parameter may be @c NULL (if it is non-null it isn't
4303	used in any way), and the @a progress return value will be always
4304	NULL. The operation completes immediately.</li>
4305	</ul>
4306	</desc>
4307	</param>
4308	<param name="environment" type="wstring" dir="in">
4309	<desc>
4310	Environment to pass to the VM process.
4311	</desc>
4312	</param>
4313	<param name="progress" type="IProgress" dir="return">
4314	<desc>Progress object to track the operation completion.</desc>
4315	</param>
4316	</method>
4317
4318	<method name="setBootOrder">
4319	<desc>
4320	Puts the given device to the specified position in
4321	the boot order.
4322
4323	To indicate that no device is associated with the given position,
4324	<link to="DeviceType_Null"/> should be used.
4325
4326	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4327
4328	<result name="E_INVALIDARG">
4329	Boot @a position out of range.
4330	</result>
4331	<result name="E_NOTIMPL">
4332	Booting from USB @a device currently not supported.
4333	</result>
4334
4335	</desc>
4336	<param name="position" type="unsigned long" dir="in">
4337	<desc>
4338	Position in the boot order (@c 1 to the total number of
4339	devices the machine can boot from, as returned by
4340	<link to="ISystemProperties::maxBootPosition"/>).
4341	</desc>
4342	</param>
4343	<param name="device" type="DeviceType" dir="in">
4344	<desc>
4345	The type of the device used to boot at the given position.
4346	</desc>
4347	</param>
4348	</method>
4349
4350	<method name="getBootOrder" const="yes">
4351	<desc>
4352	Returns the device type that occupies the specified
4353	position in the boot order.
4354
4355	@todo [remove?]
4356	If the machine can have more than one device of the returned type
4357	(such as hard disks), then a separate method should be used to
4358	retrieve the individual device that occupies the given position.
4359
4360	If here are no devices at the given position, then
4361	<link to="DeviceType_Null"/> is returned.
4362
4363	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4364
4365	<result name="E_INVALIDARG">
4366	Boot @a position out of range.
4367	</result>
4368
4369	</desc>
4370	<param name="position" type="unsigned long" dir="in">
4371	<desc>
4372	Position in the boot order (@c 1 to the total number of
4373	devices the machine can boot from, as returned by
4374	<link to="ISystemProperties::maxBootPosition"/>).
4375	</desc>
4376	</param>
4377	<param name="device" type="DeviceType" dir="return">
4378	<desc>
4379	Device at the given position.
4380	</desc>
4381	</param>
4382	</method>
4383
4384	<method name="attachDevice">
4385	<desc>
4386	Attaches a device and optionally mounts a medium to the given storage
4387	controller (<link to="IStorageController" />, identified by @a name),
4388	at the indicated port and device.
4389
4390	This method is intended for managing storage devices in general while a
4391	machine is powered off. It can be used to attach and detach fixed
4392	and removable media. The following kind of media can be attached
4393	to a machine:
4394
4395	<ul>
4396	<li>For fixed and removable media, you can pass in a medium that was
4397	previously opened using <link to="IVirtualBox::openMedium" />.
4398	</li>
4399
4400	<li>Only for storage devices supporting removable media (such as
4401	DVDs and floppies), you can also specify a null pointer to
4402	indicate an empty drive or one of the medium objects listed
4403	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4404	arrays to indicate a host drive.
4405	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4406	to change the media while the machine is running.
4407	</li>
4408	</ul>
4409
4410	In a VM's default configuration of virtual machines, the secondary
4411	master of the IDE controller is used for a CD/DVD drive.
4412
4413	After calling this returns successfully, a new instance of
4414	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4415	attachments (see <link to="IMachine::mediumAttachments"/>).
4416
4417	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4418	information about attaching media.
4419
4420	The specified device slot must not have a device attached to it,
4421	or this method will fail.
4422
4423	<note>
4424	You cannot attach a device to a newly created machine until
4425	this machine's settings are saved to disk using
4426	<link to="#saveSettings"/>.
4427	</note>
4428	<note>
4429	If the medium is being attached indirectly, a new differencing medium
4430	will implicitly be created for it and attached instead. If the
4431	changes made to the machine settings (including this indirect
4432	attachment) are later cancelled using <link to="#discardSettings"/>,
4433	this implicitly created differencing medium will implicitly
4434	be deleted.
4435	</note>
4436
4437	<result name="E_INVALIDARG">
4438	SATA device, SATA port, IDE port or IDE slot out of range, or
4439	file or UUID not found.
4440	</result>
4441	<result name="VBOX_E_INVALID_OBJECT_STATE">
4442	Machine must be registered before media can be attached.
4443	</result>
4444	<result name="VBOX_E_INVALID_VM_STATE">
4445	Invalid machine state.
4446	</result>
4447	<result name="VBOX_E_OBJECT_IN_USE">
4448	A medium is already attached to this or another virtual machine.
4449	</result>
4450
4451	</desc>
4452	<param name="name" type="wstring" dir="in">
4453	<desc>Name of the storage controller to attach the device to.</desc>
4454	</param>
4455	<param name="controllerPort" type="long" dir="in">
4456	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4457	the primary controller and 1 specifies the secondary controller.
4458	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4459	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4460	</param>
4461	<param name="device" type="long" dir="in">
4462	<desc>Device slot in the given port to attach the device to. This is only
4463	relevant for IDE controllers, for which 0 specifies the master device and
4464	1 specifies the slave device. For all other controller types, this must
4465	be 0.</desc>
4466	</param>
4467	<param name="type" type="DeviceType" dir="in">
4468	<desc>Device type of the attached device. For media opened by
4469	<link to="IVirtualBox::openMedium" />, this must match the device type
4470	specified there.</desc>
4471	</param>
4472	<param name="medium" type="IMedium" dir="in">
4473	<desc>Medium to mount or NULL for an empty drive.</desc>
4474	</param>
4475	</method>
4476
4477	<method name="detachDevice">
4478	<desc>
4479	Detaches the device attached to a device slot of the specified bus.
4480
4481	Detaching the device from the virtual machine is deferred. This means
4482	that the medium remains associated with the machine when this method
4483	returns and gets actually de-associated only after a successful
4484	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4485	for more detailed information about attaching media.
4486
4487	<note>
4488	You cannot detach a device from a running machine.
4489	</note>
4490	<note>
4491	Detaching differencing media implicitly created by <link
4492	to="#attachDevice"/> for the indirect attachment using this
4493	method will <b>not</b> implicitly delete them. The
4494	<link to="IMedium::deleteStorage"/> operation should be
4495	explicitly performed by the caller after the medium is successfully
4496	detached and the settings are saved with
4497	<link to="#saveSettings"/>, if it is the desired action.
4498	</note>
4499
4500	<result name="VBOX_E_INVALID_VM_STATE">
4501	Attempt to detach medium from a running virtual machine.
4502	</result>
4503	<result name="VBOX_E_OBJECT_NOT_FOUND">
4504	No medium attached to given slot/bus.
4505	</result>
4506	<result name="VBOX_E_NOT_SUPPORTED">
4507	Medium format does not support storage deletion.
4508	</result>
4509
4510	</desc>
4511	<param name="name" type="wstring" dir="in">
4512	<desc>Name of the storage controller to detach the medium from.</desc>
4513	</param>
4514	<param name="controllerPort" type="long" dir="in">
4515	<desc>Port number to detach the medium from.</desc>
4516	</param>
4517	<param name="device" type="long" dir="in">
4518	<desc>Device slot number to detach the medium from.</desc>
4519	</param>
4520	</method>
4521
4522	<method name="passthroughDevice">
4523	<desc>
4524	Sets the passthrough mode of an existing DVD device. Changing the
4525	setting while the VM is running is forbidden. The setting is only used
4526	if at VM start the device is configured as a host DVD drive, in all
4527	other cases it is ignored. The device must already exist; see
4528	<link to="IMachine::attachDevice"/> for how to attach a new device.
4529
4530	The @a controllerPort and @a device parameters specify the device slot and
4531	have have the same meaning as with <link to="IMachine::attachDevice" />.
4532
4533	<result name="E_INVALIDARG">
4534	SATA device, SATA port, IDE port or IDE slot out of range.
4535	</result>
4536	<result name="VBOX_E_INVALID_OBJECT_STATE">
4537	Attempt to modify an unregistered virtual machine.
4538	</result>
4539	<result name="VBOX_E_INVALID_VM_STATE">
4540	Invalid machine state.
4541	</result>
4542
4543	</desc>
4544	<param name="name" type="wstring" dir="in">
4545	<desc>Name of the storage controller.</desc>
4546	</param>
4547	<param name="controllerPort" type="long" dir="in">
4548	<desc>Storage controller port.</desc>
4549	</param>
4550	<param name="device" type="long" dir="in">
4551	<desc>Device slot in the given port.</desc>
4552	</param>
4553	<param name="passthrough" type="boolean" dir="in">
4554	<desc>New value for the passthrough setting.</desc>
4555	</param>
4556	</method>
4557
4558	<method name="setBandwidthGroupForDevice">
4559	<desc>
4560	Sets the bandwidth group of an existing storage device.
4561	The device must already exist; see <link to="IMachine::attachDevice"/>
4562	for how to attach a new device.
4563
4564	The @a controllerPort and @a device parameters specify the device slot and
4565	have have the same meaning as with <link to="IMachine::attachDevice" />.
4566
4567	<result name="E_INVALIDARG">
4568	SATA device, SATA port, IDE port or IDE slot out of range.
4569	</result>
4570	<result name="VBOX_E_INVALID_OBJECT_STATE">
4571	Attempt to modify an unregistered virtual machine.
4572	</result>
4573	<result name="VBOX_E_INVALID_VM_STATE">
4574	Invalid machine state.
4575	</result>
4576
4577	</desc>
4578	<param name="name" type="wstring" dir="in">
4579	<desc>Name of the storage controller.</desc>
4580	</param>
4581	<param name="controllerPort" type="long" dir="in">
4582	<desc>Storage controller port.</desc>
4583	</param>
4584	<param name="device" type="long" dir="in">
4585	<desc>Device slot in the given port.</desc>
4586	</param>
4587	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4588	<desc>New value for the bandwidth group or NULL for no group.</desc>
4589	</param>
4590	</method>
4591
4592	<method name="mountMedium">
4593	<desc>
4594	Mounts a medium (<link to="IMedium" />, identified
4595	by the given UUID @a id) to the given storage controller
4596	(<link to="IStorageController" />, identified by @a name),
4597	at the indicated port and device. The device must already exist;
4598	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4599
4600	This method is intended only for managing removable media, where the
4601	device is fixed but media is changeable at runtime (such as DVDs
4602	and floppies). It cannot be used for fixed media such as hard disks.
4603
4604	The @a controllerPort and @a device parameters specify the device slot and
4605	have have the same meaning as with <link to="IMachine::attachDevice" />.
4606
4607	The specified device slot can have a medium mounted, which will be
4608	unmounted first. Specifying a zero UUID (or an empty string) for
4609	@a medium does just an unmount.
4610
4611	See <link to="IMedium"/> for more detailed information about
4612	attaching media.
4613
4614	<result name="E_INVALIDARG">
4615	SATA device, SATA port, IDE port or IDE slot out of range.
4616	</result>
4617	<result name="VBOX_E_INVALID_OBJECT_STATE">
4618	Attempt to attach medium to an unregistered virtual machine.
4619	</result>
4620	<result name="VBOX_E_INVALID_VM_STATE">
4621	Invalid machine state.
4622	</result>
4623	<result name="VBOX_E_OBJECT_IN_USE">
4624	Medium already attached to this or another virtual machine.
4625	</result>
4626
4627	</desc>
4628	<param name="name" type="wstring" dir="in">
4629	<desc>Name of the storage controller to attach the medium to.</desc>
4630	</param>
4631	<param name="controllerPort" type="long" dir="in">
4632	<desc>Port to attach the medium to.</desc>
4633	</param>
4634	<param name="device" type="long" dir="in">
4635	<desc>Device slot in the given port to attach the medium to.</desc>
4636	</param>
4637	<param name="medium" type="IMedium" dir="in">
4638	<desc>Medium to mount or NULL for an empty drive.</desc>
4639	</param>
4640	<param name="force" type="boolean" dir="in">
4641	<desc>Allows to force unmount/mount of a medium which is locked by
4642	the device slot in the given port to attach the medium to.</desc>
4643	</param>
4644	</method>
4645
4646	<method name="getMedium" const="yes">
4647	<desc>
4648	Returns the virtual medium attached to a device slot of the specified
4649	bus.
4650
4651	Note that if the medium was indirectly attached by
4652	<link to="#mountMedium"/> to the given device slot then this
4653	method will return not the same object as passed to the
4654	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4655	more detailed information about mounting a medium.
4656
4657	<result name="VBOX_E_OBJECT_NOT_FOUND">
4658	No medium attached to given slot/bus.
4659	</result>
4660
4661	</desc>
4662	<param name="name" type="wstring" dir="in">
4663	<desc>Name of the storage controller the medium is attached to.</desc>
4664	</param>
4665	<param name="controllerPort" type="long" dir="in">
4666	<desc>Port to query.</desc>
4667	</param>
4668	<param name="device" type="long" dir="in">
4669	<desc>Device slot in the given port to query.</desc>
4670	</param>
4671	<param name="medium" type="IMedium" dir="return">
4672	<desc>Attached medium object.</desc>
4673	</param>
4674	</method>
4675
4676	<method name="getMediumAttachmentsOfController" const="yes">
4677	<desc>
4678	Returns an array of medium attachments which are attached to the
4679	the controller with the given name.
4680
4681	<result name="VBOX_E_OBJECT_NOT_FOUND">
4682	A storage controller with given name doesn't exist.
4683	</result>
4684	</desc>
4685	<param name="name" type="wstring" dir="in"/>
4686	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4687	</method>
4688
4689	<method name="getMediumAttachment" const="yes">
4690	<desc>
4691	Returns a medium attachment which corresponds to the controller with
4692	the given name, on the given port and device slot.
4693
4694	<result name="VBOX_E_OBJECT_NOT_FOUND">
4695	No attachment exists for the given controller/port/device combination.
4696	</result>
4697	</desc>
4698	<param name="name" type="wstring" dir="in"/>
4699	<param name="controllerPort" type="long" dir="in"/>
4700	<param name="device" type="long" dir="in"/>
4701	<param name="attachment" type="IMediumAttachment" dir="return"/>
4702	</method>
4703
4704	<method name="attachHostPciDevice">
4705	<desc>
4706	Attaches host PCI device with the given (host) PCI address to the
4707	PCI bus of the virtual machine. Please note, that this operation
4708	is two phase, as real attachment will happen when VM will start,
4709	and most information will be delivered as IHostPciDevicePlugEvent
4710	on IVirtualBox event source.
4711
4712	<see>IHostPciDevicePlugEvent</see>
4713
4714	<result name="VBOX_E_INVALID_VM_STATE">
4715	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4716	</result>
4717	<result name="VBOX_E_PDM_ERROR">
4718	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4719	</result>
4720	<result name="VBOX_E_NOT_SUPPORTED">
4721	Hardware or host OS doesn't allow PCI device passthrought.
4722	</result>
4723	</desc>
4724	<param name="hostAddress" type="long" dir="in">
4725	<desc>Address of the host PCI device.</desc>
4726	</param>
4727	<param name="desiredGuestAddress" type="long" dir="in">
4728	<desc>Desired position of this device on guest PCI bus.</desc>
4729	</param>
4730	<param name="tryToUnbind" type="boolean" dir="in">
4731	<desc>If VMM shall try to unbind existing drivers from the
4732	device before attaching it to the guest.</desc>
4733	</param>
4734	</method>
4735
4736	<method name="detachHostPciDevice">
4737	<desc>
4738	Detach host PCI device from the virtual machine.
4739	Also HostPciDevicePlugEvent on IVirtualBox event source
4740	will be delivered. As currently we don't support hot device
4741	unplug, IHostPciDevicePlugEvent event is delivered immediately.
4742
4743	<see>IHostPciDevicePlugEvent</see>
4744
4745	<result name="VBOX_E_INVALID_VM_STATE">
4746	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4747	</result>
4748	<result name="VBOX_E_OBJECT_NOT_FOUND">
4749	This host device is not attached to this machine.
4750	</result>
4751	<result name="VBOX_E_PDM_ERROR">
4752	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4753	</result>
4754	<result name="VBOX_E_NOT_SUPPORTED">
4755	Hardware or host OS doesn't allow PCI device passthrought.
4756	</result>
4757	</desc>
4758	<param name="hostAddress" type="long" dir="in">
4759	<desc>Address of the host PCI device.</desc>
4760	</param>
4761	</method>
4762
4763	<method name="getNetworkAdapter" const="yes">
4764	<desc>
4765	Returns the network adapter associated with the given slot.
4766	Slots are numbered sequentially, starting with zero. The total
4767	number of adapters per machine is defined by the
4768	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
4769	so the maximum slot number is one less than that property's value.
4770
4771	<result name="E_INVALIDARG">
4772	Invalid @a slot number.
4773	</result>
4774
4775	</desc>
4776	<param name="slot" type="unsigned long" dir="in"/>
4777	<param name="adapter" type="INetworkAdapter" dir="return"/>
4778	</method>
4779
4780	<method name="addStorageController">
4781	<desc>
4782	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4783	machine and returns it as an instance of
4784	<link to="IStorageController" />.
4785
4786	@a name identifies the controller for subsequent calls such as
4787	<link to="#getStorageControllerByName" />,
4788	<link to="#getStorageControllerByInstance" />,
4789	<link to="#removeStorageController" />,
4790	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4791
4792	After the controller has been added, you can set its exact
4793	type by setting the <link to="IStorageController::controllerType" />.
4794
4795	<result name="VBOX_E_OBJECT_IN_USE">
4796	A storage controller with given name exists already.
4797	</result>
4798	<result name="E_INVALIDARG">
4799	Invalid @a controllerType.
4800	</result>
4801	</desc>
4802	<param name="name" type="wstring" dir="in"/>
4803	<param name="connectionType" type="StorageBus" dir="in"/>
4804	<param name="controller" type="IStorageController" dir="return"/>
4805	</method>
4806
4807	<method name="getStorageControllerByName" const="yes">
4808	<desc>
4809	Returns a storage controller with the given name.
4810
4811	<result name="VBOX_E_OBJECT_NOT_FOUND">
4812	A storage controller with given name doesn't exist.
4813	</result>
4814	</desc>
4815	<param name="name" type="wstring" dir="in"/>
4816	<param name="storageController" type="IStorageController" dir="return"/>
4817	</method>
4818
4819	<method name="getStorageControllerByInstance" const="yes">
4820	<desc>
4821	Returns a storage controller with the given instance number.
4822
4823	<result name="VBOX_E_OBJECT_NOT_FOUND">
4824	A storage controller with given instance number doesn't exist.
4825	</result>
4826	</desc>
4827	<param name="instance" type="unsigned long" dir="in"/>
4828	<param name="storageController" type="IStorageController" dir="return"/>
4829	</method>
4830
4831	<method name="removeStorageController">
4832	<desc>
4833	Removes a storage controller from the machine.
4834
4835	<result name="VBOX_E_OBJECT_NOT_FOUND">
4836	A storage controller with given name doesn't exist.
4837	</result>
4838	</desc>
4839	<param name="name" type="wstring" dir="in"/>
4840	</method>
4841
4842	<method name="setStorageControllerBootable">
4843	<desc>
4844	Sets the bootable flag of the storage controller with the given name.
4845
4846	<result name="VBOX_E_OBJECT_NOT_FOUND">
4847	A storage controller with given name doesn't exist.
4848	</result>
4849	<result name="VBOX_E_OBJECT_IN_USE">
4850	Another storage controller is marked as bootable already.
4851	</result>
4852	</desc>
4853	<param name="name" type="wstring" dir="in"/>
4854	<param name="bootable" type="boolean" dir="in"/>
4855	</method>
4856
4857	<method name="getSerialPort" const="yes">
4858	<desc>
4859	Returns the serial port associated with the given slot.
4860	Slots are numbered sequentially, starting with zero. The total
4861	number of serial ports per machine is defined by the
4862	<link to="ISystemProperties::serialPortCount"/> property,
4863	so the maximum slot number is one less than that property's value.
4864
4865	<result name="E_INVALIDARG">
4866	Invalid @a slot number.
4867	</result>
4868
4869	</desc>
4870	<param name="slot" type="unsigned long" dir="in"/>
4871	<param name="port" type="ISerialPort" dir="return"/>
4872	</method>
4873
4874	<method name="getParallelPort" const="yes">
4875	<desc>
4876	Returns the parallel port associated with the given slot.
4877	Slots are numbered sequentially, starting with zero. The total
4878	number of parallel ports per machine is defined by the
4879	<link to="ISystemProperties::parallelPortCount"/> property,
4880	so the maximum slot number is one less than that property's value.
4881
4882	<result name="E_INVALIDARG">
4883	Invalid @a slot number.
4884	</result>
4885
4886	</desc>
4887	<param name="slot" type="unsigned long" dir="in"/>
4888	<param name="port" type="IParallelPort" dir="return"/>
4889	</method>
4890
4891	<method name="getExtraDataKeys">
4892	<desc>
4893	Returns an array representing the machine-specific extra data keys
4894	which currently have values defined.
4895	</desc>
4896	<param name="value" type="wstring" dir="return" safearray="yes">
4897	<desc>Array of extra data keys.</desc>
4898	</param>
4899	</method>
4900
4901	<method name="getExtraData">
4902	<desc>
4903	Returns associated machine-specific extra data.
4904
4905	If the requested data @a key does not exist, this function will
4906	succeed and return an empty string in the @a value argument.
4907
4908	<result name="VBOX_E_FILE_ERROR">
4909	Settings file not accessible.
4910	</result>
4911	<result name="VBOX_E_XML_ERROR">
4912	Could not parse the settings file.
4913	</result>
4914
4915	</desc>
4916	<param name="key" type="wstring" dir="in">
4917	<desc>Name of the data key to get.</desc>
4918	</param>
4919	<param name="value" type="wstring" dir="return">
4920	<desc>Value of the requested data key.</desc>
4921	</param>
4922	</method>
4923
4924	<method name="setExtraData">
4925	<desc>
4926	Sets associated machine-specific extra data.
4927
4928	If you pass @c null or an empty string as a key @a value, the given
4929	@a key will be deleted.
4930
4931	<note>
4932	Before performing the actual data change, this method will ask all
4933	registered listeners using the
4934	<link to="IExtraDataCanChangeEvent"/>
4935	notification for a permission. If one of the listeners refuses the
4936	new value, the change will not be performed.
4937	</note>
4938	<note>
4939	On success, the
4940	<link to="IExtraDataChangedEvent"/> notification
4941	is called to inform all registered listeners about a successful data
4942	change.
4943	</note>
4944	<note>
4945	This method can be called outside the machine session and therefore
4946	it's a caller's responsibility to handle possible race conditions
4947	when several clients change the same key at the same time.
4948	</note>
4949
4950	<result name="VBOX_E_FILE_ERROR">
4951	Settings file not accessible.
4952	</result>
4953	<result name="VBOX_E_XML_ERROR">
4954	Could not parse the settings file.
4955	</result>
4956
4957	</desc>
4958	<param name="key" type="wstring" dir="in">
4959	<desc>Name of the data key to set.</desc>
4960	</param>
4961	<param name="value" type="wstring" dir="in">
4962	<desc>Value to assign to the key.</desc>
4963	</param>
4964	</method>
4965
4966	<method name="getCPUProperty" const="yes">
4967	<desc>
4968	Returns the virtual CPU boolean value of the specified property.
4969
4970	<result name="E_INVALIDARG">
4971	Invalid property.
4972	</result>
4973
4974	</desc>
4975	<param name="property" type="CPUPropertyType" dir="in">
4976	<desc>
4977	Property type to query.
4978	</desc>
4979	</param>
4980	<param name="value" type="boolean" dir="return">
4981	<desc>
4982	Property value.
4983	</desc>
4984	</param>
4985	</method>
4986
4987	<method name="setCPUProperty">
4988	<desc>
4989	Sets the virtual CPU boolean value of the specified property.
4990
4991	<result name="E_INVALIDARG">
4992	Invalid property.
4993	</result>
4994
4995	</desc>
4996	<param name="property" type="CPUPropertyType" dir="in">
4997	<desc>
4998	Property type to query.
4999	</desc>
5000	</param>
5001	<param name="value" type="boolean" dir="in">
5002	<desc>
5003	Property value.
5004	</desc>
5005	</param>
5006	</method>
5007
5008	<method name="getCPUIDLeaf" const="yes">
5009	<desc>
5010	Returns the virtual CPU cpuid information for the specified leaf.
5011
5012	Currently supported index values for cpuid:
5013	Standard CPUID leafs: 0 - 0xA
5014	Extended CPUID leafs: 0x80000000 - 0x8000000A
5015
5016	See the Intel and AMD programmer's manuals for detailed information
5017	about the cpuid instruction and its leafs.
5018	<result name="E_INVALIDARG">
5019	Invalid id.
5020	</result>
5021
5022	</desc>
5023	<param name="id" type="unsigned long" dir="in">
5024	<desc>
5025	CPUID leaf index.
5026	</desc>
5027	</param>
5028	<param name="valEax" type="unsigned long" dir="out">
5029	<desc>
5030	CPUID leaf value for register eax.
5031	</desc>
5032	</param>
5033	<param name="valEbx" type="unsigned long" dir="out">
5034	<desc>
5035	CPUID leaf value for register ebx.
5036	</desc>
5037	</param>
5038	<param name="valEcx" type="unsigned long" dir="out">
5039	<desc>
5040	CPUID leaf value for register ecx.
5041	</desc>
5042	</param>
5043	<param name="valEdx" type="unsigned long" dir="out">
5044	<desc>
5045	CPUID leaf value for register edx.
5046	</desc>
5047	</param>
5048	</method>
5049
5050	<method name="setCPUIDLeaf">
5051	<desc>
5052	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5053	are not passed unmodified. VirtualBox clears features that it doesn't support.
5054
5055	Currently supported index values for cpuid:
5056	Standard CPUID leafs: 0 - 0xA
5057	Extended CPUID leafs: 0x80000000 - 0x8000000A
5058
5059	See the Intel and AMD programmer's manuals for detailed information
5060	about the cpuid instruction and its leafs.
5061
5062	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5063	random crashes inside VMs.
5064	<result name="E_INVALIDARG">
5065	Invalid id.
5066	</result>
5067
5068	</desc>
5069	<param name="id" type="unsigned long" dir="in">
5070	<desc>
5071	CPUID leaf index.
5072	</desc>
5073	</param>
5074	<param name="valEax" type="unsigned long" dir="in">
5075	<desc>
5076	CPUID leaf value for register eax.
5077	</desc>
5078	</param>
5079	<param name="valEbx" type="unsigned long" dir="in">
5080	<desc>
5081	CPUID leaf value for register ebx.
5082	</desc>
5083	</param>
5084	<param name="valEcx" type="unsigned long" dir="in">
5085	<desc>
5086	CPUID leaf value for register ecx.
5087	</desc>
5088	</param>
5089	<param name="valEdx" type="unsigned long" dir="in">
5090	<desc>
5091	CPUID leaf value for register edx.
5092	</desc>
5093	</param>
5094	</method>
5095
5096	<method name="removeCPUIDLeaf">
5097	<desc>
5098	Removes the virtual CPU cpuid leaf for the specified index
5099
5100	<result name="E_INVALIDARG">
5101	Invalid id.
5102	</result>
5103
5104	</desc>
5105	<param name="id" type="unsigned long" dir="in">
5106	<desc>
5107	CPUID leaf index.
5108	</desc>
5109	</param>
5110	</method>
5111
5112	<method name="removeAllCPUIDLeaves">
5113	<desc>
5114	Removes all the virtual CPU cpuid leaves
5115	</desc>
5116	</method>
5117
5118	<method name="getHWVirtExProperty" const="yes">
5119	<desc>
5120	Returns the value of the specified hardware virtualization boolean property.
5121
5122	<result name="E_INVALIDARG">
5123	Invalid property.
5124	</result>
5125
5126	</desc>
5127	<param name="property" type="HWVirtExPropertyType" dir="in">
5128	<desc>
5129	Property type to query.
5130	</desc>
5131	</param>
5132	<param name="value" type="boolean" dir="return">
5133	<desc>
5134	Property value.
5135	</desc>
5136	</param>
5137	</method>
5138
5139	<method name="setHWVirtExProperty">
5140	<desc>
5141	Sets a new value for the specified hardware virtualization boolean property.
5142
5143	<result name="E_INVALIDARG">
5144	Invalid property.
5145	</result>
5146
5147	</desc>
5148	<param name="property" type="HWVirtExPropertyType" dir="in">
5149	<desc>
5150	Property type to set.
5151	</desc>
5152	</param>
5153	<param name="value" type="boolean" dir="in">
5154	<desc>
5155	New property value.
5156	</desc>
5157	</param>
5158	</method>
5159
5160	<method name="saveSettings">
5161	<desc>
5162	Saves any changes to machine settings made since the session
5163	has been opened or a new machine has been created, or since the
5164	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5165	For registered machines, new settings become visible to all
5166	other VirtualBox clients after successful invocation of this
5167	method.
5168	<note>
5169	The method sends <link to="IMachineDataChangedEvent"/>
5170	notification event after the configuration has been successfully
5171	saved (only for registered machines).
5172	</note>
5173	<note>
5174	Calling this method is only valid on instances returned
5175	by <link to="ISession::machine"/> and on new machines
5176	created by <link to="IVirtualBox::createMachine"/> but not
5177	yet registered, or on unregistered machines after calling
5178	<link to="IMachine::unregister"/>.
5179	</note>
5180
5181	<result name="VBOX_E_FILE_ERROR">
5182	Settings file not accessible.
5183	</result>
5184	<result name="VBOX_E_XML_ERROR">
5185	Could not parse the settings file.
5186	</result>
5187	<result name="E_ACCESSDENIED">
5188	Modification request refused.
5189	</result>
5190
5191	</desc>
5192	</method>
5193
5194	<method name="discardSettings">
5195	<desc>
5196	Discards any changes to the machine settings made since the session
5197	has been opened or since the last call to <link to="#saveSettings"/>
5198	or <link to="#discardSettings"/>.
5199	<note>
5200	Calling this method is only valid on instances returned
5201	by <link to="ISession::machine"/> and on new machines
5202	created by <link to="IVirtualBox::createMachine"/> or
5203	opened by <link to="IVirtualBox::openMachine"/> but not
5204	yet registered, or on unregistered machines after calling
5205	<link to="IMachine::unregister"/>.
5206	</note>
5207
5208	<result name="VBOX_E_INVALID_VM_STATE">
5209	Virtual machine is not mutable.
5210	</result>
5211
5212	</desc>
5213	</method>
5214
5215	<method name="unregister">
5216	<desc>
5217	Unregisters a machine previously registered with
5218	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5219	cleanup before the machine is unregistered.
5220
5221	This method does not delete any files. It only changes the machine configuration and
5222	the list of registered machines in the VirtualBox object. To delete the files which
5223	belonged to the machine, including the XML file of the machine itself, call
5224	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5225	from this method.
5226
5227	How thoroughly this method cleans up the machine configuration before unregistering
5228	the machine depends on the @a cleanupMode argument.
5229
5230	<ul>
5231	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5232	cleanup will be performed. The call will fail if the machine is in "Saved" state
5233	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5234	It is the responsibility of the caller to delete all such configuration in this mode.
5235	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5236	which it replaces.</li>
5237	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5238	state or if it has snapshots or media attached. All media attached to the current machine
5239	state or in snapshots will be detached. No medium objects will be returned;
5240	all of the machine's media will remain open.</li>
5241	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5242	except that all the hard disk medium objects which were detached from the machine will
5243	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5244	API for closing and deletion.</li>
5245	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5246	that all media will be returned in the array, including removable media like DVDs and
5247	floppies. This might be useful if the user wants to inspect in detail which media were
5248	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5249	in that case because users will typically want to preserve ISO and RAW image files.</li>
5250	</ul>
5251
5252	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5253	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5254	deleted with all its saved states and hard disk images, but images for removable
5255	drives (such as ISO and RAW files) will remain on disk.
5256
5257	This API does not verify whether the media files returned in the array are still
5258	attached to other machines (i.e. shared between several machines). If such a shared
5259	image is passed to <link to="#delete" /> however, closing the image will fail there
5260	and the image will be silently skipped.
5261
5262	This API may, however, move media from this machine's media registry to other media
5263	registries (see <link to="IMedium" /> for details on media registries). For machines
5264	created with VirtualBox 4.0 or later, if media from this machine's media registry
5265	are also attached to another machine (shared attachments), each such medium will be
5266	moved to another machine's registry. This is because without this machine's media
5267	registry, the other machine cannot find its media any more and would become inaccessible.
5268
5269	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5270	before unregistering it. It may also silently call saveSettings() on other machines
5271	if media are moved to other machines' media registries.
5272
5273	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5274	is fired.
5275
5276	The call will fail if the machine is currently locked (see <link to="ISession" />).
5277
5278	<note>
5279	If the given machine is inaccessible (see <link to="#accessible"/>), it
5280	will be unregistered and fully uninitialized right afterwards. As a result,
5281	the returned machine object will be unusable and an attempt to call
5282	<b>any</b> method will return the "Object not ready" error.
5283	</note>
5284
5285	<result name="VBOX_E_INVALID_OBJECT_STATE">
5286	Machine is currently locked for a session.
5287	</result>
5288	</desc>
5289
5290	<param name="cleanupMode" type="CleanupMode" dir="in">
5291	<desc>How to clean up after the machine has been unregistered.</desc>
5292	</param>
5293	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5294	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5295	</param>
5296	</method>
5297
5298	<method name="delete">
5299	<desc>
5300	Deletes the files associated with this machine from disk. If medium objects are passed
5301	in with the @a aMedia argument, they are closed and, if closing was successful, their
5302	storage files are deleted as well. For convenience, this array of media files can be
5303	the same as the one returned from a previous <link to="#unregister" /> call.
5304
5305	This method must only be called on machines which are either write-locked (i.e. on instances
5306	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5307	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5308	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5309
5310	The following files will be deleted by this method:
5311	<ul>
5312	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5313	argument other than "UnregisterOnly", this will delete all saved state files that
5314	the machine had in use; possibly one if the machine was in "Saved" state and one
5315	for each online snapshot that the machine had.</li>
5316	<li>On each medium object passed in the @a aMedia array, this will call
5317	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5318	medium's storage on disk. Since the close() call will fail if the medium is still
5319	in use, e.g. because it is still attached to a second machine; in that case the
5320	storage will not be deleted.</li>
5321	<li>Finally, the machine's own XML file will be deleted.</li>
5322	</ul>
5323
5324	Since deleting large disk image files can be a time-consuming I/O operation, this
5325	method operates asynchronously and returns an IProgress object to allow the caller
5326	to monitor the progress. There will be one sub-operation for each file that is
5327	being deleted (saved state or medium storage file).
5328
5329	<note>
5330	<link to="#settingsModified"/> will return @c true after this
5331	method successfully returns.
5332	</note>
5333
5334	<result name="VBOX_E_INVALID_VM_STATE">
5335	Machine is registered but not write-locked.
5336	</result>
5337	<result name="VBOX_E_IPRT_ERROR">
5338	Could not delete the settings file.
5339	</result>
5340	</desc>
5341	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5342	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5343	</param>
5344	<param name="aProgress" type="IProgress" dir="return">
5345	<desc>Progress object to track the operation completion.</desc>
5346	</param>
5347	</method>
5348
5349	<method name="export">
5350	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5351	steps required to export VirtualBox machines to OVF.
5352	</desc>
5353
5354	<param name="aAppliance" type="IAppliance" dir="in">
5355	<desc>Appliance to export this machine to.</desc>
5356	</param>
5357	<param name="location" type="wstring" dir="in">
5358	<desc>The target location.</desc>
5359	</param>
5360	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5361	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5362	</param>
5363	</method >
5364
5365	<method name="findSnapshot">
5366	<desc>
5367	Returns a snapshot of this machine with the given name or UUID.
5368
5369	Returns a snapshot of this machine with the given UUID.
5370	A @c null argument can be used to obtain the first snapshot
5371	taken on this machine. To traverse the whole tree of snapshots
5372	starting from the root, inspect the root snapshot's
5373	<link to="ISnapshot::children" /> attribute and recurse over those children.
5374
5375	<result name="VBOX_E_OBJECT_NOT_FOUND">
5376	Virtual machine has no snapshots or snapshot not found.
5377	</result>
5378
5379	</desc>
5380	<param name="nameOrId" type="wstring" dir="in">
5381	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5382	</param>
5383	<param name="snapshot" type="ISnapshot" dir="return">
5384	<desc>Snapshot object with the given name.</desc>
5385	</param>
5386	</method>
5387
5388	<method name="createSharedFolder">
5389	<desc>
5390	Creates a new permanent shared folder by associating the given logical
5391	name with the given host path, adds it to the collection of shared
5392	folders and starts sharing it. Refer to the description of
5393	<link to="ISharedFolder"/> to read more about logical names.
5394
5395	<result name="VBOX_E_OBJECT_IN_USE">
5396	Shared folder already exists.
5397	</result>
5398	<result name="VBOX_E_FILE_ERROR">
5399	Shared folder @a hostPath not accessible.
5400	</result>
5401
5402	</desc>
5403	<param name="name" type="wstring" dir="in">
5404	<desc>Unique logical name of the shared folder.</desc>
5405	</param>
5406	<param name="hostPath" type="wstring" dir="in">
5407	<desc>Full path to the shared folder in the host file system.</desc>
5408	</param>
5409	<param name="writable" type="boolean" dir="in">
5410	<desc>Whether the share is writable or readonly.</desc>
5411	</param>
5412	<param name="automount" type="boolean" dir="in">
5413	<desc>Whether the share gets automatically mounted by the guest
5414	or not.</desc>
5415	</param>
5416	</method>
5417
5418	<method name="removeSharedFolder">
5419	<desc>
5420	Removes the permanent shared folder with the given name previously
5421	created by <link to="#createSharedFolder"/> from the collection of
5422	shared folders and stops sharing it.
5423
5424	<result name="VBOX_E_INVALID_VM_STATE">
5425	Virtual machine is not mutable.
5426	</result>
5427	<result name="VBOX_E_OBJECT_NOT_FOUND">
5428	Shared folder @a name does not exist.
5429	</result>
5430
5431	</desc>
5432	<param name="name" type="wstring" dir="in">
5433	<desc>Logical name of the shared folder to remove.</desc>
5434	</param>
5435	</method>
5436
5437	<method name="canShowConsoleWindow">
5438	<desc>
5439	Returns @c true if the VM console process can activate the
5440	console window and bring it to foreground on the desktop of
5441	the host PC.
5442	<note>
5443	This method will fail if a session for this machine is not
5444	currently open.
5445	</note>
5446
5447	<result name="VBOX_E_INVALID_VM_STATE">
5448	Machine session is not open.
5449	</result>
5450
5451	</desc>
5452	<param name="canShow" type="boolean" dir="return">
5453	<desc>
5454	@c true if the console window can be shown and @c false otherwise.
5455	</desc>
5456	</param>
5457	</method>
5458
5459	<method name="showConsoleWindow">
5460	<desc>
5461	Activates the console window and brings it to foreground on
5462	the desktop of the host PC. Many modern window managers on
5463	many platforms implement some sort of focus stealing
5464	prevention logic, so that it may be impossible to activate
5465	a window without the help of the currently active
5466	application. In this case, this method will return a non-zero
5467	identifier that represents the top-level window of the VM
5468	console process. The caller, if it represents a currently
5469	active process, is responsible to use this identifier (in a
5470	platform-dependent manner) to perform actual window
5471	activation.
5472	<note>
5473	This method will fail if a session for this machine is not
5474	currently open.
5475	</note>
5476
5477	<result name="VBOX_E_INVALID_VM_STATE">
5478	Machine session is not open.
5479	</result>
5480
5481	</desc>
5482	<param name="winId" type="long long" dir="return">
5483	<desc>
5484	Platform-dependent identifier of the top-level VM console
5485	window, or zero if this method has performed all actions
5486	necessary to implement the <i>show window</i> semantics for
5487	the given platform and/or VirtualBox front-end.
5488	</desc>
5489	</param>
5490	</method>
5491
5492	<method name="getGuestProperty" const="yes">
5493	<desc>
5494	Reads an entry from the machine's guest property store.
5495
5496	<result name="VBOX_E_INVALID_VM_STATE">
5497	Machine session is not open.
5498	</result>
5499
5500	</desc>
5501	<param name="name" type="wstring" dir="in">
5502	<desc>
5503	The name of the property to read.
5504	</desc>
5505	</param>
5506	<param name="value" type="wstring" dir="out">
5507	<desc>
5508	The value of the property. If the property does not exist then this
5509	will be empty.
5510	</desc>
5511	</param>
5512	<param name="timestamp" type="long long" dir="out">
5513	<desc>
5514	The time at which the property was last modified, as seen by the
5515	server process.
5516	</desc>
5517	</param>
5518	<param name="flags" type="wstring" dir="out">
5519	<desc>
5520	Additional property parameters, passed as a comma-separated list of
5521	"name=value" type entries.
5522	</desc>
5523	</param>
5524	</method>
5525
5526	<method name="getGuestPropertyValue" const="yes">
5527	<desc>
5528	Reads a value from the machine's guest property store.
5529
5530	<result name="VBOX_E_INVALID_VM_STATE">
5531	Machine session is not open.
5532	</result>
5533
5534	</desc>
5535	<param name="property" type="wstring" dir="in">
5536	<desc>
5537	The name of the property to read.
5538	</desc>
5539	</param>
5540	<param name="value" type="wstring" dir="return">
5541	<desc>
5542	The value of the property. If the property does not exist then this
5543	will be empty.
5544	</desc>
5545	</param>
5546	</method>
5547
5548	<method name="getGuestPropertyTimestamp" const="yes">
5549	<desc>
5550	Reads a property timestamp from the machine's guest property store.
5551
5552	<result name="VBOX_E_INVALID_VM_STATE">
5553	Machine session is not open.
5554	</result>
5555
5556	</desc>
5557	<param name="property" type="wstring" dir="in">
5558	<desc>
5559	The name of the property to read.
5560	</desc>
5561	</param>
5562	<param name="value" type="long long" dir="return">
5563	<desc>
5564	The timestamp. If the property does not exist then this will be
5565	empty.
5566	</desc>
5567	</param>
5568	</method>
5569
5570	<method name="setGuestProperty">
5571	<desc>
5572	Sets, changes or deletes an entry in the machine's guest property
5573	store.
5574
5575	<result name="E_ACCESSDENIED">
5576	Property cannot be changed.
5577	</result>
5578	<result name="E_INVALIDARG">
5579	Invalid @a flags.
5580	</result>
5581	<result name="VBOX_E_INVALID_VM_STATE">
5582	Virtual machine is not mutable or session not open.
5583	</result>
5584	<result name="VBOX_E_INVALID_OBJECT_STATE">
5585	Cannot set transient property when machine not running.
5586	</result>
5587
5588	</desc>
5589	<param name="property" type="wstring" dir="in">
5590	<desc>
5591	The name of the property to set, change or delete.
5592	</desc>
5593	</param>
5594	<param name="value" type="wstring" dir="in">
5595	<desc>
5596	The new value of the property to set, change or delete. If the
5597	property does not yet exist and value is non-empty, it will be
5598	created. If the value is @c null or empty, the property will be
5599	deleted if it exists.
5600	</desc>
5601	</param>
5602	<param name="flags" type="wstring" dir="in">
5603	<desc>
5604	Additional property parameters, passed as a comma-separated list of
5605	"name=value" type entries.
5606	</desc>
5607	</param>
5608	</method>
5609
5610	<method name="setGuestPropertyValue">
5611	<desc>
5612	Sets, changes or deletes a value in the machine's guest property
5613	store. The flags field will be left unchanged or created empty for a
5614	new property.
5615
5616	<result name="E_ACCESSDENIED">
5617	Property cannot be changed.
5618	</result>
5619	<result name="VBOX_E_INVALID_VM_STATE">
5620	Virtual machine is not mutable or session not open.
5621	</result>
5622	<result name="VBOX_E_INVALID_OBJECT_STATE">
5623	Cannot set transient property when machine not running.
5624	</result>
5625	</desc>
5626
5627	<param name="property" type="wstring" dir="in">
5628	<desc>
5629	The name of the property to set, change or delete.
5630	</desc>
5631	</param>
5632	<param name="value" type="wstring" dir="in">
5633	<desc>
5634	The new value of the property to set, change or delete. If the
5635	property does not yet exist and value is non-empty, it will be
5636	created. If the value is @c null or empty, the property will be
5637	deleted if it exists.
5638	</desc>
5639	</param>
5640	</method>
5641
5642	<method name="enumerateGuestProperties">
5643	<desc>
5644	Return a list of the guest properties matching a set of patterns along
5645	with their values, time stamps and flags.
5646	</desc>
5647	<param name="patterns" type="wstring" dir="in">
5648	<desc>
5649	The patterns to match the properties against, separated by '\|'
5650	characters. If this is empty or @c null, all properties will match.
5651	</desc>
5652	</param>
5653	<param name="name" type="wstring" dir="out" safearray="yes">
5654	<desc>
5655	The names of the properties returned.
5656	</desc>
5657	</param>
5658	<param name="value" type="wstring" dir="out" safearray="yes">
5659	<desc>
5660	The values of the properties returned. The array entries match the
5661	corresponding entries in the @a name array.
5662	</desc>
5663	</param>
5664	<param name="timestamp" type="long long" dir="out" safearray="yes">
5665	<desc>
5666	The time stamps of the properties returned. The array entries match
5667	the corresponding entries in the @a name array.
5668	</desc>
5669	</param>
5670	<param name="flags" type="wstring" dir="out" safearray="yes">
5671	<desc>
5672	The flags of the properties returned. The array entries match the
5673	corresponding entries in the @a name array.
5674	</desc>
5675	</param>
5676	</method>
5677
5678	<method name="querySavedGuestSize">
5679	<desc>
5680	Returns the guest dimensions from the saved state.
5681	</desc>
5682	<param name="screenId" type="unsigned long" dir="in">
5683	<desc>
5684	Saved guest screen to query info from.
5685	</desc>
5686	</param>
5687	<param name="width" type="unsigned long" dir="out">
5688	<desc>
5689	Guest width at the time of the saved state was taken.
5690	</desc>
5691	</param>
5692	<param name="height" type="unsigned long" dir="out">
5693	<desc>
5694	Guest height at the time of the saved state was taken.
5695	</desc>
5696	</param>
5697	</method>
5698
5699	<method name="querySavedThumbnailSize">
5700	<desc>
5701	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5702	</desc>
5703	<param name="screenId" type="unsigned long" dir="in">
5704	<desc>
5705	Saved guest screen to query info from.
5706	</desc>
5707	</param>
5708	<param name="size" type="unsigned long" dir="out">
5709	<desc>
5710	Size of buffer required to store the bitmap.
5711	</desc>
5712	</param>
5713	<param name="width" type="unsigned long" dir="out">
5714	<desc>
5715	Bitmap width.
5716	</desc>
5717	</param>
5718	<param name="height" type="unsigned long" dir="out">
5719	<desc>
5720	Bitmap height.
5721	</desc>
5722	</param>
5723	</method>
5724
5725	<method name="readSavedThumbnailToArray">
5726	<desc>
5727	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5728	</desc>
5729	<param name="screenId" type="unsigned long" dir="in">
5730	<desc>
5731	Saved guest screen to read from.
5732	</desc>
5733	</param>
5734	<param name="BGR" type="boolean" dir="in">
5735	<desc>
5736	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5737	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5738	</desc>
5739	</param>
5740	<param name="width" type="unsigned long" dir="out">
5741	<desc>
5742	Bitmap width.
5743	</desc>
5744	</param>
5745	<param name="height" type="unsigned long" dir="out">
5746	<desc>
5747	Bitmap height.
5748	</desc>
5749	</param>
5750	<param name="data" type="octet" safearray="yes" dir="return">
5751	<desc>
5752	Array with resulting bitmap data.
5753	</desc>
5754	</param>
5755	</method>
5756
5757	<method name="readSavedThumbnailPNGToArray">
5758	<desc>
5759	Thumbnail in PNG format is retrieved to an array of bytes.
5760	</desc>
5761	<param name="screenId" type="unsigned long" dir="in">
5762	<desc>
5763	Saved guest screen to read from.
5764	</desc>
5765	</param>
5766	<param name="width" type="unsigned long" dir="out">
5767	<desc>
5768	Image width.
5769	</desc>
5770	</param>
5771	<param name="height" type="unsigned long" dir="out">
5772	<desc>
5773	Image height.
5774	</desc>
5775	</param>
5776	<param name="data" type="octet" dir="return" safearray="yes">
5777	<desc>
5778	Array with resulting PNG data.
5779	</desc>
5780	</param>
5781	</method>
5782
5783	<method name="querySavedScreenshotPNGSize">
5784	<desc>
5785	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5786	</desc>
5787	<param name="screenId" type="unsigned long" dir="in">
5788	<desc>
5789	Saved guest screen to query info from.
5790	</desc>
5791	</param>
5792	<param name="size" type="unsigned long" dir="out">
5793	<desc>
5794	Size of buffer required to store the PNG binary data.
5795	</desc>
5796	</param>
5797	<param name="width" type="unsigned long" dir="out">
5798	<desc>
5799	Image width.
5800	</desc>
5801	</param>
5802	<param name="height" type="unsigned long" dir="out">
5803	<desc>
5804	Image height.
5805	</desc>
5806	</param>
5807	</method>
5808
5809	<method name="readSavedScreenshotPNGToArray">
5810	<desc>
5811	Screenshot in PNG format is retrieved to an array of bytes.
5812	</desc>
5813	<param name="screenId" type="unsigned long" dir="in">
5814	<desc>
5815	Saved guest screen to read from.
5816	</desc>
5817	</param>
5818	<param name="width" type="unsigned long" dir="out">
5819	<desc>
5820	Image width.
5821	</desc>
5822	</param>
5823	<param name="height" type="unsigned long" dir="out">
5824	<desc>
5825	Image height.
5826	</desc>
5827	</param>
5828	<param name="data" type="octet" dir="return" safearray="yes">
5829	<desc>
5830	Array with resulting PNG data.
5831	</desc>
5832	</param>
5833	</method>
5834
5835	<method name="hotPlugCPU">
5836	<desc>
5837	Plugs a CPU into the machine.
5838	</desc>
5839	<param name="cpu" type="unsigned long" dir="in">
5840	<desc>
5841	The CPU id to insert.
5842	</desc>
5843	</param>
5844	</method>
5845
5846	<method name="hotUnplugCPU">
5847	<desc>
5848	Removes a CPU from the machine.
5849	</desc>
5850	<param name="cpu" type="unsigned long" dir="in">
5851	<desc>
5852	The CPU id to remove.
5853	</desc>
5854	</param>
5855	</method>
5856
5857	<method name="getCPUStatus">
5858	<desc>
5859	Returns the current status of the given CPU.
5860	</desc>
5861	<param name="cpu" type="unsigned long" dir="in">
5862	<desc>
5863	The CPU id to check for.
5864	</desc>
5865	</param>
5866	<param name="attached" type="boolean" dir="return">
5867	<desc>
5868	Status of the CPU.
5869	</desc>
5870	</param>
5871	</method>
5872
5873	<method name="queryLogFilename">
5874	<desc>
5875	Queries for the VM log file name of an given index. Returns an empty
5876	string if a log file with that index doesn't exists.
5877	</desc>
5878	<param name="idx" type="unsigned long" dir="in">
5879	<desc>
5880	Which log file name to query. 0=current log file.
5881	</desc>
5882	</param>
5883	<param name="filename" type="wstring" dir="return">
5884	<desc>
5885	On return the full path to the log file or an empty string on error.
5886	</desc>
5887	</param>
5888	</method>
5889
5890	<method name="readLog">
5891	<desc>
5892	Reads the VM log file. The chunk size is limited, so even if you
5893	ask for a big piece there might be less data returned.
5894	</desc>
5895	<param name="idx" type="unsigned long" dir="in">
5896	<desc>
5897	Which log file to read. 0=current log file.
5898	</desc>
5899	</param>
5900	<param name="offset" type="long long" dir="in">
5901	<desc>
5902	Offset in the log file.
5903	</desc>
5904	</param>
5905	<param name="size" type="long long" dir="in">
5906	<desc>
5907	Chunk size to read in the log file.
5908	</desc>
5909	</param>
5910	<param name="data" type="octet" dir="return" safearray="yes">
5911	<desc>
5912	Data read from the log file. A data size of 0 means end of file
5913	if the requested chunk size was not 0. This is the unprocessed
5914	file data, i.e. the line ending style depends on the platform of
5915	the system the server is running on.
5916	</desc>
5917	</param>
5918	</method>
5919	</interface>
5920
5921	<!--
5922	// IConsole
5923	/////////////////////////////////////////////////////////////////////////
5924	-->
5925
5926	<interface
5927	name="IVRDEServerInfo" extends="$unknown"
5928	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
5929	wsmap="struct"
5930	>
5931	<desc>
5932	Contains information about the remote desktop (VRDE) server capabilities and status.
5933	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
5934	</desc>
5935
5936	<attribute name="active" type="boolean" readonly="yes">
5937	<desc>
5938	Whether the remote desktop connection is active.
5939	</desc>
5940	</attribute>
5941
5942	<attribute name="port" type="long" readonly="yes">
5943	<desc>
5944	VRDE server port number. If this property is equal to <tt>0</tt>, then
5945	the VRDE server failed to start, usually because there are no free IP
5946	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
5947	server has not yet been started.
5948	</desc>
5949	</attribute>
5950
5951	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5952	<desc>
5953	How many times a client connected.
5954	</desc>
5955	</attribute>
5956
5957	<attribute name="beginTime" type="long long" readonly="yes">
5958	<desc>
5959	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5960	</desc>
5961	</attribute>
5962
5963	<attribute name="endTime" type="long long" readonly="yes">
5964	<desc>
5965	When the last connection was terminated or the current time, if
5966	connection is still active, in milliseconds since 1970-01-01 UTC.
5967	</desc>
5968	</attribute>
5969
5970	<attribute name="bytesSent" type="long long" readonly="yes">
5971	<desc>
5972	How many bytes were sent in last or current, if still active, connection.
5973	</desc>
5974	</attribute>
5975
5976	<attribute name="bytesSentTotal" type="long long" readonly="yes">
5977	<desc>
5978	How many bytes were sent in all connections.
5979	</desc>
5980	</attribute>
5981
5982	<attribute name="bytesReceived" type="long long" readonly="yes">
5983	<desc>
5984	How many bytes were received in last or current, if still active, connection.
5985	</desc>
5986	</attribute>
5987
5988	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
5989	<desc>
5990	How many bytes were received in all connections.
5991	</desc>
5992	</attribute>
5993
5994	<attribute name="user" type="wstring" readonly="yes">
5995	<desc>
5996	Login user name supplied by the client.
5997	</desc>
5998	</attribute>
5999
6000	<attribute name="domain" type="wstring" readonly="yes">
6001	<desc>
6002	Login domain name supplied by the client.
6003	</desc>
6004	</attribute>
6005
6006	<attribute name="clientName" type="wstring" readonly="yes">
6007	<desc>
6008	The client name supplied by the client.
6009	</desc>
6010	</attribute>
6011
6012	<attribute name="clientIP" type="wstring" readonly="yes">
6013	<desc>
6014	The IP address of the client.
6015	</desc>
6016	</attribute>
6017
6018	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6019	<desc>
6020	The client software version number.
6021	</desc>
6022	</attribute>
6023
6024	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6025	<desc>
6026	Public key exchange method used when connection was established.
6027	Values: 0 - RDP4 public key exchange scheme.
6028	1 - X509 certificates were sent to client.
6029	</desc>
6030	</attribute>
6031
6032	</interface>
6033
6034	<interface
6035	name="IConsole" extends="$unknown"
6036	uuid="515e8e8d-f932-4d8e-9f32-79a52aead882"
6037	wsmap="managed"
6038	>
6039	<desc>
6040	The IConsole interface represents an interface to control virtual
6041	machine execution.
6042
6043	A console object gets created when a machine has been locked for a
6044	particular session (client process) using <link to="IMachine::lockMachine" />
6045	or <link to="IMachine::launchVMProcess"/>. The console object can
6046	then be found in the session's <link to="ISession::console" /> attribute.
6047
6048	Methods of the IConsole interface allow the caller to query the current
6049	virtual machine execution state, pause the machine or power it down, save
6050	the machine state or take a snapshot, attach and detach removable media
6051	and so on.
6052
6053	<see>ISession</see>
6054	</desc>
6055
6056	<attribute name="machine" type="IMachine" readonly="yes">
6057	<desc>
6058	Machine object for this console session.
6059	<note>
6060	This is a convenience property, it has the same value as
6061	<link to="ISession::machine"/> of the corresponding session
6062	object.
6063	</note>
6064	</desc>
6065	</attribute>
6066
6067	<attribute name="state" type="MachineState" readonly="yes">
6068	<desc>
6069	Current execution state of the machine.
6070	<note>
6071	This property always returns the same value as the corresponding
6072	property of the IMachine object for this console session.
6073	For the process that owns (executes) the VM, this is the
6074	preferable way of querying the VM state, because no IPC
6075	calls are made.
6076	</note>
6077	</desc>
6078	</attribute>
6079
6080	<attribute name="guest" type="IGuest" readonly="yes">
6081	<desc>Guest object.</desc>
6082	</attribute>
6083
6084	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6085	<desc>
6086	Virtual keyboard object.
6087	<note>
6088	If the machine is not running, any attempt to use
6089	the returned object will result in an error.
6090	</note>
6091	</desc>
6092	</attribute>
6093
6094	<attribute name="mouse" type="IMouse" readonly="yes">
6095	<desc>
6096	Virtual mouse object.
6097	<note>
6098	If the machine is not running, any attempt to use
6099	the returned object will result in an error.
6100	</note>
6101	</desc>
6102	</attribute>
6103
6104	<attribute name="display" type="IDisplay" readonly="yes">
6105	<desc>Virtual display object.
6106	<note>
6107	If the machine is not running, any attempt to use
6108	the returned object will result in an error.
6109	</note>
6110	</desc>
6111	</attribute>
6112
6113	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6114	<desc>Debugging interface.</desc>
6115	</attribute>
6116
6117	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6118	<desc>
6119	Collection of USB devices currently attached to the virtual
6120	USB controller.
6121	<note>
6122	The collection is empty if the machine is not running.
6123	</note>
6124	</desc>
6125	</attribute>
6126
6127	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6128	<desc>
6129	List of USB devices currently attached to the remote VRDE client.
6130	Once a new device is physically attached to the remote host computer,
6131	it appears in this list and remains there until detached.
6132	</desc>
6133	</attribute>
6134
6135	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6136	<desc>
6137	Collection of shared folders for the current session. These folders
6138	are called transient shared folders because they are available to the
6139	guest OS running inside the associated virtual machine only for the
6140	duration of the session (as opposed to
6141	<link to="IMachine::sharedFolders"/> which represent permanent shared
6142	folders). When the session is closed (e.g. the machine is powered down),
6143	these folders are automatically discarded.
6144
6145	New shared folders are added to the collection using
6146	<link to="#createSharedFolder"/>. Existing shared folders can be
6147	removed using <link to="#removeSharedFolder"/>.
6148	</desc>
6149	</attribute>
6150
6151	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6152	<desc>
6153	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6154	</desc>
6155	</attribute>
6156
6157	<attribute name="eventSource" type="IEventSource" readonly="yes">
6158	<desc>
6159	Event source for console events.
6160	</desc>
6161	</attribute>
6162
6163	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6164	<desc>Array of PCI devices attached to this machine.</desc>
6165	</attribute>
6166
6167	<method name="powerUp">
6168	<desc>
6169	Starts the virtual machine execution using the current machine
6170	state (that is, its current execution state, current settings and
6171	current storage devices).
6172
6173	<note>
6174	This method is only useful for front-ends that want to actually
6175	execute virtual machines in their own process (like the VirtualBox
6176	or VBoxSDL front-ends). Unless you are intending to write such a
6177	front-end, do not call this method. If you simply want to
6178	start virtual machine execution using one of the existing front-ends
6179	(for example the VirtualBox GUI or headless server), use
6180	<link to="IMachine::launchVMProcess"/> instead; these
6181	front-ends will power up the machine automatically for you.
6182	</note>
6183
6184	If the machine is powered off or aborted, the execution will
6185	start from the beginning (as if the real hardware were just
6186	powered on).
6187
6188	If the machine is in the <link to="MachineState_Saved"/> state,
6189	it will continue its execution the point where the state has
6190	been saved.
6191
6192	If the machine <link to="IMachine::teleporterEnabled"/> property is
6193	enabled on the machine being powered up, the machine will wait for an
6194	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6195	state. The returned progress object will have at least three
6196	operations where the last three are defined as: (1) powering up and
6197	starting TCP server, (2) waiting for incoming teleportations, and
6198	(3) perform teleportation. These operations will be reflected as the
6199	last three operations of the progress objected returned by
6200	<link to="IMachine::launchVMProcess"/> as well.
6201
6202	<see>#saveState</see>
6203
6204	<result name="VBOX_E_INVALID_VM_STATE">
6205	Virtual machine already running.
6206	</result>
6207	<result name="VBOX_E_HOST_ERROR">
6208	Host interface does not exist or name not set.
6209	</result>
6210	<result name="VBOX_E_FILE_ERROR">
6211	Invalid saved state file.
6212	</result>
6213	</desc>
6214	<param name="progress" type="IProgress" dir="return">
6215	<desc>Progress object to track the operation completion.</desc>
6216	</param>
6217	</method>
6218
6219	<method name="powerUpPaused">
6220	<desc>
6221	Identical to powerUp except that the VM will enter the
6222	<link to="MachineState_Paused"/> state, instead of
6223	<link to="MachineState_Running"/>.
6224
6225	<see>#powerUp</see>
6226	<result name="VBOX_E_INVALID_VM_STATE">
6227	Virtual machine already running.
6228	</result>
6229	<result name="VBOX_E_HOST_ERROR">
6230	Host interface does not exist or name not set.
6231	</result>
6232	<result name="VBOX_E_FILE_ERROR">
6233	Invalid saved state file.
6234	</result>
6235	</desc>
6236	<param name="progress" type="IProgress" dir="return">
6237	<desc>Progress object to track the operation completion.</desc>
6238	</param>
6239	</method>
6240
6241	<method name="powerDown">
6242	<desc>
6243	Initiates the power down procedure to stop the virtual machine
6244	execution.
6245
6246	The completion of the power down procedure is tracked using the returned
6247	IProgress object. After the operation is complete, the machine will go
6248	to the PoweredOff state.
6249	<result name="VBOX_E_INVALID_VM_STATE">
6250	Virtual machine must be Running, Paused or Stuck to be powered down.
6251	</result>
6252	</desc>
6253	<param name="progress" type="IProgress" dir="return">
6254	<desc>Progress object to track the operation completion.</desc>
6255	</param>
6256	</method>
6257
6258	<method name="reset">
6259	<desc>Resets the virtual machine.
6260	<result name="VBOX_E_INVALID_VM_STATE">
6261	Virtual machine not in Running state.
6262	</result>
6263	<result name="VBOX_E_VM_ERROR">
6264	Virtual machine error in reset operation.
6265	</result>
6266	</desc>
6267	</method>
6268
6269	<method name="pause">
6270	<desc>Pauses the virtual machine execution.
6271	<result name="VBOX_E_INVALID_VM_STATE">
6272	Virtual machine not in Running state.
6273	</result>
6274	<result name="VBOX_E_VM_ERROR">
6275	Virtual machine error in suspend operation.
6276	</result>
6277	</desc>
6278	</method>
6279
6280	<method name="resume">
6281	<desc>Resumes the virtual machine execution.
6282	<result name="VBOX_E_INVALID_VM_STATE">
6283	Virtual machine not in Paused state.
6284	</result>
6285	<result name="VBOX_E_VM_ERROR">
6286	Virtual machine error in resume operation.
6287	</result>
6288	</desc>
6289	</method>
6290
6291	<method name="powerButton">
6292	<desc>Sends the ACPI power button event to the guest.
6293	<result name="VBOX_E_INVALID_VM_STATE">
6294	Virtual machine not in Running state.
6295	</result>
6296	<result name="VBOX_E_PDM_ERROR">
6297	Controlled power off failed.
6298	</result>
6299	</desc>
6300	</method>
6301
6302	<method name="sleepButton">
6303	<desc>Sends the ACPI sleep button event to the guest.
6304	<result name="VBOX_E_INVALID_VM_STATE">
6305	Virtual machine not in Running state.
6306	</result>
6307	<result name="VBOX_E_PDM_ERROR">
6308	Sending sleep button event failed.
6309	</result>
6310	</desc>
6311	</method>
6312
6313	<method name="getPowerButtonHandled">
6314	<desc>Checks if the last power button event was handled by guest.
6315	<result name="VBOX_E_PDM_ERROR">
6316	Checking if the event was handled by the guest OS failed.
6317	</result>
6318	</desc>
6319	<param name="handled" type="boolean" dir="return"/>
6320	</method>
6321
6322	<method name="getGuestEnteredACPIMode">
6323	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6324	G1 (sleeping). If this method returns @c false, the guest will
6325	most likely not respond to external ACPI events.
6326	<result name="VBOX_E_INVALID_VM_STATE">
6327	Virtual machine not in Running state.
6328	</result>
6329	</desc>
6330	<param name="entered" type="boolean" dir="return"/>
6331	</method>
6332
6333	<method name="saveState">
6334	<desc>
6335	Saves the current execution state of a running virtual machine
6336	and stops its execution.
6337
6338	After this operation completes, the machine will go to the
6339	Saved state. Next time it is powered up, this state will
6340	be restored and the machine will continue its execution from
6341	the place where it was saved.
6342
6343	This operation differs from taking a snapshot to the effect
6344	that it doesn't create new differencing media. Also, once
6345	the machine is powered up from the state saved using this method,
6346	the saved state is deleted, so it will be impossible to return
6347	to this state later.
6348
6349	<note>
6350	On success, this method implicitly calls
6351	<link to="IMachine::saveSettings"/> to save all current machine
6352	settings (including runtime changes to the DVD medium, etc.).
6353	Together with the impossibility to change any VM settings when it is
6354	in the Saved state, this guarantees adequate hardware
6355	configuration of the machine when it is restored from the saved
6356	state file.
6357	</note>
6358
6359	<note>
6360	The machine must be in the Running or Paused state, otherwise
6361	the operation will fail.
6362	</note>
6363	<result name="VBOX_E_INVALID_VM_STATE">
6364	Virtual machine state neither Running nor Paused.
6365	</result>
6366	<result name="VBOX_E_FILE_ERROR">
6367	Failed to create directory for saved state file.
6368	</result>
6369
6370	<see><link to="#takeSnapshot"/></see>
6371	</desc>
6372	<param name="progress" type="IProgress" dir="return">
6373	<desc>Progress object to track the operation completion.</desc>
6374	</param>
6375	</method>
6376
6377	<method name="adoptSavedState">
6378	<desc>
6379	Associates the given saved state file to the virtual machine.
6380
6381	On success, the machine will go to the Saved state. Next time it is
6382	powered up, it will be restored from the adopted saved state and
6383	continue execution from the place where the saved state file was
6384	created.
6385
6386	The specified saved state file path may be absolute or relative to the
6387	folder the VM normally saves the state to (usually,
6388	<link to="IMachine::snapshotFolder"/>).
6389
6390	<note>
6391	It's a caller's responsibility to make sure the given saved state
6392	file is compatible with the settings of this virtual machine that
6393	represent its virtual hardware (memory size, storage disk configuration
6394	etc.). If there is a mismatch, the behavior of the virtual machine
6395	is undefined.
6396	</note>
6397	<result name="VBOX_E_INVALID_VM_STATE">
6398	Virtual machine state neither PoweredOff nor Aborted.
6399	</result>
6400	</desc>
6401	<param name="savedStateFile" type="wstring" dir="in">
6402	<desc>Path to the saved state file to adopt.</desc>
6403	</param>
6404	</method>
6405
6406	<method name="discardSavedState">
6407	<desc>
6408	Forcibly resets the machine to "Powered Off" state if it is
6409	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6410	Next time the machine is powered up, a clean boot will occur.
6411	<note>
6412	This operation is equivalent to resetting or powering off
6413	the machine without doing a proper shutdown of the guest
6414	operating system; as with resetting a running phyiscal
6415	computer, it can can lead to data loss.
6416	</note>
6417	If @a fRemoveFile is @c true, the file in the machine directory
6418	into which the machine state was saved is also deleted. If
6419	this is @c false, then the state can be recovered and later
6420	re-inserted into a machine using <link to="#adoptSavedState" />.
6421	The location of the file can be found in the
6422	<link to="IMachine::stateFilePath" /> attribute.
6423	<result name="VBOX_E_INVALID_VM_STATE">
6424	Virtual machine not in state Saved.
6425	</result>
6426	</desc>
6427	<param name="fRemoveFile" type="boolean" dir="in" >
6428	<desc>Whether to also remove the saved state file.</desc>
6429	</param>
6430	</method>
6431
6432	<method name="getDeviceActivity">
6433	<desc>
6434	Gets the current activity type of a given device or device group.
6435	<result name="E_INVALIDARG">
6436	Invalid device type.
6437	</result>
6438	</desc>
6439	<param name="type" type="DeviceType" dir="in"/>
6440	<param name="activity" type="DeviceActivity" dir="return"/>
6441	</method>
6442
6443	<method name="attachUSBDevice">
6444	<desc>
6445	Attaches a host USB device with the given UUID to the
6446	USB controller of the virtual machine.
6447
6448	The device needs to be in one of the following states:
6449	<link to="USBDeviceState_Busy"/>,
6450	<link to="USBDeviceState_Available"/> or
6451	<link to="USBDeviceState_Held"/>,
6452	otherwise an error is immediately returned.
6453
6454	When the device state is
6455	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6456	be returned if the host computer refuses to release it for some reason.
6457
6458	<see>IUSBController::deviceFilters, USBDeviceState</see>
6459	<result name="VBOX_E_INVALID_VM_STATE">
6460	Virtual machine state neither Running nor Paused.
6461	</result>
6462	<result name="VBOX_E_PDM_ERROR">
6463	Virtual machine does not have a USB controller.
6464	</result>
6465	</desc>
6466	<param name="id" type="uuid" mod="string" dir="in">
6467	<desc>UUID of the host USB device to attach.</desc>
6468	</param>
6469	</method>
6470
6471	<method name="detachUSBDevice">
6472	<desc>
6473	Detaches an USB device with the given UUID from the USB controller
6474	of the virtual machine.
6475
6476	After this method succeeds, the VirtualBox server re-initiates
6477	all USB filters as if the device were just physically attached
6478	to the host, but filters of this machine are ignored to avoid
6479	a possible automatic re-attachment.
6480
6481	<see>IUSBController::deviceFilters, USBDeviceState</see>
6482
6483	<result name="VBOX_E_PDM_ERROR">
6484	Virtual machine does not have a USB controller.
6485	</result>
6486	<result name="E_INVALIDARG">
6487	USB device not attached to this virtual machine.
6488	</result>
6489	</desc>
6490	<param name="id" type="uuid" mod="string" dir="in">
6491	<desc>UUID of the USB device to detach.</desc>
6492	</param>
6493	<param name="device" type="IUSBDevice" dir="return">
6494	<desc>Detached USB device.</desc>
6495	</param>
6496	</method>
6497
6498	<method name="findUSBDeviceByAddress">
6499	<desc>
6500	Searches for a USB device with the given host address.
6501
6502	<result name="VBOX_E_OBJECT_NOT_FOUND">
6503	Given @c name does not correspond to any USB device.
6504	</result>
6505
6506	<see>IUSBDevice::address</see>
6507	</desc>
6508	<param name="name" type="wstring" dir="in">
6509	<desc>
6510	Address of the USB device (as assigned by the host) to
6511	search for.
6512	</desc>
6513	</param>
6514	<param name="device" type="IUSBDevice" dir="return">
6515	<desc>Found USB device object.</desc>
6516	</param>
6517	</method>
6518
6519	<method name="findUSBDeviceById">
6520	<desc>
6521	Searches for a USB device with the given UUID.
6522
6523	<result name="VBOX_E_OBJECT_NOT_FOUND">
6524	Given @c id does not correspond to any USB device.
6525	</result>
6526
6527	<see>IUSBDevice::id</see>
6528	</desc>
6529	<param name="id" type="uuid" mod="string" dir="in">
6530	<desc>UUID of the USB device to search for.</desc>
6531	</param>
6532	<param name="device" type="IUSBDevice" dir="return">
6533	<desc>Found USB device object.</desc>
6534	</param>
6535	</method>
6536
6537	<method name="createSharedFolder">
6538	<desc>
6539	Creates a transient new shared folder by associating the given logical
6540	name with the given host path, adds it to the collection of shared
6541	folders and starts sharing it. Refer to the description of
6542	<link to="ISharedFolder"/> to read more about logical names.
6543
6544	<result name="VBOX_E_INVALID_VM_STATE">
6545	Virtual machine in Saved state or currently changing state.
6546	</result>
6547	<result name="VBOX_E_FILE_ERROR">
6548	Shared folder already exists or not accessible.
6549	</result>
6550	</desc>
6551	<param name="name" type="wstring" dir="in">
6552	<desc>Unique logical name of the shared folder.</desc>
6553	</param>
6554	<param name="hostPath" type="wstring" dir="in">
6555	<desc>Full path to the shared folder in the host file system.</desc>
6556	</param>
6557	<param name="writable" type="boolean" dir="in">
6558	<desc>Whether the share is writable or readonly</desc>
6559	</param>
6560	<param name="automount" type="boolean" dir="in">
6561	<desc>Whether the share gets automatically mounted by the guest
6562	or not.</desc>
6563	</param>
6564	</method>
6565
6566	<method name="removeSharedFolder">
6567	<desc>
6568	Removes a transient shared folder with the given name previously
6569	created by <link to="#createSharedFolder"/> from the collection of
6570	shared folders and stops sharing it.
6571	<result name="VBOX_E_INVALID_VM_STATE">
6572	Virtual machine in Saved state or currently changing state.
6573	</result>
6574	<result name="VBOX_E_FILE_ERROR">
6575	Shared folder does not exists.
6576	</result>
6577	</desc>
6578	<param name="name" type="wstring" dir="in">
6579	<desc>Logical name of the shared folder to remove.</desc>
6580	</param>
6581	</method>
6582
6583	<method name="takeSnapshot">
6584	<desc>
6585	Saves the current execution state
6586	and all settings of the machine and creates differencing images
6587	for all normal (non-independent) media.
6588	See <link to="ISnapshot" /> for an introduction to snapshots.
6589
6590	This method can be called for a PoweredOff, Saved (see
6591	<link to="#saveState"/>), Running or
6592	Paused virtual machine. When the machine is PoweredOff, an
6593	offline snapshot is created. When the machine is Running a live
6594	snapshot is created, and an online snapshot is is created when Paused.
6595
6596	The taken snapshot is always based on the
6597	<link to="IMachine::currentSnapshot">current snapshot</link>
6598	of the associated virtual machine and becomes a new current snapshot.
6599
6600	<note>
6601	This method implicitly calls <link to="IMachine::saveSettings"/> to
6602	save all current machine settings before taking an offline snapshot.
6603	</note>
6604
6605	<result name="VBOX_E_INVALID_VM_STATE">
6606	Virtual machine currently changing state.
6607	</result>
6608	</desc>
6609	<param name="name" type="wstring" dir="in">
6610	<desc>Short name for the snapshot.</desc>
6611	</param>
6612	<param name="description" type="wstring" dir="in">
6613	<desc>Optional description of the snapshot.</desc>
6614	</param>
6615	<param name="progress" type="IProgress" dir="return">
6616	<desc>Progress object to track the operation completion.</desc>
6617	</param>
6618	</method>
6619
6620	<method name="deleteSnapshot">
6621	<desc>
6622	Starts deleting the specified snapshot asynchronously.
6623	See <link to="ISnapshot" /> for an introduction to snapshots.
6624
6625	The execution state and settings of the associated machine stored in
6626	the snapshot will be deleted. The contents of all differencing media of
6627	this snapshot will be merged with the contents of their dependent child
6628	media to keep the medium chain valid (in other words, all changes
6629	represented by media being deleted will be propagated to their child
6630	medium). After that, this snapshot's differencing medium will be
6631	deleted. The parent of this snapshot will become a new parent for all
6632	its child snapshots.
6633
6634	If the deleted snapshot is the current one, its parent snapshot will
6635	become a new current snapshot. The current machine state is not directly
6636	affected in this case, except that currently attached differencing
6637	media based on media of the deleted snapshot will be also merged as
6638	described above.
6639
6640	If the deleted snapshot is the first or current snapshot, then the
6641	respective IMachine attributes will be adjusted. Deleting the current
6642	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6643	to make all current machine settings permanent.
6644
6645	Deleting a snapshot has the following preconditions:
6646
6647	<ul>
6648	<li>Child media of all normal media of the deleted snapshot
6649	must be accessible (see <link to="IMedium::state"/>) for this
6650	operation to succeed. In particular, this means that all virtual
6651	machines whose media are directly or indirectly based on the
6652	media of deleted snapshot must be powered off.</li>
6653
6654	<li>You cannot delete the snapshot if a medium attached to it has
6655	more than once child medium (differencing images) because otherwise
6656	merging would be impossible. This might be the case if there is
6657	more than one child snapshot or differencing images were created
6658	for other reason (e.g. implicitly because of multiple machine
6659	attachments).</li>
6660	</ul>
6661
6662
6663	The virtual machine's <link to="IMachine::state">state</link> is
6664	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6665	"DeletingSnapshotPaused" while this operation is in progress.
6666
6667	<note>
6668	Merging medium contents can be very time and disk space
6669	consuming, if these media are big in size and have many
6670	children. However, if the snapshot being deleted is the last
6671	(head) snapshot on the branch, the operation will be rather
6672	quick.
6673	</note>
6674	<result name="VBOX_E_INVALID_VM_STATE">
6675	The running virtual machine prevents deleting this snapshot. This
6676	happens only in very specific situations, usually snapshots can be
6677	deleted without trouble while a VM is running. The error message
6678	text explains the reason for the failure.
6679	</result>
6680	</desc>
6681	<param name="id" type="uuid" mod="string" dir="in">
6682	<desc>UUID of the snapshot to delete.</desc>
6683	</param>
6684	<param name="progress" type="IProgress" dir="return">
6685	<desc>Progress object to track the operation completion.</desc>
6686	</param>
6687	</method>
6688
6689	<method name="restoreSnapshot">
6690	<desc>
6691	Starts resetting the machine's current state to the state contained
6692	in the given snapshot, asynchronously. All current settings of the
6693	machine will be reset and changes stored in differencing media
6694	will be lost.
6695	See <link to="ISnapshot" /> for an introduction to snapshots.
6696
6697	After this operation is successfully completed, new empty differencing
6698	media are created for all normal media of the machine.
6699
6700	If the given snapshot is an online snapshot, the machine will go to
6701	the <link to="MachineState_Saved"> saved state</link>, so that the
6702	next time it is powered on, the execution state will be restored
6703	from the state of the snapshot.
6704
6705	<note>
6706	The machine must not be running, otherwise the operation will fail.
6707	</note>
6708
6709	<note>
6710	If the machine state is <link to="MachineState_Saved">Saved</link>
6711	prior to this operation, the saved state file will be implicitly
6712	deleted (as if <link to="IConsole::discardSavedState"/> were
6713	called).
6714	</note>
6715
6716	<result name="VBOX_E_INVALID_VM_STATE">
6717	Virtual machine is running.
6718	</result>
6719	</desc>
6720	<param name="snapshot" type="ISnapshot" dir="in">
6721	<desc>The snapshot to restore the VM state from.</desc>
6722	</param>
6723	<param name="progress" type="IProgress" dir="return">
6724	<desc>Progress object to track the operation completion.</desc>
6725	</param>
6726	</method>
6727
6728	<method name="teleport">
6729	<desc>
6730	Teleport the VM to a different host machine or process.
6731
6732	TODO explain the details.
6733
6734	<result name="VBOX_E_INVALID_VM_STATE">
6735	Virtual machine not running or paused.
6736	</result>
6737	</desc>
6738	<param name="hostname" type="wstring" dir="in">
6739	<desc>The name or IP of the host to teleport to.</desc>
6740	</param>
6741	<param name="tcpport" type="unsigned long" dir="in">
6742	<desc>The TCP port to connect to (1..65535).</desc>
6743	</param>
6744	<param name="password" type="wstring" dir="in">
6745	<desc>The password.</desc>
6746	</param>
6747	<param name="maxDowntime" type="unsigned long" dir="in">
6748	<desc>
6749	The maximum allowed downtime given as milliseconds. 0 is not a valid
6750	value. Recommended value: 250 ms.
6751
6752	The higher the value is, the greater the chance for a successful
6753	teleportation. A small value may easily result in the teleportation
6754	process taking hours and eventually fail.
6755
6756	<note>
6757	The current implementation treats this a guideline, not as an
6758	absolute rule.
6759	</note>
6760	</desc>
6761	</param>
6762	<param name="progress" type="IProgress" dir="return">
6763	<desc>Progress object to track the operation completion.</desc>
6764	</param>
6765	</method>
6766
6767	</interface>
6768
6769	<!--
6770	// IHost
6771	/////////////////////////////////////////////////////////////////////////
6772	-->
6773
6774	<enum
6775	name="HostNetworkInterfaceMediumType"
6776	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6777	>
6778	<desc>
6779	Type of encapsulation. Ethernet encapsulation includes both wired and
6780	wireless Ethernet connections.
6781	<see>IHostNetworkInterface</see>
6782	</desc>
6783
6784	<const name="Unknown" value="0">
6785	<desc>
6786	The type of interface cannot be determined.
6787	</desc>
6788	</const>
6789	<const name="Ethernet" value="1">
6790	<desc>
6791	Ethernet frame encapsulation.
6792	</desc>
6793	</const>
6794	<const name="PPP" value="2">
6795	<desc>
6796	Point-to-point protocol encapsulation.
6797	</desc>
6798	</const>
6799	<const name="SLIP" value="3">
6800	<desc>
6801	Serial line IP encapsulation.
6802	</desc>
6803	</const>
6804	</enum>
6805
6806	<enum
6807	name="HostNetworkInterfaceStatus"
6808	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6809	>
6810	<desc>
6811	Current status of the interface.
6812	<see>IHostNetworkInterface</see>
6813	</desc>
6814
6815	<const name="Unknown" value="0">
6816	<desc>
6817	The state of interface cannot be determined.
6818	</desc>
6819	</const>
6820	<const name="Up" value="1">
6821	<desc>
6822	The interface is fully operational.
6823	</desc>
6824	</const>
6825	<const name="Down" value="2">
6826	<desc>
6827	The interface is not functioning.
6828	</desc>
6829	</const>
6830	</enum>
6831
6832	<enum
6833	name="HostNetworkInterfaceType"
6834	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6835	>
6836	<desc>
6837	Network interface type.
6838	</desc>
6839	<const name="Bridged" value="1"/>
6840	<const name="HostOnly" value="2"/>
6841	</enum>
6842
6843	<interface
6844	name="IHostNetworkInterface" extends="$unknown"
6845	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6846	wsmap="managed"
6847	>
6848	<desc>
6849	Represents one of host's network interfaces. IP V6 address and network
6850	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6851	separated by colons.
6852	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6853	</desc>
6854	<attribute name="name" type="wstring" readonly="yes">
6855	<desc>Returns the host network interface name.</desc>
6856	</attribute>
6857
6858	<attribute name="id" type="uuid" mod="string" readonly="yes">
6859	<desc>Returns the interface UUID.</desc>
6860	</attribute>
6861
6862	<attribute name="networkName" type="wstring" readonly="yes">
6863	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6864	</attribute>
6865
6866	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6867	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6868	</attribute>
6869
6870	<attribute name="IPAddress" type="wstring" readonly="yes">
6871	<desc>Returns the IP V4 address of the interface.</desc>
6872	</attribute>
6873
6874	<attribute name="networkMask" type="wstring" readonly="yes">
6875	<desc>Returns the network mask of the interface.</desc>
6876	</attribute>
6877
6878	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6879	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6880	</attribute>
6881
6882	<attribute name="IPV6Address" type="wstring" readonly="yes">
6883	<desc>Returns the IP V6 address of the interface.</desc>
6884	</attribute>
6885
6886	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6887	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6888	</attribute>
6889
6890	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6891	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6892	</attribute>
6893
6894	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6895	<desc>Type of protocol encapsulation used.</desc>
6896	</attribute>
6897
6898	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6899	<desc>Status of the interface.</desc>
6900	</attribute>
6901
6902	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6903	<desc>specifies the host interface type.</desc>
6904	</attribute>
6905
6906	<method name="enableStaticIpConfig">
6907	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6908	<param name="IPAddress" type="wstring" dir="in">
6909	<desc>
6910	IP address.
6911	</desc>
6912	</param>
6913	<param name="networkMask" type="wstring" dir="in">
6914	<desc>
6915	network mask.
6916	</desc>
6917	</param>
6918	</method>
6919
6920	<method name="enableStaticIpConfigV6">
6921	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6922	<param name="IPV6Address" type="wstring" dir="in">
6923	<desc>
6924	IP address.
6925	</desc>
6926	</param>
6927	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6928	<desc>
6929	network mask.
6930	</desc>
6931	</param>
6932	</method>
6933
6934	<method name="enableDynamicIpConfig">
6935	<desc>enables the dynamic IP configuration.</desc>
6936	</method>
6937
6938	<method name="dhcpRediscover">
6939	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6940	</method>
6941
6942	</interface>
6943
6944	<interface
6945	name="IHost" extends="$unknown"
6946	uuid="dab4a2b8-c735-4f08-94fc-9bec84182e2f"
6947	wsmap="managed"
6948	>
6949	<desc>
6950	The IHost interface represents the physical machine that this VirtualBox
6951	installation runs on.
6952
6953	An object implementing this interface is returned by the
6954	<link to="IVirtualBox::host" /> attribute. This interface contains
6955	read-only information about the host's physical hardware (such as what
6956	processors and disks are available, what the host operating system is,
6957	and so on) and also allows for manipulating some of the host's hardware,
6958	such as global USB device filters and host interface networking.
6959
6960	</desc>
6961	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6962	<desc>List of DVD drives available on the host.</desc>
6963	</attribute>
6964
6965	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6966	<desc>List of floppy drives available on the host.</desc>
6967	</attribute>
6968
6969	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6970	<desc>
6971	List of USB devices currently attached to the host.
6972	Once a new device is physically attached to the host computer,
6973	it appears in this list and remains there until detached.
6974
6975	<note>
6976	If USB functionality is not available in the given edition of
6977	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6978	</note>
6979	</desc>
6980	</attribute>
6981
6982	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6983	<desc>
6984	List of USB device filters in action.
6985	When a new device is physically attached to the host computer,
6986	filters from this list are applied to it (in order they are stored
6987	in the list). The first matched filter will determine the
6988	<link to="IHostUSBDeviceFilter::action">action</link>
6989	performed on the device.
6990
6991	Unless the device is ignored by these filters, filters of all
6992	currently running virtual machines
6993	(<link to="IUSBController::deviceFilters"/>) are applied to it.
6994
6995	<note>
6996	If USB functionality is not available in the given edition of
6997	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6998	</note>
6999
7000	<see>IHostUSBDeviceFilter, USBDeviceState</see>
7001	</desc>
7002	</attribute>
7003
7004	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7005	<desc>List of host network interfaces currently defined on the host.</desc>
7006	</attribute>
7007
7008	<attribute name="processorCount" type="unsigned long" readonly="yes">
7009	<desc>Number of (logical) CPUs installed in the host system.</desc>
7010	</attribute>
7011
7012	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7013	<desc>Number of (logical) CPUs online in the host system.</desc>
7014	</attribute>
7015
7016	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7017	<desc>Number of physical processor cores installed in the host system.</desc>
7018	</attribute>
7019
7020	<method name="getProcessorSpeed">
7021	<desc>Query the (approximate) maximum speed of a specified host CPU in
7022	Megahertz.
7023	</desc>
7024	<param name="cpuId" type="unsigned long" dir="in">
7025	<desc>
7026	Identifier of the CPU.
7027	</desc>
7028	</param>
7029	<param name="speed" type="unsigned long" dir="return">
7030	<desc>
7031	Speed value. 0 is returned if value is not known or @a cpuId is
7032	invalid.
7033	</desc>
7034	</param>
7035	</method>
7036
7037	<method name="getProcessorFeature">
7038	<desc>Query whether a CPU feature is supported or not.</desc>
7039	<param name="feature" type="ProcessorFeature" dir="in">
7040	<desc>
7041	CPU Feature identifier.
7042	</desc>
7043	</param>
7044	<param name="supported" type="boolean" dir="return">
7045	<desc>
7046	Feature is supported or not.
7047	</desc>
7048	</param>
7049	</method>
7050
7051	<method name="getProcessorDescription">
7052	<desc>Query the model string of a specified host CPU.
7053	</desc>
7054	<param name="cpuId" type="unsigned long" dir="in">
7055	<desc>
7056	Identifier of the CPU.
7057	<note>
7058	The current implementation might not necessarily return the
7059	description for this exact CPU.
7060	</note>
7061	</desc>
7062	</param>
7063	<param name="description" type="wstring" dir="return">
7064	<desc>
7065	Model string. An empty string is returned if value is not known or
7066	@a cpuId is invalid.
7067	</desc>
7068	</param>
7069	</method>
7070
7071	<method name="getProcessorCPUIDLeaf">
7072	<desc>
7073	Returns the CPU cpuid information for the specified leaf.
7074	</desc>
7075	<param name="cpuId" type="unsigned long" dir="in">
7076	<desc>
7077	Identifier of the CPU. The CPU most be online.
7078	<note>
7079	The current implementation might not necessarily return the
7080	description for this exact CPU.
7081	</note>
7082	</desc>
7083	</param>
7084	<param name="leaf" type="unsigned long" dir="in">
7085	<desc>
7086	CPUID leaf index (eax).
7087	</desc>
7088	</param>
7089	<param name="subLeaf" type="unsigned long" dir="in">
7090	<desc>
7091	CPUID leaf sub index (ecx). This currently only applies to cache
7092	information on Intel CPUs. Use 0 if retrieving values for
7093	<link to="IMachine::setCPUIDLeaf"/>.
7094	</desc>
7095	</param>
7096	<param name="valEax" type="unsigned long" dir="out">
7097	<desc>
7098	CPUID leaf value for register eax.
7099	</desc>
7100	</param>
7101	<param name="valEbx" type="unsigned long" dir="out">
7102	<desc>
7103	CPUID leaf value for register ebx.
7104	</desc>
7105	</param>
7106	<param name="valEcx" type="unsigned long" dir="out">
7107	<desc>
7108	CPUID leaf value for register ecx.
7109	</desc>
7110	</param>
7111	<param name="valEdx" type="unsigned long" dir="out">
7112	<desc>
7113	CPUID leaf value for register edx.
7114	</desc>
7115	</param>
7116	</method>
7117
7118	<attribute name="memorySize" type="unsigned long" readonly="yes">
7119	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7120	</attribute>
7121
7122	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7123	<desc>Available system memory in the host system.</desc>
7124	</attribute>
7125
7126	<attribute name="operatingSystem" type="wstring" readonly="yes">
7127	<desc>Name of the host system's operating system.</desc>
7128	</attribute>
7129
7130	<attribute name="OSVersion" type="wstring" readonly="yes">
7131	<desc>Host operating system's version string.</desc>
7132	</attribute>
7133
7134	<attribute name="UTCTime" type="long long" readonly="yes">
7135	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7136	</attribute>
7137
7138	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7139	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7140	</attribute>
7141
7142	<method name="createHostOnlyNetworkInterface">
7143	<desc>
7144	Creates a new adapter for Host Only Networking.
7145	<result name="E_INVALIDARG">
7146	Host network interface @a name already exists.
7147	</result>
7148	</desc>
7149	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7150	<desc>
7151	Created host interface object.
7152	</desc>
7153	</param>
7154	<param name="progress" type="IProgress" dir="return">
7155	<desc>
7156	Progress object to track the operation completion.
7157	</desc>
7158	</param>
7159	</method>
7160
7161	<method name="removeHostOnlyNetworkInterface">
7162	<desc>
7163	Removes the given Host Only Networking interface.
7164	<result name="VBOX_E_OBJECT_NOT_FOUND">
7165	No host network interface matching @a id found.
7166	</result>
7167	</desc>
7168	<param name="id" type="uuid" mod="string" dir="in">
7169	<desc>
7170	Adapter GUID.
7171	</desc>
7172	</param>
7173	<param name="progress" type="IProgress" dir="return">
7174	<desc>
7175	Progress object to track the operation completion.
7176	</desc>
7177	</param>
7178	</method>
7179
7180	<method name="createUSBDeviceFilter">
7181	<desc>
7182	Creates a new USB device filter. All attributes except
7183	the filter name are set to empty (any match),
7184	<i>active</i> is @c false (the filter is not active).
7185
7186	The created filter can be added to the list of filters using
7187	<link to="#insertUSBDeviceFilter"/>.
7188
7189	<see>#USBDeviceFilters</see>
7190	</desc>
7191	<param name="name" type="wstring" dir="in">
7192	<desc>
7193	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7194	</desc>
7195	</param>
7196	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7197	<desc>Created filter object.</desc>
7198	</param>
7199	</method>
7200
7201	<method name="insertUSBDeviceFilter">
7202	<desc>
7203	Inserts the given USB device to the specified position
7204	in the list of filters.
7205
7206	Positions are numbered starting from @c 0. If the specified
7207	position is equal to or greater than the number of elements in
7208	the list, the filter is added at the end of the collection.
7209
7210	<note>
7211	Duplicates are not allowed, so an attempt to insert a
7212	filter already in the list is an error.
7213	</note>
7214	<note>
7215	If USB functionality is not available in the given edition of
7216	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7217	</note>
7218
7219	<see>#USBDeviceFilters</see>
7220
7221	<result name="VBOX_E_INVALID_OBJECT_STATE">
7222	USB device filter is not created within this VirtualBox instance.
7223	</result>
7224	<result name="E_INVALIDARG">
7225	USB device filter already in list.
7226	</result>
7227
7228	</desc>
7229	<param name="position" type="unsigned long" dir="in">
7230	<desc>Position to insert the filter to.</desc>
7231	</param>
7232	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7233	<desc>USB device filter to insert.</desc>
7234	</param>
7235	</method>
7236
7237	<method name="removeUSBDeviceFilter">
7238	<desc>
7239	Removes a USB device filter from the specified position in the
7240	list of filters.
7241
7242	Positions are numbered starting from @c 0. Specifying a
7243	position equal to or greater than the number of elements in
7244	the list will produce an error.
7245
7246	<note>
7247	If USB functionality is not available in the given edition of
7248	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7249	</note>
7250
7251	<see>#USBDeviceFilters</see>
7252
7253	<result name="E_INVALIDARG">
7254	USB device filter list empty or invalid @a position.
7255	</result>
7256
7257	</desc>
7258	<param name="position" type="unsigned long" dir="in">
7259	<desc>Position to remove the filter from.</desc>
7260	</param>
7261	</method>
7262
7263	<method name="findHostDVDDrive">
7264	<desc>
7265	Searches for a host DVD drive with the given @c name.
7266
7267	<result name="VBOX_E_OBJECT_NOT_FOUND">
7268	Given @c name does not correspond to any host drive.
7269	</result>
7270
7271	</desc>
7272	<param name="name" type="wstring" dir="in">
7273	<desc>Name of the host drive to search for</desc>
7274	</param>
7275	<param name="drive" type="IMedium" dir="return">
7276	<desc>Found host drive object</desc>
7277	</param>
7278	</method>
7279
7280	<method name="findHostFloppyDrive">
7281	<desc>
7282	Searches for a host floppy drive with the given @c name.
7283
7284	<result name="VBOX_E_OBJECT_NOT_FOUND">
7285	Given @c name does not correspond to any host floppy drive.
7286	</result>
7287
7288	</desc>
7289	<param name="name" type="wstring" dir="in">
7290	<desc>Name of the host floppy drive to search for</desc>
7291	</param>
7292	<param name="drive" type="IMedium" dir="return">
7293	<desc>Found host floppy drive object</desc>
7294	</param>
7295	</method>
7296
7297	<method name="findHostNetworkInterfaceByName">
7298	<desc>
7299	Searches through all host network interfaces for an interface with
7300	the given @c name.
7301	<note>
7302	The method returns an error if the given @c name does not
7303	correspond to any host network interface.
7304	</note>
7305	</desc>
7306	<param name="name" type="wstring" dir="in">
7307	<desc>Name of the host network interface to search for.</desc>
7308	</param>
7309	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7310	<desc>Found host network interface object.</desc>
7311	</param>
7312	</method>
7313	<method name="findHostNetworkInterfaceById">
7314	<desc>
7315	Searches through all host network interfaces for an interface with
7316	the given GUID.
7317	<note>
7318	The method returns an error if the given GUID does not
7319	correspond to any host network interface.
7320	</note>
7321	</desc>
7322	<param name="id" type="uuid" mod="string" dir="in">
7323	<desc>GUID of the host network interface to search for.</desc>
7324	</param>
7325	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7326	<desc>Found host network interface object.</desc>
7327	</param>
7328	</method>
7329	<method name="findHostNetworkInterfacesOfType">
7330	<desc>
7331	Searches through all host network interfaces and returns a list of interfaces of the specified type
7332	</desc>
7333	<param name="type" type="HostNetworkInterfaceType" dir="in">
7334	<desc>type of the host network interfaces to search for.</desc>
7335	</param>
7336	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7337	<desc>Found host network interface objects.</desc>
7338	</param>
7339	</method>
7340
7341	<method name="findUSBDeviceById">
7342	<desc>
7343	Searches for a USB device with the given UUID.
7344
7345	<result name="VBOX_E_OBJECT_NOT_FOUND">
7346	Given @c id does not correspond to any USB device.
7347	</result>
7348
7349	<see>IHostUSBDevice::id</see>
7350	</desc>
7351	<param name="id" type="uuid" mod="string" dir="in">
7352	<desc>UUID of the USB device to search for.</desc>
7353	</param>
7354	<param name="device" type="IHostUSBDevice" dir="return">
7355	<desc>Found USB device object.</desc>
7356	</param>
7357	</method>
7358
7359	<method name="findUSBDeviceByAddress">
7360	<desc>
7361	Searches for a USB device with the given host address.
7362
7363	<result name="VBOX_E_OBJECT_NOT_FOUND">
7364	Given @c name does not correspond to any USB device.
7365	</result>
7366
7367	<see>IHostUSBDevice::address</see>
7368	</desc>
7369	<param name="name" type="wstring" dir="in">
7370	<desc>
7371	Address of the USB device (as assigned by the host) to
7372	search for.
7373	</desc>
7374	</param>
7375	<param name="device" type="IHostUSBDevice" dir="return">
7376	<desc>Found USB device object.</desc>
7377	</param>
7378	</method>
7379
7380	<method name="generateMACAddress">
7381	<desc>
7382	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
7383	</desc>
7384	<param name="address" type="wstring" dir="return">
7385	<desc>New Ethernet MAC address.</desc>
7386	</param>
7387	</method>
7388
7389	</interface>
7390
7391	<!--
7392	// ISystemProperties
7393	/////////////////////////////////////////////////////////////////////////
7394	-->
7395
7396	<interface
7397	name="ISystemProperties"
7398	extends="$unknown"
7399	uuid="2f89cdfe-2d10-43d4-b37f-61760f877f29"
7400	wsmap="managed"
7401	>
7402	<desc>
7403	The ISystemProperties interface represents global properties of the given
7404	VirtualBox installation.
7405
7406	These properties define limits and default values for various attributes
7407	and parameters. Most of the properties are read-only, but some can be
7408	changed by a user.
7409	</desc>
7410
7411	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7412	<desc>Minimum guest system memory in Megabytes.</desc>
7413	</attribute>
7414
7415	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7416	<desc>Maximum guest system memory in Megabytes.</desc>
7417	</attribute>
7418
7419	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7420	<desc>Minimum guest video memory in Megabytes.</desc>
7421	</attribute>
7422
7423	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7424	<desc>Maximum guest video memory in Megabytes.</desc>
7425	</attribute>
7426
7427	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7428	<desc>Minimum CPU count.</desc>
7429	</attribute>
7430
7431	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7432	<desc>Maximum CPU count.</desc>
7433	</attribute>
7434
7435	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7436	<desc>Maximum of monitors which could be connected.</desc>
7437	</attribute>
7438
7439	<attribute name="infoVDSize" type="long long" readonly="yes">
7440	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7441	does not reflect the limits of any virtual disk image format.</desc>
7442	</attribute>
7443
7444	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7445	<desc>
7446	Maximum number of serial ports associated with every
7447	<link to="IMachine"/> instance.
7448	</desc>
7449	</attribute>
7450
7451	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7452	<desc>
7453	Maximum number of parallel ports associated with every
7454	<link to="IMachine"/> instance.
7455	</desc>
7456	</attribute>
7457
7458	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7459	<desc>
7460	Maximum device position in the boot order. This value corresponds
7461	to the total number of devices a machine can boot from, to make it
7462	possible to include all possible devices to the boot list.
7463	<see><link to="IMachine::setBootOrder"/></see>
7464	</desc>
7465	</attribute>
7466
7467	<attribute name="defaultMachineFolder" type="wstring">
7468	<desc>
7469	Full path to the default directory used to create new or open
7470	existing machines when a machine settings file name contains no
7471	path.
7472
7473	Starting with VirtualBox 4.0, by default, this attribute contains
7474	the full path of folder named "VirtualBox VMs" in the user's
7475	home directory, which depends on the host platform.
7476
7477	When setting this attribute, a full path must be specified.
7478	Setting this property to @c null or an empty string or the
7479	special value "Machines" (for compatibility reasons) will restore
7480	that default value.
7481
7482	If the folder specified herein does not exist, it will be created
7483	automatically as needed.
7484
7485	<see>
7486	<link to="IVirtualBox::createMachine"/>,
7487	<link to="IVirtualBox::openMachine"/>
7488	</see>
7489	</desc>
7490	</attribute>
7491
7492	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7493	<desc>
7494	List of all medium storage formats supported by this VirtualBox
7495	installation.
7496
7497	Keep in mind that the medium format identifier
7498	(<link to="IMediumFormat::id"/>) used in other API calls like
7499	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7500	medium format is a case-insensitive string. This means that, for
7501	example, all of the following strings:
7502	<pre>
7503	"VDI"
7504	"vdi"
7505	"VdI"</pre>
7506	refer to the same medium format.
7507
7508	Note that the virtual medium framework is backend-based, therefore
7509	the list of supported formats depends on what backends are currently
7510	installed.
7511
7512	<see>
7513	<link to="IMediumFormat"/>,
7514	</see>
7515	</desc>
7516	</attribute>
7517
7518	<attribute name="defaultHardDiskFormat" type="wstring">
7519	<desc>
7520	Identifier of the default medium format used by VirtualBox.
7521
7522	The medium format set by this attribute is used by VirtualBox
7523	when the medium format was not specified explicitly. One example is
7524	<link to="IVirtualBox::createHardDisk"/> with the empty
7525	format argument. A more complex example is implicit creation of
7526	differencing media when taking a snapshot of a virtual machine:
7527	this operation will try to use a format of the parent medium first
7528	and if this format does not support differencing media the default
7529	format specified by this argument will be used.
7530
7531	The list of supported medium formats may be obtained by the
7532	<link to="#mediumFormats"/> call. Note that the default medium
7533	format must have a capability to create differencing media;
7534	otherwise operations that create media implicitly may fail
7535	unexpectedly.
7536
7537	The initial value of this property is <tt>"VDI"</tt> in the current
7538	version of the VirtualBox product, but may change in the future.
7539
7540	<note>
7541	Setting this property to @c null or empty string will restore the
7542	initial value.
7543	</note>
7544
7545	<see>
7546	<link to="#mediumFormats"/>,
7547	<link to="IMediumFormat::id"/>,
7548	<link to="IVirtualBox::createHardDisk"/>
7549	</see>
7550	</desc>
7551	</attribute>
7552
7553	<attribute name="freeDiskSpaceWarning" type="long long">
7554	<desc>Issue a warning if the free disk space is below (or in some disk
7555	intensive operation is expected to go below) the given size in
7556	bytes.</desc>
7557	</attribute>
7558
7559	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7560	<desc>Issue a warning if the free disk space is below (or in some disk
7561	intensive operation is expected to go below) the given percentage.</desc>
7562	</attribute>
7563
7564	<attribute name="freeDiskSpaceError" type="long long">
7565	<desc>Issue an error if the free disk space is below (or in some disk
7566	intensive operation is expected to go below) the given size in
7567	bytes.</desc>
7568	</attribute>
7569
7570	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7571	<desc>Issue an error if the free disk space is below (or in some disk
7572	intensive operation is expected to go below) the given percentage.</desc>
7573	</attribute>
7574
7575	<attribute name="VRDEAuthLibrary" type="wstring">
7576	<desc>
7577	Library that provides authentication for Remote Desktop clients. The library
7578	is used if a virtual machine's authentication type is set to "external"
7579	in the VM RemoteDisplay configuration.
7580
7581	The system library extension (".DLL" or ".so") must be omitted.
7582	A full path can be specified; if not, then the library must reside on the
7583	system's default library path.
7584
7585	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
7586	of that name in one of the default VirtualBox library directories.
7587
7588	For details about VirtualBox authentication libraries and how to implement
7589	them, please refer to the VirtualBox manual.
7590
7591	<note>
7592	Setting this property to @c null or empty string will restore the
7593	initial value.
7594	</note>
7595	</desc>
7596	</attribute>
7597
7598	<attribute name="webServiceAuthLibrary" type="wstring">
7599	<desc>
7600	Library that provides authentication for webservice clients. The library
7601	is used if a virtual machine's authentication type is set to "external"
7602	in the VM RemoteDisplay configuration and will be called from
7603	within the <link to="IWebsessionManager::logon" /> implementation.
7604
7605	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
7606	there is no per-VM setting for this, as the webservice is a global
7607	resource (if it is running). Only for this setting (for the webservice),
7608	setting this value to a literal <tt>"null"</tt> string disables authentication,
7609	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7610	no matter what user name and password are supplied.
7611
7612	The initial value of this property is <tt>"VBoxAuth"</tt>,
7613	meaning that the webservice will use the same authentication
7614	library that is used by default for VRDE (again, see
7615	<link to="ISystemProperties::VRDEAuthLibrary" />).
7616	The format and calling convention of authentication libraries
7617	is the same for the webservice as it is for VRDE.
7618
7619	<note>
7620	Setting this property to @c null or empty string will restore the
7621	initial value.
7622	</note>
7623	</desc>
7624	</attribute>
7625
7626	<attribute name="defaultVRDEExtPack" type="wstring">
7627	<desc>
7628	The name of the extension pack providing the default VRDE.
7629
7630	This attribute is for choosing between multiple extension packs
7631	providing VRDE. If only one is installed, it will automatically be the
7632	default one. The attribute value can be empty if no VRDE extension
7633	pack is installed.
7634
7635	For details about VirtualBox Remote Desktop Extension and how to
7636	implement one, please refer to the VirtualBox SDK.
7637	</desc>
7638	</attribute>
7639
7640	<attribute name="LogHistoryCount" type="unsigned long">
7641	<desc>
7642	This value specifies how many old release log files are kept.
7643	</desc>
7644	</attribute>
7645
7646	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7647	<desc>This value hold the default audio driver for the current
7648	system.</desc>
7649	</attribute>
7650
7651
7652	<method name="getMaxNetworkAdapters">
7653	<desc>
7654	Maximum total number of network adapters associated with every
7655	<link to="IMachine"/> instance.
7656	</desc>
7657
7658	<param name="chipset" type="ChipsetType" dir="in">
7659	<desc>The chipset type to get the value for.</desc>
7660	</param>
7661
7662
7663	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
7664	<desc>The maximum total number of network adapters allowed.</desc>
7665	</param>
7666
7667	</method>
7668
7669	<method name="getMaxNetworkAdaptersOfType">
7670	<desc>
7671	Maximum number of network adapters of a given attachment type,
7672	associated with every <link to="IMachine"/> instance.
7673	</desc>
7674
7675	<param name="chipset" type="ChipsetType" dir="in">
7676	<desc>The chipset type to get the value for.</desc>
7677	</param>
7678
7679	<param name="type" type="NetworkAttachmentType" dir="in">
7680	<desc>Type of attachment.</desc>
7681	</param>
7682
7683	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
7684	<desc>The maximum number of network adapters allowed for
7685	particular chipset and attachment type.</desc>
7686	</param>
7687
7688	</method>
7689
7690
7691	<method name="getMaxDevicesPerPortForStorageBus">
7692	<desc>Returns the maximum number of devices which can be attached to a port
7693	for the given storage bus.</desc>
7694
7695	<param name="bus" type="StorageBus" dir="in">
7696	<desc>The storage bus type to get the value for.</desc>
7697	</param>
7698
7699	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7700	<desc>The maximum number of devices which can be attached to the port for the given
7701	storage bus.</desc>
7702	</param>
7703	</method>
7704
7705	<method name="getMinPortCountForStorageBus">
7706	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7707
7708	<param name="bus" type="StorageBus" dir="in">
7709	<desc>The storage bus type to get the value for.</desc>
7710	</param>
7711
7712	<param name="minPortCount" type="unsigned long" dir="return">
7713	<desc>The minimum number of ports for the given storage bus.</desc>
7714	</param>
7715	</method>
7716
7717	<method name="getMaxPortCountForStorageBus">
7718	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7719
7720	<param name="bus" type="StorageBus" dir="in">
7721	<desc>The storage bus type to get the value for.</desc>
7722	</param>
7723
7724	<param name="maxPortCount" type="unsigned long" dir="return">
7725	<desc>The maximum number of ports for the given storage bus.</desc>
7726	</param>
7727	</method>
7728
7729	<method name="getMaxInstancesOfStorageBus">
7730	<desc>Returns the maximum number of storage bus instances which
7731	can be configured for each VM. This corresponds to the number of
7732	storage controllers one can have. Value may depend on chipset type
7733	used.</desc>
7734
7735	<param name="chipset" type="ChipsetType" dir="in">
7736	<desc>The chipset type to get the value for.</desc>
7737	</param>
7738
7739	<param name="bus" type="StorageBus" dir="in">
7740	<desc>The storage bus type to get the value for.</desc>
7741	</param>
7742
7743	<param name="maxInstances" type="unsigned long" dir="return">
7744	<desc>The maximum number of instances for the given storage bus.</desc>
7745	</param>
7746	</method>
7747
7748	<method name="getDeviceTypesForStorageBus">
7749	<desc>Returns list of all the supported device types
7750	(<link to="DeviceType"/>) for the given type of storage
7751	bus.</desc>
7752
7753	<param name="bus" type="StorageBus" dir="in">
7754	<desc>The storage bus type to get the value for.</desc>
7755	</param>
7756
7757	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7758	<desc>The list of all supported device types for the given storage bus.</desc>
7759	</param>
7760	</method>
7761
7762	<method name="getDefaultIoCacheSettingForStorageController">
7763	<desc>Returns the default I/O cache setting for the
7764	given storage controller</desc>
7765
7766	<param name="controllerType" type="StorageControllerType" dir="in">
7767	<desc>The storage controller to the setting for.</desc>
7768	</param>
7769
7770	<param name="enabled" type="boolean" dir="return">
7771	<desc>Returned flag indicating the default value</desc>
7772	</param>
7773	</method>
7774	</interface>
7775
7776	<!--
7777	// IGuest
7778	/////////////////////////////////////////////////////////////////////////
7779	-->
7780
7781	<interface
7782	name="IGuestOSType" extends="$unknown"
7783	uuid="432c1546-1354-4abf-bf08-878a32a373f5"
7784	wsmap="struct"
7785	>
7786	<desc>
7787	</desc>
7788
7789	<attribute name="familyId" type="wstring" readonly="yes">
7790	<desc>Guest OS family identifier string.</desc>
7791	</attribute>
7792
7793	<attribute name="familyDescription" type="wstring" readonly="yes">
7794	<desc>Human readable description of the guest OS family.</desc>
7795	</attribute>
7796
7797	<attribute name="id" type="wstring" readonly="yes">
7798	<desc>Guest OS identifier string.</desc>
7799	</attribute>
7800
7801	<attribute name="description" type="wstring" readonly="yes">
7802	<desc>Human readable description of the guest OS.</desc>
7803	</attribute>
7804
7805	<attribute name="is64Bit" type="boolean" readonly="yes">
7806	<desc>Returns @c true if the given OS is 64-bit</desc>
7807	</attribute>
7808
7809	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7810	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7811	</attribute>
7812
7813	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7814	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7815	</attribute>
7816
7817	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7818	<desc>Recommended RAM size in Megabytes.</desc>
7819	</attribute>
7820
7821	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7822	<desc>Recommended video RAM size in Megabytes.</desc>
7823	</attribute>
7824
7825	<attribute name="recommendedHDD" type="long long" readonly="yes">
7826	<desc>Recommended hard disk size in bytes.</desc>
7827	</attribute>
7828
7829	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7830	<desc>Returns recommended network adapter for this OS type.</desc>
7831	</attribute>
7832
7833	<attribute name="recommendedPae" type="boolean" readonly="yes">
7834	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7835	</attribute>
7836
7837	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7838	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7839	</attribute>
7840
7841	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7842	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7843	</attribute>
7844
7845	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7846	<desc>Recommended storage controller type for HD drives.</desc>
7847	</attribute>
7848
7849	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7850	<desc>Recommended storage bus type for HD drives.</desc>
7851	</attribute>
7852
7853	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7854	<desc>Recommended firmware type.</desc>
7855	</attribute>
7856
7857	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7858	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7859	</attribute>
7860
7861	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7862	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7863	</attribute>
7864
7865	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7866	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7867	</attribute>
7868
7869	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7870	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7871	</attribute>
7872
7873	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
7874	<desc>Recommended chipset type.</desc>
7875	</attribute>
7876
7877	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
7878	<desc>Recommended audio type.</desc>
7879	</attribute>
7880
7881	</interface>
7882
7883	<enum
7884	name="AdditionsFacilityType"
7885	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
7886	>
7887	<desc>
7888	Guest Additions facility IDs.
7889	</desc>
7890
7891	<const name="None" value="0">
7892	<desc>No/invalid facility.</desc>
7893	</const>
7894	<const name="VBoxGuestDriver" value="20">
7895	<desc>VirtualBox base driver (VBoxGuest).</desc>
7896	</const>
7897	<const name="VBoxService" value="100">
7898	<desc>VirtualBox system service (VBoxService).</desc>
7899	</const>
7900	<const name="VBoxTrayClient" value="101">
7901	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
7902	</const>
7903	<const name="Seamless" value="1000">
7904	<desc>Seamless guest desktop integration.</desc>
7905	</const>
7906	<const name="Graphics" value="1100">
7907	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
7908	are not immediately acted on and guest display resizes are probably not initiated by
7909	the guest additions.
7910	</desc>
7911	</const>
7912	<const name="All" value="2147483646">
7913	<desc>All facilities selected.</desc>
7914	</const>
7915	</enum>
7916
7917	<enum
7918	name="AdditionsFacilityClass"
7919	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
7920	>
7921	<desc>
7922	Guest Additions facility classes.
7923	</desc>
7924
7925	<const name="None" value="0">
7926	<desc>No/invalid class.</desc>
7927	</const>
7928	<const name="Driver" value="10">
7929	<desc>Driver.</desc>
7930	</const>
7931	<const name="Service" value="30">
7932	<desc>System service.</desc>
7933	</const>
7934	<const name="Program" value="50">
7935	<desc>Program.</desc>
7936	</const>
7937	<const name="Feature" value="100">
7938	<desc>Feature.</desc>
7939	</const>
7940	<const name="ThirdParty" value="999">
7941	<desc>Third party.</desc>
7942	</const>
7943	<const name="All" value="2147483646">
7944	<desc>All facility classes selected.</desc>
7945	</const>
7946	</enum>
7947
7948	<enum
7949	name="AdditionsFacilityStatus"
7950	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
7951	>
7952	<desc>
7953	Guest Additions facility states.
7954	</desc>
7955
7956	<const name="Inactive" value="0">
7957	<desc>Facility is not active.</desc>
7958	</const>
7959	<const name="Paused" value="1">
7960	<desc>Facility has been paused.</desc>
7961	</const>
7962	<const name="PreInit" value="20">
7963	<desc>Facility is preparing to initialize.</desc>
7964	</const>
7965	<const name="Init" value="30">
7966	<desc>Facility is initializing.</desc>
7967	</const>
7968	<const name="Active" value="50">
7969	<desc>Facility is up and running.</desc>
7970	</const>
7971	<const name="Terminating" value="100">
7972	<desc>Facility is shutting down.</desc>
7973	</const>
7974	<const name="Terminated" value="101">
7975	<desc>Facility successfully shut down.</desc>
7976	</const>
7977	<const name="Failed" value="800">
7978	<desc>Facility failed to start.</desc>
7979	</const>
7980	<const name="Unknown" value="999">
7981	<desc>Facility status is unknown.</desc>
7982	</const>
7983	</enum>
7984
7985	<interface
7986	name="IAdditionsFacility" extends="$unknown"
7987	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
7988	wsmap="struct"
7989	>
7990	<desc>
7991	Structure representing a Guest Additions facility.
7992	</desc>
7993
7994	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
7995	<desc>The class this facility is part of.</desc>
7996	</attribute>
7997
7998	<attribute name="lastUpdated" type="long long" readonly="yes">
7999	<desc>
8000	Time stamp of the last status update,
8001	in milliseconds since 1970-01-01 UTC.
8002	</desc>
8003	</attribute>
8004
8005	<attribute name="name" type="wstring" readonly="yes">
8006	<desc>The facility's friendly name.</desc>
8007	</attribute>
8008
8009	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8010	<desc>The current status.</desc>
8011	</attribute>
8012
8013	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8014	<desc>The facility's type ID.</desc>
8015	</attribute>
8016	</interface>
8017
8018	<enum
8019	name="AdditionsRunLevelType"
8020	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8021	>
8022	<desc>
8023	Guest Additions run level type.
8024	</desc>
8025
8026	<const name="None" value="0">
8027	<desc>Guest Additions are not loaded.</desc>
8028	</const>
8029	<const name="System" value="1">
8030	<desc>Guest drivers are loaded.</desc>
8031	</const>
8032	<const name="Userland" value="2">
8033	<desc>Common components (such as application services) are loaded.</desc>
8034	</const>
8035	<const name="Desktop" value="3">
8036	<desc>Per-user desktop components are loaded.</desc>
8037	</const>
8038	</enum>
8039
8040	<enum
8041	name="AdditionsUpdateFlag"
8042	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8043	>
8044	<desc>
8045	Guest Additions update flags.
8046	</desc>
8047
8048	<const name="None" value="0">
8049	<desc>No flag set.</desc>
8050	</const>
8051	<const name="WaitForUpdateStartOnly" value="1">
8052	<desc>Only wait for the update process being started and do not
8053	wait while peforming the actual update.</desc>
8054	</const>
8055	</enum>
8056
8057	<enum
8058	name="ExecuteProcessFlag"
8059	uuid="3258e8a5-ba0c-43d5-86b5-cf91405fddc0"
8060	>
8061	<desc>
8062	Guest process execution flags.
8063	</desc>
8064
8065	<const name="None" value="0">
8066	<desc>No flag set.</desc>
8067	</const>
8068
8069	<const name="WaitForProcessStartOnly" value="1">
8070	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8071	process itself then uses an infinite timeout.</desc>
8072	</const>
8073
8074	<const name="IgnoreOrphanedProcesses" value="2">
8075	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8076	</const>
8077
8078	<const name="Hidden" value="4">
8079	<desc>Don't show the started process according to the guest OS guidelines.</desc>
8080	</const>
8081	</enum>
8082
8083	<enum
8084	name="ExecuteProcessStatus"
8085	uuid="153768d9-d971-4098-8b5a-c5cb1ab9ea88"
8086	>
8087	<desc>
8088	Guest process execution status.
8089	</desc>
8090
8091	<const name="Undefined" value="0">
8092	<desc>Process is in an undefined state.</desc>
8093	</const>
8094
8095	<const name="Started" value="1">
8096	<desc>Process has been started.</desc>
8097	</const>
8098
8099	<const name="TerminatedNormally" value="2">
8100	<desc>Process terminated normally.</desc>
8101	</const>
8102
8103	<const name="TerminatedSignal" value="3">
8104	<desc>Process terminated via signal.</desc>
8105	</const>
8106
8107	<const name="TerminatedAbnormally" value="4">
8108	<desc>Process terminated abnormally.</desc>
8109	</const>
8110
8111	<const name="TimedOutKilled" value="5">
8112	<desc>Process timed out and was killed.</desc>
8113	</const>
8114
8115	<const name="TimedOutAbnormally" value="6">
8116	<desc>Process timed out and was not killed successfully.</desc>
8117	</const>
8118
8119	<const name="Down" value="7">
8120	<desc>Service/OS is stopping, process was killed.</desc>
8121	</const>
8122
8123	<const name="Error" value="8">
8124	<desc>Something went wrong (error code in flags).</desc>
8125	</const>
8126	</enum>
8127
8128	<enum
8129	name="ProcessInputFlag"
8130	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8131	>
8132	<desc>
8133	Guest process input flags.
8134	</desc>
8135
8136	<const name="None" value="0">
8137	<desc>No flag set.</desc>
8138	</const>
8139
8140	<const name="EndOfFile" value="1">
8141	<desc>End of file (input) reached.</desc>
8142	</const>
8143	</enum>
8144
8145	<enum
8146	name="CopyFileFlag"
8147	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
8148	>
8149	<desc>
8150	Host/Guest copy flags. At the moment none of these flags
8151	are implemented.
8152	</desc>
8153
8154	<const name="None" value="0">
8155	<desc>No flag set.</desc>
8156	</const>
8157
8158	<const name="Recursive" value="1">
8159	<desc>Copy directories recursively.</desc>
8160	</const>
8161
8162	<const name="Update" value="2">
8163	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
8164	</const>
8165
8166	<const name="FollowLinks" value="4">
8167	<desc>Follow symbolic links.</desc>
8168	</const>
8169	</enum>
8170
8171	<enum
8172	name="CreateDirectoryFlag"
8173	uuid="26ff5bdd-c81f-4304-857b-b8be5e3f9cd6"
8174	>
8175	<desc>
8176	Directory creation flags.
8177	</desc>
8178
8179	<const name="None" value="0">
8180	<desc>No flag set.</desc>
8181	</const>
8182
8183	<const name="Parents" value="1">
8184	<desc>No error if existing, make parent directories as needed.</desc>
8185	</const>
8186	</enum>
8187
8188	<interface
8189	name="IGuest" extends="$unknown"
8190	uuid="4e78f7dd-8ca1-47e5-a344-5207f793df71"
8191	wsmap="managed"
8192	>
8193	<desc>
8194	The IGuest interface represents information about the operating system
8195	running inside the virtual machine. Used in
8196	<link to="IConsole::guest"/>.
8197
8198	IGuest provides information about the guest operating system, whether
8199	Guest Additions are installed and other OS-specific virtual machine
8200	properties.
8201	</desc>
8202
8203	<attribute name="OSTypeId" type="wstring" readonly="yes">
8204	<desc>
8205	Identifier of the Guest OS type as reported by the Guest
8206	Additions.
8207	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8208	an IGuestOSType object representing details about the given
8209	Guest OS type.
8210	<note>
8211	If Guest Additions are not installed, this value will be
8212	the same as <link to="IMachine::OSTypeId"/>.
8213	</note>
8214	</desc>
8215	</attribute>
8216
8217	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
8218	<desc>
8219	Current run level of the Guest Additions.
8220	</desc>
8221	</attribute>
8222
8223	<attribute name="additionsVersion" type="wstring" readonly="yes">
8224	<desc>
8225	Version of the Guest Additions including the revision (3 decimal numbers
8226	separated by dots + revision number) installed on the guest or empty
8227	when the Additions are not installed.
8228	</desc>
8229	</attribute>
8230
8231	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
8232	<desc>
8233	Array of current known facilities. Only returns facilities where a status is known,
8234	e.g. facilities with an unknown status will not be returned.
8235	</desc>
8236	</attribute>
8237
8238	<attribute name="memoryBalloonSize" type="unsigned long">
8239	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8240	</attribute>
8241
8242	<attribute name="statisticsUpdateInterval" type="unsigned long">
8243	<desc>Interval to update guest statistics in seconds.</desc>
8244	</attribute>
8245
8246	<method name="internalGetStatistics">
8247	<desc>
8248	Internal method; do not use as it might change at any time.
8249	</desc>
8250	<param name="cpuUser" type="unsigned long" dir="out">
8251	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
8252	</param>
8253	<param name="cpuKernel" type="unsigned long" dir="out">
8254	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
8255	</param>
8256	<param name="cpuIdle" type="unsigned long" dir="out">
8257	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
8258	</param>
8259	<param name="memTotal" type="unsigned long" dir="out">
8260	<desc>Total amount of physical guest RAM.</desc>
8261	</param>
8262	<param name="memFree" type="unsigned long" dir="out">
8263	<desc>Free amount of physical guest RAM.</desc>
8264	</param>
8265	<param name="memBalloon" type="unsigned long" dir="out">
8266	<desc>Amount of ballooned physical guest RAM.</desc>
8267	</param>
8268	<param name="memShared" type="unsigned long" dir="out">
8269	<desc>Amount of shared physical guest RAM.</desc>
8270	</param>
8271	<param name="memCache" type="unsigned long" dir="out">
8272	<desc>Total amount of guest (disk) cache memory.</desc>
8273	</param>
8274	<param name="pagedTotal" type="unsigned long" dir="out">
8275	<desc>Total amount of space in the page file.</desc>
8276	</param>
8277	<param name="memAllocTotal" type="unsigned long" dir="out">
8278	<desc>Total amount of memory allocated by the hypervisor.</desc>
8279	</param>
8280	<param name="memFreeTotal" type="unsigned long" dir="out">
8281	<desc>Total amount of free memory available in the hypervisor.</desc>
8282	</param>
8283	<param name="memBalloonTotal" type="unsigned long" dir="out">
8284	<desc>Total amount of memory ballooned by the hypervisor.</desc>
8285	</param>
8286	<param name="memSharedTotal" type="unsigned long" dir="out">
8287	<desc>Total amount of shared memory in the hypervisor.</desc>
8288	</param>
8289	</method>
8290
8291	<method name="getFacilityStatus">
8292	<desc>
8293	Get the current status of a Guest Additions facility.
8294	</desc>
8295	<param name="facility" type="AdditionsFacilityType" dir="in">
8296	<desc>Facility to check status for.</desc>
8297	</param>
8298	<param name="timestamp" type="long long" dir="out">
8299	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
8300	</param>
8301	<param name="status" type="AdditionsFacilityStatus" dir="return">
8302	<desc>The current (latest) facility status.</desc>
8303	</param>
8304	</method>
8305
8306	<method name="getAdditionsStatus">
8307	<desc>
8308	Retrieve the current status of a certain Guest Additions run level.
8309
8310	<result name="VBOX_E_NOT_SUPPORTED">
8311	Wrong status level specified.
8312	</result>
8313
8314	</desc>
8315	<param name="level" type="AdditionsRunLevelType" dir="in">
8316	<desc>Status level to check</desc>
8317	</param>
8318	<param name="active" type="boolean" dir="return">
8319	<desc>Flag whether the status level has been reached or not</desc>
8320	</param>
8321	</method>
8322
8323	<method name="setCredentials">
8324	<desc>
8325	Store login credentials that can be queried by guest operating
8326	systems with Additions installed. The credentials are transient
8327	to the session and the guest may also choose to erase them. Note
8328	that the caller cannot determine whether the guest operating system
8329	has queried or made use of the credentials.
8330
8331	<result name="VBOX_E_VM_ERROR">
8332	VMM device is not available.
8333	</result>
8334
8335	</desc>
8336	<param name="userName" type="wstring" dir="in">
8337	<desc>User name string, can be empty</desc>
8338	</param>
8339	<param name="password" type="wstring" dir="in">
8340	<desc>Password string, can be empty</desc>
8341	</param>
8342	<param name="domain" type="wstring" dir="in">
8343	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8344	</param>
8345	<param name="allowInteractiveLogon" type="boolean" dir="in">
8346	<desc>
8347	Flag whether the guest should alternatively allow the user to
8348	interactively specify different credentials. This flag might
8349	not be supported by all versions of the Additions.
8350	</desc>
8351	</param>
8352	</method>
8353
8354	<method name="executeProcess">
8355	<desc>
8356	Executes an existing program inside the guest VM.
8357
8358	<result name="VBOX_E_IPRT_ERROR">
8359	Could not execute process.
8360	</result>
8361
8362	</desc>
8363	<param name="execName" type="wstring" dir="in">
8364	<desc>
8365	Full path name of the command to execute on the guest; the
8366	commands has to exists in the guest VM in order to be executed.
8367	</desc>
8368	</param>
8369	<param name="flags" type="unsigned long" dir="in">
8370	<desc>
8371	<link to="ExecuteProcessFlag"/> flags.
8372	</desc>
8373	</param>
8374	<param name="arguments" type="wstring" safearray="yes" dir="in">
8375	<desc>
8376	Array of arguments passed to the execution command.
8377	</desc>
8378	</param>
8379	<param name="environment" type="wstring" safearray="yes" dir="in">
8380	<desc>
8381	Environment variables that can be set while the command is being
8382	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
8383	variable just set its name ("NAME") without a value.
8384	</desc>
8385	</param>
8386	<param name="userName" type="wstring" dir="in">
8387	<desc>
8388	User name under which the command will be executed; has to exist
8389	and have the appropriate rights to execute programs in the VM.
8390	</desc>
8391	</param>
8392	<param name="password" type="wstring" dir="in">
8393	<desc>
8394	Password of the user account specified.
8395	</desc>
8396	</param>
8397	<param name="timeoutMS" type="unsigned long" dir="in">
8398	<desc>
8399	The maximum timeout value (in msec) to wait for finished program
8400	execution. Pass 0 for an infinite timeout.
8401	</desc>
8402	</param>
8403	<param name="pid" type="unsigned long" dir="out">
8404	<desc>
8405	The PID (process ID) of the started command for later reference.
8406	</desc>
8407	</param>
8408	<param name="progress" type="IProgress" dir="return">
8409	<desc>Progress object to track the operation completion.</desc>
8410	</param>
8411	</method>
8412
8413	<method name="getProcessOutput">
8414	<desc>
8415	Retrieves output of a formerly started process.
8416
8417	<result name="VBOX_E_IPRT_ERROR">
8418	Could not retrieve output.
8419	</result>
8420
8421	</desc>
8422	<param name="pid" type="unsigned long" dir="in">
8423	<desc>
8424	Process id returned by earlier executeProcess() call.
8425	</desc>
8426	</param>
8427	<param name="flags" type="unsigned long" dir="in">
8428	<desc>
8429	Flags describing which output to retrieve.
8430	</desc>
8431	</param>
8432	<param name="timeoutMS" type="unsigned long" dir="in">
8433	<desc>
8434	The maximum timeout value (in msec) to wait for output
8435	data. Pass 0 for an infinite timeout.
8436	</desc>
8437	</param>
8438	<param name="size" type="long long" dir="in">
8439	<desc>
8440	Size in bytes to read in the buffer.
8441	</desc>
8442	</param>
8443	<param name="data" type="octet" dir="return" safearray="yes">
8444	<desc>
8445	Buffer for retrieving the actual output. A data size of 0 means end of file
8446	if the requested size was not 0. This is the unprocessed
8447	output data, i.e. the line ending style depends on the platform of
8448	the system the server is running on.
8449	</desc>
8450	</param>
8451	</method>
8452
8453	<method name="getProcessStatus">
8454	<desc>
8455	Retrieves status, exit code and the exit reason of a formerly started process.
8456
8457	<result name="VBOX_E_IPRT_ERROR">
8458	Process with specified PID was not found.
8459	</result>
8460
8461	</desc>
8462	<param name="pid" type="unsigned long" dir="in">
8463	<desc>
8464	Process id returned by earlier executeProcess() call.
8465	</desc>
8466	</param>
8467	<param name="exitcode" type="unsigned long" dir="out">
8468	<desc>
8469	The exit code (if available).
8470	</desc>
8471	</param>
8472	<param name="flags" type="unsigned long" dir="out">
8473	<desc>
8474	Additional flags of process status. Not used at the moment and
8475	must be set to 0.
8476	</desc>
8477	</param>
8478	<param name="reason" type="ExecuteProcessStatus" dir="return">
8479	<desc>
8480	The current process status.
8481	</desc>
8482	</param>
8483	</method>
8484
8485	<method name="copyToGuest">
8486	<desc>
8487	Copies files/directories from host to the guest.
8488
8489	<result name="VBOX_E_IPRT_ERROR">
8490	Error while copying.
8491	</result>
8492
8493	</desc>
8494	<param name="source" type="wstring" dir="in">
8495	<desc>
8496	Source file on the host to copy.
8497	</desc>
8498	</param>
8499	<param name="dest" type="wstring" dir="in">
8500	<desc>
8501	Destination path on the guest.
8502	</desc>
8503	</param>
8504	<param name="userName" type="wstring" dir="in">
8505	<desc>
8506	User name under which the copy command will be executed; the
8507	user has to exist and have the appropriate rights to write to
8508	the destination path.
8509	</desc>
8510	</param>
8511	<param name="password" type="wstring" dir="in">
8512	<desc>
8513	Password of the user account specified.
8514	</desc>
8515	</param>
8516	<param name="flags" type="unsigned long" dir="in">
8517	<desc>
8518	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
8519	</desc>
8520	</param>
8521	<param name="progress" type="IProgress" dir="return">
8522	<desc>Progress object to track the operation completion.</desc>
8523	</param>
8524	</method>
8525
8526	<method name="createDirectory">
8527	<desc>
8528	Creates a directory on the guest.
8529
8530	<result name="VBOX_E_IPRT_ERROR">
8531	Error while creating directory.
8532	</result>
8533
8534	</desc>
8535	<param name="directory" type="wstring" dir="in">
8536	<desc>
8537	Directory to create.
8538	</desc>
8539	</param>
8540	<param name="userName" type="wstring" dir="in">
8541	<desc>
8542	User name under which the directory creation will be executed; the
8543	user has to exist and have the appropriate rights to create the
8544	desired directory.
8545	</desc>
8546	</param>
8547	<param name="password" type="wstring" dir="in">
8548	<desc>
8549	Password of the user account specified.
8550	</desc>
8551	</param>
8552	<param name="mode" type="unsigned long" dir="in">
8553	<desc>
8554	File mode.
8555	</desc>
8556	</param>
8557	<param name="flags" type="unsigned long" dir="in">
8558	<desc>
8559	<link to="CreateDirectoryFlag"/> flags.
8560	</desc>
8561	</param>
8562	<param name="progress" type="IProgress" dir="return">
8563	<desc>Progress object to track the operation completion.</desc>
8564	</param>
8565	</method>
8566
8567	<method name="setProcessInput">
8568	<desc>
8569	Sends input into a formerly started process.
8570
8571	<result name="VBOX_E_IPRT_ERROR">
8572	Could not send input.
8573	</result>
8574
8575	</desc>
8576	<param name="pid" type="unsigned long" dir="in">
8577	<desc>
8578	Process id returned by earlier executeProcess() call.
8579	</desc>
8580	</param>
8581	<param name="flags" type="unsigned long" dir="in">
8582	<desc>
8583	<link to="ProcessInputFlag"/> flags.
8584	</desc>
8585	</param>
8586	<param name="timeoutMS" type="unsigned long" dir="in">
8587	<desc>
8588	The maximum timeout value (in msec) to wait for getting the
8589	data transfered to the guest. Pass 0 for an infinite timeout.
8590	</desc>
8591	</param>
8592	<param name="data" type="octet" dir="in" safearray="yes">
8593	<desc>
8594	Buffer of input data to send to the started process to.
8595	</desc>
8596	</param>
8597	<param name="written" type="unsigned long" dir="return">
8598	<desc>
8599	Number of bytes written.
8600	</desc>
8601	</param>
8602	</method>
8603
8604	<method name="updateGuestAdditions">
8605	<desc>
8606	Updates already installed Guest Additions in a VM
8607	(Windows guests only).
8608
8609	<result name="VBOX_E_IPRT_ERROR">
8610	Error while updating.
8611	</result>
8612
8613	</desc>
8614	<param name="source" type="wstring" dir="in">
8615	<desc>
8616	Path to the Guest Additions .ISO file to use for the upate.
8617	</desc>
8618	</param>
8619	<param name="flags" type="unsigned long" dir="in">
8620	<desc>
8621	<link to="AdditionsUpdateFlag"/> flags.
8622	</desc>
8623	</param>
8624	<param name="progress" type="IProgress" dir="return">
8625	<desc>Progress object to track the operation completion.</desc>
8626	</param>
8627	</method>
8628
8629	</interface>
8630
8631
8632	<!--
8633	// IProgress
8634	/////////////////////////////////////////////////////////////////////////
8635	-->
8636
8637	<interface
8638	name="IProgress" extends="$unknown"
8639	uuid="A163C98F-8635-4AA8-B770-A9941737F3EF"
8640	wsmap="managed"
8641	>
8642	<desc>
8643	The IProgress interface is used to track and control
8644	asynchronous tasks within VirtualBox.
8645
8646	An instance of this is returned every time VirtualBox starts
8647	an asynchronous task (in other words, a separate thread) which
8648	continues to run after a method call returns. For example,
8649	<link to="IConsole::saveState" />, which saves the state of
8650	a running virtual machine, can take a long time to complete.
8651	To be able to display a progress bar, a user interface such as
8652	the VirtualBox graphical user interface can use the IProgress
8653	object returned by that method.
8654
8655	Note that IProgress is a "read-only" interface in the sense
8656	that only the VirtualBox internals behind the Main API can
8657	create and manipulate progress objects, whereas client code
8658	can only use the IProgress object to monitor a task's
8659	progress and, if <link to="#cancelable" /> is @c true,
8660	cancel the task by calling <link to="#cancel" />.
8661
8662	A task represented by IProgress consists of either one or
8663	several sub-operations that run sequentially, one by one (see
8664	<link to="#operation" /> and <link to="#operationCount" />).
8665	Every operation is identified by a number (starting from 0)
8666	and has a separate description.
8667
8668	You can find the individual percentage of completion of the current
8669	operation in <link to="#operationPercent" /> and the
8670	percentage of completion of the task as a whole
8671	in <link to="#percent" />.
8672
8673	Similarly, you can wait for the completion of a particular
8674	operation via <link to="#waitForOperationCompletion" /> or
8675	for the completion of the whole task via
8676	<link to="#waitForCompletion" />.
8677	</desc>
8678
8679	<attribute name="id" type="uuid" mod="string" readonly="yes">
8680	<desc>ID of the task.</desc>
8681	</attribute>
8682
8683	<attribute name="description" type="wstring" readonly="yes">
8684	<desc>Description of the task.</desc>
8685	</attribute>
8686
8687	<attribute name="initiator" type="$unknown" readonly="yes">
8688	<desc>Initiator of the task.</desc>
8689	</attribute>
8690
8691	<attribute name="cancelable" type="boolean" readonly="yes">
8692	<desc>Whether the task can be interrupted.</desc>
8693	</attribute>
8694
8695	<attribute name="percent" type="unsigned long" readonly="yes">
8696	<desc>
8697	Current progress value of the task as a whole, in percent.
8698	This value depends on how many operations are already complete.
8699	Returns 100 if <link to="#completed" /> is @c true.
8700	</desc>
8701	</attribute>
8702
8703	<attribute name="timeRemaining" type="long" readonly="yes">
8704	<desc>
8705	Estimated remaining time until the task completes, in
8706	seconds. Returns 0 once the task has completed; returns -1
8707	if the remaining time cannot be computed, in particular if
8708	the current progress is 0.
8709
8710	Even if a value is returned, the estimate will be unreliable
8711	for low progress values. It will become more reliable as the
8712	task progresses; it is not recommended to display an ETA
8713	before at least 20% of a task have completed.
8714	</desc>
8715	</attribute>
8716
8717	<attribute name="completed" type="boolean" readonly="yes">
8718	<desc>Whether the task has been completed.</desc>
8719	</attribute>
8720
8721	<attribute name="canceled" type="boolean" readonly="yes">
8722	<desc>Whether the task has been canceled.</desc>
8723	</attribute>
8724
8725	<attribute name="resultCode" type="long" readonly="yes">
8726	<desc>
8727	Result code of the progress task.
8728	Valid only if <link to="#completed"/> is @c true.
8729	</desc>
8730	</attribute>
8731
8732	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8733	<desc>
8734	Extended information about the unsuccessful result of the
8735	progress operation. May be @c null if no extended information
8736	is available.
8737	Valid only if <link to="#completed"/> is @c true and
8738	<link to="#resultCode"/> indicates a failure.
8739	</desc>
8740	</attribute>
8741
8742	<attribute name="operationCount" type="unsigned long" readonly="yes">
8743	<desc>
8744	Number of sub-operations this task is divided into.
8745	Every task consists of at least one suboperation.
8746	</desc>
8747	</attribute>
8748
8749	<attribute name="operation" type="unsigned long" readonly="yes">
8750	<desc>Number of the sub-operation being currently executed.</desc>
8751	</attribute>
8752
8753	<attribute name="operationDescription" type="wstring" readonly="yes">
8754	<desc>
8755	Description of the sub-operation being currently executed.
8756	</desc>
8757	</attribute>
8758
8759	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8760	<desc>Progress value of the current sub-operation only, in percent.</desc>
8761	</attribute>
8762
8763	<attribute name="operationWeight" type="unsigned long" readonly="yes">
8764	<desc>Weight value of the current sub-operation only.</desc>
8765	</attribute>
8766
8767	<attribute name="timeout" type="unsigned long">
8768	<desc>
8769	When non-zero, this specifies the number of milliseconds after which
8770	the operation will automatically be canceled. This can only be set on
8771	cancelable objects.
8772	</desc>
8773	</attribute>
8774
8775	<method name="setCurrentOperationProgress">
8776	<desc>Internal method, not to be called externally.</desc>
8777	<param name="percent" type="unsigned long" dir="in" />
8778	</method>
8779	<method name="setNextOperation">
8780	<desc>Internal method, not to be called externally.</desc>
8781	<param name="nextOperationDescription" type="wstring" dir="in" />
8782	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8783	</method>
8784
8785	<method name="waitForCompletion">
8786	<desc>
8787	Waits until the task is done (including all sub-operations)
8788	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8789
8790	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
8791	thread are not processed while waiting. Neglecting event queues may
8792	have dire consequences (degrade performance, resource hogs,
8793	deadlocks, etc.), this is specially so for the main thread on
8794	platforms using XPCOM. Callers are adviced wait for short periods
8795	and service their event queues between calls, or to create a worker
8796	thread to do the waiting.
8797
8798	<result name="VBOX_E_IPRT_ERROR">
8799	Failed to wait for task completion.
8800	</result>
8801	</desc>
8802
8803	<param name="timeout" type="long" dir="in">
8804	<desc>
8805	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8806	</desc>
8807	</param>
8808	</method>
8809
8810	<method name="waitForOperationCompletion">
8811	<desc>
8812	Waits until the given operation is done with a given timeout in
8813	milliseconds; specify -1 for an indefinite wait.
8814
8815	See <link to="#waitForCompletion"> for event queue considerations.</link>
8816
8817	<result name="VBOX_E_IPRT_ERROR">
8818	Failed to wait for operation completion.
8819	</result>
8820
8821	</desc>
8822	<param name="operation" type="unsigned long" dir="in">
8823	<desc>
8824	Number of the operation to wait for.
8825	Must be less than <link to="#operationCount"/>.
8826	</desc>
8827	</param>
8828	<param name="timeout" type="long" dir="in">
8829	<desc>
8830	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8831	</desc>
8832	</param>
8833	</method>
8834
8835	<method name="cancel">
8836	<desc>
8837	Cancels the task.
8838	<note>
8839	If <link to="#cancelable"/> is @c false, then this method will fail.
8840	</note>
8841
8842	<result name="VBOX_E_INVALID_OBJECT_STATE">
8843	Operation cannot be canceled.
8844	</result>
8845
8846	</desc>
8847	</method>
8848
8849	</interface>
8850
8851	<!--
8852	// ISnapshot
8853	/////////////////////////////////////////////////////////////////////////
8854	-->
8855
8856	<interface
8857	name="ISnapshot" extends="$unknown"
8858	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8859	wsmap="managed"
8860	>
8861	<desc>
8862	The ISnapshot interface represents a snapshot of the virtual
8863	machine.
8864
8865	Together with the differencing media that are created
8866	when a snapshot is taken, a machine can be brought back to
8867	the exact state it was in when the snapshot was taken.
8868
8869	The ISnapshot interface has no methods, only attributes; snapshots
8870	are controlled through methods of the <link to="IConsole" /> interface
8871	which also manage the media associated with the snapshot.
8872	The following operations exist:
8873
8874	<ul>
8875	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
8876	by creating new, empty differencing images for the machine's
8877	media and saving the VM settings and (if the VM is running)
8878	the current VM state in the snapshot.
8879
8880	The differencing images will then receive all data written to
8881	the machine's media, while their parent (base) images
8882	remain unmodified after the snapshot has been taken (see
8883	<link to="IMedium" /> for details about differencing images).
8884	This simplifies restoring a machine to the state of a snapshot:
8885	only the differencing images need to be deleted.
8886
8887	The current machine state is not changed by taking a snapshot
8888	except that <link to="IMachine::currentSnapshot" /> is set to
8889	the newly created snapshot, which is also added to the machine's
8890	snapshots tree.
8891	</li>
8892
8893	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
8894	the state of a previous snapshot by deleting the differencing
8895	image of each of the machine's media and setting the machine's
8896	settings and state to the state that was saved in the snapshot (if any).
8897
8898	This destroys the machine's current state. After calling this,
8899	<link to="IMachine::currentSnapshot" /> points to the snapshot
8900	that was restored.
8901	</li>
8902
8903	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
8904	without affecting the current machine state.
8905
8906	This does not change the current machine state, but instead frees the
8907	resources allocated when the snapshot was taken: the settings and machine
8908	state file are deleted (if any), and the snapshot's differencing image for
8909	each of the machine's media gets merged with its parent image.
8910
8911	Neither the current machine state nor other snapshots are affected
8912	by this operation, except that parent media will be modified
8913	to contain the disk data associated with the snapshot being deleted.
8914
8915	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
8916	attribute is set to the current snapshot's parent or NULL if it
8917	has no parent. Otherwise the attribute is unchanged.
8918	</li>
8919	</ul>
8920
8921	Each snapshot contains a copy of virtual machine's settings (hardware
8922	configuration etc.). This copy is contained in an immutable (read-only)
8923	instance of <link to="IMachine" /> which is available from the snapshot's
8924	<link to="#machine" /> attribute. When restoring the snapshot, these
8925	settings are copied back to the original machine.
8926
8927	In addition, if the machine was running when the
8928	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8929	the current VM state is saved in the snapshot (similarly to what happens
8930	when a VM's state is saved). The snapshot is then said to be <i>online</i>
8931	because when restoring it, the VM will be running.
8932
8933	If the machine was in <link to="MachineState_Saved">saved</link> saved,
8934	the snapshot receives a copy of the execution state file
8935	(<link to="IMachine::stateFilePath"/>).
8936
8937	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8938	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8939	it then contains a so-called "zero execution state", representing a
8940	machine that is powered off.
8941	</desc>
8942
8943	<attribute name="id" type="uuid" mod="string" readonly="yes">
8944	<desc>UUID of the snapshot.</desc>
8945	</attribute>
8946
8947	<attribute name="name" type="wstring">
8948	<desc>Short name of the snapshot.
8949	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
8950	be called implicitly.</note>
8951	</desc>
8952	</attribute>
8953
8954	<attribute name="description" type="wstring">
8955	<desc>Optional description of the snapshot.
8956	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
8957	be called implicitly.</note>
8958	</desc>
8959	</attribute>
8960
8961	<attribute name="timeStamp" type="long long" readonly="yes">
8962	<desc>
8963	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8964	</desc>
8965	</attribute>
8966
8967	<attribute name="online" type="boolean" readonly="yes">
8968	<desc>
8969	@c true if this snapshot is an online snapshot and @c false otherwise.
8970
8971	When this attribute is @c true, the
8972	<link to="IMachine::stateFilePath"/> attribute of the
8973	<link to="#machine"/> object associated with this snapshot
8974	will point to the saved state file. Otherwise, it will be
8975	an empty string.
8976	</desc>
8977	</attribute>
8978
8979	<attribute name="machine" type="IMachine" readonly="yes">
8980	<desc>
8981	Virtual machine this snapshot is taken on. This object
8982	stores all settings the machine had when taking this snapshot.
8983	<note>
8984	The returned machine object is immutable, i.e. no
8985	any settings can be changed.
8986	</note>
8987	</desc>
8988	</attribute>
8989
8990	<attribute name="parent" type="ISnapshot" readonly="yes">
8991	<desc>
8992	Parent snapshot (a snapshot this one is based on), or
8993	@c null if the snapshot has no parent (i.e. is the first snapshot).
8994	</desc>
8995	</attribute>
8996
8997	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8998	<desc>
8999	Child snapshots (all snapshots having this one as a parent).
9000	By inspecting this attribute starting with a machine's root snapshot
9001	(which can be obtained by calling <link to="IMachine::findSnapshot" />
9002	with a @c null UUID), a machine's snapshots tree can be iterated over.
9003	</desc>
9004	</attribute>
9005
9006	</interface>
9007
9008
9009	<!--
9010	// IMedium
9011	/////////////////////////////////////////////////////////////////////////
9012	-->
9013
9014	<enum
9015	name="MediumState"
9016	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
9017	>
9018	<desc>
9019	Virtual medium state.
9020	<see>IMedium</see>
9021	</desc>
9022
9023	<const name="NotCreated" value="0">
9024	<desc>
9025	Associated medium storage does not exist (either was not created yet or
9026	was deleted).
9027	</desc>
9028	</const>
9029	<const name="Created" value="1">
9030	<desc>
9031	Associated storage exists and accessible; this gets set if the
9032	accessibility check performed by <link to="IMedium::refreshState" />
9033	was successful.
9034	</desc>
9035	</const>
9036	<const name="LockedRead" value="2">
9037	<desc>
9038	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
9039	no data modification is possible.
9040	</desc>
9041	</const>
9042	<const name="LockedWrite" value="3">
9043	<desc>
9044	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
9045	no concurrent data reading or modification is possible.
9046	</desc>
9047	</const>
9048	<const name="Inaccessible" value="4">
9049	<desc>
9050	Medium accessibility check (see <link to="IMedium::refreshState" />) has
9051	not yet been performed, or else, associated medium storage is not
9052	accessible. In the first case, <link to="IMedium::lastAccessError"/>
9053	is empty, in the second case, it describes the error that occurred.
9054	</desc>
9055	</const>
9056	<const name="Creating" value="5">
9057	<desc>
9058	Associated medium storage is being created.
9059	</desc>
9060	</const>
9061	<const name="Deleting" value="6">
9062	<desc>
9063	Associated medium storage is being deleted.
9064	</desc>
9065	</const>
9066	</enum>
9067
9068	<enum
9069	name="MediumType"
9070	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
9071	>
9072	<desc>
9073	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
9074	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
9075	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
9076	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
9077	</desc>
9078
9079	<const name="Normal" value="0">
9080	<desc>
9081	Normal medium (attached directly or indirectly, preserved
9082	when taking snapshots).
9083	</desc>
9084	</const>
9085	<const name="Immutable" value="1">
9086	<desc>
9087	Immutable medium (attached indirectly, changes are wiped out
9088	the next time the virtual machine is started).
9089	</desc>
9090	</const>
9091	<const name="Writethrough" value="2">
9092	<desc>
9093	Write through medium (attached directly, ignored when
9094	taking snapshots).
9095	</desc>
9096	</const>
9097	<const name="Shareable" value="3">
9098	<desc>
9099	Allow using this medium concurrently by several machines.
9100	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
9101	</desc>
9102	</const>
9103	<const name="Readonly" value="4">
9104	<desc>
9105	A readonly medium, which can of course be used by several machines.
9106	<note>Present and accepted since VirtualBox 4.0.</note>
9107	</desc>
9108	</const>
9109	<const name="MultiAttach" value="5">
9110	<desc>
9111	A medium which is is indirectly attached, so that one base medium can
9112	be used for several VMs which have their own differencing medium to
9113	store their modifications. In some sense a variant of Immutable
9114	with unset AutoReset flag in each differencing medium.
9115	<note>Present and accepted since VirtualBox 4.0.</note>
9116	</desc>
9117	</const>
9118	</enum>
9119
9120	<enum
9121	name="MediumVariant"
9122	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
9123	>
9124	<desc>
9125	Virtual medium image variant. More than one flag may be set.
9126	<see>IMedium</see>
9127	</desc>
9128
9129	<const name="Standard" value="0">
9130	<desc>
9131	No particular variant requested, results in using the backend default.
9132	</desc>
9133	</const>
9134	<const name="VmdkSplit2G" value="0x01">
9135	<desc>
9136	VMDK image split in chunks of less than 2GByte.
9137	</desc>
9138	</const>
9139	<const name="VmdkStreamOptimized" value="0x04">
9140	<desc>
9141	VMDK streamOptimized image. Special import/export format which is
9142	read-only/append-only.
9143	</desc>
9144	</const>
9145	<const name="VmdkESX" value="0x08">
9146	<desc>
9147	VMDK format variant used on ESX products.
9148	</desc>
9149	</const>
9150	<const name="Fixed" value="0x10000">
9151	<desc>
9152	Fixed image. Only allowed for base images.
9153	</desc>
9154	</const>
9155	<const name="Diff" value="0x20000">
9156	<desc>
9157	Differencing image. Only allowed for child images.
9158	</desc>
9159	</const>
9160	</enum>
9161
9162	<interface
9163	name="IMediumAttachment" extends="$unknown"
9164	uuid="aa4b4840-934f-454d-9a28-23e8f4235edf"
9165	wsmap="struct"
9166	>
9167	<desc>
9168	The IMediumAttachment interface links storage media to virtual machines.
9169	For each medium (<link to="IMedium"/>) which has been attached to a
9170	storage controller (<link to="IStorageController"/>) of a machine
9171	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
9172	method, one instance of IMediumAttachment is added to the machine's
9173	<link to="IMachine::mediumAttachments"/> array attribute.
9174
9175	Each medium attachment specifies the storage controller as well as a
9176	port and device number and the IMedium instance representing a virtual
9177	hard disk or floppy or DVD image.
9178
9179	For removable media (DVDs or floppies), there are two additional
9180	options. For one, the IMedium instance can be @c null to represent
9181	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
9182	secondly, the medium can be one of the pseudo-media for host drives
9183	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
9184
9185	<h3>Attaching Hard Disks</h3>
9186
9187	Hard disks are attached to virtual machines using the
9188	<link to="IMachine::attachDevice"/> method and detached using the
9189	<link to="IMachine::detachDevice"/> method. Depending on a medium's
9190	type (see <link to="IMedium::type" />), hard disks are attached either
9191	<i>directly</i> or <i>indirectly</i>.
9192
9193	When a hard disk is being attached directly, it is associated with the
9194	virtual machine and used for hard disk operations when the machine is
9195	running. When a hard disk is being attached indirectly, a new differencing
9196	hard disk linked to it is implicitly created and this differencing hard
9197	disk is associated with the machine and used for hard disk operations.
9198	This also means that if <link to="IMachine::attachDevice"/> performs
9199	a direct attachment then the same hard disk will be returned in response
9200	to the subsequent <link to="IMachine::getMedium"/> call; however if
9201	an indirect attachment is performed then
9202	<link to="IMachine::getMedium"/> will return the implicitly created
9203	differencing hard disk, not the original one passed to <link
9204	to="IMachine::attachDevice"/>. In detail:
9205
9206	<ul>
9207	<li><b>Normal base</b> hard disks that do not have children (i.e.
9208	differencing hard disks linked to them) and that are not already
9209	attached to virtual machines in snapshots are attached <b>directly</b>.
9210	Otherwise, they are attached <b>indirectly</b> because having
9211	dependent children or being part of the snapshot makes it impossible
9212	to modify hard disk contents without breaking the integrity of the
9213	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
9214	quickly determine the kind of the attachment for the given hard
9215	disk. Note that if a normal base hard disk is to be indirectly
9216	attached to a virtual machine with snapshots then a special
9217	procedure called <i>smart attachment</i> is performed (see below).</li>
9218	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
9219	they are attached <b>directly</b> if they do not have children and are
9220	not attached to virtual machines in snapshots, and <b>indirectly</b>
9221	otherwise. Note that the smart attachment procedure is never performed
9222	for differencing hard disks.</li>
9223	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
9224	they are designed to be non-writable. If an immutable hard disk is
9225	attached to a virtual machine with snapshots then a special
9226	procedure called smart attachment is performed (see below).</li>
9227	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
9228	also as designed. This also means that writethrough hard disks cannot
9229	have other hard disks linked to them at all.</li>
9230	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
9231	also as designed. This also means that shareable hard disks cannot
9232	have other hard disks linked to them at all. They behave almost
9233	like writethrough hard disks, except that shareable hard disks can
9234	be attached to several virtual machines which are running, allowing
9235	concurrent accesses. You need special cluster software running in
9236	the virtual machines to make use of such disks.</li>
9237	</ul>
9238
9239	Note that the same hard disk, regardless of its type, may be attached to
9240	more than one virtual machine at a time. In this case, the machine that is
9241	started first gains exclusive access to the hard disk and attempts to
9242	start other machines having this hard disk attached will fail until the
9243	first machine is powered down.
9244
9245	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
9246	that the given hard disk remains associated with the given machine after a
9247	successful <link to="IMachine::detachDevice"/> call until
9248	<link to="IMachine::saveSettings"/> is called to save all changes to
9249	machine settings to disk. This deferring is necessary to guarantee that
9250	the hard disk configuration may be restored at any time by a call to
9251	<link to="IMachine::discardSettings"/> before the settings
9252	are saved (committed).
9253
9254	Note that if <link to="IMachine::discardSettings"/> is called after
9255	indirectly attaching some hard disks to the machine but before a call to
9256	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
9257	all differencing hard disks implicitly created by
9258	<link to="IMachine::attachDevice"/> for these indirect attachments.
9259	Such implicitly created hard disks will also be immediately deleted when
9260	detached explicitly using the <link to="IMachine::detachDevice"/>
9261	call if it is made before <link to="IMachine::saveSettings"/>. This
9262	implicit deletion is safe because newly created differencing hard
9263	disks do not contain any user data.
9264
9265	However, keep in mind that detaching differencing hard disks that were
9266	implicitly created by <link to="IMachine::attachDevice"/>
9267	before the last <link to="IMachine::saveSettings"/> call will
9268	<b>not</b> implicitly delete them as they may already contain some data
9269	(for example, as a result of virtual machine execution). If these hard
9270	disks are no more necessary, the caller can always delete them explicitly
9271	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
9272	from this machine by the <link to="IMachine::saveSettings"/> call.
9273
9274	<h3>Smart Attachment</h3>
9275
9276	When normal base or immutable hard disks are indirectly attached to a
9277	virtual machine then some additional steps are performed to make sure the
9278	virtual machine will have the most recent "view" of the hard disk being
9279	attached. These steps include walking through the machine's snapshots
9280	starting from the current one and going through ancestors up to the first
9281	snapshot. Hard disks attached to the virtual machine in all
9282	of the encountered snapshots are checked whether they are descendants of
9283	the given normal base or immutable hard disk. The first found child (which
9284	is the differencing hard disk) will be used instead of the normal base or
9285	immutable hard disk as a parent for creating a new differencing hard disk
9286	that will be actually attached to the machine. And only if no descendants
9287	are found or if the virtual machine does not have any snapshots then the
9288	normal base or immutable hard disk will be used itself as a parent for
9289	this differencing hard disk.
9290
9291	It is easier to explain what smart attachment does using the
9292	following example:
9293	<pre>
9294	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9295
9296	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9297	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9298	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9299	Snapshot 4 (none) Snapshot 4 (none)
9300	CurState (none) CurState (D3->D2.vdi)
9301
9302	NOT
9303	...
9304	CurState (D3->B.vdi)
9305	</pre>
9306	The first column is the virtual machine configuration before the base hard
9307	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9308	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9309	mean that the hard disk that is actually attached to the machine is a
9310	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9311	another hard disk, <tt>B.vdi</tt>.
9312
9313	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9314	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9315	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9316	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9317	it cannot be attached directly and needs an indirect attachment (i.e.
9318	implicit creation of a new differencing hard disk). Due to the smart
9319	attachment procedure, the new differencing hard disk
9320	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9321	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9322	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9323	machine.
9324
9325	Note that if there is more than one descendant hard disk of the given base
9326	hard disk found in a snapshot, and there is an exact device, channel and
9327	bus match, then this exact match will be used. Otherwise, the youngest
9328	descendant will be picked up.
9329
9330	There is one more important aspect of the smart attachment procedure which
9331	is not related to snapshots at all. Before walking through the snapshots
9332	as described above, the backup copy of the current list of hard disk
9333	attachment is searched for descendants. This backup copy is created when
9334	the hard disk configuration is changed for the first time after the last
9335	<link to="IMachine::saveSettings"/> call and used by
9336	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9337	changes. When such a descendant is found in this backup copy, it will be
9338	simply re-attached back, without creating a new differencing hard disk for
9339	it. This optimization is necessary to make it possible to re-attach the
9340	base or immutable hard disk to a different bus, channel or device slot
9341	without losing the contents of the differencing hard disk actually
9342	attached to the machine in place of it.
9343
9344	</desc>
9345
9346	<attribute name="medium" type="IMedium" readonly="yes">
9347	<desc>Medium object associated with this attachment; it
9348	can be @c null for removable devices.</desc>
9349	</attribute>
9350
9351	<attribute name="controller" type="wstring" readonly="yes">
9352	<desc>Name of the storage controller of this attachment; this
9353	refers to one of the controllers in <link to="IMachine::storageControllers" />
9354	by name.</desc>
9355	</attribute>
9356
9357	<attribute name="port" type="long" readonly="yes">
9358	<desc>Port number of this attachment.
9359	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
9360	</desc>
9361	</attribute>
9362
9363	<attribute name="device" type="long" readonly="yes">
9364	<desc>Device slot number of this attachment.
9365	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
9366	</desc>
9367	</attribute>
9368
9369	<attribute name="type" type="DeviceType" readonly="yes">
9370	<desc>Device type of this attachment.</desc>
9371	</attribute>
9372
9373	<attribute name="passthrough" type="boolean" readonly="yes">
9374	<desc>Pass I/O requests through to a device on the host.</desc>
9375	</attribute>
9376
9377	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
9378	<desc>The bandwidth group this medium attachment is assigned to.</desc>
9379	</attribute>
9380
9381	</interface>
9382
9383	<interface
9384	name="IMedium" extends="$unknown"
9385	uuid="9edda847-1279-4b0a-9af7-9d66251ccc18"
9386	wsmap="managed"
9387	>
9388	<desc>
9389	The IMedium interface represents virtual storage for a machine's
9390	hard disks, CD/DVD or floppy drives. It will typically represent
9391	a disk image on the host, for example a VDI or VMDK file representing
9392	a virtual hard disk, or an ISO or RAW file representing virtual
9393	removable media, but can also point to a network location (e.g.
9394	for iSCSI targets).
9395
9396	Instances of IMedium are connected to virtual machines by way of medium
9397	attachments, which link the storage medium to a particular device slot
9398	of a storage controller of the virtual machine.
9399	In the VirtualBox API, virtual storage is therefore always represented
9400	by the following chain of object links:
9401
9402	<ul>
9403	<li><link to="IMachine::storageControllers"/> contains an array of
9404	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
9405	these are instances of <link to="IStorageController"/>).</li>
9406	<li><link to="IMachine::mediumAttachments"/> contains an array of
9407	medium attachments (instances of <link to="IMediumAttachment"/>
9408	created by <link to="IMachine::attachDevice" />),
9409	each containing a storage controller from the above array, a
9410	port/device specification, and an instance of IMedium representing
9411	the medium storage (image file).
9412
9413	For removable media, the storage medium is optional; a medium
9414	attachment with no medium represents a CD/DVD or floppy drive
9415	with no medium inserted. By contrast, hard disk attachments
9416	will always have an IMedium object attached.</li>
9417	<li>Each IMedium in turn points to a storage unit (such as a file
9418	on the host computer or a network resource) that holds actual
9419	data. This location is represented by the <link to="#location"/>
9420	attribute.</li>
9421	</ul>
9422
9423	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
9424	new hard disk media can be created with the VirtualBox API using the
9425	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
9426	disks (see below) are usually implicitly created by VirtualBox as
9427	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
9428	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
9429	should be created with external tools and then opened from within VirtualBox.
9430
9431	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
9432	drive. In that case the <link to="#id" /> attribute contains the UUID of
9433	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
9434
9435	<h3>Media registries</h3>
9436
9437	When a medium has been opened or created using one of the aforementioned
9438	APIs, it becomes "known" to VirtualBox. Known media can be attached
9439	to virtual machines and accessed through <link to="IVirtualBox::findMedium"/>.
9440	They also appear in the global
9441	<link to="IVirtualBox::hardDisks" />,
9442	<link to="IVirtualBox::DVDImages" /> and
9443	<link to="IVirtualBox::floppyImages" /> arrays.
9444
9445	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
9446	in the VirtualBox.xml file, which was shared between all machines and made
9447	transporting machines and their media from one host to another difficult.
9448
9449	Starting with VirtualBox 4.0, media are only added to a registry when they are
9450	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
9451	backwards compatibility, which registry a medium is added to depends on which
9452	VirtualBox version created a machine:
9453
9454	<ul>
9455	<li>If the medium has first been attached to a machine which was created by
9456	VirtualBox 4.0 or later, it is added to that machine's media registry in
9457	the machine XML settings file. This way all information about a machine's
9458	media attachments is contained in a single file and can be transported
9459	easily.</li>
9460	<li>For older media attachments (i.e. if the medium was first attached to a
9461	machine which was created with a VirtualBox version before 4.0), media
9462	continue to be registered in the global VirtualBox settings file, for
9463	backwards compatibility.</li>
9464	</ul>
9465
9466	See <link to="IVirtualBox::openMedium" /> for more information.
9467
9468	Media are removed from media registries by the <link to="#close"/>,
9469	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
9470
9471	<h3>Accessibility checks</h3>
9472
9473	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
9474	method is called explicitly on a medium. This is done to make the VirtualBox object
9475	ready for serving requests as fast as possible and let the end-user
9476	application decide if it needs to check media accessibility right away or not.
9477
9478	As a result, when VirtualBox starts up (e.g. the VirtualBox
9479	object gets created for the first time), all known media are in the
9480	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
9481	attribute is an empty string because no actual accessibility check has
9482	been made yet.
9483
9484	After calling <link to="#refreshState" />, a medium is considered
9485	<i>accessible</i> if its storage unit can be read. In that case, the
9486	<link to="#state"/> attribute has a value of "Created". If the storage
9487	unit cannot be read (for example, because it is located on a disconnected
9488	network resource, or was accidentally deleted outside VirtualBox),
9489	the medium is considered <i>inaccessible</i>, which is indicated by the
9490	"Inaccessible" state. The exact reason why the medium is inaccessible can be
9491	obtained by reading the <link to="#lastAccessError"/> attribute.
9492
9493	<h3>Medium types</h3>
9494
9495	There are five types of medium behavior which are stored in the
9496	<link to="#type"/> attribute (see <link to="MediumType" />) and
9497	which define the medium's behavior with attachments and snapshots.
9498
9499	All media can be also divided in two groups: <i>base</i> media and
9500	<i>differencing</i> media. A base medium contains all sectors of the
9501	medium data in its own storage and therefore can be used independently.
9502	In contrast, a differencing medium is a "delta" to some other medium and
9503	contains only those sectors which differ from that other medium, which is
9504	then called a <i>parent</i>. The differencing medium is said to be
9505	<i>linked to</i> that parent. The parent may be itself a differencing
9506	medium, thus forming a chain of linked media. The last element in that
9507	chain must always be a base medium. Note that several differencing
9508	media may be linked to the same parent medium.
9509
9510	Differencing media can be distinguished from base media by querying the
9511	<link to="#parent"/> attribute: base media do not have parents they would
9512	depend on, so the value of this attribute is always @c null for them.
9513	Using this attribute, it is possible to walk up the medium tree (from the
9514	child medium to its parent). It is also possible to walk down the tree
9515	using the <link to="#children"/> attribute.
9516
9517	Note that the type of all differencing media is "normal"; all other
9518	values are meaningless for them. Base media may be of any type.
9519
9520	<h3>Automatic composition of the file name part</h3>
9521
9522	Another extension to the <link to="IMedium::location"/> attribute is that
9523	there is a possibility to cause VirtualBox to compose a unique value for
9524	the file name part of the location using the UUID of the hard disk. This
9525	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
9526	e.g. before the storage unit is created, and works as follows. You set the
9527	value of the <link to="IMedium::location"/> attribute to a location
9528	specification which only contains the path specification but not the file
9529	name part and ends with either a forward slash or a backslash character.
9530	In response, VirtualBox will generate a new UUID for the hard disk and
9531	compose the file name using the following pattern:
9532	<pre>
9533	<path>/{<uuid>}.<ext>
9534	</pre>
9535	where <tt><path></tt> is the supplied path specification,
9536	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
9537	is the default extension for the storage format of this hard disk. After
9538	that, you may call any of the methods that create a new hard disk storage
9539	unit and they will use the generated UUID and file name.
9540	</desc>
9541
9542	<attribute name="id" type="uuid" mod="string" readonly="yes">
9543	<desc>
9544	UUID of the medium. For a newly created medium, this value is a randomly
9545	generated UUID.
9546
9547	<note>
9548	For media in one of MediumState_NotCreated, MediumState_Creating or
9549	MediumState_Deleting states, the value of this property is undefined
9550	and will most likely be an empty UUID.
9551	</note>
9552	</desc>
9553	</attribute>
9554
9555	<attribute name="description" type="wstring">
9556	<desc>
9557	Optional description of the medium. For a newly created medium the value
9558	of this attribute is an empty string.
9559
9560	Medium types that don't support this attribute will return E_NOTIMPL in
9561	attempt to get or set this attribute's value.
9562
9563	<note>
9564	For some storage types, reading this attribute may return an outdated
9565	(last known) value when <link to="#state"/> is <link
9566	to="MediumState_Inaccessible"/> or <link
9567	to="MediumState_LockedWrite"/> because the value of this attribute is
9568	stored within the storage unit itself. Also note that changing the
9569	attribute value is not possible in such case, as well as when the
9570	medium is the <link to="MediumState_LockedRead"/> state.
9571	</note>
9572	</desc>
9573	</attribute>
9574
9575	<attribute name="state" type="MediumState" readonly="yes">
9576	<desc>
9577	Returns the current medium state, which is the last state set by
9578	the accessibility check performed by <link to="#refreshState"/>.
9579	If that method has not yet been called on the medium, the state
9580	is "Inaccessible"; as opposed to truly inaccessible media, the
9581	value of <link to="#lastAccessError"/> will be an empty string in
9582	that case.
9583
9584	<note>As of version 3.1, this no longer performs an accessibility check
9585	automatically; call <link to="#refreshState"/> for that.
9586	</note>
9587	</desc>
9588	</attribute>
9589
9590	<attribute name="variant" type="unsigned long" readonly="yes">
9591	<desc>
9592	Returns the storage format variant information for this medium
9593	as a combination of the flags described at <link to="MediumVariant" />.
9594	Before <link to="#refreshState"/> is called this method returns
9595	an undefined value.
9596	</desc>
9597	</attribute>
9598
9599	<attribute name="location" type="wstring">
9600	<desc>
9601	Location of the storage unit holding medium data.
9602
9603	The format of the location string is medium type specific. For medium
9604	types using regular files in a host's file system, the location
9605	string is the full file name.
9606
9607	Some medium types may support changing the storage unit location by
9608	simply changing the value of this property. If this operation is not
9609	supported, the implementation will return E_NOTIMPL in attempt to set
9610	this attribute's value.
9611
9612	When setting a value of the location attribute which is a regular file
9613	in the host's file system, the given file name may be either relative to
9614	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9615	absolute. Note that if the given location specification does not contain
9616	the file extension part then a proper default extension will be
9617	automatically appended by the implementation depending on the medium type.
9618	</desc>
9619	</attribute>
9620
9621	<attribute name="name" type="wstring" readonly="yes">
9622	<desc>
9623	Name of the storage unit holding medium data.
9624
9625	The returned string is a short version of the <link to="#location"/>
9626	attribute that is suitable for representing the medium in situations
9627	where the full location specification is too long (such as lists
9628	and comboboxes in GUI frontends). This string is also used by frontends
9629	to sort the media list alphabetically when needed.
9630
9631	For example, for locations that are regular files in the host's file
9632	system, the value of this attribute is just the file name (+ extension),
9633	without the path specification.
9634
9635	Note that as opposed to the <link to="#location"/> attribute, the name
9636	attribute will not necessary be unique for a list of media of the
9637	given type and format.
9638	</desc>
9639	</attribute>
9640
9641	<attribute name="deviceType" type="DeviceType" readonly="yes">
9642	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9643	medium.</desc>
9644	</attribute>
9645
9646	<attribute name="hostDrive" type="boolean" readonly="yes">
9647	<desc>True if this corresponds to a drive on the host.</desc>
9648	</attribute>
9649
9650	<attribute name="size" type="long long" readonly="yes">
9651	<desc>
9652	Physical size of the storage unit used to hold medium data (in bytes).
9653
9654	<note>
9655	For media whose <link to="#state"/> is <link
9656	to="MediumState_Inaccessible"/>, the value of this property is the
9657	last known size. For <link to="MediumState_NotCreated"/> media,
9658	the returned value is zero.
9659	</note>
9660	</desc>
9661	</attribute>
9662
9663	<attribute name="format" type="wstring" readonly="yes">
9664	<desc>
9665	Storage format of this medium.
9666
9667	The value of this attribute is a string that specifies a backend used
9668	to store medium data. The storage format is defined when you create a
9669	new medium or automatically detected when you open an existing medium,
9670	and cannot be changed later.
9671
9672	The list of all storage formats supported by this VirtualBox
9673	installation can be obtained using
9674	<link to="ISystemProperties::mediumFormats"/>.
9675	</desc>
9676	</attribute>
9677
9678	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9679	<desc>
9680	Storage medium format object corresponding to this medium.
9681
9682	The value of this attribute is a reference to the medium format object
9683	that specifies the backend properties used to store medium data. The
9684	storage format is defined when you create a new medium or automatically
9685	detected when you open an existing medium, and cannot be changed later.
9686
9687	<note>@c null is returned if there is no associated medium format
9688	object. This can e.g. happen for medium objects representing host
9689	drives and other special medium objects.</note>
9690	</desc>
9691	</attribute>
9692
9693	<attribute name="type" type="MediumType">
9694	<desc>
9695	Type (role) of this medium.
9696
9697	The following constraints apply when changing the value of this
9698	attribute:
9699	<ul>
9700	<li>If a medium is attached to a virtual machine (either in the
9701	current state or in one of the snapshots), its type cannot be
9702	changed.
9703	</li>
9704	<li>As long as the medium has children, its type cannot be set
9705	to <link to="MediumType_Writethrough"/>.
9706	</li>
9707	<li>The type of all differencing media is
9708	<link to="MediumType_Normal"/> and cannot be changed.
9709	</li>
9710	</ul>
9711
9712	The type of a newly created or opened medium is set to
9713	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9714	which have a type of <link to="MediumType_Writethrough"/>.
9715	</desc>
9716	</attribute>
9717
9718	<attribute name="parent" type="IMedium" readonly="yes">
9719	<desc>
9720	Parent of this medium (the medium this medium is directly based
9721	on).
9722
9723	Only differencing media have parents. For base (non-differencing)
9724	media, @c null is returned.
9725	</desc>
9726	</attribute>
9727
9728	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9729	<desc>
9730	Children of this medium (all differencing media directly based
9731	on this medium). A @c null array is returned if this medium
9732	does not have any children.
9733	</desc>
9734	</attribute>
9735
9736	<attribute name="base" type="IMedium" readonly="yes">
9737	<desc>
9738	Base medium of this medium.
9739
9740	If this is a differencing medium, its base medium is the medium
9741	the given medium branch starts from. For all other types of media, this
9742	property returns the medium object itself (i.e. the same object this
9743	property is read on).
9744	</desc>
9745	</attribute>
9746
9747	<attribute name="readOnly" type="boolean" readonly="yes">
9748	<desc>
9749	Returns @c true if this medium is read-only and @c false otherwise.
9750
9751	A medium is considered to be read-only when its contents cannot be
9752	modified without breaking the integrity of other parties that depend on
9753	this medium such as its child media or snapshots of virtual machines
9754	where this medium is attached to these machines. If there are no
9755	children and no such snapshots then there is no dependency and the
9756	medium is not read-only.
9757
9758	The value of this attribute can be used to determine the kind of the
9759	attachment that will take place when attaching this medium to a
9760	virtual machine. If the value is @c false then the medium will
9761	be attached directly. If the value is @c true then the medium
9762	will be attached indirectly by creating a new differencing child
9763	medium for that. See the interface description for more information.
9764
9765	Note that all <link to="MediumType_Immutable">Immutable</link> media
9766	are always read-only while all
9767	<link to="MediumType_Writethrough">Writethrough</link> media are
9768	always not.
9769
9770	<note>
9771	The read-only condition represented by this attribute is related to
9772	the medium type and usage, not to the current
9773	<link to="IMedium::state">medium state</link> and not to the read-only
9774	state of the storage unit.
9775	</note>
9776	</desc>
9777	</attribute>
9778
9779	<attribute name="logicalSize" type="long long" readonly="yes">
9780	<desc>
9781	Logical size of this medium (in bytes), as reported to the
9782	guest OS running inside the virtual machine this medium is
9783	attached to. The logical size is defined when the medium is created
9784	and cannot be changed later.
9785
9786	<note>
9787	Reading this property on a differencing medium will return the size
9788	of its <link to="#base"/> medium.
9789	</note>
9790	<note>
9791	For media whose state is <link to="#state"/> is <link
9792	to="MediumState_Inaccessible"/>, the value of this property is the
9793	last known logical size. For <link to="MediumState_NotCreated"/>
9794	media, the returned value is zero.
9795	</note>
9796	</desc>
9797	</attribute>
9798
9799	<attribute name="autoReset" type="boolean">
9800	<desc>
9801	Whether this differencing medium will be automatically reset each
9802	time a virtual machine it is attached to is powered up. This
9803	attribute is automatically set to @c true for the last
9804	differencing image of an "immutable" medium (see
9805	<link to="MediumType" />).
9806
9807	See <link to="#reset"/> for more information about resetting
9808	differencing media.
9809
9810	<note>
9811	Reading this property on a base (non-differencing) medium will
9812	always @c false. Changing the value of this property in this
9813	case is not supported.
9814	</note>
9815
9816	<result name="VBOX_E_NOT_SUPPORTED">
9817	This is not a differencing medium (when changing the attribute
9818	value).
9819	</result>
9820	</desc>
9821	</attribute>
9822
9823	<attribute name="lastAccessError" type="wstring" readonly="yes">
9824	<desc>
9825	Text message that represents the result of the last accessibility
9826	check performed by <link to="#refreshState"/>.
9827
9828	An empty string is returned if the last accessibility check
9829	was successful or has not yet been called. As a result, if
9830	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9831	then <link to="#refreshState"/> has yet to be called; this is the
9832	default value of media after VirtualBox initialization.
9833	A non-empty string indicates a failure and should normally describe
9834	a reason of the failure (for example, a file read error).
9835	</desc>
9836	</attribute>
9837
9838	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9839	<desc>
9840	Array of UUIDs of all machines this medium is attached to.
9841
9842	A @c null array is returned if this medium is not attached to any
9843	machine or to any machine's snapshot.
9844
9845	<note>
9846	The returned array will include a machine even if this medium is not
9847	attached to that machine in the current state but attached to it in
9848	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9849	details.
9850	</note>
9851	</desc>
9852	</attribute>
9853
9854	<method name="setIDs">
9855	<desc>
9856	Changes the UUID and parent UUID for a hard disk medium.
9857	</desc>
9858	<param name="setImageId" type="boolean" dir="in">
9859	<desc>
9860	Select whether a new image UUID is set or not.
9861	</desc>
9862	</param>
9863	<param name="imageId" type="uuid" mod="string" dir="in">
9864	<desc>
9865	New UUID for the image. If an empty string is passed, then a new
9866	UUID is automatically created, provided that @a setImageId is @c true.
9867	Specifying a zero UUID is not allowed.
9868	</desc>
9869	</param>
9870	<param name="setParentId" type="boolean" dir="in">
9871	<desc>
9872	Select whether a new parent UUID is set or not.
9873	</desc>
9874	</param>
9875	<param name="parentId" type="uuid" mod="string" dir="in">
9876	<desc>
9877	New parent UUID for the image. If an empty string is passed, then a
9878	new UUID is automatically created, provided @a setParentId is
9879	@c true. A zero UUID is valid.
9880	</desc>
9881	</param>
9882	<result name="E_INVALIDARG">
9883	Invalid parameter combination.
9884	</result>
9885	<result name="VBOX_E_NOT_SUPPORTED">
9886	Medium is not a hard disk medium.
9887	</result>
9888	</method>
9889
9890	<method name="refreshState">
9891	<desc>
9892	If the current medium state (see <link to="MediumState"/>) is one of
9893	"Created", "Inaccessible" or "LockedRead", then this performs an
9894	accessibility check on the medium and sets the value of the <link to="#state"/>
9895	attribute accordingly; that value is also returned for convenience.
9896
9897	For all other state values, this does not perform a refresh but returns
9898	the state only.
9899
9900	The refresh, if performed, may take a long time (several seconds or even
9901	minutes, depending on the storage unit location and format) because it performs an
9902	accessibility check of the storage unit. This check may cause a significant
9903	delay if the storage unit of the given medium is, for example, a file located
9904	on a network share which is not currently accessible due to connectivity
9905	problems. In that case, the call will not return until a timeout
9906	interval defined by the host OS for this operation expires. For this reason,
9907	it is recommended to never read this attribute on the main UI thread to avoid
9908	making the UI unresponsive.
9909
9910	If the last known state of the medium is "Created" and the accessibility
9911	check fails, then the state would be set to "Inaccessible", and
9912	<link to="#lastAccessError"/> may be used to get more details about the
9913	failure. If the state of the medium is "LockedRead", then it remains the
9914	same, and a non-empty value of <link to="#lastAccessError"/> will
9915	indicate a failed accessibility check in this case.
9916
9917	Note that not all medium states are applicable to all medium types.
9918	</desc>
9919	<param name="state" type="MediumState" dir="return">
9920	<desc>
9921	New medium state.
9922	</desc>
9923	</param>
9924	</method>
9925
9926	<method name="getSnapshotIds">
9927	<desc>
9928	Returns an array of UUIDs of all snapshots of the given machine where
9929	this medium is attached to.
9930
9931	If the medium is attached to the machine in the current state, then the
9932	first element in the array will always be the ID of the queried machine
9933	(i.e. the value equal to the @c machineId argument), followed by
9934	snapshot IDs (if any).
9935
9936	If the medium is not attached to the machine in the current state, then
9937	the array will contain only snapshot IDs.
9938
9939	The returned array may be @c null if this medium is not attached
9940	to the given machine at all, neither in the current state nor in one of
9941	the snapshots.
9942	</desc>
9943	<param name="machineId" type="uuid" mod="string" dir="in">
9944	<desc>
9945	UUID of the machine to query.
9946	</desc>
9947	</param>
9948	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9949	<desc>
9950	Array of snapshot UUIDs of the given machine using this medium.
9951	</desc>
9952	</param>
9953	</method>
9954
9955	<method name="lockRead">
9956	<desc>
9957	Locks this medium for reading.
9958
9959	A read lock is shared: many clients can simultaneously lock the
9960	same medium for reading unless it is already locked for writing (see
9961	<link to="#lockWrite"/>) in which case an error is returned.
9962
9963	When the medium is locked for reading, it cannot be modified
9964	from within VirtualBox. This means that any method that changes
9965	the properties of this medium or contents of the storage unit
9966	will return an error (unless explicitly stated otherwise). That
9967	includes an attempt to start a virtual machine that wants to
9968	write to the the medium.
9969
9970	When the virtual machine is started up, it locks for reading all
9971	media it uses in read-only mode. If some medium cannot be locked
9972	for reading, the startup procedure will fail.
9973	A medium is typically locked for reading while it is used by a running
9974	virtual machine but has a depending differencing image that receives
9975	the actual write operations. This way one base medium can have
9976	multiple child differencing images which can be written to
9977	simultaneously. Read-only media such as DVD and floppy images are
9978	also locked for reading only (so they can be in use by multiple
9979	machines simultaneously).
9980
9981	A medium is also locked for reading when it is the source of a
9982	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9983
9984	The medium locked for reading must be unlocked using the <link
9985	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9986	can be nested and must be followed by the same number of paired
9987	<link to="#unlockRead"/> calls.
9988
9989	This method sets the medium state (see <link to="#state"/>) to
9990	"LockedRead" on success. The medium's previous state must be
9991	one of "Created", "Inaccessible" or "LockedRead".
9992
9993	Locking an inaccessible medium is not an error; this method performs
9994	a logical lock that prevents modifications of this medium through
9995	the VirtualBox API, not a physical file-system lock of the underlying
9996	storage unit.
9997
9998	This method returns the current state of the medium
9999	<i>before</i> the operation.
10000
10001	<result name="VBOX_E_INVALID_OBJECT_STATE">
10002	Invalid medium state (e.g. not created, locked, inaccessible,
10003	creating, deleting).
10004	</result>
10005
10006	</desc>
10007	<param name="state" type="MediumState" dir="return">
10008	<desc>
10009	State of the medium after the operation.
10010	</desc>
10011	</param>
10012	</method>
10013
10014	<method name="unlockRead">
10015	<desc>
10016	Cancels the read lock previously set by <link to="#lockRead"/>.
10017
10018	For both success and failure, this method returns the current state
10019	of the medium <i>after</i> the operation.
10020
10021	See <link to="#lockRead"/> for more details.
10022
10023	<result name="VBOX_E_INVALID_OBJECT_STATE">
10024	Medium not locked for reading.
10025	</result>
10026
10027	</desc>
10028	<param name="state" type="MediumState" dir="return">
10029	<desc>
10030	State of the medium after the operation.
10031	</desc>
10032	</param>
10033	</method>
10034
10035	<method name="lockWrite">
10036	<desc>
10037	Locks this medium for writing.
10038
10039	A write lock, as opposed to <link to="#lockRead"/>, is
10040	exclusive: there may be only one client holding a write lock,
10041	and there may be no read locks while the write lock is held.
10042	As a result, read-locking fails if a write lock is held, and
10043	write-locking fails if either a read or another write lock is held.
10044
10045	When a medium is locked for writing, it cannot be modified
10046	from within VirtualBox, and it is not guaranteed that the values
10047	of its properties are up-to-date. Any method that changes the
10048	properties of this medium or contents of the storage unit will
10049	return an error (unless explicitly stated otherwise).
10050
10051	When a virtual machine is started up, it locks for writing all
10052	media it uses to write data to. If any medium could not be locked
10053	for writing, the startup procedure will fail. If a medium has
10054	differencing images, then while the machine is running, only
10055	the last ("leaf") differencing image is locked for writing,
10056	whereas its parents are locked for reading only.
10057
10058	A medium is also locked for writing when it is the target of a
10059	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
10060
10061	The medium locked for writing must be unlocked using the <link
10062	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
10063
10064	This method sets the medium state (see <link to="#state"/>) to
10065	"LockedWrite" on success. The medium's previous state must be
10066	either "Created" or "Inaccessible".
10067
10068	Locking an inaccessible medium is not an error; this method performs
10069	a logical lock that prevents modifications of this medium through
10070	the VirtualBox API, not a physical file-system lock of the underlying
10071	storage unit.
10072
10073	For both, success and failure, this method returns the current
10074	state of the medium <i>before</i> the operation.
10075
10076	<result name="VBOX_E_INVALID_OBJECT_STATE">
10077	Invalid medium state (e.g. not created, locked, inaccessible,
10078	creating, deleting).
10079	</result>
10080
10081	</desc>
10082	<param name="state" type="MediumState" dir="return">
10083	<desc>
10084	State of the medium after the operation.
10085	</desc>
10086	</param>
10087	</method>
10088
10089	<method name="unlockWrite">
10090	<desc>
10091	Cancels the write lock previously set by <link to="#lockWrite"/>.
10092
10093	For both success and failure, this method returns the current
10094	state of the medium <i>after</i> the operation.
10095
10096	See <link to="#lockWrite"/> for more details.
10097
10098	<result name="VBOX_E_INVALID_OBJECT_STATE">
10099	Medium not locked for writing.
10100	</result>
10101
10102	</desc>
10103	<param name="state" type="MediumState" dir="return">
10104	<desc>
10105	State of the medium after the operation.
10106	</desc>
10107	</param>
10108	</method>
10109
10110	<method name="close">
10111	<desc>
10112	Closes this medium.
10113
10114	The medium must not be attached to any known virtual machine
10115	and must not have any known child media, otherwise the
10116	operation will fail.
10117
10118	When the medium is successfully closed, it is removed from
10119	the list of registered media, but its storage unit is not
10120	deleted. In particular, this means that this medium can
10121	later be opened again using the <link to="IVirtualBox::openMedium"/>
10122	call.
10123
10124	Note that after this method successfully returns, the given medium
10125	object becomes uninitialized. This means that any attempt
10126	to call any of its methods or attributes will fail with the
10127	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
10128
10129	<result name="VBOX_E_INVALID_OBJECT_STATE">
10130	Invalid medium state (other than not created, created or
10131	inaccessible).
10132	</result>
10133	<result name="VBOX_E_OBJECT_IN_USE">
10134	Medium attached to virtual machine.
10135	</result>
10136	<result name="VBOX_E_FILE_ERROR">
10137	Settings file not accessible.
10138	</result>
10139	<result name="VBOX_E_XML_ERROR">
10140	Could not parse the settings file.
10141	</result>
10142
10143	</desc>
10144	</method>
10145
10146	<!-- storage methods -->
10147
10148	<method name="getProperty">
10149	<desc>
10150	Returns the value of the custom medium property with the given name.
10151
10152	The list of all properties supported by the given medium format can
10153	be obtained with <link to="IMediumFormat::describeProperties"/>.
10154
10155	Note that if this method returns an empty string in @a value, the
10156	requested property is supported but currently not assigned any value.
10157
10158	<result name="VBOX_E_OBJECT_NOT_FOUND">
10159	Requested property does not exist (not supported by the format).
10160	</result>
10161	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10162	</desc>
10163	<param name="name" type="wstring" dir="in">
10164	<desc>Name of the property to get.</desc>
10165	</param>
10166	<param name="value" type="wstring" dir="return">
10167	<desc>Current property value.</desc>
10168	</param>
10169	</method>
10170
10171	<method name="setProperty">
10172	<desc>
10173	Sets the value of the custom medium property with the given name.
10174
10175	The list of all properties supported by the given medium format can
10176	be obtained with <link to="IMediumFormat::describeProperties"/>.
10177
10178	Note that setting the property value to @c null or an empty string is
10179	equivalent to deleting the existing value. A default value (if it is
10180	defined for this property) will be used by the format backend in this
10181	case.
10182
10183	<result name="VBOX_E_OBJECT_NOT_FOUND">
10184	Requested property does not exist (not supported by the format).
10185	</result>
10186	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10187	</desc>
10188	<param name="name" type="wstring" dir="in">
10189	<desc>Name of the property to set.</desc>
10190	</param>
10191	<param name="value" type="wstring" dir="in">
10192	<desc>Property value to set.</desc>
10193	</param>
10194	</method>
10195
10196	<method name="getProperties">
10197	<desc>
10198	Returns values for a group of properties in one call.
10199
10200	The names of the properties to get are specified using the @a names
10201	argument which is a list of comma-separated property names or
10202	an empty string if all properties are to be returned. Note that currently
10203	the value of this argument is ignored and the method always returns all
10204	existing properties.
10205
10206	The list of all properties supported by the given medium format can
10207	be obtained with <link to="IMediumFormat::describeProperties"/>.
10208
10209	The method returns two arrays, the array of property names corresponding
10210	to the @a names argument and the current values of these properties.
10211	Both arrays have the same number of elements with each elemend at the
10212	given index in the first array corresponds to an element at the same
10213	index in the second array.
10214
10215	Note that for properties that do not have assigned values,
10216	an empty string is returned at the appropriate index in the
10217	@a returnValues array.
10218
10219	</desc>
10220	<param name="names" type="wstring" dir="in">
10221	<desc>
10222	Names of properties to get.
10223	</desc>
10224	</param>
10225	<param name="returnNames" type="wstring" safearray="yes" dir="out">
10226	<desc>Names of returned properties.</desc>
10227	</param>
10228	<param name="returnValues" type="wstring" safearray="yes" dir="return">
10229	<desc>Values of returned properties.</desc>
10230	</param>
10231	</method>
10232
10233	<method name="setProperties">
10234	<desc>
10235	Sets values for a group of properties in one call.
10236
10237	The names of the properties to set are passed in the @a names
10238	array along with the new values for them in the @a values array. Both
10239	arrays have the same number of elements with each elemend at the given
10240	index in the first array corresponding to an element at the same index
10241	in the second array.
10242
10243	If there is at least one property name in @a names that is not valid,
10244	the method will fail before changing the values of any other properties
10245	from the @a names array.
10246
10247	Using this method over <link to="#setProperty"/> is preferred if you
10248	need to set several properties at once since it will result into less
10249	IPC calls.
10250
10251	The list of all properties supported by the given medium format can
10252	be obtained with <link to="IMediumFormat::describeProperties"/>.
10253
10254	Note that setting the property value to @c null or an empty string is
10255	equivalent to deleting the existing value. A default value (if it is
10256	defined for this property) will be used by the format backend in this
10257	case.
10258	</desc>
10259	<param name="names" type="wstring" safearray="yes" dir="in">
10260	<desc>Names of properties to set.</desc>
10261	</param>
10262	<param name="values" type="wstring" safearray="yes" dir="in">
10263	<desc>Values of properties to set.</desc>
10264	</param>
10265	</method>
10266
10267	<!-- storage methods -->
10268
10269	<method name="createBaseStorage">
10270	<desc>
10271	Starts creating a hard disk storage unit (fixed/dynamic, according
10272	to the variant flags) in in the background. The previous storage unit
10273	created for this object, if any, must first be deleted using
10274	<link to="#deleteStorage"/>, otherwise the operation will fail.
10275
10276	Before the operation starts, the medium is placed in
10277	<link to="MediumState_Creating"/> state. If the create operation
10278	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
10279	state.
10280
10281	After the returned progress object reports that the operation has
10282	successfully completed, the medium state will be set to <link
10283	to="MediumState_Created"/>, the medium will be remembered by this
10284	VirtualBox installation and may be attached to virtual machines.
10285
10286	<result name="VBOX_E_NOT_SUPPORTED">
10287	The variant of storage creation operation is not supported. See <link
10288	to="IMediumFormat::capabilities"/>.
10289	</result>
10290	</desc>
10291	<param name="logicalSize" type="long long" dir="in">
10292	<desc>Maximum logical size of the medium in bytes.</desc>
10293	</param>
10294	<param name="variant" type="unsigned long" dir="in">
10295	<desc>Exact image variant which should be created (as a combination of
10296	<link to="MediumVariant" /> flags).</desc>
10297	</param>
10298	<param name="progress" type="IProgress" dir="return">
10299	<desc>Progress object to track the operation completion.</desc>
10300	</param>
10301	</method>
10302
10303	<method name="deleteStorage">
10304	<desc>
10305	Starts deleting the storage unit of this medium.
10306
10307	The medium must not be attached to any known virtual machine and must
10308	not have any known child media, otherwise the operation will fail.
10309	It will also fail if there is no storage unit to delete or if deletion
10310	is already in progress, or if the medium is being in use (locked for
10311	read or for write) or inaccessible. Therefore, the only valid state for
10312	this operation to succeed is <link to="MediumState_Created"/>.
10313
10314	Before the operation starts, the medium is placed in
10315	<link to="MediumState_Deleting"/> state and gets removed from the list
10316	of remembered hard disks (media registry). If the delete operation
10317	fails, the medium will be remembered again and placed back to
10318	<link to="MediumState_Created"/> state.
10319
10320	After the returned progress object reports that the operation is
10321	complete, the medium state will be set to
10322	<link to="MediumState_NotCreated"/> and you will be able to use one of
10323	the storage creation methods to create it again.
10324
10325	<see>#close()</see>
10326
10327	<result name="VBOX_E_OBJECT_IN_USE">
10328	Medium is attached to a virtual machine.
10329	</result>
10330	<result name="VBOX_E_NOT_SUPPORTED">
10331	Storage deletion is not allowed because neither of storage creation
10332	operations are supported. See
10333	<link to="IMediumFormat::capabilities"/>.
10334	</result>
10335
10336	<note>
10337	If the deletion operation fails, it is not guaranteed that the storage
10338	unit still exists. You may check the <link to="IMedium::state"/> value
10339	to answer this question.
10340	</note>
10341	</desc>
10342	<param name="progress" type="IProgress" dir="return">
10343	<desc>Progress object to track the operation completion.</desc>
10344	</param>
10345	</method>
10346
10347	<!-- diff methods -->
10348
10349	<method name="createDiffStorage">
10350	<desc>
10351	Starts creating an empty differencing storage unit based on this
10352	medium in the format and at the location defined by the @a target
10353	argument.
10354
10355	The target medium must be in <link to="MediumState_NotCreated"/>
10356	state (i.e. must not have an existing storage unit). Upon successful
10357	completion, this operation will set the type of the target medium to
10358	<link to="MediumType_Normal"/> and create a storage unit necessary to
10359	represent the differencing medium data in the given format (according
10360	to the storage format of the target object).
10361
10362	After the returned progress object reports that the operation is
10363	successfully complete, the target medium gets remembered by this
10364	VirtualBox installation and may be attached to virtual machines.
10365
10366	<note>
10367	The medium will be set to <link to="MediumState_LockedRead"/>
10368	state for the duration of this operation.
10369	</note>
10370	<result name="VBOX_E_OBJECT_IN_USE">
10371	Medium not in @c NotCreated state.
10372	</result>
10373	</desc>
10374	<param name="target" type="IMedium" dir="in">
10375	<desc>Target medium.</desc>
10376	</param>
10377	<param name="variant" type="unsigned long" dir="in">
10378	<desc>Exact image variant which should be created (as a combination of
10379	<link to="MediumVariant" /> flags).</desc>
10380	</param>
10381	<param name="progress" type="IProgress" dir="return">
10382	<desc>Progress object to track the operation completion.</desc>
10383	</param>
10384	</method>
10385
10386	<method name="mergeTo">
10387	<desc>
10388	Starts merging the contents of this medium and all intermediate
10389	differencing media in the chain to the given target medium.
10390
10391	The target medium must be either a descendant of this medium or
10392	its ancestor (otherwise this method will immediately return a failure).
10393	It follows that there are two logical directions of the merge operation:
10394	from ancestor to descendant (<i>forward merge</i>) and from descendant to
10395	ancestor (<i>backward merge</i>). Let us consider the following medium
10396	chain:
10397
10398	<pre>Base <- Diff_1 <- Diff_2</pre>
10399
10400	Here, calling this method on the <tt>Base</tt> medium object with
10401	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
10402	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
10403	merge. Note that in both cases the contents of the resulting medium
10404	will be the same, the only difference is the medium object that takes
10405	the result of the merge operation. In case of the forward merge in the
10406	above example, the result will be written to <tt>Diff_2</tt>; in case of
10407	the backward merge, the result will be written to <tt>Base</tt>. In
10408	other words, the result of the operation is always stored in the target
10409	medium.
10410
10411	Upon successful operation completion, the storage units of all media in
10412	the chain between this (source) medium and the target medium, including
10413	the source medium itself, will be automatically deleted and the
10414	relevant medium objects (including this medium) will become
10415	uninitialized. This means that any attempt to call any of
10416	their methods or attributes will fail with the
10417	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
10418	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
10419	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
10420	Note that <tt>Diff_2</tt> in this case will become a base medium
10421	itself since it will no longer be based on any other medium.
10422
10423	Considering the above, all of the following conditions must be met in
10424	order for the merge operation to succeed:
10425	<ul>
10426	<li>
10427	Neither this (source) medium nor any intermediate
10428	differencing medium in the chain between it and the target
10429	medium is attached to any virtual machine.
10430	</li>
10431	<li>
10432	Neither the source medium nor the target medium is an
10433	<link to="MediumType_Immutable"/> medium.
10434	</li>
10435	<li>
10436	The part of the medium tree from the source medium to the
10437	target medium is a linear chain, i.e. all medium in this
10438	chain have exactly one child which is the next medium in this
10439	chain. The only exception from this rule is the target medium in
10440	the forward merge operation; it is allowed to have any number of
10441	child media because the merge operation will not change its
10442	logical contents (as it is seen by the guest OS or by children).
10443	</li>
10444	<li>
10445	None of the involved media are in
10446	<link to="MediumState_LockedRead"/> or
10447	<link to="MediumState_LockedWrite"/> state.
10448	</li>
10449	</ul>
10450
10451	<note>
10452	This (source) medium and all intermediates will be placed to <link
10453	to="MediumState_Deleting"/> state and the target medium will be
10454	placed to <link to="MediumState_LockedWrite"/> state and for the
10455	duration of this operation.
10456	</note>
10457	</desc>
10458	<param name="target" type="IMedium" dir="in">
10459	<desc>Target medium.</desc>
10460	</param>
10461	<param name="progress" type="IProgress" dir="return">
10462	<desc>Progress object to track the operation completion.</desc>
10463	</param>
10464	</method>
10465
10466	<!-- clone method -->
10467
10468	<method name="cloneTo">
10469	<desc>
10470	Starts creating a clone of this medium in the format and at the
10471	location defined by the @a target argument.
10472
10473	The target medium must be either in <link to="MediumState_NotCreated"/>
10474	state (i.e. must not have an existing storage unit) or in
10475	<link to="MediumState_Created"/> state (i.e. created and not locked, and
10476	big enough to hold the data or else the copy will be partial). Upon
10477	successful completion, the cloned medium will contain exactly the
10478	same sector data as the medium being cloned, except that in the
10479	first case a new UUID for the clone will be randomly generated, and in
10480	the second case the UUID will remain unchanged.
10481
10482	The @a parent argument defines which medium will be the parent
10483	of the clone. Passing a @c null reference indicates that the clone will
10484	be a base image, i.e. completely independent. It is possible to specify
10485	an arbitrary medium for this parameter, including the parent of the
10486	medium which is being cloned. Even cloning to a child of the source
10487	medium is possible. Note that when cloning to an existing image, the
10488	@a parent irgument is ignored.
10489
10490	After the returned progress object reports that the operation is
10491	successfully complete, the target medium gets remembered by this
10492	VirtualBox installation and may be attached to virtual machines.
10493
10494	<note>
10495	This medium will be placed to <link to="MediumState_LockedRead"/>
10496	state for the duration of this operation.
10497	</note>
10498	<result name="E_NOTIMPL">
10499	The specified cloning variant is not supported at the moment.
10500	</result>
10501	</desc>
10502	<param name="target" type="IMedium" dir="in">
10503	<desc>Target medium.</desc>
10504	</param>
10505	<param name="variant" type="unsigned long" dir="in">
10506	<desc>Exact image variant which should be created (as a combination of
10507	<link to="MediumVariant" /> flags).</desc>
10508	</param>
10509	<param name="parent" type="IMedium" dir="in">
10510	<desc>Parent of the cloned medium.</desc>
10511	</param>
10512	<param name="progress" type="IProgress" dir="return">
10513	<desc>Progress object to track the operation completion.</desc>
10514	</param>
10515	</method>
10516
10517	<!-- other methods -->
10518
10519	<method name="compact">
10520	<desc>
10521	Starts compacting of this medium. This means that the medium is
10522	transformed into a possibly more compact storage representation.
10523	This potentially creates temporary images, which can require a
10524	substantial amount of additional disk space.
10525
10526	This medium will be placed to <link to="MediumState_LockedWrite"/>
10527	state and all its parent media (if any) will be placed to
10528	<link to="MediumState_LockedRead"/> state for the duration of this
10529	operation.
10530
10531	Please note that the results can be either returned straight away,
10532	or later as the result of the background operation via the object
10533	returned via the @a progress parameter.
10534
10535	<result name="VBOX_E_NOT_SUPPORTED">
10536	Medium format does not support compacting (but potentially
10537	needs it).
10538	</result>
10539	</desc>
10540	<param name="progress" type="IProgress" dir="return">
10541	<desc>Progress object to track the operation completion.</desc>
10542	</param>
10543	</method>
10544
10545	<method name="resize">
10546	<desc>
10547	Starts resizing this medium. This means that the nominal size of the
10548	medium is set to the new value. Both increasing and decreasing the
10549	size is possible, and there are no safety checks, since VirtualBox
10550	does not make any assumptions about the medium contents.
10551
10552	Resizing usually needs additional disk space, and possibly also
10553	some temporary disk space. Note that resize does not create a full
10554	temporary copy of the medium, so the additional disk space requirement
10555	is usually much lower than using the clone operation.
10556
10557	This medium will be placed to <link to="MediumState_LockedWrite"/>
10558	state for the duration of this operation.
10559
10560	Please note that the results can be either returned straight away,
10561	or later as the result of the background operation via the object
10562	returned via the @a progress parameter.
10563
10564	<result name="VBOX_E_NOT_SUPPORTED">
10565	Medium format does not support resizing.
10566	</result>
10567	</desc>
10568	<param name="logicalSize" type="long long" dir="in">
10569	<desc>New nominal capacity of the medium in bytes.</desc>
10570	</param>
10571	<param name="progress" type="IProgress" dir="return">
10572	<desc>Progress object to track the operation completion.</desc>
10573	</param>
10574	</method>
10575
10576	<method name="reset">
10577	<desc>
10578	Starts erasing the contents of this differencing medium.
10579
10580	This operation will reset the differencing medium to its initial
10581	state when it does not contain any sector data and any read operation is
10582	redirected to its parent medium. This automatically gets called
10583	during VM power-up for every medium whose <link to="#autoReset" />
10584	attribute is @c true.
10585
10586	The medium will be write-locked for the duration of this operation (see
10587	<link to="#lockWrite" />).
10588
10589	<result name="VBOX_E_NOT_SUPPORTED">
10590	This is not a differencing medium.
10591	</result>
10592	<result name="VBOX_E_INVALID_OBJECT_STATE">
10593	Medium is not in <link to="MediumState_Created"/> or
10594	<link to="MediumState_Inaccessible"/> state.
10595	</result>
10596	</desc>
10597	<param name="progress" type="IProgress" dir="return">
10598	<desc>Progress object to track the operation completion.</desc>
10599	</param>
10600	</method>
10601
10602	</interface>
10603
10604
10605	<!--
10606	// IMediumFormat
10607	/////////////////////////////////////////////////////////////////////////
10608	-->
10609
10610	<enum
10611	name="DataType"
10612	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10613	>
10614	<const name="Int32" value="0"/>
10615	<const name="Int8" value="1"/>
10616	<const name="String" value="2"/>
10617	</enum>
10618
10619	<enum
10620	name="DataFlags"
10621	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10622	>
10623	<const name="None" value="0x00"/>
10624	<const name="Mandatory" value="0x01"/>
10625	<const name="Expert" value="0x02"/>
10626	<const name="Array" value="0x04"/>
10627	<const name="FlagMask" value="0x07"/>
10628	</enum>
10629
10630	<enum
10631	name="MediumFormatCapabilities"
10632	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
10633	>
10634	<desc>
10635	Medium format capability flags.
10636	</desc>
10637
10638	<const name="Uuid" value="0x01">
10639	<desc>
10640	Supports UUIDs as expected by VirtualBox code.
10641	</desc>
10642	</const>
10643
10644	<const name="CreateFixed" value="0x02">
10645	<desc>
10646	Supports creating fixed size images, allocating all space instantly.
10647	</desc>
10648	</const>
10649
10650	<const name="CreateDynamic" value="0x04">
10651	<desc>
10652	Supports creating dynamically growing images, allocating space on
10653	demand.
10654	</desc>
10655	</const>
10656
10657	<const name="CreateSplit2G" value="0x08">
10658	<desc>
10659	Supports creating images split in chunks of a bit less than 2 GBytes.
10660	</desc>
10661	</const>
10662
10663	<const name="Differencing" value="0x10">
10664	<desc>
10665	Supports being used as a format for differencing media (see <link
10666	to="IMedium::createDiffStorage"/>).
10667	</desc>
10668	</const>
10669
10670	<const name="Asynchronous" value="0x20">
10671	<desc>
10672	Supports asynchronous I/O operations for at least some configurations.
10673	</desc>
10674	</const>
10675
10676	<const name="File" value="0x40">
10677	<desc>
10678	The format backend operates on files (the <link to="IMedium::location"/>
10679	attribute of the medium specifies a file used to store medium
10680	data; for a list of supported file extensions see
10681	<link to="IMediumFormat::describeFileExtensions"/>).
10682	</desc>
10683	</const>
10684
10685	<const name="Properties" value="0x80">
10686	<desc>
10687	The format backend uses the property interface to configure the storage
10688	location and properties (the <link to="IMediumFormat::describeProperties"/>
10689	method is used to get access to properties supported by the given medium format).
10690	</desc>
10691	</const>
10692
10693	<const name="TcpNetworking" value="0x100">
10694	<desc>
10695	The format backend uses the TCP networking interface for network access.
10696	</desc>
10697	</const>
10698
10699	<const name="VFS" value="0x200">
10700	<desc>
10701	The format backend supports virtual filesystem functionality.
10702	</desc>
10703	</const>
10704
10705	<const name="CapabilityMask" value="0x3FF"/>
10706	</enum>
10707
10708	<interface
10709	name="IMediumFormat" extends="$unknown"
10710	uuid="4e9a873f-0599-434a-8345-619ef3fb3111"
10711	wsmap="managed"
10712	>
10713	<desc>
10714	The IMediumFormat interface represents a medium format.
10715
10716	Each medium format has an associated backend which is used to handle
10717	media stored in this format. This interface provides information
10718	about the properties of the associated backend.
10719
10720	Each medium format is identified by a string represented by the
10721	<link to="#id"/> attribute. This string is used in calls like
10722	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10723	format.
10724
10725	The list of all supported medium formats can be obtained using
10726	<link to="ISystemProperties::mediumFormats"/>.
10727
10728	<see>IMedium</see>
10729	</desc>
10730
10731	<attribute name="id" type="wstring" readonly="yes">
10732	<desc>
10733	Identifier of this format.
10734
10735	The format identifier is a non-@c null non-empty ASCII string. Note that
10736	this string is case-insensitive. This means that, for example, all of
10737	the following strings:
10738	<pre>
10739	"VDI"
10740	"vdi"
10741	"VdI"</pre>
10742	refer to the same medium format.
10743
10744	This string is used in methods of other interfaces where it is necessary
10745	to specify a medium format, such as
10746	<link to="IVirtualBox::createHardDisk"/>.
10747	</desc>
10748	</attribute>
10749
10750	<attribute name="name" type="wstring" readonly="yes">
10751	<desc>
10752	Human readable description of this format.
10753
10754	Mainly for use in file open dialogs.
10755	</desc>
10756	</attribute>
10757
10758	<attribute name="capabilities" type="unsigned long" readonly="yes">
10759	<desc>
10760	Capabilities of the format as a set of bit flags.
10761
10762	For the meaning of individual capability flags see
10763	<link to="MediumFormatCapabilities"/>.
10764	</desc>
10765	</attribute>
10766
10767	<method name="describeFileExtensions">
10768	<desc>
10769	Returns two arrays describing the supported file extensions.
10770
10771	The first array contains the supported extensions and the seconds one
10772	the type each extension supports. Both have the same size.
10773
10774	Note that some backends do not work on files, so this array may be
10775	empty.
10776
10777	<see>IMediumFormat::capabilities</see>
10778	</desc>
10779	<param name="extensions" type="wstring" safearray="yes" dir="out">
10780	<desc>The array of supported extensions.</desc>
10781	</param>
10782	<param name="type" type="DeviceType" safearray="yes" dir="out">
10783	<desc>The array which indicates the device type for every given extension.</desc>
10784	</param>
10785	</method>
10786
10787	<method name="describeProperties">
10788	<desc>
10789	Returns several arrays describing the properties supported by this
10790	format.
10791
10792	An element with the given index in each array describes one
10793	property. Thus, the number of elements in each returned array is the
10794	same and corresponds to the number of supported properties.
10795
10796	The returned arrays are filled in only if the
10797	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10798	All arguments must be non-@c null.
10799
10800	<see>DataType</see>
10801	<see>DataFlags</see>
10802	</desc>
10803
10804	<param name="names" type="wstring" safearray="yes" dir="out">
10805	<desc>Array of property names.</desc>
10806	</param>
10807	<param name="description" type="wstring" safearray="yes" dir="out">
10808	<desc>Array of property descriptions.</desc>
10809	</param>
10810	<param name="types" type="DataType" safearray="yes" dir="out">
10811	<desc>Array of property types.</desc>
10812	</param>
10813	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10814	<desc>Array of property flags.</desc>
10815	</param>
10816	<param name="defaults" type="wstring" safearray="yes" dir="out">
10817	<desc>Array of default property values.</desc>
10818	</param>
10819	</method>
10820
10821	</interface>
10822
10823
10824	<!--
10825	// IKeyboard
10826	/////////////////////////////////////////////////////////////////////////
10827	-->
10828
10829	<interface
10830	name="IKeyboard" extends="$unknown"
10831	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
10832	wsmap="managed"
10833	>
10834	<desc>
10835	The IKeyboard interface represents the virtual machine's keyboard. Used
10836	in <link to="IConsole::keyboard"/>.
10837
10838	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10839	to the virtual machine.
10840
10841	</desc>
10842	<method name="putScancode">
10843	<desc>Sends a scancode to the keyboard.
10844
10845	<result name="VBOX_E_IPRT_ERROR">
10846	Could not send scan code to virtual keyboard.
10847	</result>
10848
10849	</desc>
10850	<param name="scancode" type="long" dir="in"/>
10851	</method>
10852
10853	<method name="putScancodes">
10854	<desc>Sends an array of scancodes to the keyboard.
10855
10856	<result name="VBOX_E_IPRT_ERROR">
10857	Could not send all scan codes to virtual keyboard.
10858	</result>
10859
10860	</desc>
10861	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10862	<param name="codesStored" type="unsigned long" dir="return"/>
10863	</method>
10864
10865	<method name="putCAD">
10866	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10867	function is nothing special, it is just a convenience function
10868	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10869
10870	<result name="VBOX_E_IPRT_ERROR">
10871	Could not send all scan codes to virtual keyboard.
10872	</result>
10873
10874	</desc>
10875	</method>
10876
10877	<attribute name="eventSource" type="IEventSource" readonly="yes">
10878	<desc>
10879	Event source for keyboard events.
10880	</desc>
10881	</attribute>
10882
10883	</interface>
10884
10885
10886	<!--
10887	// IMouse
10888	/////////////////////////////////////////////////////////////////////////
10889	-->
10890
10891	<enum
10892	name="MouseButtonState"
10893	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10894	>
10895	<desc>
10896	Mouse button state.
10897	</desc>
10898
10899	<const name="LeftButton" value="0x01"/>
10900	<const name="RightButton" value="0x02"/>
10901	<const name="MiddleButton" value="0x04"/>
10902	<const name="WheelUp" value="0x08"/>
10903	<const name="WheelDown" value="0x10"/>
10904	<const name="XButton1" value="0x20"/>
10905	<const name="XButton2" value="0x40"/>
10906	<const name="MouseStateMask" value="0x7F"/>
10907	</enum>
10908
10909	<interface
10910	name="IMouse" extends="$unknown"
10911	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
10912	wsmap="managed"
10913	>
10914	<desc>
10915	The IMouse interface represents the virtual machine's mouse. Used in
10916	<link to="IConsole::mouse"/>.
10917
10918	Through this interface, the virtual machine's virtual mouse can be
10919	controlled.
10920	</desc>
10921
10922	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10923	<desc>
10924	Whether the guest OS supports absolute mouse pointer positioning
10925	or not.
10926	<note>
10927	You can use the <link to="IMouseCapabilityChangedEvent"/>
10928	event to be instantly informed about changes of this attribute
10929	during virtual machine execution.
10930	</note>
10931	<see><link to="#putMouseEventAbsolute"/></see>
10932	</desc>
10933	</attribute>
10934
10935	<attribute name="relativeSupported" type="boolean" readonly="yes">
10936	<desc>
10937	Whether the guest OS supports relative mouse pointer positioning
10938	or not.
10939	<note>
10940	You can use the <link to="IMouseCapabilityChangedEvent"/>
10941	event to be instantly informed about changes of this attribute
10942	during virtual machine execution.
10943	</note>
10944	<see><link to="#putMouseEvent"/></see>
10945	</desc>
10946	</attribute>
10947
10948	<attribute name="needsHostCursor" type="boolean" readonly="yes">
10949	<desc>
10950	Whether the guest OS can currently switch to drawing it's own mouse
10951	cursor on demand.
10952	<note>
10953	You can use the <link to="IMouseCapabilityChangedEvent"/>
10954	event to be instantly informed about changes of this attribute
10955	during virtual machine execution.
10956	</note>
10957	<see><link to="#putMouseEvent"/></see>
10958	</desc>
10959	</attribute>
10960
10961	<method name="putMouseEvent">
10962	<desc>
10963	Initiates a mouse event using relative pointer movements
10964	along x and y axis.
10965
10966	<result name="E_ACCESSDENIED">
10967	Console not powered up.
10968	</result>
10969	<result name="VBOX_E_IPRT_ERROR">
10970	Could not send mouse event to virtual mouse.
10971	</result>
10972
10973	</desc>
10974
10975	<param name="dx" type="long" dir="in">
10976	<desc>
10977	Amount of pixels the mouse should move to the right.
10978	Negative values move the mouse to the left.
10979	</desc>
10980	</param>
10981	<param name="dy" type="long" dir="in">
10982	<desc>
10983	Amount of pixels the mouse should move downwards.
10984	Negative values move the mouse upwards.
10985	</desc>
10986	</param>
10987	<param name="dz" type="long" dir="in">
10988	<desc>
10989	Amount of mouse wheel moves.
10990	Positive values describe clockwise wheel rotations,
10991	negative values describe counterclockwise rotations.
10992	</desc>
10993	</param>
10994	<param name="dw" type="long" dir="in">
10995	<desc>
10996	Amount of horizontal mouse wheel moves.
10997	Positive values describe a movement to the left,
10998	negative values describe a movement to the right.
10999	</desc>
11000	</param>
11001	<param name="buttonState" type="long" dir="in">
11002	<desc>
11003	The current state of mouse buttons. Every bit represents
11004	a mouse button as follows:
11005	<table>
11006	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
11007	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
11008	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
11009	</table>
11010	A value of <tt>1</tt> means the corresponding button is pressed.
11011	otherwise it is released.
11012	</desc>
11013	</param>
11014	</method>
11015
11016	<method name="putMouseEventAbsolute">
11017	<desc>
11018	Positions the mouse pointer using absolute x and y coordinates.
11019	These coordinates are expressed in pixels and
11020	start from <tt>[1,1]</tt> which corresponds to the top left
11021	corner of the virtual display.
11022
11023	<result name="E_ACCESSDENIED">
11024	Console not powered up.
11025	</result>
11026	<result name="VBOX_E_IPRT_ERROR">
11027	Could not send mouse event to virtual mouse.
11028	</result>
11029
11030	<note>
11031	This method will have effect only if absolute mouse
11032	positioning is supported by the guest OS.
11033	</note>
11034
11035	<see><link to="#absoluteSupported"/></see>
11036	</desc>
11037
11038	<param name="x" type="long" dir="in">
11039	<desc>
11040	X coordinate of the pointer in pixels, starting from @c 1.
11041	</desc>
11042	</param>
11043	<param name="y" type="long" dir="in">
11044	<desc>
11045	Y coordinate of the pointer in pixels, starting from @c 1.
11046	</desc>
11047	</param>
11048	<param name="dz" type="long" dir="in">
11049	<desc>
11050	Amount of mouse wheel moves.
11051	Positive values describe clockwise wheel rotations,
11052	negative values describe counterclockwise rotations.
11053	</desc>
11054	</param>
11055	<param name="dw" type="long" dir="in">
11056	<desc>
11057	Amount of horizontal mouse wheel moves.
11058	Positive values describe a movement to the left,
11059	negative values describe a movement to the right.
11060	</desc>
11061	</param>
11062	<param name="buttonState" type="long" dir="in">
11063	<desc>
11064	The current state of mouse buttons. Every bit represents
11065	a mouse button as follows:
11066	<table>
11067	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
11068	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
11069	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
11070	</table>
11071	A value of @c 1 means the corresponding button is pressed.
11072	otherwise it is released.
11073	</desc>
11074	</param>
11075	</method>
11076
11077	<attribute name="eventSource" type="IEventSource" readonly="yes">
11078	<desc>
11079	Event source for mouse events.
11080	</desc>
11081	</attribute>
11082
11083	</interface>
11084
11085	<!--
11086	// IDisplay
11087	/////////////////////////////////////////////////////////////////////////
11088	-->
11089
11090	<enum
11091	name="FramebufferPixelFormat"
11092	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
11093	>
11094	<desc>
11095	Format of the video memory buffer. Constants represented by this enum can
11096	be used to test for particular values of <link
11097	to="IFramebuffer::pixelFormat"/>. See also <link
11098	to="IFramebuffer::requestResize"/>.
11099
11100	See also www.fourcc.org for more information about FOURCC pixel formats.
11101	</desc>
11102
11103	<const name="Opaque" value="0">
11104	<desc>
11105	Unknown buffer format (the user may not assume any particular format of
11106	the buffer).
11107	</desc>
11108	</const>
11109	<const name="FOURCC_RGB" value="0x32424752">
11110	<desc>
11111	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
11112	bit layout).
11113	</desc>
11114	</const>
11115	</enum>
11116
11117	<interface
11118	name="IFramebuffer" extends="$unknown"
11119	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
11120	wsmap="suppress"
11121	>
11122	<attribute name="address" type="octet" mod="ptr" readonly="yes">
11123	<desc>Address of the start byte of the frame buffer.</desc>
11124	</attribute>
11125
11126	<attribute name="width" type="unsigned long" readonly="yes">
11127	<desc>Frame buffer width, in pixels.</desc>
11128	</attribute>
11129
11130	<attribute name="height" type="unsigned long" readonly="yes">
11131	<desc>Frame buffer height, in pixels.</desc>
11132	</attribute>
11133
11134	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
11135	<desc>
11136	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
11137	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
11138	are: 8, 15, 16, 24 and 32.
11139	</desc>
11140	</attribute>
11141
11142	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
11143	<desc>
11144	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
11145	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
11146	size of the scan line must be aligned to 32 bits.
11147	</desc>
11148	</attribute>
11149
11150	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
11151	<desc>
11152	Frame buffer pixel format. It's either one of the values defined by <link
11153	to="FramebufferPixelFormat"/> or a raw FOURCC code.
11154	<note>
11155	This attribute must never return <link
11156	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
11157	<link to="#address"/> points to must be always known.
11158	</note>
11159	</desc>
11160	</attribute>
11161
11162	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
11163	<desc>
11164	Defines whether this frame buffer uses the virtual video card's memory
11165	buffer (guest VRAM) directly or not. See <link
11166	to="IFramebuffer::requestResize"/> for more information.
11167	</desc>
11168	</attribute>
11169
11170	<attribute name="heightReduction" type="unsigned long" readonly="yes">
11171	<desc>
11172	Hint from the frame buffer about how much of the standard
11173	screen height it wants to use for itself. This information is
11174	exposed to the guest through the VESA BIOS and VMMDev interface
11175	so that it can use it for determining its video mode table. It
11176	is not guaranteed that the guest respects the value.
11177	</desc>
11178	</attribute>
11179
11180	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
11181	<desc>
11182	An alpha-blended overlay which is superposed over the frame buffer.
11183	The initial purpose is to allow the display of icons providing
11184	information about the VM state, including disk activity, in front
11185	ends which do not have other means of doing that. The overlay is
11186	designed to controlled exclusively by IDisplay. It has no locking
11187	of its own, and any changes made to it are not guaranteed to be
11188	visible until the affected portion of IFramebuffer is updated. The
11189	overlay can be created lazily the first time it is requested. This
11190	attribute can also return @c null to signal that the overlay is not
11191	implemented.
11192	</desc>
11193	</attribute>
11194
11195	<attribute name="winId" type="long long" readonly="yes">
11196	<desc>
11197	Platform-dependent identifier of the window where context of this
11198	frame buffer is drawn, or zero if there's no such window.
11199	</desc>
11200	</attribute>
11201
11202	<method name="lock">
11203	<desc>
11204	Locks the frame buffer.
11205	Gets called by the IDisplay object where this frame buffer is
11206	bound to.
11207	</desc>
11208	</method>
11209
11210	<method name="unlock">
11211	<desc>
11212	Unlocks the frame buffer.
11213	Gets called by the IDisplay object where this frame buffer is
11214	bound to.
11215	</desc>
11216	</method>
11217
11218	<method name="notifyUpdate">
11219	<desc>
11220	Informs about an update.
11221	Gets called by the display object where this buffer is
11222	registered.
11223	</desc>
11224	<param name="x" type="unsigned long" dir="in"/>
11225	<param name="y" type="unsigned long" dir="in"/>
11226	<param name="width" type="unsigned long" dir="in"/>
11227	<param name="height" type="unsigned long" dir="in"/>
11228	</method>
11229
11230	<method name="requestResize">
11231	<desc>
11232	Requests a size and pixel format change.
11233
11234	There are two modes of working with the video buffer of the virtual
11235	machine. The <i>indirect</i> mode implies that the IFramebuffer
11236	implementation allocates a memory buffer for the requested display mode
11237	and provides it to the virtual machine. In <i>direct</i> mode, the
11238	IFramebuffer implementation uses the memory buffer allocated and owned
11239	by the virtual machine. This buffer represents the video memory of the
11240	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
11241	usually faster because the implementation gets a raw pointer to the
11242	guest VRAM buffer which it can directly use for visualizing the contents
11243	of the virtual display, as opposed to the indirect mode where the
11244	contents of guest VRAM are copied to the memory buffer provided by
11245	the implementation every time a display update occurs.
11246
11247	It is important to note that the direct mode is really fast only when
11248	the implementation uses the given guest VRAM buffer directly, for
11249	example, by blitting it to the window representing the virtual machine's
11250	display, which saves at least one copy operation comparing to the
11251	indirect mode. However, using the guest VRAM buffer directly is not
11252	always possible: the format and the color depth of this buffer may be
11253	not supported by the target window, or it may be unknown (opaque) as in
11254	case of text or non-linear multi-plane VGA video modes. In this case,
11255	the indirect mode (that is always available) should be used as a
11256	fallback: when the guest VRAM contents are copied to the
11257	implementation-provided memory buffer, color and format conversion is
11258	done automatically by the underlying code.
11259
11260	The @a pixelFormat parameter defines whether the direct mode is
11261	available or not. If @a pixelFormat is <link
11262	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
11263	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
11264	@a bytesPerLine parameters must be ignored and the implementation must use
11265	the indirect mode (where it provides its own buffer in one of the
11266	supported formats). In all other cases, @a pixelFormat together with
11267	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
11268	buffer pointed to by the @a VRAM parameter and the implementation is
11269	free to choose which mode to use. To indicate that this frame buffer uses
11270	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
11271	attribute must return @c true and <link to="#address"/> must
11272	return exactly the same address that is passed in the @a VRAM parameter
11273	of this method; otherwise it is assumed that the indirect strategy is
11274	chosen.
11275
11276	The @a width and @a height parameters represent the size of the
11277	requested display mode in both modes. In case of indirect mode, the
11278	provided memory buffer should be big enough to store data of the given
11279	display mode. In case of direct mode, it is guaranteed that the given
11280	@a VRAM buffer contains enough space to represent the display mode of the
11281	given size. Note that this frame buffer's <link to="#width"/> and <link
11282	to="#height"/> attributes must return exactly the same values as
11283	passed to this method after the resize is completed (see below).
11284
11285	The @a finished output parameter determines if the implementation has
11286	finished resizing the frame buffer or not. If, for some reason, the
11287	resize cannot be finished immediately during this call, @a finished
11288	must be set to @c false, and the implementation must call
11289	<link to="IDisplay::resizeCompleted"/> after it has returned from
11290	this method as soon as possible. If @a finished is @c false, the
11291	machine will not call any frame buffer methods until
11292	<link to="IDisplay::resizeCompleted"/> is called.
11293
11294	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
11295	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
11296	this frame buffer must return exactly the same values as specified in the
11297	parameters of this method, after the resize is completed. If the
11298	indirect mode is chosen, these attributes must return values describing
11299	the format of the implementation's own memory buffer <link
11300	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
11301	value must always correlate with <link to="#pixelFormat"/>. Note that
11302	the <link to="#pixelFormat"/> attribute must never return <link
11303	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
11304
11305	<note>
11306	This method is called by the IDisplay object under the
11307	<link to="#lock"/> provided by this IFramebuffer
11308	implementation. If this method returns @c false in @a finished, then
11309	this lock is not released until
11310	<link to="IDisplay::resizeCompleted"/> is called.
11311	</note>
11312	</desc>
11313	<param name="screenId" type="unsigned long" dir="in">
11314	<desc>
11315	Logical screen number. Must be used in the corresponding call to
11316	<link to="IDisplay::resizeCompleted"/> if this call is made.
11317	</desc>
11318	</param>
11319	<param name="pixelFormat" type="unsigned long" dir="in">
11320	<desc>
11321	Pixel format of the memory buffer pointed to by @a VRAM.
11322	See also <link to="FramebufferPixelFormat"/>.
11323	</desc>
11324	</param>
11325	<param name="VRAM" type="octet" mod="ptr" dir="in">
11326	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
11327	</param>
11328	<param name="bitsPerPixel" type="unsigned long" dir="in">
11329	<desc>Color depth, bits per pixel.</desc>
11330	</param>
11331	<param name="bytesPerLine" type="unsigned long" dir="in">
11332	<desc>Size of one scan line, in bytes.</desc>
11333	</param>
11334	<param name="width" type="unsigned long" dir="in">
11335	<desc>Width of the guest display, in pixels.</desc>
11336	</param>
11337	<param name="height" type="unsigned long" dir="in">
11338	<desc>Height of the guest display, in pixels.</desc>
11339	</param>
11340	<param name="finished" type="boolean" dir="return">
11341	<desc>
11342	Can the VM start using the new frame buffer immediately
11343	after this method returns or it should wait for
11344	<link to="IDisplay::resizeCompleted"/>.
11345	</desc>
11346	</param>
11347	</method>
11348
11349	<method name="videoModeSupported">
11350	<desc>
11351	Returns whether the frame buffer implementation is willing to
11352	support a given video mode. In case it is not able to render
11353	the video mode (or for some reason not willing), it should
11354	return @c false. Usually this method is called when the guest
11355	asks the VMM device whether a given video mode is supported
11356	so the information returned is directly exposed to the guest.
11357	It is important that this method returns very quickly.
11358	</desc>
11359	<param name="width" type="unsigned long" dir="in"/>
11360	<param name="height" type="unsigned long" dir="in"/>
11361	<param name="bpp" type="unsigned long" dir="in"/>
11362	<param name="supported" type="boolean" dir="return"/>
11363	</method>
11364
11365	<method name="getVisibleRegion">
11366	<desc>
11367	Returns the visible region of this frame buffer.
11368
11369	If the @a rectangles parameter is @c null then the value of the
11370	@a count parameter is ignored and the number of elements necessary to
11371	describe the current visible region is returned in @a countCopied.
11372
11373	If @a rectangles is not @c null but @a count is less
11374	than the required number of elements to store region data, the method
11375	will report a failure. If @a count is equal or greater than the
11376	required number of elements, then the actual number of elements copied
11377	to the provided array will be returned in @a countCopied.
11378
11379	<note>
11380	The address of the provided array must be in the process space of
11381	this IFramebuffer object.
11382	</note>
11383	<note>
11384	Method not yet implemented.
11385	</note>
11386	</desc>
11387	<param name="rectangles" type="octet" mod="ptr" dir="in">
11388	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
11389	</param>
11390	<param name="count" type="unsigned long" dir="in">
11391	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11392	</param>
11393	<param name="countCopied" type="unsigned long" dir="return">
11394	<desc>Number of elements copied to the @a rectangles array.</desc>
11395	</param>
11396	</method>
11397
11398	<method name="setVisibleRegion">
11399	<desc>
11400	Suggests a new visible region to this frame buffer. This region
11401	represents the area of the VM display which is a union of regions of
11402	all top-level windows of the guest operating system running inside the
11403	VM (if the Guest Additions for this system support this
11404	functionality). This information may be used by the frontends to
11405	implement the seamless desktop integration feature.
11406
11407	<note>
11408	The address of the provided array must be in the process space of
11409	this IFramebuffer object.
11410	</note>
11411	<note>
11412	The IFramebuffer implementation must make a copy of the provided
11413	array of rectangles.
11414	</note>
11415	<note>
11416	Method not yet implemented.
11417	</note>
11418	</desc>
11419	<param name="rectangles" type="octet" mod="ptr" dir="in">
11420	<desc>Pointer to the @c RTRECT array.</desc>
11421	</param>
11422	<param name="count" type="unsigned long" dir="in">
11423	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11424	</param>
11425	</method>
11426
11427	<method name="processVHWACommand">
11428	<desc>
11429	Posts a Video HW Acceleration Command to the frame buffer for processing.
11430	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
11431	are posted from quest to the host to be processed by the host hardware.
11432
11433	<note>
11434	The address of the provided command must be in the process space of
11435	this IFramebuffer object.
11436	</note>
11437	</desc>
11438
11439	<param name="command" type="octet" mod="ptr" dir="in">
11440	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
11441	</param>
11442	</method>
11443
11444	</interface>
11445
11446	<interface
11447	name="IFramebufferOverlay" extends="IFramebuffer"
11448	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
11449	wsmap="suppress"
11450	>
11451	<desc>
11452	The IFramebufferOverlay interface represents an alpha blended overlay
11453	for displaying status icons above an IFramebuffer. It is always created
11454	not visible, so that it must be explicitly shown. It only covers a
11455	portion of the IFramebuffer, determined by its width, height and
11456	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
11457	that order) format, and may be written to directly. Do re-read the
11458	width though, after setting it, as it may be adjusted (increased) to
11459	make it more suitable for the front end.
11460	</desc>
11461	<attribute name="x" type="unsigned long" readonly="yes">
11462	<desc>X position of the overlay, relative to the frame buffer.</desc>
11463	</attribute>
11464
11465	<attribute name="y" type="unsigned long" readonly="yes">
11466	<desc>Y position of the overlay, relative to the frame buffer.</desc>
11467	</attribute>
11468
11469	<attribute name="visible" type="boolean" readonly="no">
11470	<desc>
11471	Whether the overlay is currently visible.
11472	</desc>
11473	</attribute>
11474
11475	<attribute name="alpha" type="unsigned long" readonly="no">
11476	<desc>
11477	The global alpha value for the overlay. This may or may not be
11478	supported by a given front end.
11479	</desc>
11480	</attribute>
11481
11482	<method name="move">
11483	<desc>
11484	Changes the overlay's position relative to the IFramebuffer.
11485	</desc>
11486	<param name="x" type="unsigned long" dir="in"/>
11487	<param name="y" type="unsigned long" dir="in"/>
11488	</method>
11489
11490	</interface>
11491
11492	<interface
11493	name="IDisplay" extends="$unknown"
11494	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
11495	wsmap="managed"
11496	>
11497	<desc>
11498	The IDisplay interface represents the virtual machine's display.
11499
11500	The object implementing this interface is contained in each
11501	<link to="IConsole::display"/> attribute and represents the visual
11502	output of the virtual machine.
11503
11504	The virtual display supports pluggable output targets represented by the
11505	IFramebuffer interface. Examples of the output target are a window on
11506	the host computer or an RDP session's display on a remote computer.
11507	</desc>
11508	<method name="getScreenResolution">
11509	<desc>Queries display width, height and color depth for given screen.</desc>
11510	<param name="screenId" type="unsigned long" dir="in"/>
11511	<param name="width" type="unsigned long" dir="out"/>
11512	<param name="height" type="unsigned long" dir="out"/>
11513	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
11514	</method>
11515
11516	<method name="setFramebuffer">
11517	<desc>
11518	Sets the framebuffer for given screen.
11519	</desc>
11520	<param name="screenId" type="unsigned long" dir="in"/>
11521	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11522	</method>
11523
11524	<method name="getFramebuffer">
11525	<desc>
11526	Queries the framebuffer for given screen.
11527	</desc>
11528	<param name="screenId" type="unsigned long" dir="in"/>
11529	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11530	<param name="xOrigin" type="long" dir="out"/>
11531	<param name="yOrigin" type="long" dir="out"/>
11532	</method>
11533
11534	<method name="setVideoModeHint">
11535	<desc>
11536	Asks VirtualBox to request the given video mode from
11537	the guest. This is just a hint and it cannot be guaranteed
11538	that the requested resolution will be used. Guest Additions
11539	are required for the request to be seen by guests. The caller
11540	should issue the request and wait for a resolution change and
11541	after a timeout retry.
11542
11543	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11544	parameters means that the corresponding values should be taken from the
11545	current video mode (i.e. left unchanged).
11546
11547	If the guest OS supports multi-monitor configuration then the @a display
11548	parameter specifies the number of the guest display to send the hint to:
11549	@c 0 is the primary display, @c 1 is the first secondary and
11550	so on. If the multi-monitor configuration is not supported, @a display
11551	must be @c 0.
11552
11553	<result name="E_INVALIDARG">
11554	The @a display is not associated with any monitor.
11555	</result>
11556
11557	</desc>
11558	<param name="width" type="unsigned long" dir="in"/>
11559	<param name="height" type="unsigned long" dir="in"/>
11560	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11561	<param name="display" type="unsigned long" dir="in"/>
11562	</method>
11563
11564	<method name="setSeamlessMode">
11565	<desc>
11566	Enables or disables seamless guest display rendering (seamless desktop
11567	integration) mode.
11568	<note>
11569	Calling this method has no effect if <link
11570	to="IGuest::getFacilityStatus"/> with facility <link to="AdditionsFacilityType::Seamless"/>
11571	does not return <link to="AdditionsFacilityStatus::Active"/>.
11572	</note>
11573	</desc>
11574	<param name="enabled" type="boolean" dir="in"/>
11575	</method>
11576
11577	<method name="takeScreenShot">
11578	<desc>
11579	Takes a screen shot of the requested size and copies it to the
11580	32-bpp buffer allocated by the caller and pointed to by @a address.
11581	A pixel consists of 4 bytes in order: B, G, R, 0.
11582
11583	<note>This API can be used only by the COM/XPCOM C++ API as it
11584	requires pointer support. Use <link to="#takeScreenShotToArray" />
11585	with other language bindings.
11586	</note>
11587
11588	<result name="E_NOTIMPL">
11589	Feature not implemented.
11590	</result>
11591	<result name="VBOX_E_IPRT_ERROR">
11592	Could not take a screenshot.
11593	</result>
11594
11595	</desc>
11596	<param name="screenId" type="unsigned long" dir="in"/>
11597	<param name="address" type="octet" mod="ptr" dir="in"/>
11598	<param name="width" type="unsigned long" dir="in"/>
11599	<param name="height" type="unsigned long" dir="in"/>
11600	</method>
11601
11602	<method name="takeScreenShotToArray">
11603	<desc>
11604	Takes a guest screen shot of the requested size and returns it as
11605	an array of bytes in uncompressed 32-bit RGBA format.
11606	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11607
11608	This API is slow, but could be the only option to get guest screenshot
11609	for scriptable languages not allowed to manipulate with addresses
11610	directly.
11611
11612	<result name="E_NOTIMPL">
11613	Feature not implemented.
11614	</result>
11615	<result name="VBOX_E_IPRT_ERROR">
11616	Could not take a screenshot.
11617	</result>
11618	</desc>
11619	<param name="screenId" type="unsigned long" dir="in">
11620	<desc>
11621	Monitor to take screenshot from.
11622	</desc>
11623	</param>
11624	<param name="width" type="unsigned long" dir="in">
11625	<desc>
11626	Desired image width.
11627	</desc>
11628	</param>
11629	<param name="height" type="unsigned long" dir="in">
11630	<desc>
11631	Desired image height.
11632	</desc>
11633	</param>
11634	<param name="screenData" type="octet" dir="return" safearray="yes">
11635	<desc>
11636	Array with resulting screen data.
11637	</desc>
11638	</param>
11639	</method>
11640
11641	<method name="takeScreenShotPNGToArray">
11642	<desc>
11643	Takes a guest screen shot of the requested size and returns it as
11644	PNG image in array.
11645
11646	<result name="E_NOTIMPL">
11647	Feature not implemented.
11648	</result>
11649	<result name="VBOX_E_IPRT_ERROR">
11650	Could not take a screenshot.
11651	</result>
11652	</desc>
11653	<param name="screenId" type="unsigned long" dir="in">
11654	<desc>
11655	Monitor to take the screenshot from.
11656	</desc>
11657	</param>
11658	<param name="width" type="unsigned long" dir="in">
11659	<desc>
11660	Desired image width.
11661	</desc>
11662	</param>
11663	<param name="height" type="unsigned long" dir="in">
11664	<desc>
11665	Desired image height.
11666	</desc>
11667	</param>
11668	<param name="screenData" type="octet" dir="return" safearray="yes">
11669	<desc>
11670	Array with resulting screen data.
11671	</desc>
11672	</param>
11673	</method>
11674
11675	<method name="drawToScreen">
11676	<desc>
11677	Draws a 32-bpp image of the specified size from the given buffer
11678	to the given point on the VM display.
11679
11680	<result name="E_NOTIMPL">
11681	Feature not implemented.
11682	</result>
11683	<result name="VBOX_E_IPRT_ERROR">
11684	Could not draw to screen.
11685	</result>
11686
11687	</desc>
11688	<param name="screenId" type="unsigned long" dir="in">
11689	<desc>
11690	Monitor to take the screenshot from.
11691	</desc>
11692	</param>
11693	<param name="address" type="octet" mod="ptr" dir="in">
11694	<desc>
11695	Address to store the screenshot to
11696	</desc>
11697	</param>
11698	<param name="x" type="unsigned long" dir="in">
11699	<desc>
11700	Relative to the screen top left corner.
11701	</desc>
11702	</param>
11703	<param name="y" type="unsigned long" dir="in">
11704	<desc>
11705	Relative to the screen top left corner.
11706	</desc>
11707	</param>
11708	<param name="width" type="unsigned long" dir="in">
11709	<desc>
11710	Desired image width.
11711	</desc>
11712	</param>
11713	<param name="height" type="unsigned long" dir="in">
11714	<desc>
11715	Desired image height.
11716	</desc>
11717	</param>
11718	</method>
11719
11720	<method name="invalidateAndUpdate">
11721	<desc>
11722	Does a full invalidation of the VM display and instructs the VM
11723	to update it.
11724
11725	<result name="VBOX_E_IPRT_ERROR">
11726	Could not invalidate and update screen.
11727	</result>
11728
11729	</desc>
11730	</method>
11731
11732	<method name="resizeCompleted">
11733	<desc>
11734	Signals that a framebuffer has completed the resize operation.
11735
11736	<result name="VBOX_E_NOT_SUPPORTED">
11737	Operation only valid for external frame buffers.
11738	</result>
11739
11740	</desc>
11741	<param name="screenId" type="unsigned long" dir="in"/>
11742	</method>
11743
11744	<method name="completeVHWACommand">
11745	<desc>
11746	Signals that the Video HW Acceleration command has completed.
11747	</desc>
11748
11749	<param name="command" type="octet" mod="ptr" dir="in">
11750	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11751	</param>
11752	</method>
11753
11754	</interface>
11755
11756	<!--
11757	// INetworkAdapter
11758	/////////////////////////////////////////////////////////////////////////
11759	-->
11760
11761	<enum
11762	name="NetworkAttachmentType"
11763	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11764	>
11765	<desc>
11766	Network attachment type.
11767	</desc>
11768
11769	<const name="Null" value="0">
11770	<desc>Null value, also means "not attached".</desc>
11771	</const>
11772	<const name="NAT" value="1"/>
11773	<const name="Bridged" value="2"/>
11774	<const name="Internal" value="3"/>
11775	<const name="HostOnly" value="4"/>
11776	<const name="VDE" value="5"/>
11777	</enum>
11778
11779	<enum
11780	name="NetworkAdapterType"
11781	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11782	>
11783	<desc>
11784	Network adapter type.
11785	</desc>
11786
11787	<const name="Null" value="0">
11788	<desc>Null value (never used by the API).</desc>
11789	</const>
11790	<const name="Am79C970A" value="1">
11791	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11792	</const>
11793	<const name="Am79C973" value="2">
11794	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11795	</const>
11796	<const name="I82540EM" value="3">
11797	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11798	</const>
11799	<const name="I82543GC" value="4">
11800	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11801	</const>
11802	<const name="I82545EM" value="5">
11803	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11804	</const>
11805	<const name="Virtio" value="6">
11806	<desc>Virtio network device.</desc>
11807	</const>
11808	</enum>
11809
11810	<enum
11811	name="NetworkAdapterPromiscModePolicy"
11812	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
11813	>
11814	<desc>
11815	The promiscuous mode policy of an interface.
11816	</desc>
11817
11818	<const name="Deny" value="1">
11819	<desc>Deny promiscuous mode requests.</desc>
11820	</const>
11821	<const name="AllowNetwork" value="2">
11822	<desc>
11823	Allow promicuous mode, but restrict the scope it to the internal
11824	network so that it only applies to other VMs.
11825	</desc>
11826	</const>
11827	<const name="AllowAll" value="3">
11828	<desc>
11829	Allow promicuous mode, include unrelated traffic going over the wire
11830	and internally on the host.
11831	</desc>
11832	</const>
11833	</enum>
11834
11835	<interface
11836	name="INetworkAdapter" extends="$unknown"
11837	uuid="6aa240a1-dd58-478e-92e8-aac001ce5547"
11838	wsmap="managed"
11839	>
11840	<desc>
11841	Represents a virtual network adapter that is attached to a virtual machine.
11842	Each virtual machine has a fixed number of network adapter slots with one
11843	instance of this attached to each of them. Call
11844	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11845	is attached to a given slot in a given machine.
11846
11847	Each network adapter can be in one of five attachment modes, which are
11848	represented by the <link to="NetworkAttachmentType" /> enumeration;
11849	see the <link to="#attachmentType" /> attribute.
11850	</desc>
11851
11852	<attribute name="adapterType" type="NetworkAdapterType">
11853	<desc>
11854	Type of the virtual network adapter. Depending on this value,
11855	VirtualBox will provide a different virtual network hardware
11856	to the guest.
11857	</desc>
11858	</attribute>
11859
11860	<attribute name="slot" type="unsigned long" readonly="yes">
11861	<desc>
11862	Slot number this adapter is plugged into. Corresponds to
11863	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11864	to obtain this instance.
11865	</desc>
11866	</attribute>
11867
11868	<attribute name="enabled" type="boolean">
11869	<desc>
11870	Flag whether the network adapter is present in the
11871	guest system. If disabled, the virtual guest hardware will
11872	not contain this network adapter. Can only be changed when
11873	the VM is not running.
11874	</desc>
11875	</attribute>
11876
11877	<attribute name="MACAddress" type="wstring">
11878	<desc>
11879	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11880	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11881	</desc>
11882	</attribute>
11883
11884	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11885
11886	<attribute name="hostInterface" type="wstring">
11887	<desc>
11888	Name of the host network interface the VM is attached to.
11889	</desc>
11890	</attribute>
11891
11892	<attribute name="internalNetwork" type="wstring">
11893	<desc>
11894	Name of the internal network the VM is attached to.
11895	</desc>
11896	</attribute>
11897
11898	<attribute name="NATNetwork" type="wstring">
11899	<desc>
11900	Name of the NAT network the VM is attached to.
11901	</desc>
11902	</attribute>
11903
11904	<attribute name="VDENetwork" type="wstring">
11905	<desc>
11906	Name of the VDE switch the VM is attached to.
11907	</desc>
11908	</attribute>
11909
11910	<attribute name="cableConnected" type="boolean">
11911	<desc>
11912	Flag whether the adapter reports the cable as connected or not.
11913	It can be used to report offline situations to a VM.
11914	</desc>
11915	</attribute>
11916
11917	<attribute name="lineSpeed" type="unsigned long">
11918	<desc>
11919	Line speed reported by custom drivers, in units of 1 kbps.
11920	</desc>
11921	</attribute>
11922
11923	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
11924	<desc>
11925	The promiscuous mode policy of the network adapter when attached to an
11926	internal network, host only network or a bridge.
11927	</desc>
11928	</attribute>
11929
11930	<attribute name="traceEnabled" type="boolean">
11931	<desc>
11932	Flag whether network traffic from/to the network card should be traced.
11933	Can only be toggled when the VM is turned off.
11934	</desc>
11935	</attribute>
11936
11937	<attribute name="traceFile" type="wstring">
11938	<desc>
11939	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11940	will be used.
11941	</desc>
11942	</attribute>
11943
11944	<attribute name="natDriver" type="INATEngine" readonly="yes">
11945	<desc>
11946	Points to the NAT engine which handles the network address translation
11947	for this interface. This is active only when the interface actually uses
11948	NAT (see <link to="#attachToNAT" />).
11949	</desc>
11950	</attribute>
11951
11952	<attribute name="bootPriority" type="unsigned long">
11953	<desc>
11954	Network boot priority of the adapter. Priority 1 is highest. If not set,
11955	the priority is considered to be at the lowest possible setting.
11956	</desc>
11957	</attribute>
11958
11959	<attribute name="bandwidthGroup" type="IBandwidthGroup">
11960	<desc>The bandwidth group this network adapter is assigned to.</desc>
11961	</attribute>
11962
11963	<method name="attachToNAT">
11964	<desc>
11965	Attach the network adapter to the Network Address Translation (NAT) interface.
11966	</desc>
11967	</method>
11968
11969	<method name="attachToBridgedInterface">
11970	<desc>
11971	Attach the network adapter to a bridged host interface.
11972	</desc>
11973	</method>
11974
11975	<method name="attachToInternalNetwork">
11976	<desc>
11977	Attach the network adapter to an internal network.
11978	</desc>
11979	</method>
11980
11981	<method name="attachToHostOnlyInterface">
11982	<desc>
11983	Attach the network adapter to the host-only network.
11984	</desc>
11985	</method>
11986
11987	<method name="attachToVDE">
11988	<desc>
11989	Attach the network adapter to a VDE network.
11990	</desc>
11991	</method>
11992
11993	<method name="detach">
11994	<desc>
11995	Detach the network adapter
11996	</desc>
11997	</method>
11998	</interface>
11999
12000
12001	<!--
12002	// ISerialPort
12003	/////////////////////////////////////////////////////////////////////////
12004	-->
12005
12006	<enum
12007	name="PortMode"
12008	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
12009	>
12010	<desc>
12011	The PortMode enumeration represents possible communication modes for
12012	the virtual serial port device.
12013	</desc>
12014
12015	<const name="Disconnected" value="0">
12016	<desc>Virtual device is not attached to any real host device.</desc>
12017	</const>
12018	<const name="HostPipe" value="1">
12019	<desc>Virtual device is attached to a host pipe.</desc>
12020	</const>
12021	<const name="HostDevice" value="2">
12022	<desc>Virtual device is attached to a host device.</desc>
12023	</const>
12024	<const name="RawFile" value="3">
12025	<desc>Virtual device is attached to a raw file.</desc>
12026	</const>
12027	</enum>
12028
12029	<interface
12030	name="ISerialPort" extends="$unknown"
12031	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
12032	wsmap="managed"
12033	>
12034
12035	<desc>
12036	The ISerialPort interface represents the virtual serial port device.
12037
12038	The virtual serial port device acts like an ordinary serial port
12039	inside the virtual machine. This device communicates to the real
12040	serial port hardware in one of two modes: host pipe or host device.
12041
12042	In host pipe mode, the #path attribute specifies the path to the pipe on
12043	the host computer that represents a serial port. The #server attribute
12044	determines if this pipe is created by the virtual machine process at
12045	machine startup or it must already exist before starting machine
12046	execution.
12047
12048	In host device mode, the #path attribute specifies the name of the
12049	serial port device on the host computer.
12050
12051	There is also a third communication mode: the disconnected mode. In this
12052	mode, the guest OS running inside the virtual machine will be able to
12053	detect the serial port, but all port write operations will be discarded
12054	and all port read operations will return no data.
12055
12056	<see>IMachine::getSerialPort</see>
12057	</desc>
12058
12059	<attribute name="slot" type="unsigned long" readonly="yes">
12060	<desc>
12061	Slot number this serial port is plugged into. Corresponds to
12062	the value you pass to <link to="IMachine::getSerialPort"/>
12063	to obtain this instance.
12064	</desc>
12065	</attribute>
12066
12067	<attribute name="enabled" type="boolean">
12068	<desc>
12069	Flag whether the serial port is enabled. If disabled,
12070	the serial port will not be reported to the guest OS.
12071	</desc>
12072	</attribute>
12073
12074	<attribute name="IOBase" type="unsigned long">
12075	<desc>Base I/O address of the serial port.</desc>
12076	</attribute>
12077
12078	<attribute name="IRQ" type="unsigned long">
12079	<desc>IRQ number of the serial port.</desc>
12080	</attribute>
12081
12082	<attribute name="hostMode" type="PortMode">
12083	<desc>
12084	How is this port connected to the host.
12085	<note>
12086	Changing this attribute may fail if the conditions for
12087	<link to="#path"/> are not met.
12088	</note>
12089	</desc>
12090	</attribute>
12091
12092	<attribute name="server" type="boolean">
12093	<desc>
12094	Flag whether this serial port acts as a server (creates a new pipe on
12095	the host) or as a client (uses the existing pipe). This attribute is
12096	used only when <link to="#hostMode"/> is PortMode_HostPipe.
12097	</desc>
12098	</attribute>
12099
12100	<attribute name="path" type="wstring">
12101	<desc>
12102	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
12103	PortMode_HostPipe, or the host serial device name when
12104	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
12105	cases, setting a @c null or empty string as the attribute's value
12106	is an error. Otherwise, the value of this property is ignored.
12107	</desc>
12108	</attribute>
12109
12110	</interface>
12111
12112	<!--
12113	// IParallelPort
12114	/////////////////////////////////////////////////////////////////////////
12115	-->
12116
12117	<interface
12118	name="IParallelPort" extends="$unknown"
12119	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
12120	wsmap="managed"
12121	>
12122
12123	<desc>
12124	The IParallelPort interface represents the virtual parallel port device.
12125
12126	The virtual parallel port device acts like an ordinary parallel port
12127	inside the virtual machine. This device communicates to the real
12128	parallel port hardware using the name of the parallel device on the host
12129	computer specified in the #path attribute.
12130
12131	Each virtual parallel port device is assigned a base I/O address and an
12132	IRQ number that will be reported to the guest operating system and used
12133	to operate the given parallel port from within the virtual machine.
12134
12135	<see>IMachine::getParallelPort</see>
12136	</desc>
12137
12138	<attribute name="slot" type="unsigned long" readonly="yes">
12139	<desc>
12140	Slot number this parallel port is plugged into. Corresponds to
12141	the value you pass to <link to="IMachine::getParallelPort"/>
12142	to obtain this instance.
12143	</desc>
12144	</attribute>
12145
12146	<attribute name="enabled" type="boolean">
12147	<desc>
12148	Flag whether the parallel port is enabled. If disabled,
12149	the parallel port will not be reported to the guest OS.
12150	</desc>
12151	</attribute>
12152
12153	<attribute name="IOBase" type="unsigned long">
12154	<desc>Base I/O address of the parallel port.</desc>
12155	</attribute>
12156
12157	<attribute name="IRQ" type="unsigned long">
12158	<desc>IRQ number of the parallel port.</desc>
12159	</attribute>
12160
12161	<attribute name="path" type="wstring">
12162	<desc>
12163	Host parallel device name. If this parallel port is enabled, setting a
12164	@c null or an empty string as this attribute's value will result into
12165	an error.
12166	</desc>
12167	</attribute>
12168
12169	</interface>
12170
12171
12172	<!--
12173	// IMachineDebugger
12174	/////////////////////////////////////////////////////////////////////////
12175	-->
12176
12177	<interface
12178	name="IMachineDebugger" extends="$unknown"
12179	uuid="1bfd2fa9-0d91-44d3-9515-368dcbb3eb4d"
12180	wsmap="suppress"
12181	>
12182	<method name="dumpGuestCore">
12183	<desc>
12184	Takes a core dump of the guest.
12185
12186	See include/VBox/dbgfcorefmt.h for details on the file format.
12187	</desc>
12188	<param name="filename" type="wstring" dir="in">
12189	<desc>
12190	The name of the output file. The file must not exist.
12191	</desc>
12192	</param>
12193	<param name="compression" type="wstring" dir="in">
12194	<desc>
12195	Reserved for future compression method indicator.
12196	</desc>
12197	</param>
12198	</method>
12199
12200	<method name="dumpHostProcessCore">
12201	<desc>
12202	Takes a core dump of the VM process on the host.
12203
12204	This feature is not implemented in the 4.0.0 release but it may show up
12205	in a dot release.
12206	</desc>
12207	<param name="filename" type="wstring" dir="in">
12208	<desc>
12209	The name of the output file. The file must not exist.
12210	</desc>
12211	</param>
12212	<param name="compression" type="wstring" dir="in">
12213	<desc>
12214	Reserved for future compression method indicator.
12215	</desc>
12216	</param>
12217	</method>
12218
12219	<method name="info">
12220	<desc>
12221	Interfaces with the info dumpers (DBGFInfo).
12222
12223	This feature is not implemented in the 4.0.0 release but it may show up
12224	in a dot release.
12225	</desc>
12226	<param name="name" type="wstring" dir="in">
12227	<desc>
12228	The name of the info item.
12229	</desc>
12230	</param>
12231	<param name="args" type="wstring" dir="in">
12232	<desc>
12233	Arguments to the info dumper.
12234	</desc>
12235	</param>
12236	<param name="info" type="wstring" dir="return">
12237	<desc>
12238	The into string.
12239	</desc>
12240	</param>
12241	</method>
12242
12243	<method name="injectNMI">
12244	<desc>
12245	Inject an NMI into a running VT-x/AMD-V VM.
12246	</desc>
12247	</method>
12248
12249	<method name="modifyLogGroups">
12250	<desc>
12251	Modifies the group settings of the debug logger.
12252
12253	This feature is not implemented in the 4.0.0 release but may show up
12254	in a dot release.
12255	</desc>
12256	<param name="settings" type="wstring" dir="in">
12257	<desc>The group settings string. See iprt/log.h for details.</desc>
12258	</param>
12259	</method>
12260
12261	<method name="modifyLogFlags">
12262	<desc>
12263	Modifies the debug logger flags.
12264
12265	This feature is not implemented in the 4.0.0 release but may show up
12266	in a dot release.
12267	</desc>
12268	<param name="settings" type="wstring" dir="in">
12269	<desc>The flags settings string. See iprt/log.h for details.</desc>
12270	</param>
12271	</method>
12272
12273	<method name="modifyLogDestinations">
12274	<desc>
12275	Modifies the debug logger destinations.
12276
12277	This feature is not implemented in the 4.0.0 release but may show up
12278	in a dot release.
12279	</desc>
12280	<param name="settings" type="wstring" dir="in">
12281	<desc>The destination settings string. See iprt/log.h for details.</desc>
12282	</param>
12283	</method>
12284
12285	<method name="readPhysicalMemory">
12286	<desc>
12287	Reads guest physical memory, no side effects (MMIO++).
12288
12289	This feature is not implemented in the 4.0.0 release but may show up
12290	in a dot release.
12291	</desc>
12292	<param name="address" type="long long" dir="in">
12293	<desc>The guest physical address.</desc>
12294	</param>
12295	<param name="size" type="unsigned long" dir="in">
12296	<desc>The number of bytes to read.</desc>
12297	</param>
12298	<param name="bytes" type="octet" safearray="yes" dir="return">
12299	<desc>The bytes read.</desc>
12300	</param>
12301	</method>
12302
12303	<method name="writePhysicalMemory">
12304	<desc>
12305	Writes guest physical memory, access handles (MMIO++) are ignored.
12306
12307	This feature is not implemented in the 4.0.0 release but may show up
12308	in a dot release.
12309	</desc>
12310	<param name="address" type="long long" dir="in">
12311	<desc>The guest physical address.</desc>
12312	</param>
12313	<param name="size" type="unsigned long" dir="in">
12314	<desc>The number of bytes to read.</desc>
12315	</param>
12316	<param name="bytes" type="octet" safearray="yes" dir="in">
12317	<desc>The bytes to write.</desc>
12318	</param>
12319	</method>
12320
12321	<method name="readVirtualMemory">
12322	<desc>
12323	Reads guest virtual memory, no side effects (MMIO++).
12324
12325	This feature is not implemented in the 4.0.0 release but may show up
12326	in a dot release.
12327	</desc>
12328	<param name="cpuId" type="unsigned long" dir="in">
12329	<desc>The identifier of the Virtual CPU.</desc>
12330	</param>
12331	<param name="address" type="long long" dir="in">
12332	<desc>The guest virtual address.</desc>
12333	</param>
12334	<param name="size" type="unsigned long" dir="in">
12335	<desc>The number of bytes to read.</desc>
12336	</param>
12337	<param name="bytes" type="octet" safearray="yes" dir="return">
12338	<desc>The bytes read.</desc>
12339	</param>
12340	</method>
12341
12342	<method name="writeVirtualMemory">
12343	<desc>
12344	Writes guest virtual memory, access handles (MMIO++) are ignored.
12345
12346	This feature is not implemented in the 4.0.0 release but may show up
12347	in a dot release.
12348	</desc>
12349	<param name="cpuId" type="unsigned long" dir="in">
12350	<desc>The identifier of the Virtual CPU.</desc>
12351	</param>
12352	<param name="address" type="long long" dir="in">
12353	<desc>The guest virtual address.</desc>
12354	</param>
12355	<param name="size" type="unsigned long" dir="in">
12356	<desc>The number of bytes to read.</desc>
12357	</param>
12358	<param name="bytes" type="octet" safearray="yes" dir="in">
12359	<desc>The bytes to write.</desc>
12360	</param>
12361	</method>
12362
12363	<method name="detectOS">
12364	<desc>
12365	Tries to (re-)detect the guest OS kernel.
12366
12367	This feature is not implemented in the 4.0.0 release but may show up
12368	in a dot release.
12369	</desc>
12370	<param name="os" type="wstring" dir="return">
12371	<desc>
12372	The detected OS kernel on success.
12373	</desc>
12374	</param>
12375	</method>
12376
12377	<method name="getRegister">
12378	<desc>
12379	Gets one register.
12380
12381	This feature is not implemented in the 4.0.0 release but may show up
12382	in a dot release.
12383	</desc>
12384	<param name="cpuId" type="unsigned long" dir="in">
12385	<desc>The identifier of the Virtual CPU.</desc>
12386	</param>
12387	<param name="name" type="wstring" dir="in">
12388	<desc>The register name, case is ignored.</desc>
12389	</param>
12390	<param name="value" type="wstring" dir="return">
12391	<desc>
12392	The register value. This is usually a hex value (always 0x prefixed)
12393	but other format may be used for floating point registers (TBD).
12394	</desc>
12395	</param>
12396	</method>
12397
12398	<method name="getRegisters">
12399	<desc>
12400	Gets all the registers for the given CPU.
12401
12402	This feature is not implemented in the 4.0.0 release but may show up
12403	in a dot release.
12404	</desc>
12405	<param name="cpuId" type="unsigned long" dir="in">
12406	<desc>The identifier of the Virtual CPU.</desc>
12407	</param>
12408	<param name="names" type="wstring" dir="out" safearray="yes">
12409	<desc>Array containing the lowercase register names.</desc>
12410	</param>
12411	<param name="values" type="wstring" dir="out" safearray="yes">
12412	<desc>
12413	Array paralell to the names holding the register values as if the
12414	register was returned by <link to="IMachineDebugger::getRegister"/>.
12415	</desc>
12416	</param>
12417	</method>
12418
12419	<method name="setRegister">
12420	<desc>
12421	Gets one register.
12422
12423	This feature is not implemented in the 4.0.0 release but may show up
12424	in a dot release.
12425	</desc>
12426	<param name="cpuId" type="unsigned long" dir="in">
12427	<desc>The identifier of the Virtual CPU.</desc>
12428	</param>
12429	<param name="name" type="wstring" dir="in">
12430	<desc>The register name, case is ignored.</desc>
12431	</param>
12432	<param name="value" type="wstring" dir="in">
12433	<desc>
12434	The new register value. Hexadecimal, decimal and octal formattings
12435	are supported in addition to any special formattings returned by
12436	the getters.
12437	</desc>
12438	</param>
12439	</method>
12440
12441	<method name="setRegisters">
12442	<desc>
12443	Sets zero or more registers atomically.
12444
12445	This feature is not implemented in the 4.0.0 release but may show up
12446	in a dot release.
12447	</desc>
12448	<param name="cpuId" type="unsigned long" dir="in">
12449	<desc>The identifier of the Virtual CPU.</desc>
12450	</param>
12451	<param name="names" type="wstring" dir="in" safearray="yes">
12452	<desc>Array containing the register names, case ignored.</desc>
12453	</param>
12454	<param name="values" type="wstring" dir="in" safearray="yes">
12455	<desc>
12456	Array paralell to the names holding the register values. See
12457	<link to="IMachineDebugger::setRegister"/> for formatting
12458	guidelines.
12459	</desc>
12460	</param>
12461	</method>
12462
12463	<method name="dumpGuestStack">
12464	<desc>
12465	Produce a simple stack dump using the current guest state.
12466
12467	This feature is not implemented in the 4.0.0 release but may show up
12468	in a dot release.
12469	</desc>
12470	<param name="cpuId" type="unsigned long" dir="in">
12471	<desc>The identifier of the Virtual CPU.</desc>
12472	</param>
12473	<param name="stack" type="wstring" dir="return">
12474	<desc>String containing the formatted stack dump.</desc>
12475	</param>
12476	</method>
12477
12478	<method name="resetStats">
12479	<desc>
12480	Reset VM statistics.
12481	</desc>
12482	<param name="pattern" type="wstring" dir="in">
12483	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12484	</param>
12485	</method>
12486
12487	<method name="dumpStats">
12488	<desc>
12489	Dumps VM statistics.
12490	</desc>
12491	<param name="pattern" type="wstring" dir="in">
12492	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12493	</param>
12494	</method>
12495
12496	<method name="getStats">
12497	<desc>
12498	Get the VM statistics in a XMLish format.
12499	</desc>
12500	<param name="pattern" type="wstring" dir="in">
12501	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12502	</param>
12503	<param name="withDescriptions" type="boolean" dir="in">
12504	<desc>Whether to include the descriptions.</desc>
12505	</param>
12506	<param name="stats" type="wstring" dir="out">
12507	<desc>The XML document containing the statistics.</desc>
12508	</param>
12509	</method>
12510
12511	<attribute name="singlestep" type="boolean">
12512	<desc>Switch for enabling singlestepping.</desc>
12513	</attribute>
12514
12515	<attribute name="recompileUser" type="boolean">
12516	<desc>Switch for forcing code recompilation for user mode code.</desc>
12517	</attribute>
12518
12519	<attribute name="recompileSupervisor" type="boolean">
12520	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
12521	</attribute>
12522
12523	<attribute name="PATMEnabled" type="boolean">
12524	<desc>Switch for enabling and disabling the PATM component.</desc>
12525	</attribute>
12526
12527	<attribute name="CSAMEnabled" type="boolean">
12528	<desc>Switch for enabling and disabling the CSAM component.</desc>
12529	</attribute>
12530
12531	<attribute name="logEnabled" type="boolean">
12532	<desc>Switch for enabling and disabling the debug logger.</desc>
12533	</attribute>
12534
12535	<attribute name="logFlags" type="wstring" readonly="yes">
12536	<desc>The debug logger flags.</desc>
12537	</attribute>
12538
12539	<attribute name="logGroups" type="wstring" readonly="yes">
12540	<desc>The debug logger's group settings.</desc>
12541	</attribute>
12542
12543	<attribute name="logDestinations" type="wstring" readonly="yes">
12544	<desc>The debug logger's destination settings.</desc>
12545	</attribute>
12546
12547	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
12548	<desc>
12549	Flag indicating whether the VM is currently making use of CPU hardware
12550	virtualization extensions.
12551	</desc>
12552	</attribute>
12553
12554	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
12555	<desc>
12556	Flag indicating whether the VM is currently making use of the nested paging
12557	CPU hardware virtualization extension.
12558	</desc>
12559	</attribute>
12560
12561	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
12562	<desc>
12563	Flag indicating whether the VM is currently making use of the VPID
12564	VT-x extension.
12565	</desc>
12566	</attribute>
12567
12568	<attribute name="OSName" type="wstring" readonly="yes">
12569	<desc>
12570	Query the guest OS kernel name as detected by the DBGF.
12571
12572	This feature is not implemented in the 4.0.0 release but may show up
12573	in a dot release.
12574	</desc>
12575	</attribute>
12576
12577	<attribute name="OSVersion" type="wstring" readonly="yes">
12578	<desc>
12579	Query the guest OS kernel version string as detected by the DBGF.
12580
12581	This feature is not implemented in the 4.0.0 release but may show up
12582	in a dot release.
12583	</desc>
12584	</attribute>
12585
12586	<attribute name="PAEEnabled" type="boolean" readonly="yes">
12587	<desc>
12588	Flag indicating whether the VM is currently making use of the Physical
12589	Address Extension CPU feature.
12590	</desc>
12591	</attribute>
12592
12593	<attribute name="virtualTimeRate" type="unsigned long">
12594	<desc>
12595	The rate at which the virtual time runs expressed as a percentage.
12596	The accepted range is 2% to 20000%.
12597	</desc>
12598	</attribute>
12599
12600	<attribute name="VM" type="long long" readonly="yes">
12601	<desc>
12602	Gets the VM handle. This is only for internal use while
12603	we carve the details of this interface.
12604	</desc>
12605	</attribute>
12606
12607	</interface>
12608
12609	<!--
12610	// IUSBController
12611	/////////////////////////////////////////////////////////////////////////
12612	-->
12613
12614	<interface
12615	name="IUSBController" extends="$unknown"
12616	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
12617	wsmap="managed"
12618	>
12619	<attribute name="enabled" type="boolean">
12620	<desc>
12621	Flag whether the USB controller is present in the
12622	guest system. If disabled, the virtual guest hardware will
12623	not contain any USB controller. Can only be changed when
12624	the VM is powered off.
12625	</desc>
12626	</attribute>
12627
12628	<attribute name="enabledEhci" type="boolean">
12629	<desc>
12630	Flag whether the USB EHCI controller is present in the
12631	guest system. If disabled, the virtual guest hardware will
12632	not contain a USB EHCI controller. Can only be changed when
12633	the VM is powered off.
12634	</desc>
12635	</attribute>
12636
12637	<attribute name="proxyAvailable" type="boolean" readonly="yes">
12638	<desc>
12639	Flag whether there is an USB proxy available.
12640	</desc>
12641	</attribute>
12642
12643	<attribute name="USBStandard" type="unsigned short" readonly="yes">
12644	<desc>
12645	USB standard version which the controller implements.
12646	This is a BCD which means that the major version is in the
12647	high byte and minor version is in the low byte.
12648	</desc>
12649	</attribute>
12650
12651	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
12652	<desc>
12653	List of USB device filters associated with the machine.
12654
12655	If the machine is currently running, these filters are activated
12656	every time a new (supported) USB device is attached to the host
12657	computer that was not ignored by global filters
12658	(<link to="IHost::USBDeviceFilters"/>).
12659
12660	These filters are also activated when the machine is powered up.
12661	They are run against a list of all currently available USB
12662	devices (in states
12663	<link to="USBDeviceState_Available"/>,
12664	<link to="USBDeviceState_Busy"/>,
12665	<link to="USBDeviceState_Held"/>) that were not previously
12666	ignored by global filters.
12667
12668	If at least one filter matches the USB device in question, this
12669	device is automatically captured (attached to) the virtual USB
12670	controller of this machine.
12671
12672	<see>IUSBDeviceFilter, ::IUSBController</see>
12673	</desc>
12674	</attribute>
12675
12676	<method name="createDeviceFilter">
12677	<desc>
12678	Creates a new USB device filter. All attributes except
12679	the filter name are set to empty (any match),
12680	<i>active</i> is @c false (the filter is not active).
12681
12682	The created filter can then be added to the list of filters using
12683	<link to="#insertDeviceFilter"/>.
12684
12685	<result name="VBOX_E_INVALID_VM_STATE">
12686	The virtual machine is not mutable.
12687	</result>
12688
12689	<see>#deviceFilters</see>
12690	</desc>
12691	<param name="name" type="wstring" dir="in">
12692	<desc>
12693	Filter name. See <link to="IUSBDeviceFilter::name"/>
12694	for more info.
12695	</desc>
12696	</param>
12697	<param name="filter" type="IUSBDeviceFilter" dir="return">
12698	<desc>Created filter object.</desc>
12699	</param>
12700	</method>
12701
12702	<method name="insertDeviceFilter">
12703	<desc>
12704	Inserts the given USB device to the specified position
12705	in the list of filters.
12706
12707	Positions are numbered starting from <tt>0</tt>. If the specified
12708	position is equal to or greater than the number of elements in
12709	the list, the filter is added to the end of the collection.
12710
12711	<note>
12712	Duplicates are not allowed, so an attempt to insert a
12713	filter that is already in the collection, will return an
12714	error.
12715	</note>
12716
12717	<result name="VBOX_E_INVALID_VM_STATE">
12718	Virtual machine is not mutable.
12719	</result>
12720	<result name="E_INVALIDARG">
12721	USB device filter not created within this VirtualBox instance.
12722	</result>
12723	<result name="VBOX_E_INVALID_OBJECT_STATE">
12724	USB device filter already in list.
12725	</result>
12726
12727	<see>#deviceFilters</see>
12728	</desc>
12729	<param name="position" type="unsigned long" dir="in">
12730	<desc>Position to insert the filter to.</desc>
12731	</param>
12732	<param name="filter" type="IUSBDeviceFilter" dir="in">
12733	<desc>USB device filter to insert.</desc>
12734	</param>
12735	</method>
12736
12737	<method name="removeDeviceFilter">
12738	<desc>
12739	Removes a USB device filter from the specified position in the
12740	list of filters.
12741
12742	Positions are numbered starting from <tt>0</tt>. Specifying a
12743	position equal to or greater than the number of elements in
12744	the list will produce an error.
12745
12746	<see>#deviceFilters</see>
12747
12748	<result name="VBOX_E_INVALID_VM_STATE">
12749	Virtual machine is not mutable.
12750	</result>
12751	<result name="E_INVALIDARG">
12752	USB device filter list empty or invalid @a position.
12753	</result>
12754
12755	</desc>
12756	<param name="position" type="unsigned long" dir="in">
12757	<desc>Position to remove the filter from.</desc>
12758	</param>
12759	<param name="filter" type="IUSBDeviceFilter" dir="return">
12760	<desc>Removed USB device filter.</desc>
12761	</param>
12762	</method>
12763
12764	</interface>
12765
12766
12767	<!--
12768	// IUSBDevice
12769	/////////////////////////////////////////////////////////////////////////
12770	-->
12771
12772	<interface
12773	name="IUSBDevice" extends="$unknown"
12774	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
12775	wsmap="managed"
12776	>
12777	<desc>
12778	The IUSBDevice interface represents a virtual USB device attached to the
12779	virtual machine.
12780
12781	A collection of objects implementing this interface is stored in the
12782	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
12783	attached to a running virtual machine's USB controller.
12784	</desc>
12785
12786	<attribute name="id" type="uuid" mod="string" readonly="yes">
12787	<desc>
12788	Unique USB device ID. This ID is built from #vendorId,
12789	#productId, #revision and #serialNumber.
12790	</desc>
12791	</attribute>
12792
12793	<attribute name="vendorId" type="unsigned short" readonly="yes">
12794	<desc>Vendor ID.</desc>
12795	</attribute>
12796
12797	<attribute name="productId" type="unsigned short" readonly="yes">
12798	<desc>Product ID.</desc>
12799	</attribute>
12800
12801	<attribute name="revision" type="unsigned short" readonly="yes">
12802	<desc>
12803	Product revision number. This is a packed BCD represented as
12804	unsigned short. The high byte is the integer part and the low
12805	byte is the decimal.
12806	</desc>
12807	</attribute>
12808
12809	<attribute name="manufacturer" type="wstring" readonly="yes">
12810	<desc>Manufacturer string.</desc>
12811	</attribute>
12812
12813	<attribute name="product" type="wstring" readonly="yes">
12814	<desc>Product string.</desc>
12815	</attribute>
12816
12817	<attribute name="serialNumber" type="wstring" readonly="yes">
12818	<desc>Serial number string.</desc>
12819	</attribute>
12820
12821	<attribute name="address" type="wstring" readonly="yes">
12822	<desc>Host specific address of the device.</desc>
12823	</attribute>
12824
12825	<attribute name="port" type="unsigned short" readonly="yes">
12826	<desc>
12827	Host USB port number the device is physically
12828	connected to.
12829	</desc>
12830	</attribute>
12831
12832	<attribute name="version" type="unsigned short" readonly="yes">
12833	<desc>
12834	The major USB version of the device - 1 or 2.
12835	</desc>
12836	</attribute>
12837
12838	<attribute name="portVersion" type="unsigned short" readonly="yes">
12839	<desc>
12840	The major USB version of the host USB port the device is
12841	physically connected to - 1 or 2. For devices not connected to
12842	anything this will have the same value as the version attribute.
12843	</desc>
12844	</attribute>
12845
12846	<attribute name="remote" type="boolean" readonly="yes">
12847	<desc>
12848	Whether the device is physically connected to a remote VRDE
12849	client or to a local host machine.
12850	</desc>
12851	</attribute>
12852
12853	</interface>
12854
12855
12856	<!--
12857	// IUSBDeviceFilter
12858	/////////////////////////////////////////////////////////////////////////
12859	-->
12860
12861	<interface
12862	name="IUSBDeviceFilter" extends="$unknown"
12863	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
12864	wsmap="managed"
12865	>
12866	<desc>
12867	The IUSBDeviceFilter interface represents an USB device filter used
12868	to perform actions on a group of USB devices.
12869
12870	This type of filters is used by running virtual machines to
12871	automatically capture selected USB devices once they are physically
12872	attached to the host computer.
12873
12874	A USB device is matched to the given device filter if and only if all
12875	attributes of the device match the corresponding attributes of the
12876	filter (that is, attributes are joined together using the logical AND
12877	operation). On the other hand, all together, filters in the list of
12878	filters carry the semantics of the logical OR operation. So if it is
12879	desirable to create a match like "this vendor id OR this product id",
12880	one needs to create two filters and specify "any match" (see below)
12881	for unused attributes.
12882
12883	All filter attributes used for matching are strings. Each string
12884	is an expression representing a set of values of the corresponding
12885	device attribute, that will match the given filter. Currently, the
12886	following filtering expressions are supported:
12887
12888	<ul>
12889	<li><i>Interval filters</i>. Used to specify valid intervals for
12890	integer device attributes (Vendor ID, Product ID and Revision).
12891	The format of the string is:
12892
12893	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
12894
12895	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
12896	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
12897	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
12898	is omitted before a dash (<tt>-</tt>), the minimum possible integer
12899	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
12900	possible integer is assumed.
12901	</li>
12902	<li><i>Boolean filters</i>. Used to specify acceptable values for
12903	boolean device attributes. The format of the string is:
12904
12905	<tt>true\|false\|yes\|no\|0\|1</tt>
12906
12907	</li>
12908	<li><i>Exact match</i>. Used to specify a single value for the given
12909	device attribute. Any string that doesn't start with <tt>int:</tt>
12910	represents the exact match. String device attributes are compared to
12911	this string including case of symbols. Integer attributes are first
12912	converted to a string (see individual filter attributes) and then
12913	compared ignoring case.
12914
12915	</li>
12916	<li><i>Any match</i>. Any value of the corresponding device attribute
12917	will match the given filter. An empty or @c null string is
12918	used to construct this type of filtering expressions.
12919
12920	</li>
12921	</ul>
12922
12923	<note>
12924	On the Windows host platform, interval filters are not currently
12925	available. Also all string filter attributes
12926	(<link to="#manufacturer"/>, <link to="#product"/>,
12927	<link to="#serialNumber"/>) are ignored, so they behave as
12928	<i>any match</i> no matter what string expression is specified.
12929	</note>
12930
12931	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
12932	</desc>
12933
12934	<attribute name="name" type="wstring">
12935	<desc>
12936	Visible name for this filter.
12937	This name is used to visually distinguish one filter from another,
12938	so it can neither be @c null nor an empty string.
12939	</desc>
12940	</attribute>
12941
12942	<attribute name="active" type="boolean">
12943	<desc>Whether this filter active or has been temporarily disabled.</desc>
12944	</attribute>
12945
12946	<attribute name="vendorId" type="wstring">
12947	<desc>
12948	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12949	The string representation for the <i>exact matching</i>
12950	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12951	(including leading zeroes).
12952	</desc>
12953	</attribute>
12954
12955	<attribute name="productId" type="wstring">
12956	<desc>
12957	<link to="IUSBDevice::productId">Product ID</link> filter.
12958	The string representation for the <i>exact matching</i>
12959	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12960	(including leading zeroes).
12961	</desc>
12962	</attribute>
12963
12964	<attribute name="revision" type="wstring">
12965	<desc>
12966	<link to="IUSBDevice::productId">Product revision number</link>
12967	filter. The string representation for the <i>exact matching</i>
12968	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12969	of the integer part of the revision, and <tt>F</tt> is the
12970	decimal digit of its fractional part (including leading and
12971	trailing zeros).
12972	Note that for interval filters, it's best to use the hexadecimal
12973	form, because the revision is stored as a 16 bit packed BCD value;
12974	so the expression <tt>int:0x0100-0x0199</tt> will match any
12975	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12976	</desc>
12977	</attribute>
12978
12979	<attribute name="manufacturer" type="wstring">
12980	<desc>
12981	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12982	</desc>
12983	</attribute>
12984
12985	<attribute name="product" type="wstring">
12986	<desc>
12987	<link to="IUSBDevice::product">Product</link> filter.
12988	</desc>
12989	</attribute>
12990
12991	<attribute name="serialNumber" type="wstring">
12992	<desc>
12993	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12994	</desc>
12995	</attribute>
12996
12997	<attribute name="port" type="wstring">
12998	<desc>
12999	<link to="IUSBDevice::port">Host USB port</link> filter.
13000	</desc>
13001	</attribute>
13002
13003	<attribute name="remote" type="wstring">
13004	<desc>
13005	<link to="IUSBDevice::remote">Remote state</link> filter.
13006	<note>
13007	This filter makes sense only for machine USB filters,
13008	i.e. it is ignored by IHostUSBDeviceFilter objects.
13009	</note>
13010	</desc>
13011	</attribute>
13012
13013	<attribute name="maskedInterfaces" type="unsigned long">
13014	<desc>
13015	This is an advanced option for hiding one or more USB interfaces
13016	from the guest. The value is a bit mask where the bits that are set
13017	means the corresponding USB interface should be hidden, masked off
13018	if you like.
13019	This feature only works on Linux hosts.
13020	</desc>
13021	</attribute>
13022
13023	</interface>
13024
13025
13026	<!--
13027	// IHostUSBDevice
13028	/////////////////////////////////////////////////////////////////////////
13029	-->
13030
13031	<enum
13032	name="USBDeviceState"
13033	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
13034	>
13035	<desc>
13036	USB device state. This enumeration represents all possible states
13037	of the USB device physically attached to the host computer regarding
13038	its state on the host computer and availability to guest computers
13039	(all currently running virtual machines).
13040
13041	Once a supported USB device is attached to the host, global USB
13042	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
13043	either ignore the device, or put it to USBDeviceState_Held state, or do
13044	nothing. Unless the device is ignored by global filters, filters of all
13045	currently running guests (<link to="IUSBController::deviceFilters"/>) are
13046	activated that can put it to USBDeviceState_Captured state.
13047
13048	If the device was ignored by global filters, or didn't match
13049	any filters at all (including guest ones), it is handled by the host
13050	in a normal way. In this case, the device state is determined by
13051	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
13052	or USBDeviceState_Available, depending on the current device usage.
13053
13054	Besides auto-capturing based on filters, the device can be manually
13055	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
13056	state is USBDeviceState_Busy, USBDeviceState_Available or
13057	USBDeviceState_Held.
13058
13059	<note>
13060	Due to differences in USB stack implementations in Linux and Win32,
13061	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
13062	only to the Linux version of the product. This also means that (<link
13063	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
13064	device state is USBDeviceState_Held.
13065	</note>
13066
13067	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
13068	</desc>
13069
13070	<const name="NotSupported" value="0">
13071	<desc>
13072	Not supported by the VirtualBox server, not available to guests.
13073	</desc>
13074	</const>
13075	<const name="Unavailable" value="1">
13076	<desc>
13077	Being used by the host computer exclusively,
13078	not available to guests.
13079	</desc>
13080	</const>
13081	<const name="Busy" value="2">
13082	<desc>
13083	Being used by the host computer, potentially available to guests.
13084	</desc>
13085	</const>
13086	<const name="Available" value="3">
13087	<desc>
13088	Not used by the host computer, available to guests (the host computer
13089	can also start using the device at any time).
13090	</desc>
13091	</const>
13092	<const name="Held" value="4">
13093	<desc>
13094	Held by the VirtualBox server (ignored by the host computer),
13095	available to guests.
13096	</desc>
13097	</const>
13098	<const name="Captured" value="5">
13099	<desc>
13100	Captured by one of the guest computers, not available
13101	to anybody else.
13102	</desc>
13103	</const>
13104	</enum>
13105
13106	<interface
13107	name="IHostUSBDevice" extends="IUSBDevice"
13108	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
13109	wsmap="managed"
13110	>
13111	<desc>
13112	The IHostUSBDevice interface represents a physical USB device attached
13113	to the host computer.
13114
13115	Besides properties inherited from IUSBDevice, this interface adds the
13116	<link to="#state"/> property that holds the current state of the USB
13117	device.
13118
13119	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
13120	</desc>
13121
13122	<attribute name="state" type="USBDeviceState" readonly="yes">
13123	<desc>
13124	Current state of the device.
13125	</desc>
13126	</attribute>
13127
13128	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
13129
13130	</interface>
13131
13132
13133	<!--
13134	// IHostUSBDeviceFilter
13135	/////////////////////////////////////////////////////////////////////////
13136	-->
13137
13138	<enum
13139	name="USBDeviceFilterAction"
13140	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
13141	>
13142	<desc>
13143	Actions for host USB device filters.
13144	<see>IHostUSBDeviceFilter, USBDeviceState</see>
13145	</desc>
13146
13147	<const name="Null" value="0">
13148	<desc>Null value (never used by the API).</desc>
13149	</const>
13150	<const name="Ignore" value="1">
13151	<desc>Ignore the matched USB device.</desc>
13152	</const>
13153	<const name="Hold" value="2">
13154	<desc>Hold the matched USB device.</desc>
13155	</const>
13156	</enum>
13157
13158	<interface
13159	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
13160	uuid="4cc70246-d74a-400f-8222-3900489c0374"
13161	wsmap="managed"
13162	>
13163	<desc>
13164	The IHostUSBDeviceFilter interface represents a global filter for a
13165	physical USB device used by the host computer. Used indirectly in
13166	<link to="IHost::USBDeviceFilters"/>.
13167
13168	Using filters of this type, the host computer determines the initial
13169	state of the USB device after it is physically attached to the
13170	host's USB controller.
13171
13172	<note>
13173	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
13174	filters, because it makes sense only for
13175	<link to="IUSBController::deviceFilters">machine USB filters</link>.
13176	</note>
13177
13178	<see>IHost::USBDeviceFilters</see>
13179	</desc>
13180
13181	<attribute name="action" type="USBDeviceFilterAction">
13182	<desc>
13183	Action performed by the host when an attached USB device
13184	matches this filter.
13185	</desc>
13186	</attribute>
13187
13188	</interface>
13189
13190	<!--
13191	// IAudioAdapter
13192	/////////////////////////////////////////////////////////////////////////
13193	-->
13194
13195	<enum
13196	name="AudioDriverType"
13197	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
13198	>
13199	<desc>
13200	Host audio driver type.
13201	</desc>
13202
13203	<const name="Null" value="0">
13204	<desc>Null value, also means "dummy audio driver".</desc>
13205	</const>
13206	<const name="WinMM" value="1">
13207	<desc>Windows multimedia (Windows hosts only).</desc>
13208	</const>
13209	<const name="OSS" value="2">
13210	<desc>Open Sound System (Linux hosts only).</desc>
13211	</const>
13212	<const name="ALSA" value="3">
13213	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
13214	</const>
13215	<const name="DirectSound" value="4">
13216	<desc>DirectSound (Windows hosts only).</desc>
13217	</const>
13218	<const name="CoreAudio" value="5">
13219	<desc>CoreAudio (Mac hosts only).</desc>
13220	</const>
13221	<const name="MMPM" value="6">
13222	<desc>Reserved for historical reasons.</desc>
13223	</const>
13224	<const name="Pulse" value="7">
13225	<desc>PulseAudio (Linux hosts only).</desc>
13226	</const>
13227	<const name="SolAudio" value="8">
13228	<desc>Solaris audio (Solaris hosts only).</desc>
13229	</const>
13230	</enum>
13231
13232	<enum
13233	name="AudioControllerType"
13234	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
13235	>
13236	<desc>
13237	Virtual audio controller type.
13238	</desc>
13239
13240	<const name="AC97" value="0"/>
13241	<const name="SB16" value="1"/>
13242	<const name="HDA" value="2"/>
13243	</enum>
13244
13245	<interface
13246	name="IAudioAdapter" extends="$unknown"
13247	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
13248	wsmap="managed"
13249	>
13250	<desc>
13251	The IAudioAdapter interface represents the virtual audio adapter of
13252	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
13253	</desc>
13254	<attribute name="enabled" type="boolean">
13255	<desc>
13256	Flag whether the audio adapter is present in the
13257	guest system. If disabled, the virtual guest hardware will
13258	not contain any audio adapter. Can only be changed when
13259	the VM is not running.
13260	</desc>
13261	</attribute>
13262	<attribute name="audioController" type="AudioControllerType">
13263	<desc>
13264	The audio hardware we emulate.
13265	</desc>
13266	</attribute>
13267	<attribute name="audioDriver" type="AudioDriverType">
13268	<desc>
13269	Audio driver the adapter is connected to. This setting
13270	can only be changed when the VM is not running.
13271	</desc>
13272	</attribute>
13273	</interface>
13274
13275	<enum
13276	name="AuthType"
13277	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
13278	>
13279	<desc>
13280	VirtualBox authentication type.
13281	</desc>
13282
13283	<const name="Null" value="0">
13284	<desc>Null value, also means "no authentication".</desc>
13285	</const>
13286	<const name="External" value="1"/>
13287	<const name="Guest" value="2"/>
13288	</enum>
13289
13290	<!--
13291	// IVRDEServer
13292	/////////////////////////////////////////////////////////////////////////
13293	-->
13294
13295	<interface
13296	name="IVRDEServer" extends="$unknown"
13297	uuid="be24e0db-e1d6-4d58-b85b-21053d1511b4"
13298	wsmap="managed"
13299	>
13300	<attribute name="enabled" type="boolean">
13301	<desc>VRDE server status.</desc>
13302	</attribute>
13303
13304	<attribute name="authType" type="AuthType">
13305	<desc>VRDE authentication method.</desc>
13306	</attribute>
13307
13308	<attribute name="authTimeout" type="unsigned long">
13309	<desc>Timeout for guest authentication. Milliseconds.</desc>
13310	</attribute>
13311
13312	<attribute name="allowMultiConnection" type="boolean">
13313	<desc>
13314	Flag whether multiple simultaneous connections to the VM are permitted.
13315	Note that this will be replaced by a more powerful mechanism in the future.
13316	</desc>
13317	</attribute>
13318
13319	<attribute name="reuseSingleConnection" type="boolean">
13320	<desc>
13321	Flag whether the existing connection must be dropped and a new connection
13322	must be established by the VRDE server, when a new client connects in single
13323	connection mode.
13324	</desc>
13325	</attribute>
13326
13327	<attribute name="VRDEExtPack" type="wstring">
13328	<desc>
13329	The name of Extension Pack providing VRDE for this VM. Overrides
13330	<link to="ISystemProperties::defaultVRDEExtPack"/>.
13331	</desc>
13332	</attribute>
13333
13334	<attribute name="AuthLibrary" type="wstring">
13335	<desc>
13336	Library used for authentication of RDP clients by this VM. Overrides
13337	<link to="ISystemProperties::VRDEAuthLibrary"/>.
13338	</desc>
13339	</attribute>
13340
13341	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
13342	<desc>
13343	Array of names of properties, which are supported by this VRDE server.
13344	</desc>
13345	</attribute>
13346
13347	<method name="setVRDEProperty">
13348	<desc>
13349	Sets a VRDE specific property string.
13350
13351	If you pass @c null or empty string as a key @a value, the given @a key
13352	will be deleted.
13353
13354	</desc>
13355	<param name="key" type="wstring" dir="in">
13356	<desc>Name of the key to set.</desc>
13357	</param>
13358	<param name="value" type="wstring" dir="in">
13359	<desc>Value to assign to the key.</desc>
13360	</param>
13361	</method>
13362
13363	<method name="getVRDEProperty">
13364	<desc>
13365	Returns a VRDE specific property string.
13366
13367	If the requested data @a key does not exist, this function will
13368	succeed and return an empty string in the @a value argument.
13369
13370	</desc>
13371	<param name="key" type="wstring" dir="in">
13372	<desc>Name of the key to get.</desc>
13373	</param>
13374	<param name="value" type="wstring" dir="return">
13375	<desc>Value of the requested key.</desc>
13376	</param>
13377	</method>
13378
13379	</interface>
13380
13381
13382	<!--
13383	// ISharedFolder
13384	/////////////////////////////////////////////////////////////////////////
13385	-->
13386
13387	<interface
13388	name="ISharedFolder" extends="$unknown"
13389	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
13390	wsmap="struct"
13391	>
13392	<desc>
13393	The ISharedFolder interface represents a folder in the host computer's
13394	file system accessible from the guest OS running inside a virtual
13395	machine using an associated logical name.
13396
13397	There are three types of shared folders:
13398	<ul>
13399	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
13400	folders available to all virtual machines.</li>
13401	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
13402	VM-specific shared folders available to the given virtual machine at
13403	startup.</li>
13404	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
13405	VM-specific shared folders created in the session context (for
13406	example, when the virtual machine is running) and automatically
13407	discarded when the session is closed (the VM is powered off).</li>
13408	</ul>
13409
13410	Logical names of shared folders must be unique within the given scope
13411	(global, permanent or transient). However, they do not need to be unique
13412	across scopes. In this case, the definition of the shared folder in a
13413	more specific scope takes precedence over definitions in all other
13414	scopes. The order of precedence is (more specific to more general):
13415	<ol>
13416	<li>Transient definitions</li>
13417	<li>Permanent definitions</li>
13418	<li>Global definitions</li>
13419	</ol>
13420
13421	For example, if MyMachine has a shared folder named
13422	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
13423	transient shared folder named <tt>C_DRIVE</tt> (that points
13424	to <tt>C:\\\\WINDOWS</tt>) will change the definition
13425	of <tt>C_DRIVE</tt> in the guest OS so
13426	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
13427	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
13428	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
13429	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
13430	to <tt>C:\\</tt> if it still exists.
13431
13432	Note that permanent and transient shared folders of different machines
13433	are in different name spaces, so they don't overlap and don't need to
13434	have unique logical names.
13435
13436	<note>
13437	Global shared folders are not implemented in the current version of the
13438	product.
13439	</note>
13440	</desc>
13441
13442	<attribute name="name" type="wstring" readonly="yes">
13443	<desc>Logical name of the shared folder.</desc>
13444	</attribute>
13445
13446	<attribute name="hostPath" type="wstring" readonly="yes">
13447	<desc>Full path to the shared folder in the host file system.</desc>
13448	</attribute>
13449
13450	<attribute name="accessible" type="boolean" readonly="yes">
13451	<desc>
13452	Whether the folder defined by the host path is currently
13453	accessible or not.
13454	For example, the folder can be inaccessible if it is placed
13455	on the network share that is not available by the time
13456	this property is read.
13457	</desc>
13458	</attribute>
13459
13460	<attribute name="writable" type="boolean" readonly="yes">
13461	<desc>
13462	Whether the folder defined by the host path is writable or
13463	not.
13464	</desc>
13465	</attribute>
13466
13467	<attribute name="autoMount" type="boolean" readonly="yes">
13468	<desc>
13469	Whether the folder gets automatically mounted by the guest or not.
13470	</desc>
13471	</attribute>
13472
13473	<attribute name="lastAccessError" type="wstring" readonly="yes">
13474	<desc>
13475	Text message that represents the result of the last accessibility
13476	check.
13477
13478	Accessibility checks are performed each time the <link to="#accessible"/>
13479	attribute is read. An empty string is returned if the last
13480	accessibility check was successful. A non-empty string indicates a
13481	failure and should normally describe a reason of the failure (for
13482	example, a file read error).
13483	</desc>
13484	</attribute>
13485
13486	</interface>
13487
13488	<!--
13489	// ISession
13490	/////////////////////////////////////////////////////////////////////////
13491	-->
13492
13493	<interface
13494	name="IInternalSessionControl" extends="$unknown"
13495	uuid="a2fbf834-149d-41da-ae52-0dc3b0f032b3"
13496	internal="yes"
13497	wsmap="suppress"
13498	>
13499	<method name="getPID">
13500	<desc>PID of the process that has created this Session object.
13501	</desc>
13502	<param name="pid" type="unsigned long" dir="return"/>
13503	</method>
13504
13505	<method name="getRemoteConsole">
13506	<desc>
13507	Returns the console object suitable for remote control.
13508
13509	<result name="VBOX_E_INVALID_VM_STATE">
13510	Session state prevents operation.
13511	</result>
13512	<result name="VBOX_E_INVALID_OBJECT_STATE">
13513	Session type prevents operation.
13514	</result>
13515
13516	</desc>
13517	<param name="console" type="IConsole" dir="return"/>
13518	</method>
13519
13520	<method name="assignMachine">
13521	<desc>
13522	Assigns the machine object associated with this direct-type
13523	session or informs the session that it will be a remote one
13524	(if @a machine == @c null).
13525
13526	<result name="VBOX_E_INVALID_VM_STATE">
13527	Session state prevents operation.
13528	</result>
13529	<result name="VBOX_E_INVALID_OBJECT_STATE">
13530	Session type prevents operation.
13531	</result>
13532
13533	</desc>
13534	<param name="machine" type="IMachine" dir="in"/>
13535	</method>
13536
13537	<method name="assignRemoteMachine">
13538	<desc>
13539	Assigns the machine and the (remote) console object associated with
13540	this remote-type session.
13541
13542	<result name="VBOX_E_INVALID_VM_STATE">
13543	Session state prevents operation.
13544	</result>
13545
13546	</desc>
13547	<param name="machine" type="IMachine" dir="in"/>
13548	<param name="console" type="IConsole" dir="in"/>
13549	</method>
13550
13551	<method name="updateMachineState">
13552	<desc>
13553	Updates the machine state in the VM process.
13554	Must be called only in certain cases
13555	(see the method implementation).
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="aMachineState" type="MachineState" dir="in"/>
13566	</method>
13567
13568	<method name="uninitialize">
13569	<desc>
13570	Uninitializes (closes) this session. Used by VirtualBox to close
13571	the corresponding remote session when the direct session dies
13572	or gets closed.
13573
13574	<result name="VBOX_E_INVALID_VM_STATE">
13575	Session state prevents operation.
13576	</result>
13577
13578	</desc>
13579	</method>
13580
13581	<method name="onNetworkAdapterChange">
13582	<desc>
13583	Triggered when settings of a network adapter of the
13584	associated virtual machine have changed.
13585
13586	<result name="VBOX_E_INVALID_VM_STATE">
13587	Session state prevents operation.
13588	</result>
13589	<result name="VBOX_E_INVALID_OBJECT_STATE">
13590	Session type prevents operation.
13591	</result>
13592
13593	</desc>
13594	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
13595	<param name="changeAdapter" type="boolean" dir="in"/>
13596	</method>
13597
13598	<method name="onSerialPortChange">
13599	<desc>
13600	Triggered when settings of a serial port of the
13601	associated virtual machine have changed.
13602
13603	<result name="VBOX_E_INVALID_VM_STATE">
13604	Session state prevents operation.
13605	</result>
13606	<result name="VBOX_E_INVALID_OBJECT_STATE">
13607	Session type prevents operation.
13608	</result>
13609
13610	</desc>
13611	<param name="serialPort" type="ISerialPort" dir="in"/>
13612	</method>
13613
13614	<method name="onParallelPortChange">
13615	<desc>
13616	Triggered when settings of a parallel port of the
13617	associated virtual machine have changed.
13618
13619	<result name="VBOX_E_INVALID_VM_STATE">
13620	Session state prevents operation.
13621	</result>
13622	<result name="VBOX_E_INVALID_OBJECT_STATE">
13623	Session type prevents operation.
13624	</result>
13625
13626	</desc>
13627	<param name="parallelPort" type="IParallelPort" dir="in"/>
13628	</method>
13629
13630	<method name="onStorageControllerChange">
13631	<desc>
13632	Triggered when settings of a storage controller of the
13633	associated virtual machine have changed.
13634
13635	<result name="VBOX_E_INVALID_VM_STATE">
13636	Session state prevents operation.
13637	</result>
13638	<result name="VBOX_E_INVALID_OBJECT_STATE">
13639	Session type prevents operation.
13640	</result>
13641
13642	</desc>
13643	</method>
13644
13645	<method name="onMediumChange">
13646	<desc>
13647	Triggered when attached media of the
13648	associated virtual machine have changed.
13649
13650	<result name="VBOX_E_INVALID_VM_STATE">
13651	Session state prevents operation.
13652	</result>
13653	<result name="VBOX_E_INVALID_OBJECT_STATE">
13654	Session type prevents operation.
13655	</result>
13656
13657	</desc>
13658
13659	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
13660	<param name="force" type="boolean" dir="in"/>
13661	</method>
13662
13663	<method name="onCPUChange">
13664	<desc>
13665	Notification when a CPU changes.
13666	</desc>
13667	<param name="cpu" type="unsigned long" dir="in">
13668	<desc>The CPU which changed</desc>
13669	</param>
13670	<param name="add" type="boolean" dir="in">
13671	<desc>Flag whether the CPU was added or removed</desc>
13672	</param>
13673	</method>
13674
13675	<method name="onCPUExecutionCapChange">
13676	<desc>
13677	Notification when the CPU execution cap changes.
13678	</desc>
13679	<param name="executionCap" type="unsigned long" dir="in">
13680	<desc>The new CPU execution cap value. (1-100)</desc>
13681	</param>
13682	</method>
13683
13684	<method name="onVRDEServerChange">
13685	<desc>
13686	Triggered when settings of the VRDE server object of the
13687	associated virtual machine have changed.
13688
13689	<result name="VBOX_E_INVALID_VM_STATE">
13690	Session state prevents operation.
13691	</result>
13692	<result name="VBOX_E_INVALID_OBJECT_STATE">
13693	Session type prevents operation.
13694	</result>
13695
13696	</desc>
13697	<param name="restart" type="boolean" dir="in">
13698	<desc>Flag whether the server must be restarted</desc>
13699	</param>
13700	</method>
13701
13702	<method name="onUSBControllerChange">
13703	<desc>
13704	Triggered when settings of the USB controller object of the
13705	associated virtual machine have changed.
13706
13707	<result name="VBOX_E_INVALID_VM_STATE">
13708	Session state prevents operation.
13709	</result>
13710	<result name="VBOX_E_INVALID_OBJECT_STATE">
13711	Session type prevents operation.
13712	</result>
13713
13714	</desc>
13715	</method>
13716
13717	<method name="onSharedFolderChange">
13718	<desc>
13719	Triggered when a permanent (global or machine) shared folder has been
13720	created or removed.
13721	<note>
13722	We don't pass shared folder parameters in this notification because
13723	the order in which parallel notifications are delivered is not defined,
13724	therefore it could happen that these parameters were outdated by the
13725	time of processing this notification.
13726	</note>
13727
13728	<result name="VBOX_E_INVALID_VM_STATE">
13729	Session state prevents operation.
13730	</result>
13731	<result name="VBOX_E_INVALID_OBJECT_STATE">
13732	Session type prevents operation.
13733	</result>
13734
13735	</desc>
13736	<param name="global" type="boolean" dir="in"/>
13737	</method>
13738
13739	<method name="onUSBDeviceAttach">
13740	<desc>
13741	Triggered when a request to capture a USB device (as a result
13742	of matched USB filters or direct call to
13743	<link to="IConsole::attachUSBDevice"/>) has completed.
13744	A @c null @a error object means success, otherwise it
13745	describes a failure.
13746
13747	<result name="VBOX_E_INVALID_VM_STATE">
13748	Session state prevents operation.
13749	</result>
13750	<result name="VBOX_E_INVALID_OBJECT_STATE">
13751	Session type prevents operation.
13752	</result>
13753
13754	</desc>
13755	<param name="device" type="IUSBDevice" dir="in"/>
13756	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13757	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
13758	</method>
13759
13760	<method name="onUSBDeviceDetach">
13761	<desc>
13762	Triggered when a request to release the USB device (as a result
13763	of machine termination or direct call to
13764	<link to="IConsole::detachUSBDevice"/>) has completed.
13765	A @c null @a error object means success, otherwise it
13766	describes a failure.
13767
13768	<result name="VBOX_E_INVALID_VM_STATE">
13769	Session state prevents operation.
13770	</result>
13771	<result name="VBOX_E_INVALID_OBJECT_STATE">
13772	Session type prevents operation.
13773	</result>
13774
13775	</desc>
13776	<param name="id" type="uuid" mod="string" dir="in"/>
13777	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13778	</method>
13779
13780	<method name="onShowWindow">
13781	<desc>
13782	Called by <link to="IMachine::canShowConsoleWindow"/> and by
13783	<link to="IMachine::showConsoleWindow"/> in order to notify
13784	console listeners
13785	<link to="ICanShowWindowEvent"/>
13786	and <link to="IShowWindowEvent"/>.
13787
13788	<result name="VBOX_E_INVALID_OBJECT_STATE">
13789	Session type prevents operation.
13790	</result>
13791
13792	</desc>
13793	<param name="check" type="boolean" dir="in"/>
13794	<param name="canShow" type="boolean" dir="out"/>
13795	<param name="winId" type="long long" dir="out"/>
13796	</method>
13797
13798	<method name="onBandwidthGroupChange">
13799	<desc>
13800	Notification when one of the bandwidth groups change.
13801	</desc>
13802	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
13803	<desc>The bandwidth group which changed.</desc>
13804	</param>
13805	</method>
13806
13807	<method name="accessGuestProperty">
13808	<desc>
13809	Called by <link to="IMachine::getGuestProperty"/> and by
13810	<link to="IMachine::setGuestProperty"/> in order to read and
13811	modify guest properties.
13812
13813	<result name="VBOX_E_INVALID_VM_STATE">
13814	Machine session is not open.
13815	</result>
13816	<result name="VBOX_E_INVALID_OBJECT_STATE">
13817	Session type is not direct.
13818	</result>
13819
13820	</desc>
13821	<param name="name" type="wstring" dir="in"/>
13822	<param name="value" type="wstring" dir="in"/>
13823	<param name="flags" type="wstring" dir="in"/>
13824	<param name="isSetter" type="boolean" dir="in"/>
13825	<param name="retValue" type="wstring" dir="out"/>
13826	<param name="retTimestamp" type="long long" dir="out"/>
13827	<param name="retFlags" type="wstring" dir="out"/>
13828	</method>
13829
13830	<method name="enumerateGuestProperties">
13831	<desc>
13832	Return a list of the guest properties matching a set of patterns along
13833	with their values, time stamps and flags.
13834
13835	<result name="VBOX_E_INVALID_VM_STATE">
13836	Machine session is not open.
13837	</result>
13838	<result name="VBOX_E_INVALID_OBJECT_STATE">
13839	Session type is not direct.
13840	</result>
13841
13842	</desc>
13843	<param name="patterns" type="wstring" dir="in">
13844	<desc>
13845	The patterns to match the properties against as a comma-separated
13846	string. If this is empty, all properties currently set will be
13847	returned.
13848	</desc>
13849	</param>
13850	<param name="key" type="wstring" dir="out" safearray="yes">
13851	<desc>
13852	The key names of the properties returned.
13853	</desc>
13854	</param>
13855	<param name="value" type="wstring" dir="out" safearray="yes">
13856	<desc>
13857	The values of the properties returned. The array entries match the
13858	corresponding entries in the @a key array.
13859	</desc>
13860	</param>
13861	<param name="timestamp" type="long long" dir="out" safearray="yes">
13862	<desc>
13863	The time stamps of the properties returned. The array entries match
13864	the corresponding entries in the @a key array.
13865	</desc>
13866	</param>
13867	<param name="flags" type="wstring" dir="out" safearray="yes">
13868	<desc>
13869	The flags of the properties returned. The array entries match the
13870	corresponding entries in the @a key array.
13871	</desc>
13872	</param>
13873	</method>
13874
13875	<method name="onlineMergeMedium">
13876	<desc>
13877	Triggers online merging of a hard disk. Used internally when deleting
13878	a snapshot while a VM referring to the same hard disk chain is running.
13879
13880	<result name="VBOX_E_INVALID_VM_STATE">
13881	Machine session is not open.
13882	</result>
13883	<result name="VBOX_E_INVALID_OBJECT_STATE">
13884	Session type is not direct.
13885	</result>
13886
13887	</desc>
13888	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
13889	<desc>The medium attachment to identify the medium chain.</desc>
13890	</param>
13891	<param name="sourceIdx" type="unsigned long" dir="in">
13892	<desc>The index of the source image in the chain.
13893	Redundant, but drastically reduces IPC.</desc>
13894	</param>
13895	<param name="targetIdx" type="unsigned long" dir="in">
13896	<desc>The index of the target image in the chain.
13897	Redundant, but drastically reduces IPC.</desc>
13898	</param>
13899	<param name="source" type="IMedium" dir="in">
13900	<desc>Merge source medium.</desc>
13901	</param>
13902	<param name="target" type="IMedium" dir="in">
13903	<desc>Merge target medium.</desc>
13904	</param>
13905	<param name="mergeForward" type="boolean" dir="in">
13906	<desc>Merge direction.</desc>
13907	</param>
13908	<param name="parentForTarget" type="IMedium" dir="in">
13909	<desc>For forward merges: new parent for target medium.</desc>
13910	</param>
13911	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
13912	<desc>For backward merges: list of media which need their parent UUID
13913	updated.</desc>
13914	</param>
13915	<param name="progress" type="IProgress" dir="in">
13916	<desc>
13917	Progress object for this operation.
13918	</desc>
13919	</param>
13920	</method>
13921
13922	</interface>
13923
13924	<interface
13925	name="ISession" extends="$unknown"
13926	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
13927	wsmap="managed"
13928	>
13929	<desc>
13930	The ISession interface represents a client process and allows for locking
13931	virtual machines (represented by IMachine objects) to prevent conflicting
13932	changes to the machine.
13933
13934	Any caller wishing to manipulate a virtual machine needs to create a session
13935	object first, which lives in its own process space. Such session objects are
13936	then associated with <link to="IMachine" /> objects living in the VirtualBox
13937	server process to coordinate such changes.
13938
13939	There are two typical scenarios in which sessions are used:
13940
13941	<ul>
13942	<li>To alter machine settings or control a running virtual machine, one
13943	needs to lock a machine for a given session (client process) by calling
13944	<link to="IMachine::lockMachine"/>.
13945
13946	Whereas multiple sessions may control a running virtual machine, only
13947	one process can obtain a write lock on the machine to prevent conflicting
13948	changes. A write lock is also needed if a process wants to actually run a
13949	virtual machine in its own context, such as the VirtualBox GUI or
13950	VBoxHeadless front-ends. They must also lock a machine for their own
13951	sessions before they are allowed to power up the virtual machine.
13952
13953	As a result, no machine settings can be altered while another process is
13954	already using it, either because that process is modifying machine settings
13955	or because the machine is running.
13956	</li>
13957	<li>
13958	To start a VM using one of the existing VirtualBox front-ends (e.g. the
13959	VirtualBox GUI or VBoxHeadless), one would use
13960	<link to="IMachine::launchVMProcess"/>, which also takes a session object
13961	as its first parameter. This session then identifies the caller and lets the
13962	caller control the started machine (for example, pause machine execution or
13963	power it down) as well as be notified about machine execution state changes.
13964	</li>
13965	</ul>
13966
13967	How sessions objects are created in a client process depends on whether you use
13968	the Main API via COM or via the webservice:
13969
13970	<ul>
13971	<li>When using the COM API directly, an object of the Session class from the
13972	VirtualBox type library needs to be created. In regular COM C++ client code,
13973	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
13974	This object will then act as a local session object in further calls to open
13975	a session.
13976	</li>
13977
13978	<li>In the webservice, the session manager (IWebsessionManager) instead creates
13979	a session object automatically whenever <link to="IWebsessionManager::logon" />
13980	is called. A managed object reference to that session object can be retrieved by
13981	calling <link to="IWebsessionManager::getSessionObject" />.
13982	</li>
13983	</ul>
13984	</desc>
13985
13986	<attribute name="state" type="SessionState" readonly="yes">
13987	<desc>Current state of this session.</desc>
13988	</attribute>
13989
13990	<attribute name="type" type="SessionType" readonly="yes">
13991	<desc>
13992	Type of this session. The value of this attribute is valid only
13993	if the session currently has a machine locked (i.e. its
13994	<link to="#state" /> is Locked), otherwise an error will be returned.
13995	</desc>
13996	</attribute>
13997
13998	<attribute name="machine" type="IMachine" readonly="yes">
13999	<desc>Machine object associated with this session.</desc>
14000	</attribute>
14001
14002	<attribute name="console" type="IConsole" readonly="yes">
14003	<desc>Console object associated with this session.</desc>
14004	</attribute>
14005
14006	<method name="unlockMachine">
14007	<desc>
14008	Unlocks a machine that was previously locked for the current session.
14009
14010	Calling this method is required every time a machine has been locked
14011	for a particular session using the <link to="IMachine::launchVMProcess" />
14012	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
14013	the machine will be set to <link to="MachineState_Aborted" /> on the
14014	server, and changes made to the machine settings will be lost.
14015
14016	Generally, it is recommended to unlock all machines explicitly
14017	before terminating the application (regardless of the reason for
14018	the termination).
14019
14020	<note>
14021	Do not expect the session state (<link to="ISession::state" />
14022	to return to "Unlocked" immediately after you invoke this method,
14023	particularly if you have started a new VM process. The session
14024	state will automatically return to "Unlocked" once the VM is no
14025	longer executing, which can of course take a very long time.
14026	</note>
14027
14028	<result name="E_UNEXPECTED">
14029	Session is not locked.
14030	</result>
14031
14032	</desc>
14033	</method>
14034
14035	</interface>
14036
14037	<!--
14038	// IStorageController
14039	/////////////////////////////////////////////////////////////////////////
14040	-->
14041
14042	<enum
14043	name="StorageBus"
14044	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
14045	>
14046	<desc>
14047	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
14048	see <link to="IStorageController::bus" />.
14049	</desc>
14050	<const name="Null" value="0">
14051	<desc>@c null value. Never used by the API.</desc>
14052	</const>
14053	<const name="IDE" value="1"/>
14054	<const name="SATA" value="2"/>
14055	<const name="SCSI" value="3"/>
14056	<const name="Floppy" value="4"/>
14057	<const name="SAS" value="5"/>
14058	</enum>
14059
14060	<enum
14061	name="StorageControllerType"
14062	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
14063	>
14064	<desc>
14065	The exact variant of storage controller hardware presented
14066	to the guest; see <link to="IStorageController::controllerType" />.
14067	</desc>
14068
14069	<const name="Null" value="0">
14070	<desc>@c null value. Never used by the API.</desc>
14071	</const>
14072	<const name="LsiLogic" value="1">
14073	<desc>A SCSI controller of the LsiLogic variant.</desc>
14074	</const>
14075	<const name="BusLogic" value="2">
14076	<desc>A SCSI controller of the BusLogic variant.</desc>
14077	</const>
14078	<const name="IntelAhci" value="3">
14079	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
14080	</const>
14081	<const name="PIIX3" value="4">
14082	<desc>An IDE controller of the PIIX3 variant.</desc>
14083	</const>
14084	<const name="PIIX4" value="5">
14085	<desc>An IDE controller of the PIIX4 variant.</desc>
14086	</const>
14087	<const name="ICH6" value="6">
14088	<desc>An IDE controller of the ICH6 variant.</desc>
14089	</const>
14090	<const name="I82078" value="7">
14091	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
14092	</const>
14093	<const name="LsiLogicSas" value="8">
14094	<desc>A variant of the LsiLogic controller using SAS.</desc>
14095	</const>
14096	</enum>
14097
14098	<enum
14099	name="ChipsetType"
14100	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
14101	>
14102	<desc>
14103	Type of emulated chipset (mostly southbridge).
14104	</desc>
14105
14106	<const name="Null" value="0">
14107	<desc>@c null value. Never used by the API.</desc>
14108	</const>
14109	<const name="PIIX3" value="1">
14110	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
14111	</const>
14112	<const name="ICH9" value="2">
14113	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
14114	</const>
14115	</enum>
14116
14117	<interface
14118	name="IStorageController" extends="$unknown"
14119	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
14120	wsmap="managed"
14121	>
14122	<desc>
14123	Represents a storage controller that is attached to a virtual machine
14124	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
14125	attached to storage controllers in a real computer, virtual drives
14126	(represented by <link to="IMediumAttachment" />) are attached to virtual
14127	storage controllers, represented by this interface.
14128
14129	As opposed to physical hardware, VirtualBox has a very generic concept
14130	of a storage controller, and for purposes of the Main API, all virtual
14131	storage is attached to virtual machines via instances of this interface.
14132	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
14133	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
14134	is used, certain sub-types may be available and can be selected in
14135	<link to="#controllerType" />.
14136
14137	Depending on these settings, the guest operating system might see
14138	significantly different virtual hardware.
14139	</desc>
14140
14141	<attribute name="name" type="wstring" readonly="yes">
14142	<desc>
14143	Name of the storage controller, as originally specified with
14144	<link to="IMachine::addStorageController" />. This then uniquely
14145	identifies this controller with other method calls such as
14146	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
14147	</desc>
14148	</attribute>
14149
14150	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
14151	<desc>
14152	Maximum number of devices which can be attached to one port.
14153	</desc>
14154	</attribute>
14155
14156	<attribute name="minPortCount" type="unsigned long" readonly="yes">
14157	<desc>
14158	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
14159	</desc>
14160	</attribute>
14161
14162	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
14163	<desc>
14164	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
14165	</desc>
14166	</attribute>
14167
14168	<attribute name="instance" type="unsigned long">
14169	<desc>
14170	The instance number of the device in the running VM.
14171	</desc>
14172	</attribute>
14173
14174	<attribute name="portCount" type="unsigned long">
14175	<desc>
14176	The number of currently usable ports on the controller.
14177	The minimum and maximum number of ports for one controller are
14178	stored in <link to="IStorageController::minPortCount"/>
14179	and <link to="IStorageController::maxPortCount"/>.
14180	</desc>
14181	</attribute>
14182
14183	<attribute name="bus" type="StorageBus" readonly="yes">
14184	<desc>
14185	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
14186	</desc>
14187	</attribute>
14188
14189	<attribute name="controllerType" type="StorageControllerType">
14190	<desc>
14191	The exact variant of storage controller hardware presented
14192	to the guest.
14193	Depending on this value, VirtualBox will provide a different
14194	virtual storage controller hardware to the guest.
14195	For SATA, SAS and floppy controllers, only one variant is
14196	available, but for IDE and SCSI, there are several.
14197
14198	For SCSI controllers, the default type is LsiLogic.
14199	</desc>
14200	</attribute>
14201
14202	<attribute name="useHostIOCache" type="boolean">
14203	<desc>
14204	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
14205	caches and use synchronous file APIs on the host. This was the only option in the API before
14206	VirtualBox 3.2 and is still the default for IDE controllers.
14207
14208	If false, the host I/O cache will be disabled for image files attached to this storage controller.
14209	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
14210	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
14211	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
14212	virtual machines are running at the same time to prevent I/O cache related hangs.
14213	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
14214	</desc>
14215	</attribute>
14216
14217	<attribute name="bootable" type="boolean" readonly="yes">
14218	<desc>
14219	Returns whether it is possible to boot from disks attached to this controller.
14220	</desc>
14221	</attribute>
14222
14223	<method name="getIDEEmulationPort">
14224	<desc>
14225	Gets the corresponding port number which is emulated as an IDE device.
14226	Works only with SATA controllers.
14227
14228	<result name="E_INVALIDARG">
14229	The @a devicePosition is not in the range 0 to 3.
14230	</result>
14231	<result name="E_NOTIMPL">
14232	The storage controller type is not SATAIntelAhci.
14233	</result>
14234
14235	</desc>
14236	<param name="devicePosition" type="long" dir="in"/>
14237	<param name="portNumber" type="long" dir="return"/>
14238	</method>
14239
14240	<method name="setIDEEmulationPort">
14241	<desc>
14242	Sets the port number which is emulated as an IDE device.
14243	Works only with SATA controllers.
14244
14245	<result name="E_INVALIDARG">
14246	The @a devicePosition is not in the range 0 to 3 or the
14247	@a portNumber is not in the range 0 to 29.
14248	</result>
14249	<result name="E_NOTIMPL">
14250	The storage controller type is not SATAIntelAhci.
14251	</result>
14252
14253	</desc>
14254	<param name="devicePosition" type="long" dir="in"/>
14255	<param name="portNumber" type="long" dir="in"/>
14256	</method>
14257
14258	</interface>
14259
14260	<if target="wsdl">
14261
14262	<!--
14263	// IManagedObjectRef
14264	/////////////////////////////////////////////////////////////////////////
14265	-->
14266
14267	<interface
14268	name="IManagedObjectRef" extends="$unknown"
14269	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
14270	internal="yes"
14271	wsmap="managed"
14272	wscpp="hardcoded"
14273	>
14274	<desc>
14275	Managed object reference.
14276
14277	Only within the webservice, a managed object reference (which is really
14278	an opaque number) allows a webservice client to address an object
14279	that lives in the address space of the webservice server.
14280
14281	Behind each managed object reference, there is a COM object that lives
14282	in the webservice server's address space. The COM object is not freed
14283	until the managed object reference is released, either by an explicit
14284	call to <link to="IManagedObjectRef::release" /> or by logging off from
14285	the webservice (<link to="IWebsessionManager::logoff" />), which releases
14286	all objects created during the webservice session.
14287
14288	Whenever a method call of the VirtualBox API returns a COM object, the
14289	webservice representation of that method will instead return a
14290	managed object reference, which can then be used to invoke methods
14291	on that object.
14292	</desc>
14293
14294	<method name="getInterfaceName">
14295	<desc>
14296	Returns the name of the interface that this managed object represents,
14297	for example, "IMachine", as a string.
14298	</desc>
14299	<param name="return" type="wstring" dir="return"/>
14300	</method>
14301
14302	<method name="release">
14303	<desc>
14304	Releases this managed object reference and frees the resources that
14305	were allocated for it in the webservice server process. After calling
14306	this method, the identifier of the reference can no longer be used.
14307	</desc>
14308	</method>
14309
14310	</interface>
14311
14312	<!--
14313	// IWebsessionManager
14314	/////////////////////////////////////////////////////////////////////////
14315	-->
14316
14317	<interface
14318	name="IWebsessionManager" extends="$unknown"
14319	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
14320	internal="yes"
14321	wsmap="global"
14322	wscpp="hardcoded"
14323	>
14324	<desc>
14325	Websession manager. This provides essential services
14326	to webservice clients.
14327	</desc>
14328	<method name="logon">
14329	<desc>
14330	Logs a new client onto the webservice and returns a managed object reference to
14331	the IVirtualBox instance, which the client can then use as a basis to further
14332	queries, since all calls to the VirtualBox API are based on the IVirtualBox
14333	interface, in one way or the other.
14334	</desc>
14335	<param name="username" type="wstring" dir="in"/>
14336	<param name="password" type="wstring" dir="in"/>
14337	<param name="return" type="IVirtualBox" dir="return"/>
14338	</method>
14339
14340	<method name="getSessionObject">
14341	<desc>
14342	Returns a managed object reference to the internal ISession object that was created
14343	for this web service session when the client logged on.
14344
14345	<see>ISession</see>
14346	</desc>
14347	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
14348	<param name="return" type="ISession" dir="return"/>
14349	</method>
14350
14351	<method name="logoff">
14352	<desc>
14353	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
14354	and destroys all resources associated with the session (most importantly, all
14355	managed objects created in the server while the session was active).
14356	</desc>
14357	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
14358	</method>
14359
14360	</interface>
14361
14362	</if>
14363
14364	<!--
14365	// IPerformanceCollector & friends
14366	/////////////////////////////////////////////////////////////////////////
14367	-->
14368
14369	<interface
14370	name="IPerformanceMetric" extends="$unknown"
14371	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
14372	>
14373	<desc>
14374	The IPerformanceMetric interface represents parameters of the given
14375	performance metric.
14376	</desc>
14377
14378	<attribute name="metricName" type="wstring" readonly="yes">
14379	<desc>
14380	Name of the metric.
14381	</desc>
14382	</attribute>
14383
14384	<attribute name="object" type="$unknown" readonly="yes">
14385	<desc>
14386	Object this metric belongs to.
14387	</desc>
14388	</attribute>
14389
14390	<attribute name="description" type="wstring" readonly="yes">
14391	<desc>
14392	Textual description of the metric.
14393	</desc>
14394	</attribute>
14395
14396	<attribute name="period" type="unsigned long" readonly="yes">
14397	<desc>
14398	Time interval between samples, measured in seconds.
14399	</desc>
14400	</attribute>
14401
14402	<attribute name="count" type="unsigned long" readonly="yes">
14403	<desc>
14404	Number of recent samples retained by the performance collector for this
14405	metric.
14406
14407	When the collected sample count exceeds this number, older samples
14408	are discarded.
14409	</desc>
14410	</attribute>
14411
14412	<attribute name="unit" type="wstring" readonly="yes">
14413	<desc>
14414	Unit of measurement.
14415	</desc>
14416	</attribute>
14417
14418	<attribute name="minimumValue" type="long" readonly="yes">
14419	<desc>
14420	Minimum possible value of this metric.
14421	</desc>
14422	</attribute>
14423
14424	<attribute name="maximumValue" type="long" readonly="yes">
14425	<desc>
14426	Maximum possible value of this metric.
14427	</desc>
14428	</attribute>
14429	</interface>
14430
14431	<interface
14432	name="IPerformanceCollector" extends="$unknown"
14433	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
14434	wsmap="managed"
14435	>
14436	<desc>
14437	The IPerformanceCollector interface represents a service that collects
14438	and stores performance metrics data.
14439
14440	Performance metrics are associated with objects of interfaces like IHost
14441	and IMachine. Each object has a distinct set of performance metrics. The
14442	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
14443
14444	Metric data is collected at the specified intervals and is retained
14445	internally. The interval and the number of retained samples can be set
14446	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
14447	and collection settings are not persistent, they are discarded as soon as
14448	VBoxSVC process terminates. Moreover, metric settings and data associated
14449	with a particular VM only exist while VM is running. They disappear as
14450	soon as VM shuts down. It is not possible to set up metrics for machines
14451	that are powered off. One needs to start VM first, then set up metric
14452	collection parameters.
14453
14454	Metrics are organized hierarchically, with each level separated by a
14455	slash (/) character. Generally, the scheme for metric names is like this:
14456
14457	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
14458
14459	"Category/Metric" together form the base metric name. A base metric is
14460	the smallest unit for which a sampling interval and the number of
14461	retained samples can be set. Only base metrics can be enabled and
14462	disabled. All sub-metrics are collected when their base metric is
14463	collected. Collected values for any set of sub-metrics can be queried
14464	with <link to="IPerformanceCollector::queryMetricsData" />.
14465
14466	For example "CPU/Load/User:avg" metric name stands for the "CPU"
14467	category, "Load" metric, "User" submetric, "average" aggregate. An
14468	aggregate function is computed over all retained data. Valid aggregate
14469	functions are:
14470
14471	<ul>
14472	<li>avg -- average</li>
14473	<li>min -- minimum</li>
14474	<li>max -- maximum</li>
14475	</ul>
14476
14477	When setting up metric parameters, querying metric data, enabling or
14478	disabling metrics wildcards can be used in metric names to specify a
14479	subset of metrics. For example, to select all CPU-related metrics
14480	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
14481	so on. To query metric values without aggregates <tt>*:</tt> can be used.
14482
14483	The valid names for base metrics are:
14484
14485	<ul>
14486	<li>CPU/Load</li>
14487	<li>CPU/MHz</li>
14488	<li>RAM/Usage</li>
14489	<li>RAM/VMM</li>
14490	</ul>
14491
14492	The general sequence for collecting and retrieving the metrics is:
14493	<ul>
14494	<li>
14495	Obtain an instance of IPerformanceCollector with
14496	<link to="IVirtualBox::performanceCollector" />
14497	</li>
14498	<li>
14499	Allocate and populate an array with references to objects the metrics
14500	will be collected for. Use references to IHost and IMachine objects.
14501	</li>
14502	<li>
14503	Allocate and populate an array with base metric names the data will
14504	be collected for.
14505	</li>
14506	<li>
14507	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
14508	the metric data will be collected and stored.
14509	</li>
14510	<li>
14511	Wait for the data to get collected.
14512	</li>
14513	<li>
14514	Allocate and populate an array with references to objects the metric
14515	values will be queried for. You can re-use the object array used for
14516	setting base metrics.
14517	</li>
14518	<li>
14519	Allocate and populate an array with metric names the data will be
14520	collected for. Note that metric names differ from base metric names.
14521	</li>
14522	<li>
14523	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
14524	that have been collected so far are returned. Note that the values
14525	are still retained internally and data collection continues.
14526	</li>
14527	</ul>
14528
14529	For an example of usage refer to the following files in VirtualBox SDK:
14530	<ul>
14531	<li>
14532	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
14533	</li>
14534	<li>
14535	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
14536	</li>
14537	</ul>
14538	</desc>
14539
14540	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
14541	<desc>
14542	Array of unique names of metrics.
14543
14544	This array represents all metrics supported by the performance
14545	collector. Individual objects do not necessarily support all of them.
14546	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
14547	list of supported metrics for a particular object.
14548	</desc>
14549	</attribute>
14550
14551	<method name="getMetrics">
14552	<desc>
14553	Returns parameters of specified metrics for a set of objects.
14554	<note>
14555	@c Null metrics array means all metrics. @c Null object array means
14556	all existing objects.
14557	</note>
14558	</desc>
14559	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14560	<desc>
14561	Metric name filter. Currently, only a comma-separated list of metrics
14562	is supported.
14563	</desc>
14564	</param>
14565	<param name="objects" type="$unknown" dir="in" safearray="yes">
14566	<desc>
14567	Set of objects to return metric parameters for.
14568	</desc>
14569	</param>
14570	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
14571	<desc>
14572	Array of returned metric parameters.
14573	</desc>
14574	</param>
14575	</method>
14576
14577	<method name="setupMetrics">
14578	<desc>
14579	Sets parameters of specified base metrics for a set of objects. Returns
14580	an array of <link to="IPerformanceMetric" /> describing the metrics
14581	have been affected.
14582	<note>
14583	@c Null or empty metric name array means all metrics. @c Null or
14584	empty object array means all existing objects. If metric name array
14585	contains a single element and object array contains many, the single
14586	metric name array element is applied to each object array element to
14587	form metric/object pairs.
14588	</note>
14589	</desc>
14590	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14591	<desc>
14592	Metric name filter. Comma-separated list of metrics with wildcard
14593	support.
14594	</desc>
14595	</param>
14596	<param name="objects" type="$unknown" dir="in" safearray="yes">
14597	<desc>
14598	Set of objects to setup metric parameters for.
14599	</desc>
14600	</param>
14601	<param name="period" type="unsigned long" dir="in">
14602	<desc>
14603	Time interval in seconds between two consecutive samples of
14604	performance data.
14605	</desc>
14606	</param>
14607	<param name="count" type="unsigned long" dir="in">
14608	<desc>
14609	Number of samples to retain in performance data history. Older
14610	samples get discarded.
14611	</desc>
14612	</param>
14613	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14614	<desc>
14615	Array of metrics that have been modified by the call to this method.
14616	</desc>
14617	</param>
14618	</method>
14619
14620	<method name="enableMetrics">
14621	<desc>
14622	Turns on collecting specified base metrics. Returns an array of
14623	<link to="IPerformanceMetric" /> describing the metrics have been
14624	affected.
14625	<note>
14626	@c Null or empty metric name array means all metrics. @c Null or
14627	empty object array means all existing objects. If metric name array
14628	contains a single element and object array contains many, the single
14629	metric name array element is applied to each object array element to
14630	form metric/object pairs.
14631	</note>
14632	</desc>
14633	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14634	<desc>
14635	Metric name filter. Comma-separated list of metrics with wildcard
14636	support.
14637	</desc>
14638	</param>
14639	<param name="objects" type="$unknown" dir="in" safearray="yes">
14640	<desc>
14641	Set of objects to enable metrics for.
14642	</desc>
14643	</param>
14644	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14645	<desc>
14646	Array of metrics that have been modified by the call to this method.
14647	</desc>
14648	</param>
14649	</method>
14650
14651	<method name="disableMetrics">
14652	<desc>
14653	Turns off collecting specified base metrics. Returns an array of
14654	<link to="IPerformanceMetric" /> describing the metrics have been
14655	affected.
14656	<note>
14657	@c Null or empty metric name array means all metrics. @c Null or
14658	empty object array means all existing objects. If metric name array
14659	contains a single element and object array contains many, the single
14660	metric name array element is applied to each object array element to
14661	form metric/object pairs.
14662	</note>
14663	</desc>
14664	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14665	<desc>
14666	Metric name filter. Comma-separated list of metrics with wildcard
14667	support.
14668	</desc>
14669	</param>
14670	<param name="objects" type="$unknown" dir="in" safearray="yes">
14671	<desc>
14672	Set of objects to disable metrics for.
14673	</desc>
14674	</param>
14675	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14676	<desc>
14677	Array of metrics that have been modified by the call to this method.
14678	</desc>
14679	</param>
14680	</method>
14681
14682	<method name="queryMetricsData">
14683	<desc>
14684	Queries collected metrics data for a set of objects.
14685
14686	The data itself and related metric information are returned in seven
14687	parallel and one flattened array of arrays. Elements of
14688	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
14689	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
14690	the same index describe one set of values corresponding to a single
14691	metric.
14692
14693	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
14694	start and length of a sub-array is indicated by
14695	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
14696	value for metric <tt>metricNames[i]</tt> is at
14697	<tt>returnData[returnIndices[i]]</tt>.
14698
14699	<note>
14700	@c Null or empty metric name array means all metrics. @c Null or
14701	empty object array means all existing objects. If metric name array
14702	contains a single element and object array contains many, the single
14703	metric name array element is applied to each object array element to
14704	form metric/object pairs.
14705	</note>
14706	<note>
14707	Data collection continues behind the scenes after call to @c
14708	queryMetricsData. The return data can be seen as the snapshot of the
14709	current state at the time of @c queryMetricsData call. The internally
14710	kept metric values are not cleared by the call. This makes possible
14711	querying different subsets of metrics or aggregates with subsequent
14712	calls. If periodic querying is needed it is highly suggested to query
14713	the values with @c interval*count period to avoid confusion. This way
14714	a completely new set of data values will be provided by each query.
14715	</note>
14716	</desc>
14717	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14718	<desc>
14719	Metric name filter. Comma-separated list of metrics with wildcard
14720	support.
14721	</desc>
14722	</param>
14723	<param name="objects" type="$unknown" dir="in" safearray="yes">
14724	<desc>
14725	Set of objects to query metrics for.
14726	</desc>
14727	</param>
14728	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
14729	<desc>
14730	Names of metrics returned in @c returnData.
14731	</desc>
14732	</param>
14733	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
14734	<desc>
14735	Objects associated with metrics returned in @c returnData.
14736	</desc>
14737	</param>
14738	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
14739	<desc>
14740	Units of measurement for each returned metric.
14741	</desc>
14742	</param>
14743	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
14744	<desc>
14745	Divisor that should be applied to return values in order to get
14746	floating point values. For example:
14747	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
14748	will retrieve the floating point value of i-th sample of the first
14749	metric.
14750	</desc>
14751	</param>
14752	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
14753	<desc>
14754	Sequence numbers of the first elements of value sequences of
14755	particular metrics returned in @c returnData. For aggregate metrics
14756	it is the sequence number of the sample the aggregate started
14757	calculation from.
14758	</desc>
14759	</param>
14760	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
14761	<desc>
14762	Indices of the first elements of value sequences of particular
14763	metrics returned in @c returnData.
14764	</desc>
14765	</param>
14766	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
14767	<desc>
14768	Lengths of value sequences of particular metrics.
14769	</desc>
14770	</param>
14771	<param name="returnData" type="long" dir="return" safearray="yes">
14772	<desc>
14773	Flattened array of all metric data containing sequences of values for
14774	each metric.
14775	</desc>
14776	</param>
14777	</method>
14778
14779	</interface>
14780
14781	<enum
14782	name="NATAliasMode"
14783	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
14784	>
14785	<desc></desc>
14786	<const name="AliasLog" value="0x1">
14787	<desc></desc>
14788	</const>
14789	<const name="AliasProxyOnly" value="0x02">
14790	<desc></desc>
14791	</const>
14792	<const name="AliasUseSamePorts" value="0x04">
14793	<desc></desc>
14794	</const>
14795	</enum>
14796
14797	<enum
14798	name="NATProtocol"
14799	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
14800	>
14801	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
14802	<const name="UDP" value="0">
14803	<desc>Port-forwarding uses UDP protocol.</desc>
14804	</const>
14805	<const name="TCP" value="1">
14806	<desc>Port-forwarding uses TCP protocol.</desc>
14807	</const>
14808	</enum>
14809
14810	<interface
14811	name="INATEngine" extends="$unknown"
14812	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
14813	wsmap="managed"
14814	>
14815	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
14816	allows for changing NAT behavior such as port-forwarding rules. This interface is
14817	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
14818	<attribute name="network" type="wstring">
14819	<desc>The network attribute of the NAT engine (the same value is used with built-in
14820	DHCP server to fill corresponding fields of DHCP leases).</desc>
14821	</attribute>
14822	<attribute name="hostIP" type="wstring">
14823	<desc>IP of host interface to bind all opened sockets to.
14824	<note>Changing this does not change binding of port forwarding.</note>
14825	</desc>
14826	</attribute>
14827	<attribute name="tftpPrefix" type="wstring">
14828	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
14829	the corresponding fields of DHCP leases.</desc>
14830	</attribute>
14831	<attribute name="tftpBootFile" type="wstring">
14832	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
14833	the corresponding fields of DHCP leases.</desc>
14834	</attribute>
14835	<attribute name="tftpNextServer" type="wstring">
14836	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
14837	the corresponding fields of DHCP leases.
14838	<note>The preferred form is IPv4 addresses.</note>
14839	</desc>
14840	</attribute>
14841	<attribute name="aliasMode" type="unsigned long">
14842	<desc></desc>
14843	</attribute>
14844	<attribute name="dnsPassDomain" type="boolean">
14845	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
14846	</attribute>
14847	<attribute name="dnsProxy" type="boolean">
14848	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14849	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
14850	</attribute>
14851	<attribute name="dnsUseHostResolver" type="boolean">
14852	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14853	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
14854	</attribute>
14855	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
14856	<desc>Array of NAT port-forwarding rules in string representation, in the following
14857	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
14858	</attribute>
14859	<method name="setNetworkSettings">
14860	<desc>Sets network configuration of the NAT engine.</desc>
14861	<param name="mtu" type="unsigned long" dir="in">
14862	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
14863	</param>
14864	<param name="sockSnd" type="unsigned long" dir="in">
14865	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
14866	</param>
14867	<param name="sockRcv" type="unsigned long" dir="in">
14868	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
14869	</param>
14870	<param name="TcpWndSnd" type="unsigned long" dir="in">
14871	<desc>Initial size of the NAT engine's sending TCP window in bytes when
14872	establishing a new TCP connection.</desc>
14873	</param>
14874	<param name="TcpWndRcv" type="unsigned long" dir="in">
14875	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
14876	establishing a new TCP connection.</desc>
14877	</param>
14878	</method>
14879	<method name="getNetworkSettings">
14880	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
14881	for parameter descriptions.</desc>
14882	<param name="mtu" type="unsigned long" dir="out" />
14883	<param name="sockSnd" type="unsigned long" dir="out" />
14884	<param name="sockRcv" type="unsigned long" dir="out" />
14885	<param name="TcpWndSnd" type="unsigned long" dir="out" />
14886	<param name="TcpWndRcv" type="unsigned long" dir="out" />
14887	</method>
14888	<method name="addRedirect">
14889	<desc>Adds a new NAT port-forwarding rule.</desc>
14890	<param name="name" type="wstring" dir="in">
14891	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
14892	auto-generates one using the other parameters.</desc>
14893	</param>
14894	<param name="proto" type="NATProtocol" dir="in">
14895	<desc>Protocol handled with the rule.</desc>
14896	</param>
14897	<param name="hostIp" type="wstring" dir="in">
14898	<desc>IP of the host interface to which the rule should apply. An empty ip address is
14899	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
14900	</param>
14901	<param name="hostPort" type="unsigned short" dir="in">
14902	<desc>The port number to listen on.</desc>
14903	</param>
14904	<param name="guestIp" type="wstring" dir="in">
14905	<desc>The IP address of the guest which the NAT engine will forward matching packets
14906	to. An empty IP address is acceptable, in which case the NAT engine will forward
14907	packets to the first DHCP lease (x.x.x.15).</desc>
14908	</param>
14909	<param name="guestPort" type="unsigned short" dir="in">
14910	<desc>The port number to forward.</desc>
14911	</param>
14912	</method>
14913	<method name="removeRedirect">
14914	<desc>Removes a port-forwarding rule that was previously registered.</desc>
14915	<param name="name" type="wstring" dir="in">
14916	<desc>The name of the rule to delete.</desc>
14917	</param>
14918	</method>
14919	</interface>
14920
14921	<!--
14922	// IExtPackManager
14923	/////////////////////////////////////////////////////////////////////////
14924	-->
14925
14926	<interface
14927	name="IExtPackPlugIn" extends="$unknown"
14928	uuid="58000040-e718-4746-bbce-4b86d96da461"
14929	wsmap="suppress"
14930	>
14931	<desc>
14932	Interface for keeping information about a plug-in that ships with an
14933	extension pack.
14934	</desc>
14935	<attribute name="name" type="wstring" readonly="yes">
14936	<desc>The plug-in name.</desc>
14937	</attribute>
14938	<attribute name="description" type="wstring" readonly="yes">
14939	<desc>The plug-in description.</desc>
14940	</attribute>
14941	<attribute name="frontend" type="wstring" readonly="yes">
14942	<desc>
14943	The name of the frontend or component name this plug-in plugs into.
14944	</desc>
14945	</attribute>
14946	<attribute name="modulePath" type="wstring" readonly="yes">
14947	<desc> The module path. </desc>
14948	</attribute>
14949	</interface>
14950
14951	<interface
14952	name="IExtPackBase" extends="$unknown"
14953	uuid="5ffb0b64-0ad6-467d-af62-1157e7dc3c99"
14954	wsmap="suppress"
14955	>
14956	<desc>
14957	Interface for querying information about an extension pack as well as
14958	accessing COM objects within it.
14959	</desc>
14960	<attribute name="name" type="wstring" readonly="yes">
14961	<desc>The extension pack name. This is unique.</desc>
14962	</attribute>
14963	<attribute name="description" type="wstring" readonly="yes">
14964	<desc>The extension pack description.</desc>
14965	</attribute>
14966	<attribute name="version" type="wstring" readonly="yes">
14967	<desc>
14968	The extension pack version string. This is on the same form as
14969	other VirtualBox version strings, i.e.: "1.2.3", "1.2.3_BETA1",
14970	"1.2.3-OSE", "1.2.3r45678", "1.2.3r45678-OSE", "1.2.3_BETA1-r45678"
14971	or "1.2.3_BETA1-r45678-OSE"
14972	</desc>
14973	</attribute>
14974	<attribute name="revision" type="unsigned long" readonly="yes">
14975	<desc>The extension pack internal revision number.</desc>
14976	</attribute>
14977	<attribute name="VRDEModule" type="wstring" readonly="yes">
14978	<desc>The name of the VRDE module if the extension pack sports one.</desc>
14979	</attribute>
14980	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
14981	<desc>Plug-ins provided by this extension pack.</desc>
14982	</attribute>
14983	<attribute name="usable" type="boolean" readonly="yes">
14984	<desc>
14985	Indicates whether the extension pack is usable or not.
14986
14987	There are a number of reasons why an extension pack might be unusable,
14988	typical examples would be broken installation/file or that it is
14989	incompatible with the current VirtualBox version.
14990	</desc>
14991	</attribute>
14992	<attribute name="whyUnusable" type="wstring" readonly="yes">
14993	<desc>
14994	String indicating why the extension pack is not usable. This is an
14995	empty string if usable and always a non-empty string if not usable.
14996	</desc>
14997	</attribute>
14998	<attribute name="showLicense" type="boolean" readonly="yes">
14999	<desc>Whether to show the license before installation</desc>
15000	</attribute>
15001	<attribute name="license" type="wstring" readonly="yes">
15002	<desc>
15003	The default HTML license text for the extension pack. Same as
15004	calling <link to="#queryLicense">queryLicense</link> with
15005	preferredLocale and preferredLanguage as empty strings and format set
15006	to html.
15007	</desc>
15008	</attribute>
15009
15010	<method name="queryLicense">
15011	<desc>
15012	Full feature version of the license attribute.
15013	</desc>
15014	<param name="preferredLocale" type="wstring" dir="in">
15015	<desc>
15016	The preferred license locale. Pass an empty string to get the default
15017	license.
15018	</desc>
15019	</param>
15020	<param name="preferredLanguage" type="wstring" dir="in">
15021	<desc>
15022	The preferred license language. Pass an empty string to get the
15023	default language for the locale.
15024	</desc>
15025	</param>
15026	<param name="format" type="wstring" dir="in">
15027	<desc>
15028	The license format: html, rtf or txt. If a license is present there
15029	will always be an HTML of it, the rich text format (RTF) and plain
15030	text (txt) versions are optional. If
15031	</desc>
15032	</param>
15033	<param name="licenseText" type="wstring" dir="return">
15034	<desc>The license text.</desc>
15035	</param>
15036	</method>
15037
15038	</interface>
15039
15040	<interface
15041	name="IExtPack" extends="IExtPackBase"
15042	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
15043	wsmap="suppress"
15044	>
15045	<desc>
15046	Interface for querying information about an extension pack as well as
15047	accessing COM objects within it.
15048	</desc>
15049	<method name="queryObject">
15050	<desc>
15051	Queries the IUnknown interface to an object in the extension pack
15052	main module. This allows plug-ins and others to talk directly to an
15053	extension pack.
15054	</desc>
15055	<param name="objUuid" type="wstring" dir="in">
15056	<desc>The object ID. What exactly this is </desc>
15057	</param>
15058	<param name="returnInterface" type="$unknown" dir="return">
15059	<desc>The queried interface.</desc>
15060	</param>
15061	</method>
15062	</interface>
15063
15064	<interface
15065	name="IExtPackFile" extends="IExtPackBase"
15066	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
15067	wsmap="suppress"
15068	>
15069	<desc>
15070	Extension pack file (aka tarball, .vbox-extpack) representation returned
15071	by IExtPackManager::openExtPackFile. This provides the base extension
15072	pack information with the addition of the file name. It also provides an
15073	alternative to IExtPackManager::install.
15074	</desc>
15075	<attribute name="filePath" type="wstring" readonly="yes">
15076	<desc>
15077	The path to the extension pack file.
15078	</desc>
15079	</attribute>
15080
15081	<method name="install">
15082	<desc>
15083	Install the extension pack.
15084	</desc>
15085	<param name="replace" type="boolean" dir="in">
15086	<desc>
15087	Set this to automatically uninstall any existing extension pack with
15088	the same name as the one being installed.
15089	</desc>
15090	</param>
15091	<param name="displayInfo" type="wstring" dir="in">
15092	<desc>
15093	Platform specific display information. Reserved for future hacks.
15094	</desc>
15095	</param>
15096	<param name="progess" type="IProgress" dir="return">
15097	<desc>
15098	Progress object for the operation.
15099	</desc>
15100	</param>
15101	</method>
15102	</interface>
15103
15104	<interface
15105	name="IExtPackManager" extends="$unknown"
15106	uuid="2451b1ba-ab1c-42fb-b453-c58433bea8c7"
15107	wsmap="suppress"
15108	>
15109	<desc>
15110	Interface for managing VirtualBox Extension Packs.
15111
15112	TODO: Describe extension packs, how they are managed and how to create
15113	one.
15114	</desc>
15115
15116	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
15117	<desc>
15118	List of the installed extension packs.
15119	</desc>
15120	</attribute>
15121
15122	<method name="find">
15123	<desc>
15124	Returns the extension pack with the specified name if found.
15125
15126	<result name="VBOX_E_OBJECT_NOT_FOUND">
15127	No extension pack matching @a name was found.
15128	</result>
15129	</desc>
15130	<param name="name" type="wstring" dir="in">
15131	<desc>The name of the extension pack to locate.</desc>
15132	</param>
15133	<param name="returnData" type="IExtPack" dir="return">
15134	<desc>The extension pack if found.</desc>
15135	</param>
15136	</method>
15137
15138	<method name="openExtPackFile">
15139	<desc>
15140	Attempts to open an extension pack file in preparation for
15141	installation.
15142	</desc>
15143	<param name="path" type="wstring" dir="in">
15144	<desc>The path of the extension pack tarball.</desc>
15145	</param>
15146	<param name="file" type="IExtPackFile" dir="return">
15147	<desc>The interface of the extension pack file object.</desc>
15148	</param>
15149	</method>
15150
15151	<method name="uninstall">
15152	<desc>Uninstalls an extension pack, removing all related files.</desc>
15153	<param name="name" type="wstring" dir="in">
15154	<desc>The name of the extension pack to uninstall.</desc>
15155	</param>
15156	<param name="forcedRemoval" type="boolean" dir="in">
15157	<desc>
15158	Forced removal of the extension pack. This means that the uninstall
15159	hook will not be called.
15160	</desc>
15161	</param>
15162	<param name="displayInfo" type="wstring" dir="in">
15163	<desc>
15164	Platform specific display information. Reserved for future hacks.
15165	</desc>
15166	</param>
15167	<param name="progess" type="IProgress" dir="return">
15168	<desc>
15169	Progress object for the operation.
15170	</desc>
15171	</param>
15172	</method>
15173
15174	<method name="cleanup">
15175	<desc>Cleans up failed installs and uninstalls</desc>
15176	</method>
15177
15178	<method name="QueryAllPlugInsForFrontend">
15179	<desc>
15180	Gets the path to all the plug-in modules for a given frontend.
15181
15182	This is a convenience method that is intended to simplify the plug-in
15183	loading process for a frontend.
15184	</desc>
15185	<param name="frontendName" type="wstring" dir="in">
15186	<desc>The name of the frontend or component.</desc>
15187	</param>
15188	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
15189	<desc>Array containing the plug-in modules (full paths).</desc>
15190	</param>
15191	</method>
15192
15193	<method name="IsExtPackUsable">
15194	<desc>Check if the given extension pack is loaded and usable.</desc>
15195	<param name="name" type="wstring" dir="in">
15196	<desc>The name of the extension pack to check for.</desc>
15197	</param>
15198	<param name="usable" type="boolean" dir="return">
15199	<desc>Is the given extension pack loaded and usable.</desc>
15200	</param>
15201	</method>
15202
15203	</interface>
15204
15205	<!--
15206	// BandwidthGroupType
15207	/////////////////////////////////////////////////////////////////////////
15208	-->
15209	<enum
15210	name="BandwidthGroupType"
15211	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
15212
15213	<desc>
15214	Type of a bandwidth control group.
15215	</desc>
15216
15217	<const name="Null" value="0">
15218	<desc>
15219	Null type, must be first.
15220	</desc>
15221	</const>
15222
15223	<const name="Disk" value="1">
15224	<desc>
15225	The bandwidth group controls disk I/O.
15226	</desc>
15227	</const>
15228
15229	<const name="Network" value="2">
15230	<desc>
15231	The bandwidth group controls network I/O.
15232	</desc>
15233	</const>
15234
15235	</enum>
15236
15237	<!--
15238	// IBandwidthGroup
15239	/////////////////////////////////////////////////////////////////////////
15240	-->
15241	<interface
15242	name="IBandwidthGroup" extends="$unknown"
15243	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
15244	wsmap="managed"
15245	>
15246	<desc>Represents one bandwidth group.</desc>
15247
15248	<attribute name="name" type="wstring" readonly="yes">
15249	<desc>Name of the group.</desc>
15250	</attribute>
15251
15252	<attribute name="type" type="BandwidthGroupType" readonly="yes">
15253	<desc>Type of the group.</desc>
15254	</attribute>
15255
15256	<attribute name="reference" type="unsigned long" readonly="yes">
15257	<desc>How many devices/medium attachements use this group.</desc>
15258	</attribute>
15259
15260	<attribute name="maxMbPerSec" type="unsigned long">
15261	<desc>The maximum number of MBytes which can be transfered by all
15262	entities attached to this group during one second.</desc>
15263	</attribute>
15264
15265	</interface>
15266
15267	<!--
15268	// IBandwidthControl
15269	/////////////////////////////////////////////////////////////////////////
15270	-->
15271	<interface
15272	name="IBandwidthControl" extends="$unknown"
15273	uuid="d0a24db0-f756-11df-98cf-0800200c9a66"
15274	wsmap="managed"
15275	>
15276	<desc>
15277	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
15278	This includes network and disk I/O.
15279	</desc>
15280
15281	<attribute name="numGroups" type="unsigned long" readonly="yes">
15282	<desc>
15283	The current number of existing bandwidth groups managed.
15284	</desc>
15285	</attribute>
15286
15287	<method name="CreateBandwidthGroup">
15288	<desc>
15289	Creates a new bandwidth group.
15290	</desc>
15291
15292	<param name="name" type="wstring" dir="in">
15293	<desc>Name of the bandwidth group.</desc>
15294	</param>
15295	<param name="type" type="BandwidthGroupType" dir="in">
15296	<desc>The type of the bandwidth group (network or disk).</desc>
15297	</param>
15298	<param name="maxMbPerSec" type="unsigned long" dir="in">
15299	<desc>The maximum number of MBytes which can be transfered by all
15300	entities attached to this group during one second.</desc>
15301	</param>
15302	</method>
15303
15304	<method name="DeleteBandwidthGroup">
15305	<desc>
15306	Deletes a new bandwidth group.
15307	</desc>
15308
15309	<param name="name" type="wstring" dir="in">
15310	<desc>Name of the bandwidth group to delete.</desc>
15311	</param>
15312	</method>
15313
15314	<method name="GetBandwidthGroup" const="yes">
15315	<desc>
15316	Get a bandwidth group by name.
15317	</desc>
15318
15319	<param name="name" type="wstring" dir="in">
15320	<desc>Name of the bandwidth group to get.</desc>
15321	</param>
15322	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
15323	<desc>Where to store the bandwidth group on success.</desc>
15324	</param>
15325	</method>
15326
15327	<method name="GetAllBandwidthGroups" const="yes">
15328	<desc>
15329	Get all managed bandwidth groups.
15330	</desc>
15331
15332	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
15333	<desc>The array of managed bandwidth groups.</desc>
15334	</param>
15335	</method>
15336	</interface>
15337
15338	<!--
15339	// IVirtualBoxClient
15340	/////////////////////////////////////////////////////////////////////////
15341	-->
15342
15343	<interface
15344	name="IVirtualBoxClient" extends="$unknown"
15345	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
15346	wsmap="suppress"
15347	>
15348	<desc>
15349	Convenience interface for client applications. Treat this as a
15350	singleton, i.e. never create more than one instance of this interface.
15351
15352	At the moment only available for clients of the local API (not usable
15353	via the webservice). Once the session logic is redesigned this might
15354	change.
15355	</desc>
15356
15357	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
15358	<desc>
15359	Reference to the server-side API root object.
15360	</desc>
15361	</attribute>
15362
15363	<attribute name="session" type="ISession" readonly="yes">
15364	<desc>
15365	Create a new session object and return the reference to it.
15366	</desc>
15367	</attribute>
15368
15369	<attribute name="eventSource" type="IEventSource" readonly="yes">
15370	<desc>
15371	Event source for VirtualBoxClient events.
15372	</desc>
15373	</attribute>
15374
15375	</interface>
15376
15377	<!--
15378	// Events
15379	/////////////////////////////////////////////////////////////////////////
15380	-->
15381	<enum
15382	name="VBoxEventType"
15383	uuid="e71c487f-755e-46e9-a476-dd6a5d134597"
15384	>
15385
15386	<desc>
15387	Type of an event.
15388	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15389	</desc>
15390
15391	<const name="Invalid" value="0">
15392	<desc>
15393	Invalid event, must be first.
15394	</desc>
15395	</const>
15396
15397	<const name="Any" value="1">
15398	<desc>
15399	Wildcard for all events.
15400	Events of this type are never delivered, and only used in
15401	registerListener() call to simplify registration.
15402	</desc>
15403	</const>
15404
15405	<const name="Vetoable" value="2">
15406	<desc>
15407	Wildcard for all vetoable events. Events of this type are never delivered, and only
15408	used in registerListener() call to simplify registration.
15409	</desc>
15410	</const>
15411
15412	<const name="MachineEvent" value="3">
15413	<desc>
15414	Wildcard for all machine events. Events of this type are never delivered, and only used in
15415	registerListener() call to simplify registration.
15416	</desc>
15417	</const>
15418
15419	<const name="SnapshotEvent" value="4">
15420	<desc>
15421	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
15422	registerListener() call to simplify registration.
15423	</desc>
15424	</const>
15425
15426	<const name="InputEvent" value="5">
15427	<desc>
15428	Wildcard for all input device (keyboard, mouse) events.
15429	Events of this type are never delivered, and only used in
15430	registerListener() call to simplify registration.
15431	</desc>
15432	</const>
15433
15434	<const name="LastWildcard" value="31">
15435	<desc>
15436	Last wildcard.
15437	</desc>
15438	</const>
15439
15440	<const name="OnMachineStateChanged" value="32">
15441	<desc>
15442	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
15443	</desc>
15444	</const>
15445	<const name="OnMachineDataChanged" value="33">
15446	<desc>
15447	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
15448	</desc>
15449	</const>
15450	<const name="OnExtraDataChanged" value="34">
15451	<desc>
15452	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
15453	</desc>
15454	</const>
15455	<const name="OnExtraDataCanChange" value="35">
15456	<desc>
15457	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
15458	</desc>
15459	</const>
15460	<const name="OnMediumRegistered" value="36">
15461	<desc>
15462	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
15463	</desc>
15464	</const>
15465	<const name="OnMachineRegistered" value="37">
15466	<desc>
15467	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
15468	</desc>
15469	</const>
15470	<const name="OnSessionStateChanged" value="38">
15471	<desc>
15472	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
15473	</desc>
15474	</const>
15475	<const name="OnSnapshotTaken" value="39">
15476	<desc>
15477	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
15478	</desc>
15479	</const>
15480	<const name="OnSnapshotDeleted" value="40">
15481	<desc>
15482	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
15483	</desc>
15484	</const>
15485	<const name="OnSnapshotChanged" value="41">
15486	<desc>
15487	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
15488	</desc>
15489	</const>
15490	<const name="OnGuestPropertyChanged" value="42">
15491	<desc>
15492	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
15493	</desc>
15494	</const>
15495	<!-- Console events -->
15496	<const name="OnMousePointerShapeChanged" value="43">
15497	<desc>
15498	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
15499	</desc>
15500	</const>
15501	<const name="OnMouseCapabilityChanged" value="44">
15502	<desc>
15503	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
15504	</desc>
15505	</const>
15506	<const name="OnKeyboardLedsChanged" value="45">
15507	<desc>
15508	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
15509	</desc>
15510	</const>
15511	<const name="OnStateChanged" value="46">
15512	<desc>
15513	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
15514	</desc>
15515	</const>
15516	<const name="OnAdditionsStateChanged" value="47">
15517	<desc>
15518	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
15519	</desc>
15520	</const>
15521	<const name="OnNetworkAdapterChanged" value="48">
15522	<desc>
15523	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
15524	</desc>
15525	</const>
15526	<const name="OnSerialPortChanged" value="49">
15527	<desc>
15528	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
15529	</desc>
15530	</const>
15531	<const name="OnParallelPortChanged" value="50">
15532	<desc>
15533	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
15534	</desc>
15535	</const>
15536	<const name="OnStorageControllerChanged" value="51">
15537	<desc>
15538	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
15539	</desc>
15540	</const>
15541	<const name="OnMediumChanged" value="52">
15542	<desc>
15543	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
15544	</desc>
15545	</const>
15546	<const name="OnVRDEServerChanged" value="53">
15547	<desc>
15548	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
15549	</desc>
15550	</const>
15551	<const name="OnUSBControllerChanged" value="54">
15552	<desc>
15553	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
15554	</desc>
15555	</const>
15556	<const name="OnUSBDeviceStateChanged" value="55">
15557	<desc>
15558	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
15559	</desc>
15560	</const>
15561	<const name="OnSharedFolderChanged" value="56">
15562	<desc>
15563	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
15564	</desc>
15565	</const>
15566	<const name="OnRuntimeError" value="57">
15567	<desc>
15568	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
15569	</desc>
15570	</const>
15571	<const name="OnCanShowWindow" value="58">
15572	<desc>
15573	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
15574	</desc>
15575	</const>
15576	<const name="OnShowWindow" value="59">
15577	<desc>
15578	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
15579	</desc>
15580	</const>
15581	<const name="OnCPUChanged" value="60">
15582	<desc>
15583	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
15584	</desc>
15585	</const>
15586	<const name="OnVRDEServerInfoChanged" value="61">
15587	<desc>
15588	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
15589	</desc>
15590	</const>
15591	<const name="OnEventSourceChanged" value="62">
15592	<desc>
15593	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
15594	</desc>
15595	</const>
15596	<const name="OnCPUExecutionCapChanged" value="63">
15597	<desc>
15598	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
15599	</desc>
15600	</const>
15601	<const name="OnGuestKeyboard" value="64">
15602	<desc>
15603	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
15604	</desc>
15605	</const>
15606	<const name="OnGuestMouse" value="65">
15607	<desc>
15608	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
15609	</desc>
15610	</const>
15611	<const name="OnNATRedirect" value="66">
15612	<desc>
15613	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
15614	</desc>
15615	</const>
15616	<const name="OnHostPciDevicePlug" value="67">
15617	<desc>
15618	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
15619	</desc>
15620	</const>
15621	<const name="OnVBoxSVCAvailabilityChanged" value="68">
15622	<desc>
15623	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
15624	</desc>
15625	</const>
15626	<const name="OnBandwidthGroupChanged" value="69">
15627	<desc>
15628	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
15629	</desc>
15630	</const>
15631	<const name="OnGuestMonitorChanged" value="70">
15632	<desc>
15633	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
15634	</desc>
15635	</const>
15636
15637	<!-- Last event marker -->
15638	<const name="Last" value="71">
15639	<desc>
15640	Must be last event, used for iterations and structures relying on numerical event values.
15641	</desc>
15642	</const>
15643
15644	</enum>
15645
15646	<interface
15647	name="IEventSource" extends="$unknown"
15648	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
15649	wsmap="managed"
15650	>
15651	<desc>
15652	Event source. Generally, any object which could generate events can be an event source,
15653	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
15654	an event source can work with listeners in either active or passive mode. In active mode it is up to
15655	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
15656	event source keeps track of pending events for each listener and returns available events on demand.
15657
15658	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15659	</desc>
15660
15661	<method name="createListener">
15662	<desc>
15663	Creates a new listener object, useful for passive mode.
15664	</desc>
15665	<param name="listener" type="IEventListener" dir="return"/>
15666	</method>
15667
15668	<method name="createAggregator">
15669	<desc>
15670	Creates an aggregator event source, collecting events from multiple sources.
15671	This way a single listener can listen for events coming from multiple sources,
15672	using a single blocking getEvent() on the returned aggregator.
15673	</desc>
15674	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
15675	<desc>
15676	Subordinate event source this one aggregatres.
15677	</desc>
15678	</param>
15679	<param name="result" type="IEventSource" dir="return">
15680	<desc>
15681	Event source aggregating passed sources.
15682	</desc>
15683	</param>
15684	</method>
15685
15686	<method name="registerListener">
15687	<desc>
15688	Register an event listener.
15689
15690	<note>
15691	To avoid system overload, the VirtualBox server process checks if passive event
15692	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
15693	current implementation, if more than 500 pending events are detected for a passive
15694	event listener, it is forcefully unregistered by the system, and further
15695	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
15696	</note>
15697	</desc>
15698	<param name="listener" type="IEventListener" dir="in">
15699	<desc>Listener to register.</desc>
15700	</param>
15701	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
15702	<desc>
15703	Event types listener is interested in. One can use wildcards like -
15704	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
15705	than one event.
15706	</desc>
15707	</param>
15708	<param name="active" type="boolean" dir="in">
15709	<desc>
15710	Which mode this listener is operating in.
15711	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
15712	In passive mode, an internal event queue is created for this this IEventListener.
15713	For each event coming in, it is added to queues for all interested registered passive
15714	listeners. It is then up to the external code to call the listener's
15715	<link to="IEventListener::handleEvent" /> method. When done with an event, the
15716	external code must call <link to="#eventProcessed" />.
15717	</desc>
15718	</param>
15719	</method>
15720
15721	<method name="unregisterListener">
15722	<desc>
15723	Unregister an event listener. If listener is passive, and some waitable events are still
15724	in queue they are marked as processed automatically.
15725	</desc>
15726	<param name="listener" type="IEventListener" dir="in">
15727	<desc>Listener to unregister.</desc>
15728	</param>
15729	</method>
15730
15731	<method name="fireEvent">
15732	<desc>
15733	Fire an event for this source.
15734	</desc>
15735	<param name="event" type="IEvent" dir="in">
15736	<desc>Event to deliver.</desc>
15737	</param>
15738	<param name="timeout" type="long" dir="in">
15739	<desc>
15740	Maximum time to wait for event processing (if event is waitable), in ms;
15741	0 = no wait, -1 = indefinite wait.
15742	</desc>
15743	</param>
15744	<param name="result" type="boolean" dir="return">
15745	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
15746	</param>
15747	</method>
15748
15749	<method name="getEvent">
15750	<desc>
15751	Get events from this peer's event queue (for passive mode). Calling this method
15752	regularly is required for passive event listeners to avoid system overload;
15753	see <link to="IEventSource::registerListener" /> for details.
15754
15755	<result name="VBOX_E_OBJECT_NOT_FOUND">
15756	Listener is not registered, or autounregistered.
15757	</result>
15758	</desc>
15759	<param name="listener" type="IEventListener" dir="in">
15760	<desc>Which listener to get data for.</desc>
15761	</param>
15762	<param name="timeout" type="long" dir="in">
15763	<desc>
15764	Maximum time to wait for events, in ms;
15765	0 = no wait, -1 = indefinite wait.
15766	</desc>
15767	</param>
15768	<param name="event" type="IEvent" dir="return">
15769	<desc>Event retrieved, or null if none available.</desc>
15770	</param>
15771	</method>
15772
15773	<method name="eventProcessed">
15774	<desc>
15775	Must be called for waitable events after a particular listener finished its
15776	event processing. When all listeners of a particular event have called this
15777	method, the system will then call <link to="IEvent::setProcessed" />.
15778	</desc>
15779	<param name="listener" type="IEventListener" dir="in">
15780	<desc>Which listener processed event.</desc>
15781	</param>
15782	<param name="event" type="IEvent" dir="in">
15783	<desc>Which event.</desc>
15784	</param>
15785	</method>
15786
15787	</interface>
15788
15789	<interface
15790	name="IEventListener" extends="$unknown"
15791	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
15792	wsmap="managed"
15793	>
15794	<desc>
15795	Event listener. An event listener can work in either active or passive mode, depending on the way
15796	it was registered.
15797	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15798	</desc>
15799
15800	<method name="handleEvent">
15801	<desc>
15802	Handle event callback for active listeners. It is not called for passive listeners. After
15803	calling handleEvent() on all active listeners and having received acknowledgement from all
15804	passive listeners via IEventSource::eventProcessed(), the event is marked as processed and
15805	IEvent::waitProcessed() will return immediately.
15806	</desc>
15807	<param name="event" type="IEvent" dir="in">
15808	<desc>Event available.</desc>
15809	</param>
15810	</method>
15811
15812	</interface>
15813
15814	<interface
15815	name="IEvent" extends="$unknown"
15816	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
15817	wsmap="managed"
15818	>
15819	<desc>
15820	Abstract parent interface for VirtualBox events. Actual events will typically implement
15821	a more specific interface which derives from this (see below).
15822
15823	<b>Introduction to VirtualBox events</b>
15824
15825	Generally speaking, an event (represented by this interface) signals that something
15826	happened, while an event listener (see <link to="IEventListener" />) represents an
15827	entity that is interested in certain events. In order for this to work with
15828	unidirectional protocols (i.e. web services), the concepts of passive and active
15829	listener are used.
15830
15831	Event consumers can register themselves as listeners, providing an array of
15832	events they are interested in (see <link to="IEventSource::registerListener" />).
15833	When an event triggers, the listener is notified about the event. The exact
15834	mechanism of the notification depends on whether the listener was registered as
15835	an active or passive listener:
15836
15837	<ul>
15838	<li>An active listener is very similar to a callback: it is a function invoked
15839	by the API. As opposed to the callbacks that were used in the API before
15840	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
15841	</li>
15842
15843	<li>Passive listeners are somewhat trickier to implement, but do not require
15844	a client function to be callable, which is not an option with scripting
15845	languages or web service clients. Internally the <link to="IEventSource" />
15846	implementation maintains an event queue for each passive listener, and
15847	newly arrived events are put in this queue. When the listener calls
15848	<link to="IEventSource::getEvent"/>, first element from its internal event
15849	queue is returned. When the client completes processing of an event,
15850	the <link to="IEventSource::eventProcessed" /> function must be called,
15851	acknowledging that the event was processed. It supports implementing
15852	waitable events. On passive listener unregistration, all events from its
15853	queue are auto-acknowledged.
15854	</li>
15855	</ul>
15856
15857	Waitable events are useful in situations where the event generator wants to track
15858	delivery or a party wants to wait until all listeners have completed the event. A
15859	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
15860	listeners might veto a certain action, and thus the event producer has to make
15861	sure that all listeners have processed the event and not vetoed before taking
15862	the action.
15863
15864	A given event may have both passive and active listeners at the same time.
15865
15866	<b>Using events</b>
15867
15868	Any VirtualBox object capable of producing externally visible events provides an
15869	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
15870	This event source object is notified by VirtualBox once something has happened, so
15871	consumers may register event listeners with this event source. To register a listener,
15872	an object implementing the <link to="IEventListener" /> interface must be provided.
15873	For active listeners, such an object is typically created by the consumer, while for
15874	passive listeners <link to="IEventSource::createListener" /> should be used. Please
15875	note that a listener created with @c createListener() must not be used as an active listener.
15876
15877	Once created, the listener must be registered to listen for the desired events
15878	(see <link to="IEventSource::registerListener" />), providing an array of
15879	<link to="VBoxEventType" /> enums. Those elements can either be the individual
15880	event IDs or wildcards matching multiple event IDs.
15881
15882	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
15883	called automatically when the event is triggered, while passive listeners have to call
15884	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
15885	an event processing loop.
15886
15887	The IEvent interface is an abstract parent interface for all such VirtualBox events
15888	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
15889	or the event processing loop is to check the <link to="#type" /> attribute of the event and
15890	then cast to the appropriate specific interface using @c QueryInterface().
15891	</desc>
15892
15893	<attribute name="type" readonly="yes" type="VBoxEventType">
15894	<desc>
15895	Event type.
15896	</desc>
15897	</attribute>
15898
15899	<attribute name="source" readonly="yes" type="IEventSource">
15900	<desc>
15901	Source of this event.
15902	</desc>
15903	</attribute>
15904
15905	<attribute name="waitable" readonly="yes" type="boolean">
15906	<desc>
15907	If we can wait for this event being processed. If false, waitProcessed() returns immediately,
15908	and setProcessed() doesn't make sense. Non-waitable events are generally better performing,
15909	as no additional overhead associated with waitability imposed.
15910	Waitable events are needed when one need to be able to wait for particular event processed,
15911	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
15912	until all consumers confirmed events.
15913	</desc>
15914	</attribute>
15915
15916	<method name="setProcessed">
15917	<desc>
15918	Internal method called by the system when all listeners of a particular event have called
15919	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
15920	</desc>
15921	</method>
15922
15923	<method name="waitProcessed">
15924	<desc>
15925	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
15926	described semantics, for non-waitable returns true immediately.
15927	</desc>
15928	<param name="timeout" type="long" dir="in">
15929	<desc>
15930	Maximum time to wait for event processeing, in ms;
15931	0 = no wait, -1 = indefinite wait.
15932	</desc>
15933	</param>
15934	<param name="result" type="boolean" dir="return">
15935	<desc>If this event was processed before timeout.</desc>
15936	</param>
15937	</method>
15938	</interface>
15939
15940
15941	<interface
15942	name="IReusableEvent" extends="IEvent"
15943	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
15944	wsmap="managed"
15945	>
15946	<desc>Base abstract interface for all reusable events.</desc>
15947
15948	<attribute name="generation" readonly="yes" type="unsigned long">
15949	<desc>Current generation of event, incremented on reuse.</desc>
15950	</attribute>
15951
15952	<method name="reuse">
15953	<desc>
15954	Marks an event as reused, increments 'generation', fields shall no
15955	longer be considered valid.
15956	</desc>
15957	</method>
15958	</interface>
15959
15960	<interface
15961	name="IMachineEvent" extends="IEvent"
15962	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
15963	wsmap="managed" id="MachineEvent"
15964	>
15965	<desc>Base abstract interface for all machine events.</desc>
15966
15967	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
15968	<desc>ID of the machine this event relates to.</desc>
15969	</attribute>
15970
15971	</interface>
15972
15973	<interface
15974	name="IMachineStateChangedEvent" extends="IMachineEvent"
15975	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
15976	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
15977	>
15978	<desc>Machine state change event.</desc>
15979
15980	<attribute name="state" readonly="yes" type="MachineState">
15981	<desc>New execution state.</desc>
15982	</attribute>
15983	</interface>
15984
15985	<interface
15986	name="IMachineDataChangedEvent" extends="IMachineEvent"
15987	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
15988	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
15989	>
15990	<desc>
15991	Any of the settings of the given machine has changed.
15992	</desc>
15993	</interface>
15994
15995	<interface
15996	name="IMediumRegisteredEvent" extends="IEvent"
15997	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
15998	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
15999	>
16000	<desc>
16001	The given medium was registered or unregistered
16002	within this VirtualBox installation.
16003	</desc>
16004
16005	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
16006	<desc>ID of the medium this event relates to.</desc>
16007	</attribute>
16008
16009	<attribute name="mediumType" readonly="yes" type="DeviceType">
16010	<desc>Type of the medium this event relates to.</desc>
16011	</attribute>
16012
16013	<attribute name="registered" type="boolean" readonly="yes">
16014	<desc>
16015	If @c true, the medium was registered, otherwise it was
16016	unregistered.
16017	</desc>
16018	</attribute>
16019	</interface>
16020
16021	<interface
16022	name="IMachineRegisteredEvent" extends="IMachineEvent"
16023	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
16024	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
16025	>
16026	<desc>
16027	The given machine was registered or unregistered
16028	within this VirtualBox installation.
16029	</desc>
16030
16031	<attribute name="registered" type="boolean" readonly="yes">
16032	<desc>
16033	If @c true, the machine was registered, otherwise it was
16034	unregistered.
16035	</desc>
16036	</attribute>
16037	</interface>
16038
16039	<interface
16040	name="ISessionStateChangedEvent" extends="IMachineEvent"
16041	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
16042	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
16043	>
16044	<desc>
16045	The state of the session for the given machine was changed.
16046	<see>IMachine::sessionState</see>
16047	</desc>
16048
16049	<attribute name="state" type="SessionState" readonly="yes">
16050	<desc>
16051	New session state.
16052	</desc>
16053	</attribute>
16054	</interface>
16055
16056	<interface
16057	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
16058	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
16059	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
16060	>
16061	<desc>
16062	Notification when a guest property has changed.
16063	</desc>
16064
16065	<attribute name="name" readonly="yes" type="wstring">
16066	<desc>
16067	The name of the property that has changed.
16068	</desc>
16069	</attribute>
16070
16071	<attribute name="value" readonly="yes" type="wstring">
16072	<desc>
16073	The new property value.
16074	</desc>
16075	</attribute>
16076
16077	<attribute name="flags" readonly="yes" type="wstring">
16078	<desc>
16079	The new property flags.
16080	</desc>
16081	</attribute>
16082
16083	</interface>
16084
16085	<interface
16086	name="ISnapshotEvent" extends="IMachineEvent"
16087	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
16088	wsmap="managed" id="SnapshotEvent"
16089	>
16090	<desc>Base interface for all snapshot events.</desc>
16091
16092	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
16093	<desc>ID of the snapshot this event relates to.</desc>
16094	</attribute>
16095
16096	</interface>
16097
16098	<interface
16099	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
16100	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
16101	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
16102	>
16103	<desc>
16104	A new snapshot of the machine has been taken.
16105	<see>ISnapshot</see>
16106	</desc>
16107	</interface>
16108
16109	<interface
16110	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
16111	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
16112	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
16113	>
16114	<desc>
16115	Snapshot of the given machine has been deleted.
16116
16117	<note>
16118	This notification is delivered <b>after</b> the snapshot
16119	object has been uninitialized on the server (so that any
16120	attempt to call its methods will return an error).
16121	</note>
16122
16123	<see>ISnapshot</see>
16124	</desc>
16125	</interface>
16126
16127	<interface
16128	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
16129	uuid="07541941-8079-447a-a33e-47a69c7980db"
16130	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
16131	>
16132	<desc>
16133	Snapshot properties (name and/or description) have been changed.
16134	<see>ISnapshot</see>
16135	</desc>
16136	</interface>
16137
16138	<interface
16139	name="IMousePointerShapeChangedEvent" extends="IEvent"
16140	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
16141	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
16142	>
16143	<desc>
16144	Notification when the guest mouse pointer shape has
16145	changed. The new shape data is given.
16146	</desc>
16147
16148	<attribute name="visible" type="boolean" readonly="yes">
16149	<desc>
16150	Flag whether the pointer is visible.
16151	</desc>
16152	</attribute>
16153	<attribute name="alpha" type="boolean" readonly="yes">
16154	<desc>
16155	Flag whether the pointer has an alpha channel.
16156	</desc>
16157	</attribute>
16158	<attribute name="xhot" type="unsigned long" readonly="yes">
16159	<desc>
16160	The pointer hot spot X coordinate.
16161	</desc>
16162	</attribute>
16163	<attribute name="yhot" type="unsigned long" readonly="yes">
16164	<desc>
16165	The pointer hot spot Y coordinate.
16166	</desc>
16167	</attribute>
16168	<attribute name="width" type="unsigned long" readonly="yes">
16169	<desc>
16170	Width of the pointer shape in pixels.
16171	</desc>
16172	</attribute>
16173	<attribute name="height" type="unsigned long" readonly="yes">
16174	<desc>
16175	Height of the pointer shape in pixels.
16176	</desc>
16177	</attribute>
16178	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
16179	<desc>
16180	Shape buffer arrays.
16181
16182	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
16183	followed by a 32-bpp XOR (color) mask.
16184
16185	For pointers without alpha channel the XOR mask pixels are 32
16186	bit values: (lsb)BGR0(msb). For pointers with alpha channel
16187	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
16188
16189	An AND mask is used for pointers with alpha channel, so if the
16190	callback does not support alpha, the pointer could be
16191	displayed as a normal color pointer.
16192
16193	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
16194	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
16195	height</tt>. The padding bits at the end of each scanline are
16196	undefined.
16197
16198	The XOR mask follows the AND mask on the next 4-byte aligned
16199	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
16200	Bytes in the gap between the AND and the XOR mask are undefined.
16201	The XOR mask scanlines have no gap between them and the size of
16202	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
16203
16204	<note>
16205	If @a shape is 0, only the pointer visibility is changed.
16206	</note>
16207	</desc>
16208	</attribute>
16209	</interface>
16210
16211	<interface
16212	name="IMouseCapabilityChangedEvent" extends="IEvent"
16213	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
16214	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
16215	>
16216	<desc>
16217	Notification when the mouse capabilities reported by the
16218	guest have changed. The new capabilities are passed.
16219	</desc>
16220	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
16221	<desc>
16222	Supports absolute coordinates.
16223	</desc>
16224	</attribute>
16225	<attribute name="supportsRelative" type="boolean" readonly="yes">
16226	<desc>
16227	Supports relative coordinates.
16228	</desc>
16229	</attribute>
16230	<attribute name="needsHostCursor" type="boolean" readonly="yes">
16231	<desc>
16232	If host cursor is needed.
16233	</desc>
16234	</attribute>
16235	</interface>
16236
16237	<interface
16238	name="IKeyboardLedsChangedEvent" extends="IEvent"
16239	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
16240	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
16241	>
16242	<desc>
16243	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
16244	to alter the state of the keyboard LEDs.
16245	</desc>
16246	<attribute name="numLock" type="boolean" readonly="yes">
16247	<desc>
16248	NumLock status.
16249	</desc>
16250	</attribute>
16251	<attribute name="capsLock" type="boolean" readonly="yes">
16252	<desc>
16253	CapsLock status.
16254	</desc>
16255	</attribute>
16256	<attribute name="scrollLock" type="boolean" readonly="yes">
16257	<desc>
16258	ScrollLock status.
16259	</desc>
16260	</attribute>
16261	</interface>
16262
16263	<interface
16264	name="IStateChangedEvent" extends="IEvent"
16265	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
16266	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
16267	>
16268	<desc>
16269	Notification when the execution state of the machine has changed.
16270	The new state is given.
16271	</desc>
16272	<attribute name="state" type="MachineState" readonly="yes">
16273	<desc>
16274	New machine state.
16275	</desc>
16276	</attribute>
16277	</interface>
16278
16279	<interface
16280	name="IAdditionsStateChangedEvent" extends="IEvent"
16281	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
16282	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
16283	>
16284	<desc>
16285	Notification when a Guest Additions property changes.
16286	Interested callees should query IGuest attributes to
16287	find out what has changed.
16288	</desc>
16289	</interface>
16290
16291	<interface
16292	name="INetworkAdapterChangedEvent" extends="IEvent"
16293	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
16294	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
16295	>
16296	<desc>
16297	Notification when a property of one of the
16298	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
16299	changes. Interested callees should use INetworkAdapter methods and
16300	attributes to find out what has changed.
16301	</desc>
16302	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
16303	<desc>
16304	Network adapter that is subject to change.
16305	</desc>
16306	</attribute>
16307	</interface>
16308
16309	<interface
16310	name="ISerialPortChangedEvent" extends="IEvent"
16311	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
16312	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
16313	>
16314	<desc>
16315	Notification when a property of one of the
16316	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
16317	Interested callees should use ISerialPort methods and attributes
16318	to find out what has changed.
16319	</desc>
16320	<attribute name="serialPort" type="ISerialPort" readonly="yes">
16321	<desc>
16322	Serial port that is subject to change.
16323	</desc>
16324	</attribute>
16325	</interface>
16326
16327	<interface
16328	name="IParallelPortChangedEvent" extends="IEvent"
16329	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
16330	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
16331	>
16332	<desc>
16333	Notification when a property of one of the
16334	virtual <link to="IMachine::getParallelPort">parallel ports</link>
16335	changes. Interested callees should use ISerialPort methods and
16336	attributes to find out what has changed.
16337	</desc>
16338	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
16339	<desc>
16340	Parallel port that is subject to change.
16341	</desc>
16342	</attribute>
16343	</interface>
16344
16345	<interface
16346	name="IStorageControllerChangedEvent" extends="IEvent"
16347	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
16348	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
16349	>
16350	<desc>
16351	Notification when a
16352	<link to="IMachine::mediumAttachments">medium attachment</link>
16353	changes.
16354	</desc>
16355	</interface>
16356
16357	<interface
16358	name="IMediumChangedEvent" extends="IEvent"
16359	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
16360	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
16361	>
16362	<desc>
16363	Notification when a
16364	<link to="IMachine::mediumAttachments">medium attachment</link>
16365	changes.
16366	</desc>
16367	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
16368	<desc>
16369	Medium attachment that is subject to change.
16370	</desc>
16371	</attribute>
16372	</interface>
16373
16374	<interface
16375	name="ICPUChangedEvent" extends="IEvent"
16376	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
16377	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
16378	>
16379	<desc>
16380	Notification when a CPU changes.
16381	</desc>
16382	<attribute name="cpu" type="unsigned long" readonly="yes">
16383	<desc>
16384	The CPU which changed.
16385	</desc>
16386	</attribute>
16387	<attribute name="add" type="boolean" readonly="yes">
16388	<desc>
16389	Flag whether the CPU was added or removed.
16390	</desc>
16391	</attribute>
16392	</interface>
16393
16394	<interface
16395	name="ICPUExecutionCapChangedEvent" extends="IEvent"
16396	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
16397	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
16398	>
16399	<desc>
16400	Notification when the CPU execution cap changes.
16401	</desc>
16402	<attribute name="executionCap" type="unsigned long" readonly="yes">
16403	<desc>
16404	The new CPU execution cap value. (1-100)
16405	</desc>
16406	</attribute>
16407	</interface>
16408
16409	<interface
16410	name="IGuestKeyboardEvent" extends="IEvent"
16411	uuid="88394258-7006-40d4-b339-472ee3801844"
16412	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
16413	>
16414	<desc>
16415	Notification when guest keyboard event happens.
16416	</desc>
16417	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
16418	<desc>
16419	Array of scancodes.
16420	</desc>
16421	</attribute>
16422	</interface>
16423
16424	<interface
16425	name="IGuestMouseEvent" extends="IReusableEvent"
16426	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
16427	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
16428	>
16429	<desc>
16430	Notification when guest mouse event happens.
16431	</desc>
16432
16433	<attribute name="absolute" type="boolean" readonly="yes">
16434	<desc>
16435	If this event is relative or absolute.
16436	</desc>
16437	</attribute>
16438
16439	<attribute name="x" type="long" readonly="yes">
16440	<desc>
16441	New X position, or X delta.
16442	</desc>
16443	</attribute>
16444
16445	<attribute name="y" type="long" readonly="yes">
16446	<desc>
16447	New Y position, or Y delta.
16448	</desc>
16449	</attribute>
16450
16451	<attribute name="z" type="long" readonly="yes">
16452	<desc>
16453	Z delta.
16454	</desc>
16455	</attribute>
16456
16457	<attribute name="w" type="long" readonly="yes">
16458	<desc>
16459	W delta.
16460	</desc>
16461	</attribute>
16462
16463	<attribute name="buttons" type="long" readonly="yes">
16464	<desc>
16465	Button state bitmask.
16466	</desc>
16467	</attribute>
16468
16469	</interface>
16470
16471
16472	<interface
16473	name="IVRDEServerChangedEvent" extends="IEvent"
16474	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
16475	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
16476	>
16477	<desc>
16478	Notification when a property of the
16479	<link to="IMachine::VRDEServer">VRDE server</link> changes.
16480	Interested callees should use IVRDEServer methods and attributes to
16481	find out what has changed.
16482	</desc>
16483	</interface>
16484
16485	<interface
16486	name="IVRDEServerInfoChangedEvent" extends="IEvent"
16487	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
16488	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
16489	>
16490	<desc>
16491	Notification when the status of the VRDE server changes. Interested callees
16492	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
16493	attributes to find out what is the current status.
16494	</desc>
16495	</interface>
16496
16497	<interface
16498	name="IUSBControllerChangedEvent" extends="IEvent"
16499	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
16500	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
16501	>
16502	<desc>
16503	Notification when a property of the virtual
16504	<link to="IMachine::USBController">USB controller</link> changes.
16505	Interested callees should use IUSBController methods and attributes to
16506	find out what has changed.
16507	</desc>
16508	</interface>
16509
16510	<interface
16511	name="IUSBDeviceStateChangedEvent" extends="IEvent"
16512	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
16513	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
16514	>
16515	<desc>
16516	Notification when a USB device is attached to or detached from
16517	the virtual USB controller.
16518
16519	This notification is sent as a result of the indirect
16520	request to attach the device because it matches one of the
16521	machine USB filters, or as a result of the direct request
16522	issued by <link to="IConsole::attachUSBDevice"/> or
16523	<link to="IConsole::detachUSBDevice"/>.
16524
16525	This notification is sent in case of both a succeeded and a
16526	failed request completion. When the request succeeds, the
16527	@a error parameter is @c null, and the given device has been
16528	already added to (when @a attached is @c true) or removed from
16529	(when @a attached is @c false) the collection represented by
16530	<link to="IConsole::USBDevices"/>. On failure, the collection
16531	doesn't change and the @a error parameter represents the error
16532	message describing the failure.
16533	</desc>
16534	<attribute name="device" type="IUSBDevice" readonly="yes">
16535	<desc>
16536	Device that is subject to state change.
16537	</desc>
16538	</attribute>
16539	<attribute name="attached" type="boolean" readonly="yes">
16540	<desc>
16541	@c true if the device was attached and @c false otherwise.
16542	</desc>
16543	</attribute>
16544	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
16545	<desc>
16546	@c null on success or an error message object on failure.
16547	</desc>
16548	</attribute>
16549	</interface>
16550
16551	<interface
16552	name="ISharedFolderChangedEvent" extends="IEvent"
16553	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
16554	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
16555	>
16556	<desc>
16557	Notification when a shared folder is added or removed.
16558	The @a scope argument defines one of three scopes:
16559	<link to="IVirtualBox::sharedFolders">global shared folders</link>
16560	(<link to="Scope_Global">Global</link>),
16561	<link to="IMachine::sharedFolders">permanent shared folders</link> of
16562	the machine (<link to="Scope_Machine">Machine</link>) or <link
16563	to="IConsole::sharedFolders">transient shared folders</link> of the
16564	machine (<link to="Scope_Session">Session</link>). Interested callees
16565	should use query the corresponding collections to find out what has
16566	changed.
16567	</desc>
16568	<attribute name="scope" type="Scope" readonly="yes">
16569	<desc>
16570	Scope of the notification.
16571	</desc>
16572	</attribute>
16573	</interface>
16574
16575	<interface
16576	name="IRuntimeErrorEvent" extends="IEvent"
16577	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
16578	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
16579	>
16580	<desc>
16581	Notification when an error happens during the virtual
16582	machine execution.
16583
16584	There are three kinds of runtime errors:
16585	<ul>
16586	<li><i>fatal</i></li>
16587	<li><i>non-fatal with retry</i></li>
16588	<li><i>non-fatal warnings</i></li>
16589	</ul>
16590
16591	<b>Fatal</b> errors are indicated by the @a fatal parameter set
16592	to @c true. In case of fatal errors, the virtual machine
16593	execution is always paused before calling this notification, and
16594	the notification handler is supposed either to immediately save
16595	the virtual machine state using <link to="IConsole::saveState"/>
16596	or power it off using <link to="IConsole::powerDown"/>.
16597	Resuming the execution can lead to unpredictable results.
16598
16599	<b>Non-fatal</b> errors and warnings are indicated by the
16600	@a fatal parameter set to @c false. If the virtual machine
16601	is in the Paused state by the time the error notification is
16602	received, it means that the user can <i>try to resume</i> the machine
16603	execution after attempting to solve the problem that caused the
16604	error. In this case, the notification handler is supposed
16605	to show an appropriate message to the user (depending on the
16606	value of the @a id parameter) that offers several actions such
16607	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
16608	wants to retry, the notification handler should continue
16609	the machine execution using the <link to="IConsole::resume"/>
16610	call. If the machine execution is not Paused during this
16611	notification, then it means this notification is a <i>warning</i>
16612	(for example, about a fatal condition that can happen very soon);
16613	no immediate action is required from the user, the machine
16614	continues its normal execution.
16615
16616	Note that in either case the notification handler
16617	<b>must not</b> perform any action directly on a thread
16618	where this notification is called. Everything it is allowed to
16619	do is to post a message to another thread that will then talk
16620	to the user and take the corresponding action.
16621
16622	Currently, the following error identifiers are known:
16623	<ul>
16624	<li><tt>"HostMemoryLow"</tt></li>
16625	<li><tt>"HostAudioNotResponding"</tt></li>
16626	<li><tt>"VDIStorageFull"</tt></li>
16627	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
16628	</ul>
16629	</desc>
16630	<attribute name="fatal" type="boolean" readonly="yes">
16631	<desc>
16632	Whether the error is fatal or not.
16633	</desc>
16634	</attribute>
16635	<attribute name="id" type="wstring" readonly="yes">
16636	<desc>
16637	Error identifier.
16638	</desc>
16639	</attribute>
16640	<attribute name="message" type="wstring" readonly="yes">
16641	<desc>
16642	Optional error message.
16643	</desc>
16644	</attribute>
16645	</interface>
16646
16647
16648	<interface
16649	name="IEventSourceChangedEvent" extends="IEvent"
16650	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
16651	waitable="yes"
16652	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
16653	>
16654	<desc>
16655	Notification when an event source state changes (listener added or removed).
16656	</desc>
16657
16658	<attribute name="listener" type="IEventListener" readonly="yes">
16659	<desc>
16660	Event listener which has changed.
16661	</desc>
16662	</attribute>
16663
16664	<attribute name="add" type="boolean" readonly="yes">
16665	<desc>
16666	Flag whether listener was added or removed.
16667	</desc>
16668	</attribute>
16669	</interface>
16670
16671	<interface
16672	name="IExtraDataChangedEvent" extends="IEvent"
16673	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
16674	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
16675	>
16676	<desc>
16677	Notification when machine specific or global extra data
16678	has changed.
16679	</desc>
16680	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
16681	<desc>
16682	ID of the machine this event relates to.
16683	Null for global extra data changes.
16684	</desc>
16685	</attribute>
16686	<attribute name="key" type="wstring" readonly="yes">
16687	<desc>
16688	Extra data key that has changed.
16689	</desc>
16690	</attribute>
16691	<attribute name="value" type="wstring" readonly="yes">
16692	<desc>
16693	Extra data value for the given key.
16694	</desc>
16695	</attribute>
16696	</interface>
16697
16698	<interface
16699	name="IVetoEvent" extends="IEvent"
16700	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
16701	wsmap="managed"
16702	>
16703	<desc>Base abstract interface for veto events.</desc>
16704
16705	<method name="addVeto">
16706	<desc>
16707	Adds a veto on this event.
16708	</desc>
16709	<param name="reason" type="wstring" dir="in">
16710	<desc>
16711	Reason for veto, could be null or empty string.
16712	</desc>
16713	</param>
16714	</method>
16715
16716	<method name="isVetoed">
16717	<desc>
16718	If this event was vetoed.
16719	</desc>
16720	<param name="result" type="boolean" dir="return">
16721	<desc>
16722	Reason for veto.
16723	</desc>
16724	</param>
16725	</method>
16726
16727	<method name="getVetos">
16728	<desc>
16729	Current veto reason list, if size is 0 - no veto.
16730	</desc>
16731	<param name="result" type="wstring" dir="return" safearray="yes">
16732	<desc>
16733	Array of reasons for veto provided by different event handlers.
16734	</desc>
16735	</param>
16736	</method>
16737
16738	</interface>
16739
16740	<interface
16741	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
16742	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
16743	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
16744	waitable="true"
16745	>
16746	<desc>
16747	Notification when someone tries to change extra data for
16748	either the given machine or (if @c null) global extra data.
16749	This gives the chance to veto against changes.
16750	</desc>
16751	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
16752	<desc>
16753	ID of the machine this event relates to.
16754	Null for global extra data changes.
16755	</desc>
16756	</attribute>
16757	<attribute name="key" type="wstring" readonly="yes">
16758	<desc>
16759	Extra data key that has changed.
16760	</desc>
16761	</attribute>
16762	<attribute name="value" type="wstring" readonly="yes">
16763	<desc>
16764	Extra data value for the given key.
16765	</desc>
16766	</attribute>
16767	</interface>
16768
16769	<interface
16770	name="ICanShowWindowEvent" extends="IVetoEvent"
16771	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
16772	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
16773	waitable="true"
16774	>
16775	<desc>
16776	Notification when a call to
16777	<link to="IMachine::canShowConsoleWindow"/> is made by a
16778	front-end to check if a subsequent call to
16779	<link to="IMachine::showConsoleWindow"/> can succeed.
16780
16781	The callee should give an answer appropriate to the current
16782	machine state using event veto. This answer must
16783	remain valid at least until the next
16784	<link to="IConsole::state">machine state</link> change.
16785	</desc>
16786	</interface>
16787
16788	<interface
16789	name="IShowWindowEvent" extends="IEvent"
16790	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
16791	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
16792	waitable="true"
16793	>
16794	<desc>
16795	Notification when a call to
16796	<link to="IMachine::showConsoleWindow"/>
16797	requests the console window to be activated and brought to
16798	foreground on the desktop of the host PC.
16799
16800	This notification should cause the VM console process to
16801	perform the requested action as described above. If it is
16802	impossible to do it at a time of this notification, this
16803	method should return a failure.
16804
16805	Note that many modern window managers on many platforms
16806	implement some sort of focus stealing prevention logic, so
16807	that it may be impossible to activate a window without the
16808	help of the currently active application (which is supposedly
16809	an initiator of this notification). In this case, this method
16810	must return a non-zero identifier that represents the
16811	top-level window of the VM console process. The caller, if it
16812	represents a currently active process, is responsible to use
16813	this identifier (in a platform-dependent manner) to perform
16814	actual window activation.
16815
16816	This method must set @a winId to zero if it has performed all
16817	actions necessary to complete the request and the console
16818	window is now active and in foreground, to indicate that no
16819	further action is required on the caller's side.
16820	</desc>
16821	<attribute name="winId" type="long long">
16822	<desc>
16823	Platform-dependent identifier of the top-level VM console
16824	window, or zero if this method has performed all actions
16825	necessary to implement the <i>show window</i> semantics for
16826	the given platform and/or this VirtualBox front-end.
16827	</desc>
16828	</attribute>
16829	</interface>
16830
16831	<interface
16832	name="INATRedirectEvent" extends="IMachineEvent"
16833	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
16834	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
16835	>
16836	<desc>
16837	Notification when NAT redirect rule added or removed.
16838	</desc>
16839	<attribute name="slot" type="unsigned long" readonly="yes">
16840	<desc>
16841	Adapter which NAT attached to.
16842	</desc>
16843	</attribute>
16844	<attribute name="remove" type="boolean" readonly="yes">
16845	<desc>
16846	Whether rule remove or add.
16847	</desc>
16848	</attribute>
16849	<attribute name="name" type="wstring" readonly="yes">
16850	<desc>
16851	Name of the rule.
16852	</desc>
16853	</attribute>
16854	<attribute name="proto" type="NATProtocol" readonly="yes">
16855	<desc>
16856	Protocol (TCP or UDP) of the redirect rule.
16857	</desc>
16858	</attribute>
16859	<attribute name="hostIp" type="wstring" readonly="yes">
16860	<desc>
16861	Host ip address to bind socket on.
16862	</desc>
16863	</attribute>
16864	<attribute name="hostPort" type="long" readonly="yes">
16865	<desc>
16866	Host port to bind socket on.
16867	</desc>
16868	</attribute>
16869	<attribute name="guestIp" type="wstring" readonly="yes">
16870	<desc>
16871	Guest ip address to redirect to.
16872	</desc>
16873	</attribute>
16874	<attribute name="guestPort" type="long" readonly="yes">
16875	<desc>
16876	Guest port to redirect to.
16877	</desc>
16878	</attribute>
16879	</interface>
16880
16881	<interface
16882	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
16883	waitable="yes"
16884	uuid="9cebfc27-c579-4965-8eb7-d31794cd7dcf"
16885	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
16886	>
16887	<desc>
16888	Notification when host PCI device is plugged/unplugged. Plugging
16889	usually takes place on VM startup, unplug - when
16890	IMachine::DetachHostPciDevice is called.
16891
16892	<see>IMachine::DetachHostPciDevice</see>
16893
16894	</desc>
16895
16896	<attribute name="plugged" type="boolean" readonly="yes">
16897	<desc>
16898	If device successfully plugged or unplugged.
16899	</desc>
16900	</attribute>
16901
16902	<attribute name="success" type="boolean" readonly="yes">
16903	<desc>
16904	If operation was successful, if false - 'message' attribute
16905	may be of interest.
16906	</desc>
16907	</attribute>
16908
16909	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
16910	<desc>
16911	Attachment info for this device.
16912	</desc>
16913	</attribute>
16914
16915	<attribute name="message" type="wstring" readonly="yes">
16916	<desc>
16917	Optional error message.
16918	</desc>
16919	</attribute>
16920
16921	</interface>
16922
16923	<interface
16924	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
16925	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
16926	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
16927	>
16928	<desc>
16929	Notification when VBoxSVC becomes unavailable (due to a crash or similar
16930	unexpected circumstances) or available again.
16931	</desc>
16932
16933	<attribute name="available" type="boolean" readonly="yes">
16934	<desc>
16935	Whether VBoxSVC is available now.
16936	</desc>
16937	</attribute>
16938	</interface>
16939
16940	<interface
16941	name="IBandwidthGroupChangedEvent" extends="IEvent"
16942	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
16943	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
16944	>
16945	<desc>
16946	Notification when one of the bandwidth groups changed
16947	</desc>
16948	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
16949	<desc>
16950	The changed bandwidth group.
16951	</desc>
16952	</attribute>
16953	</interface>
16954
16955	<enum
16956	name="GuestMonitorChangedEventType"
16957	uuid="ef172985-7e36-4297-95be-e46396968d66"
16958	>
16959
16960	<desc>
16961	How the guest monitor has been changed.
16962	</desc>
16963
16964	<const name="Enabled" value="0">
16965	<desc>
16966	The guest monitor has been enabled by the guest.
16967	</desc>
16968	</const>
16969
16970	<const name="Disabled" value="1">
16971	<desc>
16972	The guest monitor has been disabled by the guest.
16973	</desc>
16974	</const>
16975
16976	<const name="NewOrigin" value="2">
16977	<desc>
16978	The guest monitor origin has changed in the guest.
16979	</desc>
16980	</const>
16981	</enum>
16982
16983	<interface
16984	name="IGuestMonitorChangedEvent" extends="IEvent"
16985	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
16986	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
16987	>
16988	<desc>
16989	Notification when the guest enables one of its monitors.
16990	</desc>
16991
16992	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
16993	<desc>
16994	What was changed for this guest monitor.
16995	</desc>
16996	</attribute>
16997
16998	<attribute name="screenId" type="unsigned long" readonly="yes">
16999	<desc>
17000	The monitor which was changed.
17001	</desc>
17002	</attribute>
17003
17004	<attribute name="originX" type="unsigned long" readonly="yes">
17005	<desc>
17006	Physical X origin relative to the primary screen.
17007	Valid for Enabled and NewOrigin.
17008	</desc>
17009	</attribute>
17010
17011	<attribute name="originY" type="unsigned long" readonly="yes">
17012	<desc>
17013	Physical Y origin relative to the primary screen.
17014	Valid for Enabled and NewOrigin.
17015	</desc>
17016	</attribute>
17017
17018	<attribute name="width" type="unsigned long" readonly="yes">
17019	<desc>
17020	Width of the screen.
17021	Valid for Enabled.
17022	</desc>
17023	</attribute>
17024
17025	<attribute name="height" type="unsigned long" readonly="yes">
17026	<desc>
17027	Height of the screen.
17028	Valid for Enabled.
17029	</desc>
17030	</attribute>
17031
17032	</interface>
17033
17034	<module name="VBoxSVC" context="LocalServer">
17035	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
17036	namespace="virtualbox.org">
17037	<interface name="IVirtualBox" default="yes"/>
17038	</class>
17039	</module>
17040
17041	<module name="VBoxC" context="InprocServer" threadingModel="Free">
17042	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
17043	namespace="virtualbox.org">
17044	<interface name="IVirtualBoxClient" default="yes"/>
17045	</class>
17046
17047	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
17048	namespace="virtualbox.org">
17049	<interface name="ISession" default="yes"/>
17050	</class>
17051	</module>
17052
17053	</library>
17054
17055	</idl>
17056
17057	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format