VirtualBox.xidl@ 29945

Last change on this file since 29945 was 29927, checked in by vboxsync, 15 years ago
Main: Three state powerOn progress object when teleporting.
Property svn:eol-style set to `native`
File size: 538.4 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
127	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
128	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
129	NS_IMPL_THREADSAFE_ADDREF(_class) \
130	NS_IMPL_THREADSAFE_RELEASE(_class) \
131	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
132	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
133	#endif
134
135	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
136	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
137	NS_IMPL_THREADSAFE_ADDREF(_class) \
138	NS_IMPL_THREADSAFE_RELEASE(_class) \
139	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
140	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
141	#endif
142
143	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
144	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
145	NS_IMPL_THREADSAFE_ADDREF(_class) \
146	NS_IMPL_THREADSAFE_RELEASE(_class) \
147	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
148	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
149	#endif
150
151	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
152	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
153	NS_INTERFACE_MAP_BEGIN(_class) \
154	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
155	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
156	NS_IMPL_QUERY_CLASSINFO(_class) \
157	NS_INTERFACE_MAP_END
158	#endif
159
160	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
161	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
162	_i2, _ic2) \
163	NS_INTERFACE_MAP_BEGIN(_class) \
164	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
165	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
166	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
167	NS_IMPL_QUERY_CLASSINFO(_class) \
168	NS_INTERFACE_MAP_END
169	#endif
170
171	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
172	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
173	_i2, _ic2, _i3, _ic3) \
174	NS_INTERFACE_MAP_BEGIN(_class) \
175	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
176	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
177	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
178	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
179	NS_IMPL_QUERY_CLASSINFO(_class) \
180	NS_INTERFACE_MAP_END
181	#endif
182
183	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
184	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
185	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
186
187	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
188	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
189	NS_IMPL_THREADSAFE_ADDREF(_class) \
190	NS_IMPL_THREADSAFE_RELEASE(_class) \
191	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
192	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
193	#endif
194
195	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
196	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
197	_i2, _ic2) \
198	NS_IMPL_THREADSAFE_ADDREF(_class) \
199	NS_IMPL_THREADSAFE_RELEASE(_class) \
200	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
201	_i2, _ic2) \
202	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
203	#endif
204
205	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
206	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
207	_i2, _ic2, _i3, _ic3) \
208	NS_IMPL_THREADSAFE_ADDREF(_class) \
209	NS_IMPL_THREADSAFE_RELEASE(_class) \
210	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2, _i3, _ic3) \
212	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
213	#endif
214
215	</cpp>
216	</if>
217
218	<library
219	name="VirtualBox"
220	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
221	version="1.3"
222	desc="VirtualBox Type Library"
223	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
224	supportsErrorInfo="yes"
225	>
226
227
228	<!--
229	// COM result codes for VirtualBox
230	/////////////////////////////////////////////////////////////////////////
231	-->
232
233	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
234	<desc>
235	This section describes all VirtualBox-specific COM result codes that may
236	be returned by methods of VirtualBox COM interfaces in addition to
237	standard COM result codes.
238
239	Note that along with the result code, every VirtualBox method returns
240	extended error information through the IVirtualBoxErrorInfo interface on
241	failure. This interface is a preferred way to present the error to the end
242	user because it contains a human readable description of the error. Raw
243	result codes, both standard and described in this section, are intended to
244	be used by programs to analyze the reason of a failure and select an
245	appropriate course of action without involving the end user (for example,
246	retry the operation later or make a different call).
247
248	The standard COM result codes that may originate from our methods include:
249
250	<table>
251	<tr><td>E_INVALIDARG</td>
252	<td>
253	Returned when the value of the method's argument is not within the range
254	of valid values. This should not be confused with situations when the
255	value is within the range but simply doesn't suit the current object
256	state and there is a possibility that it will be accepted later (in such
257	cases VirtualBox-specific codes are returned, for example,
258	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
259	</td>
260	</tr>
261	<tr><td>E_POINTER</td>
262	<td>
263	Returned if a memory pointer for the output argument is invalid (for
264	example, @c null). Note that when pointers representing input
265	arguments (such as strings) are invalid, E_INVALIDARG is returned.
266	</td>
267	</tr>
268	<tr><td>E_ACCESSDENIED</td>
269	<td>
270	Returned when the called object is not ready. Since the lifetime of a
271	public COM object cannot be fully controlled by the implementation,
272	VirtualBox maintains the readiness state for all objects it creates and
273	returns this code in response to any method call on the object that was
274	deactivated by VirtualBox and is not functioning any more.
275	</td>
276	</tr>
277	<tr><td>E_OUTOFMEMORY</td>
278	<td>
279	Returned when a memory allocation operation fails.
280	</td>
281	</tr>
282	</table>
283	</desc>
284	</descGroup>
285
286	<!--
287	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
288	everything in <result>/<desc> after (and including) the first dot, so express
289	the matter of the error code in the first sentence and keep it short.
290	-->
291
292	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
293	<desc>
294	Object corresponding to the supplied arguments does not exist.
295	</desc>
296	</result>
297
298	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
299	<desc>
300	Current virtual machine state prevents the operation.
301	</desc>
302	</result>
303
304	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
305	<desc>
306	Virtual machine error occurred attempting the operation.
307	</desc>
308	</result>
309
310	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
311	<desc>
312	File not accessible or erroneous file contents.
313	</desc>
314	</result>
315
316	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
317	<desc>
318	Runtime subsystem error.
319	</desc>
320	</result>
321
322	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
323	<desc>
324	Pluggable Device Manager error.
325	</desc>
326	</result>
327
328	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
329	<desc>
330	Current object state prohibits operation.
331	</desc>
332	</result>
333
334	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
335	<desc>
336	Host operating system related error.
337	</desc>
338	</result>
339
340	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
341	<desc>
342	Requested operation is not supported.
343	</desc>
344	</result>
345
346	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
347	<desc>
348	Invalid XML found.
349	</desc>
350	</result>
351
352	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
353	<desc>
354	Current session state prohibits operation.
355	</desc>
356	</result>
357
358	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
359	<desc>
360	Object being in use prohibits operation.
361	</desc>
362	</result>
363
364	<result name="VBOX_E_DONT_CALL_AGAIN" value="0x80BB000D">
365	<desc>
366	Returned by callback methods which does not need to be called again
367	because the client does not actually make use of them.
368	</desc>
369	</result>
370
371	<!--
372	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
373	everything in <result>/<desc> after (and including) the first dot, so express
374	the matter of the error code in the first sentence and keep it short.
375	-->
376
377	<descGroup/>
378
379	<!--
380	// all common enums
381	/////////////////////////////////////////////////////////////////////////
382	-->
383
384	<enum name="SettingsVersion"
385	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
386	>
387	<desc>Settings version of VirtualBox settings files. This is written to
388	the "version" attribute of the root "VirtualBox" element in the settings
389	file XML and indicates which VirtualBox version wrote the file.
390	</desc>
391
392	<const name="Null" value="0">
393	<desc>Null value, indicates invalid version.</desc>
394	</const>
395	<const name="v1_0" value="1">
396	<desc>Legacy settings version, not currently supported.</desc>
397	</const>
398	<const name="v1_1" value="2">
399	<desc>Legacy settings version, not currently supported.</desc>
400	</const>
401	<const name="v1_2" value="3">
402	<desc>Legacy settings version, not currently supported.</desc>
403	</const>
404	<const name="v1_3pre" value="4">
405	<desc>Legacy settings version, not currently supported.</desc>
406	</const>
407	<const name="v1_3" value="5">
408	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
409	<!--
410	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
411	-->
412	</const>
413	<const name="v1_4" value="6">
414	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
415	<!--
416	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
417	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
418	-->
419	</const>
420	<const name="v1_5" value="7">
421	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
422	<!-- 2008-09-04: 2.0.0 released
423	2008-11-20: settings version 1.5 introduced
424	2008-12-17: 2.1.0 released
425	Machine changes:
426	guest OS identifiers changed;
427	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
428	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
429	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
430	-->
431	</const>
432	<const name="v1_6" value="8">
433	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
434	<!-- 2008-12-17: 2.1.0 released
435	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
436	2009-04-08: 2.2.0 released
437	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
438	-->
439	</const>
440	<const name="v1_7" value="9">
441	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
442	<!-- 2008-12-17: 2.1.0 released
443	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
444	2009-04-08: 2.2.0 released
445	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
446	Machine changes: HardDiskAttachments is now StorageControllers (done)
447	-->
448	</const>
449	<const name="v1_8" value="10">
450	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
451	<!-- Machine additions: Display/@accelerate2DVideo (done)
452	-->
453	</const>
454	<const name="v1_9" value="11">
455	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
456	<!-- The big storage controller / DVD / Floppy rework (done)
457	-->
458	</const>
459	<const name="v1_10" value="12">
460	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
461	<!-- Machine changes: RTC localOrUTC (done)
462	CPU hot-plug support
463	-->
464	</const>
465	<const name="Future" value="13">
466	<desc>Settings version greater than "1.10", written by a future VirtualBox version.</desc>
467	</const>
468	</enum>
469
470	<enum
471	name="AccessMode"
472	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
473	>
474	<desc>
475	Access mode for opening files.
476	</desc>
477
478	<const name="ReadOnly" value="1"/>
479	<const name="ReadWrite" value="2"/>
480	</enum>
481
482	<enum
483	name="MachineState"
484	uuid="e998d075-543a-41fc-8aa9-5ca3e92393fd"
485	>
486	<desc>
487	Virtual machine execution state.
488
489	This enumeration represents possible values of the <link
490	to="IMachine::state"/> attribute.
491
492	Below is the basic virtual machine state diagram. It shows how the state
493	changes during virtual machine execution. The text in square braces shows
494	a method of the IConsole interface that performs the given state
495	transition.
496
497	<pre>
498	+---------[powerDown()] <- Stuck <--[failure]-+
499	V \|
500	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
501	\| \| \| \| V \|
502	\| Aborted -----+ +--> Running --[pause()]--> Paused
503	\| \| ^ \| ^ \|
504	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
505	\| ^ \| \| \| \|
506	\| \| +-----------------------------------------+-\|-------------------+ +
507	\| \| \| \| \|
508	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
509	\| \| \| \|
510	\| +-------- Saving <--------[saveState()]<----------+---------------------+
511	\| \| \|
512	+-------------- Stopping -------[powerDown()]<----------+---------------------+
513	</pre>
514
515	Note that states to the right from PoweredOff, Aborted and Saved in the
516	above diagram are called <i>online VM states</i>. These states
517	represent the virtual machine which is being executed in a dedicated
518	process (usually with a GUI window attached to it where you can see the
519	activity of the virtual machine and interact with it). There are two
520	special pseudo-states, FirstOnline and LastOnline, that can be used in
521	relational expressions to detect if the given machine state is online or
522	not:
523
524	<pre>
525	if (machine.GetState() >= MachineState_FirstOnline &&
526	machine.GetState() <= MachineState_LastOnline)
527	{
528	...the machine is being executed...
529	}
530	</pre>
531
532	When the virtual machine is in one of the online VM states (that is, being
533	executed), only a few machine settings can be modified. Methods working
534	with such settings contain an explicit note about that. An attempt to
535	change any oter setting or perform a modifying operation during this time
536	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
537
538	All online states except Running, Paused and Stuck are transitional: they
539	represent temporary conditions of the virtual machine that will last as
540	long as the operation that initiated such a condition.
541
542	The Stuck state is a special case. It means that execution of the machine
543	has reached the "Guru Meditation" condition. This condition indicates an
544	internal VMM (virtual machine manager) failure which may happen as a
545	result of either an unhandled low-level virtual hardware exception or one
546	of the recompiler exceptions (such as the <i>too-many-traps</i>
547	condition).
548
549	Note also that any online VM state may transit to the Aborted state. This
550	happens if the process that is executing the virtual machine terminates
551	unexpectedly (for example, crashes). Other than that, the Aborted state is
552	equivalent to PoweredOff.
553
554	There are also a few additional state diagrams that do not deal with
555	virtual machine execution and therefore are shown separately. The states
556	shown on these diagrams are called <i>offline VM states</i> (this includes
557	PoweredOff, Aborted and Saved too).
558
559	The first diagram shows what happens when a lengthy setup operation is
560	being executed (such as <link to="IMachine::attachDevice"/>).
561
562	<pre>
563	+----------------------------------(same state as before the call)------+
564	\| \|
565	+-> PoweredOff --+ \|
566	\| \| \|
567	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
568	\| \|
569	+-> Saved -------+
570	</pre>
571
572	The next two diagrams demonstrate the process of taking a snapshot of a
573	powered off virtual machine, restoring the state to that as of a snapshot
574	or deleting a snapshot, respectively.
575
576	<pre>
577	+----------------------------------(same state as before the call)------+
578	\| \|
579	+-> PoweredOff --+ \|
580	\| +-->[takeSnapshot()] -------------------> Saving ------+
581	+-> Aborted -----+
582
583	+-> PoweredOff --+
584	\| \|
585	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
586	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
587	+-> Saved -------+ \|
588	\| \|
589	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
590	</pre>
591
592	Note that the Saving state is present in both the offline state group and
593	online state group. Currently, the only way to determine what group is
594	assumed in a particular case is to remember the previous machine state: if
595	it was Running or Paused, then Saving is an online state, otherwise it is
596	an offline state. This inconsistency may be removed in one of the future
597	versions of VirtualBox by adding a new state.
598
599	<note internal="yes">
600	For whoever decides to touch this enum: In order to keep the
601	comparisons involving FirstOnline and LastOnline pseudo-states valid,
602	the numeric values of these states must be correspondingly updated if
603	needed: for any online VM state, the condition
604	<tt>FirstOnline <= state <= LastOnline</tt> must be
605	@c true. The same relates to transient states for which
606	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
607	@c true.
608	</note>
609	</desc>
610
611	<const name="Null" value="0">
612	<desc>Null value (never used by the API).</desc>
613	</const>
614	<const name="PoweredOff" value="1">
615	<desc>
616	The machine is not running and has no saved execution state; it has
617	either never been started or been shut down successfully.
618	</desc>
619	</const>
620	<const name="Saved" value="2">
621	<desc>
622	The machine is not currently running, but the execution state of the machine
623	has been saved to an external file when it was running, from where
624	it can be resumed.
625	</desc>
626	</const>
627	<const name="Teleported" value="3">
628	<desc>
629	The machine was teleported to a different host (or process) and then
630	powered off. Take care when powering it on again may corrupt resources
631	it shares with the teleportation target (e.g. disk and network).
632	</desc>
633	</const>
634	<const name="Aborted" value="4">
635	<desc>
636	The process running the machine has terminated abnormally. This may
637	indicate a crash of the VM process in host execution context, or
638	the VM process has been terminated externally.
639	</desc>
640	</const>
641	<const name="Running" value="5">
642	<desc>
643	The machine is currently being executed.
644	<note internal="yes">
645	For whoever decides to touch this enum: In order to keep the
646	comparisons in the old source code valid, this state must immediately
647	precede the Paused state.
648	TODO: Lift this spectacularly wonderful restriction.
649	</note>
650	</desc>
651	</const>
652	<const name="Paused" value="6">
653	<desc>
654	Execution of the machine has been paused.
655	<note internal="yes">
656	For whoever decides to touch this enum: In order to keep the
657	comparisons in the old source code valid, this state must immediately
658	follow the Running state.
659	TODO: Lift this spectacularly wonderful restriction.
660	</note>
661	</desc>
662	</const>
663	<const name="Stuck" value="7">
664	<desc>
665	Execution of the machine has reached the "Guru Meditation"
666	condition. This indicates a severe error in the hypervisor itself.
667	<note internal="yes">
668	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
669	"Guru", perhaps? Or are there some other VMM states that are
670	intended to be lumped in here as well?
671	</note>
672	</desc>
673	</const>
674	<const name="Teleporting" value="8">
675	<desc>
676	The machine is about to be teleported to a different host or process.
677	It is possible to pause a machine in this state, but it will go to the
678	<link to="MachineState::PausedTeleporting"/> state and it will not be
679	possible to resume it again unless the teleportation fails.
680	</desc>
681	</const>
682	<const name="LiveSnapshotting" value="9">
683	<desc>
684	A live snapshot is being taken. The machine is running normally, but
685	some of the runtime configuration options are inaccessible. Also, if
686	paused while in this state it will transition to
687	<link to="MachineState::Saving"/> and it will not be resume the
688	execution until the snapshot operation has completed.
689	</desc>
690	</const>
691	<const name="Starting" value="10">
692	<desc>
693	Machine is being started after powering it on from a
694	zero execution state.
695	</desc>
696	</const>
697	<const name="Stopping" value="11">
698	<desc>
699	Machine is being normally stopped powering it off, or after the guest OS
700	has initiated a shutdown sequence.
701	</desc>
702	</const>
703	<const name="Saving" value="12">
704	<desc>
705	Machine is saving its execution state to a file, or an online
706	snapshot of the machine is being taken.
707	</desc>
708	</const>
709	<const name="Restoring" value="13">
710	<desc>
711	Execution state of the machine is being restored from a file
712	after powering it on from the saved execution state.
713	</desc>
714	</const>
715	<const name="TeleportingPausedVM" value="14">
716	<desc>
717	The machine is being teleported to another host or process, but it is
718	not running. This is the paused variant of the
719	<link to="MachineState::Teleporting"/> state.
720	</desc>
721	</const>
722	<const name="TeleportingIn" value="15">
723	<desc>
724	Teleporting the machine state in from another host or process.
725	</desc>
726	</const>
727	<const name="DeletingSnapshotOnline" value="16">
728	<desc>
729	Teleporting the machine state in from another host or process.
730	</desc>
731	</const>
732	<const name="DeletingSnapshotPaused" value="17">
733	<desc>
734	Teleporting the machine state in from another host or process.
735	</desc>
736	</const>
737	<const name="RestoringSnapshot" value="18">
738	<desc>
739	A machine snapshot is being restored; this typically does not take long.
740	</desc>
741	</const>
742	<const name="DeletingSnapshot" value="19">
743	<desc>
744	A machine snapshot is being deleted; this can take a long time since this
745	may require merging differencing media.
746	</desc>
747	</const>
748	<const name="SettingUp" value="20">
749	<desc>
750	Lengthy setup operation is in progress.
751	</desc>
752	</const>
753
754	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
755	<desc>
756	Pseudo-state: first online state (for use in relational expressions).
757	</desc>
758	</const>
759	<const name="LastOnline" value="17" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
760	<desc>
761	Pseudo-state: last online state (for use in relational expressions).
762	</desc>
763	</const>
764
765	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
766	<desc>
767	Pseudo-state: first transient state (for use in relational expressions).
768	</desc>
769	</const>
770	<const name="LastTransient" value="20" wsmap="suppress"> <!-- SettingUp -->
771	<desc>
772	Pseudo-state: last transient state (for use in relational expressions).
773	</desc>
774	</const>
775
776	</enum>
777
778	<enum
779	name="SessionState"
780	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
781	>
782	<desc>
783	Session state. This enumeration represents possible values of
784	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
785	attributes. See individual enumerator descriptions for the meaning for
786	every value.
787	</desc>
788
789	<const name="Null" value="0">
790	<desc>Null value (never used by the API).</desc>
791	</const>
792	<const name="Closed" value="1">
793	<desc>
794	The machine has no open sessions (<link to="IMachine::sessionState"/>);
795	the session is closed (<link to="ISession::state"/>)
796	</desc>
797	</const>
798	<const name="Open" value="2">
799	<desc>
800	The machine has an open direct session (<link to="IMachine::sessionState"/>);
801	the session is open (<link to="ISession::state"/>)
802	</desc>
803	</const>
804	<const name="Spawning" value="3">
805	<desc>
806	A new (direct) session is being opened for the machine as a result of
807	<link to="IVirtualBox::openRemoteSession"/> call
808	(<link to="IMachine::sessionState"/> or <link to="ISession::state"/>).
809	This state also occurs as a short transient state when a new direct
810	session is opened by calling <link to="IVirtualBox::openSession"/>.
811	</desc>
812	</const>
813	<const name="Closing" value="4">
814	<desc>
815	The direct session is being closed (<link to="IMachine::sessionState"/>);
816	the session is being closed (<link to="ISession::state"/>)
817	</desc>
818	</const>
819	</enum>
820
821	<enum
822	name="CPUPropertyType"
823	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
824	>
825	<desc>
826	Virtual CPU property type. This enumeration represents possible values of the
827	IMachine get- and setCPUProperty methods.
828	</desc>
829	<const name="Null" value="0">
830	<desc>Null value (never used by the API).</desc>
831	</const>
832	<const name="PAE" value="1">
833	<desc>
834	This setting determines whether VirtualBox will expose the Physical Address
835	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
836	is not available, it will not be reported.
837	</desc>
838	</const>
839	<const name="Synthetic" value="2">
840	<desc>
841	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
842	teleporting between host systems that differ significantly.
843	</desc>
844	</const>
845	</enum>
846
847
848	<enum
849	name="HWVirtExPropertyType"
850	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
851	>
852	<desc>
853	Hardware virtualization property type. This enumeration represents possible values
854	for the <link to="IMachine::getHWVirtExProperty"/> and
855	<link to="IMachine::setHWVirtExProperty"/> methods.
856	</desc>
857	<const name="Null" value="0">
858	<desc>Null value (never used by the API).</desc>
859	</const>
860	<const name="Enabled" value="1">
861	<desc>
862	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
863	such extensions are not available, they will not be used.
864	</desc>
865	</const>
866	<const name="Exclusive" value="2">
867	<desc>
868	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
869	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
870	feature of the host. To share these with other hypervisors, you must disable this property.
871	</desc>
872	</const>
873	<const name="VPID" value="3">
874	<desc>
875	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
876	</desc>
877	</const>
878	<const name="NestedPaging" value="4">
879	<desc>
880	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
881	</desc>
882	</const>
883	<const name="LargePages" value="5">
884	<desc>
885	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
886	</desc>
887	</const>
888	</enum>
889
890	<enum
891	name="SessionType"
892	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
893	>
894	<desc>
895	Session type. This enumeration represents possible values of the
896	<link to="ISession::type"/> attribute.
897	</desc>
898
899	<const name="Null" value="0">
900	<desc>Null value (never used by the API).</desc>
901	</const>
902	<const name="Direct" value="1">
903	<desc>
904	Direct session
905	(opened by <link to="IVirtualBox::openSession"/>)
906	</desc>
907	</const>
908	<const name="Remote" value="2">
909	<desc>
910	Remote session
911	(opened by <link to="IVirtualBox::openRemoteSession"/>)
912	</desc>
913	</const>
914	<const name="Existing" value="3">
915	<desc>
916	Existing session
917	(opened by <link to="IVirtualBox::openExistingSession"/>)
918	</desc>
919	</const>
920	</enum>
921
922	<enum
923	name="DeviceType"
924	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
925	>
926	<desc>
927	Device type.
928	</desc>
929	<const name="Null" value="0">
930	<desc>
931	Null value, may also mean "no device" (not allowed for
932	<link to="IConsole::getDeviceActivity"/>).
933	</desc>
934	</const>
935	<const name="Floppy" value="1">
936	<desc>Floppy device.</desc>
937	</const>
938	<const name="DVD" value="2">
939	<desc>CD/DVD-ROM device.</desc>
940	</const>
941	<const name="HardDisk" value="3">
942	<desc>Hard disk device.</desc>
943	</const>
944	<const name="Network" value="4">
945	<desc>Network device.</desc>
946	</const>
947	<const name="USB" value="5">
948	<desc>USB device.</desc>
949	</const>
950	<const name="SharedFolder" value="6">
951	<desc>Shared folder device.</desc>
952	</const>
953	</enum>
954
955	<enum
956	name="DeviceActivity"
957	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
958	>
959	<desc>
960	Device activity for <link to="IConsole::getDeviceActivity"/>.
961	</desc>
962
963	<const name="Null" value="0"/>
964	<const name="Idle" value="1"/>
965	<const name="Reading" value="2"/>
966	<const name="Writing" value="3"/>
967	</enum>
968
969	<enum
970	name="ClipboardMode"
971	uuid="33364716-4008-4701-8f14-be0fa3d62950"
972	>
973	<desc>
974	Host-Guest clipboard interchange mode.
975	</desc>
976
977	<const name="Disabled" value="0"/>
978	<const name="HostToGuest" value="1"/>
979	<const name="GuestToHost" value="2"/>
980	<const name="Bidirectional" value="3"/>
981	</enum>
982
983	<enum
984	name="Scope"
985	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
986	>
987	<desc>
988	Scope of the operation.
989
990	A generic enumeration used in various methods to define the action or
991	argument scope.
992	</desc>
993
994	<const name="Global" value="0"/>
995	<const name="Machine" value="1"/>
996	<const name="Session" value="2"/>
997	</enum>
998
999	<enum
1000	name="BIOSBootMenuMode"
1001	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1002	>
1003	<desc>
1004	BIOS boot menu mode.
1005	</desc>
1006
1007	<const name="Disabled" value="0"/>
1008	<const name="MenuOnly" value="1"/>
1009	<const name="MessageAndMenu" value="2"/>
1010	</enum>
1011
1012	<enum
1013	name="ProcessorFeature"
1014	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1015	>
1016	<desc>
1017	CPU features.
1018	</desc>
1019
1020	<const name="HWVirtEx" value="0"/>
1021	<const name="PAE" value="1"/>
1022	<const name="LongMode" value="2"/>
1023	<const name="NestedPaging" value="3"/>
1024	</enum>
1025
1026	<enum
1027	name="FirmwareType"
1028	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1029	>
1030	<desc>
1031	Firmware type.
1032	</desc>
1033	<const name="BIOS" value="1">
1034	<desc>BIOS Firmware.</desc>
1035	</const>
1036	<const name="EFI" value="2">
1037	<desc>EFI Firmware, bitness detetced basing on OS type.</desc>
1038	</const>
1039	<const name="EFI32" value="3">
1040	<desc>Efi firmware, 32-bit.</desc>
1041	</const>
1042	<const name="EFI64" value="4">
1043	<desc>Efi firmware, 64-bit.</desc>
1044	</const>
1045	<const name="EFIDUAL" value="5">
1046	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1047	</const>
1048	</enum>
1049
1050	<enum
1051	name="PointingHidType"
1052	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1053	>
1054	<desc>
1055	Type of pointing device used in a virtual machine.
1056	</desc>
1057	<const name="None" value="1">
1058	<desc>No mouse.</desc>
1059	</const>
1060	<const name="PS2Mouse" value="2">
1061	<desc>PS/2 auxillary device, a.k.a. mouse.</desc>
1062	</const>
1063	<const name="USBMouse" value="3">
1064	<desc>USB mouse (relative pointer).</desc>
1065	</const>
1066	<const name="USBTablet" value="4">
1067	<desc>USB tablet (absolute pointer).</desc>
1068	</const>
1069	<const name="ComboMouse" value="5">
1070	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1071	Using of such device can have negative performance implications. </desc>
1072	</const>
1073	</enum>
1074
1075	<enum
1076	name="KeyboardHidType"
1077	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1078	>
1079	<desc>
1080	Type of keyboard device used in a virtual machine.
1081	</desc>
1082	<const name="None" value="1">
1083	<desc>No keyboard.</desc>
1084	</const>
1085	<const name="PS2Keyboard" value="2">
1086	<desc>PS/2 keyboard.</desc>
1087	</const>
1088	<const name="USBKeyboard" value="3">
1089	<desc>USB keyboard.</desc>
1090	</const>
1091	<const name="ComboKeyboard" value="4">
1092	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1093	Using of such device can have negative performance implications. </desc>
1094	</const>
1095	</enum>
1096
1097	<!--
1098	// IVirtualBoxErrorInfo
1099	/////////////////////////////////////////////////////////////////////////
1100	-->
1101
1102	<interface
1103	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1104	uuid="4b86d186-407e-4f9e-8be8-e50061be8725"
1105	supportsErrorInfo="no"
1106	wsmap="managed"
1107	>
1108	<desc>
1109	The IVirtualBoxErrorInfo interface represents extended error information.
1110
1111	Extended error information can be set by VirtualBox components after
1112	unsuccessful or partially successful method invocation. This information
1113	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1114	and then shown to the client in addition to the plain 32-bit result code.
1115
1116	In MS COM, this interface extends the IErrorInfo interface,
1117	in XPCOM, it extends the nsIException interface. In both cases,
1118	it provides a set of common attributes to retrieve error
1119	information.
1120
1121	Sometimes invocation of some component's method may involve methods of
1122	other components that may also fail (independently of this method's
1123	failure), or a series of non-fatal errors may precede a fatal error that
1124	causes method failure. In cases like that, it may be desirable to preserve
1125	information about all errors happened during method invocation and deliver
1126	it to the caller. The <link to="#next"/> attribute is intended
1127	specifically for this purpose and allows to represent a chain of errors
1128	through a single IVirtualBoxErrorInfo object set after method invocation.
1129
1130	Note that errors are stored to a chain in the reverse order, i.e. the
1131	initial error object you query right after method invocation is the last
1132	error set by the callee, the object it points to in the @a next attribute
1133	is the previous error and so on, up to the first error (which is the last
1134	in the chain).
1135	</desc>
1136
1137	<attribute name="resultCode" type="long" readonly="yes">
1138	<desc>
1139	Result code of the error.
1140	Usually, it will be the same as the result code returned
1141	by the method that provided this error information, but not
1142	always. For example, on Win32, CoCreateInstance() will most
1143	likely return E_NOINTERFACE upon unsuccessful component
1144	instantiation attempt, but not the value the component factory
1145	returned. Value is typed 'long', not 'result',
1146	to make interface usable from scripting languages.
1147	<note>
1148	In MS COM, there is no equivalent.
1149	In XPCOM, it is the same as nsIException::result.
1150	</note>
1151	</desc>
1152	</attribute>
1153
1154	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1155	<desc>
1156	UUID of the interface that defined the error.
1157	<note>
1158	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1159	data type.
1160	In XPCOM, there is no equivalent.
1161	</note>
1162	</desc>
1163	</attribute>
1164
1165	<attribute name="component" type="wstring" readonly="yes">
1166	<desc>
1167	Name of the component that generated the error.
1168	<note>
1169	In MS COM, it is the same as IErrorInfo::GetSource.
1170	In XPCOM, there is no equivalent.
1171	</note>
1172	</desc>
1173	</attribute>
1174
1175	<attribute name="text" type="wstring" readonly="yes">
1176	<desc>
1177	Text description of the error.
1178	<note>
1179	In MS COM, it is the same as IErrorInfo::GetDescription.
1180	In XPCOM, it is the same as nsIException::message.
1181	</note>
1182	</desc>
1183	</attribute>
1184
1185	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1186	<desc>
1187	Next error object if there is any, or @c null otherwise.
1188	<note>
1189	In MS COM, there is no equivalent.
1190	In XPCOM, it is the same as nsIException::inner.
1191	</note>
1192	</desc>
1193	</attribute>
1194
1195	</interface>
1196
1197	<interface
1198	name="ILocalOwner" extends="$unknown"
1199	uuid="308FF42A-DC45-49D4-A950-B1EEE5E00BB5" wsmap="suppress"
1200	>
1201	<desc>
1202	The ILocalOwner interface allows to register local objects
1203	(created without COM calls, but with new()).
1204	Once registered, calls to methods of such objects can be made
1205	from remote COM processes.
1206	The main usecase is the event callback implementation where
1207	API clients provide callback objects.
1208	</desc>
1209	<method name="setLocalObject">
1210	<desc>
1211	Set local object.
1212	</desc>
1213	<param name="object" type="$unknown" dir="in">
1214	<desc>Local object to forward requests to.
1215	If null, clears currently set local object.</desc>
1216	</param>
1217	</method>
1218	</interface>
1219
1220	<!--
1221	// IVirtualBox
1222	/////////////////////////////////////////////////////////////////////////
1223	-->
1224
1225	<interface
1226	name="IVirtualBoxCallback" extends="$unknown"
1227	uuid="7f6a65b6-ad5d-4a67-8872-0b11cb7ea95c"
1228	wsmap="suppress"
1229	>
1230
1231	<method name="onMachineStateChange">
1232	<desc>
1233	The execution state of the given machine has changed.
1234	<see>IMachine::state</see>
1235	<result name="VBOX_E_DONT_CALL_AGAIN">
1236	Do not call again, this method is a NOP.
1237	</result>
1238	</desc>
1239	<param name="machineId" type="uuid" mod="string" dir="in">
1240	<desc>ID of the machine this event relates to.</desc>
1241	</param>
1242	<param name="state" type="MachineState" dir="in">
1243	<desc>New execution state.</desc>
1244	</param>
1245	</method>
1246
1247	<method name="onMachineDataChange">
1248	<desc>
1249	Any of the settings of the given machine has changed.
1250	<result name="VBOX_E_DONT_CALL_AGAIN">
1251	Do not call again, this method is a NOP.
1252	</result>
1253	</desc>
1254	<param name="machineId" type="uuid" mod="string" dir="in">
1255	<desc>ID of the machine this event relates to.</desc>
1256	</param>
1257	</method>
1258
1259	<method name="onExtraDataCanChange">
1260	<desc>
1261	Notification when someone tries to change extra data for
1262	either the given machine or (if @c null) global extra data.
1263	This gives the chance to veto against changes.
1264	<result name="VBOX_E_DONT_CALL_AGAIN">
1265	Do not call again, this method is a NOP. Change is allowed.
1266	</result>
1267	</desc>
1268	<param name="machineId" type="uuid" mod="string" dir="in">
1269	<desc>
1270	ID of the machine this event relates to
1271	(@c null ID for global extra data change requests).
1272	</desc>
1273	</param>
1274	<param name="key" type="wstring" dir="in">
1275	<desc>
1276	Extra data key for the attempted write.
1277	</desc>
1278	</param>
1279	<param name="value" type="wstring" dir="in">
1280	<desc>
1281	Extra data value for the given key.
1282	</desc>
1283	</param>
1284	<param name="error" type="wstring" dir="out">
1285	<desc>
1286	Optional error message describing the reason of the
1287	veto (ignored if this notification returns @c true).
1288	</desc>
1289	</param>
1290	<param name="allowChange" type="boolean" dir="return">
1291	<desc>
1292	Flag to indicate whether the callee agrees (@c true)
1293	or vetoes against the change (@c false).
1294	</desc>
1295	</param>
1296	</method>
1297
1298	<method name="onExtraDataChange">
1299	<desc>
1300	Notification when machine specific or global extra data
1301	has changed.
1302	<result name="VBOX_E_DONT_CALL_AGAIN">
1303	Do not call again, this method is a NOP.
1304	</result>
1305	</desc>
1306	<param name="machineId" type="uuid" mod="string" dir="in">
1307	<desc>
1308	ID of the machine this event relates to.
1309	Null for global extra data changes.
1310	</desc>
1311	</param>
1312	<param name="key" type="wstring" dir="in">
1313	<desc>
1314	Extra data key that has changed.
1315	</desc>
1316	</param>
1317	<param name="value" type="wstring" dir="in">
1318	<desc>
1319	Extra data value for the given key.
1320	</desc>
1321	</param>
1322	</method>
1323
1324	<method name="onMediumRegistered">
1325	<desc>
1326	The given medium was registered or unregistered
1327	within this VirtualBox installation.
1328
1329	The @a mediumType parameter describes what type of
1330	medium the specified @a mediumId refers to. Possible
1331	values are:
1332
1333	<ul>
1334	<li><link to="DeviceType_HardDisk"/>: the medium is a hard disk
1335	that, if registered, can be obtained using the
1336	<link to="IVirtualBox::getHardDisk"/> call.</li>
1337	<li><link to="DeviceType_DVD"/>: the medium is a CD/DVD image
1338	that, if registered, can be obtained using the
1339	<link to="IVirtualBox::getDVDImage"/> call.</li>
1340	<li><link to="DeviceType_Floppy"/>: the medium is a Floppy image
1341	that, if registered, can be obtained using the
1342	<link to="IVirtualBox::getFloppyImage"/> call.</li>
1343	</ul>
1344
1345	Note that if this is a deregistration notification,
1346	there is no way to access the object representing the
1347	unregistered medium. It is supposed that the
1348	application will do required cleanup based on the
1349	@a mediumId value.
1350
1351	<result name="VBOX_E_DONT_CALL_AGAIN">
1352	Do not call again, this method is a NOP.
1353	</result>
1354	</desc>
1355	<param name="mediumId" type="uuid" mod="string" dir="in">
1356	<desc>ID of the medium this event relates to.</desc>
1357	</param>
1358	<param name="mediumType" type="DeviceType" dir="in">
1359	<desc>Type of the medium this event relates to.</desc>
1360	</param>
1361	<param name="registered" type="boolean" dir="in">
1362	<desc>
1363	If @c true, the medium was registered, otherwise it was
1364	unregistered.
1365	</desc>
1366	</param>
1367	</method>
1368
1369	<method name="onMachineRegistered">
1370	<desc>
1371	The given machine was registered or unregistered
1372	within this VirtualBox installation.
1373	<result name="VBOX_E_DONT_CALL_AGAIN">
1374	Do not call again, this method is a NOP.
1375	</result>
1376	</desc>
1377	<param name="machineId" type="uuid" mod="string" dir="in">
1378	<desc>ID of the machine this event relates to.</desc>
1379	</param>
1380	<param name="registered" type="boolean" dir="in">
1381	<desc>
1382	If @c true, the machine was registered, otherwise it was
1383	unregistered.
1384	</desc>
1385	</param>
1386	</method>
1387
1388	<method name="onSessionStateChange">
1389	<desc>
1390	The state of the session for the given machine was changed.
1391	<see>IMachine::sessionState</see>
1392	<result name="VBOX_E_DONT_CALL_AGAIN">
1393	Do not call again, this method is a NOP.
1394	</result>
1395	</desc>
1396	<param name="machineId" type="uuid" mod="string" dir="in">
1397	<desc>ID of the machine this event relates to.</desc>
1398	</param>
1399	<param name="state" type="SessionState" dir="in">
1400	<desc>New session state.</desc>
1401	</param>
1402	</method>
1403
1404	<method name="onSnapshotTaken">
1405	<desc>
1406	A new snapshot of the machine has been taken.
1407	<see>ISnapshot</see>
1408	<result name="VBOX_E_DONT_CALL_AGAIN">
1409	Do not call again, this method is a NOP.
1410	</result>
1411	</desc>
1412	<param name="machineId" type="uuid" mod="string" dir="in">
1413	<desc>ID of the machine this event relates to.</desc>
1414	</param>
1415	<param name="snapshotId" type="uuid" mod="string" dir="in">
1416	<desc>ID of the new snapshot.</desc>
1417	</param>
1418	</method>
1419
1420	<method name="onSnapshotDeleted">
1421	<desc>
1422	Snapshot of the given machine has been deleted.
1423
1424	<note>
1425	This notification is delivered <b>after</b> the snapshot
1426	object has been uninitialized on the server (so that any
1427	attempt to call its methods will return an error).
1428	</note>
1429
1430	<see>ISnapshot</see>
1431
1432	<result name="VBOX_E_DONT_CALL_AGAIN">
1433	Do not call again, this method is a NOP.
1434	</result>
1435	</desc>
1436	<param name="machineId" type="uuid" mod="string" dir="in">
1437	<desc>ID of the machine this event relates to.</desc>
1438	</param>
1439	<param name="snapshotId" type="uuid" mod="string" dir="in">
1440	<desc>
1441	ID of the deleted snapshot. @c null means the current machine
1442	state has been deleted (restored from the current snapshot).
1443	</desc>
1444	</param>
1445	</method>
1446
1447	<method name="onSnapshotChange">
1448	<desc>
1449	Snapshot properties (name and/or description) have been changed.
1450	<see>ISnapshot</see>
1451	<result name="VBOX_E_DONT_CALL_AGAIN">
1452	Do not call again, this method is a NOP.
1453	</result>
1454	</desc>
1455	<param name="machineId" type="uuid" mod="string" dir="in">
1456	<desc>ID of the machine this event relates to.</desc>
1457	</param>
1458	<param name="snapshotId" type="uuid" mod="string" dir="in">
1459	<desc>ID of the changed snapshot.</desc>
1460	</param>
1461	</method>
1462
1463	<method name="onGuestPropertyChange">
1464	<desc>
1465	Notification when a guest property has changed.
1466	<result name="VBOX_E_DONT_CALL_AGAIN">
1467	Do not call again, this method is a NOP.
1468	</result>
1469	</desc>
1470	<param name="machineId" type="uuid" mod="string" dir="in">
1471	<desc>
1472	ID of the machine this event relates to.
1473	</desc>
1474	</param>
1475	<param name="name" type="wstring" dir="in">
1476	<desc>
1477	The name of the property that has changed.
1478	</desc>
1479	</param>
1480	<param name="value" type="wstring" dir="in">
1481	<desc>
1482	The new property value.
1483	</desc>
1484	</param>
1485	<param name="flags" type="wstring" dir="in">
1486	<desc>
1487	The new property flags.
1488	</desc>
1489	</param>
1490	</method>
1491
1492	</interface>
1493
1494	<interface
1495	name="IDHCPServer" extends="$unknown"
1496	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1497	wsmap="managed"
1498	>
1499	<desc>
1500	The IDHCPServer interface represents the vbox dhcp server configuration.
1501
1502	To enumerate all the dhcp servers on the host, use the
1503	<link to="IVirtualBox::DHCPServers"/> attribute.
1504	</desc>
1505
1506	<attribute name="enabled" type="boolean">
1507	<desc>
1508	specifies if the dhcp server is enabled
1509	</desc>
1510	</attribute>
1511
1512	<attribute name="IPAddress" type="wstring" readonly="yes">
1513	<desc>
1514	specifies server IP
1515	</desc>
1516	</attribute>
1517
1518	<attribute name="networkMask" type="wstring" readonly="yes">
1519	<desc>
1520	specifies server network mask
1521	</desc>
1522	</attribute>
1523
1524	<attribute name="networkName" type="wstring" readonly="yes">
1525	<desc>
1526	specifies internal network name the server is used for
1527	</desc>
1528	</attribute>
1529
1530	<attribute name="lowerIP" type="wstring" readonly="yes">
1531	<desc>
1532	specifies from IP adrres in server address range
1533	</desc>
1534	</attribute>
1535
1536	<attribute name="upperIP" type="wstring" readonly="yes">
1537	<desc>
1538	specifies to IP adrres in server address range
1539	</desc>
1540	</attribute>
1541
1542	<method name="setConfiguration">
1543	<desc>
1544	configures the server
1545	<result name="E_INVALIDARG">
1546	invalid configuration supplied
1547	</result>
1548	</desc>
1549	<param name="IPAddress" type="wstring" dir="in">
1550	<desc>
1551	server IP address
1552	</desc>
1553	</param>
1554	<param name="networkMask" type="wstring" dir="in">
1555	<desc>
1556	server network mask
1557	</desc>
1558	</param>
1559	<param name="FromIPAddress" type="wstring" dir="in">
1560	<desc>
1561	server From IP address for address range
1562	</desc>
1563	</param>
1564	<param name="ToIPAddress" type="wstring" dir="in">
1565	<desc>
1566	server To IP address for address range
1567	</desc>
1568	</param>
1569	</method>
1570
1571	<method name="start">
1572	<desc>
1573	Starts DHCP server process.
1574	<result name="E_FAIL">
1575	Failed to start the process.
1576	</result>
1577	</desc>
1578	<param name="networkName" type="wstring" dir="in">
1579	<desc>
1580	Name of internal network DHCP server should attach to.
1581	</desc>
1582	</param>
1583	<param name="trunkName" type="wstring" dir="in">
1584	<desc>
1585	Name of internal network trunk.
1586	</desc>
1587	</param>
1588	<param name="trunkType" type="wstring" dir="in">
1589	<desc>
1590	Type of internal network trunk.
1591	</desc>
1592	</param>
1593	</method>
1594
1595	<method name="stop">
1596	<desc>
1597	Stops DHCP server process.
1598	<result name="E_FAIL">
1599	Failed to stop the process.
1600	</result>
1601	</desc>
1602	</method>
1603	</interface>
1604
1605	<interface
1606	name="IVirtualBox" extends="$unknown"
1607	uuid="3f36e024-7fed-4f20-a02c-9158a82b44e6"
1608	wsmap="managed"
1609	>
1610	<desc>
1611	The IVirtualBox interface represents the main interface exposed by the
1612	product that provides virtual machine management.
1613
1614	An instance of IVirtualBox is required for the product to do anything
1615	useful. Even though the interface does not expose this, internally,
1616	IVirtualBox is implemented as a singleton and actually lives in the
1617	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1618	IVirtualBox can track the state of all virtual machines on a particular
1619	host, regardless of which frontend started them.
1620
1621	To enumerate all the virtual machines on the host, use the
1622	<link to="IVirtualBox::machines"/> attribute.
1623	</desc>
1624
1625	<attribute name="version" type="wstring" readonly="yes">
1626	<desc>
1627	A string representing the version number of the product. The
1628	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1629	last number represents the build number and will frequently change.
1630	</desc>
1631	</attribute>
1632
1633	<attribute name="revision" type="unsigned long" readonly="yes">
1634	<desc>
1635	The internal build revision number of the product.
1636	</desc>
1637	</attribute>
1638
1639	<attribute name="packageType" type="wstring" readonly="yes">
1640	<desc>
1641	A string representing the package type of this product. The
1642	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1643	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1644	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1645	this.
1646	</desc>
1647	</attribute>
1648
1649	<attribute name="homeFolder" type="wstring" readonly="yes">
1650	<desc>
1651	Full path to the directory where the global settings file,
1652	<tt>VirtualBox.xml</tt>, is stored.
1653
1654	In this version of VirtualBox, the value of this property is
1655	always <tt><user_dir>/.VirtualBox</tt> (where
1656	<tt><user_dir></tt> is the path to the user directory,
1657	as determined by the host OS), and cannot be changed.
1658
1659	This path is also used as the base to resolve relative paths in
1660	places where relative paths are allowed (unless otherwise
1661	expressly indicated).
1662	</desc>
1663	</attribute>
1664
1665	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1666	<desc>
1667	Full name of the global settings file.
1668	The value of this property corresponds to the value of
1669	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1670	</desc>
1671	</attribute>
1672
1673	<attribute name="host" type="IHost" readonly="yes">
1674	<desc>Associated host object.</desc>
1675	</attribute>
1676
1677	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1678	<desc>Associated system information object.</desc>
1679	</attribute>
1680
1681	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1682	<desc>
1683	Array of machine objects registered within this VirtualBox instance.
1684	</desc>
1685	</attribute>
1686
1687	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1688	<desc>
1689	Array of medium objects known to this VirtualBox installation.
1690
1691	This array contains only base media. All differencing
1692	media of the given base medium can be enumerated using
1693	<link to="IMedium::children"/>.
1694	</desc>
1695	</attribute>
1696
1697	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1698	<desc>
1699	Array of CD/DVD image objects registered with this VirtualBox instance.
1700	</desc>
1701	</attribute>
1702
1703	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1704	<desc>
1705	Array of floppy image objects registered with this VirtualBox instance.
1706	</desc>
1707	</attribute>
1708
1709	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1710
1711	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1712
1713	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1714	<desc>
1715	Collection of global shared folders. Global shared folders are
1716	available to all virtual machines.
1717
1718	New shared folders are added to the collection using
1719	<link to="#createSharedFolder"/>. Existing shared folders can be
1720	removed using <link to="#removeSharedFolder"/>.
1721
1722	<note>
1723	In the current version of the product, global shared folders are not
1724	implemented and therefore this collection is always empty.
1725	</note>
1726	</desc>
1727	</attribute>
1728
1729	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1730	<desc>
1731	Associated performance collector object.
1732	</desc>
1733	</attribute>
1734
1735	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1736	<desc>
1737	dhcp server settings.
1738	</desc>
1739	</attribute>
1740
1741	<method name="createMachine">
1742	<desc>
1743	Creates a new virtual machine.
1744
1745	The new machine is created unregistered, with the initial configuration
1746	set according to the specified guest OS type. A typical sequence of
1747	actions to create a new virtual machine is as follows:
1748
1749	<ol>
1750	<li>
1751	Call this method to have a new machine created. The returned machine
1752	object will be "mutable" allowing to change any machine property.
1753	</li>
1754
1755	<li>
1756	Configure the machine using the appropriate attributes and methods.
1757	</li>
1758
1759	<li>
1760	Call <link to="IMachine::saveSettings" /> to write the settings
1761	to the machine's XML settings file. The configuration of the newly
1762	created machine will not be saved to disk until this method is
1763	called.
1764	</li>
1765
1766	<li>
1767	Call <link to="#registerMachine" /> to add the machine to the list
1768	of machines known to VirtualBox.
1769	</li>
1770	</ol>
1771
1772	You should specify valid name for the newly created machine when calling
1773	this method. See the <link to="IMachine::name"/> attribute description
1774	for more details about the machine name.
1775
1776	The specified guest OS type identifier must match an ID of one of known
1777	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1778	array.
1779
1780	Every machine has a <i>settings file</i> that is used to store
1781	the machine configuration. This file is stored in a directory called the
1782	<i>machine settings subfolder</i>. Both the settings subfolder and file
1783	will have a name that corresponds to the name of the virtual machine.
1784	You can specify where to create the machine setting subfolder using the
1785	@a baseFolder argument. The base folder can be absolute (full path) or
1786	relative to the <link to="IVirtualBox::homeFolder">VirtualBox home
1787	directory</link>.
1788
1789	If @a baseFolder is a @c null or empty string (which is recommended), the
1790	<link to="ISystemProperties::defaultMachineFolder">default machine
1791	settings folder</link> will be used as a base folder for the created
1792	machine. Otherwise the given base folder will be used. In either case,
1793	the full path to the resulting settings file has the following
1794	structure:
1795	<pre>
1796	<base_folder>/<machine_name>/<machine_name>.xml
1797	</pre>
1798
1799	Note that if the resulting settings file already exists, this method
1800	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1801
1802	Optionally, you may specify an UUID of to assign to the created machine.
1803	However, this is not recommended and you should normally pass an empty
1804	(@c null) UUID to this method so that a new UUID will be automatically
1805	generated for every created machine. You can use UUID
1806	00000000-0000-0000-0000-000000000000 as @c null value.
1807
1808	<note>
1809	There is no way to change the name of the settings file or
1810	subfolder of the created machine directly.
1811	</note>
1812
1813	<result name="VBOX_E_OBJECT_NOT_FOUND">
1814	@a osTypeId is invalid.
1815	</result>
1816	<result name="VBOX_E_FILE_ERROR">
1817	Resulting settings file name is invalid or the settings file already
1818	exists or could not be created due to an I/O error.
1819	</result>
1820	<result name="E_INVALIDARG">
1821	@a name is empty or @c null.
1822	</result>
1823	</desc>
1824
1825	<param name="name" type="wstring" dir="in">
1826	<desc>Machine name.</desc>
1827	</param>
1828	<param name="osTypeId" type="wstring" dir="in">
1829	<desc>Guest OS Type ID.</desc>
1830	</param>
1831	<param name="baseFolder" type="wstring" dir="in">
1832	<desc>Base machine folder (optional).</desc>
1833	</param>
1834	<param name="id" type="uuid" mod="string" dir="in">
1835	<desc>Machine UUID (optional).</desc>
1836	</param>
1837	<param name="override" type="boolean" dir="in">
1838	<desc>Create the VM even if there are conflicting files.</desc>
1839	</param>
1840	<param name="machine" type="IMachine" dir="return">
1841	<desc>Created machine object.</desc>
1842	</param>
1843	</method>
1844
1845	<method name="createLegacyMachine">
1846	<desc>
1847	Creates a new virtual machine in "legacy" mode, using the specified
1848	settings file to store machine settings.
1849
1850	As opposed to machines created by <link to="#createMachine"/>,
1851	the settings file of the machine created in "legacy" mode is not
1852	automatically renamed when the machine name is changed -- it will always
1853	remain the same as specified in this method call.
1854
1855	The specified settings file name can be absolute (full path) or relative
1856	to the <link to="IVirtualBox::homeFolder">VirtualBox home
1857	directory</link>. If the file name doesn't contain an extension, the
1858	default extension (.xml) will be appended.
1859
1860	Note that the configuration of the newly created machine is not
1861	saved to disk (and therefore no settings file is created)
1862	until <link to="IMachine::saveSettings"/> is called. If the
1863	specified settings file already exists, this method
1864	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1865
1866	See <link to="#createMachine"/> for more information.
1867
1868	@deprecated This method may be removed later. Use <link
1869	to="IVirtualBox::createMachine"/> instead.
1870
1871	<note>
1872	There is no way to change the name of the settings file
1873	of the machine created in "legacy" mode.
1874	</note>
1875
1876	<result name="VBOX_E_OBJECT_NOT_FOUND">
1877	@a osTypeId is invalid.
1878	</result>
1879	<result name="VBOX_E_FILE_ERROR">
1880	@a settingsFile is invalid or the settings file already exists or
1881	could not be created due to an I/O error.
1882	</result>
1883	<result name="E_INVALIDARG">
1884	@a name or @a settingsFile is empty or @c null.
1885	</result>
1886	</desc>
1887
1888	<param name="name" type="wstring" dir="in">
1889	<desc>Machine name.</desc>
1890	</param>
1891	<param name="osTypeId" type="wstring" dir="in">
1892	<desc>Machine OS Type ID.</desc>
1893	</param>
1894	<param name="settingsFile" type="wstring" dir="in">
1895	<desc>Name of the machine settings file.</desc>
1896	</param>
1897	<param name="id" type="uuid" mod="string" dir="in">
1898	<desc>Machine UUID (optional).</desc>
1899	</param>
1900	<param name="machine" type="IMachine" dir="return">
1901	<desc>Created machine object.</desc>
1902	</param>
1903	</method>
1904
1905	<method name="openMachine">
1906	<desc>
1907	Opens a virtual machine from the existing settings file.
1908	The opened machine remains unregistered until you call
1909	<link to="#registerMachine"/>.
1910
1911	The specified settings file name can be absolute
1912	(full path) or relative to the <link to="IVirtualBox::homeFolder">
1913	VirtualBox home directory</link>. This file must exist
1914	and must be a valid machine settings file whose contents
1915	will be used to construct the machine object.
1916
1917	@deprecated Will be removed soon.
1918	<result name="VBOX_E_FILE_ERROR">
1919	Settings file name invalid, not found or sharing violation.
1920	</result>
1921	</desc>
1922	<param name="settingsFile" type="wstring" dir="in">
1923	<desc>
1924	Name of the machine settings file.
1925	</desc>
1926	</param>
1927	<param name="machine" type="IMachine" dir="return">
1928	<desc>Opened machine object.</desc>
1929	</param>
1930	<note>
1931	<link to="IMachine::settingsModified"/> will return
1932	@c false for the created machine, until any of machine settings
1933	are changed.
1934	</note>
1935	</method>
1936
1937	<method name="registerMachine">
1938	<desc>
1939
1940	Registers the machine previously created using
1941	<link to="#createMachine"/> or opened using
1942	<link to="#openMachine"/> within this VirtualBox installation. After
1943	successful method invocation, the
1944	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1945	to all registered callbacks.
1946
1947	<note>
1948	This method implicitly calls <link to="IMachine::saveSettings"/>
1949	to save all current machine settings before registering it.
1950	</note>
1951
1952	<result name="VBOX_E_OBJECT_NOT_FOUND">
1953	No matching virtual machine found.
1954	</result>
1955	<result name="VBOX_E_INVALID_OBJECT_STATE">
1956	Virtual machine was not created within this VirtualBox instance.
1957	</result>
1958
1959	</desc>
1960	<param name="machine" type="IMachine" dir="in"/>
1961	</method>
1962
1963	<method name="getMachine">
1964	<desc>
1965	Attempts to find a virtual machine given its UUID.
1966	To look up a machine by name, use <link to="IVirtualBox::findMachine" />
1967	instead.
1968
1969	<result name="VBOX_E_OBJECT_NOT_FOUND">
1970	Could not find registered machine matching @a id.
1971	</result>
1972
1973	</desc>
1974	<param name="id" type="uuid" mod="string" dir="in"/>
1975	<param name="machine" type="IMachine" dir="return"/>
1976	</method>
1977
1978	<method name="findMachine">
1979	<desc>
1980	Attempts to find a virtual machine given its name.
1981	To look up a machine by UUID, use <link to="IVirtualBox::getMachine" />
1982	instead.
1983
1984	<result name="VBOX_E_OBJECT_NOT_FOUND">
1985	Could not find registered machine matching @a name.
1986	</result>
1987
1988	</desc>
1989	<param name="name" type="wstring" dir="in"/>
1990	<param name="machine" type="IMachine" dir="return"/>
1991	</method>
1992
1993	<method name="unregisterMachine">
1994	<desc>
1995
1996	Unregisters the machine previously registered using
1997	<link to="#registerMachine"/>. After successful method invocation, the
1998	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1999	to all registered callbacks.
2000
2001	<note>
2002	The specified machine must not be in the Saved state, have an open
2003	(or a spawning) direct session associated with it, have snapshots or
2004	have any medium attached.
2005	</note>
2006
2007	<note>
2008	This method implicitly calls <link to="IMachine::saveSettings"/> to
2009	save all current machine settings before unregistering it.
2010	</note>
2011
2012	<note>
2013	If the given machine is inaccessible (see
2014	<link to="IMachine::accessible"/>), it will be unregistered and
2015	fully uninitialized right afterwards. As a result, the returned
2016	machine object will be unusable and an attempt to call
2017	<b>any</b> method will return the "Object not ready" error.
2018	</note>
2019
2020	<result name="VBOX_E_OBJECT_NOT_FOUND">
2021	Could not find registered machine matching @a id.
2022	</result>
2023	<result name="VBOX_E_INVALID_VM_STATE">
2024	Machine is in Saved state.
2025	</result>
2026	<result name="VBOX_E_INVALID_OBJECT_STATE">
2027	Machine has snapshot or open session or medium attached.
2028	</result>
2029
2030	</desc>
2031	<param name="id" type="uuid" mod="string" dir="in">
2032	<desc>UUID of the machine to unregister.</desc>
2033	</param>
2034	<param name="machine" type="IMachine" dir="return">
2035	<desc>Unregistered machine object.</desc>
2036	</param>
2037	</method>
2038
2039	<method name="createAppliance">
2040	<desc>
2041	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
2042	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
2043	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
2044	</desc>
2045	<param name="appliance" type="IAppliance" dir="return">
2046	<desc>New appliance.</desc>
2047	</param>
2048	</method>
2049
2050	<method name="createHardDisk">
2051	<desc>
2052	Creates a new base medium object that will use the given storage
2053	format and location for medium data.
2054
2055	Note that the actual storage unit is not created by this method. In
2056	order to do it, and before you are able to attach the created medium
2057	to virtual machines, you must call one of the following methods to
2058	allocate a format-specific storage unit at the specified location:
2059	<ul>
2060	<li><link to="IMedium::createBaseStorage"/></li>
2061	<li><link to="IMedium::createDiffStorage"/></li>
2062	</ul>
2063
2064	Some medium attributes, such as <link to="IMedium::id"/>, may
2065	remain uninitialized until the medium storage unit is successfully
2066	created by one of the above methods.
2067
2068	After the storage unit is successfully created, the medium gets
2069	remembered by this VirtualBox installation and will be accessible
2070	through <link to="#getHardDisk"/> and <link to="#findHardDisk"/>
2071	methods. Remembered base medium are also returned as part of
2072	the <link to="#hardDisks"/> array. See IMedium for more details.
2073
2074	The list of all storage formats supported by this VirtualBox
2075	installation can be obtained using
2076	<link to="ISystemProperties::mediumFormats"/>. If the @a format
2077	attribute is empty or @c null then the default storage format
2078	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
2079	be used for creating a storage unit of the medium.
2080
2081	Note that the format of the location string is storage format specific.
2082	See <link to="IMedium::location"/>, IMedium and
2083	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
2084
2085	<result name="VBOX_E_OBJECT_NOT_FOUND">
2086	@a format identifier is invalid. See
2087	<link to="ISystemProperties::mediumFormats"/>.
2088	</result>
2089	<result name="VBOX_E_FILE_ERROR">
2090	@a location is a not valid file name (for file-based formats only).
2091	</result>
2092	</desc>
2093	<param name="format" type="wstring" dir="in">
2094	<desc>
2095	Identifier of the storage format to use for the new medium.
2096	</desc>
2097	</param>
2098	<param name="location" type="wstring" dir="in">
2099	<desc>
2100	Location of the storage unit for the new medium.
2101	</desc>
2102	</param>
2103	<param name="medium" type="IMedium" dir="return">
2104	<desc>Created medium object.</desc>
2105	</param>
2106	</method>
2107
2108	<method name="openHardDisk">
2109	<desc>
2110	Opens a medium from an existing location, optionally replacing
2111	the image UUID and/or parent UUID.
2112
2113	After the medium is successfully opened by this method, it gets
2114	remembered by (known to) this VirtualBox installation and will be
2115	accessible through <link to="#getHardDisk"/> and
2116	<link to="#findHardDisk"/> methods. Remembered base media
2117	are also returned as part of the <link to="#hardDisks"/> array and can
2118	be attached to virtual machines. See IMedium for more details.
2119
2120	If a differencing medium is to be opened by this method, the
2121	operation will succeed only if its parent medium and all ancestors,
2122	if any, are already known to this VirtualBox installation (for example,
2123	were opened by this method before).
2124
2125	This method tries to guess the storage format of the specified medium
2126	by reading medium data at the specified location.
2127
2128	If @a accessMode is ReadWrite (which it should be), the image is opened
2129	for read/write access and must have according permissions, as VirtualBox
2130	may actually write status information into the disk's metadata sections.
2131
2132	Note that write access is required for all typical image usage in VirtualBox,
2133	since VirtualBox may need to write metadata such as a UUID into the image.
2134	The only exception is opening a source image temporarily for copying and
2135	cloning when the image will quickly be closed again.
2136
2137	Note that the format of the location string is storage format specific.
2138	See <link to="IMedium::location"/>, IMedium and
2139	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
2140
2141	<result name="VBOX_E_FILE_ERROR">
2142	Invalid medium storage file location or could not find the medium
2143	at the specified location.
2144	</result>
2145	<result name="VBOX_E_IPRT_ERROR">
2146	Could not get medium storage format.
2147	</result>
2148	<result name="E_INVALIDARG">
2149	Invalid medium storage format.
2150	</result>
2151
2152	</desc>
2153	<param name="location" type="wstring" dir="in">
2154	<desc>
2155	Location of the storage unit that contains medium data in one of
2156	the supported storage formats.
2157	</desc>
2158	</param>
2159	<param name="accessMode" type="AccessMode" dir="in">
2160	<desc>
2161	Determines whether to open the image in read/write or read-only mode.
2162	</desc>
2163	</param>
2164	<param name="setImageId" type="boolean" dir="in">
2165	<desc>
2166	Select whether a new image UUID is set or not.
2167	</desc>
2168	</param>
2169	<param name="imageId" type="uuid" mod="string" dir="in">
2170	<desc>
2171	New UUID for the image. If an empty string is passed, then a new
2172	UUID is automatically created. Specifying a zero UUIDs is not valid.
2173	</desc>
2174	</param>
2175	<param name="setParentId" type="boolean" dir="in">
2176	<desc>
2177	Select whether a new parent UUID is set or not.
2178	</desc>
2179	</param>
2180	<param name="parentId" type="uuid" mod="string" dir="in">
2181	<desc>
2182	New parent UUID for the image. If an empty string is passed, then a
2183	new UUID is automatically created, provided @a setParentId is
2184	@c true. A zero UUID is valid.
2185	</desc>
2186	</param>
2187	<param name="medium" type="IMedium" dir="return">
2188	<desc>Opened medium object.</desc>
2189	</param>
2190	</method>
2191
2192	<method name="getHardDisk" const="yes">
2193	<desc>
2194	Returns a medium with the given UUID.
2195
2196	The medium with the given UUID must be known to this VirtualBox
2197	installation, i.e. it must be previously created by
2198	<link to="#createHardDisk"/> or opened by <link
2199	to="#openHardDisk"/>, or attached to some known virtual machine.
2200
2201	<result name="VBOX_E_OBJECT_NOT_FOUND">
2202	No medium object matching @a id found.
2203	</result>
2204
2205	</desc>
2206	<param name="id" type="uuid" mod="string" dir="in">
2207	<desc>UUID of the medium to look for.</desc>
2208	</param>
2209	<param name="medium" type="IMedium" dir="return">
2210	<desc>Found medium object.</desc>
2211	</param>
2212	</method>
2213
2214	<method name="findHardDisk">
2215	<desc>
2216	Returns a medium that uses the given location to store medium data.
2217
2218	The given medium must be known to this VirtualBox installation, i.e.
2219	it must be previously created by
2220	<link to="#createHardDisk"/> or opened by <link
2221	to="#openHardDisk"/>, or attached to some known virtual machine.
2222
2223	The search is done by comparing the value of the @a location argument to
2224	the <link to="IMedium::location"/> attribute of each known medium.
2225
2226	For locations represented by file names in the host's file system, the
2227	requested location can be a path relative to the
2228	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2229	only a file name without any path is given, the
2230	<link to="ISystemProperties::defaultHardDiskFolder"> default medium
2231	folder</link> will be prepended to the file name before searching. Note
2232	that on case sensitive file systems, a case sensitive comparison is
2233	performed, otherwise the case of symbols in the file path is ignored.
2234
2235	<result name="VBOX_E_OBJECT_NOT_FOUND">
2236	No medium object matching @a location found.
2237	</result>
2238
2239	</desc>
2240	<param name="location" type="wstring" dir="in">
2241	<desc>Location string to search for.</desc>
2242	</param>
2243	<param name="medium" type="IMedium" dir="return">
2244	<desc>Found medium object.</desc>
2245	</param>
2246	</method>
2247
2248	<method name="openDVDImage">
2249	<desc>
2250	Opens a CD/DVD image contained in the specified file of the supported
2251	format and assigns it the given UUID.
2252
2253	After the image is successfully opened by this method, it gets
2254	remembered by (known to) this VirtualBox installation and will be
2255	accessible through <link to="#getDVDImage"/> and
2256	<link to="#findDVDImage"/> methods. Remembered images are also
2257	returned as part of the <link to="#DVDImages"/> array and can be mounted
2258	to virtual machines. See IMedium for more details.
2259
2260	See <link to="IMedium::location"/> to get more details about the format
2261	of the location string.
2262
2263	<note>
2264	Currently only ISO 9960 CD/DVD images are supported by VirtualBox.
2265	</note>
2266
2267	<result name="VBOX_E_FILE_ERROR">
2268	Invalid CD/DVD image file location or could not find the CD/DVD
2269	image at the specified location.
2270	</result>
2271	<result name="VBOX_E_INVALID_OBJECT_STATE">
2272	CD/DVD image already exists in the media registry.
2273	</result>
2274
2275	</desc>
2276	<param name="location" type="wstring" dir="in">
2277	<desc>
2278	Full path to the file that contains a valid CD/DVD image.
2279	</desc>
2280	</param>
2281	<param name="id" type="uuid" mod="string" dir="in">
2282	<desc>
2283	UUID to assign to the given image within this VirtualBox installation.
2284	If an empty (@c null) UUID is specified, the system will randomly
2285	generate a new UUID.
2286	</desc>
2287	</param>
2288	<param name="image" type="IMedium" dir="return">
2289	<desc>Opened CD/DVD image object.</desc>
2290	</param>
2291	</method>
2292
2293	<method name="getDVDImage">
2294	<desc>
2295	Returns a CD/DVD image with the given UUID.
2296
2297	The image with the given UUID must be known to this VirtualBox
2298	installation, i.e. it must be previously opened by <link
2299	to="#openDVDImage"/>, or mounted to some known virtual machine.
2300
2301	<result name="VBOX_E_OBJECT_NOT_FOUND">
2302	No matching DVD image found in the media registry.
2303	</result>
2304
2305	</desc>
2306	<param name="id" type="uuid" mod="string" dir="in">
2307	<desc>UUID of the image to look for.</desc>
2308	</param>
2309	<param name="image" type="IMedium" dir="return">
2310	<desc>Found CD/DVD image object.</desc>
2311	</param>
2312	</method>
2313
2314	<method name="findDVDImage">
2315	<desc>
2316	Returns a CD/DVD image with the given image location.
2317
2318	The image with the given UUID must be known to this VirtualBox
2319	installation, i.e. it must be previously opened by <link
2320	to="#openDVDImage"/>, or mounted to some known virtual machine.
2321
2322	The search is done by comparing the value of the @a location argument to
2323	the <link to="IMedium::location"/> attribute of each known CD/DVD image.
2324
2325	The requested location can be a path relative to the
2326	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2327	only a file name without any path is given, the
2328	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2329	folder</link> will be prepended to the file name before searching. Note
2330	that on case sensitive file systems, a case sensitive comparison is
2331	performed, otherwise the case in the file path is ignored.
2332
2333	<result name="VBOX_E_FILE_ERROR">
2334	Invalid image file location.
2335	</result>
2336	<result name="VBOX_E_OBJECT_NOT_FOUND">
2337	No matching DVD image found in the media registry.
2338	</result>
2339
2340	</desc>
2341	<param name="location" type="wstring" dir="in">
2342	<desc>CD/DVD image file path to look for.</desc>
2343	</param>
2344	<param name="image" type="IMedium" dir="return">
2345	<desc>Found CD/DVD image object.</desc>
2346	</param>
2347	</method>
2348
2349	<method name="openFloppyImage">
2350	<desc>
2351	Opens a floppy image contained in the specified file of the supported
2352	format and assigns it the given UUID.
2353
2354	After the image is successfully opened by this method, it gets
2355	remembered by (known to) this VirtualBox installation and will be
2356	accessible through <link to="#getFloppyImage"/> and
2357	<link to="#findFloppyImage"/> methods. Remembered images are also
2358	returned as part of the <link to="#floppyImages"/> array and can be
2359	mounted to virtual machines. See IMedium for more details.
2360
2361	See <link to="IMedium::location"/> to get more details about the format
2362	of the location string.
2363
2364	<result name="VBOX_E_FILE_ERROR">
2365	Invalid floppy image file location or could not find the floppy
2366	image at the specified location.
2367	</result>
2368	<result name="VBOX_E_INVALID_OBJECT_STATE">
2369	Floppy image already exists in the media registry.
2370	</result>
2371
2372	<note>
2373	Currently, only raw floppy images are supported by VirtualBox.
2374	</note>
2375	</desc>
2376	<param name="location" type="wstring" dir="in">
2377	<desc>
2378	Full path to the file that contains a valid floppy image.
2379	</desc>
2380	</param>
2381	<param name="id" type="uuid" mod="string" dir="in">
2382	<desc>
2383	UUID to assign to the given image file within this VirtualBox
2384	installation. If an empty (@c null) UUID is specified, the system will
2385	randomly generate a new UUID.
2386	</desc>
2387	</param>
2388	<param name="image" type="IMedium" dir="return">
2389	<desc>Opened floppy image object.</desc>
2390	</param>
2391	</method>
2392
2393	<method name="getFloppyImage">
2394	<desc>
2395	Returns a floppy image with the given UUID.
2396
2397	The image with the given UUID must be known to this VirtualBox
2398	installation, i.e. it must be previously opened by <link
2399	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2400
2401	<result name="VBOX_E_OBJECT_NOT_FOUND">
2402	No matching floppy image found in the media registry.
2403	</result>
2404
2405	</desc>
2406	<param name="id" type="uuid" mod="string" dir="in">
2407	<desc>UUID of the image to look for.</desc>
2408	</param>
2409	<param name="image" type="IMedium" dir="return">
2410	<desc>Found floppy image object.</desc>
2411	</param>
2412	</method>
2413
2414	<method name="findFloppyImage">
2415	<desc>
2416	Returns a floppy image with the given image location.
2417
2418	The image with the given UUID must be known to this VirtualBox
2419	installation, i.e. it must be previously opened by <link
2420	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2421
2422	The search is done by comparing the value of the @a location argument to
2423	the <link to="IMedium::location"/> attribute of each known floppy image.
2424
2425	The requested location can be a path relative to the
2426	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2427	only a file name without any path is given, the
2428	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2429	folder</link> will be prepended to the file name before searching. Note
2430	that on case sensitive file systems, a case sensitive comparison is
2431	performed, otherwise the case of symbols in the file path is ignored.
2432
2433	<result name="VBOX_E_FILE_ERROR">
2434	Invalid image file location.
2435	</result>
2436	<result name="VBOX_E_OBJECT_NOT_FOUND">
2437	No matching floppy image found in the media registry.
2438	</result>
2439
2440	</desc>
2441	<param name="location" type="wstring" dir="in">
2442	<desc>Floppy image file path to look for.</desc>
2443	</param>
2444	<param name="image" type="IMedium" dir="return">
2445	<desc>Found floppy image object.</desc>
2446	</param>
2447	</method>
2448
2449	<method name="getGuestOSType">
2450	<desc>
2451	Returns an object describing the specified guest OS type.
2452
2453	The requested guest OS type is specified using a string which is a
2454	mnemonic identifier of the guest operating system, such as
2455	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2456	particular virtual machine can be read or set using the
2457	<link to="IMachine::OSTypeId"/> attribute.
2458
2459	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2460	available guest OS type objects. Each object has an
2461	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2462	the guest OS this object describes.
2463
2464	<result name="E_INVALIDARG">
2465	@a id is not a valid Guest OS type.
2466	</result>
2467
2468	</desc>
2469	<param name="id" type="uuid" mod="string" dir="in">
2470	<desc>Guest OS type ID string.</desc>
2471	</param>
2472	<param name="type" type="IGuestOSType" dir="return">
2473	<desc>Guest OS type object.</desc>
2474	</param>
2475	</method>
2476
2477	<method name="createSharedFolder">
2478	<desc>
2479	Creates a new global shared folder by associating the given logical
2480	name with the given host path, adds it to the collection of shared
2481	folders and starts sharing it. Refer to the description of
2482	<link to="ISharedFolder"/> to read more about logical names.
2483	<note>
2484	In the current implementation, this operation is not
2485	implemented.
2486	</note>
2487	</desc>
2488	<param name="name" type="wstring" dir="in">
2489	<desc>Unique logical name of the shared folder.</desc>
2490	</param>
2491	<param name="hostPath" type="wstring" dir="in">
2492	<desc>Full path to the shared folder in the host file system.</desc>
2493	</param>
2494	<param name="writable" type="boolean" dir="in">
2495	<desc>Whether the share is writable or readonly</desc>
2496	</param>
2497	</method>
2498
2499	<method name="removeSharedFolder">
2500	<desc>
2501	Removes the global shared folder with the given name previously
2502	created by <link to="#createSharedFolder"/> from the collection of
2503	shared folders and stops sharing it.
2504	<note>
2505	In the current implementation, this operation is not
2506	implemented.
2507	</note>
2508	</desc>
2509	<param name="name" type="wstring" dir="in">
2510	<desc>Logical name of the shared folder to remove.</desc>
2511	</param>
2512	</method>
2513
2514	<method name="getExtraDataKeys">
2515	<desc>
2516	Returns an array representing the global extra data keys which currently
2517	have values defined.
2518	</desc>
2519	<param name="value" type="wstring" dir="return" safearray="yes">
2520	<desc>Array of extra data keys.</desc>
2521	</param>
2522	</method>
2523
2524	<method name="getExtraData">
2525	<desc>
2526	Returns associated global extra data.
2527
2528	If the requested data @a key does not exist, this function will
2529	succeed and return an empty string in the @a value argument.
2530
2531	<result name="VBOX_E_FILE_ERROR">
2532	Settings file not accessible.
2533	</result>
2534	<result name="VBOX_E_XML_ERROR">
2535	Could not parse the settings file.
2536	</result>
2537
2538	</desc>
2539	<param name="key" type="wstring" dir="in">
2540	<desc>Name of the data key to get.</desc>
2541	</param>
2542	<param name="value" type="wstring" dir="return">
2543	<desc>Value of the requested data key.</desc>
2544	</param>
2545	</method>
2546
2547	<method name="setExtraData">
2548	<desc>
2549	Sets associated global extra data.
2550
2551	If you pass @c null or empty string as a key @a value, the given @a key
2552	will be deleted.
2553
2554	<note>
2555	Before performing the actual data change, this method will ask all
2556	registered callbacks using the
2557	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
2558	notification for a permission. If one of the callbacks refuses the
2559	new value, the change will not be performed.
2560	</note>
2561	<note>
2562	On success, the
2563	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
2564	is called to inform all registered callbacks about a successful data
2565	change.
2566	</note>
2567
2568	<result name="VBOX_E_FILE_ERROR">
2569	Settings file not accessible.
2570	</result>
2571	<result name="VBOX_E_XML_ERROR">
2572	Could not parse the settings file.
2573	</result>
2574	<result name="E_ACCESSDENIED">
2575	Modification request refused.
2576	</result>
2577
2578	</desc>
2579	<param name="key" type="wstring" dir="in">
2580	<desc>Name of the data key to set.</desc>
2581	</param>
2582	<param name="value" type="wstring" dir="in">
2583	<desc>Value to assign to the key.</desc>
2584	</param>
2585	</method>
2586
2587	<method name="openSession">
2588	<desc>
2589	Opens a new direct session with the given virtual machine.
2590
2591	A direct session acts as a local lock on the given VM.
2592	There can be only one direct session open at a time for every
2593	virtual machine, protecting the VM from being manipulated by
2594	conflicting actions from different processes. Only after a
2595	direct session has been opened, one can change all VM settings
2596	and execute the VM in the process space of the session object.
2597
2598	Sessions therefore can be compared to mutex semaphores that
2599	lock a given VM for modification and execution.
2600	See <link to="ISession">ISession</link> for details.
2601
2602	<note>Unless you are writing a new VM frontend, you will not
2603	want to execute a VM in the current process. To spawn a new
2604	process that executes a VM, use
2605	<link to="IVirtualBox::openRemoteSession" />
2606	instead.</note>
2607
2608	Upon successful return, the session object can be used to
2609	get access to the machine and to the VM console.
2610
2611	In VirtualBox terminology, the machine becomes "mutable" after
2612	a session has been opened. Note that the "mutable" machine
2613	object, on which you may invoke IMachine methods to change its
2614	settings, will be a different object from the immutable IMachine
2615	objects returned by various IVirtualBox methods. To obtain a
2616	mutable IMachine object (upon which you can invoke settings methods),
2617	use the <link to="ISession::machine" /> attribute.
2618
2619	One must always call <link to="ISession::close" /> to release the
2620	lock on the machine, or the machine's state will eventually be
2621	set to "Aborted".
2622
2623	In other words, to change settings on a machine, the following
2624	sequence is typically performed:
2625
2626	<ol>
2627	<li>Call this method (openSession) to have a machine locked for
2628	the current session.</li>
2629
2630	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
2631
2632	<li>Change the settings of the machine.</li>
2633
2634	<li>Call <link to="IMachine::saveSettings" />.</li>
2635
2636	<li>Close the session by calling <link to="ISession::close"/>.</li>
2637	</ol>
2638
2639	<result name="E_UNEXPECTED">
2640	Virtual machine not registered.
2641	</result>
2642	<result name="E_ACCESSDENIED">
2643	Process not started by OpenRemoteSession.
2644	</result>
2645	<result name="VBOX_E_OBJECT_NOT_FOUND">
2646	No matching virtual machine found.
2647	</result>
2648	<result name="VBOX_E_INVALID_OBJECT_STATE">
2649	Session already open or being opened.
2650	</result>
2651	<result name="VBOX_E_VM_ERROR">
2652	Failed to assign machine to session.
2653	</result>
2654
2655	</desc>
2656	<param name="session" type="ISession" dir="in">
2657	<desc>
2658	Session object that will represent the opened session after
2659	successful method invocation. This object must not represent
2660	the already open session.
2661	<note>
2662	This session will be automatically closed if the
2663	VirtualBox server is terminated for some reason.
2664	</note>
2665	</desc>
2666	</param>
2667	<param name="machineId" type="uuid" mod="string" dir="in">
2668	<desc>ID of the virtual machine to open a session with.</desc>
2669	</param>
2670	</method>
2671
2672	<method name="openRemoteSession">
2673	<desc>
2674	Spawns a new process that executes a virtual machine (called a
2675	"remote session").
2676
2677	Opening a remote session causes the VirtualBox server to start a new
2678	process that opens a direct session with the given VM. As a result, the
2679	VM is locked by that direct session in the new process, preventing
2680	conflicting changes from other processes. Since sessions act as locks
2681	that prevent conflicting changes, one cannot open a remote session
2682	for a VM that already has another open session (direct or remote), or
2683	is currently in the process of opening one (see <link
2684	to="IMachine::sessionState"/>).
2685
2686	While the remote session still provides some level of control over the
2687	VM execution to the caller (using the <link to="IConsole" /> interface),
2688	not all VM settings are available for modification within the remote
2689	session context.
2690
2691	This operation can take some time (a new VM is started in a new process,
2692	for which memory and other resources need to be set up). Because of this,
2693	an <link to="IProgress" /> is returned to allow the caller to wait for this
2694	asynchronous operation to be completed. Until then, the remote session
2695	object remains in the closed state, and accessing the machine or its
2696	console through it is invalid. It is recommended to use
2697	<link to="IProgress::waitForCompletion" /> or similar calls to wait for
2698	completion. Completion is signalled when the VM is powered on. Error
2699	messages etc. can be queried via the progress object, if available.
2700
2701	As with all <link to="ISession" /> objects, it is recommended to call
2702	<link to="ISession::close" /> on the local session object once openRemoteSession()
2703	has been called. However, the session's state (see <link to="ISession::state" />)
2704	will not return to "Closed" until the remote session has also closed (i.e.
2705	until the VM is no longer running). In that case, however, the state of
2706	the session will automatically change back to "Closed".
2707
2708	Currently supported session types (values of the @a type
2709	argument) are:
2710	<ul>
2711	<li><tt>"gui"</tt>: VirtualBox Qt GUI session</li>
2712	<li><tt>"vrdp"</tt>: VirtualBox VRDP Server session</li>
2713	<li><tt>"sdl"</tt>: VirtualBox SDL GUI session</li>
2714	</ul>
2715
2716	The @a environment argument is a string containing definitions of
2717	environment variables in the following format:
2718	@code
2719	NAME[=VALUE]\n
2720	NAME[=VALUE]\n
2721	...
2722	@endcode
2723	where <tt>\\n</tt> is the new line character. These environment
2724	variables will be appended to the environment of the VirtualBox server
2725	process. If an environment variable exists both in the server process
2726	and in this list, the value from this list takes precedence over the
2727	server's variable. If the value of the environment variable is
2728	omitted, this variable will be removed from the resulting environment.
2729	If the environment string is @c null or empty, the server environment
2730	is inherited by the started process as is.
2731
2732	<see>openExistingSession</see>
2733
2734	<result name="E_UNEXPECTED">
2735	Virtual machine not registered.
2736	</result>
2737	<result name="E_INVALIDARG">
2738	Invalid session type @a type.
2739	</result>
2740	<result name="VBOX_E_OBJECT_NOT_FOUND">
2741	No machine matching @a machineId found.
2742	</result>
2743	<result name="VBOX_E_INVALID_OBJECT_STATE">
2744	Session already open or being opened.
2745	</result>
2746	<result name="VBOX_E_IPRT_ERROR">
2747	Launching process for machine failed.
2748	</result>
2749	<result name="VBOX_E_VM_ERROR">
2750	Failed to assign machine to session.
2751	</result>
2752
2753	</desc>
2754	<param name="session" type="ISession" dir="in">
2755	<desc>
2756	Session object that will represent the opened remote session
2757	after successful method invocation (this object must not
2758	represent an already open session).
2759	</desc>
2760	</param>
2761	<param name="machineId" type="uuid" mod="string" dir="in">
2762	<desc>ID of the virtual machine to open a session with.</desc>
2763	</param>
2764	<param name="type" type="wstring" dir="in">
2765	<desc>
2766	Type of the remote session (case sensitive).
2767	</desc>
2768	</param>
2769	<param name="environment" type="wstring" dir="in">
2770	<desc>
2771	Environment to pass to the opened session.
2772	</desc>
2773	</param>
2774	<param name="progress" type="IProgress" dir="return">
2775	<desc>Progress object to track the operation completion.</desc>
2776	</param>
2777	</method>
2778
2779	<method name="openExistingSession">
2780	<desc>
2781	Opens a new remote session with the virtual machine for
2782	which a direct session is already open.
2783
2784	The remote session provides some level of control over the VM
2785	execution (using the IConsole interface) to the caller; however,
2786	within the remote session context, not all VM settings are available
2787	for modification.
2788
2789	As opposed to <link to="#openRemoteSession"/>, the number of
2790	remote sessions opened this way is not limited by the API
2791
2792	<note>
2793	It is an error to open a remote session with the machine that
2794	doesn't have an open direct session.
2795	</note>
2796
2797	<result name="E_UNEXPECTED">
2798	Virtual machine not registered.
2799	</result>
2800	<result name="VBOX_E_OBJECT_NOT_FOUND">
2801	No machine matching @a machineId found.
2802	</result>
2803	<result name="VBOX_E_INVALID_OBJECT_STATE">
2804	Session already open or being opened.
2805	</result>
2806	<result name="VBOX_E_INVALID_SESSION_STATE">
2807	Direct session state not Open.
2808	</result>
2809	<result name="VBOX_E_VM_ERROR">
2810	Failed to get console object from direct session or assign
2811	machine to session.
2812	</result>
2813
2814	<see>openRemoteSession</see>
2815	</desc>
2816	<param name="session" type="ISession" dir="in">
2817	<desc>
2818	Session object that will represent the open remote session
2819	after successful method invocation. This object must not
2820	represent an already open session.
2821	<note>
2822	This session will be automatically closed when the peer
2823	(direct) session dies or gets closed.
2824	</note>
2825	</desc>
2826	</param>
2827	<param name="machineId" type="uuid" mod="string" dir="in">
2828	<desc>ID of the virtual machine to open a session with.</desc>
2829	</param>
2830	</method>
2831
2832	<method name="registerCallback">
2833	<desc>
2834	Registers a new global VirtualBox callback. The methods of the given
2835	callback object will be called by VirtualBox when an appropriate
2836	event occurs.
2837
2838	<result name="E_INVALIDARG">
2839	A @c null callback cannot be registered.
2840	</result>
2841
2842	</desc>
2843	<param name="callback" type="IVirtualBoxCallback" dir="in">
2844	<desc>Callback object to register.</desc>
2845	</param>
2846	</method>
2847
2848	<method name="unregisterCallback">
2849	<desc>
2850	Unregisters the previously registered global VirtualBox callback.
2851
2852	<result name="E_INVALIDARG">
2853	Specified @a callback not registered.
2854	</result>
2855
2856	</desc>
2857	<param name="callback" type="IVirtualBoxCallback" dir="in">
2858	<desc>Callback object to unregister.</desc>
2859	</param>
2860	</method>
2861
2862	<method name="waitForPropertyChange">
2863	<desc>
2864	Blocks the caller until any of the properties represented by the
2865	@a what argument changes the value or until the given timeout interval
2866	expires.
2867
2868	The @a what argument is a comma separated list of property masks that
2869	describe properties the caller is interested in. The property mask is
2870	a string in the following format:
2871
2872	<pre>
2873	[[group.]subgroup.]name
2874	</pre>
2875
2876	where @c name is the property name and @c group, @c subgroup are zero
2877	or more property group specifiers. Each element (group or name) in
2878	the property mask may be either a Latin string or an asterisk symbol
2879	(@c "*") which is used to match any string for the given element. A
2880	property mask that doesn't contain asterisk symbols represents a
2881	single fully qualified property name.
2882
2883	Groups in the fully qualified property name go from more generic (the
2884	left-most part) to more specific (the right-most part). The first
2885	element is usually a name of the object the property belongs to. The
2886	second element may be either a property name, or a child object name,
2887	or an index if the preceding element names an object which is one of
2888	many objects of the same type. This way, property names form a
2889	hierarchy of properties. Here are some examples of property names:
2890
2891	<table>
2892	<tr>
2893	<td><tt>VirtualBox.version</tt></td>
2894	<td><link to="IVirtualBox::version"/> property</td>
2895	</tr>
2896	<tr>
2897	<td><tt>Machine.<UUID>.name</tt></td>
2898	<td><link to="IMachine::name"/> property of the machine with the
2899	given UUID</td>
2900	</tr>
2901	</table>
2902
2903	Most property names directly correspond to the properties of objects
2904	(components) provided by the VirtualBox library and may be used to
2905	track changes to these properties. However, there may be
2906	pseudo-property names that don't correspond to any existing object's
2907	property directly, as well as there may be object properties that
2908	don't have a corresponding property name that is understood by this
2909	method, and therefore changes to such properties cannot be
2910	tracked. See individual object's property descriptions to get a
2911	fully qualified property name that can be used with this method (if
2912	any).
2913
2914	There is a special property mask @c "*" (i.e. a string consisting of a
2915	single asterisk symbol) that can be used to match all properties.
2916	Below are more examples of property masks:
2917
2918	<table>
2919	<tr>
2920	<td><tt>VirtualBox.*</tt></td>
2921	<td>Track all properties of the VirtualBox object</td>
2922	</tr>
2923	<tr>
2924	<td><tt>Machine.*.name</tt></td>
2925	<td>Track changes to the <link to="IMachine::name"/> property of
2926	all registered virtual machines</td>
2927	</tr>
2928	</table>
2929
2930	<note>
2931	This function is not implemented in the current version of the
2932	product.
2933	</note>
2934	</desc>
2935	<param name="what" type="wstring" dir="in">
2936	<desc>Comma separated list of property masks.</desc>
2937	</param>
2938	<param name="timeout" type="unsigned long" dir="in">
2939	<desc>
2940	Wait timeout in milliseconds.
2941	Specify -1 for an indefinite wait.
2942	</desc>
2943	</param>
2944	<param name="changed" type="wstring" dir="out">
2945	<desc>
2946	Comma separated list of properties that have been changed and caused
2947	this method to return to the caller.
2948	</desc>
2949	</param>
2950	<param name="values" type="wstring" dir="out">
2951	<desc>Reserved, not currently used.</desc>
2952	</param>
2953	</method>
2954
2955	<!--method name="createDHCPServerForInterface">
2956	<desc>
2957	Creates a dhcp server settings to be used for the given interface
2958	<result name="E_INVALIDARG">
2959	Host network interface @a name already exists.
2960	</result>
2961	</desc>
2962	<param name="interface" type="IHostNetworkInterface" dir="in">
2963	<desc>Network Interface</desc>
2964	</param>
2965	<param name="server" type="IDHCPServer" dir="out">
2966	<desc>Dhcp server settings</desc>
2967	</param>
2968	</method-->
2969
2970	<method name="createDHCPServer">
2971	<desc>
2972	Creates a dhcp server settings to be used for the given internal network name
2973	<result name="E_INVALIDARG">
2974	Host network interface @a name already exists.
2975	</result>
2976	</desc>
2977	<param name="name" type="wstring" dir="in">
2978	<desc>server name</desc>
2979	</param>
2980	<param name="server" type="IDHCPServer" dir="return">
2981	<desc>Dhcp server settings</desc>
2982	</param>
2983	</method>
2984
2985	<method name="findDHCPServerByNetworkName">
2986	<desc>
2987	Searches a dhcp server settings to be used for the given internal network name
2988	<result name="E_INVALIDARG">
2989	Host network interface @a name already exists.
2990	</result>
2991
2992	</desc>
2993	<param name="name" type="wstring" dir="in">
2994	<desc>server name</desc>
2995	</param>
2996	<param name="server" type="IDHCPServer" dir="return">
2997	<desc>Dhcp server settings</desc>
2998	</param>
2999	</method>
3000
3001	<!--method name="findDHCPServerForInterface">
3002	<desc>
3003	Searches a dhcp server settings to be used for the given interface
3004	<result name="E_INVALIDARG">
3005	Host network interface @a name already exists.
3006	</result>
3007	</desc>
3008	<param name="interface" type="IHostNetworkInterface" dir="in">
3009	<desc>Network Interface</desc>
3010	</param>
3011	<param name="server" type="IDHCPServer" dir="out">
3012	<desc>Dhcp server settings</desc>
3013	</param>
3014	</method-->
3015
3016	<method name="removeDHCPServer">
3017	<desc>
3018	Removes the dhcp server settings
3019	<result name="E_INVALIDARG">
3020	Host network interface @a name already exists.
3021	</result>
3022	</desc>
3023	<param name="server" type="IDHCPServer" dir="in">
3024	<desc>Dhcp server settings to be removed</desc>
3025	</param>
3026	</method>
3027
3028
3029	<method name="checkFirmwarePresent">
3030	<desc>
3031	Check if this VirtualBox installation has a firmware
3032	of the given type available, either system-wide or per-user.
3033	Optionally, this may return a hint where this firmware can be
3034	downloaded from.
3035	</desc>
3036	<param name="firmwareType" type="FirmwareType" dir="in">
3037	<desc>
3038	Type of firmware to check.
3039	</desc>
3040	</param>
3041	<param name="version" type="wstring" dir="in">
3042	<desc>Expected version number, usually empty string (presently ignored).</desc>
3043	</param>
3044
3045	<param name="url" type="wstring" dir="out">
3046	<desc>
3047	Suggested URL to download this firmware from.
3048	</desc>
3049	</param>
3050
3051	<param name="file" type="wstring" dir="out">
3052	<desc>
3053	Filename of firmware, only valid if result == TRUE.
3054	</desc>
3055	</param>
3056
3057	<param name="result" type="boolean" dir="return">
3058	<desc>If firmware of this type and version is available.</desc>
3059	</param>
3060	</method>
3061
3062	</interface>
3063
3064	<!--
3065	// IVFSExplorer
3066	/////////////////////////////////////////////////////////////////////////
3067	-->
3068
3069	<enum
3070	name="VFSType"
3071	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
3072	>
3073	<desc>
3074	Virtual file systems supported by VFSExplorer.
3075	</desc>
3076
3077	<const name="File" value="1" />
3078	<const name="Cloud" value="2" />
3079	<const name="S3" value="3" />
3080	<const name="WebDav" value="4" />
3081	</enum>
3082
3083	<enum
3084	name="VFSFileType"
3085	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
3086	>
3087	<desc>
3088	File types known by VFSExplorer.
3089	</desc>
3090
3091	<const name="Unknown" value="1" />
3092	<const name="Fifo" value="2" />
3093	<const name="DevChar" value="3" />
3094	<const name="Directory" value="4" />
3095	<const name="DevBlock" value="5" />
3096	<const name="File" value="6" />
3097	<const name="SymLink" value="7" />
3098	<const name="Socket" value="8" />
3099	<const name="WhiteOut" value="9" />
3100	</enum>
3101
3102	<interface
3103	name="IVFSExplorer" extends="$unknown"
3104	uuid="2bb864a1-02a3-4474-a1d4-fb5f23b742e1"
3105	wsmap="managed"
3106	>
3107	<desc>
3108	The VFSExplorer interface unifies access to different file system
3109	types. This includes local file systems as well remote file systems like
3110	S3. For a list of supported types see <link to="VFSType" />.
3111	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
3112	</desc>
3113
3114	<attribute name="path" type="wstring" readonly="yes">
3115	<desc>Returns the current path in the virtual file system.</desc>
3116	</attribute>
3117
3118	<attribute name="type" type="VFSType" readonly="yes">
3119	<desc>Returns the file system type which is currently in use.</desc>
3120	</attribute>
3121
3122	<method name="update">
3123	<desc>Updates the internal list of files/directories from the
3124	current directory level. Use <link to="#entryList" /> to get the full list
3125	after a call to this method.</desc>
3126
3127	<param name="aProgress" type="IProgress" dir="return">
3128	<desc>Progress object to track the operation completion.</desc>
3129	</param>
3130	</method>
3131
3132	<method name="cd">
3133	<desc>Change the current directory level.</desc>
3134
3135	<param name="aDir" type="wstring" dir="in">
3136	<desc>The name of the directory to go in.</desc>
3137	</param>
3138
3139	<param name="aProgress" type="IProgress" dir="return">
3140	<desc>Progress object to track the operation completion.</desc>
3141	</param>
3142	</method>
3143
3144	<method name="cdUp">
3145	<desc>Go one directory upwards from the current directory level.</desc>
3146
3147	<param name="aProgress" type="IProgress" dir="return">
3148	<desc>Progress object to track the operation completion.</desc>
3149	</param>
3150	</method>
3151
3152	<method name="entryList">
3153	<desc>Returns a list of files/directories after a call to <link
3154	to="#update" />. The user is responsible for keeping this internal
3155	list up do date.</desc>
3156
3157	<param name="aNames" type="wstring" safearray="yes" dir="out">
3158	<desc>The list of names for the entries.</desc>
3159	</param>
3160
3161	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
3162	<desc>The list of types for the entries.</desc>
3163	</param>
3164	</method>
3165
3166	<method name="exists">
3167	<desc>Checks if the given file list exists in the current directory
3168	level.</desc>
3169
3170	<param name="aNames" type="wstring" safearray="yes" dir="in">
3171	<desc>The names to check.</desc>
3172	</param>
3173
3174	<param name="aExists" type="wstring" safearray="yes" dir="return">
3175	<desc>The names which exist.</desc>
3176	</param>
3177	</method>
3178
3179	<method name="remove">
3180	<desc>Deletes the given files in the current directory level.</desc>
3181
3182	<param name="aNames" type="wstring" safearray="yes" dir="in">
3183	<desc>The names to remove.</desc>
3184	</param>
3185
3186	<param name="aProgress" type="IProgress" dir="return">
3187	<desc>Progress object to track the operation completion.</desc>
3188	</param>
3189	</method>
3190
3191	</interface>
3192
3193	<!--
3194	// IAppliance
3195	/////////////////////////////////////////////////////////////////////////
3196	-->
3197
3198	<interface
3199	name="IAppliance" extends="$unknown"
3200	uuid="e3ba9ab9-ac2c-4266-8bd2-91c4bf721ceb"
3201	wsmap="managed"
3202	>
3203	<desc>
3204	Represents a platform-independent appliance in OVF format. An instance of this is returned
3205	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
3206	virtual machines within an appliance with VirtualBox.
3207
3208	The OVF standard suggests two different physical file formats:
3209
3210	<ol>
3211	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
3212	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
3213	this descriptor file references other files such as disk images, as OVF appliances typically
3214	do, those additional files must be in the same directory as the descriptor file.</li>
3215
3216	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
3217	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
3218	files and optionally other files.
3219
3220	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
3221	be added with a later version.</li>
3222	</ol>
3223
3224	<b>Importing</b> an OVF appliance into VirtualBox as instances of
3225	<link to="IMachine" /> involves the following sequence of API calls:
3226
3227	<ol>
3228	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
3229	</li>
3230
3231	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
3232	would like to import. So long as this file is syntactically valid, this will succeed
3233	and fill the appliance object with the parsed data from the OVF file.
3234	</li>
3235
3236	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
3237	contents of the IAppliance attributes accordingly. These can be inspected by a
3238	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
3239	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
3240	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
3241	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
3242	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
3243	The GUI can then give the user the option to confirm and/or change these suggestions.
3244	</li>
3245
3246	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3247	virtual system (machine) to override the suggestions made by the interpret() routine.
3248	</li>
3249
3250	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
3251	VirtualBox as instances of <link to="IMachine" /> that match the information in the
3252	virtual system descriptions.
3253	</li>
3254	</ol>
3255
3256	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
3257
3258	<ol>
3259	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
3260	an empty IAppliance object.
3261	</li>
3262
3263	<li>For each machine you would like to export, call <link to="IMachine::export" />
3264	with the IAppliance object you just created. Each such call creates one instance of
3265	<link to="IVirtualSystemDescription" /> inside the appliance.
3266	</li>
3267
3268	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3269	virtual system (machine) to override the suggestions made by the export() routine.
3270	</li>
3271
3272	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
3273	file written.</li>
3274	</ol>
3275
3276	</desc>
3277
3278	<attribute name="path" type="wstring" readonly="yes">
3279	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
3280	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
3281	<link to="#write" /> (for export).
3282	This attribute is empty until one of these methods has been called.
3283	</desc>
3284	</attribute>
3285
3286	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
3287	<desc>
3288	Array of virtual disk definitions. One such description exists for each
3289	disk definition in the OVF; each string array item represents one such piece of
3290	disk information, with the information fields separated by tab (\t) characters.
3291
3292	The caller should be prepared for additional fields being appended to
3293	this string in future versions of VirtualBox and therefore check for
3294	the number of tabs in the strings returned.
3295
3296	In the current version, the following eight fields are returned per string
3297	in the array:
3298
3299	<ol>
3300	<li>Disk ID (unique string identifier given to disk)</li>
3301
3302	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
3303
3304	<li>Populated size (optional unsigned integer indicating the current size of the
3305	disk; can be approximate; -1 if unspecified)</li>
3306
3307	<li>Format (string identifying the disk format, typically
3308	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
3309
3310	<li>Reference (where to find the disk image, typically a file name; if empty,
3311	then the disk should be created on import)</li>
3312
3313	<li>Image size (optional unsigned integer indicating the size of the image,
3314	which need not necessarily be the same as the values specified above, since
3315	the image may be compressed or sparse; -1 if not specified)</li>
3316
3317	<li>Chunk size (optional unsigned integer if the image is split into chunks;
3318	presently unsupported and always -1)</li>
3319
3320	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
3321	</ol>
3322	</desc>
3323	</attribute>
3324
3325	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
3326	<desc> Array of virtual system descriptions. One such description is created
3327	for each virtual system (machine) found in the OVF.
3328	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
3329	(for export) has been called.
3330	</desc>
3331	</attribute>
3332
3333	<method name="read">
3334	<desc>
3335	Reads an OVF file into the appliance object.
3336
3337	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
3338	mere fact that this method returns successfully does not mean that VirtualBox supports all
3339	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
3340	</desc>
3341	<param name="file" type="wstring" dir="in">
3342	<desc>
3343	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3344	on whether the appliance is distributed as a set of files or as a single file, respectively).
3345	</desc>
3346	</param>
3347	<param name="aProgress" type="IProgress" dir="return">
3348	<desc></desc>
3349	</param>
3350	</method>
3351
3352	<method name="interpret">
3353	<desc>
3354	Interprets the OVF data that was read when the appliance was constructed. After
3355	calling this method, one can inspect the
3356	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
3357	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
3358	the appliance.
3359
3360	Calling this method is the second step of importing an appliance into VirtualBox;
3361	see <link to="IAppliance" /> for an overview.
3362
3363	After calling this method, one should call <link to="#getWarnings" /> to find out
3364	if problems were encountered during the processing which might later lead to
3365	errors.
3366	</desc>
3367	</method>
3368
3369	<method name="importMachines">
3370	<desc>
3371	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
3372	and other interfaces that match the information contained in the appliance as
3373	closely as possible, as represented by the import instructions in the
3374	<link to="#virtualSystemDescriptions" /> array.
3375
3376	Calling this method is the final step of importing an appliance into VirtualBox;
3377	see <link to="IAppliance" /> for an overview.
3378
3379	Since importing the appliance will most probably involve copying and converting
3380	disk images, which can take a long time, this method operates asynchronously and
3381	returns an IProgress object to allow the caller to monitor the progress.
3382	</desc>
3383
3384	<param name="aProgress" type="IProgress" dir="return">
3385	<desc></desc>
3386	</param>
3387	</method>
3388
3389	<method name="createVFSExplorer">
3390	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
3391
3392	<param name="aUri" type="wstring" dir="in">
3393	<desc>The URI describing the file system to use.</desc>
3394	</param>
3395
3396	<param name="aExplorer" type="IVFSExplorer" dir="return">
3397	<desc></desc>
3398	</param>
3399	</method>
3400
3401	<method name="write">
3402	<desc>
3403	Writes the contents of the appliance exports into a new OVF file.
3404
3405	Calling this method is the final step of exporting an appliance from VirtualBox;
3406	see <link to="IAppliance" /> for an overview.
3407
3408	Since exporting the appliance will most probably involve copying and converting
3409	disk images, which can take a long time, this method operates asynchronously and
3410	returns an IProgress object to allow the caller to monitor the progress.
3411	</desc>
3412	<param name="format" type="wstring" dir="in">
3413	<desc>
3414	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
3415	future versions of VirtualBox may support additional formats.
3416	</desc>
3417	</param>
3418	<param name="path" type="wstring" dir="in">
3419	<desc>
3420	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3421	on whether the appliance is distributed as a set of files or as a single file, respectively).
3422	</desc>
3423	</param>
3424	<param name="aProgress" type="IProgress" dir="return">
3425	<desc>Progress object to track the operation completion.</desc>
3426	</param>
3427	</method>
3428
3429	<method name="getWarnings">
3430	<desc>Returns textual warnings which occured during execution of <link to="#interpret" />.</desc>
3431
3432	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
3433	<desc></desc>
3434	</param>
3435	</method>
3436
3437	</interface>
3438
3439	<enum
3440	name="VirtualSystemDescriptionType"
3441	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
3442	>
3443	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
3444	a configuration value.</desc>
3445
3446	<const name="Ignore" value="1" />
3447	<const name="OS" value="2" />
3448	<const name="Name" value="3" />
3449	<const name="Product" value="4" />
3450	<const name="Vendor" value="5" />
3451	<const name="Version" value="6" />
3452	<const name="ProductUrl" value="7" />
3453	<const name="VendorUrl" value="8" />
3454	<const name="Description" value="9" />
3455	<const name="License" value="10" />
3456	<const name="Miscellaneous" value="11" />
3457	<const name="CPU" value="12" />
3458	<const name="Memory" value="13" />
3459	<const name="HardDiskControllerIDE" value="14" />
3460	<const name="HardDiskControllerSATA" value="15" />
3461	<const name="HardDiskControllerSCSI" value="16" />
3462	<const name="HardDiskControllerSAS" value="17" />
3463	<const name="HardDiskImage" value="18" />
3464	<const name="Floppy" value="19" />
3465	<const name="CDROM" value="20" />
3466	<const name="NetworkAdapter" value="21" />
3467	<const name="USBController" value="22" />
3468	<const name="SoundCard" value="23" />
3469
3470	</enum>
3471
3472	<enum
3473	name="VirtualSystemDescriptionValueType"
3474	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
3475	>
3476	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
3477	type to fetch.</desc>
3478
3479	<const name="Reference" value="1" />
3480	<const name="Original" value="2" />
3481	<const name="Auto" value="3" />
3482	<const name="ExtraConfig" value="4" />
3483
3484	</enum>
3485
3486	<interface
3487	name="IVirtualSystemDescription" extends="$unknown"
3488	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
3489	wsmap="managed"
3490	>
3491
3492	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
3493	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
3494	<link to="IAppliance::interpret" /> has been called, that array contains information
3495	about how the virtual systems described in the OVF should best be imported into
3496	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
3497	import an OVF into VirtualBox.
3498	</desc>
3499
3500	<attribute name="count" type="unsigned long" readonly="yes">
3501	<desc>Return the number of virtual system description entries.</desc>
3502	</attribute>
3503
3504	<method name="getDescription">
3505	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
3506	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
3507
3508	The list below identifies the value sets that are possible depending on the
3509	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
3510	the array item with the same index in @a aOvfValues[] will contain the original value as contained
3511	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
3512	will contain a suggested value to be used for VirtualBox. Depending on the description type,
3513	the @a aExtraConfigValues[] array item may also be used.
3514
3515	<ul>
3516	<li>
3517	"OS": the guest operating system type. There must be exactly one such array item on import. The
3518	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
3519	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
3520	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
3521	</li>
3522	<li>
3523	"Name": the name to give to the new virtual machine. There can be at most one such array item;
3524	if none is present on import, then an automatic name will be created from the operating system
3525	type. The correponding item im @a aOvfValues[] will contain the suggested virtual machine name
3526	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
3527	<link to="IMachine" /> name that does not exist yet.
3528	</li>
3529	<li>
3530	"Description": an arbitrary description.
3531	</li>
3532	<li>
3533	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
3534	code to display such a license for agreement; the Main API does not enforce any such policy.
3535	</li>
3536	<li>
3537	Miscellaneous: reserved for future use.
3538	</li>
3539	<li>
3540	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
3541	</li>
3542	<li>
3543	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
3544	is present on import, then VirtualBox will set a meaningful default based on the operating system
3545	type.
3546	</li>
3547	<li>
3548	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
3549	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
3550	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
3551	writes into the OVF.
3552	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
3553	type can use to specify which hard disk controller a virtual disk should be connected to.
3554	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
3555	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
3556	its virtual machines supports four channels (primary master, primary slave, secondary master,
3557	secondary slave) and thus maps to two IDE controllers in the OVF sense.
3558	</li>
3559	<li>
3560	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
3561	has no value in @a aOvfValues[] or @a aVBoxValues[].
3562	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
3563	</li>
3564	<li>
3565	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
3566	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
3567	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
3568	whereas VirtualBox considers it a class of storage controllers of its own; see
3569	<link to="StorageControllerType" />).
3570	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
3571	</li>
3572	<li>
3573	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
3574	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
3575
3576	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
3577	a path since the image file should be in the same location as the OVF file itself), whereas the
3578	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
3579	hard disk image. This means that on import the image will be copied and converted from the
3580	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
3581	On import, the target image will also be registered with VirtualBox.
3582
3583	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
3584	format: "controller=<index>;channel=<c>"
3585	In this string, <index> must be an integer specifying the hard disk controller to connect
3586	the image to. That number must be the index of an array item with one of the hard disk controller
3587	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
3588	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
3589	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
3590	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
3591	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
3592	</li>
3593	<li>
3594	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
3595	attachment information as with "HardDiskImage" items.
3596	</li>
3597	<li>
3598	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
3599	attachment information as with "HardDiskImage" items.
3600	</li>
3601	<li>
3602	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
3603	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
3604	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
3605	</li>
3606	<li>
3607	"USBController": a USB controller. There can be at most one such item. If and only if such an
3608	item ispresent, USB support will be enabled for the new virtual machine.
3609	</li>
3610	<li>
3611	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
3612	present, sound support will be enabled for the new virtual machine. Note that the virtual
3613	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
3614	may be different from the virtual soundcard expected by the appliance.
3615	</li>
3616	</ul>
3617
3618	</desc>
3619
3620	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3621	<desc></desc>
3622	</param>
3623
3624	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3625	<desc></desc>
3626	</param>
3627
3628	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3629	<desc></desc>
3630	</param>
3631
3632	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3633	<desc></desc>
3634	</param>
3635
3636	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3637	<desc></desc>
3638	</param>
3639
3640	</method>
3641
3642	<method name="getDescriptionByType">
3643	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
3644	should be returned.</desc>
3645
3646	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3647	<desc></desc>
3648	</param>
3649
3650	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3651	<desc></desc>
3652	</param>
3653
3654	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3655	<desc></desc>
3656	</param>
3657
3658	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3659	<desc></desc>
3660	</param>
3661
3662	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3663	<desc></desc>
3664	</param>
3665
3666	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3667	<desc></desc>
3668	</param>
3669
3670	</method>
3671
3672	<method name="getValuesByType">
3673	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
3674	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
3675	values.</desc>
3676
3677	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3678	<desc></desc>
3679	</param>
3680
3681	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
3682	<desc></desc>
3683	</param>
3684
3685	<param name="aValues" type="wstring" dir="return" safearray="yes">
3686	<desc></desc>
3687	</param>
3688
3689	</method>
3690
3691	<method name="setFinalValues">
3692	<desc>
3693	This method allows the appliance's user to change the configuration for the virtual
3694	system descriptions. For each array item returned from <link to="#getDescription" />,
3695	you must pass in one boolean value and one configuration value.
3696
3697	Each item in the boolean array determines whether the particular configuration item
3698	should be enabled.
3699	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
3700	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
3701	and SoundCard.
3702
3703	For the "vbox" and "extra configuration" values, if you pass in the same arrays
3704	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
3705	the configuration remains unchanged. Please see the documentation for getDescription()
3706	for valid configuration values for the individual array item types. If the
3707	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3708	</desc>
3709
3710	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
3711	<desc></desc>
3712	</param>
3713
3714	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
3715	<desc></desc>
3716	</param>
3717
3718	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
3719	<desc></desc>
3720	</param>
3721	</method>
3722
3723	<method name="addDescription">
3724	<desc>
3725	This method adds an additional description entry to the stack of already
3726	available descriptions for this virtual system. This is handy for writing
3727	values which aren't directly supported by VirtualBox. One example would
3728	be the License type of <link to="VirtualSystemDescriptionType" />.
3729	</desc>
3730
3731	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3732	<desc></desc>
3733	</param>
3734
3735	<param name="aVBoxValue" type="wstring" dir="in">
3736	<desc></desc>
3737	</param>
3738
3739	<param name="aExtraConfigValue" type="wstring" dir="in">
3740	<desc></desc>
3741	</param>
3742	</method>
3743	</interface>
3744
3745
3746	<!--
3747	// IMachine
3748	/////////////////////////////////////////////////////////////////////////
3749	-->
3750
3751	<interface
3752	name="IInternalMachineControl" extends="$unknown"
3753	uuid="26604a54-8628-491b-a0ea-e1392a16d13b"
3754	internal="yes"
3755	wsmap="suppress"
3756	>
3757	<method name="setRemoveSavedState">
3758	<desc>
3759	Updates the flag whether saved state is removed on a machine state
3760	change from Saved to PoweredOff.
3761	</desc>
3762	<param name="aRemove" type="boolean" dir="in"/>
3763	</method>
3764
3765	<method name="updateState">
3766	<desc>
3767	Updates the VM state.
3768	<note>
3769	This operation will also update the settings file with
3770	the correct information about the saved state file
3771	and delete this file from disk when appropriate.
3772	</note>
3773	</desc>
3774	<param name="state" type="MachineState" dir="in"/>
3775	</method>
3776
3777	<method name="getIPCId">
3778	<param name="id" type="wstring" dir="return"/>
3779	</method>
3780
3781	<method name="beginPowerUp">
3782	<desc>
3783	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
3784	gives it the progress object that should be part of any pending
3785	<link to="IVirtualBox::openRemoteSession"/> operations. The progress
3786	object may be called back to reflect an early cancelation, so some care
3787	have to be taken with respect to any cancelation callbacks. The console
3788	object will call <link to="IInternalMachineControl::endPowerUp"/>
3789	to signal the completion of the progress object.
3790	</desc>
3791	<param name="progress" type="IProgress" dir="in"/>
3792	</method>
3793
3794	<method name="endPowerUp">
3795	<desc>
3796	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3797	This method may query status information from the progress object it
3798	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3799	it over to any in progress <link to="IVirtualBox::openRemoteSession"/>
3800	call in order to complete that progress object.
3801	</desc>
3802	<param name="result" type="long" dir="in"/>
3803	</method>
3804
3805	<method name="runUSBDeviceFilters">
3806	<desc>
3807	Asks the server to run USB devices filters of the associated
3808	machine against the given USB device and tell if there is
3809	a match.
3810	<note>
3811	Intended to be used only for remote USB devices. Local
3812	ones don't require to call this method (this is done
3813	implicitly by the Host and USBProxyService).
3814	</note>
3815	</desc>
3816	<param name="device" type="IUSBDevice" dir="in"/>
3817	<param name="matched" type="boolean" dir="out"/>
3818	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3819	</method>
3820
3821	<method name="captureUSBDevice">
3822	<desc>
3823	Requests a capture of the given host USB device.
3824	When the request is completed, the VM process will
3825	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3826	notification.
3827	</desc>
3828	<param name="id" type="uuid" mod="string" dir="in"/>
3829	</method>
3830
3831	<method name="detachUSBDevice">
3832	<desc>
3833	Notification that a VM is going to detach (@a done = @c false) or has
3834	already detached (@a done = @c true) the given USB device.
3835	When the @a done = @c true request is completed, the VM process will
3836	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3837	notification.
3838	<note>
3839	In the @a done = @c true case, the server must run its own filters
3840	and filters of all VMs but this one on the detached device
3841	as if it were just attached to the host computer.
3842	</note>
3843	</desc>
3844	<param name="id" type="uuid" mod="string" dir="in"/>
3845	<param name="done" type="boolean" dir="in"/>
3846	</method>
3847
3848	<method name="autoCaptureUSBDevices">
3849	<desc>
3850	Requests a capture all matching USB devices attached to the host.
3851	When the request is completed, the VM process will
3852	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3853	notification per every captured device.
3854	</desc>
3855	</method>
3856
3857	<method name="detachAllUSBDevices">
3858	<desc>
3859	Notification that a VM that is being powered down. The done
3860	parameter indicates whether which stage of the power down
3861	we're at. When @a done = @c false the VM is announcing its
3862	intentions, while when @a done = @c true the VM is reporting
3863	what it has done.
3864	<note>
3865	In the @a done = @c true case, the server must run its own filters
3866	and filters of all VMs but this one on all detach devices as
3867	if they were just attached to the host computer.
3868	</note>
3869	</desc>
3870	<param name="done" type="boolean" dir="in"/>
3871	</method>
3872
3873	<method name="onSessionEnd">
3874	<desc>
3875	Triggered by the given session object when the session is about
3876	to close normally.
3877	</desc>
3878	<param name="session" type="ISession" dir="in">
3879	<desc>Session that is being closed</desc>
3880	</param>
3881	<param name="progress" type="IProgress" dir="return">
3882	<desc>
3883	Used to wait until the corresponding machine is actually
3884	dissociated from the given session on the server.
3885	Returned only when this session is a direct one.
3886	</desc>
3887	</param>
3888	</method>
3889
3890	<method name="beginSavingState">
3891	<desc>
3892	Called by the VM process to inform the server it wants to
3893	save the current state and stop the VM execution.
3894	</desc>
3895	<param name="progress" type="IProgress" dir="in">
3896	<desc>
3897	Progress object created by the VM process to wait until
3898	the state is saved.
3899	</desc>
3900	</param>
3901	<param name="stateFilePath" type="wstring" dir="out">
3902	<desc>
3903	File path the VM process must save the execution state to.
3904	</desc>
3905	</param>
3906	</method>
3907
3908	<method name="endSavingState">
3909	<desc>
3910	Called by the VM process to inform the server that saving
3911	the state previously requested by #beginSavingState is either
3912	successfully finished or there was a failure.
3913
3914	<result name="VBOX_E_FILE_ERROR">
3915	Settings file not accessible.
3916	</result>
3917	<result name="VBOX_E_XML_ERROR">
3918	Could not parse the settings file.
3919	</result>
3920
3921	</desc>
3922
3923	<param name="success" type="boolean" dir="in">
3924	<desc>@c true to indicate success and @c false otherwise.
3925	</desc>
3926	</param>
3927	</method>
3928
3929	<method name="adoptSavedState">
3930	<desc>
3931	Gets called by IConsole::adoptSavedState.
3932	<result name="VBOX_E_FILE_ERROR">
3933	Invalid saved state file path.
3934	</result>
3935	</desc>
3936	<param name="savedStateFile" type="wstring" dir="in">
3937	<desc>Path to the saved state file to adopt.</desc>
3938	</param>
3939	</method>
3940
3941	<method name="beginTakingSnapshot">
3942	<desc>
3943	Called from the VM process to request from the server to perform the
3944	server-side actions of creating a snapshot (creating differencing images
3945	and the snapshot object).
3946
3947	<result name="VBOX_E_FILE_ERROR">
3948	Settings file not accessible.
3949	</result>
3950	<result name="VBOX_E_XML_ERROR">
3951	Could not parse the settings file.
3952	</result>
3953	</desc>
3954	<param name="initiator" type="IConsole" dir="in">
3955	<desc>The console object that initiated this call.</desc>
3956	</param>
3957	<param name="name" type="wstring" dir="in">
3958	<desc>Snapshot name.</desc>
3959	</param>
3960	<param name="description" type="wstring" dir="in">
3961	<desc>Snapshot description.</desc>
3962	</param>
3963	<param name="consoleProgress" type="IProgress" dir="in">
3964	<desc>
3965	Progress object created by the VM process tracking the
3966	snapshot's progress. This has the following sub-operations:
3967	<ul>
3968	<li>setting up (weight 1);</li>
3969	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3970	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3971	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3972	<li>finishing up (weight 1)</li>
3973	</ul>
3974	</desc>
3975	</param>
3976	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3977	<desc>
3978	Whether this is an online snapshot (i.e. the machine is running).
3979	</desc>
3980	</param>
3981	<param name="stateFilePath" type="wstring" dir="out">
3982	<desc>
3983	File path the VM process must save the execution state to.
3984	</desc>
3985	</param>
3986	</method>
3987
3988	<method name="endTakingSnapshot">
3989	<desc>
3990	Called by the VM process to inform the server that the snapshot
3991	previously requested by #beginTakingSnapshot is either
3992	successfully taken or there was a failure.
3993	</desc>
3994
3995	<param name="success" type="boolean" dir="in">
3996	<desc>@c true to indicate success and @c false otherwise</desc>
3997	</param>
3998	</method>
3999
4000	<method name="deleteSnapshot">
4001	<desc>
4002	Gets called by IConsole::deleteSnapshot.
4003	<result name="VBOX_E_INVALID_OBJECT_STATE">
4004	Snapshot has more than one child snapshot.
4005	</result>
4006	</desc>
4007	<param name="initiator" type="IConsole" dir="in">
4008	<desc>The console object that initiated this call.</desc>
4009	</param>
4010	<param name="id" type="uuid" mod="string" dir="in">
4011	<desc>UUID of the snapshot to delete.</desc>
4012	</param>
4013	<param name="machineState" type="MachineState" dir="out">
4014	<desc>New machine state after this operation is started.</desc>
4015	</param>
4016	<param name="progress" type="IProgress" dir="return">
4017	<desc>Progress object to track the operation completion.</desc>
4018	</param>
4019	</method>
4020
4021	<method name="finishOnlineMergeMedium">
4022	<desc>
4023	Gets called by IConsole::onlineMergeMedium.
4024	</desc>
4025	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
4026	<desc>The medium attachment which needs to be cleaned up.</desc>
4027	</param>
4028	<param name="source" type="IMedium" dir="in">
4029	<desc>Merge source medium.</desc>
4030	</param>
4031	<param name="target" type="IMedium" dir="in">
4032	<desc>Merge target medium.</desc>
4033	</param>
4034	<param name="mergeForward" type="boolean" dir="in">
4035	<desc>Merge direction.</desc>
4036	</param>
4037	<param name="parentForTarget" type="IMedium" dir="in">
4038	<desc>For forward merges: new parent for target medium.</desc>
4039	</param>
4040	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
4041	<desc>For backward merges: list of media which need their parent UUID
4042	updated.</desc>
4043	</param>
4044	</method>
4045
4046	<method name="restoreSnapshot">
4047	<desc>
4048	Gets called by IConsole::RestoreSnapshot.
4049	</desc>
4050	<param name="initiator" type="IConsole" dir="in">
4051	<desc>The console object that initiated this call.</desc>
4052	</param>
4053	<param name="snapshot" type="ISnapshot" dir="in">
4054	<desc>The snapshot to restore the VM state from.</desc>
4055	</param>
4056	<param name="machineState" type="MachineState" dir="out">
4057	<desc>New machine state after this operation is started.</desc>
4058	</param>
4059	<param name="progress" type="IProgress" dir="return">
4060	<desc>Progress object to track the operation completion.</desc>
4061	</param>
4062	</method>
4063
4064	<method name="pullGuestProperties">
4065	<desc>
4066	Get the list of the guest properties matching a set of patterns along
4067	with their values, time stamps and flags and give responsibility for
4068	managing properties to the console.
4069	</desc>
4070	<param name="name" type="wstring" dir="out" safearray="yes">
4071	<desc>
4072	The names of the properties returned.
4073	</desc>
4074	</param>
4075	<param name="value" type="wstring" dir="out" safearray="yes">
4076	<desc>
4077	The values of the properties returned. The array entries match the
4078	corresponding entries in the @a name array.
4079	</desc>
4080	</param>
4081	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
4082	<desc>
4083	The time stamps of the properties returned. The array entries match
4084	the corresponding entries in the @a name array.
4085	</desc>
4086	</param>
4087	<param name="flags" type="wstring" dir="out" safearray="yes">
4088	<desc>
4089	The flags of the properties returned. The array entries match the
4090	corresponding entries in the @a name array.
4091	</desc>
4092	</param>
4093	</method>
4094
4095	<method name="pushGuestProperty">
4096	<desc>
4097	Update a single guest property in IMachine.
4098	</desc>
4099	<param name="name" type="wstring" dir="in">
4100	<desc>
4101	The name of the property to be updated.
4102	</desc>
4103	</param>
4104	<param name="value" type="wstring" dir="in">
4105	<desc>
4106	The value of the property.
4107	</desc>
4108	</param>
4109	<param name="timestamp" type="unsigned long long" dir="in">
4110	<desc>
4111	The timestamp of the property.
4112	</desc>
4113	</param>
4114	<param name="flags" type="wstring" dir="in">
4115	<desc>
4116	The flags of the property.
4117	</desc>
4118	</param>
4119	</method>
4120
4121	<method name="lockMedia">
4122	<desc>
4123	Locks all media attached to the machine for writing and parents of
4124	attached differencing media (if any) for reading. This operation is
4125	atomic so that if it fails no media is actually locked.
4126
4127	This method is intended to be called when the machine is in Starting or
4128	Restoring state. The locked media will be automatically unlocked when
4129	the machine is powered off or crashed.
4130	</desc>
4131	</method>
4132	<method name="unlockMedia">
4133	<desc>
4134	Unlocks all media previously locked using
4135	<link to="IInternalMachineControl::lockMedia"/>.
4136
4137	This method is intended to be used with teleportation so that it is
4138	possible to teleport between processes on the same machine.
4139	</desc>
4140	</method>
4141	</interface>
4142
4143	<interface
4144	name="IBIOSSettings" extends="$unknown"
4145	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
4146	wsmap="managed"
4147	>
4148	<desc>
4149	The IBIOSSettings interface represents BIOS settings of the virtual
4150	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
4151	</desc>
4152	<attribute name="logoFadeIn" type="boolean">
4153	<desc>Fade in flag for BIOS logo animation.</desc>
4154	</attribute>
4155
4156	<attribute name="logoFadeOut" type="boolean">
4157	<desc>Fade out flag for BIOS logo animation.</desc>
4158	</attribute>
4159
4160	<attribute name="logoDisplayTime" type="unsigned long">
4161	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
4162	</attribute>
4163
4164	<attribute name="logoImagePath" type="wstring">
4165	<desc>
4166	Local file system path for external BIOS splash image. Empty string
4167	means the default image is shown on boot.
4168	</desc>
4169	</attribute>
4170
4171	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
4172	<desc>Mode of the BIOS boot device menu.</desc>
4173	</attribute>
4174
4175	<attribute name="ACPIEnabled" type="boolean">
4176	<desc>ACPI support flag.</desc>
4177	</attribute>
4178
4179	<attribute name="IOAPICEnabled" type="boolean">
4180	<desc>
4181	IO APIC support flag. If set, VirtualBox will provide an IO APIC
4182	and support IRQs above 15.
4183	</desc>
4184	</attribute>
4185
4186	<attribute name="timeOffset" type="long long">
4187	<desc>
4188	Offset in milliseconds from the host system time. This allows for
4189	guests running with a different system date/time than the host.
4190	It is equivalent to setting the system date/time in the BIOS except
4191	it is not an absolute value but a relative one. Guest Additions
4192	time synchronization honors this offset.
4193	</desc>
4194	</attribute>
4195
4196	<attribute name="PXEDebugEnabled" type="boolean">
4197	<desc>
4198	PXE debug logging flag. If set, VirtualBox will write extensive
4199	PXE trace information to the release log.
4200	</desc>
4201	</attribute>
4202
4203	</interface>
4204
4205	<interface
4206	name="IMachine" extends="$unknown"
4207	uuid="6d9212cb-a5c0-48b7-bbc1-3fa2ba2ee6d2"
4208	wsmap="managed"
4209	>
4210	<desc>
4211	The IMachine interface represents a virtual machine, or guest, created
4212	in VirtualBox.
4213
4214	This interface is used in two contexts. First of all, a collection of
4215	objects implementing this interface is stored in the
4216	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
4217	machines that are currently registered with this VirtualBox
4218	installation. Also, once a session has been opened for the given virtual
4219	machine (e.g. the virtual machine is running), the machine object
4220	associated with the open session can be queried from the session object;
4221	see <link to="ISession"/> for details.
4222
4223	The main role of this interface is to expose the settings of the virtual
4224	machine and provide methods to change various aspects of the virtual
4225	machine's configuration. For machine objects stored in the
4226	<link to="IVirtualBox::machines"/> collection, all attributes are
4227	read-only unless explicitly stated otherwise in individual attribute
4228	and method descriptions. In order to change a machine setting, a session
4229	for this machine must be opened using one of
4230	<link to="IVirtualBox::openSession"/>,
4231	<link to="IVirtualBox::openRemoteSession"/> or
4232	<link to="IVirtualBox::openExistingSession"/> methods. After the
4233	session has been successfully opened, a mutable machine object needs to
4234	be queried from the session object and then the desired settings changes
4235	can be applied to the returned object using IMachine attributes and
4236	methods. See the <link to="ISession"/> interface description for more
4237	information about sessions.
4238
4239	Note that IMachine does not provide methods to control virtual machine
4240	execution (such as start the machine, or power it down) -- these methods
4241	are grouped in a separate interface called <link to="IConsole" />.
4242
4243	<see>ISession, IConsole</see>
4244	</desc>
4245
4246	<attribute name="parent" type="IVirtualBox" readonly="yes">
4247	<desc>Associated parent object.</desc>
4248	</attribute>
4249
4250	<attribute name="accessible" type="boolean" readonly="yes">
4251	<desc>
4252	Whether this virtual machine is currently accessible or not.
4253
4254	A machine is always deemed accessible unless it is registered <i>and</i>
4255	its settings file cannot be read or parsed (either because the file itself
4256	is unavailable or has invalid XML contents).
4257
4258	Every time this property is read, the accessibility state of
4259	this machine is re-evaluated. If the returned value is @c false,
4260	the <link to="#accessError"/> property may be used to get the
4261	detailed error information describing the reason of
4262	inaccessibility, including XML error messages.
4263
4264	When the machine is inaccessible, only the following properties
4265	can be used on it:
4266	<ul>
4267	<li><link to="#parent"/></li>
4268	<li><link to="#id"/></li>
4269	<li><link to="#settingsFilePath"/></li>
4270	<li><link to="#accessible"/></li>
4271	<li><link to="#accessError"/></li>
4272	</ul>
4273
4274	An attempt to access any other property or method will return
4275	an error.
4276
4277	The only possible action you can perform on an inaccessible
4278	machine is to unregister it using the
4279	<link to="IVirtualBox::unregisterMachine"/> call (or, to check
4280	for the accessibility state once more by querying this
4281	property).
4282
4283	<note>
4284	In the current implementation, once this property returns
4285	@c true, the machine will never become inaccessible
4286	later, even if its settings file cannot be successfully
4287	read/written any more (at least, until the VirtualBox
4288	server is restarted). This limitation may be removed in
4289	future releases.
4290	</note>
4291	</desc>
4292	</attribute>
4293
4294	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
4295	<desc>
4296	Error information describing the reason of machine
4297	inaccessibility.
4298
4299	Reading this property is only valid after the last call to
4300	<link to="#accessible"/> returned @c false (i.e. the
4301	machine is currently unaccessible). Otherwise, a @c null
4302	IVirtualBoxErrorInfo object will be returned.
4303	</desc>
4304	</attribute>
4305
4306	<attribute name="name" type="wstring">
4307	<desc>
4308	Name of the virtual machine.
4309
4310	Besides being used for human-readable identification purposes
4311	everywhere in VirtualBox, the virtual machine name is also used
4312	as a name of the machine's settings file and as a name of the
4313	subdirectory this settings file resides in. Thus, every time you
4314	change the value of this property, the settings file will be
4315	renamed once you call <link to="#saveSettings"/> to confirm the
4316	change. The containing subdirectory will be also renamed, but
4317	only if it has exactly the same name as the settings file
4318	itself prior to changing this property (for backward compatibility
4319	with previous API releases). The above implies the following
4320	limitations:
4321	<ul>
4322	<li>The machine name cannot be empty.</li>
4323	<li>The machine name can contain only characters that are valid
4324	file name characters according to the rules of the file
4325	system used to store VirtualBox configuration.</li>
4326	<li>You cannot have two or more machines with the same name
4327	if they use the same subdirectory for storing the machine
4328	settings files.</li>
4329	<li>You cannot change the name of the machine if it is running,
4330	or if any file in the directory containing the settings file
4331	is being used by another running machine or by any other
4332	process in the host operating system at a time when
4333	<link to="#saveSettings"/> is called.
4334	</li>
4335	</ul>
4336	If any of the above limitations are hit, <link to="#saveSettings"/>
4337	will return an appropriate error message explaining the exact
4338	reason and the changes you made to this machine will not be
4339	saved.
4340	<note>
4341	For "legacy" machines created using the
4342	<link to="IVirtualBox::createLegacyMachine"/> call,
4343	the above naming limitations do not apply because the
4344	machine name does not affect the settings file name.
4345	The settings file name remains the same as it was specified
4346	during machine creation and never changes.
4347	</note>
4348	</desc>
4349	</attribute>
4350
4351	<attribute name="description" type="wstring">
4352	<desc>
4353	Description of the virtual machine.
4354
4355	The description attribute can contain any text and is
4356	typically used to describe the hardware and software
4357	configuration of the virtual machine in detail (i.e. network
4358	settings, versions of the installed software and so on).
4359	</desc>
4360	</attribute>
4361
4362	<attribute name="id" type="uuid" mod="string" readonly="yes">
4363	<desc>UUID of the virtual machine.</desc>
4364	</attribute>
4365
4366	<attribute name="OSTypeId" type="wstring">
4367	<desc>
4368	User-defined identifier of the Guest OS type.
4369	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
4370	an IGuestOSType object representing details about the given
4371	Guest OS type.
4372	<note>
4373	This value may differ from the value returned by
4374	<link to="IGuest::OSTypeId"/> if Guest Additions are
4375	installed to the guest OS.
4376	</note>
4377	</desc>
4378	</attribute>
4379
4380	<attribute name="HardwareVersion" type="wstring">
4381	<desc>Hardware version identifier. Internal use only for now.</desc>
4382	</attribute>
4383
4384	<attribute name="hardwareUUID" type="uuid" mod="string">
4385	<desc>
4386	The UUID presented to the guest via memory tables, hardware and guest
4387	properties. For most VMs this is the same as the @a id, but for VMs
4388	which have been cloned or teleported it may be the same as the source
4389	VM. This latter is because the guest shouldn't notice that it was
4390	cloned or teleported.
4391	</desc>
4392	</attribute>
4393
4394	<attribute name="CPUCount" type="unsigned long">
4395	<desc>Number of virtual CPUs in the VM.</desc>
4396	</attribute>
4397
4398	<attribute name="CPUHotPlugEnabled" type="boolean">
4399	<desc>
4400	This setting determines whether VirtualBox allows CPU
4401	hotplugging for this machine.</desc>
4402	</attribute>
4403
4404	<attribute name="memorySize" type="unsigned long">
4405	<desc>System memory size in megabytes.</desc>
4406	</attribute>
4407
4408	<attribute name="memoryBalloonSize" type="unsigned long">
4409	<desc>Memory balloon size in megabytes.</desc>
4410	</attribute>
4411
4412	<attribute name="PageFusionEnabled" type="boolean">
4413	<desc>
4414	This setting determines whether VirtualBox allows page
4415	fusion for this machine (64 bits host only).
4416	</desc>
4417	</attribute>
4418
4419	<attribute name="VRAMSize" type="unsigned long">
4420	<desc>Video memory size in megabytes.</desc>
4421	</attribute>
4422
4423	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4424	<desc>
4425	This setting determines whether VirtualBox allows this machine to make
4426	use of the 3D graphics support available on the host.</desc>
4427	</attribute>
4428
4429	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4430	<desc>
4431	This setting determines whether VirtualBox allows this machine to make
4432	use of the 2D video acceleration support available on the host.</desc>
4433	</attribute>
4434
4435	<attribute name="monitorCount" type="unsigned long">
4436	<desc>
4437	Number of virtual monitors.
4438	<note>
4439	Only effective on Windows XP and later guests with
4440	Guest Additions installed.
4441	</note>
4442	</desc>
4443	</attribute>
4444
4445	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4446	<desc>Object containing all BIOS settings.</desc>
4447	</attribute>
4448
4449	<attribute name="firmwareType" type="FirmwareType">
4450	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4451	bootstrap in this VM.</desc>
4452	</attribute>
4453
4454	<attribute name="pointingHidType" type="PointingHidType">
4455	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
4456	The default is typically "PS2Mouse" but can vary depending on the
4457	requirements of the guest operating system.</desc>
4458	</attribute>
4459
4460	<attribute name="keyboardHidType" type="KeyboardHidType">
4461	<desc>Type of keyboard HID used in this VM.
4462	The default is typically "PS2Keyboard" but can vary depending on the
4463	requirements of the guest operating system.</desc>
4464	</attribute>
4465
4466	<attribute name="hpetEnabled" type="boolean">
4467	<desc>This attribute controls if High Precision Event Timer (HPET) is
4468	enabled in this VM. Use this property if you want to provide guests
4469	with additional time source, or if guest requires HPET to function correctly.
4470	Default is false.</desc>
4471	</attribute>
4472
4473	<attribute name="snapshotFolder" type="wstring">
4474	<desc>
4475	Full path to the directory used to store snapshot data
4476	(differencing media and saved state files) of this machine.
4477
4478	The initial value of this property is
4479	<tt><</tt><link to="#settingsFilePath">
4480	path_to_settings_file</link><tt>>/<</tt>
4481	<link to="#id">machine_uuid</link>
4482	<tt>></tt>.
4483
4484	Currently, it is an error to try to change this property on
4485	a machine that has snapshots (because this would require to
4486	move possibly large files to a different location).
4487	A separate method will be available for this purpose later.
4488
4489	<note>
4490	Setting this property to @c null or to an empty string will restore
4491	the initial value.
4492	</note>
4493	<note>
4494	When setting this property, the specified path can be
4495	absolute (full path) or relative to the directory where the
4496	<link to="#settingsFilePath">machine settings file</link>
4497	is located. When reading this property, a full path is
4498	always returned.
4499	</note>
4500	<note>
4501	The specified path may not exist, it will be created
4502	when necessary.
4503	</note>
4504	</desc>
4505	</attribute>
4506
4507	<attribute name="VRDPServer" type="IVRDPServer" readonly="yes">
4508	<desc>VRDP server object.</desc>
4509	</attribute>
4510
4511	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4512	<desc>Array of media attached to this machine.</desc>
4513	</attribute>
4514
4515	<attribute name="USBController" type="IUSBController" readonly="yes">
4516	<desc>
4517	Associated USB controller object.
4518
4519	<note>
4520	If USB functionality is not available in the given edition of
4521	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4522	</note>
4523	</desc>
4524	</attribute>
4525
4526	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4527	<desc>Associated audio adapter, always present.</desc>
4528	</attribute>
4529
4530	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4531	<desc>Array of storage controllers attached to this machine.</desc>
4532	</attribute>
4533
4534	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4535	<desc>
4536	Full name of the file containing machine settings data.
4537	</desc>
4538	</attribute>
4539
4540	<attribute name="settingsModified" type="boolean" readonly="yes">
4541	<desc>
4542	Whether the settings of this machine have been modified
4543	(but neither yet saved nor discarded).
4544	<note>
4545	Reading this property is only valid on instances returned
4546	by <link to="ISession::machine"/> and on new machines
4547	created by <link to="IVirtualBox::createMachine"/> or opened
4548	by <link to="IVirtualBox::openMachine"/> but not
4549	yet registered, or on unregistered machines after calling
4550	<link to="IVirtualBox::unregisterMachine"/>. For all other
4551	cases, the settings can never be modified.
4552	</note>
4553	<note>
4554	For newly created unregistered machines, the value of this
4555	property is always @c true until <link to="#saveSettings"/>
4556	is called (no matter if any machine settings have been
4557	changed after the creation or not). For opened machines
4558	the value is set to @c false (and then follows to normal rules).
4559	</note>
4560	</desc>
4561	</attribute>
4562
4563	<attribute name="sessionState" type="SessionState" readonly="yes">
4564	<desc>Current session state for this machine.</desc>
4565	</attribute>
4566
4567	<attribute name="sessionType" type="wstring" readonly="yes">
4568	<desc>
4569	Type of the session. If <link to="#sessionState"/> is
4570	SessionSpawning or SessionOpen, this attribute contains the
4571	same value as passed to the
4572	<link to="IVirtualBox::openRemoteSession"/> method in the
4573	@a type parameter. If the session was opened directly using
4574	<link to="IVirtualBox::openSession"/>, or if
4575	<link to="#sessionState"/> is SessionClosed, the value of this
4576	attribute is an empty string.
4577	</desc>
4578	</attribute>
4579
4580	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4581	<desc>
4582	Identifier of the session process. This attribute contains the
4583	platform-dependent identifier of the process that has opened a
4584	direct session for this machine using the
4585	<link to="IVirtualBox::openSession"/> call. The returned value
4586	is only valid if <link to="#sessionState"/> is SessionOpen or
4587	SessionClosing (i.e. a session is currently open or being
4588	closed) by the time this property is read.
4589	</desc>
4590	</attribute>
4591
4592	<attribute name="state" type="MachineState" readonly="yes">
4593	<desc>Current execution state of this machine.</desc>
4594	</attribute>
4595
4596	<attribute name="lastStateChange" type="long long" readonly="yes">
4597	<desc>
4598	Time stamp of the last execution state change,
4599	in milliseconds since 1970-01-01 UTC.
4600	</desc>
4601	</attribute>
4602
4603	<attribute name="stateFilePath" type="wstring" readonly="yes">
4604	<desc>
4605	Full path to the file that stores the execution state of
4606	the machine when it is in the <link to="MachineState_Saved"/> state.
4607	<note>
4608	When the machine is not in the Saved state, this attribute is
4609	an empty string.
4610	</note>
4611	</desc>
4612	</attribute>
4613
4614	<attribute name="logFolder" type="wstring" readonly="yes">
4615	<desc>
4616	Full path to the folder that stores a set of rotated log files
4617	recorded during machine execution. The most recent log file is
4618	named <tt>VBox.log</tt>, the previous log file is
4619	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4620	in the current version).
4621	</desc>
4622	</attribute>
4623
4624	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4625	<desc>
4626	Current snapshot of this machine. This is @c null if the machine
4627	currently has no snapshots. If it is not @c null, then it was
4628	set by one of <link to="Console::takeSnapshot" />,
4629	<link to="Console::deleteSnapshot" />
4630	or <link to="Console::restoreSnapshot" />, depending on which
4631	was called last. See <link to="ISnapshot"/> for details.
4632	</desc>
4633	</attribute>
4634
4635	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4636	<desc>
4637	Number of snapshots taken on this machine. Zero means the
4638	machine doesn't have any snapshots.
4639	</desc>
4640	</attribute>
4641
4642	<attribute name="currentStateModified" type="boolean" readonly="yes">
4643	<desc>
4644	Returns @c true if the current state of the machine is not
4645	identical to the state stored in the current snapshot.
4646
4647	The current state is identical to the current snapshot only
4648	directly after one of the following calls are made:
4649
4650	<ul>
4651	<li><link to="IConsole::restoreSnapshot"/>
4652	</li>
4653	<li><link to="IConsole::takeSnapshot"/> (issued on a
4654	"powered off" or "saved" machine, for which
4655	<link to="#settingsModified"/> returns @c false)
4656	</li>
4657	<li><link to="IMachine::setCurrentSnapshot"/>
4658	</li>
4659	</ul>
4660
4661	The current state remains identical until one of the following
4662	happens:
4663	<ul>
4664	<li>settings of the machine are changed</li>
4665	<li>the saved state is deleted</li>
4666	<li>the current snapshot is deleted</li>
4667	<li>an attempt to execute the machine is made</li>
4668	</ul>
4669
4670	<note>
4671	For machines that don't have snapshots, this property is
4672	always @c false.
4673	</note>
4674	</desc>
4675	</attribute>
4676
4677	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4678	<desc>
4679	Collection of shared folders for this machine (permanent shared
4680	folders). These folders are shared automatically at machine startup
4681	and available only to the guest OS installed within this machine.
4682
4683	New shared folders are added to the collection using
4684	<link to="#createSharedFolder"/>. Existing shared folders can be
4685	removed using <link to="#removeSharedFolder"/>.
4686	</desc>
4687	</attribute>
4688
4689	<attribute name="clipboardMode" type="ClipboardMode">
4690	<desc>
4691	Synchronization mode between the host OS clipboard
4692	and the guest OS clipboard.
4693	</desc>
4694	</attribute>
4695
4696	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4697	<desc>
4698	A comma-separated list of simple glob patterns. Changes to guest
4699	properties whose name matches one of the patterns will generate an
4700	<link to="IVirtualBoxCallback::onGuestPropertyChange"/> signal.
4701	</desc>
4702	</attribute>
4703
4704	<attribute name="teleporterEnabled" type="boolean">
4705	<desc>
4706	When set to @a true, the virtual machine becomes a target teleporter
4707	the next time it is powered on. This can only set to @a true when the
4708	VM is in the @a PoweredOff or @a Aborted state.
4709
4710	<!-- This property is automatically set to @a false when the VM is powered
4711	on. (bird: This doesn't work yet ) -->
4712	</desc>
4713	</attribute>
4714
4715	<attribute name="teleporterPort" type="unsigned long">
4716	<desc>
4717	The TCP port the target teleporter will listen for incoming
4718	teleportations on.
4719
4720	0 means the port is automatically selected upon power on. The actual
4721	value can be read from this property while the machine is waiting for
4722	incoming teleportations.
4723	</desc>
4724	</attribute>
4725
4726	<attribute name="teleporterAddress" type="wstring">
4727	<desc>
4728	The address the target teleporter will listen on. If set to an empty
4729	string, it will listen on all addresses.
4730	</desc>
4731	</attribute>
4732
4733	<attribute name="teleporterPassword" type="wstring">
4734	<desc>
4735	The password the to check for on the target teleporter. This is just a
4736	very basic measure to prevent simple hacks and operators accidentally
4737	beaming a virtual machine to the wrong place.
4738	</desc>
4739	</attribute>
4740
4741	<attribute name="RTCUseUTC" type="boolean">
4742	<desc>
4743	When set to @a true, the RTC device of the virtual machine will run
4744	in UTC time, otherwise in local time. Especially Unix guests prefer
4745	the time in UTC.
4746	</desc>
4747	</attribute>
4748
4749	<attribute name="ioCacheEnabled" type="boolean">
4750	<desc>
4751	When set to @a true, the builtin I/O cache of the virtual machine
4752	will be enabled.
4753	</desc>
4754	</attribute>
4755
4756	<attribute name="ioCacheSize" type="unsigned long">
4757	<desc>
4758	Maximum size of the I/O cache in MB.
4759	</desc>
4760	</attribute>
4761
4762	<attribute name="ioBandwidthMax" type="unsigned long">
4763	<desc>
4764	The maximum number of MB the VM is allowed to transfer per second.
4765	0 means unlimited bandwidth.
4766	</desc>
4767	</attribute>
4768
4769	<method name="setBootOrder">
4770	<desc>
4771	Puts the given device to the specified position in
4772	the boot order.
4773
4774	To indicate that no device is associated with the given position,
4775	<link to="DeviceType_Null"/> should be used.
4776
4777	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4778
4779	<result name="E_INVALIDARG">
4780	Boot @a position out of range.
4781	</result>
4782	<result name="E_NOTIMPL">
4783	Booting from USB @a device currently not supported.
4784	</result>
4785
4786	</desc>
4787	<param name="position" type="unsigned long" dir="in">
4788	<desc>
4789	Position in the boot order (@c 1 to the total number of
4790	devices the machine can boot from, as returned by
4791	<link to="ISystemProperties::maxBootPosition"/>).
4792	</desc>
4793	</param>
4794	<param name="device" type="DeviceType" dir="in">
4795	<desc>
4796	The type of the device used to boot at the given position.
4797	</desc>
4798	</param>
4799	</method>
4800
4801	<method name="getBootOrder" const="yes">
4802	<desc>
4803	Returns the device type that occupies the specified
4804	position in the boot order.
4805
4806	@todo [remove?]
4807	If the machine can have more than one device of the returned type
4808	(such as hard disks), then a separate method should be used to
4809	retrieve the individual device that occupies the given position.
4810
4811	If here are no devices at the given position, then
4812	<link to="DeviceType_Null"/> is returned.
4813
4814	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4815
4816	<result name="E_INVALIDARG">
4817	Boot @a position out of range.
4818	</result>
4819
4820	</desc>
4821	<param name="position" type="unsigned long" dir="in">
4822	<desc>
4823	Position in the boot order (@c 1 to the total number of
4824	devices the machine can boot from, as returned by
4825	<link to="ISystemProperties::maxBootPosition"/>).
4826	</desc>
4827	</param>
4828	<param name="device" type="DeviceType" dir="return">
4829	<desc>
4830	Device at the given position.
4831	</desc>
4832	</param>
4833	</method>
4834
4835	<method name="attachDevice">
4836	<desc>
4837	Attaches a device and optionally mounts a medium to the given storage
4838	controller (<link to="IStorageController" />, identified by @a name),
4839	at the indicated port and device.
4840
4841	This method is intended for managing storage devices in general (it works
4842	for both fixed and removable media). For storage devices supporting removable
4843	media (such as DVDs and floppies), you can also use <link to="IMedium::mountMedium"/>
4844	for changing the media while the machine is running.
4845
4846	In a VM's default configuration of virtual machines, the secondary
4847	master of the IDE controller is used for a CD/DVD drive.
4848
4849	For fixed media such as hard disks, the given medium identifier cannot
4850	be a zero UUID. It may be a zero UUID for removable media such as DVDs
4851	and floppies.
4852
4853	After calling this returns successfully, a new instance of
4854	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4855	attachments (<link to="IMachine::mediumAttachments"/>).
4856
4857	The specified device slot must not have a device attached to it,
4858	or this method will fail.
4859
4860	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4861	information about attaching media.
4862
4863	<note>
4864	You cannot attach a device to a running machine. Also, you cannot
4865	attach a device to a newly created machine until this machine's
4866	settings are saved to disk using <link to="#saveSettings"/>.
4867	</note>
4868	<note>
4869	If the medium is being attached indirectly, a new differencing medium
4870	will implicitly be created for it and attached instead. If the
4871	changes made to the machine settings (including this indirect
4872	attachment) are later cancelled using <link to="#discardSettings"/>,
4873	this implicitly created differencing medium will implicitly
4874	be deleted.
4875	</note>
4876
4877	<result name="E_INVALIDARG">
4878	SATA device, SATA port, IDE port or IDE slot out of range.
4879	</result>
4880	<result name="VBOX_E_INVALID_OBJECT_STATE">
4881	Attempt to attach medium to an unregistered virtual machine.
4882	</result>
4883	<result name="VBOX_E_INVALID_VM_STATE">
4884	Invalid machine state.
4885	</result>
4886	<result name="VBOX_E_OBJECT_IN_USE">
4887	Hard disk already attached to this or another virtual machine.
4888	</result>
4889
4890	</desc>
4891	<param name="name" type="wstring" dir="in">
4892	<desc>Name of the storage controller to attach the device to.</desc>
4893	</param>
4894	<param name="controllerPort" type="long" dir="in">
4895	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4896	the primary controller and 1 specifies the secondary controller.
4897	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4898	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4899	</param>
4900	<param name="device" type="long" dir="in">
4901	<desc>Device slot in the given port to attach the device to. This is only
4902	relevant for IDE controllers, for which 0 specifies the master device and
4903	1 specifies the slave device. For all other controller types, this must
4904	be 0.</desc>
4905	</param>
4906	<param name="type" type="DeviceType" dir="in">
4907	<desc>Device type of the attached device.</desc>
4908	</param>
4909	<param name="id" type="uuid" mod="string" dir="in">
4910	<desc>UUID of the medium to mount. Zero UUID means do not mount any
4911	medium.</desc>
4912	</param>
4913	</method>
4914
4915	<method name="detachDevice">
4916	<desc>
4917	Detaches the device attached to a device slot of the specified bus.
4918
4919	Detaching the device from the virtual machine is deferred. This means
4920	that the medium remains associated with the machine when this method
4921	returns and gets actually de-associated only after a successful
4922	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4923	for more detailed information about attaching media.
4924
4925	<note>
4926	You cannot detach a device from a running machine.
4927	</note>
4928	<note>
4929	Detaching differencing media implicitly created by <link
4930	to="#attachDevice"/> for the indirect attachment using this
4931	method will <b>not</b> implicitly delete them. The
4932	<link to="IMedium::deleteStorage"/> operation should be
4933	explicitly performed by the caller after the medium is successfully
4934	detached and the settings are saved with
4935	<link to="#saveSettings"/>, if it is the desired action.
4936	</note>
4937
4938	<result name="VBOX_E_INVALID_VM_STATE">
4939	Attempt to detach medium from a running virtual machine.
4940	</result>
4941	<result name="VBOX_E_OBJECT_NOT_FOUND">
4942	No medium attached to given slot/bus.
4943	</result>
4944	<result name="VBOX_E_NOT_SUPPORTED">
4945	Medium format does not support storage deletion.
4946	</result>
4947
4948	</desc>
4949	<param name="name" type="wstring" dir="in">
4950	<desc>Name of the storage controller to detach the medium from.</desc>
4951	</param>
4952	<param name="controllerPort" type="long" dir="in">
4953	<desc>Port number to detach the medium from.</desc>
4954	</param>
4955	<param name="device" type="long" dir="in">
4956	<desc>Device slot number to detach the medium from.</desc>
4957	</param>
4958	</method>
4959
4960	<method name="passthroughDevice">
4961	<desc>
4962	Sets the passthrough mode of an existing DVD device. Changing the
4963	setting while the VM is running is forbidden. The setting is only used
4964	if at VM start the device is configured as a host DVD drive, in all
4965	other cases it is ignored. The device must already exist; see
4966	<link to="IMachine::attachDevice"/> for how to attach a new device.
4967
4968	The @a controllerPort and @a device parameters specify the device slot and
4969	have have the same meaning as with <link to="IMachine::attachDevice" />.
4970
4971	<result name="E_INVALIDARG">
4972	SATA device, SATA port, IDE port or IDE slot out of range.
4973	</result>
4974	<result name="VBOX_E_INVALID_OBJECT_STATE">
4975	Attempt to modify an unregistered virtual machine.
4976	</result>
4977	<result name="VBOX_E_INVALID_VM_STATE">
4978	Invalid machine state.
4979	</result>
4980
4981	</desc>
4982	<param name="name" type="wstring" dir="in">
4983	<desc>Name of the storage controller.</desc>
4984	</param>
4985	<param name="controllerPort" type="long" dir="in">
4986	<desc>Storage controller port.</desc>
4987	</param>
4988	<param name="device" type="long" dir="in">
4989	<desc>Device slot in the given port.</desc>
4990	</param>
4991	<param name="passthrough" type="boolean" dir="in">
4992	<desc>New value for the passthrough setting.</desc>
4993	</param>
4994	</method>
4995
4996	<method name="mountMedium">
4997	<desc>
4998	Mounts a medium (<link to="IMedium" />, identified
4999	by the given UUID @a id) to the given storage controller
5000	(<link to="IStorageController" />, identified by @a name),
5001	at the indicated port and device. The device must already exist;
5002	see <link to="IMachine::attachDevice"/> for how to attach a new device.
5003
5004	This method is intended only for managing removable media, where the
5005	device is fixed but media is changeable at runtime (such as DVDs
5006	and floppies). It cannot be used for fixed media such as hard disks.
5007
5008	The @a controllerPort and @a device parameters specify the device slot and
5009	have have the same meaning as with <link to="IMachine::attachDevice" />.
5010
5011	The specified device slot can have a medium mounted, which will be
5012	unmounted first. Specifying a zero UUID (or an empty string) for
5013	@a medium does just an unmount.
5014
5015	See <link to="IMedium"/> for more detailed information about
5016	attaching media.
5017
5018	<result name="E_INVALIDARG">
5019	SATA device, SATA port, IDE port or IDE slot out of range.
5020	</result>
5021	<result name="VBOX_E_INVALID_OBJECT_STATE">
5022	Attempt to attach medium to an unregistered virtual machine.
5023	</result>
5024	<result name="VBOX_E_INVALID_VM_STATE">
5025	Invalid machine state.
5026	</result>
5027	<result name="VBOX_E_OBJECT_IN_USE">
5028	Medium already attached to this or another virtual machine.
5029	</result>
5030
5031	</desc>
5032	<param name="name" type="wstring" dir="in">
5033	<desc>Name of the storage controller to attach the medium to.</desc>
5034	</param>
5035	<param name="controllerPort" type="long" dir="in">
5036	<desc>Port to attach the medium to.</desc>
5037	</param>
5038	<param name="device" type="long" dir="in">
5039	<desc>Device slot in the given port to attach the medium to.</desc>
5040	</param>
5041	<param name="medium" type="uuid" mod="string" dir="in">
5042	<desc>UUID of the medium to attach. A zero UUID means unmount the
5043	currently mounted medium.</desc>
5044	</param>
5045	<param name="force" type="boolean" dir="in">
5046	<desc>Allows to force unmount/mount of a medium which is locked by
5047	theDevice slot in the given port to attach the medium to.</desc>
5048	</param>
5049	</method>
5050
5051	<method name="getMedium" const="yes">
5052	<desc>
5053	Returns the virtual medium attached to a device slot of the specified
5054	bus.
5055
5056	Note that if the medium was indirectly attached by
5057	<link to="#mountMedium"/> to the given device slot then this
5058	method will return not the same object as passed to the
5059	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5060	more detailed information about mounting a medium.
5061
5062	<result name="VBOX_E_OBJECT_NOT_FOUND">
5063	No medium attached to given slot/bus.
5064	</result>
5065
5066	</desc>
5067	<param name="name" type="wstring" dir="in">
5068	<desc>Name of the storage controller the medium is attached to.</desc>
5069	</param>
5070	<param name="controllerPort" type="long" dir="in">
5071	<desc>Port to query.</desc>
5072	</param>
5073	<param name="device" type="long" dir="in">
5074	<desc>Device slot in the given port to query.</desc>
5075	</param>
5076	<param name="medium" type="IMedium" dir="return">
5077	<desc>Attached medium object.</desc>
5078	</param>
5079	</method>
5080
5081	<method name="getMediumAttachmentsOfController" const="yes">
5082	<desc>
5083	Returns an array of medium attachments which are attached to the
5084	the controller with the given name.
5085
5086	<result name="VBOX_E_OBJECT_NOT_FOUND">
5087	A storage controller with given name doesn't exist.
5088	</result>
5089	</desc>
5090	<param name="name" type="wstring" dir="in"/>
5091	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5092	</method>
5093
5094	<method name="getMediumAttachment" const="yes">
5095	<desc>
5096	Returns a medium attachment which corresponds to the controller with
5097	the given name, on the given port and device slot.
5098
5099	<result name="VBOX_E_OBJECT_NOT_FOUND">
5100	No attachment exists for the given controller/port/device combination.
5101	</result>
5102	</desc>
5103	<param name="name" type="wstring" dir="in"/>
5104	<param name="controllerPort" type="long" dir="in"/>
5105	<param name="device" type="long" dir="in"/>
5106	<param name="attachment" type="IMediumAttachment" dir="return"/>
5107	</method>
5108
5109	<method name="getNetworkAdapter" const="yes">
5110	<desc>
5111	Returns the network adapter associated with the given slot.
5112	Slots are numbered sequentially, starting with zero. The total
5113	number of adapters per machine is defined by the
5114	<link to="ISystemProperties::networkAdapterCount"/> property,
5115	so the maximum slot number is one less than that property's value.
5116
5117	<result name="E_INVALIDARG">
5118	Invalid @a slot number.
5119	</result>
5120
5121	</desc>
5122	<param name="slot" type="unsigned long" dir="in"/>
5123	<param name="adapter" type="INetworkAdapter" dir="return"/>
5124	</method>
5125
5126	<method name="addStorageController">
5127	<desc>
5128	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5129	machine and returns it as an instance of
5130	<link to="IStorageController" />.
5131
5132	@a name identifies the controller for subsequent calls such as
5133	<link to="#getStorageControllerByName" />,
5134	<link to="#getStorageControllerByInstance" />,
5135	<link to="#removeStorageController" />,
5136	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5137
5138	After the controller has been added, you can set its exact
5139	type by setting the <link to="IStorageController::controllerType" />.
5140
5141	<result name="VBOX_E_OBJECT_IN_USE">
5142	A storage controller with given name exists already.
5143	</result>
5144	<result name="E_INVALIDARG">
5145	Invalid @a controllerType.
5146	</result>
5147	</desc>
5148	<param name="name" type="wstring" dir="in"/>
5149	<param name="connectionType" type="StorageBus" dir="in"/>
5150	<param name="controller" type="IStorageController" dir="return"/>
5151	</method>
5152
5153	<method name="getStorageControllerByName" const="yes">
5154	<desc>
5155	Returns a storage controller with the given name.
5156
5157	<result name="VBOX_E_OBJECT_NOT_FOUND">
5158	A storage controller with given name doesn't exist.
5159	</result>
5160	</desc>
5161	<param name="name" type="wstring" dir="in"/>
5162	<param name="storageController" type="IStorageController" dir="return"/>
5163	</method>
5164
5165	<method name="getStorageControllerByInstance" const="yes">
5166	<desc>
5167	Returns a storage controller with the given instance number.
5168
5169	<result name="VBOX_E_OBJECT_NOT_FOUND">
5170	A storage controller with given instance number doesn't exist.
5171	</result>
5172	</desc>
5173	<param name="instance" type="unsigned long" dir="in"/>
5174	<param name="storageController" type="IStorageController" dir="return"/>
5175	</method>
5176
5177	<method name="removeStorageController">
5178	<desc>
5179	Removes a storage controller from the machine.
5180
5181	<result name="VBOX_E_OBJECT_NOT_FOUND">
5182	A storage controller with given name doesn't exist.
5183	</result>
5184	</desc>
5185	<param name="name" type="wstring" dir="in"/>
5186	</method>
5187
5188	<method name="getSerialPort" const="yes">
5189	<desc>
5190	Returns the serial port associated with the given slot.
5191	Slots are numbered sequentially, starting with zero. The total
5192	number of serial ports per machine is defined by the
5193	<link to="ISystemProperties::serialPortCount"/> property,
5194	so the maximum slot number is one less than that property's value.
5195
5196	<result name="E_INVALIDARG">
5197	Invalid @a slot number.
5198	</result>
5199
5200	</desc>
5201	<param name="slot" type="unsigned long" dir="in"/>
5202	<param name="port" type="ISerialPort" dir="return"/>
5203	</method>
5204
5205	<method name="getParallelPort" const="yes">
5206	<desc>
5207	Returns the parallel port associated with the given slot.
5208	Slots are numbered sequentially, starting with zero. The total
5209	number of parallel ports per machine is defined by the
5210	<link to="ISystemProperties::parallelPortCount"/> property,
5211	so the maximum slot number is one less than that property's value.
5212
5213	<result name="E_INVALIDARG">
5214	Invalid @a slot number.
5215	</result>
5216
5217	</desc>
5218	<param name="slot" type="unsigned long" dir="in"/>
5219	<param name="port" type="IParallelPort" dir="return"/>
5220	</method>
5221
5222	<method name="getExtraDataKeys">
5223	<desc>
5224	Returns an array representing the machine-specific extra data keys
5225	which currently have values defined.
5226	</desc>
5227	<param name="value" type="wstring" dir="return" safearray="yes">
5228	<desc>Array of extra data keys.</desc>
5229	</param>
5230	</method>
5231
5232	<method name="getExtraData">
5233	<desc>
5234	Returns associated machine-specific extra data.
5235
5236	If the requested data @a key does not exist, this function will
5237	succeed and return an empty string in the @a value argument.
5238
5239	<result name="VBOX_E_FILE_ERROR">
5240	Settings file not accessible.
5241	</result>
5242	<result name="VBOX_E_XML_ERROR">
5243	Could not parse the settings file.
5244	</result>
5245
5246	</desc>
5247	<param name="key" type="wstring" dir="in">
5248	<desc>Name of the data key to get.</desc>
5249	</param>
5250	<param name="value" type="wstring" dir="return">
5251	<desc>Value of the requested data key.</desc>
5252	</param>
5253	</method>
5254
5255	<method name="setExtraData">
5256	<desc>
5257	Sets associated machine-specific extra data.
5258
5259	If you pass @c null or an empty string as a key @a value, the given
5260	@a key will be deleted.
5261
5262	<note>
5263	Before performing the actual data change, this method will ask all
5264	registered callbacks using the
5265	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
5266	notification for a permission. If one of the callbacks refuses the
5267	new value, the change will not be performed.
5268	</note>
5269	<note>
5270	On success, the
5271	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
5272	is called to inform all registered callbacks about a successful data
5273	change.
5274	</note>
5275	<note>
5276	This method can be called outside the machine session and therefore
5277	it's a caller's responsibility to handle possible race conditions
5278	when several clients change the same key at the same time.
5279	</note>
5280
5281	<result name="VBOX_E_FILE_ERROR">
5282	Settings file not accessible.
5283	</result>
5284	<result name="VBOX_E_XML_ERROR">
5285	Could not parse the settings file.
5286	</result>
5287
5288	</desc>
5289	<param name="key" type="wstring" dir="in">
5290	<desc>Name of the data key to set.</desc>
5291	</param>
5292	<param name="value" type="wstring" dir="in">
5293	<desc>Value to assign to the key.</desc>
5294	</param>
5295	</method>
5296
5297	<method name="getCPUProperty" const="yes">
5298	<desc>
5299	Returns the virtual CPU boolean value of the specified property.
5300
5301	<result name="E_INVALIDARG">
5302	Invalid property.
5303	</result>
5304
5305	</desc>
5306	<param name="property" type="CPUPropertyType" dir="in">
5307	<desc>
5308	Property type to query.
5309	</desc>
5310	</param>
5311	<param name="value" type="boolean" dir="return">
5312	<desc>
5313	Property value.
5314	</desc>
5315	</param>
5316	</method>
5317
5318	<method name="setCPUProperty">
5319	<desc>
5320	Sets the virtual CPU boolean value of the specified property.
5321
5322	<result name="E_INVALIDARG">
5323	Invalid property.
5324	</result>
5325
5326	</desc>
5327	<param name="property" type="CPUPropertyType" dir="in">
5328	<desc>
5329	Property type to query.
5330	</desc>
5331	</param>
5332	<param name="value" type="boolean" dir="in">
5333	<desc>
5334	Property value.
5335	</desc>
5336	</param>
5337	</method>
5338
5339	<method name="getCPUIDLeaf" const="yes">
5340	<desc>
5341	Returns the virtual CPU cpuid information for the specified leaf.
5342
5343	Currently supported index values for cpuid:
5344	Standard CPUID leafs: 0 - 0xA
5345	Extended CPUID leafs: 0x80000000 - 0x8000000A
5346
5347	See the Intel and AMD programmer's manuals for detailed information
5348	about the cpuid instruction and its leafs.
5349	<result name="E_INVALIDARG">
5350	Invalid id.
5351	</result>
5352
5353	</desc>
5354	<param name="id" type="unsigned long" dir="in">
5355	<desc>
5356	CPUID leaf index.
5357	</desc>
5358	</param>
5359	<param name="valEax" type="unsigned long" dir="out">
5360	<desc>
5361	CPUID leaf value for register eax.
5362	</desc>
5363	</param>
5364	<param name="valEbx" type="unsigned long" dir="out">
5365	<desc>
5366	CPUID leaf value for register ebx.
5367	</desc>
5368	</param>
5369	<param name="valEcx" type="unsigned long" dir="out">
5370	<desc>
5371	CPUID leaf value for register ecx.
5372	</desc>
5373	</param>
5374	<param name="valEdx" type="unsigned long" dir="out">
5375	<desc>
5376	CPUID leaf value for register edx.
5377	</desc>
5378	</param>
5379	</method>
5380
5381	<method name="setCPUIDLeaf">
5382	<desc>
5383	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5384	are not passed unmodified. VirtualBox clears features that it doesn't support.
5385
5386	Currently supported index values for cpuid:
5387	Standard CPUID leafs: 0 - 0xA
5388	Extended CPUID leafs: 0x80000000 - 0x8000000A
5389
5390	See the Intel and AMD programmer's manuals for detailed information
5391	about the cpuid instruction and its leafs.
5392
5393	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5394	random crashes inside VMs.
5395	<result name="E_INVALIDARG">
5396	Invalid id.
5397	</result>
5398
5399	</desc>
5400	<param name="id" type="unsigned long" dir="in">
5401	<desc>
5402	CPUID leaf index.
5403	</desc>
5404	</param>
5405	<param name="valEax" type="unsigned long" dir="in">
5406	<desc>
5407	CPUID leaf value for register eax.
5408	</desc>
5409	</param>
5410	<param name="valEbx" type="unsigned long" dir="in">
5411	<desc>
5412	CPUID leaf value for register ebx.
5413	</desc>
5414	</param>
5415	<param name="valEcx" type="unsigned long" dir="in">
5416	<desc>
5417	CPUID leaf value for register ecx.
5418	</desc>
5419	</param>
5420	<param name="valEdx" type="unsigned long" dir="in">
5421	<desc>
5422	CPUID leaf value for register edx.
5423	</desc>
5424	</param>
5425	</method>
5426
5427	<method name="removeCPUIDLeaf">
5428	<desc>
5429	Removes the virtual CPU cpuid leaf for the specified index
5430
5431	<result name="E_INVALIDARG">
5432	Invalid id.
5433	</result>
5434
5435	</desc>
5436	<param name="id" type="unsigned long" dir="in">
5437	<desc>
5438	CPUID leaf index.
5439	</desc>
5440	</param>
5441	</method>
5442
5443	<method name="removeAllCPUIDLeaves">
5444	<desc>
5445	Removes all the virtual CPU cpuid leaves
5446	</desc>
5447	</method>
5448
5449	<method name="getHWVirtExProperty" const="yes">
5450	<desc>
5451	Returns the value of the specified hardware virtualization boolean property.
5452
5453	<result name="E_INVALIDARG">
5454	Invalid property.
5455	</result>
5456
5457	</desc>
5458	<param name="property" type="HWVirtExPropertyType" dir="in">
5459	<desc>
5460	Property type to query.
5461	</desc>
5462	</param>
5463	<param name="value" type="boolean" dir="return">
5464	<desc>
5465	Property value.
5466	</desc>
5467	</param>
5468	</method>
5469
5470	<method name="setHWVirtExProperty">
5471	<desc>
5472	Sets a new value for the specified hardware virtualization boolean property.
5473
5474	<result name="E_INVALIDARG">
5475	Invalid property.
5476	</result>
5477
5478	</desc>
5479	<param name="property" type="HWVirtExPropertyType" dir="in">
5480	<desc>
5481	Property type to set.
5482	</desc>
5483	</param>
5484	<param name="value" type="boolean" dir="in">
5485	<desc>
5486	New property value.
5487	</desc>
5488	</param>
5489	</method>
5490
5491	<method name="saveSettings">
5492	<desc>
5493	Saves any changes to machine settings made since the session
5494	has been opened or a new machine has been created, or since the
5495	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5496	For registered machines, new settings become visible to all
5497	other VirtualBox clients after successful invocation of this
5498	method.
5499	<note>
5500	The method sends <link to="IVirtualBoxCallback::onMachineDataChange"/>
5501	notification event after the configuration has been successfully
5502	saved (only for registered machines).
5503	</note>
5504	<note>
5505	Calling this method is only valid on instances returned
5506	by <link to="ISession::machine"/> and on new machines
5507	created by <link to="IVirtualBox::createMachine"/> but not
5508	yet registered, or on unregistered machines after calling
5509	<link to="IVirtualBox::unregisterMachine"/>.
5510	</note>
5511
5512	<result name="VBOX_E_FILE_ERROR">
5513	Settings file not accessible.
5514	</result>
5515	<result name="VBOX_E_XML_ERROR">
5516	Could not parse the settings file.
5517	</result>
5518	<result name="E_ACCESSDENIED">
5519	Modification request refused.
5520	</result>
5521
5522	</desc>
5523	</method>
5524
5525	<method name="discardSettings">
5526	<desc>
5527	Discards any changes to the machine settings made since the session
5528	has been opened or since the last call to <link to="#saveSettings"/>
5529	or <link to="#discardSettings"/>.
5530	<note>
5531	Calling this method is only valid on instances returned
5532	by <link to="ISession::machine"/> and on new machines
5533	created by <link to="IVirtualBox::createMachine"/> or
5534	opened by <link to="IVirtualBox::openMachine"/> but not
5535	yet registered, or on unregistered machines after calling
5536	<link to="IVirtualBox::unregisterMachine"/>.
5537	</note>
5538
5539	<result name="VBOX_E_INVALID_VM_STATE">
5540	Virtual machine is not mutable.
5541	</result>
5542
5543	</desc>
5544	</method>
5545
5546	<method name="deleteSettings">
5547	<desc>
5548	Deletes the settings file of this machine from disk.
5549	The machine must not be registered in order for this operation
5550	to succeed.
5551	<note>
5552	<link to="#settingsModified"/> will return @c true after this
5553	method successfully returns.
5554	</note>
5555	<note>
5556	Calling this method is only valid on instances returned
5557	by <link to="ISession::machine"/> and on new machines
5558	created by <link to="IVirtualBox::createMachine"/> or
5559	opened by <link to="IVirtualBox::openMachine"/> but not
5560	yet registered, or on unregistered machines after calling
5561	<link to="IVirtualBox::unregisterMachine"/>.
5562	</note>
5563	<note>
5564	The deleted machine settings file can be restored (saved again)
5565	by calling <link to="#saveSettings"/>.
5566	</note>
5567
5568	<result name="VBOX_E_INVALID_VM_STATE">
5569	Cannot delete settings of a registered machine or
5570	machine not mutable.
5571	</result>
5572	<result name="VBOX_E_IPRT_ERROR">
5573	Could not delete the settings file.
5574	</result>
5575
5576	</desc>
5577	</method>
5578
5579	<method name="export">
5580	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5581	steps required to export VirtualBox machines to OVF.
5582	</desc>
5583
5584	<param name="aAppliance" type="IAppliance" dir="in">
5585	<desc>Appliance to export this machine to.</desc>
5586	</param>
5587	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5588	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5589	</param>
5590	</method >
5591
5592	<method name="getSnapshot">
5593	<desc>
5594	Returns a snapshot of this machine with the given UUID.
5595	A @c null UUID can be used to obtain the first snapshot
5596	taken on this machine. This is useful if you want to traverse
5597	the whole tree of snapshots starting from the root.
5598
5599	<result name="VBOX_E_OBJECT_NOT_FOUND">
5600	Virtual machine has no snapshots or snapshot not found.
5601	</result>
5602
5603	</desc>
5604	<param name="id" type="uuid" mod="string" dir="in">
5605	<desc>UUID of the snapshot to get</desc>
5606	</param>
5607	<param name="snapshot" type="ISnapshot" dir="return">
5608	<desc>Snapshot object with the given UUID.</desc>
5609	</param>
5610	</method>
5611
5612	<method name="findSnapshot">
5613	<desc>
5614	Returns a snapshot of this machine with the given name.
5615
5616	<result name="VBOX_E_OBJECT_NOT_FOUND">
5617	Virtual machine has no snapshots or snapshot not found.
5618	</result>
5619
5620	</desc>
5621	<param name="name" type="wstring" dir="in">
5622	<desc>Name of the snapshot to find</desc>
5623	</param>
5624	<param name="snapshot" type="ISnapshot" dir="return">
5625	<desc>Snapshot object with the given name.</desc>
5626	</param>
5627	</method>
5628
5629	<method name="setCurrentSnapshot">
5630	<desc>
5631	Sets the current snapshot of this machine.
5632	<note>
5633	In the current implementation, this operation is not
5634	implemented.
5635	</note>
5636	</desc>
5637	<param name="id" type="uuid" mod="string" dir="in">
5638	<desc>UUID of the snapshot to set as the current snapshot.</desc>
5639	</param>
5640	</method>
5641
5642	<method name="createSharedFolder">
5643	<desc>
5644	Creates a new permanent shared folder by associating the given logical
5645	name with the given host path, adds it to the collection of shared
5646	folders and starts sharing it. Refer to the description of
5647	<link to="ISharedFolder"/> to read more about logical names.
5648
5649	<result name="VBOX_E_OBJECT_IN_USE">
5650	Shared folder already exists.
5651	</result>
5652	<result name="VBOX_E_FILE_ERROR">
5653	Shared folder @a hostPath not accessible.
5654	</result>
5655
5656	</desc>
5657	<param name="name" type="wstring" dir="in">
5658	<desc>Unique logical name of the shared folder.</desc>
5659	</param>
5660	<param name="hostPath" type="wstring" dir="in">
5661	<desc>Full path to the shared folder in the host file system.</desc>
5662	</param>
5663	<param name="writable" type="boolean" dir="in">
5664	<desc>Whether the share is writable or readonly</desc>
5665	</param>
5666	</method>
5667
5668	<method name="removeSharedFolder">
5669	<desc>
5670	Removes the permanent shared folder with the given name previously
5671	created by <link to="#createSharedFolder"/> from the collection of
5672	shared folders and stops sharing it.
5673
5674	<result name="VBOX_E_INVALID_VM_STATE">
5675	Virtual machine is not mutable.
5676	</result>
5677	<result name="VBOX_E_OBJECT_NOT_FOUND">
5678	Shared folder @a name does not exist.
5679	</result>
5680
5681	</desc>
5682	<param name="name" type="wstring" dir="in">
5683	<desc>Logical name of the shared folder to remove.</desc>
5684	</param>
5685	</method>
5686
5687	<method name="canShowConsoleWindow">
5688	<desc>
5689	Returns @c true if the VM console process can activate the
5690	console window and bring it to foreground on the desktop of
5691	the host PC.
5692	<note>
5693	This method will fail if a session for this machine is not
5694	currently open.
5695	</note>
5696
5697	<result name="VBOX_E_INVALID_VM_STATE">
5698	Machine session is not open.
5699	</result>
5700
5701	</desc>
5702	<param name="canShow" type="boolean" dir="return">
5703	<desc>
5704	@c true if the console window can be shown and @c false otherwise.
5705	</desc>
5706	</param>
5707	</method>
5708
5709	<method name="showConsoleWindow">
5710	<desc>
5711	Activates the console window and brings it to foreground on
5712	the desktop of the host PC. Many modern window managers on
5713	many platforms implement some sort of focus stealing
5714	prevention logic, so that it may be impossible to activate
5715	a window without the help of the currently active
5716	application. In this case, this method will return a non-zero
5717	identifier that represents the top-level window of the VM
5718	console process. The caller, if it represents a currently
5719	active process, is responsible to use this identifier (in a
5720	platform-dependent manner) to perform actual window
5721	activation.
5722	<note>
5723	This method will fail if a session for this machine is not
5724	currently open.
5725	</note>
5726
5727	<result name="VBOX_E_INVALID_VM_STATE">
5728	Machine session is not open.
5729	</result>
5730
5731	</desc>
5732	<param name="winId" type="unsigned long long" dir="return">
5733	<desc>
5734	Platform-dependent identifier of the top-level VM console
5735	window, or zero if this method has performed all actions
5736	necessary to implement the <i>show window</i> semantics for
5737	the given platform and/or VirtualBox front-end.
5738	</desc>
5739	</param>
5740	</method>
5741
5742	<method name="getGuestProperty" const="yes">
5743	<desc>
5744	Reads an entry from the machine's guest property store.
5745
5746	<result name="VBOX_E_INVALID_VM_STATE">
5747	Machine session is not open.
5748	</result>
5749
5750	</desc>
5751	<param name="name" type="wstring" dir="in">
5752	<desc>
5753	The name of the property to read.
5754	</desc>
5755	</param>
5756	<param name="value" type="wstring" dir="out">
5757	<desc>
5758	The value of the property. If the property does not exist then this
5759	will be empty.
5760	</desc>
5761	</param>
5762	<param name="timestamp" type="unsigned long long" dir="out">
5763	<desc>
5764	The time at which the property was last modified, as seen by the
5765	server process.
5766	</desc>
5767	</param>
5768	<param name="flags" type="wstring" dir="out">
5769	<desc>
5770	Additional property parameters, passed as a comma-separated list of
5771	"name=value" type entries.
5772	</desc>
5773	</param>
5774	</method>
5775
5776	<method name="getGuestPropertyValue" const="yes">
5777	<desc>
5778	Reads a value from the machine's guest property store.
5779
5780	<result name="VBOX_E_INVALID_VM_STATE">
5781	Machine session is not open.
5782	</result>
5783
5784	</desc>
5785	<param name="property" type="wstring" dir="in">
5786	<desc>
5787	The name of the property to read.
5788	</desc>
5789	</param>
5790	<param name="value" type="wstring" dir="return">
5791	<desc>
5792	The value of the property. If the property does not exist then this
5793	will be empty.
5794	</desc>
5795	</param>
5796	</method>
5797
5798	<method name="getGuestPropertyTimestamp" const="yes">
5799	<desc>
5800	Reads a property timestamp from the machine's guest property store.
5801
5802	<result name="VBOX_E_INVALID_VM_STATE">
5803	Machine session is not open.
5804	</result>
5805
5806	</desc>
5807	<param name="property" type="wstring" dir="in">
5808	<desc>
5809	The name of the property to read.
5810	</desc>
5811	</param>
5812	<param name="value" type="unsigned long long" dir="return">
5813	<desc>
5814	The timestamp. If the property does not exist then this will be
5815	empty.
5816	</desc>
5817	</param>
5818	</method>
5819
5820	<method name="setGuestProperty">
5821	<desc>
5822	Sets, changes or deletes an entry in the machine's guest property
5823	store.
5824
5825	<result name="E_ACCESSDENIED">
5826	Property cannot be changed.
5827	</result>
5828	<result name="E_INVALIDARG">
5829	Invalid @a flags.
5830	</result>
5831	<result name="VBOX_E_INVALID_VM_STATE">
5832	Virtual machine is not mutable or session not open.
5833	</result>
5834	<result name="VBOX_E_INVALID_OBJECT_STATE">
5835	Cannot set transient property when machine not running.
5836	</result>
5837
5838	</desc>
5839	<param name="property" type="wstring" dir="in">
5840	<desc>
5841	The name of the property to set, change or delete.
5842	</desc>
5843	</param>
5844	<param name="value" type="wstring" dir="in">
5845	<desc>
5846	The new value of the property to set, change or delete. If the
5847	property does not yet exist and value is non-empty, it will be
5848	created. If the value is @c null or empty, the property will be
5849	deleted if it exists.
5850	</desc>
5851	</param>
5852	<param name="flags" type="wstring" dir="in">
5853	<desc>
5854	Additional property parameters, passed as a comma-separated list of
5855	"name=value" type entries.
5856	</desc>
5857	</param>
5858	</method>
5859
5860	<method name="setGuestPropertyValue">
5861	<desc>
5862	Sets, changes or deletes a value in the machine's guest property
5863	store. The flags field will be left unchanged or created empty for a
5864	new property.
5865
5866	<result name="E_ACCESSDENIED">
5867	Property cannot be changed.
5868	</result>
5869	<result name="VBOX_E_INVALID_VM_STATE">
5870	Virtual machine is not mutable or session not open.
5871	</result>
5872	<result name="VBOX_E_INVALID_OBJECT_STATE">
5873	Cannot set transient property when machine not running.
5874	</result>
5875	</desc>
5876
5877	<param name="property" type="wstring" dir="in">
5878	<desc>
5879	The name of the property to set, change or delete.
5880	</desc>
5881	</param>
5882	<param name="value" type="wstring" dir="in">
5883	<desc>
5884	The new value of the property to set, change or delete. If the
5885	property does not yet exist and value is non-empty, it will be
5886	created. If the value is @c null or empty, the property will be
5887	deleted if it exists.
5888	</desc>
5889	</param>
5890	</method>
5891
5892	<method name="enumerateGuestProperties">
5893	<desc>
5894	Return a list of the guest properties matching a set of patterns along
5895	with their values, time stamps and flags.
5896	</desc>
5897	<param name="patterns" type="wstring" dir="in">
5898	<desc>
5899	The patterns to match the properties against, separated by '\|'
5900	characters. If this is empty or @c null, all properties will match.
5901	</desc>
5902	</param>
5903	<param name="name" type="wstring" dir="out" safearray="yes">
5904	<desc>
5905	The names of the properties returned.
5906	</desc>
5907	</param>
5908	<param name="value" type="wstring" dir="out" safearray="yes">
5909	<desc>
5910	The values of the properties returned. The array entries match the
5911	corresponding entries in the @a name array.
5912	</desc>
5913	</param>
5914	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
5915	<desc>
5916	The time stamps of the properties returned. The array entries match
5917	the corresponding entries in the @a name array.
5918	</desc>
5919	</param>
5920	<param name="flags" type="wstring" dir="out" safearray="yes">
5921	<desc>
5922	The flags of the properties returned. The array entries match the
5923	corresponding entries in the @a name array.
5924	</desc>
5925	</param>
5926	</method>
5927
5928	<method name="querySavedThumbnailSize">
5929	<desc>
5930	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5931	</desc>
5932	<param name="screenId" type="unsigned long" dir="in">
5933	<desc>
5934	Saved guest screen to query info from.
5935	</desc>
5936	</param>
5937	<param name="size" type="unsigned long" dir="out">
5938	<desc>
5939	Size of buffer required to store the bitmap.
5940	</desc>
5941	</param>
5942	<param name="width" type="unsigned long" dir="out">
5943	<desc>
5944	Bitmap width.
5945	</desc>
5946	</param>
5947	<param name="height" type="unsigned long" dir="out">
5948	<desc>
5949	Bitmap height.
5950	</desc>
5951	</param>
5952	</method>
5953
5954	<method name="readSavedThumbnailToArray">
5955	<desc>
5956	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5957	</desc>
5958	<param name="screenId" type="unsigned long" dir="in">
5959	<desc>
5960	Saved guest screen to read from.
5961	</desc>
5962	</param>
5963	<param name="BGR" type="boolean" dir="in">
5964	<desc>
5965	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5966	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5967	</desc>
5968	</param>
5969	<param name="width" type="unsigned long" dir="out">
5970	<desc>
5971	Bitmap width.
5972	</desc>
5973	</param>
5974	<param name="height" type="unsigned long" dir="out">
5975	<desc>
5976	Bitmap height.
5977	</desc>
5978	</param>
5979	<param name="data" type="octet" dir="return" safearray="yes">
5980	<desc>
5981	Array with resulting bitmap data.
5982	</desc>
5983	</param>
5984	</method>
5985
5986	<method name="querySavedScreenshotPNGSize">
5987	<desc>
5988	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5989	</desc>
5990	<param name="screenId" type="unsigned long" dir="in">
5991	<desc>
5992	Saved guest screen to query info from.
5993	</desc>
5994	</param>
5995	<param name="size" type="unsigned long" dir="out">
5996	<desc>
5997	Size of buffer required to store the PNG binary data.
5998	</desc>
5999	</param>
6000	<param name="width" type="unsigned long" dir="out">
6001	<desc>
6002	Image width.
6003	</desc>
6004	</param>
6005	<param name="height" type="unsigned long" dir="out">
6006	<desc>
6007	Image height.
6008	</desc>
6009	</param>
6010	</method>
6011
6012	<method name="readSavedScreenshotPNGToArray">
6013	<desc>
6014	Screenshot in PNG format is retrieved to an array of bytes.
6015	</desc>
6016	<param name="screenId" type="unsigned long" dir="in">
6017	<desc>
6018	Saved guest screen to read from.
6019	</desc>
6020	</param>
6021	<param name="width" type="unsigned long" dir="out">
6022	<desc>
6023	Image width.
6024	</desc>
6025	</param>
6026	<param name="height" type="unsigned long" dir="out">
6027	<desc>
6028	Image height.
6029	</desc>
6030	</param>
6031	<param name="data" type="octet" dir="return" safearray="yes">
6032	<desc>
6033	Array with resulting PNG data.
6034	</desc>
6035	</param>
6036	</method>
6037
6038	<method name="hotPlugCPU">
6039	<desc>
6040	Plugs a CPU into the machine.
6041	</desc>
6042	<param name="cpu" type="unsigned long" dir="in">
6043	<desc>
6044	The CPU id to insert.
6045	</desc>
6046	</param>
6047	</method>
6048
6049	<method name="hotUnplugCPU">
6050	<desc>
6051	Removes a CPU from the machine.
6052	</desc>
6053	<param name="cpu" type="unsigned long" dir="in">
6054	<desc>
6055	The CPU id to remove.
6056	</desc>
6057	</param>
6058	</method>
6059
6060	<method name="getCPUStatus">
6061	<desc>
6062	Returns the current status of the given CPU.
6063	</desc>
6064	<param name="cpu" type="unsigned long" dir="in">
6065	<desc>
6066	The CPU id to check for.
6067	</desc>
6068	</param>
6069	<param name="attached" type="boolean" dir="return">
6070	<desc>
6071	Status of the CPU.
6072	</desc>
6073	</param>
6074	</method>
6075
6076	<method name="queryLogFilename">
6077	<desc>
6078	Queries for the VM log file name of an given index. Returns an empty
6079	string if a log file with that index doesn't exists.
6080	</desc>
6081	<param name="idx" type="unsigned long" dir="in">
6082	<desc>
6083	Which log file name to query. 0=current log file.
6084	</desc>
6085	</param>
6086	<param name="filename" type="wstring" dir="return">
6087	<desc>
6088	On return the full path to the log file or an empty string on error.
6089	</desc>
6090	</param>
6091	</method>
6092
6093	<method name="readLog">
6094	<desc>
6095	Reads the VM log file. The chunk size is limited, so even if you
6096	ask for a big piece there might be less data returned.
6097	</desc>
6098	<param name="idx" type="unsigned long" dir="in">
6099	<desc>
6100	Which log file to read. 0=current log file.
6101	</desc>
6102	</param>
6103	<param name="offset" type="unsigned long long" dir="in">
6104	<desc>
6105	Offset in the log file.
6106	</desc>
6107	</param>
6108	<param name="size" type="unsigned long long" dir="in">
6109	<desc>
6110	Chunk size to read in the log file.
6111	</desc>
6112	</param>
6113	<param name="data" type="octet" dir="return" safearray="yes">
6114	<desc>
6115	Data read from the log file. A data size of 0 means end of file
6116	if the requested chunk size was not 0. This is the unprocessed
6117	file data, i.e. the line ending style depends on the platform of
6118	the system the server is running on.
6119	</desc>
6120	</param>
6121	</method>
6122	</interface>
6123
6124	<!--
6125	// IConsole
6126	/////////////////////////////////////////////////////////////////////////
6127	-->
6128
6129	<interface
6130	name="IConsoleCallback" extends="$unknown"
6131	uuid="60703f8d-81e4-4b45-a147-dcfd07692b19"
6132	wsmap="suppress"
6133	>
6134
6135	<desc>
6136	This interface is used by a client of the Main API that need to
6137	be notified of events. For example, a graphical user interface
6138	can use this to learn about machine state changes so they can
6139	update the list of virtual machines without having to rely
6140	on polling.
6141
6142	Whenever relevant events occur in VirtualBox, the callbacks in
6143	objects of this interface are called. In order for this to be
6144	useful, a client needs to create its own subclass that implements
6145	this interface in which the methods for the relevant callbacks
6146	are overridden. An instance of this subclass interface can then
6147	be passed to <link to="IConsole::registerCallback" />.
6148	</desc>
6149
6150	<method name="onMousePointerShapeChange">
6151	<desc>
6152	Notification when the guest mouse pointer shape has
6153	changed. The new shape data is given.
6154	<result name="VBOX_E_DONT_CALL_AGAIN">
6155	Do not call again, this method is a NOP.
6156	</result>
6157	</desc>
6158	<param name="visible" type="boolean" dir="in">
6159	<desc>
6160	Flag whether the pointer is visible.
6161	</desc>
6162	</param>
6163	<param name="alpha" type="boolean" dir="in">
6164	<desc>
6165	Flag whether the pointer has an alpha channel.
6166	</desc>
6167	</param>
6168	<param name="xHot" type="unsigned long" dir="in">
6169	<desc>
6170	The pointer hot spot x coordinate.
6171	</desc>
6172	</param>
6173	<param name="yHot" type="unsigned long" dir="in">
6174	<desc>
6175	The pointer hot spot y coordinate.
6176	</desc>
6177	</param>
6178	<param name="width" type="unsigned long" dir="in">
6179	<desc>
6180	Width of the pointer shape in pixels.
6181	</desc>
6182	</param>
6183	<param name="height" type="unsigned long" dir="in">
6184	<desc>
6185	Height of the pointer shape in pixels.
6186	</desc>
6187	</param>
6188	<param name="shape" type="octet" safearray="yes" dir="in">
6189	<desc>
6190	Shape buffer arrays.
6191
6192	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
6193	followed by a 32-bpp XOR (color) mask.
6194
6195	For pointers without alpha channel the XOR mask pixels are 32
6196	bit values: (lsb)BGR0(msb). For pointers with alpha channel
6197	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
6198
6199	An AND mask is used for pointers with alpha channel, so if the
6200	callback does not support alpha, the pointer could be
6201	displayed as a normal color pointer.
6202
6203	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
6204	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
6205	height</tt>. The padding bits at the end of each scanline are
6206	undefined.
6207
6208	The XOR mask follows the AND mask on the next 4-byte aligned
6209	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
6210	Bytes in the gap between the AND and the XOR mask are undefined.
6211	The XOR mask scanlines have no gap between them and the size of
6212	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
6213
6214	<note>
6215	If @a shape is 0, only the pointer visibility is changed.
6216	</note>
6217	</desc>
6218	</param>
6219	</method>
6220
6221	<method name="onMouseCapabilityChange">
6222	<desc>
6223	Notification when the mouse capabilities reported by the
6224	guest have changed. The new capabilities are passed.
6225	<result name="VBOX_E_DONT_CALL_AGAIN">
6226	Do not call again, this method is a NOP.
6227	</result>
6228	</desc>
6229	<param name="supportsAbsolute" type="boolean" dir="in"/>
6230	<param name="supportsRelative" type="boolean" dir="in"/>
6231	<param name="needsHostCursor" type="boolean" dir="in"/>
6232	</method>
6233
6234	<method name="onKeyboardLedsChange">
6235	<desc>
6236	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
6237	to alter the state of the keyboard LEDs.
6238	<result name="VBOX_E_DONT_CALL_AGAIN">
6239	Do not call again, this method is a NOP.
6240	</result>
6241	</desc>
6242	<param name="numLock" type="boolean" dir="in"/>
6243	<param name="capsLock" type="boolean" dir="in"/>
6244	<param name="scrollLock" type="boolean" dir="in"/>
6245	</method>
6246
6247	<method name="onStateChange">
6248	<desc>
6249	Notification when the execution state of the machine has changed.
6250	The new state will be given.
6251	<result name="VBOX_E_DONT_CALL_AGAIN">
6252	Do not call again, this method is a NOP.
6253	</result>
6254	</desc>
6255	<param name="state" type="MachineState" dir="in"/>
6256	</method>
6257
6258	<method name="onAdditionsStateChange">
6259	<desc>
6260	Notification when a Guest Additions property changes.
6261	Interested callees should query IGuest attributes to
6262	find out what has changed.
6263	</desc>
6264	</method>
6265
6266	<method name="onNetworkAdapterChange">
6267	<desc>
6268	Notification when a property of one of the
6269	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
6270	changes. Interested callees should use INetworkAdapter methods and
6271	attributes to find out what has changed.
6272	<result name="VBOX_E_DONT_CALL_AGAIN">
6273	Do not call again, this method is a NOP.
6274	</result>
6275	</desc>
6276	<param name="networkAdapter" type="INetworkAdapter" dir="in">
6277	<desc>Network adapter that is subject to change.</desc>
6278	</param>
6279	</method>
6280
6281	<method name="onSerialPortChange">
6282	<desc>
6283	Notification when a property of one of the
6284	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
6285	Interested callees should use ISerialPort methods and attributes
6286	to find out what has changed.
6287	<result name="VBOX_E_DONT_CALL_AGAIN">
6288	Do not call again, this method is a NOP.
6289	</result>
6290	</desc>
6291	<param name="serialPort" type="ISerialPort" dir="in">
6292	<desc>Serial port that is subject to change.</desc>
6293	</param>
6294	</method>
6295
6296	<method name="onParallelPortChange">
6297	<desc>
6298	Notification when a property of one of the
6299	virtual <link to="IMachine::getParallelPort">parallel ports</link>
6300	changes. Interested callees should use ISerialPort methods and
6301	attributes to find out what has changed.
6302	<result name="VBOX_E_DONT_CALL_AGAIN">
6303	Do not call again, this method is a NOP.
6304	</result>
6305	</desc>
6306	<param name="parallelPort" type="IParallelPort" dir="in">
6307	<desc>Parallel port that is subject to change.</desc>
6308	</param>
6309	</method>
6310
6311	<method name="onStorageControllerChange">
6312	<desc>
6313	Notification when a property of one of the
6314	virtual <link to="IMachine::storageControllers">storage controllers</link>
6315	changes. Interested callees should query the corresponding collections
6316	to find out what has changed.
6317	<result name="VBOX_E_DONT_CALL_AGAIN">
6318	Do not call again, this method is a NOP.
6319	</result>
6320	</desc>
6321	</method>
6322
6323	<method name="onMediumChange">
6324	<desc>
6325	Notification when a
6326	<link to="IMachine::mediumAttachments">medium attachment</link>
6327	changes.
6328	<result name="VBOX_E_DONT_CALL_AGAIN">
6329	Do not call again, this method is a NOP.
6330	</result>
6331	</desc>
6332	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
6333	<desc>Medium attachment that is subject to change.</desc>
6334	</param>
6335	</method>
6336
6337	<method name="onCPUChange">
6338	<desc>
6339	Notification when a CPU changes.
6340	<result name="VBOX_E_DONT_CALL_AGAIN">
6341	Do not call again, this method is a NOP.
6342	</result>
6343	</desc>
6344	<param name="cpu" type="unsigned long" dir="in">
6345	<desc>The CPU which changed</desc>
6346	</param>
6347	<param name="add" type="boolean" dir="in">
6348	<desc>Flag whether the CPU was added or removed</desc>
6349	</param>
6350	</method>
6351
6352	<method name="onVRDPServerChange">
6353	<desc>
6354	Notification when a property of the
6355	<link to="IMachine::VRDPServer">VRDP server</link> changes.
6356	Interested callees should use IVRDPServer methods and attributes to
6357	find out what has changed.
6358	<result name="VBOX_E_DONT_CALL_AGAIN">
6359	Do not call again, this method is a NOP.
6360	</result>
6361	</desc>
6362	</method>
6363
6364	<method name="onRemoteDisplayInfoChange">
6365	<desc>
6366	Notification when the status of the VRDP server changes. Interested callees
6367	should use <link to="IConsole::RemoteDisplayInfo">IRemoteDisplayInfo</link>
6368	attributes to find out what is the current status.
6369	<result name="VBOX_E_DONT_CALL_AGAIN">
6370	Do not call again, this method is a NOP.
6371	</result>
6372	</desc>
6373	</method>
6374
6375	<method name="onUSBControllerChange">
6376	<desc>
6377	Notification when a property of the virtual
6378	<link to="IMachine::USBController">USB controller</link> changes.
6379	Interested callees should use IUSBController methods and attributes to
6380	find out what has changed.
6381	<result name="VBOX_E_DONT_CALL_AGAIN">
6382	Do not call again, this method is a NOP.
6383	</result>
6384	</desc>
6385	</method>
6386
6387	<method name="onUSBDeviceStateChange">
6388	<desc>
6389	Notification when a USB device is attached to or detached from
6390	the virtual USB controller.
6391
6392	This notification is sent as a result of the indirect
6393	request to attach the device because it matches one of the
6394	machine USB filters, or as a result of the direct request
6395	issued by <link to="IConsole::attachUSBDevice"/> or
6396	<link to="IConsole::detachUSBDevice"/>.
6397
6398	This notification is sent in case of both a succeeded and a
6399	failed request completion. When the request succeeds, the
6400	@a error parameter is @c null, and the given device has been
6401	already added to (when @a attached is @c true) or removed from
6402	(when @a attached is @c false) the collection represented by
6403	<link to="IConsole::USBDevices"/>. On failure, the collection
6404	doesn't change and the @a error parameter represents the error
6405	message describing the failure.
6406
6407	<result name="VBOX_E_DONT_CALL_AGAIN">
6408	Do not call again, this method is a NOP.
6409	</result>
6410	</desc>
6411	<param name="device" type="IUSBDevice" dir="in">
6412	<desc>Device that is subject to state change.</desc>
6413	</param>
6414	<param name="attached" type="boolean" dir="in">
6415	<desc>
6416	@c true if the device was attached and @c false otherwise.
6417	</desc>
6418	</param>
6419	<param name="error" type="IVirtualBoxErrorInfo" dir="in">
6420	<desc>
6421	@c null on success or an error message object on failure.
6422	</desc>
6423	</param>
6424	</method>
6425
6426	<method name="onSharedFolderChange">
6427	<desc>
6428	Notification when a shared folder is added or removed.
6429	The @a scope argument defines one of three scopes:
6430	<link to="IVirtualBox::sharedFolders">global shared folders</link>
6431	(<link to="Scope_Global">Global</link>),
6432	<link to="IMachine::sharedFolders">permanent shared folders</link> of
6433	the machine (<link to="Scope_Machine">Machine</link>) or <link
6434	to="IConsole::sharedFolders">transient shared folders</link> of the
6435	machine (<link to="Scope_Session">Session</link>). Interested callees
6436	should use query the corresponding collections to find out what has
6437	changed.
6438	<result name="VBOX_E_DONT_CALL_AGAIN">
6439	Do not call again, this method is a NOP.
6440	</result>
6441	</desc>
6442	<param name="scope" type="Scope" dir="in">
6443	<desc>Scope of the notification.</desc>
6444	</param>
6445	</method>
6446
6447	<method name="onRuntimeError">
6448	<desc>
6449	Notification when an error happens during the virtual
6450	machine execution.
6451
6452	There are three kinds of runtime errors:
6453	<ul>
6454	<li><i>fatal</i></li>
6455	<li><i>non-fatal with retry</i></li>
6456	<li><i>non-fatal warnings</i></li>
6457	</ul>
6458
6459	<b>Fatal</b> errors are indicated by the @a fatal parameter set
6460	to @c true. In case of fatal errors, the virtual machine
6461	execution is always paused before calling this notification, and
6462	the notification handler is supposed either to immediately save
6463	the virtual machine state using <link to="IConsole::saveState"/>
6464	or power it off using <link to="IConsole::powerDown"/>.
6465	Resuming the execution can lead to unpredictable results.
6466
6467	<b>Non-fatal</b> errors and warnings are indicated by the
6468	@a fatal parameter set to @c false. If the virtual machine
6469	is in the Paused state by the time the error notification is
6470	received, it means that the user can <i>try to resume</i> the machine
6471	execution after attempting to solve the problem that caused the
6472	error. In this case, the notification handler is supposed
6473	to show an appropriate message to the user (depending on the
6474	value of the @a id parameter) that offers several actions such
6475	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
6476	wants to retry, the notification handler should continue
6477	the machine execution using the <link to="IConsole::resume"/>
6478	call. If the machine execution is not Paused during this
6479	notification, then it means this notification is a <i>warning</i>
6480	(for example, about a fatal condition that can happen very soon);
6481	no immediate action is required from the user, the machine
6482	continues its normal execution.
6483
6484	Note that in either case the notification handler
6485	<b>must not</b> perform any action directly on a thread
6486	where this notification is called. Everything it is allowed to
6487	do is to post a message to another thread that will then talk
6488	to the user and take the corresponding action.
6489
6490	Currently, the following error identifiers are known:
6491	<ul>
6492	<li><tt>"HostMemoryLow"</tt></li>
6493	<li><tt>"HostAudioNotResponding"</tt></li>
6494	<li><tt>"VDIStorageFull"</tt></li>
6495	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
6496	</ul>
6497
6498	<note>
6499	This notification is not designed to be implemented by
6500	more than one callback at a time. If you have multiple
6501	IConsoleCallback instances registered on the given
6502	IConsole object, make sure you simply do nothing but
6503	return @c S_OK from all but one of them that does actual
6504	user notification and performs necessary actions.
6505	</note>
6506
6507	<result name="VBOX_E_DONT_CALL_AGAIN">
6508	Do not call again, this method is a NOP.
6509	</result>
6510	</desc>
6511	<param name="fatal" type="boolean" dir="in">
6512	<desc>Whether the error is fatal or not</desc>
6513	</param>
6514	<param name="id" type="wstring" dir="in">
6515	<desc>Error identifier</desc>
6516	</param>
6517	<param name="message" type="wstring" dir="in">
6518	<desc>Optional error message</desc>
6519	</param>
6520	</method>
6521
6522	<method name="onCanShowWindow">
6523	<desc>
6524	Notification when a call to
6525	<link to="IMachine::canShowConsoleWindow"/> is made by a
6526	front-end to check if a subsequent call to
6527	<link to="IMachine::showConsoleWindow"/> can succeed.
6528
6529	The callee should give an answer appropriate to the current
6530	machine state in the @a canShow argument. This answer must
6531	remain valid at least until the next
6532	<link to="IConsole::state">machine state</link> change.
6533
6534	<note>
6535	This notification is not designed to be implemented by
6536	more than one callback at a time. If you have multiple
6537	IConsoleCallback instances registered on the given
6538	IConsole object, make sure you simply do nothing but
6539	return @c true and @c S_OK from all but one of them that
6540	actually manages console window activation.
6541	</note>
6542
6543	<result name="VBOX_E_DONT_CALL_AGAIN">
6544	Do not call again, this method is a NOP.
6545	</result>
6546	</desc>
6547	<param name="canShow" type="boolean" dir="return">
6548	<desc>
6549	@c true if the console window can be shown and @c false otherwise.
6550	</desc>
6551	</param>
6552	</method>
6553
6554	<method name="onShowWindow">
6555	<desc>
6556	Notification when a call to
6557	<link to="IMachine::showConsoleWindow"/>
6558	requests the console window to be activated and brought to
6559	foreground on the desktop of the host PC.
6560
6561	This notification should cause the VM console process to
6562	perform the requested action as described above. If it is
6563	impossible to do it at a time of this notification, this
6564	method should return a failure.
6565
6566	Note that many modern window managers on many platforms
6567	implement some sort of focus stealing prevention logic, so
6568	that it may be impossible to activate a window without the
6569	help of the currently active application (which is supposedly
6570	an initiator of this notification). In this case, this method
6571	must return a non-zero identifier that represents the
6572	top-level window of the VM console process. The caller, if it
6573	represents a currently active process, is responsible to use
6574	this identifier (in a platform-dependent manner) to perform
6575	actual window activation.
6576
6577	This method must set @a winId to zero if it has performed all
6578	actions necessary to complete the request and the console
6579	window is now active and in foreground, to indicate that no
6580	further action is required on the caller's side.
6581
6582	<note>
6583	This notification is not designed to be implemented by
6584	more than one callback at a time. If you have multiple
6585	IConsoleCallback instances registered on the given
6586	IConsole object, make sure you simply do nothing but
6587	return @c S_OK from all but one of them that actually
6588	manages console window activation.
6589	</note>
6590
6591	<result name="VBOX_E_DONT_CALL_AGAIN">
6592	Do not call again, this method is a NOP.
6593	</result>
6594	</desc>
6595	<param name="winId" type="unsigned long long" dir="return">
6596	<desc>
6597	Platform-dependent identifier of the top-level VM console
6598	window, or zero if this method has performed all actions
6599	necessary to implement the <i>show window</i> semantics for
6600	the given platform and/or this VirtualBox front-end.
6601	</desc>
6602	</param>
6603	</method>
6604
6605	</interface>
6606
6607	<interface
6608	name="IRemoteDisplayInfo" extends="$unknown"
6609	uuid="b3741084-806f-4c3b-8c42-ebad1a81e45a"
6610	wsmap="struct"
6611	>
6612	<desc>
6613	Contains information about the remote display (VRDP) capabilities and status.
6614	This is used in the <link to="IConsole::remoteDisplayInfo" /> attribute.
6615	</desc>
6616
6617	<attribute name="active" type="boolean" readonly="yes">
6618	<desc>
6619	Whether the remote display connection is active.
6620	</desc>
6621	</attribute>
6622
6623	<attribute name="port" type="long" readonly="yes">
6624	<desc>
6625	VRDP server port number. If this property is equal to <tt>0</tt>, then
6626	the VRDP server failed to start, usually because there are no free TCP
6627	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDP
6628	server has not yet been started.
6629	</desc>
6630	</attribute>
6631
6632	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6633	<desc>
6634	How many times a client connected.
6635	</desc>
6636	</attribute>
6637
6638	<attribute name="beginTime" type="long long" readonly="yes">
6639	<desc>
6640	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6641	</desc>
6642	</attribute>
6643
6644	<attribute name="endTime" type="long long" readonly="yes">
6645	<desc>
6646	When the last connection was terminated or the current time, if
6647	connection is still active, in milliseconds since 1970-01-01 UTC.
6648	</desc>
6649	</attribute>
6650
6651	<attribute name="bytesSent" type="unsigned long long" readonly="yes">
6652	<desc>
6653	How many bytes were sent in last or current, if still active, connection.
6654	</desc>
6655	</attribute>
6656
6657	<attribute name="bytesSentTotal" type="unsigned long long" readonly="yes">
6658	<desc>
6659	How many bytes were sent in all connections.
6660	</desc>
6661	</attribute>
6662
6663	<attribute name="bytesReceived" type="unsigned long long" readonly="yes">
6664	<desc>
6665	How many bytes were received in last or current, if still active, connection.
6666	</desc>
6667	</attribute>
6668
6669	<attribute name="bytesReceivedTotal" type="unsigned long long" readonly="yes">
6670	<desc>
6671	How many bytes were received in all connections.
6672	</desc>
6673	</attribute>
6674
6675	<attribute name="user" type="wstring" readonly="yes">
6676	<desc>
6677	Login user name supplied by the client.
6678	</desc>
6679	</attribute>
6680
6681	<attribute name="domain" type="wstring" readonly="yes">
6682	<desc>
6683	Login domain name supplied by the client.
6684	</desc>
6685	</attribute>
6686
6687	<attribute name="clientName" type="wstring" readonly="yes">
6688	<desc>
6689	The client name supplied by the client.
6690	</desc>
6691	</attribute>
6692
6693	<attribute name="clientIP" type="wstring" readonly="yes">
6694	<desc>
6695	The IP address of the client.
6696	</desc>
6697	</attribute>
6698
6699	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6700	<desc>
6701	The client software version number.
6702	</desc>
6703	</attribute>
6704
6705	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6706	<desc>
6707	Public key exchange method used when connection was established.
6708	Values: 0 - RDP4 public key exchange scheme.
6709	1 - X509 certificates were sent to client.
6710	</desc>
6711	</attribute>
6712
6713	</interface>
6714
6715	<interface
6716	name="IConsole" extends="$unknown"
6717	uuid="6375231a-c17c-464b-92cb-ae9e128d71c3"
6718	wsmap="managed"
6719	>
6720	<desc>
6721	The IConsole interface represents an interface to control virtual
6722	machine execution.
6723
6724	The console object that implements the IConsole interface is obtained
6725	from a session object after the session for the given machine has been
6726	opened using one of <link to="IVirtualBox::openSession"/>,
6727	<link to="IVirtualBox::openRemoteSession"/> or
6728	<link to="IVirtualBox::openExistingSession"/> methods.
6729
6730	Methods of the IConsole interface allow the caller to query the current
6731	virtual machine execution state, pause the machine or power it down, save
6732	the machine state or take a snapshot, attach and detach removable media
6733	and so on.
6734
6735	<see>ISession</see>
6736	</desc>
6737
6738	<attribute name="machine" type="IMachine" readonly="yes">
6739	<desc>
6740	Machine object this console is sessioned with.
6741	<note>
6742	This is a convenience property, it has the same value as
6743	<link to="ISession::machine"/> of the corresponding session
6744	object.
6745	</note>
6746	</desc>
6747	</attribute>
6748
6749	<attribute name="state" type="MachineState" readonly="yes">
6750	<desc>
6751	Current execution state of the machine.
6752	<note>
6753	This property always returns the same value as the corresponding
6754	property of the IMachine object this console is sessioned with.
6755	For the process that owns (executes) the VM, this is the
6756	preferable way of querying the VM state, because no IPC
6757	calls are made.
6758	</note>
6759	</desc>
6760	</attribute>
6761
6762	<attribute name="guest" type="IGuest" readonly="yes">
6763	<desc>Guest object.</desc>
6764	</attribute>
6765
6766	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6767	<desc>
6768	Virtual keyboard object.
6769	<note>
6770	If the machine is not running, any attempt to use
6771	the returned object will result in an error.
6772	</note>
6773	</desc>
6774	</attribute>
6775
6776	<attribute name="mouse" type="IMouse" readonly="yes">
6777	<desc>
6778	Virtual mouse object.
6779	<note>
6780	If the machine is not running, any attempt to use
6781	the returned object will result in an error.
6782	</note>
6783	</desc>
6784	</attribute>
6785
6786	<attribute name="display" type="IDisplay" readonly="yes">
6787	<desc>Virtual display object.
6788	<note>
6789	If the machine is not running, any attempt to use
6790	the returned object will result in an error.
6791	</note>
6792	</desc>
6793	</attribute>
6794
6795	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6796	<desc>Debugging interface.</desc>
6797	</attribute>
6798
6799	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6800	<desc>
6801	Collection of USB devices currently attached to the virtual
6802	USB controller.
6803	<note>
6804	The collection is empty if the machine is not running.
6805	</note>
6806	</desc>
6807	</attribute>
6808
6809	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6810	<desc>
6811	List of USB devices currently attached to the remote VRDP client.
6812	Once a new device is physically attached to the remote host computer,
6813	it appears in this list and remains there until detached.
6814	</desc>
6815	</attribute>
6816
6817	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6818	<desc>
6819	Collection of shared folders for the current session. These folders
6820	are called transient shared folders because they are available to the
6821	guest OS running inside the associated virtual machine only for the
6822	duration of the session (as opposed to
6823	<link to="IMachine::sharedFolders"/> which represent permanent shared
6824	folders). When the session is closed (e.g. the machine is powered down),
6825	these folders are automatically discarded.
6826
6827	New shared folders are added to the collection using
6828	<link to="#createSharedFolder"/>. Existing shared folders can be
6829	removed using <link to="#removeSharedFolder"/>.
6830	</desc>
6831	</attribute>
6832
6833	<attribute name="remoteDisplayInfo" type="IRemoteDisplayInfo" readonly="yes">
6834	<desc>
6835	Interface that provides information on Remote Display (VRDP) connection.
6836	</desc>
6837	</attribute>
6838
6839	<method name="powerUp">
6840	<desc>
6841	Starts the virtual machine execution using the current machine
6842	state (that is, its current execution state, current settings and
6843	current storage devices).
6844
6845	If the machine is powered off or aborted, the execution will
6846	start from the beginning (as if the real hardware were just
6847	powered on).
6848
6849	If the machine is in the <link to="MachineState_Saved"/> state,
6850	it will continue its execution the point where the state has
6851	been saved.
6852
6853	If the machine <link to="IMachine::teleporterEnabled"/> property is
6854	enabled on the machine being powered up, the machine will wait for an
6855	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6856	state. The returned progress object will have at least three
6857	operations where the last three are defined as: (1) powering up and
6858	starting TCP server, (2) waiting for incoming teleportations, and
6859	(3) perform teleportation. These operations will be reflected as the
6860	last three operations of the progress objected returned by
6861	<link to="IVirtualBox::openRemoteSession"/> as well.
6862
6863	<note>
6864	Unless you are trying to write a new VirtualBox front-end that
6865	performs direct machine execution (like the VirtualBox or VBoxSDL
6866	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
6867	session opened by <link to="IVirtualBox::openSession"/> and use this
6868	session only to change virtual machine settings. If you simply want to
6869	start virtual machine execution using one of the existing front-ends
6870	(for example the VirtualBox GUI or headless server), simply use
6871	<link to="IVirtualBox::openRemoteSession"/>; these front-ends will
6872	power up the machine automatically for you.
6873	</note>
6874
6875	<see>#saveState</see>
6876	<result name="VBOX_E_INVALID_VM_STATE">
6877	Virtual machine already running.
6878	</result>
6879	<result name="VBOX_E_HOST_ERROR">
6880	Host interface does not exist or name not set.
6881	</result>
6882	<result name="VBOX_E_FILE_ERROR">
6883	Invalid saved state file.
6884	</result>
6885	</desc>
6886	<param name="progress" type="IProgress" dir="return">
6887	<desc>Progress object to track the operation completion.</desc>
6888	</param>
6889	</method>
6890
6891	<method name="powerUpPaused">
6892	<desc>
6893	Identical to powerUp except that the VM will enter the
6894	<link to="MachineState_Paused"/> state, instead of
6895	<link to="MachineState_Running"/>.
6896
6897	<see>#powerUp</see>
6898	<result name="VBOX_E_INVALID_VM_STATE">
6899	Virtual machine already running.
6900	</result>
6901	<result name="VBOX_E_HOST_ERROR">
6902	Host interface does not exist or name not set.
6903	</result>
6904	<result name="VBOX_E_FILE_ERROR">
6905	Invalid saved state file.
6906	</result>
6907	</desc>
6908	<param name="progress" type="IProgress" dir="return">
6909	<desc>Progress object to track the operation completion.</desc>
6910	</param>
6911	</method>
6912
6913	<method name="powerDown">
6914	<desc>
6915	Initiates the power down procedure to stop the virtual machine
6916	execution.
6917
6918	The completion of the power down procedure is tracked using the returned
6919	IProgress object. After the operation is complete, the machine will go
6920	to the PoweredOff state.
6921	<result name="VBOX_E_INVALID_VM_STATE">
6922	Virtual machine must be Running, Paused or Stuck to be powered down.
6923	</result>
6924	</desc>
6925	<param name="progress" type="IProgress" dir="return">
6926	<desc>Progress object to track the operation completion.</desc>
6927	</param>
6928	</method>
6929
6930	<method name="reset">
6931	<desc>Resets the virtual machine.
6932	<result name="VBOX_E_INVALID_VM_STATE">
6933	Virtual machine not in Running state.
6934	</result>
6935	<result name="VBOX_E_VM_ERROR">
6936	Virtual machine error in reset operation.
6937	</result>
6938	</desc>
6939	</method>
6940
6941	<method name="pause">
6942	<desc>Pauses the virtual machine execution.
6943	<result name="VBOX_E_INVALID_VM_STATE">
6944	Virtual machine not in Running state.
6945	</result>
6946	<result name="VBOX_E_VM_ERROR">
6947	Virtual machine error in suspend operation.
6948	</result>
6949	</desc>
6950	</method>
6951
6952	<method name="resume">
6953	<desc>Resumes the virtual machine execution.
6954	<result name="VBOX_E_INVALID_VM_STATE">
6955	Virtual machine not in Paused state.
6956	</result>
6957	<result name="VBOX_E_VM_ERROR">
6958	Virtual machine error in resume operation.
6959	</result>
6960	</desc>
6961	</method>
6962
6963	<method name="powerButton">
6964	<desc>Sends the ACPI power button event to the guest.
6965	<result name="VBOX_E_INVALID_VM_STATE">
6966	Virtual machine not in Running state.
6967	</result>
6968	<result name="VBOX_E_PDM_ERROR">
6969	Controlled power off failed.
6970	</result>
6971	</desc>
6972	</method>
6973
6974	<method name="sleepButton">
6975	<desc>Sends the ACPI sleep button event to the guest.
6976	<result name="VBOX_E_INVALID_VM_STATE">
6977	Virtual machine not in Running state.
6978	</result>
6979	<result name="VBOX_E_PDM_ERROR">
6980	Sending sleep button event failed.
6981	</result>
6982	</desc>
6983	</method>
6984
6985	<method name="getPowerButtonHandled">
6986	<desc>Checks if the last power button event was handled by guest.
6987	<result name="VBOX_E_PDM_ERROR">
6988	Checking if the event was handled by the guest OS failed.
6989	</result>
6990	</desc>
6991	<param name="handled" type="boolean" dir="return"/>
6992	</method>
6993
6994	<method name="getGuestEnteredACPIMode">
6995	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6996	G1 (sleeping). If this method returns @c false, the guest will
6997	most likely not respond to external ACPI events.
6998	<result name="VBOX_E_INVALID_VM_STATE">
6999	Virtual machine not in Running state.
7000	</result>
7001	</desc>
7002	<param name="entered" type="boolean" dir="return"/>
7003	</method>
7004
7005	<method name="saveState">
7006	<desc>
7007	Saves the current execution state of a running virtual machine
7008	and stops its execution.
7009
7010	After this operation completes, the machine will go to the
7011	Saved state. Next time it is powered up, this state will
7012	be restored and the machine will continue its execution from
7013	the place where it was saved.
7014
7015	This operation differs from taking a snapshot to the effect
7016	that it doesn't create new differencing media. Also, once
7017	the machine is powered up from the state saved using this method,
7018	the saved state is deleted, so it will be impossible to return
7019	to this state later.
7020
7021	<note>
7022	On success, this method implicitly calls
7023	<link to="IMachine::saveSettings"/> to save all current machine
7024	settings (including runtime changes to the DVD medium, etc.).
7025	Together with the impossibility to change any VM settings when it is
7026	in the Saved state, this guarantees adequate hardware
7027	configuration of the machine when it is restored from the saved
7028	state file.
7029	</note>
7030
7031	<note>
7032	The machine must be in the Running or Paused state, otherwise
7033	the operation will fail.
7034	</note>
7035	<result name="VBOX_E_INVALID_VM_STATE">
7036	Virtual machine state neither Running nor Paused.
7037	</result>
7038	<result name="VBOX_E_FILE_ERROR">
7039	Failed to create directory for saved state file.
7040	</result>
7041
7042	<see><link to="#takeSnapshot"/></see>
7043	</desc>
7044	<param name="progress" type="IProgress" dir="return">
7045	<desc>Progress object to track the operation completion.</desc>
7046	</param>
7047	</method>
7048
7049	<method name="adoptSavedState">
7050	<desc>
7051	Associates the given saved state file to the virtual machine.
7052
7053	On success, the machine will go to the Saved state. Next time it is
7054	powered up, it will be restored from the adopted saved state and
7055	continue execution from the place where the saved state file was
7056	created.
7057
7058	The specified saved state file path may be absolute or relative to the
7059	folder the VM normally saves the state to (usually,
7060	<link to="IMachine::snapshotFolder"/>).
7061
7062	<note>
7063	It's a caller's responsibility to make sure the given saved state
7064	file is compatible with the settings of this virtual machine that
7065	represent its virtual hardware (memory size, storage disk configuration
7066	etc.). If there is a mismatch, the behavior of the virtual machine
7067	is undefined.
7068	</note>
7069	<result name="VBOX_E_INVALID_VM_STATE">
7070	Virtual machine state neither PoweredOff nor Aborted.
7071	</result>
7072	</desc>
7073	<param name="savedStateFile" type="wstring" dir="in">
7074	<desc>Path to the saved state file to adopt.</desc>
7075	</param>
7076	</method>
7077
7078	<method name="forgetSavedState">
7079	<desc>
7080	Forgets the saved state of the virtual machine previously created
7081	by <link to="#saveState"/>. Next time the machine is powered up, a
7082	clean boot will occur. If @a remove is @c true the saved state file
7083	is deleted.
7084	<note>
7085	This operation is equivalent to resetting or powering off
7086	the machine without doing a proper shutdown in the guest OS.
7087	</note>
7088	<result name="VBOX_E_INVALID_VM_STATE">
7089	Virtual machine not in state Saved.
7090	</result>
7091	</desc>
7092	<param name="remove" type="boolean" dir="in">
7093	<desc>If @c true remove the saved state file.</desc>
7094	</param>
7095	</method>
7096
7097	<method name="getDeviceActivity">
7098	<desc>
7099	Gets the current activity type of a given device or device group.
7100	<result name="E_INVALIDARG">
7101	Invalid device type.
7102	</result>
7103	</desc>
7104	<param name="type" type="DeviceType" dir="in"/>
7105	<param name="activity" type="DeviceActivity" dir="return"/>
7106	</method>
7107
7108	<method name="attachUSBDevice">
7109	<desc>
7110	Attaches a host USB device with the given UUID to the
7111	USB controller of the virtual machine.
7112
7113	The device needs to be in one of the following states:
7114	<link to="USBDeviceState_Busy"/>,
7115	<link to="USBDeviceState_Available"/> or
7116	<link to="USBDeviceState_Held"/>,
7117	otherwise an error is immediately returned.
7118
7119	When the device state is
7120	<link to="USBDeviceState_Busy">Busy</link>, an error may also
7121	be returned if the host computer refuses to release it for some reason.
7122
7123	<see>IUSBController::deviceFilters, USBDeviceState</see>
7124	<result name="VBOX_E_INVALID_VM_STATE">
7125	Virtual machine state neither Running nor Paused.
7126	</result>
7127	<result name="VBOX_E_PDM_ERROR">
7128	Virtual machine does not have a USB controller.
7129	</result>
7130	</desc>
7131	<param name="id" type="uuid" mod="string" dir="in">
7132	<desc>UUID of the host USB device to attach.</desc>
7133	</param>
7134	</method>
7135
7136	<method name="detachUSBDevice">
7137	<desc>
7138	Detaches an USB device with the given UUID from the USB controller
7139	of the virtual machine.
7140
7141	After this method succeeds, the VirtualBox server re-initiates
7142	all USB filters as if the device were just physically attached
7143	to the host, but filters of this machine are ignored to avoid
7144	a possible automatic re-attachment.
7145
7146	<see>IUSBController::deviceFilters, USBDeviceState</see>
7147
7148	<result name="VBOX_E_PDM_ERROR">
7149	Virtual machine does not have a USB controller.
7150	</result>
7151	<result name="E_INVALIDARG">
7152	USB device not attached to this virtual machine.
7153	</result>
7154	</desc>
7155	<param name="id" type="uuid" mod="string" dir="in">
7156	<desc>UUID of the USB device to detach.</desc>
7157	</param>
7158	<param name="device" type="IUSBDevice" dir="return">
7159	<desc>Detached USB device.</desc>
7160	</param>
7161	</method>
7162
7163	<method name="findUSBDeviceByAddress">
7164	<desc>
7165	Searches for a USB device with the given host address.
7166
7167	<result name="VBOX_E_OBJECT_NOT_FOUND">
7168	Given @c name does not correspond to any USB device.
7169	</result>
7170
7171	<see>IUSBDevice::address</see>
7172	</desc>
7173	<param name="name" type="wstring" dir="in">
7174	<desc>
7175	Address of the USB device (as assigned by the host) to
7176	search for.
7177	</desc>
7178	</param>
7179	<param name="device" type="IUSBDevice" dir="return">
7180	<desc>Found USB device object.</desc>
7181	</param>
7182	</method>
7183
7184	<method name="findUSBDeviceById">
7185	<desc>
7186	Searches for a USB device with the given UUID.
7187
7188	<result name="VBOX_E_OBJECT_NOT_FOUND">
7189	Given @c id does not correspond to any USB device.
7190	</result>
7191
7192	<see>IUSBDevice::id</see>
7193	</desc>
7194	<param name="id" type="uuid" mod="string" dir="in">
7195	<desc>UUID of the USB device to search for.</desc>
7196	</param>
7197	<param name="device" type="IUSBDevice" dir="return">
7198	<desc>Found USB device object.</desc>
7199	</param>
7200	</method>
7201
7202	<method name="createSharedFolder">
7203	<desc>
7204	Creates a transient new shared folder by associating the given logical
7205	name with the given host path, adds it to the collection of shared
7206	folders and starts sharing it. Refer to the description of
7207	<link to="ISharedFolder"/> to read more about logical names.
7208
7209	<result name="VBOX_E_INVALID_VM_STATE">
7210	Virtual machine in Saved state or currently changing state.
7211	</result>
7212	<result name="VBOX_E_FILE_ERROR">
7213	Shared folder already exists or not accessible.
7214	</result>
7215	</desc>
7216	<param name="name" type="wstring" dir="in">
7217	<desc>Unique logical name of the shared folder.</desc>
7218	</param>
7219	<param name="hostPath" type="wstring" dir="in">
7220	<desc>Full path to the shared folder in the host file system.</desc>
7221	</param>
7222	<param name="writable" type="boolean" dir="in">
7223	<desc>Whether the share is writable or readonly</desc>
7224	</param>
7225	</method>
7226
7227	<method name="removeSharedFolder">
7228	<desc>
7229	Removes a transient shared folder with the given name previously
7230	created by <link to="#createSharedFolder"/> from the collection of
7231	shared folders and stops sharing it.
7232	<result name="VBOX_E_INVALID_VM_STATE">
7233	Virtual machine in Saved state or currently changing state.
7234	</result>
7235	<result name="VBOX_E_FILE_ERROR">
7236	Shared folder does not exists.
7237	</result>
7238	</desc>
7239	<param name="name" type="wstring" dir="in">
7240	<desc>Logical name of the shared folder to remove.</desc>
7241	</param>
7242	</method>
7243
7244	<method name="takeSnapshot">
7245	<desc>
7246	Saves the current execution state
7247	and all settings of the machine and creates differencing images
7248	for all normal (non-independent) media.
7249	See <link to="ISnapshot" /> for an introduction to snapshots.
7250
7251	This method can be called for a PoweredOff, Saved (see
7252	<link to="#saveState"/>), Running or
7253	Paused virtual machine. When the machine is PoweredOff, an
7254	offline snapshot is created. When the machine is Running a live
7255	snapshot is created, and an online snapshot is is created when Paused.
7256
7257	The taken snapshot is always based on the
7258	<link to="IMachine::currentSnapshot">current snapshot</link>
7259	of the associated virtual machine and becomes a new current snapshot.
7260
7261	<note>
7262	This method implicitly calls <link to="IMachine::saveSettings"/> to
7263	save all current machine settings before taking an offline snapshot.
7264	</note>
7265
7266	<result name="VBOX_E_INVALID_VM_STATE">
7267	Virtual machine currently changing state.
7268	</result>
7269	</desc>
7270	<param name="name" type="wstring" dir="in">
7271	<desc>Short name for the snapshot.</desc>
7272	</param>
7273	<param name="description" type="wstring" dir="in">
7274	<desc>Optional description of the snapshot.</desc>
7275	</param>
7276	<param name="progress" type="IProgress" dir="return">
7277	<desc>Progress object to track the operation completion.</desc>
7278	</param>
7279	</method>
7280
7281	<method name="deleteSnapshot">
7282	<desc>
7283	Starts deleting the specified snapshot asynchronously.
7284	See <link to="ISnapshot" /> for an introduction to snapshots.
7285
7286	The execution state and settings of the associated machine stored in
7287	the snapshot will be deleted. The contents of all differencing media of
7288	this snapshot will be merged with the contents of their dependent child
7289	media to keep the medium chain valid (in other words, all changes
7290	represented by media being deleted will be propagated to their child
7291	medium). After that, this snapshot's differencing medium will be
7292	deleted. The parent of this snapshot will become a new parent for all
7293	its child snapshots.
7294
7295	If the deleted snapshot is the current one, its parent snapshot will
7296	become a new current snapshot. The current machine state is not directly
7297	affected in this case, except that currently attached differencing
7298	media based on media of the deleted snapshot will be also merged as
7299	described above.
7300
7301	If the deleted snapshot is the first or current snapshot, then the
7302	respective IMachine attributes will be adjusted. Deleting the current
7303	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7304	to make all current machine settings permanent.
7305
7306	Deleting a snapshot has the following preconditions:
7307
7308	<ul>
7309	<li>Child media of all normal media of the deleted snapshot
7310	must be accessible (see <link to="IMedium::state"/>) for this
7311	operation to succeed. In particular, this means that all virtual
7312	machines, whose media are directly or indirectly based on the
7313	media of deleted snapshot, must be powered off.</li>
7314
7315	<li>You cannot delete the snapshot if a medium attached to it has
7316	more than once child medium (differencing images) because otherwise
7317	merging would be impossible. This might be the case if there is
7318	more than one child snapshot or differencing images were created
7319	for other reason (e.g. implicitly because of multiple machine
7320	attachments).</li>
7321	</ul>
7322
7323
7324	The virtual machine's <link to="IMachine::state">state</link> is changed to "DeletingSnapshot"
7325	while this operation is in progress.
7326
7327	<note>
7328	Merging medium contents can be very time and disk space
7329	consuming, if these media are big in size and have many
7330	children. However, if the snapshot being deleted is the last
7331	(head) snapshot on the branch, the operation will be rather
7332	quick.
7333	</note>
7334	<result name="VBOX_E_INVALID_VM_STATE">
7335	Virtual machine is running.
7336	</result>
7337	</desc>
7338	<param name="id" type="uuid" mod="string" dir="in">
7339	<desc>UUID of the snapshot to delete.</desc>
7340	</param>
7341	<param name="progress" type="IProgress" dir="return">
7342	<desc>Progress object to track the operation completion.</desc>
7343	</param>
7344	</method>
7345
7346	<method name="restoreSnapshot">
7347	<desc>
7348	Starts resetting the machine's current state to the state contained
7349	in the given snapshot, asynchronously. All current settings of the
7350	machine will be reset and changes stored in differencing media
7351	will be lost.
7352	See <link to="ISnapshot" /> for an introduction to snapshots.
7353
7354	After this operation is successfully completed, new empty differencing
7355	media are created for all normal media of the machine.
7356
7357	If the given snapshot is an online snapshot, the machine will go to
7358	the <link to="MachineState_Saved"> saved state</link>, so that the
7359	next time it is powered on, the execution state will be restored
7360	from the state of the snapshot.
7361
7362	<note>
7363	The machine must not be running, otherwise the operation will fail.
7364	</note>
7365
7366	<note>
7367	If the machine state is <link to="MachineState_Saved">Saved</link>
7368	prior to this operation, the saved state file will be implicitly
7369	deleted (as if <link to="IConsole::forgetSavedState"/> were
7370	called).
7371	</note>
7372
7373	<result name="VBOX_E_INVALID_VM_STATE">
7374	Virtual machine is running.
7375	</result>
7376	</desc>
7377	<param name="snapshot" type="ISnapshot" dir="in">
7378	<desc>The snapshot to restore the VM state from.</desc>
7379	</param>
7380	<param name="progress" type="IProgress" dir="return">
7381	<desc>Progress object to track the operation completion.</desc>
7382	</param>
7383	</method>
7384
7385	<method name="teleport">
7386	<desc>
7387	Teleport the VM to a different host machine or process.
7388
7389	TODO explain the details.
7390
7391	<result name="VBOX_E_INVALID_VM_STATE">
7392	Virtual machine not running or paused.
7393	</result>
7394	</desc>
7395	<param name="hostname" type="wstring" dir="in">
7396	<desc>The name or IP of the host to teleport to.</desc>
7397	</param>
7398	<param name="tcpport" type="unsigned long" dir="in">
7399	<desc>The TCP port to connect to (1..65535).</desc>
7400	</param>
7401	<param name="password" type="wstring" dir="in">
7402	<desc>The password.</desc>
7403	</param>
7404	<param name="maxDowntime" type="unsigned long" dir="in">
7405	<desc>
7406	The maximum allowed downtime given as milliseconds. 0 is not a valid
7407	value. Recommended value: 250 ms.
7408
7409	The higher the value is, the greater the chance for a successful
7410	teleportation. A small value may easily result in the teleportation
7411	process taking hours and eventually fail.
7412
7413	<note>
7414	The current implementation treats this a guideline, not as an
7415	absolute rule.
7416	</note>
7417	</desc>
7418	</param>
7419	<param name="progress" type="IProgress" dir="return">
7420	<desc>Progress object to track the operation completion.</desc>
7421	</param>
7422	</method>
7423
7424	<method name="registerCallback">
7425	<desc>
7426	Registers a new console callback on this instance. The methods of the
7427	callback interface will be called by this instance when the appropriate
7428	event occurs.
7429	</desc>
7430	<param name="callback" type="IConsoleCallback" dir="in"/>
7431	</method>
7432
7433	<method name="unregisterCallback">
7434	<desc>
7435	Unregisters the console callback previously registered using
7436	<link to="#registerCallback"/>.
7437	<result name="E_INVALIDARG">
7438	Given @a callback handler is not registered.
7439	</result>
7440	</desc>
7441	<param name="callback" type="IConsoleCallback" dir="in"/>
7442	</method>
7443	</interface>
7444
7445	<!--
7446	// IHost
7447	/////////////////////////////////////////////////////////////////////////
7448	-->
7449
7450	<enum
7451	name="HostNetworkInterfaceMediumType"
7452	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7453	>
7454	<desc>
7455	Type of encapsulation. Ethernet encapsulation includes both wired and
7456	wireless Ethernet connections.
7457	<see>IHostNetworkInterface</see>
7458	</desc>
7459
7460	<const name="Unknown" value="0">
7461	<desc>
7462	The type of interface cannot be determined.
7463	</desc>
7464	</const>
7465	<const name="Ethernet" value="1">
7466	<desc>
7467	Ethernet frame encapsulation.
7468	</desc>
7469	</const>
7470	<const name="PPP" value="2">
7471	<desc>
7472	Point-to-point protocol encapsulation.
7473	</desc>
7474	</const>
7475	<const name="SLIP" value="3">
7476	<desc>
7477	Serial line IP encapsulation.
7478	</desc>
7479	</const>
7480	</enum>
7481
7482	<enum
7483	name="HostNetworkInterfaceStatus"
7484	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7485	>
7486	<desc>
7487	Current status of the interface.
7488	<see>IHostNetworkInterface</see>
7489	</desc>
7490
7491	<const name="Unknown" value="0">
7492	<desc>
7493	The state of interface cannot be determined.
7494	</desc>
7495	</const>
7496	<const name="Up" value="1">
7497	<desc>
7498	The interface is fully operational.
7499	</desc>
7500	</const>
7501	<const name="Down" value="2">
7502	<desc>
7503	The interface is not functioning.
7504	</desc>
7505	</const>
7506	</enum>
7507
7508	<enum
7509	name="HostNetworkInterfaceType"
7510	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7511	>
7512	<desc>
7513	Network interface type.
7514	</desc>
7515	<const name="Bridged" value="1"/>
7516	<const name="HostOnly" value="2"/>
7517	</enum>
7518
7519	<interface
7520	name="IHostNetworkInterface" extends="$unknown"
7521	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7522	wsmap="managed"
7523	>
7524	<desc>
7525	Represents one of host's network interfaces. IP V6 address and network
7526	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7527	separated by colons.
7528	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7529	</desc>
7530	<attribute name="name" type="wstring" readonly="yes">
7531	<desc>Returns the host network interface name.</desc>
7532	</attribute>
7533
7534	<attribute name="id" type="uuid" mod="string" readonly="yes">
7535	<desc>Returns the interface UUID.</desc>
7536	</attribute>
7537
7538	<attribute name="networkName" type="wstring" readonly="yes">
7539	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7540	</attribute>
7541
7542	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7543	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7544	</attribute>
7545
7546	<attribute name="IPAddress" type="wstring" readonly="yes">
7547	<desc>Returns the IP V4 address of the interface.</desc>
7548	</attribute>
7549
7550	<attribute name="networkMask" type="wstring" readonly="yes">
7551	<desc>Returns the network mask of the interface.</desc>
7552	</attribute>
7553
7554	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7555	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7556	</attribute>
7557
7558	<attribute name="IPV6Address" type="wstring" readonly="yes">
7559	<desc>Returns the IP V6 address of the interface.</desc>
7560	</attribute>
7561
7562	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7563	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7564	</attribute>
7565
7566	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7567	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7568	</attribute>
7569
7570	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7571	<desc>Type of protocol encapsulation used.</desc>
7572	</attribute>
7573
7574	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7575	<desc>Status of the interface.</desc>
7576	</attribute>
7577
7578	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7579	<desc>specifies the host interface type.</desc>
7580	</attribute>
7581
7582	<method name="enableStaticIpConfig">
7583	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7584	<param name="IPAddress" type="wstring" dir="in">
7585	<desc>
7586	IP address.
7587	</desc>
7588	</param>
7589	<param name="networkMask" type="wstring" dir="in">
7590	<desc>
7591	network mask.
7592	</desc>
7593	</param>
7594	</method>
7595
7596	<method name="enableStaticIpConfigV6">
7597	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7598	<param name="IPV6Address" type="wstring" dir="in">
7599	<desc>
7600	IP address.
7601	</desc>
7602	</param>
7603	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7604	<desc>
7605	network mask.
7606	</desc>
7607	</param>
7608	</method>
7609
7610	<method name="enableDynamicIpConfig">
7611	<desc>enables the dynamic IP configuration.</desc>
7612	</method>
7613
7614	<method name="dhcpRediscover">
7615	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7616	</method>
7617
7618	</interface>
7619
7620	<interface
7621	name="IHost" extends="$unknown"
7622	uuid="35b004f4-7806-4009-bfa8-d1308adba7e5"
7623	wsmap="managed"
7624	>
7625	<desc>
7626	The IHost interface represents the physical machine that this VirtualBox
7627	installation runs on.
7628
7629	An object implementing this interface is returned by the
7630	<link to="IVirtualBox::host" /> attribute. This interface contains
7631	read-only information about the host's physical hardware (such as what
7632	processors and disks are available, what the host operating system is,
7633	and so on) and also allows for manipulating some of the host's hardware,
7634	such as global USB device filters and host interface networking.
7635
7636	</desc>
7637	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7638	<desc>List of DVD drives available on the host.</desc>
7639	</attribute>
7640
7641	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7642	<desc>List of floppy drives available on the host.</desc>
7643	</attribute>
7644
7645	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7646	<desc>
7647	List of USB devices currently attached to the host.
7648	Once a new device is physically attached to the host computer,
7649	it appears in this list and remains there until detached.
7650
7651	<note>
7652	If USB functionality is not available in the given edition of
7653	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7654	</note>
7655	</desc>
7656	</attribute>
7657
7658	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7659	<desc>
7660	List of USB device filters in action.
7661	When a new device is physically attached to the host computer,
7662	filters from this list are applied to it (in order they are stored
7663	in the list). The first matched filter will determine the
7664	<link to="IHostUSBDeviceFilter::action">action</link>
7665	performed on the device.
7666
7667	Unless the device is ignored by these filters, filters of all
7668	currently running virtual machines
7669	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7670
7671	<note>
7672	If USB functionality is not available in the given edition of
7673	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7674	</note>
7675
7676	<see>IHostUSBDeviceFilter, USBDeviceState</see>
7677	</desc>
7678	</attribute>
7679
7680	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7681	<desc>List of host network interfaces currently defined on the host.</desc>
7682	</attribute>
7683
7684	<attribute name="processorCount" type="unsigned long" readonly="yes">
7685	<desc>Number of (logical) CPUs installed in the host system.</desc>
7686	</attribute>
7687
7688	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7689	<desc>Number of (logical) CPUs online in the host system.</desc>
7690	</attribute>
7691
7692	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7693	<desc>Number of physical processor cores installed in the host system.</desc>
7694	</attribute>
7695
7696	<method name="getProcessorSpeed">
7697	<desc>Query the (approximate) maximum speed of a specified host CPU in
7698	Megahertz.
7699	</desc>
7700	<param name="cpuId" type="unsigned long" dir="in">
7701	<desc>
7702	Identifier of the CPU.
7703	</desc>
7704	</param>
7705	<param name="speed" type="unsigned long" dir="return">
7706	<desc>
7707	Speed value. 0 is returned if value is not known or @a cpuId is
7708	invalid.
7709	</desc>
7710	</param>
7711	</method>
7712
7713	<method name="getProcessorFeature">
7714	<desc>Query whether a CPU feature is supported or not.</desc>
7715	<param name="feature" type="ProcessorFeature" dir="in">
7716	<desc>
7717	CPU Feature identifier.
7718	</desc>
7719	</param>
7720	<param name="supported" type="boolean" dir="return">
7721	<desc>
7722	Feature is supported or not.
7723	</desc>
7724	</param>
7725	</method>
7726
7727	<method name="getProcessorDescription">
7728	<desc>Query the model string of a specified host CPU.
7729	</desc>
7730	<param name="cpuId" type="unsigned long" dir="in">
7731	<desc>
7732	Identifier of the CPU.
7733	<note>
7734	The current implementation might not necessarily return the
7735	description for this exact CPU.
7736	</note>
7737	</desc>
7738	</param>
7739	<param name="description" type="wstring" dir="return">
7740	<desc>
7741	Model string. An empty string is returned if value is not known or
7742	@a cpuId is invalid.
7743	</desc>
7744	</param>
7745	</method>
7746
7747	<method name="getProcessorCPUIDLeaf">
7748	<desc>
7749	Returns the CPU cpuid information for the specified leaf.
7750	</desc>
7751	<param name="cpuId" type="unsigned long" dir="in">
7752	<desc>
7753	Identifier of the CPU. The CPU most be online.
7754	<note>
7755	The current implementation might not necessarily return the
7756	description for this exact CPU.
7757	</note>
7758	</desc>
7759	</param>
7760	<param name="leaf" type="unsigned long" dir="in">
7761	<desc>
7762	CPUID leaf index (eax).
7763	</desc>
7764	</param>
7765	<param name="subLeaf" type="unsigned long" dir="in">
7766	<desc>
7767	CPUID leaf sub index (ecx). This currently only applies to cache
7768	information on Intel CPUs. Use 0 if retriving values for
7769	<link to="IMachine::setCPUIDLeaf"/>.
7770	</desc>
7771	</param>
7772	<param name="valEax" type="unsigned long" dir="out">
7773	<desc>
7774	CPUID leaf value for register eax.
7775	</desc>
7776	</param>
7777	<param name="valEbx" type="unsigned long" dir="out">
7778	<desc>
7779	CPUID leaf value for register ebx.
7780	</desc>
7781	</param>
7782	<param name="valEcx" type="unsigned long" dir="out">
7783	<desc>
7784	CPUID leaf value for register ecx.
7785	</desc>
7786	</param>
7787	<param name="valEdx" type="unsigned long" dir="out">
7788	<desc>
7789	CPUID leaf value for register edx.
7790	</desc>
7791	</param>
7792	</method>
7793
7794	<attribute name="memorySize" type="unsigned long" readonly="yes">
7795	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7796	</attribute>
7797
7798	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7799	<desc>Available system memory in the host system.</desc>
7800	</attribute>
7801
7802	<attribute name="operatingSystem" type="wstring" readonly="yes">
7803	<desc>Name of the host system's operating system.</desc>
7804	</attribute>
7805
7806	<attribute name="OSVersion" type="wstring" readonly="yes">
7807	<desc>Host operating system's version string.</desc>
7808	</attribute>
7809
7810	<attribute name="UTCTime" type="long long" readonly="yes">
7811	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7812	</attribute>
7813
7814	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7815	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7816	</attribute>
7817
7818	<method name="createHostOnlyNetworkInterface">
7819	<desc>
7820	Creates a new adapter for Host Only Networking.
7821	<result name="E_INVALIDARG">
7822	Host network interface @a name already exists.
7823	</result>
7824	</desc>
7825	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7826	<desc>
7827	Created host interface object.
7828	</desc>
7829	</param>
7830	<param name="progress" type="IProgress" dir="return">
7831	<desc>
7832	Progress object to track the operation completion.
7833	</desc>
7834	</param>
7835	</method>
7836
7837	<method name="removeHostOnlyNetworkInterface">
7838	<desc>
7839	Removes the given Host Only Networking interface.
7840	<result name="VBOX_E_OBJECT_NOT_FOUND">
7841	No host network interface matching @a id found.
7842	</result>
7843	</desc>
7844	<param name="id" type="uuid" mod="string" dir="in">
7845	<desc>
7846	Adapter GUID.
7847	</desc>
7848	</param>
7849	<param name="progress" type="IProgress" dir="return">
7850	<desc>
7851	Progress object to track the operation completion.
7852	</desc>
7853	</param>
7854	</method>
7855
7856	<method name="createUSBDeviceFilter">
7857	<desc>
7858	Creates a new USB device filter. All attributes except
7859	the filter name are set to empty (any match),
7860	<i>active</i> is @c false (the filter is not active).
7861
7862	The created filter can be added to the list of filters using
7863	<link to="#insertUSBDeviceFilter"/>.
7864
7865	<see>#USBDeviceFilters</see>
7866	</desc>
7867	<param name="name" type="wstring" dir="in">
7868	<desc>
7869	Filter name. See <link to="IHostUSBDeviceFilter::name"/>
7870	for more info.
7871	</desc>
7872	</param>
7873	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7874	<desc>Created filter object.</desc>
7875	</param>
7876	</method>
7877
7878	<method name="insertUSBDeviceFilter">
7879	<desc>
7880	Inserts the given USB device to the specified position
7881	in the list of filters.
7882
7883	Positions are numbered starting from @c 0. If the specified
7884	position is equal to or greater than the number of elements in
7885	the list, the filter is added at the end of the collection.
7886
7887	<note>
7888	Duplicates are not allowed, so an attempt to insert a
7889	filter already in the list is an error.
7890	</note>
7891	<note>
7892	If USB functionality is not available in the given edition of
7893	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7894	</note>
7895
7896	<see>#USBDeviceFilters</see>
7897
7898	<result name="VBOX_E_INVALID_OBJECT_STATE">
7899	USB device filter is not created within this VirtualBox instance.
7900	</result>
7901	<result name="E_INVALIDARG">
7902	USB device filter already in list.
7903	</result>
7904
7905	</desc>
7906	<param name="position" type="unsigned long" dir="in">
7907	<desc>Position to insert the filter to.</desc>
7908	</param>
7909	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7910	<desc>USB device filter to insert.</desc>
7911	</param>
7912	</method>
7913
7914	<method name="removeUSBDeviceFilter">
7915	<desc>
7916	Removes a USB device filter from the specified position in the
7917	list of filters.
7918
7919	Positions are numbered starting from @c 0. Specifying a
7920	position equal to or greater than the number of elements in
7921	the list will produce an error.
7922
7923	<note>
7924	If USB functionality is not available in the given edition of
7925	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7926	</note>
7927
7928	<see>#USBDeviceFilters</see>
7929
7930	<result name="E_INVALIDARG">
7931	USB device filter list empty or invalid @a position.
7932	</result>
7933
7934	</desc>
7935	<param name="position" type="unsigned long" dir="in">
7936	<desc>Position to remove the filter from.</desc>
7937	</param>
7938	</method>
7939
7940	<method name="findHostDVDDrive">
7941	<desc>
7942	Searches for a host DVD drive with the given @c name.
7943
7944	<result name="VBOX_E_OBJECT_NOT_FOUND">
7945	Given @c name does not correspond to any host drive.
7946	</result>
7947
7948	</desc>
7949	<param name="name" type="wstring" dir="in">
7950	<desc>Name of the host drive to search for</desc>
7951	</param>
7952	<param name="drive" type="IMedium" dir="return">
7953	<desc>Found host drive object</desc>
7954	</param>
7955	</method>
7956
7957	<method name="findHostFloppyDrive">
7958	<desc>
7959	Searches for a host floppy drive with the given @c name.
7960
7961	<result name="VBOX_E_OBJECT_NOT_FOUND">
7962	Given @c name does not correspond to any host floppy drive.
7963	</result>
7964
7965	</desc>
7966	<param name="name" type="wstring" dir="in">
7967	<desc>Name of the host floppy drive to search for</desc>
7968	</param>
7969	<param name="drive" type="IMedium" dir="return">
7970	<desc>Found host floppy drive object</desc>
7971	</param>
7972	</method>
7973
7974	<method name="findHostNetworkInterfaceByName">
7975	<desc>
7976	Searches through all host network interfaces for an interface with
7977	the given @c name.
7978	<note>
7979	The method returns an error if the given @c name does not
7980	correspond to any host network interface.
7981	</note>
7982	</desc>
7983	<param name="name" type="wstring" dir="in">
7984	<desc>Name of the host network interface to search for.</desc>
7985	</param>
7986	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7987	<desc>Found host network interface object.</desc>
7988	</param>
7989	</method>
7990	<method name="findHostNetworkInterfaceById">
7991	<desc>
7992	Searches through all host network interfaces for an interface with
7993	the given GUID.
7994	<note>
7995	The method returns an error if the given GUID does not
7996	correspond to any host network interface.
7997	</note>
7998	</desc>
7999	<param name="id" type="uuid" mod="string" dir="in">
8000	<desc>GUID of the host network interface to search for.</desc>
8001	</param>
8002	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8003	<desc>Found host network interface object.</desc>
8004	</param>
8005	</method>
8006	<method name="findHostNetworkInterfacesOfType">
8007	<desc>
8008	Searches through all host network interfaces and returns a list of interfaces of the specified type
8009	</desc>
8010	<param name="type" type="HostNetworkInterfaceType" dir="in">
8011	<desc>type of the host network interfaces to search for.</desc>
8012	</param>
8013	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
8014	<desc>Found host network interface objects.</desc>
8015	</param>
8016	</method>
8017
8018	<method name="findUSBDeviceById">
8019	<desc>
8020	Searches for a USB device with the given UUID.
8021
8022	<result name="VBOX_E_OBJECT_NOT_FOUND">
8023	Given @c id does not correspond to any USB device.
8024	</result>
8025
8026	<see>IHostUSBDevice::id</see>
8027	</desc>
8028	<param name="id" type="uuid" mod="string" dir="in">
8029	<desc>UUID of the USB device to search for.</desc>
8030	</param>
8031	<param name="device" type="IHostUSBDevice" dir="return">
8032	<desc>Found USB device object.</desc>
8033	</param>
8034	</method>
8035
8036	<method name="findUSBDeviceByAddress">
8037	<desc>
8038	Searches for a USB device with the given host address.
8039
8040	<result name="VBOX_E_OBJECT_NOT_FOUND">
8041	Given @c name does not correspond to any USB device.
8042	</result>
8043
8044	<see>IHostUSBDevice::address</see>
8045	</desc>
8046	<param name="name" type="wstring" dir="in">
8047	<desc>
8048	Address of the USB device (as assigned by the host) to
8049	search for.
8050	</desc>
8051	</param>
8052	<param name="device" type="IHostUSBDevice" dir="return">
8053	<desc>Found USB device object.</desc>
8054	</param>
8055	</method>
8056
8057	</interface>
8058
8059	<!--
8060	// ISystemProperties
8061	/////////////////////////////////////////////////////////////////////////
8062	-->
8063
8064	<interface
8065	name="ISystemProperties"
8066	extends="$unknown"
8067	uuid="07c3ffd8-8f59-49cc-b608-53a332e85cc3"
8068	wsmap="managed"
8069	>
8070	<desc>
8071	The ISystemProperties interface represents global properties of the given
8072	VirtualBox installation.
8073
8074	These properties define limits and default values for various attributes
8075	and parameters. Most of the properties are read-only, but some can be
8076	changed by a user.
8077	</desc>
8078
8079	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
8080	<desc>Minimum guest system memory in Megabytes.</desc>
8081	</attribute>
8082
8083	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
8084	<desc>Maximum guest system memory in Megabytes.</desc>
8085	</attribute>
8086
8087	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
8088	<desc>Minimum guest video memory in Megabytes.</desc>
8089	</attribute>
8090
8091	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
8092	<desc>Maximum guest video memory in Megabytes.</desc>
8093	</attribute>
8094
8095	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
8096	<desc>Minimum CPU count.</desc>
8097	</attribute>
8098
8099	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
8100	<desc>Maximum CPU count.</desc>
8101	</attribute>
8102
8103	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
8104	<desc>Maximum of monitors which could be connected.</desc>
8105	</attribute>
8106
8107	<attribute name="maxVDISize" type="unsigned long long" readonly="yes">
8108	<desc>Maximum size of a virtual disk image in Megabytes.</desc>
8109	</attribute>
8110
8111	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
8112	<desc>
8113	Number of network adapters associated with every
8114	<link to="IMachine"/> instance.
8115	</desc>
8116	</attribute>
8117
8118	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
8119	<desc>
8120	Number of serial ports associated with every
8121	<link to="IMachine"/> instance.
8122	</desc>
8123	</attribute>
8124
8125	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
8126	<desc>
8127	Number of parallel ports associated with every
8128	<link to="IMachine"/> instance.
8129	</desc>
8130	</attribute>
8131
8132	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
8133	<desc>
8134	Maximum device position in the boot order. This value corresponds
8135	to the total number of devices a machine can boot from, to make it
8136	possible to include all possible devices to the boot list.
8137	<see><link to="IMachine::setBootOrder"/></see>
8138	</desc>
8139	</attribute>
8140
8141	<attribute name="defaultMachineFolder" type="wstring">
8142	<desc>
8143	Full path to the default directory used to create new or open
8144	existing machines when a settings file name contains no
8145	path.
8146
8147	The initial value of this property is
8148	<tt><</tt><link to="IVirtualBox::homeFolder">
8149	VirtualBox_home</link><tt>>/Machines</tt>.
8150
8151	<note>
8152	Setting this property to @c null or an empty string will restore the
8153	initial value.
8154	</note>
8155	<note>
8156	When settings this property, the specified path can be
8157	absolute (full path) or relative
8158	to the <link to="IVirtualBox::homeFolder">
8159	VirtualBox home directory</link>.
8160	When reading this property, a full path is
8161	always returned.
8162	</note>
8163	<note>
8164	The specified path may not exist, it will be created
8165	when necessary.
8166	</note>
8167
8168	<see>
8169	<link to="IVirtualBox::createMachine"/>,
8170	<link to="IVirtualBox::openMachine"/>
8171	</see>
8172	</desc>
8173	</attribute>
8174
8175	<attribute name="defaultHardDiskFolder" type="wstring">
8176	<desc>
8177	Full path to the default directory used to create new or open existing
8178	virtual disks.
8179
8180	This path is used when the storage unit of a hard disk is a regular file
8181	in the host's file system and only a file name that contains no path is
8182	given.
8183
8184	The initial value of this property is
8185	<tt><</tt>
8186	<link to="IVirtualBox::homeFolder">VirtualBox_home</link>
8187	<tt>>/HardDisks</tt>.
8188
8189	<note>
8190	Setting this property to @c null or empty string will restore the
8191	initial value.
8192	</note>
8193	<note>
8194	When settings this property, the specified path can be relative
8195	to the
8196	<link to="IVirtualBox::homeFolder">VirtualBox home directory</link> or
8197	absolute. When reading this property, a full path is
8198	always returned.
8199	</note>
8200	<note>
8201	The specified path may not exist, it will be created
8202	when necessary.
8203	</note>
8204
8205	<see>
8206	IMedium,
8207	<link to="IVirtualBox::createHardDisk"/>,
8208	<link to="IVirtualBox::openHardDisk"/>,
8209	<link to="IMedium::location"/>
8210	</see>
8211	</desc>
8212	</attribute>
8213
8214	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
8215	<desc>
8216	List of all medium storage formats supported by this VirtualBox
8217	installation.
8218
8219	Keep in mind that the medium format identifier
8220	(<link to="IMediumFormat::id"/>) used in other API calls like
8221	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
8222	medium format is a case-insensitive string. This means that, for
8223	example, all of the following strings:
8224	<pre>
8225	"VDI"
8226	"vdi"
8227	"VdI"</pre>
8228	refer to the same medium format.
8229
8230	Note that the virtual medium framework is backend-based, therefore
8231	the list of supported formats depends on what backends are currently
8232	installed.
8233
8234	<see>
8235	<link to="IMediumFormat"/>,
8236	</see>
8237	</desc>
8238	</attribute>
8239
8240	<attribute name="defaultHardDiskFormat" type="wstring">
8241	<desc>
8242	Identifier of the default medium format used by VirtualBox.
8243
8244	The medium format set by this attribute is used by VirtualBox
8245	when the medium format was not specified explicitly. One example is
8246	<link to="IVirtualBox::createHardDisk"/> with the empty
8247	format argument. A more complex example is implicit creation of
8248	differencing media when taking a snapshot of a virtual machine:
8249	this operation will try to use a format of the parent medium first
8250	and if this format does not support differencing media the default
8251	format specified by this argument will be used.
8252
8253	The list of supported medium formats may be obtained by the
8254	<link to="#mediaFormats"/> call. Note that the default medium
8255	format must have a capability to create differencing media;
8256	otherwise operations that create media implicitly may fail
8257	unexpectedly.
8258
8259	The initial value of this property is <tt>"VDI"</tt> in the current
8260	version of the VirtualBox product, but may change in the future.
8261
8262	<note>
8263	Setting this property to @c null or empty string will restore the
8264	initial value.
8265	</note>
8266
8267	<see>
8268	<link to="#mediaFormats"/>,
8269	<link to="IMediumFormat::id"/>,
8270	<link to="IVirtualBox::createHardDisk"/>
8271	</see>
8272	</desc>
8273	</attribute>
8274
8275	<attribute name="freeDiskSpaceWarning" type="unsigned long long">
8276	<desc>Issue a warning if the free disk space is below (or in some disk
8277	intensive operation is expected to go below) the given size in
8278	Megabytes.</desc>
8279	</attribute>
8280
8281	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8282	<desc>Issue a warning if the free disk space is below (or in some disk
8283	intensive operation is expected to go below) the given percentage.</desc>
8284	</attribute>
8285
8286	<attribute name="freeDiskSpaceError" type="unsigned long long">
8287	<desc>Issue an error if the free disk space is below (or in some disk
8288	intensive operation is expected to go below) the given size in
8289	Megabytes.</desc>
8290	</attribute>
8291
8292	<attribute name="freeDiskSpacePercentError" type="unsigned long">
8293	<desc>Issue an error if the free disk space is below (or in some disk
8294	intensive operation is expected to go below) the given percentage.</desc>
8295	</attribute>
8296
8297	<attribute name="remoteDisplayAuthLibrary" type="wstring">
8298	<desc>
8299	Library that provides authentication for VRDP clients. The library
8300	is used if a virtual machine's authentication type is set to "external"
8301	in the VM RemoteDisplay configuration.
8302
8303	The system library extension (".DLL" or ".so") must be omitted.
8304	A full path can be specified; if not, then the library must reside on the
8305	system's default library path.
8306
8307	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
8308	of that name in one of the default VirtualBox library directories.
8309
8310	For details about VirtualBox authentication libraries and how to implement
8311	them, please refer to the VirtualBox manual.
8312
8313	<note>
8314	Setting this property to @c null or empty string will restore the
8315	initial value.
8316	</note>
8317	</desc>
8318	</attribute>
8319
8320	<attribute name="webServiceAuthLibrary" type="wstring">
8321	<desc>
8322	Library that provides authentication for webservice clients. The library
8323	is used if a virtual machine's authentication type is set to "external"
8324	in the VM RemoteDisplay configuration and will be called from
8325	within the <link to="IWebsessionManager::logon" /> implementation.
8326
8327	As opposed to <link to="ISystemProperties::remoteDisplayAuthLibrary" />,
8328	there is no per-VM setting for this, as the webservice is a global
8329	resource (if it is running). Only for this setting (for the webservice),
8330	setting this value to a literal <tt>"null"</tt> string disables authentication,
8331	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8332	no matter what user name and password are supplied.
8333
8334	The initial value of this property is <tt>"VRDPAuth"</tt>,
8335	meaning that the webservice will use the same authentication
8336	library that is used by default for VBoxVRDP (again, see
8337	<link to="ISystemProperties::remoteDisplayAuthLibrary" />).
8338	The format and calling convention of authentication libraries
8339	is the same for the webservice as it is for VBoxVRDP.
8340
8341	<note>
8342	Setting this property to @c null or empty string will restore the
8343	initial value.
8344	</note>
8345	</desc>
8346	</attribute>
8347
8348	<attribute name="LogHistoryCount" type="unsigned long">
8349	<desc>
8350	This value specifies how many old release log files are kept.
8351	</desc>
8352	</attribute>
8353
8354	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8355	<desc>This value hold the default audio driver for the current
8356	system.</desc>
8357	</attribute>
8358
8359	<method name="getMaxDevicesPerPortForStorageBus">
8360	<desc>Returns the maximum number of devices which can be attached to a port
8361	for the given storage bus.</desc>
8362
8363	<param name="bus" type="StorageBus" dir="in">
8364	<desc>The storage bus type to get the value for.</desc>
8365	</param>
8366
8367	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8368	<desc>The maximum number of devices which can eb attached to the port for the given
8369	storage bus.</desc>
8370	</param>
8371	</method>
8372
8373	<method name="getMinPortCountForStorageBus">
8374	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8375
8376	<param name="bus" type="StorageBus" dir="in">
8377	<desc>The storage bus type to get the value for.</desc>
8378	</param>
8379
8380	<param name="minPortCount" type="unsigned long" dir="return">
8381	<desc>The minimum number of ports for the given storage bus.</desc>
8382	</param>
8383	</method>
8384
8385	<method name="getMaxPortCountForStorageBus">
8386	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8387
8388	<param name="bus" type="StorageBus" dir="in">
8389	<desc>The storage bus type to get the value for.</desc>
8390	</param>
8391
8392	<param name="maxPortCount" type="unsigned long" dir="return">
8393	<desc>The maximum number of ports for the given storage bus.</desc>
8394	</param>
8395	</method>
8396
8397	<method name="getMaxInstancesOfStorageBus">
8398	<desc>Returns the maximum number of storage bus instances which
8399	can be configured for each VM. This corresponds to the number of
8400	storage controllers one can have.</desc>
8401
8402	<param name="bus" type="StorageBus" dir="in">
8403	<desc>The storage bus type to get the value for.</desc>
8404	</param>
8405
8406	<param name="maxInstances" type="unsigned long" dir="return">
8407	<desc>The maximum number of instances for the given storage bus.</desc>
8408	</param>
8409	</method>
8410
8411	<method name="getDeviceTypesForStorageBus">
8412	<desc>Returns list of all the supported device types
8413	(<link to="DeviceType"/>) for the given type of storage
8414	bus.</desc>
8415
8416	<param name="bus" type="StorageBus" dir="in">
8417	<desc>The storage bus type to get the value for.</desc>
8418	</param>
8419
8420	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8421	<desc>The list of all supported device types for the given storage bus.</desc>
8422	</param>
8423	</method>
8424	</interface>
8425
8426	<!--
8427	// IGuest
8428	/////////////////////////////////////////////////////////////////////////
8429	-->
8430
8431	<interface
8432	name="IGuestOSType" extends="$unknown"
8433	uuid="e3f6727e-a09b-41ea-a824-864a176472f3"
8434	wsmap="struct"
8435	>
8436	<desc>
8437	</desc>
8438
8439	<attribute name="familyId" type="wstring" readonly="yes">
8440	<desc>Guest OS family identifier string.</desc>
8441	</attribute>
8442
8443	<attribute name="familyDescription" type="wstring" readonly="yes">
8444	<desc>Human readable description of the guest OS family.</desc>
8445	</attribute>
8446
8447	<attribute name="id" type="wstring" readonly="yes">
8448	<desc>Guest OS identifier string.</desc>
8449	</attribute>
8450
8451	<attribute name="description" type="wstring" readonly="yes">
8452	<desc>Human readable description of the guest OS.</desc>
8453	</attribute>
8454
8455	<attribute name="is64Bit" type="boolean" readonly="yes">
8456	<desc>Returns @c true if the given OS is 64-bit</desc>
8457	</attribute>
8458
8459	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8460	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8461	</attribute>
8462
8463	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8464	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8465	</attribute>
8466
8467	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8468	<desc>Recommended RAM size in Megabytes.</desc>
8469	</attribute>
8470
8471	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8472	<desc>Recommended video RAM size in Megabytes.</desc>
8473	</attribute>
8474
8475	<attribute name="recommendedHDD" type="unsigned long" readonly="yes">
8476	<desc>Recommended hard disk size in Megabytes.</desc>
8477	</attribute>
8478
8479	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8480	<desc>Returns recommended network adapter for this OS type.</desc>
8481	</attribute>
8482
8483	<attribute name="recommendedPae" type="boolean" readonly="yes">
8484	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8485	</attribute>
8486
8487	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
8488	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8489	</attribute>
8490
8491	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
8492	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8493	</attribute>
8494
8495	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
8496	<desc>Recommended storage controller type for HD drives.</desc>
8497	</attribute>
8498
8499	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
8500	<desc>Recommended storage bus type for HD drives.</desc>
8501	</attribute>
8502
8503	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8504	<desc>Recommended firmware type.</desc>
8505	</attribute>
8506
8507	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
8508	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8509	</attribute>
8510
8511	<attribute name="recommendedHpet" type="boolean" readonly="yes">
8512	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8513	</attribute>
8514
8515	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
8516	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8517	</attribute>
8518
8519	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
8520	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8521	</attribute>
8522
8523	</interface>
8524
8525	<interface
8526	name="IGuest" extends="$unknown"
8527	uuid="d915dff1-ed38-495a-91f1-ab6c53932468"
8528	wsmap="managed"
8529	>
8530	<desc>
8531	The IGuest interface represents information about the operating system
8532	running inside the virtual machine. Used in
8533	<link to="IConsole::guest"/>.
8534
8535	IGuest provides information about the guest operating system, whether
8536	Guest Additions are installed and other OS-specific virtual machine
8537	properties.
8538	</desc>
8539
8540	<attribute name="OSTypeId" type="wstring" readonly="yes">
8541	<desc>
8542	Identifier of the Guest OS type as reported by the Guest
8543	Additions.
8544	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8545	an IGuestOSType object representing details about the given
8546	Guest OS type.
8547	<note>
8548	If Guest Additions are not installed, this value will be
8549	the same as <link to="IMachine::OSTypeId"/>.
8550	</note>
8551	</desc>
8552	</attribute>
8553
8554	<attribute name="additionsActive" type="boolean" readonly="yes">
8555	<desc>
8556	Flag whether the Guest Additions are installed and active
8557	in which case their version will be returned by the
8558	<link to="#additionsVersion"/> property.
8559	</desc>
8560	</attribute>
8561
8562	<attribute name="additionsVersion" type="wstring" readonly="yes">
8563	<desc>
8564	Version of the Guest Additions (3 decimal numbers separated
8565	by dots) or empty when the Additions are not installed. The
8566	Additions may also report a version but yet not be active as
8567	the version might be refused by VirtualBox (incompatible) or
8568	other failures occurred.
8569	</desc>
8570	</attribute>
8571
8572	<attribute name="supportsSeamless" type="boolean" readonly="yes">
8573	<desc>
8574	Flag whether seamless guest display rendering (seamless desktop
8575	integration) is supported.
8576	</desc>
8577	</attribute>
8578
8579	<attribute name="supportsGraphics" type="boolean" readonly="yes">
8580	<desc>
8581	Flag whether the guest is in graphics mode. If it is not, then
8582	seamless rendering will not work, resize hints are not immediately
8583	acted on and guest display resizes are probably not initiated by
8584	the guest additions.
8585	</desc>
8586	</attribute>
8587
8588	<attribute name="memoryBalloonSize" type="unsigned long">
8589	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8590	</attribute>
8591
8592	<attribute name="pageFusionEnabled" type="boolean">
8593	<desc>Flag whether page fusion is enabled or not.</desc>
8594	</attribute>
8595
8596	<attribute name="statisticsUpdateInterval" type="unsigned long">
8597	<desc>Interval to update guest statistics in seconds.</desc>
8598	</attribute>
8599
8600	<method name="internalGetStatistics">
8601	<desc>
8602	Internal method; do not use as it might change at any time
8603	</desc>
8604	<param name="cpuUser" type="unsigned long" dir="out">
8605	<desc>Percentage of processor time spent in user mode as seen by the guest</desc>
8606	</param>
8607	<param name="cpuKernel" type="unsigned long" dir="out">
8608	<desc>Percentage of processor time spent in kernel mode as seen by the guest</desc>
8609	</param>
8610	<param name="cpuIdle" type="unsigned long" dir="out">
8611	<desc>Percentage of processor time spent idling as seen by the guest</desc>
8612	</param>
8613	<param name="memTotal" type="unsigned long" dir="out">
8614	<desc>Total amount of physical guest RAM</desc>
8615	</param>
8616	<param name="memFree" type="unsigned long" dir="out">
8617	<desc>Free amount of physical guest RAM</desc>
8618	</param>
8619	<param name="memBalloon" type="unsigned long" dir="out">
8620	<desc>Amount of ballooned physical guest RAM</desc>
8621	</param>
8622	<param name="memShared" type="unsigned long" dir="out">
8623	<desc>Amount of shared physical guest RAM</desc>
8624	</param>
8625	<param name="memCache" type="unsigned long" dir="out">
8626	<desc>Total amount of guest (disk) cache memory</desc>
8627	</param>
8628	<param name="pagedTotal" type="unsigned long" dir="out">
8629	<desc>Total amount of space in the page file</desc>
8630	</param>
8631	<param name="memAllocTotal" type="unsigned long" dir="out">
8632	<desc>Total amount of memory allocated by the hypervisor</desc>
8633	</param>
8634	<param name="memFreeTotal" type="unsigned long" dir="out">
8635	<desc>Total amount of free memory available in the hypervisor</desc>
8636	</param>
8637	<param name="memBalloonTotal" type="unsigned long" dir="out">
8638	<desc>Total amount of memory ballooned by the hypervisor</desc>
8639	</param>
8640	<param name="memSharedTotal" type="unsigned long" dir="out">
8641	<desc>Total amount of shared memory in the hypervisor</desc>
8642	</param>
8643	</method>
8644
8645	<method name="setCredentials">
8646	<desc>
8647	Store login credentials that can be queried by guest operating
8648	systems with Additions installed. The credentials are transient
8649	to the session and the guest may also choose to erase them. Note
8650	that the caller cannot determine whether the guest operating system
8651	has queried or made use of the credentials.
8652
8653	<result name="VBOX_E_VM_ERROR">
8654	VMM device is not available.
8655	</result>
8656
8657	</desc>
8658	<param name="userName" type="wstring" dir="in">
8659	<desc>User name string, can be empty</desc>
8660	</param>
8661	<param name="password" type="wstring" dir="in">
8662	<desc>Password string, can be empty</desc>
8663	</param>
8664	<param name="domain" type="wstring" dir="in">
8665	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8666	</param>
8667	<param name="allowInteractiveLogon" type="boolean" dir="in">
8668	<desc>
8669	Flag whether the guest should alternatively allow the user to
8670	interactively specify different credentials. This flag might
8671	not be supported by all versions of the Additions.
8672	</desc>
8673	</param>
8674	</method>
8675
8676	<method name="executeProcess">
8677	<desc>
8678	Executes an existing program inside the guest VM.
8679
8680	<result name="VBOX_E_IPRT_ERROR">
8681	Could not execute process.
8682	</result>
8683
8684	</desc>
8685	<param name="execName" type="wstring" dir="in">
8686	<desc>
8687	Full path name of the command to execute on the guest; the
8688	commands has to exists in the guest VM in order to be executed.
8689	</desc>
8690	</param>
8691	<param name="flags" type="unsigned long" dir="in">
8692	<desc>
8693	Execution flags - currently not supported and therefore
8694	has to be set to 0.
8695	</desc>
8696	</param>
8697	<param name="arguments" type="wstring" safearray="yes" dir="in">
8698	<desc>
8699	Array of arguments passed to the execution command.
8700	</desc>
8701	</param>
8702	<param name="environment" type="wstring" safearray="yes" dir="in">
8703	<desc>
8704	Environment variables that can be set while the command is being
8705	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
8706	variable just set its name ("NAME") without a value.
8707	</desc>
8708	</param>
8709	<param name="userName" type="wstring" dir="in">
8710	<desc>
8711	User name under which the command will be executed; has to exist
8712	and have the appropriate rights to execute programs in the VM.
8713	</desc>
8714	</param>
8715	<param name="password" type="wstring" dir="in">
8716	<desc>
8717	Password of the user account specified.
8718	</desc>
8719	</param>
8720	<param name="timeoutMS" type="unsigned long" dir="in">
8721	<desc>
8722	The maximum timeout value (in msec) to wait for finished program
8723	execution. Pass 0 for an infinite timeout.
8724	</desc>
8725	</param>
8726	<param name="pid" type="unsigned long" dir="out">
8727	<desc>
8728	The PID (process ID) of the started command for later reference.
8729	</desc>
8730	</param>
8731	<param name="progress" type="IProgress" dir="return">
8732	<desc>Progress object to track the operation completion.</desc>
8733	</param>
8734	</method>
8735
8736	<method name="getProcessOutput">
8737	<desc>
8738	Retrieves output of a formerly started process.
8739
8740	<result name="VBOX_E_IPRT_ERROR">
8741	Could not retrieve output.
8742	</result>
8743
8744	</desc>
8745	<param name="pid" type="unsigned long" dir="in">
8746	<desc>
8747	Process id returned by earlier executeProcess() call.
8748	</desc>
8749	</param>
8750	<param name="flags" type="unsigned long" dir="in">
8751	<desc>
8752	Flags describing which output to retrieve.
8753	</desc>
8754	</param>
8755	<param name="timeoutMS" type="unsigned long" dir="in">
8756	<desc>
8757	The maximum timeout value (in msec) to wait for output
8758	data. Pass 0 for an infinite timeout.
8759	</desc>
8760	</param>
8761	<param name="size" type="unsigned long long" dir="in">
8762	<desc>
8763	Size in bytes to read in the buffer.
8764	</desc>
8765	</param>
8766	<param name="data" type="octet" dir="return" safearray="yes">
8767	<desc>
8768	Buffer for retrieving the actual output. A data size of 0 means end of file
8769	if the requested size was not 0. This is the unprocessed
8770	output data, i.e. the line ending style depends on the platform of
8771	the system the server is running on.
8772	</desc>
8773	</param>
8774	</method>
8775
8776	<method name="getProcessStatus">
8777	<desc>
8778	Retrieves status, exit code and the exit reason of a formerly started process.
8779
8780	<result name="VBOX_E_IPRT_ERROR">
8781	Process with specified PID was not found.
8782	</result>
8783
8784	</desc>
8785	<param name="pid" type="unsigned long" dir="in">
8786	<desc>
8787	Process id returned by earlier executeProcess() call.
8788	</desc>
8789	</param>
8790	<param name="exitcode" type="unsigned long" dir="out">
8791	<desc>
8792	The exit code (if available).
8793	</desc>
8794	</param>
8795	<param name="flags" type="unsigned long" dir="out">
8796	<desc>
8797	Additional flags of process status (not used at the moment).
8798	</desc>
8799	</param>
8800	<param name="reason" type="unsigned long" dir="return">
8801	<desc>
8802	The current process status.
8803	</desc>
8804	</param>
8805	</method>
8806
8807	</interface>
8808
8809
8810	<!--
8811	// IProgress
8812	/////////////////////////////////////////////////////////////////////////
8813	-->
8814
8815	<interface
8816	name="IProgress" extends="$unknown"
8817	uuid="856aa038-853f-42e2-acf7-6e7b02dbe294"
8818	wsmap="managed"
8819	>
8820	<desc>
8821	The IProgress interface is used to track and control
8822	asynchronous tasks within VirtualBox.
8823
8824	An instance of this is returned every time VirtualBox starts
8825	an asynchronous task (in other words, a separate thread) which
8826	continues to run after a method call returns. For example,
8827	<link to="IConsole::saveState" />, which saves the state of
8828	a running virtual machine, can take a long time to complete.
8829	To be able to display a progress bar, a user interface such as
8830	the VirtualBox graphical user interface can use the IProgress
8831	object returned by that method.
8832
8833	Note that IProgress is a "read-only" interface in the sense
8834	that only the VirtualBox internals behind the Main API can
8835	create and manipulate progress objects, whereas client code
8836	can only use the IProgress object to monitor a task's
8837	progress and, if <link to="#cancelable" /> is @c true,
8838	cancel the task by calling <link to="#cancel" />.
8839
8840	A task represented by IProgress consists of either one or
8841	several sub-operations that run sequentially, one by one (see
8842	<link to="#operation" /> and <link to="#operationCount" />).
8843	Every operation is identified by a number (starting from 0)
8844	and has a separate description.
8845
8846	You can find the individual percentage of completion of the current
8847	operation in <link to="#operationPercent" /> and the
8848	percentage of completion of the task as a whole
8849	in <link to="#percent" />.
8850
8851	Similarly, you can wait for the completion of a particular
8852	operation via <link to="#waitForOperationCompletion" /> or
8853	for the completion of the whole task via
8854	<link to="#waitForCompletion" />.
8855	</desc>
8856
8857	<attribute name="id" type="uuid" mod="string" readonly="yes">
8858	<desc>ID of the task.</desc>
8859	</attribute>
8860
8861	<attribute name="description" type="wstring" readonly="yes">
8862	<desc>Description of the task.</desc>
8863	</attribute>
8864
8865	<attribute name="initiator" type="$unknown" readonly="yes">
8866	<desc>Initiator of the task.</desc>
8867	</attribute>
8868
8869	<attribute name="cancelable" type="boolean" readonly="yes">
8870	<desc>Whether the task can be interrupted.</desc>
8871	</attribute>
8872
8873	<attribute name="percent" type="unsigned long" readonly="yes">
8874	<desc>
8875	Current progress value of the task as a whole, in percent.
8876	This value depends on how many operations are already complete.
8877	Returns 100 if <link to="#completed" /> is @c true.
8878	</desc>
8879	</attribute>
8880
8881	<attribute name="timeRemaining" type="long" readonly="yes">
8882	<desc>
8883	Estimated remaining time until the task completes, in
8884	seconds. Returns 0 once the task has completed; returns -1
8885	if the remaining time cannot be computed, in particular if
8886	the current progress is 0.
8887
8888	Even if a value is returned, the estimate will be unreliable
8889	for low progress values. It will become more reliable as the
8890	task progresses; it is not recommended to display an ETA
8891	before at least 20% of a task have completed.
8892	</desc>
8893	</attribute>
8894
8895	<attribute name="completed" type="boolean" readonly="yes">
8896	<desc>Whether the task has been completed.</desc>
8897	</attribute>
8898
8899	<attribute name="canceled" type="boolean" readonly="yes">
8900	<desc>Whether the task has been canceled.</desc>
8901	</attribute>
8902
8903	<attribute name="resultCode" type="long" readonly="yes">
8904	<desc>
8905	Result code of the progress task.
8906	Valid only if <link to="#completed"/> is @c true.
8907	</desc>
8908	</attribute>
8909
8910	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8911	<desc>
8912	Extended information about the unsuccessful result of the
8913	progress operation. May be @c null if no extended information
8914	is available.
8915	Valid only if <link to="#completed"/> is @c true and
8916	<link to="#resultCode"/> indicates a failure.
8917	</desc>
8918	</attribute>
8919
8920	<attribute name="operationCount" type="unsigned long" readonly="yes">
8921	<desc>
8922	Number of sub-operations this task is divided into.
8923	Every task consists of at least one suboperation.
8924	</desc>
8925	</attribute>
8926
8927	<attribute name="operation" type="unsigned long" readonly="yes">
8928	<desc>Number of the sub-operation being currently executed.</desc>
8929	</attribute>
8930
8931	<attribute name="operationDescription" type="wstring" readonly="yes">
8932	<desc>
8933	Description of the sub-operation being currently executed.
8934	</desc>
8935	</attribute>
8936
8937	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8938	<desc>Progress value of the current sub-operation only, in percent.</desc>
8939	</attribute>
8940
8941	<attribute name="timeout" type="unsigned long">
8942	<desc>
8943	When non-zero, this specifies the number of milliseconds after which
8944	the operation will automatically be canceled. This can only be set on
8945	cancelable objects.
8946	</desc>
8947	</attribute>
8948
8949	<method name="setCurrentOperationProgress">
8950	<desc>Internal method, not to be called externally.</desc>
8951	<param name="percent" type="unsigned long" dir="in" />
8952	</method>
8953	<method name="setNextOperation">
8954	<desc>Internal method, not to be called externally.</desc>
8955	<param name="nextOperationDescription" type="wstring" dir="in" />
8956	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8957	</method>
8958
8959	<method name="waitForCompletion">
8960	<desc>
8961	Waits until the task is done (including all sub-operations)
8962	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8963
8964	<result name="VBOX_E_IPRT_ERROR">
8965	Failed to wait for task completion.
8966	</result>
8967	</desc>
8968
8969	<param name="timeout" type="long" dir="in">
8970	<desc>
8971	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8972	</desc>
8973	</param>
8974	</method>
8975
8976	<method name="waitForOperationCompletion">
8977	<desc>
8978	Waits until the given operation is done with a given timeout in
8979	milliseconds; specify -1 for an indefinite wait.
8980
8981	<result name="VBOX_E_IPRT_ERROR">
8982	Failed to wait for operation completion.
8983	</result>
8984
8985	</desc>
8986	<param name="operation" type="unsigned long" dir="in">
8987	<desc>
8988	Number of the operation to wait for.
8989	Must be less than <link to="#operationCount"/>.
8990	</desc>
8991	</param>
8992	<param name="timeout" type="long" dir="in">
8993	<desc>
8994	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8995	</desc>
8996	</param>
8997	</method>
8998
8999	<method name="cancel">
9000	<desc>
9001	Cancels the task.
9002	<note>
9003	If <link to="#cancelable"/> is @c false, then this method will fail.
9004	</note>
9005
9006	<result name="VBOX_E_INVALID_OBJECT_STATE">
9007	Operation cannot be canceled.
9008	</result>
9009
9010	</desc>
9011	</method>
9012
9013	</interface>
9014
9015
9016	<!--
9017	// ISnapshot
9018	/////////////////////////////////////////////////////////////////////////
9019	-->
9020
9021	<interface
9022	name="ISnapshot" extends="$unknown"
9023	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
9024	wsmap="managed"
9025	>
9026	<desc>
9027	The ISnapshot interface represents a snapshot of the virtual
9028	machine.
9029
9030	Together with the differencing media that are created
9031	when a snapshot is taken, a machine can be brought back to
9032	the exact state it was in when the snapshot was taken.
9033
9034	The ISnapshot interface has no methods, only attributes; snapshots
9035	are controlled through methods of the <link to="IConsole" /> interface
9036	which also manage the media associated with the snapshot.
9037	The following operations exist:
9038
9039	<ul>
9040	<li><link to="IConsole::takeSnapshot"/>: creates a new snapshot
9041	by creating new, empty differencing images for the machine's
9042	media and saving the VM settings and (if the VM is running)
9043	the current VM state in the snapshot.
9044
9045	The differencing images will then receive all data written to
9046	the machine's media, while their parent (base) images
9047	remain unmodified after the snapshot has been taken (see
9048	<link to="IMedium" /> for details about differencing images).
9049	This simplifies restoring a machine to the state of a snapshot:
9050	only the differencing images need to be deleted.
9051
9052	The current machine state is not changed by taking a snapshot.
9053	If the machine is running, it will resume execution after the
9054	snapshot has been taken.
9055	</li>
9056
9057	<li><link to="IConsole::restoreSnapshot"/>: this goes back to
9058	a previous snapshot. This resets the machine's state to that of
9059	the previous snapshot by deleting the differencing image of each
9060	of the machine's media and setting the machine's settings
9061	and state to the state that was saved in the snapshot (if any).
9062
9063	This destroys the machine's current state.
9064	</li>
9065
9066	<li><link to="IConsole::deleteSnapshot"/>: deletes a snapshot
9067	without affecting the current machine state.
9068
9069	This does not change the machine, but instead frees the resources
9070	allocated when the snapshot was taken: the settings and machine state
9071	is deleted (if any), and the snapshot's differencing image for each
9072	of the machine's media gets merged with its parent image.
9073
9074	Neither the current machine state nor other snapshots are affected
9075	by this operation, except that parent media will be modified
9076	to contain the disk data associated with the snapshot being deleted.
9077	</li>
9078	</ul>
9079
9080	Each snapshot contains the settings of the virtual machine (hardware
9081	configuration etc.). In addition, if the machine was running when the
9082	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
9083	the current VM state is saved in the snapshot (similarly to what happens
9084	when a VM's state is saved). The snapshot is then said to
9085	be <i>online</i> because when restoring it, the VM will be running.
9086
9087	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
9088	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
9089
9090	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
9091	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
9092	it then contains a so-called "zero execution state", representing a
9093	machine that is powered off.
9094
9095	<h3>Snapshot branches and the "current" snapshot</h3>
9096
9097	Snapshots can be chained, whereby every next snapshot is based on the
9098	previous one. This chaining is related to medium branching
9099	(see the <link to="IMedium"/> description) in that every time
9100	a new snapshot is created, a new differencing medium is implicitly
9101	created for all normal media attached to the machine.
9102
9103	Each virtual machine has a "current snapshot", identified by
9104	<link to="IMachine::currentSnapshot"/>. Presently, this is always set
9105	to the last snapshot in the chain. In a future version of VirtualBox,
9106	it will be possible to reset a machine's current state to that of an
9107	earlier snapshot without deleting the current state so that it will be
9108	possible to create alternative snapshot paths in a snapshot tree.
9109
9110	In the current implementation, multiple snapshot branches within one
9111	virtual machine are not allowed. Every machine has a single branch,
9112	and <link to="IConsole::takeSnapshot"/> operation adds a new
9113	snapshot to the top of that branch.
9114	</desc>
9115
9116	<attribute name="id" type="uuid" mod="string" readonly="yes">
9117	<desc>UUID of the snapshot.</desc>
9118	</attribute>
9119
9120	<attribute name="name" type="wstring">
9121	<desc>Short name of the snapshot.</desc>
9122	</attribute>
9123
9124	<attribute name="description" type="wstring">
9125	<desc>Optional description of the snapshot.</desc>
9126	</attribute>
9127
9128	<attribute name="timeStamp" type="long long" readonly="yes">
9129	<desc>
9130	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
9131	</desc>
9132	</attribute>
9133
9134	<attribute name="online" type="boolean" readonly="yes">
9135	<desc>
9136	@c true if this snapshot is an online snapshot and @c false otherwise.
9137
9138	When this attribute is @c true, the
9139	<link to="IMachine::stateFilePath"/> attribute of the
9140	<link to="#machine"/> object associated with this snapshot
9141	will point to the saved state file. Otherwise, it will be
9142	an empty string.
9143	</desc>
9144	</attribute>
9145
9146	<attribute name="machine" type="IMachine" readonly="yes">
9147	<desc>
9148	Virtual machine this snapshot is taken on. This object
9149	stores all settings the machine had when taking this snapshot.
9150	<note>
9151	The returned machine object is immutable, i.e. no
9152	any settings can be changed.
9153	</note>
9154	</desc>
9155	</attribute>
9156
9157	<attribute name="parent" type="ISnapshot" readonly="yes">
9158	<desc>
9159	Parent snapshot (a snapshot this one is based on), or
9160	@c null if the snapshot has no parent (i.e. is the first snapshot).
9161	</desc>
9162	</attribute>
9163
9164	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
9165	<desc>
9166	Child snapshots (all snapshots having this one as a parent).
9167	</desc>
9168	</attribute>
9169
9170	</interface>
9171
9172
9173	<!--
9174	// IMedium
9175	/////////////////////////////////////////////////////////////////////////
9176	-->
9177
9178	<enum
9179	name="MediumState"
9180	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
9181	>
9182	<desc>
9183	Virtual medium state.
9184	<see>IMedium</see>
9185	</desc>
9186
9187	<const name="NotCreated" value="0">
9188	<desc>
9189	Associated medium storage does not exist (either was not created yet or
9190	was deleted).
9191	</desc>
9192	</const>
9193	<const name="Created" value="1">
9194	<desc>
9195	Associated storage exists and accessible; this gets set if the
9196	accessibility check performed by <link to="IMedium::refreshState" />
9197	was successful.
9198	</desc>
9199	</const>
9200	<const name="LockedRead" value="2">
9201	<desc>
9202	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
9203	no data modification is possible.
9204	</desc>
9205	</const>
9206	<const name="LockedWrite" value="3">
9207	<desc>
9208	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
9209	no concurrent data reading or modification is possible.
9210	</desc>
9211	</const>
9212	<const name="Inaccessible" value="4">
9213	<desc>
9214	Medium accessiblity check (see <link to="IMedium::refreshState" />) has
9215	not yet been performed, or else, associated medium storage is not
9216	accessible. In the first case, <link to="IMedium::lastAccessError"/>
9217	is empty, in the second case, it describes the error that occured.
9218	</desc>
9219	</const>
9220	<const name="Creating" value="5">
9221	<desc>
9222	Associated medium storage is being created.
9223	</desc>
9224	</const>
9225	<const name="Deleting" value="6">
9226	<desc>
9227	Associated medium storage is being deleted.
9228	</desc>
9229	</const>
9230	</enum>
9231
9232	<enum
9233	name="MediumType"
9234	uuid="46bf1fd4-ad86-4ded-8c49-28bd2d148e5a"
9235	>
9236	<desc>
9237	Virtual medium type.
9238	<see>IMedium</see>
9239	</desc>
9240
9241	<const name="Normal" value="0">
9242	<desc>
9243	Normal medium (attached directly or indirectly, preserved
9244	when taking snapshots).
9245	</desc>
9246	</const>
9247	<const name="Immutable" value="1">
9248	<desc>
9249	Immutable medium (attached indirectly, changes are wiped out
9250	the next time the virtual machine is started).
9251	</desc>
9252	</const>
9253	<const name="Writethrough" value="2">
9254	<desc>
9255	Write through medium (attached directly, ignored when
9256	taking snapshots).
9257	</desc>
9258	</const>
9259	<const name="Shareable" value="3">
9260	<desc>
9261	Allow using this medium concurrently by several machines.
9262	<note>This is a stub value. Not usable until this note is removed.</note>
9263	</desc>
9264	</const>
9265	</enum>
9266
9267	<enum
9268	name="MediumVariant"
9269	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
9270	>
9271	<desc>
9272	Virtual medium image variant. More than one flag may be set.
9273	<see>IMedium</see>
9274	</desc>
9275
9276	<const name="Standard" value="0">
9277	<desc>
9278	No particular variant requested, results in using the backend default.
9279	</desc>
9280	</const>
9281	<const name="VmdkSplit2G" value="0x01">
9282	<desc>
9283	VMDK image split in chunks of less than 2GByte.
9284	</desc>
9285	</const>
9286	<const name="VmdkStreamOptimized" value="0x04">
9287	<desc>
9288	VMDK streamOptimized image. Special import/export format which is
9289	read-only/append-only.
9290	</desc>
9291	</const>
9292	<const name="VmdkESX" value="0x08">
9293	<desc>
9294	VMDK format variant used on ESX products.
9295	</desc>
9296	</const>
9297	<const name="Fixed" value="0x10000">
9298	<desc>
9299	Fixed image. Only allowed for base images.
9300	</desc>
9301	</const>
9302	<const name="Diff" value="0x20000">
9303	<desc>
9304	Fixed image. Only allowed for base images.
9305	</desc>
9306	</const>
9307	</enum>
9308
9309	<interface
9310	name="IMediumAttachment" extends="$unknown"
9311	uuid="e58eb3eb-8627-428b-bdf8-34487c848de5"
9312	wsmap="struct"
9313	>
9314	<desc>
9315	The IMediumAttachment interface represents the attachment
9316	of a storage medium to a virtual machine. Each machine contains
9317	an array of its medium attachments in <link to="IMachine::mediumAttachments"/>.
9318
9319	Each medium attachment specifies a storage controller as well as a port
9320	and device number. Fixed media (hard disks) will always also specify
9321	an instance of IMedium in <link to="#medium" />, referring to the hard disk
9322	medium. For removeable media, the IMedia instance is optional; it can be
9323	@c null if no media is mounted (see <link to="IMachine::mountMedium" />).
9324	</desc>
9325
9326	<attribute name="medium" type="IMedium" readonly="yes">
9327	<desc>Medium object associated with this attachment; it
9328	can be @c null for removable devices.</desc>
9329	</attribute>
9330
9331	<attribute name="controller" type="wstring" readonly="yes">
9332	<desc>Name of the storage controller of this attachment; this
9333	refers to one of the controllers in <link to="IMachine::storageControllers" />
9334	by name.</desc>
9335	</attribute>
9336
9337	<attribute name="port" type="long" readonly="yes">
9338	<desc>Port number of this attachment.
9339	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
9340	</desc>
9341	</attribute>
9342
9343	<attribute name="device" type="long" readonly="yes">
9344	<desc>Device slot number of this attachment.
9345	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
9346	</desc>
9347	</attribute>
9348
9349	<attribute name="type" type="DeviceType" readonly="yes">
9350	<desc>Device type of this attachment.</desc>
9351	</attribute>
9352
9353	<attribute name="passthrough" type="boolean" readonly="yes">
9354	<desc>Pass I/O requests through to a device on the host.</desc>
9355	</attribute>
9356
9357	</interface>
9358
9359	<interface
9360	name="IMedium" extends="$unknown"
9361	uuid="1d578f43-5ef1-4415-b556-7592d3ccdc8f"
9362	wsmap="managed"
9363	>
9364	<desc>
9365	The IMedium interface represents virtual storage for a machine's
9366	hard disks, CD/DVD or floppy drives. It will typically represent
9367	a disk image on the host, for example a VDI or VMDK file representing
9368	a virtual hard disk, or an ISO or RAW file representing virtual
9369	removable media, but can also point to a network location (e.g.
9370	for iSCSI targets).
9371
9372	Instances of IMedium are connected to virtual machines by way of
9373	medium attachments (see <link to="IMediumAttachment" />), which link
9374	the storage medium to a particular device slot of a storage controller
9375	of the virtual machine.
9376	In the VirtualBox API, virtual storage is therefore always represented
9377	by the following chain of object links:
9378
9379	<ul>
9380	<li><link to="IMachine::storageControllers"/> contains an array of
9381	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
9382	these are instances of <link to="IStorageController"/>).</li>
9383	<li><link to="IMachine::mediumAttachments"/> contains an array of
9384	medium attachments (instances of <link to="IMediumAttachment"/>),
9385	each containing a storage controller from the above array, a
9386	port/device specification, and an instance of IMedium representing
9387	the medium storage (image file).
9388
9389	For removable media, the storage medium is optional; a medium
9390	attachment with no medium represents a CD/DVD or floppy drive
9391	with no medium inserted. By contrast, hard disk attachments
9392	will always have an IMedium object attached.</li>
9393	<li>Each IMedium in turn points to a storage unit (such as a file
9394	on the host computer or a network resource) that holds actual
9395	data. This location is represented by the <link to="#location"/>
9396	attribute.</li>
9397	</ul>
9398
9399	Existing media are opened using the following methods, depending on the
9400	media type:
9401	<ul>
9402	<li><link to="IVirtualBox::openHardDisk"/></li>
9403	<li><link to="IVirtualBox::openDVDImage"/></li>
9404	<li><link to="IVirtualBox::openFloppyImage"/></li>
9405	</ul>
9406
9407	New hard disk media can be created with the VirtualBox API using the
9408	<link to="IVirtualBox::createHardDisk"/> method.
9409
9410	CD/DVD and floppy images (ISO and RAW files) are usually created outside
9411	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
9412	type in a regular file.
9413
9414	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
9415	drive; in that case the <link to="#id" /> attribute contains the UUID of
9416	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
9417
9418	<h3>Known media</h3>
9419
9420	When an existing medium is opened for the first time, it is automatically
9421	remembered by the given VirtualBox installation or, in other words, becomes
9422	a <i>known medium</i>. Known media are stored in the media
9423	registry transparently maintained by VirtualBox and stored in settings
9424	files so that this registry is preserved when VirtualBox is not running.
9425
9426	Newly created virtual media are remembered only when the associated
9427	storage unit is actually created.
9428
9429	All known media can be enumerated using
9430	<link to="IVirtualBox::hardDisks"/>,
9431	<link to="IVirtualBox::DVDImages"/> and
9432	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
9433	quickly found by UUID using <link to="IVirtualBox::getHardDisk"/>
9434	and similar methods or by location using
9435	<link to="IVirtualBox::findHardDisk"/> and similar methods.
9436
9437	Only known media can be attached to virtual machines.
9438
9439	Removing known media from the media registry is performed when the given
9440	medium is closed using the <link to="#close"/> method or when its
9441	associated storage unit is deleted.
9442
9443	<h3>Accessibility checks</h3>
9444
9445	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
9446	method is called explicitly on a medium. This is done to make the VirtualBox object
9447	ready for serving requests as fast as possible and let the end-user
9448	application decide if it needs to check media accessibility right away or not.
9449
9450	As a result, when VirtualBox starts up (e.g. the VirtualBox
9451	object gets created for the first time), all known media are in the
9452	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
9453	attribute is an empty string because no actual accessibility check has
9454	been made yet.
9455
9456	After calling <link to="#refreshState" />, a medium is considered
9457	<i>accessible</i> if its storage unit can be read. In that case, the
9458	<link to="#state"/> attribute has a value of "Created". If the storage
9459	unit cannot be read (for example, because it is located on a disconnected
9460	network resource, or was accidentally deleted outside VirtualBox),
9461	the medium is considered <i>inaccessible</i>, which is indicated by the
9462	"Inaccessible" state. The exact reason why the medium is inaccessible can be
9463	obtained by reading the <link to="#lastAccessError"/> attribute.
9464
9465	<h3>Medium types</h3>
9466
9467	There are three types of medium behavior (see <link to="MediumType" />):
9468	"normal", "immutable" and "writethrough", represented by the
9469	<link to="#type"/> attribute. The type of the medium defines how the
9470	medium is attached to a virtual machine and what happens when a
9471	<link to="ISnapshot">snapshot</link> of the virtual machine with the
9472	attached medium is taken. At the moment DVD and floppy media are always
9473	of type "writethrough".
9474
9475	All media can be also divided in two groups: <i>base</i> media and
9476	<i>differencing</i> media. A base medium contains all sectors of the
9477	medium data in its own storage and therefore can be used independently.
9478	In contrast, a differencing mediun is a "delta" to some other medium and
9479	contains only those sectors which differ from that other medium, which is
9480	then called a <i>parent</i>. The differencing medium is said to be
9481	<i>linked to</i> that parent. The parent may be itself a differencing
9482	medium, thus forming a chain of linked media. The last element in that
9483	chain must always be a base medium. Note that several differencing
9484	media may be linked to the same parent medium.
9485
9486	Differencing media can be distinguished from base media by querying the
9487	<link to="#parent"/> attribute: base media do not have parents they would
9488	depend on, so the value of this attribute is always @c null for them.
9489	Using this attribute, it is possible to walk up the medium tree (from the
9490	child medium to its parent). It is also possible to walk down the tree
9491	using the <link to="#children"/> attribute.
9492
9493	Note that the type of all differencing media is "Normal"; all other
9494	values are meaningless for them. Base media may be of any type.
9495
9496	<h3>Creating hard disks</h3>
9497
9498	New base hard disks are created using
9499	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
9500	opened using <link to="IVirtualBox::openHardDisk"/>. Differencing hard
9501	disks are usually implicitly created by VirtualBox when needed but may
9502	also be created explicitly using <link to="#createDiffStorage"/>.
9503
9504	After the hard disk is successfully created (including the storage unit)
9505	or opened, it becomes a known hard disk (remembered in the internal media
9506	registry). Known hard disks can be attached to a virtual machine, accessed
9507	through <link to="IVirtualBox::getHardDisk"/> and
9508	<link to="IVirtualBox::findHardDisk"/> methods or enumerated using the
9509	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
9510
9511	The following methods, besides <link to="IMedium::close"/>,
9512	automatically remove the hard disk from the media registry:
9513	<ul>
9514	<li><link to="#deleteStorage"/></li>
9515	<li><link to="#mergeTo"/></li>
9516	</ul>
9517
9518	If the storage unit of the hard disk is a regular file in the host's
9519	file system then the rules stated in the description of the
9520	<link to="IMedium::location"/> attribute apply when setting its value. In
9521	addition, a plain file name without any path may be given, in which case
9522	the <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
9523	folder</link> will be prepended to it.
9524
9525	<h4>Automatic composition of the file name part</h4>
9526
9527	Another extension to the <link to="IMedium::location"/> attribute is that
9528	there is a possibility to cause VirtualBox to compose a unique value for
9529	the file name part of the location using the UUID of the hard disk. This
9530	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
9531	e.g. before the storage unit is created, and works as follows. You set the
9532	value of the <link to="IMedium::location"/> attribute to a location
9533	specification which only contains the path specification but not the file
9534	name part and ends with either a forward slash or a backslash character.
9535	In response, VirtualBox will generate a new UUID for the hard disk and
9536	compose the file name using the following pattern:
9537	<pre>
9538	<path>/{<uuid>}.<ext>
9539	</pre>
9540	where <tt><path></tt> is the supplied path specification,
9541	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
9542	is the default extension for the storage format of this hard disk. After
9543	that, you may call any of the methods that create a new hard disk storage
9544	unit and they will use the generated UUID and file name.
9545
9546	<h3>Attaching Hard Disks</h3>
9547
9548	Hard disks are attached to virtual machines using the
9549	<link to="IMachine::attachDevice"/> method and detached using the
9550	<link to="IMachine::detachDevice"/> method. Depending on their
9551	<link to="#type"/>, hard disks are attached either
9552	<i>directly</i> or <i>indirectly</i>.
9553
9554	When a hard disk is being attached directly, it is associated with the
9555	virtual machine and used for hard disk operations when the machine is
9556	running. When a hard disk is being attached indirectly, a new differencing
9557	hard disk linked to it is implicitly created and this differencing hard
9558	disk is associated with the machine and used for hard disk operations.
9559	This also means that if <link to="IMachine::attachDevice"/> performs
9560	a direct attachment then the same hard disk will be returned in response
9561	to the subsequent <link to="IMachine::getMedium"/> call; however if
9562	an indirect attachment is performed then
9563	<link to="IMachine::getMedium"/> will return the implicitly created
9564	differencing hard disk, not the original one passed to <link
9565	to="IMachine::attachDevice"/>. In detail:
9566
9567	<ul>
9568	<li><b>Normal base</b> hard disks that do not have children (i.e.
9569	differencing hard disks linked to them) and that are not already
9570	attached to virtual machines in snapshots are attached <b>directly</b>.
9571	Otherwise, they are attached <b>indirectly</b> because having
9572	dependent children or being part of the snapshot makes it impossible
9573	to modify hard disk contents without breaking the integrity of the
9574	dependent party. The <link to="#readOnly"/> attribute allows to
9575	quickly determine the kind of the attachment for the given hard
9576	disk. Note that if a normal base hard disk is to be indirectly
9577	attached to a virtual machine with snapshots then a special
9578	procedure called <i>smart attachment</i> is performed (see below).</li>
9579	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
9580	they are attached <b>directly</b> if they do not have children and are
9581	not attached to virtual machines in snapshots, and <b>indirectly</b>
9582	otherwise. Note that the smart attachment procedure is never performed
9583	for differencing hard disks.</li>
9584	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
9585	they are designed to be non-writable. If an immutable hard disk is
9586	attached to a virtual machine with snapshots then a special
9587	procedure called smart attachment is performed (see below).</li>
9588	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
9589	also as designed. This also means that writethrough hard disks cannot
9590	have other hard disks linked to them at all.</li>
9591	</ul>
9592
9593	Note that the same hard disk, regardless of its type, may be attached to
9594	more than one virtual machine at a time. In this case, the machine that is
9595	started first gains exclusive access to the hard disk and attempts to
9596	start other machines having this hard disk attached will fail until the
9597	first machine is powered down.
9598
9599	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
9600	that the given hard disk remains associated with the given machine after a
9601	successful <link to="IMachine::detachDevice"/> call until
9602	<link to="IMachine::saveSettings"/> is called to save all changes to
9603	machine settings to disk. This deferring is necessary to guarantee that
9604	the hard disk configuration may be restored at any time by a call to
9605	<link to="IMachine::discardSettings"/> before the settings
9606	are saved (committed).
9607
9608	Note that if <link to="IMachine::discardSettings"/> is called after
9609	indirectly attaching some hard disks to the machine but before a call to
9610	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
9611	all differencing hard disks implicitly created by
9612	<link to="IMachine::attachDevice"/> for these indirect attachments.
9613	Such implicitly created hard disks will also be immediately deleted when
9614	detached explicitly using the <link to="IMachine::detachDevice"/>
9615	call if it is made before <link to="IMachine::saveSettings"/>. This
9616	implicit deletion is safe because newly created differencing hard
9617	disks do not contain any user data.
9618
9619	However, keep in mind that detaching differencing hard disks that were
9620	implicitly created by <link to="IMachine::attachDevice"/>
9621	before the last <link to="IMachine::saveSettings"/> call will
9622	<b>not</b> implicitly delete them as they may already contain some data
9623	(for example, as a result of virtual machine execution). If these hard
9624	disks are no more necessary, the caller can always delete them explicitly
9625	using <link to="#deleteStorage"/> after they are actually de-associated
9626	from this machine by the <link to="IMachine::saveSettings"/> call.
9627
9628	<h3>Smart Attachment</h3>
9629
9630	When normal base or immutable hard disks are indirectly attached to a
9631	virtual machine then some additional steps are performed to make sure the
9632	virtual machine will have the most recent "view" of the hard disk being
9633	attached. These steps include walking through the machine's snapshots
9634	starting from the current one and going through ancestors up to the first
9635	snapshot. Hard disks attached to the virtual machine in all
9636	of the encountered snapshots are checked whether they are descendants of
9637	the given normal base or immutable hard disk. The first found child (which
9638	is the differencing hard disk) will be used instead of the normal base or
9639	immutable hard disk as a parent for creating a new differencing hard disk
9640	that will be actually attached to the machine. And only if no descendants
9641	are found or if the virtual machine does not have any snapshots then the
9642	normal base or immutable hard disk will be used itself as a parent for
9643	this differencing hard disk.
9644
9645	It is easier to explain what smart attachment does using the
9646	following example:
9647	<pre>
9648	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9649
9650	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9651	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9652	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9653	Snapshot 4 (none) Snapshot 4 (none)
9654	CurState (none) CurState (D3->D2.vdi)
9655
9656	NOT
9657	...
9658	CurState (D3->B.vdi)
9659	</pre>
9660	The first column is the virtual machine configuration before the base hard
9661	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9662	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9663	mean that the hard disk that is actually attached to the machine is a
9664	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9665	another hard disk, <tt>B.vdi</tt>.
9666
9667	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9668	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9669	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9670	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9671	it cannot be attached directly and needs an indirect attachment (i.e.
9672	implicit creation of a new differencing hard disk). Due to the smart
9673	attachment procedure, the new differencing hard disk
9674	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9675	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9676	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9677	machine.
9678
9679	Note that if there is more than one descendant hard disk of the given base
9680	hard disk found in a snapshot, and there is an exact device, channel and
9681	bus match, then this exact match will be used. Otherwise, the youngest
9682	descendant will be picked up.
9683
9684	There is one more important aspect of the smart attachment procedure which
9685	is not related to snapshots at all. Before walking through the snapshots
9686	as described above, the backup copy of the current list of hard disk
9687	attachment is searched for descendants. This backup copy is created when
9688	the hard disk configuration is changed for the first time after the last
9689	<link to="IMachine::saveSettings"/> call and used by
9690	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9691	changes. When such a descendant is found in this backup copy, it will be
9692	simply re-attached back, without creating a new differencing hard disk for
9693	it. This optimization is necessary to make it possible to re-attach the
9694	base or immutable hard disk to a different bus, channel or device slot
9695	without losing the contents of the differencing hard disk actually
9696	attached to the machine in place of it.
9697	</desc>
9698
9699	<attribute name="id" type="uuid" mod="string" readonly="yes">
9700	<desc>
9701	UUID of the medium. For a newly created medium, this value is a randomly
9702	generated UUID.
9703
9704	<note>
9705	For media in one of MediumState_NotCreated, MediumState_Creating or
9706	MediumState_Deleting states, the value of this property is undefined
9707	and will most likely be an empty UUID.
9708	</note>
9709	</desc>
9710	</attribute>
9711
9712	<attribute name="description" type="wstring">
9713	<desc>
9714	Optional description of the medium. For a newly created medium the value
9715	of this attribute is an empty string.
9716
9717	Medium types that don't support this attribute will return E_NOTIMPL in
9718	attempt to get or set this attribute's value.
9719
9720	<note>
9721	For some storage types, reading this attribute may return an outdated
9722	(last known) value when <link to="#state"/> is <link
9723	to="MediumState_Inaccessible"/> or <link
9724	to="MediumState_LockedWrite"/> because the value of this attribute is
9725	stored within the storage unit itself. Also note that changing the
9726	attribute value is not possible in such case, as well as when the
9727	medium is the <link to="MediumState_LockedRead"/> state.
9728	</note>
9729	</desc>
9730	</attribute>
9731
9732	<attribute name="state" type="MediumState" readonly="yes">
9733	<desc>
9734	Returns the current medium state, which is the last state set by
9735	the accessibility check performed by <link to="#refreshState"/>.
9736	If that method has not yet been called on the medium, the state
9737	is "Inaccessible"; as opposed to truly inaccessible media, the
9738	value of <link to="#lastAccessError"/> will be an empty string in
9739	that case.
9740
9741	<note>As of version 3.1, this no longer performs an accessibility check
9742	automatically; call <link to="#refreshState"/> for that.
9743	</note>
9744	</desc>
9745	</attribute>
9746
9747	<attribute name="location" type="wstring">
9748	<desc>
9749	Location of the storage unit holding medium data.
9750
9751	The format of the location string is medium type specific. For medium
9752	types using regular files in a host's file system, the location
9753	string is the full file name.
9754
9755	Some medium types may support changing the storage unit location by
9756	simply changing the value of this property. If this operation is not
9757	supported, the implementation will return E_NOTIMPL in attempt to set
9758	this attribute's value.
9759
9760	When setting a value of the location attribute which is a regular file
9761	in the host's file system, the given file name may be either relative to
9762	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9763	absolute. Note that if the given location specification does not contain
9764	the file extension part then a proper default extension will be
9765	automatically appended by the implementation depending on the medium type.
9766	</desc>
9767	</attribute>
9768
9769	<attribute name="name" type="wstring" readonly="yes">
9770	<desc>
9771	Name of the storage unit holding medium data.
9772
9773	The returned string is a short version of the <link to="#location"/>
9774	attribute that is suitable for representing the medium in situations
9775	where the full location specification is too long (such as lists
9776	and comboboxes in GUI frontends). This string is also used by frontends
9777	to sort the media list alphabetically when needed.
9778
9779	For example, for locations that are regular files in the host's file
9780	system, the value of this attribute is just the file name (+ extension),
9781	without the path specification.
9782
9783	Note that as opposed to the <link to="#location"/> attribute, the name
9784	attribute will not necessary be unique for a list of media of the
9785	given type and format.
9786	</desc>
9787	</attribute>
9788
9789	<attribute name="deviceType" type="DeviceType" readonly="yes">
9790	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9791	medium.</desc>
9792	</attribute>
9793
9794	<attribute name="hostDrive" type="boolean" readonly="yes">
9795	<desc>True if this corresponds to a drive on the host.</desc>
9796	</attribute>
9797
9798	<attribute name="size" type="unsigned long long" readonly="yes">
9799	<desc>
9800	Physical size of the storage unit used to hold medium data (in bytes).
9801
9802	<note>
9803	For media whose <link to="#state"/> is <link
9804	to="MediumState_Inaccessible"/>, the value of this property is the
9805	last known size. For <link to="MediumState_NotCreated"/> media,
9806	the returned value is zero.
9807	</note>
9808	</desc>
9809	</attribute>
9810
9811	<attribute name="format" type="wstring" readonly="yes">
9812	<desc>
9813	Storage format of this medium.
9814
9815	The value of this attribute is a string that specifies a backend used
9816	to store medium data. The storage format is defined when you create a
9817	new medium or automatically detected when you open an existing medium,
9818	and cannot be changed later.
9819
9820	The list of all storage formats supported by this VirtualBox
9821	installation can be obtained using
9822	<link to="ISystemProperties::mediumFormats"/>.
9823	</desc>
9824	</attribute>
9825
9826	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9827	<desc>
9828	Storage medium format object corresponding to this medium.
9829
9830	The value of this attribute is a reference to the medium format object
9831	that specifies the backend properties used to store medium data. The
9832	storage format is defined when you create a new medium or automatically
9833	detected when you open an existing medium, and cannot be changed later.
9834
9835	<note>@c null is returned if there is no associated medium format
9836	object. This can e.g. happen for medium objects representing host
9837	drives and other special medium objects.</note>
9838	</desc>
9839	</attribute>
9840
9841	<attribute name="type" type="MediumType">
9842	<desc>
9843	Type (role) of this medium.
9844
9845	The following constraints apply when changing the value of this
9846	attribute:
9847	<ul>
9848	<li>If a medium is attached to a virtual machine (either in the
9849	current state or in one of the snapshots), its type cannot be
9850	changed.
9851	</li>
9852	<li>As long as the medium has children, its type cannot be set
9853	to <link to="MediumType_Writethrough"/>.
9854	</li>
9855	<li>The type of all differencing media is
9856	<link to="MediumType_Normal"/> and cannot be changed.
9857	</li>
9858	</ul>
9859
9860	The type of a newly created or opened medium is set to
9861	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9862	which have a type of <link to="MediumType_Writethrough"/>.
9863	</desc>
9864	</attribute>
9865
9866	<attribute name="parent" type="IMedium" readonly="yes">
9867	<desc>
9868	Parent of this medium (the medium this medium is directly based
9869	on).
9870
9871	Only differencing media have parents. For base (non-differencing)
9872	media, @c null is returned.
9873	</desc>
9874	</attribute>
9875
9876	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9877	<desc>
9878	Children of this medium (all differencing media directly based
9879	on this medium). A @c null array is returned if this medium
9880	does not have any children.
9881	</desc>
9882	</attribute>
9883
9884	<attribute name="base" type="IMedium" readonly="yes">
9885	<desc>
9886	Base medium of this medium.
9887
9888	If this is a differencing medium, its base medium is the medium
9889	the given medium branch starts from. For all other types of media, this
9890	property returns the medium object itself (i.e. the same object this
9891	property is read on).
9892	</desc>
9893	</attribute>
9894
9895	<attribute name="readOnly" type="boolean" readonly="yes">
9896	<desc>
9897	Returns @c true if this medium is read-only and @c false otherwise.
9898
9899	A medium is considered to be read-only when its contents cannot be
9900	modified without breaking the integrity of other parties that depend on
9901	this medium such as its child media or snapshots of virtual machines
9902	where this medium is attached to these machines. If there are no
9903	children and no such snapshots then there is no dependency and the
9904	medium is not read-only.
9905
9906	The value of this attribute can be used to determine the kind of the
9907	attachment that will take place when attaching this medium to a
9908	virtual machine. If the value is @c false then the medium will
9909	be attached directly. If the value is @c true then the medium
9910	will be attached indirectly by creating a new differencing child
9911	medium for that. See the interface description for more information.
9912
9913	Note that all <link to="MediumType_Immutable">Immutable</link> media
9914	are always read-only while all
9915	<link to="MediumType_Writethrough">Writethrough</link> media are
9916	always not.
9917
9918	<note>
9919	The read-only condition represented by this attribute is related to
9920	the medium type and usage, not to the current
9921	<link to="IMedium::state">medium state</link> and not to the read-only
9922	state of the storage unit.
9923	</note>
9924	</desc>
9925	</attribute>
9926
9927	<attribute name="logicalSize" type="unsigned long long" readonly="yes">
9928	<desc>
9929	Logical size of this medium (in megabytes), as reported to the
9930	guest OS running inside the virtual machine this medium is
9931	attached to. The logical size is defined when the medium is created
9932	and cannot be changed later.
9933
9934	<note>
9935	Reading this property on a differencing medium will return the size
9936	of its <link to="#base"/> medium.
9937	</note>
9938	<note>
9939	For media whose state is <link to="#state"/> is <link
9940	to="MediumState_Inaccessible"/>, the value of this property is the
9941	last known logical size. For <link to="MediumaState_NotCreated"/>
9942	media, the returned value is zero.
9943	</note>
9944	</desc>
9945	</attribute>
9946
9947	<attribute name="autoReset" type="boolean">
9948	<desc>
9949	Whether this differencing medium will be automatically reset each
9950	time a virtual machine it is attached to is powered up. This
9951	attribute is automatically set to @c true for the last
9952	differencing image of an "immutable" medium (see
9953	<link to="MediumType" />).
9954
9955	See <link to="#reset"/> for more information about resetting
9956	differencing media.
9957
9958	<note>
9959	Reading this property on a base (non-differencing) medium will
9960	always @c false. Changing the value of this property in this
9961	case is not supported.
9962	</note>
9963
9964	<result name="VBOX_E_NOT_SUPPORTED">
9965	This is not a differencing medium (when changing the attribute
9966	value).
9967	</result>
9968	</desc>
9969	</attribute>
9970
9971	<attribute name="lastAccessError" type="wstring" readonly="yes">
9972	<desc>
9973	Text message that represents the result of the last accessibility
9974	check performed by <link to="#refreshState"/>.
9975
9976	An empty string is returned if the last accessibility check
9977	was successful or has not yet been called. As a result, if
9978	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9979	then <link to="#refreshState"/> has yet to be called; this is the
9980	default value of media after VirtualBox initialization.
9981	A non-empty string indicates a failure and should normally describe
9982	a reason of the failure (for example, a file read error).
9983	</desc>
9984	</attribute>
9985
9986	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9987	<desc>
9988	Array of UUIDs of all machines this medium is attached to.
9989
9990	A @c null array is returned if this medium is not attached to any
9991	machine or to any machine's snapshot.
9992
9993	<note>
9994	The returned array will include a machine even if this medium is not
9995	attached to that machine in the current state but attached to it in
9996	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9997	details.
9998	</note>
9999	</desc>
10000	</attribute>
10001
10002	<method name="refreshState">
10003	<desc>
10004	If the current medium state (see <link to="MediumState"/>) is one of
10005	"Created", "Inaccessible" or "LockedRead", then this performs an
10006	accessibility check on the medium and sets the value of the <link to="#state"/>
10007	attribute accordingly; that value is also returned for convenience.
10008
10009	For all other state values, this does not perform a refresh but returns
10010	the state only.
10011
10012	The refresh, if performed, may take a long time (several seconds or even
10013	minutes, depending on the storage unit location and format) because it performs an
10014	accessibility check of the storage unit. This check may cause a significant
10015	delay if the storage unit of the given medium is, for example, a file located
10016	on a network share which is not currently accessible due to connectivity
10017	problems. In that case, the call will not return until a timeout
10018	interval defined by the host OS for this operation expires. For this reason,
10019	it is recommended to never read this attribute on the main UI thread to avoid
10020	making the UI unresponsive.
10021
10022	If the last known state of the medium is "Created" and the accessibility
10023	check fails, then the state would be set to "Inaccessible", and
10024	<link to="#lastAccessError"/> may be used to get more details about the
10025	failure. If the state of the medium is "LockedRead", then it remains the
10026	same, and a non-empty value of <link to="#lastAccessError"/> will
10027	indicate a failed accessibility check in this case.
10028
10029	Note that not all medium states are applicable to all medium types.
10030	</desc>
10031	<param name="state" type="MediumState" dir="return">
10032	<desc>
10033	New medium state.
10034	</desc>
10035	</param>
10036	</method>
10037
10038	<method name="getSnapshotIds">
10039	<desc>
10040	Returns an array of UUIDs of all snapshots of the given machine where
10041	this medium is attached to.
10042
10043	If the medium is attached to the machine in the current state, then the
10044	first element in the array will always be the ID of the queried machine
10045	(i.e. the value equal to the @c machineId argument), followed by
10046	snapshot IDs (if any).
10047
10048	If the medium is not attached to the machine in the current state, then
10049	the array will contain only snapshot IDs.
10050
10051	The returned array may be @c null if this medium is not attached
10052	to the given machine at all, neither in the current state nor in one of
10053	the snapshots.
10054	</desc>
10055	<param name="machineId" type="uuid" mod="string" dir="in">
10056	<desc>
10057	UUID of the machine to query.
10058	</desc>
10059	</param>
10060	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
10061	<desc>
10062	Array of snapshot UUIDs of the given machine using this medium.
10063	</desc>
10064	</param>
10065	</method>
10066
10067	<method name="lockRead">
10068	<desc>
10069	Locks this medium for reading.
10070
10071	A read lock is shared: many clients can simultaneously lock the
10072	same medium for reading unless it is already locked for writing (see
10073	<link to="#lockWrite"/>) in which case an error is returned.
10074
10075	When the medium is locked for reading, it cannot be modified
10076	from within VirtualBox. This means that any method that changes
10077	the properties of this medium or contents of the storage unit
10078	will return an error (unless explicitly stated otherwise). That
10079	includes an attempt to start a virtual machine that wants to
10080	write to the the medium.
10081
10082	When the virtual machine is started up, it locks for reading all
10083	media it uses in read-only mode. If some medium cannot be locked
10084	for reading, the startup procedure will fail.
10085	A medium is typically locked for reading while it is used by a running
10086	virtual machine but has a depending differencing image that receives
10087	the actual write operations. This way one base medium can have
10088	multiple child differencing images which can be written to
10089	simultaneously. Read-only media such as DVD and floppy images are
10090	also locked for reading only (so they can be in use by multiple
10091	machines simultaneously).
10092
10093	A medium is also locked for reading when it is the source of a
10094	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
10095
10096	The medium locked for reading must be unlocked using the <link
10097	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
10098	can be nested and must be followed by the same number of paired
10099	<link to="#unlockRead"/> calls.
10100
10101	This method sets the medium state (see <link to="#state"/>) to
10102	"LockedRead" on success. The medium's previous state must be
10103	one of "Created", "Inaccessible" or "LockedRead".
10104
10105	Locking an inaccessible medium is not an error; this method performs
10106	a logical lock that prevents modifications of this medium through
10107	the VirtualBox API, not a physical file-system lock of the underlying
10108	storage unit.
10109
10110	This method returns the current state of the medium
10111	<i>before</i> the operation.
10112
10113	<result name="VBOX_E_INVALID_OBJECT_STATE">
10114	Invalid medium state (e.g. not created, locked, inaccessible,
10115	creating, deleting).
10116	</result>
10117
10118	</desc>
10119	<param name="state" type="MediumState" dir="return">
10120	<desc>
10121	State of the medium after the operation.
10122	</desc>
10123	</param>
10124	</method>
10125
10126	<method name="unlockRead">
10127	<desc>
10128	Cancels the read lock previously set by <link to="#lockRead"/>.
10129
10130	For both success and failure, this method returns the current state
10131	of the medium <i>after</i> the operation.
10132
10133	See <link to="#lockRead"/> for more details.
10134
10135	<result name="VBOX_E_INVALID_OBJECT_STATE">
10136	Medium not locked for reading.
10137	</result>
10138
10139	</desc>
10140	<param name="state" type="MediumState" dir="return">
10141	<desc>
10142	State of the medium after the operation.
10143	</desc>
10144	</param>
10145	</method>
10146
10147	<method name="lockWrite">
10148	<desc>
10149	Locks this medium for writing.
10150
10151	A write lock, as opposed to <link to="#lockRead"/>, is
10152	exclusive: there may be only one client holding a write lock,
10153	and there may be no read locks while the write lock is held.
10154	As a result, read-locking fails if a write lock is held, and
10155	write-locking fails if either a read or another write lock is held.
10156
10157	When a medium is locked for writing, it cannot be modified
10158	from within VirtualBox, and it is not guaranteed that the values
10159	of its properties are up-to-date. Any method that changes the
10160	properties of this medium or contents of the storage unit will
10161	return an error (unless explicitly stated otherwise).
10162
10163	When a virtual machine is started up, it locks for writing all
10164	media it uses to write data to. If any medium could not be locked
10165	for writing, the startup procedure will fail. If a medium has
10166	differencing images, then while the machine is running, only
10167	the last ("leaf") differencing image is locked for writing,
10168	whereas its parents are locked for reading only.
10169
10170	A medium is also locked for writing when it is the target of a
10171	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
10172
10173	The medium locked for writing must be unlocked using the <link
10174	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
10175
10176	This method sets the medium state (see <link to="#state"/>) to
10177	"LockedWrite" on success. The medium's previous state must be
10178	either "Created" or "Inaccessible".
10179
10180	Locking an inaccessible medium is not an error; this method performs
10181	a logical lock that prevents modifications of this medium through
10182	the VirtualBox API, not a physical file-system lock of the underlying
10183	storage unit.
10184
10185	For both, success and failure, this method returns the current
10186	state of the medium <i>before</i> the operation.
10187
10188	<result name="VBOX_E_INVALID_OBJECT_STATE">
10189	Invalid medium state (e.g. not created, locked, inaccessible,
10190	creating, deleting).
10191	</result>
10192
10193	</desc>
10194	<param name="state" type="MediumState" dir="return">
10195	<desc>
10196	State of the medium after the operation.
10197	</desc>
10198	</param>
10199	</method>
10200
10201	<method name="unlockWrite">
10202	<desc>
10203	Cancels the write lock previously set by <link to="#lockWrite"/>.
10204
10205	For both success and failure, this method returns the current
10206	state of the medium <i>after</i> the operation.
10207
10208	See <link to="#lockWrite"/> for more details.
10209
10210	<result name="VBOX_E_INVALID_OBJECT_STATE">
10211	Medium not locked for writing.
10212	</result>
10213
10214	</desc>
10215	<param name="state" type="MediumState" dir="return">
10216	<desc>
10217	State of the medium after the operation.
10218	</desc>
10219	</param>
10220	</method>
10221
10222	<method name="close">
10223	<desc>
10224	Closes this medium.
10225
10226	The medium must not be attached to any known virtual machine
10227	and must not have any known child media, otherwise the
10228	operation will fail.
10229
10230	When the medium is successfully closed, it gets removed from
10231	the list of remembered media, but its storage unit is not
10232	deleted. In particular, this means that this medium can be
10233	later opened again using the <link
10234	to="IVirtualBox::openHardDisk"/> call.
10235
10236	Note that after this method successfully returns, the given medium
10237	object becomes uninitialized. This means that any attempt
10238	to call any of its methods or attributes will fail with the
10239	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
10240
10241	<result name="VBOX_E_INVALID_OBJECT_STATE">
10242	Invalid medium state (other than not created, created or
10243	inaccessible).
10244	</result>
10245	<result name="VBOX_E_OBJECT_IN_USE">
10246	Medium attached to virtual machine.
10247	</result>
10248	<result name="VBOX_E_FILE_ERROR">
10249	Settings file not accessible.
10250	</result>
10251	<result name="VBOX_E_XML_ERROR">
10252	Could not parse the settings file.
10253	</result>
10254
10255	</desc>
10256	</method>
10257
10258	<!-- storage methods -->
10259
10260	<method name="getProperty">
10261	<desc>
10262	Returns the value of the custom medium property with the given name.
10263
10264	The list of all properties supported by the given medium format can
10265	be obtained with <link to="IMediumFormat::describeProperties"/>.
10266
10267	Note that if this method returns an empty string in @a value, the
10268	requested property is supported but currently not assigned any value.
10269
10270	<result name="VBOX_E_OBJECT_NOT_FOUND">
10271	Requested property does not exist (not supported by the format).
10272	</result>
10273	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10274	</desc>
10275	<param name="name" type="wstring" dir="in">
10276	<desc>Name of the property to get.</desc>
10277	</param>
10278	<param name="value" type="wstring" dir="return">
10279	<desc>Current property value.</desc>
10280	</param>
10281	</method>
10282
10283	<method name="setProperty">
10284	<desc>
10285	Sets the value of the custom medium property with the given name.
10286
10287	The list of all properties supported by the given medium format can
10288	be obtained with <link to="IMediumFormat::describeProperties"/>.
10289
10290	Note that setting the property value to @c null or an empty string is
10291	equivalent to deleting the existing value. A default value (if it is
10292	defined for this property) will be used by the format backend in this
10293	case.
10294
10295	<result name="VBOX_E_OBJECT_NOT_FOUND">
10296	Requested property does not exist (not supported by the format).
10297	</result>
10298	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10299	</desc>
10300	<param name="name" type="wstring" dir="in">
10301	<desc>Name of the property to set.</desc>
10302	</param>
10303	<param name="value" type="wstring" dir="in">
10304	<desc>Property value to set.</desc>
10305	</param>
10306	</method>
10307
10308	<method name="getProperties">
10309	<desc>
10310	Returns values for a group of properties in one call.
10311
10312	The names of the properties to get are specified using the @a names
10313	argument which is a list of comma-separated property names or
10314	an empty string if all properties are to be returned. Note that currently
10315	the value of this argument is ignored and the method always returns all
10316	existing properties.
10317
10318	The list of all properties supported by the given medium format can
10319	be obtained with <link to="IMediumFormat::describeProperties"/>.
10320
10321	The method returns two arrays, the array of property names corresponding
10322	to the @a names argument and the current values of these properties.
10323	Both arrays have the same number of elements with each elemend at the
10324	given index in the first array corresponds to an element at the same
10325	index in the second array.
10326
10327	Note that for properties that do not have assigned values,
10328	an empty string is returned at the appropriate index in the
10329	@a returnValues array.
10330
10331	</desc>
10332	<param name="names" type="wstring" dir="in">
10333	<desc>
10334	Names of properties to get.
10335	</desc>
10336	</param>
10337	<param name="returnNames" type="wstring" safearray="yes" dir="out">
10338	<desc>Names of returned properties.</desc>
10339	</param>
10340	<param name="returnValues" type="wstring" safearray="yes" dir="return">
10341	<desc>Values of returned properties.</desc>
10342	</param>
10343	</method>
10344
10345	<method name="setProperties">
10346	<desc>
10347	Sets values for a group of properties in one call.
10348
10349	The names of the properties to set are passed in the @a names
10350	array along with the new values for them in the @a values array. Both
10351	arrays have the same number of elements with each elemend at the given
10352	index in the first array corresponding to an element at the same index
10353	in the second array.
10354
10355	If there is at least one property name in @a names that is not valid,
10356	the method will fail before changing the values of any other properties
10357	from the @a names array.
10358
10359	Using this method over <link to="#setProperty"/> is preferred if you
10360	need to set several properties at once since it will result into less
10361	IPC calls.
10362
10363	The list of all properties supported by the given medium format can
10364	be obtained with <link to="IMediumFormat::describeProperties"/>.
10365
10366	Note that setting the property value to @c null or an empty string is
10367	equivalent to deleting the existing value. A default value (if it is
10368	defined for this property) will be used by the format backend in this
10369	case.
10370	</desc>
10371	<param name="names" type="wstring" safearray="yes" dir="in">
10372	<desc>Names of properties to set.</desc>
10373	</param>
10374	<param name="values" type="wstring" safearray="yes" dir="in">
10375	<desc>Values of properties to set.</desc>
10376	</param>
10377	</method>
10378
10379	<!-- storage methods -->
10380
10381	<method name="createBaseStorage">
10382	<desc>
10383	Starts creating a hard disk storage unit (fixed/dynamic, according
10384	to the variant flags) in in the background. The previous storage unit
10385	created for this object, if any, must first be deleted using
10386	<link to="#deleteStorage"/>, otherwise the operation will fail.
10387
10388	Before the operation starts, the medium is placed in
10389	<link to="MediumState_Creating"/> state. If the create operation
10390	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
10391	state.
10392
10393	After the returned progress object reports that the operation has
10394	successfully completed, the medium state will be set to <link
10395	to="MediumState_Created"/>, the medium will be remembered by this
10396	VirtualBox installation and may be attached to virtual machines.
10397
10398	<result name="VBOX_E_NOT_SUPPORTED">
10399	The variant of storage creation operation is not supported. See <link
10400	to="IMediumFormat::capabilities"/>.
10401	</result>
10402	</desc>
10403	<param name="logicalSize" type="unsigned long long" dir="in">
10404	<desc>Maximum logical size of the medium in megabytes.</desc>
10405	</param>
10406	<param name="variant" type="MediumVariant" dir="in">
10407	<desc>Exact image variant which should be created.</desc>
10408	</param>
10409	<param name="progress" type="IProgress" dir="return">
10410	<desc>Progress object to track the operation completion.</desc>
10411	</param>
10412	</method>
10413
10414	<method name="deleteStorage">
10415	<desc>
10416	Starts deleting the storage unit of this medium.
10417
10418	The medium must not be attached to any known virtual machine and must
10419	not have any known child media, otherwise the operation will fail.
10420	It will also fail if there is no storage unit to delete or if deletion
10421	is already in progress, or if the medium is being in use (locked for
10422	read or for write) or inaccessible. Therefore, the only valid state for
10423	this operation to succeed is <link to="MediumState_Created"/>.
10424
10425	Before the operation starts, the medium is placed in
10426	<link to="MediumState_Deleting"/> state and gets removed from the list
10427	of remembered hard disks (media registry). If the delete operation
10428	fails, the medium will be remembered again and placed back to
10429	<link to="MediumState_Created"/> state.
10430
10431	After the returned progress object reports that the operation is
10432	complete, the medium state will be set to
10433	<link to="MediumState_NotCreated"/> and you will be able to use one of
10434	the storage creation methods to create it again.
10435
10436	<see>#close()</see>
10437
10438	<result name="VBOX_E_OBJECT_IN_USE">
10439	Medium is attached to a virtual machine.
10440	</result>
10441	<result name="VBOX_E_NOT_SUPPORTED">
10442	Storage deletion is not allowed because neither of storage creation
10443	operations are supported. See
10444	<link to="IMediumFormat::capabilities"/>.
10445	</result>
10446
10447	<note>
10448	If the deletion operation fails, it is not guaranteed that the storage
10449	unit still exists. You may check the <link to="IMedium::state"/> value
10450	to answer this question.
10451	</note>
10452	</desc>
10453	<param name="progress" type="IProgress" dir="return">
10454	<desc>Progress object to track the operation completion.</desc>
10455	</param>
10456	</method>
10457
10458	<!-- diff methods -->
10459
10460	<method name="createDiffStorage">
10461	<desc>
10462	Starts creating an empty differencing storage unit based on this
10463	medium in the format and at the location defined by the @a target
10464	argument.
10465
10466	The target medium must be in <link to="MediumState_NotCreated"/>
10467	state (i.e. must not have an existing storage unit). Upon successful
10468	completion, this operation will set the type of the target medium to
10469	<link to="MediumType_Normal"/> and create a storage unit necessary to
10470	represent the differencing medium data in the given format (according
10471	to the storage format of the target object).
10472
10473	After the returned progress object reports that the operation is
10474	successfully complete, the target medium gets remembered by this
10475	VirtualBox installation and may be attached to virtual machines.
10476
10477	<note>
10478	The medium will be set to <link to="MediumState_LockedRead"/>
10479	state for the duration of this operation.
10480	</note>
10481	<result name="VBOX_E_OBJECT_IN_USE">
10482	Medium not in @c NotCreated state.
10483	</result>
10484	</desc>
10485	<param name="target" type="IMedium" dir="in">
10486	<desc>Target medium.</desc>
10487	</param>
10488	<param name="variant" type="MediumVariant" dir="in">
10489	<desc>Exact image variant which should be created.</desc>
10490	</param>
10491	<param name="progress" type="IProgress" dir="return">
10492	<desc>Progress object to track the operation completion.</desc>
10493	</param>
10494	</method>
10495
10496	<method name="mergeTo">
10497	<desc>
10498	Starts merging the contents of this medium and all intermediate
10499	differencing media in the chain to the given target medium.
10500
10501	The target medium must be either a descendant of this medium or
10502	its ancestor (otherwise this method will immediately return a failure).
10503	It follows that there are two logical directions of the merge operation:
10504	from ancestor to descendant (<i>forward merge</i>) and from descendant to
10505	ancestor (<i>backward merge</i>). Let us consider the following medium
10506	chain:
10507
10508	<pre>Base <- Diff_1 <- Diff_2</pre>
10509
10510	Here, calling this method on the <tt>Base</tt> medium object with
10511	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
10512	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
10513	merge. Note that in both cases the contents of the resulting medium
10514	will be the same, the only difference is the medium object that takes
10515	the result of the merge operation. In case of the forward merge in the
10516	above example, the result will be written to <tt>Diff_2</tt>; in case of
10517	the backward merge, the result will be written to <tt>Base</tt>. In
10518	other words, the result of the operation is always stored in the target
10519	medium.
10520
10521	Upon successful operation completion, the storage units of all media in
10522	the chain between this (source) medium and the target medium, including
10523	the source medium itself, will be automatically deleted and the
10524	relevant medium objects (including this medium) will become
10525	uninitialized. This means that any attempt to call any of
10526	their methods or attributes will fail with the
10527	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
10528	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
10529	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
10530	Note that <tt>Diff_2</tt> in this case will become a base medium
10531	itself since it will no longer be based on any other medium.
10532
10533	Considering the above, all of the following conditions must be met in
10534	order for the merge operation to succeed:
10535	<ul>
10536	<li>
10537	Neither this (source) medium nor any intermediate
10538	differencing medium in the chain between it and the target
10539	medium is attached to any virtual machine.
10540	</li>
10541	<li>
10542	Neither the source medium nor the target medium is an
10543	<link to="MediumType_Immutable"/> medium.
10544	</li>
10545	<li>
10546	The part of the medium tree from the source medium to the
10547	target medium is a linear chain, i.e. all medium in this
10548	chain have exactly one child which is the next medium in this
10549	chain. The only exception from this rule is the target medium in
10550	the forward merge operation; it is allowed to have any number of
10551	child media because the merge operation will not change its
10552	logical contents (as it is seen by the guest OS or by children).
10553	</li>
10554	<li>
10555	None of the involved media are in
10556	<link to="MediumState_LockedRead"/> or
10557	<link to="MediumState_LockedWrite"/> state.
10558	</li>
10559	</ul>
10560
10561	<note>
10562	This (source) medium and all intermediates will be placed to <link
10563	to="MediumState_Deleting"/> state and the target medium will be
10564	placed to <link to="MediumState_LockedWrite"/> state and for the
10565	duration of this operation.
10566	</note>
10567	</desc>
10568	<param name="target" type="IMedium" dir="in">
10569	<desc>Target medium.</desc>
10570	</param>
10571	<param name="progress" type="IProgress" dir="return">
10572	<desc>Progress object to track the operation completion.</desc>
10573	</param>
10574	</method>
10575
10576	<!-- clone method -->
10577
10578	<method name="cloneTo">
10579	<desc>
10580	Starts creating a clone of this medium in the format and at the
10581	location defined by the @a target argument.
10582
10583	The target medium must be either in <link to="MediumState_NotCreated"/>
10584	state (i.e. must not have an existing storage unit) or in
10585	<link to="MediumState_Created"/> state (i.e. created and not locked, and
10586	big enough to hold the data or else the copy will be partial). Upon
10587	successful completion, the cloned medium will contain exactly the
10588	same sector data as the medium being cloned, except that in the
10589	first case a new UUID for the clone will be randomly generated, and in
10590	the second case the UUID will remain unchanged.
10591
10592	The @a parent argument defines which medium will be the parent
10593	of the clone. Passing a @c null reference indicates that the clone will
10594	be a base image, i.e. completely independent. It is possible to specify
10595	an arbitrary medium for this parameter, including the parent of the
10596	medium which is being cloned. Even cloning to a child of the source
10597	medium is possible. Note that when cloning to an existing image, the
10598	@a parent irgument is ignored.
10599
10600	After the returned progress object reports that the operation is
10601	successfully complete, the target medium gets remembered by this
10602	VirtualBox installation and may be attached to virtual machines.
10603
10604	<note>
10605	This medium will be placed to <link to="MediumState_LockedRead"/>
10606	state for the duration of this operation.
10607	</note>
10608	<result name="E_NOTIMPL">
10609	The specified cloning variant is not supported at the moment.
10610	</result>
10611	</desc>
10612	<param name="target" type="IMedium" dir="in">
10613	<desc>Target medium.</desc>
10614	</param>
10615	<param name="variant" type="MediumVariant" dir="in">
10616	<desc>Exact image variant which should be created.</desc>
10617	</param>
10618	<param name="parent" type="IMedium" dir="in">
10619	<desc>Parent of the cloned medium.</desc>
10620	</param>
10621	<param name="progress" type="IProgress" dir="return">
10622	<desc>Progress object to track the operation completion.</desc>
10623	</param>
10624	</method>
10625
10626	<!-- other methods -->
10627
10628	<method name="compact">
10629	<desc>
10630	Starts compacting of this medium. This means that the medium is
10631	transformed into a possibly more compact storage representation.
10632	This potentially creates temporary images, which can require a
10633	substantial amount of additional disk space.
10634
10635	This medium will be placed to <link to="MediumState_LockedWrite"/>
10636	state and all its parent media (if any) will be placed to
10637	<link to="MediumState_LockedRead"/> state for the duration of this
10638	operation.
10639
10640	Please note that the results can be either returned straight away,
10641	or later as the result of the background operation via the object
10642	returned via the @a progress parameter.
10643
10644	<result name="VBOX_E_NOT_SUPPORTED">
10645	Medium format does not support compacting (but potentially
10646	needs it).
10647	</result>
10648	</desc>
10649	<param name="progress" type="IProgress" dir="return">
10650	<desc>Progress object to track the operation completion.</desc>
10651	</param>
10652	</method>
10653
10654	<method name="resize">
10655	<desc>
10656	Starts resizing this medium. This means that the nominal size of the
10657	medium is set to the new value. Both increasing and decreasing the
10658	size is possible, and there are no safety checks, since VirtualBox
10659	does not make any assumptions about the medium contents.
10660
10661	Resizing usually needs additional disk space, and possibly also
10662	some temporary disk space. Note that resize does not create a full
10663	temporary copy of the medium, so the additional disk space requirement
10664	is usually much lower than using the clone operation.
10665
10666	This medium will be placed to <link to="MediumState_LockedWrite"/>
10667	state for the duration of this operation.
10668
10669	Please note that the results can be either returned straight away,
10670	or later as the result of the background operation via the object
10671	returned via the @a progress parameter.
10672
10673	<result name="VBOX_E_NOT_SUPPORTED">
10674	Medium format does not support resizing.
10675	</result>
10676	</desc>
10677	<param name="logicalSize" type="unsigned long long" dir="in">
10678	<desc>New nominal capacity of the medium in megabytes.</desc>
10679	</param>
10680	<param name="progress" type="IProgress" dir="return">
10681	<desc>Progress object to track the operation completion.</desc>
10682	</param>
10683	</method>
10684
10685	<method name="reset">
10686	<desc>
10687	Starts erasing the contents of this differencing medium.
10688
10689	This operation will reset the differencing medium to its initial
10690	state when it does not contain any sector data and any read operation is
10691	redirected to its parent medium. This automatically gets called
10692	during VM power-up for every medium whose <link to="#autoReset" />
10693	attribute is @c true.
10694
10695	The medium will be write-locked for the duration of this operation (see
10696	<link to="#lockWrite" />).
10697
10698	<result name="VBOX_E_NOT_SUPPORTED">
10699	This is not a differencing medium.
10700	</result>
10701	<result name="VBOX_E_INVALID_OBJECT_STATE">
10702	Medium is not in <link to="MediumState_Created"/> or
10703	<link to="MediumState_Inaccessible"/> state.
10704	</result>
10705	</desc>
10706	<param name="progress" type="IProgress" dir="return">
10707	<desc>Progress object to track the operation completion.</desc>
10708	</param>
10709	</method>
10710
10711	</interface>
10712
10713
10714	<!--
10715	// IMediumFormat
10716	/////////////////////////////////////////////////////////////////////////
10717	-->
10718
10719	<enum
10720	name="DataType"
10721	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10722	>
10723	<const name="Int32" value="0"/>
10724	<const name="Int8" value="1"/>
10725	<const name="String" value="2"/>
10726	</enum>
10727
10728	<enum
10729	name="DataFlags"
10730	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10731	>
10732	<const name="None" value="0x00"/>
10733	<const name="Mandatory" value="0x01"/>
10734	<const name="Expert" value="0x02"/>
10735	<const name="Array" value="0x04"/>
10736	<const name="FlagMask" value="0x07"/>
10737	</enum>
10738
10739	<enum
10740	name="MediumFormatCapabilities"
10741	uuid="70fcf810-99e8-4edc-aee4-7f51d489e657"
10742	>
10743	<desc>
10744	Medium format capability flags.
10745	</desc>
10746
10747	<const name="Uuid" value="0x01">
10748	<desc>
10749	Supports UUIDs as expected by VirtualBox code.
10750	</desc>
10751	</const>
10752
10753	<const name="CreateFixed" value="0x02">
10754	<desc>
10755	Supports creating fixed size images, allocating all space instantly.
10756	</desc>
10757	</const>
10758
10759	<const name="CreateDynamic" value="0x04">
10760	<desc>
10761	Supports creating dynamically growing images, allocating space on
10762	demand.
10763	</desc>
10764	</const>
10765
10766	<const name="CreateSplit2G" value="0x08">
10767	<desc>
10768	Supports creating images split in chunks of a bit less than 2 GBytes.
10769	</desc>
10770	</const>
10771
10772	<const name="Differencing" value="0x10">
10773	<desc>
10774	Supports being used as a format for differencing media (see <link
10775	to="IMedium::createDiffStorage"/>).
10776	</desc>
10777	</const>
10778
10779	<const name="Asynchronous" value="0x20">
10780	<desc>
10781	Supports asynchronous I/O operations for at least some configurations.
10782	</desc>
10783	</const>
10784
10785	<const name="File" value="0x40">
10786	<desc>
10787	The format backend operates on files (the <link to="IMedium::location"/>
10788	attribute of the medium specifies a file used to store medium
10789	data; for a list of supported file extensions see
10790	<link to="IMediumFormat::fileExtensions"/>).
10791	</desc>
10792	</const>
10793
10794	<const name="Properties" value="0x80">
10795	<desc>
10796	The format backend uses the property interface to configure the storage
10797	location and properties (the <link to="IMediumFormat::describeProperties"/>
10798	method is used to get access to properties supported by the given medium format).
10799	</desc>
10800	</const>
10801
10802	<const name="CapabilityMask" value="0xFF"/>
10803	</enum>
10804
10805	<interface
10806	name="IMediumFormat" extends="$unknown"
10807	uuid="89f52554-d469-4799-9fad-1705e86a08b1"
10808	wsmap="managed"
10809	>
10810	<desc>
10811	The IMediumFormat interface represents a medium format.
10812
10813	Each medium format has an associated backend which is used to handle
10814	media stored in this format. This interface provides information
10815	about the properties of the associated backend.
10816
10817	Each medium format is identified by a string represented by the
10818	<link to="#id"/> attribute. This string is used in calls like
10819	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10820	format.
10821
10822	The list of all supported medium formats can be obtained using
10823	<link to="ISystemProperties::mediaFormats"/>.
10824
10825	<see>IMedium</see>
10826	</desc>
10827
10828	<attribute name="id" type="wstring" readonly="yes">
10829	<desc>
10830	Identifier of this format.
10831
10832	The format identifier is a non-@c null non-empty ASCII string. Note that
10833	this string is case-insensitive. This means that, for example, all of
10834	the following strings:
10835	<pre>
10836	"VDI"
10837	"vdi"
10838	"VdI"</pre>
10839	refer to the same medium format.
10840
10841	This string is used in methods of other interfaces where it is necessary
10842	to specify a medium format, such as
10843	<link to="IVirtualBox::createHardDisk"/>.
10844	</desc>
10845	</attribute>
10846
10847	<attribute name="name" type="wstring" readonly="yes">
10848	<desc>
10849	Human readable description of this format.
10850
10851	Mainly for use in file open dialogs.
10852	</desc>
10853	</attribute>
10854
10855	<attribute name="fileExtensions" type="wstring" safearray="yes" readonly="yes">
10856	<desc>
10857	Array of strings containing the supported file extensions.
10858
10859	The first extension in the array is the extension preferred by the
10860	backend. It is recommended to use this extension when specifying a
10861	location of the storage unit for a new medium.
10862
10863	Note that some backends do not work on files, so this array may be
10864	empty.
10865
10866	<see>IMediumFormat::capabilities</see>
10867	</desc>
10868	</attribute>
10869
10870	<attribute name="capabilities" type="unsigned long" readonly="yes">
10871	<desc>
10872	Capabilities of the format as a set of bit flags.
10873
10874	For the meaning of individual capability flags see
10875	<link to="MediumFormatCapabilities"/>.
10876	</desc>
10877	</attribute>
10878
10879	<method name="describeProperties">
10880	<desc>
10881	Returns several arrays describing the properties supported by this
10882	format.
10883
10884	An element with the given index in each array describes one
10885	property. Thus, the number of elements in each returned array is the
10886	same and corresponds to the number of supported properties.
10887
10888	The returned arrays are filled in only if the
10889	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10890	All arguments must be non-@c null.
10891
10892	<see>DataType</see>
10893	<see>DataFlags</see>
10894	</desc>
10895
10896	<param name="names" type="wstring" safearray="yes" dir="out">
10897	<desc>Array of property names.</desc>
10898	</param>
10899	<param name="description" type="wstring" safearray="yes" dir="out">
10900	<desc>Array of property descriptions.</desc>
10901	</param>
10902	<param name="types" type="DataType" safearray="yes" dir="out">
10903	<desc>Array of property types.</desc>
10904	</param>
10905	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10906	<desc>Array of property flags.</desc>
10907	</param>
10908	<param name="defaults" type="wstring" safearray="yes" dir="out">
10909	<desc>Array of default property values.</desc>
10910	</param>
10911	</method>
10912
10913	</interface>
10914
10915
10916	<!--
10917	// IKeyboard
10918	/////////////////////////////////////////////////////////////////////////
10919	-->
10920
10921	<interface
10922	name="IKeyboard" extends="$unknown"
10923	uuid="2d1a531b-4c6e-49cc-8af6-5c857b78b5d7"
10924	wsmap="managed"
10925	>
10926	<desc>
10927	The IKeyboard interface represents the virtual machine's keyboard. Used
10928	in <link to="IConsole::keyboard"/>.
10929
10930	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10931	to the virtual machine.
10932
10933	</desc>
10934	<method name="putScancode">
10935	<desc>Sends a scancode to the keyboard.
10936
10937	<result name="VBOX_E_IPRT_ERROR">
10938	Could not send scan code to virtual keyboard.
10939	</result>
10940
10941	</desc>
10942	<param name="scancode" type="long" dir="in"/>
10943	</method>
10944
10945	<method name="putScancodes">
10946	<desc>Sends an array of scancodes to the keyboard.
10947
10948	<result name="VBOX_E_IPRT_ERROR">
10949	Could not send all scan codes to virtual keyboard.
10950	</result>
10951
10952	</desc>
10953	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10954	<param name="codesStored" type="unsigned long" dir="return"/>
10955	</method>
10956
10957	<method name="putCAD">
10958	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10959	function is nothing special, it is just a convenience function
10960	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10961
10962	<result name="VBOX_E_IPRT_ERROR">
10963	Could not send all scan codes to virtual keyboard.
10964	</result>
10965
10966	</desc>
10967	</method>
10968
10969	</interface>
10970
10971
10972	<!--
10973	// IMouse
10974	/////////////////////////////////////////////////////////////////////////
10975	-->
10976
10977	<enum
10978	name="MouseButtonState"
10979	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10980	>
10981	<desc>
10982	Mouse button state.
10983	</desc>
10984
10985	<const name="LeftButton" value="0x01"/>
10986	<const name="RightButton" value="0x02"/>
10987	<const name="MiddleButton" value="0x04"/>
10988	<const name="WheelUp" value="0x08"/>
10989	<const name="WheelDown" value="0x10"/>
10990	<const name="XButton1" value="0x20"/>
10991	<const name="XButton2" value="0x40"/>
10992	<const name="MouseStateMask" value="0x7F"/>
10993	</enum>
10994
10995	<interface
10996	name="IMouse" extends="$unknown"
10997	uuid="7c0f2eae-f92d-498c-b802-e1a3763774dc"
10998	wsmap="managed"
10999	>
11000	<desc>
11001	The IMouse interface represents the virtual machine's mouse. Used in
11002	<link to="IConsole::mouse"/>.
11003
11004	Through this interface, the virtual machine's virtual mouse can be
11005	controlled.
11006	</desc>
11007
11008	<attribute name="absoluteSupported" type="boolean" readonly="yes">
11009	<desc>
11010	Whether the guest OS supports absolute mouse pointer positioning
11011	or not.
11012	<note>
11013	You can use the <link to="IConsoleCallback::onMouseCapabilityChange"/>
11014	callback to be instantly informed about changes of this attribute
11015	during virtual machine execution.
11016	</note>
11017	<see><link to="#putMouseEventAbsolute"/></see>
11018	</desc>
11019	</attribute>
11020
11021	<attribute name="relativeSupported" type="boolean" readonly="yes">
11022	<desc>
11023	Whether the guest OS supports relative mouse pointer positioning
11024	or not.
11025	<note>
11026	You can use the <link to="IConsoleCallback::onMouseCapabilityChange"/>
11027	callback to be instantly informed about changes of this attribute
11028	during virtual machine execution.
11029	</note>
11030	<see><link to="#putMouseEvent"/></see>
11031	</desc>
11032	</attribute>
11033
11034	<attribute name="needsHostCursor" type="boolean" readonly="yes">
11035	<desc>
11036	Whether the guest OS can currently switch to drawing it's own mouse
11037	cursor on demand.
11038	<note>
11039	You can use the <link to="IConsoleCallback::onMouseCapabilityChange"/>
11040	callback to be instantly informed about changes of this attribute
11041	during virtual machine execution.
11042	</note>
11043	<see><link to="#putMouseEvent"/></see>
11044	</desc>
11045	</attribute>
11046
11047	<method name="putMouseEvent">
11048	<desc>
11049	Initiates a mouse event using relative pointer movements
11050	along x and y axis.
11051
11052	<result name="E_ACCESSDENIED">
11053	Console not powered up.
11054	</result>
11055	<result name="VBOX_E_IPRT_ERROR">
11056	Could not send mouse event to virtual mouse.
11057	</result>
11058
11059	</desc>
11060
11061	<param name="dx" type="long" dir="in">
11062	<desc>
11063	Amount of pixels the mouse should move to the right.
11064	Negative values move the mouse to the left.
11065	</desc>
11066	</param>
11067	<param name="dy" type="long" dir="in">
11068	<desc>
11069	Amount of pixels the mouse should move downwards.
11070	Negative values move the mouse upwards.
11071	</desc>
11072	</param>
11073	<param name="dz" type="long" dir="in">
11074	<desc>
11075	Amount of mouse wheel moves.
11076	Positive values describe clockwise wheel rotations,
11077	negative values describe counterclockwise rotations.
11078	</desc>
11079	</param>
11080	<param name="dw" type="long" dir="in">
11081	<desc>
11082	Amount of horizontal mouse wheel moves.
11083	Positive values describe a movement to the left,
11084	negative values describe a movement to the right.
11085	</desc>
11086	</param>
11087	<param name="buttonState" type="long" dir="in">
11088	<desc>
11089	The current state of mouse buttons. Every bit represents
11090	a mouse button as follows:
11091	<table>
11092	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
11093	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
11094	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
11095	</table>
11096	A value of <tt>1</tt> means the corresponding button is pressed.
11097	otherwise it is released.
11098	</desc>
11099	</param>
11100	</method>
11101
11102	<method name="putMouseEventAbsolute">
11103	<desc>
11104	Positions the mouse pointer using absolute x and y coordinates.
11105	These coordinates are expressed in pixels and
11106	start from <tt>[1,1]</tt> which corresponds to the top left
11107	corner of the virtual display.
11108
11109	<result name="E_ACCESSDENIED">
11110	Console not powered up.
11111	</result>
11112	<result name="VBOX_E_IPRT_ERROR">
11113	Could not send mouse event to virtual mouse.
11114	</result>
11115
11116	<note>
11117	This method will have effect only if absolute mouse
11118	positioning is supported by the guest OS.
11119	</note>
11120
11121	<see><link to="#absoluteSupported"/></see>
11122	</desc>
11123
11124	<param name="x" type="long" dir="in">
11125	<desc>
11126	X coordinate of the pointer in pixels, starting from @c 1.
11127	</desc>
11128	</param>
11129	<param name="y" type="long" dir="in">
11130	<desc>
11131	Y coordinate of the pointer in pixels, starting from @c 1.
11132	</desc>
11133	</param>
11134	<param name="dz" type="long" dir="in">
11135	<desc>
11136	Amount of mouse wheel moves.
11137	Positive values describe clockwise wheel rotations,
11138	negative values describe counterclockwise rotations.
11139	</desc>
11140	</param>
11141	<param name="dw" type="long" dir="in">
11142	<desc>
11143	Amount of horizontal mouse wheel moves.
11144	Positive values describe a movement to the left,
11145	negative values describe a movement to the right.
11146	</desc>
11147	</param>
11148	<param name="buttonState" type="long" dir="in">
11149	<desc>
11150	The current state of mouse buttons. Every bit represents
11151	a mouse button as follows:
11152	<table>
11153	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
11154	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
11155	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
11156	</table>
11157	A value of @c 1 means the corresponding button is pressed.
11158	otherwise it is released.
11159	</desc>
11160	</param>
11161	</method>
11162
11163	</interface>
11164
11165	<!--
11166	// IDisplay
11167	/////////////////////////////////////////////////////////////////////////
11168	-->
11169
11170	<enum
11171	name="FramebufferPixelFormat"
11172	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
11173	>
11174	<desc>
11175	Format of the video memory buffer. Constants represented by this enum can
11176	be used to test for particular values of <link
11177	to="IFramebuffer::pixelFormat"/>. See also <link
11178	to="IFramebuffer::requestResize"/>.
11179
11180	See also www.fourcc.org for more information about FOURCC pixel formats.
11181	</desc>
11182
11183	<const name="Opaque" value="0">
11184	<desc>
11185	Unknown buffer format (the user may not assume any particular format of
11186	the buffer).
11187	</desc>
11188	</const>
11189	<const name="FOURCC_RGB" value="0x32424752">
11190	<desc>
11191	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
11192	bit layout).
11193	</desc>
11194	</const>
11195	</enum>
11196
11197	<interface
11198	name="IFramebuffer" extends="$unknown"
11199	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
11200	wsmap="suppress"
11201	>
11202	<attribute name="address" type="octet" mod="ptr" readonly="yes">
11203	<desc>Address of the start byte of the frame buffer.</desc>
11204	</attribute>
11205
11206	<attribute name="width" type="unsigned long" readonly="yes">
11207	<desc>Frame buffer width, in pixels.</desc>
11208	</attribute>
11209
11210	<attribute name="height" type="unsigned long" readonly="yes">
11211	<desc>Frame buffer height, in pixels.</desc>
11212	</attribute>
11213
11214	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
11215	<desc>
11216	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
11217	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
11218	are: 8, 15, 16, 24 and 32.
11219	</desc>
11220	</attribute>
11221
11222	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
11223	<desc>
11224	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
11225	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
11226	size of the scan line must be aligned to 32 bits.
11227	</desc>
11228	</attribute>
11229
11230	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
11231	<desc>
11232	Frame buffer pixel format. It's either one of the values defined by <link
11233	to="FramebufferPixelFormat"/> or a raw FOURCC code.
11234	<note>
11235	This attribute must never return <link
11236	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
11237	<link to="#address"/> points to must be always known.
11238	</note>
11239	</desc>
11240	</attribute>
11241
11242	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
11243	<desc>
11244	Defines whether this frame buffer uses the virtual video card's memory
11245	buffer (guest VRAM) directly or not. See <link
11246	to="IFramebuffer::requestResize"/> for more information.
11247	</desc>
11248	</attribute>
11249
11250	<attribute name="heightReduction" type="unsigned long" readonly="yes">
11251	<desc>
11252	Hint from the frame buffer about how much of the standard
11253	screen height it wants to use for itself. This information is
11254	exposed to the guest through the VESA BIOS and VMMDev interface
11255	so that it can use it for determining its video mode table. It
11256	is not guaranteed that the guest respects the value.
11257	</desc>
11258	</attribute>
11259
11260	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
11261	<desc>
11262	An alpha-blended overlay which is superposed over the frame buffer.
11263	The initial purpose is to allow the display of icons providing
11264	information about the VM state, including disk activity, in front
11265	ends which do not have other means of doing that. The overlay is
11266	designed to controlled exclusively by IDisplay. It has no locking
11267	of its own, and any changes made to it are not guaranteed to be
11268	visible until the affected portion of IFramebuffer is updated. The
11269	overlay can be created lazily the first time it is requested. This
11270	attribute can also return @c null to signal that the overlay is not
11271	implemented.
11272	</desc>
11273	</attribute>
11274
11275	<attribute name="winId" type="unsigned long long" readonly="yes">
11276	<desc>
11277	Platform-dependent identifier of the window where context of this
11278	frame buffer is drawn, or zero if there's no such window.
11279	</desc>
11280	</attribute>
11281
11282	<method name="lock">
11283	<desc>
11284	Locks the frame buffer.
11285	Gets called by the IDisplay object where this frame buffer is
11286	bound to.
11287	</desc>
11288	</method>
11289
11290	<method name="unlock">
11291	<desc>
11292	Unlocks the frame buffer.
11293	Gets called by the IDisplay object where this frame buffer is
11294	bound to.
11295	</desc>
11296	</method>
11297
11298	<method name="notifyUpdate">
11299	<desc>
11300	Informs about an update.
11301	Gets called by the display object where this buffer is
11302	registered.
11303	</desc>
11304	<param name="x" type="unsigned long" dir="in"/>
11305	<param name="y" type="unsigned long" dir="in"/>
11306	<param name="width" type="unsigned long" dir="in"/>
11307	<param name="height" type="unsigned long" dir="in"/>
11308	</method>
11309
11310	<method name="requestResize">
11311	<desc>
11312	Requests a size and pixel format change.
11313
11314	There are two modes of working with the video buffer of the virtual
11315	machine. The <i>indirect</i> mode implies that the IFramebuffer
11316	implementation allocates a memory buffer for the requested display mode
11317	and provides it to the virtual machine. In <i>direct</i> mode, the
11318	IFramebuffer implementation uses the memory buffer allocated and owned
11319	by the virtual machine. This buffer represents the video memory of the
11320	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
11321	usually faster because the implementation gets a raw pointer to the
11322	guest VRAM buffer which it can directly use for visualizing the contents
11323	of the virtual display, as opposed to the indirect mode where the
11324	contents of guest VRAM are copied to the memory buffer provided by
11325	the implementation every time a display update occurs.
11326
11327	It is important to note that the direct mode is really fast only when
11328	the implementation uses the given guest VRAM buffer directly, for
11329	example, by blitting it to the window representing the virtual machine's
11330	display, which saves at least one copy operation comparing to the
11331	indirect mode. However, using the guest VRAM buffer directly is not
11332	always possible: the format and the color depth of this buffer may be
11333	not supported by the target window, or it may be unknown (opaque) as in
11334	case of text or non-linear multi-plane VGA video modes. In this case,
11335	the indirect mode (that is always available) should be used as a
11336	fallback: when the guest VRAM contents are copied to the
11337	implementation-provided memory buffer, color and format conversion is
11338	done automatically by the underlying code.
11339
11340	The @a pixelFormat parameter defines whether the direct mode is
11341	available or not. If @a pixelFormat is <link
11342	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
11343	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
11344	@a bytesPerLine parameters must be ignored and the implementation must use
11345	the indirect mode (where it provides its own buffer in one of the
11346	supported formats). In all other cases, @a pixelFormat together with
11347	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
11348	buffer pointed to by the @a VRAM parameter and the implementation is
11349	free to choose which mode to use. To indicate that this frame buffer uses
11350	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
11351	attribute must return @c true and <link to="#address"/> must
11352	return exactly the same address that is passed in the @a VRAM parameter
11353	of this method; otherwise it is assumed that the indirect strategy is
11354	chosen.
11355
11356	The @a width and @a height parameters represent the size of the
11357	requested display mode in both modes. In case of indirect mode, the
11358	provided memory buffer should be big enough to store data of the given
11359	display mode. In case of direct mode, it is guaranteed that the given
11360	@a VRAM buffer contains enough space to represent the display mode of the
11361	given size. Note that this frame buffer's <link to="#width"/> and <link
11362	to="#height"/> attributes must return exactly the same values as
11363	passed to this method after the resize is completed (see below).
11364
11365	The @a finished output parameter determines if the implementation has
11366	finished resizing the frame buffer or not. If, for some reason, the
11367	resize cannot be finished immediately during this call, @a finished
11368	must be set to @c false, and the implementation must call
11369	<link to="IDisplay::resizeCompleted"/> after it has returned from
11370	this method as soon as possible. If @a finished is @c false, the
11371	machine will not call any frame buffer methods until
11372	<link to="IDisplay::resizeCompleted"/> is called.
11373
11374	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
11375	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
11376	this frame buffer must return exactly the same values as specified in the
11377	parameters of this method, after the resize is completed. If the
11378	indirect mode is chosen, these attributes must return values describing
11379	the format of the implementation's own memory buffer <link
11380	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
11381	value must always correlate with <link to="#pixelFormat"/>. Note that
11382	the <link to="#pixelFormat"/> attribute must never return <link
11383	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
11384
11385	<note>
11386	This method is called by the IDisplay object under the
11387	<link to="#lock"/> provided by this IFramebuffer
11388	implementation. If this method returns @c false in @a finished, then
11389	this lock is not released until
11390	<link to="IDisplay::resizeCompleted"/> is called.
11391	</note>
11392	</desc>
11393	<param name="screenId" type="unsigned long" dir="in">
11394	<desc>
11395	Logical screen number. Must be used in the corresponding call to
11396	<link to="IDisplay::resizeCompleted"/> if this call is made.
11397	</desc>
11398	</param>
11399	<param name="pixelFormat" type="unsigned long" dir="in">
11400	<desc>
11401	Pixel format of the memory buffer pointed to by @a VRAM.
11402	See also <link to="FramebufferPixelFormat"/>.
11403	</desc>
11404	</param>
11405	<param name="VRAM" type="octet" mod="ptr" dir="in">
11406	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
11407	</param>
11408	<param name="bitsPerPixel" type="unsigned long" dir="in">
11409	<desc>Color depth, bits per pixel.</desc>
11410	</param>
11411	<param name="bytesPerLine" type="unsigned long" dir="in">
11412	<desc>Size of one scan line, in bytes.</desc>
11413	</param>
11414	<param name="width" type="unsigned long" dir="in">
11415	<desc>Width of the guest display, in pixels.</desc>
11416	</param>
11417	<param name="height" type="unsigned long" dir="in">
11418	<desc>Height of the guest display, in pixels.</desc>
11419	</param>
11420	<param name="finished" type="boolean" dir="return">
11421	<desc>
11422	Can the VM start using the new frame buffer immediately
11423	after this method returns or it should wait for
11424	<link to="IDisplay::resizeCompleted"/>.
11425	</desc>
11426	</param>
11427	</method>
11428
11429	<method name="videoModeSupported">
11430	<desc>
11431	Returns whether the frame buffer implementation is willing to
11432	support a given video mode. In case it is not able to render
11433	the video mode (or for some reason not willing), it should
11434	return @c false. Usually this method is called when the guest
11435	asks the VMM device whether a given video mode is supported
11436	so the information returned is directly exposed to the guest.
11437	It is important that this method returns very quickly.
11438	</desc>
11439	<param name="width" type="unsigned long" dir="in"/>
11440	<param name="height" type="unsigned long" dir="in"/>
11441	<param name="bpp" type="unsigned long" dir="in"/>
11442	<param name="supported" type="boolean" dir="return"/>
11443	</method>
11444
11445	<method name="getVisibleRegion">
11446	<desc>
11447	Returns the visible region of this frame buffer.
11448
11449	If the @a rectangles parameter is @c null then the value of the
11450	@a count parameter is ignored and the number of elements necessary to
11451	describe the current visible region is returned in @a countCopied.
11452
11453	If @a rectangles is not @c null but @a count is less
11454	than the required number of elements to store region data, the method
11455	will report a failure. If @a count is equal or greater than the
11456	required number of elements, then the actual number of elements copied
11457	to the provided array will be returned in @a countCopied.
11458
11459	<note>
11460	The address of the provided array must be in the process space of
11461	this IFramebuffer object.
11462	</note>
11463	<note>
11464	Method not yet implemented.
11465	</note>
11466	</desc>
11467	<param name="rectangles" type="octet" mod="ptr" dir="in">
11468	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
11469	</param>
11470	<param name="count" type="unsigned long" dir="in">
11471	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11472	</param>
11473	<param name="countCopied" type="unsigned long" dir="return">
11474	<desc>Number of elements copied to the @a rectangles array.</desc>
11475	</param>
11476	</method>
11477
11478	<method name="setVisibleRegion">
11479	<desc>
11480	Suggests a new visible region to this frame buffer. This region
11481	represents the area of the VM display which is a union of regions of
11482	all top-level windows of the guest operating system running inside the
11483	VM (if the Guest Additions for this system support this
11484	functionality). This information may be used by the frontends to
11485	implement the seamless desktop integration feature.
11486
11487	<note>
11488	The address of the provided array must be in the process space of
11489	this IFramebuffer object.
11490	</note>
11491	<note>
11492	The IFramebuffer implementation must make a copy of the provided
11493	array of rectangles.
11494	</note>
11495	<note>
11496	Method not yet implemented.
11497	</note>
11498	</desc>
11499	<param name="rectangles" type="octet" mod="ptr" dir="in">
11500	<desc>Pointer to the @c RTRECT array.</desc>
11501	</param>
11502	<param name="count" type="unsigned long" dir="in">
11503	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11504	</param>
11505	</method>
11506
11507	<method name="processVHWACommand">
11508	<desc>
11509	Posts a Video HW Acceleration Command to the frame buffer for processing.
11510	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color covnersion, overlaying, etc.)
11511	are posted from quest to the host to be processed by the host hardware.
11512
11513	<note>
11514	The address of the provided command must be in the process space of
11515	this IFramebuffer object.
11516	</note>
11517	</desc>
11518
11519	<param name="command" type="octet" mod="ptr" dir="in">
11520	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
11521	</param>
11522	</method>
11523
11524	</interface>
11525
11526	<interface
11527	name="IFramebufferOverlay" extends="IFramebuffer"
11528	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
11529	wsmap="suppress"
11530	>
11531	<desc>
11532	The IFramebufferOverlay interface represents an alpha blended overlay
11533	for displaying status icons above an IFramebuffer. It is always created
11534	not visible, so that it must be explicitly shown. It only covers a
11535	portion of the IFramebuffer, determined by its width, height and
11536	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
11537	that order) format, and may be written to directly. Do re-read the
11538	width though, after setting it, as it may be adjusted (increased) to
11539	make it more suitable for the front end.
11540	</desc>
11541	<attribute name="x" type="unsigned long" readonly="yes">
11542	<desc>X position of the overlay, relative to the frame buffer.</desc>
11543	</attribute>
11544
11545	<attribute name="y" type="unsigned long" readonly="yes">
11546	<desc>Y position of the overlay, relative to the frame buffer.</desc>
11547	</attribute>
11548
11549	<attribute name="visible" type="boolean" readonly="no">
11550	<desc>
11551	Whether the overlay is currently visible.
11552	</desc>
11553	</attribute>
11554
11555	<attribute name="alpha" type="unsigned long" readonly="no">
11556	<desc>
11557	The global alpha value for the overlay. This may or may not be
11558	supported by a given front end.
11559	</desc>
11560	</attribute>
11561
11562	<method name="move">
11563	<desc>
11564	Changes the overlay's position relative to the IFramebuffer.
11565	</desc>
11566	<param name="x" type="unsigned long" dir="in"/>
11567	<param name="y" type="unsigned long" dir="in"/>
11568	</method>
11569
11570	</interface>
11571
11572	<interface
11573	name="IDisplay" extends="$unknown"
11574	uuid="1fa79e39-0cc9-4ab3-9df3-ed3e96b42496"
11575	wsmap="managed"
11576	>
11577	<desc>
11578	The IDisplay interface represents the virtual machine's display.
11579
11580	The object implementing this interface is contained in each
11581	<link to="IConsole::display"/> attribute and represents the visual
11582	output of the virtual machine.
11583
11584	The virtual display supports pluggable output targets represented by the
11585	IFramebuffer interface. Examples of the output target are a window on
11586	the host computer or an RDP session's display on a remote computer.
11587	</desc>
11588	<method name="getScreenResolution">
11589	<desc>Queries display width, height and color depth for given screen.</desc>
11590	<param name="screenId" type="unsigned long" dir="in"/>
11591	<param name="width" type="unsigned long" dir="out"/>
11592	<param name="height" type="unsigned long" dir="out"/>
11593	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
11594	</method>
11595
11596	<method name="setFramebuffer">
11597	<desc>
11598	Sets the framebuffer for given screen.
11599	</desc>
11600	<param name="screenId" type="unsigned long" dir="in"/>
11601	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11602	</method>
11603
11604	<method name="getFramebuffer">
11605	<desc>
11606	Queries the framebuffer for given screen.
11607	</desc>
11608	<param name="screenId" type="unsigned long" dir="in"/>
11609	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11610	<param name="xOrigin" type="long" dir="out"/>
11611	<param name="yOrigin" type="long" dir="out"/>
11612	</method>
11613
11614	<method name="setVideoModeHint">
11615	<desc>
11616	Asks VirtualBox to request the given video mode from
11617	the guest. This is just a hint and it cannot be guaranteed
11618	that the requested resolution will be used. Guest Additions
11619	are required for the request to be seen by guests. The caller
11620	should issue the request and wait for a resolution change and
11621	after a timeout retry.
11622
11623	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11624	parameters means that the corresponding values should be taken from the
11625	current video mode (i.e. left unchanged).
11626
11627	If the guest OS supports multi-monitor configuration then the @a display
11628	parameter specifies the number of the guest display to send the hint to:
11629	@c 0 is the primary display, @c 1 is the first secondary and
11630	so on. If the multi-monitor configuration is not supported, @a display
11631	must be @c 0.
11632
11633	<result name="E_INVALIDARG">
11634	The @a display is not associated with any monitor.
11635	</result>
11636
11637	</desc>
11638	<param name="width" type="unsigned long" dir="in"/>
11639	<param name="height" type="unsigned long" dir="in"/>
11640	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11641	<param name="display" type="unsigned long" dir="in"/>
11642	</method>
11643
11644	<method name="setSeamlessMode">
11645	<desc>
11646	Enables or disables seamless guest display rendering (seamless desktop
11647	integration) mode.
11648	<note>
11649	Calling this method has no effect if <link
11650	to="IGuest::supportsSeamless"/> returns @c false.
11651	</note>
11652	</desc>
11653	<param name="enabled" type="boolean" dir="in"/>
11654	</method>
11655
11656	<method name="takeScreenShot">
11657	<desc>
11658	Takes a screen shot of the requested size and copies it to the
11659	32-bpp buffer allocated by the caller and pointed to by @a address.
11660	A pixel consists of 4 bytes in order: B, G, R, 0.
11661
11662	<note>This API can be used only by the COM/XPCOM C++ API as it
11663	requires pointer support. Use <link to="#takeScreenShotToArray" />
11664	with other language bindings.
11665	</note>
11666
11667	<result name="E_NOTIMPL">
11668	Feature not implemented.
11669	</result>
11670	<result name="VBOX_E_IPRT_ERROR">
11671	Could not take a screenshot.
11672	</result>
11673
11674	</desc>
11675	<param name="screenId" type="unsigned long" dir="in"/>
11676	<param name="address" type="octet" mod="ptr" dir="in"/>
11677	<param name="width" type="unsigned long" dir="in"/>
11678	<param name="height" type="unsigned long" dir="in"/>
11679	</method>
11680
11681	<method name="takeScreenShotToArray">
11682	<desc>
11683	Takes a guest screen shot of the requested size and returns it as
11684	an array of bytes in uncompressed 32-bit RGBA format.
11685	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11686
11687	This API is slow, but could be the only option to get guest screenshot
11688	for scriptable languages not allowed to manipulate with addresses
11689	directly.
11690
11691	<result name="E_NOTIMPL">
11692	Feature not implemented.
11693	</result>
11694	<result name="VBOX_E_IPRT_ERROR">
11695	Could not take a screenshot.
11696	</result>
11697	</desc>
11698	<param name="screenId" type="unsigned long" dir="in">
11699	<desc>
11700	Monitor to take screenshot from.
11701	</desc>
11702	</param>
11703	<param name="width" type="unsigned long" dir="in">
11704	<desc>
11705	Desired image width.
11706	</desc>
11707	</param>
11708	<param name="height" type="unsigned long" dir="in">
11709	<desc>
11710	Desired image height.
11711	</desc>
11712	</param>
11713	<param name="screenData" type="octet" dir="return" safearray="yes">
11714	<desc>
11715	Array with resulting screen data.
11716	</desc>
11717	</param>
11718	</method>
11719
11720	<method name="drawToScreen">
11721	<desc>
11722	Draws a 32-bpp image of the specified size from the given buffer
11723	to the given point on the VM display.
11724
11725	<result name="E_NOTIMPL">
11726	Feature not implemented.
11727	</result>
11728	<result name="VBOX_E_IPRT_ERROR">
11729	Could not draw to screen.
11730	</result>
11731
11732	</desc>
11733	<param name="screenId" type="unsigned long" dir="in"/>
11734	<param name="address" type="octet" mod="ptr" dir="in"/>
11735	<param name="x" type="unsigned long" dir="in">
11736	<desc>Relative to the screen top left corner.</desc>
11737	</param>
11738	<param name="y" type="unsigned long" dir="in">
11739	<desc>Relative to the screen top left corner.</desc>
11740	</param>
11741	<param name="width" type="unsigned long" dir="in"/>
11742	<param name="height" type="unsigned long" dir="in"/>
11743	</method>
11744
11745	<method name="invalidateAndUpdate">
11746	<desc>
11747	Does a full invalidation of the VM display and instructs the VM
11748	to update it.
11749
11750	<result name="VBOX_E_IPRT_ERROR">
11751	Could not invalidate and update screen.
11752	</result>
11753
11754	</desc>
11755	</method>
11756
11757	<method name="resizeCompleted">
11758	<desc>
11759	Signals that a framebuffer has completed the resize operation.
11760
11761	<result name="VBOX_E_NOT_SUPPORTED">
11762	Operation only valid for external frame buffers.
11763	</result>
11764
11765	</desc>
11766	<param name="screenId" type="unsigned long" dir="in"/>
11767	</method>
11768
11769	<method name="completeVHWACommand">
11770	<desc>
11771	Signals that the Video HW Acceleration command has completed.
11772	</desc>
11773
11774	<param name="command" type="octet" mod="ptr" dir="in">
11775	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11776	</param>
11777	</method>
11778
11779	</interface>
11780
11781	<!--
11782	// INetworkAdapter
11783	/////////////////////////////////////////////////////////////////////////
11784	-->
11785
11786	<enum
11787	name="NetworkAttachmentType"
11788	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11789	>
11790	<desc>
11791	Network attachment type.
11792	</desc>
11793
11794	<const name="Null" value="0">
11795	<desc>Null value, also means "not attached".</desc>
11796	</const>
11797	<const name="NAT" value="1"/>
11798	<const name="Bridged" value="2"/>
11799	<const name="Internal" value="3"/>
11800	<const name="HostOnly" value="4"/>
11801	<const name="VDE" value="5"/>
11802	</enum>
11803
11804	<enum
11805	name="NetworkAdapterType"
11806	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11807	>
11808	<desc>
11809	Network adapter type.
11810	</desc>
11811
11812	<const name="Null" value="0">
11813	<desc>Null value (never used by the API).</desc>
11814	</const>
11815	<const name="Am79C970A" value="1">
11816	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11817	</const>
11818	<const name="Am79C973" value="2">
11819	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11820	</const>
11821	<const name="I82540EM" value="3">
11822	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11823	</const>
11824	<const name="I82543GC" value="4">
11825	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11826	</const>
11827	<const name="I82545EM" value="5">
11828	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11829	</const>
11830	<const name="Virtio" value="6">
11831	<desc>Virtio network device.</desc>
11832	</const>
11833	</enum>
11834
11835	<interface
11836	name="INetworkAdapter" extends="$unknown"
11837	uuid="5bdb9df8-a5e1-4322-a139-b7a4a734c790"
11838	wsmap="managed"
11839	>
11840	<desc>
11841	Represents a virtual network adapter that is attached to a virtual machine.
11842	Each virtual machine has a fixed number of network adapter slots with one
11843	instance of this attached to each of them. Call
11844	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11845	is attached to a given slot in a given machine.
11846
11847	Each network adapter can be in one of five attachment modes, which are
11848	represented by the <link to="NetworkAttachmentType" /> enumeration;
11849	see the <link to="#attachmentType" /> attribute.
11850	</desc>
11851
11852	<attribute name="adapterType" type="NetworkAdapterType">
11853	<desc>
11854	Type of the virtual network adapter. Depending on this value,
11855	VirtualBox will provide a different virtual network hardware
11856	to the guest.
11857	</desc>
11858	</attribute>
11859
11860	<attribute name="slot" type="unsigned long" readonly="yes">
11861	<desc>
11862	Slot number this adapter is plugged into. Corresponds to
11863	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11864	to obtain this instance.
11865	</desc>
11866	</attribute>
11867
11868	<attribute name="enabled" type="boolean">
11869	<desc>
11870	Flag whether the network adapter is present in the
11871	guest system. If disabled, the virtual guest hardware will
11872	not contain this network adapter. Can only be changed when
11873	the VM is not running.
11874	</desc>
11875	</attribute>
11876
11877	<attribute name="MACAddress" type="wstring">
11878	<desc>
11879	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11880	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11881	</desc>
11882	</attribute>
11883
11884	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11885
11886	<attribute name="hostInterface" type="wstring">
11887	<desc>
11888	Name of the host network interface the VM is attached to.
11889	</desc>
11890	</attribute>
11891
11892	<attribute name="internalNetwork" type="wstring">
11893	<desc>
11894	Name of the internal network the VM is attached to.
11895	</desc>
11896	</attribute>
11897
11898	<attribute name="NATNetwork" type="wstring">
11899	<desc>
11900	Name of the NAT network the VM is attached to.
11901	</desc>
11902	</attribute>
11903
11904	<attribute name="VDENetwork" type="wstring">
11905	<desc>
11906	Name of the VDE switch the VM is attached to.
11907	</desc>
11908	</attribute>
11909
11910	<attribute name="cableConnected" type="boolean">
11911	<desc>
11912	Flag whether the adapter reports the cable as connected or not.
11913	It can be used to report offline situations to a VM.
11914	</desc>
11915	</attribute>
11916
11917	<attribute name="lineSpeed" type="unsigned long">
11918	<desc>
11919	Line speed reported by custom drivers, in units of 1 kbps.
11920	</desc>
11921	</attribute>
11922
11923	<attribute name="traceEnabled" type="boolean">
11924	<desc>
11925	Flag whether network traffic from/to the network card should be traced.
11926	Can only be toggled when the VM is turned off.
11927	</desc>
11928	</attribute>
11929
11930	<attribute name="traceFile" type="wstring">
11931	<desc>
11932	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11933	will be used.
11934	</desc>
11935	</attribute>
11936
11937	<attribute name="natDriver" type="INATEngine" readonly="yes">
11938	<desc>
11939	Points to the NAT engine which handles the network address translation
11940	for this interface. This is active only when the interface actually uses
11941	NAT (see <link to="#attachToNAT" />).
11942	</desc>
11943	</attribute>
11944
11945	<attribute name="bootPriority" type="unsigned long">
11946	<desc>
11947	Network boot priority of the adapter. Priority 1 is highest. If not set,
11948	the priority is considered to be at the lowest possible setting.
11949	</desc>
11950	</attribute>
11951
11952	<method name="attachToNAT">
11953	<desc>
11954	Attach the network adapter to the Network Address Translation (NAT) interface.
11955	</desc>
11956	</method>
11957
11958	<method name="attachToBridgedInterface">
11959	<desc>
11960	Attach the network adapter to a bridged host interface.
11961	</desc>
11962	</method>
11963
11964	<method name="attachToInternalNetwork">
11965	<desc>
11966	Attach the network adapter to an internal network.
11967	</desc>
11968	</method>
11969
11970	<method name="attachToHostOnlyInterface">
11971	<desc>
11972	Attach the network adapter to the host-only network.
11973	</desc>
11974	</method>
11975
11976	<method name="attachToVDE">
11977	<desc>
11978	Attach the network adapter to a VDE network.
11979	</desc>
11980	</method>
11981
11982	<method name="detach">
11983	<desc>
11984	Detach the network adapter
11985	</desc>
11986	</method>
11987	</interface>
11988
11989
11990	<!--
11991	// ISerialPort
11992	/////////////////////////////////////////////////////////////////////////
11993	-->
11994
11995	<enum
11996	name="PortMode"
11997	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11998	>
11999	<desc>
12000	The PortMode enumeration represents possible communication modes for
12001	the virtual serial port device.
12002	</desc>
12003
12004	<const name="Disconnected" value="0">
12005	<desc>Virtual device is not attached to any real host device.</desc>
12006	</const>
12007	<const name="HostPipe" value="1">
12008	<desc>Virtual device is attached to a host pipe.</desc>
12009	</const>
12010	<const name="HostDevice" value="2">
12011	<desc>Virtual device is attached to a host device.</desc>
12012	</const>
12013	<const name="RawFile" value="3">
12014	<desc>Virtual device is attached to a raw file.</desc>
12015	</const>
12016	</enum>
12017
12018	<interface
12019	name="ISerialPort" extends="$unknown"
12020	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
12021	wsmap="managed"
12022	>
12023
12024	<desc>
12025	The ISerialPort interface represents the virtual serial port device.
12026
12027	The virtual serial port device acts like an ordinary serial port
12028	inside the virtual machine. This device communicates to the real
12029	serial port hardware in one of two modes: host pipe or host device.
12030
12031	In host pipe mode, the #path attribute specifies the path to the pipe on
12032	the host computer that represents a serial port. The #server attribute
12033	determines if this pipe is created by the virtual machine process at
12034	machine startup or it must already exist before starting machine
12035	execution.
12036
12037	In host device mode, the #path attribute specifies the name of the
12038	serial port device on the host computer.
12039
12040	There is also a third communication mode: the disconnected mode. In this
12041	mode, the guest OS running inside the virtual machine will be able to
12042	detect the serial port, but all port write operations will be discarded
12043	and all port read operations will return no data.
12044
12045	<see>IMachine::getSerialPort</see>
12046	</desc>
12047
12048	<attribute name="slot" type="unsigned long" readonly="yes">
12049	<desc>
12050	Slot number this serial port is plugged into. Corresponds to
12051	the value you pass to <link to="IMachine::getSerialPort"/>
12052	to obtain this instance.
12053	</desc>
12054	</attribute>
12055
12056	<attribute name="enabled" type="boolean">
12057	<desc>
12058	Flag whether the serial port is enabled. If disabled,
12059	the serial port will not be reported to the guest OS.
12060	</desc>
12061	</attribute>
12062
12063	<attribute name="IOBase" type="unsigned long">
12064	<desc>Base I/O address of the serial port.</desc>
12065	</attribute>
12066
12067	<attribute name="IRQ" type="unsigned long">
12068	<desc>IRQ number of the serial port.</desc>
12069	</attribute>
12070
12071	<attribute name="hostMode" type="PortMode">
12072	<desc>
12073	How is this port connected to the host.
12074	<note>
12075	Changing this attribute may fail if the conditions for
12076	<link to="#path"/> are not met.
12077	</note>
12078	</desc>
12079	</attribute>
12080
12081	<attribute name="server" type="boolean">
12082	<desc>
12083	Flag whether this serial port acts as a server (creates a new pipe on
12084	the host) or as a client (uses the existing pipe). This attribute is
12085	used only when <link to="#hostMode"/> is PortMode_HostPipe.
12086	</desc>
12087	</attribute>
12088
12089	<attribute name="path" type="wstring">
12090	<desc>
12091	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
12092	PortMode_HostPipe, or the host serial device name when
12093	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
12094	cases, setting a @c null or empty string as the attribute's value
12095	is an error. Otherwise, the value of this property is ignored.
12096	</desc>
12097	</attribute>
12098
12099	</interface>
12100
12101	<!--
12102	// IParallelPort
12103	/////////////////////////////////////////////////////////////////////////
12104	-->
12105
12106	<interface
12107	name="IParallelPort" extends="$unknown"
12108	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
12109	wsmap="managed"
12110	>
12111
12112	<desc>
12113	The IParallelPort interface represents the virtual parallel port device.
12114
12115	The virtual parallel port device acts like an ordinary parallel port
12116	inside the virtual machine. This device communicates to the real
12117	parallel port hardware using the name of the parallel device on the host
12118	computer specified in the #path attribute.
12119
12120	Each virtual parallel port device is assigned a base I/O address and an
12121	IRQ number that will be reported to the guest operating system and used
12122	to operate the given parallel port from within the virtual machine.
12123
12124	<see>IMachine::getParallelPort</see>
12125	</desc>
12126
12127	<attribute name="slot" type="unsigned long" readonly="yes">
12128	<desc>
12129	Slot number this parallel port is plugged into. Corresponds to
12130	the value you pass to <link to="IMachine::getParallelPort"/>
12131	to obtain this instance.
12132	</desc>
12133	</attribute>
12134
12135	<attribute name="enabled" type="boolean">
12136	<desc>
12137	Flag whether the parallel port is enabled. If disabled,
12138	the parallel port will not be reported to the guest OS.
12139	</desc>
12140	</attribute>
12141
12142	<attribute name="IOBase" type="unsigned long">
12143	<desc>Base I/O address of the parallel port.</desc>
12144	</attribute>
12145
12146	<attribute name="IRQ" type="unsigned long">
12147	<desc>IRQ number of the parallel port.</desc>
12148	</attribute>
12149
12150	<attribute name="path" type="wstring">
12151	<desc>
12152	Host parallel device name. If this parallel port is enabled, setting a
12153	@c null or an empty string as this attribute's value will result into
12154	an error.
12155	</desc>
12156	</attribute>
12157
12158	</interface>
12159
12160
12161	<!--
12162	// IMachineDebugger
12163	/////////////////////////////////////////////////////////////////////////
12164	-->
12165
12166	<interface
12167	name="IMachineDebugger" extends="$unknown"
12168	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
12169	wsmap="suppress"
12170	>
12171	<method name="resetStats">
12172	<desc>
12173	Reset VM statistics.
12174	</desc>
12175	<param name="pattern" type="wstring" dir="in">
12176	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12177	</param>
12178	</method>
12179
12180	<method name="dumpStats">
12181	<desc>
12182	Dumps VM statistics.
12183	</desc>
12184	<param name="pattern" type="wstring" dir="in">
12185	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12186	</param>
12187	</method>
12188
12189	<method name="getStats">
12190	<desc>
12191	Get the VM statistics in a XMLish format.
12192	</desc>
12193	<param name="pattern" type="wstring" dir="in">
12194	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12195	</param>
12196	<param name="withDescriptions" type="boolean" dir="in">
12197	<desc>Whether to include the descriptions.</desc>
12198	</param>
12199	<param name="stats" type="wstring" dir="out">
12200	<desc>The XML document containing the statistics.</desc>
12201	</param>
12202	</method>
12203
12204	<method name="injectNMI">
12205	<desc>
12206	Inject an NMI into a running VT-x/AMD-V VM.
12207	</desc>
12208	</method>
12209
12210	<attribute name="singlestep" type="boolean">
12211	<desc>Switch for enabling singlestepping.</desc>
12212	</attribute>
12213
12214	<attribute name="recompileUser" type="boolean">
12215	<desc>Switch for forcing code recompilation for user mode code.</desc>
12216	</attribute>
12217
12218	<attribute name="recompileSupervisor" type="boolean">
12219	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
12220	</attribute>
12221
12222	<attribute name="PATMEnabled" type="boolean">
12223	<desc>Switch for enabling and disabling the PATM component.</desc>
12224	</attribute>
12225
12226	<attribute name="CSAMEnabled" type="boolean">
12227	<desc>Switch for enabling and disabling the CSAM component.</desc>
12228	</attribute>
12229
12230	<attribute name="logEnabled" type="boolean">
12231	<desc>Switch for enabling and disabling logging.</desc>
12232	</attribute>
12233
12234	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
12235	<desc>
12236	Flag indicating whether the VM is currently making use of CPU hardware
12237	virtualization extensions.
12238	</desc>
12239	</attribute>
12240
12241	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
12242	<desc>
12243	Flag indicating whether the VM is currently making use of the nested paging
12244	CPU hardware virtualization extension.
12245	</desc>
12246	</attribute>
12247
12248	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
12249	<desc>
12250	Flag indicating whether the VM is currently making use of the VPID
12251	VT-x extension.
12252	</desc>
12253	</attribute>
12254
12255	<attribute name="PAEEnabled" type="boolean" readonly="yes">
12256	<desc>
12257	Flag indicating whether the VM is currently making use of the Physical
12258	Address Extension CPU feature.
12259	</desc>
12260	</attribute>
12261
12262	<attribute name="virtualTimeRate" type="unsigned long">
12263	<desc>
12264	The rate at which the virtual time runs expressed as a percentage.
12265	The accepted range is 2% to 20000%.
12266	</desc>
12267	</attribute>
12268
12269	<!-- @todo method for setting log flags, groups and destination! -->
12270
12271	<attribute name="VM" type="unsigned long long" readonly="yes">
12272	<desc>
12273	Gets the VM handle. This is only for internal use while
12274	we carve the details of this interface.
12275	</desc>
12276	</attribute>
12277
12278	</interface>
12279
12280	<!--
12281	// IUSBController
12282	/////////////////////////////////////////////////////////////////////////
12283	-->
12284
12285	<interface
12286	name="IUSBController" extends="$unknown"
12287	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
12288	wsmap="managed"
12289	>
12290	<attribute name="enabled" type="boolean">
12291	<desc>
12292	Flag whether the USB controller is present in the
12293	guest system. If disabled, the virtual guest hardware will
12294	not contain any USB controller. Can only be changed when
12295	the VM is powered off.
12296	</desc>
12297	</attribute>
12298
12299	<attribute name="enabledEhci" type="boolean">
12300	<desc>
12301	Flag whether the USB EHCI controller is present in the
12302	guest system. If disabled, the virtual guest hardware will
12303	not contain a USB EHCI controller. Can only be changed when
12304	the VM is powered off.
12305	</desc>
12306	</attribute>
12307
12308	<attribute name="proxyAvailable" type="boolean" readonly="yes">
12309	<desc>
12310	Flag whether there is an USB proxy available.
12311	</desc>
12312	</attribute>
12313
12314	<attribute name="USBStandard" type="unsigned short" readonly="yes">
12315	<desc>
12316	USB standard version which the controller implements.
12317	This is a BCD which means that the major version is in the
12318	high byte and minor version is in the low byte.
12319	</desc>
12320	</attribute>
12321
12322	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
12323	<desc>
12324	List of USB device filters associated with the machine.
12325
12326	If the machine is currently running, these filters are activated
12327	every time a new (supported) USB device is attached to the host
12328	computer that was not ignored by global filters
12329	(<link to="IHost::USBDeviceFilters"/>).
12330
12331	These filters are also activated when the machine is powered up.
12332	They are run against a list of all currently available USB
12333	devices (in states
12334	<link to="USBDeviceState_Available"/>,
12335	<link to="USBDeviceState_Busy"/>,
12336	<link to="USBDeviceState_Held"/>) that were not previously
12337	ignored by global filters.
12338
12339	If at least one filter matches the USB device in question, this
12340	device is automatically captured (attached to) the virtual USB
12341	controller of this machine.
12342
12343	<see>IUSBDeviceFilter, ::IUSBController</see>
12344	</desc>
12345	</attribute>
12346
12347	<method name="createDeviceFilter">
12348	<desc>
12349	Creates a new USB device filter. All attributes except
12350	the filter name are set to empty (any match),
12351	<i>active</i> is @c false (the filter is not active).
12352
12353	The created filter can then be added to the list of filters using
12354	<link to="#insertDeviceFilter"/>.
12355
12356	<result name="VBOX_E_INVALID_VM_STATE">
12357	The virtual machine is not mutable.
12358	</result>
12359
12360	<see>#deviceFilters</see>
12361	</desc>
12362	<param name="name" type="wstring" dir="in">
12363	<desc>
12364	Filter name. See <link to="IUSBDeviceFilter::name"/>
12365	for more info.
12366	</desc>
12367	</param>
12368	<param name="filter" type="IUSBDeviceFilter" dir="return">
12369	<desc>Created filter object.</desc>
12370	</param>
12371	</method>
12372
12373	<method name="insertDeviceFilter">
12374	<desc>
12375	Inserts the given USB device to the specified position
12376	in the list of filters.
12377
12378	Positions are numbered starting from <tt>0</tt>. If the specified
12379	position is equal to or greater than the number of elements in
12380	the list, the filter is added to the end of the collection.
12381
12382	<note>
12383	Duplicates are not allowed, so an attempt to insert a
12384	filter that is already in the collection, will return an
12385	error.
12386	</note>
12387
12388	<result name="VBOX_E_INVALID_VM_STATE">
12389	Virtual machine is not mutable.
12390	</result>
12391	<result name="E_INVALIDARG">
12392	USB device filter not created within this VirtualBox instance.
12393	</result>
12394	<result name="VBOX_E_INVALID_OBJECT_STATE">
12395	USB device filter already in list.
12396	</result>
12397
12398	<see>#deviceFilters</see>
12399	</desc>
12400	<param name="position" type="unsigned long" dir="in">
12401	<desc>Position to insert the filter to.</desc>
12402	</param>
12403	<param name="filter" type="IUSBDeviceFilter" dir="in">
12404	<desc>USB device filter to insert.</desc>
12405	</param>
12406	</method>
12407
12408	<method name="removeDeviceFilter">
12409	<desc>
12410	Removes a USB device filter from the specified position in the
12411	list of filters.
12412
12413	Positions are numbered starting from <tt>0</tt>. Specifying a
12414	position equal to or greater than the number of elements in
12415	the list will produce an error.
12416
12417	<see>#deviceFilters</see>
12418
12419	<result name="VBOX_E_INVALID_VM_STATE">
12420	Virtual machine is not mutable.
12421	</result>
12422	<result name="E_INVALIDARG">
12423	USB device filter list empty or invalid @a position.
12424	</result>
12425
12426	</desc>
12427	<param name="position" type="unsigned long" dir="in">
12428	<desc>Position to remove the filter from.</desc>
12429	</param>
12430	<param name="filter" type="IUSBDeviceFilter" dir="return">
12431	<desc>Removed USB device filter.</desc>
12432	</param>
12433	</method>
12434
12435	</interface>
12436
12437
12438	<!--
12439	// IUSBDevice
12440	/////////////////////////////////////////////////////////////////////////
12441	-->
12442
12443	<interface
12444	name="IUSBDevice" extends="$unknown"
12445	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
12446	wsmap="managed"
12447	>
12448	<desc>
12449	The IUSBDevice interface represents a virtual USB device attached to the
12450	virtual machine.
12451
12452	A collection of objects implementing this interface is stored in the
12453	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
12454	attached to a running virtual machine's USB controller.
12455	</desc>
12456
12457	<attribute name="id" type="uuid" mod="string" readonly="yes">
12458	<desc>
12459	Unique USB device ID. This ID is built from #vendorId,
12460	#productId, #revision and #serialNumber.
12461	</desc>
12462	</attribute>
12463
12464	<attribute name="vendorId" type="unsigned short" readonly="yes">
12465	<desc>Vendor ID.</desc>
12466	</attribute>
12467
12468	<attribute name="productId" type="unsigned short" readonly="yes">
12469	<desc>Product ID.</desc>
12470	</attribute>
12471
12472	<attribute name="revision" type="unsigned short" readonly="yes">
12473	<desc>
12474	Product revision number. This is a packed BCD represented as
12475	unsigned short. The high byte is the integer part and the low
12476	byte is the decimal.
12477	</desc>
12478	</attribute>
12479
12480	<attribute name="manufacturer" type="wstring" readonly="yes">
12481	<desc>Manufacturer string.</desc>
12482	</attribute>
12483
12484	<attribute name="product" type="wstring" readonly="yes">
12485	<desc>Product string.</desc>
12486	</attribute>
12487
12488	<attribute name="serialNumber" type="wstring" readonly="yes">
12489	<desc>Serial number string.</desc>
12490	</attribute>
12491
12492	<attribute name="address" type="wstring" readonly="yes">
12493	<desc>Host specific address of the device.</desc>
12494	</attribute>
12495
12496	<attribute name="port" type="unsigned short" readonly="yes">
12497	<desc>
12498	Host USB port number the device is physically
12499	connected to.
12500	</desc>
12501	</attribute>
12502
12503	<attribute name="version" type="unsigned short" readonly="yes">
12504	<desc>
12505	The major USB version of the device - 1 or 2.
12506	</desc>
12507	</attribute>
12508
12509	<attribute name="portVersion" type="unsigned short" readonly="yes">
12510	<desc>
12511	The major USB version of the host USB port the device is
12512	physically connected to - 1 or 2. For devices not connected to
12513	anything this will have the same value as the version attribute.
12514	</desc>
12515	</attribute>
12516
12517	<attribute name="remote" type="boolean" readonly="yes">
12518	<desc>
12519	Whether the device is physically connected to a remote VRDP
12520	client or to a local host machine.
12521	</desc>
12522	</attribute>
12523
12524	</interface>
12525
12526
12527	<!--
12528	// IUSBDeviceFilter
12529	/////////////////////////////////////////////////////////////////////////
12530	-->
12531
12532	<interface
12533	name="IUSBDeviceFilter" extends="$unknown"
12534	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
12535	wsmap="managed"
12536	>
12537	<desc>
12538	The IUSBDeviceFilter interface represents an USB device filter used
12539	to perform actions on a group of USB devices.
12540
12541	This type of filters is used by running virtual machines to
12542	automatically capture selected USB devices once they are physically
12543	attached to the host computer.
12544
12545	A USB device is matched to the given device filter if and only if all
12546	attributes of the device match the corresponding attributes of the
12547	filter (that is, attributes are joined together using the logical AND
12548	operation). On the other hand, all together, filters in the list of
12549	filters carry the semantics of the logical OR operation. So if it is
12550	desirable to create a match like "this vendor id OR this product id",
12551	one needs to create two filters and specify "any match" (see below)
12552	for unused attributes.
12553
12554	All filter attributes used for matching are strings. Each string
12555	is an expression representing a set of values of the corresponding
12556	device attribute, that will match the given filter. Currently, the
12557	following filtering expressions are supported:
12558
12559	<ul>
12560	<li><i>Interval filters</i>. Used to specify valid intervals for
12561	integer device attributes (Vendor ID, Product ID and Revision).
12562	The format of the string is:
12563
12564	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
12565
12566	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
12567	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
12568	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
12569	is omitted before a dash (<tt>-</tt>), the minimum possible integer
12570	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
12571	possible integer is assumed.
12572	</li>
12573	<li><i>Boolean filters</i>. Used to specify acceptable values for
12574	boolean device attributes. The format of the string is:
12575
12576	<tt>true\|false\|yes\|no\|0\|1</tt>
12577
12578	</li>
12579	<li><i>Exact match</i>. Used to specify a single value for the given
12580	device attribute. Any string that doesn't start with <tt>int:</tt>
12581	represents the exact match. String device attributes are compared to
12582	this string including case of symbols. Integer attributes are first
12583	converted to a string (see individual filter attributes) and then
12584	compared ignoring case.
12585
12586	</li>
12587	<li><i>Any match</i>. Any value of the corresponding device attribute
12588	will match the given filter. An empty or @c null string is
12589	used to construct this type of filtering expressions.
12590
12591	</li>
12592	</ul>
12593
12594	<note>
12595	On the Windows host platform, interval filters are not currently
12596	available. Also all string filter attributes
12597	(<link to="#manufacturer"/>, <link to="#product"/>,
12598	<link to="#serialNumber"/>) are ignored, so they behave as
12599	<i>any match</i> no matter what string expression is specified.
12600	</note>
12601
12602	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
12603	</desc>
12604
12605	<attribute name="name" type="wstring">
12606	<desc>
12607	Visible name for this filter.
12608	This name is used to visually distinguish one filter from another,
12609	so it can neither be @c null nor an empty string.
12610	</desc>
12611	</attribute>
12612
12613	<attribute name="active" type="boolean">
12614	<desc>Whether this filter active or has been temporarily disabled.</desc>
12615	</attribute>
12616
12617	<attribute name="vendorId" type="wstring">
12618	<desc>
12619	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12620	The string representation for the <i>exact matching</i>
12621	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12622	(including leading zeroes).
12623	</desc>
12624	</attribute>
12625
12626	<attribute name="productId" type="wstring">
12627	<desc>
12628	<link to="IUSBDevice::productId">Product ID</link> filter.
12629	The string representation for the <i>exact matching</i>
12630	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12631	(including leading zeroes).
12632	</desc>
12633	</attribute>
12634
12635	<attribute name="revision" type="wstring">
12636	<desc>
12637	<link to="IUSBDevice::productId">Product revision number</link>
12638	filter. The string representation for the <i>exact matching</i>
12639	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12640	of the integer part of the revision, and <tt>F</tt> is the
12641	decimal digit of its fractional part (including leading and
12642	trailing zeros).
12643	Note that for interval filters, it's best to use the hexadecimal
12644	form, because the revision is stored as a 16 bit packed BCD value;
12645	so the expression <tt>int:0x0100-0x0199</tt> will match any
12646	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12647	</desc>
12648	</attribute>
12649
12650	<attribute name="manufacturer" type="wstring">
12651	<desc>
12652	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12653	</desc>
12654	</attribute>
12655
12656	<attribute name="product" type="wstring">
12657	<desc>
12658	<link to="IUSBDevice::product">Product</link> filter.
12659	</desc>
12660	</attribute>
12661
12662	<attribute name="serialNumber" type="wstring">
12663	<desc>
12664	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12665	</desc>
12666	</attribute>
12667
12668	<attribute name="port" type="wstring">
12669	<desc>
12670	<link to="IUSBDevice::port">Host USB port</link> filter.
12671	</desc>
12672	</attribute>
12673
12674	<attribute name="remote" type="wstring">
12675	<desc>
12676	<link to="IUSBDevice::remote">Remote state</link> filter.
12677	<note>
12678	This filter makes sense only for machine USB filters,
12679	i.e. it is ignored by IHostUSBDeviceFilter objects.
12680	</note>
12681	</desc>
12682	</attribute>
12683
12684	<attribute name="maskedInterfaces" type="unsigned long">
12685	<desc>
12686	This is an advanced option for hiding one or more USB interfaces
12687	from the guest. The value is a bit mask where the bits that are set
12688	means the corresponding USB interface should be hidden, masked off
12689	if you like.
12690	This feature only works on Linux hosts.
12691	</desc>
12692	</attribute>
12693
12694	</interface>
12695
12696
12697	<!--
12698	// IHostUSBDevice
12699	/////////////////////////////////////////////////////////////////////////
12700	-->
12701
12702	<enum
12703	name="USBDeviceState"
12704	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12705	>
12706	<desc>
12707	USB device state. This enumeration represents all possible states
12708	of the USB device physically attached to the host computer regarding
12709	its state on the host computer and availability to guest computers
12710	(all currently running virtual machines).
12711
12712	Once a supported USB device is attached to the host, global USB
12713	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12714	either ignore the device, or put it to USBDeviceState_Held state, or do
12715	nothing. Unless the device is ignored by global filters, filters of all
12716	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12717	activated that can put it to USBDeviceState_Captured state.
12718
12719	If the device was ignored by global filters, or didn't match
12720	any filters at all (including guest ones), it is handled by the host
12721	in a normal way. In this case, the device state is determined by
12722	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12723	or USBDeviceState_Available, depending on the current device usage.
12724
12725	Besides auto-capturing based on filters, the device can be manually
12726	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12727	state is USBDeviceState_Busy, USBDeviceState_Available or
12728	USBDeviceState_Held.
12729
12730	<note>
12731	Due to differences in USB stack implementations in Linux and Win32,
12732	states USBDeviceState_Busy and USBDeviceState_vailable are applicable
12733	only to the Linux version of the product. This also means that (<link
12734	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12735	device state is USBDeviceState_Held.
12736	</note>
12737
12738	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12739	</desc>
12740
12741	<const name="NotSupported" value="0">
12742	<desc>
12743	Not supported by the VirtualBox server, not available to guests.
12744	</desc>
12745	</const>
12746	<const name="Unavailable" value="1">
12747	<desc>
12748	Being used by the host computer exclusively,
12749	not available to guests.
12750	</desc>
12751	</const>
12752	<const name="Busy" value="2">
12753	<desc>
12754	Being used by the host computer, potentially available to guests.
12755	</desc>
12756	</const>
12757	<const name="Available" value="3">
12758	<desc>
12759	Not used by the host computer, available to guests (the host computer
12760	can also start using the device at any time).
12761	</desc>
12762	</const>
12763	<const name="Held" value="4">
12764	<desc>
12765	Held by the VirtualBox server (ignored by the host computer),
12766	available to guests.
12767	</desc>
12768	</const>
12769	<const name="Captured" value="5">
12770	<desc>
12771	Captured by one of the guest computers, not available
12772	to anybody else.
12773	</desc>
12774	</const>
12775	</enum>
12776
12777	<interface
12778	name="IHostUSBDevice" extends="IUSBDevice"
12779	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12780	wsmap="managed"
12781	>
12782	<desc>
12783	The IHostUSBDevice interface represents a physical USB device attached
12784	to the host computer.
12785
12786	Besides properties inherited from IUSBDevice, this interface adds the
12787	<link to="#state"/> property that holds the current state of the USB
12788	device.
12789
12790	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12791	</desc>
12792
12793	<attribute name="state" type="USBDeviceState" readonly="yes">
12794	<desc>
12795	Current state of the device.
12796	</desc>
12797	</attribute>
12798
12799	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12800
12801	</interface>
12802
12803
12804	<!--
12805	// IHostUSBDeviceFilter
12806	/////////////////////////////////////////////////////////////////////////
12807	-->
12808
12809	<enum
12810	name="USBDeviceFilterAction"
12811	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12812	>
12813	<desc>
12814	Actions for host USB device filters.
12815	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12816	</desc>
12817
12818	<const name="Null" value="0">
12819	<desc>Null value (never used by the API).</desc>
12820	</const>
12821	<const name="Ignore" value="1">
12822	<desc>Ignore the matched USB device.</desc>
12823	</const>
12824	<const name="Hold" value="2">
12825	<desc>Hold the matched USB device.</desc>
12826	</const>
12827	</enum>
12828
12829	<interface
12830	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12831	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12832	wsmap="managed"
12833	>
12834	<desc>
12835	The IHostUSBDeviceFilter interface represents a global filter for a
12836	physical USB device used by the host computer. Used indirectly in
12837	<link to="IHost::USBDeviceFilters"/>.
12838
12839	Using filters of this type, the host computer determines the initial
12840	state of the USB device after it is physically attached to the
12841	host's USB controller.
12842
12843	<note>
12844	The <link to="#remote"/> attribute is ignored by this type of
12845	filters, because it makes sense only for
12846	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12847	</note>
12848
12849	<see>IHost::USBDeviceFilters</see>
12850	</desc>
12851
12852	<attribute name="action" type="USBDeviceFilterAction">
12853	<desc>
12854	Action performed by the host when an attached USB device
12855	matches this filter.
12856	</desc>
12857	</attribute>
12858
12859	</interface>
12860
12861	<!--
12862	// IAudioAdapter
12863	/////////////////////////////////////////////////////////////////////////
12864	-->
12865
12866	<enum
12867	name="AudioDriverType"
12868	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12869	>
12870	<desc>
12871	Host audio driver type.
12872	</desc>
12873
12874	<const name="Null" value="0">
12875	<desc>Null value, also means "dummy audio driver".</desc>
12876	</const>
12877	<const name="WinMM" value="1">
12878	<desc>Windows multimedia (Windows hosts only).</desc>
12879	</const>
12880	<const name="OSS" value="2">
12881	<desc>Open Sound System (Linux hosts only).</desc>
12882	</const>
12883	<const name="ALSA" value="3">
12884	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12885	</const>
12886	<const name="DirectSound" value="4">
12887	<desc>DirectSound (Windows hosts only).</desc>
12888	</const>
12889	<const name="CoreAudio" value="5">
12890	<desc>CoreAudio (Mac hosts only).</desc>
12891	</const>
12892	<const name="MMPM" value="6">
12893	<desc>Reserved for historical reasons.</desc>
12894	</const>
12895	<const name="Pulse" value="7">
12896	<desc>PulseAudio (Linux hosts only).</desc>
12897	</const>
12898	<const name="SolAudio" value="8">
12899	<desc>Solaris audio (Solaris hosts only).</desc>
12900	</const>
12901	</enum>
12902
12903	<enum
12904	name="AudioControllerType"
12905	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12906	>
12907	<desc>
12908	Virtual audio controller type.
12909	</desc>
12910
12911	<const name="AC97" value="0"/>
12912	<const name="SB16" value="1"/>
12913	</enum>
12914
12915	<interface
12916	name="IAudioAdapter" extends="$unknown"
12917	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12918	wsmap="managed"
12919	>
12920	<desc>
12921	The IAudioAdapter interface represents the virtual audio adapter of
12922	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12923	</desc>
12924	<attribute name="enabled" type="boolean">
12925	<desc>
12926	Flag whether the audio adapter is present in the
12927	guest system. If disabled, the virtual guest hardware will
12928	not contain any audio adapter. Can only be changed when
12929	the VM is not running.
12930	</desc>
12931	</attribute>
12932	<attribute name="audioController" type="AudioControllerType">
12933	<desc>
12934	The audio hardware we emulate.
12935	</desc>
12936	</attribute>
12937	<attribute name="audioDriver" type="AudioDriverType">
12938	<desc>
12939	Audio driver the adapter is connected to. This setting
12940	can only be changed when the VM is not running.
12941	</desc>
12942	</attribute>
12943	</interface>
12944
12945	<!--
12946	// IVRDPServer
12947	/////////////////////////////////////////////////////////////////////////
12948	-->
12949
12950	<enum
12951	name="VRDPAuthType"
12952	uuid="3d91887a-b67f-4b33-85bf-2da7ab1ea83a"
12953	>
12954	<desc>
12955	VRDP authentication type.
12956	</desc>
12957
12958	<const name="Null" value="0">
12959	<desc>Null value, also means "no authentication".</desc>
12960	</const>
12961	<const name="External" value="1"/>
12962	<const name="Guest" value="2"/>
12963	</enum>
12964
12965	<interface
12966	name="IVRDPServer" extends="$unknown"
12967	uuid="7aeeb530-0b08-41fe-835d-9be9ec1dbe5c"
12968	wsmap="managed"
12969	>
12970	<attribute name="enabled" type="boolean">
12971	<desc>VRDP server status.</desc>
12972	</attribute>
12973
12974	<attribute name="ports" type="wstring">
12975	<desc>
12976	VRDP server port numbers. The server will try to bind to one of free ports from the list.
12977	<note>
12978	This is a string of comma separated TCP port numbers or port number ranges.
12979	Example <tt>5000,5010-5012,5015</tt>
12980	</note>
12981	</desc>
12982	</attribute>
12983
12984	<attribute name="netAddress" type="wstring">
12985	<desc>VRDP server address.</desc>
12986	</attribute>
12987
12988	<attribute name="authType" type="VRDPAuthType">
12989	<desc>VRDP authentication method.</desc>
12990	</attribute>
12991
12992	<attribute name="authTimeout" type="unsigned long">
12993	<desc>Timeout for guest authentication. Milliseconds.</desc>
12994	</attribute>
12995
12996	<attribute name="allowMultiConnection" type="boolean">
12997	<desc>
12998	Flag whether multiple simultaneous connections to the VM are permitted.
12999	Note that this will be replaced by a more powerful mechanism in the future.
13000	</desc>
13001	</attribute>
13002
13003	<attribute name="reuseSingleConnection" type="boolean">
13004	<desc>
13005	Flag whether the existing connection must be dropped and a new connection
13006	must be established by the VRDP server, when a new client connects in single
13007	connection mode.
13008	</desc>
13009	</attribute>
13010
13011	<attribute name="videoChannel" type="boolean">
13012	<desc>
13013	Flag whether RDP video channel is supported.
13014	</desc>
13015	</attribute>
13016
13017	<attribute name="videoChannelQuality" type="unsigned long">
13018	<desc>
13019	Image quality in percents.
13020	</desc>
13021	</attribute>
13022
13023	</interface>
13024
13025
13026	<!--
13027	// ISharedFolder
13028	/////////////////////////////////////////////////////////////////////////
13029	-->
13030
13031	<interface
13032	name="ISharedFolder" extends="$unknown"
13033	uuid="64637bb2-9e17-471c-b8f3-f8968dd9884e"
13034	wsmap="struct"
13035	>
13036	<desc>
13037	The ISharedFolder interface represents a folder in the host computer's
13038	file system accessible from the guest OS running inside a virtual
13039	machine using an associated logical name.
13040
13041	There are three types of shared folders:
13042	<ul>
13043	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
13044	folders available to all virtual machines.</li>
13045	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
13046	VM-specific shared folders available to the given virtual machine at
13047	startup.</li>
13048	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
13049	VM-specific shared folders created in the session context (for
13050	example, when the virtual machine is running) and automatically
13051	discarded when the session is closed (the VM is powered off).</li>
13052	</ul>
13053
13054	Logical names of shared folders must be unique within the given scope
13055	(global, permanent or transient). However, they do not need to be unique
13056	across scopes. In this case, the definition of the shared folder in a
13057	more specific scope takes precedence over definitions in all other
13058	scopes. The order of precedence is (more specific to more general):
13059	<ol>
13060	<li>Transient definitions</li>
13061	<li>Permanent definitions</li>
13062	<li>Global definitions</li>
13063	</ol>
13064
13065	For example, if MyMachine has a shared folder named
13066	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
13067	transient shared folder named <tt>C_DRIVE</tt> (that points
13068	to <tt>C:\\\\WINDOWS</tt>) will change the definition
13069	of <tt>C_DRIVE</tt> in the guest OS so
13070	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
13071	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
13072	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
13073	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
13074	to <tt>C:\\</tt> if it still exists.
13075
13076	Note that permanent and transient shared folders of different machines
13077	are in different name spaces, so they don't overlap and don't need to
13078	have unique logical names.
13079
13080	<note>
13081	Global shared folders are not implemented in the current version of the
13082	product.
13083	</note>
13084	</desc>
13085
13086	<attribute name="name" type="wstring" readonly="yes">
13087	<desc>Logical name of the shared folder.</desc>
13088	</attribute>
13089
13090	<attribute name="hostPath" type="wstring" readonly="yes">
13091	<desc>Full path to the shared folder in the host file system.</desc>
13092	</attribute>
13093
13094	<attribute name="accessible" type="boolean" readonly="yes">
13095	<desc>
13096	Whether the folder defined by the host path is currently
13097	accessible or not.
13098	For example, the folder can be unaccessible if it is placed
13099	on the network share that is not available by the time
13100	this property is read.
13101	</desc>
13102	</attribute>
13103
13104	<attribute name="writable" type="boolean" readonly="yes">
13105	<desc>
13106	Whether the folder defined by the host path is writable or
13107	not.
13108	</desc>
13109	</attribute>
13110
13111	<attribute name="lastAccessError" type="wstring" readonly="yes">
13112	<desc>
13113	Text message that represents the result of the last accessibility
13114	check.
13115
13116	Accessibility checks are performed each time the <link to="#accessible"/>
13117	attribute is read. An empty string is returned if the last
13118	accessibility check was successful. A non-empty string indicates a
13119	failure and should normally describe a reason of the failure (for
13120	example, a file read error).
13121	</desc>
13122	</attribute>
13123
13124	</interface>
13125
13126	<!--
13127	// ISession
13128	/////////////////////////////////////////////////////////////////////////
13129	-->
13130
13131	<interface
13132	name="IInternalSessionControl" extends="$unknown"
13133	uuid="ab161f72-e4b3-44e6-a919-2256474bda66"
13134	internal="yes"
13135	wsmap="suppress"
13136	>
13137	<method name="getPID">
13138	<desc>PID of the process that has created this Session object.
13139	</desc>
13140	<param name="pid" type="unsigned long" dir="return"/>
13141	</method>
13142
13143	<method name="getRemoteConsole">
13144	<desc>
13145	Returns the console object suitable for remote control.
13146
13147	<result name="VBOX_E_INVALID_VM_STATE">
13148	Session state prevents operation.
13149	</result>
13150	<result name="VBOX_E_INVALID_OBJECT_STATE">
13151	Session type prevents operation.
13152	</result>
13153
13154	</desc>
13155	<param name="console" type="IConsole" dir="return"/>
13156	</method>
13157
13158	<method name="assignMachine">
13159	<desc>
13160	Assigns the machine object associated with this direct-type
13161	session or informs the session that it will be a remote one
13162	(if @a machine == @c null).
13163
13164	<result name="VBOX_E_INVALID_VM_STATE">
13165	Session state prevents operation.
13166	</result>
13167	<result name="VBOX_E_INVALID_OBJECT_STATE">
13168	Session type prevents operation.
13169	</result>
13170
13171	</desc>
13172	<param name="machine" type="IMachine" dir="in"/>
13173	</method>
13174
13175	<method name="assignRemoteMachine">
13176	<desc>
13177	Assigns the machine and the (remote) console object associated with
13178	this remote-type session.
13179
13180	<result name="VBOX_E_INVALID_VM_STATE">
13181	Session state prevents operation.
13182	</result>
13183
13184	</desc>
13185	<param name="machine" type="IMachine" dir="in"/>
13186	<param name="console" type="IConsole" dir="in"/>
13187	</method>
13188
13189	<method name="updateMachineState">
13190	<desc>
13191	Updates the machine state in the VM process.
13192	Must be called only in certain cases
13193	(see the method implementation).
13194
13195	<result name="VBOX_E_INVALID_VM_STATE">
13196	Session state prevents operation.
13197	</result>
13198	<result name="VBOX_E_INVALID_OBJECT_STATE">
13199	Session type prevents operation.
13200	</result>
13201
13202	</desc>
13203	<param name="aMachineState" type="MachineState" dir="in"/>
13204	</method>
13205
13206	<method name="uninitialize">
13207	<desc>
13208	Uninitializes (closes) this session. Used by VirtualBox to close
13209	the corresponding remote session when the direct session dies
13210	or gets closed.
13211
13212	<result name="VBOX_E_INVALID_VM_STATE">
13213	Session state prevents operation.
13214	</result>
13215
13216	</desc>
13217	</method>
13218
13219	<method name="onNetworkAdapterChange">
13220	<desc>
13221	Triggered when settings of a network adapter of the
13222	associated virtual machine have changed.
13223
13224	<result name="VBOX_E_INVALID_VM_STATE">
13225	Session state prevents operation.
13226	</result>
13227	<result name="VBOX_E_INVALID_OBJECT_STATE">
13228	Session type prevents operation.
13229	</result>
13230
13231	</desc>
13232	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
13233	<param name="changeAdapter" type="boolean" dir="in"/>
13234	</method>
13235
13236	<method name="onSerialPortChange">
13237	<desc>
13238	Triggered when settings of a serial port of the
13239	associated virtual machine have changed.
13240
13241	<result name="VBOX_E_INVALID_VM_STATE">
13242	Session state prevents operation.
13243	</result>
13244	<result name="VBOX_E_INVALID_OBJECT_STATE">
13245	Session type prevents operation.
13246	</result>
13247
13248	</desc>
13249	<param name="serialPort" type="ISerialPort" dir="in"/>
13250	</method>
13251
13252	<method name="onParallelPortChange">
13253	<desc>
13254	Triggered when settings of a parallel port of the
13255	associated virtual machine have changed.
13256
13257	<result name="VBOX_E_INVALID_VM_STATE">
13258	Session state prevents operation.
13259	</result>
13260	<result name="VBOX_E_INVALID_OBJECT_STATE">
13261	Session type prevents operation.
13262	</result>
13263
13264	</desc>
13265	<param name="parallelPort" type="IParallelPort" dir="in"/>
13266	</method>
13267
13268	<method name="onStorageControllerChange">
13269	<desc>
13270	Triggered when settings of a storage controller of the
13271	associated virtual machine have changed.
13272
13273	<result name="VBOX_E_INVALID_VM_STATE">
13274	Session state prevents operation.
13275	</result>
13276	<result name="VBOX_E_INVALID_OBJECT_STATE">
13277	Session type prevents operation.
13278	</result>
13279
13280	</desc>
13281	</method>
13282
13283	<method name="onMediumChange">
13284	<desc>
13285	Triggered when attached media of the
13286	associated virtual machine have changed.
13287
13288	<result name="VBOX_E_INVALID_VM_STATE">
13289	Session state prevents operation.
13290	</result>
13291	<result name="VBOX_E_INVALID_OBJECT_STATE">
13292	Session type prevents operation.
13293	</result>
13294
13295	</desc>
13296
13297	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
13298	<param name="force" type="boolean" dir="in"/>
13299	</method>
13300
13301	<method name="onCPUChange">
13302	<desc>
13303	Notification when a CPU changes.
13304	</desc>
13305	<param name="cpu" type="unsigned long" dir="in">
13306	<desc>The CPU which changed</desc>
13307	</param>
13308	<param name="add" type="boolean" dir="in">
13309	<desc>Flag whether the CPU was added or removed</desc>
13310	</param>
13311	</method>
13312
13313	<method name="onVRDPServerChange">
13314	<desc>
13315	Triggered when settings of the VRDP server object of the
13316	associated virtual machine have changed.
13317
13318	<result name="VBOX_E_INVALID_VM_STATE">
13319	Session state prevents operation.
13320	</result>
13321	<result name="VBOX_E_INVALID_OBJECT_STATE">
13322	Session type prevents operation.
13323	</result>
13324
13325	</desc>
13326	<param name="restart" type="boolean" dir="in">
13327	<desc>Flag whether the server must be restarted</desc>
13328	</param>
13329	</method>
13330
13331	<method name="onUSBControllerChange">
13332	<desc>
13333	Triggered when settings of the USB controller object of the
13334	associated virtual machine have changed.
13335
13336	<result name="VBOX_E_INVALID_VM_STATE">
13337	Session state prevents operation.
13338	</result>
13339	<result name="VBOX_E_INVALID_OBJECT_STATE">
13340	Session type prevents operation.
13341	</result>
13342
13343	</desc>
13344	</method>
13345
13346	<method name="onSharedFolderChange">
13347	<desc>
13348	Triggered when a permanent (global or machine) shared folder has been
13349	created or removed.
13350	<note>
13351	We don't pass shared folder parameters in this notification because
13352	the order in which parallel notifications are delivered is not defined,
13353	therefore it could happen that these parameters were outdated by the
13354	time of processing this notification.
13355	</note>
13356
13357	<result name="VBOX_E_INVALID_VM_STATE">
13358	Session state prevents operation.
13359	</result>
13360	<result name="VBOX_E_INVALID_OBJECT_STATE">
13361	Session type prevents operation.
13362	</result>
13363
13364	</desc>
13365	<param name="global" type="boolean" dir="in"/>
13366	</method>
13367
13368	<method name="onUSBDeviceAttach">
13369	<desc>
13370	Triggered when a request to capture a USB device (as a result
13371	of matched USB filters or direct call to
13372	<link to="IConsole::attachUSBDevice"/>) has completed.
13373	A @c null @a error object means success, otherwise it
13374	describes a failure.
13375
13376	<result name="VBOX_E_INVALID_VM_STATE">
13377	Session state prevents operation.
13378	</result>
13379	<result name="VBOX_E_INVALID_OBJECT_STATE">
13380	Session type prevents operation.
13381	</result>
13382
13383	</desc>
13384	<param name="device" type="IUSBDevice" dir="in"/>
13385	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13386	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
13387	</method>
13388
13389	<method name="onUSBDeviceDetach">
13390	<desc>
13391	Triggered when a request to release the USB device (as a result
13392	of machine termination or direct call to
13393	<link to="IConsole::detachUSBDevice"/>) has completed.
13394	A @c null @a error object means success, otherwise it
13395	describes a failure.
13396
13397	<result name="VBOX_E_INVALID_VM_STATE">
13398	Session state prevents operation.
13399	</result>
13400	<result name="VBOX_E_INVALID_OBJECT_STATE">
13401	Session type prevents operation.
13402	</result>
13403
13404	</desc>
13405	<param name="id" type="uuid" mod="string" dir="in"/>
13406	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13407	</method>
13408
13409	<method name="onShowWindow">
13410	<desc>
13411	Called by <link to="IMachine::canShowConsoleWindow"/> and by
13412	<link to="IMachine::showConsoleWindow"/> in order to notify
13413	console callbacks
13414	<link to="IConsoleCallback::onCanShowWindow"/>
13415	and <link to="IConsoleCallback::onShowWindow"/>.
13416
13417	<result name="VBOX_E_INVALID_OBJECT_STATE">
13418	Session type prevents operation.
13419	</result>
13420
13421	</desc>
13422	<param name="check" type="boolean" dir="in"/>
13423	<param name="canShow" type="boolean" dir="out"/>
13424	<param name="winId" type="unsigned long long" dir="out"/>
13425	</method>
13426
13427	<method name="accessGuestProperty">
13428	<desc>
13429	Called by <link to="IMachine::getGuestProperty"/> and by
13430	<link to="IMachine::setGuestProperty"/> in order to read and
13431	modify guest properties.
13432
13433	<result name="VBOX_E_INVALID_VM_STATE">
13434	Machine session is not open.
13435	</result>
13436	<result name="VBOX_E_INVALID_OBJECT_STATE">
13437	Session type is not direct.
13438	</result>
13439
13440	</desc>
13441	<param name="name" type="wstring" dir="in"/>
13442	<param name="value" type="wstring" dir="in"/>
13443	<param name="flags" type="wstring" dir="in"/>
13444	<param name="isSetter" type="boolean" dir="in"/>
13445	<param name="retValue" type="wstring" dir="out"/>
13446	<param name="retTimestamp" type="unsigned long long" dir="out"/>
13447	<param name="retFlags" type="wstring" dir="out"/>
13448	</method>
13449
13450	<method name="enumerateGuestProperties">
13451	<desc>
13452	Return a list of the guest properties matching a set of patterns along
13453	with their values, time stamps and flags.
13454
13455	<result name="VBOX_E_INVALID_VM_STATE">
13456	Machine session is not open.
13457	</result>
13458	<result name="VBOX_E_INVALID_OBJECT_STATE">
13459	Session type is not direct.
13460	</result>
13461
13462	</desc>
13463	<param name="patterns" type="wstring" dir="in">
13464	<desc>
13465	The patterns to match the properties against as a comma-separated
13466	string. If this is empty, all properties currently set will be
13467	returned.
13468	</desc>
13469	</param>
13470	<param name="key" type="wstring" dir="out" safearray="yes">
13471	<desc>
13472	The key names of the properties returned.
13473	</desc>
13474	</param>
13475	<param name="value" type="wstring" dir="out" safearray="yes">
13476	<desc>
13477	The values of the properties returned. The array entries match the
13478	corresponding entries in the @a key array.
13479	</desc>
13480	</param>
13481	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
13482	<desc>
13483	The time stamps of the properties returned. The array entries match
13484	the corresponding entries in the @a key array.
13485	</desc>
13486	</param>
13487	<param name="flags" type="wstring" dir="out" safearray="yes">
13488	<desc>
13489	The flags of the properties returned. The array entries match the
13490	corresponding entries in the @a key array.
13491	</desc>
13492	</param>
13493	</method>
13494
13495	<method name="onlineMergeMedium">
13496	<desc>
13497	Triggers online merging of a hard disk. Used internally when deleting
13498	a snapshot while a VM referring to the same hard disk chain is running.
13499
13500	<result name="VBOX_E_INVALID_VM_STATE">
13501	Machine session is not open.
13502	</result>
13503	<result name="VBOX_E_INVALID_OBJECT_STATE">
13504	Session type is not direct.
13505	</result>
13506
13507	</desc>
13508	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
13509	<desc>The medium attachment to identify the medium chain.</desc>
13510	</param>
13511	<param name="sourceIdx" type="unsigned long" dir="in">
13512	<desc>The index of the source image in the chain.
13513	Redundant, but drastically reduces IPC.</desc>
13514	</param>
13515	<param name="targetIdx" type="unsigned long" dir="in">
13516	<desc>The index of the target image in the chain.
13517	Redundant, but drastically reduces IPC.</desc>
13518	</param>
13519	<param name="source" type="IMedium" dir="in">
13520	<desc>Merge source medium.</desc>
13521	</param>
13522	<param name="target" type="IMedium" dir="in">
13523	<desc>Merge target medium.</desc>
13524	</param>
13525	<param name="mergeForward" type="boolean" dir="in">
13526	<desc>Merge direction.</desc>
13527	</param>
13528	<param name="parentForTarget" type="IMedium" dir="in">
13529	<desc>For forward merges: new parent for target medium.</desc>
13530	</param>
13531	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
13532	<desc>For backward merges: list of media which need their parent UUID
13533	updated.</desc>
13534	</param>
13535	<param name="progress" type="IProgress" dir="in">
13536	<desc>
13537	Progress object for this operation.
13538	</desc>
13539	</param>
13540	</method>
13541
13542	</interface>
13543
13544	<interface
13545	name="ISession" extends="$unknown"
13546	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
13547	wsmap="managed"
13548	>
13549	<desc>
13550	The ISession interface represents a serialization primitive for virtual
13551	machines.
13552
13553	With VirtualBox, every time one wishes to manipulate a virtual machine
13554	(e.g. change its settings or start execution), a session object is
13555	required. Such an object must be passed to one of the session methods
13556	that open the given session, which then initiates the machine manipulation.
13557
13558	A session serves several purposes: it identifies to the inter-process VirtualBox
13559	code which process is currently working with the virtual machine, and it ensures
13560	that there are no incompatible requests from several processes for the
13561	same virtual machine. Session objects can therefore be thought of as mutex
13562	semaphores that lock virtual machines to prevent conflicting accesses from
13563	several processes.
13564
13565	How sessions objects are used depends on whether you use the Main API
13566	via COM or via the webservice:
13567
13568	<ul>
13569	<li>When using the COM API directly, an object of the Session class from the
13570	VirtualBox type library needs to be created. In regular COM C++ client code,
13571	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
13572	This object will then act as a local session object in further calls to open
13573	a session.
13574	</li>
13575
13576	<li>In the webservice, the session manager (IWebsessionManager) instead creates
13577	one session object automatically when <link to="IWebsessionManager::logon" />
13578	is called. A managed object reference to that session object can be retrieved by
13579	calling <link to="IWebsessionManager::getSessionObject" />. This session object
13580	reference can then be used to open sessions.
13581	</li>
13582	</ul>
13583
13584	Sessions are mainly used in two variations:
13585
13586	<ul>
13587	<li>
13588	To start a virtual machine in a separate process, one would call
13589	<link to="IVirtualBox::openRemoteSession"/>, which requires a session
13590	object as its first parameter. This session then identifies the caller
13591	and lets him control the started machine (for example, pause machine
13592	execution or power it down) as well as be notified about machine
13593	execution state changes.
13594	</li>
13595
13596	<li>To alter machine settings, or to start machine execution within the
13597	current process, one needs to open a direct session for the machine first by
13598	calling <link to="IVirtualBox::openSession"/>. While a direct session
13599	is open within one process, no any other process may open another direct
13600	session for the same machine. This prevents the machine from being changed
13601	by other processes while it is running or while the machine is being configured.
13602	</li>
13603	</ul>
13604
13605	One also can attach to an existing direct session already opened by
13606	another process (for example, in order to send a control request to the
13607	virtual machine such as the pause or the reset request). This is done by
13608	calling <link to="IVirtualBox::openExistingSession"/>.
13609
13610	<note>
13611	Unless you are trying to write a new VirtualBox front-end that
13612	performs direct machine execution (like the VirtualBox or VBoxSDL
13613	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
13614	session opened by <link to="IVirtualBox::openSession"/> and use this
13615	session only to change virtual machine settings. If you simply want to
13616	start virtual machine execution using one of the existing front-ends
13617	(for example the VirtualBox GUI or headless server), simply use
13618	<link to="IVirtualBox::openRemoteSession"/>; these front-ends
13619	will power up the machine automatically for you.
13620	</note>
13621	</desc>
13622
13623	<attribute name="state" type="SessionState" readonly="yes">
13624	<desc>Current state of this session.</desc>
13625	</attribute>
13626
13627	<attribute name="type" type="SessionType" readonly="yes">
13628	<desc>
13629	Type of this session. The value of this attribute is valid only
13630	if the session is currently open (i.e. its #state is
13631	SessionType_SessionOpen), otherwise an error will be returned.
13632	</desc>
13633	</attribute>
13634
13635	<attribute name="machine" type="IMachine" readonly="yes">
13636	<desc>Machine object associated with this session.</desc>
13637	</attribute>
13638
13639	<attribute name="console" type="IConsole" readonly="yes">
13640	<desc>Console object associated with this session.</desc>
13641	</attribute>
13642
13643	<method name="close">
13644	<desc>
13645	Closes a session that was previously opened.
13646
13647	It is recommended that every time an "open session" method (such as
13648	<link to="IVirtualBox::openRemoteSession" /> or
13649	<link to="IVirtualBox::openSession" />) has been called to
13650	manipulate a virtual machine, the caller invoke
13651	ISession::close() when it's done doing so. Since sessions are
13652	serialization primitives much like ordinary mutexes, they are
13653	best used the same way: for each "open" call, there should be
13654	a matching "close" call, even when errors occur.
13655
13656	Otherwise, if a direct session for a machine opened with
13657	<link to="IVirtualBox::openSession"/> is not explicitly closed
13658	when the application terminates, the state of the machine will
13659	be set to <link to="MachineState_Aborted" /> on the server.
13660
13661	Generally, it is recommended to close all open sessions explicitly
13662	before terminating the application (regardless of the reason for
13663	the termination).
13664
13665	<note>
13666	Do not expect the session state (<link to="ISession::state" />
13667	to return to "Closed" immediately after you invoke
13668	ISession::close(), particularly if you have started a remote
13669	session to execute the VM in a new process. The session state will
13670	automatically return to "Closed" once the VM is no longer executing,
13671	which can of course take a very long time.
13672	</note>
13673
13674	<result name="E_UNEXPECTED">
13675	Session is not open.
13676	</result>
13677
13678	</desc>
13679	</method>
13680
13681	</interface>
13682
13683	<!--
13684	// IStorageController
13685	/////////////////////////////////////////////////////////////////////////
13686	-->
13687
13688	<enum
13689	name="StorageBus"
13690	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
13691	>
13692	<desc>
13693	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
13694	see <link to="IStorageController::bus" />.
13695	</desc>
13696	<const name="Null" value="0">
13697	<desc>@c null value. Never used by the API.</desc>
13698	</const>
13699	<const name="IDE" value="1"/>
13700	<const name="SATA" value="2"/>
13701	<const name="SCSI" value="3"/>
13702	<const name="Floppy" value="4"/>
13703	<const name="SAS" value="5"/>
13704	</enum>
13705
13706	<enum
13707	name="StorageControllerType"
13708	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13709	>
13710	<desc>
13711	The exact variant of storage controller hardware presented
13712	to the guest; see <link to="IStorageController::controllerType" />.
13713	</desc>
13714
13715	<const name="Null" value="0">
13716	<desc>@c null value. Never used by the API.</desc>
13717	</const>
13718	<const name="LsiLogic" value="1">
13719	<desc>A SCSI controller of the LsiLogic variant.</desc>
13720	</const>
13721	<const name="BusLogic" value="2">
13722	<desc>A SCSI controller of the BusLogic variant.</desc>
13723	</const>
13724	<const name="IntelAhci" value="3">
13725	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13726	</const>
13727	<const name="PIIX3" value="4">
13728	<desc>An IDE controller of the PIIX3 variant.</desc>
13729	</const>
13730	<const name="PIIX4" value="5">
13731	<desc>An IDE controller of the PIIX4 variant.</desc>
13732	</const>
13733	<const name="ICH6" value="6">
13734	<desc>An IDE controller of the ICH6 variant.</desc>
13735	</const>
13736	<const name="I82078" value="7">
13737	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
13738	</const>
13739	<const name="LsiLogicSas" value="8">
13740	<desc>A variant of the LsiLogic controller using SAS.</desc>
13741	</const>
13742	</enum>
13743
13744	<interface
13745	name="IStorageController" extends="$unknown"
13746	uuid="fd93adc0-bbaa-4256-9e6e-00e29f9151c9"
13747	wsmap="managed"
13748	>
13749	<desc>
13750	Represents a storage controller that is attached to a virtual machine
13751	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
13752	attached to storage controllers in a real computer, virtual drives
13753	(represented by <link to="IMediumAttachment" />) are attached to virtual
13754	storage controllers, represented by this interface.
13755
13756	As opposed to physical hardware, VirtualBox has a very generic concept
13757	of a storage controller, and for purposes of the Main API, all virtual
13758	storage is attached to virtual machines via instances of this interface.
13759	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
13760	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
13761	is used, certain sub-types may be available and can be selected in
13762	<link to="#controllerType" />.
13763
13764	Depending on these settings, the guest operating system might see
13765	significantly different virtual hardware.
13766	</desc>
13767
13768	<attribute name="name" type="wstring" readonly="yes">
13769	<desc>
13770	Name of the storage controller, as originally specified with
13771	<link to="IMachine::addStorageController" />. This then uniquely
13772	identifies this controller with other method calls such as
13773	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
13774	</desc>
13775	</attribute>
13776
13777	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
13778	<desc>
13779	Maximum number of devices which can be attached to one port.
13780	</desc>
13781	</attribute>
13782
13783	<attribute name="minPortCount" type="unsigned long" readonly="yes">
13784	<desc>
13785	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
13786	</desc>
13787	</attribute>
13788
13789	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
13790	<desc>
13791	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
13792	</desc>
13793	</attribute>
13794
13795	<attribute name="instance" type="unsigned long">
13796	<desc>
13797	The instance number of the device in the running VM.
13798	</desc>
13799	</attribute>
13800
13801	<attribute name="portCount" type="unsigned long">
13802	<desc>
13803	The number of currently usable ports on the controller.
13804	The minimum and maximum number of ports for one controller are
13805	stored in <link to="IStorageController::minPortCount"/>
13806	and <link to="IStorageController::maxPortCount"/>.
13807	</desc>
13808	</attribute>
13809
13810	<attribute name="bus" type="StorageBus" readonly="yes">
13811	<desc>
13812	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
13813	</desc>
13814	</attribute>
13815
13816	<attribute name="controllerType" type="StorageControllerType">
13817	<desc>
13818	The exact variant of storage controller hardware presented
13819	to the guest.
13820	Depending on this value, VirtualBox will provide a different
13821	virtual storage controller hardware to the guest.
13822	For SATA, SAS and floppy controllers, only one variant is
13823	available, but for IDE and SCSI, there are several.
13824
13825	For SCSI controllers, the default type is LsiLogic.
13826	</desc>
13827	</attribute>
13828
13829	<attribute name="useHostIOCache" type="boolean">
13830	<desc>
13831	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
13832	caches and use synchronous file APIs on the host. This was the only option in the API before
13833	VirtualBox 3.2 and is still the default for IDE controllers.
13834
13835	If false, the host I/O cache will be disabled for image files attached to this storage controller.
13836	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
13837	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
13838	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
13839	virtual machines are running at the same time to prevent I/O cache related hangs.
13840	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
13841	</desc>
13842	</attribute>
13843
13844	<method name="getIDEEmulationPort">
13845	<desc>
13846	Gets the corresponding port number which is emulated as an IDE device.
13847	Works only with SATA controllers.
13848
13849	<result name="E_INVALIDARG">
13850	The @a devicePosition is not in the range 0 to 3.
13851	</result>
13852	<result name="E_NOTIMPL">
13853	The storage controller type is not SATAIntelAhci.
13854	</result>
13855
13856	</desc>
13857	<param name="devicePosition" type="long" dir="in"/>
13858	<param name="portNumber" type="long" dir="return"/>
13859	</method>
13860
13861	<method name="setIDEEmulationPort">
13862	<desc>
13863	Sets the port number which is emulated as an IDE device.
13864	Works only with SATA controllers.
13865
13866	<result name="E_INVALIDARG">
13867	The @a devicePosition is not in the range 0 to 3 or the
13868	@a portNumber is not in the range 0 to 29.
13869	</result>
13870	<result name="E_NOTIMPL">
13871	The storage controller type is not SATAIntelAhci.
13872	</result>
13873
13874	</desc>
13875	<param name="devicePosition" type="long" dir="in"/>
13876	<param name="portNumber" type="long" dir="in"/>
13877	</method>
13878
13879	</interface>
13880
13881	<if target="wsdl">
13882
13883	<!--
13884	// IManagedObjectRef
13885	/////////////////////////////////////////////////////////////////////////
13886	-->
13887
13888	<interface
13889	name="IManagedObjectRef" extends="$unknown"
13890	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13891	internal="yes"
13892	wsmap="managed"
13893	wscpp="hardcoded"
13894	>
13895	<desc>
13896	Managed object reference.
13897
13898	Only within the webservice, a managed object reference (which is really
13899	an opaque number) allows a webservice client to address an object
13900	that lives in the address space of the webservice server.
13901
13902	Behind each managed object reference, there is a COM object that lives
13903	in the webservice server's address space. The COM object is not freed
13904	until the managed object reference is released, either by an explicit
13905	call to <link to="IManagedObjectRef::release" /> or by logging off from
13906	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13907	all objects created during the webservice session.
13908
13909	Whenever a method call of the VirtualBox API returns a COM object, the
13910	webservice representation of that method will instead return a
13911	managed object reference, which can then be used to invoke methods
13912	on that object.
13913	</desc>
13914
13915	<method name="getInterfaceName">
13916	<desc>
13917	Returns the name of the interface that this managed object represents,
13918	for example, "IMachine", as a string.
13919	</desc>
13920	<param name="return" type="wstring" dir="return"/>
13921	</method>
13922
13923	<method name="release">
13924	<desc>
13925	Releases this managed object reference and frees the resources that
13926	were allocated for it in the webservice server process. After calling
13927	this method, the identifier of the reference can no longer be used.
13928	</desc>
13929	</method>
13930
13931	</interface>
13932
13933	<!--
13934	// IWebsessionManager
13935	/////////////////////////////////////////////////////////////////////////
13936	-->
13937
13938	<interface
13939	name="IWebsessionManager" extends="$unknown"
13940	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13941	internal="yes"
13942	wsmap="global"
13943	wscpp="hardcoded"
13944	>
13945	<desc>
13946	Websession manager. This provides essential services
13947	to webservice clients.
13948	</desc>
13949	<method name="logon">
13950	<desc>
13951	Logs a new client onto the webservice and returns a managed object reference to
13952	the IVirtualBox instance, which the client can then use as a basis to further
13953	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13954	interface, in one way or the other.
13955	</desc>
13956	<param name="username" type="wstring" dir="in"/>
13957	<param name="password" type="wstring" dir="in"/>
13958	<param name="return" type="IVirtualBox" dir="return"/>
13959	</method>
13960
13961	<method name="getSessionObject">
13962	<desc>
13963	Returns a managed object reference to the internal ISession object that was created
13964	for this web service session when the client logged on.
13965
13966	<see>ISession</see>
13967	</desc>
13968	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13969	<param name="return" type="ISession" dir="return"/>
13970	</method>
13971
13972	<method name="logoff">
13973	<desc>
13974	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13975	and destroys all resources associated with the session (most importantly, all
13976	managed objects created in the server while the session was active).
13977	</desc>
13978	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13979	</method>
13980
13981	</interface>
13982
13983	</if>
13984
13985	<!--
13986	// IPerformanceCollector & friends
13987	/////////////////////////////////////////////////////////////////////////
13988	-->
13989
13990	<interface
13991	name="IPerformanceMetric" extends="$unknown"
13992	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
13993	>
13994	<desc>
13995	The IPerformanceMetric interface represents parameters of the given
13996	performance metric.
13997	</desc>
13998
13999	<attribute name="metricName" type="wstring" readonly="yes">
14000	<desc>
14001	Name of the metric.
14002	</desc>
14003	</attribute>
14004
14005	<attribute name="object" type="$unknown" readonly="yes">
14006	<desc>
14007	Object this metric belongs to.
14008	</desc>
14009	</attribute>
14010
14011	<attribute name="description" type="wstring" readonly="yes">
14012	<desc>
14013	Textual description of the metric.
14014	</desc>
14015	</attribute>
14016
14017	<attribute name="period" type="unsigned long" readonly="yes">
14018	<desc>
14019	Time interval between samples, measured in seconds.
14020	</desc>
14021	</attribute>
14022
14023	<attribute name="count" type="unsigned long" readonly="yes">
14024	<desc>
14025	Number of recent samples retained by the performance collector for this
14026	metric.
14027
14028	When the collected sample count exceeds this number, older samples
14029	are discarded.
14030	</desc>
14031	</attribute>
14032
14033	<attribute name="unit" type="wstring" readonly="yes">
14034	<desc>
14035	Unit of measurement.
14036	</desc>
14037	</attribute>
14038
14039	<attribute name="minimumValue" type="long" readonly="yes">
14040	<desc>
14041	Minimum possible value of this metric.
14042	</desc>
14043	</attribute>
14044
14045	<attribute name="maximumValue" type="long" readonly="yes">
14046	<desc>
14047	Maximum possible value of this metric.
14048	</desc>
14049	</attribute>
14050	</interface>
14051
14052	<interface
14053	name="IPerformanceCollector" extends="$unknown"
14054	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
14055	wsmap="managed"
14056	>
14057	<desc>
14058	The IPerformanceCollector interface represents a service that collects
14059	and stores performance metrics data.
14060
14061	Performance metrics are associated with objects of interfaces like IHost
14062	and IMachine. Each object has a distinct set of performance metrics. The
14063	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
14064
14065	Metric data is collected at the specified intervals and is retained
14066	internally. The interval and the number of retained samples can be set
14067	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
14068	and collection settings are not persistent, they are discarded as soon as
14069	VBoxSVC process terminates. Moreover, metric settings and data associated
14070	with a particular VM only exist while VM is running. They disappear as
14071	soon as VM shuts down. It is not possible to set up metrics for machines
14072	that are powered off. One needs to start VM first, then set up metric
14073	collection parameters.
14074
14075	Metrics are organized hierarchically, with each level separated by a
14076	slash (/) character. Generally, the scheme for metric names is like this:
14077
14078	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
14079
14080	"Category/Metric" together form the base metric name. A base metric is
14081	the smallest unit for which a sampling interval and the number of
14082	retained samples can be set. Only base metrics can be enabled and
14083	disabled. All sub-metrics are collected when their base metric is
14084	collected. Collected values for any set of sub-metrics can be queried
14085	with <link to="IPerformanceCollector::queryMetricsData" />.
14086
14087	For example "CPU/Load/User:avg" metric name stands for the "CPU"
14088	category, "Load" metric, "User" submetric, "average" aggregate. An
14089	aggregate function is computed over all retained data. Valid aggregate
14090	functions are:
14091
14092	<ul>
14093	<li>avg -- average</li>
14094	<li>min -- minimum</li>
14095	<li>max -- maximum</li>
14096	</ul>
14097
14098	When setting up metric parameters, querying metric data, enabling or
14099	disabling metrics wildcards can be used in metric names to specify a
14100	subset of metrics. For example, to select all CPU-related metrics
14101	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
14102	so on. To query metric values without aggregates <tt>*:</tt> can be used.
14103
14104	The valid names for base metrics are:
14105
14106	<ul>
14107	<li>CPU/Load</li>
14108	<li>CPU/MHz</li>
14109	<li>RAM/Usage</li>
14110	</ul>
14111
14112	The general sequence for collecting and retrieving the metrics is:
14113	<ul>
14114	<li>
14115	Obtain an instance of IPerformanceCollector with
14116	<link to="IVirtualBox::performanceCollector" />
14117	</li>
14118	<li>
14119	Allocate and populate an array with references to objects the metrics
14120	will be collected for. Use references to IHost and IMachine objects.
14121	</li>
14122	<li>
14123	Allocate and populate an array with base metric names the data will
14124	be collected for.
14125	</li>
14126	<li>
14127	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
14128	the metric data will be collected and stored.
14129	</li>
14130	<li>
14131	Wait for the data to get collected.
14132	</li>
14133	<li>
14134	Allocate and populate an array with references to objects the metric
14135	values will be queried for. You can re-use the object array used for
14136	setting base metrics.
14137	</li>
14138	<li>
14139	Allocate and populate an array with metric names the data will be
14140	collected for. Note that metric names differ from base metric names.
14141	</li>
14142	<li>
14143	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
14144	that have been collected so far are returned. Note that the values
14145	are still retained internally and data collection continues.
14146	</li>
14147	</ul>
14148
14149	For an example of usage refer to the following files in VirtualBox SDK:
14150	<ul>
14151	<li>
14152	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
14153	</li>
14154	<li>
14155	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
14156	</li>
14157	</ul>
14158	</desc>
14159
14160	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
14161	<desc>
14162	Array of unique names of metrics.
14163
14164	This array represents all metrics supported by the performance
14165	collector. Individual objects do not necessarily support all of them.
14166	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
14167	list of supported metrics for a particular object.
14168	</desc>
14169	</attribute>
14170
14171	<method name="getMetrics">
14172	<desc>
14173	Returns parameters of specified metrics for a set of objects.
14174	<note>
14175	@c Null metrics array means all metrics. @c Null object array means
14176	all existing objects.
14177	</note>
14178	</desc>
14179	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14180	<desc>
14181	Metric name filter. Currently, only a comma-separated list of metrics
14182	is supported.
14183	</desc>
14184	</param>
14185	<param name="objects" type="$unknown" dir="in" safearray="yes">
14186	<desc>
14187	Set of objects to return metric parameters for.
14188	</desc>
14189	</param>
14190	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
14191	<desc>
14192	Array of returned metric parameters.
14193	</desc>
14194	</param>
14195	</method>
14196
14197	<method name="setupMetrics">
14198	<desc>
14199	Sets parameters of specified base metrics for a set of objects. Returns
14200	an array of <link to="IPerformanceMetric" /> describing the metrics
14201	have been affected.
14202	<note>
14203	@c Null or empty metric name array means all metrics. @c Null or
14204	empty object array means all existing objects. If metric name array
14205	contains a single element and object array contains many, the single
14206	metric name array element is applied to each object array element to
14207	form metric/object pairs.
14208	</note>
14209	</desc>
14210	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14211	<desc>
14212	Metric name filter. Comma-separated list of metrics with wildcard
14213	support.
14214	</desc>
14215	</param>
14216	<param name="objects" type="$unknown" dir="in" safearray="yes">
14217	<desc>
14218	Set of objects to setup metric parameters for.
14219	</desc>
14220	</param>
14221	<param name="period" type="unsigned long" dir="in">
14222	<desc>
14223	Time interval in seconds between two consecutive samples of
14224	performance data.
14225	</desc>
14226	</param>
14227	<param name="count" type="unsigned long" dir="in">
14228	<desc>
14229	Number of samples to retain in performance data history. Older
14230	samples get discarded.
14231	</desc>
14232	</param>
14233	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14234	<desc>
14235	Array of metrics that have been modified by the call to this method.
14236	</desc>
14237	</param>
14238	</method>
14239
14240	<method name="enableMetrics">
14241	<desc>
14242	Turns on collecting specified base metrics. Returns an array of
14243	<link to="IPerformanceMetric" /> describing the metrics have been
14244	affected.
14245	<note>
14246	@c Null or empty metric name array means all metrics. @c Null or
14247	empty object array means all existing objects. If metric name array
14248	contains a single element and object array contains many, the single
14249	metric name array element is applied to each object array element to
14250	form metric/object pairs.
14251	</note>
14252	</desc>
14253	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14254	<desc>
14255	Metric name filter. Comma-separated list of metrics with wildcard
14256	support.
14257	</desc>
14258	</param>
14259	<param name="objects" type="$unknown" dir="in" safearray="yes">
14260	<desc>
14261	Set of objects to enable metrics for.
14262	</desc>
14263	</param>
14264	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14265	<desc>
14266	Array of metrics that have been modified by the call to this method.
14267	</desc>
14268	</param>
14269	</method>
14270
14271	<method name="disableMetrics">
14272	<desc>
14273	Turns off collecting specified base metrics. Returns an array of
14274	<link to="IPerformanceMetric" /> describing the metrics have been
14275	affected.
14276	<note>
14277	@c Null or empty metric name array means all metrics. @c Null or
14278	empty object array means all existing objects. If metric name array
14279	contains a single element and object array contains many, the single
14280	metric name array element is applied to each object array element to
14281	form metric/object pairs.
14282	</note>
14283	</desc>
14284	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14285	<desc>
14286	Metric name filter. Comma-separated list of metrics with wildcard
14287	support.
14288	</desc>
14289	</param>
14290	<param name="objects" type="$unknown" dir="in" safearray="yes">
14291	<desc>
14292	Set of objects to disable metrics for.
14293	</desc>
14294	</param>
14295	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14296	<desc>
14297	Array of metrics that have been modified by the call to this method.
14298	</desc>
14299	</param>
14300	</method>
14301
14302	<method name="queryMetricsData">
14303	<desc>
14304	Queries collected metrics data for a set of objects.
14305
14306	The data itself and related metric information are returned in seven
14307	parallel and one flattened array of arrays. Elements of
14308	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
14309	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
14310	the same index describe one set of values corresponding to a single
14311	metric.
14312
14313	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
14314	start and length of a sub-array is indicated by
14315	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
14316	value for metric <tt>metricNames[i]</tt> is at
14317	<tt>returnData[returnIndices[i]]</tt>.
14318
14319	<note>
14320	@c Null or empty metric name array means all metrics. @c Null or
14321	empty object array means all existing objects. If metric name array
14322	contains a single element and object array contains many, the single
14323	metric name array element is applied to each object array element to
14324	form metric/object pairs.
14325	</note>
14326	<note>
14327	Data collection continues behind the scenes after call to @c
14328	queryMetricsData. The return data can be seen as the snapshot of the
14329	current state at the time of @c queryMetricsData call. The internally
14330	kept metric values are not cleared by the call. This makes possible
14331	querying different subsets of metrics or aggregates with subsequent
14332	calls. If periodic querying is needed it is highly suggested to query
14333	the values with @c interval*count period to avoid confusion. This way
14334	a completely new set of data values will be provided by each query.
14335	</note>
14336	</desc>
14337	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14338	<desc>
14339	Metric name filter. Comma-separated list of metrics with wildcard
14340	support.
14341	</desc>
14342	</param>
14343	<param name="objects" type="$unknown" dir="in" safearray="yes">
14344	<desc>
14345	Set of objects to query metrics for.
14346	</desc>
14347	</param>
14348	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
14349	<desc>
14350	Names of metrics returned in @c returnData.
14351	</desc>
14352	</param>
14353	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
14354	<desc>
14355	Objects associated with metrics returned in @c returnData.
14356	</desc>
14357	</param>
14358	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
14359	<desc>
14360	Units of measurement for each returned metric.
14361	</desc>
14362	</param>
14363	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
14364	<desc>
14365	Divisor that should be applied to return values in order to get
14366	floating point values. For example:
14367	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
14368	will retrieve the floating point value of i-th sample of the first
14369	metric.
14370	</desc>
14371	</param>
14372	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
14373	<desc>
14374	Sequence numbers of the first elements of value sequences of
14375	particular metrics returned in @c returnData. For aggregate metrics
14376	it is the sequence number of the sample the aggregate started
14377	calculation from.
14378	</desc>
14379	</param>
14380	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
14381	<desc>
14382	Indices of the first elements of value sequences of particular
14383	metrics returned in @c returnData.
14384	</desc>
14385	</param>
14386	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
14387	<desc>
14388	Lengths of value sequences of particular metrics.
14389	</desc>
14390	</param>
14391	<param name="returnData" type="long" dir="return" safearray="yes">
14392	<desc>
14393	Flattened array of all metric data containing sequences of values for
14394	each metric.
14395	</desc>
14396	</param>
14397	</method>
14398
14399	</interface>
14400	<enum
14401	name="NATAliasMode"
14402	uuid="67772168-50d9-11df-9669-7fb714ee4fa1">
14403	<desc></desc>
14404	<const name="AliasLog" value="0x1">
14405	<desc></desc>
14406	</const>
14407	<const name="AliasProxyOnly" value="0x02">
14408	<desc></desc>
14409	</const>
14410	<const name="AliasUseSamePorts" value="0x04">
14411	<desc></desc>
14412	</const>
14413	</enum>
14414	<enum
14415	name="NATProtocol"
14416	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
14417	>
14418	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
14419	<const name="UDP" value="0">
14420	<desc>Port-forwarding uses UDP protocol.</desc>
14421	</const>
14422	<const name="TCP" value="1">
14423	<desc>Port-forwarding uses TCP protocol.</desc>
14424	</const>
14425	</enum>
14426
14427	<interface
14428	name="INATEngine" extends="$unknown"
14429	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
14430	wsmap="managed"
14431	>
14432	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
14433	allows for changing NAT behavior such as port-forwarding rules. This interface is
14434	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
14435	<attribute name="network" type="wstring">
14436	<desc>The network attribute of the NAT engine (the same value is used with built-in
14437	DHCP server to fill corresponding fields of DHCP leases).</desc>
14438	</attribute>
14439	<attribute name="hostIP" type="wstring">
14440	<desc>IP of host interface to bind all opened sockets to.
14441	<note>Changing this does not change binding of port forwarding.</note>
14442	</desc>
14443	</attribute>
14444	<attribute name="tftpPrefix" type="wstring">
14445	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
14446	the corresponding fields of DHCP leases.</desc>
14447	</attribute>
14448	<attribute name="tftpBootFile" type="wstring">
14449	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
14450	the corresponding fields of DHCP leases.</desc>
14451	</attribute>
14452	<attribute name="tftpNextServer" type="wstring">
14453	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
14454	the corresponding fields of DHCP leases.
14455	<note>The preferred form is IPv4 addresses.</note>
14456	</desc>
14457	</attribute>
14458	<attribute name="aliasMode" type="unsigned long">
14459	<desc></desc>
14460	</attribute>
14461	<attribute name="dnsPassDomain" type="boolean">
14462	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
14463	</attribute>
14464	<attribute name="dnsProxy" type="boolean">
14465	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14466	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
14467	</attribute>
14468	<attribute name="dnsUseHostResolver" type="boolean">
14469	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14470	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
14471	</attribute>
14472	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
14473	<desc>Array of NAT port-forwarding rules in string representation, in the following
14474	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
14475	</attribute>
14476	<method name="setNetworkSettings">
14477	<desc>Sets network configuration of the NAT engine.</desc>
14478	<param name="mtu" type="unsigned long" dir="in">
14479	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
14480	</param>
14481	<param name="sockSnd" type="unsigned long" dir="in">
14482	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
14483	</param>
14484	<param name="sockRcv" type="unsigned long" dir="in">
14485	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
14486	</param>
14487	<param name="TcpWndSnd" type="unsigned long" dir="in">
14488	<desc>Initial size of the NAT engine's sending TCP window in bytes when
14489	establishing a new TCP connection.</desc>
14490	</param>
14491	<param name="TcpWndRcv" type="unsigned long" dir="in">
14492	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
14493	establishing a new TCP connection.</desc>
14494	</param>
14495	</method>
14496	<method name="getNetworkSettings">
14497	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
14498	for parameter descriptions.</desc>
14499	<param name="mtu" type="unsigned long" dir="out" />
14500	<param name="sockSnd" type="unsigned long" dir="out" />
14501	<param name="sockRcv" type="unsigned long" dir="out" />
14502	<param name="TcpWndSnd" type="unsigned long" dir="out" />
14503	<param name="TcpWndRcv" type="unsigned long" dir="out" />
14504	</method>
14505	<method name="addRedirect">
14506	<desc>Adds a new NAT port-forwarding rule.</desc>
14507	<param name="name" type="wstring" dir="in">
14508	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
14509	auto-generates one using the other parameters.</desc>
14510	</param>
14511	<param name="proto" type="NATProtocol" dir="in">
14512	<desc>Protocol handled with the rule.</desc>
14513	</param>
14514	<param name="hostIp" type="wstring" dir="in">
14515	<desc>IP of the host interface to which the rule should apply. An empty ip address is
14516	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
14517	</param>
14518	<param name="hostPort" type="unsigned short" dir="in">
14519	<desc>The port number to listen on.</desc>
14520	</param>
14521	<param name="guestIp" type="wstring" dir="in">
14522	<desc>The IP address of the guest which the NAT engine will forward matching packets
14523	to. An empty IP address is acceptable, in which case the NAT engine will forward
14524	packets to the first DHCP lease (x.x.x.15).</desc>
14525	</param>
14526	<param name="guestPort" type="unsigned short" dir="in">
14527	<desc>The port number to forward.</desc>
14528	</param>
14529	</method>
14530	<method name="removeRedirect">
14531	<desc>Removes a port-forwarding rule that was previously registered.</desc>
14532	<param name="name" type="wstring" dir="in">
14533	<desc>The name of the rule to delete.</desc>
14534	</param>
14535	</method>
14536	</interface>
14537
14538	<module name="VBoxSVC" context="LocalServer">
14539	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
14540	namespace="virtualbox.org">
14541	<interface name="IVirtualBox" default="yes"/>
14542	<eventsink name="IVirtualBoxCallback" default="yes"/>
14543	</class>
14544	</module>
14545
14546	<module name="VBoxC" context="InprocServer" threadingModel="Free">
14547	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
14548	namespace="virtualbox.org">
14549	<interface name="ISession" default="yes"/>
14550	<eventsink name="IConsoleCallback" default="yes"/>
14551
14552	</class>
14553	<class name="CallbackWrapper" uuid="49EE8561-5563-4715-B18C-A4B1A490DAFE"
14554	namespace="virtualbox.org">
14555	<interface name="ILocalOwner" default="yes"/>
14556	<interface name="IVirtualBoxCallback"/>
14557	<interface name="IConsoleCallback"/>
14558	</class>
14559	</module>
14560
14561	</library>
14562
14563	</idl>
14564
14565	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format