VirtualBox.xidl@ 30871

Last change on this file since 30871 was 30871, checked in by vboxsync, 14 years ago
Main: event names now in past tense
Property svn:eol-style set to `native`
File size: 546.6 KB

Line
1	<?xml version="1.0" ?>
2
3	<!--
4
5	Copyright (C) 2006-2010 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	the VBoxManage command-line interface and the VBoxVRDP server) 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 name="SettingsVersion"
388	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
389	>
390	<desc>Settings version of VirtualBox settings files. This is written to
391	the "version" attribute of the root "VirtualBox" element in the settings
392	file XML and indicates which VirtualBox version wrote the file.
393	</desc>
394
395	<const name="Null" value="0">
396	<desc>Null value, indicates invalid version.</desc>
397	</const>
398	<const name="v1_0" value="1">
399	<desc>Legacy settings version, not currently supported.</desc>
400	</const>
401	<const name="v1_1" value="2">
402	<desc>Legacy settings version, not currently supported.</desc>
403	</const>
404	<const name="v1_2" value="3">
405	<desc>Legacy settings version, not currently supported.</desc>
406	</const>
407	<const name="v1_3pre" value="4">
408	<desc>Legacy settings version, not currently supported.</desc>
409	</const>
410	<const name="v1_3" value="5">
411	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
412	<!--
413	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
414	-->
415	</const>
416	<const name="v1_4" value="6">
417	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
418	<!--
419	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
420	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
421	-->
422	</const>
423	<const name="v1_5" value="7">
424	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
425	<!-- 2008-09-04: 2.0.0 released
426	2008-11-20: settings version 1.5 introduced
427	2008-12-17: 2.1.0 released
428	Machine changes:
429	guest OS identifiers changed;
430	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
431	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
432	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
433	-->
434	</const>
435	<const name="v1_6" value="8">
436	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
437	<!-- 2008-12-17: 2.1.0 released
438	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
439	2009-04-08: 2.2.0 released
440	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
441	-->
442	</const>
443	<const name="v1_7" value="9">
444	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
445	<!-- 2008-12-17: 2.1.0 released
446	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
447	2009-04-08: 2.2.0 released
448	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
449	Machine changes: HardDiskAttachments is now StorageControllers (done)
450	-->
451	</const>
452	<const name="v1_8" value="10">
453	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
454	<!-- Machine additions: Display/@accelerate2DVideo (done)
455	-->
456	</const>
457	<const name="v1_9" value="11">
458	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
459	<!-- The big storage controller / DVD / Floppy rework (done)
460	-->
461	</const>
462	<const name="v1_10" value="12">
463	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
464	<!-- Machine changes: RTC localOrUTC (done)
465	CPU hot-plug support
466	-->
467	</const>
468	<const name="Future" value="13">
469	<desc>Settings version greater than "1.10", written by a future VirtualBox version.</desc>
470	</const>
471	</enum>
472
473	<enum
474	name="AccessMode"
475	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
476	>
477	<desc>
478	Access mode for opening files.
479	</desc>
480
481	<const name="ReadOnly" value="1"/>
482	<const name="ReadWrite" value="2"/>
483	</enum>
484
485	<enum
486	name="MachineState"
487	uuid="e998d075-543a-41fc-8aa9-5ca3e92393fd"
488	>
489	<desc>
490	Virtual machine execution state.
491
492	This enumeration represents possible values of the <link
493	to="IMachine::state"/> attribute.
494
495	Below is the basic virtual machine state diagram. It shows how the state
496	changes during virtual machine execution. The text in square braces shows
497	a method of the IConsole interface that performs the given state
498	transition.
499
500	<pre>
501	+---------[powerDown()] <- Stuck <--[failure]-+
502	V \|
503	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
504	\| \| \| \| V \|
505	\| Aborted -----+ +--> Running --[pause()]--> Paused
506	\| \| ^ \| ^ \|
507	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
508	\| ^ \| \| \| \|
509	\| \| +-----------------------------------------+-\|-------------------+ +
510	\| \| \| \| \|
511	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
512	\| \| \| \|
513	\| +-------- Saving <--------[saveState()]<----------+---------------------+
514	\| \| \|
515	+-------------- Stopping -------[powerDown()]<----------+---------------------+
516	</pre>
517
518	Note that states to the right from PoweredOff, Aborted and Saved in the
519	above diagram are called <i>online VM states</i>. These states
520	represent the virtual machine which is being executed in a dedicated
521	process (usually with a GUI window attached to it where you can see the
522	activity of the virtual machine and interact with it). There are two
523	special pseudo-states, FirstOnline and LastOnline, that can be used in
524	relational expressions to detect if the given machine state is online or
525	not:
526
527	<pre>
528	if (machine.GetState() >= MachineState_FirstOnline &&
529	machine.GetState() <= MachineState_LastOnline)
530	{
531	...the machine is being executed...
532	}
533	</pre>
534
535	When the virtual machine is in one of the online VM states (that is, being
536	executed), only a few machine settings can be modified. Methods working
537	with such settings contain an explicit note about that. An attempt to
538	change any oter setting or perform a modifying operation during this time
539	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
540
541	All online states except Running, Paused and Stuck are transitional: they
542	represent temporary conditions of the virtual machine that will last as
543	long as the operation that initiated such a condition.
544
545	The Stuck state is a special case. It means that execution of the machine
546	has reached the "Guru Meditation" condition. This condition indicates an
547	internal VMM (virtual machine manager) failure which may happen as a
548	result of either an unhandled low-level virtual hardware exception or one
549	of the recompiler exceptions (such as the <i>too-many-traps</i>
550	condition).
551
552	Note also that any online VM state may transit to the Aborted state. This
553	happens if the process that is executing the virtual machine terminates
554	unexpectedly (for example, crashes). Other than that, the Aborted state is
555	equivalent to PoweredOff.
556
557	There are also a few additional state diagrams that do not deal with
558	virtual machine execution and therefore are shown separately. The states
559	shown on these diagrams are called <i>offline VM states</i> (this includes
560	PoweredOff, Aborted and Saved too).
561
562	The first diagram shows what happens when a lengthy setup operation is
563	being executed (such as <link to="IMachine::attachDevice"/>).
564
565	<pre>
566	+----------------------------------(same state as before the call)------+
567	\| \|
568	+-> PoweredOff --+ \|
569	\| \| \|
570	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
571	\| \|
572	+-> Saved -------+
573	</pre>
574
575	The next two diagrams demonstrate the process of taking a snapshot of a
576	powered off virtual machine, restoring the state to that as of a snapshot
577	or deleting a snapshot, respectively.
578
579	<pre>
580	+----------------------------------(same state as before the call)------+
581	\| \|
582	+-> PoweredOff --+ \|
583	\| +-->[takeSnapshot()] -------------------> Saving ------+
584	+-> Aborted -----+
585
586	+-> PoweredOff --+
587	\| \|
588	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
589	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
590	+-> Saved -------+ \|
591	\| \|
592	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
593	</pre>
594
595	Note that the Saving state is present in both the offline state group and
596	online state group. Currently, the only way to determine what group is
597	assumed in a particular case is to remember the previous machine state: if
598	it was Running or Paused, then Saving is an online state, otherwise it is
599	an offline state. This inconsistency may be removed in one of the future
600	versions of VirtualBox by adding a new state.
601
602	<note internal="yes">
603	For whoever decides to touch this enum: In order to keep the
604	comparisons involving FirstOnline and LastOnline pseudo-states valid,
605	the numeric values of these states must be correspondingly updated if
606	needed: for any online VM state, the condition
607	<tt>FirstOnline <= state <= LastOnline</tt> must be
608	@c true. The same relates to transient states for which
609	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
610	@c true.
611	</note>
612	</desc>
613
614	<const name="Null" value="0">
615	<desc>Null value (never used by the API).</desc>
616	</const>
617	<const name="PoweredOff" value="1">
618	<desc>
619	The machine is not running and has no saved execution state; it has
620	either never been started or been shut down successfully.
621	</desc>
622	</const>
623	<const name="Saved" value="2">
624	<desc>
625	The machine is not currently running, but the execution state of the machine
626	has been saved to an external file when it was running, from where
627	it can be resumed.
628	</desc>
629	</const>
630	<const name="Teleported" value="3">
631	<desc>
632	The machine was teleported to a different host (or process) and then
633	powered off. Take care when powering it on again may corrupt resources
634	it shares with the teleportation target (e.g. disk and network).
635	</desc>
636	</const>
637	<const name="Aborted" value="4">
638	<desc>
639	The process running the machine has terminated abnormally. This may
640	indicate a crash of the VM process in host execution context, or
641	the VM process has been terminated externally.
642	</desc>
643	</const>
644	<const name="Running" value="5">
645	<desc>
646	The machine is currently being executed.
647	<note internal="yes">
648	For whoever decides to touch this enum: In order to keep the
649	comparisons in the old source code valid, this state must immediately
650	precede the Paused state.
651	TODO: Lift this spectacularly wonderful restriction.
652	</note>
653	</desc>
654	</const>
655	<const name="Paused" value="6">
656	<desc>
657	Execution of the machine has been paused.
658	<note internal="yes">
659	For whoever decides to touch this enum: In order to keep the
660	comparisons in the old source code valid, this state must immediately
661	follow the Running state.
662	TODO: Lift this spectacularly wonderful restriction.
663	</note>
664	</desc>
665	</const>
666	<const name="Stuck" value="7">
667	<desc>
668	Execution of the machine has reached the "Guru Meditation"
669	condition. This indicates a severe error in the hypervisor itself.
670	<note internal="yes">
671	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
672	"Guru", perhaps? Or are there some other VMM states that are
673	intended to be lumped in here as well?
674	</note>
675	</desc>
676	</const>
677	<const name="Teleporting" value="8">
678	<desc>
679	The machine is about to be teleported to a different host or process.
680	It is possible to pause a machine in this state, but it will go to the
681	<link to="MachineState::PausedTeleporting"/> state and it will not be
682	possible to resume it again unless the teleportation fails.
683	</desc>
684	</const>
685	<const name="LiveSnapshotting" value="9">
686	<desc>
687	A live snapshot is being taken. The machine is running normally, but
688	some of the runtime configuration options are inaccessible. Also, if
689	paused while in this state it will transition to
690	<link to="MachineState::Saving"/> and it will not be resume the
691	execution until the snapshot operation has completed.
692	</desc>
693	</const>
694	<const name="Starting" value="10">
695	<desc>
696	Machine is being started after powering it on from a
697	zero execution state.
698	</desc>
699	</const>
700	<const name="Stopping" value="11">
701	<desc>
702	Machine is being normally stopped powering it off, or after the guest OS
703	has initiated a shutdown sequence.
704	</desc>
705	</const>
706	<const name="Saving" value="12">
707	<desc>
708	Machine is saving its execution state to a file, or an online
709	snapshot of the machine is being taken.
710	</desc>
711	</const>
712	<const name="Restoring" value="13">
713	<desc>
714	Execution state of the machine is being restored from a file
715	after powering it on from the saved execution state.
716	</desc>
717	</const>
718	<const name="TeleportingPausedVM" value="14">
719	<desc>
720	The machine is being teleported to another host or process, but it is
721	not running. This is the paused variant of the
722	<link to="MachineState::Teleporting"/> state.
723	</desc>
724	</const>
725	<const name="TeleportingIn" value="15">
726	<desc>
727	Teleporting the machine state in from another host or process.
728	</desc>
729	</const>
730	<const name="DeletingSnapshotOnline" value="16">
731	<desc>
732	Teleporting the machine state in from another host or process.
733	</desc>
734	</const>
735	<const name="DeletingSnapshotPaused" value="17">
736	<desc>
737	Teleporting the machine state in from another host or process.
738	</desc>
739	</const>
740	<const name="RestoringSnapshot" value="18">
741	<desc>
742	A machine snapshot is being restored; this typically does not take long.
743	</desc>
744	</const>
745	<const name="DeletingSnapshot" value="19">
746	<desc>
747	A machine snapshot is being deleted; this can take a long time since this
748	may require merging differencing media.
749	</desc>
750	</const>
751	<const name="SettingUp" value="20">
752	<desc>
753	Lengthy setup operation is in progress.
754	</desc>
755	</const>
756
757	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
758	<desc>
759	Pseudo-state: first online state (for use in relational expressions).
760	</desc>
761	</const>
762	<const name="LastOnline" value="17" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
763	<desc>
764	Pseudo-state: last online state (for use in relational expressions).
765	</desc>
766	</const>
767
768	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
769	<desc>
770	Pseudo-state: first transient state (for use in relational expressions).
771	</desc>
772	</const>
773	<const name="LastTransient" value="20" wsmap="suppress"> <!-- SettingUp -->
774	<desc>
775	Pseudo-state: last transient state (for use in relational expressions).
776	</desc>
777	</const>
778
779	</enum>
780
781	<enum
782	name="SessionState"
783	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
784	>
785	<desc>
786	Session state. This enumeration represents possible values of
787	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
788	attributes. See individual enumerator descriptions for the meaning for
789	every value.
790	</desc>
791
792	<const name="Null" value="0">
793	<desc>Null value (never used by the API).</desc>
794	</const>
795	<const name="Closed" value="1">
796	<desc>
797	The machine has no open sessions (<link to="IMachine::sessionState"/>);
798	the session is closed (<link to="ISession::state"/>)
799	</desc>
800	</const>
801	<const name="Open" value="2">
802	<desc>
803	The machine has an open direct session (<link to="IMachine::sessionState"/>);
804	the session is open (<link to="ISession::state"/>)
805	</desc>
806	</const>
807	<const name="Spawning" value="3">
808	<desc>
809	A new (direct) session is being opened for the machine as a result of
810	<link to="IVirtualBox::openRemoteSession"/> call
811	(<link to="IMachine::sessionState"/> or <link to="ISession::state"/>).
812	This state also occurs as a short transient state when a new direct
813	session is opened by calling <link to="IVirtualBox::openSession"/>.
814	</desc>
815	</const>
816	<const name="Closing" value="4">
817	<desc>
818	The direct session is being closed (<link to="IMachine::sessionState"/>);
819	the session is being closed (<link to="ISession::state"/>)
820	</desc>
821	</const>
822	</enum>
823
824	<enum
825	name="CPUPropertyType"
826	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
827	>
828	<desc>
829	Virtual CPU property type. This enumeration represents possible values of the
830	IMachine get- and setCPUProperty methods.
831	</desc>
832	<const name="Null" value="0">
833	<desc>Null value (never used by the API).</desc>
834	</const>
835	<const name="PAE" value="1">
836	<desc>
837	This setting determines whether VirtualBox will expose the Physical Address
838	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
839	is not available, it will not be reported.
840	</desc>
841	</const>
842	<const name="Synthetic" value="2">
843	<desc>
844	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
845	teleporting between host systems that differ significantly.
846	</desc>
847	</const>
848	</enum>
849
850
851	<enum
852	name="HWVirtExPropertyType"
853	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
854	>
855	<desc>
856	Hardware virtualization property type. This enumeration represents possible values
857	for the <link to="IMachine::getHWVirtExProperty"/> and
858	<link to="IMachine::setHWVirtExProperty"/> methods.
859	</desc>
860	<const name="Null" value="0">
861	<desc>Null value (never used by the API).</desc>
862	</const>
863	<const name="Enabled" value="1">
864	<desc>
865	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
866	such extensions are not available, they will not be used.
867	</desc>
868	</const>
869	<const name="Exclusive" value="2">
870	<desc>
871	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
872	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
873	feature of the host. To share these with other hypervisors, you must disable this property.
874	</desc>
875	</const>
876	<const name="VPID" value="3">
877	<desc>
878	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
879	</desc>
880	</const>
881	<const name="NestedPaging" value="4">
882	<desc>
883	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
884	</desc>
885	</const>
886	<const name="LargePages" value="5">
887	<desc>
888	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
889	</desc>
890	</const>
891	</enum>
892
893	<enum
894	name="SessionType"
895	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
896	>
897	<desc>
898	Session type. This enumeration represents possible values of the
899	<link to="ISession::type"/> attribute.
900	</desc>
901
902	<const name="Null" value="0">
903	<desc>Null value (never used by the API).</desc>
904	</const>
905	<const name="Direct" value="1">
906	<desc>
907	Direct session
908	(opened by <link to="IVirtualBox::openSession"/>)
909	</desc>
910	</const>
911	<const name="Remote" value="2">
912	<desc>
913	Remote session
914	(opened by <link to="IVirtualBox::openRemoteSession"/>)
915	</desc>
916	</const>
917	<const name="Existing" value="3">
918	<desc>
919	Existing session
920	(opened by <link to="IVirtualBox::openExistingSession"/>)
921	</desc>
922	</const>
923	</enum>
924
925	<enum
926	name="DeviceType"
927	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
928	>
929	<desc>
930	Device type.
931	</desc>
932	<const name="Null" value="0">
933	<desc>
934	Null value, may also mean "no device" (not allowed for
935	<link to="IConsole::getDeviceActivity"/>).
936	</desc>
937	</const>
938	<const name="Floppy" value="1">
939	<desc>Floppy device.</desc>
940	</const>
941	<const name="DVD" value="2">
942	<desc>CD/DVD-ROM device.</desc>
943	</const>
944	<const name="HardDisk" value="3">
945	<desc>Hard disk device.</desc>
946	</const>
947	<const name="Network" value="4">
948	<desc>Network device.</desc>
949	</const>
950	<const name="USB" value="5">
951	<desc>USB device.</desc>
952	</const>
953	<const name="SharedFolder" value="6">
954	<desc>Shared folder device.</desc>
955	</const>
956	</enum>
957
958	<enum
959	name="DeviceActivity"
960	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
961	>
962	<desc>
963	Device activity for <link to="IConsole::getDeviceActivity"/>.
964	</desc>
965
966	<const name="Null" value="0"/>
967	<const name="Idle" value="1"/>
968	<const name="Reading" value="2"/>
969	<const name="Writing" value="3"/>
970	</enum>
971
972	<enum
973	name="ClipboardMode"
974	uuid="33364716-4008-4701-8f14-be0fa3d62950"
975	>
976	<desc>
977	Host-Guest clipboard interchange mode.
978	</desc>
979
980	<const name="Disabled" value="0"/>
981	<const name="HostToGuest" value="1"/>
982	<const name="GuestToHost" value="2"/>
983	<const name="Bidirectional" value="3"/>
984	</enum>
985
986	<enum
987	name="Scope"
988	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
989	>
990	<desc>
991	Scope of the operation.
992
993	A generic enumeration used in various methods to define the action or
994	argument scope.
995	</desc>
996
997	<const name="Global" value="0"/>
998	<const name="Machine" value="1"/>
999	<const name="Session" value="2"/>
1000	</enum>
1001
1002	<enum
1003	name="BIOSBootMenuMode"
1004	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1005	>
1006	<desc>
1007	BIOS boot menu mode.
1008	</desc>
1009
1010	<const name="Disabled" value="0"/>
1011	<const name="MenuOnly" value="1"/>
1012	<const name="MessageAndMenu" value="2"/>
1013	</enum>
1014
1015	<enum
1016	name="ProcessorFeature"
1017	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1018	>
1019	<desc>
1020	CPU features.
1021	</desc>
1022
1023	<const name="HWVirtEx" value="0"/>
1024	<const name="PAE" value="1"/>
1025	<const name="LongMode" value="2"/>
1026	<const name="NestedPaging" value="3"/>
1027	</enum>
1028
1029	<enum
1030	name="FirmwareType"
1031	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1032	>
1033	<desc>
1034	Firmware type.
1035	</desc>
1036	<const name="BIOS" value="1">
1037	<desc>BIOS Firmware.</desc>
1038	</const>
1039	<const name="EFI" value="2">
1040	<desc>EFI Firmware, bitness detetced basing on OS type.</desc>
1041	</const>
1042	<const name="EFI32" value="3">
1043	<desc>Efi firmware, 32-bit.</desc>
1044	</const>
1045	<const name="EFI64" value="4">
1046	<desc>Efi firmware, 64-bit.</desc>
1047	</const>
1048	<const name="EFIDUAL" value="5">
1049	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1050	</const>
1051	</enum>
1052
1053	<enum
1054	name="PointingHidType"
1055	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1056	>
1057	<desc>
1058	Type of pointing device used in a virtual machine.
1059	</desc>
1060	<const name="None" value="1">
1061	<desc>No mouse.</desc>
1062	</const>
1063	<const name="PS2Mouse" value="2">
1064	<desc>PS/2 auxillary device, a.k.a. mouse.</desc>
1065	</const>
1066	<const name="USBMouse" value="3">
1067	<desc>USB mouse (relative pointer).</desc>
1068	</const>
1069	<const name="USBTablet" value="4">
1070	<desc>USB tablet (absolute pointer).</desc>
1071	</const>
1072	<const name="ComboMouse" value="5">
1073	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1074	Using of such device can have negative performance implications. </desc>
1075	</const>
1076	</enum>
1077
1078	<enum
1079	name="KeyboardHidType"
1080	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1081	>
1082	<desc>
1083	Type of keyboard device used in a virtual machine.
1084	</desc>
1085	<const name="None" value="1">
1086	<desc>No keyboard.</desc>
1087	</const>
1088	<const name="PS2Keyboard" value="2">
1089	<desc>PS/2 keyboard.</desc>
1090	</const>
1091	<const name="USBKeyboard" value="3">
1092	<desc>USB keyboard.</desc>
1093	</const>
1094	<const name="ComboKeyboard" value="4">
1095	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1096	Using of such device can have negative performance implications. </desc>
1097	</const>
1098	</enum>
1099
1100	<!--
1101	// IVirtualBoxErrorInfo
1102	/////////////////////////////////////////////////////////////////////////
1103	-->
1104
1105	<interface
1106	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1107	uuid="4b86d186-407e-4f9e-8be8-e50061be8725"
1108	supportsErrorInfo="no"
1109	wsmap="managed"
1110	>
1111	<desc>
1112	The IVirtualBoxErrorInfo interface represents extended error information.
1113
1114	Extended error information can be set by VirtualBox components after
1115	unsuccessful or partially successful method invocation. This information
1116	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1117	and then shown to the client in addition to the plain 32-bit result code.
1118
1119	In MS COM, this interface extends the IErrorInfo interface,
1120	in XPCOM, it extends the nsIException interface. In both cases,
1121	it provides a set of common attributes to retrieve error
1122	information.
1123
1124	Sometimes invocation of some component's method may involve methods of
1125	other components that may also fail (independently of this method's
1126	failure), or a series of non-fatal errors may precede a fatal error that
1127	causes method failure. In cases like that, it may be desirable to preserve
1128	information about all errors happened during method invocation and deliver
1129	it to the caller. The <link to="#next"/> attribute is intended
1130	specifically for this purpose and allows to represent a chain of errors
1131	through a single IVirtualBoxErrorInfo object set after method invocation.
1132
1133	Note that errors are stored to a chain in the reverse order, i.e. the
1134	initial error object you query right after method invocation is the last
1135	error set by the callee, the object it points to in the @a next attribute
1136	is the previous error and so on, up to the first error (which is the last
1137	in the chain).
1138	</desc>
1139
1140	<attribute name="resultCode" type="long" readonly="yes">
1141	<desc>
1142	Result code of the error.
1143	Usually, it will be the same as the result code returned
1144	by the method that provided this error information, but not
1145	always. For example, on Win32, CoCreateInstance() will most
1146	likely return E_NOINTERFACE upon unsuccessful component
1147	instantiation attempt, but not the value the component factory
1148	returned. Value is typed 'long', not 'result',
1149	to make interface usable from scripting languages.
1150	<note>
1151	In MS COM, there is no equivalent.
1152	In XPCOM, it is the same as nsIException::result.
1153	</note>
1154	</desc>
1155	</attribute>
1156
1157	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1158	<desc>
1159	UUID of the interface that defined the error.
1160	<note>
1161	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1162	data type.
1163	In XPCOM, there is no equivalent.
1164	</note>
1165	</desc>
1166	</attribute>
1167
1168	<attribute name="component" type="wstring" readonly="yes">
1169	<desc>
1170	Name of the component that generated the error.
1171	<note>
1172	In MS COM, it is the same as IErrorInfo::GetSource.
1173	In XPCOM, there is no equivalent.
1174	</note>
1175	</desc>
1176	</attribute>
1177
1178	<attribute name="text" type="wstring" readonly="yes">
1179	<desc>
1180	Text description of the error.
1181	<note>
1182	In MS COM, it is the same as IErrorInfo::GetDescription.
1183	In XPCOM, it is the same as nsIException::message.
1184	</note>
1185	</desc>
1186	</attribute>
1187
1188	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1189	<desc>
1190	Next error object if there is any, or @c null otherwise.
1191	<note>
1192	In MS COM, there is no equivalent.
1193	In XPCOM, it is the same as nsIException::inner.
1194	</note>
1195	</desc>
1196	</attribute>
1197
1198	</interface>
1199
1200	<!--
1201	// IVirtualBox
1202	/////////////////////////////////////////////////////////////////////////
1203	-->
1204
1205	<interface
1206	name="IDHCPServer" extends="$unknown"
1207	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1208	wsmap="managed"
1209	>
1210	<desc>
1211	The IDHCPServer interface represents the vbox dhcp server configuration.
1212
1213	To enumerate all the dhcp servers on the host, use the
1214	<link to="IVirtualBox::DHCPServers"/> attribute.
1215	</desc>
1216
1217	<attribute name="enabled" type="boolean">
1218	<desc>
1219	specifies if the dhcp server is enabled
1220	</desc>
1221	</attribute>
1222
1223	<attribute name="IPAddress" type="wstring" readonly="yes">
1224	<desc>
1225	specifies server IP
1226	</desc>
1227	</attribute>
1228
1229	<attribute name="networkMask" type="wstring" readonly="yes">
1230	<desc>
1231	specifies server network mask
1232	</desc>
1233	</attribute>
1234
1235	<attribute name="networkName" type="wstring" readonly="yes">
1236	<desc>
1237	specifies internal network name the server is used for
1238	</desc>
1239	</attribute>
1240
1241	<attribute name="lowerIP" type="wstring" readonly="yes">
1242	<desc>
1243	specifies from IP adrres in server address range
1244	</desc>
1245	</attribute>
1246
1247	<attribute name="upperIP" type="wstring" readonly="yes">
1248	<desc>
1249	specifies to IP adrres in server address range
1250	</desc>
1251	</attribute>
1252
1253	<method name="setConfiguration">
1254	<desc>
1255	configures the server
1256	<result name="E_INVALIDARG">
1257	invalid configuration supplied
1258	</result>
1259	</desc>
1260	<param name="IPAddress" type="wstring" dir="in">
1261	<desc>
1262	server IP address
1263	</desc>
1264	</param>
1265	<param name="networkMask" type="wstring" dir="in">
1266	<desc>
1267	server network mask
1268	</desc>
1269	</param>
1270	<param name="FromIPAddress" type="wstring" dir="in">
1271	<desc>
1272	server From IP address for address range
1273	</desc>
1274	</param>
1275	<param name="ToIPAddress" type="wstring" dir="in">
1276	<desc>
1277	server To IP address for address range
1278	</desc>
1279	</param>
1280	</method>
1281
1282	<method name="start">
1283	<desc>
1284	Starts DHCP server process.
1285	<result name="E_FAIL">
1286	Failed to start the process.
1287	</result>
1288	</desc>
1289	<param name="networkName" type="wstring" dir="in">
1290	<desc>
1291	Name of internal network DHCP server should attach to.
1292	</desc>
1293	</param>
1294	<param name="trunkName" type="wstring" dir="in">
1295	<desc>
1296	Name of internal network trunk.
1297	</desc>
1298	</param>
1299	<param name="trunkType" type="wstring" dir="in">
1300	<desc>
1301	Type of internal network trunk.
1302	</desc>
1303	</param>
1304	</method>
1305
1306	<method name="stop">
1307	<desc>
1308	Stops DHCP server process.
1309	<result name="E_FAIL">
1310	Failed to stop the process.
1311	</result>
1312	</desc>
1313	</method>
1314	</interface>
1315
1316	<interface
1317	name="IVirtualBox" extends="$unknown"
1318	uuid="f0c2e058-8c72-4d56-95e7-3107627aba6e"
1319	wsmap="managed"
1320	>
1321	<desc>
1322	The IVirtualBox interface represents the main interface exposed by the
1323	product that provides virtual machine management.
1324
1325	An instance of IVirtualBox is required for the product to do anything
1326	useful. Even though the interface does not expose this, internally,
1327	IVirtualBox is implemented as a singleton and actually lives in the
1328	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1329	IVirtualBox can track the state of all virtual machines on a particular
1330	host, regardless of which frontend started them.
1331
1332	To enumerate all the virtual machines on the host, use the
1333	<link to="IVirtualBox::machines"/> attribute.
1334	</desc>
1335
1336	<attribute name="version" type="wstring" readonly="yes">
1337	<desc>
1338	A string representing the version number of the product. The
1339	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1340	last number represents the build number and will frequently change.
1341	</desc>
1342	</attribute>
1343
1344	<attribute name="revision" type="unsigned long" readonly="yes">
1345	<desc>
1346	The internal build revision number of the product.
1347	</desc>
1348	</attribute>
1349
1350	<attribute name="packageType" type="wstring" readonly="yes">
1351	<desc>
1352	A string representing the package type of this product. The
1353	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1354	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1355	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1356	this.
1357	</desc>
1358	</attribute>
1359
1360	<attribute name="homeFolder" type="wstring" readonly="yes">
1361	<desc>
1362	Full path to the directory where the global settings file,
1363	<tt>VirtualBox.xml</tt>, is stored.
1364
1365	In this version of VirtualBox, the value of this property is
1366	always <tt><user_dir>/.VirtualBox</tt> (where
1367	<tt><user_dir></tt> is the path to the user directory,
1368	as determined by the host OS), and cannot be changed.
1369
1370	This path is also used as the base to resolve relative paths in
1371	places where relative paths are allowed (unless otherwise
1372	expressly indicated).
1373	</desc>
1374	</attribute>
1375
1376	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1377	<desc>
1378	Full name of the global settings file.
1379	The value of this property corresponds to the value of
1380	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1381	</desc>
1382	</attribute>
1383
1384	<attribute name="host" type="IHost" readonly="yes">
1385	<desc>Associated host object.</desc>
1386	</attribute>
1387
1388	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1389	<desc>Associated system information object.</desc>
1390	</attribute>
1391
1392	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1393	<desc>
1394	Array of machine objects registered within this VirtualBox instance.
1395	</desc>
1396	</attribute>
1397
1398	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1399	<desc>
1400	Array of medium objects known to this VirtualBox installation.
1401
1402	This array contains only base media. All differencing
1403	media of the given base medium can be enumerated using
1404	<link to="IMedium::children"/>.
1405	</desc>
1406	</attribute>
1407
1408	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1409	<desc>
1410	Array of CD/DVD image objects registered with this VirtualBox instance.
1411	</desc>
1412	</attribute>
1413
1414	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1415	<desc>
1416	Array of floppy image objects registered with this VirtualBox instance.
1417	</desc>
1418	</attribute>
1419
1420	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1421
1422	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1423
1424	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1425	<desc>
1426	Collection of global shared folders. Global shared folders are
1427	available to all virtual machines.
1428
1429	New shared folders are added to the collection using
1430	<link to="#createSharedFolder"/>. Existing shared folders can be
1431	removed using <link to="#removeSharedFolder"/>.
1432
1433	<note>
1434	In the current version of the product, global shared folders are not
1435	implemented and therefore this collection is always empty.
1436	</note>
1437	</desc>
1438	</attribute>
1439
1440	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1441	<desc>
1442	Associated performance collector object.
1443	</desc>
1444	</attribute>
1445
1446	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1447	<desc>
1448	dhcp server settings.
1449	</desc>
1450	</attribute>
1451
1452	<attribute name="eventSource" type="IEventSource" readonly="yes">
1453	<desc>
1454	Event source for VirtualBox events.
1455	</desc>
1456	</attribute>
1457
1458
1459	<method name="createMachine">
1460	<desc>
1461	Creates a new virtual machine.
1462
1463	The new machine is created unregistered, with the initial configuration
1464	set according to the specified guest OS type. A typical sequence of
1465	actions to create a new virtual machine is as follows:
1466
1467	<ol>
1468	<li>
1469	Call this method to have a new machine created. The returned machine
1470	object will be "mutable" allowing to change any machine property.
1471	</li>
1472
1473	<li>
1474	Configure the machine using the appropriate attributes and methods.
1475	</li>
1476
1477	<li>
1478	Call <link to="IMachine::saveSettings" /> to write the settings
1479	to the machine's XML settings file. The configuration of the newly
1480	created machine will not be saved to disk until this method is
1481	called.
1482	</li>
1483
1484	<li>
1485	Call <link to="#registerMachine" /> to add the machine to the list
1486	of machines known to VirtualBox.
1487	</li>
1488	</ol>
1489
1490	You should specify valid name for the newly created machine when calling
1491	this method. See the <link to="IMachine::name"/> attribute description
1492	for more details about the machine name.
1493
1494	The specified guest OS type identifier must match an ID of one of known
1495	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1496	array.
1497
1498	Every machine has a <i>settings file</i> that is used to store
1499	the machine configuration. This file is stored in a directory called the
1500	<i>machine settings subfolder</i>. Both the settings subfolder and file
1501	will have a name that corresponds to the name of the virtual machine.
1502	You can specify where to create the machine setting subfolder using the
1503	@a baseFolder argument. The base folder can be absolute (full path) or
1504	relative to the <link to="IVirtualBox::homeFolder">VirtualBox home
1505	directory</link>.
1506
1507	If @a baseFolder is a @c null or empty string (which is recommended), the
1508	<link to="ISystemProperties::defaultMachineFolder">default machine
1509	settings folder</link> will be used as a base folder for the created
1510	machine. Otherwise the given base folder will be used. In either case,
1511	the full path to the resulting settings file has the following
1512	structure:
1513	<pre>
1514	<base_folder>/<machine_name>/<machine_name>.xml
1515	</pre>
1516
1517	Note that if the resulting settings file already exists, this method
1518	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1519
1520	Optionally, you may specify an UUID of to assign to the created machine.
1521	However, this is not recommended and you should normally pass an empty
1522	(@c null) UUID to this method so that a new UUID will be automatically
1523	generated for every created machine. You can use UUID
1524	00000000-0000-0000-0000-000000000000 as @c null value.
1525
1526	<note>
1527	There is no way to change the name of the settings file or
1528	subfolder of the created machine directly.
1529	</note>
1530
1531	<result name="VBOX_E_OBJECT_NOT_FOUND">
1532	@a osTypeId is invalid.
1533	</result>
1534	<result name="VBOX_E_FILE_ERROR">
1535	Resulting settings file name is invalid or the settings file already
1536	exists or could not be created due to an I/O error.
1537	</result>
1538	<result name="E_INVALIDARG">
1539	@a name is empty or @c null.
1540	</result>
1541	</desc>
1542
1543	<param name="name" type="wstring" dir="in">
1544	<desc>Machine name.</desc>
1545	</param>
1546	<param name="osTypeId" type="wstring" dir="in">
1547	<desc>Guest OS Type ID.</desc>
1548	</param>
1549	<param name="baseFolder" type="wstring" dir="in">
1550	<desc>Base machine folder (optional).</desc>
1551	</param>
1552	<param name="id" type="uuid" mod="string" dir="in">
1553	<desc>Machine UUID (optional).</desc>
1554	</param>
1555	<param name="override" type="boolean" dir="in">
1556	<desc>Create the VM even if there are conflicting files.</desc>
1557	</param>
1558	<param name="machine" type="IMachine" dir="return">
1559	<desc>Created machine object.</desc>
1560	</param>
1561	</method>
1562
1563	<method name="createLegacyMachine">
1564	<desc>
1565	Creates a new virtual machine in "legacy" mode, using the specified
1566	settings file to store machine settings.
1567
1568	As opposed to machines created by <link to="#createMachine"/>,
1569	the settings file of the machine created in "legacy" mode is not
1570	automatically renamed when the machine name is changed -- it will always
1571	remain the same as specified in this method call.
1572
1573	The specified settings file name can be absolute (full path) or relative
1574	to the <link to="IVirtualBox::homeFolder">VirtualBox home
1575	directory</link>. If the file name doesn't contain an extension, the
1576	default extension (.xml) will be appended.
1577
1578	Note that the configuration of the newly created machine is not
1579	saved to disk (and therefore no settings file is created)
1580	until <link to="IMachine::saveSettings"/> is called. If the
1581	specified settings file already exists, this method
1582	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1583
1584	See <link to="#createMachine"/> for more information.
1585
1586	@deprecated This method may be removed later. Use <link
1587	to="IVirtualBox::createMachine"/> instead.
1588
1589	<note>
1590	There is no way to change the name of the settings file
1591	of the machine created in "legacy" mode.
1592	</note>
1593
1594	<result name="VBOX_E_OBJECT_NOT_FOUND">
1595	@a osTypeId is invalid.
1596	</result>
1597	<result name="VBOX_E_FILE_ERROR">
1598	@a settingsFile is invalid or the settings file already exists or
1599	could not be created due to an I/O error.
1600	</result>
1601	<result name="E_INVALIDARG">
1602	@a name or @a settingsFile is empty or @c null.
1603	</result>
1604	</desc>
1605
1606	<param name="name" type="wstring" dir="in">
1607	<desc>Machine name.</desc>
1608	</param>
1609	<param name="osTypeId" type="wstring" dir="in">
1610	<desc>Machine OS Type ID.</desc>
1611	</param>
1612	<param name="settingsFile" type="wstring" dir="in">
1613	<desc>Name of the machine settings file.</desc>
1614	</param>
1615	<param name="id" type="uuid" mod="string" dir="in">
1616	<desc>Machine UUID (optional).</desc>
1617	</param>
1618	<param name="machine" type="IMachine" dir="return">
1619	<desc>Created machine object.</desc>
1620	</param>
1621	</method>
1622
1623	<method name="openMachine">
1624	<desc>
1625	Opens a virtual machine from the existing settings file.
1626	The opened machine remains unregistered until you call
1627	<link to="#registerMachine"/>.
1628
1629	The specified settings file name can be absolute
1630	(full path) or relative to the <link to="IVirtualBox::homeFolder">
1631	VirtualBox home directory</link>. This file must exist
1632	and must be a valid machine settings file whose contents
1633	will be used to construct the machine object.
1634
1635	@deprecated Will be removed soon.
1636	<result name="VBOX_E_FILE_ERROR">
1637	Settings file name invalid, not found or sharing violation.
1638	</result>
1639	</desc>
1640	<param name="settingsFile" type="wstring" dir="in">
1641	<desc>
1642	Name of the machine settings file.
1643	</desc>
1644	</param>
1645	<param name="machine" type="IMachine" dir="return">
1646	<desc>Opened machine object.</desc>
1647	</param>
1648	<note>
1649	<link to="IMachine::settingsModified"/> will return
1650	@c false for the created machine, until any of machine settings
1651	are changed.
1652	</note>
1653	</method>
1654
1655	<method name="registerMachine">
1656	<desc>
1657
1658	Registers the machine previously created using
1659	<link to="#createMachine"/> or opened using
1660	<link to="#openMachine"/> within this VirtualBox installation. After
1661	successful method invocation, the
1662	<link to="IMachineRegisteredEvent"/> event is fired.
1663
1664	<note>
1665	This method implicitly calls <link to="IMachine::saveSettings"/>
1666	to save all current machine settings before registering it.
1667	</note>
1668
1669	<result name="VBOX_E_OBJECT_NOT_FOUND">
1670	No matching virtual machine found.
1671	</result>
1672	<result name="VBOX_E_INVALID_OBJECT_STATE">
1673	Virtual machine was not created within this VirtualBox instance.
1674	</result>
1675
1676	</desc>
1677	<param name="machine" type="IMachine" dir="in"/>
1678	</method>
1679
1680	<method name="getMachine">
1681	<desc>
1682	Attempts to find a virtual machine given its UUID.
1683	To look up a machine by name, use <link to="IVirtualBox::findMachine" />
1684	instead.
1685
1686	<result name="VBOX_E_OBJECT_NOT_FOUND">
1687	Could not find registered machine matching @a id.
1688	</result>
1689
1690	</desc>
1691	<param name="id" type="uuid" mod="string" dir="in"/>
1692	<param name="machine" type="IMachine" dir="return"/>
1693	</method>
1694
1695	<method name="findMachine">
1696	<desc>
1697	Attempts to find a virtual machine given its name.
1698	To look up a machine by UUID, use <link to="IVirtualBox::getMachine" />
1699	instead.
1700
1701	<result name="VBOX_E_OBJECT_NOT_FOUND">
1702	Could not find registered machine matching @a name.
1703	</result>
1704
1705	</desc>
1706	<param name="name" type="wstring" dir="in"/>
1707	<param name="machine" type="IMachine" dir="return"/>
1708	</method>
1709
1710	<method name="unregisterMachine">
1711	<desc>
1712
1713	Unregisters the machine previously registered using
1714	<link to="#registerMachine"/>. After successful method invocation, the
1715	<link to="IMachineRegisteredEvent"/> event is fired.
1716
1717	<note>
1718	The specified machine must not be in the Saved state, have an open
1719	(or a spawning) direct session associated with it, have snapshots or
1720	have any medium attached.
1721	</note>
1722
1723	<note>
1724	This method implicitly calls <link to="IMachine::saveSettings"/> to
1725	save all current machine settings before unregistering it.
1726	</note>
1727
1728	<note>
1729	If the given machine is inaccessible (see
1730	<link to="IMachine::accessible"/>), it will be unregistered and
1731	fully uninitialized right afterwards. As a result, the returned
1732	machine object will be unusable and an attempt to call
1733	<b>any</b> method will return the "Object not ready" error.
1734	</note>
1735
1736	<result name="VBOX_E_OBJECT_NOT_FOUND">
1737	Could not find registered machine matching @a id.
1738	</result>
1739	<result name="VBOX_E_INVALID_VM_STATE">
1740	Machine is in Saved state.
1741	</result>
1742	<result name="VBOX_E_INVALID_OBJECT_STATE">
1743	Machine has snapshot or open session or medium attached.
1744	</result>
1745
1746	</desc>
1747	<param name="id" type="uuid" mod="string" dir="in">
1748	<desc>UUID of the machine to unregister.</desc>
1749	</param>
1750	<param name="machine" type="IMachine" dir="return">
1751	<desc>Unregistered machine object.</desc>
1752	</param>
1753	</method>
1754
1755	<method name="createAppliance">
1756	<desc>
1757	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1758	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1759	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1760	</desc>
1761	<param name="appliance" type="IAppliance" dir="return">
1762	<desc>New appliance.</desc>
1763	</param>
1764	</method>
1765
1766	<method name="createHardDisk">
1767	<desc>
1768	Creates a new base medium object that will use the given storage
1769	format and location for medium data.
1770
1771	Note that the actual storage unit is not created by this method. In
1772	order to do it, and before you are able to attach the created medium
1773	to virtual machines, you must call one of the following methods to
1774	allocate a format-specific storage unit at the specified location:
1775	<ul>
1776	<li><link to="IMedium::createBaseStorage"/></li>
1777	<li><link to="IMedium::createDiffStorage"/></li>
1778	</ul>
1779
1780	Some medium attributes, such as <link to="IMedium::id"/>, may
1781	remain uninitialized until the medium storage unit is successfully
1782	created by one of the above methods.
1783
1784	After the storage unit is successfully created, the medium gets
1785	remembered by this VirtualBox installation and will be accessible
1786	through <link to="#getHardDisk"/> and <link to="#findHardDisk"/>
1787	methods. Remembered base medium are also returned as part of
1788	the <link to="#hardDisks"/> array. See IMedium for more details.
1789
1790	The list of all storage formats supported by this VirtualBox
1791	installation can be obtained using
1792	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1793	attribute is empty or @c null then the default storage format
1794	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1795	be used for creating a storage unit of the medium.
1796
1797	Note that the format of the location string is storage format specific.
1798	See <link to="IMedium::location"/>, IMedium and
1799	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
1800
1801	<result name="VBOX_E_OBJECT_NOT_FOUND">
1802	@a format identifier is invalid. See
1803	<link to="ISystemProperties::mediumFormats"/>.
1804	</result>
1805	<result name="VBOX_E_FILE_ERROR">
1806	@a location is a not valid file name (for file-based formats only).
1807	</result>
1808	</desc>
1809	<param name="format" type="wstring" dir="in">
1810	<desc>
1811	Identifier of the storage format to use for the new medium.
1812	</desc>
1813	</param>
1814	<param name="location" type="wstring" dir="in">
1815	<desc>
1816	Location of the storage unit for the new medium.
1817	</desc>
1818	</param>
1819	<param name="medium" type="IMedium" dir="return">
1820	<desc>Created medium object.</desc>
1821	</param>
1822	</method>
1823
1824	<method name="openHardDisk">
1825	<desc>
1826	Opens a medium from an existing location, optionally replacing
1827	the image UUID and/or parent UUID.
1828
1829	After the medium is successfully opened by this method, it gets
1830	remembered by (known to) this VirtualBox installation and will be
1831	accessible through <link to="#getHardDisk"/> and
1832	<link to="#findHardDisk"/> methods. Remembered base media
1833	are also returned as part of the <link to="#hardDisks"/> array and can
1834	be attached to virtual machines. See IMedium for more details.
1835
1836	If a differencing medium is to be opened by this method, the
1837	operation will succeed only if its parent medium and all ancestors,
1838	if any, are already known to this VirtualBox installation (for example,
1839	were opened by this method before).
1840
1841	This method tries to guess the storage format of the specified medium
1842	by reading medium data at the specified location.
1843
1844	If @a accessMode is ReadWrite (which it should be), the image is opened
1845	for read/write access and must have according permissions, as VirtualBox
1846	may actually write status information into the disk's metadata sections.
1847
1848	Note that write access is required for all typical image usage in VirtualBox,
1849	since VirtualBox may need to write metadata such as a UUID into the image.
1850	The only exception is opening a source image temporarily for copying and
1851	cloning when the image will quickly be closed again.
1852
1853	Note that the format of the location string is storage format specific.
1854	See <link to="IMedium::location"/>, IMedium and
1855	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
1856
1857	<result name="VBOX_E_FILE_ERROR">
1858	Invalid medium storage file location or could not find the medium
1859	at the specified location.
1860	</result>
1861	<result name="VBOX_E_IPRT_ERROR">
1862	Could not get medium storage format.
1863	</result>
1864	<result name="E_INVALIDARG">
1865	Invalid medium storage format.
1866	</result>
1867
1868	</desc>
1869	<param name="location" type="wstring" dir="in">
1870	<desc>
1871	Location of the storage unit that contains medium data in one of
1872	the supported storage formats.
1873	</desc>
1874	</param>
1875	<param name="accessMode" type="AccessMode" dir="in">
1876	<desc>
1877	Determines whether to open the image in read/write or read-only mode.
1878	</desc>
1879	</param>
1880	<param name="setImageId" type="boolean" dir="in">
1881	<desc>
1882	Select whether a new image UUID is set or not.
1883	</desc>
1884	</param>
1885	<param name="imageId" type="uuid" mod="string" dir="in">
1886	<desc>
1887	New UUID for the image. If an empty string is passed, then a new
1888	UUID is automatically created. Specifying a zero UUIDs is not valid.
1889	</desc>
1890	</param>
1891	<param name="setParentId" type="boolean" dir="in">
1892	<desc>
1893	Select whether a new parent UUID is set or not.
1894	</desc>
1895	</param>
1896	<param name="parentId" type="uuid" mod="string" dir="in">
1897	<desc>
1898	New parent UUID for the image. If an empty string is passed, then a
1899	new UUID is automatically created, provided @a setParentId is
1900	@c true. A zero UUID is valid.
1901	</desc>
1902	</param>
1903	<param name="medium" type="IMedium" dir="return">
1904	<desc>Opened medium object.</desc>
1905	</param>
1906	</method>
1907
1908	<method name="getHardDisk" const="yes">
1909	<desc>
1910	Returns a medium with the given UUID.
1911
1912	The medium with the given UUID must be known to this VirtualBox
1913	installation, i.e. it must be previously created by
1914	<link to="#createHardDisk"/> or opened by <link
1915	to="#openHardDisk"/>, or attached to some known virtual machine.
1916
1917	<result name="VBOX_E_OBJECT_NOT_FOUND">
1918	No medium object matching @a id found.
1919	</result>
1920
1921	</desc>
1922	<param name="id" type="uuid" mod="string" dir="in">
1923	<desc>UUID of the medium to look for.</desc>
1924	</param>
1925	<param name="medium" type="IMedium" dir="return">
1926	<desc>Found medium object.</desc>
1927	</param>
1928	</method>
1929
1930	<method name="findHardDisk">
1931	<desc>
1932	Returns a medium that uses the given location to store medium data.
1933
1934	The given medium must be known to this VirtualBox installation, i.e.
1935	it must be previously created by
1936	<link to="#createHardDisk"/> or opened by <link
1937	to="#openHardDisk"/>, or attached to some known virtual machine.
1938
1939	The search is done by comparing the value of the @a location argument to
1940	the <link to="IMedium::location"/> attribute of each known medium.
1941
1942	For locations represented by file names in the host's file system, the
1943	requested location can be a path relative to the
1944	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
1945	only a file name without any path is given, the
1946	<link to="ISystemProperties::defaultHardDiskFolder"> default medium
1947	folder</link> will be prepended to the file name before searching. Note
1948	that on case sensitive file systems, a case sensitive comparison is
1949	performed, otherwise the case of symbols in the file path is ignored.
1950
1951	<result name="VBOX_E_OBJECT_NOT_FOUND">
1952	No medium object matching @a location found.
1953	</result>
1954
1955	</desc>
1956	<param name="location" type="wstring" dir="in">
1957	<desc>Location string to search for.</desc>
1958	</param>
1959	<param name="medium" type="IMedium" dir="return">
1960	<desc>Found medium object.</desc>
1961	</param>
1962	</method>
1963
1964	<method name="openDVDImage">
1965	<desc>
1966	Opens a CD/DVD image contained in the specified file of the supported
1967	format and assigns it the given UUID.
1968
1969	After the image is successfully opened by this method, it gets
1970	remembered by (known to) this VirtualBox installation and will be
1971	accessible through <link to="#getDVDImage"/> and
1972	<link to="#findDVDImage"/> methods. Remembered images are also
1973	returned as part of the <link to="#DVDImages"/> array and can be mounted
1974	to virtual machines. See IMedium for more details.
1975
1976	See <link to="IMedium::location"/> to get more details about the format
1977	of the location string.
1978
1979	<note>
1980	Currently only ISO 9960 CD/DVD images are supported by VirtualBox.
1981	</note>
1982
1983	<result name="VBOX_E_FILE_ERROR">
1984	Invalid CD/DVD image file location or could not find the CD/DVD
1985	image at the specified location.
1986	</result>
1987	<result name="VBOX_E_INVALID_OBJECT_STATE">
1988	CD/DVD image already exists in the media registry.
1989	</result>
1990
1991	</desc>
1992	<param name="location" type="wstring" dir="in">
1993	<desc>
1994	Full path to the file that contains a valid CD/DVD image.
1995	</desc>
1996	</param>
1997	<param name="id" type="uuid" mod="string" dir="in">
1998	<desc>
1999	UUID to assign to the given image within this VirtualBox installation.
2000	If an empty (@c null) UUID is specified, the system will randomly
2001	generate a new UUID.
2002	</desc>
2003	</param>
2004	<param name="image" type="IMedium" dir="return">
2005	<desc>Opened CD/DVD image object.</desc>
2006	</param>
2007	</method>
2008
2009	<method name="getDVDImage">
2010	<desc>
2011	Returns a CD/DVD image with the given UUID.
2012
2013	The image with the given UUID must be known to this VirtualBox
2014	installation, i.e. it must be previously opened by <link
2015	to="#openDVDImage"/>, or mounted to some known virtual machine.
2016
2017	<result name="VBOX_E_OBJECT_NOT_FOUND">
2018	No matching DVD image found in the media registry.
2019	</result>
2020
2021	</desc>
2022	<param name="id" type="uuid" mod="string" dir="in">
2023	<desc>UUID of the image to look for.</desc>
2024	</param>
2025	<param name="image" type="IMedium" dir="return">
2026	<desc>Found CD/DVD image object.</desc>
2027	</param>
2028	</method>
2029
2030	<method name="findDVDImage">
2031	<desc>
2032	Returns a CD/DVD image with the given image location.
2033
2034	The image with the given UUID must be known to this VirtualBox
2035	installation, i.e. it must be previously opened by <link
2036	to="#openDVDImage"/>, or mounted to some known virtual machine.
2037
2038	The search is done by comparing the value of the @a location argument to
2039	the <link to="IMedium::location"/> attribute of each known CD/DVD image.
2040
2041	The requested location can be a path relative to the
2042	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2043	only a file name without any path is given, the
2044	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2045	folder</link> will be prepended to the file name before searching. Note
2046	that on case sensitive file systems, a case sensitive comparison is
2047	performed, otherwise the case in the file path is ignored.
2048
2049	<result name="VBOX_E_FILE_ERROR">
2050	Invalid image file location.
2051	</result>
2052	<result name="VBOX_E_OBJECT_NOT_FOUND">
2053	No matching DVD image found in the media registry.
2054	</result>
2055
2056	</desc>
2057	<param name="location" type="wstring" dir="in">
2058	<desc>CD/DVD image file path to look for.</desc>
2059	</param>
2060	<param name="image" type="IMedium" dir="return">
2061	<desc>Found CD/DVD image object.</desc>
2062	</param>
2063	</method>
2064
2065	<method name="openFloppyImage">
2066	<desc>
2067	Opens a floppy image contained in the specified file of the supported
2068	format and assigns it the given UUID.
2069
2070	After the image is successfully opened by this method, it gets
2071	remembered by (known to) this VirtualBox installation and will be
2072	accessible through <link to="#getFloppyImage"/> and
2073	<link to="#findFloppyImage"/> methods. Remembered images are also
2074	returned as part of the <link to="#floppyImages"/> array and can be
2075	mounted to virtual machines. See IMedium for more details.
2076
2077	See <link to="IMedium::location"/> to get more details about the format
2078	of the location string.
2079
2080	<result name="VBOX_E_FILE_ERROR">
2081	Invalid floppy image file location or could not find the floppy
2082	image at the specified location.
2083	</result>
2084	<result name="VBOX_E_INVALID_OBJECT_STATE">
2085	Floppy image already exists in the media registry.
2086	</result>
2087
2088	<note>
2089	Currently, only raw floppy images are supported by VirtualBox.
2090	</note>
2091	</desc>
2092	<param name="location" type="wstring" dir="in">
2093	<desc>
2094	Full path to the file that contains a valid floppy image.
2095	</desc>
2096	</param>
2097	<param name="id" type="uuid" mod="string" dir="in">
2098	<desc>
2099	UUID to assign to the given image file within this VirtualBox
2100	installation. If an empty (@c null) UUID is specified, the system will
2101	randomly generate a new UUID.
2102	</desc>
2103	</param>
2104	<param name="image" type="IMedium" dir="return">
2105	<desc>Opened floppy image object.</desc>
2106	</param>
2107	</method>
2108
2109	<method name="getFloppyImage">
2110	<desc>
2111	Returns a floppy image with the given UUID.
2112
2113	The image with the given UUID must be known to this VirtualBox
2114	installation, i.e. it must be previously opened by <link
2115	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2116
2117	<result name="VBOX_E_OBJECT_NOT_FOUND">
2118	No matching floppy image found in the media registry.
2119	</result>
2120
2121	</desc>
2122	<param name="id" type="uuid" mod="string" dir="in">
2123	<desc>UUID of the image to look for.</desc>
2124	</param>
2125	<param name="image" type="IMedium" dir="return">
2126	<desc>Found floppy image object.</desc>
2127	</param>
2128	</method>
2129
2130	<method name="findFloppyImage">
2131	<desc>
2132	Returns a floppy image with the given image location.
2133
2134	The image with the given UUID must be known to this VirtualBox
2135	installation, i.e. it must be previously opened by <link
2136	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2137
2138	The search is done by comparing the value of the @a location argument to
2139	the <link to="IMedium::location"/> attribute of each known floppy image.
2140
2141	The requested location can be a path relative to the
2142	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2143	only a file name without any path is given, the
2144	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2145	folder</link> will be prepended to the file name before searching. Note
2146	that on case sensitive file systems, a case sensitive comparison is
2147	performed, otherwise the case of symbols in the file path is ignored.
2148
2149	<result name="VBOX_E_FILE_ERROR">
2150	Invalid image file location.
2151	</result>
2152	<result name="VBOX_E_OBJECT_NOT_FOUND">
2153	No matching floppy image found in the media registry.
2154	</result>
2155
2156	</desc>
2157	<param name="location" type="wstring" dir="in">
2158	<desc>Floppy image file path to look for.</desc>
2159	</param>
2160	<param name="image" type="IMedium" dir="return">
2161	<desc>Found floppy image object.</desc>
2162	</param>
2163	</method>
2164
2165	<method name="getGuestOSType">
2166	<desc>
2167	Returns an object describing the specified guest OS type.
2168
2169	The requested guest OS type is specified using a string which is a
2170	mnemonic identifier of the guest operating system, such as
2171	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2172	particular virtual machine can be read or set using the
2173	<link to="IMachine::OSTypeId"/> attribute.
2174
2175	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2176	available guest OS type objects. Each object has an
2177	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2178	the guest OS this object describes.
2179
2180	<result name="E_INVALIDARG">
2181	@a id is not a valid Guest OS type.
2182	</result>
2183
2184	</desc>
2185	<param name="id" type="uuid" mod="string" dir="in">
2186	<desc>Guest OS type ID string.</desc>
2187	</param>
2188	<param name="type" type="IGuestOSType" dir="return">
2189	<desc>Guest OS type object.</desc>
2190	</param>
2191	</method>
2192
2193	<method name="createSharedFolder">
2194	<desc>
2195	Creates a new global shared folder by associating the given logical
2196	name with the given host path, adds it to the collection of shared
2197	folders and starts sharing it. Refer to the description of
2198	<link to="ISharedFolder"/> to read more about logical names.
2199	<note>
2200	In the current implementation, this operation is not
2201	implemented.
2202	</note>
2203	</desc>
2204	<param name="name" type="wstring" dir="in">
2205	<desc>Unique logical name of the shared folder.</desc>
2206	</param>
2207	<param name="hostPath" type="wstring" dir="in">
2208	<desc>Full path to the shared folder in the host file system.</desc>
2209	</param>
2210	<param name="writable" type="boolean" dir="in">
2211	<desc>Whether the share is writable or readonly</desc>
2212	</param>
2213	</method>
2214
2215	<method name="removeSharedFolder">
2216	<desc>
2217	Removes the global shared folder with the given name previously
2218	created by <link to="#createSharedFolder"/> from the collection of
2219	shared folders and stops sharing it.
2220	<note>
2221	In the current implementation, this operation is not
2222	implemented.
2223	</note>
2224	</desc>
2225	<param name="name" type="wstring" dir="in">
2226	<desc>Logical name of the shared folder to remove.</desc>
2227	</param>
2228	</method>
2229
2230	<method name="getExtraDataKeys">
2231	<desc>
2232	Returns an array representing the global extra data keys which currently
2233	have values defined.
2234	</desc>
2235	<param name="value" type="wstring" dir="return" safearray="yes">
2236	<desc>Array of extra data keys.</desc>
2237	</param>
2238	</method>
2239
2240	<method name="getExtraData">
2241	<desc>
2242	Returns associated global extra data.
2243
2244	If the requested data @a key does not exist, this function will
2245	succeed and return an empty string in the @a value argument.
2246
2247	<result name="VBOX_E_FILE_ERROR">
2248	Settings file not accessible.
2249	</result>
2250	<result name="VBOX_E_XML_ERROR">
2251	Could not parse the settings file.
2252	</result>
2253
2254	</desc>
2255	<param name="key" type="wstring" dir="in">
2256	<desc>Name of the data key to get.</desc>
2257	</param>
2258	<param name="value" type="wstring" dir="return">
2259	<desc>Value of the requested data key.</desc>
2260	</param>
2261	</method>
2262
2263	<method name="setExtraData">
2264	<desc>
2265	Sets associated global extra data.
2266
2267	If you pass @c null or empty string as a key @a value, the given @a key
2268	will be deleted.
2269
2270	<note>
2271	Before performing the actual data change, this method will ask all
2272	registered event listener using the
2273	<link to="IExtraDataCanChangeEvent"/>
2274	notification for a permission. If one of the listeners refuses the
2275	new value, the change will not be performed.
2276	</note>
2277	<note>
2278	On success, the
2279	<link to="IExtraDataChanged"/> notification
2280	is called to inform all registered listeners about a successful data
2281	change.
2282	</note>
2283
2284	<result name="VBOX_E_FILE_ERROR">
2285	Settings file not accessible.
2286	</result>
2287	<result name="VBOX_E_XML_ERROR">
2288	Could not parse the settings file.
2289	</result>
2290	<result name="E_ACCESSDENIED">
2291	Modification request refused.
2292	</result>
2293
2294	</desc>
2295	<param name="key" type="wstring" dir="in">
2296	<desc>Name of the data key to set.</desc>
2297	</param>
2298	<param name="value" type="wstring" dir="in">
2299	<desc>Value to assign to the key.</desc>
2300	</param>
2301	</method>
2302
2303	<method name="openSession">
2304	<desc>
2305	Opens a new direct session with the given virtual machine.
2306
2307	A direct session acts as a local lock on the given VM.
2308	There can be only one direct session open at a time for every
2309	virtual machine, protecting the VM from being manipulated by
2310	conflicting actions from different processes. Only after a
2311	direct session has been opened, one can change all VM settings
2312	and execute the VM in the process space of the session object.
2313
2314	Sessions therefore can be compared to mutex semaphores that
2315	lock a given VM for modification and execution.
2316	See <link to="ISession">ISession</link> for details.
2317
2318	<note>Unless you are writing a new VM frontend, you will not
2319	want to execute a VM in the current process. To spawn a new
2320	process that executes a VM, use
2321	<link to="IVirtualBox::openRemoteSession" />
2322	instead.</note>
2323
2324	Upon successful return, the session object can be used to
2325	get access to the machine and to the VM console.
2326
2327	In VirtualBox terminology, the machine becomes "mutable" after
2328	a session has been opened. Note that the "mutable" machine
2329	object, on which you may invoke IMachine methods to change its
2330	settings, will be a different object from the immutable IMachine
2331	objects returned by various IVirtualBox methods. To obtain a
2332	mutable IMachine object (upon which you can invoke settings methods),
2333	use the <link to="ISession::machine" /> attribute.
2334
2335	One must always call <link to="ISession::close" /> to release the
2336	lock on the machine, or the machine's state will eventually be
2337	set to "Aborted".
2338
2339	In other words, to change settings on a machine, the following
2340	sequence is typically performed:
2341
2342	<ol>
2343	<li>Call this method (openSession) to have a machine locked for
2344	the current session.</li>
2345
2346	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
2347
2348	<li>Change the settings of the machine.</li>
2349
2350	<li>Call <link to="IMachine::saveSettings" />.</li>
2351
2352	<li>Close the session by calling <link to="ISession::close"/>.</li>
2353	</ol>
2354
2355	<result name="E_UNEXPECTED">
2356	Virtual machine not registered.
2357	</result>
2358	<result name="E_ACCESSDENIED">
2359	Process not started by OpenRemoteSession.
2360	</result>
2361	<result name="VBOX_E_OBJECT_NOT_FOUND">
2362	No matching virtual machine found.
2363	</result>
2364	<result name="VBOX_E_INVALID_OBJECT_STATE">
2365	Session already open or being opened.
2366	</result>
2367	<result name="VBOX_E_VM_ERROR">
2368	Failed to assign machine to session.
2369	</result>
2370
2371	</desc>
2372	<param name="session" type="ISession" dir="in">
2373	<desc>
2374	Session object that will represent the opened session after
2375	successful method invocation. This object must not represent
2376	the already open session.
2377	<note>
2378	This session will be automatically closed if the
2379	VirtualBox server is terminated for some reason.
2380	</note>
2381	</desc>
2382	</param>
2383	<param name="machineId" type="uuid" mod="string" dir="in">
2384	<desc>ID of the virtual machine to open a session with.</desc>
2385	</param>
2386	</method>
2387
2388	<method name="openRemoteSession">
2389	<desc>
2390	Spawns a new process that executes a virtual machine (called a
2391	"remote session").
2392
2393	Opening a remote session causes the VirtualBox server to start a new
2394	process that opens a direct session with the given VM. As a result, the
2395	VM is locked by that direct session in the new process, preventing
2396	conflicting changes from other processes. Since sessions act as locks
2397	that prevent conflicting changes, one cannot open a remote session
2398	for a VM that already has another open session (direct or remote), or
2399	is currently in the process of opening one (see <link
2400	to="IMachine::sessionState"/>).
2401
2402	While the remote session still provides some level of control over the
2403	VM execution to the caller (using the <link to="IConsole" /> interface),
2404	not all VM settings are available for modification within the remote
2405	session context.
2406
2407	This operation can take some time (a new VM is started in a new process,
2408	for which memory and other resources need to be set up). Because of this,
2409	an <link to="IProgress" /> is returned to allow the caller to wait for this
2410	asynchronous operation to be completed. Until then, the remote session
2411	object remains in the closed state, and accessing the machine or its
2412	console through it is invalid. It is recommended to use
2413	<link to="IProgress::waitForCompletion" /> or similar calls to wait for
2414	completion. Completion is signalled when the VM is powered on. Error
2415	messages etc. can be queried via the progress object, if available.
2416
2417	As with all <link to="ISession" /> objects, it is recommended to call
2418	<link to="ISession::close" /> on the local session object once openRemoteSession()
2419	has been called. However, the session's state (see <link to="ISession::state" />)
2420	will not return to "Closed" until the remote session has also closed (i.e.
2421	until the VM is no longer running). In that case, however, the state of
2422	the session will automatically change back to "Closed".
2423
2424	Currently supported session types (values of the @a type
2425	argument) are:
2426	<ul>
2427	<li><tt>"gui"</tt>: VirtualBox Qt GUI session</li>
2428	<li><tt>"vrdp"</tt>: VirtualBox VRDP Server session</li>
2429	<li><tt>"sdl"</tt>: VirtualBox SDL GUI session</li>
2430	</ul>
2431
2432	The @a environment argument is a string containing definitions of
2433	environment variables in the following format:
2434	@code
2435	NAME[=VALUE]\n
2436	NAME[=VALUE]\n
2437	...
2438	@endcode
2439	where <tt>\\n</tt> is the new line character. These environment
2440	variables will be appended to the environment of the VirtualBox server
2441	process. If an environment variable exists both in the server process
2442	and in this list, the value from this list takes precedence over the
2443	server's variable. If the value of the environment variable is
2444	omitted, this variable will be removed from the resulting environment.
2445	If the environment string is @c null or empty, the server environment
2446	is inherited by the started process as is.
2447
2448	The progress object will have at least 2 operation. The first operation
2449	covers the period up to the new VM process calls powerUp. The
2450	subsequent operations mirrors the <link to="IConsole::powerUp"/>
2451	progress object. Because <link to="IConsole::powerUp"/> may require
2452	some extra operation, the <link to="IProgress::operationCount"/> may
2453	change at the completion of operation1.
2454
2455	For details on the teleportation progress operation, see
2456	<link to="IConsole::powerUp"/>.
2457
2458	<see>openExistingSession</see>
2459
2460	<result name="E_UNEXPECTED">
2461	Virtual machine not registered.
2462	</result>
2463	<result name="E_INVALIDARG">
2464	Invalid session type @a type.
2465	</result>
2466	<result name="VBOX_E_OBJECT_NOT_FOUND">
2467	No machine matching @a machineId found.
2468	</result>
2469	<result name="VBOX_E_INVALID_OBJECT_STATE">
2470	Session already open or being opened.
2471	</result>
2472	<result name="VBOX_E_IPRT_ERROR">
2473	Launching process for machine failed.
2474	</result>
2475	<result name="VBOX_E_VM_ERROR">
2476	Failed to assign machine to session.
2477	</result>
2478
2479	</desc>
2480	<param name="session" type="ISession" dir="in">
2481	<desc>
2482	Session object that will represent the opened remote session
2483	after successful method invocation (this object must not
2484	represent an already open session).
2485	</desc>
2486	</param>
2487	<param name="machineId" type="uuid" mod="string" dir="in">
2488	<desc>ID of the virtual machine to open a session with.</desc>
2489	</param>
2490	<param name="type" type="wstring" dir="in">
2491	<desc>
2492	Type of the remote session (case sensitive).
2493	</desc>
2494	</param>
2495	<param name="environment" type="wstring" dir="in">
2496	<desc>
2497	Environment to pass to the opened session.
2498	</desc>
2499	</param>
2500	<param name="progress" type="IProgress" dir="return">
2501	<desc>Progress object to track the operation completion.</desc>
2502	</param>
2503	</method>
2504
2505	<method name="openExistingSession">
2506	<desc>
2507	Opens a new remote session with the virtual machine for
2508	which a direct session is already open.
2509
2510	The remote session provides some level of control over the VM
2511	execution (using the IConsole interface) to the caller; however,
2512	within the remote session context, not all VM settings are available
2513	for modification.
2514
2515	As opposed to <link to="#openRemoteSession"/>, the number of
2516	remote sessions opened this way is not limited by the API
2517
2518	<note>
2519	It is an error to open a remote session with the machine that
2520	doesn't have an open direct session.
2521	</note>
2522
2523	<result name="E_UNEXPECTED">
2524	Virtual machine not registered.
2525	</result>
2526	<result name="VBOX_E_OBJECT_NOT_FOUND">
2527	No machine matching @a machineId found.
2528	</result>
2529	<result name="VBOX_E_INVALID_OBJECT_STATE">
2530	Session already open or being opened.
2531	</result>
2532	<result name="VBOX_E_INVALID_SESSION_STATE">
2533	Direct session state not Open.
2534	</result>
2535	<result name="VBOX_E_VM_ERROR">
2536	Failed to get console object from direct session or assign
2537	machine to session.
2538	</result>
2539
2540	<see>openRemoteSession</see>
2541	</desc>
2542	<param name="session" type="ISession" dir="in">
2543	<desc>
2544	Session object that will represent the open remote session
2545	after successful method invocation. This object must not
2546	represent an already open session.
2547	<note>
2548	This session will be automatically closed when the peer
2549	(direct) session dies or gets closed.
2550	</note>
2551	</desc>
2552	</param>
2553	<param name="machineId" type="uuid" mod="string" dir="in">
2554	<desc>ID of the virtual machine to open a session with.</desc>
2555	</param>
2556	</method>
2557
2558	<method name="waitForPropertyChange">
2559	<desc>
2560	Blocks the caller until any of the properties represented by the
2561	@a what argument changes the value or until the given timeout interval
2562	expires.
2563
2564	The @a what argument is a comma separated list of property masks that
2565	describe properties the caller is interested in. The property mask is
2566	a string in the following format:
2567
2568	<pre>
2569	[[group.]subgroup.]name
2570	</pre>
2571
2572	where @c name is the property name and @c group, @c subgroup are zero
2573	or more property group specifiers. Each element (group or name) in
2574	the property mask may be either a Latin string or an asterisk symbol
2575	(@c "*") which is used to match any string for the given element. A
2576	property mask that doesn't contain asterisk symbols represents a
2577	single fully qualified property name.
2578
2579	Groups in the fully qualified property name go from more generic (the
2580	left-most part) to more specific (the right-most part). The first
2581	element is usually a name of the object the property belongs to. The
2582	second element may be either a property name, or a child object name,
2583	or an index if the preceding element names an object which is one of
2584	many objects of the same type. This way, property names form a
2585	hierarchy of properties. Here are some examples of property names:
2586
2587	<table>
2588	<tr>
2589	<td><tt>VirtualBox.version</tt></td>
2590	<td><link to="IVirtualBox::version"/> property</td>
2591	</tr>
2592	<tr>
2593	<td><tt>Machine.<UUID>.name</tt></td>
2594	<td><link to="IMachine::name"/> property of the machine with the
2595	given UUID</td>
2596	</tr>
2597	</table>
2598
2599	Most property names directly correspond to the properties of objects
2600	(components) provided by the VirtualBox library and may be used to
2601	track changes to these properties. However, there may be
2602	pseudo-property names that don't correspond to any existing object's
2603	property directly, as well as there may be object properties that
2604	don't have a corresponding property name that is understood by this
2605	method, and therefore changes to such properties cannot be
2606	tracked. See individual object's property descriptions to get a
2607	fully qualified property name that can be used with this method (if
2608	any).
2609
2610	There is a special property mask @c "*" (i.e. a string consisting of a
2611	single asterisk symbol) that can be used to match all properties.
2612	Below are more examples of property masks:
2613
2614	<table>
2615	<tr>
2616	<td><tt>VirtualBox.*</tt></td>
2617	<td>Track all properties of the VirtualBox object</td>
2618	</tr>
2619	<tr>
2620	<td><tt>Machine.*.name</tt></td>
2621	<td>Track changes to the <link to="IMachine::name"/> property of
2622	all registered virtual machines</td>
2623	</tr>
2624	</table>
2625
2626	<note>
2627	This function is not implemented in the current version of the
2628	product.
2629	</note>
2630	</desc>
2631	<param name="what" type="wstring" dir="in">
2632	<desc>Comma separated list of property masks.</desc>
2633	</param>
2634	<param name="timeout" type="unsigned long" dir="in">
2635	<desc>
2636	Wait timeout in milliseconds.
2637	Specify -1 for an indefinite wait.
2638	</desc>
2639	</param>
2640	<param name="changed" type="wstring" dir="out">
2641	<desc>
2642	Comma separated list of properties that have been changed and caused
2643	this method to return to the caller.
2644	</desc>
2645	</param>
2646	<param name="values" type="wstring" dir="out">
2647	<desc>Reserved, not currently used.</desc>
2648	</param>
2649	</method>
2650
2651	<!--method name="createDHCPServerForInterface">
2652	<desc>
2653	Creates a dhcp server settings to be used for the given interface
2654	<result name="E_INVALIDARG">
2655	Host network interface @a name already exists.
2656	</result>
2657	</desc>
2658	<param name="interface" type="IHostNetworkInterface" dir="in">
2659	<desc>Network Interface</desc>
2660	</param>
2661	<param name="server" type="IDHCPServer" dir="out">
2662	<desc>Dhcp server settings</desc>
2663	</param>
2664	</method-->
2665
2666	<method name="createDHCPServer">
2667	<desc>
2668	Creates a dhcp server settings to be used for the given internal network name
2669	<result name="E_INVALIDARG">
2670	Host network interface @a name already exists.
2671	</result>
2672	</desc>
2673	<param name="name" type="wstring" dir="in">
2674	<desc>server name</desc>
2675	</param>
2676	<param name="server" type="IDHCPServer" dir="return">
2677	<desc>Dhcp server settings</desc>
2678	</param>
2679	</method>
2680
2681	<method name="findDHCPServerByNetworkName">
2682	<desc>
2683	Searches a dhcp server settings to be used for the given internal network name
2684	<result name="E_INVALIDARG">
2685	Host network interface @a name already exists.
2686	</result>
2687
2688	</desc>
2689	<param name="name" type="wstring" dir="in">
2690	<desc>server name</desc>
2691	</param>
2692	<param name="server" type="IDHCPServer" dir="return">
2693	<desc>Dhcp server settings</desc>
2694	</param>
2695	</method>
2696
2697	<!--method name="findDHCPServerForInterface">
2698	<desc>
2699	Searches a dhcp server settings to be used for the given interface
2700	<result name="E_INVALIDARG">
2701	Host network interface @a name already exists.
2702	</result>
2703	</desc>
2704	<param name="interface" type="IHostNetworkInterface" dir="in">
2705	<desc>Network Interface</desc>
2706	</param>
2707	<param name="server" type="IDHCPServer" dir="out">
2708	<desc>Dhcp server settings</desc>
2709	</param>
2710	</method-->
2711
2712	<method name="removeDHCPServer">
2713	<desc>
2714	Removes the dhcp server settings
2715	<result name="E_INVALIDARG">
2716	Host network interface @a name already exists.
2717	</result>
2718	</desc>
2719	<param name="server" type="IDHCPServer" dir="in">
2720	<desc>Dhcp server settings to be removed</desc>
2721	</param>
2722	</method>
2723
2724
2725	<method name="checkFirmwarePresent">
2726	<desc>
2727	Check if this VirtualBox installation has a firmware
2728	of the given type available, either system-wide or per-user.
2729	Optionally, this may return a hint where this firmware can be
2730	downloaded from.
2731	</desc>
2732	<param name="firmwareType" type="FirmwareType" dir="in">
2733	<desc>
2734	Type of firmware to check.
2735	</desc>
2736	</param>
2737	<param name="version" type="wstring" dir="in">
2738	<desc>Expected version number, usually empty string (presently ignored).</desc>
2739	</param>
2740
2741	<param name="url" type="wstring" dir="out">
2742	<desc>
2743	Suggested URL to download this firmware from.
2744	</desc>
2745	</param>
2746
2747	<param name="file" type="wstring" dir="out">
2748	<desc>
2749	Filename of firmware, only valid if result == TRUE.
2750	</desc>
2751	</param>
2752
2753	<param name="result" type="boolean" dir="return">
2754	<desc>If firmware of this type and version is available.</desc>
2755	</param>
2756	</method>
2757
2758	</interface>
2759
2760	<!--
2761	// IVFSExplorer
2762	/////////////////////////////////////////////////////////////////////////
2763	-->
2764
2765	<enum
2766	name="VFSType"
2767	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2768	>
2769	<desc>
2770	Virtual file systems supported by VFSExplorer.
2771	</desc>
2772
2773	<const name="File" value="1" />
2774	<const name="Cloud" value="2" />
2775	<const name="S3" value="3" />
2776	<const name="WebDav" value="4" />
2777	</enum>
2778
2779	<enum
2780	name="VFSFileType"
2781	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2782	>
2783	<desc>
2784	File types known by VFSExplorer.
2785	</desc>
2786
2787	<const name="Unknown" value="1" />
2788	<const name="Fifo" value="2" />
2789	<const name="DevChar" value="3" />
2790	<const name="Directory" value="4" />
2791	<const name="DevBlock" value="5" />
2792	<const name="File" value="6" />
2793	<const name="SymLink" value="7" />
2794	<const name="Socket" value="8" />
2795	<const name="WhiteOut" value="9" />
2796	</enum>
2797
2798	<interface
2799	name="IVFSExplorer" extends="$unknown"
2800	uuid="2bb864a1-02a3-4474-a1d4-fb5f23b742e1"
2801	wsmap="managed"
2802	>
2803	<desc>
2804	The VFSExplorer interface unifies access to different file system
2805	types. This includes local file systems as well remote file systems like
2806	S3. For a list of supported types see <link to="VFSType" />.
2807	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2808	</desc>
2809
2810	<attribute name="path" type="wstring" readonly="yes">
2811	<desc>Returns the current path in the virtual file system.</desc>
2812	</attribute>
2813
2814	<attribute name="type" type="VFSType" readonly="yes">
2815	<desc>Returns the file system type which is currently in use.</desc>
2816	</attribute>
2817
2818	<method name="update">
2819	<desc>Updates the internal list of files/directories from the
2820	current directory level. Use <link to="#entryList" /> to get the full list
2821	after a call to this method.</desc>
2822
2823	<param name="aProgress" type="IProgress" dir="return">
2824	<desc>Progress object to track the operation completion.</desc>
2825	</param>
2826	</method>
2827
2828	<method name="cd">
2829	<desc>Change the current directory level.</desc>
2830
2831	<param name="aDir" type="wstring" dir="in">
2832	<desc>The name of the directory to go in.</desc>
2833	</param>
2834
2835	<param name="aProgress" type="IProgress" dir="return">
2836	<desc>Progress object to track the operation completion.</desc>
2837	</param>
2838	</method>
2839
2840	<method name="cdUp">
2841	<desc>Go one directory upwards from the current directory level.</desc>
2842
2843	<param name="aProgress" type="IProgress" dir="return">
2844	<desc>Progress object to track the operation completion.</desc>
2845	</param>
2846	</method>
2847
2848	<method name="entryList">
2849	<desc>Returns a list of files/directories after a call to <link
2850	to="#update" />. The user is responsible for keeping this internal
2851	list up do date.</desc>
2852
2853	<param name="aNames" type="wstring" safearray="yes" dir="out">
2854	<desc>The list of names for the entries.</desc>
2855	</param>
2856
2857	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2858	<desc>The list of types for the entries.</desc>
2859	</param>
2860	</method>
2861
2862	<method name="exists">
2863	<desc>Checks if the given file list exists in the current directory
2864	level.</desc>
2865
2866	<param name="aNames" type="wstring" safearray="yes" dir="in">
2867	<desc>The names to check.</desc>
2868	</param>
2869
2870	<param name="aExists" type="wstring" safearray="yes" dir="return">
2871	<desc>The names which exist.</desc>
2872	</param>
2873	</method>
2874
2875	<method name="remove">
2876	<desc>Deletes the given files in the current directory level.</desc>
2877
2878	<param name="aNames" type="wstring" safearray="yes" dir="in">
2879	<desc>The names to remove.</desc>
2880	</param>
2881
2882	<param name="aProgress" type="IProgress" dir="return">
2883	<desc>Progress object to track the operation completion.</desc>
2884	</param>
2885	</method>
2886
2887	</interface>
2888
2889	<!--
2890	// IAppliance
2891	/////////////////////////////////////////////////////////////////////////
2892	-->
2893
2894	<interface
2895	name="IAppliance" extends="$unknown"
2896	uuid="e3ba9ab9-ac2c-4266-8bd2-91c4bf721ceb"
2897	wsmap="managed"
2898	>
2899	<desc>
2900	Represents a platform-independent appliance in OVF format. An instance of this is returned
2901	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2902	virtual machines within an appliance with VirtualBox.
2903
2904	The OVF standard suggests two different physical file formats:
2905
2906	<ol>
2907	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2908	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2909	this descriptor file references other files such as disk images, as OVF appliances typically
2910	do, those additional files must be in the same directory as the descriptor file.</li>
2911
2912	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2913	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2914	files and optionally other files.
2915
2916	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2917	be added with a later version.</li>
2918	</ol>
2919
2920	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2921	<link to="IMachine" /> involves the following sequence of API calls:
2922
2923	<ol>
2924	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2925	</li>
2926
2927	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2928	would like to import. So long as this file is syntactically valid, this will succeed
2929	and fill the appliance object with the parsed data from the OVF file.
2930	</li>
2931
2932	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2933	contents of the IAppliance attributes accordingly. These can be inspected by a
2934	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2935	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2936	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2937	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2938	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2939	The GUI can then give the user the option to confirm and/or change these suggestions.
2940	</li>
2941
2942	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2943	virtual system (machine) to override the suggestions made by the interpret() routine.
2944	</li>
2945
2946	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2947	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2948	virtual system descriptions.
2949	</li>
2950	</ol>
2951
2952	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2953
2954	<ol>
2955	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2956	an empty IAppliance object.
2957	</li>
2958
2959	<li>For each machine you would like to export, call <link to="IMachine::export" />
2960	with the IAppliance object you just created. Each such call creates one instance of
2961	<link to="IVirtualSystemDescription" /> inside the appliance.
2962	</li>
2963
2964	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2965	virtual system (machine) to override the suggestions made by the export() routine.
2966	</li>
2967
2968	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2969	file written.</li>
2970	</ol>
2971
2972	</desc>
2973
2974	<attribute name="path" type="wstring" readonly="yes">
2975	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2976	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2977	<link to="#write" /> (for export).
2978	This attribute is empty until one of these methods has been called.
2979	</desc>
2980	</attribute>
2981
2982	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2983	<desc>
2984	Array of virtual disk definitions. One such description exists for each
2985	disk definition in the OVF; each string array item represents one such piece of
2986	disk information, with the information fields separated by tab (\t) characters.
2987
2988	The caller should be prepared for additional fields being appended to
2989	this string in future versions of VirtualBox and therefore check for
2990	the number of tabs in the strings returned.
2991
2992	In the current version, the following eight fields are returned per string
2993	in the array:
2994
2995	<ol>
2996	<li>Disk ID (unique string identifier given to disk)</li>
2997
2998	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2999
3000	<li>Populated size (optional unsigned integer indicating the current size of the
3001	disk; can be approximate; -1 if unspecified)</li>
3002
3003	<li>Format (string identifying the disk format, typically
3004	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
3005
3006	<li>Reference (where to find the disk image, typically a file name; if empty,
3007	then the disk should be created on import)</li>
3008
3009	<li>Image size (optional unsigned integer indicating the size of the image,
3010	which need not necessarily be the same as the values specified above, since
3011	the image may be compressed or sparse; -1 if not specified)</li>
3012
3013	<li>Chunk size (optional unsigned integer if the image is split into chunks;
3014	presently unsupported and always -1)</li>
3015
3016	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
3017	</ol>
3018	</desc>
3019	</attribute>
3020
3021	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
3022	<desc> Array of virtual system descriptions. One such description is created
3023	for each virtual system (machine) found in the OVF.
3024	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
3025	(for export) has been called.
3026	</desc>
3027	</attribute>
3028
3029	<method name="read">
3030	<desc>
3031	Reads an OVF file into the appliance object.
3032
3033	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
3034	mere fact that this method returns successfully does not mean that VirtualBox supports all
3035	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
3036	</desc>
3037	<param name="file" type="wstring" dir="in">
3038	<desc>
3039	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3040	on whether the appliance is distributed as a set of files or as a single file, respectively).
3041	</desc>
3042	</param>
3043	<param name="aProgress" type="IProgress" dir="return">
3044	<desc></desc>
3045	</param>
3046	</method>
3047
3048	<method name="interpret">
3049	<desc>
3050	Interprets the OVF data that was read when the appliance was constructed. After
3051	calling this method, one can inspect the
3052	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
3053	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
3054	the appliance.
3055
3056	Calling this method is the second step of importing an appliance into VirtualBox;
3057	see <link to="IAppliance" /> for an overview.
3058
3059	After calling this method, one should call <link to="#getWarnings" /> to find out
3060	if problems were encountered during the processing which might later lead to
3061	errors.
3062	</desc>
3063	</method>
3064
3065	<method name="importMachines">
3066	<desc>
3067	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
3068	and other interfaces that match the information contained in the appliance as
3069	closely as possible, as represented by the import instructions in the
3070	<link to="#virtualSystemDescriptions" /> array.
3071
3072	Calling this method is the final step of importing an appliance into VirtualBox;
3073	see <link to="IAppliance" /> for an overview.
3074
3075	Since importing the appliance will most probably involve copying and converting
3076	disk images, which can take a long time, this method operates asynchronously and
3077	returns an IProgress object to allow the caller to monitor the progress.
3078	</desc>
3079
3080	<param name="aProgress" type="IProgress" dir="return">
3081	<desc></desc>
3082	</param>
3083	</method>
3084
3085	<method name="createVFSExplorer">
3086	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
3087
3088	<param name="aUri" type="wstring" dir="in">
3089	<desc>The URI describing the file system to use.</desc>
3090	</param>
3091
3092	<param name="aExplorer" type="IVFSExplorer" dir="return">
3093	<desc></desc>
3094	</param>
3095	</method>
3096
3097	<method name="write">
3098	<desc>
3099	Writes the contents of the appliance exports into a new OVF file.
3100
3101	Calling this method is the final step of exporting an appliance from VirtualBox;
3102	see <link to="IAppliance" /> for an overview.
3103
3104	Since exporting the appliance will most probably involve copying and converting
3105	disk images, which can take a long time, this method operates asynchronously and
3106	returns an IProgress object to allow the caller to monitor the progress.
3107	</desc>
3108	<param name="format" type="wstring" dir="in">
3109	<desc>
3110	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
3111	future versions of VirtualBox may support additional formats.
3112	</desc>
3113	</param>
3114	<param name="path" type="wstring" dir="in">
3115	<desc>
3116	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3117	on whether the appliance is distributed as a set of files or as a single file, respectively).
3118	</desc>
3119	</param>
3120	<param name="aProgress" type="IProgress" dir="return">
3121	<desc>Progress object to track the operation completion.</desc>
3122	</param>
3123	</method>
3124
3125	<method name="getWarnings">
3126	<desc>Returns textual warnings which occured during execution of <link to="#interpret" />.</desc>
3127
3128	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
3129	<desc></desc>
3130	</param>
3131	</method>
3132
3133	</interface>
3134
3135	<enum
3136	name="VirtualSystemDescriptionType"
3137	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
3138	>
3139	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
3140	a configuration value.</desc>
3141
3142	<const name="Ignore" value="1" />
3143	<const name="OS" value="2" />
3144	<const name="Name" value="3" />
3145	<const name="Product" value="4" />
3146	<const name="Vendor" value="5" />
3147	<const name="Version" value="6" />
3148	<const name="ProductUrl" value="7" />
3149	<const name="VendorUrl" value="8" />
3150	<const name="Description" value="9" />
3151	<const name="License" value="10" />
3152	<const name="Miscellaneous" value="11" />
3153	<const name="CPU" value="12" />
3154	<const name="Memory" value="13" />
3155	<const name="HardDiskControllerIDE" value="14" />
3156	<const name="HardDiskControllerSATA" value="15" />
3157	<const name="HardDiskControllerSCSI" value="16" />
3158	<const name="HardDiskControllerSAS" value="17" />
3159	<const name="HardDiskImage" value="18" />
3160	<const name="Floppy" value="19" />
3161	<const name="CDROM" value="20" />
3162	<const name="NetworkAdapter" value="21" />
3163	<const name="USBController" value="22" />
3164	<const name="SoundCard" value="23" />
3165
3166	</enum>
3167
3168	<enum
3169	name="VirtualSystemDescriptionValueType"
3170	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
3171	>
3172	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
3173	type to fetch.</desc>
3174
3175	<const name="Reference" value="1" />
3176	<const name="Original" value="2" />
3177	<const name="Auto" value="3" />
3178	<const name="ExtraConfig" value="4" />
3179
3180	</enum>
3181
3182	<interface
3183	name="IVirtualSystemDescription" extends="$unknown"
3184	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
3185	wsmap="managed"
3186	>
3187
3188	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
3189	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
3190	<link to="IAppliance::interpret" /> has been called, that array contains information
3191	about how the virtual systems described in the OVF should best be imported into
3192	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
3193	import an OVF into VirtualBox.
3194	</desc>
3195
3196	<attribute name="count" type="unsigned long" readonly="yes">
3197	<desc>Return the number of virtual system description entries.</desc>
3198	</attribute>
3199
3200	<method name="getDescription">
3201	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
3202	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
3203
3204	The list below identifies the value sets that are possible depending on the
3205	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
3206	the array item with the same index in @a aOvfValues[] will contain the original value as contained
3207	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
3208	will contain a suggested value to be used for VirtualBox. Depending on the description type,
3209	the @a aExtraConfigValues[] array item may also be used.
3210
3211	<ul>
3212	<li>
3213	"OS": the guest operating system type. There must be exactly one such array item on import. The
3214	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
3215	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
3216	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
3217	</li>
3218	<li>
3219	"Name": the name to give to the new virtual machine. There can be at most one such array item;
3220	if none is present on import, then an automatic name will be created from the operating system
3221	type. The correponding item im @a aOvfValues[] will contain the suggested virtual machine name
3222	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
3223	<link to="IMachine" /> name that does not exist yet.
3224	</li>
3225	<li>
3226	"Description": an arbitrary description.
3227	</li>
3228	<li>
3229	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
3230	code to display such a license for agreement; the Main API does not enforce any such policy.
3231	</li>
3232	<li>
3233	Miscellaneous: reserved for future use.
3234	</li>
3235	<li>
3236	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
3237	</li>
3238	<li>
3239	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
3240	is present on import, then VirtualBox will set a meaningful default based on the operating system
3241	type.
3242	</li>
3243	<li>
3244	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
3245	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
3246	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
3247	writes into the OVF.
3248	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
3249	type can use to specify which hard disk controller a virtual disk should be connected to.
3250	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
3251	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
3252	its virtual machines supports four channels (primary master, primary slave, secondary master,
3253	secondary slave) and thus maps to two IDE controllers in the OVF sense.
3254	</li>
3255	<li>
3256	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
3257	has no value in @a aOvfValues[] or @a aVBoxValues[].
3258	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
3259	</li>
3260	<li>
3261	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
3262	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
3263	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
3264	whereas VirtualBox considers it a class of storage controllers of its own; see
3265	<link to="StorageControllerType" />).
3266	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
3267	</li>
3268	<li>
3269	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
3270	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
3271
3272	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
3273	a path since the image file should be in the same location as the OVF file itself), whereas the
3274	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
3275	hard disk image. This means that on import the image will be copied and converted from the
3276	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
3277	On import, the target image will also be registered with VirtualBox.
3278
3279	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
3280	format: "controller=<index>;channel=<c>"
3281	In this string, <index> must be an integer specifying the hard disk controller to connect
3282	the image to. That number must be the index of an array item with one of the hard disk controller
3283	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
3284	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
3285	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
3286	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
3287	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
3288	</li>
3289	<li>
3290	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
3291	attachment information as with "HardDiskImage" items.
3292	</li>
3293	<li>
3294	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
3295	attachment information as with "HardDiskImage" items.
3296	</li>
3297	<li>
3298	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
3299	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
3300	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
3301	</li>
3302	<li>
3303	"USBController": a USB controller. There can be at most one such item. If and only if such an
3304	item ispresent, USB support will be enabled for the new virtual machine.
3305	</li>
3306	<li>
3307	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
3308	present, sound support will be enabled for the new virtual machine. Note that the virtual
3309	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
3310	may be different from the virtual soundcard expected by the appliance.
3311	</li>
3312	</ul>
3313
3314	</desc>
3315
3316	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3317	<desc></desc>
3318	</param>
3319
3320	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3321	<desc></desc>
3322	</param>
3323
3324	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3325	<desc></desc>
3326	</param>
3327
3328	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3329	<desc></desc>
3330	</param>
3331
3332	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3333	<desc></desc>
3334	</param>
3335
3336	</method>
3337
3338	<method name="getDescriptionByType">
3339	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
3340	should be returned.</desc>
3341
3342	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3343	<desc></desc>
3344	</param>
3345
3346	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3347	<desc></desc>
3348	</param>
3349
3350	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3351	<desc></desc>
3352	</param>
3353
3354	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3355	<desc></desc>
3356	</param>
3357
3358	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3359	<desc></desc>
3360	</param>
3361
3362	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3363	<desc></desc>
3364	</param>
3365
3366	</method>
3367
3368	<method name="getValuesByType">
3369	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
3370	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
3371	values.</desc>
3372
3373	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3374	<desc></desc>
3375	</param>
3376
3377	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
3378	<desc></desc>
3379	</param>
3380
3381	<param name="aValues" type="wstring" dir="return" safearray="yes">
3382	<desc></desc>
3383	</param>
3384
3385	</method>
3386
3387	<method name="setFinalValues">
3388	<desc>
3389	This method allows the appliance's user to change the configuration for the virtual
3390	system descriptions. For each array item returned from <link to="#getDescription" />,
3391	you must pass in one boolean value and one configuration value.
3392
3393	Each item in the boolean array determines whether the particular configuration item
3394	should be enabled.
3395	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
3396	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
3397	and SoundCard.
3398
3399	For the "vbox" and "extra configuration" values, if you pass in the same arrays
3400	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
3401	the configuration remains unchanged. Please see the documentation for getDescription()
3402	for valid configuration values for the individual array item types. If the
3403	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3404	</desc>
3405
3406	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
3407	<desc></desc>
3408	</param>
3409
3410	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
3411	<desc></desc>
3412	</param>
3413
3414	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
3415	<desc></desc>
3416	</param>
3417	</method>
3418
3419	<method name="addDescription">
3420	<desc>
3421	This method adds an additional description entry to the stack of already
3422	available descriptions for this virtual system. This is handy for writing
3423	values which aren't directly supported by VirtualBox. One example would
3424	be the License type of <link to="VirtualSystemDescriptionType" />.
3425	</desc>
3426
3427	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3428	<desc></desc>
3429	</param>
3430
3431	<param name="aVBoxValue" type="wstring" dir="in">
3432	<desc></desc>
3433	</param>
3434
3435	<param name="aExtraConfigValue" type="wstring" dir="in">
3436	<desc></desc>
3437	</param>
3438	</method>
3439	</interface>
3440
3441
3442	<!--
3443	// IMachine
3444	/////////////////////////////////////////////////////////////////////////
3445	-->
3446
3447	<interface
3448	name="IInternalMachineControl" extends="$unknown"
3449	uuid="26604a54-8628-491b-a0ea-e1392a16d13b"
3450	internal="yes"
3451	wsmap="suppress"
3452	>
3453	<method name="setRemoveSavedState">
3454	<desc>
3455	Updates the flag whether saved state is removed on a machine state
3456	change from Saved to PoweredOff.
3457	</desc>
3458	<param name="aRemove" type="boolean" dir="in"/>
3459	</method>
3460
3461	<method name="updateState">
3462	<desc>
3463	Updates the VM state.
3464	<note>
3465	This operation will also update the settings file with
3466	the correct information about the saved state file
3467	and delete this file from disk when appropriate.
3468	</note>
3469	</desc>
3470	<param name="state" type="MachineState" dir="in"/>
3471	</method>
3472
3473	<method name="getIPCId">
3474	<param name="id" type="wstring" dir="return"/>
3475	</method>
3476
3477	<method name="beginPowerUp">
3478	<desc>
3479	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
3480	gives it the progress object that should be part of any pending
3481	<link to="IVirtualBox::openRemoteSession"/> operations. The progress
3482	object may be called back to reflect an early cancelation, so some care
3483	have to be taken with respect to any cancelation callbacks. The console
3484	object will call <link to="IInternalMachineControl::endPowerUp"/>
3485	to signal the completion of the progress object.
3486	</desc>
3487	<param name="progress" type="IProgress" dir="in"/>
3488	</method>
3489
3490	<method name="endPowerUp">
3491	<desc>
3492	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3493	This method may query status information from the progress object it
3494	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3495	it over to any in progress <link to="IVirtualBox::openRemoteSession"/>
3496	call in order to complete that progress object.
3497	</desc>
3498	<param name="result" type="long" dir="in"/>
3499	</method>
3500
3501	<method name="runUSBDeviceFilters">
3502	<desc>
3503	Asks the server to run USB devices filters of the associated
3504	machine against the given USB device and tell if there is
3505	a match.
3506	<note>
3507	Intended to be used only for remote USB devices. Local
3508	ones don't require to call this method (this is done
3509	implicitly by the Host and USBProxyService).
3510	</note>
3511	</desc>
3512	<param name="device" type="IUSBDevice" dir="in"/>
3513	<param name="matched" type="boolean" dir="out"/>
3514	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3515	</method>
3516
3517	<method name="captureUSBDevice">
3518	<desc>
3519	Requests a capture of the given host USB device.
3520	When the request is completed, the VM process will
3521	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3522	notification.
3523	</desc>
3524	<param name="id" type="uuid" mod="string" dir="in"/>
3525	</method>
3526
3527	<method name="detachUSBDevice">
3528	<desc>
3529	Notification that a VM is going to detach (@a done = @c false) or has
3530	already detached (@a done = @c true) the given USB device.
3531	When the @a done = @c true request is completed, the VM process will
3532	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3533	notification.
3534	<note>
3535	In the @a done = @c true case, the server must run its own filters
3536	and filters of all VMs but this one on the detached device
3537	as if it were just attached to the host computer.
3538	</note>
3539	</desc>
3540	<param name="id" type="uuid" mod="string" dir="in"/>
3541	<param name="done" type="boolean" dir="in"/>
3542	</method>
3543
3544	<method name="autoCaptureUSBDevices">
3545	<desc>
3546	Requests a capture all matching USB devices attached to the host.
3547	When the request is completed, the VM process will
3548	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3549	notification per every captured device.
3550	</desc>
3551	</method>
3552
3553	<method name="detachAllUSBDevices">
3554	<desc>
3555	Notification that a VM that is being powered down. The done
3556	parameter indicates whether which stage of the power down
3557	we're at. When @a done = @c false the VM is announcing its
3558	intentions, while when @a done = @c true the VM is reporting
3559	what it has done.
3560	<note>
3561	In the @a done = @c true case, the server must run its own filters
3562	and filters of all VMs but this one on all detach devices as
3563	if they were just attached to the host computer.
3564	</note>
3565	</desc>
3566	<param name="done" type="boolean" dir="in"/>
3567	</method>
3568
3569	<method name="onSessionEnd">
3570	<desc>
3571	Triggered by the given session object when the session is about
3572	to close normally.
3573	</desc>
3574	<param name="session" type="ISession" dir="in">
3575	<desc>Session that is being closed</desc>
3576	</param>
3577	<param name="progress" type="IProgress" dir="return">
3578	<desc>
3579	Used to wait until the corresponding machine is actually
3580	dissociated from the given session on the server.
3581	Returned only when this session is a direct one.
3582	</desc>
3583	</param>
3584	</method>
3585
3586	<method name="beginSavingState">
3587	<desc>
3588	Called by the VM process to inform the server it wants to
3589	save the current state and stop the VM execution.
3590	</desc>
3591	<param name="progress" type="IProgress" dir="in">
3592	<desc>
3593	Progress object created by the VM process to wait until
3594	the state is saved.
3595	</desc>
3596	</param>
3597	<param name="stateFilePath" type="wstring" dir="out">
3598	<desc>
3599	File path the VM process must save the execution state to.
3600	</desc>
3601	</param>
3602	</method>
3603
3604	<method name="endSavingState">
3605	<desc>
3606	Called by the VM process to inform the server that saving
3607	the state previously requested by #beginSavingState is either
3608	successfully finished or there was a failure.
3609
3610	<result name="VBOX_E_FILE_ERROR">
3611	Settings file not accessible.
3612	</result>
3613	<result name="VBOX_E_XML_ERROR">
3614	Could not parse the settings file.
3615	</result>
3616
3617	</desc>
3618
3619	<param name="success" type="boolean" dir="in">
3620	<desc>@c true to indicate success and @c false otherwise.
3621	</desc>
3622	</param>
3623	</method>
3624
3625	<method name="adoptSavedState">
3626	<desc>
3627	Gets called by IConsole::adoptSavedState.
3628	<result name="VBOX_E_FILE_ERROR">
3629	Invalid saved state file path.
3630	</result>
3631	</desc>
3632	<param name="savedStateFile" type="wstring" dir="in">
3633	<desc>Path to the saved state file to adopt.</desc>
3634	</param>
3635	</method>
3636
3637	<method name="beginTakingSnapshot">
3638	<desc>
3639	Called from the VM process to request from the server to perform the
3640	server-side actions of creating a snapshot (creating differencing images
3641	and the snapshot object).
3642
3643	<result name="VBOX_E_FILE_ERROR">
3644	Settings file not accessible.
3645	</result>
3646	<result name="VBOX_E_XML_ERROR">
3647	Could not parse the settings file.
3648	</result>
3649	</desc>
3650	<param name="initiator" type="IConsole" dir="in">
3651	<desc>The console object that initiated this call.</desc>
3652	</param>
3653	<param name="name" type="wstring" dir="in">
3654	<desc>Snapshot name.</desc>
3655	</param>
3656	<param name="description" type="wstring" dir="in">
3657	<desc>Snapshot description.</desc>
3658	</param>
3659	<param name="consoleProgress" type="IProgress" dir="in">
3660	<desc>
3661	Progress object created by the VM process tracking the
3662	snapshot's progress. This has the following sub-operations:
3663	<ul>
3664	<li>setting up (weight 1);</li>
3665	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3666	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3667	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3668	<li>finishing up (weight 1)</li>
3669	</ul>
3670	</desc>
3671	</param>
3672	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3673	<desc>
3674	Whether this is an online snapshot (i.e. the machine is running).
3675	</desc>
3676	</param>
3677	<param name="stateFilePath" type="wstring" dir="out">
3678	<desc>
3679	File path the VM process must save the execution state to.
3680	</desc>
3681	</param>
3682	</method>
3683
3684	<method name="endTakingSnapshot">
3685	<desc>
3686	Called by the VM process to inform the server that the snapshot
3687	previously requested by #beginTakingSnapshot is either
3688	successfully taken or there was a failure.
3689	</desc>
3690
3691	<param name="success" type="boolean" dir="in">
3692	<desc>@c true to indicate success and @c false otherwise</desc>
3693	</param>
3694	</method>
3695
3696	<method name="deleteSnapshot">
3697	<desc>
3698	Gets called by IConsole::deleteSnapshot.
3699	<result name="VBOX_E_INVALID_OBJECT_STATE">
3700	Snapshot has more than one child snapshot.
3701	</result>
3702	</desc>
3703	<param name="initiator" type="IConsole" dir="in">
3704	<desc>The console object that initiated this call.</desc>
3705	</param>
3706	<param name="id" type="uuid" mod="string" dir="in">
3707	<desc>UUID of the snapshot to delete.</desc>
3708	</param>
3709	<param name="machineState" type="MachineState" dir="out">
3710	<desc>New machine state after this operation is started.</desc>
3711	</param>
3712	<param name="progress" type="IProgress" dir="return">
3713	<desc>Progress object to track the operation completion.</desc>
3714	</param>
3715	</method>
3716
3717	<method name="finishOnlineMergeMedium">
3718	<desc>
3719	Gets called by IConsole::onlineMergeMedium.
3720	</desc>
3721	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3722	<desc>The medium attachment which needs to be cleaned up.</desc>
3723	</param>
3724	<param name="source" type="IMedium" dir="in">
3725	<desc>Merge source medium.</desc>
3726	</param>
3727	<param name="target" type="IMedium" dir="in">
3728	<desc>Merge target medium.</desc>
3729	</param>
3730	<param name="mergeForward" type="boolean" dir="in">
3731	<desc>Merge direction.</desc>
3732	</param>
3733	<param name="parentForTarget" type="IMedium" dir="in">
3734	<desc>For forward merges: new parent for target medium.</desc>
3735	</param>
3736	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3737	<desc>For backward merges: list of media which need their parent UUID
3738	updated.</desc>
3739	</param>
3740	</method>
3741
3742	<method name="restoreSnapshot">
3743	<desc>
3744	Gets called by IConsole::RestoreSnapshot.
3745	</desc>
3746	<param name="initiator" type="IConsole" dir="in">
3747	<desc>The console object that initiated this call.</desc>
3748	</param>
3749	<param name="snapshot" type="ISnapshot" dir="in">
3750	<desc>The snapshot to restore the VM state from.</desc>
3751	</param>
3752	<param name="machineState" type="MachineState" dir="out">
3753	<desc>New machine state after this operation is started.</desc>
3754	</param>
3755	<param name="progress" type="IProgress" dir="return">
3756	<desc>Progress object to track the operation completion.</desc>
3757	</param>
3758	</method>
3759
3760	<method name="pullGuestProperties">
3761	<desc>
3762	Get the list of the guest properties matching a set of patterns along
3763	with their values, time stamps and flags and give responsibility for
3764	managing properties to the console.
3765	</desc>
3766	<param name="name" type="wstring" dir="out" safearray="yes">
3767	<desc>
3768	The names of the properties returned.
3769	</desc>
3770	</param>
3771	<param name="value" type="wstring" dir="out" safearray="yes">
3772	<desc>
3773	The values of the properties returned. The array entries match the
3774	corresponding entries in the @a name array.
3775	</desc>
3776	</param>
3777	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
3778	<desc>
3779	The time stamps of the properties returned. The array entries match
3780	the corresponding entries in the @a name array.
3781	</desc>
3782	</param>
3783	<param name="flags" type="wstring" dir="out" safearray="yes">
3784	<desc>
3785	The flags of the properties returned. The array entries match the
3786	corresponding entries in the @a name array.
3787	</desc>
3788	</param>
3789	</method>
3790
3791	<method name="pushGuestProperty">
3792	<desc>
3793	Update a single guest property in IMachine.
3794	</desc>
3795	<param name="name" type="wstring" dir="in">
3796	<desc>
3797	The name of the property to be updated.
3798	</desc>
3799	</param>
3800	<param name="value" type="wstring" dir="in">
3801	<desc>
3802	The value of the property.
3803	</desc>
3804	</param>
3805	<param name="timestamp" type="unsigned long long" dir="in">
3806	<desc>
3807	The timestamp of the property.
3808	</desc>
3809	</param>
3810	<param name="flags" type="wstring" dir="in">
3811	<desc>
3812	The flags of the property.
3813	</desc>
3814	</param>
3815	</method>
3816
3817	<method name="lockMedia">
3818	<desc>
3819	Locks all media attached to the machine for writing and parents of
3820	attached differencing media (if any) for reading. This operation is
3821	atomic so that if it fails no media is actually locked.
3822
3823	This method is intended to be called when the machine is in Starting or
3824	Restoring state. The locked media will be automatically unlocked when
3825	the machine is powered off or crashed.
3826	</desc>
3827	</method>
3828	<method name="unlockMedia">
3829	<desc>
3830	Unlocks all media previously locked using
3831	<link to="IInternalMachineControl::lockMedia"/>.
3832
3833	This method is intended to be used with teleportation so that it is
3834	possible to teleport between processes on the same machine.
3835	</desc>
3836	</method>
3837	</interface>
3838
3839	<interface
3840	name="IBIOSSettings" extends="$unknown"
3841	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3842	wsmap="managed"
3843	>
3844	<desc>
3845	The IBIOSSettings interface represents BIOS settings of the virtual
3846	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3847	</desc>
3848	<attribute name="logoFadeIn" type="boolean">
3849	<desc>Fade in flag for BIOS logo animation.</desc>
3850	</attribute>
3851
3852	<attribute name="logoFadeOut" type="boolean">
3853	<desc>Fade out flag for BIOS logo animation.</desc>
3854	</attribute>
3855
3856	<attribute name="logoDisplayTime" type="unsigned long">
3857	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3858	</attribute>
3859
3860	<attribute name="logoImagePath" type="wstring">
3861	<desc>
3862	Local file system path for external BIOS splash image. Empty string
3863	means the default image is shown on boot.
3864	</desc>
3865	</attribute>
3866
3867	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3868	<desc>Mode of the BIOS boot device menu.</desc>
3869	</attribute>
3870
3871	<attribute name="ACPIEnabled" type="boolean">
3872	<desc>ACPI support flag.</desc>
3873	</attribute>
3874
3875	<attribute name="IOAPICEnabled" type="boolean">
3876	<desc>
3877	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3878	and support IRQs above 15.
3879	</desc>
3880	</attribute>
3881
3882	<attribute name="timeOffset" type="long long">
3883	<desc>
3884	Offset in milliseconds from the host system time. This allows for
3885	guests running with a different system date/time than the host.
3886	It is equivalent to setting the system date/time in the BIOS except
3887	it is not an absolute value but a relative one. Guest Additions
3888	time synchronization honors this offset.
3889	</desc>
3890	</attribute>
3891
3892	<attribute name="PXEDebugEnabled" type="boolean">
3893	<desc>
3894	PXE debug logging flag. If set, VirtualBox will write extensive
3895	PXE trace information to the release log.
3896	</desc>
3897	</attribute>
3898
3899	</interface>
3900
3901	<interface
3902	name="IMachine" extends="$unknown"
3903	uuid="6d9212cb-a5c0-48b7-bbc1-3fa2ba2ee6d2"
3904	wsmap="managed"
3905	>
3906	<desc>
3907	The IMachine interface represents a virtual machine, or guest, created
3908	in VirtualBox.
3909
3910	This interface is used in two contexts. First of all, a collection of
3911	objects implementing this interface is stored in the
3912	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3913	machines that are currently registered with this VirtualBox
3914	installation. Also, once a session has been opened for the given virtual
3915	machine (e.g. the virtual machine is running), the machine object
3916	associated with the open session can be queried from the session object;
3917	see <link to="ISession"/> for details.
3918
3919	The main role of this interface is to expose the settings of the virtual
3920	machine and provide methods to change various aspects of the virtual
3921	machine's configuration. For machine objects stored in the
3922	<link to="IVirtualBox::machines"/> collection, all attributes are
3923	read-only unless explicitly stated otherwise in individual attribute
3924	and method descriptions. In order to change a machine setting, a session
3925	for this machine must be opened using one of
3926	<link to="IVirtualBox::openSession"/>,
3927	<link to="IVirtualBox::openRemoteSession"/> or
3928	<link to="IVirtualBox::openExistingSession"/> methods. After the
3929	session has been successfully opened, a mutable machine object needs to
3930	be queried from the session object and then the desired settings changes
3931	can be applied to the returned object using IMachine attributes and
3932	methods. See the <link to="ISession"/> interface description for more
3933	information about sessions.
3934
3935	Note that IMachine does not provide methods to control virtual machine
3936	execution (such as start the machine, or power it down) -- these methods
3937	are grouped in a separate interface called <link to="IConsole" />.
3938
3939	<see>ISession, IConsole</see>
3940	</desc>
3941
3942	<attribute name="parent" type="IVirtualBox" readonly="yes">
3943	<desc>Associated parent object.</desc>
3944	</attribute>
3945
3946	<attribute name="accessible" type="boolean" readonly="yes">
3947	<desc>
3948	Whether this virtual machine is currently accessible or not.
3949
3950	A machine is always deemed accessible unless it is registered <i>and</i>
3951	its settings file cannot be read or parsed (either because the file itself
3952	is unavailable or has invalid XML contents).
3953
3954	Every time this property is read, the accessibility state of
3955	this machine is re-evaluated. If the returned value is @c false,
3956	the <link to="#accessError"/> property may be used to get the
3957	detailed error information describing the reason of
3958	inaccessibility, including XML error messages.
3959
3960	When the machine is inaccessible, only the following properties
3961	can be used on it:
3962	<ul>
3963	<li><link to="#parent"/></li>
3964	<li><link to="#id"/></li>
3965	<li><link to="#settingsFilePath"/></li>
3966	<li><link to="#accessible"/></li>
3967	<li><link to="#accessError"/></li>
3968	</ul>
3969
3970	An attempt to access any other property or method will return
3971	an error.
3972
3973	The only possible action you can perform on an inaccessible
3974	machine is to unregister it using the
3975	<link to="IVirtualBox::unregisterMachine"/> call (or, to check
3976	for the accessibility state once more by querying this
3977	property).
3978
3979	<note>
3980	In the current implementation, once this property returns
3981	@c true, the machine will never become inaccessible
3982	later, even if its settings file cannot be successfully
3983	read/written any more (at least, until the VirtualBox
3984	server is restarted). This limitation may be removed in
3985	future releases.
3986	</note>
3987	</desc>
3988	</attribute>
3989
3990	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3991	<desc>
3992	Error information describing the reason of machine
3993	inaccessibility.
3994
3995	Reading this property is only valid after the last call to
3996	<link to="#accessible"/> returned @c false (i.e. the
3997	machine is currently unaccessible). Otherwise, a @c null
3998	IVirtualBoxErrorInfo object will be returned.
3999	</desc>
4000	</attribute>
4001
4002	<attribute name="name" type="wstring">
4003	<desc>
4004	Name of the virtual machine.
4005
4006	Besides being used for human-readable identification purposes
4007	everywhere in VirtualBox, the virtual machine name is also used
4008	as a name of the machine's settings file and as a name of the
4009	subdirectory this settings file resides in. Thus, every time you
4010	change the value of this property, the settings file will be
4011	renamed once you call <link to="#saveSettings"/> to confirm the
4012	change. The containing subdirectory will be also renamed, but
4013	only if it has exactly the same name as the settings file
4014	itself prior to changing this property (for backward compatibility
4015	with previous API releases). The above implies the following
4016	limitations:
4017	<ul>
4018	<li>The machine name cannot be empty.</li>
4019	<li>The machine name can contain only characters that are valid
4020	file name characters according to the rules of the file
4021	system used to store VirtualBox configuration.</li>
4022	<li>You cannot have two or more machines with the same name
4023	if they use the same subdirectory for storing the machine
4024	settings files.</li>
4025	<li>You cannot change the name of the machine if it is running,
4026	or if any file in the directory containing the settings file
4027	is being used by another running machine or by any other
4028	process in the host operating system at a time when
4029	<link to="#saveSettings"/> is called.
4030	</li>
4031	</ul>
4032	If any of the above limitations are hit, <link to="#saveSettings"/>
4033	will return an appropriate error message explaining the exact
4034	reason and the changes you made to this machine will not be
4035	saved.
4036	<note>
4037	For "legacy" machines created using the
4038	<link to="IVirtualBox::createLegacyMachine"/> call,
4039	the above naming limitations do not apply because the
4040	machine name does not affect the settings file name.
4041	The settings file name remains the same as it was specified
4042	during machine creation and never changes.
4043	</note>
4044	</desc>
4045	</attribute>
4046
4047	<attribute name="description" type="wstring">
4048	<desc>
4049	Description of the virtual machine.
4050
4051	The description attribute can contain any text and is
4052	typically used to describe the hardware and software
4053	configuration of the virtual machine in detail (i.e. network
4054	settings, versions of the installed software and so on).
4055	</desc>
4056	</attribute>
4057
4058	<attribute name="id" type="uuid" mod="string" readonly="yes">
4059	<desc>UUID of the virtual machine.</desc>
4060	</attribute>
4061
4062	<attribute name="OSTypeId" type="wstring">
4063	<desc>
4064	User-defined identifier of the Guest OS type.
4065	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
4066	an IGuestOSType object representing details about the given
4067	Guest OS type.
4068	<note>
4069	This value may differ from the value returned by
4070	<link to="IGuest::OSTypeId"/> if Guest Additions are
4071	installed to the guest OS.
4072	</note>
4073	</desc>
4074	</attribute>
4075
4076	<attribute name="HardwareVersion" type="wstring">
4077	<desc>Hardware version identifier. Internal use only for now.</desc>
4078	</attribute>
4079
4080	<attribute name="hardwareUUID" type="uuid" mod="string">
4081	<desc>
4082	The UUID presented to the guest via memory tables, hardware and guest
4083	properties. For most VMs this is the same as the @a id, but for VMs
4084	which have been cloned or teleported it may be the same as the source
4085	VM. This latter is because the guest shouldn't notice that it was
4086	cloned or teleported.
4087	</desc>
4088	</attribute>
4089
4090	<attribute name="CPUCount" type="unsigned long">
4091	<desc>Number of virtual CPUs in the VM.</desc>
4092	</attribute>
4093
4094	<attribute name="CPUHotPlugEnabled" type="boolean">
4095	<desc>
4096	This setting determines whether VirtualBox allows CPU
4097	hotplugging for this machine.</desc>
4098	</attribute>
4099
4100	<attribute name="memorySize" type="unsigned long">
4101	<desc>System memory size in megabytes.</desc>
4102	</attribute>
4103
4104	<attribute name="memoryBalloonSize" type="unsigned long">
4105	<desc>Memory balloon size in megabytes.</desc>
4106	</attribute>
4107
4108	<attribute name="PageFusionEnabled" type="boolean">
4109	<desc>
4110	This setting determines whether VirtualBox allows page
4111	fusion for this machine (64 bits host only).
4112	</desc>
4113	</attribute>
4114
4115	<attribute name="VRAMSize" type="unsigned long">
4116	<desc>Video memory size in megabytes.</desc>
4117	</attribute>
4118
4119	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4120	<desc>
4121	This setting determines whether VirtualBox allows this machine to make
4122	use of the 3D graphics support available on the host.</desc>
4123	</attribute>
4124
4125	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4126	<desc>
4127	This setting determines whether VirtualBox allows this machine to make
4128	use of the 2D video acceleration support available on the host.</desc>
4129	</attribute>
4130
4131	<attribute name="monitorCount" type="unsigned long">
4132	<desc>
4133	Number of virtual monitors.
4134	<note>
4135	Only effective on Windows XP and later guests with
4136	Guest Additions installed.
4137	</note>
4138	</desc>
4139	</attribute>
4140
4141	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4142	<desc>Object containing all BIOS settings.</desc>
4143	</attribute>
4144
4145	<attribute name="firmwareType" type="FirmwareType">
4146	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4147	bootstrap in this VM.</desc>
4148	</attribute>
4149
4150	<attribute name="pointingHidType" type="PointingHidType">
4151	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
4152	The default is typically "PS2Mouse" but can vary depending on the
4153	requirements of the guest operating system.</desc>
4154	</attribute>
4155
4156	<attribute name="keyboardHidType" type="KeyboardHidType">
4157	<desc>Type of keyboard HID used in this VM.
4158	The default is typically "PS2Keyboard" but can vary depending on the
4159	requirements of the guest operating system.</desc>
4160	</attribute>
4161
4162	<attribute name="hpetEnabled" type="boolean">
4163	<desc>This attribute controls if High Precision Event Timer (HPET) is
4164	enabled in this VM. Use this property if you want to provide guests
4165	with additional time source, or if guest requires HPET to function correctly.
4166	Default is false.</desc>
4167	</attribute>
4168
4169	<attribute name="snapshotFolder" type="wstring">
4170	<desc>
4171	Full path to the directory used to store snapshot data
4172	(differencing media and saved state files) of this machine.
4173
4174	The initial value of this property is
4175	<tt><</tt><link to="#settingsFilePath">
4176	path_to_settings_file</link><tt>>/<</tt>
4177	<link to="#id">machine_uuid</link>
4178	<tt>></tt>.
4179
4180	Currently, it is an error to try to change this property on
4181	a machine that has snapshots (because this would require to
4182	move possibly large files to a different location).
4183	A separate method will be available for this purpose later.
4184
4185	<note>
4186	Setting this property to @c null or to an empty string will restore
4187	the initial value.
4188	</note>
4189	<note>
4190	When setting this property, the specified path can be
4191	absolute (full path) or relative to the directory where the
4192	<link to="#settingsFilePath">machine settings file</link>
4193	is located. When reading this property, a full path is
4194	always returned.
4195	</note>
4196	<note>
4197	The specified path may not exist, it will be created
4198	when necessary.
4199	</note>
4200	</desc>
4201	</attribute>
4202
4203	<attribute name="VRDPServer" type="IVRDPServer" readonly="yes">
4204	<desc>VRDP server object.</desc>
4205	</attribute>
4206
4207	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4208	<desc>Array of media attached to this machine.</desc>
4209	</attribute>
4210
4211	<attribute name="USBController" type="IUSBController" readonly="yes">
4212	<desc>
4213	Associated USB controller object.
4214
4215	<note>
4216	If USB functionality is not available in the given edition of
4217	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4218	</note>
4219	</desc>
4220	</attribute>
4221
4222	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4223	<desc>Associated audio adapter, always present.</desc>
4224	</attribute>
4225
4226	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4227	<desc>Array of storage controllers attached to this machine.</desc>
4228	</attribute>
4229
4230	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4231	<desc>
4232	Full name of the file containing machine settings data.
4233	</desc>
4234	</attribute>
4235
4236	<attribute name="settingsModified" type="boolean" readonly="yes">
4237	<desc>
4238	Whether the settings of this machine have been modified
4239	(but neither yet saved nor discarded).
4240	<note>
4241	Reading this property is only valid on instances returned
4242	by <link to="ISession::machine"/> and on new machines
4243	created by <link to="IVirtualBox::createMachine"/> or opened
4244	by <link to="IVirtualBox::openMachine"/> but not
4245	yet registered, or on unregistered machines after calling
4246	<link to="IVirtualBox::unregisterMachine"/>. For all other
4247	cases, the settings can never be modified.
4248	</note>
4249	<note>
4250	For newly created unregistered machines, the value of this
4251	property is always @c true until <link to="#saveSettings"/>
4252	is called (no matter if any machine settings have been
4253	changed after the creation or not). For opened machines
4254	the value is set to @c false (and then follows to normal rules).
4255	</note>
4256	</desc>
4257	</attribute>
4258
4259	<attribute name="sessionState" type="SessionState" readonly="yes">
4260	<desc>Current session state for this machine.</desc>
4261	</attribute>
4262
4263	<attribute name="sessionType" type="wstring" readonly="yes">
4264	<desc>
4265	Type of the session. If <link to="#sessionState"/> is
4266	SessionSpawning or SessionOpen, this attribute contains the
4267	same value as passed to the
4268	<link to="IVirtualBox::openRemoteSession"/> method in the
4269	@a type parameter. If the session was opened directly using
4270	<link to="IVirtualBox::openSession"/>, or if
4271	<link to="#sessionState"/> is SessionClosed, the value of this
4272	attribute is an empty string.
4273	</desc>
4274	</attribute>
4275
4276	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4277	<desc>
4278	Identifier of the session process. This attribute contains the
4279	platform-dependent identifier of the process that has opened a
4280	direct session for this machine using the
4281	<link to="IVirtualBox::openSession"/> call. The returned value
4282	is only valid if <link to="#sessionState"/> is SessionOpen or
4283	SessionClosing (i.e. a session is currently open or being
4284	closed) by the time this property is read.
4285	</desc>
4286	</attribute>
4287
4288	<attribute name="state" type="MachineState" readonly="yes">
4289	<desc>Current execution state of this machine.</desc>
4290	</attribute>
4291
4292	<attribute name="lastStateChange" type="long long" readonly="yes">
4293	<desc>
4294	Time stamp of the last execution state change,
4295	in milliseconds since 1970-01-01 UTC.
4296	</desc>
4297	</attribute>
4298
4299	<attribute name="stateFilePath" type="wstring" readonly="yes">
4300	<desc>
4301	Full path to the file that stores the execution state of
4302	the machine when it is in the <link to="MachineState_Saved"/> state.
4303	<note>
4304	When the machine is not in the Saved state, this attribute is
4305	an empty string.
4306	</note>
4307	</desc>
4308	</attribute>
4309
4310	<attribute name="logFolder" type="wstring" readonly="yes">
4311	<desc>
4312	Full path to the folder that stores a set of rotated log files
4313	recorded during machine execution. The most recent log file is
4314	named <tt>VBox.log</tt>, the previous log file is
4315	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4316	in the current version).
4317	</desc>
4318	</attribute>
4319
4320	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4321	<desc>
4322	Current snapshot of this machine. This is @c null if the machine
4323	currently has no snapshots. If it is not @c null, then it was
4324	set by one of <link to="Console::takeSnapshot" />,
4325	<link to="Console::deleteSnapshot" />
4326	or <link to="Console::restoreSnapshot" />, depending on which
4327	was called last. See <link to="ISnapshot"/> for details.
4328	</desc>
4329	</attribute>
4330
4331	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4332	<desc>
4333	Number of snapshots taken on this machine. Zero means the
4334	machine doesn't have any snapshots.
4335	</desc>
4336	</attribute>
4337
4338	<attribute name="currentStateModified" type="boolean" readonly="yes">
4339	<desc>
4340	Returns @c true if the current state of the machine is not
4341	identical to the state stored in the current snapshot.
4342
4343	The current state is identical to the current snapshot only
4344	directly after one of the following calls are made:
4345
4346	<ul>
4347	<li><link to="IConsole::restoreSnapshot"/>
4348	</li>
4349	<li><link to="IConsole::takeSnapshot"/> (issued on a
4350	"powered off" or "saved" machine, for which
4351	<link to="#settingsModified"/> returns @c false)
4352	</li>
4353	<li><link to="IMachine::setCurrentSnapshot"/>
4354	</li>
4355	</ul>
4356
4357	The current state remains identical until one of the following
4358	happens:
4359	<ul>
4360	<li>settings of the machine are changed</li>
4361	<li>the saved state is deleted</li>
4362	<li>the current snapshot is deleted</li>
4363	<li>an attempt to execute the machine is made</li>
4364	</ul>
4365
4366	<note>
4367	For machines that don't have snapshots, this property is
4368	always @c false.
4369	</note>
4370	</desc>
4371	</attribute>
4372
4373	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4374	<desc>
4375	Collection of shared folders for this machine (permanent shared
4376	folders). These folders are shared automatically at machine startup
4377	and available only to the guest OS installed within this machine.
4378
4379	New shared folders are added to the collection using
4380	<link to="#createSharedFolder"/>. Existing shared folders can be
4381	removed using <link to="#removeSharedFolder"/>.
4382	</desc>
4383	</attribute>
4384
4385	<attribute name="clipboardMode" type="ClipboardMode">
4386	<desc>
4387	Synchronization mode between the host OS clipboard
4388	and the guest OS clipboard.
4389	</desc>
4390	</attribute>
4391
4392	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4393	<desc>
4394	A comma-separated list of simple glob patterns. Changes to guest
4395	properties whose name matches one of the patterns will generate an
4396	<link to="IGuestPropertyChangedEvent"/> signal.
4397	</desc>
4398	</attribute>
4399
4400	<attribute name="teleporterEnabled" type="boolean">
4401	<desc>
4402	When set to @a true, the virtual machine becomes a target teleporter
4403	the next time it is powered on. This can only set to @a true when the
4404	VM is in the @a PoweredOff or @a Aborted state.
4405
4406	<!-- This property is automatically set to @a false when the VM is powered
4407	on. (bird: This doesn't work yet ) -->
4408	</desc>
4409	</attribute>
4410
4411	<attribute name="teleporterPort" type="unsigned long">
4412	<desc>
4413	The TCP port the target teleporter will listen for incoming
4414	teleportations on.
4415
4416	0 means the port is automatically selected upon power on. The actual
4417	value can be read from this property while the machine is waiting for
4418	incoming teleportations.
4419	</desc>
4420	</attribute>
4421
4422	<attribute name="teleporterAddress" type="wstring">
4423	<desc>
4424	The address the target teleporter will listen on. If set to an empty
4425	string, it will listen on all addresses.
4426	</desc>
4427	</attribute>
4428
4429	<attribute name="teleporterPassword" type="wstring">
4430	<desc>
4431	The password the to check for on the target teleporter. This is just a
4432	very basic measure to prevent simple hacks and operators accidentally
4433	beaming a virtual machine to the wrong place.
4434	</desc>
4435	</attribute>
4436
4437	<attribute name="RTCUseUTC" type="boolean">
4438	<desc>
4439	When set to @a true, the RTC device of the virtual machine will run
4440	in UTC time, otherwise in local time. Especially Unix guests prefer
4441	the time in UTC.
4442	</desc>
4443	</attribute>
4444
4445	<attribute name="ioCacheEnabled" type="boolean">
4446	<desc>
4447	When set to @a true, the builtin I/O cache of the virtual machine
4448	will be enabled.
4449	</desc>
4450	</attribute>
4451
4452	<attribute name="ioCacheSize" type="unsigned long">
4453	<desc>
4454	Maximum size of the I/O cache in MB.
4455	</desc>
4456	</attribute>
4457
4458	<attribute name="ioBandwidthMax" type="unsigned long">
4459	<desc>
4460	The maximum number of MB the VM is allowed to transfer per second.
4461	0 means unlimited bandwidth.
4462	</desc>
4463	</attribute>
4464
4465	<method name="setBootOrder">
4466	<desc>
4467	Puts the given device to the specified position in
4468	the boot order.
4469
4470	To indicate that no device is associated with the given position,
4471	<link to="DeviceType_Null"/> should be used.
4472
4473	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4474
4475	<result name="E_INVALIDARG">
4476	Boot @a position out of range.
4477	</result>
4478	<result name="E_NOTIMPL">
4479	Booting from USB @a device currently not supported.
4480	</result>
4481
4482	</desc>
4483	<param name="position" type="unsigned long" dir="in">
4484	<desc>
4485	Position in the boot order (@c 1 to the total number of
4486	devices the machine can boot from, as returned by
4487	<link to="ISystemProperties::maxBootPosition"/>).
4488	</desc>
4489	</param>
4490	<param name="device" type="DeviceType" dir="in">
4491	<desc>
4492	The type of the device used to boot at the given position.
4493	</desc>
4494	</param>
4495	</method>
4496
4497	<method name="getBootOrder" const="yes">
4498	<desc>
4499	Returns the device type that occupies the specified
4500	position in the boot order.
4501
4502	@todo [remove?]
4503	If the machine can have more than one device of the returned type
4504	(such as hard disks), then a separate method should be used to
4505	retrieve the individual device that occupies the given position.
4506
4507	If here are no devices at the given position, then
4508	<link to="DeviceType_Null"/> is returned.
4509
4510	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4511
4512	<result name="E_INVALIDARG">
4513	Boot @a position out of range.
4514	</result>
4515
4516	</desc>
4517	<param name="position" type="unsigned long" dir="in">
4518	<desc>
4519	Position in the boot order (@c 1 to the total number of
4520	devices the machine can boot from, as returned by
4521	<link to="ISystemProperties::maxBootPosition"/>).
4522	</desc>
4523	</param>
4524	<param name="device" type="DeviceType" dir="return">
4525	<desc>
4526	Device at the given position.
4527	</desc>
4528	</param>
4529	</method>
4530
4531	<method name="attachDevice">
4532	<desc>
4533	Attaches a device and optionally mounts a medium to the given storage
4534	controller (<link to="IStorageController" />, identified by @a name),
4535	at the indicated port and device.
4536
4537	This method is intended for managing storage devices in general (it works
4538	for both fixed and removable media). For storage devices supporting removable
4539	media (such as DVDs and floppies), you can also use <link to="IMedium::mountMedium"/>
4540	for changing the media while the machine is running.
4541
4542	In a VM's default configuration of virtual machines, the secondary
4543	master of the IDE controller is used for a CD/DVD drive.
4544
4545	For fixed media such as hard disks, the given medium identifier cannot
4546	be a zero UUID. It may be a zero UUID for removable media such as DVDs
4547	and floppies.
4548
4549	After calling this returns successfully, a new instance of
4550	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4551	attachments (<link to="IMachine::mediumAttachments"/>).
4552
4553	The specified device slot must not have a device attached to it,
4554	or this method will fail.
4555
4556	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4557	information about attaching media.
4558
4559	<note>
4560	You cannot attach a device to a running machine. Also, you cannot
4561	attach a device to a newly created machine until this machine's
4562	settings are saved to disk using <link to="#saveSettings"/>.
4563	</note>
4564	<note>
4565	If the medium is being attached indirectly, a new differencing medium
4566	will implicitly be created for it and attached instead. If the
4567	changes made to the machine settings (including this indirect
4568	attachment) are later cancelled using <link to="#discardSettings"/>,
4569	this implicitly created differencing medium will implicitly
4570	be deleted.
4571	</note>
4572
4573	<result name="E_INVALIDARG">
4574	SATA device, SATA port, IDE port or IDE slot out of range.
4575	</result>
4576	<result name="VBOX_E_INVALID_OBJECT_STATE">
4577	Attempt to attach medium to an unregistered virtual machine.
4578	</result>
4579	<result name="VBOX_E_INVALID_VM_STATE">
4580	Invalid machine state.
4581	</result>
4582	<result name="VBOX_E_OBJECT_IN_USE">
4583	Hard disk already attached to this or another virtual machine.
4584	</result>
4585
4586	</desc>
4587	<param name="name" type="wstring" dir="in">
4588	<desc>Name of the storage controller to attach the device to.</desc>
4589	</param>
4590	<param name="controllerPort" type="long" dir="in">
4591	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4592	the primary controller and 1 specifies the secondary controller.
4593	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4594	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4595	</param>
4596	<param name="device" type="long" dir="in">
4597	<desc>Device slot in the given port to attach the device to. This is only
4598	relevant for IDE controllers, for which 0 specifies the master device and
4599	1 specifies the slave device. For all other controller types, this must
4600	be 0.</desc>
4601	</param>
4602	<param name="type" type="DeviceType" dir="in">
4603	<desc>Device type of the attached device.</desc>
4604	</param>
4605	<param name="id" type="uuid" mod="string" dir="in">
4606	<desc>UUID of the medium to mount. Zero UUID means do not mount any
4607	medium.</desc>
4608	</param>
4609	</method>
4610
4611	<method name="detachDevice">
4612	<desc>
4613	Detaches the device attached to a device slot of the specified bus.
4614
4615	Detaching the device from the virtual machine is deferred. This means
4616	that the medium remains associated with the machine when this method
4617	returns and gets actually de-associated only after a successful
4618	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4619	for more detailed information about attaching media.
4620
4621	<note>
4622	You cannot detach a device from a running machine.
4623	</note>
4624	<note>
4625	Detaching differencing media implicitly created by <link
4626	to="#attachDevice"/> for the indirect attachment using this
4627	method will <b>not</b> implicitly delete them. The
4628	<link to="IMedium::deleteStorage"/> operation should be
4629	explicitly performed by the caller after the medium is successfully
4630	detached and the settings are saved with
4631	<link to="#saveSettings"/>, if it is the desired action.
4632	</note>
4633
4634	<result name="VBOX_E_INVALID_VM_STATE">
4635	Attempt to detach medium from a running virtual machine.
4636	</result>
4637	<result name="VBOX_E_OBJECT_NOT_FOUND">
4638	No medium attached to given slot/bus.
4639	</result>
4640	<result name="VBOX_E_NOT_SUPPORTED">
4641	Medium format does not support storage deletion.
4642	</result>
4643
4644	</desc>
4645	<param name="name" type="wstring" dir="in">
4646	<desc>Name of the storage controller to detach the medium from.</desc>
4647	</param>
4648	<param name="controllerPort" type="long" dir="in">
4649	<desc>Port number to detach the medium from.</desc>
4650	</param>
4651	<param name="device" type="long" dir="in">
4652	<desc>Device slot number to detach the medium from.</desc>
4653	</param>
4654	</method>
4655
4656	<method name="passthroughDevice">
4657	<desc>
4658	Sets the passthrough mode of an existing DVD device. Changing the
4659	setting while the VM is running is forbidden. The setting is only used
4660	if at VM start the device is configured as a host DVD drive, in all
4661	other cases it is ignored. The device must already exist; see
4662	<link to="IMachine::attachDevice"/> for how to attach a new device.
4663
4664	The @a controllerPort and @a device parameters specify the device slot and
4665	have have the same meaning as with <link to="IMachine::attachDevice" />.
4666
4667	<result name="E_INVALIDARG">
4668	SATA device, SATA port, IDE port or IDE slot out of range.
4669	</result>
4670	<result name="VBOX_E_INVALID_OBJECT_STATE">
4671	Attempt to modify an unregistered virtual machine.
4672	</result>
4673	<result name="VBOX_E_INVALID_VM_STATE">
4674	Invalid machine state.
4675	</result>
4676
4677	</desc>
4678	<param name="name" type="wstring" dir="in">
4679	<desc>Name of the storage controller.</desc>
4680	</param>
4681	<param name="controllerPort" type="long" dir="in">
4682	<desc>Storage controller port.</desc>
4683	</param>
4684	<param name="device" type="long" dir="in">
4685	<desc>Device slot in the given port.</desc>
4686	</param>
4687	<param name="passthrough" type="boolean" dir="in">
4688	<desc>New value for the passthrough setting.</desc>
4689	</param>
4690	</method>
4691
4692	<method name="mountMedium">
4693	<desc>
4694	Mounts a medium (<link to="IMedium" />, identified
4695	by the given UUID @a id) to the given storage controller
4696	(<link to="IStorageController" />, identified by @a name),
4697	at the indicated port and device. The device must already exist;
4698	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4699
4700	This method is intended only for managing removable media, where the
4701	device is fixed but media is changeable at runtime (such as DVDs
4702	and floppies). It cannot be used for fixed media such as hard disks.
4703
4704	The @a controllerPort and @a device parameters specify the device slot and
4705	have have the same meaning as with <link to="IMachine::attachDevice" />.
4706
4707	The specified device slot can have a medium mounted, which will be
4708	unmounted first. Specifying a zero UUID (or an empty string) for
4709	@a medium does just an unmount.
4710
4711	See <link to="IMedium"/> for more detailed information about
4712	attaching media.
4713
4714	<result name="E_INVALIDARG">
4715	SATA device, SATA port, IDE port or IDE slot out of range.
4716	</result>
4717	<result name="VBOX_E_INVALID_OBJECT_STATE">
4718	Attempt to attach medium to an unregistered virtual machine.
4719	</result>
4720	<result name="VBOX_E_INVALID_VM_STATE">
4721	Invalid machine state.
4722	</result>
4723	<result name="VBOX_E_OBJECT_IN_USE">
4724	Medium already attached to this or another virtual machine.
4725	</result>
4726
4727	</desc>
4728	<param name="name" type="wstring" dir="in">
4729	<desc>Name of the storage controller to attach the medium to.</desc>
4730	</param>
4731	<param name="controllerPort" type="long" dir="in">
4732	<desc>Port to attach the medium to.</desc>
4733	</param>
4734	<param name="device" type="long" dir="in">
4735	<desc>Device slot in the given port to attach the medium to.</desc>
4736	</param>
4737	<param name="medium" type="uuid" mod="string" dir="in">
4738	<desc>UUID of the medium to attach. A zero UUID means unmount the
4739	currently mounted medium.</desc>
4740	</param>
4741	<param name="force" type="boolean" dir="in">
4742	<desc>Allows to force unmount/mount of a medium which is locked by
4743	theDevice slot in the given port to attach the medium to.</desc>
4744	</param>
4745	</method>
4746
4747	<method name="getMedium" const="yes">
4748	<desc>
4749	Returns the virtual medium attached to a device slot of the specified
4750	bus.
4751
4752	Note that if the medium was indirectly attached by
4753	<link to="#mountMedium"/> to the given device slot then this
4754	method will return not the same object as passed to the
4755	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4756	more detailed information about mounting a medium.
4757
4758	<result name="VBOX_E_OBJECT_NOT_FOUND">
4759	No medium attached to given slot/bus.
4760	</result>
4761
4762	</desc>
4763	<param name="name" type="wstring" dir="in">
4764	<desc>Name of the storage controller the medium is attached to.</desc>
4765	</param>
4766	<param name="controllerPort" type="long" dir="in">
4767	<desc>Port to query.</desc>
4768	</param>
4769	<param name="device" type="long" dir="in">
4770	<desc>Device slot in the given port to query.</desc>
4771	</param>
4772	<param name="medium" type="IMedium" dir="return">
4773	<desc>Attached medium object.</desc>
4774	</param>
4775	</method>
4776
4777	<method name="getMediumAttachmentsOfController" const="yes">
4778	<desc>
4779	Returns an array of medium attachments which are attached to the
4780	the controller with the given name.
4781
4782	<result name="VBOX_E_OBJECT_NOT_FOUND">
4783	A storage controller with given name doesn't exist.
4784	</result>
4785	</desc>
4786	<param name="name" type="wstring" dir="in"/>
4787	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4788	</method>
4789
4790	<method name="getMediumAttachment" const="yes">
4791	<desc>
4792	Returns a medium attachment which corresponds to the controller with
4793	the given name, on the given port and device slot.
4794
4795	<result name="VBOX_E_OBJECT_NOT_FOUND">
4796	No attachment exists for the given controller/port/device combination.
4797	</result>
4798	</desc>
4799	<param name="name" type="wstring" dir="in"/>
4800	<param name="controllerPort" type="long" dir="in"/>
4801	<param name="device" type="long" dir="in"/>
4802	<param name="attachment" type="IMediumAttachment" dir="return"/>
4803	</method>
4804
4805	<method name="getNetworkAdapter" const="yes">
4806	<desc>
4807	Returns the network adapter associated with the given slot.
4808	Slots are numbered sequentially, starting with zero. The total
4809	number of adapters per machine is defined by the
4810	<link to="ISystemProperties::networkAdapterCount"/> property,
4811	so the maximum slot number is one less than that property's value.
4812
4813	<result name="E_INVALIDARG">
4814	Invalid @a slot number.
4815	</result>
4816
4817	</desc>
4818	<param name="slot" type="unsigned long" dir="in"/>
4819	<param name="adapter" type="INetworkAdapter" dir="return"/>
4820	</method>
4821
4822	<method name="addStorageController">
4823	<desc>
4824	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4825	machine and returns it as an instance of
4826	<link to="IStorageController" />.
4827
4828	@a name identifies the controller for subsequent calls such as
4829	<link to="#getStorageControllerByName" />,
4830	<link to="#getStorageControllerByInstance" />,
4831	<link to="#removeStorageController" />,
4832	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4833
4834	After the controller has been added, you can set its exact
4835	type by setting the <link to="IStorageController::controllerType" />.
4836
4837	<result name="VBOX_E_OBJECT_IN_USE">
4838	A storage controller with given name exists already.
4839	</result>
4840	<result name="E_INVALIDARG">
4841	Invalid @a controllerType.
4842	</result>
4843	</desc>
4844	<param name="name" type="wstring" dir="in"/>
4845	<param name="connectionType" type="StorageBus" dir="in"/>
4846	<param name="controller" type="IStorageController" dir="return"/>
4847	</method>
4848
4849	<method name="getStorageControllerByName" const="yes">
4850	<desc>
4851	Returns a storage controller with the given name.
4852
4853	<result name="VBOX_E_OBJECT_NOT_FOUND">
4854	A storage controller with given name doesn't exist.
4855	</result>
4856	</desc>
4857	<param name="name" type="wstring" dir="in"/>
4858	<param name="storageController" type="IStorageController" dir="return"/>
4859	</method>
4860
4861	<method name="getStorageControllerByInstance" const="yes">
4862	<desc>
4863	Returns a storage controller with the given instance number.
4864
4865	<result name="VBOX_E_OBJECT_NOT_FOUND">
4866	A storage controller with given instance number doesn't exist.
4867	</result>
4868	</desc>
4869	<param name="instance" type="unsigned long" dir="in"/>
4870	<param name="storageController" type="IStorageController" dir="return"/>
4871	</method>
4872
4873	<method name="removeStorageController">
4874	<desc>
4875	Removes a storage controller from the machine.
4876
4877	<result name="VBOX_E_OBJECT_NOT_FOUND">
4878	A storage controller with given name doesn't exist.
4879	</result>
4880	</desc>
4881	<param name="name" type="wstring" dir="in"/>
4882	</method>
4883
4884	<method name="getSerialPort" const="yes">
4885	<desc>
4886	Returns the serial port associated with the given slot.
4887	Slots are numbered sequentially, starting with zero. The total
4888	number of serial ports per machine is defined by the
4889	<link to="ISystemProperties::serialPortCount"/> property,
4890	so the maximum slot number is one less than that property's value.
4891
4892	<result name="E_INVALIDARG">
4893	Invalid @a slot number.
4894	</result>
4895
4896	</desc>
4897	<param name="slot" type="unsigned long" dir="in"/>
4898	<param name="port" type="ISerialPort" dir="return"/>
4899	</method>
4900
4901	<method name="getParallelPort" const="yes">
4902	<desc>
4903	Returns the parallel port associated with the given slot.
4904	Slots are numbered sequentially, starting with zero. The total
4905	number of parallel ports per machine is defined by the
4906	<link to="ISystemProperties::parallelPortCount"/> property,
4907	so the maximum slot number is one less than that property's value.
4908
4909	<result name="E_INVALIDARG">
4910	Invalid @a slot number.
4911	</result>
4912
4913	</desc>
4914	<param name="slot" type="unsigned long" dir="in"/>
4915	<param name="port" type="IParallelPort" dir="return"/>
4916	</method>
4917
4918	<method name="getExtraDataKeys">
4919	<desc>
4920	Returns an array representing the machine-specific extra data keys
4921	which currently have values defined.
4922	</desc>
4923	<param name="value" type="wstring" dir="return" safearray="yes">
4924	<desc>Array of extra data keys.</desc>
4925	</param>
4926	</method>
4927
4928	<method name="getExtraData">
4929	<desc>
4930	Returns associated machine-specific extra data.
4931
4932	If the requested data @a key does not exist, this function will
4933	succeed and return an empty string in the @a value argument.
4934
4935	<result name="VBOX_E_FILE_ERROR">
4936	Settings file not accessible.
4937	</result>
4938	<result name="VBOX_E_XML_ERROR">
4939	Could not parse the settings file.
4940	</result>
4941
4942	</desc>
4943	<param name="key" type="wstring" dir="in">
4944	<desc>Name of the data key to get.</desc>
4945	</param>
4946	<param name="value" type="wstring" dir="return">
4947	<desc>Value of the requested data key.</desc>
4948	</param>
4949	</method>
4950
4951	<method name="setExtraData">
4952	<desc>
4953	Sets associated machine-specific extra data.
4954
4955	If you pass @c null or an empty string as a key @a value, the given
4956	@a key will be deleted.
4957
4958	<note>
4959	Before performing the actual data change, this method will ask all
4960	registered listeners using the
4961	<link to="IExtraDataCanChangeEvent"/>
4962	notification for a permission. If one of the listeners refuses the
4963	new value, the change will not be performed.
4964	</note>
4965	<note>
4966	On success, the
4967	<link to="IExtraDataChangedEvent"/> notification
4968	is called to inform all registered listeners about a successful data
4969	change.
4970	</note>
4971	<note>
4972	This method can be called outside the machine session and therefore
4973	it's a caller's responsibility to handle possible race conditions
4974	when several clients change the same key at the same time.
4975	</note>
4976
4977	<result name="VBOX_E_FILE_ERROR">
4978	Settings file not accessible.
4979	</result>
4980	<result name="VBOX_E_XML_ERROR">
4981	Could not parse the settings file.
4982	</result>
4983
4984	</desc>
4985	<param name="key" type="wstring" dir="in">
4986	<desc>Name of the data key to set.</desc>
4987	</param>
4988	<param name="value" type="wstring" dir="in">
4989	<desc>Value to assign to the key.</desc>
4990	</param>
4991	</method>
4992
4993	<method name="getCPUProperty" const="yes">
4994	<desc>
4995	Returns the virtual CPU boolean value of the specified property.
4996
4997	<result name="E_INVALIDARG">
4998	Invalid property.
4999	</result>
5000
5001	</desc>
5002	<param name="property" type="CPUPropertyType" dir="in">
5003	<desc>
5004	Property type to query.
5005	</desc>
5006	</param>
5007	<param name="value" type="boolean" dir="return">
5008	<desc>
5009	Property value.
5010	</desc>
5011	</param>
5012	</method>
5013
5014	<method name="setCPUProperty">
5015	<desc>
5016	Sets the virtual CPU boolean value of the specified property.
5017
5018	<result name="E_INVALIDARG">
5019	Invalid property.
5020	</result>
5021
5022	</desc>
5023	<param name="property" type="CPUPropertyType" dir="in">
5024	<desc>
5025	Property type to query.
5026	</desc>
5027	</param>
5028	<param name="value" type="boolean" dir="in">
5029	<desc>
5030	Property value.
5031	</desc>
5032	</param>
5033	</method>
5034
5035	<method name="getCPUIDLeaf" const="yes">
5036	<desc>
5037	Returns the virtual CPU cpuid information for the specified leaf.
5038
5039	Currently supported index values for cpuid:
5040	Standard CPUID leafs: 0 - 0xA
5041	Extended CPUID leafs: 0x80000000 - 0x8000000A
5042
5043	See the Intel and AMD programmer's manuals for detailed information
5044	about the cpuid instruction and its leafs.
5045	<result name="E_INVALIDARG">
5046	Invalid id.
5047	</result>
5048
5049	</desc>
5050	<param name="id" type="unsigned long" dir="in">
5051	<desc>
5052	CPUID leaf index.
5053	</desc>
5054	</param>
5055	<param name="valEax" type="unsigned long" dir="out">
5056	<desc>
5057	CPUID leaf value for register eax.
5058	</desc>
5059	</param>
5060	<param name="valEbx" type="unsigned long" dir="out">
5061	<desc>
5062	CPUID leaf value for register ebx.
5063	</desc>
5064	</param>
5065	<param name="valEcx" type="unsigned long" dir="out">
5066	<desc>
5067	CPUID leaf value for register ecx.
5068	</desc>
5069	</param>
5070	<param name="valEdx" type="unsigned long" dir="out">
5071	<desc>
5072	CPUID leaf value for register edx.
5073	</desc>
5074	</param>
5075	</method>
5076
5077	<method name="setCPUIDLeaf">
5078	<desc>
5079	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5080	are not passed unmodified. VirtualBox clears features that it doesn't support.
5081
5082	Currently supported index values for cpuid:
5083	Standard CPUID leafs: 0 - 0xA
5084	Extended CPUID leafs: 0x80000000 - 0x8000000A
5085
5086	See the Intel and AMD programmer's manuals for detailed information
5087	about the cpuid instruction and its leafs.
5088
5089	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5090	random crashes inside VMs.
5091	<result name="E_INVALIDARG">
5092	Invalid id.
5093	</result>
5094
5095	</desc>
5096	<param name="id" type="unsigned long" dir="in">
5097	<desc>
5098	CPUID leaf index.
5099	</desc>
5100	</param>
5101	<param name="valEax" type="unsigned long" dir="in">
5102	<desc>
5103	CPUID leaf value for register eax.
5104	</desc>
5105	</param>
5106	<param name="valEbx" type="unsigned long" dir="in">
5107	<desc>
5108	CPUID leaf value for register ebx.
5109	</desc>
5110	</param>
5111	<param name="valEcx" type="unsigned long" dir="in">
5112	<desc>
5113	CPUID leaf value for register ecx.
5114	</desc>
5115	</param>
5116	<param name="valEdx" type="unsigned long" dir="in">
5117	<desc>
5118	CPUID leaf value for register edx.
5119	</desc>
5120	</param>
5121	</method>
5122
5123	<method name="removeCPUIDLeaf">
5124	<desc>
5125	Removes the virtual CPU cpuid leaf for the specified index
5126
5127	<result name="E_INVALIDARG">
5128	Invalid id.
5129	</result>
5130
5131	</desc>
5132	<param name="id" type="unsigned long" dir="in">
5133	<desc>
5134	CPUID leaf index.
5135	</desc>
5136	</param>
5137	</method>
5138
5139	<method name="removeAllCPUIDLeaves">
5140	<desc>
5141	Removes all the virtual CPU cpuid leaves
5142	</desc>
5143	</method>
5144
5145	<method name="getHWVirtExProperty" const="yes">
5146	<desc>
5147	Returns the value of the specified hardware virtualization boolean property.
5148
5149	<result name="E_INVALIDARG">
5150	Invalid property.
5151	</result>
5152
5153	</desc>
5154	<param name="property" type="HWVirtExPropertyType" dir="in">
5155	<desc>
5156	Property type to query.
5157	</desc>
5158	</param>
5159	<param name="value" type="boolean" dir="return">
5160	<desc>
5161	Property value.
5162	</desc>
5163	</param>
5164	</method>
5165
5166	<method name="setHWVirtExProperty">
5167	<desc>
5168	Sets a new value for the specified hardware virtualization boolean property.
5169
5170	<result name="E_INVALIDARG">
5171	Invalid property.
5172	</result>
5173
5174	</desc>
5175	<param name="property" type="HWVirtExPropertyType" dir="in">
5176	<desc>
5177	Property type to set.
5178	</desc>
5179	</param>
5180	<param name="value" type="boolean" dir="in">
5181	<desc>
5182	New property value.
5183	</desc>
5184	</param>
5185	</method>
5186
5187	<method name="saveSettings">
5188	<desc>
5189	Saves any changes to machine settings made since the session
5190	has been opened or a new machine has been created, or since the
5191	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5192	For registered machines, new settings become visible to all
5193	other VirtualBox clients after successful invocation of this
5194	method.
5195	<note>
5196	The method sends <link to="IMachineDataChangedEvent"/>
5197	notification event after the configuration has been successfully
5198	saved (only for registered machines).
5199	</note>
5200	<note>
5201	Calling this method is only valid on instances returned
5202	by <link to="ISession::machine"/> and on new machines
5203	created by <link to="IVirtualBox::createMachine"/> but not
5204	yet registered, or on unregistered machines after calling
5205	<link to="IVirtualBox::unregisterMachine"/>.
5206	</note>
5207
5208	<result name="VBOX_E_FILE_ERROR">
5209	Settings file not accessible.
5210	</result>
5211	<result name="VBOX_E_XML_ERROR">
5212	Could not parse the settings file.
5213	</result>
5214	<result name="E_ACCESSDENIED">
5215	Modification request refused.
5216	</result>
5217
5218	</desc>
5219	</method>
5220
5221	<method name="discardSettings">
5222	<desc>
5223	Discards any changes to the machine settings made since the session
5224	has been opened or since the last call to <link to="#saveSettings"/>
5225	or <link to="#discardSettings"/>.
5226	<note>
5227	Calling this method is only valid on instances returned
5228	by <link to="ISession::machine"/> and on new machines
5229	created by <link to="IVirtualBox::createMachine"/> or
5230	opened by <link to="IVirtualBox::openMachine"/> but not
5231	yet registered, or on unregistered machines after calling
5232	<link to="IVirtualBox::unregisterMachine"/>.
5233	</note>
5234
5235	<result name="VBOX_E_INVALID_VM_STATE">
5236	Virtual machine is not mutable.
5237	</result>
5238
5239	</desc>
5240	</method>
5241
5242	<method name="deleteSettings">
5243	<desc>
5244	Deletes the settings file of this machine from disk.
5245	The machine must not be registered in order for this operation
5246	to succeed.
5247	<note>
5248	<link to="#settingsModified"/> will return @c true after this
5249	method successfully returns.
5250	</note>
5251	<note>
5252	Calling this method is only valid on instances returned
5253	by <link to="ISession::machine"/> and on new machines
5254	created by <link to="IVirtualBox::createMachine"/> or
5255	opened by <link to="IVirtualBox::openMachine"/> but not
5256	yet registered, or on unregistered machines after calling
5257	<link to="IVirtualBox::unregisterMachine"/>.
5258	</note>
5259	<note>
5260	The deleted machine settings file can be restored (saved again)
5261	by calling <link to="#saveSettings"/>.
5262	</note>
5263
5264	<result name="VBOX_E_INVALID_VM_STATE">
5265	Cannot delete settings of a registered machine or
5266	machine not mutable.
5267	</result>
5268	<result name="VBOX_E_IPRT_ERROR">
5269	Could not delete the settings file.
5270	</result>
5271
5272	</desc>
5273	</method>
5274
5275	<method name="export">
5276	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5277	steps required to export VirtualBox machines to OVF.
5278	</desc>
5279
5280	<param name="aAppliance" type="IAppliance" dir="in">
5281	<desc>Appliance to export this machine to.</desc>
5282	</param>
5283	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5284	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5285	</param>
5286	</method >
5287
5288	<method name="getSnapshot">
5289	<desc>
5290	Returns a snapshot of this machine with the given UUID.
5291	A @c null UUID can be used to obtain the first snapshot
5292	taken on this machine. This is useful if you want to traverse
5293	the whole tree of snapshots starting from the root.
5294
5295	<result name="VBOX_E_OBJECT_NOT_FOUND">
5296	Virtual machine has no snapshots or snapshot not found.
5297	</result>
5298
5299	</desc>
5300	<param name="id" type="uuid" mod="string" dir="in">
5301	<desc>UUID of the snapshot to get</desc>
5302	</param>
5303	<param name="snapshot" type="ISnapshot" dir="return">
5304	<desc>Snapshot object with the given UUID.</desc>
5305	</param>
5306	</method>
5307
5308	<method name="findSnapshot">
5309	<desc>
5310	Returns a snapshot of this machine with the given name.
5311
5312	<result name="VBOX_E_OBJECT_NOT_FOUND">
5313	Virtual machine has no snapshots or snapshot not found.
5314	</result>
5315
5316	</desc>
5317	<param name="name" type="wstring" dir="in">
5318	<desc>Name of the snapshot to find</desc>
5319	</param>
5320	<param name="snapshot" type="ISnapshot" dir="return">
5321	<desc>Snapshot object with the given name.</desc>
5322	</param>
5323	</method>
5324
5325	<method name="setCurrentSnapshot">
5326	<desc>
5327	Sets the current snapshot of this machine.
5328	<note>
5329	In the current implementation, this operation is not
5330	implemented.
5331	</note>
5332	</desc>
5333	<param name="id" type="uuid" mod="string" dir="in">
5334	<desc>UUID of the snapshot to set as the current snapshot.</desc>
5335	</param>
5336	</method>
5337
5338	<method name="createSharedFolder">
5339	<desc>
5340	Creates a new permanent shared folder by associating the given logical
5341	name with the given host path, adds it to the collection of shared
5342	folders and starts sharing it. Refer to the description of
5343	<link to="ISharedFolder"/> to read more about logical names.
5344
5345	<result name="VBOX_E_OBJECT_IN_USE">
5346	Shared folder already exists.
5347	</result>
5348	<result name="VBOX_E_FILE_ERROR">
5349	Shared folder @a hostPath not accessible.
5350	</result>
5351
5352	</desc>
5353	<param name="name" type="wstring" dir="in">
5354	<desc>Unique logical name of the shared folder.</desc>
5355	</param>
5356	<param name="hostPath" type="wstring" dir="in">
5357	<desc>Full path to the shared folder in the host file system.</desc>
5358	</param>
5359	<param name="writable" type="boolean" dir="in">
5360	<desc>Whether the share is writable or readonly</desc>
5361	</param>
5362	</method>
5363
5364	<method name="removeSharedFolder">
5365	<desc>
5366	Removes the permanent shared folder with the given name previously
5367	created by <link to="#createSharedFolder"/> from the collection of
5368	shared folders and stops sharing it.
5369
5370	<result name="VBOX_E_INVALID_VM_STATE">
5371	Virtual machine is not mutable.
5372	</result>
5373	<result name="VBOX_E_OBJECT_NOT_FOUND">
5374	Shared folder @a name does not exist.
5375	</result>
5376
5377	</desc>
5378	<param name="name" type="wstring" dir="in">
5379	<desc>Logical name of the shared folder to remove.</desc>
5380	</param>
5381	</method>
5382
5383	<method name="canShowConsoleWindow">
5384	<desc>
5385	Returns @c true if the VM console process can activate the
5386	console window and bring it to foreground on the desktop of
5387	the host PC.
5388	<note>
5389	This method will fail if a session for this machine is not
5390	currently open.
5391	</note>
5392
5393	<result name="VBOX_E_INVALID_VM_STATE">
5394	Machine session is not open.
5395	</result>
5396
5397	</desc>
5398	<param name="canShow" type="boolean" dir="return">
5399	<desc>
5400	@c true if the console window can be shown and @c false otherwise.
5401	</desc>
5402	</param>
5403	</method>
5404
5405	<method name="showConsoleWindow">
5406	<desc>
5407	Activates the console window and brings it to foreground on
5408	the desktop of the host PC. Many modern window managers on
5409	many platforms implement some sort of focus stealing
5410	prevention logic, so that it may be impossible to activate
5411	a window without the help of the currently active
5412	application. In this case, this method will return a non-zero
5413	identifier that represents the top-level window of the VM
5414	console process. The caller, if it represents a currently
5415	active process, is responsible to use this identifier (in a
5416	platform-dependent manner) to perform actual window
5417	activation.
5418	<note>
5419	This method will fail if a session for this machine is not
5420	currently open.
5421	</note>
5422
5423	<result name="VBOX_E_INVALID_VM_STATE">
5424	Machine session is not open.
5425	</result>
5426
5427	</desc>
5428	<param name="winId" type="unsigned long long" dir="return">
5429	<desc>
5430	Platform-dependent identifier of the top-level VM console
5431	window, or zero if this method has performed all actions
5432	necessary to implement the <i>show window</i> semantics for
5433	the given platform and/or VirtualBox front-end.
5434	</desc>
5435	</param>
5436	</method>
5437
5438	<method name="getGuestProperty" const="yes">
5439	<desc>
5440	Reads an entry from the machine's guest property store.
5441
5442	<result name="VBOX_E_INVALID_VM_STATE">
5443	Machine session is not open.
5444	</result>
5445
5446	</desc>
5447	<param name="name" type="wstring" dir="in">
5448	<desc>
5449	The name of the property to read.
5450	</desc>
5451	</param>
5452	<param name="value" type="wstring" dir="out">
5453	<desc>
5454	The value of the property. If the property does not exist then this
5455	will be empty.
5456	</desc>
5457	</param>
5458	<param name="timestamp" type="unsigned long long" dir="out">
5459	<desc>
5460	The time at which the property was last modified, as seen by the
5461	server process.
5462	</desc>
5463	</param>
5464	<param name="flags" type="wstring" dir="out">
5465	<desc>
5466	Additional property parameters, passed as a comma-separated list of
5467	"name=value" type entries.
5468	</desc>
5469	</param>
5470	</method>
5471
5472	<method name="getGuestPropertyValue" const="yes">
5473	<desc>
5474	Reads a value from the machine's guest property store.
5475
5476	<result name="VBOX_E_INVALID_VM_STATE">
5477	Machine session is not open.
5478	</result>
5479
5480	</desc>
5481	<param name="property" type="wstring" dir="in">
5482	<desc>
5483	The name of the property to read.
5484	</desc>
5485	</param>
5486	<param name="value" type="wstring" dir="return">
5487	<desc>
5488	The value of the property. If the property does not exist then this
5489	will be empty.
5490	</desc>
5491	</param>
5492	</method>
5493
5494	<method name="getGuestPropertyTimestamp" const="yes">
5495	<desc>
5496	Reads a property timestamp from the machine's guest property store.
5497
5498	<result name="VBOX_E_INVALID_VM_STATE">
5499	Machine session is not open.
5500	</result>
5501
5502	</desc>
5503	<param name="property" type="wstring" dir="in">
5504	<desc>
5505	The name of the property to read.
5506	</desc>
5507	</param>
5508	<param name="value" type="unsigned long long" dir="return">
5509	<desc>
5510	The timestamp. If the property does not exist then this will be
5511	empty.
5512	</desc>
5513	</param>
5514	</method>
5515
5516	<method name="setGuestProperty">
5517	<desc>
5518	Sets, changes or deletes an entry in the machine's guest property
5519	store.
5520
5521	<result name="E_ACCESSDENIED">
5522	Property cannot be changed.
5523	</result>
5524	<result name="E_INVALIDARG">
5525	Invalid @a flags.
5526	</result>
5527	<result name="VBOX_E_INVALID_VM_STATE">
5528	Virtual machine is not mutable or session not open.
5529	</result>
5530	<result name="VBOX_E_INVALID_OBJECT_STATE">
5531	Cannot set transient property when machine not running.
5532	</result>
5533
5534	</desc>
5535	<param name="property" type="wstring" dir="in">
5536	<desc>
5537	The name of the property to set, change or delete.
5538	</desc>
5539	</param>
5540	<param name="value" type="wstring" dir="in">
5541	<desc>
5542	The new value of the property to set, change or delete. If the
5543	property does not yet exist and value is non-empty, it will be
5544	created. If the value is @c null or empty, the property will be
5545	deleted if it exists.
5546	</desc>
5547	</param>
5548	<param name="flags" type="wstring" dir="in">
5549	<desc>
5550	Additional property parameters, passed as a comma-separated list of
5551	"name=value" type entries.
5552	</desc>
5553	</param>
5554	</method>
5555
5556	<method name="setGuestPropertyValue">
5557	<desc>
5558	Sets, changes or deletes a value in the machine's guest property
5559	store. The flags field will be left unchanged or created empty for a
5560	new property.
5561
5562	<result name="E_ACCESSDENIED">
5563	Property cannot be changed.
5564	</result>
5565	<result name="VBOX_E_INVALID_VM_STATE">
5566	Virtual machine is not mutable or session not open.
5567	</result>
5568	<result name="VBOX_E_INVALID_OBJECT_STATE">
5569	Cannot set transient property when machine not running.
5570	</result>
5571	</desc>
5572
5573	<param name="property" type="wstring" dir="in">
5574	<desc>
5575	The name of the property to set, change or delete.
5576	</desc>
5577	</param>
5578	<param name="value" type="wstring" dir="in">
5579	<desc>
5580	The new value of the property to set, change or delete. If the
5581	property does not yet exist and value is non-empty, it will be
5582	created. If the value is @c null or empty, the property will be
5583	deleted if it exists.
5584	</desc>
5585	</param>
5586	</method>
5587
5588	<method name="enumerateGuestProperties">
5589	<desc>
5590	Return a list of the guest properties matching a set of patterns along
5591	with their values, time stamps and flags.
5592	</desc>
5593	<param name="patterns" type="wstring" dir="in">
5594	<desc>
5595	The patterns to match the properties against, separated by '\|'
5596	characters. If this is empty or @c null, all properties will match.
5597	</desc>
5598	</param>
5599	<param name="name" type="wstring" dir="out" safearray="yes">
5600	<desc>
5601	The names of the properties returned.
5602	</desc>
5603	</param>
5604	<param name="value" type="wstring" dir="out" safearray="yes">
5605	<desc>
5606	The values of the properties returned. The array entries match the
5607	corresponding entries in the @a name array.
5608	</desc>
5609	</param>
5610	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
5611	<desc>
5612	The time stamps of the properties returned. The array entries match
5613	the corresponding entries in the @a name array.
5614	</desc>
5615	</param>
5616	<param name="flags" type="wstring" dir="out" safearray="yes">
5617	<desc>
5618	The flags of the properties returned. The array entries match the
5619	corresponding entries in the @a name array.
5620	</desc>
5621	</param>
5622	</method>
5623
5624	<method name="querySavedThumbnailSize">
5625	<desc>
5626	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5627	</desc>
5628	<param name="screenId" type="unsigned long" dir="in">
5629	<desc>
5630	Saved guest screen to query info from.
5631	</desc>
5632	</param>
5633	<param name="size" type="unsigned long" dir="out">
5634	<desc>
5635	Size of buffer required to store the bitmap.
5636	</desc>
5637	</param>
5638	<param name="width" type="unsigned long" dir="out">
5639	<desc>
5640	Bitmap width.
5641	</desc>
5642	</param>
5643	<param name="height" type="unsigned long" dir="out">
5644	<desc>
5645	Bitmap height.
5646	</desc>
5647	</param>
5648	</method>
5649
5650	<method name="readSavedThumbnailToArray">
5651	<desc>
5652	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5653	</desc>
5654	<param name="screenId" type="unsigned long" dir="in">
5655	<desc>
5656	Saved guest screen to read from.
5657	</desc>
5658	</param>
5659	<param name="BGR" type="boolean" dir="in">
5660	<desc>
5661	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5662	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5663	</desc>
5664	</param>
5665	<param name="width" type="unsigned long" dir="out">
5666	<desc>
5667	Bitmap width.
5668	</desc>
5669	</param>
5670	<param name="height" type="unsigned long" dir="out">
5671	<desc>
5672	Bitmap height.
5673	</desc>
5674	</param>
5675	<param name="data" type="octet" dir="return" safearray="yes">
5676	<desc>
5677	Array with resulting bitmap data.
5678	</desc>
5679	</param>
5680	</method>
5681
5682	<method name="querySavedScreenshotPNGSize">
5683	<desc>
5684	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5685	</desc>
5686	<param name="screenId" type="unsigned long" dir="in">
5687	<desc>
5688	Saved guest screen to query info from.
5689	</desc>
5690	</param>
5691	<param name="size" type="unsigned long" dir="out">
5692	<desc>
5693	Size of buffer required to store the PNG binary data.
5694	</desc>
5695	</param>
5696	<param name="width" type="unsigned long" dir="out">
5697	<desc>
5698	Image width.
5699	</desc>
5700	</param>
5701	<param name="height" type="unsigned long" dir="out">
5702	<desc>
5703	Image height.
5704	</desc>
5705	</param>
5706	</method>
5707
5708	<method name="readSavedScreenshotPNGToArray">
5709	<desc>
5710	Screenshot in PNG format is retrieved to an array of bytes.
5711	</desc>
5712	<param name="screenId" type="unsigned long" dir="in">
5713	<desc>
5714	Saved guest screen to read from.
5715	</desc>
5716	</param>
5717	<param name="width" type="unsigned long" dir="out">
5718	<desc>
5719	Image width.
5720	</desc>
5721	</param>
5722	<param name="height" type="unsigned long" dir="out">
5723	<desc>
5724	Image height.
5725	</desc>
5726	</param>
5727	<param name="data" type="octet" dir="return" safearray="yes">
5728	<desc>
5729	Array with resulting PNG data.
5730	</desc>
5731	</param>
5732	</method>
5733
5734	<method name="hotPlugCPU">
5735	<desc>
5736	Plugs a CPU into the machine.
5737	</desc>
5738	<param name="cpu" type="unsigned long" dir="in">
5739	<desc>
5740	The CPU id to insert.
5741	</desc>
5742	</param>
5743	</method>
5744
5745	<method name="hotUnplugCPU">
5746	<desc>
5747	Removes a CPU from the machine.
5748	</desc>
5749	<param name="cpu" type="unsigned long" dir="in">
5750	<desc>
5751	The CPU id to remove.
5752	</desc>
5753	</param>
5754	</method>
5755
5756	<method name="getCPUStatus">
5757	<desc>
5758	Returns the current status of the given CPU.
5759	</desc>
5760	<param name="cpu" type="unsigned long" dir="in">
5761	<desc>
5762	The CPU id to check for.
5763	</desc>
5764	</param>
5765	<param name="attached" type="boolean" dir="return">
5766	<desc>
5767	Status of the CPU.
5768	</desc>
5769	</param>
5770	</method>
5771
5772	<method name="queryLogFilename">
5773	<desc>
5774	Queries for the VM log file name of an given index. Returns an empty
5775	string if a log file with that index doesn't exists.
5776	</desc>
5777	<param name="idx" type="unsigned long" dir="in">
5778	<desc>
5779	Which log file name to query. 0=current log file.
5780	</desc>
5781	</param>
5782	<param name="filename" type="wstring" dir="return">
5783	<desc>
5784	On return the full path to the log file or an empty string on error.
5785	</desc>
5786	</param>
5787	</method>
5788
5789	<method name="readLog">
5790	<desc>
5791	Reads the VM log file. The chunk size is limited, so even if you
5792	ask for a big piece there might be less data returned.
5793	</desc>
5794	<param name="idx" type="unsigned long" dir="in">
5795	<desc>
5796	Which log file to read. 0=current log file.
5797	</desc>
5798	</param>
5799	<param name="offset" type="unsigned long long" dir="in">
5800	<desc>
5801	Offset in the log file.
5802	</desc>
5803	</param>
5804	<param name="size" type="unsigned long long" dir="in">
5805	<desc>
5806	Chunk size to read in the log file.
5807	</desc>
5808	</param>
5809	<param name="data" type="octet" dir="return" safearray="yes">
5810	<desc>
5811	Data read from the log file. A data size of 0 means end of file
5812	if the requested chunk size was not 0. This is the unprocessed
5813	file data, i.e. the line ending style depends on the platform of
5814	the system the server is running on.
5815	</desc>
5816	</param>
5817	</method>
5818	</interface>
5819
5820	<!--
5821	// IConsole
5822	/////////////////////////////////////////////////////////////////////////
5823	-->
5824
5825	<interface
5826	name="IRemoteDisplayInfo" extends="$unknown"
5827	uuid="b3741084-806f-4c3b-8c42-ebad1a81e45a"
5828	wsmap="struct"
5829	>
5830	<desc>
5831	Contains information about the remote display (VRDP) capabilities and status.
5832	This is used in the <link to="IConsole::remoteDisplayInfo" /> attribute.
5833	</desc>
5834
5835	<attribute name="active" type="boolean" readonly="yes">
5836	<desc>
5837	Whether the remote display connection is active.
5838	</desc>
5839	</attribute>
5840
5841	<attribute name="port" type="long" readonly="yes">
5842	<desc>
5843	VRDP server port number. If this property is equal to <tt>0</tt>, then
5844	the VRDP server failed to start, usually because there are no free TCP
5845	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDP
5846	server has not yet been started.
5847	</desc>
5848	</attribute>
5849
5850	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5851	<desc>
5852	How many times a client connected.
5853	</desc>
5854	</attribute>
5855
5856	<attribute name="beginTime" type="long long" readonly="yes">
5857	<desc>
5858	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5859	</desc>
5860	</attribute>
5861
5862	<attribute name="endTime" type="long long" readonly="yes">
5863	<desc>
5864	When the last connection was terminated or the current time, if
5865	connection is still active, in milliseconds since 1970-01-01 UTC.
5866	</desc>
5867	</attribute>
5868
5869	<attribute name="bytesSent" type="unsigned long long" readonly="yes">
5870	<desc>
5871	How many bytes were sent in last or current, if still active, connection.
5872	</desc>
5873	</attribute>
5874
5875	<attribute name="bytesSentTotal" type="unsigned long long" readonly="yes">
5876	<desc>
5877	How many bytes were sent in all connections.
5878	</desc>
5879	</attribute>
5880
5881	<attribute name="bytesReceived" type="unsigned long long" readonly="yes">
5882	<desc>
5883	How many bytes were received in last or current, if still active, connection.
5884	</desc>
5885	</attribute>
5886
5887	<attribute name="bytesReceivedTotal" type="unsigned long long" readonly="yes">
5888	<desc>
5889	How many bytes were received in all connections.
5890	</desc>
5891	</attribute>
5892
5893	<attribute name="user" type="wstring" readonly="yes">
5894	<desc>
5895	Login user name supplied by the client.
5896	</desc>
5897	</attribute>
5898
5899	<attribute name="domain" type="wstring" readonly="yes">
5900	<desc>
5901	Login domain name supplied by the client.
5902	</desc>
5903	</attribute>
5904
5905	<attribute name="clientName" type="wstring" readonly="yes">
5906	<desc>
5907	The client name supplied by the client.
5908	</desc>
5909	</attribute>
5910
5911	<attribute name="clientIP" type="wstring" readonly="yes">
5912	<desc>
5913	The IP address of the client.
5914	</desc>
5915	</attribute>
5916
5917	<attribute name="clientVersion" type="unsigned long" readonly="yes">
5918	<desc>
5919	The client software version number.
5920	</desc>
5921	</attribute>
5922
5923	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
5924	<desc>
5925	Public key exchange method used when connection was established.
5926	Values: 0 - RDP4 public key exchange scheme.
5927	1 - X509 certificates were sent to client.
5928	</desc>
5929	</attribute>
5930
5931	</interface>
5932
5933	<interface
5934	name="IConsole" extends="$unknown"
5935	uuid="6375231a-c17c-464b-92cb-ae9e128d71c3"
5936	wsmap="managed"
5937	>
5938	<desc>
5939	The IConsole interface represents an interface to control virtual
5940	machine execution.
5941
5942	The console object that implements the IConsole interface is obtained
5943	from a session object after the session for the given machine has been
5944	opened using one of <link to="IVirtualBox::openSession"/>,
5945	<link to="IVirtualBox::openRemoteSession"/> or
5946	<link to="IVirtualBox::openExistingSession"/> methods.
5947
5948	Methods of the IConsole interface allow the caller to query the current
5949	virtual machine execution state, pause the machine or power it down, save
5950	the machine state or take a snapshot, attach and detach removable media
5951	and so on.
5952
5953	<see>ISession</see>
5954	</desc>
5955
5956	<attribute name="machine" type="IMachine" readonly="yes">
5957	<desc>
5958	Machine object this console is sessioned with.
5959	<note>
5960	This is a convenience property, it has the same value as
5961	<link to="ISession::machine"/> of the corresponding session
5962	object.
5963	</note>
5964	</desc>
5965	</attribute>
5966
5967	<attribute name="state" type="MachineState" readonly="yes">
5968	<desc>
5969	Current execution state of the machine.
5970	<note>
5971	This property always returns the same value as the corresponding
5972	property of the IMachine object this console is sessioned with.
5973	For the process that owns (executes) the VM, this is the
5974	preferable way of querying the VM state, because no IPC
5975	calls are made.
5976	</note>
5977	</desc>
5978	</attribute>
5979
5980	<attribute name="guest" type="IGuest" readonly="yes">
5981	<desc>Guest object.</desc>
5982	</attribute>
5983
5984	<attribute name="keyboard" type="IKeyboard" readonly="yes">
5985	<desc>
5986	Virtual keyboard object.
5987	<note>
5988	If the machine is not running, any attempt to use
5989	the returned object will result in an error.
5990	</note>
5991	</desc>
5992	</attribute>
5993
5994	<attribute name="mouse" type="IMouse" readonly="yes">
5995	<desc>
5996	Virtual mouse object.
5997	<note>
5998	If the machine is not running, any attempt to use
5999	the returned object will result in an error.
6000	</note>
6001	</desc>
6002	</attribute>
6003
6004	<attribute name="display" type="IDisplay" readonly="yes">
6005	<desc>Virtual display object.
6006	<note>
6007	If the machine is not running, any attempt to use
6008	the returned object will result in an error.
6009	</note>
6010	</desc>
6011	</attribute>
6012
6013	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6014	<desc>Debugging interface.</desc>
6015	</attribute>
6016
6017	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6018	<desc>
6019	Collection of USB devices currently attached to the virtual
6020	USB controller.
6021	<note>
6022	The collection is empty if the machine is not running.
6023	</note>
6024	</desc>
6025	</attribute>
6026
6027	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6028	<desc>
6029	List of USB devices currently attached to the remote VRDP client.
6030	Once a new device is physically attached to the remote host computer,
6031	it appears in this list and remains there until detached.
6032	</desc>
6033	</attribute>
6034
6035	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6036	<desc>
6037	Collection of shared folders for the current session. These folders
6038	are called transient shared folders because they are available to the
6039	guest OS running inside the associated virtual machine only for the
6040	duration of the session (as opposed to
6041	<link to="IMachine::sharedFolders"/> which represent permanent shared
6042	folders). When the session is closed (e.g. the machine is powered down),
6043	these folders are automatically discarded.
6044
6045	New shared folders are added to the collection using
6046	<link to="#createSharedFolder"/>. Existing shared folders can be
6047	removed using <link to="#removeSharedFolder"/>.
6048	</desc>
6049	</attribute>
6050
6051	<attribute name="remoteDisplayInfo" type="IRemoteDisplayInfo" readonly="yes">
6052	<desc>
6053	Interface that provides information on Remote Display (VRDP) connection.
6054	</desc>
6055	</attribute>
6056
6057	<attribute name="eventSource" type="IEventSource" readonly="yes">
6058	<desc>
6059	Event source for console events.
6060	</desc>
6061	</attribute>
6062
6063	<method name="powerUp">
6064	<desc>
6065	Starts the virtual machine execution using the current machine
6066	state (that is, its current execution state, current settings and
6067	current storage devices).
6068
6069	If the machine is powered off or aborted, the execution will
6070	start from the beginning (as if the real hardware were just
6071	powered on).
6072
6073	If the machine is in the <link to="MachineState_Saved"/> state,
6074	it will continue its execution the point where the state has
6075	been saved.
6076
6077	If the machine <link to="IMachine::teleporterEnabled"/> property is
6078	enabled on the machine being powered up, the machine will wait for an
6079	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6080	state. The returned progress object will have at least three
6081	operations where the last three are defined as: (1) powering up and
6082	starting TCP server, (2) waiting for incoming teleportations, and
6083	(3) perform teleportation. These operations will be reflected as the
6084	last three operations of the progress objected returned by
6085	<link to="IVirtualBox::openRemoteSession"/> as well.
6086
6087	<note>
6088	Unless you are trying to write a new VirtualBox front-end that
6089	performs direct machine execution (like the VirtualBox or VBoxSDL
6090	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
6091	session opened by <link to="IVirtualBox::openSession"/> and use this
6092	session only to change virtual machine settings. If you simply want to
6093	start virtual machine execution using one of the existing front-ends
6094	(for example the VirtualBox GUI or headless server), simply use
6095	<link to="IVirtualBox::openRemoteSession"/>; these front-ends will
6096	power up the machine automatically for you.
6097	</note>
6098
6099	<see>#saveState</see>
6100	<result name="VBOX_E_INVALID_VM_STATE">
6101	Virtual machine already running.
6102	</result>
6103	<result name="VBOX_E_HOST_ERROR">
6104	Host interface does not exist or name not set.
6105	</result>
6106	<result name="VBOX_E_FILE_ERROR">
6107	Invalid saved state file.
6108	</result>
6109	</desc>
6110	<param name="progress" type="IProgress" dir="return">
6111	<desc>Progress object to track the operation completion.</desc>
6112	</param>
6113	</method>
6114
6115	<method name="powerUpPaused">
6116	<desc>
6117	Identical to powerUp except that the VM will enter the
6118	<link to="MachineState_Paused"/> state, instead of
6119	<link to="MachineState_Running"/>.
6120
6121	<see>#powerUp</see>
6122	<result name="VBOX_E_INVALID_VM_STATE">
6123	Virtual machine already running.
6124	</result>
6125	<result name="VBOX_E_HOST_ERROR">
6126	Host interface does not exist or name not set.
6127	</result>
6128	<result name="VBOX_E_FILE_ERROR">
6129	Invalid saved state file.
6130	</result>
6131	</desc>
6132	<param name="progress" type="IProgress" dir="return">
6133	<desc>Progress object to track the operation completion.</desc>
6134	</param>
6135	</method>
6136
6137	<method name="powerDown">
6138	<desc>
6139	Initiates the power down procedure to stop the virtual machine
6140	execution.
6141
6142	The completion of the power down procedure is tracked using the returned
6143	IProgress object. After the operation is complete, the machine will go
6144	to the PoweredOff state.
6145	<result name="VBOX_E_INVALID_VM_STATE">
6146	Virtual machine must be Running, Paused or Stuck to be powered down.
6147	</result>
6148	</desc>
6149	<param name="progress" type="IProgress" dir="return">
6150	<desc>Progress object to track the operation completion.</desc>
6151	</param>
6152	</method>
6153
6154	<method name="reset">
6155	<desc>Resets the virtual machine.
6156	<result name="VBOX_E_INVALID_VM_STATE">
6157	Virtual machine not in Running state.
6158	</result>
6159	<result name="VBOX_E_VM_ERROR">
6160	Virtual machine error in reset operation.
6161	</result>
6162	</desc>
6163	</method>
6164
6165	<method name="pause">
6166	<desc>Pauses the virtual machine execution.
6167	<result name="VBOX_E_INVALID_VM_STATE">
6168	Virtual machine not in Running state.
6169	</result>
6170	<result name="VBOX_E_VM_ERROR">
6171	Virtual machine error in suspend operation.
6172	</result>
6173	</desc>
6174	</method>
6175
6176	<method name="resume">
6177	<desc>Resumes the virtual machine execution.
6178	<result name="VBOX_E_INVALID_VM_STATE">
6179	Virtual machine not in Paused state.
6180	</result>
6181	<result name="VBOX_E_VM_ERROR">
6182	Virtual machine error in resume operation.
6183	</result>
6184	</desc>
6185	</method>
6186
6187	<method name="powerButton">
6188	<desc>Sends the ACPI power button event to the guest.
6189	<result name="VBOX_E_INVALID_VM_STATE">
6190	Virtual machine not in Running state.
6191	</result>
6192	<result name="VBOX_E_PDM_ERROR">
6193	Controlled power off failed.
6194	</result>
6195	</desc>
6196	</method>
6197
6198	<method name="sleepButton">
6199	<desc>Sends the ACPI sleep button event to the guest.
6200	<result name="VBOX_E_INVALID_VM_STATE">
6201	Virtual machine not in Running state.
6202	</result>
6203	<result name="VBOX_E_PDM_ERROR">
6204	Sending sleep button event failed.
6205	</result>
6206	</desc>
6207	</method>
6208
6209	<method name="getPowerButtonHandled">
6210	<desc>Checks if the last power button event was handled by guest.
6211	<result name="VBOX_E_PDM_ERROR">
6212	Checking if the event was handled by the guest OS failed.
6213	</result>
6214	</desc>
6215	<param name="handled" type="boolean" dir="return"/>
6216	</method>
6217
6218	<method name="getGuestEnteredACPIMode">
6219	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6220	G1 (sleeping). If this method returns @c false, the guest will
6221	most likely not respond to external ACPI events.
6222	<result name="VBOX_E_INVALID_VM_STATE">
6223	Virtual machine not in Running state.
6224	</result>
6225	</desc>
6226	<param name="entered" type="boolean" dir="return"/>
6227	</method>
6228
6229	<method name="saveState">
6230	<desc>
6231	Saves the current execution state of a running virtual machine
6232	and stops its execution.
6233
6234	After this operation completes, the machine will go to the
6235	Saved state. Next time it is powered up, this state will
6236	be restored and the machine will continue its execution from
6237	the place where it was saved.
6238
6239	This operation differs from taking a snapshot to the effect
6240	that it doesn't create new differencing media. Also, once
6241	the machine is powered up from the state saved using this method,
6242	the saved state is deleted, so it will be impossible to return
6243	to this state later.
6244
6245	<note>
6246	On success, this method implicitly calls
6247	<link to="IMachine::saveSettings"/> to save all current machine
6248	settings (including runtime changes to the DVD medium, etc.).
6249	Together with the impossibility to change any VM settings when it is
6250	in the Saved state, this guarantees adequate hardware
6251	configuration of the machine when it is restored from the saved
6252	state file.
6253	</note>
6254
6255	<note>
6256	The machine must be in the Running or Paused state, otherwise
6257	the operation will fail.
6258	</note>
6259	<result name="VBOX_E_INVALID_VM_STATE">
6260	Virtual machine state neither Running nor Paused.
6261	</result>
6262	<result name="VBOX_E_FILE_ERROR">
6263	Failed to create directory for saved state file.
6264	</result>
6265
6266	<see><link to="#takeSnapshot"/></see>
6267	</desc>
6268	<param name="progress" type="IProgress" dir="return">
6269	<desc>Progress object to track the operation completion.</desc>
6270	</param>
6271	</method>
6272
6273	<method name="adoptSavedState">
6274	<desc>
6275	Associates the given saved state file to the virtual machine.
6276
6277	On success, the machine will go to the Saved state. Next time it is
6278	powered up, it will be restored from the adopted saved state and
6279	continue execution from the place where the saved state file was
6280	created.
6281
6282	The specified saved state file path may be absolute or relative to the
6283	folder the VM normally saves the state to (usually,
6284	<link to="IMachine::snapshotFolder"/>).
6285
6286	<note>
6287	It's a caller's responsibility to make sure the given saved state
6288	file is compatible with the settings of this virtual machine that
6289	represent its virtual hardware (memory size, storage disk configuration
6290	etc.). If there is a mismatch, the behavior of the virtual machine
6291	is undefined.
6292	</note>
6293	<result name="VBOX_E_INVALID_VM_STATE">
6294	Virtual machine state neither PoweredOff nor Aborted.
6295	</result>
6296	</desc>
6297	<param name="savedStateFile" type="wstring" dir="in">
6298	<desc>Path to the saved state file to adopt.</desc>
6299	</param>
6300	</method>
6301
6302	<method name="forgetSavedState">
6303	<desc>
6304	Forgets the saved state of the virtual machine previously created
6305	by <link to="#saveState"/>. Next time the machine is powered up, a
6306	clean boot will occur. If @a remove is @c true the saved state file
6307	is deleted.
6308	<note>
6309	This operation is equivalent to resetting or powering off
6310	the machine without doing a proper shutdown in the guest OS.
6311	</note>
6312	<result name="VBOX_E_INVALID_VM_STATE">
6313	Virtual machine not in state Saved.
6314	</result>
6315	</desc>
6316	<param name="removeFile" type="boolean" dir="in">
6317	<desc>If @c true remove the saved state file.</desc>
6318	</param>
6319	</method>
6320
6321	<method name="getDeviceActivity">
6322	<desc>
6323	Gets the current activity type of a given device or device group.
6324	<result name="E_INVALIDARG">
6325	Invalid device type.
6326	</result>
6327	</desc>
6328	<param name="type" type="DeviceType" dir="in"/>
6329	<param name="activity" type="DeviceActivity" dir="return"/>
6330	</method>
6331
6332	<method name="attachUSBDevice">
6333	<desc>
6334	Attaches a host USB device with the given UUID to the
6335	USB controller of the virtual machine.
6336
6337	The device needs to be in one of the following states:
6338	<link to="USBDeviceState_Busy"/>,
6339	<link to="USBDeviceState_Available"/> or
6340	<link to="USBDeviceState_Held"/>,
6341	otherwise an error is immediately returned.
6342
6343	When the device state is
6344	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6345	be returned if the host computer refuses to release it for some reason.
6346
6347	<see>IUSBController::deviceFilters, USBDeviceState</see>
6348	<result name="VBOX_E_INVALID_VM_STATE">
6349	Virtual machine state neither Running nor Paused.
6350	</result>
6351	<result name="VBOX_E_PDM_ERROR">
6352	Virtual machine does not have a USB controller.
6353	</result>
6354	</desc>
6355	<param name="id" type="uuid" mod="string" dir="in">
6356	<desc>UUID of the host USB device to attach.</desc>
6357	</param>
6358	</method>
6359
6360	<method name="detachUSBDevice">
6361	<desc>
6362	Detaches an USB device with the given UUID from the USB controller
6363	of the virtual machine.
6364
6365	After this method succeeds, the VirtualBox server re-initiates
6366	all USB filters as if the device were just physically attached
6367	to the host, but filters of this machine are ignored to avoid
6368	a possible automatic re-attachment.
6369
6370	<see>IUSBController::deviceFilters, USBDeviceState</see>
6371
6372	<result name="VBOX_E_PDM_ERROR">
6373	Virtual machine does not have a USB controller.
6374	</result>
6375	<result name="E_INVALIDARG">
6376	USB device not attached to this virtual machine.
6377	</result>
6378	</desc>
6379	<param name="id" type="uuid" mod="string" dir="in">
6380	<desc>UUID of the USB device to detach.</desc>
6381	</param>
6382	<param name="device" type="IUSBDevice" dir="return">
6383	<desc>Detached USB device.</desc>
6384	</param>
6385	</method>
6386
6387	<method name="findUSBDeviceByAddress">
6388	<desc>
6389	Searches for a USB device with the given host address.
6390
6391	<result name="VBOX_E_OBJECT_NOT_FOUND">
6392	Given @c name does not correspond to any USB device.
6393	</result>
6394
6395	<see>IUSBDevice::address</see>
6396	</desc>
6397	<param name="name" type="wstring" dir="in">
6398	<desc>
6399	Address of the USB device (as assigned by the host) to
6400	search for.
6401	</desc>
6402	</param>
6403	<param name="device" type="IUSBDevice" dir="return">
6404	<desc>Found USB device object.</desc>
6405	</param>
6406	</method>
6407
6408	<method name="findUSBDeviceById">
6409	<desc>
6410	Searches for a USB device with the given UUID.
6411
6412	<result name="VBOX_E_OBJECT_NOT_FOUND">
6413	Given @c id does not correspond to any USB device.
6414	</result>
6415
6416	<see>IUSBDevice::id</see>
6417	</desc>
6418	<param name="id" type="uuid" mod="string" dir="in">
6419	<desc>UUID of the USB device to search for.</desc>
6420	</param>
6421	<param name="device" type="IUSBDevice" dir="return">
6422	<desc>Found USB device object.</desc>
6423	</param>
6424	</method>
6425
6426	<method name="createSharedFolder">
6427	<desc>
6428	Creates a transient new shared folder by associating the given logical
6429	name with the given host path, adds it to the collection of shared
6430	folders and starts sharing it. Refer to the description of
6431	<link to="ISharedFolder"/> to read more about logical names.
6432
6433	<result name="VBOX_E_INVALID_VM_STATE">
6434	Virtual machine in Saved state or currently changing state.
6435	</result>
6436	<result name="VBOX_E_FILE_ERROR">
6437	Shared folder already exists or not accessible.
6438	</result>
6439	</desc>
6440	<param name="name" type="wstring" dir="in">
6441	<desc>Unique logical name of the shared folder.</desc>
6442	</param>
6443	<param name="hostPath" type="wstring" dir="in">
6444	<desc>Full path to the shared folder in the host file system.</desc>
6445	</param>
6446	<param name="writable" type="boolean" dir="in">
6447	<desc>Whether the share is writable or readonly</desc>
6448	</param>
6449	</method>
6450
6451	<method name="removeSharedFolder">
6452	<desc>
6453	Removes a transient shared folder with the given name previously
6454	created by <link to="#createSharedFolder"/> from the collection of
6455	shared folders and stops sharing it.
6456	<result name="VBOX_E_INVALID_VM_STATE">
6457	Virtual machine in Saved state or currently changing state.
6458	</result>
6459	<result name="VBOX_E_FILE_ERROR">
6460	Shared folder does not exists.
6461	</result>
6462	</desc>
6463	<param name="name" type="wstring" dir="in">
6464	<desc>Logical name of the shared folder to remove.</desc>
6465	</param>
6466	</method>
6467
6468	<method name="takeSnapshot">
6469	<desc>
6470	Saves the current execution state
6471	and all settings of the machine and creates differencing images
6472	for all normal (non-independent) media.
6473	See <link to="ISnapshot" /> for an introduction to snapshots.
6474
6475	This method can be called for a PoweredOff, Saved (see
6476	<link to="#saveState"/>), Running or
6477	Paused virtual machine. When the machine is PoweredOff, an
6478	offline snapshot is created. When the machine is Running a live
6479	snapshot is created, and an online snapshot is is created when Paused.
6480
6481	The taken snapshot is always based on the
6482	<link to="IMachine::currentSnapshot">current snapshot</link>
6483	of the associated virtual machine and becomes a new current snapshot.
6484
6485	<note>
6486	This method implicitly calls <link to="IMachine::saveSettings"/> to
6487	save all current machine settings before taking an offline snapshot.
6488	</note>
6489
6490	<result name="VBOX_E_INVALID_VM_STATE">
6491	Virtual machine currently changing state.
6492	</result>
6493	</desc>
6494	<param name="name" type="wstring" dir="in">
6495	<desc>Short name for the snapshot.</desc>
6496	</param>
6497	<param name="description" type="wstring" dir="in">
6498	<desc>Optional description of the snapshot.</desc>
6499	</param>
6500	<param name="progress" type="IProgress" dir="return">
6501	<desc>Progress object to track the operation completion.</desc>
6502	</param>
6503	</method>
6504
6505	<method name="deleteSnapshot">
6506	<desc>
6507	Starts deleting the specified snapshot asynchronously.
6508	See <link to="ISnapshot" /> for an introduction to snapshots.
6509
6510	The execution state and settings of the associated machine stored in
6511	the snapshot will be deleted. The contents of all differencing media of
6512	this snapshot will be merged with the contents of their dependent child
6513	media to keep the medium chain valid (in other words, all changes
6514	represented by media being deleted will be propagated to their child
6515	medium). After that, this snapshot's differencing medium will be
6516	deleted. The parent of this snapshot will become a new parent for all
6517	its child snapshots.
6518
6519	If the deleted snapshot is the current one, its parent snapshot will
6520	become a new current snapshot. The current machine state is not directly
6521	affected in this case, except that currently attached differencing
6522	media based on media of the deleted snapshot will be also merged as
6523	described above.
6524
6525	If the deleted snapshot is the first or current snapshot, then the
6526	respective IMachine attributes will be adjusted. Deleting the current
6527	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6528	to make all current machine settings permanent.
6529
6530	Deleting a snapshot has the following preconditions:
6531
6532	<ul>
6533	<li>Child media of all normal media of the deleted snapshot
6534	must be accessible (see <link to="IMedium::state"/>) for this
6535	operation to succeed. In particular, this means that all virtual
6536	machines, whose media are directly or indirectly based on the
6537	media of deleted snapshot, must be powered off.</li>
6538
6539	<li>You cannot delete the snapshot if a medium attached to it has
6540	more than once child medium (differencing images) because otherwise
6541	merging would be impossible. This might be the case if there is
6542	more than one child snapshot or differencing images were created
6543	for other reason (e.g. implicitly because of multiple machine
6544	attachments).</li>
6545	</ul>
6546
6547
6548	The virtual machine's <link to="IMachine::state">state</link> is changed to "DeletingSnapshot"
6549	while this operation is in progress.
6550
6551	<note>
6552	Merging medium contents can be very time and disk space
6553	consuming, if these media are big in size and have many
6554	children. However, if the snapshot being deleted is the last
6555	(head) snapshot on the branch, the operation will be rather
6556	quick.
6557	</note>
6558	<result name="VBOX_E_INVALID_VM_STATE">
6559	Virtual machine is running.
6560	</result>
6561	</desc>
6562	<param name="id" type="uuid" mod="string" dir="in">
6563	<desc>UUID of the snapshot to delete.</desc>
6564	</param>
6565	<param name="progress" type="IProgress" dir="return">
6566	<desc>Progress object to track the operation completion.</desc>
6567	</param>
6568	</method>
6569
6570	<method name="restoreSnapshot">
6571	<desc>
6572	Starts resetting the machine's current state to the state contained
6573	in the given snapshot, asynchronously. All current settings of the
6574	machine will be reset and changes stored in differencing media
6575	will be lost.
6576	See <link to="ISnapshot" /> for an introduction to snapshots.
6577
6578	After this operation is successfully completed, new empty differencing
6579	media are created for all normal media of the machine.
6580
6581	If the given snapshot is an online snapshot, the machine will go to
6582	the <link to="MachineState_Saved"> saved state</link>, so that the
6583	next time it is powered on, the execution state will be restored
6584	from the state of the snapshot.
6585
6586	<note>
6587	The machine must not be running, otherwise the operation will fail.
6588	</note>
6589
6590	<note>
6591	If the machine state is <link to="MachineState_Saved">Saved</link>
6592	prior to this operation, the saved state file will be implicitly
6593	deleted (as if <link to="IConsole::forgetSavedState"/> were
6594	called).
6595	</note>
6596
6597	<result name="VBOX_E_INVALID_VM_STATE">
6598	Virtual machine is running.
6599	</result>
6600	</desc>
6601	<param name="snapshot" type="ISnapshot" dir="in">
6602	<desc>The snapshot to restore the VM state from.</desc>
6603	</param>
6604	<param name="progress" type="IProgress" dir="return">
6605	<desc>Progress object to track the operation completion.</desc>
6606	</param>
6607	</method>
6608
6609	<method name="teleport">
6610	<desc>
6611	Teleport the VM to a different host machine or process.
6612
6613	TODO explain the details.
6614
6615	<result name="VBOX_E_INVALID_VM_STATE">
6616	Virtual machine not running or paused.
6617	</result>
6618	</desc>
6619	<param name="hostname" type="wstring" dir="in">
6620	<desc>The name or IP of the host to teleport to.</desc>
6621	</param>
6622	<param name="tcpport" type="unsigned long" dir="in">
6623	<desc>The TCP port to connect to (1..65535).</desc>
6624	</param>
6625	<param name="password" type="wstring" dir="in">
6626	<desc>The password.</desc>
6627	</param>
6628	<param name="maxDowntime" type="unsigned long" dir="in">
6629	<desc>
6630	The maximum allowed downtime given as milliseconds. 0 is not a valid
6631	value. Recommended value: 250 ms.
6632
6633	The higher the value is, the greater the chance for a successful
6634	teleportation. A small value may easily result in the teleportation
6635	process taking hours and eventually fail.
6636
6637	<note>
6638	The current implementation treats this a guideline, not as an
6639	absolute rule.
6640	</note>
6641	</desc>
6642	</param>
6643	<param name="progress" type="IProgress" dir="return">
6644	<desc>Progress object to track the operation completion.</desc>
6645	</param>
6646	</method>
6647
6648	</interface>
6649
6650	<!--
6651	// IHost
6652	/////////////////////////////////////////////////////////////////////////
6653	-->
6654
6655	<enum
6656	name="HostNetworkInterfaceMediumType"
6657	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6658	>
6659	<desc>
6660	Type of encapsulation. Ethernet encapsulation includes both wired and
6661	wireless Ethernet connections.
6662	<see>IHostNetworkInterface</see>
6663	</desc>
6664
6665	<const name="Unknown" value="0">
6666	<desc>
6667	The type of interface cannot be determined.
6668	</desc>
6669	</const>
6670	<const name="Ethernet" value="1">
6671	<desc>
6672	Ethernet frame encapsulation.
6673	</desc>
6674	</const>
6675	<const name="PPP" value="2">
6676	<desc>
6677	Point-to-point protocol encapsulation.
6678	</desc>
6679	</const>
6680	<const name="SLIP" value="3">
6681	<desc>
6682	Serial line IP encapsulation.
6683	</desc>
6684	</const>
6685	</enum>
6686
6687	<enum
6688	name="HostNetworkInterfaceStatus"
6689	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6690	>
6691	<desc>
6692	Current status of the interface.
6693	<see>IHostNetworkInterface</see>
6694	</desc>
6695
6696	<const name="Unknown" value="0">
6697	<desc>
6698	The state of interface cannot be determined.
6699	</desc>
6700	</const>
6701	<const name="Up" value="1">
6702	<desc>
6703	The interface is fully operational.
6704	</desc>
6705	</const>
6706	<const name="Down" value="2">
6707	<desc>
6708	The interface is not functioning.
6709	</desc>
6710	</const>
6711	</enum>
6712
6713	<enum
6714	name="HostNetworkInterfaceType"
6715	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6716	>
6717	<desc>
6718	Network interface type.
6719	</desc>
6720	<const name="Bridged" value="1"/>
6721	<const name="HostOnly" value="2"/>
6722	</enum>
6723
6724	<interface
6725	name="IHostNetworkInterface" extends="$unknown"
6726	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6727	wsmap="managed"
6728	>
6729	<desc>
6730	Represents one of host's network interfaces. IP V6 address and network
6731	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6732	separated by colons.
6733	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6734	</desc>
6735	<attribute name="name" type="wstring" readonly="yes">
6736	<desc>Returns the host network interface name.</desc>
6737	</attribute>
6738
6739	<attribute name="id" type="uuid" mod="string" readonly="yes">
6740	<desc>Returns the interface UUID.</desc>
6741	</attribute>
6742
6743	<attribute name="networkName" type="wstring" readonly="yes">
6744	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6745	</attribute>
6746
6747	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6748	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6749	</attribute>
6750
6751	<attribute name="IPAddress" type="wstring" readonly="yes">
6752	<desc>Returns the IP V4 address of the interface.</desc>
6753	</attribute>
6754
6755	<attribute name="networkMask" type="wstring" readonly="yes">
6756	<desc>Returns the network mask of the interface.</desc>
6757	</attribute>
6758
6759	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6760	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6761	</attribute>
6762
6763	<attribute name="IPV6Address" type="wstring" readonly="yes">
6764	<desc>Returns the IP V6 address of the interface.</desc>
6765	</attribute>
6766
6767	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6768	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6769	</attribute>
6770
6771	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6772	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6773	</attribute>
6774
6775	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6776	<desc>Type of protocol encapsulation used.</desc>
6777	</attribute>
6778
6779	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6780	<desc>Status of the interface.</desc>
6781	</attribute>
6782
6783	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6784	<desc>specifies the host interface type.</desc>
6785	</attribute>
6786
6787	<method name="enableStaticIpConfig">
6788	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6789	<param name="IPAddress" type="wstring" dir="in">
6790	<desc>
6791	IP address.
6792	</desc>
6793	</param>
6794	<param name="networkMask" type="wstring" dir="in">
6795	<desc>
6796	network mask.
6797	</desc>
6798	</param>
6799	</method>
6800
6801	<method name="enableStaticIpConfigV6">
6802	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6803	<param name="IPV6Address" type="wstring" dir="in">
6804	<desc>
6805	IP address.
6806	</desc>
6807	</param>
6808	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6809	<desc>
6810	network mask.
6811	</desc>
6812	</param>
6813	</method>
6814
6815	<method name="enableDynamicIpConfig">
6816	<desc>enables the dynamic IP configuration.</desc>
6817	</method>
6818
6819	<method name="dhcpRediscover">
6820	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6821	</method>
6822
6823	</interface>
6824
6825	<interface
6826	name="IHost" extends="$unknown"
6827	uuid="35b004f4-7806-4009-bfa8-d1308adba7e5"
6828	wsmap="managed"
6829	>
6830	<desc>
6831	The IHost interface represents the physical machine that this VirtualBox
6832	installation runs on.
6833
6834	An object implementing this interface is returned by the
6835	<link to="IVirtualBox::host" /> attribute. This interface contains
6836	read-only information about the host's physical hardware (such as what
6837	processors and disks are available, what the host operating system is,
6838	and so on) and also allows for manipulating some of the host's hardware,
6839	such as global USB device filters and host interface networking.
6840
6841	</desc>
6842	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6843	<desc>List of DVD drives available on the host.</desc>
6844	</attribute>
6845
6846	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6847	<desc>List of floppy drives available on the host.</desc>
6848	</attribute>
6849
6850	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6851	<desc>
6852	List of USB devices currently attached to the host.
6853	Once a new device is physically attached to the host computer,
6854	it appears in this list and remains there until detached.
6855
6856	<note>
6857	If USB functionality is not available in the given edition of
6858	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6859	</note>
6860	</desc>
6861	</attribute>
6862
6863	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6864	<desc>
6865	List of USB device filters in action.
6866	When a new device is physically attached to the host computer,
6867	filters from this list are applied to it (in order they are stored
6868	in the list). The first matched filter will determine the
6869	<link to="IHostUSBDeviceFilter::action">action</link>
6870	performed on the device.
6871
6872	Unless the device is ignored by these filters, filters of all
6873	currently running virtual machines
6874	(<link to="IUSBController::deviceFilters"/>) are applied to it.
6875
6876	<note>
6877	If USB functionality is not available in the given edition of
6878	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6879	</note>
6880
6881	<see>IHostUSBDeviceFilter, USBDeviceState</see>
6882	</desc>
6883	</attribute>
6884
6885	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
6886	<desc>List of host network interfaces currently defined on the host.</desc>
6887	</attribute>
6888
6889	<attribute name="processorCount" type="unsigned long" readonly="yes">
6890	<desc>Number of (logical) CPUs installed in the host system.</desc>
6891	</attribute>
6892
6893	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
6894	<desc>Number of (logical) CPUs online in the host system.</desc>
6895	</attribute>
6896
6897	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
6898	<desc>Number of physical processor cores installed in the host system.</desc>
6899	</attribute>
6900
6901	<method name="getProcessorSpeed">
6902	<desc>Query the (approximate) maximum speed of a specified host CPU in
6903	Megahertz.
6904	</desc>
6905	<param name="cpuId" type="unsigned long" dir="in">
6906	<desc>
6907	Identifier of the CPU.
6908	</desc>
6909	</param>
6910	<param name="speed" type="unsigned long" dir="return">
6911	<desc>
6912	Speed value. 0 is returned if value is not known or @a cpuId is
6913	invalid.
6914	</desc>
6915	</param>
6916	</method>
6917
6918	<method name="getProcessorFeature">
6919	<desc>Query whether a CPU feature is supported or not.</desc>
6920	<param name="feature" type="ProcessorFeature" dir="in">
6921	<desc>
6922	CPU Feature identifier.
6923	</desc>
6924	</param>
6925	<param name="supported" type="boolean" dir="return">
6926	<desc>
6927	Feature is supported or not.
6928	</desc>
6929	</param>
6930	</method>
6931
6932	<method name="getProcessorDescription">
6933	<desc>Query the model string of a specified host CPU.
6934	</desc>
6935	<param name="cpuId" type="unsigned long" dir="in">
6936	<desc>
6937	Identifier of the CPU.
6938	<note>
6939	The current implementation might not necessarily return the
6940	description for this exact CPU.
6941	</note>
6942	</desc>
6943	</param>
6944	<param name="description" type="wstring" dir="return">
6945	<desc>
6946	Model string. An empty string is returned if value is not known or
6947	@a cpuId is invalid.
6948	</desc>
6949	</param>
6950	</method>
6951
6952	<method name="getProcessorCPUIDLeaf">
6953	<desc>
6954	Returns the CPU cpuid information for the specified leaf.
6955	</desc>
6956	<param name="cpuId" type="unsigned long" dir="in">
6957	<desc>
6958	Identifier of the CPU. The CPU most be online.
6959	<note>
6960	The current implementation might not necessarily return the
6961	description for this exact CPU.
6962	</note>
6963	</desc>
6964	</param>
6965	<param name="leaf" type="unsigned long" dir="in">
6966	<desc>
6967	CPUID leaf index (eax).
6968	</desc>
6969	</param>
6970	<param name="subLeaf" type="unsigned long" dir="in">
6971	<desc>
6972	CPUID leaf sub index (ecx). This currently only applies to cache
6973	information on Intel CPUs. Use 0 if retriving values for
6974	<link to="IMachine::setCPUIDLeaf"/>.
6975	</desc>
6976	</param>
6977	<param name="valEax" type="unsigned long" dir="out">
6978	<desc>
6979	CPUID leaf value for register eax.
6980	</desc>
6981	</param>
6982	<param name="valEbx" type="unsigned long" dir="out">
6983	<desc>
6984	CPUID leaf value for register ebx.
6985	</desc>
6986	</param>
6987	<param name="valEcx" type="unsigned long" dir="out">
6988	<desc>
6989	CPUID leaf value for register ecx.
6990	</desc>
6991	</param>
6992	<param name="valEdx" type="unsigned long" dir="out">
6993	<desc>
6994	CPUID leaf value for register edx.
6995	</desc>
6996	</param>
6997	</method>
6998
6999	<attribute name="memorySize" type="unsigned long" readonly="yes">
7000	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7001	</attribute>
7002
7003	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7004	<desc>Available system memory in the host system.</desc>
7005	</attribute>
7006
7007	<attribute name="operatingSystem" type="wstring" readonly="yes">
7008	<desc>Name of the host system's operating system.</desc>
7009	</attribute>
7010
7011	<attribute name="OSVersion" type="wstring" readonly="yes">
7012	<desc>Host operating system's version string.</desc>
7013	</attribute>
7014
7015	<attribute name="UTCTime" type="long long" readonly="yes">
7016	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7017	</attribute>
7018
7019	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7020	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7021	</attribute>
7022
7023	<method name="createHostOnlyNetworkInterface">
7024	<desc>
7025	Creates a new adapter for Host Only Networking.
7026	<result name="E_INVALIDARG">
7027	Host network interface @a name already exists.
7028	</result>
7029	</desc>
7030	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7031	<desc>
7032	Created host interface object.
7033	</desc>
7034	</param>
7035	<param name="progress" type="IProgress" dir="return">
7036	<desc>
7037	Progress object to track the operation completion.
7038	</desc>
7039	</param>
7040	</method>
7041
7042	<method name="removeHostOnlyNetworkInterface">
7043	<desc>
7044	Removes the given Host Only Networking interface.
7045	<result name="VBOX_E_OBJECT_NOT_FOUND">
7046	No host network interface matching @a id found.
7047	</result>
7048	</desc>
7049	<param name="id" type="uuid" mod="string" dir="in">
7050	<desc>
7051	Adapter GUID.
7052	</desc>
7053	</param>
7054	<param name="progress" type="IProgress" dir="return">
7055	<desc>
7056	Progress object to track the operation completion.
7057	</desc>
7058	</param>
7059	</method>
7060
7061	<method name="createUSBDeviceFilter">
7062	<desc>
7063	Creates a new USB device filter. All attributes except
7064	the filter name are set to empty (any match),
7065	<i>active</i> is @c false (the filter is not active).
7066
7067	The created filter can be added to the list of filters using
7068	<link to="#insertUSBDeviceFilter"/>.
7069
7070	<see>#USBDeviceFilters</see>
7071	</desc>
7072	<param name="name" type="wstring" dir="in">
7073	<desc>
7074	Filter name. See <link to="IHostUSBDeviceFilter::name"/>
7075	for more info.
7076	</desc>
7077	</param>
7078	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7079	<desc>Created filter object.</desc>
7080	</param>
7081	</method>
7082
7083	<method name="insertUSBDeviceFilter">
7084	<desc>
7085	Inserts the given USB device to the specified position
7086	in the list of filters.
7087
7088	Positions are numbered starting from @c 0. If the specified
7089	position is equal to or greater than the number of elements in
7090	the list, the filter is added at the end of the collection.
7091
7092	<note>
7093	Duplicates are not allowed, so an attempt to insert a
7094	filter already in the list is an error.
7095	</note>
7096	<note>
7097	If USB functionality is not available in the given edition of
7098	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7099	</note>
7100
7101	<see>#USBDeviceFilters</see>
7102
7103	<result name="VBOX_E_INVALID_OBJECT_STATE">
7104	USB device filter is not created within this VirtualBox instance.
7105	</result>
7106	<result name="E_INVALIDARG">
7107	USB device filter already in list.
7108	</result>
7109
7110	</desc>
7111	<param name="position" type="unsigned long" dir="in">
7112	<desc>Position to insert the filter to.</desc>
7113	</param>
7114	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7115	<desc>USB device filter to insert.</desc>
7116	</param>
7117	</method>
7118
7119	<method name="removeUSBDeviceFilter">
7120	<desc>
7121	Removes a USB device filter from the specified position in the
7122	list of filters.
7123
7124	Positions are numbered starting from @c 0. Specifying a
7125	position equal to or greater than the number of elements in
7126	the list will produce an error.
7127
7128	<note>
7129	If USB functionality is not available in the given edition of
7130	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7131	</note>
7132
7133	<see>#USBDeviceFilters</see>
7134
7135	<result name="E_INVALIDARG">
7136	USB device filter list empty or invalid @a position.
7137	</result>
7138
7139	</desc>
7140	<param name="position" type="unsigned long" dir="in">
7141	<desc>Position to remove the filter from.</desc>
7142	</param>
7143	</method>
7144
7145	<method name="findHostDVDDrive">
7146	<desc>
7147	Searches for a host DVD drive with the given @c name.
7148
7149	<result name="VBOX_E_OBJECT_NOT_FOUND">
7150	Given @c name does not correspond to any host drive.
7151	</result>
7152
7153	</desc>
7154	<param name="name" type="wstring" dir="in">
7155	<desc>Name of the host drive to search for</desc>
7156	</param>
7157	<param name="drive" type="IMedium" dir="return">
7158	<desc>Found host drive object</desc>
7159	</param>
7160	</method>
7161
7162	<method name="findHostFloppyDrive">
7163	<desc>
7164	Searches for a host floppy drive with the given @c name.
7165
7166	<result name="VBOX_E_OBJECT_NOT_FOUND">
7167	Given @c name does not correspond to any host floppy drive.
7168	</result>
7169
7170	</desc>
7171	<param name="name" type="wstring" dir="in">
7172	<desc>Name of the host floppy drive to search for</desc>
7173	</param>
7174	<param name="drive" type="IMedium" dir="return">
7175	<desc>Found host floppy drive object</desc>
7176	</param>
7177	</method>
7178
7179	<method name="findHostNetworkInterfaceByName">
7180	<desc>
7181	Searches through all host network interfaces for an interface with
7182	the given @c name.
7183	<note>
7184	The method returns an error if the given @c name does not
7185	correspond to any host network interface.
7186	</note>
7187	</desc>
7188	<param name="name" type="wstring" dir="in">
7189	<desc>Name of the host network interface to search for.</desc>
7190	</param>
7191	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7192	<desc>Found host network interface object.</desc>
7193	</param>
7194	</method>
7195	<method name="findHostNetworkInterfaceById">
7196	<desc>
7197	Searches through all host network interfaces for an interface with
7198	the given GUID.
7199	<note>
7200	The method returns an error if the given GUID does not
7201	correspond to any host network interface.
7202	</note>
7203	</desc>
7204	<param name="id" type="uuid" mod="string" dir="in">
7205	<desc>GUID of the host network interface to search for.</desc>
7206	</param>
7207	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7208	<desc>Found host network interface object.</desc>
7209	</param>
7210	</method>
7211	<method name="findHostNetworkInterfacesOfType">
7212	<desc>
7213	Searches through all host network interfaces and returns a list of interfaces of the specified type
7214	</desc>
7215	<param name="type" type="HostNetworkInterfaceType" dir="in">
7216	<desc>type of the host network interfaces to search for.</desc>
7217	</param>
7218	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7219	<desc>Found host network interface objects.</desc>
7220	</param>
7221	</method>
7222
7223	<method name="findUSBDeviceById">
7224	<desc>
7225	Searches for a USB device with the given UUID.
7226
7227	<result name="VBOX_E_OBJECT_NOT_FOUND">
7228	Given @c id does not correspond to any USB device.
7229	</result>
7230
7231	<see>IHostUSBDevice::id</see>
7232	</desc>
7233	<param name="id" type="uuid" mod="string" dir="in">
7234	<desc>UUID of the USB device to search for.</desc>
7235	</param>
7236	<param name="device" type="IHostUSBDevice" dir="return">
7237	<desc>Found USB device object.</desc>
7238	</param>
7239	</method>
7240
7241	<method name="findUSBDeviceByAddress">
7242	<desc>
7243	Searches for a USB device with the given host address.
7244
7245	<result name="VBOX_E_OBJECT_NOT_FOUND">
7246	Given @c name does not correspond to any USB device.
7247	</result>
7248
7249	<see>IHostUSBDevice::address</see>
7250	</desc>
7251	<param name="name" type="wstring" dir="in">
7252	<desc>
7253	Address of the USB device (as assigned by the host) to
7254	search for.
7255	</desc>
7256	</param>
7257	<param name="device" type="IHostUSBDevice" dir="return">
7258	<desc>Found USB device object.</desc>
7259	</param>
7260	</method>
7261
7262	</interface>
7263
7264	<!--
7265	// ISystemProperties
7266	/////////////////////////////////////////////////////////////////////////
7267	-->
7268
7269	<interface
7270	name="ISystemProperties"
7271	extends="$unknown"
7272	uuid="07c3ffd8-8f59-49cc-b608-53a332e85cc3"
7273	wsmap="managed"
7274	>
7275	<desc>
7276	The ISystemProperties interface represents global properties of the given
7277	VirtualBox installation.
7278
7279	These properties define limits and default values for various attributes
7280	and parameters. Most of the properties are read-only, but some can be
7281	changed by a user.
7282	</desc>
7283
7284	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7285	<desc>Minimum guest system memory in Megabytes.</desc>
7286	</attribute>
7287
7288	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7289	<desc>Maximum guest system memory in Megabytes.</desc>
7290	</attribute>
7291
7292	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7293	<desc>Minimum guest video memory in Megabytes.</desc>
7294	</attribute>
7295
7296	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7297	<desc>Maximum guest video memory in Megabytes.</desc>
7298	</attribute>
7299
7300	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7301	<desc>Minimum CPU count.</desc>
7302	</attribute>
7303
7304	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7305	<desc>Maximum CPU count.</desc>
7306	</attribute>
7307
7308	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7309	<desc>Maximum of monitors which could be connected.</desc>
7310	</attribute>
7311
7312	<attribute name="maxVDISize" type="unsigned long long" readonly="yes">
7313	<desc>Maximum size of a virtual disk image in Megabytes.</desc>
7314	</attribute>
7315
7316	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7317	<desc>
7318	Number of network adapters associated with every
7319	<link to="IMachine"/> instance.
7320	</desc>
7321	</attribute>
7322
7323	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7324	<desc>
7325	Number of serial ports associated with every
7326	<link to="IMachine"/> instance.
7327	</desc>
7328	</attribute>
7329
7330	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7331	<desc>
7332	Number of parallel ports associated with every
7333	<link to="IMachine"/> instance.
7334	</desc>
7335	</attribute>
7336
7337	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7338	<desc>
7339	Maximum device position in the boot order. This value corresponds
7340	to the total number of devices a machine can boot from, to make it
7341	possible to include all possible devices to the boot list.
7342	<see><link to="IMachine::setBootOrder"/></see>
7343	</desc>
7344	</attribute>
7345
7346	<attribute name="defaultMachineFolder" type="wstring">
7347	<desc>
7348	Full path to the default directory used to create new or open
7349	existing machines when a settings file name contains no
7350	path.
7351
7352	The initial value of this property is
7353	<tt><</tt><link to="IVirtualBox::homeFolder">
7354	VirtualBox_home</link><tt>>/Machines</tt>.
7355
7356	<note>
7357	Setting this property to @c null or an empty string will restore the
7358	initial value.
7359	</note>
7360	<note>
7361	When settings this property, the specified path can be
7362	absolute (full path) or relative
7363	to the <link to="IVirtualBox::homeFolder">
7364	VirtualBox home directory</link>.
7365	When reading this property, a full path is
7366	always returned.
7367	</note>
7368	<note>
7369	The specified path may not exist, it will be created
7370	when necessary.
7371	</note>
7372
7373	<see>
7374	<link to="IVirtualBox::createMachine"/>,
7375	<link to="IVirtualBox::openMachine"/>
7376	</see>
7377	</desc>
7378	</attribute>
7379
7380	<attribute name="defaultHardDiskFolder" type="wstring">
7381	<desc>
7382	Full path to the default directory used to create new or open existing
7383	virtual disks.
7384
7385	This path is used when the storage unit of a hard disk is a regular file
7386	in the host's file system and only a file name that contains no path is
7387	given.
7388
7389	The initial value of this property is
7390	<tt><</tt>
7391	<link to="IVirtualBox::homeFolder">VirtualBox_home</link>
7392	<tt>>/HardDisks</tt>.
7393
7394	<note>
7395	Setting this property to @c null or empty string will restore the
7396	initial value.
7397	</note>
7398	<note>
7399	When settings this property, the specified path can be relative
7400	to the
7401	<link to="IVirtualBox::homeFolder">VirtualBox home directory</link> or
7402	absolute. When reading this property, a full path is
7403	always returned.
7404	</note>
7405	<note>
7406	The specified path may not exist, it will be created
7407	when necessary.
7408	</note>
7409
7410	<see>
7411	IMedium,
7412	<link to="IVirtualBox::createHardDisk"/>,
7413	<link to="IVirtualBox::openHardDisk"/>,
7414	<link to="IMedium::location"/>
7415	</see>
7416	</desc>
7417	</attribute>
7418
7419	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7420	<desc>
7421	List of all medium storage formats supported by this VirtualBox
7422	installation.
7423
7424	Keep in mind that the medium format identifier
7425	(<link to="IMediumFormat::id"/>) used in other API calls like
7426	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7427	medium format is a case-insensitive string. This means that, for
7428	example, all of the following strings:
7429	<pre>
7430	"VDI"
7431	"vdi"
7432	"VdI"</pre>
7433	refer to the same medium format.
7434
7435	Note that the virtual medium framework is backend-based, therefore
7436	the list of supported formats depends on what backends are currently
7437	installed.
7438
7439	<see>
7440	<link to="IMediumFormat"/>,
7441	</see>
7442	</desc>
7443	</attribute>
7444
7445	<attribute name="defaultHardDiskFormat" type="wstring">
7446	<desc>
7447	Identifier of the default medium format used by VirtualBox.
7448
7449	The medium format set by this attribute is used by VirtualBox
7450	when the medium format was not specified explicitly. One example is
7451	<link to="IVirtualBox::createHardDisk"/> with the empty
7452	format argument. A more complex example is implicit creation of
7453	differencing media when taking a snapshot of a virtual machine:
7454	this operation will try to use a format of the parent medium first
7455	and if this format does not support differencing media the default
7456	format specified by this argument will be used.
7457
7458	The list of supported medium formats may be obtained by the
7459	<link to="#mediaFormats"/> call. Note that the default medium
7460	format must have a capability to create differencing media;
7461	otherwise operations that create media implicitly may fail
7462	unexpectedly.
7463
7464	The initial value of this property is <tt>"VDI"</tt> in the current
7465	version of the VirtualBox product, but may change in the future.
7466
7467	<note>
7468	Setting this property to @c null or empty string will restore the
7469	initial value.
7470	</note>
7471
7472	<see>
7473	<link to="#mediaFormats"/>,
7474	<link to="IMediumFormat::id"/>,
7475	<link to="IVirtualBox::createHardDisk"/>
7476	</see>
7477	</desc>
7478	</attribute>
7479
7480	<attribute name="freeDiskSpaceWarning" type="unsigned long long">
7481	<desc>Issue a warning if the free disk space is below (or in some disk
7482	intensive operation is expected to go below) the given size in
7483	Megabytes.</desc>
7484	</attribute>
7485
7486	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7487	<desc>Issue a warning if the free disk space is below (or in some disk
7488	intensive operation is expected to go below) the given percentage.</desc>
7489	</attribute>
7490
7491	<attribute name="freeDiskSpaceError" type="unsigned long long">
7492	<desc>Issue an error if the free disk space is below (or in some disk
7493	intensive operation is expected to go below) the given size in
7494	Megabytes.</desc>
7495	</attribute>
7496
7497	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7498	<desc>Issue an error if the free disk space is below (or in some disk
7499	intensive operation is expected to go below) the given percentage.</desc>
7500	</attribute>
7501
7502	<attribute name="remoteDisplayAuthLibrary" type="wstring">
7503	<desc>
7504	Library that provides authentication for VRDP clients. The library
7505	is used if a virtual machine's authentication type is set to "external"
7506	in the VM RemoteDisplay configuration.
7507
7508	The system library extension (".DLL" or ".so") must be omitted.
7509	A full path can be specified; if not, then the library must reside on the
7510	system's default library path.
7511
7512	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
7513	of that name in one of the default VirtualBox library directories.
7514
7515	For details about VirtualBox authentication libraries and how to implement
7516	them, please refer to the VirtualBox manual.
7517
7518	<note>
7519	Setting this property to @c null or empty string will restore the
7520	initial value.
7521	</note>
7522	</desc>
7523	</attribute>
7524
7525	<attribute name="webServiceAuthLibrary" type="wstring">
7526	<desc>
7527	Library that provides authentication for webservice clients. The library
7528	is used if a virtual machine's authentication type is set to "external"
7529	in the VM RemoteDisplay configuration and will be called from
7530	within the <link to="IWebsessionManager::logon" /> implementation.
7531
7532	As opposed to <link to="ISystemProperties::remoteDisplayAuthLibrary" />,
7533	there is no per-VM setting for this, as the webservice is a global
7534	resource (if it is running). Only for this setting (for the webservice),
7535	setting this value to a literal <tt>"null"</tt> string disables authentication,
7536	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7537	no matter what user name and password are supplied.
7538
7539	The initial value of this property is <tt>"VRDPAuth"</tt>,
7540	meaning that the webservice will use the same authentication
7541	library that is used by default for VBoxVRDP (again, see
7542	<link to="ISystemProperties::remoteDisplayAuthLibrary" />).
7543	The format and calling convention of authentication libraries
7544	is the same for the webservice as it is for VBoxVRDP.
7545
7546	<note>
7547	Setting this property to @c null or empty string will restore the
7548	initial value.
7549	</note>
7550	</desc>
7551	</attribute>
7552
7553	<attribute name="LogHistoryCount" type="unsigned long">
7554	<desc>
7555	This value specifies how many old release log files are kept.
7556	</desc>
7557	</attribute>
7558
7559	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7560	<desc>This value hold the default audio driver for the current
7561	system.</desc>
7562	</attribute>
7563
7564	<method name="getMaxDevicesPerPortForStorageBus">
7565	<desc>Returns the maximum number of devices which can be attached to a port
7566	for the given storage bus.</desc>
7567
7568	<param name="bus" type="StorageBus" dir="in">
7569	<desc>The storage bus type to get the value for.</desc>
7570	</param>
7571
7572	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7573	<desc>The maximum number of devices which can eb attached to the port for the given
7574	storage bus.</desc>
7575	</param>
7576	</method>
7577
7578	<method name="getMinPortCountForStorageBus">
7579	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7580
7581	<param name="bus" type="StorageBus" dir="in">
7582	<desc>The storage bus type to get the value for.</desc>
7583	</param>
7584
7585	<param name="minPortCount" type="unsigned long" dir="return">
7586	<desc>The minimum number of ports for the given storage bus.</desc>
7587	</param>
7588	</method>
7589
7590	<method name="getMaxPortCountForStorageBus">
7591	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7592
7593	<param name="bus" type="StorageBus" dir="in">
7594	<desc>The storage bus type to get the value for.</desc>
7595	</param>
7596
7597	<param name="maxPortCount" type="unsigned long" dir="return">
7598	<desc>The maximum number of ports for the given storage bus.</desc>
7599	</param>
7600	</method>
7601
7602	<method name="getMaxInstancesOfStorageBus">
7603	<desc>Returns the maximum number of storage bus instances which
7604	can be configured for each VM. This corresponds to the number of
7605	storage controllers one can have.</desc>
7606
7607	<param name="bus" type="StorageBus" dir="in">
7608	<desc>The storage bus type to get the value for.</desc>
7609	</param>
7610
7611	<param name="maxInstances" type="unsigned long" dir="return">
7612	<desc>The maximum number of instances for the given storage bus.</desc>
7613	</param>
7614	</method>
7615
7616	<method name="getDeviceTypesForStorageBus">
7617	<desc>Returns list of all the supported device types
7618	(<link to="DeviceType"/>) for the given type of storage
7619	bus.</desc>
7620
7621	<param name="bus" type="StorageBus" dir="in">
7622	<desc>The storage bus type to get the value for.</desc>
7623	</param>
7624
7625	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7626	<desc>The list of all supported device types for the given storage bus.</desc>
7627	</param>
7628	</method>
7629	</interface>
7630
7631	<!--
7632	// IGuest
7633	/////////////////////////////////////////////////////////////////////////
7634	-->
7635
7636	<interface
7637	name="IGuestOSType" extends="$unknown"
7638	uuid="e3f6727e-a09b-41ea-a824-864a176472f3"
7639	wsmap="struct"
7640	>
7641	<desc>
7642	</desc>
7643
7644	<attribute name="familyId" type="wstring" readonly="yes">
7645	<desc>Guest OS family identifier string.</desc>
7646	</attribute>
7647
7648	<attribute name="familyDescription" type="wstring" readonly="yes">
7649	<desc>Human readable description of the guest OS family.</desc>
7650	</attribute>
7651
7652	<attribute name="id" type="wstring" readonly="yes">
7653	<desc>Guest OS identifier string.</desc>
7654	</attribute>
7655
7656	<attribute name="description" type="wstring" readonly="yes">
7657	<desc>Human readable description of the guest OS.</desc>
7658	</attribute>
7659
7660	<attribute name="is64Bit" type="boolean" readonly="yes">
7661	<desc>Returns @c true if the given OS is 64-bit</desc>
7662	</attribute>
7663
7664	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7665	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7666	</attribute>
7667
7668	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7669	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7670	</attribute>
7671
7672	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7673	<desc>Recommended RAM size in Megabytes.</desc>
7674	</attribute>
7675
7676	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7677	<desc>Recommended video RAM size in Megabytes.</desc>
7678	</attribute>
7679
7680	<attribute name="recommendedHDD" type="unsigned long" readonly="yes">
7681	<desc>Recommended hard disk size in Megabytes.</desc>
7682	</attribute>
7683
7684	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7685	<desc>Returns recommended network adapter for this OS type.</desc>
7686	</attribute>
7687
7688	<attribute name="recommendedPae" type="boolean" readonly="yes">
7689	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7690	</attribute>
7691
7692	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7693	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7694	</attribute>
7695
7696	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7697	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7698	</attribute>
7699
7700	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7701	<desc>Recommended storage controller type for HD drives.</desc>
7702	</attribute>
7703
7704	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7705	<desc>Recommended storage bus type for HD drives.</desc>
7706	</attribute>
7707
7708	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7709	<desc>Recommended firmware type.</desc>
7710	</attribute>
7711
7712	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7713	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7714	</attribute>
7715
7716	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7717	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7718	</attribute>
7719
7720	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7721	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7722	</attribute>
7723
7724	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7725	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7726	</attribute>
7727
7728	</interface>
7729
7730	<interface
7731	name="IGuest" extends="$unknown"
7732	uuid="d915dff1-ed38-495a-91f1-ab6c53932468"
7733	wsmap="managed"
7734	>
7735	<desc>
7736	The IGuest interface represents information about the operating system
7737	running inside the virtual machine. Used in
7738	<link to="IConsole::guest"/>.
7739
7740	IGuest provides information about the guest operating system, whether
7741	Guest Additions are installed and other OS-specific virtual machine
7742	properties.
7743	</desc>
7744
7745	<attribute name="OSTypeId" type="wstring" readonly="yes">
7746	<desc>
7747	Identifier of the Guest OS type as reported by the Guest
7748	Additions.
7749	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
7750	an IGuestOSType object representing details about the given
7751	Guest OS type.
7752	<note>
7753	If Guest Additions are not installed, this value will be
7754	the same as <link to="IMachine::OSTypeId"/>.
7755	</note>
7756	</desc>
7757	</attribute>
7758
7759	<attribute name="additionsActive" type="boolean" readonly="yes">
7760	<desc>
7761	Flag whether the Guest Additions are installed and active
7762	in which case their version will be returned by the
7763	<link to="#additionsVersion"/> property.
7764	</desc>
7765	</attribute>
7766
7767	<attribute name="additionsVersion" type="wstring" readonly="yes">
7768	<desc>
7769	Version of the Guest Additions (3 decimal numbers separated
7770	by dots) or empty when the Additions are not installed. The
7771	Additions may also report a version but yet not be active as
7772	the version might be refused by VirtualBox (incompatible) or
7773	other failures occurred.
7774	</desc>
7775	</attribute>
7776
7777	<attribute name="supportsSeamless" type="boolean" readonly="yes">
7778	<desc>
7779	Flag whether seamless guest display rendering (seamless desktop
7780	integration) is supported.
7781	</desc>
7782	</attribute>
7783
7784	<attribute name="supportsGraphics" type="boolean" readonly="yes">
7785	<desc>
7786	Flag whether the guest is in graphics mode. If it is not, then
7787	seamless rendering will not work, resize hints are not immediately
7788	acted on and guest display resizes are probably not initiated by
7789	the guest additions.
7790	</desc>
7791	</attribute>
7792
7793	<attribute name="memoryBalloonSize" type="unsigned long">
7794	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
7795	</attribute>
7796
7797	<attribute name="pageFusionEnabled" type="boolean">
7798	<desc>Flag whether page fusion is enabled or not.</desc>
7799	</attribute>
7800
7801	<attribute name="statisticsUpdateInterval" type="unsigned long">
7802	<desc>Interval to update guest statistics in seconds.</desc>
7803	</attribute>
7804
7805	<method name="internalGetStatistics">
7806	<desc>
7807	Internal method; do not use as it might change at any time
7808	</desc>
7809	<param name="cpuUser" type="unsigned long" dir="out">
7810	<desc>Percentage of processor time spent in user mode as seen by the guest</desc>
7811	</param>
7812	<param name="cpuKernel" type="unsigned long" dir="out">
7813	<desc>Percentage of processor time spent in kernel mode as seen by the guest</desc>
7814	</param>
7815	<param name="cpuIdle" type="unsigned long" dir="out">
7816	<desc>Percentage of processor time spent idling as seen by the guest</desc>
7817	</param>
7818	<param name="memTotal" type="unsigned long" dir="out">
7819	<desc>Total amount of physical guest RAM</desc>
7820	</param>
7821	<param name="memFree" type="unsigned long" dir="out">
7822	<desc>Free amount of physical guest RAM</desc>
7823	</param>
7824	<param name="memBalloon" type="unsigned long" dir="out">
7825	<desc>Amount of ballooned physical guest RAM</desc>
7826	</param>
7827	<param name="memShared" type="unsigned long" dir="out">
7828	<desc>Amount of shared physical guest RAM</desc>
7829	</param>
7830	<param name="memCache" type="unsigned long" dir="out">
7831	<desc>Total amount of guest (disk) cache memory</desc>
7832	</param>
7833	<param name="pagedTotal" type="unsigned long" dir="out">
7834	<desc>Total amount of space in the page file</desc>
7835	</param>
7836	<param name="memAllocTotal" type="unsigned long" dir="out">
7837	<desc>Total amount of memory allocated by the hypervisor</desc>
7838	</param>
7839	<param name="memFreeTotal" type="unsigned long" dir="out">
7840	<desc>Total amount of free memory available in the hypervisor</desc>
7841	</param>
7842	<param name="memBalloonTotal" type="unsigned long" dir="out">
7843	<desc>Total amount of memory ballooned by the hypervisor</desc>
7844	</param>
7845	<param name="memSharedTotal" type="unsigned long" dir="out">
7846	<desc>Total amount of shared memory in the hypervisor</desc>
7847	</param>
7848	</method>
7849
7850	<method name="setCredentials">
7851	<desc>
7852	Store login credentials that can be queried by guest operating
7853	systems with Additions installed. The credentials are transient
7854	to the session and the guest may also choose to erase them. Note
7855	that the caller cannot determine whether the guest operating system
7856	has queried or made use of the credentials.
7857
7858	<result name="VBOX_E_VM_ERROR">
7859	VMM device is not available.
7860	</result>
7861
7862	</desc>
7863	<param name="userName" type="wstring" dir="in">
7864	<desc>User name string, can be empty</desc>
7865	</param>
7866	<param name="password" type="wstring" dir="in">
7867	<desc>Password string, can be empty</desc>
7868	</param>
7869	<param name="domain" type="wstring" dir="in">
7870	<desc>Domain name (guest logon scheme specific), can be empty</desc>
7871	</param>
7872	<param name="allowInteractiveLogon" type="boolean" dir="in">
7873	<desc>
7874	Flag whether the guest should alternatively allow the user to
7875	interactively specify different credentials. This flag might
7876	not be supported by all versions of the Additions.
7877	</desc>
7878	</param>
7879	</method>
7880
7881	<method name="executeProcess">
7882	<desc>
7883	Executes an existing program inside the guest VM.
7884
7885	<result name="VBOX_E_IPRT_ERROR">
7886	Could not execute process.
7887	</result>
7888
7889	</desc>
7890	<param name="execName" type="wstring" dir="in">
7891	<desc>
7892	Full path name of the command to execute on the guest; the
7893	commands has to exists in the guest VM in order to be executed.
7894	</desc>
7895	</param>
7896	<param name="flags" type="unsigned long" dir="in">
7897	<desc>
7898	Execution flags - currently not supported and therefore
7899	has to be set to 0.
7900	</desc>
7901	</param>
7902	<param name="arguments" type="wstring" safearray="yes" dir="in">
7903	<desc>
7904	Array of arguments passed to the execution command.
7905	</desc>
7906	</param>
7907	<param name="environment" type="wstring" safearray="yes" dir="in">
7908	<desc>
7909	Environment variables that can be set while the command is being
7910	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
7911	variable just set its name ("NAME") without a value.
7912	</desc>
7913	</param>
7914	<param name="userName" type="wstring" dir="in">
7915	<desc>
7916	User name under which the command will be executed; has to exist
7917	and have the appropriate rights to execute programs in the VM.
7918	</desc>
7919	</param>
7920	<param name="password" type="wstring" dir="in">
7921	<desc>
7922	Password of the user account specified.
7923	</desc>
7924	</param>
7925	<param name="timeoutMS" type="unsigned long" dir="in">
7926	<desc>
7927	The maximum timeout value (in msec) to wait for finished program
7928	execution. Pass 0 for an infinite timeout.
7929	</desc>
7930	</param>
7931	<param name="pid" type="unsigned long" dir="out">
7932	<desc>
7933	The PID (process ID) of the started command for later reference.
7934	</desc>
7935	</param>
7936	<param name="progress" type="IProgress" dir="return">
7937	<desc>Progress object to track the operation completion.</desc>
7938	</param>
7939	</method>
7940
7941	<method name="getProcessOutput">
7942	<desc>
7943	Retrieves output of a formerly started process.
7944
7945	<result name="VBOX_E_IPRT_ERROR">
7946	Could not retrieve output.
7947	</result>
7948
7949	</desc>
7950	<param name="pid" type="unsigned long" dir="in">
7951	<desc>
7952	Process id returned by earlier executeProcess() call.
7953	</desc>
7954	</param>
7955	<param name="flags" type="unsigned long" dir="in">
7956	<desc>
7957	Flags describing which output to retrieve.
7958	</desc>
7959	</param>
7960	<param name="timeoutMS" type="unsigned long" dir="in">
7961	<desc>
7962	The maximum timeout value (in msec) to wait for output
7963	data. Pass 0 for an infinite timeout.
7964	</desc>
7965	</param>
7966	<param name="size" type="unsigned long long" dir="in">
7967	<desc>
7968	Size in bytes to read in the buffer.
7969	</desc>
7970	</param>
7971	<param name="data" type="octet" dir="return" safearray="yes">
7972	<desc>
7973	Buffer for retrieving the actual output. A data size of 0 means end of file
7974	if the requested size was not 0. This is the unprocessed
7975	output data, i.e. the line ending style depends on the platform of
7976	the system the server is running on.
7977	</desc>
7978	</param>
7979	</method>
7980
7981	<method name="getProcessStatus">
7982	<desc>
7983	Retrieves status, exit code and the exit reason of a formerly started process.
7984
7985	<result name="VBOX_E_IPRT_ERROR">
7986	Process with specified PID was not found.
7987	</result>
7988
7989	</desc>
7990	<param name="pid" type="unsigned long" dir="in">
7991	<desc>
7992	Process id returned by earlier executeProcess() call.
7993	</desc>
7994	</param>
7995	<param name="exitcode" type="unsigned long" dir="out">
7996	<desc>
7997	The exit code (if available).
7998	</desc>
7999	</param>
8000	<param name="flags" type="unsigned long" dir="out">
8001	<desc>
8002	Additional flags of process status (not used at the moment).
8003	</desc>
8004	</param>
8005	<param name="reason" type="unsigned long" dir="return">
8006	<desc>
8007	The current process status.
8008	</desc>
8009	</param>
8010	</method>
8011
8012	</interface>
8013
8014
8015	<!--
8016	// IProgress
8017	/////////////////////////////////////////////////////////////////////////
8018	-->
8019
8020	<interface
8021	name="IProgress" extends="$unknown"
8022	uuid="856aa038-853f-42e2-acf7-6e7b02dbe294"
8023	wsmap="managed"
8024	>
8025	<desc>
8026	The IProgress interface is used to track and control
8027	asynchronous tasks within VirtualBox.
8028
8029	An instance of this is returned every time VirtualBox starts
8030	an asynchronous task (in other words, a separate thread) which
8031	continues to run after a method call returns. For example,
8032	<link to="IConsole::saveState" />, which saves the state of
8033	a running virtual machine, can take a long time to complete.
8034	To be able to display a progress bar, a user interface such as
8035	the VirtualBox graphical user interface can use the IProgress
8036	object returned by that method.
8037
8038	Note that IProgress is a "read-only" interface in the sense
8039	that only the VirtualBox internals behind the Main API can
8040	create and manipulate progress objects, whereas client code
8041	can only use the IProgress object to monitor a task's
8042	progress and, if <link to="#cancelable" /> is @c true,
8043	cancel the task by calling <link to="#cancel" />.
8044
8045	A task represented by IProgress consists of either one or
8046	several sub-operations that run sequentially, one by one (see
8047	<link to="#operation" /> and <link to="#operationCount" />).
8048	Every operation is identified by a number (starting from 0)
8049	and has a separate description.
8050
8051	You can find the individual percentage of completion of the current
8052	operation in <link to="#operationPercent" /> and the
8053	percentage of completion of the task as a whole
8054	in <link to="#percent" />.
8055
8056	Similarly, you can wait for the completion of a particular
8057	operation via <link to="#waitForOperationCompletion" /> or
8058	for the completion of the whole task via
8059	<link to="#waitForCompletion" />.
8060	</desc>
8061
8062	<attribute name="id" type="uuid" mod="string" readonly="yes">
8063	<desc>ID of the task.</desc>
8064	</attribute>
8065
8066	<attribute name="description" type="wstring" readonly="yes">
8067	<desc>Description of the task.</desc>
8068	</attribute>
8069
8070	<attribute name="initiator" type="$unknown" readonly="yes">
8071	<desc>Initiator of the task.</desc>
8072	</attribute>
8073
8074	<attribute name="cancelable" type="boolean" readonly="yes">
8075	<desc>Whether the task can be interrupted.</desc>
8076	</attribute>
8077
8078	<attribute name="percent" type="unsigned long" readonly="yes">
8079	<desc>
8080	Current progress value of the task as a whole, in percent.
8081	This value depends on how many operations are already complete.
8082	Returns 100 if <link to="#completed" /> is @c true.
8083	</desc>
8084	</attribute>
8085
8086	<attribute name="timeRemaining" type="long" readonly="yes">
8087	<desc>
8088	Estimated remaining time until the task completes, in
8089	seconds. Returns 0 once the task has completed; returns -1
8090	if the remaining time cannot be computed, in particular if
8091	the current progress is 0.
8092
8093	Even if a value is returned, the estimate will be unreliable
8094	for low progress values. It will become more reliable as the
8095	task progresses; it is not recommended to display an ETA
8096	before at least 20% of a task have completed.
8097	</desc>
8098	</attribute>
8099
8100	<attribute name="completed" type="boolean" readonly="yes">
8101	<desc>Whether the task has been completed.</desc>
8102	</attribute>
8103
8104	<attribute name="canceled" type="boolean" readonly="yes">
8105	<desc>Whether the task has been canceled.</desc>
8106	</attribute>
8107
8108	<attribute name="resultCode" type="long" readonly="yes">
8109	<desc>
8110	Result code of the progress task.
8111	Valid only if <link to="#completed"/> is @c true.
8112	</desc>
8113	</attribute>
8114
8115	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8116	<desc>
8117	Extended information about the unsuccessful result of the
8118	progress operation. May be @c null if no extended information
8119	is available.
8120	Valid only if <link to="#completed"/> is @c true and
8121	<link to="#resultCode"/> indicates a failure.
8122	</desc>
8123	</attribute>
8124
8125	<attribute name="operationCount" type="unsigned long" readonly="yes">
8126	<desc>
8127	Number of sub-operations this task is divided into.
8128	Every task consists of at least one suboperation.
8129	</desc>
8130	</attribute>
8131
8132	<attribute name="operation" type="unsigned long" readonly="yes">
8133	<desc>Number of the sub-operation being currently executed.</desc>
8134	</attribute>
8135
8136	<attribute name="operationDescription" type="wstring" readonly="yes">
8137	<desc>
8138	Description of the sub-operation being currently executed.
8139	</desc>
8140	</attribute>
8141
8142	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8143	<desc>Progress value of the current sub-operation only, in percent.</desc>
8144	</attribute>
8145
8146	<attribute name="timeout" type="unsigned long">
8147	<desc>
8148	When non-zero, this specifies the number of milliseconds after which
8149	the operation will automatically be canceled. This can only be set on
8150	cancelable objects.
8151	</desc>
8152	</attribute>
8153
8154	<method name="setCurrentOperationProgress">
8155	<desc>Internal method, not to be called externally.</desc>
8156	<param name="percent" type="unsigned long" dir="in" />
8157	</method>
8158	<method name="setNextOperation">
8159	<desc>Internal method, not to be called externally.</desc>
8160	<param name="nextOperationDescription" type="wstring" dir="in" />
8161	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8162	</method>
8163
8164	<method name="waitForCompletion">
8165	<desc>
8166	Waits until the task is done (including all sub-operations)
8167	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8168
8169	<result name="VBOX_E_IPRT_ERROR">
8170	Failed to wait for task completion.
8171	</result>
8172	</desc>
8173
8174	<param name="timeout" type="long" dir="in">
8175	<desc>
8176	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8177	</desc>
8178	</param>
8179	</method>
8180
8181	<method name="waitForOperationCompletion">
8182	<desc>
8183	Waits until the given operation is done with a given timeout in
8184	milliseconds; specify -1 for an indefinite wait.
8185
8186	<result name="VBOX_E_IPRT_ERROR">
8187	Failed to wait for operation completion.
8188	</result>
8189
8190	</desc>
8191	<param name="operation" type="unsigned long" dir="in">
8192	<desc>
8193	Number of the operation to wait for.
8194	Must be less than <link to="#operationCount"/>.
8195	</desc>
8196	</param>
8197	<param name="timeout" type="long" dir="in">
8198	<desc>
8199	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8200	</desc>
8201	</param>
8202	</method>
8203
8204	<method name="cancel">
8205	<desc>
8206	Cancels the task.
8207	<note>
8208	If <link to="#cancelable"/> is @c false, then this method will fail.
8209	</note>
8210
8211	<result name="VBOX_E_INVALID_OBJECT_STATE">
8212	Operation cannot be canceled.
8213	</result>
8214
8215	</desc>
8216	</method>
8217
8218	</interface>
8219
8220	<!--
8221	// ISnapshot
8222	/////////////////////////////////////////////////////////////////////////
8223	-->
8224
8225	<interface
8226	name="ISnapshot" extends="$unknown"
8227	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8228	wsmap="managed"
8229	>
8230	<desc>
8231	The ISnapshot interface represents a snapshot of the virtual
8232	machine.
8233
8234	Together with the differencing media that are created
8235	when a snapshot is taken, a machine can be brought back to
8236	the exact state it was in when the snapshot was taken.
8237
8238	The ISnapshot interface has no methods, only attributes; snapshots
8239	are controlled through methods of the <link to="IConsole" /> interface
8240	which also manage the media associated with the snapshot.
8241	The following operations exist:
8242
8243	<ul>
8244	<li><link to="IConsole::takeSnapshot"/>: creates a new snapshot
8245	by creating new, empty differencing images for the machine's
8246	media and saving the VM settings and (if the VM is running)
8247	the current VM state in the snapshot.
8248
8249	The differencing images will then receive all data written to
8250	the machine's media, while their parent (base) images
8251	remain unmodified after the snapshot has been taken (see
8252	<link to="IMedium" /> for details about differencing images).
8253	This simplifies restoring a machine to the state of a snapshot:
8254	only the differencing images need to be deleted.
8255
8256	The current machine state is not changed by taking a snapshot.
8257	If the machine is running, it will resume execution after the
8258	snapshot has been taken.
8259	</li>
8260
8261	<li><link to="IConsole::restoreSnapshot"/>: this goes back to
8262	a previous snapshot. This resets the machine's state to that of
8263	the previous snapshot by deleting the differencing image of each
8264	of the machine's media and setting the machine's settings
8265	and state to the state that was saved in the snapshot (if any).
8266
8267	This destroys the machine's current state.
8268	</li>
8269
8270	<li><link to="IConsole::deleteSnapshot"/>: deletes a snapshot
8271	without affecting the current machine state.
8272
8273	This does not change the machine, but instead frees the resources
8274	allocated when the snapshot was taken: the settings and machine state
8275	is deleted (if any), and the snapshot's differencing image for each
8276	of the machine's media gets merged with its parent image.
8277
8278	Neither the current machine state nor other snapshots are affected
8279	by this operation, except that parent media will be modified
8280	to contain the disk data associated with the snapshot being deleted.
8281	</li>
8282	</ul>
8283
8284	Each snapshot contains the settings of the virtual machine (hardware
8285	configuration etc.). In addition, if the machine was running when the
8286	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8287	the current VM state is saved in the snapshot (similarly to what happens
8288	when a VM's state is saved). The snapshot is then said to
8289	be <i>online</i> because when restoring it, the VM will be running.
8290
8291	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
8292	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8293
8294	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8295	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8296	it then contains a so-called "zero execution state", representing a
8297	machine that is powered off.
8298
8299	<h3>Snapshot branches and the "current" snapshot</h3>
8300
8301	Snapshots can be chained, whereby every next snapshot is based on the
8302	previous one. This chaining is related to medium branching
8303	(see the <link to="IMedium"/> description) in that every time
8304	a new snapshot is created, a new differencing medium is implicitly
8305	created for all normal media attached to the machine.
8306
8307	Each virtual machine has a "current snapshot", identified by
8308	<link to="IMachine::currentSnapshot"/>. Presently, this is always set
8309	to the last snapshot in the chain. In a future version of VirtualBox,
8310	it will be possible to reset a machine's current state to that of an
8311	earlier snapshot without deleting the current state so that it will be
8312	possible to create alternative snapshot paths in a snapshot tree.
8313
8314	In the current implementation, multiple snapshot branches within one
8315	virtual machine are not allowed. Every machine has a single branch,
8316	and <link to="IConsole::takeSnapshot"/> operation adds a new
8317	snapshot to the top of that branch.
8318	</desc>
8319
8320	<attribute name="id" type="uuid" mod="string" readonly="yes">
8321	<desc>UUID of the snapshot.</desc>
8322	</attribute>
8323
8324	<attribute name="name" type="wstring">
8325	<desc>Short name of the snapshot.</desc>
8326	</attribute>
8327
8328	<attribute name="description" type="wstring">
8329	<desc>Optional description of the snapshot.</desc>
8330	</attribute>
8331
8332	<attribute name="timeStamp" type="long long" readonly="yes">
8333	<desc>
8334	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8335	</desc>
8336	</attribute>
8337
8338	<attribute name="online" type="boolean" readonly="yes">
8339	<desc>
8340	@c true if this snapshot is an online snapshot and @c false otherwise.
8341
8342	When this attribute is @c true, the
8343	<link to="IMachine::stateFilePath"/> attribute of the
8344	<link to="#machine"/> object associated with this snapshot
8345	will point to the saved state file. Otherwise, it will be
8346	an empty string.
8347	</desc>
8348	</attribute>
8349
8350	<attribute name="machine" type="IMachine" readonly="yes">
8351	<desc>
8352	Virtual machine this snapshot is taken on. This object
8353	stores all settings the machine had when taking this snapshot.
8354	<note>
8355	The returned machine object is immutable, i.e. no
8356	any settings can be changed.
8357	</note>
8358	</desc>
8359	</attribute>
8360
8361	<attribute name="parent" type="ISnapshot" readonly="yes">
8362	<desc>
8363	Parent snapshot (a snapshot this one is based on), or
8364	@c null if the snapshot has no parent (i.e. is the first snapshot).
8365	</desc>
8366	</attribute>
8367
8368	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8369	<desc>
8370	Child snapshots (all snapshots having this one as a parent).
8371	</desc>
8372	</attribute>
8373
8374	</interface>
8375
8376
8377	<!--
8378	// IMedium
8379	/////////////////////////////////////////////////////////////////////////
8380	-->
8381
8382	<enum
8383	name="MediumState"
8384	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8385	>
8386	<desc>
8387	Virtual medium state.
8388	<see>IMedium</see>
8389	</desc>
8390
8391	<const name="NotCreated" value="0">
8392	<desc>
8393	Associated medium storage does not exist (either was not created yet or
8394	was deleted).
8395	</desc>
8396	</const>
8397	<const name="Created" value="1">
8398	<desc>
8399	Associated storage exists and accessible; this gets set if the
8400	accessibility check performed by <link to="IMedium::refreshState" />
8401	was successful.
8402	</desc>
8403	</const>
8404	<const name="LockedRead" value="2">
8405	<desc>
8406	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8407	no data modification is possible.
8408	</desc>
8409	</const>
8410	<const name="LockedWrite" value="3">
8411	<desc>
8412	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8413	no concurrent data reading or modification is possible.
8414	</desc>
8415	</const>
8416	<const name="Inaccessible" value="4">
8417	<desc>
8418	Medium accessiblity check (see <link to="IMedium::refreshState" />) has
8419	not yet been performed, or else, associated medium storage is not
8420	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8421	is empty, in the second case, it describes the error that occured.
8422	</desc>
8423	</const>
8424	<const name="Creating" value="5">
8425	<desc>
8426	Associated medium storage is being created.
8427	</desc>
8428	</const>
8429	<const name="Deleting" value="6">
8430	<desc>
8431	Associated medium storage is being deleted.
8432	</desc>
8433	</const>
8434	</enum>
8435
8436	<enum
8437	name="MediumType"
8438	uuid="46bf1fd4-ad86-4ded-8c49-28bd2d148e5a"
8439	>
8440	<desc>
8441	Virtual medium type.
8442	<see>IMedium</see>
8443	</desc>
8444
8445	<const name="Normal" value="0">
8446	<desc>
8447	Normal medium (attached directly or indirectly, preserved
8448	when taking snapshots).
8449	</desc>
8450	</const>
8451	<const name="Immutable" value="1">
8452	<desc>
8453	Immutable medium (attached indirectly, changes are wiped out
8454	the next time the virtual machine is started).
8455	</desc>
8456	</const>
8457	<const name="Writethrough" value="2">
8458	<desc>
8459	Write through medium (attached directly, ignored when
8460	taking snapshots).
8461	</desc>
8462	</const>
8463	<const name="Shareable" value="3">
8464	<desc>
8465	Allow using this medium concurrently by several machines.
8466	<note>This is a stub value. Not usable until this note is removed.</note>
8467	</desc>
8468	</const>
8469	</enum>
8470
8471	<enum
8472	name="MediumVariant"
8473	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8474	>
8475	<desc>
8476	Virtual medium image variant. More than one flag may be set.
8477	<see>IMedium</see>
8478	</desc>
8479
8480	<const name="Standard" value="0">
8481	<desc>
8482	No particular variant requested, results in using the backend default.
8483	</desc>
8484	</const>
8485	<const name="VmdkSplit2G" value="0x01">
8486	<desc>
8487	VMDK image split in chunks of less than 2GByte.
8488	</desc>
8489	</const>
8490	<const name="VmdkStreamOptimized" value="0x04">
8491	<desc>
8492	VMDK streamOptimized image. Special import/export format which is
8493	read-only/append-only.
8494	</desc>
8495	</const>
8496	<const name="VmdkESX" value="0x08">
8497	<desc>
8498	VMDK format variant used on ESX products.
8499	</desc>
8500	</const>
8501	<const name="Fixed" value="0x10000">
8502	<desc>
8503	Fixed image. Only allowed for base images.
8504	</desc>
8505	</const>
8506	<const name="Diff" value="0x20000">
8507	<desc>
8508	Fixed image. Only allowed for base images.
8509	</desc>
8510	</const>
8511	</enum>
8512
8513	<interface
8514	name="IMediumAttachment" extends="$unknown"
8515	uuid="e58eb3eb-8627-428b-bdf8-34487c848de5"
8516	wsmap="struct"
8517	>
8518	<desc>
8519	The IMediumAttachment interface represents the attachment
8520	of a storage medium to a virtual machine. Each machine contains
8521	an array of its medium attachments in <link to="IMachine::mediumAttachments"/>.
8522
8523	Each medium attachment specifies a storage controller as well as a port
8524	and device number. Fixed media (hard disks) will always also specify
8525	an instance of IMedium in <link to="#medium" />, referring to the hard disk
8526	medium. For removeable media, the IMedia instance is optional; it can be
8527	@c null if no media is mounted (see <link to="IMachine::mountMedium" />).
8528	</desc>
8529
8530	<attribute name="medium" type="IMedium" readonly="yes">
8531	<desc>Medium object associated with this attachment; it
8532	can be @c null for removable devices.</desc>
8533	</attribute>
8534
8535	<attribute name="controller" type="wstring" readonly="yes">
8536	<desc>Name of the storage controller of this attachment; this
8537	refers to one of the controllers in <link to="IMachine::storageControllers" />
8538	by name.</desc>
8539	</attribute>
8540
8541	<attribute name="port" type="long" readonly="yes">
8542	<desc>Port number of this attachment.
8543	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8544	</desc>
8545	</attribute>
8546
8547	<attribute name="device" type="long" readonly="yes">
8548	<desc>Device slot number of this attachment.
8549	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8550	</desc>
8551	</attribute>
8552
8553	<attribute name="type" type="DeviceType" readonly="yes">
8554	<desc>Device type of this attachment.</desc>
8555	</attribute>
8556
8557	<attribute name="passthrough" type="boolean" readonly="yes">
8558	<desc>Pass I/O requests through to a device on the host.</desc>
8559	</attribute>
8560
8561	</interface>
8562
8563	<interface
8564	name="IMedium" extends="$unknown"
8565	uuid="1d578f43-5ef1-4415-b556-7592d3ccdc8f"
8566	wsmap="managed"
8567	>
8568	<desc>
8569	The IMedium interface represents virtual storage for a machine's
8570	hard disks, CD/DVD or floppy drives. It will typically represent
8571	a disk image on the host, for example a VDI or VMDK file representing
8572	a virtual hard disk, or an ISO or RAW file representing virtual
8573	removable media, but can also point to a network location (e.g.
8574	for iSCSI targets).
8575
8576	Instances of IMedium are connected to virtual machines by way of
8577	medium attachments (see <link to="IMediumAttachment" />), which link
8578	the storage medium to a particular device slot of a storage controller
8579	of the virtual machine.
8580	In the VirtualBox API, virtual storage is therefore always represented
8581	by the following chain of object links:
8582
8583	<ul>
8584	<li><link to="IMachine::storageControllers"/> contains an array of
8585	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
8586	these are instances of <link to="IStorageController"/>).</li>
8587	<li><link to="IMachine::mediumAttachments"/> contains an array of
8588	medium attachments (instances of <link to="IMediumAttachment"/>),
8589	each containing a storage controller from the above array, a
8590	port/device specification, and an instance of IMedium representing
8591	the medium storage (image file).
8592
8593	For removable media, the storage medium is optional; a medium
8594	attachment with no medium represents a CD/DVD or floppy drive
8595	with no medium inserted. By contrast, hard disk attachments
8596	will always have an IMedium object attached.</li>
8597	<li>Each IMedium in turn points to a storage unit (such as a file
8598	on the host computer or a network resource) that holds actual
8599	data. This location is represented by the <link to="#location"/>
8600	attribute.</li>
8601	</ul>
8602
8603	Existing media are opened using the following methods, depending on the
8604	media type:
8605	<ul>
8606	<li><link to="IVirtualBox::openHardDisk"/></li>
8607	<li><link to="IVirtualBox::openDVDImage"/></li>
8608	<li><link to="IVirtualBox::openFloppyImage"/></li>
8609	</ul>
8610
8611	New hard disk media can be created with the VirtualBox API using the
8612	<link to="IVirtualBox::createHardDisk"/> method.
8613
8614	CD/DVD and floppy images (ISO and RAW files) are usually created outside
8615	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
8616	type in a regular file.
8617
8618	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
8619	drive; in that case the <link to="#id" /> attribute contains the UUID of
8620	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
8621
8622	<h3>Known media</h3>
8623
8624	When an existing medium is opened for the first time, it is automatically
8625	remembered by the given VirtualBox installation or, in other words, becomes
8626	a <i>known medium</i>. Known media are stored in the media
8627	registry transparently maintained by VirtualBox and stored in settings
8628	files so that this registry is preserved when VirtualBox is not running.
8629
8630	Newly created virtual media are remembered only when the associated
8631	storage unit is actually created.
8632
8633	All known media can be enumerated using
8634	<link to="IVirtualBox::hardDisks"/>,
8635	<link to="IVirtualBox::DVDImages"/> and
8636	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
8637	quickly found by UUID using <link to="IVirtualBox::getHardDisk"/>
8638	and similar methods or by location using
8639	<link to="IVirtualBox::findHardDisk"/> and similar methods.
8640
8641	Only known media can be attached to virtual machines.
8642
8643	Removing known media from the media registry is performed when the given
8644	medium is closed using the <link to="#close"/> method or when its
8645	associated storage unit is deleted.
8646
8647	<h3>Accessibility checks</h3>
8648
8649	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
8650	method is called explicitly on a medium. This is done to make the VirtualBox object
8651	ready for serving requests as fast as possible and let the end-user
8652	application decide if it needs to check media accessibility right away or not.
8653
8654	As a result, when VirtualBox starts up (e.g. the VirtualBox
8655	object gets created for the first time), all known media are in the
8656	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
8657	attribute is an empty string because no actual accessibility check has
8658	been made yet.
8659
8660	After calling <link to="#refreshState" />, a medium is considered
8661	<i>accessible</i> if its storage unit can be read. In that case, the
8662	<link to="#state"/> attribute has a value of "Created". If the storage
8663	unit cannot be read (for example, because it is located on a disconnected
8664	network resource, or was accidentally deleted outside VirtualBox),
8665	the medium is considered <i>inaccessible</i>, which is indicated by the
8666	"Inaccessible" state. The exact reason why the medium is inaccessible can be
8667	obtained by reading the <link to="#lastAccessError"/> attribute.
8668
8669	<h3>Medium types</h3>
8670
8671	There are three types of medium behavior (see <link to="MediumType" />):
8672	"normal", "immutable" and "writethrough", represented by the
8673	<link to="#type"/> attribute. The type of the medium defines how the
8674	medium is attached to a virtual machine and what happens when a
8675	<link to="ISnapshot">snapshot</link> of the virtual machine with the
8676	attached medium is taken. At the moment DVD and floppy media are always
8677	of type "writethrough".
8678
8679	All media can be also divided in two groups: <i>base</i> media and
8680	<i>differencing</i> media. A base medium contains all sectors of the
8681	medium data in its own storage and therefore can be used independently.
8682	In contrast, a differencing mediun is a "delta" to some other medium and
8683	contains only those sectors which differ from that other medium, which is
8684	then called a <i>parent</i>. The differencing medium is said to be
8685	<i>linked to</i> that parent. The parent may be itself a differencing
8686	medium, thus forming a chain of linked media. The last element in that
8687	chain must always be a base medium. Note that several differencing
8688	media may be linked to the same parent medium.
8689
8690	Differencing media can be distinguished from base media by querying the
8691	<link to="#parent"/> attribute: base media do not have parents they would
8692	depend on, so the value of this attribute is always @c null for them.
8693	Using this attribute, it is possible to walk up the medium tree (from the
8694	child medium to its parent). It is also possible to walk down the tree
8695	using the <link to="#children"/> attribute.
8696
8697	Note that the type of all differencing media is "Normal"; all other
8698	values are meaningless for them. Base media may be of any type.
8699
8700	<h3>Creating hard disks</h3>
8701
8702	New base hard disks are created using
8703	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
8704	opened using <link to="IVirtualBox::openHardDisk"/>. Differencing hard
8705	disks are usually implicitly created by VirtualBox when needed but may
8706	also be created explicitly using <link to="#createDiffStorage"/>.
8707
8708	After the hard disk is successfully created (including the storage unit)
8709	or opened, it becomes a known hard disk (remembered in the internal media
8710	registry). Known hard disks can be attached to a virtual machine, accessed
8711	through <link to="IVirtualBox::getHardDisk"/> and
8712	<link to="IVirtualBox::findHardDisk"/> methods or enumerated using the
8713	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
8714
8715	The following methods, besides <link to="IMedium::close"/>,
8716	automatically remove the hard disk from the media registry:
8717	<ul>
8718	<li><link to="#deleteStorage"/></li>
8719	<li><link to="#mergeTo"/></li>
8720	</ul>
8721
8722	If the storage unit of the hard disk is a regular file in the host's
8723	file system then the rules stated in the description of the
8724	<link to="IMedium::location"/> attribute apply when setting its value. In
8725	addition, a plain file name without any path may be given, in which case
8726	the <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
8727	folder</link> will be prepended to it.
8728
8729	<h4>Automatic composition of the file name part</h4>
8730
8731	Another extension to the <link to="IMedium::location"/> attribute is that
8732	there is a possibility to cause VirtualBox to compose a unique value for
8733	the file name part of the location using the UUID of the hard disk. This
8734	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
8735	e.g. before the storage unit is created, and works as follows. You set the
8736	value of the <link to="IMedium::location"/> attribute to a location
8737	specification which only contains the path specification but not the file
8738	name part and ends with either a forward slash or a backslash character.
8739	In response, VirtualBox will generate a new UUID for the hard disk and
8740	compose the file name using the following pattern:
8741	<pre>
8742	<path>/{<uuid>}.<ext>
8743	</pre>
8744	where <tt><path></tt> is the supplied path specification,
8745	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
8746	is the default extension for the storage format of this hard disk. After
8747	that, you may call any of the methods that create a new hard disk storage
8748	unit and they will use the generated UUID and file name.
8749
8750	<h3>Attaching Hard Disks</h3>
8751
8752	Hard disks are attached to virtual machines using the
8753	<link to="IMachine::attachDevice"/> method and detached using the
8754	<link to="IMachine::detachDevice"/> method. Depending on their
8755	<link to="#type"/>, hard disks are attached either
8756	<i>directly</i> or <i>indirectly</i>.
8757
8758	When a hard disk is being attached directly, it is associated with the
8759	virtual machine and used for hard disk operations when the machine is
8760	running. When a hard disk is being attached indirectly, a new differencing
8761	hard disk linked to it is implicitly created and this differencing hard
8762	disk is associated with the machine and used for hard disk operations.
8763	This also means that if <link to="IMachine::attachDevice"/> performs
8764	a direct attachment then the same hard disk will be returned in response
8765	to the subsequent <link to="IMachine::getMedium"/> call; however if
8766	an indirect attachment is performed then
8767	<link to="IMachine::getMedium"/> will return the implicitly created
8768	differencing hard disk, not the original one passed to <link
8769	to="IMachine::attachDevice"/>. In detail:
8770
8771	<ul>
8772	<li><b>Normal base</b> hard disks that do not have children (i.e.
8773	differencing hard disks linked to them) and that are not already
8774	attached to virtual machines in snapshots are attached <b>directly</b>.
8775	Otherwise, they are attached <b>indirectly</b> because having
8776	dependent children or being part of the snapshot makes it impossible
8777	to modify hard disk contents without breaking the integrity of the
8778	dependent party. The <link to="#readOnly"/> attribute allows to
8779	quickly determine the kind of the attachment for the given hard
8780	disk. Note that if a normal base hard disk is to be indirectly
8781	attached to a virtual machine with snapshots then a special
8782	procedure called <i>smart attachment</i> is performed (see below).</li>
8783	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
8784	they are attached <b>directly</b> if they do not have children and are
8785	not attached to virtual machines in snapshots, and <b>indirectly</b>
8786	otherwise. Note that the smart attachment procedure is never performed
8787	for differencing hard disks.</li>
8788	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
8789	they are designed to be non-writable. If an immutable hard disk is
8790	attached to a virtual machine with snapshots then a special
8791	procedure called smart attachment is performed (see below).</li>
8792	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
8793	also as designed. This also means that writethrough hard disks cannot
8794	have other hard disks linked to them at all.</li>
8795	</ul>
8796
8797	Note that the same hard disk, regardless of its type, may be attached to
8798	more than one virtual machine at a time. In this case, the machine that is
8799	started first gains exclusive access to the hard disk and attempts to
8800	start other machines having this hard disk attached will fail until the
8801	first machine is powered down.
8802
8803	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
8804	that the given hard disk remains associated with the given machine after a
8805	successful <link to="IMachine::detachDevice"/> call until
8806	<link to="IMachine::saveSettings"/> is called to save all changes to
8807	machine settings to disk. This deferring is necessary to guarantee that
8808	the hard disk configuration may be restored at any time by a call to
8809	<link to="IMachine::discardSettings"/> before the settings
8810	are saved (committed).
8811
8812	Note that if <link to="IMachine::discardSettings"/> is called after
8813	indirectly attaching some hard disks to the machine but before a call to
8814	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
8815	all differencing hard disks implicitly created by
8816	<link to="IMachine::attachDevice"/> for these indirect attachments.
8817	Such implicitly created hard disks will also be immediately deleted when
8818	detached explicitly using the <link to="IMachine::detachDevice"/>
8819	call if it is made before <link to="IMachine::saveSettings"/>. This
8820	implicit deletion is safe because newly created differencing hard
8821	disks do not contain any user data.
8822
8823	However, keep in mind that detaching differencing hard disks that were
8824	implicitly created by <link to="IMachine::attachDevice"/>
8825	before the last <link to="IMachine::saveSettings"/> call will
8826	<b>not</b> implicitly delete them as they may already contain some data
8827	(for example, as a result of virtual machine execution). If these hard
8828	disks are no more necessary, the caller can always delete them explicitly
8829	using <link to="#deleteStorage"/> after they are actually de-associated
8830	from this machine by the <link to="IMachine::saveSettings"/> call.
8831
8832	<h3>Smart Attachment</h3>
8833
8834	When normal base or immutable hard disks are indirectly attached to a
8835	virtual machine then some additional steps are performed to make sure the
8836	virtual machine will have the most recent "view" of the hard disk being
8837	attached. These steps include walking through the machine's snapshots
8838	starting from the current one and going through ancestors up to the first
8839	snapshot. Hard disks attached to the virtual machine in all
8840	of the encountered snapshots are checked whether they are descendants of
8841	the given normal base or immutable hard disk. The first found child (which
8842	is the differencing hard disk) will be used instead of the normal base or
8843	immutable hard disk as a parent for creating a new differencing hard disk
8844	that will be actually attached to the machine. And only if no descendants
8845	are found or if the virtual machine does not have any snapshots then the
8846	normal base or immutable hard disk will be used itself as a parent for
8847	this differencing hard disk.
8848
8849	It is easier to explain what smart attachment does using the
8850	following example:
8851	<pre>
8852	BEFORE attaching B.vdi: AFTER attaching B.vdi:
8853
8854	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
8855	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
8856	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
8857	Snapshot 4 (none) Snapshot 4 (none)
8858	CurState (none) CurState (D3->D2.vdi)
8859
8860	NOT
8861	...
8862	CurState (D3->B.vdi)
8863	</pre>
8864	The first column is the virtual machine configuration before the base hard
8865	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
8866	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
8867	mean that the hard disk that is actually attached to the machine is a
8868	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
8869	another hard disk, <tt>B.vdi</tt>.
8870
8871	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
8872	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
8873	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
8874	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
8875	it cannot be attached directly and needs an indirect attachment (i.e.
8876	implicit creation of a new differencing hard disk). Due to the smart
8877	attachment procedure, the new differencing hard disk
8878	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
8879	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
8880	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
8881	machine.
8882
8883	Note that if there is more than one descendant hard disk of the given base
8884	hard disk found in a snapshot, and there is an exact device, channel and
8885	bus match, then this exact match will be used. Otherwise, the youngest
8886	descendant will be picked up.
8887
8888	There is one more important aspect of the smart attachment procedure which
8889	is not related to snapshots at all. Before walking through the snapshots
8890	as described above, the backup copy of the current list of hard disk
8891	attachment is searched for descendants. This backup copy is created when
8892	the hard disk configuration is changed for the first time after the last
8893	<link to="IMachine::saveSettings"/> call and used by
8894	<link to="IMachine::discardSettings"/> to undo the recent hard disk
8895	changes. When such a descendant is found in this backup copy, it will be
8896	simply re-attached back, without creating a new differencing hard disk for
8897	it. This optimization is necessary to make it possible to re-attach the
8898	base or immutable hard disk to a different bus, channel or device slot
8899	without losing the contents of the differencing hard disk actually
8900	attached to the machine in place of it.
8901	</desc>
8902
8903	<attribute name="id" type="uuid" mod="string" readonly="yes">
8904	<desc>
8905	UUID of the medium. For a newly created medium, this value is a randomly
8906	generated UUID.
8907
8908	<note>
8909	For media in one of MediumState_NotCreated, MediumState_Creating or
8910	MediumState_Deleting states, the value of this property is undefined
8911	and will most likely be an empty UUID.
8912	</note>
8913	</desc>
8914	</attribute>
8915
8916	<attribute name="description" type="wstring">
8917	<desc>
8918	Optional description of the medium. For a newly created medium the value
8919	of this attribute is an empty string.
8920
8921	Medium types that don't support this attribute will return E_NOTIMPL in
8922	attempt to get or set this attribute's value.
8923
8924	<note>
8925	For some storage types, reading this attribute may return an outdated
8926	(last known) value when <link to="#state"/> is <link
8927	to="MediumState_Inaccessible"/> or <link
8928	to="MediumState_LockedWrite"/> because the value of this attribute is
8929	stored within the storage unit itself. Also note that changing the
8930	attribute value is not possible in such case, as well as when the
8931	medium is the <link to="MediumState_LockedRead"/> state.
8932	</note>
8933	</desc>
8934	</attribute>
8935
8936	<attribute name="state" type="MediumState" readonly="yes">
8937	<desc>
8938	Returns the current medium state, which is the last state set by
8939	the accessibility check performed by <link to="#refreshState"/>.
8940	If that method has not yet been called on the medium, the state
8941	is "Inaccessible"; as opposed to truly inaccessible media, the
8942	value of <link to="#lastAccessError"/> will be an empty string in
8943	that case.
8944
8945	<note>As of version 3.1, this no longer performs an accessibility check
8946	automatically; call <link to="#refreshState"/> for that.
8947	</note>
8948	</desc>
8949	</attribute>
8950
8951	<attribute name="location" type="wstring">
8952	<desc>
8953	Location of the storage unit holding medium data.
8954
8955	The format of the location string is medium type specific. For medium
8956	types using regular files in a host's file system, the location
8957	string is the full file name.
8958
8959	Some medium types may support changing the storage unit location by
8960	simply changing the value of this property. If this operation is not
8961	supported, the implementation will return E_NOTIMPL in attempt to set
8962	this attribute's value.
8963
8964	When setting a value of the location attribute which is a regular file
8965	in the host's file system, the given file name may be either relative to
8966	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
8967	absolute. Note that if the given location specification does not contain
8968	the file extension part then a proper default extension will be
8969	automatically appended by the implementation depending on the medium type.
8970	</desc>
8971	</attribute>
8972
8973	<attribute name="name" type="wstring" readonly="yes">
8974	<desc>
8975	Name of the storage unit holding medium data.
8976
8977	The returned string is a short version of the <link to="#location"/>
8978	attribute that is suitable for representing the medium in situations
8979	where the full location specification is too long (such as lists
8980	and comboboxes in GUI frontends). This string is also used by frontends
8981	to sort the media list alphabetically when needed.
8982
8983	For example, for locations that are regular files in the host's file
8984	system, the value of this attribute is just the file name (+ extension),
8985	without the path specification.
8986
8987	Note that as opposed to the <link to="#location"/> attribute, the name
8988	attribute will not necessary be unique for a list of media of the
8989	given type and format.
8990	</desc>
8991	</attribute>
8992
8993	<attribute name="deviceType" type="DeviceType" readonly="yes">
8994	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
8995	medium.</desc>
8996	</attribute>
8997
8998	<attribute name="hostDrive" type="boolean" readonly="yes">
8999	<desc>True if this corresponds to a drive on the host.</desc>
9000	</attribute>
9001
9002	<attribute name="size" type="unsigned long long" readonly="yes">
9003	<desc>
9004	Physical size of the storage unit used to hold medium data (in bytes).
9005
9006	<note>
9007	For media whose <link to="#state"/> is <link
9008	to="MediumState_Inaccessible"/>, the value of this property is the
9009	last known size. For <link to="MediumState_NotCreated"/> media,
9010	the returned value is zero.
9011	</note>
9012	</desc>
9013	</attribute>
9014
9015	<attribute name="format" type="wstring" readonly="yes">
9016	<desc>
9017	Storage format of this medium.
9018
9019	The value of this attribute is a string that specifies a backend used
9020	to store medium data. The storage format is defined when you create a
9021	new medium or automatically detected when you open an existing medium,
9022	and cannot be changed later.
9023
9024	The list of all storage formats supported by this VirtualBox
9025	installation can be obtained using
9026	<link to="ISystemProperties::mediumFormats"/>.
9027	</desc>
9028	</attribute>
9029
9030	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9031	<desc>
9032	Storage medium format object corresponding to this medium.
9033
9034	The value of this attribute is a reference to the medium format object
9035	that specifies the backend properties used to store medium data. The
9036	storage format is defined when you create a new medium or automatically
9037	detected when you open an existing medium, and cannot be changed later.
9038
9039	<note>@c null is returned if there is no associated medium format
9040	object. This can e.g. happen for medium objects representing host
9041	drives and other special medium objects.</note>
9042	</desc>
9043	</attribute>
9044
9045	<attribute name="type" type="MediumType">
9046	<desc>
9047	Type (role) of this medium.
9048
9049	The following constraints apply when changing the value of this
9050	attribute:
9051	<ul>
9052	<li>If a medium is attached to a virtual machine (either in the
9053	current state or in one of the snapshots), its type cannot be
9054	changed.
9055	</li>
9056	<li>As long as the medium has children, its type cannot be set
9057	to <link to="MediumType_Writethrough"/>.
9058	</li>
9059	<li>The type of all differencing media is
9060	<link to="MediumType_Normal"/> and cannot be changed.
9061	</li>
9062	</ul>
9063
9064	The type of a newly created or opened medium is set to
9065	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9066	which have a type of <link to="MediumType_Writethrough"/>.
9067	</desc>
9068	</attribute>
9069
9070	<attribute name="parent" type="IMedium" readonly="yes">
9071	<desc>
9072	Parent of this medium (the medium this medium is directly based
9073	on).
9074
9075	Only differencing media have parents. For base (non-differencing)
9076	media, @c null is returned.
9077	</desc>
9078	</attribute>
9079
9080	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9081	<desc>
9082	Children of this medium (all differencing media directly based
9083	on this medium). A @c null array is returned if this medium
9084	does not have any children.
9085	</desc>
9086	</attribute>
9087
9088	<attribute name="base" type="IMedium" readonly="yes">
9089	<desc>
9090	Base medium of this medium.
9091
9092	If this is a differencing medium, its base medium is the medium
9093	the given medium branch starts from. For all other types of media, this
9094	property returns the medium object itself (i.e. the same object this
9095	property is read on).
9096	</desc>
9097	</attribute>
9098
9099	<attribute name="readOnly" type="boolean" readonly="yes">
9100	<desc>
9101	Returns @c true if this medium is read-only and @c false otherwise.
9102
9103	A medium is considered to be read-only when its contents cannot be
9104	modified without breaking the integrity of other parties that depend on
9105	this medium such as its child media or snapshots of virtual machines
9106	where this medium is attached to these machines. If there are no
9107	children and no such snapshots then there is no dependency and the
9108	medium is not read-only.
9109
9110	The value of this attribute can be used to determine the kind of the
9111	attachment that will take place when attaching this medium to a
9112	virtual machine. If the value is @c false then the medium will
9113	be attached directly. If the value is @c true then the medium
9114	will be attached indirectly by creating a new differencing child
9115	medium for that. See the interface description for more information.
9116
9117	Note that all <link to="MediumType_Immutable">Immutable</link> media
9118	are always read-only while all
9119	<link to="MediumType_Writethrough">Writethrough</link> media are
9120	always not.
9121
9122	<note>
9123	The read-only condition represented by this attribute is related to
9124	the medium type and usage, not to the current
9125	<link to="IMedium::state">medium state</link> and not to the read-only
9126	state of the storage unit.
9127	</note>
9128	</desc>
9129	</attribute>
9130
9131	<attribute name="logicalSize" type="unsigned long long" readonly="yes">
9132	<desc>
9133	Logical size of this medium (in megabytes), as reported to the
9134	guest OS running inside the virtual machine this medium is
9135	attached to. The logical size is defined when the medium is created
9136	and cannot be changed later.
9137
9138	<note>
9139	Reading this property on a differencing medium will return the size
9140	of its <link to="#base"/> medium.
9141	</note>
9142	<note>
9143	For media whose state is <link to="#state"/> is <link
9144	to="MediumState_Inaccessible"/>, the value of this property is the
9145	last known logical size. For <link to="MediumaState_NotCreated"/>
9146	media, the returned value is zero.
9147	</note>
9148	</desc>
9149	</attribute>
9150
9151	<attribute name="autoReset" type="boolean">
9152	<desc>
9153	Whether this differencing medium will be automatically reset each
9154	time a virtual machine it is attached to is powered up. This
9155	attribute is automatically set to @c true for the last
9156	differencing image of an "immutable" medium (see
9157	<link to="MediumType" />).
9158
9159	See <link to="#reset"/> for more information about resetting
9160	differencing media.
9161
9162	<note>
9163	Reading this property on a base (non-differencing) medium will
9164	always @c false. Changing the value of this property in this
9165	case is not supported.
9166	</note>
9167
9168	<result name="VBOX_E_NOT_SUPPORTED">
9169	This is not a differencing medium (when changing the attribute
9170	value).
9171	</result>
9172	</desc>
9173	</attribute>
9174
9175	<attribute name="lastAccessError" type="wstring" readonly="yes">
9176	<desc>
9177	Text message that represents the result of the last accessibility
9178	check performed by <link to="#refreshState"/>.
9179
9180	An empty string is returned if the last accessibility check
9181	was successful or has not yet been called. As a result, if
9182	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9183	then <link to="#refreshState"/> has yet to be called; this is the
9184	default value of media after VirtualBox initialization.
9185	A non-empty string indicates a failure and should normally describe
9186	a reason of the failure (for example, a file read error).
9187	</desc>
9188	</attribute>
9189
9190	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9191	<desc>
9192	Array of UUIDs of all machines this medium is attached to.
9193
9194	A @c null array is returned if this medium is not attached to any
9195	machine or to any machine's snapshot.
9196
9197	<note>
9198	The returned array will include a machine even if this medium is not
9199	attached to that machine in the current state but attached to it in
9200	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9201	details.
9202	</note>
9203	</desc>
9204	</attribute>
9205
9206	<method name="refreshState">
9207	<desc>
9208	If the current medium state (see <link to="MediumState"/>) is one of
9209	"Created", "Inaccessible" or "LockedRead", then this performs an
9210	accessibility check on the medium and sets the value of the <link to="#state"/>
9211	attribute accordingly; that value is also returned for convenience.
9212
9213	For all other state values, this does not perform a refresh but returns
9214	the state only.
9215
9216	The refresh, if performed, may take a long time (several seconds or even
9217	minutes, depending on the storage unit location and format) because it performs an
9218	accessibility check of the storage unit. This check may cause a significant
9219	delay if the storage unit of the given medium is, for example, a file located
9220	on a network share which is not currently accessible due to connectivity
9221	problems. In that case, the call will not return until a timeout
9222	interval defined by the host OS for this operation expires. For this reason,
9223	it is recommended to never read this attribute on the main UI thread to avoid
9224	making the UI unresponsive.
9225
9226	If the last known state of the medium is "Created" and the accessibility
9227	check fails, then the state would be set to "Inaccessible", and
9228	<link to="#lastAccessError"/> may be used to get more details about the
9229	failure. If the state of the medium is "LockedRead", then it remains the
9230	same, and a non-empty value of <link to="#lastAccessError"/> will
9231	indicate a failed accessibility check in this case.
9232
9233	Note that not all medium states are applicable to all medium types.
9234	</desc>
9235	<param name="state" type="MediumState" dir="return">
9236	<desc>
9237	New medium state.
9238	</desc>
9239	</param>
9240	</method>
9241
9242	<method name="getSnapshotIds">
9243	<desc>
9244	Returns an array of UUIDs of all snapshots of the given machine where
9245	this medium is attached to.
9246
9247	If the medium is attached to the machine in the current state, then the
9248	first element in the array will always be the ID of the queried machine
9249	(i.e. the value equal to the @c machineId argument), followed by
9250	snapshot IDs (if any).
9251
9252	If the medium is not attached to the machine in the current state, then
9253	the array will contain only snapshot IDs.
9254
9255	The returned array may be @c null if this medium is not attached
9256	to the given machine at all, neither in the current state nor in one of
9257	the snapshots.
9258	</desc>
9259	<param name="machineId" type="uuid" mod="string" dir="in">
9260	<desc>
9261	UUID of the machine to query.
9262	</desc>
9263	</param>
9264	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9265	<desc>
9266	Array of snapshot UUIDs of the given machine using this medium.
9267	</desc>
9268	</param>
9269	</method>
9270
9271	<method name="lockRead">
9272	<desc>
9273	Locks this medium for reading.
9274
9275	A read lock is shared: many clients can simultaneously lock the
9276	same medium for reading unless it is already locked for writing (see
9277	<link to="#lockWrite"/>) in which case an error is returned.
9278
9279	When the medium is locked for reading, it cannot be modified
9280	from within VirtualBox. This means that any method that changes
9281	the properties of this medium or contents of the storage unit
9282	will return an error (unless explicitly stated otherwise). That
9283	includes an attempt to start a virtual machine that wants to
9284	write to the the medium.
9285
9286	When the virtual machine is started up, it locks for reading all
9287	media it uses in read-only mode. If some medium cannot be locked
9288	for reading, the startup procedure will fail.
9289	A medium is typically locked for reading while it is used by a running
9290	virtual machine but has a depending differencing image that receives
9291	the actual write operations. This way one base medium can have
9292	multiple child differencing images which can be written to
9293	simultaneously. Read-only media such as DVD and floppy images are
9294	also locked for reading only (so they can be in use by multiple
9295	machines simultaneously).
9296
9297	A medium is also locked for reading when it is the source of a
9298	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9299
9300	The medium locked for reading must be unlocked using the <link
9301	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9302	can be nested and must be followed by the same number of paired
9303	<link to="#unlockRead"/> calls.
9304
9305	This method sets the medium state (see <link to="#state"/>) to
9306	"LockedRead" on success. The medium's previous state must be
9307	one of "Created", "Inaccessible" or "LockedRead".
9308
9309	Locking an inaccessible medium is not an error; this method performs
9310	a logical lock that prevents modifications of this medium through
9311	the VirtualBox API, not a physical file-system lock of the underlying
9312	storage unit.
9313
9314	This method returns the current state of the medium
9315	<i>before</i> the operation.
9316
9317	<result name="VBOX_E_INVALID_OBJECT_STATE">
9318	Invalid medium state (e.g. not created, locked, inaccessible,
9319	creating, deleting).
9320	</result>
9321
9322	</desc>
9323	<param name="state" type="MediumState" dir="return">
9324	<desc>
9325	State of the medium after the operation.
9326	</desc>
9327	</param>
9328	</method>
9329
9330	<method name="unlockRead">
9331	<desc>
9332	Cancels the read lock previously set by <link to="#lockRead"/>.
9333
9334	For both success and failure, this method returns the current state
9335	of the medium <i>after</i> the operation.
9336
9337	See <link to="#lockRead"/> for more details.
9338
9339	<result name="VBOX_E_INVALID_OBJECT_STATE">
9340	Medium not locked for reading.
9341	</result>
9342
9343	</desc>
9344	<param name="state" type="MediumState" dir="return">
9345	<desc>
9346	State of the medium after the operation.
9347	</desc>
9348	</param>
9349	</method>
9350
9351	<method name="lockWrite">
9352	<desc>
9353	Locks this medium for writing.
9354
9355	A write lock, as opposed to <link to="#lockRead"/>, is
9356	exclusive: there may be only one client holding a write lock,
9357	and there may be no read locks while the write lock is held.
9358	As a result, read-locking fails if a write lock is held, and
9359	write-locking fails if either a read or another write lock is held.
9360
9361	When a medium is locked for writing, it cannot be modified
9362	from within VirtualBox, and it is not guaranteed that the values
9363	of its properties are up-to-date. Any method that changes the
9364	properties of this medium or contents of the storage unit will
9365	return an error (unless explicitly stated otherwise).
9366
9367	When a virtual machine is started up, it locks for writing all
9368	media it uses to write data to. If any medium could not be locked
9369	for writing, the startup procedure will fail. If a medium has
9370	differencing images, then while the machine is running, only
9371	the last ("leaf") differencing image is locked for writing,
9372	whereas its parents are locked for reading only.
9373
9374	A medium is also locked for writing when it is the target of a
9375	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9376
9377	The medium locked for writing must be unlocked using the <link
9378	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9379
9380	This method sets the medium state (see <link to="#state"/>) to
9381	"LockedWrite" on success. The medium's previous state must be
9382	either "Created" or "Inaccessible".
9383
9384	Locking an inaccessible medium is not an error; this method performs
9385	a logical lock that prevents modifications of this medium through
9386	the VirtualBox API, not a physical file-system lock of the underlying
9387	storage unit.
9388
9389	For both, success and failure, this method returns the current
9390	state of the medium <i>before</i> the operation.
9391
9392	<result name="VBOX_E_INVALID_OBJECT_STATE">
9393	Invalid medium state (e.g. not created, locked, inaccessible,
9394	creating, deleting).
9395	</result>
9396
9397	</desc>
9398	<param name="state" type="MediumState" dir="return">
9399	<desc>
9400	State of the medium after the operation.
9401	</desc>
9402	</param>
9403	</method>
9404
9405	<method name="unlockWrite">
9406	<desc>
9407	Cancels the write lock previously set by <link to="#lockWrite"/>.
9408
9409	For both success and failure, this method returns the current
9410	state of the medium <i>after</i> the operation.
9411
9412	See <link to="#lockWrite"/> for more details.
9413
9414	<result name="VBOX_E_INVALID_OBJECT_STATE">
9415	Medium not locked for writing.
9416	</result>
9417
9418	</desc>
9419	<param name="state" type="MediumState" dir="return">
9420	<desc>
9421	State of the medium after the operation.
9422	</desc>
9423	</param>
9424	</method>
9425
9426	<method name="close">
9427	<desc>
9428	Closes this medium.
9429
9430	The medium must not be attached to any known virtual machine
9431	and must not have any known child media, otherwise the
9432	operation will fail.
9433
9434	When the medium is successfully closed, it gets removed from
9435	the list of remembered media, but its storage unit is not
9436	deleted. In particular, this means that this medium can be
9437	later opened again using the <link
9438	to="IVirtualBox::openHardDisk"/> call.
9439
9440	Note that after this method successfully returns, the given medium
9441	object becomes uninitialized. This means that any attempt
9442	to call any of its methods or attributes will fail with the
9443	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9444
9445	<result name="VBOX_E_INVALID_OBJECT_STATE">
9446	Invalid medium state (other than not created, created or
9447	inaccessible).
9448	</result>
9449	<result name="VBOX_E_OBJECT_IN_USE">
9450	Medium attached to virtual machine.
9451	</result>
9452	<result name="VBOX_E_FILE_ERROR">
9453	Settings file not accessible.
9454	</result>
9455	<result name="VBOX_E_XML_ERROR">
9456	Could not parse the settings file.
9457	</result>
9458
9459	</desc>
9460	</method>
9461
9462	<!-- storage methods -->
9463
9464	<method name="getProperty">
9465	<desc>
9466	Returns the value of the custom medium property with the given name.
9467
9468	The list of all properties supported by the given medium format can
9469	be obtained with <link to="IMediumFormat::describeProperties"/>.
9470
9471	Note that if this method returns an empty string in @a value, the
9472	requested property is supported but currently not assigned any value.
9473
9474	<result name="VBOX_E_OBJECT_NOT_FOUND">
9475	Requested property does not exist (not supported by the format).
9476	</result>
9477	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9478	</desc>
9479	<param name="name" type="wstring" dir="in">
9480	<desc>Name of the property to get.</desc>
9481	</param>
9482	<param name="value" type="wstring" dir="return">
9483	<desc>Current property value.</desc>
9484	</param>
9485	</method>
9486
9487	<method name="setProperty">
9488	<desc>
9489	Sets the value of the custom medium property with the given name.
9490
9491	The list of all properties supported by the given medium format can
9492	be obtained with <link to="IMediumFormat::describeProperties"/>.
9493
9494	Note that setting the property value to @c null or an empty string is
9495	equivalent to deleting the existing value. A default value (if it is
9496	defined for this property) will be used by the format backend in this
9497	case.
9498
9499	<result name="VBOX_E_OBJECT_NOT_FOUND">
9500	Requested property does not exist (not supported by the format).
9501	</result>
9502	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9503	</desc>
9504	<param name="name" type="wstring" dir="in">
9505	<desc>Name of the property to set.</desc>
9506	</param>
9507	<param name="value" type="wstring" dir="in">
9508	<desc>Property value to set.</desc>
9509	</param>
9510	</method>
9511
9512	<method name="getProperties">
9513	<desc>
9514	Returns values for a group of properties in one call.
9515
9516	The names of the properties to get are specified using the @a names
9517	argument which is a list of comma-separated property names or
9518	an empty string if all properties are to be returned. Note that currently
9519	the value of this argument is ignored and the method always returns all
9520	existing properties.
9521
9522	The list of all properties supported by the given medium format can
9523	be obtained with <link to="IMediumFormat::describeProperties"/>.
9524
9525	The method returns two arrays, the array of property names corresponding
9526	to the @a names argument and the current values of these properties.
9527	Both arrays have the same number of elements with each elemend at the
9528	given index in the first array corresponds to an element at the same
9529	index in the second array.
9530
9531	Note that for properties that do not have assigned values,
9532	an empty string is returned at the appropriate index in the
9533	@a returnValues array.
9534
9535	</desc>
9536	<param name="names" type="wstring" dir="in">
9537	<desc>
9538	Names of properties to get.
9539	</desc>
9540	</param>
9541	<param name="returnNames" type="wstring" safearray="yes" dir="out">
9542	<desc>Names of returned properties.</desc>
9543	</param>
9544	<param name="returnValues" type="wstring" safearray="yes" dir="return">
9545	<desc>Values of returned properties.</desc>
9546	</param>
9547	</method>
9548
9549	<method name="setProperties">
9550	<desc>
9551	Sets values for a group of properties in one call.
9552
9553	The names of the properties to set are passed in the @a names
9554	array along with the new values for them in the @a values array. Both
9555	arrays have the same number of elements with each elemend at the given
9556	index in the first array corresponding to an element at the same index
9557	in the second array.
9558
9559	If there is at least one property name in @a names that is not valid,
9560	the method will fail before changing the values of any other properties
9561	from the @a names array.
9562
9563	Using this method over <link to="#setProperty"/> is preferred if you
9564	need to set several properties at once since it will result into less
9565	IPC calls.
9566
9567	The list of all properties supported by the given medium format can
9568	be obtained with <link to="IMediumFormat::describeProperties"/>.
9569
9570	Note that setting the property value to @c null or an empty string is
9571	equivalent to deleting the existing value. A default value (if it is
9572	defined for this property) will be used by the format backend in this
9573	case.
9574	</desc>
9575	<param name="names" type="wstring" safearray="yes" dir="in">
9576	<desc>Names of properties to set.</desc>
9577	</param>
9578	<param name="values" type="wstring" safearray="yes" dir="in">
9579	<desc>Values of properties to set.</desc>
9580	</param>
9581	</method>
9582
9583	<!-- storage methods -->
9584
9585	<method name="createBaseStorage">
9586	<desc>
9587	Starts creating a hard disk storage unit (fixed/dynamic, according
9588	to the variant flags) in in the background. The previous storage unit
9589	created for this object, if any, must first be deleted using
9590	<link to="#deleteStorage"/>, otherwise the operation will fail.
9591
9592	Before the operation starts, the medium is placed in
9593	<link to="MediumState_Creating"/> state. If the create operation
9594	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
9595	state.
9596
9597	After the returned progress object reports that the operation has
9598	successfully completed, the medium state will be set to <link
9599	to="MediumState_Created"/>, the medium will be remembered by this
9600	VirtualBox installation and may be attached to virtual machines.
9601
9602	<result name="VBOX_E_NOT_SUPPORTED">
9603	The variant of storage creation operation is not supported. See <link
9604	to="IMediumFormat::capabilities"/>.
9605	</result>
9606	</desc>
9607	<param name="logicalSize" type="unsigned long long" dir="in">
9608	<desc>Maximum logical size of the medium in megabytes.</desc>
9609	</param>
9610	<param name="variant" type="MediumVariant" dir="in">
9611	<desc>Exact image variant which should be created.</desc>
9612	</param>
9613	<param name="progress" type="IProgress" dir="return">
9614	<desc>Progress object to track the operation completion.</desc>
9615	</param>
9616	</method>
9617
9618	<method name="deleteStorage">
9619	<desc>
9620	Starts deleting the storage unit of this medium.
9621
9622	The medium must not be attached to any known virtual machine and must
9623	not have any known child media, otherwise the operation will fail.
9624	It will also fail if there is no storage unit to delete or if deletion
9625	is already in progress, or if the medium is being in use (locked for
9626	read or for write) or inaccessible. Therefore, the only valid state for
9627	this operation to succeed is <link to="MediumState_Created"/>.
9628
9629	Before the operation starts, the medium is placed in
9630	<link to="MediumState_Deleting"/> state and gets removed from the list
9631	of remembered hard disks (media registry). If the delete operation
9632	fails, the medium will be remembered again and placed back to
9633	<link to="MediumState_Created"/> state.
9634
9635	After the returned progress object reports that the operation is
9636	complete, the medium state will be set to
9637	<link to="MediumState_NotCreated"/> and you will be able to use one of
9638	the storage creation methods to create it again.
9639
9640	<see>#close()</see>
9641
9642	<result name="VBOX_E_OBJECT_IN_USE">
9643	Medium is attached to a virtual machine.
9644	</result>
9645	<result name="VBOX_E_NOT_SUPPORTED">
9646	Storage deletion is not allowed because neither of storage creation
9647	operations are supported. See
9648	<link to="IMediumFormat::capabilities"/>.
9649	</result>
9650
9651	<note>
9652	If the deletion operation fails, it is not guaranteed that the storage
9653	unit still exists. You may check the <link to="IMedium::state"/> value
9654	to answer this question.
9655	</note>
9656	</desc>
9657	<param name="progress" type="IProgress" dir="return">
9658	<desc>Progress object to track the operation completion.</desc>
9659	</param>
9660	</method>
9661
9662	<!-- diff methods -->
9663
9664	<method name="createDiffStorage">
9665	<desc>
9666	Starts creating an empty differencing storage unit based on this
9667	medium in the format and at the location defined by the @a target
9668	argument.
9669
9670	The target medium must be in <link to="MediumState_NotCreated"/>
9671	state (i.e. must not have an existing storage unit). Upon successful
9672	completion, this operation will set the type of the target medium to
9673	<link to="MediumType_Normal"/> and create a storage unit necessary to
9674	represent the differencing medium data in the given format (according
9675	to the storage format of the target object).
9676
9677	After the returned progress object reports that the operation is
9678	successfully complete, the target medium gets remembered by this
9679	VirtualBox installation and may be attached to virtual machines.
9680
9681	<note>
9682	The medium will be set to <link to="MediumState_LockedRead"/>
9683	state for the duration of this operation.
9684	</note>
9685	<result name="VBOX_E_OBJECT_IN_USE">
9686	Medium not in @c NotCreated state.
9687	</result>
9688	</desc>
9689	<param name="target" type="IMedium" dir="in">
9690	<desc>Target medium.</desc>
9691	</param>
9692	<param name="variant" type="MediumVariant" dir="in">
9693	<desc>Exact image variant which should be created.</desc>
9694	</param>
9695	<param name="progress" type="IProgress" dir="return">
9696	<desc>Progress object to track the operation completion.</desc>
9697	</param>
9698	</method>
9699
9700	<method name="mergeTo">
9701	<desc>
9702	Starts merging the contents of this medium and all intermediate
9703	differencing media in the chain to the given target medium.
9704
9705	The target medium must be either a descendant of this medium or
9706	its ancestor (otherwise this method will immediately return a failure).
9707	It follows that there are two logical directions of the merge operation:
9708	from ancestor to descendant (<i>forward merge</i>) and from descendant to
9709	ancestor (<i>backward merge</i>). Let us consider the following medium
9710	chain:
9711
9712	<pre>Base <- Diff_1 <- Diff_2</pre>
9713
9714	Here, calling this method on the <tt>Base</tt> medium object with
9715	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
9716	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
9717	merge. Note that in both cases the contents of the resulting medium
9718	will be the same, the only difference is the medium object that takes
9719	the result of the merge operation. In case of the forward merge in the
9720	above example, the result will be written to <tt>Diff_2</tt>; in case of
9721	the backward merge, the result will be written to <tt>Base</tt>. In
9722	other words, the result of the operation is always stored in the target
9723	medium.
9724
9725	Upon successful operation completion, the storage units of all media in
9726	the chain between this (source) medium and the target medium, including
9727	the source medium itself, will be automatically deleted and the
9728	relevant medium objects (including this medium) will become
9729	uninitialized. This means that any attempt to call any of
9730	their methods or attributes will fail with the
9731	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
9732	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
9733	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
9734	Note that <tt>Diff_2</tt> in this case will become a base medium
9735	itself since it will no longer be based on any other medium.
9736
9737	Considering the above, all of the following conditions must be met in
9738	order for the merge operation to succeed:
9739	<ul>
9740	<li>
9741	Neither this (source) medium nor any intermediate
9742	differencing medium in the chain between it and the target
9743	medium is attached to any virtual machine.
9744	</li>
9745	<li>
9746	Neither the source medium nor the target medium is an
9747	<link to="MediumType_Immutable"/> medium.
9748	</li>
9749	<li>
9750	The part of the medium tree from the source medium to the
9751	target medium is a linear chain, i.e. all medium in this
9752	chain have exactly one child which is the next medium in this
9753	chain. The only exception from this rule is the target medium in
9754	the forward merge operation; it is allowed to have any number of
9755	child media because the merge operation will not change its
9756	logical contents (as it is seen by the guest OS or by children).
9757	</li>
9758	<li>
9759	None of the involved media are in
9760	<link to="MediumState_LockedRead"/> or
9761	<link to="MediumState_LockedWrite"/> state.
9762	</li>
9763	</ul>
9764
9765	<note>
9766	This (source) medium and all intermediates will be placed to <link
9767	to="MediumState_Deleting"/> state and the target medium will be
9768	placed to <link to="MediumState_LockedWrite"/> state and for the
9769	duration of this operation.
9770	</note>
9771	</desc>
9772	<param name="target" type="IMedium" dir="in">
9773	<desc>Target medium.</desc>
9774	</param>
9775	<param name="progress" type="IProgress" dir="return">
9776	<desc>Progress object to track the operation completion.</desc>
9777	</param>
9778	</method>
9779
9780	<!-- clone method -->
9781
9782	<method name="cloneTo">
9783	<desc>
9784	Starts creating a clone of this medium in the format and at the
9785	location defined by the @a target argument.
9786
9787	The target medium must be either in <link to="MediumState_NotCreated"/>
9788	state (i.e. must not have an existing storage unit) or in
9789	<link to="MediumState_Created"/> state (i.e. created and not locked, and
9790	big enough to hold the data or else the copy will be partial). Upon
9791	successful completion, the cloned medium will contain exactly the
9792	same sector data as the medium being cloned, except that in the
9793	first case a new UUID for the clone will be randomly generated, and in
9794	the second case the UUID will remain unchanged.
9795
9796	The @a parent argument defines which medium will be the parent
9797	of the clone. Passing a @c null reference indicates that the clone will
9798	be a base image, i.e. completely independent. It is possible to specify
9799	an arbitrary medium for this parameter, including the parent of the
9800	medium which is being cloned. Even cloning to a child of the source
9801	medium is possible. Note that when cloning to an existing image, the
9802	@a parent irgument is ignored.
9803
9804	After the returned progress object reports that the operation is
9805	successfully complete, the target medium gets remembered by this
9806	VirtualBox installation and may be attached to virtual machines.
9807
9808	<note>
9809	This medium will be placed to <link to="MediumState_LockedRead"/>
9810	state for the duration of this operation.
9811	</note>
9812	<result name="E_NOTIMPL">
9813	The specified cloning variant is not supported at the moment.
9814	</result>
9815	</desc>
9816	<param name="target" type="IMedium" dir="in">
9817	<desc>Target medium.</desc>
9818	</param>
9819	<param name="variant" type="MediumVariant" dir="in">
9820	<desc>Exact image variant which should be created.</desc>
9821	</param>
9822	<param name="parent" type="IMedium" dir="in">
9823	<desc>Parent of the cloned medium.</desc>
9824	</param>
9825	<param name="progress" type="IProgress" dir="return">
9826	<desc>Progress object to track the operation completion.</desc>
9827	</param>
9828	</method>
9829
9830	<!-- other methods -->
9831
9832	<method name="compact">
9833	<desc>
9834	Starts compacting of this medium. This means that the medium is
9835	transformed into a possibly more compact storage representation.
9836	This potentially creates temporary images, which can require a
9837	substantial amount of additional disk space.
9838
9839	This medium will be placed to <link to="MediumState_LockedWrite"/>
9840	state and all its parent media (if any) will be placed to
9841	<link to="MediumState_LockedRead"/> state for the duration of this
9842	operation.
9843
9844	Please note that the results can be either returned straight away,
9845	or later as the result of the background operation via the object
9846	returned via the @a progress parameter.
9847
9848	<result name="VBOX_E_NOT_SUPPORTED">
9849	Medium format does not support compacting (but potentially
9850	needs it).
9851	</result>
9852	</desc>
9853	<param name="progress" type="IProgress" dir="return">
9854	<desc>Progress object to track the operation completion.</desc>
9855	</param>
9856	</method>
9857
9858	<method name="resize">
9859	<desc>
9860	Starts resizing this medium. This means that the nominal size of the
9861	medium is set to the new value. Both increasing and decreasing the
9862	size is possible, and there are no safety checks, since VirtualBox
9863	does not make any assumptions about the medium contents.
9864
9865	Resizing usually needs additional disk space, and possibly also
9866	some temporary disk space. Note that resize does not create a full
9867	temporary copy of the medium, so the additional disk space requirement
9868	is usually much lower than using the clone operation.
9869
9870	This medium will be placed to <link to="MediumState_LockedWrite"/>
9871	state for the duration of this operation.
9872
9873	Please note that the results can be either returned straight away,
9874	or later as the result of the background operation via the object
9875	returned via the @a progress parameter.
9876
9877	<result name="VBOX_E_NOT_SUPPORTED">
9878	Medium format does not support resizing.
9879	</result>
9880	</desc>
9881	<param name="logicalSize" type="unsigned long long" dir="in">
9882	<desc>New nominal capacity of the medium in megabytes.</desc>
9883	</param>
9884	<param name="progress" type="IProgress" dir="return">
9885	<desc>Progress object to track the operation completion.</desc>
9886	</param>
9887	</method>
9888
9889	<method name="reset">
9890	<desc>
9891	Starts erasing the contents of this differencing medium.
9892
9893	This operation will reset the differencing medium to its initial
9894	state when it does not contain any sector data and any read operation is
9895	redirected to its parent medium. This automatically gets called
9896	during VM power-up for every medium whose <link to="#autoReset" />
9897	attribute is @c true.
9898
9899	The medium will be write-locked for the duration of this operation (see
9900	<link to="#lockWrite" />).
9901
9902	<result name="VBOX_E_NOT_SUPPORTED">
9903	This is not a differencing medium.
9904	</result>
9905	<result name="VBOX_E_INVALID_OBJECT_STATE">
9906	Medium is not in <link to="MediumState_Created"/> or
9907	<link to="MediumState_Inaccessible"/> state.
9908	</result>
9909	</desc>
9910	<param name="progress" type="IProgress" dir="return">
9911	<desc>Progress object to track the operation completion.</desc>
9912	</param>
9913	</method>
9914
9915	</interface>
9916
9917
9918	<!--
9919	// IMediumFormat
9920	/////////////////////////////////////////////////////////////////////////
9921	-->
9922
9923	<enum
9924	name="DataType"
9925	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
9926	>
9927	<const name="Int32" value="0"/>
9928	<const name="Int8" value="1"/>
9929	<const name="String" value="2"/>
9930	</enum>
9931
9932	<enum
9933	name="DataFlags"
9934	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
9935	>
9936	<const name="None" value="0x00"/>
9937	<const name="Mandatory" value="0x01"/>
9938	<const name="Expert" value="0x02"/>
9939	<const name="Array" value="0x04"/>
9940	<const name="FlagMask" value="0x07"/>
9941	</enum>
9942
9943	<enum
9944	name="MediumFormatCapabilities"
9945	uuid="70fcf810-99e8-4edc-aee4-7f51d489e657"
9946	>
9947	<desc>
9948	Medium format capability flags.
9949	</desc>
9950
9951	<const name="Uuid" value="0x01">
9952	<desc>
9953	Supports UUIDs as expected by VirtualBox code.
9954	</desc>
9955	</const>
9956
9957	<const name="CreateFixed" value="0x02">
9958	<desc>
9959	Supports creating fixed size images, allocating all space instantly.
9960	</desc>
9961	</const>
9962
9963	<const name="CreateDynamic" value="0x04">
9964	<desc>
9965	Supports creating dynamically growing images, allocating space on
9966	demand.
9967	</desc>
9968	</const>
9969
9970	<const name="CreateSplit2G" value="0x08">
9971	<desc>
9972	Supports creating images split in chunks of a bit less than 2 GBytes.
9973	</desc>
9974	</const>
9975
9976	<const name="Differencing" value="0x10">
9977	<desc>
9978	Supports being used as a format for differencing media (see <link
9979	to="IMedium::createDiffStorage"/>).
9980	</desc>
9981	</const>
9982
9983	<const name="Asynchronous" value="0x20">
9984	<desc>
9985	Supports asynchronous I/O operations for at least some configurations.
9986	</desc>
9987	</const>
9988
9989	<const name="File" value="0x40">
9990	<desc>
9991	The format backend operates on files (the <link to="IMedium::location"/>
9992	attribute of the medium specifies a file used to store medium
9993	data; for a list of supported file extensions see
9994	<link to="IMediumFormat::fileExtensions"/>).
9995	</desc>
9996	</const>
9997
9998	<const name="Properties" value="0x80">
9999	<desc>
10000	The format backend uses the property interface to configure the storage
10001	location and properties (the <link to="IMediumFormat::describeProperties"/>
10002	method is used to get access to properties supported by the given medium format).
10003	</desc>
10004	</const>
10005
10006	<const name="CapabilityMask" value="0xFF"/>
10007	</enum>
10008
10009	<interface
10010	name="IMediumFormat" extends="$unknown"
10011	uuid="89f52554-d469-4799-9fad-1705e86a08b1"
10012	wsmap="managed"
10013	>
10014	<desc>
10015	The IMediumFormat interface represents a medium format.
10016
10017	Each medium format has an associated backend which is used to handle
10018	media stored in this format. This interface provides information
10019	about the properties of the associated backend.
10020
10021	Each medium format is identified by a string represented by the
10022	<link to="#id"/> attribute. This string is used in calls like
10023	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10024	format.
10025
10026	The list of all supported medium formats can be obtained using
10027	<link to="ISystemProperties::mediaFormats"/>.
10028
10029	<see>IMedium</see>
10030	</desc>
10031
10032	<attribute name="id" type="wstring" readonly="yes">
10033	<desc>
10034	Identifier of this format.
10035
10036	The format identifier is a non-@c null non-empty ASCII string. Note that
10037	this string is case-insensitive. This means that, for example, all of
10038	the following strings:
10039	<pre>
10040	"VDI"
10041	"vdi"
10042	"VdI"</pre>
10043	refer to the same medium format.
10044
10045	This string is used in methods of other interfaces where it is necessary
10046	to specify a medium format, such as
10047	<link to="IVirtualBox::createHardDisk"/>.
10048	</desc>
10049	</attribute>
10050
10051	<attribute name="name" type="wstring" readonly="yes">
10052	<desc>
10053	Human readable description of this format.
10054
10055	Mainly for use in file open dialogs.
10056	</desc>
10057	</attribute>
10058
10059	<attribute name="fileExtensions" type="wstring" safearray="yes" readonly="yes">
10060	<desc>
10061	Array of strings containing the supported file extensions.
10062
10063	The first extension in the array is the extension preferred by the
10064	backend. It is recommended to use this extension when specifying a
10065	location of the storage unit for a new medium.
10066
10067	Note that some backends do not work on files, so this array may be
10068	empty.
10069
10070	<see>IMediumFormat::capabilities</see>
10071	</desc>
10072	</attribute>
10073
10074	<attribute name="capabilities" type="unsigned long" readonly="yes">
10075	<desc>
10076	Capabilities of the format as a set of bit flags.
10077
10078	For the meaning of individual capability flags see
10079	<link to="MediumFormatCapabilities"/>.
10080	</desc>
10081	</attribute>
10082
10083	<method name="describeProperties">
10084	<desc>
10085	Returns several arrays describing the properties supported by this
10086	format.
10087
10088	An element with the given index in each array describes one
10089	property. Thus, the number of elements in each returned array is the
10090	same and corresponds to the number of supported properties.
10091
10092	The returned arrays are filled in only if the
10093	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10094	All arguments must be non-@c null.
10095
10096	<see>DataType</see>
10097	<see>DataFlags</see>
10098	</desc>
10099
10100	<param name="names" type="wstring" safearray="yes" dir="out">
10101	<desc>Array of property names.</desc>
10102	</param>
10103	<param name="description" type="wstring" safearray="yes" dir="out">
10104	<desc>Array of property descriptions.</desc>
10105	</param>
10106	<param name="types" type="DataType" safearray="yes" dir="out">
10107	<desc>Array of property types.</desc>
10108	</param>
10109	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10110	<desc>Array of property flags.</desc>
10111	</param>
10112	<param name="defaults" type="wstring" safearray="yes" dir="out">
10113	<desc>Array of default property values.</desc>
10114	</param>
10115	</method>
10116
10117	</interface>
10118
10119
10120	<!--
10121	// IKeyboard
10122	/////////////////////////////////////////////////////////////////////////
10123	-->
10124
10125	<interface
10126	name="IKeyboard" extends="$unknown"
10127	uuid="2d1a531b-4c6e-49cc-8af6-5c857b78b5d7"
10128	wsmap="managed"
10129	>
10130	<desc>
10131	The IKeyboard interface represents the virtual machine's keyboard. Used
10132	in <link to="IConsole::keyboard"/>.
10133
10134	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10135	to the virtual machine.
10136
10137	</desc>
10138	<method name="putScancode">
10139	<desc>Sends a scancode to the keyboard.
10140
10141	<result name="VBOX_E_IPRT_ERROR">
10142	Could not send scan code to virtual keyboard.
10143	</result>
10144
10145	</desc>
10146	<param name="scancode" type="long" dir="in"/>
10147	</method>
10148
10149	<method name="putScancodes">
10150	<desc>Sends an array of scancodes to the keyboard.
10151
10152	<result name="VBOX_E_IPRT_ERROR">
10153	Could not send all scan codes to virtual keyboard.
10154	</result>
10155
10156	</desc>
10157	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10158	<param name="codesStored" type="unsigned long" dir="return"/>
10159	</method>
10160
10161	<method name="putCAD">
10162	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10163	function is nothing special, it is just a convenience function
10164	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10165
10166	<result name="VBOX_E_IPRT_ERROR">
10167	Could not send all scan codes to virtual keyboard.
10168	</result>
10169
10170	</desc>
10171	</method>
10172
10173	</interface>
10174
10175
10176	<!--
10177	// IMouse
10178	/////////////////////////////////////////////////////////////////////////
10179	-->
10180
10181	<enum
10182	name="MouseButtonState"
10183	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10184	>
10185	<desc>
10186	Mouse button state.
10187	</desc>
10188
10189	<const name="LeftButton" value="0x01"/>
10190	<const name="RightButton" value="0x02"/>
10191	<const name="MiddleButton" value="0x04"/>
10192	<const name="WheelUp" value="0x08"/>
10193	<const name="WheelDown" value="0x10"/>
10194	<const name="XButton1" value="0x20"/>
10195	<const name="XButton2" value="0x40"/>
10196	<const name="MouseStateMask" value="0x7F"/>
10197	</enum>
10198
10199	<interface
10200	name="IMouse" extends="$unknown"
10201	uuid="7c0f2eae-f92d-498c-b802-e1a3763774dc"
10202	wsmap="managed"
10203	>
10204	<desc>
10205	The IMouse interface represents the virtual machine's mouse. Used in
10206	<link to="IConsole::mouse"/>.
10207
10208	Through this interface, the virtual machine's virtual mouse can be
10209	controlled.
10210	</desc>
10211
10212	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10213	<desc>
10214	Whether the guest OS supports absolute mouse pointer positioning
10215	or not.
10216	<note>
10217	You can use the <link to="IMouseCapabilityChangedEvent"/>
10218	event to be instantly informed about changes of this attribute
10219	during virtual machine execution.
10220	</note>
10221	<see><link to="#putMouseEventAbsolute"/></see>
10222	</desc>
10223	</attribute>
10224
10225	<attribute name="relativeSupported" type="boolean" readonly="yes">
10226	<desc>
10227	Whether the guest OS supports relative mouse pointer positioning
10228	or not.
10229	<note>
10230	You can use the <link to="IMouseCapabilityChangedEvent"/>
10231	event to be instantly informed about changes of this attribute
10232	during virtual machine execution.
10233	</note>
10234	<see><link to="#putMouseEvent"/></see>
10235	</desc>
10236	</attribute>
10237
10238	<attribute name="needsHostCursor" type="boolean" readonly="yes">
10239	<desc>
10240	Whether the guest OS can currently switch to drawing it's own mouse
10241	cursor on demand.
10242	<note>
10243	You can use the <link to="IMouseCapabilityChangedEvent"/>
10244	event to be instantly informed about changes of this attribute
10245	during virtual machine execution.
10246	</note>
10247	<see><link to="#putMouseEvent"/></see>
10248	</desc>
10249	</attribute>
10250
10251	<method name="putMouseEvent">
10252	<desc>
10253	Initiates a mouse event using relative pointer movements
10254	along x and y axis.
10255
10256	<result name="E_ACCESSDENIED">
10257	Console not powered up.
10258	</result>
10259	<result name="VBOX_E_IPRT_ERROR">
10260	Could not send mouse event to virtual mouse.
10261	</result>
10262
10263	</desc>
10264
10265	<param name="dx" type="long" dir="in">
10266	<desc>
10267	Amount of pixels the mouse should move to the right.
10268	Negative values move the mouse to the left.
10269	</desc>
10270	</param>
10271	<param name="dy" type="long" dir="in">
10272	<desc>
10273	Amount of pixels the mouse should move downwards.
10274	Negative values move the mouse upwards.
10275	</desc>
10276	</param>
10277	<param name="dz" type="long" dir="in">
10278	<desc>
10279	Amount of mouse wheel moves.
10280	Positive values describe clockwise wheel rotations,
10281	negative values describe counterclockwise rotations.
10282	</desc>
10283	</param>
10284	<param name="dw" type="long" dir="in">
10285	<desc>
10286	Amount of horizontal mouse wheel moves.
10287	Positive values describe a movement to the left,
10288	negative values describe a movement to the right.
10289	</desc>
10290	</param>
10291	<param name="buttonState" type="long" dir="in">
10292	<desc>
10293	The current state of mouse buttons. Every bit represents
10294	a mouse button as follows:
10295	<table>
10296	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10297	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10298	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10299	</table>
10300	A value of <tt>1</tt> means the corresponding button is pressed.
10301	otherwise it is released.
10302	</desc>
10303	</param>
10304	</method>
10305
10306	<method name="putMouseEventAbsolute">
10307	<desc>
10308	Positions the mouse pointer using absolute x and y coordinates.
10309	These coordinates are expressed in pixels and
10310	start from <tt>[1,1]</tt> which corresponds to the top left
10311	corner of the virtual display.
10312
10313	<result name="E_ACCESSDENIED">
10314	Console not powered up.
10315	</result>
10316	<result name="VBOX_E_IPRT_ERROR">
10317	Could not send mouse event to virtual mouse.
10318	</result>
10319
10320	<note>
10321	This method will have effect only if absolute mouse
10322	positioning is supported by the guest OS.
10323	</note>
10324
10325	<see><link to="#absoluteSupported"/></see>
10326	</desc>
10327
10328	<param name="x" type="long" dir="in">
10329	<desc>
10330	X coordinate of the pointer in pixels, starting from @c 1.
10331	</desc>
10332	</param>
10333	<param name="y" type="long" dir="in">
10334	<desc>
10335	Y coordinate of the pointer in pixels, starting from @c 1.
10336	</desc>
10337	</param>
10338	<param name="dz" type="long" dir="in">
10339	<desc>
10340	Amount of mouse wheel moves.
10341	Positive values describe clockwise wheel rotations,
10342	negative values describe counterclockwise rotations.
10343	</desc>
10344	</param>
10345	<param name="dw" type="long" dir="in">
10346	<desc>
10347	Amount of horizontal mouse wheel moves.
10348	Positive values describe a movement to the left,
10349	negative values describe a movement to the right.
10350	</desc>
10351	</param>
10352	<param name="buttonState" type="long" dir="in">
10353	<desc>
10354	The current state of mouse buttons. Every bit represents
10355	a mouse button as follows:
10356	<table>
10357	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10358	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10359	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10360	</table>
10361	A value of @c 1 means the corresponding button is pressed.
10362	otherwise it is released.
10363	</desc>
10364	</param>
10365	</method>
10366
10367	</interface>
10368
10369	<!--
10370	// IDisplay
10371	/////////////////////////////////////////////////////////////////////////
10372	-->
10373
10374	<enum
10375	name="FramebufferPixelFormat"
10376	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10377	>
10378	<desc>
10379	Format of the video memory buffer. Constants represented by this enum can
10380	be used to test for particular values of <link
10381	to="IFramebuffer::pixelFormat"/>. See also <link
10382	to="IFramebuffer::requestResize"/>.
10383
10384	See also www.fourcc.org for more information about FOURCC pixel formats.
10385	</desc>
10386
10387	<const name="Opaque" value="0">
10388	<desc>
10389	Unknown buffer format (the user may not assume any particular format of
10390	the buffer).
10391	</desc>
10392	</const>
10393	<const name="FOURCC_RGB" value="0x32424752">
10394	<desc>
10395	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10396	bit layout).
10397	</desc>
10398	</const>
10399	</enum>
10400
10401	<interface
10402	name="IFramebuffer" extends="$unknown"
10403	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10404	wsmap="suppress"
10405	>
10406	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10407	<desc>Address of the start byte of the frame buffer.</desc>
10408	</attribute>
10409
10410	<attribute name="width" type="unsigned long" readonly="yes">
10411	<desc>Frame buffer width, in pixels.</desc>
10412	</attribute>
10413
10414	<attribute name="height" type="unsigned long" readonly="yes">
10415	<desc>Frame buffer height, in pixels.</desc>
10416	</attribute>
10417
10418	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10419	<desc>
10420	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10421	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10422	are: 8, 15, 16, 24 and 32.
10423	</desc>
10424	</attribute>
10425
10426	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10427	<desc>
10428	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10429	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10430	size of the scan line must be aligned to 32 bits.
10431	</desc>
10432	</attribute>
10433
10434	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10435	<desc>
10436	Frame buffer pixel format. It's either one of the values defined by <link
10437	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10438	<note>
10439	This attribute must never return <link
10440	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10441	<link to="#address"/> points to must be always known.
10442	</note>
10443	</desc>
10444	</attribute>
10445
10446	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10447	<desc>
10448	Defines whether this frame buffer uses the virtual video card's memory
10449	buffer (guest VRAM) directly or not. See <link
10450	to="IFramebuffer::requestResize"/> for more information.
10451	</desc>
10452	</attribute>
10453
10454	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10455	<desc>
10456	Hint from the frame buffer about how much of the standard
10457	screen height it wants to use for itself. This information is
10458	exposed to the guest through the VESA BIOS and VMMDev interface
10459	so that it can use it for determining its video mode table. It
10460	is not guaranteed that the guest respects the value.
10461	</desc>
10462	</attribute>
10463
10464	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10465	<desc>
10466	An alpha-blended overlay which is superposed over the frame buffer.
10467	The initial purpose is to allow the display of icons providing
10468	information about the VM state, including disk activity, in front
10469	ends which do not have other means of doing that. The overlay is
10470	designed to controlled exclusively by IDisplay. It has no locking
10471	of its own, and any changes made to it are not guaranteed to be
10472	visible until the affected portion of IFramebuffer is updated. The
10473	overlay can be created lazily the first time it is requested. This
10474	attribute can also return @c null to signal that the overlay is not
10475	implemented.
10476	</desc>
10477	</attribute>
10478
10479	<attribute name="winId" type="unsigned long long" readonly="yes">
10480	<desc>
10481	Platform-dependent identifier of the window where context of this
10482	frame buffer is drawn, or zero if there's no such window.
10483	</desc>
10484	</attribute>
10485
10486	<method name="lock">
10487	<desc>
10488	Locks the frame buffer.
10489	Gets called by the IDisplay object where this frame buffer is
10490	bound to.
10491	</desc>
10492	</method>
10493
10494	<method name="unlock">
10495	<desc>
10496	Unlocks the frame buffer.
10497	Gets called by the IDisplay object where this frame buffer is
10498	bound to.
10499	</desc>
10500	</method>
10501
10502	<method name="notifyUpdate">
10503	<desc>
10504	Informs about an update.
10505	Gets called by the display object where this buffer is
10506	registered.
10507	</desc>
10508	<param name="x" type="unsigned long" dir="in"/>
10509	<param name="y" type="unsigned long" dir="in"/>
10510	<param name="width" type="unsigned long" dir="in"/>
10511	<param name="height" type="unsigned long" dir="in"/>
10512	</method>
10513
10514	<method name="requestResize">
10515	<desc>
10516	Requests a size and pixel format change.
10517
10518	There are two modes of working with the video buffer of the virtual
10519	machine. The <i>indirect</i> mode implies that the IFramebuffer
10520	implementation allocates a memory buffer for the requested display mode
10521	and provides it to the virtual machine. In <i>direct</i> mode, the
10522	IFramebuffer implementation uses the memory buffer allocated and owned
10523	by the virtual machine. This buffer represents the video memory of the
10524	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
10525	usually faster because the implementation gets a raw pointer to the
10526	guest VRAM buffer which it can directly use for visualizing the contents
10527	of the virtual display, as opposed to the indirect mode where the
10528	contents of guest VRAM are copied to the memory buffer provided by
10529	the implementation every time a display update occurs.
10530
10531	It is important to note that the direct mode is really fast only when
10532	the implementation uses the given guest VRAM buffer directly, for
10533	example, by blitting it to the window representing the virtual machine's
10534	display, which saves at least one copy operation comparing to the
10535	indirect mode. However, using the guest VRAM buffer directly is not
10536	always possible: the format and the color depth of this buffer may be
10537	not supported by the target window, or it may be unknown (opaque) as in
10538	case of text or non-linear multi-plane VGA video modes. In this case,
10539	the indirect mode (that is always available) should be used as a
10540	fallback: when the guest VRAM contents are copied to the
10541	implementation-provided memory buffer, color and format conversion is
10542	done automatically by the underlying code.
10543
10544	The @a pixelFormat parameter defines whether the direct mode is
10545	available or not. If @a pixelFormat is <link
10546	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
10547	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
10548	@a bytesPerLine parameters must be ignored and the implementation must use
10549	the indirect mode (where it provides its own buffer in one of the
10550	supported formats). In all other cases, @a pixelFormat together with
10551	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
10552	buffer pointed to by the @a VRAM parameter and the implementation is
10553	free to choose which mode to use. To indicate that this frame buffer uses
10554	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
10555	attribute must return @c true and <link to="#address"/> must
10556	return exactly the same address that is passed in the @a VRAM parameter
10557	of this method; otherwise it is assumed that the indirect strategy is
10558	chosen.
10559
10560	The @a width and @a height parameters represent the size of the
10561	requested display mode in both modes. In case of indirect mode, the
10562	provided memory buffer should be big enough to store data of the given
10563	display mode. In case of direct mode, it is guaranteed that the given
10564	@a VRAM buffer contains enough space to represent the display mode of the
10565	given size. Note that this frame buffer's <link to="#width"/> and <link
10566	to="#height"/> attributes must return exactly the same values as
10567	passed to this method after the resize is completed (see below).
10568
10569	The @a finished output parameter determines if the implementation has
10570	finished resizing the frame buffer or not. If, for some reason, the
10571	resize cannot be finished immediately during this call, @a finished
10572	must be set to @c false, and the implementation must call
10573	<link to="IDisplay::resizeCompleted"/> after it has returned from
10574	this method as soon as possible. If @a finished is @c false, the
10575	machine will not call any frame buffer methods until
10576	<link to="IDisplay::resizeCompleted"/> is called.
10577
10578	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
10579	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
10580	this frame buffer must return exactly the same values as specified in the
10581	parameters of this method, after the resize is completed. If the
10582	indirect mode is chosen, these attributes must return values describing
10583	the format of the implementation's own memory buffer <link
10584	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
10585	value must always correlate with <link to="#pixelFormat"/>. Note that
10586	the <link to="#pixelFormat"/> attribute must never return <link
10587	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
10588
10589	<note>
10590	This method is called by the IDisplay object under the
10591	<link to="#lock"/> provided by this IFramebuffer
10592	implementation. If this method returns @c false in @a finished, then
10593	this lock is not released until
10594	<link to="IDisplay::resizeCompleted"/> is called.
10595	</note>
10596	</desc>
10597	<param name="screenId" type="unsigned long" dir="in">
10598	<desc>
10599	Logical screen number. Must be used in the corresponding call to
10600	<link to="IDisplay::resizeCompleted"/> if this call is made.
10601	</desc>
10602	</param>
10603	<param name="pixelFormat" type="unsigned long" dir="in">
10604	<desc>
10605	Pixel format of the memory buffer pointed to by @a VRAM.
10606	See also <link to="FramebufferPixelFormat"/>.
10607	</desc>
10608	</param>
10609	<param name="VRAM" type="octet" mod="ptr" dir="in">
10610	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
10611	</param>
10612	<param name="bitsPerPixel" type="unsigned long" dir="in">
10613	<desc>Color depth, bits per pixel.</desc>
10614	</param>
10615	<param name="bytesPerLine" type="unsigned long" dir="in">
10616	<desc>Size of one scan line, in bytes.</desc>
10617	</param>
10618	<param name="width" type="unsigned long" dir="in">
10619	<desc>Width of the guest display, in pixels.</desc>
10620	</param>
10621	<param name="height" type="unsigned long" dir="in">
10622	<desc>Height of the guest display, in pixels.</desc>
10623	</param>
10624	<param name="finished" type="boolean" dir="return">
10625	<desc>
10626	Can the VM start using the new frame buffer immediately
10627	after this method returns or it should wait for
10628	<link to="IDisplay::resizeCompleted"/>.
10629	</desc>
10630	</param>
10631	</method>
10632
10633	<method name="videoModeSupported">
10634	<desc>
10635	Returns whether the frame buffer implementation is willing to
10636	support a given video mode. In case it is not able to render
10637	the video mode (or for some reason not willing), it should
10638	return @c false. Usually this method is called when the guest
10639	asks the VMM device whether a given video mode is supported
10640	so the information returned is directly exposed to the guest.
10641	It is important that this method returns very quickly.
10642	</desc>
10643	<param name="width" type="unsigned long" dir="in"/>
10644	<param name="height" type="unsigned long" dir="in"/>
10645	<param name="bpp" type="unsigned long" dir="in"/>
10646	<param name="supported" type="boolean" dir="return"/>
10647	</method>
10648
10649	<method name="getVisibleRegion">
10650	<desc>
10651	Returns the visible region of this frame buffer.
10652
10653	If the @a rectangles parameter is @c null then the value of the
10654	@a count parameter is ignored and the number of elements necessary to
10655	describe the current visible region is returned in @a countCopied.
10656
10657	If @a rectangles is not @c null but @a count is less
10658	than the required number of elements to store region data, the method
10659	will report a failure. If @a count is equal or greater than the
10660	required number of elements, then the actual number of elements copied
10661	to the provided array will be returned in @a countCopied.
10662
10663	<note>
10664	The address of the provided array must be in the process space of
10665	this IFramebuffer object.
10666	</note>
10667	<note>
10668	Method not yet implemented.
10669	</note>
10670	</desc>
10671	<param name="rectangles" type="octet" mod="ptr" dir="in">
10672	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
10673	</param>
10674	<param name="count" type="unsigned long" dir="in">
10675	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10676	</param>
10677	<param name="countCopied" type="unsigned long" dir="return">
10678	<desc>Number of elements copied to the @a rectangles array.</desc>
10679	</param>
10680	</method>
10681
10682	<method name="setVisibleRegion">
10683	<desc>
10684	Suggests a new visible region to this frame buffer. This region
10685	represents the area of the VM display which is a union of regions of
10686	all top-level windows of the guest operating system running inside the
10687	VM (if the Guest Additions for this system support this
10688	functionality). This information may be used by the frontends to
10689	implement the seamless desktop integration feature.
10690
10691	<note>
10692	The address of the provided array must be in the process space of
10693	this IFramebuffer object.
10694	</note>
10695	<note>
10696	The IFramebuffer implementation must make a copy of the provided
10697	array of rectangles.
10698	</note>
10699	<note>
10700	Method not yet implemented.
10701	</note>
10702	</desc>
10703	<param name="rectangles" type="octet" mod="ptr" dir="in">
10704	<desc>Pointer to the @c RTRECT array.</desc>
10705	</param>
10706	<param name="count" type="unsigned long" dir="in">
10707	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10708	</param>
10709	</method>
10710
10711	<method name="processVHWACommand">
10712	<desc>
10713	Posts a Video HW Acceleration Command to the frame buffer for processing.
10714	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color covnersion, overlaying, etc.)
10715	are posted from quest to the host to be processed by the host hardware.
10716
10717	<note>
10718	The address of the provided command must be in the process space of
10719	this IFramebuffer object.
10720	</note>
10721	</desc>
10722
10723	<param name="command" type="octet" mod="ptr" dir="in">
10724	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
10725	</param>
10726	</method>
10727
10728	</interface>
10729
10730	<interface
10731	name="IFramebufferOverlay" extends="IFramebuffer"
10732	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
10733	wsmap="suppress"
10734	>
10735	<desc>
10736	The IFramebufferOverlay interface represents an alpha blended overlay
10737	for displaying status icons above an IFramebuffer. It is always created
10738	not visible, so that it must be explicitly shown. It only covers a
10739	portion of the IFramebuffer, determined by its width, height and
10740	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
10741	that order) format, and may be written to directly. Do re-read the
10742	width though, after setting it, as it may be adjusted (increased) to
10743	make it more suitable for the front end.
10744	</desc>
10745	<attribute name="x" type="unsigned long" readonly="yes">
10746	<desc>X position of the overlay, relative to the frame buffer.</desc>
10747	</attribute>
10748
10749	<attribute name="y" type="unsigned long" readonly="yes">
10750	<desc>Y position of the overlay, relative to the frame buffer.</desc>
10751	</attribute>
10752
10753	<attribute name="visible" type="boolean" readonly="no">
10754	<desc>
10755	Whether the overlay is currently visible.
10756	</desc>
10757	</attribute>
10758
10759	<attribute name="alpha" type="unsigned long" readonly="no">
10760	<desc>
10761	The global alpha value for the overlay. This may or may not be
10762	supported by a given front end.
10763	</desc>
10764	</attribute>
10765
10766	<method name="move">
10767	<desc>
10768	Changes the overlay's position relative to the IFramebuffer.
10769	</desc>
10770	<param name="x" type="unsigned long" dir="in"/>
10771	<param name="y" type="unsigned long" dir="in"/>
10772	</method>
10773
10774	</interface>
10775
10776	<interface
10777	name="IDisplay" extends="$unknown"
10778	uuid="1fa79e39-0cc9-4ab3-9df3-ed3e96b42496"
10779	wsmap="managed"
10780	>
10781	<desc>
10782	The IDisplay interface represents the virtual machine's display.
10783
10784	The object implementing this interface is contained in each
10785	<link to="IConsole::display"/> attribute and represents the visual
10786	output of the virtual machine.
10787
10788	The virtual display supports pluggable output targets represented by the
10789	IFramebuffer interface. Examples of the output target are a window on
10790	the host computer or an RDP session's display on a remote computer.
10791	</desc>
10792	<method name="getScreenResolution">
10793	<desc>Queries display width, height and color depth for given screen.</desc>
10794	<param name="screenId" type="unsigned long" dir="in"/>
10795	<param name="width" type="unsigned long" dir="out"/>
10796	<param name="height" type="unsigned long" dir="out"/>
10797	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
10798	</method>
10799
10800	<method name="setFramebuffer">
10801	<desc>
10802	Sets the framebuffer for given screen.
10803	</desc>
10804	<param name="screenId" type="unsigned long" dir="in"/>
10805	<param name="framebuffer" type="IFramebuffer" dir="in"/>
10806	</method>
10807
10808	<method name="getFramebuffer">
10809	<desc>
10810	Queries the framebuffer for given screen.
10811	</desc>
10812	<param name="screenId" type="unsigned long" dir="in"/>
10813	<param name="framebuffer" type="IFramebuffer" dir="out"/>
10814	<param name="xOrigin" type="long" dir="out"/>
10815	<param name="yOrigin" type="long" dir="out"/>
10816	</method>
10817
10818	<method name="setVideoModeHint">
10819	<desc>
10820	Asks VirtualBox to request the given video mode from
10821	the guest. This is just a hint and it cannot be guaranteed
10822	that the requested resolution will be used. Guest Additions
10823	are required for the request to be seen by guests. The caller
10824	should issue the request and wait for a resolution change and
10825	after a timeout retry.
10826
10827	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
10828	parameters means that the corresponding values should be taken from the
10829	current video mode (i.e. left unchanged).
10830
10831	If the guest OS supports multi-monitor configuration then the @a display
10832	parameter specifies the number of the guest display to send the hint to:
10833	@c 0 is the primary display, @c 1 is the first secondary and
10834	so on. If the multi-monitor configuration is not supported, @a display
10835	must be @c 0.
10836
10837	<result name="E_INVALIDARG">
10838	The @a display is not associated with any monitor.
10839	</result>
10840
10841	</desc>
10842	<param name="width" type="unsigned long" dir="in"/>
10843	<param name="height" type="unsigned long" dir="in"/>
10844	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
10845	<param name="display" type="unsigned long" dir="in"/>
10846	</method>
10847
10848	<method name="setSeamlessMode">
10849	<desc>
10850	Enables or disables seamless guest display rendering (seamless desktop
10851	integration) mode.
10852	<note>
10853	Calling this method has no effect if <link
10854	to="IGuest::supportsSeamless"/> returns @c false.
10855	</note>
10856	</desc>
10857	<param name="enabled" type="boolean" dir="in"/>
10858	</method>
10859
10860	<method name="takeScreenShot">
10861	<desc>
10862	Takes a screen shot of the requested size and copies it to the
10863	32-bpp buffer allocated by the caller and pointed to by @a address.
10864	A pixel consists of 4 bytes in order: B, G, R, 0.
10865
10866	<note>This API can be used only by the COM/XPCOM C++ API as it
10867	requires pointer support. Use <link to="#takeScreenShotToArray" />
10868	with other language bindings.
10869	</note>
10870
10871	<result name="E_NOTIMPL">
10872	Feature not implemented.
10873	</result>
10874	<result name="VBOX_E_IPRT_ERROR">
10875	Could not take a screenshot.
10876	</result>
10877
10878	</desc>
10879	<param name="screenId" type="unsigned long" dir="in"/>
10880	<param name="address" type="octet" mod="ptr" dir="in"/>
10881	<param name="width" type="unsigned long" dir="in"/>
10882	<param name="height" type="unsigned long" dir="in"/>
10883	</method>
10884
10885	<method name="takeScreenShotToArray">
10886	<desc>
10887	Takes a guest screen shot of the requested size and returns it as
10888	an array of bytes in uncompressed 32-bit RGBA format.
10889	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
10890
10891	This API is slow, but could be the only option to get guest screenshot
10892	for scriptable languages not allowed to manipulate with addresses
10893	directly.
10894
10895	<result name="E_NOTIMPL">
10896	Feature not implemented.
10897	</result>
10898	<result name="VBOX_E_IPRT_ERROR">
10899	Could not take a screenshot.
10900	</result>
10901	</desc>
10902	<param name="screenId" type="unsigned long" dir="in">
10903	<desc>
10904	Monitor to take screenshot from.
10905	</desc>
10906	</param>
10907	<param name="width" type="unsigned long" dir="in">
10908	<desc>
10909	Desired image width.
10910	</desc>
10911	</param>
10912	<param name="height" type="unsigned long" dir="in">
10913	<desc>
10914	Desired image height.
10915	</desc>
10916	</param>
10917	<param name="screenData" type="octet" dir="return" safearray="yes">
10918	<desc>
10919	Array with resulting screen data.
10920	</desc>
10921	</param>
10922	</method>
10923
10924	<method name="drawToScreen">
10925	<desc>
10926	Draws a 32-bpp image of the specified size from the given buffer
10927	to the given point on the VM display.
10928
10929	<result name="E_NOTIMPL">
10930	Feature not implemented.
10931	</result>
10932	<result name="VBOX_E_IPRT_ERROR">
10933	Could not draw to screen.
10934	</result>
10935
10936	</desc>
10937	<param name="screenId" type="unsigned long" dir="in"/>
10938	<param name="address" type="octet" mod="ptr" dir="in"/>
10939	<param name="x" type="unsigned long" dir="in">
10940	<desc>Relative to the screen top left corner.</desc>
10941	</param>
10942	<param name="y" type="unsigned long" dir="in">
10943	<desc>Relative to the screen top left corner.</desc>
10944	</param>
10945	<param name="width" type="unsigned long" dir="in"/>
10946	<param name="height" type="unsigned long" dir="in"/>
10947	</method>
10948
10949	<method name="invalidateAndUpdate">
10950	<desc>
10951	Does a full invalidation of the VM display and instructs the VM
10952	to update it.
10953
10954	<result name="VBOX_E_IPRT_ERROR">
10955	Could not invalidate and update screen.
10956	</result>
10957
10958	</desc>
10959	</method>
10960
10961	<method name="resizeCompleted">
10962	<desc>
10963	Signals that a framebuffer has completed the resize operation.
10964
10965	<result name="VBOX_E_NOT_SUPPORTED">
10966	Operation only valid for external frame buffers.
10967	</result>
10968
10969	</desc>
10970	<param name="screenId" type="unsigned long" dir="in"/>
10971	</method>
10972
10973	<method name="completeVHWACommand">
10974	<desc>
10975	Signals that the Video HW Acceleration command has completed.
10976	</desc>
10977
10978	<param name="command" type="octet" mod="ptr" dir="in">
10979	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
10980	</param>
10981	</method>
10982
10983	</interface>
10984
10985	<!--
10986	// INetworkAdapter
10987	/////////////////////////////////////////////////////////////////////////
10988	-->
10989
10990	<enum
10991	name="NetworkAttachmentType"
10992	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
10993	>
10994	<desc>
10995	Network attachment type.
10996	</desc>
10997
10998	<const name="Null" value="0">
10999	<desc>Null value, also means "not attached".</desc>
11000	</const>
11001	<const name="NAT" value="1"/>
11002	<const name="Bridged" value="2"/>
11003	<const name="Internal" value="3"/>
11004	<const name="HostOnly" value="4"/>
11005	<const name="VDE" value="5"/>
11006	</enum>
11007
11008	<enum
11009	name="NetworkAdapterType"
11010	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11011	>
11012	<desc>
11013	Network adapter type.
11014	</desc>
11015
11016	<const name="Null" value="0">
11017	<desc>Null value (never used by the API).</desc>
11018	</const>
11019	<const name="Am79C970A" value="1">
11020	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11021	</const>
11022	<const name="Am79C973" value="2">
11023	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11024	</const>
11025	<const name="I82540EM" value="3">
11026	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11027	</const>
11028	<const name="I82543GC" value="4">
11029	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11030	</const>
11031	<const name="I82545EM" value="5">
11032	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11033	</const>
11034	<const name="Virtio" value="6">
11035	<desc>Virtio network device.</desc>
11036	</const>
11037	</enum>
11038
11039	<interface
11040	name="INetworkAdapter" extends="$unknown"
11041	uuid="5bdb9df8-a5e1-4322-a139-b7a4a734c790"
11042	wsmap="managed"
11043	>
11044	<desc>
11045	Represents a virtual network adapter that is attached to a virtual machine.
11046	Each virtual machine has a fixed number of network adapter slots with one
11047	instance of this attached to each of them. Call
11048	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11049	is attached to a given slot in a given machine.
11050
11051	Each network adapter can be in one of five attachment modes, which are
11052	represented by the <link to="NetworkAttachmentType" /> enumeration;
11053	see the <link to="#attachmentType" /> attribute.
11054	</desc>
11055
11056	<attribute name="adapterType" type="NetworkAdapterType">
11057	<desc>
11058	Type of the virtual network adapter. Depending on this value,
11059	VirtualBox will provide a different virtual network hardware
11060	to the guest.
11061	</desc>
11062	</attribute>
11063
11064	<attribute name="slot" type="unsigned long" readonly="yes">
11065	<desc>
11066	Slot number this adapter is plugged into. Corresponds to
11067	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11068	to obtain this instance.
11069	</desc>
11070	</attribute>
11071
11072	<attribute name="enabled" type="boolean">
11073	<desc>
11074	Flag whether the network adapter is present in the
11075	guest system. If disabled, the virtual guest hardware will
11076	not contain this network adapter. Can only be changed when
11077	the VM is not running.
11078	</desc>
11079	</attribute>
11080
11081	<attribute name="MACAddress" type="wstring">
11082	<desc>
11083	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11084	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11085	</desc>
11086	</attribute>
11087
11088	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11089
11090	<attribute name="hostInterface" type="wstring">
11091	<desc>
11092	Name of the host network interface the VM is attached to.
11093	</desc>
11094	</attribute>
11095
11096	<attribute name="internalNetwork" type="wstring">
11097	<desc>
11098	Name of the internal network the VM is attached to.
11099	</desc>
11100	</attribute>
11101
11102	<attribute name="NATNetwork" type="wstring">
11103	<desc>
11104	Name of the NAT network the VM is attached to.
11105	</desc>
11106	</attribute>
11107
11108	<attribute name="VDENetwork" type="wstring">
11109	<desc>
11110	Name of the VDE switch the VM is attached to.
11111	</desc>
11112	</attribute>
11113
11114	<attribute name="cableConnected" type="boolean">
11115	<desc>
11116	Flag whether the adapter reports the cable as connected or not.
11117	It can be used to report offline situations to a VM.
11118	</desc>
11119	</attribute>
11120
11121	<attribute name="lineSpeed" type="unsigned long">
11122	<desc>
11123	Line speed reported by custom drivers, in units of 1 kbps.
11124	</desc>
11125	</attribute>
11126
11127	<attribute name="traceEnabled" type="boolean">
11128	<desc>
11129	Flag whether network traffic from/to the network card should be traced.
11130	Can only be toggled when the VM is turned off.
11131	</desc>
11132	</attribute>
11133
11134	<attribute name="traceFile" type="wstring">
11135	<desc>
11136	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11137	will be used.
11138	</desc>
11139	</attribute>
11140
11141	<attribute name="natDriver" type="INATEngine" readonly="yes">
11142	<desc>
11143	Points to the NAT engine which handles the network address translation
11144	for this interface. This is active only when the interface actually uses
11145	NAT (see <link to="#attachToNAT" />).
11146	</desc>
11147	</attribute>
11148
11149	<attribute name="bootPriority" type="unsigned long">
11150	<desc>
11151	Network boot priority of the adapter. Priority 1 is highest. If not set,
11152	the priority is considered to be at the lowest possible setting.
11153	</desc>
11154	</attribute>
11155
11156	<method name="attachToNAT">
11157	<desc>
11158	Attach the network adapter to the Network Address Translation (NAT) interface.
11159	</desc>
11160	</method>
11161
11162	<method name="attachToBridgedInterface">
11163	<desc>
11164	Attach the network adapter to a bridged host interface.
11165	</desc>
11166	</method>
11167
11168	<method name="attachToInternalNetwork">
11169	<desc>
11170	Attach the network adapter to an internal network.
11171	</desc>
11172	</method>
11173
11174	<method name="attachToHostOnlyInterface">
11175	<desc>
11176	Attach the network adapter to the host-only network.
11177	</desc>
11178	</method>
11179
11180	<method name="attachToVDE">
11181	<desc>
11182	Attach the network adapter to a VDE network.
11183	</desc>
11184	</method>
11185
11186	<method name="detach">
11187	<desc>
11188	Detach the network adapter
11189	</desc>
11190	</method>
11191	</interface>
11192
11193
11194	<!--
11195	// ISerialPort
11196	/////////////////////////////////////////////////////////////////////////
11197	-->
11198
11199	<enum
11200	name="PortMode"
11201	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11202	>
11203	<desc>
11204	The PortMode enumeration represents possible communication modes for
11205	the virtual serial port device.
11206	</desc>
11207
11208	<const name="Disconnected" value="0">
11209	<desc>Virtual device is not attached to any real host device.</desc>
11210	</const>
11211	<const name="HostPipe" value="1">
11212	<desc>Virtual device is attached to a host pipe.</desc>
11213	</const>
11214	<const name="HostDevice" value="2">
11215	<desc>Virtual device is attached to a host device.</desc>
11216	</const>
11217	<const name="RawFile" value="3">
11218	<desc>Virtual device is attached to a raw file.</desc>
11219	</const>
11220	</enum>
11221
11222	<interface
11223	name="ISerialPort" extends="$unknown"
11224	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11225	wsmap="managed"
11226	>
11227
11228	<desc>
11229	The ISerialPort interface represents the virtual serial port device.
11230
11231	The virtual serial port device acts like an ordinary serial port
11232	inside the virtual machine. This device communicates to the real
11233	serial port hardware in one of two modes: host pipe or host device.
11234
11235	In host pipe mode, the #path attribute specifies the path to the pipe on
11236	the host computer that represents a serial port. The #server attribute
11237	determines if this pipe is created by the virtual machine process at
11238	machine startup or it must already exist before starting machine
11239	execution.
11240
11241	In host device mode, the #path attribute specifies the name of the
11242	serial port device on the host computer.
11243
11244	There is also a third communication mode: the disconnected mode. In this
11245	mode, the guest OS running inside the virtual machine will be able to
11246	detect the serial port, but all port write operations will be discarded
11247	and all port read operations will return no data.
11248
11249	<see>IMachine::getSerialPort</see>
11250	</desc>
11251
11252	<attribute name="slot" type="unsigned long" readonly="yes">
11253	<desc>
11254	Slot number this serial port is plugged into. Corresponds to
11255	the value you pass to <link to="IMachine::getSerialPort"/>
11256	to obtain this instance.
11257	</desc>
11258	</attribute>
11259
11260	<attribute name="enabled" type="boolean">
11261	<desc>
11262	Flag whether the serial port is enabled. If disabled,
11263	the serial port will not be reported to the guest OS.
11264	</desc>
11265	</attribute>
11266
11267	<attribute name="IOBase" type="unsigned long">
11268	<desc>Base I/O address of the serial port.</desc>
11269	</attribute>
11270
11271	<attribute name="IRQ" type="unsigned long">
11272	<desc>IRQ number of the serial port.</desc>
11273	</attribute>
11274
11275	<attribute name="hostMode" type="PortMode">
11276	<desc>
11277	How is this port connected to the host.
11278	<note>
11279	Changing this attribute may fail if the conditions for
11280	<link to="#path"/> are not met.
11281	</note>
11282	</desc>
11283	</attribute>
11284
11285	<attribute name="server" type="boolean">
11286	<desc>
11287	Flag whether this serial port acts as a server (creates a new pipe on
11288	the host) or as a client (uses the existing pipe). This attribute is
11289	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11290	</desc>
11291	</attribute>
11292
11293	<attribute name="path" type="wstring">
11294	<desc>
11295	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11296	PortMode_HostPipe, or the host serial device name when
11297	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11298	cases, setting a @c null or empty string as the attribute's value
11299	is an error. Otherwise, the value of this property is ignored.
11300	</desc>
11301	</attribute>
11302
11303	</interface>
11304
11305	<!--
11306	// IParallelPort
11307	/////////////////////////////////////////////////////////////////////////
11308	-->
11309
11310	<interface
11311	name="IParallelPort" extends="$unknown"
11312	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11313	wsmap="managed"
11314	>
11315
11316	<desc>
11317	The IParallelPort interface represents the virtual parallel port device.
11318
11319	The virtual parallel port device acts like an ordinary parallel port
11320	inside the virtual machine. This device communicates to the real
11321	parallel port hardware using the name of the parallel device on the host
11322	computer specified in the #path attribute.
11323
11324	Each virtual parallel port device is assigned a base I/O address and an
11325	IRQ number that will be reported to the guest operating system and used
11326	to operate the given parallel port from within the virtual machine.
11327
11328	<see>IMachine::getParallelPort</see>
11329	</desc>
11330
11331	<attribute name="slot" type="unsigned long" readonly="yes">
11332	<desc>
11333	Slot number this parallel port is plugged into. Corresponds to
11334	the value you pass to <link to="IMachine::getParallelPort"/>
11335	to obtain this instance.
11336	</desc>
11337	</attribute>
11338
11339	<attribute name="enabled" type="boolean">
11340	<desc>
11341	Flag whether the parallel port is enabled. If disabled,
11342	the parallel port will not be reported to the guest OS.
11343	</desc>
11344	</attribute>
11345
11346	<attribute name="IOBase" type="unsigned long">
11347	<desc>Base I/O address of the parallel port.</desc>
11348	</attribute>
11349
11350	<attribute name="IRQ" type="unsigned long">
11351	<desc>IRQ number of the parallel port.</desc>
11352	</attribute>
11353
11354	<attribute name="path" type="wstring">
11355	<desc>
11356	Host parallel device name. If this parallel port is enabled, setting a
11357	@c null or an empty string as this attribute's value will result into
11358	an error.
11359	</desc>
11360	</attribute>
11361
11362	</interface>
11363
11364
11365	<!--
11366	// IMachineDebugger
11367	/////////////////////////////////////////////////////////////////////////
11368	-->
11369
11370	<interface
11371	name="IMachineDebugger" extends="$unknown"
11372	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
11373	wsmap="suppress"
11374	>
11375	<method name="resetStats">
11376	<desc>
11377	Reset VM statistics.
11378	</desc>
11379	<param name="pattern" type="wstring" dir="in">
11380	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11381	</param>
11382	</method>
11383
11384	<method name="dumpStats">
11385	<desc>
11386	Dumps VM statistics.
11387	</desc>
11388	<param name="pattern" type="wstring" dir="in">
11389	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11390	</param>
11391	</method>
11392
11393	<method name="getStats">
11394	<desc>
11395	Get the VM statistics in a XMLish format.
11396	</desc>
11397	<param name="pattern" type="wstring" dir="in">
11398	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11399	</param>
11400	<param name="withDescriptions" type="boolean" dir="in">
11401	<desc>Whether to include the descriptions.</desc>
11402	</param>
11403	<param name="stats" type="wstring" dir="out">
11404	<desc>The XML document containing the statistics.</desc>
11405	</param>
11406	</method>
11407
11408	<method name="injectNMI">
11409	<desc>
11410	Inject an NMI into a running VT-x/AMD-V VM.
11411	</desc>
11412	</method>
11413
11414	<attribute name="singlestep" type="boolean">
11415	<desc>Switch for enabling singlestepping.</desc>
11416	</attribute>
11417
11418	<attribute name="recompileUser" type="boolean">
11419	<desc>Switch for forcing code recompilation for user mode code.</desc>
11420	</attribute>
11421
11422	<attribute name="recompileSupervisor" type="boolean">
11423	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
11424	</attribute>
11425
11426	<attribute name="PATMEnabled" type="boolean">
11427	<desc>Switch for enabling and disabling the PATM component.</desc>
11428	</attribute>
11429
11430	<attribute name="CSAMEnabled" type="boolean">
11431	<desc>Switch for enabling and disabling the CSAM component.</desc>
11432	</attribute>
11433
11434	<attribute name="logEnabled" type="boolean">
11435	<desc>Switch for enabling and disabling logging.</desc>
11436	</attribute>
11437
11438	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
11439	<desc>
11440	Flag indicating whether the VM is currently making use of CPU hardware
11441	virtualization extensions.
11442	</desc>
11443	</attribute>
11444
11445	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
11446	<desc>
11447	Flag indicating whether the VM is currently making use of the nested paging
11448	CPU hardware virtualization extension.
11449	</desc>
11450	</attribute>
11451
11452	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11453	<desc>
11454	Flag indicating whether the VM is currently making use of the VPID
11455	VT-x extension.
11456	</desc>
11457	</attribute>
11458
11459	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11460	<desc>
11461	Flag indicating whether the VM is currently making use of the Physical
11462	Address Extension CPU feature.
11463	</desc>
11464	</attribute>
11465
11466	<attribute name="virtualTimeRate" type="unsigned long">
11467	<desc>
11468	The rate at which the virtual time runs expressed as a percentage.
11469	The accepted range is 2% to 20000%.
11470	</desc>
11471	</attribute>
11472
11473	<!-- @todo method for setting log flags, groups and destination! -->
11474
11475	<attribute name="VM" type="unsigned long long" readonly="yes">
11476	<desc>
11477	Gets the VM handle. This is only for internal use while
11478	we carve the details of this interface.
11479	</desc>
11480	</attribute>
11481
11482	</interface>
11483
11484	<!--
11485	// IUSBController
11486	/////////////////////////////////////////////////////////////////////////
11487	-->
11488
11489	<interface
11490	name="IUSBController" extends="$unknown"
11491	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
11492	wsmap="managed"
11493	>
11494	<attribute name="enabled" type="boolean">
11495	<desc>
11496	Flag whether the USB controller is present in the
11497	guest system. If disabled, the virtual guest hardware will
11498	not contain any USB controller. Can only be changed when
11499	the VM is powered off.
11500	</desc>
11501	</attribute>
11502
11503	<attribute name="enabledEhci" type="boolean">
11504	<desc>
11505	Flag whether the USB EHCI controller is present in the
11506	guest system. If disabled, the virtual guest hardware will
11507	not contain a USB EHCI controller. Can only be changed when
11508	the VM is powered off.
11509	</desc>
11510	</attribute>
11511
11512	<attribute name="proxyAvailable" type="boolean" readonly="yes">
11513	<desc>
11514	Flag whether there is an USB proxy available.
11515	</desc>
11516	</attribute>
11517
11518	<attribute name="USBStandard" type="unsigned short" readonly="yes">
11519	<desc>
11520	USB standard version which the controller implements.
11521	This is a BCD which means that the major version is in the
11522	high byte and minor version is in the low byte.
11523	</desc>
11524	</attribute>
11525
11526	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
11527	<desc>
11528	List of USB device filters associated with the machine.
11529
11530	If the machine is currently running, these filters are activated
11531	every time a new (supported) USB device is attached to the host
11532	computer that was not ignored by global filters
11533	(<link to="IHost::USBDeviceFilters"/>).
11534
11535	These filters are also activated when the machine is powered up.
11536	They are run against a list of all currently available USB
11537	devices (in states
11538	<link to="USBDeviceState_Available"/>,
11539	<link to="USBDeviceState_Busy"/>,
11540	<link to="USBDeviceState_Held"/>) that were not previously
11541	ignored by global filters.
11542
11543	If at least one filter matches the USB device in question, this
11544	device is automatically captured (attached to) the virtual USB
11545	controller of this machine.
11546
11547	<see>IUSBDeviceFilter, ::IUSBController</see>
11548	</desc>
11549	</attribute>
11550
11551	<method name="createDeviceFilter">
11552	<desc>
11553	Creates a new USB device filter. All attributes except
11554	the filter name are set to empty (any match),
11555	<i>active</i> is @c false (the filter is not active).
11556
11557	The created filter can then be added to the list of filters using
11558	<link to="#insertDeviceFilter"/>.
11559
11560	<result name="VBOX_E_INVALID_VM_STATE">
11561	The virtual machine is not mutable.
11562	</result>
11563
11564	<see>#deviceFilters</see>
11565	</desc>
11566	<param name="name" type="wstring" dir="in">
11567	<desc>
11568	Filter name. See <link to="IUSBDeviceFilter::name"/>
11569	for more info.
11570	</desc>
11571	</param>
11572	<param name="filter" type="IUSBDeviceFilter" dir="return">
11573	<desc>Created filter object.</desc>
11574	</param>
11575	</method>
11576
11577	<method name="insertDeviceFilter">
11578	<desc>
11579	Inserts the given USB device to the specified position
11580	in the list of filters.
11581
11582	Positions are numbered starting from <tt>0</tt>. If the specified
11583	position is equal to or greater than the number of elements in
11584	the list, the filter is added to the end of the collection.
11585
11586	<note>
11587	Duplicates are not allowed, so an attempt to insert a
11588	filter that is already in the collection, will return an
11589	error.
11590	</note>
11591
11592	<result name="VBOX_E_INVALID_VM_STATE">
11593	Virtual machine is not mutable.
11594	</result>
11595	<result name="E_INVALIDARG">
11596	USB device filter not created within this VirtualBox instance.
11597	</result>
11598	<result name="VBOX_E_INVALID_OBJECT_STATE">
11599	USB device filter already in list.
11600	</result>
11601
11602	<see>#deviceFilters</see>
11603	</desc>
11604	<param name="position" type="unsigned long" dir="in">
11605	<desc>Position to insert the filter to.</desc>
11606	</param>
11607	<param name="filter" type="IUSBDeviceFilter" dir="in">
11608	<desc>USB device filter to insert.</desc>
11609	</param>
11610	</method>
11611
11612	<method name="removeDeviceFilter">
11613	<desc>
11614	Removes a USB device filter from the specified position in the
11615	list of filters.
11616
11617	Positions are numbered starting from <tt>0</tt>. Specifying a
11618	position equal to or greater than the number of elements in
11619	the list will produce an error.
11620
11621	<see>#deviceFilters</see>
11622
11623	<result name="VBOX_E_INVALID_VM_STATE">
11624	Virtual machine is not mutable.
11625	</result>
11626	<result name="E_INVALIDARG">
11627	USB device filter list empty or invalid @a position.
11628	</result>
11629
11630	</desc>
11631	<param name="position" type="unsigned long" dir="in">
11632	<desc>Position to remove the filter from.</desc>
11633	</param>
11634	<param name="filter" type="IUSBDeviceFilter" dir="return">
11635	<desc>Removed USB device filter.</desc>
11636	</param>
11637	</method>
11638
11639	</interface>
11640
11641
11642	<!--
11643	// IUSBDevice
11644	/////////////////////////////////////////////////////////////////////////
11645	-->
11646
11647	<interface
11648	name="IUSBDevice" extends="$unknown"
11649	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
11650	wsmap="managed"
11651	>
11652	<desc>
11653	The IUSBDevice interface represents a virtual USB device attached to the
11654	virtual machine.
11655
11656	A collection of objects implementing this interface is stored in the
11657	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
11658	attached to a running virtual machine's USB controller.
11659	</desc>
11660
11661	<attribute name="id" type="uuid" mod="string" readonly="yes">
11662	<desc>
11663	Unique USB device ID. This ID is built from #vendorId,
11664	#productId, #revision and #serialNumber.
11665	</desc>
11666	</attribute>
11667
11668	<attribute name="vendorId" type="unsigned short" readonly="yes">
11669	<desc>Vendor ID.</desc>
11670	</attribute>
11671
11672	<attribute name="productId" type="unsigned short" readonly="yes">
11673	<desc>Product ID.</desc>
11674	</attribute>
11675
11676	<attribute name="revision" type="unsigned short" readonly="yes">
11677	<desc>
11678	Product revision number. This is a packed BCD represented as
11679	unsigned short. The high byte is the integer part and the low
11680	byte is the decimal.
11681	</desc>
11682	</attribute>
11683
11684	<attribute name="manufacturer" type="wstring" readonly="yes">
11685	<desc>Manufacturer string.</desc>
11686	</attribute>
11687
11688	<attribute name="product" type="wstring" readonly="yes">
11689	<desc>Product string.</desc>
11690	</attribute>
11691
11692	<attribute name="serialNumber" type="wstring" readonly="yes">
11693	<desc>Serial number string.</desc>
11694	</attribute>
11695
11696	<attribute name="address" type="wstring" readonly="yes">
11697	<desc>Host specific address of the device.</desc>
11698	</attribute>
11699
11700	<attribute name="port" type="unsigned short" readonly="yes">
11701	<desc>
11702	Host USB port number the device is physically
11703	connected to.
11704	</desc>
11705	</attribute>
11706
11707	<attribute name="version" type="unsigned short" readonly="yes">
11708	<desc>
11709	The major USB version of the device - 1 or 2.
11710	</desc>
11711	</attribute>
11712
11713	<attribute name="portVersion" type="unsigned short" readonly="yes">
11714	<desc>
11715	The major USB version of the host USB port the device is
11716	physically connected to - 1 or 2. For devices not connected to
11717	anything this will have the same value as the version attribute.
11718	</desc>
11719	</attribute>
11720
11721	<attribute name="remote" type="boolean" readonly="yes">
11722	<desc>
11723	Whether the device is physically connected to a remote VRDP
11724	client or to a local host machine.
11725	</desc>
11726	</attribute>
11727
11728	</interface>
11729
11730
11731	<!--
11732	// IUSBDeviceFilter
11733	/////////////////////////////////////////////////////////////////////////
11734	-->
11735
11736	<interface
11737	name="IUSBDeviceFilter" extends="$unknown"
11738	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
11739	wsmap="managed"
11740	>
11741	<desc>
11742	The IUSBDeviceFilter interface represents an USB device filter used
11743	to perform actions on a group of USB devices.
11744
11745	This type of filters is used by running virtual machines to
11746	automatically capture selected USB devices once they are physically
11747	attached to the host computer.
11748
11749	A USB device is matched to the given device filter if and only if all
11750	attributes of the device match the corresponding attributes of the
11751	filter (that is, attributes are joined together using the logical AND
11752	operation). On the other hand, all together, filters in the list of
11753	filters carry the semantics of the logical OR operation. So if it is
11754	desirable to create a match like "this vendor id OR this product id",
11755	one needs to create two filters and specify "any match" (see below)
11756	for unused attributes.
11757
11758	All filter attributes used for matching are strings. Each string
11759	is an expression representing a set of values of the corresponding
11760	device attribute, that will match the given filter. Currently, the
11761	following filtering expressions are supported:
11762
11763	<ul>
11764	<li><i>Interval filters</i>. Used to specify valid intervals for
11765	integer device attributes (Vendor ID, Product ID and Revision).
11766	The format of the string is:
11767
11768	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
11769
11770	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
11771	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
11772	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
11773	is omitted before a dash (<tt>-</tt>), the minimum possible integer
11774	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
11775	possible integer is assumed.
11776	</li>
11777	<li><i>Boolean filters</i>. Used to specify acceptable values for
11778	boolean device attributes. The format of the string is:
11779
11780	<tt>true\|false\|yes\|no\|0\|1</tt>
11781
11782	</li>
11783	<li><i>Exact match</i>. Used to specify a single value for the given
11784	device attribute. Any string that doesn't start with <tt>int:</tt>
11785	represents the exact match. String device attributes are compared to
11786	this string including case of symbols. Integer attributes are first
11787	converted to a string (see individual filter attributes) and then
11788	compared ignoring case.
11789
11790	</li>
11791	<li><i>Any match</i>. Any value of the corresponding device attribute
11792	will match the given filter. An empty or @c null string is
11793	used to construct this type of filtering expressions.
11794
11795	</li>
11796	</ul>
11797
11798	<note>
11799	On the Windows host platform, interval filters are not currently
11800	available. Also all string filter attributes
11801	(<link to="#manufacturer"/>, <link to="#product"/>,
11802	<link to="#serialNumber"/>) are ignored, so they behave as
11803	<i>any match</i> no matter what string expression is specified.
11804	</note>
11805
11806	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
11807	</desc>
11808
11809	<attribute name="name" type="wstring">
11810	<desc>
11811	Visible name for this filter.
11812	This name is used to visually distinguish one filter from another,
11813	so it can neither be @c null nor an empty string.
11814	</desc>
11815	</attribute>
11816
11817	<attribute name="active" type="boolean">
11818	<desc>Whether this filter active or has been temporarily disabled.</desc>
11819	</attribute>
11820
11821	<attribute name="vendorId" type="wstring">
11822	<desc>
11823	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
11824	The string representation for the <i>exact matching</i>
11825	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
11826	(including leading zeroes).
11827	</desc>
11828	</attribute>
11829
11830	<attribute name="productId" type="wstring">
11831	<desc>
11832	<link to="IUSBDevice::productId">Product ID</link> filter.
11833	The string representation for the <i>exact matching</i>
11834	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
11835	(including leading zeroes).
11836	</desc>
11837	</attribute>
11838
11839	<attribute name="revision" type="wstring">
11840	<desc>
11841	<link to="IUSBDevice::productId">Product revision number</link>
11842	filter. The string representation for the <i>exact matching</i>
11843	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
11844	of the integer part of the revision, and <tt>F</tt> is the
11845	decimal digit of its fractional part (including leading and
11846	trailing zeros).
11847	Note that for interval filters, it's best to use the hexadecimal
11848	form, because the revision is stored as a 16 bit packed BCD value;
11849	so the expression <tt>int:0x0100-0x0199</tt> will match any
11850	revision from <tt>1.0</tt> to <tt>1.99</tt>.
11851	</desc>
11852	</attribute>
11853
11854	<attribute name="manufacturer" type="wstring">
11855	<desc>
11856	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
11857	</desc>
11858	</attribute>
11859
11860	<attribute name="product" type="wstring">
11861	<desc>
11862	<link to="IUSBDevice::product">Product</link> filter.
11863	</desc>
11864	</attribute>
11865
11866	<attribute name="serialNumber" type="wstring">
11867	<desc>
11868	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
11869	</desc>
11870	</attribute>
11871
11872	<attribute name="port" type="wstring">
11873	<desc>
11874	<link to="IUSBDevice::port">Host USB port</link> filter.
11875	</desc>
11876	</attribute>
11877
11878	<attribute name="remote" type="wstring">
11879	<desc>
11880	<link to="IUSBDevice::remote">Remote state</link> filter.
11881	<note>
11882	This filter makes sense only for machine USB filters,
11883	i.e. it is ignored by IHostUSBDeviceFilter objects.
11884	</note>
11885	</desc>
11886	</attribute>
11887
11888	<attribute name="maskedInterfaces" type="unsigned long">
11889	<desc>
11890	This is an advanced option for hiding one or more USB interfaces
11891	from the guest. The value is a bit mask where the bits that are set
11892	means the corresponding USB interface should be hidden, masked off
11893	if you like.
11894	This feature only works on Linux hosts.
11895	</desc>
11896	</attribute>
11897
11898	</interface>
11899
11900
11901	<!--
11902	// IHostUSBDevice
11903	/////////////////////////////////////////////////////////////////////////
11904	-->
11905
11906	<enum
11907	name="USBDeviceState"
11908	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
11909	>
11910	<desc>
11911	USB device state. This enumeration represents all possible states
11912	of the USB device physically attached to the host computer regarding
11913	its state on the host computer and availability to guest computers
11914	(all currently running virtual machines).
11915
11916	Once a supported USB device is attached to the host, global USB
11917	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
11918	either ignore the device, or put it to USBDeviceState_Held state, or do
11919	nothing. Unless the device is ignored by global filters, filters of all
11920	currently running guests (<link to="IUSBController::deviceFilters"/>) are
11921	activated that can put it to USBDeviceState_Captured state.
11922
11923	If the device was ignored by global filters, or didn't match
11924	any filters at all (including guest ones), it is handled by the host
11925	in a normal way. In this case, the device state is determined by
11926	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
11927	or USBDeviceState_Available, depending on the current device usage.
11928
11929	Besides auto-capturing based on filters, the device can be manually
11930	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
11931	state is USBDeviceState_Busy, USBDeviceState_Available or
11932	USBDeviceState_Held.
11933
11934	<note>
11935	Due to differences in USB stack implementations in Linux and Win32,
11936	states USBDeviceState_Busy and USBDeviceState_vailable are applicable
11937	only to the Linux version of the product. This also means that (<link
11938	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
11939	device state is USBDeviceState_Held.
11940	</note>
11941
11942	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
11943	</desc>
11944
11945	<const name="NotSupported" value="0">
11946	<desc>
11947	Not supported by the VirtualBox server, not available to guests.
11948	</desc>
11949	</const>
11950	<const name="Unavailable" value="1">
11951	<desc>
11952	Being used by the host computer exclusively,
11953	not available to guests.
11954	</desc>
11955	</const>
11956	<const name="Busy" value="2">
11957	<desc>
11958	Being used by the host computer, potentially available to guests.
11959	</desc>
11960	</const>
11961	<const name="Available" value="3">
11962	<desc>
11963	Not used by the host computer, available to guests (the host computer
11964	can also start using the device at any time).
11965	</desc>
11966	</const>
11967	<const name="Held" value="4">
11968	<desc>
11969	Held by the VirtualBox server (ignored by the host computer),
11970	available to guests.
11971	</desc>
11972	</const>
11973	<const name="Captured" value="5">
11974	<desc>
11975	Captured by one of the guest computers, not available
11976	to anybody else.
11977	</desc>
11978	</const>
11979	</enum>
11980
11981	<interface
11982	name="IHostUSBDevice" extends="IUSBDevice"
11983	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
11984	wsmap="managed"
11985	>
11986	<desc>
11987	The IHostUSBDevice interface represents a physical USB device attached
11988	to the host computer.
11989
11990	Besides properties inherited from IUSBDevice, this interface adds the
11991	<link to="#state"/> property that holds the current state of the USB
11992	device.
11993
11994	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
11995	</desc>
11996
11997	<attribute name="state" type="USBDeviceState" readonly="yes">
11998	<desc>
11999	Current state of the device.
12000	</desc>
12001	</attribute>
12002
12003	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12004
12005	</interface>
12006
12007
12008	<!--
12009	// IHostUSBDeviceFilter
12010	/////////////////////////////////////////////////////////////////////////
12011	-->
12012
12013	<enum
12014	name="USBDeviceFilterAction"
12015	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12016	>
12017	<desc>
12018	Actions for host USB device filters.
12019	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12020	</desc>
12021
12022	<const name="Null" value="0">
12023	<desc>Null value (never used by the API).</desc>
12024	</const>
12025	<const name="Ignore" value="1">
12026	<desc>Ignore the matched USB device.</desc>
12027	</const>
12028	<const name="Hold" value="2">
12029	<desc>Hold the matched USB device.</desc>
12030	</const>
12031	</enum>
12032
12033	<interface
12034	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12035	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12036	wsmap="managed"
12037	>
12038	<desc>
12039	The IHostUSBDeviceFilter interface represents a global filter for a
12040	physical USB device used by the host computer. Used indirectly in
12041	<link to="IHost::USBDeviceFilters"/>.
12042
12043	Using filters of this type, the host computer determines the initial
12044	state of the USB device after it is physically attached to the
12045	host's USB controller.
12046
12047	<note>
12048	The <link to="#remote"/> attribute is ignored by this type of
12049	filters, because it makes sense only for
12050	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12051	</note>
12052
12053	<see>IHost::USBDeviceFilters</see>
12054	</desc>
12055
12056	<attribute name="action" type="USBDeviceFilterAction">
12057	<desc>
12058	Action performed by the host when an attached USB device
12059	matches this filter.
12060	</desc>
12061	</attribute>
12062
12063	</interface>
12064
12065	<!--
12066	// IAudioAdapter
12067	/////////////////////////////////////////////////////////////////////////
12068	-->
12069
12070	<enum
12071	name="AudioDriverType"
12072	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12073	>
12074	<desc>
12075	Host audio driver type.
12076	</desc>
12077
12078	<const name="Null" value="0">
12079	<desc>Null value, also means "dummy audio driver".</desc>
12080	</const>
12081	<const name="WinMM" value="1">
12082	<desc>Windows multimedia (Windows hosts only).</desc>
12083	</const>
12084	<const name="OSS" value="2">
12085	<desc>Open Sound System (Linux hosts only).</desc>
12086	</const>
12087	<const name="ALSA" value="3">
12088	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12089	</const>
12090	<const name="DirectSound" value="4">
12091	<desc>DirectSound (Windows hosts only).</desc>
12092	</const>
12093	<const name="CoreAudio" value="5">
12094	<desc>CoreAudio (Mac hosts only).</desc>
12095	</const>
12096	<const name="MMPM" value="6">
12097	<desc>Reserved for historical reasons.</desc>
12098	</const>
12099	<const name="Pulse" value="7">
12100	<desc>PulseAudio (Linux hosts only).</desc>
12101	</const>
12102	<const name="SolAudio" value="8">
12103	<desc>Solaris audio (Solaris hosts only).</desc>
12104	</const>
12105	</enum>
12106
12107	<enum
12108	name="AudioControllerType"
12109	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12110	>
12111	<desc>
12112	Virtual audio controller type.
12113	</desc>
12114
12115	<const name="AC97" value="0"/>
12116	<const name="SB16" value="1"/>
12117	</enum>
12118
12119	<interface
12120	name="IAudioAdapter" extends="$unknown"
12121	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12122	wsmap="managed"
12123	>
12124	<desc>
12125	The IAudioAdapter interface represents the virtual audio adapter of
12126	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12127	</desc>
12128	<attribute name="enabled" type="boolean">
12129	<desc>
12130	Flag whether the audio adapter is present in the
12131	guest system. If disabled, the virtual guest hardware will
12132	not contain any audio adapter. Can only be changed when
12133	the VM is not running.
12134	</desc>
12135	</attribute>
12136	<attribute name="audioController" type="AudioControllerType">
12137	<desc>
12138	The audio hardware we emulate.
12139	</desc>
12140	</attribute>
12141	<attribute name="audioDriver" type="AudioDriverType">
12142	<desc>
12143	Audio driver the adapter is connected to. This setting
12144	can only be changed when the VM is not running.
12145	</desc>
12146	</attribute>
12147	</interface>
12148
12149	<!--
12150	// IVRDPServer
12151	/////////////////////////////////////////////////////////////////////////
12152	-->
12153
12154	<enum
12155	name="VRDPAuthType"
12156	uuid="3d91887a-b67f-4b33-85bf-2da7ab1ea83a"
12157	>
12158	<desc>
12159	VRDP authentication type.
12160	</desc>
12161
12162	<const name="Null" value="0">
12163	<desc>Null value, also means "no authentication".</desc>
12164	</const>
12165	<const name="External" value="1"/>
12166	<const name="Guest" value="2"/>
12167	</enum>
12168
12169	<interface
12170	name="IVRDPServer" extends="$unknown"
12171	uuid="7aeeb530-0b08-41fe-835d-9be9ec1dbe5c"
12172	wsmap="managed"
12173	>
12174	<attribute name="enabled" type="boolean">
12175	<desc>VRDP server status.</desc>
12176	</attribute>
12177
12178	<attribute name="ports" type="wstring">
12179	<desc>
12180	VRDP server port numbers. The server will try to bind to one of free ports from the list.
12181	<note>
12182	This is a string of comma separated TCP port numbers or port number ranges.
12183	Example <tt>5000,5010-5012,5015</tt>
12184	</note>
12185	</desc>
12186	</attribute>
12187
12188	<attribute name="netAddress" type="wstring">
12189	<desc>VRDP server address.</desc>
12190	</attribute>
12191
12192	<attribute name="authType" type="VRDPAuthType">
12193	<desc>VRDP authentication method.</desc>
12194	</attribute>
12195
12196	<attribute name="authTimeout" type="unsigned long">
12197	<desc>Timeout for guest authentication. Milliseconds.</desc>
12198	</attribute>
12199
12200	<attribute name="allowMultiConnection" type="boolean">
12201	<desc>
12202	Flag whether multiple simultaneous connections to the VM are permitted.
12203	Note that this will be replaced by a more powerful mechanism in the future.
12204	</desc>
12205	</attribute>
12206
12207	<attribute name="reuseSingleConnection" type="boolean">
12208	<desc>
12209	Flag whether the existing connection must be dropped and a new connection
12210	must be established by the VRDP server, when a new client connects in single
12211	connection mode.
12212	</desc>
12213	</attribute>
12214
12215	<attribute name="videoChannel" type="boolean">
12216	<desc>
12217	Flag whether RDP video channel is supported.
12218	</desc>
12219	</attribute>
12220
12221	<attribute name="videoChannelQuality" type="unsigned long">
12222	<desc>
12223	Image quality in percents.
12224	</desc>
12225	</attribute>
12226
12227	</interface>
12228
12229
12230	<!--
12231	// ISharedFolder
12232	/////////////////////////////////////////////////////////////////////////
12233	-->
12234
12235	<interface
12236	name="ISharedFolder" extends="$unknown"
12237	uuid="64637bb2-9e17-471c-b8f3-f8968dd9884e"
12238	wsmap="struct"
12239	>
12240	<desc>
12241	The ISharedFolder interface represents a folder in the host computer's
12242	file system accessible from the guest OS running inside a virtual
12243	machine using an associated logical name.
12244
12245	There are three types of shared folders:
12246	<ul>
12247	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
12248	folders available to all virtual machines.</li>
12249	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
12250	VM-specific shared folders available to the given virtual machine at
12251	startup.</li>
12252	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
12253	VM-specific shared folders created in the session context (for
12254	example, when the virtual machine is running) and automatically
12255	discarded when the session is closed (the VM is powered off).</li>
12256	</ul>
12257
12258	Logical names of shared folders must be unique within the given scope
12259	(global, permanent or transient). However, they do not need to be unique
12260	across scopes. In this case, the definition of the shared folder in a
12261	more specific scope takes precedence over definitions in all other
12262	scopes. The order of precedence is (more specific to more general):
12263	<ol>
12264	<li>Transient definitions</li>
12265	<li>Permanent definitions</li>
12266	<li>Global definitions</li>
12267	</ol>
12268
12269	For example, if MyMachine has a shared folder named
12270	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
12271	transient shared folder named <tt>C_DRIVE</tt> (that points
12272	to <tt>C:\\\\WINDOWS</tt>) will change the definition
12273	of <tt>C_DRIVE</tt> in the guest OS so
12274	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
12275	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
12276	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
12277	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
12278	to <tt>C:\\</tt> if it still exists.
12279
12280	Note that permanent and transient shared folders of different machines
12281	are in different name spaces, so they don't overlap and don't need to
12282	have unique logical names.
12283
12284	<note>
12285	Global shared folders are not implemented in the current version of the
12286	product.
12287	</note>
12288	</desc>
12289
12290	<attribute name="name" type="wstring" readonly="yes">
12291	<desc>Logical name of the shared folder.</desc>
12292	</attribute>
12293
12294	<attribute name="hostPath" type="wstring" readonly="yes">
12295	<desc>Full path to the shared folder in the host file system.</desc>
12296	</attribute>
12297
12298	<attribute name="accessible" type="boolean" readonly="yes">
12299	<desc>
12300	Whether the folder defined by the host path is currently
12301	accessible or not.
12302	For example, the folder can be unaccessible if it is placed
12303	on the network share that is not available by the time
12304	this property is read.
12305	</desc>
12306	</attribute>
12307
12308	<attribute name="writable" type="boolean" readonly="yes">
12309	<desc>
12310	Whether the folder defined by the host path is writable or
12311	not.
12312	</desc>
12313	</attribute>
12314
12315	<attribute name="lastAccessError" type="wstring" readonly="yes">
12316	<desc>
12317	Text message that represents the result of the last accessibility
12318	check.
12319
12320	Accessibility checks are performed each time the <link to="#accessible"/>
12321	attribute is read. An empty string is returned if the last
12322	accessibility check was successful. A non-empty string indicates a
12323	failure and should normally describe a reason of the failure (for
12324	example, a file read error).
12325	</desc>
12326	</attribute>
12327
12328	</interface>
12329
12330	<!--
12331	// ISession
12332	/////////////////////////////////////////////////////////////////////////
12333	-->
12334
12335	<interface
12336	name="IInternalSessionControl" extends="$unknown"
12337	uuid="ab161f72-e4b3-44e6-a919-2256474bda66"
12338	internal="yes"
12339	wsmap="suppress"
12340	>
12341	<method name="getPID">
12342	<desc>PID of the process that has created this Session object.
12343	</desc>
12344	<param name="pid" type="unsigned long" dir="return"/>
12345	</method>
12346
12347	<method name="getRemoteConsole">
12348	<desc>
12349	Returns the console object suitable for remote control.
12350
12351	<result name="VBOX_E_INVALID_VM_STATE">
12352	Session state prevents operation.
12353	</result>
12354	<result name="VBOX_E_INVALID_OBJECT_STATE">
12355	Session type prevents operation.
12356	</result>
12357
12358	</desc>
12359	<param name="console" type="IConsole" dir="return"/>
12360	</method>
12361
12362	<method name="assignMachine">
12363	<desc>
12364	Assigns the machine object associated with this direct-type
12365	session or informs the session that it will be a remote one
12366	(if @a machine == @c null).
12367
12368	<result name="VBOX_E_INVALID_VM_STATE">
12369	Session state prevents operation.
12370	</result>
12371	<result name="VBOX_E_INVALID_OBJECT_STATE">
12372	Session type prevents operation.
12373	</result>
12374
12375	</desc>
12376	<param name="machine" type="IMachine" dir="in"/>
12377	</method>
12378
12379	<method name="assignRemoteMachine">
12380	<desc>
12381	Assigns the machine and the (remote) console object associated with
12382	this remote-type session.
12383
12384	<result name="VBOX_E_INVALID_VM_STATE">
12385	Session state prevents operation.
12386	</result>
12387
12388	</desc>
12389	<param name="machine" type="IMachine" dir="in"/>
12390	<param name="console" type="IConsole" dir="in"/>
12391	</method>
12392
12393	<method name="updateMachineState">
12394	<desc>
12395	Updates the machine state in the VM process.
12396	Must be called only in certain cases
12397	(see the method implementation).
12398
12399	<result name="VBOX_E_INVALID_VM_STATE">
12400	Session state prevents operation.
12401	</result>
12402	<result name="VBOX_E_INVALID_OBJECT_STATE">
12403	Session type prevents operation.
12404	</result>
12405
12406	</desc>
12407	<param name="aMachineState" type="MachineState" dir="in"/>
12408	</method>
12409
12410	<method name="uninitialize">
12411	<desc>
12412	Uninitializes (closes) this session. Used by VirtualBox to close
12413	the corresponding remote session when the direct session dies
12414	or gets closed.
12415
12416	<result name="VBOX_E_INVALID_VM_STATE">
12417	Session state prevents operation.
12418	</result>
12419
12420	</desc>
12421	</method>
12422
12423	<method name="onNetworkAdapterChange">
12424	<desc>
12425	Triggered when settings of a network adapter of the
12426	associated virtual machine have changed.
12427
12428	<result name="VBOX_E_INVALID_VM_STATE">
12429	Session state prevents operation.
12430	</result>
12431	<result name="VBOX_E_INVALID_OBJECT_STATE">
12432	Session type prevents operation.
12433	</result>
12434
12435	</desc>
12436	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
12437	<param name="changeAdapter" type="boolean" dir="in"/>
12438	</method>
12439
12440	<method name="onSerialPortChange">
12441	<desc>
12442	Triggered when settings of a serial port of the
12443	associated virtual machine have changed.
12444
12445	<result name="VBOX_E_INVALID_VM_STATE">
12446	Session state prevents operation.
12447	</result>
12448	<result name="VBOX_E_INVALID_OBJECT_STATE">
12449	Session type prevents operation.
12450	</result>
12451
12452	</desc>
12453	<param name="serialPort" type="ISerialPort" dir="in"/>
12454	</method>
12455
12456	<method name="onParallelPortChange">
12457	<desc>
12458	Triggered when settings of a parallel port of the
12459	associated virtual machine have changed.
12460
12461	<result name="VBOX_E_INVALID_VM_STATE">
12462	Session state prevents operation.
12463	</result>
12464	<result name="VBOX_E_INVALID_OBJECT_STATE">
12465	Session type prevents operation.
12466	</result>
12467
12468	</desc>
12469	<param name="parallelPort" type="IParallelPort" dir="in"/>
12470	</method>
12471
12472	<method name="onStorageControllerChange">
12473	<desc>
12474	Triggered when settings of a storage controller of the
12475	associated virtual machine have changed.
12476
12477	<result name="VBOX_E_INVALID_VM_STATE">
12478	Session state prevents operation.
12479	</result>
12480	<result name="VBOX_E_INVALID_OBJECT_STATE">
12481	Session type prevents operation.
12482	</result>
12483
12484	</desc>
12485	</method>
12486
12487	<method name="onMediumChange">
12488	<desc>
12489	Triggered when attached media of the
12490	associated virtual machine have changed.
12491
12492	<result name="VBOX_E_INVALID_VM_STATE">
12493	Session state prevents operation.
12494	</result>
12495	<result name="VBOX_E_INVALID_OBJECT_STATE">
12496	Session type prevents operation.
12497	</result>
12498
12499	</desc>
12500
12501	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
12502	<param name="force" type="boolean" dir="in"/>
12503	</method>
12504
12505	<method name="onCPUChange">
12506	<desc>
12507	Notification when a CPU changes.
12508	</desc>
12509	<param name="cpu" type="unsigned long" dir="in">
12510	<desc>The CPU which changed</desc>
12511	</param>
12512	<param name="add" type="boolean" dir="in">
12513	<desc>Flag whether the CPU was added or removed</desc>
12514	</param>
12515	</method>
12516
12517	<method name="onVRDPServerChange">
12518	<desc>
12519	Triggered when settings of the VRDP server object of the
12520	associated virtual machine have changed.
12521
12522	<result name="VBOX_E_INVALID_VM_STATE">
12523	Session state prevents operation.
12524	</result>
12525	<result name="VBOX_E_INVALID_OBJECT_STATE">
12526	Session type prevents operation.
12527	</result>
12528
12529	</desc>
12530	<param name="restart" type="boolean" dir="in">
12531	<desc>Flag whether the server must be restarted</desc>
12532	</param>
12533	</method>
12534
12535	<method name="onUSBControllerChange">
12536	<desc>
12537	Triggered when settings of the USB controller object of the
12538	associated virtual machine have changed.
12539
12540	<result name="VBOX_E_INVALID_VM_STATE">
12541	Session state prevents operation.
12542	</result>
12543	<result name="VBOX_E_INVALID_OBJECT_STATE">
12544	Session type prevents operation.
12545	</result>
12546
12547	</desc>
12548	</method>
12549
12550	<method name="onSharedFolderChange">
12551	<desc>
12552	Triggered when a permanent (global or machine) shared folder has been
12553	created or removed.
12554	<note>
12555	We don't pass shared folder parameters in this notification because
12556	the order in which parallel notifications are delivered is not defined,
12557	therefore it could happen that these parameters were outdated by the
12558	time of processing this notification.
12559	</note>
12560
12561	<result name="VBOX_E_INVALID_VM_STATE">
12562	Session state prevents operation.
12563	</result>
12564	<result name="VBOX_E_INVALID_OBJECT_STATE">
12565	Session type prevents operation.
12566	</result>
12567
12568	</desc>
12569	<param name="global" type="boolean" dir="in"/>
12570	</method>
12571
12572	<method name="onUSBDeviceAttach">
12573	<desc>
12574	Triggered when a request to capture a USB device (as a result
12575	of matched USB filters or direct call to
12576	<link to="IConsole::attachUSBDevice"/>) has completed.
12577	A @c null @a error object means success, otherwise it
12578	describes a failure.
12579
12580	<result name="VBOX_E_INVALID_VM_STATE">
12581	Session state prevents operation.
12582	</result>
12583	<result name="VBOX_E_INVALID_OBJECT_STATE">
12584	Session type prevents operation.
12585	</result>
12586
12587	</desc>
12588	<param name="device" type="IUSBDevice" dir="in"/>
12589	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12590	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
12591	</method>
12592
12593	<method name="onUSBDeviceDetach">
12594	<desc>
12595	Triggered when a request to release the USB device (as a result
12596	of machine termination or direct call to
12597	<link to="IConsole::detachUSBDevice"/>) has completed.
12598	A @c null @a error object means success, otherwise it
12599	describes a failure.
12600
12601	<result name="VBOX_E_INVALID_VM_STATE">
12602	Session state prevents operation.
12603	</result>
12604	<result name="VBOX_E_INVALID_OBJECT_STATE">
12605	Session type prevents operation.
12606	</result>
12607
12608	</desc>
12609	<param name="id" type="uuid" mod="string" dir="in"/>
12610	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12611	</method>
12612
12613	<method name="onShowWindow">
12614	<desc>
12615	Called by <link to="IMachine::canShowConsoleWindow"/> and by
12616	<link to="IMachine::showConsoleWindow"/> in order to notify
12617	console listeners
12618	<link to="ICanShowWindowEvent"/>
12619	and <link to="IShowWindowEvent"/>.
12620
12621	<result name="VBOX_E_INVALID_OBJECT_STATE">
12622	Session type prevents operation.
12623	</result>
12624
12625	</desc>
12626	<param name="check" type="boolean" dir="in"/>
12627	<param name="canShow" type="boolean" dir="out"/>
12628	<param name="winId" type="unsigned long long" dir="out"/>
12629	</method>
12630
12631	<method name="accessGuestProperty">
12632	<desc>
12633	Called by <link to="IMachine::getGuestProperty"/> and by
12634	<link to="IMachine::setGuestProperty"/> in order to read and
12635	modify guest properties.
12636
12637	<result name="VBOX_E_INVALID_VM_STATE">
12638	Machine session is not open.
12639	</result>
12640	<result name="VBOX_E_INVALID_OBJECT_STATE">
12641	Session type is not direct.
12642	</result>
12643
12644	</desc>
12645	<param name="name" type="wstring" dir="in"/>
12646	<param name="value" type="wstring" dir="in"/>
12647	<param name="flags" type="wstring" dir="in"/>
12648	<param name="isSetter" type="boolean" dir="in"/>
12649	<param name="retValue" type="wstring" dir="out"/>
12650	<param name="retTimestamp" type="unsigned long long" dir="out"/>
12651	<param name="retFlags" type="wstring" dir="out"/>
12652	</method>
12653
12654	<method name="enumerateGuestProperties">
12655	<desc>
12656	Return a list of the guest properties matching a set of patterns along
12657	with their values, time stamps and flags.
12658
12659	<result name="VBOX_E_INVALID_VM_STATE">
12660	Machine session is not open.
12661	</result>
12662	<result name="VBOX_E_INVALID_OBJECT_STATE">
12663	Session type is not direct.
12664	</result>
12665
12666	</desc>
12667	<param name="patterns" type="wstring" dir="in">
12668	<desc>
12669	The patterns to match the properties against as a comma-separated
12670	string. If this is empty, all properties currently set will be
12671	returned.
12672	</desc>
12673	</param>
12674	<param name="key" type="wstring" dir="out" safearray="yes">
12675	<desc>
12676	The key names of the properties returned.
12677	</desc>
12678	</param>
12679	<param name="value" type="wstring" dir="out" safearray="yes">
12680	<desc>
12681	The values of the properties returned. The array entries match the
12682	corresponding entries in the @a key array.
12683	</desc>
12684	</param>
12685	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
12686	<desc>
12687	The time stamps of the properties returned. The array entries match
12688	the corresponding entries in the @a key array.
12689	</desc>
12690	</param>
12691	<param name="flags" type="wstring" dir="out" safearray="yes">
12692	<desc>
12693	The flags of the properties returned. The array entries match the
12694	corresponding entries in the @a key array.
12695	</desc>
12696	</param>
12697	</method>
12698
12699	<method name="onlineMergeMedium">
12700	<desc>
12701	Triggers online merging of a hard disk. Used internally when deleting
12702	a snapshot while a VM referring to the same hard disk chain is running.
12703
12704	<result name="VBOX_E_INVALID_VM_STATE">
12705	Machine session is not open.
12706	</result>
12707	<result name="VBOX_E_INVALID_OBJECT_STATE">
12708	Session type is not direct.
12709	</result>
12710
12711	</desc>
12712	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
12713	<desc>The medium attachment to identify the medium chain.</desc>
12714	</param>
12715	<param name="sourceIdx" type="unsigned long" dir="in">
12716	<desc>The index of the source image in the chain.
12717	Redundant, but drastically reduces IPC.</desc>
12718	</param>
12719	<param name="targetIdx" type="unsigned long" dir="in">
12720	<desc>The index of the target image in the chain.
12721	Redundant, but drastically reduces IPC.</desc>
12722	</param>
12723	<param name="source" type="IMedium" dir="in">
12724	<desc>Merge source medium.</desc>
12725	</param>
12726	<param name="target" type="IMedium" dir="in">
12727	<desc>Merge target medium.</desc>
12728	</param>
12729	<param name="mergeForward" type="boolean" dir="in">
12730	<desc>Merge direction.</desc>
12731	</param>
12732	<param name="parentForTarget" type="IMedium" dir="in">
12733	<desc>For forward merges: new parent for target medium.</desc>
12734	</param>
12735	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
12736	<desc>For backward merges: list of media which need their parent UUID
12737	updated.</desc>
12738	</param>
12739	<param name="progress" type="IProgress" dir="in">
12740	<desc>
12741	Progress object for this operation.
12742	</desc>
12743	</param>
12744	</method>
12745
12746	</interface>
12747
12748	<interface
12749	name="ISession" extends="$unknown"
12750	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
12751	wsmap="managed"
12752	>
12753	<desc>
12754	The ISession interface represents a serialization primitive for virtual
12755	machines.
12756
12757	With VirtualBox, every time one wishes to manipulate a virtual machine
12758	(e.g. change its settings or start execution), a session object is
12759	required. Such an object must be passed to one of the session methods
12760	that open the given session, which then initiates the machine manipulation.
12761
12762	A session serves several purposes: it identifies to the inter-process VirtualBox
12763	code which process is currently working with the virtual machine, and it ensures
12764	that there are no incompatible requests from several processes for the
12765	same virtual machine. Session objects can therefore be thought of as mutex
12766	semaphores that lock virtual machines to prevent conflicting accesses from
12767	several processes.
12768
12769	How sessions objects are used depends on whether you use the Main API
12770	via COM or via the webservice:
12771
12772	<ul>
12773	<li>When using the COM API directly, an object of the Session class from the
12774	VirtualBox type library needs to be created. In regular COM C++ client code,
12775	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
12776	This object will then act as a local session object in further calls to open
12777	a session.
12778	</li>
12779
12780	<li>In the webservice, the session manager (IWebsessionManager) instead creates
12781	one session object automatically when <link to="IWebsessionManager::logon" />
12782	is called. A managed object reference to that session object can be retrieved by
12783	calling <link to="IWebsessionManager::getSessionObject" />. This session object
12784	reference can then be used to open sessions.
12785	</li>
12786	</ul>
12787
12788	Sessions are mainly used in two variations:
12789
12790	<ul>
12791	<li>
12792	To start a virtual machine in a separate process, one would call
12793	<link to="IVirtualBox::openRemoteSession"/>, which requires a session
12794	object as its first parameter. This session then identifies the caller
12795	and lets him control the started machine (for example, pause machine
12796	execution or power it down) as well as be notified about machine
12797	execution state changes.
12798	</li>
12799
12800	<li>To alter machine settings, or to start machine execution within the
12801	current process, one needs to open a direct session for the machine first by
12802	calling <link to="IVirtualBox::openSession"/>. While a direct session
12803	is open within one process, no any other process may open another direct
12804	session for the same machine. This prevents the machine from being changed
12805	by other processes while it is running or while the machine is being configured.
12806	</li>
12807	</ul>
12808
12809	One also can attach to an existing direct session already opened by
12810	another process (for example, in order to send a control request to the
12811	virtual machine such as the pause or the reset request). This is done by
12812	calling <link to="IVirtualBox::openExistingSession"/>.
12813
12814	<note>
12815	Unless you are trying to write a new VirtualBox front-end that
12816	performs direct machine execution (like the VirtualBox or VBoxSDL
12817	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
12818	session opened by <link to="IVirtualBox::openSession"/> and use this
12819	session only to change virtual machine settings. If you simply want to
12820	start virtual machine execution using one of the existing front-ends
12821	(for example the VirtualBox GUI or headless server), simply use
12822	<link to="IVirtualBox::openRemoteSession"/>; these front-ends
12823	will power up the machine automatically for you.
12824	</note>
12825	</desc>
12826
12827	<attribute name="state" type="SessionState" readonly="yes">
12828	<desc>Current state of this session.</desc>
12829	</attribute>
12830
12831	<attribute name="type" type="SessionType" readonly="yes">
12832	<desc>
12833	Type of this session. The value of this attribute is valid only
12834	if the session is currently open (i.e. its #state is
12835	SessionType_SessionOpen), otherwise an error will be returned.
12836	</desc>
12837	</attribute>
12838
12839	<attribute name="machine" type="IMachine" readonly="yes">
12840	<desc>Machine object associated with this session.</desc>
12841	</attribute>
12842
12843	<attribute name="console" type="IConsole" readonly="yes">
12844	<desc>Console object associated with this session.</desc>
12845	</attribute>
12846
12847	<method name="close">
12848	<desc>
12849	Closes a session that was previously opened.
12850
12851	It is recommended that every time an "open session" method (such as
12852	<link to="IVirtualBox::openRemoteSession" /> or
12853	<link to="IVirtualBox::openSession" />) has been called to
12854	manipulate a virtual machine, the caller invoke
12855	ISession::close() when it's done doing so. Since sessions are
12856	serialization primitives much like ordinary mutexes, they are
12857	best used the same way: for each "open" call, there should be
12858	a matching "close" call, even when errors occur.
12859
12860	Otherwise, if a direct session for a machine opened with
12861	<link to="IVirtualBox::openSession"/> is not explicitly closed
12862	when the application terminates, the state of the machine will
12863	be set to <link to="MachineState_Aborted" /> on the server.
12864
12865	Generally, it is recommended to close all open sessions explicitly
12866	before terminating the application (regardless of the reason for
12867	the termination).
12868
12869	<note>
12870	Do not expect the session state (<link to="ISession::state" />
12871	to return to "Closed" immediately after you invoke
12872	ISession::close(), particularly if you have started a remote
12873	session to execute the VM in a new process. The session state will
12874	automatically return to "Closed" once the VM is no longer executing,
12875	which can of course take a very long time.
12876	</note>
12877
12878	<result name="E_UNEXPECTED">
12879	Session is not open.
12880	</result>
12881
12882	</desc>
12883	</method>
12884
12885	</interface>
12886
12887	<!--
12888	// IStorageController
12889	/////////////////////////////////////////////////////////////////////////
12890	-->
12891
12892	<enum
12893	name="StorageBus"
12894	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
12895	>
12896	<desc>
12897	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
12898	see <link to="IStorageController::bus" />.
12899	</desc>
12900	<const name="Null" value="0">
12901	<desc>@c null value. Never used by the API.</desc>
12902	</const>
12903	<const name="IDE" value="1"/>
12904	<const name="SATA" value="2"/>
12905	<const name="SCSI" value="3"/>
12906	<const name="Floppy" value="4"/>
12907	<const name="SAS" value="5"/>
12908	</enum>
12909
12910	<enum
12911	name="StorageControllerType"
12912	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
12913	>
12914	<desc>
12915	The exact variant of storage controller hardware presented
12916	to the guest; see <link to="IStorageController::controllerType" />.
12917	</desc>
12918
12919	<const name="Null" value="0">
12920	<desc>@c null value. Never used by the API.</desc>
12921	</const>
12922	<const name="LsiLogic" value="1">
12923	<desc>A SCSI controller of the LsiLogic variant.</desc>
12924	</const>
12925	<const name="BusLogic" value="2">
12926	<desc>A SCSI controller of the BusLogic variant.</desc>
12927	</const>
12928	<const name="IntelAhci" value="3">
12929	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
12930	</const>
12931	<const name="PIIX3" value="4">
12932	<desc>An IDE controller of the PIIX3 variant.</desc>
12933	</const>
12934	<const name="PIIX4" value="5">
12935	<desc>An IDE controller of the PIIX4 variant.</desc>
12936	</const>
12937	<const name="ICH6" value="6">
12938	<desc>An IDE controller of the ICH6 variant.</desc>
12939	</const>
12940	<const name="I82078" value="7">
12941	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
12942	</const>
12943	<const name="LsiLogicSas" value="8">
12944	<desc>A variant of the LsiLogic controller using SAS.</desc>
12945	</const>
12946	</enum>
12947
12948	<interface
12949	name="IStorageController" extends="$unknown"
12950	uuid="fd93adc0-bbaa-4256-9e6e-00e29f9151c9"
12951	wsmap="managed"
12952	>
12953	<desc>
12954	Represents a storage controller that is attached to a virtual machine
12955	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
12956	attached to storage controllers in a real computer, virtual drives
12957	(represented by <link to="IMediumAttachment" />) are attached to virtual
12958	storage controllers, represented by this interface.
12959
12960	As opposed to physical hardware, VirtualBox has a very generic concept
12961	of a storage controller, and for purposes of the Main API, all virtual
12962	storage is attached to virtual machines via instances of this interface.
12963	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
12964	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
12965	is used, certain sub-types may be available and can be selected in
12966	<link to="#controllerType" />.
12967
12968	Depending on these settings, the guest operating system might see
12969	significantly different virtual hardware.
12970	</desc>
12971
12972	<attribute name="name" type="wstring" readonly="yes">
12973	<desc>
12974	Name of the storage controller, as originally specified with
12975	<link to="IMachine::addStorageController" />. This then uniquely
12976	identifies this controller with other method calls such as
12977	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
12978	</desc>
12979	</attribute>
12980
12981	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
12982	<desc>
12983	Maximum number of devices which can be attached to one port.
12984	</desc>
12985	</attribute>
12986
12987	<attribute name="minPortCount" type="unsigned long" readonly="yes">
12988	<desc>
12989	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
12990	</desc>
12991	</attribute>
12992
12993	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
12994	<desc>
12995	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
12996	</desc>
12997	</attribute>
12998
12999	<attribute name="instance" type="unsigned long">
13000	<desc>
13001	The instance number of the device in the running VM.
13002	</desc>
13003	</attribute>
13004
13005	<attribute name="portCount" type="unsigned long">
13006	<desc>
13007	The number of currently usable ports on the controller.
13008	The minimum and maximum number of ports for one controller are
13009	stored in <link to="IStorageController::minPortCount"/>
13010	and <link to="IStorageController::maxPortCount"/>.
13011	</desc>
13012	</attribute>
13013
13014	<attribute name="bus" type="StorageBus" readonly="yes">
13015	<desc>
13016	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
13017	</desc>
13018	</attribute>
13019
13020	<attribute name="controllerType" type="StorageControllerType">
13021	<desc>
13022	The exact variant of storage controller hardware presented
13023	to the guest.
13024	Depending on this value, VirtualBox will provide a different
13025	virtual storage controller hardware to the guest.
13026	For SATA, SAS and floppy controllers, only one variant is
13027	available, but for IDE and SCSI, there are several.
13028
13029	For SCSI controllers, the default type is LsiLogic.
13030	</desc>
13031	</attribute>
13032
13033	<attribute name="useHostIOCache" type="boolean">
13034	<desc>
13035	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
13036	caches and use synchronous file APIs on the host. This was the only option in the API before
13037	VirtualBox 3.2 and is still the default for IDE controllers.
13038
13039	If false, the host I/O cache will be disabled for image files attached to this storage controller.
13040	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
13041	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
13042	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
13043	virtual machines are running at the same time to prevent I/O cache related hangs.
13044	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
13045	</desc>
13046	</attribute>
13047
13048	<method name="getIDEEmulationPort">
13049	<desc>
13050	Gets the corresponding port number which is emulated as an IDE device.
13051	Works only with SATA controllers.
13052
13053	<result name="E_INVALIDARG">
13054	The @a devicePosition is not in the range 0 to 3.
13055	</result>
13056	<result name="E_NOTIMPL">
13057	The storage controller type is not SATAIntelAhci.
13058	</result>
13059
13060	</desc>
13061	<param name="devicePosition" type="long" dir="in"/>
13062	<param name="portNumber" type="long" dir="return"/>
13063	</method>
13064
13065	<method name="setIDEEmulationPort">
13066	<desc>
13067	Sets the port number which is emulated as an IDE device.
13068	Works only with SATA controllers.
13069
13070	<result name="E_INVALIDARG">
13071	The @a devicePosition is not in the range 0 to 3 or the
13072	@a portNumber is not in the range 0 to 29.
13073	</result>
13074	<result name="E_NOTIMPL">
13075	The storage controller type is not SATAIntelAhci.
13076	</result>
13077
13078	</desc>
13079	<param name="devicePosition" type="long" dir="in"/>
13080	<param name="portNumber" type="long" dir="in"/>
13081	</method>
13082
13083	</interface>
13084
13085	<if target="wsdl">
13086
13087	<!--
13088	// IManagedObjectRef
13089	/////////////////////////////////////////////////////////////////////////
13090	-->
13091
13092	<interface
13093	name="IManagedObjectRef" extends="$unknown"
13094	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13095	internal="yes"
13096	wsmap="managed"
13097	wscpp="hardcoded"
13098	>
13099	<desc>
13100	Managed object reference.
13101
13102	Only within the webservice, a managed object reference (which is really
13103	an opaque number) allows a webservice client to address an object
13104	that lives in the address space of the webservice server.
13105
13106	Behind each managed object reference, there is a COM object that lives
13107	in the webservice server's address space. The COM object is not freed
13108	until the managed object reference is released, either by an explicit
13109	call to <link to="IManagedObjectRef::release" /> or by logging off from
13110	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13111	all objects created during the webservice session.
13112
13113	Whenever a method call of the VirtualBox API returns a COM object, the
13114	webservice representation of that method will instead return a
13115	managed object reference, which can then be used to invoke methods
13116	on that object.
13117	</desc>
13118
13119	<method name="getInterfaceName">
13120	<desc>
13121	Returns the name of the interface that this managed object represents,
13122	for example, "IMachine", as a string.
13123	</desc>
13124	<param name="return" type="wstring" dir="return"/>
13125	</method>
13126
13127	<method name="release">
13128	<desc>
13129	Releases this managed object reference and frees the resources that
13130	were allocated for it in the webservice server process. After calling
13131	this method, the identifier of the reference can no longer be used.
13132	</desc>
13133	</method>
13134
13135	</interface>
13136
13137	<!--
13138	// IWebsessionManager
13139	/////////////////////////////////////////////////////////////////////////
13140	-->
13141
13142	<interface
13143	name="IWebsessionManager" extends="$unknown"
13144	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13145	internal="yes"
13146	wsmap="global"
13147	wscpp="hardcoded"
13148	>
13149	<desc>
13150	Websession manager. This provides essential services
13151	to webservice clients.
13152	</desc>
13153	<method name="logon">
13154	<desc>
13155	Logs a new client onto the webservice and returns a managed object reference to
13156	the IVirtualBox instance, which the client can then use as a basis to further
13157	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13158	interface, in one way or the other.
13159	</desc>
13160	<param name="username" type="wstring" dir="in"/>
13161	<param name="password" type="wstring" dir="in"/>
13162	<param name="return" type="IVirtualBox" dir="return"/>
13163	</method>
13164
13165	<method name="getSessionObject">
13166	<desc>
13167	Returns a managed object reference to the internal ISession object that was created
13168	for this web service session when the client logged on.
13169
13170	<see>ISession</see>
13171	</desc>
13172	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13173	<param name="return" type="ISession" dir="return"/>
13174	</method>
13175
13176	<method name="logoff">
13177	<desc>
13178	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13179	and destroys all resources associated with the session (most importantly, all
13180	managed objects created in the server while the session was active).
13181	</desc>
13182	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13183	</method>
13184
13185	</interface>
13186
13187	</if>
13188
13189	<!--
13190	// IPerformanceCollector & friends
13191	/////////////////////////////////////////////////////////////////////////
13192	-->
13193
13194	<interface
13195	name="IPerformanceMetric" extends="$unknown"
13196	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
13197	>
13198	<desc>
13199	The IPerformanceMetric interface represents parameters of the given
13200	performance metric.
13201	</desc>
13202
13203	<attribute name="metricName" type="wstring" readonly="yes">
13204	<desc>
13205	Name of the metric.
13206	</desc>
13207	</attribute>
13208
13209	<attribute name="object" type="$unknown" readonly="yes">
13210	<desc>
13211	Object this metric belongs to.
13212	</desc>
13213	</attribute>
13214
13215	<attribute name="description" type="wstring" readonly="yes">
13216	<desc>
13217	Textual description of the metric.
13218	</desc>
13219	</attribute>
13220
13221	<attribute name="period" type="unsigned long" readonly="yes">
13222	<desc>
13223	Time interval between samples, measured in seconds.
13224	</desc>
13225	</attribute>
13226
13227	<attribute name="count" type="unsigned long" readonly="yes">
13228	<desc>
13229	Number of recent samples retained by the performance collector for this
13230	metric.
13231
13232	When the collected sample count exceeds this number, older samples
13233	are discarded.
13234	</desc>
13235	</attribute>
13236
13237	<attribute name="unit" type="wstring" readonly="yes">
13238	<desc>
13239	Unit of measurement.
13240	</desc>
13241	</attribute>
13242
13243	<attribute name="minimumValue" type="long" readonly="yes">
13244	<desc>
13245	Minimum possible value of this metric.
13246	</desc>
13247	</attribute>
13248
13249	<attribute name="maximumValue" type="long" readonly="yes">
13250	<desc>
13251	Maximum possible value of this metric.
13252	</desc>
13253	</attribute>
13254	</interface>
13255
13256	<interface
13257	name="IPerformanceCollector" extends="$unknown"
13258	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
13259	wsmap="managed"
13260	>
13261	<desc>
13262	The IPerformanceCollector interface represents a service that collects
13263	and stores performance metrics data.
13264
13265	Performance metrics are associated with objects of interfaces like IHost
13266	and IMachine. Each object has a distinct set of performance metrics. The
13267	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
13268
13269	Metric data is collected at the specified intervals and is retained
13270	internally. The interval and the number of retained samples can be set
13271	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
13272	and collection settings are not persistent, they are discarded as soon as
13273	VBoxSVC process terminates. Moreover, metric settings and data associated
13274	with a particular VM only exist while VM is running. They disappear as
13275	soon as VM shuts down. It is not possible to set up metrics for machines
13276	that are powered off. One needs to start VM first, then set up metric
13277	collection parameters.
13278
13279	Metrics are organized hierarchically, with each level separated by a
13280	slash (/) character. Generally, the scheme for metric names is like this:
13281
13282	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
13283
13284	"Category/Metric" together form the base metric name. A base metric is
13285	the smallest unit for which a sampling interval and the number of
13286	retained samples can be set. Only base metrics can be enabled and
13287	disabled. All sub-metrics are collected when their base metric is
13288	collected. Collected values for any set of sub-metrics can be queried
13289	with <link to="IPerformanceCollector::queryMetricsData" />.
13290
13291	For example "CPU/Load/User:avg" metric name stands for the "CPU"
13292	category, "Load" metric, "User" submetric, "average" aggregate. An
13293	aggregate function is computed over all retained data. Valid aggregate
13294	functions are:
13295
13296	<ul>
13297	<li>avg -- average</li>
13298	<li>min -- minimum</li>
13299	<li>max -- maximum</li>
13300	</ul>
13301
13302	When setting up metric parameters, querying metric data, enabling or
13303	disabling metrics wildcards can be used in metric names to specify a
13304	subset of metrics. For example, to select all CPU-related metrics
13305	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
13306	so on. To query metric values without aggregates <tt>*:</tt> can be used.
13307
13308	The valid names for base metrics are:
13309
13310	<ul>
13311	<li>CPU/Load</li>
13312	<li>CPU/MHz</li>
13313	<li>RAM/Usage</li>
13314	</ul>
13315
13316	The general sequence for collecting and retrieving the metrics is:
13317	<ul>
13318	<li>
13319	Obtain an instance of IPerformanceCollector with
13320	<link to="IVirtualBox::performanceCollector" />
13321	</li>
13322	<li>
13323	Allocate and populate an array with references to objects the metrics
13324	will be collected for. Use references to IHost and IMachine objects.
13325	</li>
13326	<li>
13327	Allocate and populate an array with base metric names the data will
13328	be collected for.
13329	</li>
13330	<li>
13331	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
13332	the metric data will be collected and stored.
13333	</li>
13334	<li>
13335	Wait for the data to get collected.
13336	</li>
13337	<li>
13338	Allocate and populate an array with references to objects the metric
13339	values will be queried for. You can re-use the object array used for
13340	setting base metrics.
13341	</li>
13342	<li>
13343	Allocate and populate an array with metric names the data will be
13344	collected for. Note that metric names differ from base metric names.
13345	</li>
13346	<li>
13347	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
13348	that have been collected so far are returned. Note that the values
13349	are still retained internally and data collection continues.
13350	</li>
13351	</ul>
13352
13353	For an example of usage refer to the following files in VirtualBox SDK:
13354	<ul>
13355	<li>
13356	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
13357	</li>
13358	<li>
13359	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
13360	</li>
13361	</ul>
13362	</desc>
13363
13364	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
13365	<desc>
13366	Array of unique names of metrics.
13367
13368	This array represents all metrics supported by the performance
13369	collector. Individual objects do not necessarily support all of them.
13370	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
13371	list of supported metrics for a particular object.
13372	</desc>
13373	</attribute>
13374
13375	<method name="getMetrics">
13376	<desc>
13377	Returns parameters of specified metrics for a set of objects.
13378	<note>
13379	@c Null metrics array means all metrics. @c Null object array means
13380	all existing objects.
13381	</note>
13382	</desc>
13383	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13384	<desc>
13385	Metric name filter. Currently, only a comma-separated list of metrics
13386	is supported.
13387	</desc>
13388	</param>
13389	<param name="objects" type="$unknown" dir="in" safearray="yes">
13390	<desc>
13391	Set of objects to return metric parameters for.
13392	</desc>
13393	</param>
13394	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
13395	<desc>
13396	Array of returned metric parameters.
13397	</desc>
13398	</param>
13399	</method>
13400
13401	<method name="setupMetrics">
13402	<desc>
13403	Sets parameters of specified base metrics for a set of objects. Returns
13404	an array of <link to="IPerformanceMetric" /> describing the metrics
13405	have been affected.
13406	<note>
13407	@c Null or empty metric name array means all metrics. @c Null or
13408	empty object array means all existing objects. If metric name array
13409	contains a single element and object array contains many, the single
13410	metric name array element is applied to each object array element to
13411	form metric/object pairs.
13412	</note>
13413	</desc>
13414	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13415	<desc>
13416	Metric name filter. Comma-separated list of metrics with wildcard
13417	support.
13418	</desc>
13419	</param>
13420	<param name="objects" type="$unknown" dir="in" safearray="yes">
13421	<desc>
13422	Set of objects to setup metric parameters for.
13423	</desc>
13424	</param>
13425	<param name="period" type="unsigned long" dir="in">
13426	<desc>
13427	Time interval in seconds between two consecutive samples of
13428	performance data.
13429	</desc>
13430	</param>
13431	<param name="count" type="unsigned long" dir="in">
13432	<desc>
13433	Number of samples to retain in performance data history. Older
13434	samples get discarded.
13435	</desc>
13436	</param>
13437	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13438	<desc>
13439	Array of metrics that have been modified by the call to this method.
13440	</desc>
13441	</param>
13442	</method>
13443
13444	<method name="enableMetrics">
13445	<desc>
13446	Turns on collecting specified base metrics. Returns an array of
13447	<link to="IPerformanceMetric" /> describing the metrics have been
13448	affected.
13449	<note>
13450	@c Null or empty metric name array means all metrics. @c Null or
13451	empty object array means all existing objects. If metric name array
13452	contains a single element and object array contains many, the single
13453	metric name array element is applied to each object array element to
13454	form metric/object pairs.
13455	</note>
13456	</desc>
13457	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13458	<desc>
13459	Metric name filter. Comma-separated list of metrics with wildcard
13460	support.
13461	</desc>
13462	</param>
13463	<param name="objects" type="$unknown" dir="in" safearray="yes">
13464	<desc>
13465	Set of objects to enable metrics for.
13466	</desc>
13467	</param>
13468	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13469	<desc>
13470	Array of metrics that have been modified by the call to this method.
13471	</desc>
13472	</param>
13473	</method>
13474
13475	<method name="disableMetrics">
13476	<desc>
13477	Turns off collecting specified base metrics. Returns an array of
13478	<link to="IPerformanceMetric" /> describing the metrics have been
13479	affected.
13480	<note>
13481	@c Null or empty metric name array means all metrics. @c Null or
13482	empty object array means all existing objects. If metric name array
13483	contains a single element and object array contains many, the single
13484	metric name array element is applied to each object array element to
13485	form metric/object pairs.
13486	</note>
13487	</desc>
13488	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13489	<desc>
13490	Metric name filter. Comma-separated list of metrics with wildcard
13491	support.
13492	</desc>
13493	</param>
13494	<param name="objects" type="$unknown" dir="in" safearray="yes">
13495	<desc>
13496	Set of objects to disable metrics for.
13497	</desc>
13498	</param>
13499	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13500	<desc>
13501	Array of metrics that have been modified by the call to this method.
13502	</desc>
13503	</param>
13504	</method>
13505
13506	<method name="queryMetricsData">
13507	<desc>
13508	Queries collected metrics data for a set of objects.
13509
13510	The data itself and related metric information are returned in seven
13511	parallel and one flattened array of arrays. Elements of
13512	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
13513	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
13514	the same index describe one set of values corresponding to a single
13515	metric.
13516
13517	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
13518	start and length of a sub-array is indicated by
13519	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
13520	value for metric <tt>metricNames[i]</tt> is at
13521	<tt>returnData[returnIndices[i]]</tt>.
13522
13523	<note>
13524	@c Null or empty metric name array means all metrics. @c Null or
13525	empty object array means all existing objects. If metric name array
13526	contains a single element and object array contains many, the single
13527	metric name array element is applied to each object array element to
13528	form metric/object pairs.
13529	</note>
13530	<note>
13531	Data collection continues behind the scenes after call to @c
13532	queryMetricsData. The return data can be seen as the snapshot of the
13533	current state at the time of @c queryMetricsData call. The internally
13534	kept metric values are not cleared by the call. This makes possible
13535	querying different subsets of metrics or aggregates with subsequent
13536	calls. If periodic querying is needed it is highly suggested to query
13537	the values with @c interval*count period to avoid confusion. This way
13538	a completely new set of data values will be provided by each query.
13539	</note>
13540	</desc>
13541	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13542	<desc>
13543	Metric name filter. Comma-separated list of metrics with wildcard
13544	support.
13545	</desc>
13546	</param>
13547	<param name="objects" type="$unknown" dir="in" safearray="yes">
13548	<desc>
13549	Set of objects to query metrics for.
13550	</desc>
13551	</param>
13552	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
13553	<desc>
13554	Names of metrics returned in @c returnData.
13555	</desc>
13556	</param>
13557	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
13558	<desc>
13559	Objects associated with metrics returned in @c returnData.
13560	</desc>
13561	</param>
13562	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
13563	<desc>
13564	Units of measurement for each returned metric.
13565	</desc>
13566	</param>
13567	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
13568	<desc>
13569	Divisor that should be applied to return values in order to get
13570	floating point values. For example:
13571	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
13572	will retrieve the floating point value of i-th sample of the first
13573	metric.
13574	</desc>
13575	</param>
13576	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
13577	<desc>
13578	Sequence numbers of the first elements of value sequences of
13579	particular metrics returned in @c returnData. For aggregate metrics
13580	it is the sequence number of the sample the aggregate started
13581	calculation from.
13582	</desc>
13583	</param>
13584	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
13585	<desc>
13586	Indices of the first elements of value sequences of particular
13587	metrics returned in @c returnData.
13588	</desc>
13589	</param>
13590	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
13591	<desc>
13592	Lengths of value sequences of particular metrics.
13593	</desc>
13594	</param>
13595	<param name="returnData" type="long" dir="return" safearray="yes">
13596	<desc>
13597	Flattened array of all metric data containing sequences of values for
13598	each metric.
13599	</desc>
13600	</param>
13601	</method>
13602
13603	</interface>
13604	<enum
13605	name="NATAliasMode"
13606	uuid="67772168-50d9-11df-9669-7fb714ee4fa1">
13607	<desc></desc>
13608	<const name="AliasLog" value="0x1">
13609	<desc></desc>
13610	</const>
13611	<const name="AliasProxyOnly" value="0x02">
13612	<desc></desc>
13613	</const>
13614	<const name="AliasUseSamePorts" value="0x04">
13615	<desc></desc>
13616	</const>
13617	</enum>
13618	<enum
13619	name="NATProtocol"
13620	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
13621	>
13622	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
13623	<const name="UDP" value="0">
13624	<desc>Port-forwarding uses UDP protocol.</desc>
13625	</const>
13626	<const name="TCP" value="1">
13627	<desc>Port-forwarding uses TCP protocol.</desc>
13628	</const>
13629	</enum>
13630
13631	<interface
13632	name="INATEngine" extends="$unknown"
13633	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
13634	wsmap="managed"
13635	>
13636	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
13637	allows for changing NAT behavior such as port-forwarding rules. This interface is
13638	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
13639	<attribute name="network" type="wstring">
13640	<desc>The network attribute of the NAT engine (the same value is used with built-in
13641	DHCP server to fill corresponding fields of DHCP leases).</desc>
13642	</attribute>
13643	<attribute name="hostIP" type="wstring">
13644	<desc>IP of host interface to bind all opened sockets to.
13645	<note>Changing this does not change binding of port forwarding.</note>
13646	</desc>
13647	</attribute>
13648	<attribute name="tftpPrefix" type="wstring">
13649	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
13650	the corresponding fields of DHCP leases.</desc>
13651	</attribute>
13652	<attribute name="tftpBootFile" type="wstring">
13653	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
13654	the corresponding fields of DHCP leases.</desc>
13655	</attribute>
13656	<attribute name="tftpNextServer" type="wstring">
13657	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
13658	the corresponding fields of DHCP leases.
13659	<note>The preferred form is IPv4 addresses.</note>
13660	</desc>
13661	</attribute>
13662	<attribute name="aliasMode" type="unsigned long">
13663	<desc></desc>
13664	</attribute>
13665	<attribute name="dnsPassDomain" type="boolean">
13666	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
13667	</attribute>
13668	<attribute name="dnsProxy" type="boolean">
13669	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
13670	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
13671	</attribute>
13672	<attribute name="dnsUseHostResolver" type="boolean">
13673	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
13674	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
13675	</attribute>
13676	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
13677	<desc>Array of NAT port-forwarding rules in string representation, in the following
13678	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
13679	</attribute>
13680	<method name="setNetworkSettings">
13681	<desc>Sets network configuration of the NAT engine.</desc>
13682	<param name="mtu" type="unsigned long" dir="in">
13683	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
13684	</param>
13685	<param name="sockSnd" type="unsigned long" dir="in">
13686	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
13687	</param>
13688	<param name="sockRcv" type="unsigned long" dir="in">
13689	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
13690	</param>
13691	<param name="TcpWndSnd" type="unsigned long" dir="in">
13692	<desc>Initial size of the NAT engine's sending TCP window in bytes when
13693	establishing a new TCP connection.</desc>
13694	</param>
13695	<param name="TcpWndRcv" type="unsigned long" dir="in">
13696	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
13697	establishing a new TCP connection.</desc>
13698	</param>
13699	</method>
13700	<method name="getNetworkSettings">
13701	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
13702	for parameter descriptions.</desc>
13703	<param name="mtu" type="unsigned long" dir="out" />
13704	<param name="sockSnd" type="unsigned long" dir="out" />
13705	<param name="sockRcv" type="unsigned long" dir="out" />
13706	<param name="TcpWndSnd" type="unsigned long" dir="out" />
13707	<param name="TcpWndRcv" type="unsigned long" dir="out" />
13708	</method>
13709	<method name="addRedirect">
13710	<desc>Adds a new NAT port-forwarding rule.</desc>
13711	<param name="name" type="wstring" dir="in">
13712	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
13713	auto-generates one using the other parameters.</desc>
13714	</param>
13715	<param name="proto" type="NATProtocol" dir="in">
13716	<desc>Protocol handled with the rule.</desc>
13717	</param>
13718	<param name="hostIp" type="wstring" dir="in">
13719	<desc>IP of the host interface to which the rule should apply. An empty ip address is
13720	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
13721	</param>
13722	<param name="hostPort" type="unsigned short" dir="in">
13723	<desc>The port number to listen on.</desc>
13724	</param>
13725	<param name="guestIp" type="wstring" dir="in">
13726	<desc>The IP address of the guest which the NAT engine will forward matching packets
13727	to. An empty IP address is acceptable, in which case the NAT engine will forward
13728	packets to the first DHCP lease (x.x.x.15).</desc>
13729	</param>
13730	<param name="guestPort" type="unsigned short" dir="in">
13731	<desc>The port number to forward.</desc>
13732	</param>
13733	</method>
13734	<method name="removeRedirect">
13735	<desc>Removes a port-forwarding rule that was previously registered.</desc>
13736	<param name="name" type="wstring" dir="in">
13737	<desc>The name of the rule to delete.</desc>
13738	</param>
13739	</method>
13740	</interface>
13741
13742	<enum
13743	name="VBoxEventType"
13744	uuid="7d695029-32b8-4855-86d3-75de9082923b">
13745
13746	<desc>
13747	Type of an event.
13748	</desc>
13749
13750	<const name="Invalid" value="0">
13751	<desc>
13752	Invalid event, must be first.
13753	</desc>
13754	</const>
13755
13756	<const name="Any" value="1">
13757	<desc>
13758	Wildcard for all events. Events of this type are never delivered, and only used in
13759	registerListener() call to simplify registration.
13760	</desc>
13761	</const>
13762
13763	<const name="MachineEvent" value="2">
13764	<desc>
13765	Wildcard for all machine events. Events of this type are never delivered, and only used in
13766	registerListener() call to simplify registration.
13767	</desc>
13768	</const>
13769
13770	<const name="SnapshotEvent" value="3">
13771	<desc>
13772	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
13773	registerListener() call to simplify registration.
13774	</desc>
13775	</const>
13776
13777	<const name="InputEvent" value="4">
13778	<desc>
13779	Wildcard for all input device (keyboard, mouse) events.
13780	Events of this type are never delivered, and only used in
13781	registerListener() call to simplify registration.
13782	</desc>
13783	</const>
13784
13785	<const name="LastWildcard" value="31">
13786	<desc>
13787	Last wildcard.
13788	</desc>
13789	</const>
13790
13791	<const name="OnMachineStateChanged" value="32">
13792	<desc>
13793	<see>IMachineStateChangedEvent</see>
13794	</desc>
13795	</const>
13796	<const name="OnMachineDataChanged" value="33">
13797	<desc>
13798	<see>IMachineDataChangedEvent</see>
13799	</desc>
13800	</const>
13801	<const name="OnExtraDataChanged" value="34">
13802	<desc>
13803	<see>IExtraDataChangedEvent</see>
13804	</desc>
13805	</const>
13806	<const name="OnExtraDataCanChange" value="35">
13807	<desc>
13808	<see>IExtraDataCanChangeEvent</see>
13809	</desc>
13810	</const>
13811	<const name="OnMediumRegistered" value="36">
13812	<desc>
13813	<see>IMediumRegistered</see>
13814	</desc>
13815	</const>
13816	<const name="OnMachineRegistered" value="37">
13817	<desc>
13818	<see>IMachineRegisteredEvent</see>
13819	</desc>
13820	</const>
13821	<const name="OnSessionStateChanged" value="38">
13822	<desc>
13823	<see>ISessionStateChangedEvent</see>
13824	</desc>
13825	</const>
13826	<const name="OnSnapshotTaken" value="39">
13827	<desc>
13828	<see>ISnapshotTakenEvent</see>
13829	</desc>
13830	</const>
13831	<const name="OnSnapshotDeleted" value="40">
13832	<desc>
13833	<see>ISnapshotDeletedEvent</see>
13834	</desc>
13835	</const>
13836	<const name="OnSnapshotChanged" value="41">
13837	<desc>
13838	<see>ISnapshotChangedEvent</see>
13839	</desc>
13840	</const>
13841	<const name="OnGuestPropertyChanged" value="42">
13842	<desc>
13843	<see>IGuestPropertyChangedEvent</see>
13844	</desc>
13845	</const>
13846	<!-- Console events -->
13847	<const name="OnMousePointerShapeChanged" value="43">
13848	<desc>
13849	<see>IMousePointerShapeChangedEvent</see>
13850	</desc>
13851	</const>
13852	<const name="OnMouseCapabilityChanged" value="44">
13853	<desc>
13854	<see>IMouseCapabilityChangedEvent</see>
13855	</desc>
13856	</const>
13857	<const name="OnKeyboardLedsChanged" value="45">
13858	<desc>
13859	<see>IKeyboardLedsChangedEvent</see>
13860	</desc>
13861	</const>
13862	<const name="OnStateChanged" value="46">
13863	<desc>
13864	<see>IStateChangedEvent</see>
13865	</desc>
13866	</const>
13867	<const name="OnAdditionsStateChanged" value="47">
13868	<desc>
13869	<see>IAdditionsStateChangedEvent</see>
13870	</desc>
13871	</const>
13872	<const name="OnNetworkAdapterChanged" value="48">
13873	<desc>
13874	<see>INetworkAdapterChangedEvent</see>
13875	</desc>
13876	</const>
13877	<const name="OnSerialPortChanged" value="49">
13878	<desc>
13879	<see>ISerialPortChangedEvent</see>
13880	</desc>
13881	</const>
13882	<const name="OnParallelPortChanged" value="50">
13883	<desc>
13884	<see>IParallelPortChangedEvent</see>
13885	</desc>
13886	</const>
13887	<const name="OnStorageControllerChanged" value="51">
13888	<desc>
13889	<see>IStorageControllerChangedEvent</see>
13890	</desc>
13891	</const>
13892	<const name="OnMediumChanged" value="52">
13893	<desc>
13894	<see>IMediumChangedEvent</see>
13895	</desc>
13896	</const>
13897	<const name="OnVRDPServerChanged" value="53">
13898	<desc>
13899	<see>IVRDPServerChangedEvent</see>
13900	</desc>
13901	</const>
13902	<const name="OnUSBControllerChanged" value="54">
13903	<desc>
13904	<see>IUSBControllerChangedEvent</see>
13905	</desc>
13906	</const>
13907	<const name="OnUSBDeviceStateChanged" value="55">
13908	<desc>
13909	<see>IUSBDeviceStateChangedEvent</see>
13910	</desc>
13911	</const>
13912	<const name="OnSharedFolderChanged" value="56">
13913	<desc>
13914	<see>ISharedFolderChangedEvent</see>
13915	</desc>
13916	</const>
13917	<const name="OnRuntimeError" value="57">
13918	<desc>
13919	<see>IRuntimeErrorEvent</see>
13920	</desc>
13921	</const>
13922	<const name="OnCanShowWindow" value="58">
13923	<desc>
13924	<see>ICanShowWindowEvent</see>
13925	</desc>
13926	</const>
13927	<const name="OnShowWindow" value="59">
13928	<desc>
13929	<see>IShowWindowEvent</see>
13930	</desc>
13931	</const>
13932	<const name="OnCPUChanged" value="60">
13933	<desc>
13934	<see>ICPUChangedEvent</see>
13935	</desc>
13936	</const>
13937	<const name="OnRemoteDisplayInfoChanged" value="61">
13938	<desc>
13939	<see>IRemoteDisplayInfoChangedEvent</see>
13940	</desc>
13941	</const>
13942	<const name="OnEventSourceChanged" value="62">
13943	<desc>
13944	<see>IEventSourceChangedEvent</see>
13945	</desc>
13946	</const>
13947	<!-- Last event marker -->
13948	<const name="Last" value="63">
13949	<desc>
13950	Must be last event, used for iterations and structures relying on numerical event values.
13951	</desc>
13952	</const>
13953
13954	</enum>
13955
13956	<interface
13957	name="IEventSource" extends="$unknown"
13958	uuid="3c670618-f727-4fe9-94d2-8243f489a033"
13959	wsmap="managed"
13960	>
13961	<desc>
13962	Event source. Generally, any object which could generate events can be an event source,
13963	or aggregate one. To simplify using one-way protocols, such as webservices running on top of HTTP(S),
13964	event source can work with listeners in either active or passive mode. In active mode it's up to
13965	IEventSource implementation to call handleEvent(), in passive mode event source keeps track of
13966	pending events for each listener and returns available events on demand.
13967	</desc>
13968
13969	<method name="createListener">
13970	<desc>
13971	Creates new listener object, useful for passive mode.
13972	<see>IEventListener</see>
13973	</desc>
13974	<param name="listener" type="IEventListener" dir="return"/>
13975	</method>
13976
13977	<method name="registerListener">
13978	<desc>
13979	Register an event listener.
13980	</desc>
13981	<param name="listener" type="IEventListener" dir="in">
13982	<desc>Listener to register.</desc>
13983	</param>
13984	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
13985	<desc>
13986	Event types listener is interested in. One can use wildcards like Any -
13987	<see>VBoxEventType::Any</see> to specify wildcards.
13988	</desc>
13989	</param>
13990	<param name="active" type="boolean" dir="in">
13991	<desc>
13992	Which mode this listener shall function in.
13993	If in active mode, IEventListener's handleEvent() is called directly.
13994	If in passive mode - for this IEventListener internal event queue is created.
13995	When next event comes, it's added to queues for all interested registered passive
13996	listeners. It's up to external code to call listener's handleEvent() then.
13997	When done with event, it shall call source's eventComplete().
13998	</desc>
13999	</param>
14000	</method>
14001
14002	<method name="unregisterListener">
14003	<desc>
14004	Unregister an event listener. If listener is passive, and some waitable events are still
14005	in queue they are marked as processed automatically.
14006	</desc>
14007	<param name="listener" type="IEventListener" dir="in">
14008	<desc>Listener to unregister.</desc>
14009	</param>
14010	</method>
14011
14012	<method name="fireEvent">
14013	<desc>
14014	Fire an event for this source.
14015	</desc>
14016	<param name="event" type="IEvent" dir="in">
14017	<desc>Event to deliver.</desc>
14018	</param>
14019	<param name="timeout" type="long" dir="in">
14020	<desc>
14021	Timeout to wait until event processed in ms (if event is waitable),
14022	0 - no wait, -1 - forever until delivered.
14023	</desc>
14024	</param>
14025	<param name="result" type="boolean" dir="return">
14026	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
14027	</param>
14028	</method>
14029
14030	<method name="getEvent">
14031	<desc>
14032	Get events from this peer's event queue (for passive mode). Consumer's implementation
14033	must call listener's handleEvent() once event is available.
14034	</desc>
14035	<param name="listener" type="IEventListener" dir="in">
14036	<desc>Which listener get data for.</desc>
14037	</param>
14038	<param name="timeout" type="long" dir="in">
14039	<desc>Timeout to wait until event available in ms, 0 - no wait, -1 - forever until available.</desc>
14040	</param>
14041	<param name="event" type="IEvent" dir="return">
14042	<desc>Event retrieved, or null if none available.</desc>
14043	</param>
14044	</method>
14045
14046	<method name="eventProcessed">
14047	<desc>
14048	Must be called for waitable events when particular listener finished event processing.
14049	When all listeners who this event was aimed to call eventProcessed() event source
14050	can call event's setProcessed().
14051	</desc>
14052	<param name="listener" type="IEventListener" dir="in">
14053	<desc>Which listener processed event.</desc>
14054	</param>
14055	<param name="event" type="IEvent" dir="in">
14056	<desc>Which event.</desc>
14057	</param>
14058	</method>
14059
14060	</interface>
14061
14062	<interface
14063	name="IEventListener" extends="$unknown"
14064	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
14065	wsmap="managed"
14066	>
14067	<desc>
14068	Event listener. Event listener can work in either active, or passive mode, depending on the way it's registered.
14069	</desc>
14070
14071	<method name="handleEvent">
14072	<desc>
14073	Handle event callback (called directly by IEventSource in active mode, or could be
14074	called by event processor thread in passive mode).
14075	</desc>
14076	<param name="event" type="IEvent" dir="in">
14077	<desc>Event available.</desc>
14078	</param>
14079	</method>
14080
14081	</interface>
14082
14083	<interface
14084	name="IEvent" extends="$unknown"
14085	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
14086	wsmap="managed"
14087	>
14088	<desc>
14089	Generic event. Usually events implements some of IEvent subinterfaces, so
14090	standard use pattern is to check 'type' attribute and downcast (with QueryInterface())
14091	appropraitely.
14092	</desc>
14093
14094	<attribute name="type" readonly="yes" type="VBoxEventType">
14095	<desc>
14096	Event type.
14097	</desc>
14098	</attribute>
14099
14100	<attribute name="source" readonly="yes" type="IEventSource">
14101	<desc>
14102	Source of this event.
14103	</desc>
14104	</attribute>
14105
14106	<attribute name="waitable" readonly="yes" type="boolean">
14107	<desc>
14108	If we can wait for this event being processed. If false, waitProcessed() returns immediately,
14109	and setProcessed() doesn't make sense. Non-waitable events are generally better performing,
14110	as no additional overhead associated with waitability imposed.
14111	Waitable events are needed when some need to be able to wait for particular event processed,
14112	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
14113	until all consumers confirmed events.
14114	</desc>
14115	</attribute>
14116
14117	<method name="setProcessed">
14118	<desc>
14119	Called to mark the moment when this event is considered processed.
14120	</desc>
14121	</method>
14122
14123	<method name="waitProcessed">
14124	<desc>
14125	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
14126	described semantics, for non-waitable returns true immediately.
14127	</desc>
14128	<param name="timeout" type="long" dir="in">
14129	<desc>Timeout to wait until event processed in ms, 0 - no wait, -1 - forever until processed.</desc>
14130	</param>
14131	<param name="result" type="boolean" dir="return">
14132	<desc>If this event was processed before timeout.</desc>
14133	</param>
14134	</method>
14135	</interface>
14136
14137
14138	<interface
14139	name="IMachineEvent" extends="IEvent"
14140	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
14141	wsmap="managed" id="MachineEvent"
14142	>
14143	<desc>Base abstract interface for all machine events.</desc>
14144
14145	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
14146	<desc>ID of the machine this event relates to.</desc>
14147	</attribute>
14148
14149	</interface>
14150
14151	<interface
14152	name="IMachineStateChangedEvent" extends="IMachineEvent"
14153	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
14154	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
14155	>
14156	<desc>Machine state change event.</desc>
14157
14158	<attribute name="state" readonly="yes" type="MachineState">
14159	<desc>New execution state.</desc>
14160	</attribute>
14161	</interface>
14162
14163	<interface
14164	name="IMachineDataChangedEvent" extends="IMachineEvent"
14165	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
14166	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
14167	>
14168	<desc>
14169	Any of the settings of the given machine has changed.
14170	</desc>
14171	</interface>
14172
14173	<interface
14174	name="IMachineRegisteredEvent" extends="IMachineEvent"
14175	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
14176	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
14177	>
14178	<desc>
14179	The given machine was registered or unregistered
14180	within this VirtualBox installation.
14181	</desc>
14182
14183	<attribute name="registered" type="boolean" readonly="yes">
14184	<desc>
14185	If @c true, the machine was registered, otherwise it was
14186	unregistered.
14187	</desc>
14188	</attribute>
14189	</interface>
14190
14191	<interface
14192	name="ISessionStateChangedEvent" extends="IMachineEvent"
14193	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
14194	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
14195	>
14196	<desc>
14197	The state of the session for the given machine was changed.
14198	<see>IMachine::sessionState</see>
14199	</desc>
14200
14201	<attribute name="state" type="SessionState" readonly="yes">
14202	<desc>
14203	New session state.
14204	</desc>
14205	</attribute>
14206	</interface>
14207
14208	<interface
14209	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
14210	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
14211	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
14212	>
14213	<desc>
14214	Notification when a guest property has changed.
14215	</desc>
14216
14217	<attribute name="name" readonly="yes" type="wstring">
14218	<desc>
14219	The name of the property that has changed.
14220	</desc>
14221	</attribute>
14222
14223	<attribute name="value" readonly="yes" type="wstring">
14224	<desc>
14225	The new property value.
14226	</desc>
14227	</attribute>
14228
14229	<attribute name="flags" readonly="yes" type="wstring">
14230	<desc>
14231	The new property flags.
14232	</desc>
14233	</attribute>
14234
14235	</interface>
14236
14237	<interface
14238	name="ISnapshotEvent" extends="IMachineEvent"
14239	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
14240	wsmap="managed" id="SnapshotEvent"
14241	>
14242	<desc>Base interface for all snapshot events.</desc>
14243
14244	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
14245	<desc>ID of the snapshot this event relates to.</desc>
14246	</attribute>
14247
14248	</interface>
14249
14250	<interface
14251	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
14252	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
14253	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
14254	>
14255	<desc>
14256	A new snapshot of the machine has been taken.
14257	<see>ISnapshot</see>
14258	</desc>
14259	</interface>
14260
14261	<interface
14262	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
14263	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
14264	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
14265	>
14266	<desc>
14267	Snapshot of the given machine has been deleted.
14268
14269	<note>
14270	This notification is delivered <b>after</b> the snapshot
14271	object has been uninitialized on the server (so that any
14272	attempt to call its methods will return an error).
14273	</note>
14274
14275	<see>ISnapshot</see>
14276	</desc>
14277	</interface>
14278
14279	<interface
14280	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
14281	uuid="07541941-8079-447a-a33e-47a69c7980db"
14282	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
14283	>
14284	<desc>
14285	Snapshot properties (name and/or description) have been changed.
14286	<see>ISnapshot</see>
14287	</desc>
14288	</interface>
14289
14290	<interface
14291	name="IMousePointerShapeChangedEvent" extends="IEvent"
14292	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
14293	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
14294	>
14295	<desc>
14296	Notification when the guest mouse pointer shape has
14297	changed. The new shape data is given.
14298	</desc>
14299
14300	<attribute name="visible" type="boolean" readonly="yes">
14301	<desc>
14302	Flag whether the pointer is visible.
14303	</desc>
14304	</attribute>
14305	<attribute name="alpha" type="boolean" readonly="yes">
14306	<desc>
14307	Flag whether the pointer has an alpha channel.
14308	</desc>
14309	</attribute>
14310	<attribute name="xhot" type="unsigned long" readonly="yes">
14311	<desc>
14312	The pointer hot spot X coordinate.
14313	</desc>
14314	</attribute>
14315	<attribute name="yhot" type="unsigned long" readonly="yes">
14316	<desc>
14317	The pointer hot spot Y coordinate.
14318	</desc>
14319	</attribute>
14320	<attribute name="width" type="unsigned long" readonly="yes">
14321	<desc>
14322	Width of the pointer shape in pixels.
14323	</desc>
14324	</attribute>
14325	<attribute name="height" type="unsigned long" readonly="yes">
14326	<desc>
14327	Height of the pointer shape in pixels.
14328	</desc>
14329	</attribute>
14330	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
14331	<desc>
14332	Shape buffer arrays.
14333
14334	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
14335	followed by a 32-bpp XOR (color) mask.
14336
14337	For pointers without alpha channel the XOR mask pixels are 32
14338	bit values: (lsb)BGR0(msb). For pointers with alpha channel
14339	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
14340
14341	An AND mask is used for pointers with alpha channel, so if the
14342	callback does not support alpha, the pointer could be
14343	displayed as a normal color pointer.
14344
14345	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
14346	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
14347	height</tt>. The padding bits at the end of each scanline are
14348	undefined.
14349
14350	The XOR mask follows the AND mask on the next 4-byte aligned
14351	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
14352	Bytes in the gap between the AND and the XOR mask are undefined.
14353	The XOR mask scanlines have no gap between them and the size of
14354	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
14355
14356	<note>
14357	If @a shape is 0, only the pointer visibility is changed.
14358	</note>
14359	</desc>
14360	</attribute>
14361	</interface>
14362
14363	<interface
14364	name="IMouseCapabilityChangedEvent" extends="IEvent"
14365	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
14366	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
14367	>
14368	<desc>
14369	Notification when the mouse capabilities reported by the
14370	guest have changed. The new capabilities are passed.
14371	</desc>
14372	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
14373	<desc>
14374	Supports absolute coordinates.
14375	</desc>
14376	</attribute>
14377	<attribute name="supportsRelative" type="boolean" readonly="yes">
14378	<desc>
14379	Supports relative coordinates.
14380	</desc>
14381	</attribute>
14382	<attribute name="needsHostCursor" type="boolean" readonly="yes">
14383	<desc>
14384	If host cursor is needed.
14385	</desc>
14386	</attribute>
14387	</interface>
14388
14389	<interface
14390	name="IKeyboardLedsChangedEvent" extends="IEvent"
14391	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
14392	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
14393	>
14394	<desc>
14395	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
14396	to alter the state of the keyboard LEDs.
14397	</desc>
14398	<attribute name="numLock" type="boolean" readonly="yes">
14399	<desc>
14400	NumLock status.
14401	</desc>
14402	</attribute>
14403	<attribute name="capsLock" type="boolean" readonly="yes">
14404	<desc>
14405	CapsLock status.
14406	</desc>
14407	</attribute>
14408	<attribute name="scrollLock" type="boolean" readonly="yes">
14409	<desc>
14410	ScrollLock status.
14411	</desc>
14412	</attribute>
14413	</interface>
14414
14415	<interface
14416	name="IStateChangedEvent" extends="IEvent"
14417	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
14418	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
14419	>
14420	<desc>
14421	Notification when the execution state of the machine has changed.
14422	The new state is given.
14423	</desc>
14424	<attribute name="state" type="MachineState" readonly="yes">
14425	<desc>
14426	New machine state.
14427	</desc>
14428	</attribute>
14429	</interface>
14430
14431	<interface
14432	name="IAdditionsStateChangedEvent" extends="IEvent"
14433	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
14434	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
14435	>
14436	<desc>
14437	Notification when a Guest Additions property changes.
14438	Interested callees should query IGuest attributes to
14439	find out what has changed.
14440	</desc>
14441	</interface>
14442
14443	<interface
14444	name="INetworkAdapterChangedEvent" extends="IEvent"
14445	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
14446	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
14447	>
14448	<desc>
14449	Notification when a property of one of the
14450	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
14451	changes. Interested callees should use INetworkAdapter methods and
14452	attributes to find out what has changed.
14453	</desc>
14454	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
14455	<desc>
14456	Network adapter that is subject to change.
14457	</desc>
14458	</attribute>
14459	</interface>
14460
14461	<interface
14462	name="ISerialPortChangedEvent" extends="IEvent"
14463	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
14464	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
14465	>
14466	<desc>
14467	Notification when a property of one of the
14468	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
14469	Interested callees should use ISerialPort methods and attributes
14470	to find out what has changed.
14471	</desc>
14472	<attribute name="serialPort" type="ISerialPort" readonly="yes">
14473	<desc>
14474	Serial port that is subject to change.
14475	</desc>
14476	</attribute>
14477	</interface>
14478
14479	<interface
14480	name="IParallelPortChangedEvent" extends="IEvent"
14481	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
14482	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
14483	>
14484	<desc>
14485	Notification when a property of one of the
14486	virtual <link to="IMachine::getParallelPort">parallel ports</link>
14487	changes. Interested callees should use ISerialPort methods and
14488	attributes to find out what has changed.
14489	</desc>
14490	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
14491	<desc>
14492	Parallel port that is subject to change.
14493	</desc>
14494	</attribute>
14495	</interface>
14496
14497	<interface
14498	name="IStorageControllerChangedEvent" extends="IEvent"
14499	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
14500	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
14501	>
14502	<desc>
14503	Notification when a
14504	<link to="IMachine::mediumAttachments">medium attachment</link>
14505	changes.
14506	</desc>
14507	</interface>
14508
14509	<interface
14510	name="IMediumChangedEvent" extends="IEvent"
14511	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
14512	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
14513	>
14514	<desc>
14515	Notification when a
14516	<link to="IMachine::mediumAttachments">medium attachment</link>
14517	changes.
14518	</desc>
14519	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
14520	<desc>
14521	Medium attachment that is subject to change.
14522	</desc>
14523	</attribute>
14524	</interface>
14525
14526	<interface
14527	name="ICPUChangedEvent" extends="IEvent"
14528	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
14529	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
14530	>
14531	<desc>
14532	Notification when a CPU changes.
14533	</desc>
14534	<attribute name="cpu" type="unsigned long" readonly="yes">
14535	<desc>
14536	The CPU which changed.
14537	</desc>
14538	</attribute>
14539	<attribute name="add" type="boolean" readonly="yes">
14540	<desc>
14541	Flag whether the CPU was added or removed.
14542	</desc>
14543	</attribute>
14544	</interface>
14545
14546	<interface
14547	name="IVRDPServerChangedEvent" extends="IEvent"
14548	uuid="726038B6-6279-4A7A-8037-D041693D1915"
14549	wsmap="managed" autogen="VBoxEvent" id="OnVRDPServerChanged"
14550	>
14551	<desc>
14552	Notification when a property of the
14553	<link to="IMachine::VRDPServer">VRDP server</link> changes.
14554	Interested callees should use IVRDPServer methods and attributes to
14555	find out what has changed.
14556	</desc>
14557	</interface>
14558
14559	<interface
14560	name="IRemoteDisplayInfoChangedEvent" extends="IEvent"
14561	uuid="65B556C5-2A99-47D8-B311-FC177F0914CD"
14562	wsmap="managed" autogen="VBoxEvent" id="OnRemoteDisplayInfoChanged"
14563	>
14564	<desc>
14565	Notification when the status of the VRDP server changes. Interested callees
14566	should use <link to="IConsole::RemoteDisplayInfo">IRemoteDisplayInfo</link>
14567	attributes to find out what is the current status.
14568	</desc>
14569	</interface>
14570
14571	<interface
14572	name="IUSBControllerChangedEvent" extends="IEvent"
14573	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
14574	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
14575	>
14576	<desc>
14577	Notification when a property of the virtual
14578	<link to="IMachine::USBController">USB controller</link> changes.
14579	Interested callees should use IUSBController methods and attributes to
14580	find out what has changed.
14581	</desc>
14582	</interface>
14583
14584	<interface
14585	name="IUSBDeviceStateChangedEvent" extends="IEvent"
14586	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
14587	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
14588	>
14589	<desc>
14590	Notification when a USB device is attached to or detached from
14591	the virtual USB controller.
14592
14593	This notification is sent as a result of the indirect
14594	request to attach the device because it matches one of the
14595	machine USB filters, or as a result of the direct request
14596	issued by <link to="IConsole::attachUSBDevice"/> or
14597	<link to="IConsole::detachUSBDevice"/>.
14598
14599	This notification is sent in case of both a succeeded and a
14600	failed request completion. When the request succeeds, the
14601	@a error parameter is @c null, and the given device has been
14602	already added to (when @a attached is @c true) or removed from
14603	(when @a attached is @c false) the collection represented by
14604	<link to="IConsole::USBDevices"/>. On failure, the collection
14605	doesn't change and the @a error parameter represents the error
14606	message describing the failure.
14607	</desc>
14608	<attribute name="device" type="IUSBDevice" readonly="yes">
14609	<desc>
14610	Device that is subject to state change.
14611	</desc>
14612	</attribute>
14613	<attribute name="attached" type="boolean" readonly="yes">
14614	<desc>
14615	@c true if the device was attached and @c false otherwise.
14616	</desc>
14617	</attribute>
14618	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
14619	<desc>
14620	@c null on success or an error message object on failure.
14621	</desc>
14622	</attribute>
14623	</interface>
14624
14625	<interface
14626	name="ISharedFolderChangedEvent" extends="IEvent"
14627	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
14628	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
14629	>
14630	<desc>
14631	Notification when a shared folder is added or removed.
14632	The @a scope argument defines one of three scopes:
14633	<link to="IVirtualBox::sharedFolders">global shared folders</link>
14634	(<link to="Scope_Global">Global</link>),
14635	<link to="IMachine::sharedFolders">permanent shared folders</link> of
14636	the machine (<link to="Scope_Machine">Machine</link>) or <link
14637	to="IConsole::sharedFolders">transient shared folders</link> of the
14638	machine (<link to="Scope_Session">Session</link>). Interested callees
14639	should use query the corresponding collections to find out what has
14640	changed.
14641	</desc>
14642	<attribute name="scope" type="Scope" readonly="yes">
14643	<desc>
14644	Scope of the notification.
14645	</desc>
14646	</attribute>
14647	</interface>
14648
14649	<interface
14650	name="IRuntimeErrorEvent" extends="IEvent"
14651	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
14652	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
14653	>
14654	<desc>
14655	Notification when an error happens during the virtual
14656	machine execution.
14657
14658	There are three kinds of runtime errors:
14659	<ul>
14660	<li><i>fatal</i></li>
14661	<li><i>non-fatal with retry</i></li>
14662	<li><i>non-fatal warnings</i></li>
14663	</ul>
14664
14665	<b>Fatal</b> errors are indicated by the @a fatal parameter set
14666	to @c true. In case of fatal errors, the virtual machine
14667	execution is always paused before calling this notification, and
14668	the notification handler is supposed either to immediately save
14669	the virtual machine state using <link to="IConsole::saveState"/>
14670	or power it off using <link to="IConsole::powerDown"/>.
14671	Resuming the execution can lead to unpredictable results.
14672
14673	<b>Non-fatal</b> errors and warnings are indicated by the
14674	@a fatal parameter set to @c false. If the virtual machine
14675	is in the Paused state by the time the error notification is
14676	received, it means that the user can <i>try to resume</i> the machine
14677	execution after attempting to solve the problem that caused the
14678	error. In this case, the notification handler is supposed
14679	to show an appropriate message to the user (depending on the
14680	value of the @a id parameter) that offers several actions such
14681	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
14682	wants to retry, the notification handler should continue
14683	the machine execution using the <link to="IConsole::resume"/>
14684	call. If the machine execution is not Paused during this
14685	notification, then it means this notification is a <i>warning</i>
14686	(for example, about a fatal condition that can happen very soon);
14687	no immediate action is required from the user, the machine
14688	continues its normal execution.
14689
14690	Note that in either case the notification handler
14691	<b>must not</b> perform any action directly on a thread
14692	where this notification is called. Everything it is allowed to
14693	do is to post a message to another thread that will then talk
14694	to the user and take the corresponding action.
14695
14696	Currently, the following error identifiers are known:
14697	<ul>
14698	<li><tt>"HostMemoryLow"</tt></li>
14699	<li><tt>"HostAudioNotResponding"</tt></li>
14700	<li><tt>"VDIStorageFull"</tt></li>
14701	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
14702	</ul>
14703	</desc>
14704	<attribute name="fatal" type="boolean" readonly="yes">
14705	<desc>
14706	Whether the error is fatal or not.
14707	</desc>
14708	</attribute>
14709	<attribute name="id" type="wstring" readonly="yes">
14710	<desc>
14711	Error identifier.
14712	</desc>
14713	</attribute>
14714	<attribute name="message" type="wstring" readonly="yes">
14715	<desc>
14716	Optional error message.
14717	</desc>
14718	</attribute>
14719	</interface>
14720
14721
14722	<interface
14723	name="IEventSourceChangedEvent" extends="IEvent"
14724	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
14725	waitable="yes"
14726	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
14727	>
14728	<desc>
14729	Notification when an event source state changes (listener added or removed).
14730	</desc>
14731
14732	<attribute name="listener" type="IEventListener" readonly="yes">
14733	<desc>
14734	Event listener which has changed.
14735	</desc>
14736	</attribute>
14737
14738	<attribute name="add" type="boolean" readonly="yes">
14739	<desc>
14740	Flag whether listener was added or removed.
14741	</desc>
14742	</attribute>
14743	</interface>
14744
14745	<interface
14746	name="IExtraDataChangedEvent" extends="IEvent"
14747	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
14748	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
14749	>
14750	<desc>
14751	Notification when machine specific or global extra data
14752	has changed.
14753	</desc>
14754	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
14755	<desc>
14756	ID of the machine this event relates to.
14757	Null for global extra data changes.
14758	</desc>
14759	</attribute>
14760	<attribute name="key" type="wstring" readonly="yes">
14761	<desc>
14762	Extra data key that has changed.
14763	</desc>
14764	</attribute>
14765	<attribute name="value" type="wstring" readonly="yes">
14766	<desc>
14767	Extra data value for the given key.
14768	</desc>
14769	</attribute>
14770	</interface>
14771
14772	<interface
14773	name="IVetoEvent" extends="IEvent"
14774	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
14775	wsmap="managed"
14776	>
14777	<desc>Base abstract interface for veto events.</desc>
14778
14779	<method name="addVeto">
14780	<desc>
14781	Adds a veto on this event.
14782	</desc>
14783	<param name="reason" type="wstring" dir="in">
14784	<desc>
14785	Reason for veto, could be null or empty string.
14786	</desc>
14787	</param>
14788	</method>
14789
14790	<method name="isVetoed">
14791	<desc>
14792	If this event was vetoed.
14793	</desc>
14794	<param name="result" type="boolean" dir="return">
14795	<desc>
14796	Reason for veto.
14797	</desc>
14798	</param>
14799	</method>
14800
14801	<method name="getVetos">
14802	<desc>
14803	Current veto reason list, if size is 0 - no veto.
14804	</desc>
14805	<param name="result" type="wstring" dir="return" safearray="yes">
14806	<desc>
14807	Array of reasons for veto provided by different event handlers.
14808	</desc>
14809	</param>
14810	</method>
14811
14812	</interface>
14813
14814	<interface
14815	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
14816	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
14817	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
14818	waitable="true"
14819	>
14820	<desc>
14821	Notification when someone tries to change extra data for
14822	either the given machine or (if @c null) global extra data.
14823	This gives the chance to veto against changes.
14824	</desc>
14825	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
14826	<desc>
14827	ID of the machine this event relates to.
14828	Null for global extra data changes.
14829	</desc>
14830	</attribute>
14831	<attribute name="key" type="wstring" readonly="yes">
14832	<desc>
14833	Extra data key that has changed.
14834	</desc>
14835	</attribute>
14836	<attribute name="value" type="wstring" readonly="yes">
14837	<desc>
14838	Extra data value for the given key.
14839	</desc>
14840	</attribute>
14841	</interface>
14842
14843	<interface
14844	name="ICanShowWindowEvent" extends="IVetoEvent"
14845	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
14846	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
14847	waitable="true"
14848	>
14849	<desc>
14850	Notification when a call to
14851	<link to="IMachine::canShowConsoleWindow"/> is made by a
14852	front-end to check if a subsequent call to
14853	<link to="IMachine::showConsoleWindow"/> can succeed.
14854
14855	The callee should give an answer appropriate to the current
14856	machine state using event veto. This answer must
14857	remain valid at least until the next
14858	<link to="IConsole::state">machine state</link> change.
14859	</desc>
14860	</interface>
14861
14862	<interface
14863	name="IShowWindowEvent" extends="IEvent"
14864	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
14865	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
14866	waitable="true"
14867	>
14868	<desc>
14869	Notification when a call to
14870	<link to="IMachine::showConsoleWindow"/>
14871	requests the console window to be activated and brought to
14872	foreground on the desktop of the host PC.
14873
14874	This notification should cause the VM console process to
14875	perform the requested action as described above. If it is
14876	impossible to do it at a time of this notification, this
14877	method should return a failure.
14878
14879	Note that many modern window managers on many platforms
14880	implement some sort of focus stealing prevention logic, so
14881	that it may be impossible to activate a window without the
14882	help of the currently active application (which is supposedly
14883	an initiator of this notification). In this case, this method
14884	must return a non-zero identifier that represents the
14885	top-level window of the VM console process. The caller, if it
14886	represents a currently active process, is responsible to use
14887	this identifier (in a platform-dependent manner) to perform
14888	actual window activation.
14889
14890	This method must set @a winId to zero if it has performed all
14891	actions necessary to complete the request and the console
14892	window is now active and in foreground, to indicate that no
14893	further action is required on the caller's side.
14894	</desc>
14895	<attribute name="winId" type="unsigned long long">
14896	<desc>
14897	Platform-dependent identifier of the top-level VM console
14898	window, or zero if this method has performed all actions
14899	necessary to implement the <i>show window</i> semantics for
14900	the given platform and/or this VirtualBox front-end.
14901	</desc>
14902	</attribute>
14903	</interface>
14904
14905	<module name="VBoxSVC" context="LocalServer">
14906	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
14907	namespace="virtualbox.org">
14908	<interface name="IVirtualBox" default="yes"/>
14909	</class>
14910	</module>
14911
14912	<module name="VBoxC" context="InprocServer" threadingModel="Free">
14913	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
14914	namespace="virtualbox.org">
14915	<interface name="ISession" default="yes"/>
14916	</class>
14917
14918	<class name="Console" uuid="577230FF-164F-4CAC-8548-312D8275A4A7"
14919	namespace="virtualbox.org">
14920	<interface name="IConsole" default="yes"/>
14921	</class>
14922	</module>
14923
14924	</library>
14925
14926	</idl>
14927
14928	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format