VirtualBox.xidl@ 27521

Last change on this file since 27521 was 27391, checked in by vboxsync, 15 years ago
Main: change uuid
Property svn:eol-style set to `native`
File size: 514.9 KB

Line
1	<?xml version="1.0" ?>
2
3	<!--
4	* :tabSize=2:indentSize=2:noTabs=true:
5	* :folding=explicit:collapseFolds=1:
6	*
7	* Master declaration for VirtualBox's Main API, represented
8	* by COM/XPCOM and web service interfaces.
9	*
10	* From this document, the build system generates several files
11	* via XSLT that are then used during the build process.
12	*
13	* Below is the list of XSL templates that operate on this file and
14	* output files they generate. These XSL templates must be updated
15	* whenever the schema of this file changes:
16	*
17	* 1. src/VBox/Main/idl/midl.xsl =>
18	* out/<platform>/bin/sdk/idl/VirtualBox.idl
19	* (MS COM interface definition file for Main API)
20	*
21	* 2. src/VBox/Main/idl/xpidl.xsl =>
22	* out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
23	* (XPCOM interface definition file for Main API)
24	*
25	* 3. src/VBox/Main/idl/doxygen.xsl =>
26	* out/<platform>/obj/src/VBox/Main/VirtualBox.idl
27	* (pseudo-IDL for Doxygen to generate the official Main API
28	* documentation)
29	*
30	* 4. src/VBox/Main/webservice/*.xsl =>
31	* a bunch of WSDL and C++ files
32	* (VirtualBox web service sources and SOAP mappers;
33	* see src/VBox/Main/webservice/Makefile.kmk for details)
34	*
35	* 5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
36	* out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
37	* (smart Qt-based C++ wrapper classes for COM interfaces
38	* of the Main API)
39	*
40	* 6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
41	* out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
42	* (Main API TypeLib block for the WiX installer)
43	*
44	* 7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
45	* out/<platform>/obj/Runtime/errmsgvboxcomdata.h
46	* (<result> extraction for the %Rhrc format specifier)
47	*
48	Copyright (C) 2006-2010 Sun Microsystems, Inc.
49
50	This file is part of VirtualBox Open Source Edition (OSE), as
51	available from http://www.virtualbox.org. This file is free software;
52	you can redistribute it and/or modify it under the terms of the GNU
53	General Public License (GPL) as published by the Free Software
54	Foundation, in version 2 as it comes in the "COPYING" file of the
55	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
56	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
57
58	Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
59	Clara, CA 95054 USA or visit http://www.sun.com if you need
60	additional information or have any questions.
61	-->
62
63	<idl>
64
65	<desc>
66	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
67	describes the so-called <i>VirtualBox Main API</i> which comprises all public
68	COM interfaces and components provided by the VirtualBox server and by the
69	VirtualBox client library.
70
71	VirtualBox employs a client-server design, meaning that whenever any part of
72	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
73	interface or any virtual machine --, a dedicated server process named
74	VBoxSVC runs in the background. This allows multiple processes working with
75	VirtualBox to cooperate without conflicts. These processes communicate to each
76	other using inter-process communication facilities provided by the COM
77	implementation of the host computer.
78
79	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
80	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
81	implementation, is used.
82
83	All the parts that a typical VirtualBox user interacts with (the Qt GUI,
84	the VBoxManage command-line interface and the VBoxVRDP server) are technically
85	front-ends to the Main API and only use the interfaces that are documented
86	in this Main API documentation. This ensures that, with any given release
87	version of VirtualBox, all capabilities of the product that could be useful
88	to an external client program are always exposed by way of this API.
89
90	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
91	contains two public component classes:
92	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
93	implement IVirtualBox and ISession interfaces respectively. These two classes
94	are of supreme importance and will be needed in order for any front-end
95	program to do anything useful. It is recommended to read the documentation of
96	the mentioned interfaces first.
97
98	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
99	there can be only one object of this class on the local machine at any given
100	time. This object is a parent of many other objects in the VirtualBox COM
101	library and lives in the VBoxSVC process. In fact, when you create an instance
102	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
103	process is already running, starts it if not, and returns you a reference to
104	the <tt>VirtualBox</tt> object created in this process. When the last reference
105	to this object is released, the VBoxSVC process ends (with a 5 second delay to
106	protect from too frequent restarts).
107
108	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
109	as many <tt>Session</tt> objects as you need but all of them will live in a
110	process which issues the object instantiation call. <tt>Session</tt> objects
111	represent virtual machine sessions which are used to configure virtual
112	machines and control their execution.
113	</desc>
114
115	<if target="midl">
116	<cpp line="enum {"/>
117	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
118	<cpp line=" kTypeLibraryMinorVersion = 0"/>
119	<cpp line="};"/>
120	</if>
121
122	<if target="xpidl">
123	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
124	<cpp>
125	/* currently, nsISupportsImpl.h lacks the below-like macros */
126
127	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
128	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
129	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
130
131	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
132	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
133	NS_IMPL_THREADSAFE_ADDREF(_class) \
134	NS_IMPL_THREADSAFE_RELEASE(_class) \
135	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
136	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
137	#endif
138
139	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
140	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
141	NS_IMPL_THREADSAFE_ADDREF(_class) \
142	NS_IMPL_THREADSAFE_RELEASE(_class) \
143	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
144	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
145	#endif
146
147	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
148	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
149	NS_IMPL_THREADSAFE_ADDREF(_class) \
150	NS_IMPL_THREADSAFE_RELEASE(_class) \
151	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
152	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
153	#endif
154
155	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
156	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
157	NS_INTERFACE_MAP_BEGIN(_class) \
158	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
159	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
160	NS_IMPL_QUERY_CLASSINFO(_class) \
161	NS_INTERFACE_MAP_END
162	#endif
163
164	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
165	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
166	_i2, _ic2) \
167	NS_INTERFACE_MAP_BEGIN(_class) \
168	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
169	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
170	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
171	NS_IMPL_QUERY_CLASSINFO(_class) \
172	NS_INTERFACE_MAP_END
173	#endif
174
175	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
176	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
177	_i2, _ic2, _i3, _ic3) \
178	NS_INTERFACE_MAP_BEGIN(_class) \
179	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
180	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
181	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
182	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
183	NS_IMPL_QUERY_CLASSINFO(_class) \
184	NS_INTERFACE_MAP_END
185	#endif
186
187	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
188	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
189	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
190
191	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
192	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
193	NS_IMPL_THREADSAFE_ADDREF(_class) \
194	NS_IMPL_THREADSAFE_RELEASE(_class) \
195	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
196	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
197	#endif
198
199	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
200	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
201	_i2, _ic2) \
202	NS_IMPL_THREADSAFE_ADDREF(_class) \
203	NS_IMPL_THREADSAFE_RELEASE(_class) \
204	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
205	_i2, _ic2) \
206	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
207	#endif
208
209	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
210	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2, _i3, _ic3) \
212	NS_IMPL_THREADSAFE_ADDREF(_class) \
213	NS_IMPL_THREADSAFE_RELEASE(_class) \
214	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
215	_i2, _ic2, _i3, _ic3) \
216	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
217	#endif
218
219	</cpp>
220	</if>
221
222	<library
223	name="VirtualBox"
224	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
225	version="1.3"
226	desc="VirtualBox Type Library"
227	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
228	supportsErrorInfo="yes"
229	>
230
231
232	<!--
233	// COM result codes for VirtualBox
234	/////////////////////////////////////////////////////////////////////////
235	-->
236
237	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
238	<desc>
239	This section describes all VirtualBox-specific COM result codes that may
240	be returned by methods of VirtualBox COM interfaces in addition to
241	standard COM result codes.
242
243	Note that along with the result code, every VirtualBox method returns
244	extended error information through the IVirtualBoxErrorInfo interface on
245	failure. This interface is a preferred way to present the error to the end
246	user because it contains a human readable description of the error. Raw
247	result codes, both standard and described in this section, are intended to
248	be used by programs to analyze the reason of a failure and select an
249	appropriate course of action without involving the end user (for example,
250	retry the operation later or make a different call).
251
252	The standard COM result codes that may originate from our methods include:
253
254	<table>
255	<tr><td>E_INVALIDARG</td>
256	<td>
257	Returned when the value of the method's argument is not within the range
258	of valid values. This should not be confused with situations when the
259	value is within the range but simply doesn't suit the current object
260	state and there is a possibility that it will be accepted later (in such
261	cases VirtualBox-specific codes are returned, for example,
262	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
263	</td>
264	</tr>
265	<tr><td>E_POINTER</td>
266	<td>
267	Returned if a memory pointer for the output argument is invalid (for
268	example, @c null). Note that when pointers representing input
269	arguments (such as strings) are invalid, E_INVALIDARG is returned.
270	</td>
271	</tr>
272	<tr><td>E_ACCESSDENIED</td>
273	<td>
274	Returned when the called object is not ready. Since the lifetime of a
275	public COM object cannot be fully controlled by the implementation,
276	VirtualBox maintains the readiness state for all objects it creates and
277	returns this code in response to any method call on the object that was
278	deactivated by VirtualBox and is not functioning any more.
279	</td>
280	</tr>
281	<tr><td>E_OUTOFMEMORY</td>
282	<td>
283	Returned when a memory allocation operation fails.
284	</td>
285	</tr>
286	</table>
287	</desc>
288	</descGroup>
289
290	<!--
291	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
292	everything in <result>/<desc> after (and including) the first dot, so express
293	the matter of the error code in the first sentence and keep it short.
294	-->
295
296	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
297	<desc>
298	Object corresponding to the supplied arguments does not exist.
299	</desc>
300	</result>
301
302	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
303	<desc>
304	Current virtual machine state prevents the operation.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
309	<desc>
310	Virtual machine error occurred attempting the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
315	<desc>
316	File not accessible or erroneous file contents.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
321	<desc>
322	Runtime subsystem error.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
327	<desc>
328	Pluggable Device Manager error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
333	<desc>
334	Current object state prohibits operation.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
339	<desc>
340	Host operating system related error.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
345	<desc>
346	Requested operation is not supported.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
351	<desc>
352	Invalid XML found.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
357	<desc>
358	Current session state prohibits operation.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
363	<desc>
364	Object being in use prohibits operation.
365	</desc>
366	</result>
367
368	<!--
369	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
370	everything in <result>/<desc> after (and including) the first dot, so express
371	the matter of the error code in the first sentence and keep it short.
372	-->
373
374	<descGroup/>
375
376	<!--
377	// all common enums
378	/////////////////////////////////////////////////////////////////////////
379	-->
380
381	<enum name="SettingsVersion"
382	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
383	>
384	<desc>Settings version of VirtualBox settings files. This is written to
385	the "version" attribute of the root "VirtualBox" element in the settings
386	file XML and indicates which VirtualBox version wrote the file.
387	</desc>
388
389	<const name="Null" value="0">
390	<desc>Null value, indicates invalid version.</desc>
391	</const>
392	<const name="v1_0" value="1">
393	<desc>Legacy settings version, not currently supported.</desc>
394	</const>
395	<const name="v1_1" value="2">
396	<desc>Legacy settings version, not currently supported.</desc>
397	</const>
398	<const name="v1_2" value="3">
399	<desc>Legacy settings version, not currently supported.</desc>
400	</const>
401	<const name="v1_3pre" value="4">
402	<desc>Legacy settings version, not currently supported.</desc>
403	</const>
404	<const name="v1_3" value="5">
405	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
406	<!--
407	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
408	-->
409	</const>
410	<const name="v1_4" value="6">
411	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
412	<!--
413	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
414	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
415	-->
416	</const>
417	<const name="v1_5" value="7">
418	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
419	<!-- 2008-09-04: 2.0.0 released
420	2008-11-20: settings version 1.5 introduced
421	2008-12-17: 2.1.0 released
422	Machine changes:
423	guest OS identifiers changed;
424	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
425	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
426	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
427	-->
428	</const>
429	<const name="v1_6" value="8">
430	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
431	<!-- 2008-12-17: 2.1.0 released
432	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
433	2009-04-08: 2.2.0 released
434	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
435	-->
436	</const>
437	<const name="v1_7" value="9">
438	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
439	<!-- 2008-12-17: 2.1.0 released
440	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
441	2009-04-08: 2.2.0 released
442	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
443	Machine changes: HardDiskAttachments is now StorageControllers (done)
444	-->
445	</const>
446	<const name="v1_8" value="10">
447	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
448	<!-- Machine additions: Display/@accelerate2DVideo (done)
449	-->
450	</const>
451	<const name="v1_9" value="11">
452	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
453	<!-- The big storage controller / DVD / Floppy rework (done)
454	-->
455	</const>
456	<const name="v1_10" value="12">
457	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
458	<!-- Machine changes: RTC localOrUTC (done)
459	CPU hot-plug support
460	-->
461	</const>
462	<const name="Future" value="13">
463	<desc>Settings version greater than "1.10", written by a future VirtualBox version.</desc>
464	</const>
465	</enum>
466
467	<enum
468	name="AccessMode"
469	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
470	>
471	<desc>
472	Access mode for opening files.
473	</desc>
474
475	<const name="ReadOnly" value="1"/>
476	<const name="ReadWrite" value="2"/>
477	</enum>
478
479	<enum
480	name="MachineState"
481	uuid="36518cf6-cdf0-4d0d-ad2a-5ee9c60c7494"
482	>
483	<desc>
484	Virtual machine execution state.
485
486	This enumeration represents possible values of the <link
487	to="IMachine::state"/> attribute.
488
489	Below is the basic virtual machine state diagram. It shows how the state
490	changes during virtual machine execution. The text in square braces shows
491	a method of the IConsole interface that performs the given state
492	transition.
493
494	<pre>
495	+---------[powerDown()] <- Stuck <--[failure]-+
496	V \|
497	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
498	\| \| \| \| V \|
499	\| Aborted -----+ +--> Running --[pause()]--> Paused
500	\| \| ^ \| ^ \|
501	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
502	\| ^ \| \| \| \|
503	\| \| +-----------------------------------------+-\|-------------------+ +
504	\| \| \| \| \|
505	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
506	\| \| \| \|
507	\| +-------- Saving <--------[saveState()]<----------+---------------------+
508	\| \| \|
509	+-------------- Stopping -------[powerDown()]<----------+---------------------+
510	</pre>
511
512	Note that states to the right from PoweredOff, Aborted and Saved in the
513	above diagram are called <i>online VM states</i>. These states
514	represent the virtual machine which is being executed in a dedicated
515	process (usually with a GUI window attached to it where you can see the
516	activity of the virtual machine and interact with it). There are two
517	special pseudo-states, FirstOnline and LastOnline, that can be used in
518	relational expressions to detect if the given machine state is online or
519	not:
520
521	<pre>
522	if (machine.GetState() >= MachineState_FirstOnline &&
523	machine.GetState() <= MachineState_LastOnline)
524	{
525	...the machine is being executed...
526	}
527	</pre>
528
529	When the virtual machine is in one of the online VM states (that is, being
530	executed), only a few machine settings can be modified. Methods working
531	with such settings contain an explicit note about that. An attempt to
532	change any oter setting or perform a modifying operation during this time
533	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
534
535	All online states except Running, Paused and Stuck are transitional: they
536	represent temporary conditions of the virtual machine that will last as
537	long as the operation that initiated such a condition.
538
539	The Stuck state is a special case. It means that execution of the machine
540	has reached the "Guru Meditation" condition. This condition indicates an
541	internal VMM (virtual machine manager) failure which may happen as a
542	result of either an unhandled low-level virtual hardware exception or one
543	of the recompiler exceptions (such as the <i>too-many-traps</i>
544	condition).
545
546	Note also that any online VM state may transit to the Aborted state. This
547	happens if the process that is executing the virtual machine terminates
548	unexpectedly (for example, crashes). Other than that, the Aborted state is
549	equivalent to PoweredOff.
550
551	There are also a few additional state diagrams that do not deal with
552	virtual machine execution and therefore are shown separately. The states
553	shown on these diagrams are called <i>offline VM states</i> (this includes
554	PoweredOff, Aborted and Saved too).
555
556	The first diagram shows what happens when a lengthy setup operation is
557	being executed (such as <link to="IMachine::attachDevice"/>).
558
559	<pre>
560	+----------------------------------(same state as before the call)------+
561	\| \|
562	+-> PoweredOff --+ \|
563	\| \| \|
564	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
565	\| \|
566	+-> Saved -------+
567	</pre>
568
569	The next two diagrams demonstrate the process of taking a snapshot of a
570	powered off virtual machine and performing one of the "discard..."
571	operations, respectively.
572
573	<pre>
574	+----------------------------------(same state as before the call)------+
575	\| \|
576	+-> PoweredOff --+ \|
577	\| +-->[takeSnapshot()] -------------------> Saving ------+
578	+-> Aborted -----+
579
580	+-> PoweredOff --+
581	\| \|
582	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
583	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
584	+-> Saved -------+ \|
585	\| \|
586	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
587	</pre>
588
589	Note that the Saving state is present in both the offline state group and
590	online state group. Currently, the only way to determine what group is
591	assumed in a particular case is to remember the previous machine state: if
592	it was Running or Paused, then Saving is an online state, otherwise it is
593	an offline state. This inconsistency may be removed in one of the future
594	versions of VirtualBox by adding a new state.
595
596	<note internal="yes">
597	For whoever decides to touch this enum: In order to keep the
598	comparisons involving FirstOnline and LastOnline pseudo-states valid,
599	the numeric values of these states must be correspondingly updated if
600	needed: for any online VM state, the condition
601	<tt>FirstOnline <= state <= LastOnline</tt> must be
602	@c true. The same relates to transient states for which
603	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
604	@c true.
605	</note>
606	</desc>
607
608	<const name="Null" value="0">
609	<desc>Null value (never used by the API).</desc>
610	</const>
611	<const name="PoweredOff" value="1">
612	<desc>
613	The machine is not running and has no saved execution state; it has
614	either never been started or been shut down successfully.
615	</desc>
616	</const>
617	<const name="Saved" value="2">
618	<desc>
619	The machine is not currently running, but the execution state of the machine
620	has been saved to an external file when it was running, from where
621	it can be resumed.
622	</desc>
623	</const>
624	<const name="Teleported" value="3">
625	<desc>
626	The machine was teleported to a different host (or process) and then
627	powered off. Take care when powering it on again may corrupt resources
628	it shares with the teleportation target (e.g. disk and network).
629	</desc>
630	</const>
631	<const name="Aborted" value="4">
632	<desc>
633	The process running the machine has terminated abnormally. This may
634	indicate a crash of the VM process in host execution context, or
635	the VM process has been terminated externally.
636	</desc>
637	</const>
638	<const name="Running" value="5">
639	<desc>
640	The machine is currently being executed.
641	<note internal="yes">
642	For whoever decides to touch this enum: In order to keep the
643	comparisons in the old source code valid, this state must immediately
644	precede the Paused state.
645	TODO: Lift this spectacularly wonderful restriction.
646	</note>
647	</desc>
648	</const>
649	<const name="Paused" value="6">
650	<desc>
651	Execution of the machine has been paused.
652	<note internal="yes">
653	For whoever decides to touch this enum: In order to keep the
654	comparisons in the old source code valid, this state must immediately
655	follow the Running state.
656	TODO: Lift this spectacularly wonderful restriction.
657	</note>
658	</desc>
659	</const>
660	<const name="Stuck" value="7">
661	<desc>
662	Execution of the machine has reached the "Guru Meditation"
663	condition. This indicates a severe error in the hypervisor itself.
664	<note internal="yes">
665	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
666	"Guru", perhaps? Or are there some other VMM states that are
667	intended to be lumped in here as well?
668	</note>
669	</desc>
670	</const>
671	<const name="Teleporting" value="8">
672	<desc>
673	The machine is about to be teleported to a different host or process.
674	It is possible to pause a machine in this state, but it will go to the
675	<link to="MachineState::PausedTeleporting"/> state and it will not be
676	possible to resume it again unless the teleportation fails.
677	</desc>
678	</const>
679	<const name="LiveSnapshotting" value="9">
680	<desc>
681	A live snapshot is being taken. The machine is running normally, but
682	some of the runtime configuration options are inaccessible. Also, if
683	paused while in this state it will transition to
684	<link to="MachineState::Saving"/> and it will not be resume the
685	execution until the snapshot operation has completed.
686	</desc>
687	</const>
688	<const name="Starting" value="10">
689	<desc>
690	Machine is being started after powering it on from a
691	zero execution state.
692	</desc>
693	</const>
694	<const name="Stopping" value="11">
695	<desc>
696	Machine is being normally stopped powering it off, or after the guest OS
697	has initiated a shutdown sequence.
698	</desc>
699	</const>
700	<const name="Saving" value="12">
701	<desc>
702	Machine is saving its execution state to a file, or an online
703	snapshot of the machine is being taken.
704	</desc>
705	</const>
706	<const name="Restoring" value="13">
707	<desc>
708	Execution state of the machine is being restored from a file
709	after powering it on from the saved execution state.
710	</desc>
711	</const>
712	<const name="TeleportingPausedVM" value="14">
713	<desc>
714	The machine is being teleported to another host or process, but it is
715	not running. This is the paused variant of the
716	<link to="MachineState::Teleporting"/> state.
717	</desc>
718	</const>
719	<const name="TeleportingIn" value="15">
720	<desc>
721	Teleporting the machine state in from another host or process.
722	</desc>
723	</const>
724	<const name="RestoringSnapshot" value="16">
725	<desc>
726	A machine snapshot is being restored; this typically does not take long.
727	</desc>
728	</const>
729	<const name="DeletingSnapshot" value="17">
730	<desc>
731	A machine snapshot is being deleted; this can take a long time since this
732	may require merging differencing media.
733	</desc>
734	</const>
735	<const name="SettingUp" value="18">
736	<desc>
737	Lengthy setup operation is in progress.
738	</desc>
739	</const>
740
741	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
742	<desc>
743	Pseudo-state: first online state (for use in relational expressions).
744	</desc>
745	</const>
746	<const name="LastOnline" value="13" wsmap="suppress"> <!-- TeleportingIn -->
747	<desc>
748	Pseudo-state: last online state (for use in relational expressions).
749	</desc>
750	</const>
751
752	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
753	<desc>
754	Pseudo-state: first transient state (for use in relational expressions).
755	</desc>
756	</const>
757	<const name="LastTransient" value="18" wsmap="suppress"> <!-- SettingUp -->
758	<desc>
759	Pseudo-state: last transient state (for use in relational expressions).
760	</desc>
761	</const>
762
763	</enum>
764
765	<enum
766	name="SessionState"
767	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
768	>
769	<desc>
770	Session state. This enumeration represents possible values of
771	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
772	attributes. See individual enumerator descriptions for the meaning for
773	every value.
774	</desc>
775
776	<const name="Null" value="0">
777	<desc>Null value (never used by the API).</desc>
778	</const>
779	<const name="Closed" value="1">
780	<desc>
781	The machine has no open sessions (<link to="IMachine::sessionState"/>);
782	the session is closed (<link to="ISession::state"/>)
783	</desc>
784	</const>
785	<const name="Open" value="2">
786	<desc>
787	The machine has an open direct session (<link to="IMachine::sessionState"/>);
788	the session is open (<link to="ISession::state"/>)
789	</desc>
790	</const>
791	<const name="Spawning" value="3">
792	<desc>
793	A new (direct) session is being opened for the machine as a result of
794	<link to="IVirtualBox::openRemoteSession"/> call
795	(<link to="IMachine::sessionState"/> or <link to="ISession::state"/>).
796	This state also occurs as a short transient state when a new direct
797	session is opened by calling <link to="IVirtualBox::openSession"/>.
798	</desc>
799	</const>
800	<const name="Closing" value="4">
801	<desc>
802	The direct session is being closed (<link to="IMachine::sessionState"/>);
803	the session is being closed (<link to="ISession::state"/>)
804	</desc>
805	</const>
806	</enum>
807
808	<enum
809	name="CpuPropertyType"
810	uuid="af7bb668-eeb1-4404-b77f-a114b30c92d6"
811	>
812	<desc>
813	Virtual CPU property type. This enumeration represents possible values of the
814	IMachine get- and setCpuProperty methods.
815	</desc>
816	<const name="Null" value="0">
817	<desc>Null value (never used by the API).</desc>
818	</const>
819	<const name="PAE" value="1">
820	<desc>
821	This setting determines whether VirtualBox will expose the Physical Address
822	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
823	is not available, it will not be reported.
824	</desc>
825	</const>
826	<const name="Synthetic" value="2">
827	<desc>
828	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
829	teleporting between host systems that differ significantly.
830	</desc>
831	</const>
832	</enum>
833
834
835	<enum
836	name="HWVirtExPropertyType"
837	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
838	>
839	<desc>
840	Hardware virtualization property type. This enumeration represents possible values
841	for the <link to="IMachine::getHWVirtExProperty"/> and
842	<link to="IMachine::setHWVirtExProperty"/> methods.
843	</desc>
844	<const name="Null" value="0">
845	<desc>Null value (never used by the API).</desc>
846	</const>
847	<const name="Enabled" value="1">
848	<desc>
849	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
850	such extensions are not available, they will not be used.
851	</desc>
852	</const>
853	<const name="Exclusive" value="2">
854	<desc>
855	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
856	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
857	feature of the host. To share these with other hypervisors, you must disable this property.
858	</desc>
859	</const>
860	<const name="VPID" value="3">
861	<desc>
862	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
863	</desc>
864	</const>
865	<const name="NestedPaging" value="4">
866	<desc>
867	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
868	</desc>
869	</const>
870	<const name="LargePages" value="5">
871	<desc>
872	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
873	</desc>
874	</const>
875	</enum>
876
877	<enum
878	name="SessionType"
879	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
880	>
881	<desc>
882	Session type. This enumeration represents possible values of the
883	<link to="ISession::type"/> attribute.
884	</desc>
885
886	<const name="Null" value="0">
887	<desc>Null value (never used by the API).</desc>
888	</const>
889	<const name="Direct" value="1">
890	<desc>
891	Direct session
892	(opened by <link to="IVirtualBox::openSession"/>)
893	</desc>
894	</const>
895	<const name="Remote" value="2">
896	<desc>
897	Remote session
898	(opened by <link to="IVirtualBox::openRemoteSession"/>)
899	</desc>
900	</const>
901	<const name="Existing" value="3">
902	<desc>
903	Existing session
904	(opened by <link to="IVirtualBox::openExistingSession"/>)
905	</desc>
906	</const>
907	</enum>
908
909	<enum
910	name="DeviceType"
911	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
912	>
913	<desc>
914	Device type.
915	</desc>
916	<const name="Null" value="0">
917	<desc>
918	Null value, may also mean "no device" (not allowed for
919	<link to="IConsole::getDeviceActivity"/>).
920	</desc>
921	</const>
922	<const name="Floppy" value="1">
923	<desc>Floppy device.</desc>
924	</const>
925	<const name="DVD" value="2">
926	<desc>CD/DVD-ROM device.</desc>
927	</const>
928	<const name="HardDisk" value="3">
929	<desc>Hard disk device.</desc>
930	</const>
931	<const name="Network" value="4">
932	<desc>Network device.</desc>
933	</const>
934	<const name="USB" value="5">
935	<desc>USB device.</desc>
936	</const>
937	<const name="SharedFolder" value="6">
938	<desc>Shared folder device.</desc>
939	</const>
940	</enum>
941
942	<enum
943	name="DeviceActivity"
944	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
945	>
946	<desc>
947	Device activity for <link to="IConsole::getDeviceActivity"/>.
948	</desc>
949
950	<const name="Null" value="0"/>
951	<const name="Idle" value="1"/>
952	<const name="Reading" value="2"/>
953	<const name="Writing" value="3"/>
954	</enum>
955
956	<enum
957	name="ClipboardMode"
958	uuid="33364716-4008-4701-8f14-be0fa3d62950"
959	>
960	<desc>
961	Host-Guest clipboard interchange mode.
962	</desc>
963
964	<const name="Disabled" value="0"/>
965	<const name="HostToGuest" value="1"/>
966	<const name="GuestToHost" value="2"/>
967	<const name="Bidirectional" value="3"/>
968	</enum>
969
970	<enum
971	name="Scope"
972	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
973	>
974	<desc>
975	Scope of the operation.
976
977	A generic enumeration used in various methods to define the action or
978	argument scope.
979	</desc>
980
981	<const name="Global" value="0"/>
982	<const name="Machine" value="1"/>
983	<const name="Session" value="2"/>
984	</enum>
985
986	<enum
987	name="GuestStatisticType"
988	uuid="aa7c1d71-aafe-47a8-9608-27d2d337cf55"
989	>
990	<desc>
991	Statistics type for <link to="IGuest::getStatistic"/>.
992	</desc>
993
994	<const name="CPULoad_Idle" value="0">
995	<desc>
996	Idle CPU load (0-100%) for last interval.
997	</desc>
998	</const>
999	<const name="CPULoad_Kernel" value="1">
1000	<desc>
1001	Kernel CPU load (0-100%) for last interval.
1002	</desc>
1003	</const>
1004	<const name="CPULoad_User" value="2">
1005	<desc>
1006	User CPU load (0-100%) for last interval.
1007	</desc>
1008	</const>
1009	<const name="Threads" value="3">
1010	<desc>
1011	Total number of threads in the system.
1012	</desc>
1013	</const>
1014	<const name="Processes" value="4">
1015	<desc>
1016	Total number of processes in the system.
1017	</desc>
1018	</const>
1019	<const name="Handles" value="5">
1020	<desc>
1021	Total number of handles in the system.
1022	</desc>
1023	</const>
1024	<const name="MemoryLoad" value="6">
1025	<desc>
1026	Memory load (0-100%).
1027	</desc>
1028	</const>
1029	<const name="PhysMemTotal" value="7">
1030	<desc>
1031	Total physical memory in megabytes.
1032	</desc>
1033	</const>
1034	<const name="PhysMemAvailable" value="8">
1035	<desc>
1036	Free physical memory in megabytes.
1037	</desc>
1038	</const>
1039	<const name="PhysMemBalloon" value="9">
1040	<desc>
1041	Ballooned physical memory in megabytes.
1042	</desc>
1043	</const>
1044	<const name="MemCommitTotal" value="10">
1045	<desc>
1046	Total amount of memory in the committed state in megabytes.
1047	</desc>
1048	</const>
1049	<const name="MemKernelTotal" value="11">
1050	<desc>
1051	Total amount of memory used by the guest OS's kernel in megabytes.
1052	</desc>
1053	</const>
1054	<const name="MemKernelPaged" value="12">
1055	<desc>
1056	Total amount of paged memory used by the guest OS's kernel in megabytes.
1057	</desc>
1058	</const>
1059	<const name="MemKernelNonpaged" value="13">
1060	<desc>
1061	Total amount of non-paged memory used by the guest OS's kernel in megabytes.
1062	</desc>
1063	</const>
1064	<const name="MemSystemCache" value="14">
1065	<desc>
1066	Total amount of memory used by the guest OS's system cache in megabytes.
1067	</desc>
1068	</const>
1069	<const name="PageFileSize" value="15">
1070	<desc>
1071	Pagefile size in megabytes.
1072	</desc>
1073	</const>
1074	<const name="SampleNumber" value="16">
1075	<desc>
1076	Statistics sample number
1077	</desc>
1078	</const>
1079	<const name="MaxVal" value="17"/>
1080	</enum>
1081
1082	<enum
1083	name="BIOSBootMenuMode"
1084	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1085	>
1086	<desc>
1087	BIOS boot menu mode.
1088	</desc>
1089
1090	<const name="Disabled" value="0"/>
1091	<const name="MenuOnly" value="1"/>
1092	<const name="MessageAndMenu" value="2"/>
1093	</enum>
1094
1095	<enum
1096	name="ProcessorFeature"
1097	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1098	>
1099	<desc>
1100	CPU features.
1101	</desc>
1102
1103	<const name="HWVirtEx" value="0"/>
1104	<const name="PAE" value="1"/>
1105	<const name="LongMode" value="2"/>
1106	<const name="NestedPaging" value="3"/>
1107	</enum>
1108
1109	<enum
1110	name="FirmwareType"
1111	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1112	>
1113	<desc>
1114	Firmware type.
1115	</desc>
1116	<const name="BIOS" value="1">
1117	<desc>BIOS Firmware.</desc>
1118	</const>
1119	<const name="EFI" value="2">
1120	<desc>EFI Firmware, bitness detetced basing on OS type.</desc>
1121	</const>
1122	<const name="EFI32" value="3">
1123	<desc>Efi firmware, 32-bit.</desc>
1124	</const>
1125	<const name="EFI64" value="4">
1126	<desc>Efi firmware, 64-bit.</desc>
1127	</const>
1128	<const name="EFIDUAL" value="5">
1129	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1130	</const>
1131	</enum>
1132
1133	<enum
1134	name="PointingHidType"
1135	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1136	>
1137	<desc>
1138	Type of pointing device used in a virtual machine.
1139	</desc>
1140	<const name="None" value="1">
1141	<desc>No mouse.</desc>
1142	</const>
1143	<const name="PS2Mouse" value="2">
1144	<desc>PS/2 auxillary device, a.k.a. mouse.</desc>
1145	</const>
1146	<const name="USBMouse" value="3">
1147	<desc>USB mouse (relative pointer).</desc>
1148	</const>
1149	<const name="USBTablet" value="4">
1150	<desc>USB tablet (absolute pointer).</desc>
1151	</const>
1152	<const name="ComboMouse" value="5">
1153	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1154	Using of such device can have negative performance implications. </desc>
1155	</const>
1156	</enum>
1157
1158	<enum
1159	name="KeyboardHidType"
1160	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1161	>
1162	<desc>
1163	Type of keyboard device used in a virtual machine.
1164	</desc>
1165	<const name="None" value="1">
1166	<desc>No keyboard.</desc>
1167	</const>
1168	<const name="PS2Keyboard" value="2">
1169	<desc>PS/2 keyboard.</desc>
1170	</const>
1171	<const name="USBKeyboard" value="3">
1172	<desc>USB keyboard.</desc>
1173	</const>
1174	<const name="ComboKeyboard" value="4">
1175	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1176	Using of such device can have negative performance implications. </desc>
1177	</const>
1178	</enum>
1179
1180	<enum
1181	name="IoMgrType"
1182	uuid="35567419-4d2a-4256-a74e-efcae33493a2"
1183	>
1184	<desc>
1185	Type of the I/O manager used for the image files in a virtual machine.
1186	</desc>
1187	<const name="Simple" value="1">
1188	<desc>Simple manager. Normally only used if the default one runs into an
1189	error. </desc>
1190	</const>
1191	<const name="Async" value="2">
1192	<desc>Asynchronous manager using the async I/O API on the host if present.
1193	This is the default manager.</desc>
1194	</const>
1195	</enum>
1196
1197	<enum
1198	name="IoBackendType"
1199	uuid="2a7e16d1-4e6b-4d5d-b0c9-b9bbe6c5b2ad"
1200	>
1201	<desc>
1202	Type of I/O backend used for the image files in a virtual machine.
1203	</desc>
1204	<const name="Buffered" value="1">
1205	<desc>Image files will use the host cache if possible.
1206	This type does not work with the Async I/O manager on Linux hosts.
1207	Default on all hosts except Linux.</desc>
1208	</const>
1209	<const name="Unbuffered" value="2">
1210	<desc>Image files will not use the host cache.
1211	This should be used on OS X and Linux hosts if a high I/O load is expected
1212	or many virtual machines are running to prevent I/O cache
1213	related hangs. Default on Linux hosts.</desc>
1214	</const>
1215	</enum>
1216
1217	<!--
1218	// IVirtualBoxErrorInfo
1219	/////////////////////////////////////////////////////////////////////////
1220	-->
1221
1222	<interface
1223	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1224	uuid="4b86d186-407e-4f9e-8be8-e50061be8725"
1225	supportsErrorInfo="no"
1226	wsmap="managed"
1227	>
1228	<desc>
1229	The IVirtualBoxErrorInfo interface represents extended error information.
1230
1231	Extended error information can be set by VirtualBox components after
1232	unsuccessful or partially successful method invocation. This information
1233	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1234	and then shown to the client in addition to the plain 32-bit result code.
1235
1236	In MS COM, this interface extends the IErrorInfo interface,
1237	in XPCOM, it extends the nsIException interface. In both cases,
1238	it provides a set of common attributes to retrieve error
1239	information.
1240
1241	Sometimes invocation of some component's method may involve methods of
1242	other components that may also fail (independently of this method's
1243	failure), or a series of non-fatal errors may precede a fatal error that
1244	causes method failure. In cases like that, it may be desirable to preserve
1245	information about all errors happened during method invocation and deliver
1246	it to the caller. The <link to="#next"/> attribute is intended
1247	specifically for this purpose and allows to represent a chain of errors
1248	through a single IVirtualBoxErrorInfo object set after method invocation.
1249
1250	Note that errors are stored to a chain in the reverse order, i.e. the
1251	initial error object you query right after method invocation is the last
1252	error set by the callee, the object it points to in the @a next attribute
1253	is the previous error and so on, up to the first error (which is the last
1254	in the chain).
1255	</desc>
1256
1257	<attribute name="resultCode" type="long" readonly="yes">
1258	<desc>
1259	Result code of the error.
1260	Usually, it will be the same as the result code returned
1261	by the method that provided this error information, but not
1262	always. For example, on Win32, CoCreateInstance() will most
1263	likely return E_NOINTERFACE upon unsuccessful component
1264	instantiation attempt, but not the value the component factory
1265	returned. Value is typed 'long', not 'result',
1266	to make interface usable from scripting languages.
1267	<note>
1268	In MS COM, there is no equivalent.
1269	In XPCOM, it is the same as nsIException::result.
1270	</note>
1271	</desc>
1272	</attribute>
1273
1274	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1275	<desc>
1276	UUID of the interface that defined the error.
1277	<note>
1278	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1279	data type.
1280	In XPCOM, there is no equivalent.
1281	</note>
1282	</desc>
1283	</attribute>
1284
1285	<attribute name="component" type="wstring" readonly="yes">
1286	<desc>
1287	Name of the component that generated the error.
1288	<note>
1289	In MS COM, it is the same as IErrorInfo::GetSource.
1290	In XPCOM, there is no equivalent.
1291	</note>
1292	</desc>
1293	</attribute>
1294
1295	<attribute name="text" type="wstring" readonly="yes">
1296	<desc>
1297	Text description of the error.
1298	<note>
1299	In MS COM, it is the same as IErrorInfo::GetDescription.
1300	In XPCOM, it is the same as nsIException::message.
1301	</note>
1302	</desc>
1303	</attribute>
1304
1305	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1306	<desc>
1307	Next error object if there is any, or @c null otherwise.
1308	<note>
1309	In MS COM, there is no equivalent.
1310	In XPCOM, it is the same as nsIException::inner.
1311	</note>
1312	</desc>
1313	</attribute>
1314
1315	</interface>
1316
1317	<interface
1318	name="ILocalOwner" extends="$dispatched"
1319	uuid="308FF42A-DC45-49D4-A950-B1EEE5E00BB5" wsmap="suppress"
1320	>
1321	<desc>
1322	The ILocalOwner interface allows to register local objects
1323	(created without COM calls, but with new()).
1324	Once registered, calls to methods of such objects can be made
1325	from remote COM processes.
1326	The main usecase is the event callback implementation where
1327	API clients provide callback objects.
1328	</desc>
1329	<method name="setLocalObject">
1330	<desc>
1331	Set local object.
1332	</desc>
1333	<param name="object" type="$unknown" dir="in">
1334	<desc>Local object to forward requests to.
1335	If null, clears currently set local object.</desc>
1336	</param>
1337	</method>
1338	</interface>
1339
1340	<!--
1341	// IVirtualBox
1342	/////////////////////////////////////////////////////////////////////////
1343	-->
1344
1345	<interface
1346	name="IVirtualBoxCallback" extends="$unknown"
1347	uuid="9a65adf2-3ee6-406b-bca2-2b1fa05f0d0b"
1348	wsmap="suppress"
1349	>
1350
1351	<method name="onMachineStateChange">
1352	<desc>
1353	The execution state of the given machine has changed.
1354	<see>IMachine::state</see>
1355	</desc>
1356	<param name="machineId" type="uuid" mod="string" dir="in">
1357	<desc>ID of the machine this event relates to.</desc>
1358	</param>
1359	<param name="state" type="MachineState" dir="in">
1360	<desc>New execution state.</desc>
1361	</param>
1362	</method>
1363
1364	<method name="onMachineDataChange">
1365	<desc>
1366	Any of the settings of the given machine has changed.
1367	</desc>
1368	<param name="machineId" type="uuid" mod="string" dir="in">
1369	<desc>ID of the machine this event relates to.</desc>
1370	</param>
1371	</method>
1372
1373	<method name="onExtraDataCanChange">
1374	<desc>
1375	Notification when someone tries to change extra data for
1376	either the given machine or (if @c null) global extra data.
1377	This gives the chance to veto against changes.
1378	</desc>
1379	<param name="machineId" type="uuid" mod="string" dir="in">
1380	<desc>
1381	ID of the machine this event relates to
1382	(@c null ID for global extra data change requests).
1383	</desc>
1384	</param>
1385	<param name="key" type="wstring" dir="in">
1386	<desc>
1387	Extra data key for the attempted write.
1388	</desc>
1389	</param>
1390	<param name="value" type="wstring" dir="in">
1391	<desc>
1392	Extra data value for the given key.
1393	</desc>
1394	</param>
1395	<param name="error" type="wstring" dir="out">
1396	<desc>
1397	Optional error message describing the reason of the
1398	veto (ignored if this notification returns @c true).
1399	</desc>
1400	</param>
1401	<param name="allowChange" type="boolean" dir="return">
1402	<desc>
1403	Flag to indicate whether the callee agrees (@c true)
1404	or vetoes against the change (@c false).
1405	</desc>
1406	</param>
1407	</method>
1408
1409	<method name="onExtraDataChange">
1410	<desc>
1411	Notification when machine specific or global extra data
1412	has changed.
1413	</desc>
1414	<param name="machineId" type="uuid" mod="string" dir="in">
1415	<desc>
1416	ID of the machine this event relates to.
1417	Null for global extra data changes.
1418	</desc>
1419	</param>
1420	<param name="key" type="wstring" dir="in">
1421	<desc>
1422	Extra data key that has changed.
1423	</desc>
1424	</param>
1425	<param name="value" type="wstring" dir="in">
1426	<desc>
1427	Extra data value for the given key.
1428	</desc>
1429	</param>
1430	</method>
1431
1432	<method name="onMediumRegistered">
1433	<desc>
1434	The given medium was registered or unregistered
1435	within this VirtualBox installation.
1436
1437	The @a mediumType parameter describes what type of
1438	medium the specified @a mediumId refers to. Possible
1439	values are:
1440
1441	<ul>
1442	<li><link to="DeviceType_HardDisk"/>: the medium is a hard disk
1443	that, if registered, can be obtained using the
1444	<link to="IVirtualBox::getHardDisk"/> call.</li>
1445	<li><link to="DeviceType_DVD"/>: the medium is a CD/DVD image
1446	that, if registered, can be obtained using the
1447	<link to="IVirtualBox::getDVDImage"/> call.</li>
1448	<li><link to="DeviceType_Floppy"/>: the medium is a Floppy image
1449	that, if registered, can be obtained using the
1450	<link to="IVirtualBox::getFloppyImage"/> call.</li>
1451	</ul>
1452
1453	Note that if this is a deregistration notification,
1454	there is no way to access the object representing the
1455	unregistered medium. It is supposed that the
1456	application will do required cleanup based on the
1457	@a mediumId value.
1458	</desc>
1459	<param name="mediumId" type="uuid" mod="string" dir="in">
1460	<desc>ID of the medium this event relates to.</desc>
1461	</param>
1462	<param name="mediumType" type="DeviceType" dir="in">
1463	<desc>Type of the medium this event relates to.</desc>
1464	</param>
1465	<param name="registered" type="boolean" dir="in">
1466	<desc>
1467	If @c true, the medium was registered, otherwise it was
1468	unregistered.
1469	</desc>
1470	</param>
1471	</method>
1472
1473	<method name="onMachineRegistered">
1474	<desc>
1475	The given machine was registered or unregistered
1476	within this VirtualBox installation.
1477	</desc>
1478	<param name="machineId" type="uuid" mod="string" dir="in">
1479	<desc>ID of the machine this event relates to.</desc>
1480	</param>
1481	<param name="registered" type="boolean" dir="in">
1482	<desc>
1483	If @c true, the machine was registered, otherwise it was
1484	unregistered.
1485	</desc>
1486	</param>
1487	</method>
1488
1489	<method name="onSessionStateChange">
1490	<desc>
1491	The state of the session for the given machine was changed.
1492	<see>IMachine::sessionState</see>
1493	</desc>
1494	<param name="machineId" type="uuid" mod="string" dir="in">
1495	<desc>ID of the machine this event relates to.</desc>
1496	</param>
1497	<param name="state" type="SessionState" dir="in">
1498	<desc>New session state.</desc>
1499	</param>
1500	</method>
1501
1502	<method name="onSnapshotTaken">
1503	<desc>
1504	A new snapshot of the machine has been taken.
1505	<see>ISnapshot</see>
1506	</desc>
1507	<param name="machineId" type="uuid" mod="string" dir="in">
1508	<desc>ID of the machine this event relates to.</desc>
1509	</param>
1510	<param name="snapshotId" type="uuid" mod="string" dir="in">
1511	<desc>ID of the new snapshot.</desc>
1512	</param>
1513	</method>
1514
1515	<method name="onSnapshotDiscarded">
1516	<desc>
1517	Snapshot of the given machine has been discarded.
1518
1519	<note>
1520	This notification is delivered <b>after</b> the snapshot
1521	object has been uninitialized on the server (so that any
1522	attempt to call its methods will return an error).
1523	</note>
1524
1525	<see>ISnapshot</see>
1526	</desc>
1527	<param name="machineId" type="uuid" mod="string" dir="in">
1528	<desc>ID of the machine this event relates to.</desc>
1529	</param>
1530	<param name="snapshotId" type="uuid" mod="string" dir="in">
1531	<desc>
1532	ID of the discarded snapshot. @c null means the current machine
1533	state has been discarded (restored from the current snapshot).
1534	</desc>
1535	</param>
1536	</method>
1537
1538	<method name="onSnapshotChange">
1539	<desc>
1540	Snapshot properties (name and/or description) have been changed.
1541	<see>ISnapshot</see>
1542	</desc>
1543	<param name="machineId" type="uuid" mod="string" dir="in">
1544	<desc>ID of the machine this event relates to.</desc>
1545	</param>
1546	<param name="snapshotId" type="uuid" mod="string" dir="in">
1547	<desc>ID of the changed snapshot.</desc>
1548	</param>
1549	</method>
1550
1551	<method name="onGuestPropertyChange">
1552	<desc>
1553	Notification when a guest property has changed.
1554	</desc>
1555	<param name="machineId" type="uuid" mod="string" dir="in">
1556	<desc>
1557	ID of the machine this event relates to.
1558	</desc>
1559	</param>
1560	<param name="name" type="wstring" dir="in">
1561	<desc>
1562	The name of the property that has changed.
1563	</desc>
1564	</param>
1565	<param name="value" type="wstring" dir="in">
1566	<desc>
1567	The new property value.
1568	</desc>
1569	</param>
1570	<param name="flags" type="wstring" dir="in">
1571	<desc>
1572	The new property flags.
1573	</desc>
1574	</param>
1575	</method>
1576
1577	</interface>
1578
1579	<interface
1580	name="IDHCPServer" extends="$unknown"
1581	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1582	wsmap="managed"
1583	>
1584	<desc>
1585	The IDHCPServer interface represents the vbox dhcp server configuration.
1586
1587	To enumerate all the dhcp servers on the host, use the
1588	<link to="IVirtualBox::DHCPServers"/> attribute.
1589	</desc>
1590
1591	<attribute name="enabled" type="boolean">
1592	<desc>
1593	specifies if the dhcp server is enabled
1594	</desc>
1595	</attribute>
1596
1597	<attribute name="IPAddress" type="wstring" readonly="yes">
1598	<desc>
1599	specifies server IP
1600	</desc>
1601	</attribute>
1602
1603	<attribute name="networkMask" type="wstring" readonly="yes">
1604	<desc>
1605	specifies server network mask
1606	</desc>
1607	</attribute>
1608
1609	<attribute name="networkName" type="wstring" readonly="yes">
1610	<desc>
1611	specifies internal network name the server is used for
1612	</desc>
1613	</attribute>
1614
1615	<attribute name="lowerIP" type="wstring" readonly="yes">
1616	<desc>
1617	specifies from IP adrres in server address range
1618	</desc>
1619	</attribute>
1620
1621	<attribute name="upperIP" type="wstring" readonly="yes">
1622	<desc>
1623	specifies to IP adrres in server address range
1624	</desc>
1625	</attribute>
1626
1627	<method name="setConfiguration">
1628	<desc>
1629	configures the server
1630	<result name="E_INVALIDARG">
1631	invalid configuration supplied
1632	</result>
1633	</desc>
1634	<param name="IPAddress" type="wstring" dir="in">
1635	<desc>
1636	server IP address
1637	</desc>
1638	</param>
1639	<param name="networkMask" type="wstring" dir="in">
1640	<desc>
1641	server network mask
1642	</desc>
1643	</param>
1644	<param name="FromIPAddress" type="wstring" dir="in">
1645	<desc>
1646	server From IP address for address range
1647	</desc>
1648	</param>
1649	<param name="ToIPAddress" type="wstring" dir="in">
1650	<desc>
1651	server To IP address for address range
1652	</desc>
1653	</param>
1654	</method>
1655
1656	<method name="start">
1657	<desc>
1658	Starts DHCP server process.
1659	<result name="E_FAIL">
1660	Failed to start the process.
1661	</result>
1662	</desc>
1663	<param name="networkName" type="wstring" dir="in">
1664	<desc>
1665	Name of internal network DHCP server should attach to.
1666	</desc>
1667	</param>
1668	<param name="trunkName" type="wstring" dir="in">
1669	<desc>
1670	Name of internal network trunk.
1671	</desc>
1672	</param>
1673	<param name="trunkType" type="wstring" dir="in">
1674	<desc>
1675	Type of internal network trunk.
1676	</desc>
1677	</param>
1678	</method>
1679
1680	<method name="stop">
1681	<desc>
1682	Stops DHCP server process.
1683	<result name="E_FAIL">
1684	Failed to stop the process.
1685	</result>
1686	</desc>
1687	</method>
1688	</interface>
1689
1690	<interface
1691	name="IVirtualBox" extends="$dispatched"
1692	uuid="2158464a-f706-414b-a8c4-fb589dfc6b62"
1693	wsmap="managed"
1694	>
1695	<desc>
1696	The IVirtualBox interface represents the main interface exposed by the
1697	product that provides virtual machine management.
1698
1699	An instance of IVirtualBox is required for the product to do anything
1700	useful. Even though the interface does not expose this, internally,
1701	IVirtualBox is implemented as a singleton and actually lives in the
1702	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1703	IVirtualBox can track the state of all virtual machines on a particular
1704	host, regardless of which frontend started them.
1705
1706	To enumerate all the virtual machines on the host, use the
1707	<link to="IVirtualBox::machines"/> attribute.
1708	</desc>
1709
1710	<attribute name="version" type="wstring" readonly="yes">
1711	<desc>
1712	A string representing the version number of the product. The
1713	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1714	last number represents the build number and will frequently change.
1715	</desc>
1716	</attribute>
1717
1718	<attribute name="revision" type="unsigned long" readonly="yes">
1719	<desc>
1720	The internal build revision number of the product.
1721	</desc>
1722	</attribute>
1723
1724	<attribute name="packageType" type="wstring" readonly="yes">
1725	<desc>
1726	A string representing the package type of this product. The
1727	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1728	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1729	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1730	this.
1731	</desc>
1732	</attribute>
1733
1734	<attribute name="homeFolder" type="wstring" readonly="yes">
1735	<desc>
1736	Full path to the directory where the global settings file,
1737	<tt>VirtualBox.xml</tt>, is stored.
1738
1739	In this version of VirtualBox, the value of this property is
1740	always <tt><user_dir>/.VirtualBox</tt> (where
1741	<tt><user_dir></tt> is the path to the user directory,
1742	as determined by the host OS), and cannot be changed.
1743
1744	This path is also used as the base to resolve relative paths in
1745	places where relative paths are allowed (unless otherwise
1746	expressly indicated).
1747	</desc>
1748	</attribute>
1749
1750	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1751	<desc>
1752	Full name of the global settings file.
1753	The value of this property corresponds to the value of
1754	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1755	</desc>
1756	</attribute>
1757
1758	<attribute name="host" type="IHost" readonly="yes">
1759	<desc>Associated host object.</desc>
1760	</attribute>
1761
1762	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1763	<desc>Associated system information object.</desc>
1764	</attribute>
1765
1766	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1767	<desc>
1768	Array of machine objects registered within this VirtualBox instance.
1769	</desc>
1770	</attribute>
1771
1772	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1773	<desc>
1774	Array of medium objects known to this VirtualBox installation.
1775
1776	This array contains only base media. All differencing
1777	media of the given base medium can be enumerated using
1778	<link to="IMedium::children"/>.
1779	</desc>
1780	</attribute>
1781
1782	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1783	<desc>
1784	Array of CD/DVD image objects registered with this VirtualBox instance.
1785	</desc>
1786	</attribute>
1787
1788	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1789	<desc>
1790	Array of floppy image objects registered with this VirtualBox instance.
1791	</desc>
1792	</attribute>
1793
1794	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1795
1796	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1797
1798	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1799	<desc>
1800	Collection of global shared folders. Global shared folders are
1801	available to all virtual machines.
1802
1803	New shared folders are added to the collection using
1804	<link to="#createSharedFolder"/>. Existing shared folders can be
1805	removed using <link to="#removeSharedFolder"/>.
1806
1807	<note>
1808	In the current version of the product, global shared folders are not
1809	implemented and therefore this collection is always empty.
1810	</note>
1811	</desc>
1812	</attribute>
1813
1814	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1815	<desc>
1816	Associated performance collector object.
1817	</desc>
1818	</attribute>
1819
1820	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1821	<desc>
1822	dhcp server settings.
1823	</desc>
1824	</attribute>
1825
1826	<method name="createMachine">
1827	<desc>
1828	Creates a new virtual machine.
1829
1830	The new machine is created unregistered, with the initial configuration
1831	set according to the specified guest OS type. A typical sequence of
1832	actions to create a new virtual machine is as follows:
1833
1834	<ol>
1835	<li>
1836	Call this method to have a new machine created. The returned machine
1837	object will be "mutable" allowing to change any machine property.
1838	</li>
1839
1840	<li>
1841	Configure the machine using the appropriate attributes and methods.
1842	</li>
1843
1844	<li>
1845	Call <link to="IMachine::saveSettings" /> to write the settings
1846	to the machine's XML settings file. The configuration of the newly
1847	created machine will not be saved to disk until this method is
1848	called.
1849	</li>
1850
1851	<li>
1852	Call <link to="#registerMachine" /> to add the machine to the list
1853	of machines known to VirtualBox.
1854	</li>
1855	</ol>
1856
1857	You should specify valid name for the newly created machine when calling
1858	this method. See the <link to="IMachine::name"/> attribute description
1859	for more details about the machine name.
1860
1861	The specified guest OS type identifier must match an ID of one of known
1862	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1863	array.
1864
1865	Every machine has a <i>settings file</i> that is used to store
1866	the machine configuration. This file is stored in a directory called the
1867	<i>machine settings subfolder</i>. Both the settings subfolder and file
1868	will have a name that corresponds to the name of the virtual machine.
1869	You can specify where to create the machine setting subfolder using the
1870	@a baseFolder argument. The base folder can be absolute (full path) or
1871	relative to the <link to="IVirtualBox::homeFolder">VirtualBox home
1872	directory</link>.
1873
1874	If @a baseFolder is a @c null or empty string (which is recommended), the
1875	<link to="ISystemProperties::defaultMachineFolder">default machine
1876	settings folder</link> will be used as a base folder for the created
1877	machine. Otherwise the given base folder will be used. In either case,
1878	the full path to the resulting settings file has the following
1879	structure:
1880	<pre>
1881	<base_folder>/<machine_name>/<machine_name>.xml
1882	</pre>
1883
1884	Note that if the resulting settings file already exists, this method
1885	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1886
1887	Optionally, you may specify an UUID of to assign to the created machine.
1888	However, this is not recommended and you should normally pass an empty
1889	(@c null) UUID to this method so that a new UUID will be automatically
1890	generated for every created machine. You can use UUID
1891	00000000-0000-0000-0000-000000000000 as @c null value.
1892
1893	<note>
1894	There is no way to change the name of the settings file or
1895	subfolder of the created machine directly.
1896	</note>
1897
1898	<result name="VBOX_E_OBJECT_NOT_FOUND">
1899	@a osTypeId is invalid.
1900	</result>
1901	<result name="VBOX_E_FILE_ERROR">
1902	Resulting settings file name is invalid or the settings file already
1903	exists or could not be created due to an I/O error.
1904	</result>
1905	<result name="E_INVALIDARG">
1906	@a name is empty or @c null.
1907	</result>
1908	</desc>
1909
1910	<param name="name" type="wstring" dir="in">
1911	<desc>Machine name.</desc>
1912	</param>
1913	<param name="osTypeId" type="wstring" dir="in">
1914	<desc>Guest OS Type ID.</desc>
1915	</param>
1916	<param name="baseFolder" type="wstring" dir="in">
1917	<desc>Base machine folder (optional).</desc>
1918	</param>
1919	<param name="id" type="uuid" mod="string" dir="in">
1920	<desc>Machine UUID (optional).</desc>
1921	</param>
1922	<param name="machine" type="IMachine" dir="return">
1923	<desc>Created machine object.</desc>
1924	</param>
1925	</method>
1926
1927	<method name="createLegacyMachine">
1928	<desc>
1929	Creates a new virtual machine in "legacy" mode, using the specified
1930	settings file to store machine settings.
1931
1932	As opposed to machines created by <link to="#createMachine"/>,
1933	the settings file of the machine created in "legacy" mode is not
1934	automatically renamed when the machine name is changed -- it will always
1935	remain the same as specified in this method call.
1936
1937	The specified settings file name can be absolute (full path) or relative
1938	to the <link to="IVirtualBox::homeFolder">VirtualBox home
1939	directory</link>. If the file name doesn't contain an extension, the
1940	default extension (.xml) will be appended.
1941
1942	Note that the configuration of the newly created machine is not
1943	saved to disk (and therefore no settings file is created)
1944	until <link to="IMachine::saveSettings"/> is called. If the
1945	specified settings file already exists, this method
1946	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1947
1948	See <link to="#createMachine"/> for more information.
1949
1950	@deprecated This method may be removed later. Use <link
1951	to="IVirtualBox::createMachine"/> instead.
1952
1953	<note>
1954	There is no way to change the name of the settings file
1955	of the machine created in "legacy" mode.
1956	</note>
1957
1958	<result name="VBOX_E_OBJECT_NOT_FOUND">
1959	@a osTypeId is invalid.
1960	</result>
1961	<result name="VBOX_E_FILE_ERROR">
1962	@a settingsFile is invalid or the settings file already exists or
1963	could not be created due to an I/O error.
1964	</result>
1965	<result name="E_INVALIDARG">
1966	@a name or @a settingsFile is empty or @c null.
1967	</result>
1968	</desc>
1969
1970	<param name="name" type="wstring" dir="in">
1971	<desc>Machine name.</desc>
1972	</param>
1973	<param name="osTypeId" type="wstring" dir="in">
1974	<desc>Machine OS Type ID.</desc>
1975	</param>
1976	<param name="settingsFile" type="wstring" dir="in">
1977	<desc>Name of the machine settings file.</desc>
1978	</param>
1979	<param name="id" type="uuid" mod="string" dir="in">
1980	<desc>Machine UUID (optional).</desc>
1981	</param>
1982	<param name="machine" type="IMachine" dir="return">
1983	<desc>Created machine object.</desc>
1984	</param>
1985	</method>
1986
1987	<method name="openMachine">
1988	<desc>
1989	Opens a virtual machine from the existing settings file.
1990	The opened machine remains unregistered until you call
1991	<link to="#registerMachine"/>.
1992
1993	The specified settings file name can be absolute
1994	(full path) or relative to the <link to="IVirtualBox::homeFolder">
1995	VirtualBox home directory</link>. This file must exist
1996	and must be a valid machine settings file whose contents
1997	will be used to construct the machine object.
1998
1999	@deprecated Will be removed soon.
2000	<result name="VBOX_E_FILE_ERROR">
2001	Settings file name invalid, not found or sharing violation.
2002	</result>
2003	</desc>
2004	<param name="settingsFile" type="wstring" dir="in">
2005	<desc>
2006	Name of the machine settings file.
2007	</desc>
2008	</param>
2009	<param name="machine" type="IMachine" dir="return">
2010	<desc>Opened machine object.</desc>
2011	</param>
2012	<note>
2013	<link to="IMachine::settingsModified"/> will return
2014	@c false for the created machine, until any of machine settings
2015	are changed.
2016	</note>
2017	</method>
2018
2019	<method name="registerMachine">
2020	<desc>
2021
2022	Registers the machine previously created using
2023	<link to="#createMachine"/> or opened using
2024	<link to="#openMachine"/> within this VirtualBox installation. After
2025	successful method invocation, the
2026	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
2027	to all registered callbacks.
2028
2029	<note>
2030	This method implicitly calls <link to="IMachine::saveSettings"/>
2031	to save all current machine settings before registering it.
2032	</note>
2033
2034	<result name="VBOX_E_OBJECT_NOT_FOUND">
2035	No matching virtual machine found.
2036	</result>
2037	<result name="VBOX_E_INVALID_OBJECT_STATE">
2038	Virtual machine was not created within this VirtualBox instance.
2039	</result>
2040
2041	</desc>
2042	<param name="machine" type="IMachine" dir="in"/>
2043	</method>
2044
2045	<method name="getMachine">
2046	<desc>
2047	Attempts to find a virtual machine given its UUID.
2048	To look up a machine by name, use <link to="IVirtualBox::findMachine" />
2049	instead.
2050
2051	<result name="VBOX_E_OBJECT_NOT_FOUND">
2052	Could not find registered machine matching @a id.
2053	</result>
2054
2055	</desc>
2056	<param name="id" type="uuid" mod="string" dir="in"/>
2057	<param name="machine" type="IMachine" dir="return"/>
2058	</method>
2059
2060	<method name="findMachine">
2061	<desc>
2062	Attempts to find a virtual machine given its name.
2063	To look up a machine by UUID, use <link to="IVirtualBox::getMachine" />
2064	instead.
2065
2066	<result name="VBOX_E_OBJECT_NOT_FOUND">
2067	Could not find registered machine matching @a name.
2068	</result>
2069
2070	</desc>
2071	<param name="name" type="wstring" dir="in"/>
2072	<param name="machine" type="IMachine" dir="return"/>
2073	</method>
2074
2075	<method name="unregisterMachine">
2076	<desc>
2077
2078	Unregisters the machine previously registered using
2079	<link to="#registerMachine"/>. After successful method invocation, the
2080	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
2081	to all registered callbacks.
2082
2083	<note>
2084	The specified machine must not be in the Saved state, have an open
2085	(or a spawning) direct session associated with it, have snapshots or
2086	have any medium attached.
2087	</note>
2088
2089	<note>
2090	This method implicitly calls <link to="IMachine::saveSettings"/> to
2091	save all current machine settings before unregistering it.
2092	</note>
2093
2094	<note>
2095	If the given machine is inaccessible (see
2096	<link to="IMachine::accessible"/>), it will be unregistered and
2097	fully uninitialized right afterwards. As a result, the returned
2098	machine object will be unusable and an attempt to call
2099	<b>any</b> method will return the "Object not ready" error.
2100	</note>
2101
2102	<result name="VBOX_E_OBJECT_NOT_FOUND">
2103	Could not find registered machine matching @a id.
2104	</result>
2105	<result name="VBOX_E_INVALID_VM_STATE">
2106	Machine is in Saved state.
2107	</result>
2108	<result name="VBOX_E_INVALID_OBJECT_STATE">
2109	Machine has snapshot or open session or medium attached.
2110	</result>
2111
2112	</desc>
2113	<param name="id" type="uuid" mod="string" dir="in">
2114	<desc>UUID of the machine to unregister.</desc>
2115	</param>
2116	<param name="machine" type="IMachine" dir="return">
2117	<desc>Unregistered machine object.</desc>
2118	</param>
2119	</method>
2120
2121	<method name="createAppliance">
2122	<desc>
2123	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
2124	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
2125	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
2126	</desc>
2127	<param name="appliance" type="IAppliance" dir="return">
2128	<desc>New appliance.</desc>
2129	</param>
2130	</method>
2131
2132	<method name="createHardDisk">
2133	<desc>
2134	Creates a new base medium object that will use the given storage
2135	format and location for medium data.
2136
2137	Note that the actual storage unit is not created by this method. In
2138	order to do it, and before you are able to attach the created medium
2139	to virtual machines, you must call one of the following methods to
2140	allocate a format-specific storage unit at the specified location:
2141	<ul>
2142	<li><link to="IMedium::createBaseStorage"/></li>
2143	<li><link to="IMedium::createDiffStorage"/></li>
2144	</ul>
2145
2146	Some medium attributes, such as <link to="IMedium::id"/>, may
2147	remain uninitialized until the medium storage unit is successfully
2148	created by one of the above methods.
2149
2150	After the storage unit is successfully created, the medium gets
2151	remembered by this VirtualBox installation and will be accessible
2152	through <link to="#getHardDisk"/> and <link to="#findHardDisk"/>
2153	methods. Remembered base medium are also returned as part of
2154	the <link to="#hardDisks"/> array. See IMedium for more details.
2155
2156	The list of all storage formats supported by this VirtualBox
2157	installation can be obtained using
2158	<link to="ISystemProperties::mediumFormats"/>. If the @a format
2159	attribute is empty or @c null then the default storage format
2160	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
2161	be used for creating a storage unit of the medium.
2162
2163	Note that the format of the location string is storage format specific.
2164	See <link to="IMedium::location"/>, IMedium and
2165	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
2166
2167	<result name="VBOX_E_OBJECT_NOT_FOUND">
2168	@a format identifier is invalid. See
2169	<link to="ISystemProperties::mediumFormats"/>.
2170	</result>
2171	<result name="VBOX_E_FILE_ERROR">
2172	@a location is a not valid file name (for file-based formats only).
2173	</result>
2174	</desc>
2175	<param name="format" type="wstring" dir="in">
2176	<desc>
2177	Identifier of the storage format to use for the new medium.
2178	</desc>
2179	</param>
2180	<param name="location" type="wstring" dir="in">
2181	<desc>
2182	Location of the storage unit for the new medium.
2183	</desc>
2184	</param>
2185	<param name="medium" type="IMedium" dir="return">
2186	<desc>Created medium object.</desc>
2187	</param>
2188	</method>
2189
2190	<method name="openHardDisk">
2191	<desc>
2192	Opens a medium from an existing location, optionally replacing
2193	the image UUID and/or parent UUID.
2194
2195	After the medium is successfully opened by this method, it gets
2196	remembered by (known to) this VirtualBox installation and will be
2197	accessible through <link to="#getHardDisk"/> and
2198	<link to="#findHardDisk"/> methods. Remembered base media
2199	are also returned as part of the <link to="#hardDisks"/> array and can
2200	be attached to virtual machines. See IMedium for more details.
2201
2202	If a differencing medium is to be opened by this method, the
2203	operation will succeed only if its parent medium and all ancestors,
2204	if any, are already known to this VirtualBox installation (for example,
2205	were opened by this method before).
2206
2207	This method tries to guess the storage format of the specified medium
2208	by reading medium data at the specified location.
2209
2210	If @a accessMode is ReadWrite (which it should be), the image is opened
2211	for read/write access and must have according permissions, as VirtualBox
2212	may actually write status information into the disk's metadata sections.
2213
2214	Note that write access is required for all typical image usage in VirtualBox,
2215	since VirtualBox may need to write metadata such as a UUID into the image.
2216	The only exception is opening a source image temporarily for copying and
2217	cloning when the image will quickly be closed again.
2218
2219	Note that the format of the location string is storage format specific.
2220	See <link to="IMedium::location"/>, IMedium and
2221	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
2222
2223	<result name="VBOX_E_FILE_ERROR">
2224	Invalid medium storage file location or could not find the medium
2225	at the specified location.
2226	</result>
2227	<result name="VBOX_E_IPRT_ERROR">
2228	Could not get medium storage format.
2229	</result>
2230	<result name="E_INVALIDARG">
2231	Invalid medium storage format.
2232	</result>
2233
2234	</desc>
2235	<param name="location" type="wstring" dir="in">
2236	<desc>
2237	Location of the storage unit that contains medium data in one of
2238	the supported storage formats.
2239	</desc>
2240	</param>
2241	<param name="accessMode" type="AccessMode" dir="in">
2242	<desc>
2243	Determines whether to open the image in read/write or read-only mode.
2244	</desc>
2245	</param>
2246	<param name="setImageId" type="boolean" dir="in">
2247	<desc>
2248	Select whether a new image UUID is set or not.
2249	</desc>
2250	</param>
2251	<param name="imageId" type="uuid" mod="string" dir="in">
2252	<desc>
2253	New UUID for the image. If an empty string is passed, then a new
2254	UUID is automatically created. Specifying a zero UUIDs is not valid.
2255	</desc>
2256	</param>
2257	<param name="setParentId" type="boolean" dir="in">
2258	<desc>
2259	Select whether a new parent UUID is set or not.
2260	</desc>
2261	</param>
2262	<param name="parentId" type="uuid" mod="string" dir="in">
2263	<desc>
2264	New parent UUID for the image. If an empty string is passed, then a
2265	new UUID is automatically created, provided @a setParentId is
2266	@c true. A zero UUID is valid.
2267	</desc>
2268	</param>
2269	<param name="medium" type="IMedium" dir="return">
2270	<desc>Opened medium object.</desc>
2271	</param>
2272	</method>
2273
2274	<method name="getHardDisk" const="yes">
2275	<desc>
2276	Returns a medium with the given UUID.
2277
2278	The medium with the given UUID must be known to this VirtualBox
2279	installation, i.e. it must be previously created by
2280	<link to="#createHardDisk"/> or opened by <link
2281	to="#openHardDisk"/>, or attached to some known virtual machine.
2282
2283	<result name="VBOX_E_OBJECT_NOT_FOUND">
2284	No medium object matching @a id found.
2285	</result>
2286
2287	</desc>
2288	<param name="id" type="uuid" mod="string" dir="in">
2289	<desc>UUID of the medium to look for.</desc>
2290	</param>
2291	<param name="medium" type="IMedium" dir="return">
2292	<desc>Found medium object.</desc>
2293	</param>
2294	</method>
2295
2296	<method name="findHardDisk">
2297	<desc>
2298	Returns a medium that uses the given location to store medium data.
2299
2300	The given medium must be known to this VirtualBox installation, i.e.
2301	it must be previously created by
2302	<link to="#createHardDisk"/> or opened by <link
2303	to="#openHardDisk"/>, or attached to some known virtual machine.
2304
2305	The search is done by comparing the value of the @a location argument to
2306	the <link to="IMedium::location"/> attribute of each known medium.
2307
2308	For locations represented by file names in the host's file system, the
2309	requested location can be a path relative to the
2310	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2311	only a file name without any path is given, the
2312	<link to="ISystemProperties::defaultHardDiskFolder"> default medium
2313	folder</link> will be prepended to the file name before searching. Note
2314	that on case sensitive file systems, a case sensitive comparison is
2315	performed, otherwise the case of symbols in the file path is ignored.
2316
2317	<result name="VBOX_E_OBJECT_NOT_FOUND">
2318	No medium object matching @a location found.
2319	</result>
2320
2321	</desc>
2322	<param name="location" type="wstring" dir="in">
2323	<desc>Location string to search for.</desc>
2324	</param>
2325	<param name="medium" type="IMedium" dir="return">
2326	<desc>Found medium object.</desc>
2327	</param>
2328	</method>
2329
2330	<method name="openDVDImage">
2331	<desc>
2332	Opens a CD/DVD image contained in the specified file of the supported
2333	format and assigns it the given UUID.
2334
2335	After the image is successfully opened by this method, it gets
2336	remembered by (known to) this VirtualBox installation and will be
2337	accessible through <link to="#getDVDImage"/> and
2338	<link to="#findDVDImage"/> methods. Remembered images are also
2339	returned as part of the <link to="#DVDImages"/> array and can be mounted
2340	to virtual machines. See IMedium for more details.
2341
2342	See <link to="IMedium::location"/> to get more details about the format
2343	of the location string.
2344
2345	<note>
2346	Currently only ISO 9960 CD/DVD images are supported by VirtualBox.
2347	</note>
2348
2349	<result name="VBOX_E_FILE_ERROR">
2350	Invalid CD/DVD image file location or could not find the CD/DVD
2351	image at the specified location.
2352	</result>
2353	<result name="VBOX_E_INVALID_OBJECT_STATE">
2354	CD/DVD image already exists in the media registry.
2355	</result>
2356
2357	</desc>
2358	<param name="location" type="wstring" dir="in">
2359	<desc>
2360	Full path to the file that contains a valid CD/DVD image.
2361	</desc>
2362	</param>
2363	<param name="id" type="uuid" mod="string" dir="in">
2364	<desc>
2365	UUID to assign to the given image within this VirtualBox installation.
2366	If an empty (@c null) UUID is specified, the system will randomly
2367	generate a new UUID.
2368	</desc>
2369	</param>
2370	<param name="image" type="IMedium" dir="return">
2371	<desc>Opened CD/DVD image object.</desc>
2372	</param>
2373	</method>
2374
2375	<method name="getDVDImage">
2376	<desc>
2377	Returns a CD/DVD image with the given UUID.
2378
2379	The image with the given UUID must be known to this VirtualBox
2380	installation, i.e. it must be previously opened by <link
2381	to="#openDVDImage"/>, or mounted to some known virtual machine.
2382
2383	<result name="VBOX_E_OBJECT_NOT_FOUND">
2384	No matching DVD image found in the media registry.
2385	</result>
2386
2387	</desc>
2388	<param name="id" type="uuid" mod="string" dir="in">
2389	<desc>UUID of the image to look for.</desc>
2390	</param>
2391	<param name="image" type="IMedium" dir="return">
2392	<desc>Found CD/DVD image object.</desc>
2393	</param>
2394	</method>
2395
2396	<method name="findDVDImage">
2397	<desc>
2398	Returns a CD/DVD image with the given image location.
2399
2400	The image with the given UUID must be known to this VirtualBox
2401	installation, i.e. it must be previously opened by <link
2402	to="#openDVDImage"/>, or mounted to some known virtual machine.
2403
2404	The search is done by comparing the value of the @a location argument to
2405	the <link to="IMedium::location"/> attribute of each known CD/DVD image.
2406
2407	The requested location can be a path relative to the
2408	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2409	only a file name without any path is given, the
2410	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2411	folder</link> will be prepended to the file name before searching. Note
2412	that on case sensitive file systems, a case sensitive comparison is
2413	performed, otherwise the case in the file path is ignored.
2414
2415	<result name="VBOX_E_FILE_ERROR">
2416	Invalid image file location.
2417	</result>
2418	<result name="VBOX_E_OBJECT_NOT_FOUND">
2419	No matching DVD image found in the media registry.
2420	</result>
2421
2422	</desc>
2423	<param name="location" type="wstring" dir="in">
2424	<desc>CD/DVD image file path to look for.</desc>
2425	</param>
2426	<param name="image" type="IMedium" dir="return">
2427	<desc>Found CD/DVD image object.</desc>
2428	</param>
2429	</method>
2430
2431	<method name="openFloppyImage">
2432	<desc>
2433	Opens a floppy image contained in the specified file of the supported
2434	format and assigns it the given UUID.
2435
2436	After the image is successfully opened by this method, it gets
2437	remembered by (known to) this VirtualBox installation and will be
2438	accessible through <link to="#getFloppyImage"/> and
2439	<link to="#findFloppyImage"/> methods. Remembered images are also
2440	returned as part of the <link to="#floppyImages"/> array and can be
2441	mounted to virtual machines. See IMedium for more details.
2442
2443	See <link to="IMedium::location"/> to get more details about the format
2444	of the location string.
2445
2446	<result name="VBOX_E_FILE_ERROR">
2447	Invalid floppy image file location or could not find the floppy
2448	image at the specified location.
2449	</result>
2450	<result name="VBOX_E_INVALID_OBJECT_STATE">
2451	Floppy image already exists in the media registry.
2452	</result>
2453
2454	<note>
2455	Currently, only raw floppy images are supported by VirtualBox.
2456	</note>
2457	</desc>
2458	<param name="location" type="wstring" dir="in">
2459	<desc>
2460	Full path to the file that contains a valid floppy image.
2461	</desc>
2462	</param>
2463	<param name="id" type="uuid" mod="string" dir="in">
2464	<desc>
2465	UUID to assign to the given image file within this VirtualBox
2466	installation. If an empty (@c null) UUID is specified, the system will
2467	randomly generate a new UUID.
2468	</desc>
2469	</param>
2470	<param name="image" type="IMedium" dir="return">
2471	<desc>Opened floppy image object.</desc>
2472	</param>
2473	</method>
2474
2475	<method name="getFloppyImage">
2476	<desc>
2477	Returns a floppy image with the given UUID.
2478
2479	The image with the given UUID must be known to this VirtualBox
2480	installation, i.e. it must be previously opened by <link
2481	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2482
2483	<result name="VBOX_E_OBJECT_NOT_FOUND">
2484	No matching floppy image found in the media registry.
2485	</result>
2486
2487	</desc>
2488	<param name="id" type="uuid" mod="string" dir="in">
2489	<desc>UUID of the image to look for.</desc>
2490	</param>
2491	<param name="image" type="IMedium" dir="return">
2492	<desc>Found floppy image object.</desc>
2493	</param>
2494	</method>
2495
2496	<method name="findFloppyImage">
2497	<desc>
2498	Returns a floppy image with the given image location.
2499
2500	The image with the given UUID must be known to this VirtualBox
2501	installation, i.e. it must be previously opened by <link
2502	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2503
2504	The search is done by comparing the value of the @a location argument to
2505	the <link to="IMedium::location"/> attribute of each known floppy image.
2506
2507	The requested location can be a path relative to the
2508	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2509	only a file name without any path is given, the
2510	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2511	folder</link> will be prepended to the file name before searching. Note
2512	that on case sensitive file systems, a case sensitive comparison is
2513	performed, otherwise the case of symbols in the file path is ignored.
2514
2515	<result name="VBOX_E_FILE_ERROR">
2516	Invalid image file location.
2517	</result>
2518	<result name="VBOX_E_OBJECT_NOT_FOUND">
2519	No matching floppy image found in the media registry.
2520	</result>
2521
2522	</desc>
2523	<param name="location" type="wstring" dir="in">
2524	<desc>Floppy image file path to look for.</desc>
2525	</param>
2526	<param name="image" type="IMedium" dir="return">
2527	<desc>Found floppy image object.</desc>
2528	</param>
2529	</method>
2530
2531	<method name="getGuestOSType">
2532	<desc>
2533	Returns an object describing the specified guest OS type.
2534
2535	The requested guest OS type is specified using a string which is a
2536	mnemonic identifier of the guest operating system, such as
2537	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2538	particular virtual machine can be read or set using the
2539	<link to="IMachine::OSTypeId"/> attribute.
2540
2541	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2542	available guest OS type objects. Each object has an
2543	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2544	the guest OS this object describes.
2545
2546	<result name="E_INVALIDARG">
2547	@a id is not a valid Guest OS type.
2548	</result>
2549
2550	</desc>
2551	<param name="id" type="uuid" mod="string" dir="in">
2552	<desc>Guest OS type ID string.</desc>
2553	</param>
2554	<param name="type" type="IGuestOSType" dir="return">
2555	<desc>Guest OS type object.</desc>
2556	</param>
2557	</method>
2558
2559	<method name="createSharedFolder">
2560	<desc>
2561	Creates a new global shared folder by associating the given logical
2562	name with the given host path, adds it to the collection of shared
2563	folders and starts sharing it. Refer to the description of
2564	<link to="ISharedFolder"/> to read more about logical names.
2565	<note>
2566	In the current implementation, this operation is not
2567	implemented.
2568	</note>
2569	</desc>
2570	<param name="name" type="wstring" dir="in">
2571	<desc>Unique logical name of the shared folder.</desc>
2572	</param>
2573	<param name="hostPath" type="wstring" dir="in">
2574	<desc>Full path to the shared folder in the host file system.</desc>
2575	</param>
2576	<param name="writable" type="boolean" dir="in">
2577	<desc>Whether the share is writable or readonly</desc>
2578	</param>
2579	</method>
2580
2581	<method name="removeSharedFolder">
2582	<desc>
2583	Removes the global shared folder with the given name previously
2584	created by <link to="#createSharedFolder"/> from the collection of
2585	shared folders and stops sharing it.
2586	<note>
2587	In the current implementation, this operation is not
2588	implemented.
2589	</note>
2590	</desc>
2591	<param name="name" type="wstring" dir="in">
2592	<desc>Logical name of the shared folder to remove.</desc>
2593	</param>
2594	</method>
2595
2596	<method name="getExtraDataKeys">
2597	<desc>
2598	Returns an array representing the global extra data keys which currently
2599	have values defined.
2600	</desc>
2601	<param name="value" type="wstring" dir="return" safearray="yes">
2602	<desc>Array of extra data keys.</desc>
2603	</param>
2604	</method>
2605
2606	<method name="getExtraData">
2607	<desc>
2608	Returns associated global extra data.
2609
2610	If the requested data @a key does not exist, this function will
2611	succeed and return an empty string in the @a value argument.
2612
2613	<result name="VBOX_E_FILE_ERROR">
2614	Settings file not accessible.
2615	</result>
2616	<result name="VBOX_E_XML_ERROR">
2617	Could not parse the settings file.
2618	</result>
2619
2620	</desc>
2621	<param name="key" type="wstring" dir="in">
2622	<desc>Name of the data key to get.</desc>
2623	</param>
2624	<param name="value" type="wstring" dir="return">
2625	<desc>Value of the requested data key.</desc>
2626	</param>
2627	</method>
2628
2629	<method name="setExtraData">
2630	<desc>
2631	Sets associated global extra data.
2632
2633	If you pass @c null or empty string as a key @a value, the given @a key
2634	will be deleted.
2635
2636	<note>
2637	Before performing the actual data change, this method will ask all
2638	registered callbacks using the
2639	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
2640	notification for a permission. If one of the callbacks refuses the
2641	new value, the change will not be performed.
2642	</note>
2643	<note>
2644	On success, the
2645	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
2646	is called to inform all registered callbacks about a successful data
2647	change.
2648	</note>
2649
2650	<result name="VBOX_E_FILE_ERROR">
2651	Settings file not accessible.
2652	</result>
2653	<result name="VBOX_E_XML_ERROR">
2654	Could not parse the settings file.
2655	</result>
2656	<result name="E_ACCESSDENIED">
2657	Modification request refused.
2658	</result>
2659
2660	</desc>
2661	<param name="key" type="wstring" dir="in">
2662	<desc>Name of the data key to set.</desc>
2663	</param>
2664	<param name="value" type="wstring" dir="in">
2665	<desc>Value to assign to the key.</desc>
2666	</param>
2667	</method>
2668
2669	<method name="openSession">
2670	<desc>
2671	Opens a new direct session with the given virtual machine.
2672
2673	A direct session acts as a local lock on the given VM.
2674	There can be only one direct session open at a time for every
2675	virtual machine, protecting the VM from being manipulated by
2676	conflicting actions from different processes. Only after a
2677	direct session has been opened, one can change all VM settings
2678	and execute the VM in the process space of the session object.
2679
2680	Sessions therefore can be compared to mutex semaphores that
2681	lock a given VM for modification and execution.
2682	See <link to="ISession">ISession</link> for details.
2683
2684	<note>Unless you are writing a new VM frontend, you will not
2685	want to execute a VM in the current process. To spawn a new
2686	process that executes a VM, use
2687	<link to="IVirtualBox::openRemoteSession" />
2688	instead.</note>
2689
2690	Upon successful return, the session object can be used to
2691	get access to the machine and to the VM console.
2692
2693	In VirtualBox terminology, the machine becomes "mutable" after
2694	a session has been opened. Note that the "mutable" machine
2695	object, on which you may invoke IMachine methods to change its
2696	settings, will be a different object from the immutable IMachine
2697	objects returned by various IVirtualBox methods. To obtain a
2698	mutable IMachine object (upon which you can invoke settings methods),
2699	use the <link to="ISession::machine" /> attribute.
2700
2701	One must always call <link to="ISession::close" /> to release the
2702	lock on the machine, or the machine's state will eventually be
2703	set to "Aborted".
2704
2705	In other words, to change settings on a machine, the following
2706	sequence is typically performed:
2707
2708	<ol>
2709	<li>Call this method (openSession) to have a machine locked for
2710	the current session.</li>
2711
2712	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
2713
2714	<li>Change the settings of the machine.</li>
2715
2716	<li>Call <link to="IMachine::saveSettings" />.</li>
2717
2718	<li>Close the session by calling <link to="ISession::close"/>.</li>
2719	</ol>
2720
2721	<result name="E_UNEXPECTED">
2722	Virtual machine not registered.
2723	</result>
2724	<result name="E_ACCESSDENIED">
2725	Process not started by OpenRemoteSession.
2726	</result>
2727	<result name="VBOX_E_OBJECT_NOT_FOUND">
2728	No matching virtual machine found.
2729	</result>
2730	<result name="VBOX_E_INVALID_OBJECT_STATE">
2731	Session already open or being opened.
2732	</result>
2733	<result name="VBOX_E_VM_ERROR">
2734	Failed to assign machine to session.
2735	</result>
2736
2737	</desc>
2738	<param name="session" type="ISession" dir="in">
2739	<desc>
2740	Session object that will represent the opened session after
2741	successful method invocation. This object must not represent
2742	the already open session.
2743	<note>
2744	This session will be automatically closed if the
2745	VirtualBox server is terminated for some reason.
2746	</note>
2747	</desc>
2748	</param>
2749	<param name="machineId" type="uuid" mod="string" dir="in">
2750	<desc>ID of the virtual machine to open a session with.</desc>
2751	</param>
2752	</method>
2753
2754	<method name="openRemoteSession">
2755	<desc>
2756	Spawns a new process that executes a virtual machine (called a
2757	"remote session").
2758
2759	Opening a remote session causes the VirtualBox server to start a new
2760	process that opens a direct session with the given VM. As a result, the
2761	VM is locked by that direct session in the new process, preventing
2762	conflicting changes from other processes. Since sessions act as locks
2763	that prevent conflicting changes, one cannot open a remote session
2764	for a VM that already has another open session (direct or remote), or
2765	is currently in the process of opening one (see <link
2766	to="IMachine::sessionState"/>).
2767
2768	While the remote session still provides some level of control over the
2769	VM execution to the caller (using the <link to="IConsole" /> interface),
2770	not all VM settings are available for modification within the remote
2771	session context.
2772
2773	This operation can take some time (a new VM is started in a new process,
2774	for which memory and other resources need to be set up). Because of this,
2775	an <link to="IProgress" /> is returned to allow the caller to wait for this
2776	asynchronous operation to be completed. Until then, the remote session
2777	object remains in the closed state, and accessing the machine or its
2778	console through it is invalid. It is recommended to use
2779	<link to="IProgress::waitForCompletion" /> or similar calls to wait for
2780	completion. Completion is signalled when the VM is powered on. Error
2781	messages etc. can be queried via the progress object, if available.
2782
2783	As with all <link to="ISession" /> objects, it is recommended to call
2784	<link to="ISession::close" /> on the local session object once openRemoteSession()
2785	has been called. However, the session's state (see <link to="ISession::state" />)
2786	will not return to "Closed" until the remote session has also closed (i.e.
2787	until the VM is no longer running). In that case, however, the state of
2788	the session will automatically change back to "Closed".
2789
2790	Currently supported session types (values of the @a type
2791	argument) are:
2792	<ul>
2793	<li><tt>"gui"</tt>: VirtualBox Qt GUI session</li>
2794	<li><tt>"vrdp"</tt>: VirtualBox VRDP Server session</li>
2795	<li><tt>"sdl"</tt>: VirtualBox SDL GUI session</li>
2796	</ul>
2797
2798	The @a environment argument is a string containing definitions of
2799	environment variables in the following format:
2800	@code
2801	NAME[=VALUE]\n
2802	NAME[=VALUE]\n
2803	...
2804	@endcode
2805	where <tt>\\n</tt> is the new line character. These environment
2806	variables will be appended to the environment of the VirtualBox server
2807	process. If an environment variable exists both in the server process
2808	and in this list, the value from this list takes precedence over the
2809	server's variable. If the value of the environment variable is
2810	omitted, this variable will be removed from the resulting environment.
2811	If the environment string is @c null or empty, the server environment
2812	is inherited by the started process as is.
2813
2814	<see>openExistingSession</see>
2815
2816	<result name="E_UNEXPECTED">
2817	Virtual machine not registered.
2818	</result>
2819	<result name="E_INVALIDARG">
2820	Invalid session type @a type.
2821	</result>
2822	<result name="VBOX_E_OBJECT_NOT_FOUND">
2823	No machine matching @a machineId found.
2824	</result>
2825	<result name="VBOX_E_INVALID_OBJECT_STATE">
2826	Session already open or being opened.
2827	</result>
2828	<result name="VBOX_E_IPRT_ERROR">
2829	Launching process for machine failed.
2830	</result>
2831	<result name="VBOX_E_VM_ERROR">
2832	Failed to assign machine to session.
2833	</result>
2834
2835	</desc>
2836	<param name="session" type="ISession" dir="in">
2837	<desc>
2838	Session object that will represent the opened remote session
2839	after successful method invocation (this object must not
2840	represent an already open session).
2841	</desc>
2842	</param>
2843	<param name="machineId" type="uuid" mod="string" dir="in">
2844	<desc>ID of the virtual machine to open a session with.</desc>
2845	</param>
2846	<param name="type" type="wstring" dir="in">
2847	<desc>
2848	Type of the remote session (case sensitive).
2849	</desc>
2850	</param>
2851	<param name="environment" type="wstring" dir="in">
2852	<desc>
2853	Environment to pass to the opened session.
2854	</desc>
2855	</param>
2856	<param name="progress" type="IProgress" dir="return">
2857	<desc>Progress object to track the operation completion.</desc>
2858	</param>
2859	</method>
2860
2861	<method name="openExistingSession">
2862	<desc>
2863	Opens a new remote session with the virtual machine for
2864	which a direct session is already open.
2865
2866	The remote session provides some level of control over the VM
2867	execution (using the IConsole interface) to the caller; however,
2868	within the remote session context, not all VM settings are available
2869	for modification.
2870
2871	As opposed to <link to="#openRemoteSession"/>, the number of
2872	remote sessions opened this way is not limited by the API
2873
2874	<note>
2875	It is an error to open a remote session with the machine that
2876	doesn't have an open direct session.
2877	</note>
2878
2879	<result name="E_UNEXPECTED">
2880	Virtual machine not registered.
2881	</result>
2882	<result name="VBOX_E_OBJECT_NOT_FOUND">
2883	No machine matching @a machineId found.
2884	</result>
2885	<result name="VBOX_E_INVALID_OBJECT_STATE">
2886	Session already open or being opened.
2887	</result>
2888	<result name="VBOX_E_INVALID_SESSION_STATE">
2889	Direct session state not Open.
2890	</result>
2891	<result name="VBOX_E_VM_ERROR">
2892	Failed to get console object from direct session or assign
2893	machine to session.
2894	</result>
2895
2896	<see>openRemoteSession</see>
2897	</desc>
2898	<param name="session" type="ISession" dir="in">
2899	<desc>
2900	Session object that will represent the open remote session
2901	after successful method invocation. This object must not
2902	represent an already open session.
2903	<note>
2904	This session will be automatically closed when the peer
2905	(direct) session dies or gets closed.
2906	</note>
2907	</desc>
2908	</param>
2909	<param name="machineId" type="uuid" mod="string" dir="in">
2910	<desc>ID of the virtual machine to open a session with.</desc>
2911	</param>
2912	</method>
2913
2914	<method name="registerCallback">
2915	<desc>
2916	Registers a new global VirtualBox callback. The methods of the given
2917	callback object will be called by VirtualBox when an appropriate
2918	event occurs.
2919
2920	<result name="E_INVALIDARG">
2921	A @c null callback cannot be registered.
2922	</result>
2923
2924	</desc>
2925	<param name="callback" type="IVirtualBoxCallback" dir="in">
2926	<desc>Callback object to register.</desc>
2927	</param>
2928	</method>
2929
2930	<method name="unregisterCallback">
2931	<desc>
2932	Unregisters the previously registered global VirtualBox callback.
2933
2934	<result name="E_INVALIDARG">
2935	Specified @a callback not registered.
2936	</result>
2937
2938	</desc>
2939	<param name="callback" type="IVirtualBoxCallback" dir="in">
2940	<desc>Callback object to unregister.</desc>
2941	</param>
2942	</method>
2943
2944	<method name="waitForPropertyChange">
2945	<desc>
2946	Blocks the caller until any of the properties represented by the
2947	@a what argument changes the value or until the given timeout interval
2948	expires.
2949
2950	The @a what argument is a comma separated list of property masks that
2951	describe properties the caller is interested in. The property mask is
2952	a string in the following format:
2953
2954	<pre>
2955	[[group.]subgroup.]name
2956	</pre>
2957
2958	where @c name is the property name and @c group, @c subgroup are zero
2959	or more property group specifiers. Each element (group or name) in
2960	the property mask may be either a Latin string or an asterisk symbol
2961	(@c "*") which is used to match any string for the given element. A
2962	property mask that doesn't contain asterisk symbols represents a
2963	single fully qualified property name.
2964
2965	Groups in the fully qualified property name go from more generic (the
2966	left-most part) to more specific (the right-most part). The first
2967	element is usually a name of the object the property belongs to. The
2968	second element may be either a property name, or a child object name,
2969	or an index if the preceding element names an object which is one of
2970	many objects of the same type. This way, property names form a
2971	hierarchy of properties. Here are some examples of property names:
2972
2973	<table>
2974	<tr>
2975	<td><tt>VirtualBox.version</tt></td>
2976	<td><link to="IVirtualBox::version"/> property</td>
2977	</tr>
2978	<tr>
2979	<td><tt>Machine.<UUID>.name</tt></td>
2980	<td><link to="IMachine::name"/> property of the machine with the
2981	given UUID</td>
2982	</tr>
2983	</table>
2984
2985	Most property names directly correspond to the properties of objects
2986	(components) provided by the VirtualBox library and may be used to
2987	track changes to these properties. However, there may be
2988	pseudo-property names that don't correspond to any existing object's
2989	property directly, as well as there may be object properties that
2990	don't have a corresponding property name that is understood by this
2991	method, and therefore changes to such properties cannot be
2992	tracked. See individual object's property descriptions to get a
2993	fully qualified property name that can be used with this method (if
2994	any).
2995
2996	There is a special property mask @c "*" (i.e. a string consisting of a
2997	single asterisk symbol) that can be used to match all properties.
2998	Below are more examples of property masks:
2999
3000	<table>
3001	<tr>
3002	<td><tt>VirtualBox.*</tt></td>
3003	<td>Track all properties of the VirtualBox object</td>
3004	</tr>
3005	<tr>
3006	<td><tt>Machine.*.name</tt></td>
3007	<td>Track changes to the <link to="IMachine::name"/> property of
3008	all registered virtual machines</td>
3009	</tr>
3010	</table>
3011
3012	<note>
3013	This function is not implemented in the current version of the
3014	product.
3015	</note>
3016	</desc>
3017	<param name="what" type="wstring" dir="in">
3018	<desc>Comma separated list of property masks.</desc>
3019	</param>
3020	<param name="timeout" type="unsigned long" dir="in">
3021	<desc>
3022	Wait timeout in milliseconds.
3023	Specify -1 for an indefinite wait.
3024	</desc>
3025	</param>
3026	<param name="changed" type="wstring" dir="out">
3027	<desc>
3028	Comma separated list of properties that have been changed and caused
3029	this method to return to the caller.
3030	</desc>
3031	</param>
3032	<param name="values" type="wstring" dir="out">
3033	<desc>Reserved, not currently used.</desc>
3034	</param>
3035	</method>
3036
3037	<!--method name="createDHCPServerForInterface">
3038	<desc>
3039	Creates a dhcp server settings to be used for the given interface
3040	<result name="E_INVALIDARG">
3041	Host network interface @a name already exists.
3042	</result>
3043	</desc>
3044	<param name="interface" type="IHostNetworkInterface" dir="in">
3045	<desc>Network Interface</desc>
3046	</param>
3047	<param name="server" type="IDHCPServer" dir="out">
3048	<desc>Dhcp server settings</desc>
3049	</param>
3050	</method-->
3051
3052	<method name="createDHCPServer">
3053	<desc>
3054	Creates a dhcp server settings to be used for the given internal network name
3055	<result name="E_INVALIDARG">
3056	Host network interface @a name already exists.
3057	</result>
3058	</desc>
3059	<param name="name" type="wstring" dir="in">
3060	<desc>server name</desc>
3061	</param>
3062	<param name="server" type="IDHCPServer" dir="return">
3063	<desc>Dhcp server settings</desc>
3064	</param>
3065	</method>
3066
3067	<method name="findDHCPServerByNetworkName">
3068	<desc>
3069	Searches a dhcp server settings to be used for the given internal network name
3070	<result name="E_INVALIDARG">
3071	Host network interface @a name already exists.
3072	</result>
3073
3074	</desc>
3075	<param name="name" type="wstring" dir="in">
3076	<desc>server name</desc>
3077	</param>
3078	<param name="server" type="IDHCPServer" dir="return">
3079	<desc>Dhcp server settings</desc>
3080	</param>
3081	</method>
3082
3083	<!--method name="findDHCPServerForInterface">
3084	<desc>
3085	Searches a dhcp server settings to be used for the given interface
3086	<result name="E_INVALIDARG">
3087	Host network interface @a name already exists.
3088	</result>
3089	</desc>
3090	<param name="interface" type="IHostNetworkInterface" dir="in">
3091	<desc>Network Interface</desc>
3092	</param>
3093	<param name="server" type="IDHCPServer" dir="out">
3094	<desc>Dhcp server settings</desc>
3095	</param>
3096	</method-->
3097
3098	<method name="removeDHCPServer">
3099	<desc>
3100	Removes the dhcp server settings
3101	<result name="E_INVALIDARG">
3102	Host network interface @a name already exists.
3103	</result>
3104	</desc>
3105	<param name="server" type="IDHCPServer" dir="in">
3106	<desc>Dhcp server settings to be removed</desc>
3107	</param>
3108	</method>
3109
3110
3111	<method name="checkFirmwarePresent">
3112	<desc>
3113	Check if this VirtualBox installation has a firmware
3114	of the given type available, either system-wide or per-user.
3115	Optionally, this may return a hint where this firmware can be
3116	downloaded from.
3117	</desc>
3118	<param name="firmwareType" type="FirmwareType" dir="in">
3119	<desc>
3120	Type of firmware to check.
3121	</desc>
3122	</param>
3123	<param name="version" type="wstring" dir="in">
3124	<desc>Expected version number, usually empty string (presently ignored).</desc>
3125	</param>
3126
3127	<param name="url" type="wstring" dir="out">
3128	<desc>
3129	Suggested URL to download this firmware from.
3130	</desc>
3131	</param>
3132
3133	<param name="file" type="wstring" dir="out">
3134	<desc>
3135	Filename of firmware, only valid if result == TRUE.
3136	</desc>
3137	</param>
3138
3139	<param name="result" type="boolean" dir="return">
3140	<desc>If firmware of this type and version is available.</desc>
3141	</param>
3142	</method>
3143
3144	</interface>
3145
3146	<!--
3147	// IVFSExplorer
3148	/////////////////////////////////////////////////////////////////////////
3149	-->
3150
3151	<enum
3152	name="VFSType"
3153	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
3154	>
3155	<desc>
3156	Virtual file systems supported by VFSExplorer.
3157	</desc>
3158
3159	<const name="File" value="1" />
3160	<const name="Cloud" value="2" />
3161	<const name="S3" value="3" />
3162	<const name="WebDav" value="4" />
3163	</enum>
3164
3165	<enum
3166	name="VFSFileType"
3167	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
3168	>
3169	<desc>
3170	File types known by VFSExplorer.
3171	</desc>
3172
3173	<const name="Unknown" value="1" />
3174	<const name="Fifo" value="2" />
3175	<const name="DevChar" value="3" />
3176	<const name="Directory" value="4" />
3177	<const name="DevBlock" value="5" />
3178	<const name="File" value="6" />
3179	<const name="SymLink" value="7" />
3180	<const name="Socket" value="8" />
3181	<const name="WhiteOut" value="9" />
3182	</enum>
3183
3184	<interface
3185	name="IVFSExplorer" extends="$unknown"
3186	uuid="2bb864a1-02a3-4474-a1d4-fb5f23b742e1"
3187	wsmap="managed"
3188	>
3189	<desc>
3190	The VFSExplorer interface unifies access to different file system
3191	types. This includes local file systems as well remote file systems like
3192	S3. For a list of supported types see <link to="VFSType" />.
3193	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
3194	</desc>
3195
3196	<attribute name="path" type="wstring" readonly="yes">
3197	<desc>Returns the current path in the virtual file system.</desc>
3198	</attribute>
3199
3200	<attribute name="type" type="VFSType" readonly="yes">
3201	<desc>Returns the file system type which is currently in use.</desc>
3202	</attribute>
3203
3204	<method name="update">
3205	<desc>Updates the internal list of files/directories from the
3206	current directory level. Use <link to="#entryList" /> to get the full list
3207	after a call to this method.</desc>
3208
3209	<param name="aProgress" type="IProgress" dir="return">
3210	<desc>Progress object to track the operation completion.</desc>
3211	</param>
3212	</method>
3213
3214	<method name="cd">
3215	<desc>Change the current directory level.</desc>
3216
3217	<param name="aDir" type="wstring" dir="in">
3218	<desc>The name of the directory to go in.</desc>
3219	</param>
3220
3221	<param name="aProgress" type="IProgress" dir="return">
3222	<desc>Progress object to track the operation completion.</desc>
3223	</param>
3224	</method>
3225
3226	<method name="cdUp">
3227	<desc>Go one directory upwards from the current directory level.</desc>
3228
3229	<param name="aProgress" type="IProgress" dir="return">
3230	<desc>Progress object to track the operation completion.</desc>
3231	</param>
3232	</method>
3233
3234	<method name="entryList">
3235	<desc>Returns a list of files/directories after a call to <link
3236	to="#update" />. The user is responsible for keeping this internal
3237	list up do date.</desc>
3238
3239	<param name="aNames" type="wstring" safearray="yes" dir="out">
3240	<desc>The list of names for the entries.</desc>
3241	</param>
3242
3243	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
3244	<desc>The list of types for the entries.</desc>
3245	</param>
3246	</method>
3247
3248	<method name="exists">
3249	<desc>Checks if the given file list exists in the current directory
3250	level.</desc>
3251
3252	<param name="aNames" type="wstring" safearray="yes" dir="in">
3253	<desc>The names to check.</desc>
3254	</param>
3255
3256	<param name="aExists" type="wstring" safearray="yes" dir="return">
3257	<desc>The names which exist.</desc>
3258	</param>
3259	</method>
3260
3261	<method name="remove">
3262	<desc>Deletes the given files in the current directory level.</desc>
3263
3264	<param name="aNames" type="wstring" safearray="yes" dir="in">
3265	<desc>The names to remove.</desc>
3266	</param>
3267
3268	<param name="aProgress" type="IProgress" dir="return">
3269	<desc>Progress object to track the operation completion.</desc>
3270	</param>
3271	</method>
3272
3273	</interface>
3274
3275	<!--
3276	// IAppliance
3277	/////////////////////////////////////////////////////////////////////////
3278	-->
3279
3280	<interface
3281	name="IAppliance" extends="$unknown"
3282	uuid="e3ba9ab9-ac2c-4266-8bd2-91c4bf721ceb"
3283	wsmap="managed"
3284	>
3285	<desc>
3286	Represents a platform-independent appliance in OVF format. An instance of this is returned
3287	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
3288	appliances with VirtualBox.
3289
3290	The OVF standard suggests two different physical file formats:
3291
3292	<ol>
3293	<li>If the OVF is distributed as a set of files, then @a file must be a fully qualified
3294	path name to an existing OVF descriptor file with an <tt>.ovf</tt> file extension. If
3295	this descriptor file references other files, as OVF appliances distributed as a set of
3296	files most likely do, those files must be in the same directory as the descriptor file.</li>
3297
3298	<li>If the OVF is distributed as a single file, it must be in TAR format and have the
3299	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
3300	files and optionally other files.
3301
3302	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
3303	be added with a later version.</li>
3304	</ol>
3305
3306	<b>Importing</b> an OVF appliance into VirtualBox as instances of
3307	<link to="IMachine" /> involves the following sequence of API calls:
3308
3309	<ol>
3310	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
3311	</li>
3312
3313	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
3314	would like to import. So long as this file is syntactically valid, this will succeed
3315	and return an instance of IAppliance that contains the parsed data from the OVF file.
3316	</li>
3317
3318	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
3319	contents of the IAppliance attributes accordingly. These can be inspected by a
3320	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
3321	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
3322	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
3323	systems in the OVF, which in turn describe the virtual hardware prescribed by the
3324	OVF (network and hardware adapters, virtual disk images, memory size and so on).
3325	The GUI can then give the user the option to confirm and/or change these suggestions.
3326	</li>
3327
3328	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3329	virtual system to override the suggestions made by the interpret() routine.
3330	</li>
3331
3332	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
3333	VirtualBox as instances of <link to="IMachine" /> that match the information in the
3334	virtual system descriptions.
3335	</li>
3336	</ol>
3337
3338	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
3339
3340	<ol>
3341	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
3342	an empty IAppliance object.
3343	</li>
3344
3345	<li>For each machine you would like to export, call <link to="IMachine::export" />
3346	with the IAppliance object you just created. This creates an instance of
3347	<link to="IVirtualSystemDescription" /> inside the appliance.
3348	</li>
3349
3350	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3351	virtual system to override the suggestions made by the export() routine.
3352	</li>
3353
3354	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
3355	file written.</li>
3356	</ol>
3357
3358	</desc>
3359
3360	<attribute name="path" type="wstring" readonly="yes">
3361	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
3362	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
3363	<link to="#write" /> (for export).
3364	This attribute is empty until one of these methods has been called.
3365	</desc>
3366	</attribute>
3367
3368	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
3369	<desc>
3370	Array of virtual disk definitions. One such description exists for each
3371	disk definition in the OVF; each string array item represents one such piece of
3372	disk information, with the information fields separated by tab (\\t) characters.
3373
3374	The caller should be prepared for additional fields being appended to
3375	this string in future versions of VirtualBox and therefore check for
3376	the number of tabs in the strings returned.
3377
3378	In the current version, the following eight fields are returned per string
3379	in the array:
3380
3381	<ol>
3382	<li>Disk ID (unique string identifier given to disk)</li>
3383
3384	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
3385
3386	<li>Populated size (optional unsigned integer indicating the current size of the
3387	disk; can be approximate; -1 if unspecified)</li>
3388
3389	<li>Format (string identifying the disk format, typically
3390	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
3391
3392	<li>Reference (where to find the disk image, typically a file name; if empty,
3393	then the disk should be created on import)</li>
3394
3395	<li>Image size (optional unsigned integer indicating the size of the image,
3396	which need not necessarily be the same as the values specified above, since
3397	the image may be compressed or sparse; -1 if not specified)</li>
3398
3399	<li>Chunk size (optional unsigned integer if the image is split into chunks;
3400	presently unsupported and always -1)</li>
3401
3402	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
3403	</ol>
3404	</desc>
3405	</attribute>
3406
3407	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
3408	<desc> Array of virtual system descriptions. One such description is created
3409	for each virtual system found in the OVF.
3410	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
3411	(for export) has been called.
3412	</desc>
3413	</attribute>
3414
3415	<method name="read">
3416	<desc>
3417	Reads an OVF file into the appliance object.
3418
3419	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
3420	mere fact that this method returns successfully does not mean that VirtualBox supports all
3421	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
3422	</desc>
3423	<param name="file" type="wstring" dir="in">
3424	<desc>
3425	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3426	on whether the appliance is distributed as a set of files or as a single file, respectively).
3427	</desc>
3428	</param>
3429	<param name="aProgress" type="IProgress" dir="return">
3430	<desc></desc>
3431	</param>
3432	</method>
3433
3434	<method name="interpret">
3435	<desc>
3436	Interprets the OVF data that was read when the appliance was constructed. After
3437	calling this method, one can inspect the
3438	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
3439	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
3440	the appliance.
3441
3442	Calling this method is the second step of importing an appliance into VirtualBox;
3443	see <link to="IAppliance" /> for an overview.
3444
3445	After calling this method, one should call <link to="#getWarnings" /> to find out
3446	if problems were encountered during the processing which might later lead to
3447	errors.
3448	</desc>
3449	</method>
3450
3451	<method name="importMachines">
3452	<desc>
3453	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
3454	and other interfaces that match the information contained in the appliance as
3455	closely as possible, as represented by the import instructions in the
3456	<link to="#virtualSystemDescriptions" /> array.
3457
3458	Calling this method is the final step of importing an appliance into VirtualBox;
3459	see <link to="IAppliance" /> for an overview.
3460
3461	Since importing the appliance will most probably involve copying and converting
3462	disk images, which can take a long time, this method operates asynchronously and
3463	returns an IProgress object to allow the caller to monitor the progress.
3464	</desc>
3465
3466	<param name="aProgress" type="IProgress" dir="return">
3467	<desc></desc>
3468	</param>
3469	</method>
3470
3471	<method name="createVFSExplorer">
3472	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
3473
3474	<param name="aUri" type="wstring" dir="in">
3475	<desc>The URI describing the file system to use.</desc>
3476	</param>
3477
3478	<param name="aExplorer" type="IVFSExplorer" dir="return">
3479	<desc></desc>
3480	</param>
3481	</method>
3482
3483	<method name="write">
3484	<desc>
3485	Writes the contents of the appliance exports into a new OVF file.
3486
3487	Calling this method is the final step of exporting an appliance from VirtualBox;
3488	see <link to="IAppliance" /> for an overview.
3489
3490	Since exporting the appliance will most probably involve copying and converting
3491	disk images, which can take a long time, this method operates asynchronously and
3492	returns an IProgress object to allow the caller to monitor the progress.
3493	</desc>
3494	<param name="format" type="wstring" dir="in">
3495	<desc>
3496	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
3497	future versions of VirtualBox may support additional formats.
3498	</desc>
3499	</param>
3500	<param name="path" type="wstring" dir="in">
3501	<desc>
3502	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3503	on whether the appliance is distributed as a set of files or as a single file, respectively).
3504	</desc>
3505	</param>
3506	<param name="aProgress" type="IProgress" dir="return">
3507	<desc>Progress object to track the operation completion.</desc>
3508	</param>
3509	</method>
3510
3511	<method name="getWarnings">
3512	<desc>Returns textual warnings which occured during execution of <link to="#interpret" />.</desc>
3513
3514	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
3515	<desc></desc>
3516	</param>
3517	</method>
3518
3519	</interface>
3520
3521	<enum
3522	name="VirtualSystemDescriptionType"
3523	uuid="aacc58de-5b45-4f82-ae2e-dd9a824fc3b5"
3524	>
3525	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
3526	a configuration value.</desc>
3527
3528	<const name="Ignore" value="1" />
3529	<const name="OS" value="2" />
3530	<const name="Name" value="3" />
3531	<const name="Product" value="4" />
3532	<const name="Vendor" value="5" />
3533	<const name="Version" value="6" />
3534	<const name="ProductUrl" value="7" />
3535	<const name="VendorUrl" value="8" />
3536	<const name="Description" value="9" />
3537	<const name="License" value="10" />
3538	<const name="Miscellaneous" value="11" />
3539	<const name="CPU" value="12" />
3540	<const name="Memory" value="13" />
3541	<const name="HardDiskControllerIDE" value="14" />
3542	<const name="HardDiskControllerSATA" value="15" />
3543	<const name="HardDiskControllerSCSI" value="16" />
3544	<const name="HardDiskImage" value="17" />
3545	<const name="Floppy" value="18" />
3546	<const name="CDROM" value="19" />
3547	<const name="NetworkAdapter" value="20" />
3548	<const name="USBController" value="21" />
3549	<const name="SoundCard" value="22" />
3550
3551	</enum>
3552
3553	<enum
3554	name="VirtualSystemDescriptionValueType"
3555	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
3556	>
3557	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
3558	type to fetch.</desc>
3559
3560	<const name="Reference" value="1" />
3561	<const name="Original" value="2" />
3562	<const name="Auto" value="3" />
3563	<const name="ExtraConfig" value="4" />
3564
3565	</enum>
3566
3567	<interface
3568	name="IVirtualSystemDescription" extends="$unknown"
3569	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
3570	wsmap="managed"
3571	>
3572
3573	<desc>This interface is used in the <link to="IAppliance::virtualSystemDescriptions" /> array.
3574	After <link to="IAppliance::interpret" /> has been called, that array contains
3575	information about how the virtual systems described in the OVF should best be imported into VirtualBox
3576	virtual machines. See <link to="IAppliance" /> for the steps required to import an OVF
3577	into VirtualBox.
3578	</desc>
3579
3580	<attribute name="count" type="unsigned long" readonly="yes">
3581	<desc>Return the number of virtual system description entries.</desc>
3582	</attribute>
3583
3584	<method name="getDescription">
3585	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
3586	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
3587
3588	The list below identifies the value sets that are possible depending on the
3589	<link to="VirtualSystemDescriptionType" /> enum value in the array item in aTypes[]. In each case,
3590	the array item with the same index in aOvfValues[] will contain the original value as contained
3591	in the OVF file (just for informational purposes), and the corresponding item in aVBoxValues[]
3592	will contain a suggested value to be used for VirtualBox. Depending on the description type,
3593	the aExtraConfigValues[] array item may also be used.
3594
3595	<ul>
3596	<li>
3597	"OS": the guest operating system type. There must be exactly one such array item on import. The
3598	corresponding item in aVBoxValues[] contains the suggested guest operating system for VirtualBox.
3599	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
3600	item in aOvfValues[] will contain a numerical value that described the operating system in the OVF.
3601	</li>
3602	<li>
3603	"Name": the name to give to the new virtual machine. There can be at most one such array item;
3604	if none is present on import, then an automatic name will be created from the operating system
3605	type. The correponding item im aOvfValues[] will contain the suggested virtual machine name
3606	from the OVF file, and aVBoxValues[] will contain a suggestion for a unique VirtualBox
3607	<link to="IMachine" /> name that does not exist yet.
3608	</li>
3609	<li>
3610	"Description": an arbitrary description.
3611	</li>
3612	<li>
3613	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
3614	code to display such a license for agreement; the Main API does not enforce any such policy.
3615	</li>
3616	<li>
3617	Miscellaneous: reserved for future use.
3618	</li>
3619	<li>
3620	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
3621	</li>
3622	<li>
3623	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
3624	is present on import, then VirtualBox will set a meaningful default based on the operating system
3625	type.
3626	</li>
3627	<li>
3628	"HarddiskControllerIDE": an IDE hard disk controller. There can be at most one such item. This
3629	has no value in aOvfValues[] or aVBoxValues[].
3630	The matching item in the aRefs[] array will contain an integer that items of the "Harddisk"
3631	type can use to specify which hard disk controller a virtual disk should be connected to.
3632	</li>
3633	<li>
3634	"HarddiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
3635	has no value in aOvfValues[] or aVBoxValues[].
3636	The matching item in the aRefs[] array will be used as with IDE controllers (see above).
3637	</li>
3638	<li>
3639	"HarddiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
3640	The items in aOvfValues[] and aVBoxValues[] will either be "LsiLogic" or "BusLogic".
3641	The matching item in the aRefs[] array will be used as with IDE controllers (see above).
3642	</li>
3643	<li>
3644	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
3645	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
3646
3647	The array item in aOvfValues[] will contain the file specification from the OVF file (without
3648	a path since the image file should be in the same location as the OVF file itself), whereas the
3649	item in aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
3650	hard disk image. This means that on import the image will be copied and converted from the
3651	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
3652	On import, the target image will also be registered with VirtualBox.
3653
3654	The matching item in the aExtraConfigValues[] array must contain a string of the following
3655	format: "controller=<index>;channel=<c>"
3656	In this string, <index> must be an integer specifying the hard disk controller to connect
3657	the image to. That number must be the index of an array item with one of the hard disk controller
3658	types (HarddiskControllerSCSI, HarddiskControllerSATA, HarddiskControllerIDE).
3659	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
3660	this can range from 0-3 (which VirtualBox will interpret as primary master, primary slave, secondary master and
3661	secondary slave. For SATA and SCSI controllers, the channel can range from 0-29.
3662	</li>
3663	<li>
3664	"CDROM": a virtual CD-ROM drive. The matching item in aExtraConfigValue[] contains the same
3665	attachment information as with "HardDiskImage" items.
3666	</li>
3667	<li>
3668	"CDROM": a virtual floppy drive. The matching item in aExtraConfigValue[] contains the same
3669	attachment information as with "HardDiskImage" items.
3670	</li>
3671	<li>
3672	"NetworkAdapter": a network adapter. The array item in aVBoxValues[] will specify the hardware
3673	for the network adapter, whereas the array item in aExtraConfigValues[] will have a string
3674	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
3675	</li>
3676	<li>
3677	"USBController": a USB controller. There can be at most one such item. If and only if such an
3678	item ispresent, USB support will be enabled for the new virtual machine.
3679	</li>
3680	<li>
3681	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
3682	present, sound support will be enabled for the new virtual machine. Note that the virtual
3683	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
3684	may be different from the virtual soundcard expected by the appliance.
3685	</li>
3686	</ul>
3687
3688	</desc>
3689
3690	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3691	<desc></desc>
3692	</param>
3693
3694	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3695	<desc></desc>
3696	</param>
3697
3698	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3699	<desc></desc>
3700	</param>
3701
3702	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3703	<desc></desc>
3704	</param>
3705
3706	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3707	<desc></desc>
3708	</param>
3709
3710	</method>
3711
3712	<method name="getDescriptionByType">
3713	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
3714	should be returned.</desc>
3715
3716	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3717	<desc></desc>
3718	</param>
3719
3720	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3721	<desc></desc>
3722	</param>
3723
3724	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3725	<desc></desc>
3726	</param>
3727
3728	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3729	<desc></desc>
3730	</param>
3731
3732	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3733	<desc></desc>
3734	</param>
3735
3736	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3737	<desc></desc>
3738	</param>
3739
3740	</method>
3741
3742	<method name="getValuesByType">
3743	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
3744	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
3745	values.</desc>
3746
3747	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3748	<desc></desc>
3749	</param>
3750
3751	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
3752	<desc></desc>
3753	</param>
3754
3755	<param name="aValues" type="wstring" dir="return" safearray="yes">
3756	<desc></desc>
3757	</param>
3758
3759	</method>
3760
3761	<method name="setFinalValues">
3762	<desc>
3763	This method allows the appliance's user to change the configuration for the virtual
3764	system descriptions. For each array item returned from <link to="#getDescription" />,
3765	you must pass in one boolean value and one configuration value.
3766
3767	Each item in the boolean array determines whether the particular configuration item
3768	should be enabled.
3769	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
3770	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
3771	and SoundCard.
3772
3773	For the "vbox" and "extra configuration" values, if you pass in the same arrays
3774	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
3775	the configuration remains unchanged. Please see the documentation for getDescription()
3776	for valid configuration values for the individual array item types. If the
3777	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3778	</desc>
3779
3780	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
3781	<desc></desc>
3782	</param>
3783
3784	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
3785	<desc></desc>
3786	</param>
3787
3788	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
3789	<desc></desc>
3790	</param>
3791	</method>
3792
3793	<method name="addDescription">
3794	<desc>
3795	This method adds an additional description entry to the stack of already
3796	available descriptions for this virtual system. This is handy for writing
3797	values which aren't directly supported by VirtualBox. One example would
3798	be the License type of <link to="VirtualSystemDescriptionType" />.
3799	</desc>
3800
3801	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3802	<desc></desc>
3803	</param>
3804
3805	<param name="aVBoxValue" type="wstring" dir="in">
3806	<desc></desc>
3807	</param>
3808
3809	<param name="aExtraConfigValue" type="wstring" dir="in">
3810	<desc></desc>
3811	</param>
3812	</method>
3813	</interface>
3814
3815
3816	<!--
3817	// IMachine
3818	/////////////////////////////////////////////////////////////////////////
3819	-->
3820
3821	<interface
3822	name="IInternalMachineControl" extends="$unknown"
3823	uuid="35d8d838-d066-447d-927a-fd93afdbec90"
3824	internal="yes"
3825	wsmap="suppress"
3826	>
3827	<method name="setRemoveSavedState">
3828	<desc>
3829	Updates the flag whether saved state is removed on a machine state
3830	change from Saved to PoweredOff.
3831	</desc>
3832	<param name="aRemove" type="boolean" dir="in"/>
3833	</method>
3834
3835	<method name="updateState">
3836	<desc>
3837	Updates the VM state.
3838	<note>
3839	This operation will also update the settings file with
3840	the correct information about the saved state file
3841	and delete this file from disk when appropriate.
3842	</note>
3843	</desc>
3844	<param name="state" type="MachineState" dir="in"/>
3845	</method>
3846
3847	<method name="getIPCId">
3848	<param name="id" type="wstring" dir="return"/>
3849	</method>
3850
3851	<method name="setPowerUpInfo">
3852	<desc>
3853	Transfers success (@c null) or error information for this session.
3854	This method updates the progress object to signal completion of the
3855	<link to="IVirtualBox::openRemoteSession"/> method if appropriate,
3856	which means that the progress object returned by
3857	<link to="IConsole::powerUp"/>.
3858	</desc>
3859	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
3860	</method>
3861
3862	<method name="runUSBDeviceFilters">
3863	<desc>
3864	Asks the server to run USB devices filters of the associated
3865	machine against the given USB device and tell if there is
3866	a match.
3867	<note>
3868	Intended to be used only for remote USB devices. Local
3869	ones don't require to call this method (this is done
3870	implicitly by the Host and USBProxyService).
3871	</note>
3872	</desc>
3873	<param name="device" type="IUSBDevice" dir="in"/>
3874	<param name="matched" type="boolean" dir="out"/>
3875	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3876	</method>
3877
3878	<method name="captureUSBDevice">
3879	<desc>
3880	Requests a capture of the given host USB device.
3881	When the request is completed, the VM process will
3882	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3883	notification.
3884	</desc>
3885	<param name="id" type="uuid" mod="string" dir="in"/>
3886	</method>
3887
3888	<method name="detachUSBDevice">
3889	<desc>
3890	Notification that a VM is going to detach (@a done = @c false) or has
3891	already detached (@a done = @c true) the given USB device.
3892	When the @a done = @c true request is completed, the VM process will
3893	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3894	notification.
3895	<note>
3896	In the @a done = @c true case, the server must run its own filters
3897	and filters of all VMs but this one on the detached device
3898	as if it were just attached to the host computer.
3899	</note>
3900	</desc>
3901	<param name="id" type="uuid" mod="string" dir="in"/>
3902	<param name="done" type="boolean" dir="in"/>
3903	</method>
3904
3905	<method name="autoCaptureUSBDevices">
3906	<desc>
3907	Requests a capture all matching USB devices attached to the host.
3908	When the request is completed, the VM process will
3909	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3910	notification per every captured device.
3911	</desc>
3912	</method>
3913
3914	<method name="detachAllUSBDevices">
3915	<desc>
3916	Notification that a VM that is being powered down. The done
3917	parameter indicates whether which stage of the power down
3918	we're at. When @a done = @c false the VM is announcing its
3919	intentions, while when @a done = @c true the VM is reporting
3920	what it has done.
3921	<note>
3922	In the @a done = @c true case, the server must run its own filters
3923	and filters of all VMs but this one on all detach devices as
3924	if they were just attached to the host computer.
3925	</note>
3926	</desc>
3927	<param name="done" type="boolean" dir="in"/>
3928	</method>
3929
3930	<method name="onSessionEnd">
3931	<desc>
3932	Triggered by the given session object when the session is about
3933	to close normally.
3934	</desc>
3935	<param name="session" type="ISession" dir="in">
3936	<desc>Session that is being closed</desc>
3937	</param>
3938	<param name="progress" type="IProgress" dir="return">
3939	<desc>
3940	Used to wait until the corresponding machine is actually
3941	dissociated from the given session on the server.
3942	Returned only when this session is a direct one.
3943	</desc>
3944	</param>
3945	</method>
3946
3947	<method name="beginSavingState">
3948	<desc>
3949	Called by the VM process to inform the server it wants to
3950	save the current state and stop the VM execution.
3951	</desc>
3952	<param name="progress" type="IProgress" dir="in">
3953	<desc>
3954	Progress object created by the VM process to wait until
3955	the state is saved.
3956	</desc>
3957	</param>
3958	<param name="stateFilePath" type="wstring" dir="out">
3959	<desc>
3960	File path the VM process must save the execution state to.
3961	</desc>
3962	</param>
3963	</method>
3964
3965	<method name="endSavingState">
3966	<desc>
3967	Called by the VM process to inform the server that saving
3968	the state previously requested by #beginSavingState is either
3969	successfully finished or there was a failure.
3970
3971	<result name="VBOX_E_FILE_ERROR">
3972	Settings file not accessible.
3973	</result>
3974	<result name="VBOX_E_XML_ERROR">
3975	Could not parse the settings file.
3976	</result>
3977
3978	</desc>
3979
3980	<param name="success" type="boolean" dir="in">
3981	<desc>@c true to indicate success and @c false otherwise.
3982	</desc>
3983	</param>
3984	</method>
3985
3986	<method name="adoptSavedState">
3987	<desc>
3988	Gets called by IConsole::adoptSavedState.
3989	<result name="VBOX_E_FILE_ERROR">
3990	Invalid saved state file path.
3991	</result>
3992	</desc>
3993	<param name="savedStateFile" type="wstring" dir="in">
3994	<desc>Path to the saved state file to adopt.</desc>
3995	</param>
3996	</method>
3997
3998	<method name="beginTakingSnapshot">
3999	<desc>
4000	Called from the VM process to request from the server to perform the
4001	server-side actions of creating a snapshot (creating differencing images
4002	and the snapshot object).
4003
4004	<result name="VBOX_E_FILE_ERROR">
4005	Settings file not accessible.
4006	</result>
4007	<result name="VBOX_E_XML_ERROR">
4008	Could not parse the settings file.
4009	</result>
4010	</desc>
4011	<param name="initiator" type="IConsole" dir="in">
4012	<desc>The console object that initiated this call.</desc>
4013	</param>
4014	<param name="name" type="wstring" dir="in">
4015	<desc>Snapshot name.</desc>
4016	</param>
4017	<param name="description" type="wstring" dir="in">
4018	<desc>Snapshot description.</desc>
4019	</param>
4020	<param name="consoleProgress" type="IProgress" dir="in">
4021	<desc>
4022	Progress object created by the VM process tracking the
4023	snapshot's progress. This has the following sub-operations:
4024	<ul>
4025	<li>setting up (weight 1);</li>
4026	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
4027	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
4028	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
4029	<li>finishing up (weight 1)</li>
4030	</ul>
4031	</desc>
4032	</param>
4033	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
4034	<desc>
4035	Whether this is an online snapshot (i.e. the machine is running).
4036	</desc>
4037	</param>
4038	<param name="stateFilePath" type="wstring" dir="out">
4039	<desc>
4040	File path the VM process must save the execution state to.
4041	</desc>
4042	</param>
4043	</method>
4044
4045	<method name="endTakingSnapshot">
4046	<desc>
4047	Called by the VM process to inform the server that the snapshot
4048	previously requested by #beginTakingSnapshot is either
4049	successfully taken or there was a failure.
4050	</desc>
4051
4052	<param name="success" type="boolean" dir="in">
4053	<desc>@c true to indicate success and @c false otherwise</desc>
4054	</param>
4055	</method>
4056
4057	<method name="deleteSnapshot">
4058	<desc>
4059	Gets called by IConsole::deleteSnapshot.
4060	<result name="VBOX_E_INVALID_OBJECT_STATE">
4061	Snapshot has more than one child snapshot.
4062	</result>
4063	</desc>
4064	<param name="initiator" type="IConsole" dir="in">
4065	<desc>The console object that initiated this call.</desc>
4066	</param>
4067	<param name="id" type="uuid" mod="string" dir="in">
4068	<desc>UUID of the snapshot to discard.</desc>
4069	</param>
4070	<param name="machineState" type="MachineState" dir="out">
4071	<desc>New machine state after this operation is started.</desc>
4072	</param>
4073	<param name="progress" type="IProgress" dir="return">
4074	<desc>Progress object to track the operation completion.</desc>
4075	</param>
4076	</method>
4077
4078	<method name="restoreSnapshot">
4079	<desc>
4080	Gets called by IConsole::RestoreSnapshot.
4081	</desc>
4082	<param name="initiator" type="IConsole" dir="in">
4083	<desc>The console object that initiated this call.</desc>
4084	</param>
4085	<param name="snapshot" type="ISnapshot" dir="in">
4086	<desc>The snapshot to restore the VM state from.</desc>
4087	</param>
4088	<param name="machineState" type="MachineState" dir="out">
4089	<desc>New machine state after this operation is started.</desc>
4090	</param>
4091	<param name="progress" type="IProgress" dir="return">
4092	<desc>Progress object to track the operation completion.</desc>
4093	</param>
4094	</method>
4095
4096	<method name="pullGuestProperties">
4097	<desc>
4098	Get the list of the guest properties matching a set of patterns along
4099	with their values, time stamps and flags and give responsibility for
4100	managing properties to the console.
4101	</desc>
4102	<param name="name" type="wstring" dir="out" safearray="yes">
4103	<desc>
4104	The names of the properties returned.
4105	</desc>
4106	</param>
4107	<param name="value" type="wstring" dir="out" safearray="yes">
4108	<desc>
4109	The values of the properties returned. The array entries match the
4110	corresponding entries in the @a name array.
4111	</desc>
4112	</param>
4113	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
4114	<desc>
4115	The time stamps of the properties returned. The array entries match
4116	the corresponding entries in the @a name array.
4117	</desc>
4118	</param>
4119	<param name="flags" type="wstring" dir="out" safearray="yes">
4120	<desc>
4121	The flags of the properties returned. The array entries match the
4122	corresponding entries in the @a name array.
4123	</desc>
4124	</param>
4125	</method>
4126
4127	<method name="pushGuestProperties">
4128	<desc>
4129	Set the list of the guest properties matching a set of patterns along
4130	with their values, time stamps and flags and return responsibility for
4131	managing properties to IMachine.
4132	</desc>
4133	<param name="name" type="wstring" dir="in" safearray="yes">
4134	<desc>
4135	The names of the properties.
4136	</desc>
4137	</param>
4138	<param name="value" type="wstring" dir="in" safearray="yes">
4139	<desc>
4140	The values of the properties. The array entries match the
4141	corresponding entries in the @a name array.
4142	</desc>
4143	</param>
4144	<param name="timestamp" type="unsigned long long" dir="in" safearray="yes">
4145	<desc>
4146	The time stamps of the properties. The array entries match
4147	the corresponding entries in the @a name array.
4148	</desc>
4149	</param>
4150	<param name="flags" type="wstring" dir="in" safearray="yes">
4151	<desc>
4152	The flags of the properties. The array entries match the
4153	corresponding entries in the @a name array.
4154	</desc>
4155	</param>
4156	</method>
4157	<method name="pushGuestProperty">
4158	<desc>
4159	Update a single guest property in IMachine.
4160	</desc>
4161	<param name="name" type="wstring" dir="in">
4162	<desc>
4163	The name of the property to be updated.
4164	</desc>
4165	</param>
4166	<param name="value" type="wstring" dir="in">
4167	<desc>
4168	The value of the property.
4169	</desc>
4170	</param>
4171	<param name="timestamp" type="unsigned long long" dir="in">
4172	<desc>
4173	The timestamp of the property.
4174	</desc>
4175	</param>
4176	<param name="flags" type="wstring" dir="in">
4177	<desc>
4178	The flags of the property.
4179	</desc>
4180	</param>
4181	</method>
4182
4183	<method name="lockMedia">
4184	<desc>
4185	Locks all media attached to the machine for writing and parents of
4186	attached differencing media (if any) for reading. This operation is
4187	atomic so that if it fails no media is actually locked.
4188
4189	This method is intended to be called when the machine is in Starting or
4190	Restoring state. The locked media will be automatically unlocked when
4191	the machine is powered off or crashed.
4192	</desc>
4193	</method>
4194	<method name="unlockMedia">
4195	<desc>
4196	Unlocks all media previously locked using
4197	<link to="IInternalMachineControl::lockMedia"/>.
4198
4199	This method is intended to be used with teleportation so that it is
4200	possible to teleport between processes on the same machine.
4201	</desc>
4202	</method>
4203	</interface>
4204
4205	<interface
4206	name="IBIOSSettings" extends="$unknown"
4207	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
4208	wsmap="managed"
4209	>
4210	<desc>
4211	The IBIOSSettings interface represents BIOS settings of the virtual
4212	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
4213	</desc>
4214	<attribute name="logoFadeIn" type="boolean">
4215	<desc>Fade in flag for BIOS logo animation.</desc>
4216	</attribute>
4217
4218	<attribute name="logoFadeOut" type="boolean">
4219	<desc>Fade out flag for BIOS logo animation.</desc>
4220	</attribute>
4221
4222	<attribute name="logoDisplayTime" type="unsigned long">
4223	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
4224	</attribute>
4225
4226	<attribute name="logoImagePath" type="wstring">
4227	<desc>
4228	Local file system path for external BIOS splash image. Empty string
4229	means the default image is shown on boot.
4230	</desc>
4231	</attribute>
4232
4233	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
4234	<desc>Mode of the BIOS boot device menu.</desc>
4235	</attribute>
4236
4237	<attribute name="ACPIEnabled" type="boolean">
4238	<desc>ACPI support flag.</desc>
4239	</attribute>
4240
4241	<attribute name="IOAPICEnabled" type="boolean">
4242	<desc>
4243	IO APIC support flag. If set, VirtualBox will provide an IO APIC
4244	and support IRQs above 15.
4245	</desc>
4246	</attribute>
4247
4248	<attribute name="timeOffset" type="long long">
4249	<desc>
4250	Offset in milliseconds from the host system time. This allows for
4251	guests running with a different system date/time than the host.
4252	It is equivalent to setting the system date/time in the BIOS except
4253	it is not an absolute value but a relative one. Guest Additions
4254	time synchronization honors this offset.
4255	</desc>
4256	</attribute>
4257
4258	<attribute name="PXEDebugEnabled" type="boolean">
4259	<desc>
4260	PXE debug logging flag. If set, VirtualBox will write extensive
4261	PXE trace information to the release log.
4262	</desc>
4263	</attribute>
4264
4265	</interface>
4266
4267	<interface
4268	name="IMachine" extends="$unknown"
4269	uuid="8d8f6fbb-54c1-4604-b68e-17619d458611"
4270	wsmap="managed"
4271	>
4272	<desc>
4273	The IMachine interface represents a virtual machine, or guest, created
4274	in VirtualBox.
4275
4276	This interface is used in two contexts. First of all, a collection of
4277	objects implementing this interface is stored in the
4278	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
4279	machines that are currently registered with this VirtualBox
4280	installation. Also, once a session has been opened for the given virtual
4281	machine (e.g. the virtual machine is running), the machine object
4282	associated with the open session can be queried from the session object;
4283	see <link to="ISession"/> for details.
4284
4285	The main role of this interface is to expose the settings of the virtual
4286	machine and provide methods to change various aspects of the virtual
4287	machine's configuration. For machine objects stored in the
4288	<link to="IVirtualBox::machines"/> collection, all attributes are
4289	read-only unless explicitly stated otherwise in individual attribute
4290	and method descriptions. In order to change a machine setting, a session
4291	for this machine must be opened using one of
4292	<link to="IVirtualBox::openSession"/>,
4293	<link to="IVirtualBox::openRemoteSession"/> or
4294	<link to="IVirtualBox::openExistingSession"/> methods. After the
4295	session has been successfully opened, a mutable machine object needs to
4296	be queried from the session object and then the desired settings changes
4297	can be applied to the returned object using IMachine attributes and
4298	methods. See the <link to="ISession"/> interface description for more
4299	information about sessions.
4300
4301	Note that IMachine does not provide methods to control virtual machine
4302	execution (such as start the machine, or power it down) -- these methods
4303	are grouped in a separate interface called <link to="IConsole" />.
4304
4305	<see>ISession, IConsole</see>
4306	</desc>
4307
4308	<attribute name="parent" type="IVirtualBox" readonly="yes">
4309	<desc>Associated parent object.</desc>
4310	</attribute>
4311
4312	<attribute name="accessible" type="boolean" readonly="yes">
4313	<desc>
4314	Whether this virtual machine is currently accessible or not.
4315
4316	A machine is always deemed accessible unless it is registered <i>and</i>
4317	its settings file cannot be read or parsed (either because the file itself
4318	is unavailable or has invalid XML contents).
4319
4320	Every time this property is read, the accessibility state of
4321	this machine is re-evaluated. If the returned value is @c false,
4322	the <link to="#accessError"/> property may be used to get the
4323	detailed error information describing the reason of
4324	inaccessibility, including XML error messages.
4325
4326	When the machine is inaccessible, only the following properties
4327	can be used on it:
4328	<ul>
4329	<li><link to="#parent"/></li>
4330	<li><link to="#id"/></li>
4331	<li><link to="#settingsFilePath"/></li>
4332	<li><link to="#accessible"/></li>
4333	<li><link to="#accessError"/></li>
4334	</ul>
4335
4336	An attempt to access any other property or method will return
4337	an error.
4338
4339	The only possible action you can perform on an inaccessible
4340	machine is to unregister it using the
4341	<link to="IVirtualBox::unregisterMachine"/> call (or, to check
4342	for the accessibility state once more by querying this
4343	property).
4344
4345	<note>
4346	In the current implementation, once this property returns
4347	@c true, the machine will never become inaccessible
4348	later, even if its settings file cannot be successfully
4349	read/written any more (at least, until the VirtualBox
4350	server is restarted). This limitation may be removed in
4351	future releases.
4352	</note>
4353	</desc>
4354	</attribute>
4355
4356	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
4357	<desc>
4358	Error information describing the reason of machine
4359	inaccessibility.
4360
4361	Reading this property is only valid after the last call to
4362	<link to="#accessible"/> returned @c false (i.e. the
4363	machine is currently unaccessible). Otherwise, a @c null
4364	IVirtualBoxErrorInfo object will be returned.
4365	</desc>
4366	</attribute>
4367
4368	<attribute name="name" type="wstring">
4369	<desc>
4370	Name of the virtual machine.
4371
4372	Besides being used for human-readable identification purposes
4373	everywhere in VirtualBox, the virtual machine name is also used
4374	as a name of the machine's settings file and as a name of the
4375	subdirectory this settings file resides in. Thus, every time you
4376	change the value of this property, the settings file will be
4377	renamed once you call <link to="#saveSettings"/> to confirm the
4378	change. The containing subdirectory will be also renamed, but
4379	only if it has exactly the same name as the settings file
4380	itself prior to changing this property (for backward compatibility
4381	with previous API releases). The above implies the following
4382	limitations:
4383	<ul>
4384	<li>The machine name cannot be empty.</li>
4385	<li>The machine name can contain only characters that are valid
4386	file name characters according to the rules of the file
4387	system used to store VirtualBox configuration.</li>
4388	<li>You cannot have two or more machines with the same name
4389	if they use the same subdirectory for storing the machine
4390	settings files.</li>
4391	<li>You cannot change the name of the machine if it is running,
4392	or if any file in the directory containing the settings file
4393	is being used by another running machine or by any other
4394	process in the host operating system at a time when
4395	<link to="#saveSettings"/> is called.
4396	</li>
4397	</ul>
4398	If any of the above limitations are hit, <link to="#saveSettings"/>
4399	will return an appropriate error message explaining the exact
4400	reason and the changes you made to this machine will not be
4401	saved.
4402	<note>
4403	For "legacy" machines created using the
4404	<link to="IVirtualBox::createLegacyMachine"/> call,
4405	the above naming limitations do not apply because the
4406	machine name does not affect the settings file name.
4407	The settings file name remains the same as it was specified
4408	during machine creation and never changes.
4409	</note>
4410	</desc>
4411	</attribute>
4412
4413	<attribute name="description" type="wstring">
4414	<desc>
4415	Description of the virtual machine.
4416
4417	The description attribute can contain any text and is
4418	typically used to describe the hardware and software
4419	configuration of the virtual machine in detail (i.e. network
4420	settings, versions of the installed software and so on).
4421	</desc>
4422	</attribute>
4423
4424	<attribute name="id" type="uuid" mod="string" readonly="yes">
4425	<desc>UUID of the virtual machine.</desc>
4426	</attribute>
4427
4428	<attribute name="OSTypeId" type="wstring">
4429	<desc>
4430	User-defined identifier of the Guest OS type.
4431	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
4432	an IGuestOSType object representing details about the given
4433	Guest OS type.
4434	<note>
4435	This value may differ from the value returned by
4436	<link to="IGuest::OSTypeId"/> if Guest Additions are
4437	installed to the guest OS.
4438	</note>
4439	</desc>
4440	</attribute>
4441
4442	<attribute name="HardwareVersion" type="wstring">
4443	<desc>Hardware version identifier. Internal use only for now.</desc>
4444	</attribute>
4445
4446	<attribute name="hardwareUUID" type="uuid" mod="string">
4447	<desc>
4448	The UUID presented to the guest via memory tables, hardware and guest
4449	properties. For most VMs this is the same as the @a id, but for VMs
4450	which have been cloned or teleported it may be the same as the source
4451	VM. This latter is because the guest shouldn't notice that it was
4452	cloned or teleported.
4453	</desc>
4454	</attribute>
4455
4456	<attribute name="CPUCount" type="unsigned long">
4457	<desc>Number of virtual CPUs in the VM.</desc>
4458	</attribute>
4459
4460	<attribute name="CPUHotPlugEnabled" type="boolean">
4461	<desc>
4462	This setting determines whether VirtualBox allows CPU
4463	hotplugging for this machine.</desc>
4464	</attribute>
4465
4466	<attribute name="memorySize" type="unsigned long">
4467	<desc>System memory size in megabytes.</desc>
4468	</attribute>
4469
4470	<attribute name="memoryBalloonSize" type="unsigned long">
4471	<desc>Initial memory balloon size in megabytes.</desc>
4472	</attribute>
4473
4474	<attribute name="statisticsUpdateInterval" type="unsigned long">
4475	<desc>Initial interval to update guest statistics in seconds.</desc>
4476	</attribute>
4477
4478	<attribute name="VRAMSize" type="unsigned long">
4479	<desc>Video memory size in megabytes.</desc>
4480	</attribute>
4481
4482	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4483	<desc>
4484	This setting determines whether VirtualBox allows this machine to make
4485	use of the 3D graphics support available on the host.</desc>
4486	</attribute>
4487
4488	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4489	<desc>
4490	This setting determines whether VirtualBox allows this machine to make
4491	use of the 2D video acceleration support available on the host.</desc>
4492	</attribute>
4493
4494	<attribute name="monitorCount" type="unsigned long">
4495	<desc>
4496	Number of virtual monitors.
4497	<note>
4498	Only effective on Windows XP and later guests with
4499	Guest Additions installed.
4500	</note>
4501	</desc>
4502	</attribute>
4503
4504	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4505	<desc>Object containing all BIOS settings.</desc>
4506	</attribute>
4507
4508	<attribute name="firmwareType" type="FirmwareType">
4509	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4510	bootstrap in this VM.</desc>
4511	</attribute>
4512
4513	<attribute name="pointingHidType" type="PointingHidType">
4514	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
4515	The default is typically "PS2Mouse" but can vary depending on the
4516	requirements of the guest operating system.</desc>
4517	</attribute>
4518
4519	<attribute name="keyboardHidType" type="KeyboardHidType">
4520	<desc>Type of keyboard HID used in this VM.
4521	The default is typically "PS2Keyboard" but can vary depending on the
4522	requirements of the guest operating system.</desc>
4523	</attribute>
4524
4525	<attribute name="hpetEnabled" type="boolean">
4526	<desc>This attribute controls if High Precision Event Timer (HPET) is
4527	enabled in this VM. Use this property if you want to provide guests
4528	with additional time source, or if guest requires HPET to function correctly.
4529	Default is false.</desc>
4530	</attribute>
4531
4532	<attribute name="snapshotFolder" type="wstring">
4533	<desc>
4534	Full path to the directory used to store snapshot data
4535	(differencing media and saved state files) of this machine.
4536
4537	The initial value of this property is
4538	<tt><</tt><link to="#settingsFilePath">
4539	path_to_settings_file</link><tt>>/<</tt>
4540	<link to="#id">machine_uuid</link>
4541	<tt>></tt>.
4542
4543	Currently, it is an error to try to change this property on
4544	a machine that has snapshots (because this would require to
4545	move possibly large files to a different location).
4546	A separate method will be available for this purpose later.
4547
4548	<note>
4549	Setting this property to @c null or to an empty string will restore
4550	the initial value.
4551	</note>
4552	<note>
4553	When setting this property, the specified path can be
4554	absolute (full path) or relative to the directory where the
4555	<link to="#settingsFilePath">machine settings file</link>
4556	is located. When reading this property, a full path is
4557	always returned.
4558	</note>
4559	<note>
4560	The specified path may not exist, it will be created
4561	when necessary.
4562	</note>
4563	</desc>
4564	</attribute>
4565
4566	<attribute name="VRDPServer" type="IVRDPServer" readonly="yes">
4567	<desc>VRDP server object.</desc>
4568	</attribute>
4569
4570	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4571	<desc>Array of media attached to this machine.</desc>
4572	</attribute>
4573
4574	<attribute name="USBController" type="IUSBController" readonly="yes">
4575	<desc>
4576	Associated USB controller object.
4577
4578	<note>
4579	If USB functionality is not available in the given edition of
4580	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4581	</note>
4582	</desc>
4583	</attribute>
4584
4585	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4586	<desc>Associated audio adapter, always present.</desc>
4587	</attribute>
4588
4589	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4590	<desc>Array of storage controllers attached to this machine.</desc>
4591	</attribute>
4592
4593	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4594	<desc>
4595	Full name of the file containing machine settings data.
4596	</desc>
4597	</attribute>
4598
4599	<attribute name="settingsModified" type="boolean" readonly="yes">
4600	<desc>
4601	Whether the settings of this machine have been modified
4602	(but neither yet saved nor discarded).
4603	<note>
4604	Reading this property is only valid on instances returned
4605	by <link to="ISession::machine"/> and on new machines
4606	created by <link to="IVirtualBox::createMachine"/> or opened
4607	by <link to="IVirtualBox::openMachine"/> but not
4608	yet registered, or on unregistered machines after calling
4609	<link to="IVirtualBox::unregisterMachine"/>. For all other
4610	cases, the settings can never be modified.
4611	</note>
4612	<note>
4613	For newly created unregistered machines, the value of this
4614	property is always @c true until <link to="#saveSettings"/>
4615	is called (no matter if any machine settings have been
4616	changed after the creation or not). For opened machines
4617	the value is set to @c false (and then follows to normal rules).
4618	</note>
4619	</desc>
4620	</attribute>
4621
4622	<attribute name="sessionState" type="SessionState" readonly="yes">
4623	<desc>Current session state for this machine.</desc>
4624	</attribute>
4625
4626	<attribute name="sessionType" type="wstring" readonly="yes">
4627	<desc>
4628	Type of the session. If <link to="#sessionState"/> is
4629	SessionSpawning or SessionOpen, this attribute contains the
4630	same value as passed to the
4631	<link to="IVirtualBox::openRemoteSession"/> method in the
4632	@a type parameter. If the session was opened directly using
4633	<link to="IVirtualBox::openSession"/>, or if
4634	<link to="#sessionState"/> is SessionClosed, the value of this
4635	attribute is an empty string.
4636	</desc>
4637	</attribute>
4638
4639	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4640	<desc>
4641	Identifier of the session process. This attribute contains the
4642	platform-dependent identifier of the process that has opened a
4643	direct session for this machine using the
4644	<link to="IVirtualBox::openSession"/> call. The returned value
4645	is only valid if <link to="#sessionState"/> is SessionOpen or
4646	SessionClosing (i.e. a session is currently open or being
4647	closed) by the time this property is read.
4648	</desc>
4649	</attribute>
4650
4651	<attribute name="state" type="MachineState" readonly="yes">
4652	<desc>Current execution state of this machine.</desc>
4653	</attribute>
4654
4655	<attribute name="lastStateChange" type="long long" readonly="yes">
4656	<desc>
4657	Time stamp of the last execution state change,
4658	in milliseconds since 1970-01-01 UTC.
4659	</desc>
4660	</attribute>
4661
4662	<attribute name="stateFilePath" type="wstring" readonly="yes">
4663	<desc>
4664	Full path to the file that stores the execution state of
4665	the machine when it is in the <link to="MachineState_Saved"/> state.
4666	<note>
4667	When the machine is not in the Saved state, this attribute is
4668	an empty string.
4669	</note>
4670	</desc>
4671	</attribute>
4672
4673	<attribute name="logFolder" type="wstring" readonly="yes">
4674	<desc>
4675	Full path to the folder that stores a set of rotated log files
4676	recorded during machine execution. The most recent log file is
4677	named <tt>VBox.log</tt>, the previous log file is
4678	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4679	in the current version).
4680	</desc>
4681	</attribute>
4682
4683	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4684	<desc>
4685	Current snapshot of this machine. This is @c null if the machine
4686	currently has no snapshots. If it is not @c null, then it was
4687	set by one of <link to="Console::takeSnapshot" />,
4688	<link to="Console::deleteSnapshot" />
4689	or <link to="Console::restoreSnapshot" />, depending on which
4690	was called last. See <link to="ISnapshot"/> for details.
4691	</desc>
4692	</attribute>
4693
4694	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4695	<desc>
4696	Number of snapshots taken on this machine. Zero means the
4697	machine doesn't have any snapshots.
4698	</desc>
4699	</attribute>
4700
4701	<attribute name="currentStateModified" type="boolean" readonly="yes">
4702	<desc>
4703	Returns @c true if the current state of the machine is not
4704	identical to the state stored in the current snapshot.
4705
4706	The current state is identical to the current snapshot only
4707	directly after one of the following calls are made:
4708
4709	<ul>
4710	<li><link to="IConsole::restoreSnapshot"/>
4711	</li>
4712	<li><link to="IConsole::takeSnapshot"/> (issued on a
4713	"powered off" or "saved" machine, for which
4714	<link to="#settingsModified"/> returns @c false)
4715	</li>
4716	<li><link to="IMachine::setCurrentSnapshot"/>
4717	</li>
4718	</ul>
4719
4720	The current state remains identical until one of the following
4721	happens:
4722	<ul>
4723	<li>settings of the machine are changed</li>
4724	<li>the saved state is discarded</li>
4725	<li>the current snapshot is discarded</li>
4726	<li>an attempt to execute the machine is made</li>
4727	</ul>
4728
4729	<note>
4730	For machines that don't have snapshots, this property is
4731	always @c false.
4732	</note>
4733	</desc>
4734	</attribute>
4735
4736	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4737	<desc>
4738	Collection of shared folders for this machine (permanent shared
4739	folders). These folders are shared automatically at machine startup
4740	and available only to the guest OS installed within this machine.
4741
4742	New shared folders are added to the collection using
4743	<link to="#createSharedFolder"/>. Existing shared folders can be
4744	removed using <link to="#removeSharedFolder"/>.
4745	</desc>
4746	</attribute>
4747
4748	<attribute name="clipboardMode" type="ClipboardMode">
4749	<desc>
4750	Synchronization mode between the host OS clipboard
4751	and the guest OS clipboard.
4752	</desc>
4753	</attribute>
4754
4755	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4756	<desc>
4757	A comma-separated list of simple glob patterns. Changes to guest
4758	properties whose name matches one of the patterns will generate an
4759	<link to="IVirtualBoxCallback::onGuestPropertyChange"/> signal.
4760	</desc>
4761	</attribute>
4762
4763	<attribute name="teleporterEnabled" type="boolean">
4764	<desc>
4765	When set to @a true, the virtual machine becomes a target teleporter
4766	the next time it is powered on. This can only set to @a true when the
4767	VM is in the @a PoweredOff or @a Aborted state.
4768
4769	<!-- This property is automatically set to @a false when the VM is powered
4770	on. (bird: This doesn't work yet ) -->
4771	</desc>
4772	</attribute>
4773
4774	<attribute name="teleporterPort" type="unsigned long">
4775	<desc>
4776	The TCP port the target teleporter will listen for incoming
4777	teleportations on.
4778
4779	0 means the port is automatically selected upon power on. The actual
4780	value can be read from this property while the machine is waiting for
4781	incoming teleportations.
4782	</desc>
4783	</attribute>
4784
4785	<attribute name="teleporterAddress" type="wstring">
4786	<desc>
4787	The address the target teleporter will listen on. If set to an empty
4788	string, it will listen on all addresses.
4789	</desc>
4790	</attribute>
4791
4792	<attribute name="teleporterPassword" type="wstring">
4793	<desc>
4794	The password the to check for on the target teleporter. This is just a
4795	very basic measure to prevent simple hacks and operators accidentally
4796	beaming a virtual machine to the wrong place.
4797	</desc>
4798	</attribute>
4799
4800	<attribute name="RTCUseUTC" type="boolean">
4801	<desc>
4802	When set to @a true, the RTC device of the virtual machine will run
4803	in UTC time, otherwise in local time. Especially Unix guests prefer
4804	the time in UTC.
4805	</desc>
4806	</attribute>
4807
4808	<attribute name="ioMgr" type="IoMgrType">
4809	<desc>
4810	Selects the I/O manager to use for the virtual machine.
4811	</desc>
4812	</attribute>
4813
4814	<attribute name="ioBackend" type="IoBackendType">
4815	<desc>
4816	Selects the I/O backend to use for the virtual machine.
4817	</desc>
4818	</attribute>
4819
4820	<attribute name="ioCacheEnabled" type="boolean">
4821	<desc>
4822	When set to @a true, the builtin I/O cache of the virtual machine
4823	will be enabled.
4824	</desc>
4825	</attribute>
4826
4827	<attribute name="ioCacheSize" type="unsigned long">
4828	<desc>
4829	Maximum size of the I/O cache in MB.
4830	</desc>
4831	</attribute>
4832
4833	<attribute name="ioBandwidthMax" type="unsigned long">
4834	<desc>
4835	The maximum number of MB the VM is allowed to transfer per second.
4836	0 means unlimited bandwidth.
4837	</desc>
4838	</attribute>
4839
4840	<method name="setBootOrder">
4841	<desc>
4842	Puts the given device to the specified position in
4843	the boot order.
4844
4845	To indicate that no device is associated with the given position,
4846	<link to="DeviceType_Null"/> should be used.
4847
4848	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4849
4850	<result name="E_INVALIDARG">
4851	Boot @a position out of range.
4852	</result>
4853	<result name="E_NOTIMPL">
4854	Booting from USB @a device currently not supported.
4855	</result>
4856
4857	</desc>
4858	<param name="position" type="unsigned long" dir="in">
4859	<desc>
4860	Position in the boot order (@c 1 to the total number of
4861	devices the machine can boot from, as returned by
4862	<link to="ISystemProperties::maxBootPosition"/>).
4863	</desc>
4864	</param>
4865	<param name="device" type="DeviceType" dir="in">
4866	<desc>
4867	The type of the device used to boot at the given position.
4868	</desc>
4869	</param>
4870	</method>
4871
4872	<method name="getBootOrder" const="yes">
4873	<desc>
4874	Returns the device type that occupies the specified
4875	position in the boot order.
4876
4877	@todo [remove?]
4878	If the machine can have more than one device of the returned type
4879	(such as hard disks), then a separate method should be used to
4880	retrieve the individual device that occupies the given position.
4881
4882	If here are no devices at the given position, then
4883	<link to="DeviceType_Null"/> is returned.
4884
4885	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4886
4887	<result name="E_INVALIDARG">
4888	Boot @a position out of range.
4889	</result>
4890
4891	</desc>
4892	<param name="position" type="unsigned long" dir="in">
4893	<desc>
4894	Position in the boot order (@c 1 to the total number of
4895	devices the machine can boot from, as returned by
4896	<link to="ISystemProperties::maxBootPosition"/>).
4897	</desc>
4898	</param>
4899	<param name="device" type="DeviceType" dir="return">
4900	<desc>
4901	Device at the given position.
4902	</desc>
4903	</param>
4904	</method>
4905
4906	<method name="attachDevice">
4907	<desc>
4908	Attaches a device and optionally mounts a medium to the given storage
4909	controller (<link to="IStorageController" />, identified by @a name),
4910	at the indicated port and device.
4911
4912	This method is intended for managing storage devices in general (it works
4913	for both fixed and removable media). For storage devices supporting removable
4914	media (such as DVDs and floppies), you can also use <link to="IMedium::mountMedium"/>
4915	for changing the media while the machine is running.
4916
4917	For the IDE bus, the @a controllerPort parameter can be either
4918	@c 0 or @c 1, to specify the primary or secondary IDE controller,
4919	respectively. For each of these, @a device can then be either @c 0 or @c 1,
4920	to specify the master or the slave device, respectively. (In the
4921	default configuration of virtual machines, the secondary master is
4922	used for a CD/DVD drive.)
4923
4924	For an SATA controller, @a controllerPort must be a number ranging
4925	from @c 0 to @c 29. For a SCSI controller, @a controllerPort must
4926	be a number ranging from @c 0 to @c 15.
4927
4928	For both SCSI and SATA, the @a device parameter is unused and must
4929	be @c 0.
4930
4931	For fixed media such as hard disks, the given medium identifier cannot
4932	be a zero UUID. It may be a zero UUID for removable media such as DVDs
4933	and floppies.
4934
4935	After calling this returns successfully, a new instance of
4936	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4937	attachments (<link to="IMachine::mediumAttachments"/>).
4938
4939	The specified device slot must not have a device attached to it,
4940	or this method will fail.
4941
4942	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4943	information about attaching media.
4944
4945	<note>
4946	You cannot attach a device to a running machine. Also, you cannot
4947	attach a device to a newly created machine until this machine's
4948	settings are saved to disk using <link to="#saveSettings"/>.
4949	</note>
4950	<note>
4951	If the medium is being attached indirectly, a new differencing medium
4952	will implicitly be created for it and attached instead. If the
4953	changes made to the machine settings (including this indirect
4954	attachment) are later cancelled using <link to="#discardSettings"/>,
4955	this implicitly created differencing medium will implicitly
4956	be deleted.
4957	</note>
4958
4959	<result name="E_INVALIDARG">
4960	SATA device, SATA port, IDE port or IDE slot out of range.
4961	</result>
4962	<result name="VBOX_E_INVALID_OBJECT_STATE">
4963	Attempt to attach medium to an unregistered virtual machine.
4964	</result>
4965	<result name="VBOX_E_INVALID_VM_STATE">
4966	Invalid machine state.
4967	</result>
4968	<result name="VBOX_E_OBJECT_IN_USE">
4969	Hard disk already attached to this or another virtual machine.
4970	</result>
4971
4972	</desc>
4973	<param name="name" type="wstring" dir="in">
4974	<desc>Name of the storage controller to attach the device to.</desc>
4975	</param>
4976	<param name="controllerPort" type="long" dir="in">
4977	<desc>Port to attach the device to.</desc>
4978	</param>
4979	<param name="device" type="long" dir="in">
4980	<desc>Device slot in the given port to attach the device to.</desc>
4981	</param>
4982	<param name="type" type="DeviceType" dir="in">
4983	<desc>Device type of the attached device.</desc>
4984	</param>
4985	<param name="id" type="uuid" mod="string" dir="in">
4986	<desc>UUID of the medium to mount. Zero UUID means do not mount any
4987	medium.</desc>
4988	</param>
4989	</method>
4990
4991	<method name="detachDevice">
4992	<desc>
4993	Detaches the device attached to a device slot of the specified bus.
4994
4995	Detaching the device from the virtual machine is deferred. This means
4996	that the medium remains associated with the machine when this method
4997	returns and gets actually de-associated only after a successful
4998	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4999	for more detailed information about attaching media.
5000
5001	<note>
5002	You cannot detach a device from a running machine.
5003	</note>
5004	<note>
5005	Detaching differencing media implicitly created by <link
5006	to="#attachDevice"/> for the indirect attachment using this
5007	method will <b>not</b> implicitly delete them. The
5008	<link to="IMedium::deleteStorage"/> operation should be
5009	explicitly performed by the caller after the medium is successfully
5010	detached and the settings are saved with
5011	<link to="#saveSettings"/>, if it is the desired action.
5012	</note>
5013
5014	<result name="VBOX_E_INVALID_VM_STATE">
5015	Attempt to detach medium from a running virtual machine.
5016	</result>
5017	<result name="VBOX_E_OBJECT_NOT_FOUND">
5018	No medium attached to given slot/bus.
5019	</result>
5020	<result name="VBOX_E_NOT_SUPPORTED">
5021	Medium format does not support storage deletion.
5022	</result>
5023
5024	</desc>
5025	<param name="name" type="wstring" dir="in">
5026	<desc>Name of the storage controller to detach the medium from.</desc>
5027	</param>
5028	<param name="controllerPort" type="long" dir="in">
5029	<desc>Port number to detach the medium from.</desc>
5030	</param>
5031	<param name="device" type="long" dir="in">
5032	<desc>Device slot number to detach the medium from.</desc>
5033	</param>
5034	</method>
5035
5036	<method name="passthroughDevice">
5037	<desc>
5038	Sets the passthrough mode of an existing DVD device. Changing the
5039	setting while the VM is running is forbidden. The setting is only used
5040	if at VM start the device is configured as a host DVD drive, in all
5041	other cases it is ignored. The device must already exist; see
5042	<link to="IMachine::attachDevice"/> for how to attach a new device.
5043
5044	The @a controllerPort and @a device parameters specify the device slot and
5045	have have the same meaning as with <link to="IMachine::attachDevice" />.
5046
5047	<result name="E_INVALIDARG">
5048	SATA device, SATA port, IDE port or IDE slot out of range.
5049	</result>
5050	<result name="VBOX_E_INVALID_OBJECT_STATE">
5051	Attempt to modify an unregistered virtual machine.
5052	</result>
5053	<result name="VBOX_E_INVALID_VM_STATE">
5054	Invalid machine state.
5055	</result>
5056
5057	</desc>
5058	<param name="name" type="wstring" dir="in">
5059	<desc>Name of the storage controller.</desc>
5060	</param>
5061	<param name="controllerPort" type="long" dir="in">
5062	<desc>Storage controller port.</desc>
5063	</param>
5064	<param name="device" type="long" dir="in">
5065	<desc>Device slot in the given port.</desc>
5066	</param>
5067	<param name="passthrough" type="boolean" dir="in">
5068	<desc>New value for the passthrough setting.</desc>
5069	</param>
5070	</method>
5071
5072	<method name="mountMedium">
5073	<desc>
5074	Mounts a medium (<link to="IMedium" />, identified
5075	by the given UUID @a id) to the given storage controller
5076	(<link to="IStorageController" />, identified by @a name),
5077	at the indicated port and device. The device must already exist;
5078	see <link to="IMachine::attachDevice"/> for how to attach a new device.
5079
5080	This method is intended only for managing removable media, where the
5081	device is fixed but media is changeable at runtime (such as DVDs
5082	and floppies). It cannot be used for fixed media such as hard disks.
5083
5084	The @a controllerPort and @a device parameters specify the device slot and
5085	have have the same meaning as with <link to="IMachine::attachDevice" />.
5086
5087	The specified device slot can have a medium mounted, which will be
5088	unmounted first. Specifying a zero UUID (or an empty string) for
5089	@a medium does just an unmount.
5090
5091	See <link to="IMedium"/> for more detailed information about
5092	attaching media.
5093
5094	<result name="E_INVALIDARG">
5095	SATA device, SATA port, IDE port or IDE slot out of range.
5096	</result>
5097	<result name="VBOX_E_INVALID_OBJECT_STATE">
5098	Attempt to attach medium to an unregistered virtual machine.
5099	</result>
5100	<result name="VBOX_E_INVALID_VM_STATE">
5101	Invalid machine state.
5102	</result>
5103	<result name="VBOX_E_OBJECT_IN_USE">
5104	Medium already attached to this or another virtual machine.
5105	</result>
5106
5107	</desc>
5108	<param name="name" type="wstring" dir="in">
5109	<desc>Name of the storage controller to attach the medium to.</desc>
5110	</param>
5111	<param name="controllerPort" type="long" dir="in">
5112	<desc>Port to attach the medium to.</desc>
5113	</param>
5114	<param name="device" type="long" dir="in">
5115	<desc>Device slot in the given port to attach the medium to.</desc>
5116	</param>
5117	<param name="medium" type="uuid" mod="string" dir="in">
5118	<desc>UUID of the medium to attach. A zero UUID means unmount the
5119	currently mounted medium.</desc>
5120	</param>
5121	<param name="force" type="boolean" dir="in">
5122	<desc>Allows to force unmount/mount of a medium which is locked by
5123	theDevice slot in the given port to attach the medium to.</desc>
5124	</param>
5125	</method>
5126
5127	<method name="getMedium" const="yes">
5128	<desc>
5129	Returns the virtual medium attached to a device slot of the specified
5130	bus.
5131
5132	Note that if the medium was indirectly attached by
5133	<link to="#mountMedium"/> to the given device slot then this
5134	method will return not the same object as passed to the
5135	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5136	more detailed information about mounting a medium.
5137
5138	<result name="VBOX_E_OBJECT_NOT_FOUND">
5139	No medium attached to given slot/bus.
5140	</result>
5141
5142	</desc>
5143	<param name="name" type="wstring" dir="in">
5144	<desc>Name of the storage controller the medium is attached to.</desc>
5145	</param>
5146	<param name="controllerPort" type="long" dir="in">
5147	<desc>Port to query.</desc>
5148	</param>
5149	<param name="device" type="long" dir="in">
5150	<desc>Device slot in the given port to query.</desc>
5151	</param>
5152	<param name="medium" type="IMedium" dir="return">
5153	<desc>Attached medium object.</desc>
5154	</param>
5155	</method>
5156
5157	<method name="getMediumAttachmentsOfController" const="yes">
5158	<desc>
5159	Returns an array of medium attachments which are attached to the
5160	the controller with the given name.
5161
5162	<result name="VBOX_E_OBJECT_NOT_FOUND">
5163	A storage controller with given name doesn't exist.
5164	</result>
5165	</desc>
5166	<param name="name" type="wstring" dir="in"/>
5167	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5168	</method>
5169
5170	<method name="getMediumAttachment" const="yes">
5171	<desc>
5172	Returns a medium attachment which corresponds to the controller with
5173	the given name, on the given port and device slot.
5174
5175	<result name="VBOX_E_OBJECT_NOT_FOUND">
5176	No attachment exists for the given controller/port/device combination.
5177	</result>
5178	</desc>
5179	<param name="name" type="wstring" dir="in"/>
5180	<param name="controllerPort" type="long" dir="in"/>
5181	<param name="device" type="long" dir="in"/>
5182	<param name="attachment" type="IMediumAttachment" dir="return"/>
5183	</method>
5184
5185	<method name="getNetworkAdapter" const="yes">
5186	<desc>
5187	Returns the network adapter associated with the given slot.
5188	Slots are numbered sequentially, starting with zero. The total
5189	number of adapters per machine is defined by the
5190	<link to="ISystemProperties::networkAdapterCount"/> property,
5191	so the maximum slot number is one less than that property's value.
5192
5193	<result name="E_INVALIDARG">
5194	Invalid @a slot number.
5195	</result>
5196
5197	</desc>
5198	<param name="slot" type="unsigned long" dir="in"/>
5199	<param name="adapter" type="INetworkAdapter" dir="return"/>
5200	</method>
5201
5202	<method name="addStorageController">
5203	<desc>
5204	Adds a new storage controller (SCSI or SATA controller) to the
5205	machine and returns it as an instance of
5206	<link to="IStorageController" />.
5207
5208	@a name identifies the controller for subsequent calls such as
5209	<link to="#getStorageControllerByName" />,
5210	<link to="#getStorageControllerByInstance" />,
5211	<link to="#removeStorageController" />,
5212	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5213
5214	After the controller has been added, you can set its exact
5215	type by setting the <link to="IStorageController::controllerType" />.
5216
5217	<result name="VBOX_E_OBJECT_IN_USE">
5218	A storage controller with given name exists already.
5219	</result>
5220	<result name="E_INVALIDARG">
5221	Invalid @a controllerType.
5222	</result>
5223	</desc>
5224	<param name="name" type="wstring" dir="in"/>
5225	<param name="connectionType" type="StorageBus" dir="in"/>
5226	<param name="controller" type="IStorageController" dir="return"/>
5227	</method>
5228
5229	<method name="getStorageControllerByName" const="yes">
5230	<desc>
5231	Returns a storage controller with the given name.
5232
5233	<result name="VBOX_E_OBJECT_NOT_FOUND">
5234	A storage controller with given name doesn't exist.
5235	</result>
5236	</desc>
5237	<param name="name" type="wstring" dir="in"/>
5238	<param name="storageController" type="IStorageController" dir="return"/>
5239	</method>
5240
5241	<method name="getStorageControllerByInstance" const="yes">
5242	<desc>
5243	Returns a storage controller with the given instance number.
5244
5245	<result name="VBOX_E_OBJECT_NOT_FOUND">
5246	A storage controller with given instance number doesn't exist.
5247	</result>
5248	</desc>
5249	<param name="instance" type="unsigned long" dir="in"/>
5250	<param name="storageController" type="IStorageController" dir="return"/>
5251	</method>
5252
5253	<method name="removeStorageController">
5254	<desc>
5255	Removes a storage controller from the machine.
5256
5257	<result name="VBOX_E_OBJECT_NOT_FOUND">
5258	A storage controller with given name doesn't exist.
5259	</result>
5260	</desc>
5261	<param name="name" type="wstring" dir="in"/>
5262	</method>
5263
5264	<method name="getSerialPort" const="yes">
5265	<desc>
5266	Returns the serial port associated with the given slot.
5267	Slots are numbered sequentially, starting with zero. The total
5268	number of serial ports per machine is defined by the
5269	<link to="ISystemProperties::serialPortCount"/> property,
5270	so the maximum slot number is one less than that property's value.
5271
5272	<result name="E_INVALIDARG">
5273	Invalid @a slot number.
5274	</result>
5275
5276	</desc>
5277	<param name="slot" type="unsigned long" dir="in"/>
5278	<param name="port" type="ISerialPort" dir="return"/>
5279	</method>
5280
5281	<method name="getParallelPort" const="yes">
5282	<desc>
5283	Returns the parallel port associated with the given slot.
5284	Slots are numbered sequentially, starting with zero. The total
5285	number of parallel ports per machine is defined by the
5286	<link to="ISystemProperties::parallelPortCount"/> property,
5287	so the maximum slot number is one less than that property's value.
5288
5289	<result name="E_INVALIDARG">
5290	Invalid @a slot number.
5291	</result>
5292
5293	</desc>
5294	<param name="slot" type="unsigned long" dir="in"/>
5295	<param name="port" type="IParallelPort" dir="return"/>
5296	</method>
5297
5298	<method name="getExtraDataKeys">
5299	<desc>
5300	Returns an array representing the machine-specific extra data keys
5301	which currently have values defined.
5302	</desc>
5303	<param name="value" type="wstring" dir="return" safearray="yes">
5304	<desc>Array of extra data keys.</desc>
5305	</param>
5306	</method>
5307
5308	<method name="getExtraData">
5309	<desc>
5310	Returns associated machine-specific extra data.
5311
5312	If the requested data @a key does not exist, this function will
5313	succeed and return an empty string in the @a value argument.
5314
5315	<result name="VBOX_E_FILE_ERROR">
5316	Settings file not accessible.
5317	</result>
5318	<result name="VBOX_E_XML_ERROR">
5319	Could not parse the settings file.
5320	</result>
5321
5322	</desc>
5323	<param name="key" type="wstring" dir="in">
5324	<desc>Name of the data key to get.</desc>
5325	</param>
5326	<param name="value" type="wstring" dir="return">
5327	<desc>Value of the requested data key.</desc>
5328	</param>
5329	</method>
5330
5331	<method name="setExtraData">
5332	<desc>
5333	Sets associated machine-specific extra data.
5334
5335	If you pass @c null or an empty string as a key @a value, the given
5336	@a key will be deleted.
5337
5338	<note>
5339	Before performing the actual data change, this method will ask all
5340	registered callbacks using the
5341	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
5342	notification for a permission. If one of the callbacks refuses the
5343	new value, the change will not be performed.
5344	</note>
5345	<note>
5346	On success, the
5347	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
5348	is called to inform all registered callbacks about a successful data
5349	change.
5350	</note>
5351	<note>
5352	This method can be called outside the machine session and therefore
5353	it's a caller's responsibility to handle possible race conditions
5354	when several clients change the same key at the same time.
5355	</note>
5356
5357	<result name="VBOX_E_FILE_ERROR">
5358	Settings file not accessible.
5359	</result>
5360	<result name="VBOX_E_XML_ERROR">
5361	Could not parse the settings file.
5362	</result>
5363
5364	</desc>
5365	<param name="key" type="wstring" dir="in">
5366	<desc>Name of the data key to set.</desc>
5367	</param>
5368	<param name="value" type="wstring" dir="in">
5369	<desc>Value to assign to the key.</desc>
5370	</param>
5371	</method>
5372
5373	<method name="getCpuProperty" const="yes">
5374	<desc>
5375	Returns the virtual CPU boolean value of the specified property.
5376
5377	<result name="E_INVALIDARG">
5378	Invalid property.
5379	</result>
5380
5381	</desc>
5382	<param name="property" type="CpuPropertyType" dir="in">
5383	<desc>
5384	Property type to query.
5385	</desc>
5386	</param>
5387	<param name="value" type="boolean" dir="return">
5388	<desc>
5389	Property value.
5390	</desc>
5391	</param>
5392	</method>
5393
5394	<method name="setCpuProperty">
5395	<desc>
5396	Sets the virtual CPU boolean value of the specified property.
5397
5398	<result name="E_INVALIDARG">
5399	Invalid property.
5400	</result>
5401
5402	</desc>
5403	<param name="property" type="CpuPropertyType" dir="in">
5404	<desc>
5405	Property type to query.
5406	</desc>
5407	</param>
5408	<param name="value" type="boolean" dir="in">
5409	<desc>
5410	Property value.
5411	</desc>
5412	</param>
5413	</method>
5414
5415	<method name="getCpuIdLeaf" const="yes">
5416	<desc>
5417	Returns the virtual CPU cpuid information for the specified leaf.
5418
5419	Currently supported index values for cpuid:
5420	Standard CPUID leafs: 0 - 0xA
5421	Extended CPUID leafs: 0x80000000 - 0x8000000A
5422
5423	See the Intel and AMD programmer's manuals for detailed information
5424	about the cpuid instruction and its leafs.
5425	<result name="E_INVALIDARG">
5426	Invalid id.
5427	</result>
5428
5429	</desc>
5430	<param name="id" type="unsigned long" dir="in">
5431	<desc>
5432	Cpuid leaf index.
5433	</desc>
5434	</param>
5435	<param name="valEax" type="unsigned long" dir="out">
5436	<desc>
5437	Cpuid leaf value for register eax.
5438	</desc>
5439	</param>
5440	<param name="valEbx" type="unsigned long" dir="out">
5441	<desc>
5442	Cpuid leaf value for register ebx.
5443	</desc>
5444	</param>
5445	<param name="valEcx" type="unsigned long" dir="out">
5446	<desc>
5447	Cpuid leaf value for register ecx.
5448	</desc>
5449	</param>
5450	<param name="valEdx" type="unsigned long" dir="out">
5451	<desc>
5452	Cpuid leaf value for register edx.
5453	</desc>
5454	</param>
5455	</method>
5456
5457	<method name="setCpuIdLeaf" const="yes">
5458	<desc>
5459	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5460	are not passed unmodified. VirtualBox clears features that it doesn't support.
5461
5462	Currently supported index values for cpuid:
5463	Standard CPUID leafs: 0 - 0xA
5464	Extended CPUID leafs: 0x80000000 - 0x8000000A
5465
5466	See the Intel and AMD programmer's manuals for detailed information
5467	about the cpuid instruction and its leafs.
5468
5469	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5470	random crashes inside VMs.
5471	<result name="E_INVALIDARG">
5472	Invalid id.
5473	</result>
5474
5475	</desc>
5476	<param name="id" type="unsigned long" dir="in">
5477	<desc>
5478	Cpuid leaf index.
5479	</desc>
5480	</param>
5481	<param name="valEax" type="unsigned long" dir="in">
5482	<desc>
5483	Cpuid leaf value for register eax.
5484	</desc>
5485	</param>
5486	<param name="valEbx" type="unsigned long" dir="in">
5487	<desc>
5488	Cpuid leaf value for register ebx.
5489	</desc>
5490	</param>
5491	<param name="valEcx" type="unsigned long" dir="in">
5492	<desc>
5493	Cpuid leaf value for register ecx.
5494	</desc>
5495	</param>
5496	<param name="valEdx" type="unsigned long" dir="in">
5497	<desc>
5498	Cpuid leaf value for register edx.
5499	</desc>
5500	</param>
5501	</method>
5502
5503	<method name="removeCpuIdLeaf" const="yes">
5504	<desc>
5505	Removes the virtual CPU cpuid leaf for the specified index
5506
5507	<result name="E_INVALIDARG">
5508	Invalid id.
5509	</result>
5510
5511	</desc>
5512	<param name="id" type="unsigned long" dir="in">
5513	<desc>
5514	Cpuid leaf index.
5515	</desc>
5516	</param>
5517	</method>
5518
5519	<method name="removeAllCpuIdLeafs" const="yes">
5520	<desc>
5521	Removes all the virtual CPU cpuid leafs
5522	</desc>
5523	</method>
5524
5525	<method name="getHWVirtExProperty" const="yes">
5526	<desc>
5527	Returns the value of the specified hardware virtualization boolean property.
5528
5529	<result name="E_INVALIDARG">
5530	Invalid property.
5531	</result>
5532
5533	</desc>
5534	<param name="property" type="HWVirtExPropertyType" dir="in">
5535	<desc>
5536	Property type to query.
5537	</desc>
5538	</param>
5539	<param name="value" type="boolean" dir="return">
5540	<desc>
5541	Property value.
5542	</desc>
5543	</param>
5544	</method>
5545
5546	<method name="setHWVirtExProperty">
5547	<desc>
5548	Sets a new value for the specified hardware virtualization boolean property.
5549
5550	<result name="E_INVALIDARG">
5551	Invalid property.
5552	</result>
5553
5554	</desc>
5555	<param name="property" type="HWVirtExPropertyType" dir="in">
5556	<desc>
5557	Property type to set.
5558	</desc>
5559	</param>
5560	<param name="value" type="boolean" dir="in">
5561	<desc>
5562	New property value.
5563	</desc>
5564	</param>
5565	</method>
5566
5567	<method name="saveSettings">
5568	<desc>
5569	Saves any changes to machine settings made since the session
5570	has been opened or a new machine has been created, or since the
5571	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5572	For registered machines, new settings become visible to all
5573	other VirtualBox clients after successful invocation of this
5574	method.
5575	<note>
5576	The method sends <link to="IVirtualBoxCallback::onMachineDataChange"/>
5577	notification event after the configuration has been successfully
5578	saved (only for registered machines).
5579	</note>
5580	<note>
5581	Calling this method is only valid on instances returned
5582	by <link to="ISession::machine"/> and on new machines
5583	created by <link to="IVirtualBox::createMachine"/> but not
5584	yet registered, or on unregistered machines after calling
5585	<link to="IVirtualBox::unregisterMachine"/>.
5586	</note>
5587
5588	<result name="VBOX_E_FILE_ERROR">
5589	Settings file not accessible.
5590	</result>
5591	<result name="VBOX_E_XML_ERROR">
5592	Could not parse the settings file.
5593	</result>
5594	<result name="E_ACCESSDENIED">
5595	Modification request refused.
5596	</result>
5597
5598	</desc>
5599	</method>
5600
5601	<method name="discardSettings">
5602	<desc>
5603	Discards any changes to the machine settings made since the session
5604	has been opened or since the last call to <link to="#saveSettings"/>
5605	or <link to="#discardSettings"/>.
5606	<note>
5607	Calling this method is only valid on instances returned
5608	by <link to="ISession::machine"/> and on new machines
5609	created by <link to="IVirtualBox::createMachine"/> or
5610	opened by <link to="IVirtualBox::openMachine"/> but not
5611	yet registered, or on unregistered machines after calling
5612	<link to="IVirtualBox::unregisterMachine"/>.
5613	</note>
5614
5615	<result name="VBOX_E_INVALID_VM_STATE">
5616	Virtual machine is not mutable.
5617	</result>
5618
5619	</desc>
5620	</method>
5621
5622	<method name="deleteSettings">
5623	<desc>
5624	Deletes the settings file of this machine from disk.
5625	The machine must not be registered in order for this operation
5626	to succeed.
5627	<note>
5628	<link to="#settingsModified"/> will return @c true after this
5629	method successfully returns.
5630	</note>
5631	<note>
5632	Calling this method is only valid on instances returned
5633	by <link to="ISession::machine"/> and on new machines
5634	created by <link to="IVirtualBox::createMachine"/> or
5635	opened by <link to="IVirtualBox::openMachine"/> but not
5636	yet registered, or on unregistered machines after calling
5637	<link to="IVirtualBox::unregisterMachine"/>.
5638	</note>
5639	<note>
5640	The deleted machine settings file can be restored (saved again)
5641	by calling <link to="#saveSettings"/>.
5642	</note>
5643
5644	<result name="VBOX_E_INVALID_VM_STATE">
5645	Cannot delete settings of a registered machine or
5646	machine not mutable.
5647	</result>
5648	<result name="VBOX_E_IPRT_ERROR">
5649	Could not delete the settings file.
5650	</result>
5651
5652	</desc>
5653	</method>
5654
5655	<method name="export">
5656	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5657	steps required to export VirtualBox machines to OVF.
5658	</desc>
5659
5660	<param name="aAppliance" type="IAppliance" dir="in">
5661	<desc>Appliance to export this machine to.</desc>
5662	</param>
5663	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5664	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5665	</param>
5666	</method >
5667
5668	<method name="getSnapshot">
5669	<desc>
5670	Returns a snapshot of this machine with the given UUID.
5671	A @c null UUID can be used to obtain the first snapshot
5672	taken on this machine. This is useful if you want to traverse
5673	the whole tree of snapshots starting from the root.
5674
5675	<result name="VBOX_E_OBJECT_NOT_FOUND">
5676	Virtual machine has no snapshots or snapshot not found.
5677	</result>
5678
5679	</desc>
5680	<param name="id" type="uuid" mod="string" dir="in">
5681	<desc>UUID of the snapshot to get</desc>
5682	</param>
5683	<param name="snapshot" type="ISnapshot" dir="return">
5684	<desc>Snapshot object with the given UUID.</desc>
5685	</param>
5686	</method>
5687
5688	<method name="findSnapshot">
5689	<desc>
5690	Returns a snapshot of this machine with the given name.
5691
5692	<result name="VBOX_E_OBJECT_NOT_FOUND">
5693	Virtual machine has no snapshots or snapshot not found.
5694	</result>
5695
5696	</desc>
5697	<param name="name" type="wstring" dir="in">
5698	<desc>Name of the snapshot to find</desc>
5699	</param>
5700	<param name="snapshot" type="ISnapshot" dir="return">
5701	<desc>Snapshot object with the given name.</desc>
5702	</param>
5703	</method>
5704
5705	<method name="setCurrentSnapshot">
5706	<desc>
5707	Sets the current snapshot of this machine.
5708	<note>
5709	In the current implementation, this operation is not
5710	implemented.
5711	</note>
5712	</desc>
5713	<param name="id" type="uuid" mod="string" dir="in">
5714	<desc>UUID of the snapshot to set as the current snapshot.</desc>
5715	</param>
5716	</method>
5717
5718	<method name="createSharedFolder">
5719	<desc>
5720	Creates a new permanent shared folder by associating the given logical
5721	name with the given host path, adds it to the collection of shared
5722	folders and starts sharing it. Refer to the description of
5723	<link to="ISharedFolder"/> to read more about logical names.
5724
5725	<result name="VBOX_E_OBJECT_IN_USE">
5726	Shared folder already exists.
5727	</result>
5728	<result name="VBOX_E_FILE_ERROR">
5729	Shared folder @a hostPath not accessible.
5730	</result>
5731
5732	</desc>
5733	<param name="name" type="wstring" dir="in">
5734	<desc>Unique logical name of the shared folder.</desc>
5735	</param>
5736	<param name="hostPath" type="wstring" dir="in">
5737	<desc>Full path to the shared folder in the host file system.</desc>
5738	</param>
5739	<param name="writable" type="boolean" dir="in">
5740	<desc>Whether the share is writable or readonly</desc>
5741	</param>
5742	</method>
5743
5744	<method name="removeSharedFolder">
5745	<desc>
5746	Removes the permanent shared folder with the given name previously
5747	created by <link to="#createSharedFolder"/> from the collection of
5748	shared folders and stops sharing it.
5749
5750	<result name="VBOX_E_INVALID_VM_STATE">
5751	Virtual machine is not mutable.
5752	</result>
5753	<result name="VBOX_E_OBJECT_NOT_FOUND">
5754	Shared folder @a name does not exist.
5755	</result>
5756
5757	</desc>
5758	<param name="name" type="wstring" dir="in">
5759	<desc>Logical name of the shared folder to remove.</desc>
5760	</param>
5761	</method>
5762
5763	<method name="canShowConsoleWindow">
5764	<desc>
5765	Returns @c true if the VM console process can activate the
5766	console window and bring it to foreground on the desktop of
5767	the host PC.
5768	<note>
5769	This method will fail if a session for this machine is not
5770	currently open.
5771	</note>
5772
5773	<result name="VBOX_E_INVALID_VM_STATE">
5774	Machine session is not open.
5775	</result>
5776
5777	</desc>
5778	<param name="canShow" type="boolean" dir="return">
5779	<desc>
5780	@c true if the console window can be shown and @c false otherwise.
5781	</desc>
5782	</param>
5783	</method>
5784
5785	<method name="showConsoleWindow">
5786	<desc>
5787	Activates the console window and brings it to foreground on
5788	the desktop of the host PC. Many modern window managers on
5789	many platforms implement some sort of focus stealing
5790	prevention logic, so that it may be impossible to activate
5791	a window without the help of the currently active
5792	application. In this case, this method will return a non-zero
5793	identifier that represents the top-level window of the VM
5794	console process. The caller, if it represents a currently
5795	active process, is responsible to use this identifier (in a
5796	platform-dependent manner) to perform actual window
5797	activation.
5798	<note>
5799	This method will fail if a session for this machine is not
5800	currently open.
5801	</note>
5802
5803	<result name="VBOX_E_INVALID_VM_STATE">
5804	Machine session is not open.
5805	</result>
5806
5807	</desc>
5808	<param name="winId" type="unsigned long long" dir="return">
5809	<desc>
5810	Platform-dependent identifier of the top-level VM console
5811	window, or zero if this method has performed all actions
5812	necessary to implement the <i>show window</i> semantics for
5813	the given platform and/or VirtualBox front-end.
5814	</desc>
5815	</param>
5816	</method>
5817
5818	<method name="getGuestProperty">
5819	<desc>
5820	Reads an entry from the machine's guest property store.
5821
5822	<result name="VBOX_E_INVALID_VM_STATE">
5823	Machine session is not open.
5824	</result>
5825
5826	</desc>
5827	<param name="name" type="wstring" dir="in">
5828	<desc>
5829	The name of the property to read.
5830	</desc>
5831	</param>
5832	<param name="value" type="wstring" dir="out">
5833	<desc>
5834	The value of the property. If the property does not exist then this
5835	will be empty.
5836	</desc>
5837	</param>
5838	<param name="timestamp" type="unsigned long long" dir="out">
5839	<desc>
5840	The time at which the property was last modified, as seen by the
5841	server process.
5842	</desc>
5843	</param>
5844	<param name="flags" type="wstring" dir="out">
5845	<desc>
5846	Additional property parameters, passed as a comma-separated list of
5847	"name=value" type entries.
5848	</desc>
5849	</param>
5850	</method>
5851
5852	<method name="getGuestPropertyValue">
5853	<desc>
5854	Reads a value from the machine's guest property store.
5855
5856	<result name="VBOX_E_INVALID_VM_STATE">
5857	Machine session is not open.
5858	</result>
5859
5860	</desc>
5861	<param name="property" type="wstring" dir="in">
5862	<desc>
5863	The name of the property to read.
5864	</desc>
5865	</param>
5866	<param name="value" type="wstring" dir="return">
5867	<desc>
5868	The value of the property. If the property does not exist then this
5869	will be empty.
5870	</desc>
5871	</param>
5872	</method>
5873
5874	<method name="getGuestPropertyTimestamp">
5875	<desc>
5876	Reads a property timestamp from the machine's guest property store.
5877
5878	<result name="VBOX_E_INVALID_VM_STATE">
5879	Machine session is not open.
5880	</result>
5881
5882	</desc>
5883	<param name="property" type="wstring" dir="in">
5884	<desc>
5885	The name of the property to read.
5886	</desc>
5887	</param>
5888	<param name="value" type="unsigned long long" dir="return">
5889	<desc>
5890	The timestamp. If the property does not exist then this will be
5891	empty.
5892	</desc>
5893	</param>
5894	</method>
5895
5896	<method name="setGuestProperty">
5897	<desc>
5898	Sets, changes or deletes an entry in the machine's guest property
5899	store.
5900
5901	<result name="E_ACCESSDENIED">
5902	Property cannot be changed.
5903	</result>
5904	<result name="E_INVALIDARG">
5905	Invalid @a flags.
5906	</result>
5907	<result name="VBOX_E_INVALID_VM_STATE">
5908	Virtual machine is not mutable or session not open.
5909	</result>
5910	<result name="VBOX_E_INVALID_OBJECT_STATE">
5911	Cannot set transient property when machine not running.
5912	</result>
5913
5914	</desc>
5915	<param name="property" type="wstring" dir="in">
5916	<desc>
5917	The name of the property to set, change or delete.
5918	</desc>
5919	</param>
5920	<param name="value" type="wstring" dir="in">
5921	<desc>
5922	The new value of the property to set, change or delete. If the
5923	property does not yet exist and value is non-empty, it will be
5924	created. If the value is @c null or empty, the property will be
5925	deleted if it exists.
5926	</desc>
5927	</param>
5928	<param name="flags" type="wstring" dir="in">
5929	<desc>
5930	Additional property parameters, passed as a comma-separated list of
5931	"name=value" type entries.
5932	</desc>
5933	</param>
5934	</method>
5935
5936	<method name="setGuestPropertyValue">
5937	<desc>
5938	Sets, changes or deletes a value in the machine's guest property
5939	store. The flags field will be left unchanged or created empty for a
5940	new property.
5941
5942	<result name="E_ACCESSDENIED">
5943	Property cannot be changed.
5944	</result>
5945	<result name="VBOX_E_INVALID_VM_STATE">
5946	Virtual machine is not mutable or session not open.
5947	</result>
5948	<result name="VBOX_E_INVALID_OBJECT_STATE">
5949	Cannot set transient property when machine not running.
5950	</result>
5951	</desc>
5952
5953	<param name="property" type="wstring" dir="in">
5954	<desc>
5955	The name of the property to set, change or delete.
5956	</desc>
5957	</param>
5958	<param name="value" type="wstring" dir="in">
5959	<desc>
5960	The new value of the property to set, change or delete. If the
5961	property does not yet exist and value is non-empty, it will be
5962	created. If the value is @c null or empty, the property will be
5963	deleted if it exists.
5964	</desc>
5965	</param>
5966	</method>
5967
5968	<method name="enumerateGuestProperties">
5969	<desc>
5970	Return a list of the guest properties matching a set of patterns along
5971	with their values, time stamps and flags.
5972	</desc>
5973	<param name="patterns" type="wstring" dir="in">
5974	<desc>
5975	The patterns to match the properties against, separated by '\|'
5976	characters. If this is empty or @c null, all properties will match.
5977	</desc>
5978	</param>
5979	<param name="name" type="wstring" dir="out" safearray="yes">
5980	<desc>
5981	The names of the properties returned.
5982	</desc>
5983	</param>
5984	<param name="value" type="wstring" dir="out" safearray="yes">
5985	<desc>
5986	The values of the properties returned. The array entries match the
5987	corresponding entries in the @a name array.
5988	</desc>
5989	</param>
5990	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
5991	<desc>
5992	The time stamps of the properties returned. The array entries match
5993	the corresponding entries in the @a name array.
5994	</desc>
5995	</param>
5996	<param name="flags" type="wstring" dir="out" safearray="yes">
5997	<desc>
5998	The flags of the properties returned. The array entries match the
5999	corresponding entries in the @a name array.
6000	</desc>
6001	</param>
6002	</method>
6003
6004	<method name="querySavedThumbnailSize">
6005	<desc>
6006	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
6007	</desc>
6008	<param name="size" type="unsigned long" dir="out">
6009	<desc>
6010	Size of buffer required to store the bitmap.
6011	</desc>
6012	</param>
6013	<param name="width" type="unsigned long" dir="out">
6014	<desc>
6015	Bitmap width.
6016	</desc>
6017	</param>
6018	<param name="height" type="unsigned long" dir="out">
6019	<desc>
6020	Bitmap height.
6021	</desc>
6022	</param>
6023	</method>
6024
6025	<method name="readSavedThumbnailToArray">
6026	<desc>
6027	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
6028	</desc>
6029	<param name="BGR" type="boolean" dir="in">
6030	<desc>
6031	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6032	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
6033	</desc>
6034	</param>
6035	<param name="width" type="unsigned long" dir="out">
6036	<desc>
6037	Bitmap width.
6038	</desc>
6039	</param>
6040	<param name="height" type="unsigned long" dir="out">
6041	<desc>
6042	Bitmap height.
6043	</desc>
6044	</param>
6045	<param name="data" type="octet" dir="return" safearray="yes">
6046	<desc>
6047	Array with resulting bitmap data.
6048	</desc>
6049	</param>
6050	</method>
6051
6052	<method name="querySavedScreenshotPNGSize">
6053	<desc>
6054	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6055	</desc>
6056	<param name="size" type="unsigned long" dir="out">
6057	<desc>
6058	Size of buffer required to store the PNG binary data.
6059	</desc>
6060	</param>
6061	<param name="width" type="unsigned long" dir="out">
6062	<desc>
6063	Image width.
6064	</desc>
6065	</param>
6066	<param name="height" type="unsigned long" dir="out">
6067	<desc>
6068	Image height.
6069	</desc>
6070	</param>
6071	</method>
6072
6073	<method name="readSavedScreenshotPNGToArray">
6074	<desc>
6075	Screenshot in PNG format is retrieved to an array of bytes.
6076	</desc>
6077	<param name="width" type="unsigned long" dir="out">
6078	<desc>
6079	Image width.
6080	</desc>
6081	</param>
6082	<param name="height" type="unsigned long" dir="out">
6083	<desc>
6084	Image height.
6085	</desc>
6086	</param>
6087	<param name="data" type="octet" dir="return" safearray="yes">
6088	<desc>
6089	Array with resulting PNG data.
6090	</desc>
6091	</param>
6092	</method>
6093
6094	<method name="HotPlugCPU">
6095	<desc>
6096	Plugs a CPU into the machine.
6097	</desc>
6098	<param name="cpu" type="unsigned long" dir="in">
6099	<desc>
6100	The CPU id to insert.
6101	</desc>
6102	</param>
6103	</method>
6104
6105	<method name="HotUnplugCPU">
6106	<desc>
6107	Removes a CPU from the machine.
6108	</desc>
6109	<param name="cpu" type="unsigned long" dir="in">
6110	<desc>
6111	The CPU id to remove.
6112	</desc>
6113	</param>
6114	</method>
6115
6116	<method name="GetCPUStatus">
6117	<desc>
6118	Plugs a CPU into the machine.
6119	</desc>
6120	<param name="cpu" type="unsigned long" dir="in">
6121	<desc>
6122	The CPU id to check for.
6123	</desc>
6124	</param>
6125	<param name="attached" type="boolean" dir="return">
6126	<desc>
6127	Status of the CPU.
6128	</desc>
6129	</param>
6130	</method>
6131	</interface>
6132
6133	<!--
6134	// IConsole
6135	/////////////////////////////////////////////////////////////////////////
6136	-->
6137
6138	<interface
6139	name="IConsoleCallback" extends="$unknown"
6140	uuid="60703f8d-81e4-4b45-a147-dcfd07692b19"
6141	wsmap="suppress"
6142	>
6143
6144	<desc>
6145	This interface is used by a client of the Main API that need to
6146	be notified of events. For example, a graphical user interface
6147	can use this to learn about machine state changes so they can
6148	update the list of virtual machines without having to rely
6149	on polling.
6150
6151	Whenever relevant events occur in VirtualBox, the callbacks in
6152	objects of this interface are called. In order for this to be
6153	useful, a client needs to create its own subclass that implements
6154	this interface in which the methods for the relevant callbacks
6155	are overridden. An instance of this subclass interface can then
6156	be passed to <link to="IConsole::registerCallback" />.
6157	</desc>
6158
6159	<method name="onMousePointerShapeChange">
6160	<desc>
6161	Notification when the guest mouse pointer shape has
6162	changed. The new shape data is given.
6163	</desc>
6164	<param name="visible" type="boolean" dir="in">
6165	<desc>
6166	Flag whether the pointer is visible.
6167	</desc>
6168	</param>
6169	<param name="alpha" type="boolean" dir="in">
6170	<desc>
6171	Flag whether the pointer has an alpha channel.
6172	</desc>
6173	</param>
6174	<param name="xHot" type="unsigned long" dir="in">
6175	<desc>
6176	The pointer hot spot x coordinate.
6177	</desc>
6178	</param>
6179	<param name="yHot" type="unsigned long" dir="in">
6180	<desc>
6181	The pointer hot spot y coordinate.
6182	</desc>
6183	</param>
6184	<param name="width" type="unsigned long" dir="in">
6185	<desc>
6186	Width of the pointer shape in pixels.
6187	</desc>
6188	</param>
6189	<param name="height" type="unsigned long" dir="in">
6190	<desc>
6191	Height of the pointer shape in pixels.
6192	</desc>
6193	</param>
6194	<param name="shape" type="octet" mod="ptr" dir="in">
6195	<desc>
6196	Address of the shape buffer.
6197
6198	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
6199	followed by a 32-bpp XOR (color) mask.
6200
6201	For pointers without alpha channel the XOR mask pixels are 32
6202	bit values: (lsb)BGR0(msb). For pointers with alpha channel
6203	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
6204
6205	An AND mask is used for pointers with alpha channel, so if the
6206	callback does not support alpha, the pointer could be
6207	displayed as a normal color pointer.
6208
6209	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
6210	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
6211	height</tt>. The padding bits at the end of each scanline are
6212	undefined.
6213
6214	The XOR mask follows the AND mask on the next 4-byte aligned
6215	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
6216	Bytes in the gap between the AND and the XOR mask are undefined.
6217	The XOR mask scanlines have no gap between them and the size of
6218	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
6219
6220	<note>
6221	If @a shape is 0, only the pointer visibility is changed.
6222	</note>
6223	</desc>
6224	</param>
6225	</method>
6226
6227	<method name="onMouseCapabilityChange">
6228	<desc>
6229	Notification when the mouse capabilities reported by the
6230	guest have changed. The new capabilities are passed.
6231	</desc>
6232	<param name="supportsAbsolute" type="boolean" dir="in"/>
6233	<param name="supportsRelative" type="boolean" dir="in"/>
6234	<param name="needsHostCursor" type="boolean" dir="in"/>
6235	</method>
6236
6237	<method name="onKeyboardLedsChange">
6238	<desc>
6239	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
6240	to alter the state of the keyboard LEDs.
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	</desc>
6252	<param name="state" type="MachineState" dir="in"/>
6253	</method>
6254
6255	<method name="onAdditionsStateChange">
6256	<desc>
6257	Notification when a Guest Additions property changes.
6258	Interested callees should query IGuest attributes to
6259	find out what has changed.
6260	</desc>
6261	</method>
6262
6263	<method name="onNetworkAdapterChange">
6264	<desc>
6265	Notification when a property of one of the
6266	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
6267	changes. Interested callees should use INetworkAdapter methods and
6268	attributes to find out what has changed.
6269	</desc>
6270	<param name="networkAdapter" type="INetworkAdapter" dir="in">
6271	<desc>Network adapter that is subject to change.</desc>
6272	</param>
6273	</method>
6274
6275	<method name="onSerialPortChange">
6276	<desc>
6277	Notification when a property of one of the
6278	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
6279	Interested callees should use ISerialPort methods and attributes
6280	to find out what has changed.
6281	</desc>
6282	<param name="serialPort" type="ISerialPort" dir="in">
6283	<desc>Serial port that is subject to change.</desc>
6284	</param>
6285	</method>
6286
6287	<method name="onParallelPortChange">
6288	<desc>
6289	Notification when a property of one of the
6290	virtual <link to="IMachine::getParallelPort">parallel ports</link>
6291	changes. Interested callees should use ISerialPort methods and
6292	attributes to find out what has changed.
6293	</desc>
6294	<param name="parallelPort" type="IParallelPort" dir="in">
6295	<desc>Parallel port that is subject to change.</desc>
6296	</param>
6297	</method>
6298
6299	<method name="onStorageControllerChange">
6300	<desc>
6301	Notification when a property of one of the
6302	virtual <link to="IMachine::storageControllers">storage controllers</link>
6303	changes. Interested callees should query the corresponding collections
6304	to find out what has changed.
6305	</desc>
6306	</method>
6307
6308	<method name="onMediumChange">
6309	<desc>
6310	Notification when a
6311	<link to="IMachine::mediumAttachments">medium attachment</link>
6312	changes.
6313	</desc>
6314	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
6315	<desc>Medium attachment that is subject to change.</desc>
6316	</param>
6317	</method>
6318
6319	<method name="onCPUChange">
6320	<desc>
6321	Notification when a CPU changes.
6322	</desc>
6323	<param name="cpu" type="unsigned long" dir="in">
6324	<desc>The CPU which changed</desc>
6325	</param>
6326	<param name="add" type="boolean" dir="in">
6327	<desc>Flag whether the CPU was added or removed</desc>
6328	</param>
6329	</method>
6330
6331	<method name="onVRDPServerChange">
6332	<desc>
6333	Notification when a property of the
6334	<link to="IMachine::VRDPServer">VRDP server</link> changes.
6335	Interested callees should use IVRDPServer methods and attributes to
6336	find out what has changed.
6337	</desc>
6338	</method>
6339
6340	<method name="onRemoteDisplayInfoChange">
6341	<desc>
6342	Notification when the status of the VRDP server changes. Interested callees
6343	should use <link to="IConsole::RemoteDisplayInfo">IRemoteDisplayInfo</link>
6344	attributes to find out what is the current status.
6345	</desc>
6346	</method>
6347
6348	<method name="onUSBControllerChange">
6349	<desc>
6350	Notification when a property of the virtual
6351	<link to="IMachine::USBController">USB controller</link> changes.
6352	Interested callees should use IUSBController methods and attributes to
6353	find out what has changed.
6354	</desc>
6355	</method>
6356
6357	<method name="onUSBDeviceStateChange">
6358	<desc>
6359	Notification when a USB device is attached to or detached from
6360	the virtual USB controller.
6361
6362	This notification is sent as a result of the indirect
6363	request to attach the device because it matches one of the
6364	machine USB filters, or as a result of the direct request
6365	issued by <link to="IConsole::attachUSBDevice"/> or
6366	<link to="IConsole::detachUSBDevice"/>.
6367
6368	This notification is sent in case of both a succeeded and a
6369	failed request completion. When the request succeeds, the
6370	@a error parameter is @c null, and the given device has been
6371	already added to (when @a attached is @c true) or removed from
6372	(when @a attached is @c false) the collection represented by
6373	<link to="IConsole::USBDevices"/>. On failure, the collection
6374	doesn't change and the @a error parameter represents the error
6375	message describing the failure.
6376
6377	</desc>
6378	<param name="device" type="IUSBDevice" dir="in">
6379	<desc>Device that is subject to state change.</desc>
6380	</param>
6381	<param name="attached" type="boolean" dir="in">
6382	<desc>
6383	@c true if the device was attached and @c false otherwise.
6384	</desc>
6385	</param>
6386	<param name="error" type="IVirtualBoxErrorInfo" dir="in">
6387	<desc>
6388	@c null on success or an error message object on failure.
6389	</desc>
6390	</param>
6391	</method>
6392
6393	<method name="onSharedFolderChange">
6394	<desc>
6395	Notification when a shared folder is added or removed.
6396	The @a scope argument defines one of three scopes:
6397	<link to="IVirtualBox::sharedFolders">global shared folders</link>
6398	(<link to="Scope_Global">Global</link>),
6399	<link to="IMachine::sharedFolders">permanent shared folders</link> of
6400	the machine (<link to="Scope_Machine">Machine</link>) or <link
6401	to="IConsole::sharedFolders">transient shared folders</link> of the
6402	machine (<link to="Scope_Session">Session</link>). Interested callees
6403	should use query the corresponding collections to find out what has
6404	changed.
6405	</desc>
6406	<param name="scope" type="Scope" dir="in">
6407	<desc>Scope of the notification.</desc>
6408	</param>
6409	</method>
6410
6411	<method name="onRuntimeError">
6412	<desc>
6413	Notification when an error happens during the virtual
6414	machine execution.
6415
6416	There are three kinds of runtime errors:
6417	<ul>
6418	<li><i>fatal</i></li>
6419	<li><i>non-fatal with retry</i></li>
6420	<li><i>non-fatal warnings</i></li>
6421	</ul>
6422
6423	<b>Fatal</b> errors are indicated by the @a fatal parameter set
6424	to @c true. In case of fatal errors, the virtual machine
6425	execution is always paused before calling this notification, and
6426	the notification handler is supposed either to immediately save
6427	the virtual machine state using <link to="IConsole::saveState"/>
6428	or power it off using <link to="IConsole::powerDown"/>.
6429	Resuming the execution can lead to unpredictable results.
6430
6431	<b>Non-fatal</b> errors and warnings are indicated by the
6432	@a fatal parameter set to @c false. If the virtual machine
6433	is in the Paused state by the time the error notification is
6434	received, it means that the user can <i>try to resume</i> the machine
6435	execution after attempting to solve the problem that caused the
6436	error. In this case, the notification handler is supposed
6437	to show an appropriate message to the user (depending on the
6438	value of the @a id parameter) that offers several actions such
6439	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
6440	wants to retry, the notification handler should continue
6441	the machine execution using the <link to="IConsole::resume"/>
6442	call. If the machine execution is not Paused during this
6443	notification, then it means this notification is a <i>warning</i>
6444	(for example, about a fatal condition that can happen very soon);
6445	no immediate action is required from the user, the machine
6446	continues its normal execution.
6447
6448	Note that in either case the notification handler
6449	<b>must not</b> perform any action directly on a thread
6450	where this notification is called. Everything it is allowed to
6451	do is to post a message to another thread that will then talk
6452	to the user and take the corresponding action.
6453
6454	Currently, the following error identifiers are known:
6455	<ul>
6456	<li><tt>"HostMemoryLow"</tt></li>
6457	<li><tt>"HostAudioNotResponding"</tt></li>
6458	<li><tt>"VDIStorageFull"</tt></li>
6459	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
6460	</ul>
6461
6462	<note>
6463	This notification is not designed to be implemented by
6464	more than one callback at a time. If you have multiple
6465	IConsoleCallback instances registered on the given
6466	IConsole object, make sure you simply do nothing but
6467	return @c S_OK from all but one of them that does actual
6468	user notification and performs necessary actions.
6469	</note>
6470
6471	</desc>
6472	<param name="fatal" type="boolean" dir="in">
6473	<desc>Whether the error is fatal or not</desc>
6474	</param>
6475	<param name="id" type="wstring" dir="in">
6476	<desc>Error identifier</desc>
6477	</param>
6478	<param name="message" type="wstring" dir="in">
6479	<desc>Optional error message</desc>
6480	</param>
6481	</method>
6482
6483	<method name="onCanShowWindow">
6484	<desc>
6485	Notification when a call to
6486	<link to="IMachine::canShowConsoleWindow"/> is made by a
6487	front-end to check if a subsequent call to
6488	<link to="IMachine::showConsoleWindow"/> can succeed.
6489
6490	The callee should give an answer appropriate to the current
6491	machine state in the @a canShow argument. This answer must
6492	remain valid at least until the next
6493	<link to="IConsole::state">machine state</link> change.
6494
6495	<note>
6496	This notification is not designed to be implemented by
6497	more than one callback at a time. If you have multiple
6498	IConsoleCallback instances registered on the given
6499	IConsole object, make sure you simply do nothing but
6500	return @c true and @c S_OK from all but one of them that
6501	actually manages console window activation.
6502	</note>
6503	</desc>
6504	<param name="canShow" type="boolean" dir="return">
6505	<desc>
6506	@c true if the console window can be shown and @c false otherwise.
6507	</desc>
6508	</param>
6509	</method>
6510
6511	<method name="onShowWindow">
6512	<desc>
6513	Notification when a call to
6514	<link to="IMachine::showConsoleWindow"/>
6515	requests the console window to be activated and brought to
6516	foreground on the desktop of the host PC.
6517
6518	This notification should cause the VM console process to
6519	perform the requested action as described above. If it is
6520	impossible to do it at a time of this notification, this
6521	method should return a failure.
6522
6523	Note that many modern window managers on many platforms
6524	implement some sort of focus stealing prevention logic, so
6525	that it may be impossible to activate a window without the
6526	help of the currently active application (which is supposedly
6527	an initiator of this notification). In this case, this method
6528	must return a non-zero identifier that represents the
6529	top-level window of the VM console process. The caller, if it
6530	represents a currently active process, is responsible to use
6531	this identifier (in a platform-dependent manner) to perform
6532	actual window activation.
6533
6534	This method must set @a winId to zero if it has performed all
6535	actions necessary to complete the request and the console
6536	window is now active and in foreground, to indicate that no
6537	further action is required on the caller's side.
6538
6539	<note>
6540	This notification is not designed to be implemented by
6541	more than one callback at a time. If you have multiple
6542	IConsoleCallback instances registered on the given
6543	IConsole object, make sure you simply do nothing but
6544	return @c S_OK from all but one of them that actually
6545	manages console window activation.
6546	</note>
6547	</desc>
6548	<param name="winId" type="unsigned long long" dir="return">
6549	<desc>
6550	Platform-dependent identifier of the top-level VM console
6551	window, or zero if this method has performed all actions
6552	necessary to implement the <i>show window</i> semantics for
6553	the given platform and/or this VirtualBox front-end.
6554	</desc>
6555	</param>
6556	</method>
6557
6558	</interface>
6559
6560	<interface
6561	name="IRemoteDisplayInfo" extends="$unknown"
6562	uuid="b3741084-806f-4c3b-8c42-ebad1a81e45a"
6563	wsmap="struct"
6564	>
6565	<desc>
6566	Contains information about the remote display (VRDP) capabilities and status.
6567	This is used in the <link to="IConsole::remoteDisplayInfo" /> attribute.
6568	</desc>
6569
6570	<attribute name="active" type="boolean" readonly="yes">
6571	<desc>
6572	Whether the remote display connection is active.
6573	</desc>
6574	</attribute>
6575
6576	<attribute name="port" type="long" readonly="yes">
6577	<desc>
6578	VRDP server port number. If this property is equal to <tt>0</tt>, then
6579	the VRDP server failed to start, usually because there are no free TCP
6580	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDP
6581	server has not yet been started.
6582	</desc>
6583	</attribute>
6584
6585	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6586	<desc>
6587	How many times a client connected.
6588	</desc>
6589	</attribute>
6590
6591	<attribute name="beginTime" type="long long" readonly="yes">
6592	<desc>
6593	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6594	</desc>
6595	</attribute>
6596
6597	<attribute name="endTime" type="long long" readonly="yes">
6598	<desc>
6599	When the last connection was terminated or the current time, if
6600	connection is still active, in milliseconds since 1970-01-01 UTC.
6601	</desc>
6602	</attribute>
6603
6604	<attribute name="bytesSent" type="unsigned long long" readonly="yes">
6605	<desc>
6606	How many bytes were sent in last or current, if still active, connection.
6607	</desc>
6608	</attribute>
6609
6610	<attribute name="bytesSentTotal" type="unsigned long long" readonly="yes">
6611	<desc>
6612	How many bytes were sent in all connections.
6613	</desc>
6614	</attribute>
6615
6616	<attribute name="bytesReceived" type="unsigned long long" readonly="yes">
6617	<desc>
6618	How many bytes were received in last or current, if still active, connection.
6619	</desc>
6620	</attribute>
6621
6622	<attribute name="bytesReceivedTotal" type="unsigned long long" readonly="yes">
6623	<desc>
6624	How many bytes were received in all connections.
6625	</desc>
6626	</attribute>
6627
6628	<attribute name="user" type="wstring" readonly="yes">
6629	<desc>
6630	Login user name supplied by the client.
6631	</desc>
6632	</attribute>
6633
6634	<attribute name="domain" type="wstring" readonly="yes">
6635	<desc>
6636	Login domain name supplied by the client.
6637	</desc>
6638	</attribute>
6639
6640	<attribute name="clientName" type="wstring" readonly="yes">
6641	<desc>
6642	The client name supplied by the client.
6643	</desc>
6644	</attribute>
6645
6646	<attribute name="clientIP" type="wstring" readonly="yes">
6647	<desc>
6648	The IP address of the client.
6649	</desc>
6650	</attribute>
6651
6652	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6653	<desc>
6654	The client software version number.
6655	</desc>
6656	</attribute>
6657
6658	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6659	<desc>
6660	Public key exchange method used when connection was established.
6661	Values: 0 - RDP4 public key exchange scheme.
6662	1 - X509 certificates were sent to client.
6663	</desc>
6664	</attribute>
6665
6666	</interface>
6667
6668	<interface
6669	name="IConsole" extends="$unknown"
6670	uuid="6375231a-c17c-464b-92cb-ae9e128d71c3"
6671	wsmap="managed"
6672	>
6673	<desc>
6674	The IConsole interface represents an interface to control virtual
6675	machine execution.
6676
6677	The console object that implements the IConsole interface is obtained
6678	from a session object after the session for the given machine has been
6679	opened using one of <link to="IVirtualBox::openSession"/>,
6680	<link to="IVirtualBox::openRemoteSession"/> or
6681	<link to="IVirtualBox::openExistingSession"/> methods.
6682
6683	Methods of the IConsole interface allow the caller to query the current
6684	virtual machine execution state, pause the machine or power it down, save
6685	the machine state or take a snapshot, attach and detach removable media
6686	and so on.
6687
6688	<see>ISession</see>
6689	</desc>
6690
6691	<attribute name="machine" type="IMachine" readonly="yes">
6692	<desc>
6693	Machine object this console is sessioned with.
6694	<note>
6695	This is a convenience property, it has the same value as
6696	<link to="ISession::machine"/> of the corresponding session
6697	object.
6698	</note>
6699	</desc>
6700	</attribute>
6701
6702	<attribute name="state" type="MachineState" readonly="yes">
6703	<desc>
6704	Current execution state of the machine.
6705	<note>
6706	This property always returns the same value as the corresponding
6707	property of the IMachine object this console is sessioned with.
6708	For the process that owns (executes) the VM, this is the
6709	preferable way of querying the VM state, because no IPC
6710	calls are made.
6711	</note>
6712	</desc>
6713	</attribute>
6714
6715	<attribute name="guest" type="IGuest" readonly="yes">
6716	<desc>Guest object.</desc>
6717	</attribute>
6718
6719	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6720	<desc>
6721	Virtual keyboard object.
6722	<note>
6723	If the machine is not running, any attempt to use
6724	the returned object will result in an error.
6725	</note>
6726	</desc>
6727	</attribute>
6728
6729	<attribute name="mouse" type="IMouse" readonly="yes">
6730	<desc>
6731	Virtual mouse object.
6732	<note>
6733	If the machine is not running, any attempt to use
6734	the returned object will result in an error.
6735	</note>
6736	</desc>
6737	</attribute>
6738
6739	<attribute name="display" type="IDisplay" readonly="yes">
6740	<desc>Virtual display object.
6741	<note>
6742	If the machine is not running, any attempt to use
6743	the returned object will result in an error.
6744	</note>
6745	</desc>
6746	</attribute>
6747
6748	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6749	<desc>Debugging interface.</desc>
6750	</attribute>
6751
6752	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6753	<desc>
6754	Collection of USB devices currently attached to the virtual
6755	USB controller.
6756	<note>
6757	The collection is empty if the machine is not running.
6758	</note>
6759	</desc>
6760	</attribute>
6761
6762	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6763	<desc>
6764	List of USB devices currently attached to the remote VRDP client.
6765	Once a new device is physically attached to the remote host computer,
6766	it appears in this list and remains there until detached.
6767	</desc>
6768	</attribute>
6769
6770	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6771	<desc>
6772	Collection of shared folders for the current session. These folders
6773	are called transient shared folders because they are available to the
6774	guest OS running inside the associated virtual machine only for the
6775	duration of the session (as opposed to
6776	<link to="IMachine::sharedFolders"/> which represent permanent shared
6777	folders). When the session is closed (e.g. the machine is powered down),
6778	these folders are automatically discarded.
6779
6780	New shared folders are added to the collection using
6781	<link to="#createSharedFolder"/>. Existing shared folders can be
6782	removed using <link to="#removeSharedFolder"/>.
6783	</desc>
6784	</attribute>
6785
6786	<attribute name="remoteDisplayInfo" type="IRemoteDisplayInfo" readonly="yes">
6787	<desc>
6788	Interface that provides information on Remote Display (VRDP) connection.
6789	</desc>
6790	</attribute>
6791
6792	<method name="powerUp">
6793	<desc>
6794	Starts the virtual machine execution using the current machine
6795	state (that is, its current execution state, current settings and
6796	current storage devices).
6797
6798	If the machine is powered off or aborted, the execution will
6799	start from the beginning (as if the real hardware were just
6800	powered on).
6801
6802	If the machine is in the <link to="MachineState_Saved"/> state,
6803	it will continue its execution the point where the state has
6804	been saved.
6805
6806	<note>
6807	Unless you are trying to write a new VirtualBox front-end that
6808	performs direct machine execution (like the VirtualBox or VBoxSDL
6809	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
6810	session opened by <link to="IVirtualBox::openSession"/> and use this
6811	session only to change virtual machine settings. If you simply want to
6812	start virtual machine execution using one of the existing front-ends
6813	(for example the VirtualBox GUI or headless server), simply use
6814	<link to="IVirtualBox::openRemoteSession"/>; these front-ends will
6815	power up the machine automatically for you.
6816	</note>
6817
6818	<see>#saveState</see>
6819	<result name="VBOX_E_INVALID_VM_STATE">
6820	Virtual machine already running.
6821	</result>
6822	<result name="VBOX_E_HOST_ERROR">
6823	Host interface does not exist or name not set.
6824	</result>
6825	<result name="VBOX_E_FILE_ERROR">
6826	Invalid saved state file.
6827	</result>
6828	</desc>
6829	<param name="progress" type="IProgress" dir="return">
6830	<desc>Progress object to track the operation completion.</desc>
6831	</param>
6832	</method>
6833
6834	<method name="powerUpPaused">
6835	<desc>
6836	Identical to powerUp except that the VM will enter the
6837	<link to="MachineState_Paused"/> state, instead of
6838	<link to="MachineState_Running"/>.
6839
6840	<see>#powerUp</see>
6841	<result name="VBOX_E_INVALID_VM_STATE">
6842	Virtual machine already running.
6843	</result>
6844	<result name="VBOX_E_HOST_ERROR">
6845	Host interface does not exist or name not set.
6846	</result>
6847	<result name="VBOX_E_FILE_ERROR">
6848	Invalid saved state file.
6849	</result>
6850	</desc>
6851	<param name="progress" type="IProgress" dir="return">
6852	<desc>Progress object to track the operation completion.</desc>
6853	</param>
6854	</method>
6855
6856	<method name="powerDown">
6857	<desc>
6858	Initiates the power down procedure to stop the virtual machine
6859	execution.
6860
6861	The completion of the power down procedure is tracked using the returned
6862	IProgress object. After the operation is complete, the machine will go
6863	to the PoweredOff state.
6864	<result name="VBOX_E_INVALID_VM_STATE">
6865	Virtual machine must be Running, Paused or Stuck to be powered down.
6866	</result>
6867	</desc>
6868	<param name="progress" type="IProgress" dir="return">
6869	<desc>Progress object to track the operation completion.</desc>
6870	</param>
6871	</method>
6872
6873	<method name="reset">
6874	<desc>Resets the virtual machine.
6875	<result name="VBOX_E_INVALID_VM_STATE">
6876	Virtual machine not in Running state.
6877	</result>
6878	<result name="VBOX_E_VM_ERROR">
6879	Virtual machine error in reset operation.
6880	</result>
6881	</desc>
6882	</method>
6883
6884	<method name="pause">
6885	<desc>Pauses the virtual machine execution.
6886	<result name="VBOX_E_INVALID_VM_STATE">
6887	Virtual machine not in Running state.
6888	</result>
6889	<result name="VBOX_E_VM_ERROR">
6890	Virtual machine error in suspend operation.
6891	</result>
6892	</desc>
6893	</method>
6894
6895	<method name="resume">
6896	<desc>Resumes the virtual machine execution.
6897	<result name="VBOX_E_INVALID_VM_STATE">
6898	Virtual machine not in Paused state.
6899	</result>
6900	<result name="VBOX_E_VM_ERROR">
6901	Virtual machine error in resume operation.
6902	</result>
6903	</desc>
6904	</method>
6905
6906	<method name="powerButton">
6907	<desc>Sends the ACPI power button event to the guest.
6908	<result name="VBOX_E_INVALID_VM_STATE">
6909	Virtual machine not in Running state.
6910	</result>
6911	<result name="VBOX_E_PDM_ERROR">
6912	Controlled power off failed.
6913	</result>
6914	</desc>
6915	</method>
6916
6917	<method name="sleepButton">
6918	<desc>Sends the ACPI sleep button event to the guest.
6919	<result name="VBOX_E_INVALID_VM_STATE">
6920	Virtual machine not in Running state.
6921	</result>
6922	<result name="VBOX_E_PDM_ERROR">
6923	Sending sleep button event failed.
6924	</result>
6925	</desc>
6926	</method>
6927
6928	<method name="getPowerButtonHandled">
6929	<desc>Checks if the last power button event was handled by guest.
6930	<result name="VBOX_E_PDM_ERROR">
6931	Checking if the event was handled by the guest OS failed.
6932	</result>
6933	</desc>
6934	<param name="handled" type="boolean" dir="return"/>
6935	</method>
6936
6937	<method name="getGuestEnteredACPIMode">
6938	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6939	G1 (sleeping). If this method returns @c false, the guest will
6940	most likely not respond to external ACPI events.
6941	<result name="VBOX_E_INVALID_VM_STATE">
6942	Virtual machine not in Running state.
6943	</result>
6944	</desc>
6945	<param name="entered" type="boolean" dir="return"/>
6946	</method>
6947
6948	<method name="saveState">
6949	<desc>
6950	Saves the current execution state of a running virtual machine
6951	and stops its execution.
6952
6953	After this operation completes, the machine will go to the
6954	Saved state. Next time it is powered up, this state will
6955	be restored and the machine will continue its execution from
6956	the place where it was saved.
6957
6958	This operation differs from taking a snapshot to the effect
6959	that it doesn't create new differencing media. Also, once
6960	the machine is powered up from the state saved using this method,
6961	the saved state is deleted, so it will be impossible to return
6962	to this state later.
6963
6964	<note>
6965	On success, this method implicitly calls
6966	<link to="IMachine::saveSettings"/> to save all current machine
6967	settings (including runtime changes to the DVD medium, etc.).
6968	Together with the impossibility to change any VM settings when it is
6969	in the Saved state, this guarantees adequate hardware
6970	configuration of the machine when it is restored from the saved
6971	state file.
6972	</note>
6973
6974	<note>
6975	The machine must be in the Running or Paused state, otherwise
6976	the operation will fail.
6977	</note>
6978	<result name="VBOX_E_INVALID_VM_STATE">
6979	Virtual machine state neither Running nor Paused.
6980	</result>
6981	<result name="VBOX_E_FILE_ERROR">
6982	Failed to create directory for saved state file.
6983	</result>
6984
6985	<see><link to="#takeSnapshot"/></see>
6986	</desc>
6987	<param name="progress" type="IProgress" dir="return">
6988	<desc>Progress object to track the operation completion.</desc>
6989	</param>
6990	</method>
6991
6992	<method name="adoptSavedState">
6993	<desc>
6994	Associates the given saved state file to the virtual machine.
6995
6996	On success, the machine will go to the Saved state. Next time it is
6997	powered up, it will be restored from the adopted saved state and
6998	continue execution from the place where the saved state file was
6999	created.
7000
7001	The specified saved state file path may be absolute or relative to the
7002	folder the VM normally saves the state to (usually,
7003	<link to="IMachine::snapshotFolder"/>).
7004
7005	<note>
7006	It's a caller's responsibility to make sure the given saved state
7007	file is compatible with the settings of this virtual machine that
7008	represent its virtual hardware (memory size, storage disk configuration
7009	etc.). If there is a mismatch, the behavior of the virtual machine
7010	is undefined.
7011	</note>
7012	<result name="VBOX_E_INVALID_VM_STATE">
7013	Virtual machine state neither PoweredOff nor Aborted.
7014	</result>
7015	</desc>
7016	<param name="savedStateFile" type="wstring" dir="in">
7017	<desc>Path to the saved state file to adopt.</desc>
7018	</param>
7019	</method>
7020
7021	<method name="forgetSavedState">
7022	<desc>
7023	Forgets the saved state of the virtual machine previously created
7024	by <link to="#saveState"/>. Next time the machine is powered up, a
7025	clean boot will occur. If @a remove is @c true the saved state file
7026	is deleted.
7027	<note>
7028	This operation is equivalent to resetting or powering off
7029	the machine without doing a proper shutdown in the guest OS.
7030	</note>
7031	<result name="VBOX_E_INVALID_VM_STATE">
7032	Virtual machine not in state Saved.
7033	</result>
7034	</desc>
7035	<param name="remove" type="boolean" dir="in">
7036	<desc>If @c true remove the saved state file.</desc>
7037	</param>
7038	</method>
7039
7040	<method name="getDeviceActivity">
7041	<desc>
7042	Gets the current activity type of a given device or device group.
7043	<result name="E_INVALIDARG">
7044	Invalid device type.
7045	</result>
7046	</desc>
7047	<param name="type" type="DeviceType" dir="in"/>
7048	<param name="activity" type="DeviceActivity" dir="return"/>
7049	</method>
7050
7051	<method name="attachUSBDevice">
7052	<desc>
7053	Attaches a host USB device with the given UUID to the
7054	USB controller of the virtual machine.
7055
7056	The device needs to be in one of the following states:
7057	<link to="USBDeviceState_Busy"/>,
7058	<link to="USBDeviceState_Available"/> or
7059	<link to="USBDeviceState_Held"/>,
7060	otherwise an error is immediately returned.
7061
7062	When the device state is
7063	<link to="USBDeviceState_Busy">Busy</link>, an error may also
7064	be returned if the host computer refuses to release it for some reason.
7065
7066	<see>IUSBController::deviceFilters, USBDeviceState</see>
7067	<result name="VBOX_E_INVALID_VM_STATE">
7068	Virtual machine state neither Running nor Paused.
7069	</result>
7070	<result name="VBOX_E_PDM_ERROR">
7071	Virtual machine does not have a USB controller.
7072	</result>
7073	</desc>
7074	<param name="id" type="uuid" mod="string" dir="in">
7075	<desc>UUID of the host USB device to attach.</desc>
7076	</param>
7077	</method>
7078
7079	<method name="detachUSBDevice">
7080	<desc>
7081	Detaches an USB device with the given UUID from the USB controller
7082	of the virtual machine.
7083
7084	After this method succeeds, the VirtualBox server re-initiates
7085	all USB filters as if the device were just physically attached
7086	to the host, but filters of this machine are ignored to avoid
7087	a possible automatic re-attachment.
7088
7089	<see>IUSBController::deviceFilters, USBDeviceState</see>
7090
7091	<result name="VBOX_E_PDM_ERROR">
7092	Virtual machine does not have a USB controller.
7093	</result>
7094	<result name="E_INVALIDARG">
7095	USB device not attached to this virtual machine.
7096	</result>
7097	</desc>
7098	<param name="id" type="uuid" mod="string" dir="in">
7099	<desc>UUID of the USB device to detach.</desc>
7100	</param>
7101	<param name="device" type="IUSBDevice" dir="return">
7102	<desc>Detached USB device.</desc>
7103	</param>
7104	</method>
7105
7106	<method name="findUSBDeviceByAddress">
7107	<desc>
7108	Searches for a USB device with the given host address.
7109
7110	<result name="VBOX_E_OBJECT_NOT_FOUND">
7111	Given @c name does not correspond to any USB device.
7112	</result>
7113
7114	<see>IUSBDevice::address</see>
7115	</desc>
7116	<param name="name" type="wstring" dir="in">
7117	<desc>
7118	Address of the USB device (as assigned by the host) to
7119	search for.
7120	</desc>
7121	</param>
7122	<param name="device" type="IUSBDevice" dir="return">
7123	<desc>Found USB device object.</desc>
7124	</param>
7125	</method>
7126
7127	<method name="findUSBDeviceById">
7128	<desc>
7129	Searches for a USB device with the given UUID.
7130
7131	<result name="VBOX_E_OBJECT_NOT_FOUND">
7132	Given @c id does not correspond to any USB device.
7133	</result>
7134
7135	<see>IUSBDevice::id</see>
7136	</desc>
7137	<param name="id" type="uuid" mod="string" dir="in">
7138	<desc>UUID of the USB device to search for.</desc>
7139	</param>
7140	<param name="device" type="IUSBDevice" dir="return">
7141	<desc>Found USB device object.</desc>
7142	</param>
7143	</method>
7144
7145	<method name="createSharedFolder">
7146	<desc>
7147	Creates a transient new shared folder by associating the given logical
7148	name with the given host path, adds it to the collection of shared
7149	folders and starts sharing it. Refer to the description of
7150	<link to="ISharedFolder"/> to read more about logical names.
7151
7152	<result name="VBOX_E_INVALID_VM_STATE">
7153	Virtual machine in Saved state or currently changing state.
7154	</result>
7155	<result name="VBOX_E_FILE_ERROR">
7156	Shared folder already exists or not accessible.
7157	</result>
7158	</desc>
7159	<param name="name" type="wstring" dir="in">
7160	<desc>Unique logical name of the shared folder.</desc>
7161	</param>
7162	<param name="hostPath" type="wstring" dir="in">
7163	<desc>Full path to the shared folder in the host file system.</desc>
7164	</param>
7165	<param name="writable" type="boolean" dir="in">
7166	<desc>Whether the share is writable or readonly</desc>
7167	</param>
7168	</method>
7169
7170	<method name="removeSharedFolder">
7171	<desc>
7172	Removes a transient shared folder with the given name previously
7173	created by <link to="#createSharedFolder"/> from the collection of
7174	shared folders and stops sharing it.
7175	<result name="VBOX_E_INVALID_VM_STATE">
7176	Virtual machine in Saved state or currently changing state.
7177	</result>
7178	<result name="VBOX_E_FILE_ERROR">
7179	Shared folder does not exists.
7180	</result>
7181	</desc>
7182	<param name="name" type="wstring" dir="in">
7183	<desc>Logical name of the shared folder to remove.</desc>
7184	</param>
7185	</method>
7186
7187	<method name="takeSnapshot">
7188	<desc>
7189	Saves the current execution state
7190	and all settings of the machine and creates differencing images
7191	for all normal (non-independent) media.
7192	See <link to="ISnapshot" /> for an introduction to snapshots.
7193
7194	This method can be called for a PoweredOff, Saved (see
7195	<link to="#saveState"/>), Running or
7196	Paused virtual machine. When the machine is PoweredOff, an
7197	offline snapshot is created. When the machine is Running a live
7198	snapshot is created, and an online snapshot is is created when Paused.
7199
7200	The taken snapshot is always based on the
7201	<link to="IMachine::currentSnapshot">current snapshot</link>
7202	of the associated virtual machine and becomes a new current snapshot.
7203
7204	<note>
7205	This method implicitly calls <link to="IMachine::saveSettings"/> to
7206	save all current machine settings before taking an offline snapshot.
7207	</note>
7208
7209	<result name="VBOX_E_INVALID_VM_STATE">
7210	Virtual machine currently changing state.
7211	</result>
7212	</desc>
7213	<param name="name" type="wstring" dir="in">
7214	<desc>Short name for the snapshot.</desc>
7215	</param>
7216	<param name="description" type="wstring" dir="in">
7217	<desc>Optional description of the snapshot.</desc>
7218	</param>
7219	<param name="progress" type="IProgress" dir="return">
7220	<desc>Progress object to track the operation completion.</desc>
7221	</param>
7222	</method>
7223
7224	<method name="deleteSnapshot">
7225	<desc>
7226	Starts deleting the specified snapshot asynchronously.
7227	See <link to="ISnapshot" /> for an introduction to snapshots.
7228
7229	The execution state and settings of the associated machine stored in
7230	the snapshot will be deleted. The contents of all differencing media of
7231	this snapshot will be merged with the contents of their dependent child
7232	media to keep the medium chain valid (in other words, all changes
7233	represented by media being discarded will be propagated to their child
7234	medium). After that, this snapshot's differencing medium will be
7235	deleted. The parent of this snapshot will become a new parent for all
7236	its child snapshots.
7237
7238	If the deleted snapshot is the current one, its parent snapshot will
7239	become a new current snapshot. The current machine state is not directly
7240	affected in this case, except that currently attached differencing
7241	media based on media of the discarded snapshot will be also merged as
7242	described above.
7243
7244	If the deleted snapshot is the first or current snapshot, then the
7245	respective IMachine attributes will be adjusted. Deleting the current
7246	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7247	to make all current machine settings permanent.
7248
7249	Deleting a snapshot has the following preconditions:
7250
7251	<ul>
7252	<li>Child media of all normal media of the discarded snapshot
7253	must be accessible (see <link to="IMedium::state"/>) for this
7254	operation to succeed. In particular, this means that all virtual
7255	machines, whose media are directly or indirectly based on the
7256	media of discarded snapshot, must be powered off.</li>
7257
7258	<li>You cannot delete the snapshot if a medium attached to it has
7259	more than once child medium (differencing images) because otherwise
7260	merging would be impossible. This might be the case if there is
7261	more than one child snapshot or differencing images were created
7262	for other reason (e.g. implicitly because of multiple machine
7263	attachments).</li>
7264	</ul>
7265
7266
7267	The virtual machine's <link to="IMachine::state">state</link> is changed to "DeletingSnapshot"
7268	while this operation is in progress.
7269
7270	<note>
7271	Merging medium contents can be very time and disk space
7272	consuming, if these media are big in size and have many
7273	children. However, if the snapshot being discarded is the last
7274	(head) snapshot on the branch, the operation will be rather
7275	quick.
7276	</note>
7277	<result name="VBOX_E_INVALID_VM_STATE">
7278	Virtual machine is running.
7279	</result>
7280	</desc>
7281	<param name="id" type="uuid" mod="string" dir="in">
7282	<desc>UUID of the snapshot to discard.</desc>
7283	</param>
7284	<param name="progress" type="IProgress" dir="return">
7285	<desc>Progress object to track the operation completion.</desc>
7286	</param>
7287	</method>
7288
7289	<method name="restoreSnapshot">
7290	<desc>
7291	Starts resetting the machine's current state to the state contained
7292	in the given snapshot, asynchronously. All current settings of the
7293	machine will be reset and changes stored in differencing media
7294	will be lost.
7295	See <link to="ISnapshot" /> for an introduction to snapshots.
7296
7297	After this operation is successfully completed, new empty differencing
7298	media are created for all normal media of the machine.
7299
7300	If the given snapshot is an online snapshot, the machine will go to
7301	the <link to="MachineState_Saved"> saved state</link>, so that the
7302	next time it is powered on, the execution state will be restored
7303	from the state of the snapshot.
7304
7305	<note>
7306	The machine must not be running, otherwise the operation will fail.
7307	</note>
7308
7309	<note>
7310	If the machine state is <link to="MachineState_Saved">Saved</link>
7311	prior to this operation, the saved state file will be implicitly
7312	discarded (as if <link to="IConsole::forgetSavedState"/> were
7313	called).
7314	</note>
7315
7316	<result name="VBOX_E_INVALID_VM_STATE">
7317	Virtual machine is running.
7318	</result>
7319	</desc>
7320	<param name="snapshot" type="ISnapshot" dir="in">
7321	<desc>The snapshot to restore the VM state from.</desc>
7322	</param>
7323	<param name="progress" type="IProgress" dir="return">
7324	<desc>Progress object to track the operation completion.</desc>
7325	</param>
7326	</method>
7327
7328	<method name="teleport">
7329	<desc>
7330	Teleport the VM to a different host machine or process.
7331
7332	TODO explain the details.
7333
7334	<result name="VBOX_E_INVALID_VM_STATE">
7335	Virtual machine not running or paused.
7336	</result>
7337	</desc>
7338	<param name="hostname" type="wstring" dir="in">
7339	<desc>The name or IP of the host to teleport to.</desc>
7340	</param>
7341	<param name="tcpport" type="unsigned long" dir="in">
7342	<desc>The TCP port to connect to (1..65535).</desc>
7343	</param>
7344	<param name="password" type="wstring" dir="in">
7345	<desc>The password.</desc>
7346	</param>
7347	<param name="maxDowntime" type="unsigned long" dir="in">
7348	<desc>
7349	The maximum allowed downtime given as milliseconds. 0 is not a valid
7350	value. Recommended value: 250 ms.
7351
7352	The higher the value is, the greater the chance for a successful
7353	teleportation. A small value may easily result in the teleportation
7354	process taking hours and eventually fail.
7355
7356	<note>
7357	The current implementation treats this a guideline, not as an
7358	absolute rule.
7359	</note>
7360	</desc>
7361	</param>
7362	<param name="progress" type="IProgress" dir="return">
7363	<desc>Progress object to track the operation completion.</desc>
7364	</param>
7365	</method>
7366
7367	<method name="registerCallback">
7368	<desc>
7369	Registers a new console callback on this instance. The methods of the
7370	callback interface will be called by this instance when the appropriate
7371	event occurs.
7372	</desc>
7373	<param name="callback" type="IConsoleCallback" dir="in"/>
7374	</method>
7375
7376	<method name="unregisterCallback">
7377	<desc>
7378	Unregisters the console callback previously registered using
7379	<link to="#registerCallback"/>.
7380	<result name="E_INVALIDARG">
7381	Given @a callback handler is not registered.
7382	</result>
7383	</desc>
7384	<param name="callback" type="IConsoleCallback" dir="in"/>
7385	</method>
7386	</interface>
7387
7388	<!--
7389	// IHost
7390	/////////////////////////////////////////////////////////////////////////
7391	-->
7392
7393	<enum
7394	name="HostNetworkInterfaceMediumType"
7395	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7396	>
7397	<desc>
7398	Type of encapsulation. Ethernet encapsulation includes both wired and
7399	wireless Ethernet connections.
7400	<see>IHostNetworkInterface</see>
7401	</desc>
7402
7403	<const name="Unknown" value="0">
7404	<desc>
7405	The type of interface cannot be determined.
7406	</desc>
7407	</const>
7408	<const name="Ethernet" value="1">
7409	<desc>
7410	Ethernet frame encapsulation.
7411	</desc>
7412	</const>
7413	<const name="PPP" value="2">
7414	<desc>
7415	Point-to-point protocol encapsulation.
7416	</desc>
7417	</const>
7418	<const name="SLIP" value="3">
7419	<desc>
7420	Serial line IP encapsulation.
7421	</desc>
7422	</const>
7423	</enum>
7424
7425	<enum
7426	name="HostNetworkInterfaceStatus"
7427	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7428	>
7429	<desc>
7430	Current status of the interface.
7431	<see>IHostNetworkInterface</see>
7432	</desc>
7433
7434	<const name="Unknown" value="0">
7435	<desc>
7436	The state of interface cannot be determined.
7437	</desc>
7438	</const>
7439	<const name="Up" value="1">
7440	<desc>
7441	The interface is fully operational.
7442	</desc>
7443	</const>
7444	<const name="Down" value="2">
7445	<desc>
7446	The interface is not functioning.
7447	</desc>
7448	</const>
7449	</enum>
7450
7451	<enum
7452	name="HostNetworkInterfaceType"
7453	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7454	>
7455	<desc>
7456	Network interface type.
7457	</desc>
7458	<const name="Bridged" value="1"/>
7459	<const name="HostOnly" value="2"/>
7460	</enum>
7461
7462	<interface
7463	name="IHostNetworkInterface" extends="$unknown"
7464	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7465	wsmap="managed"
7466	>
7467	<desc>
7468	Represents one of host's network interfaces. IP V6 address and network
7469	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7470	separated by colons.
7471	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7472	</desc>
7473	<attribute name="name" type="wstring" readonly="yes">
7474	<desc>Returns the host network interface name.</desc>
7475	</attribute>
7476
7477	<attribute name="id" type="uuid" mod="string" readonly="yes">
7478	<desc>Returns the interface UUID.</desc>
7479	</attribute>
7480
7481	<attribute name="networkName" type="wstring" readonly="yes">
7482	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7483	</attribute>
7484
7485	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7486	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7487	</attribute>
7488
7489	<attribute name="IPAddress" type="wstring" readonly="yes">
7490	<desc>Returns the IP V4 address of the interface.</desc>
7491	</attribute>
7492
7493	<attribute name="networkMask" type="wstring" readonly="yes">
7494	<desc>Returns the network mask of the interface.</desc>
7495	</attribute>
7496
7497	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7498	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7499	</attribute>
7500
7501	<attribute name="IPV6Address" type="wstring" readonly="yes">
7502	<desc>Returns the IP V6 address of the interface.</desc>
7503	</attribute>
7504
7505	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7506	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7507	</attribute>
7508
7509	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7510	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7511	</attribute>
7512
7513	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7514	<desc>Type of protocol encapsulation used.</desc>
7515	</attribute>
7516
7517	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7518	<desc>Status of the interface.</desc>
7519	</attribute>
7520
7521	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7522	<desc>specifies the host interface type.</desc>
7523	</attribute>
7524
7525	<method name="enableStaticIpConfig">
7526	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7527	<param name="IPAddress" type="wstring" dir="in">
7528	<desc>
7529	IP address.
7530	</desc>
7531	</param>
7532	<param name="networkMask" type="wstring" dir="in">
7533	<desc>
7534	network mask.
7535	</desc>
7536	</param>
7537	</method>
7538
7539	<method name="enableStaticIpConfigV6">
7540	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7541	<param name="IPV6Address" type="wstring" dir="in">
7542	<desc>
7543	IP address.
7544	</desc>
7545	</param>
7546	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7547	<desc>
7548	network mask.
7549	</desc>
7550	</param>
7551	</method>
7552
7553	<method name="enableDynamicIpConfig">
7554	<desc>enables the dynamic IP configuration.</desc>
7555	</method>
7556
7557	<method name="dhcpRediscover">
7558	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7559	</method>
7560
7561	</interface>
7562
7563	<interface
7564	name="IHost" extends="$unknown"
7565	uuid="e380cbfc-ae65-4fa6-899e-45ded6b3132a"
7566	wsmap="managed"
7567	>
7568	<desc>
7569	The IHost interface represents the physical machine that this VirtualBox
7570	installation runs on.
7571
7572	An object implementing this interface is returned by the
7573	<link to="IVirtualBox::host" /> attribute. This interface contains
7574	read-only information about the host's physical hardware (such as what
7575	processors and disks are available, what the host operating system is,
7576	and so on) and also allows for manipulating some of the host's hardware,
7577	such as global USB device filters and host interface networking.
7578
7579	</desc>
7580	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7581	<desc>List of DVD drives available on the host.</desc>
7582	</attribute>
7583
7584	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7585	<desc>List of floppy drives available on the host.</desc>
7586	</attribute>
7587
7588	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7589	<desc>
7590	List of USB devices currently attached to the host.
7591	Once a new device is physically attached to the host computer,
7592	it appears in this list and remains there until detached.
7593
7594	<note>
7595	If USB functionality is not available in the given edition of
7596	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7597	</note>
7598	</desc>
7599	</attribute>
7600
7601	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7602	<desc>
7603	List of USB device filters in action.
7604	When a new device is physically attached to the host computer,
7605	filters from this list are applied to it (in order they are stored
7606	in the list). The first matched filter will determine the
7607	<link to="IHostUSBDeviceFilter::action">action</link>
7608	performed on the device.
7609
7610	Unless the device is ignored by these filters, filters of all
7611	currently running virtual machines
7612	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7613
7614	<note>
7615	If USB functionality is not available in the given edition of
7616	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7617	</note>
7618
7619	<see>IHostUSBDeviceFilter, USBDeviceState</see>
7620	</desc>
7621	</attribute>
7622
7623	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7624	<desc>List of host network interfaces currently defined on the host.</desc>
7625	</attribute>
7626
7627	<attribute name="processorCount" type="unsigned long" readonly="yes">
7628	<desc>Number of (logical) CPUs installed in the host system.</desc>
7629	</attribute>
7630
7631	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7632	<desc>Number of (logical) CPUs online in the host system.</desc>
7633	</attribute>
7634
7635	<method name="getProcessorSpeed">
7636	<desc>Query the (approximate) maximum speed of a specified host CPU in
7637	Megahertz.
7638	</desc>
7639	<param name="cpuId" type="unsigned long" dir="in">
7640	<desc>
7641	Identifier of the CPU.
7642	</desc>
7643	</param>
7644	<param name="speed" type="unsigned long" dir="return">
7645	<desc>
7646	Speed value. 0 is returned if value is not known or @a cpuId is
7647	invalid.
7648	</desc>
7649	</param>
7650	</method>
7651
7652	<method name="getProcessorFeature">
7653	<desc>Query whether a CPU feature is supported or not.</desc>
7654	<param name="feature" type="ProcessorFeature" dir="in">
7655	<desc>
7656	CPU Feature identifier.
7657	</desc>
7658	</param>
7659	<param name="supported" type="boolean" dir="return">
7660	<desc>
7661	Feature is supported or not.
7662	</desc>
7663	</param>
7664	</method>
7665
7666	<method name="getProcessorDescription">
7667	<desc>Query the model string of a specified host CPU.
7668	</desc>
7669	<param name="cpuId" type="unsigned long" dir="in">
7670	<desc>
7671	Identifier of the CPU.
7672	<note>
7673	The current implementation might not necessarily return the
7674	description for this exact CPU.
7675	</note>
7676	</desc>
7677	</param>
7678	<param name="description" type="wstring" dir="return">
7679	<desc>
7680	Model string. An empty string is returned if value is not known or
7681	@a cpuId is invalid.
7682	</desc>
7683	</param>
7684	</method>
7685
7686	<method name="getProcessorCpuIdLeaf">
7687	<desc>
7688	Returns the CPU cpuid information for the specified leaf.
7689	</desc>
7690	<param name="cpuId" type="unsigned long" dir="in">
7691	<desc>
7692	Identifier of the CPU. The CPU most be online.
7693	<note>
7694	The current implementation might not necessarily return the
7695	description for this exact CPU.
7696	</note>
7697	</desc>
7698	</param>
7699	<param name="leaf" type="unsigned long" dir="in">
7700	<desc>
7701	Cpuid leaf index (eax).
7702	</desc>
7703	</param>
7704	<param name="subLeaf" type="unsigned long" dir="in">
7705	<desc>
7706	Cpuid leaf sub index (ecx). This currently only applies to cache
7707	information on Intel CPUs. Use 0 if retriving values for
7708	<link to="IMachine::setCpuIdLeaf"/>.
7709	</desc>
7710	</param>
7711	<param name="valEax" type="unsigned long" dir="out">
7712	<desc>
7713	Cpuid leaf value for register eax.
7714	</desc>
7715	</param>
7716	<param name="valEbx" type="unsigned long" dir="out">
7717	<desc>
7718	Cpuid leaf value for register ebx.
7719	</desc>
7720	</param>
7721	<param name="valEcx" type="unsigned long" dir="out">
7722	<desc>
7723	Cpuid leaf value for register ecx.
7724	</desc>
7725	</param>
7726	<param name="valEdx" type="unsigned long" dir="out">
7727	<desc>
7728	Cpuid leaf value for register edx.
7729	</desc>
7730	</param>
7731	</method>
7732
7733	<attribute name="memorySize" type="unsigned long" readonly="yes">
7734	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7735	</attribute>
7736
7737	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7738	<desc>Available system memory in the host system.</desc>
7739	</attribute>
7740
7741	<attribute name="operatingSystem" type="wstring" readonly="yes">
7742	<desc>Name of the host system's operating system.</desc>
7743	</attribute>
7744
7745	<attribute name="OSVersion" type="wstring" readonly="yes">
7746	<desc>Host operating system's version string.</desc>
7747	</attribute>
7748
7749	<attribute name="UTCTime" type="long long" readonly="yes">
7750	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7751	</attribute>
7752
7753	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7754	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7755	</attribute>
7756
7757	<method name="createHostOnlyNetworkInterface">
7758	<desc>
7759	Creates a new adapter for Host Only Networking.
7760	<result name="E_INVALIDARG">
7761	Host network interface @a name already exists.
7762	</result>
7763	</desc>
7764	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7765	<desc>
7766	Created host interface object.
7767	</desc>
7768	</param>
7769	<param name="progress" type="IProgress" dir="return">
7770	<desc>
7771	Progress object to track the operation completion.
7772	</desc>
7773	</param>
7774	</method>
7775
7776	<method name="removeHostOnlyNetworkInterface">
7777	<desc>
7778	Removes the given Host Only Networking interface.
7779	<result name="VBOX_E_OBJECT_NOT_FOUND">
7780	No host network interface matching @a id found.
7781	</result>
7782	</desc>
7783	<param name="id" type="uuid" mod="string" dir="in">
7784	<desc>
7785	Adapter GUID.
7786	</desc>
7787	</param>
7788	<param name="progress" type="IProgress" dir="return">
7789	<desc>
7790	Progress object to track the operation completion.
7791	</desc>
7792	</param>
7793	</method>
7794
7795	<method name="createUSBDeviceFilter">
7796	<desc>
7797	Creates a new USB device filter. All attributes except
7798	the filter name are set to empty (any match),
7799	<i>active</i> is @c false (the filter is not active).
7800
7801	The created filter can be added to the list of filters using
7802	<link to="#insertUSBDeviceFilter"/>.
7803
7804	<see>#USBDeviceFilters</see>
7805	</desc>
7806	<param name="name" type="wstring" dir="in">
7807	<desc>
7808	Filter name. See <link to="IHostUSBDeviceFilter::name"/>
7809	for more info.
7810	</desc>
7811	</param>
7812	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7813	<desc>Created filter object.</desc>
7814	</param>
7815	</method>
7816
7817	<method name="insertUSBDeviceFilter">
7818	<desc>
7819	Inserts the given USB device to the specified position
7820	in the list of filters.
7821
7822	Positions are numbered starting from @c 0. If the specified
7823	position is equal to or greater than the number of elements in
7824	the list, the filter is added at the end of the collection.
7825
7826	<note>
7827	Duplicates are not allowed, so an attempt to insert a
7828	filter already in the list is an error.
7829	</note>
7830	<note>
7831	If USB functionality is not available in the given edition of
7832	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7833	</note>
7834
7835	<see>#USBDeviceFilters</see>
7836
7837	<result name="VBOX_E_INVALID_OBJECT_STATE">
7838	USB device filter is not created within this VirtualBox instance.
7839	</result>
7840	<result name="E_INVALIDARG">
7841	USB device filter already in list.
7842	</result>
7843
7844	</desc>
7845	<param name="position" type="unsigned long" dir="in">
7846	<desc>Position to insert the filter to.</desc>
7847	</param>
7848	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7849	<desc>USB device filter to insert.</desc>
7850	</param>
7851	</method>
7852
7853	<method name="removeUSBDeviceFilter">
7854	<desc>
7855	Removes a USB device filter from the specified position in the
7856	list of filters.
7857
7858	Positions are numbered starting from @c 0. Specifying a
7859	position equal to or greater than the number of elements in
7860	the list will produce an error.
7861
7862	<note>
7863	If USB functionality is not available in the given edition of
7864	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7865	</note>
7866
7867	<see>#USBDeviceFilters</see>
7868
7869	<result name="E_INVALIDARG">
7870	USB device filter list empty or invalid @a position.
7871	</result>
7872
7873	</desc>
7874	<param name="position" type="unsigned long" dir="in">
7875	<desc>Position to remove the filter from.</desc>
7876	</param>
7877	</method>
7878
7879	<method name="findHostDVDDrive">
7880	<desc>
7881	Searches for a host DVD drive with the given @c name.
7882
7883	<result name="VBOX_E_OBJECT_NOT_FOUND">
7884	Given @c name does not correspond to any host drive.
7885	</result>
7886
7887	</desc>
7888	<param name="name" type="wstring" dir="in">
7889	<desc>Name of the host drive to search for</desc>
7890	</param>
7891	<param name="drive" type="IMedium" dir="return">
7892	<desc>Found host drive object</desc>
7893	</param>
7894	</method>
7895
7896	<method name="findHostFloppyDrive">
7897	<desc>
7898	Searches for a host floppy drive with the given @c name.
7899
7900	<result name="VBOX_E_OBJECT_NOT_FOUND">
7901	Given @c name does not correspond to any host floppy drive.
7902	</result>
7903
7904	</desc>
7905	<param name="name" type="wstring" dir="in">
7906	<desc>Name of the host floppy drive to search for</desc>
7907	</param>
7908	<param name="drive" type="IMedium" dir="return">
7909	<desc>Found host floppy drive object</desc>
7910	</param>
7911	</method>
7912
7913	<method name="findHostNetworkInterfaceByName">
7914	<desc>
7915	Searches through all host network interfaces for an interface with
7916	the given @c name.
7917	<note>
7918	The method returns an error if the given @c name does not
7919	correspond to any host network interface.
7920	</note>
7921	</desc>
7922	<param name="name" type="wstring" dir="in">
7923	<desc>Name of the host network interface to search for.</desc>
7924	</param>
7925	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7926	<desc>Found host network interface object.</desc>
7927	</param>
7928	</method>
7929	<method name="findHostNetworkInterfaceById">
7930	<desc>
7931	Searches through all host network interfaces for an interface with
7932	the given GUID.
7933	<note>
7934	The method returns an error if the given GUID does not
7935	correspond to any host network interface.
7936	</note>
7937	</desc>
7938	<param name="id" type="uuid" mod="string" dir="in">
7939	<desc>GUID of the host network interface to search for.</desc>
7940	</param>
7941	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7942	<desc>Found host network interface object.</desc>
7943	</param>
7944	</method>
7945	<method name="findHostNetworkInterfacesOfType">
7946	<desc>
7947	Searches through all host network interfaces and returns a list of interfaces of the specified type
7948	</desc>
7949	<param name="type" type="HostNetworkInterfaceType" dir="in">
7950	<desc>type of the host network interfaces to search for.</desc>
7951	</param>
7952	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7953	<desc>Found host network interface objects.</desc>
7954	</param>
7955	</method>
7956
7957	<method name="findUSBDeviceById">
7958	<desc>
7959	Searches for a USB device with the given UUID.
7960
7961	<result name="VBOX_E_OBJECT_NOT_FOUND">
7962	Given @c id does not correspond to any USB device.
7963	</result>
7964
7965	<see>IHostUSBDevice::id</see>
7966	</desc>
7967	<param name="id" type="uuid" mod="string" dir="in">
7968	<desc>UUID of the USB device to search for.</desc>
7969	</param>
7970	<param name="device" type="IHostUSBDevice" dir="return">
7971	<desc>Found USB device object.</desc>
7972	</param>
7973	</method>
7974
7975	<method name="findUSBDeviceByAddress">
7976	<desc>
7977	Searches for a USB device with the given host address.
7978
7979	<result name="VBOX_E_OBJECT_NOT_FOUND">
7980	Given @c name does not correspond to any USB device.
7981	</result>
7982
7983	<see>IHostUSBDevice::address</see>
7984	</desc>
7985	<param name="name" type="wstring" dir="in">
7986	<desc>
7987	Address of the USB device (as assigned by the host) to
7988	search for.
7989	</desc>
7990	</param>
7991	<param name="device" type="IHostUSBDevice" dir="return">
7992	<desc>Found USB device object.</desc>
7993	</param>
7994	</method>
7995
7996	</interface>
7997
7998	<!--
7999	// ISystemProperties
8000	/////////////////////////////////////////////////////////////////////////
8001	-->
8002
8003	<interface
8004	name="ISystemProperties"
8005	extends="$unknown"
8006	uuid="fca0d89c-d2ce-45c1-a7b9-e6e7d8501eb1"
8007	wsmap="managed"
8008	>
8009	<desc>
8010	The ISystemProperties interface represents global properties of the given
8011	VirtualBox installation.
8012
8013	These properties define limits and default values for various attributes
8014	and parameters. Most of the properties are read-only, but some can be
8015	changed by a user.
8016	</desc>
8017
8018	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
8019	<desc>Minimum guest system memory in Megabytes.</desc>
8020	</attribute>
8021
8022	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
8023	<desc>Maximum guest system memory in Megabytes.</desc>
8024	</attribute>
8025
8026	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
8027	<desc>Minimum guest video memory in Megabytes.</desc>
8028	</attribute>
8029
8030	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
8031	<desc>Maximum guest video memory in Megabytes.</desc>
8032	</attribute>
8033
8034	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
8035	<desc>Minimum CPU count.</desc>
8036	</attribute>
8037
8038	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
8039	<desc>Maximum CPU count.</desc>
8040	</attribute>
8041
8042	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
8043	<desc>Maximum of monitors which could be connected.</desc>
8044	</attribute>
8045
8046	<attribute name="maxVDISize" type="unsigned long long" readonly="yes">
8047	<desc>Maximum size of a virtual disk image in Megabytes.</desc>
8048	</attribute>
8049
8050	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
8051	<desc>
8052	Number of network adapters associated with every
8053	<link to="IMachine"/> instance.
8054	</desc>
8055	</attribute>
8056
8057	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
8058	<desc>
8059	Number of serial ports associated with every
8060	<link to="IMachine"/> instance.
8061	</desc>
8062	</attribute>
8063
8064	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
8065	<desc>
8066	Number of parallel ports associated with every
8067	<link to="IMachine"/> instance.
8068	</desc>
8069	</attribute>
8070
8071	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
8072	<desc>
8073	Maximum device position in the boot order. This value corresponds
8074	to the total number of devices a machine can boot from, to make it
8075	possible to include all possible devices to the boot list.
8076	<see><link to="IMachine::setBootOrder"/></see>
8077	</desc>
8078	</attribute>
8079
8080	<attribute name="defaultMachineFolder" type="wstring">
8081	<desc>
8082	Full path to the default directory used to create new or open
8083	existing machines when a settings file name contains no
8084	path.
8085
8086	The initial value of this property is
8087	<tt><</tt><link to="IVirtualBox::homeFolder">
8088	VirtualBox_home</link><tt>>/Machines</tt>.
8089
8090	<note>
8091	Setting this property to @c null or an empty string will restore the
8092	initial value.
8093	</note>
8094	<note>
8095	When settings this property, the specified path can be
8096	absolute (full path) or relative
8097	to the <link to="IVirtualBox::homeFolder">
8098	VirtualBox home directory</link>.
8099	When reading this property, a full path is
8100	always returned.
8101	</note>
8102	<note>
8103	The specified path may not exist, it will be created
8104	when necessary.
8105	</note>
8106
8107	<see>
8108	<link to="IVirtualBox::createMachine"/>,
8109	<link to="IVirtualBox::openMachine"/>
8110	</see>
8111	</desc>
8112	</attribute>
8113
8114	<attribute name="defaultHardDiskFolder" type="wstring">
8115	<desc>
8116	Full path to the default directory used to create new or open existing
8117	virtual disks.
8118
8119	This path is used when the storage unit of a hard disk is a regular file
8120	in the host's file system and only a file name that contains no path is
8121	given.
8122
8123	The initial value of this property is
8124	<tt><</tt>
8125	<link to="IVirtualBox::homeFolder">VirtualBox_home</link>
8126	<tt>>/HardDisks</tt>.
8127
8128	<note>
8129	Setting this property to @c null or empty string will restore the
8130	initial value.
8131	</note>
8132	<note>
8133	When settings this property, the specified path can be relative
8134	to the
8135	<link to="IVirtualBox::homeFolder">VirtualBox home directory</link> or
8136	absolute. When reading this property, a full path is
8137	always returned.
8138	</note>
8139	<note>
8140	The specified path may not exist, it will be created
8141	when necessary.
8142	</note>
8143
8144	<see>
8145	IMedium,
8146	<link to="IVirtualBox::createHardDisk"/>,
8147	<link to="IVirtualBox::openHardDisk"/>,
8148	<link to="IMedium::location"/>
8149	</see>
8150	</desc>
8151	</attribute>
8152
8153	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
8154	<desc>
8155	List of all medium storage formats supported by this VirtualBox
8156	installation.
8157
8158	Keep in mind that the medium format identifier
8159	(<link to="IMediumFormat::id"/>) used in other API calls like
8160	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
8161	medium format is a case-insensitive string. This means that, for
8162	example, all of the following strings:
8163	<pre>
8164	"VDI"
8165	"vdi"
8166	"VdI"</pre>
8167	refer to the same medium format.
8168
8169	Note that the virtual medium framework is backend-based, therefore
8170	the list of supported formats depends on what backends are currently
8171	installed.
8172
8173	<see>
8174	<link to="IMediumFormat"/>,
8175	</see>
8176	</desc>
8177	</attribute>
8178
8179	<attribute name="defaultHardDiskFormat" type="wstring">
8180	<desc>
8181	Identifier of the default medium format used by VirtualBox.
8182
8183	The medium format set by this attribute is used by VirtualBox
8184	when the medium format was not specified explicitly. One example is
8185	<link to="IVirtualBox::createHardDisk"/> with the empty
8186	format argument. A more complex example is implicit creation of
8187	differencing media when taking a snapshot of a virtual machine:
8188	this operation will try to use a format of the parent medium first
8189	and if this format does not support differencing media the default
8190	format specified by this argument will be used.
8191
8192	The list of supported medium formats may be obtained by the
8193	<link to="#mediaFormats"/> call. Note that the default medium
8194	format must have a capability to create differencing media;
8195	otherwise operations that create media implicitly may fail
8196	unexpectedly.
8197
8198	The initial value of this property is <tt>"VDI"</tt> in the current
8199	version of the VirtualBox product, but may change in the future.
8200
8201	<note>
8202	Setting this property to @c null or empty string will restore the
8203	initial value.
8204	</note>
8205
8206	<see>
8207	<link to="#mediaFormats"/>,
8208	<link to="IMediumFormat::id"/>,
8209	<link to="IVirtualBox::createHardDisk"/>
8210	</see>
8211	</desc>
8212	</attribute>
8213
8214	<attribute name="remoteDisplayAuthLibrary" type="wstring">
8215	<desc>
8216	Library that provides authentication for VRDP clients. The library
8217	is used if a virtual machine's authentication type is set to "external"
8218	in the VM RemoteDisplay configuration.
8219
8220	The system library extension (".DLL" or ".so") must be omitted.
8221	A full path can be specified; if not, then the library must reside on the
8222	system's default library path.
8223
8224	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
8225	of that name in one of the default VirtualBox library directories.
8226
8227	For details about VirtualBox authentication libraries and how to implement
8228	them, please refer to the VirtualBox manual.
8229
8230	<note>
8231	Setting this property to @c null or empty string will restore the
8232	initial value.
8233	</note>
8234	</desc>
8235	</attribute>
8236
8237	<attribute name="webServiceAuthLibrary" type="wstring">
8238	<desc>
8239	Library that provides authentication for webservice clients. The library
8240	is used if a virtual machine's authentication type is set to "external"
8241	in the VM RemoteDisplay configuration and will be called from
8242	within the <link to="IWebsessionManager::logon" /> implementation.
8243
8244	As opposed to <link to="ISystemProperties::remoteDisplayAuthLibrary" />,
8245	there is no per-VM setting for this, as the webservice is a global
8246	resource (if it is running). Only for this setting (for the webservice),
8247	setting this value to a literal <tt>"null"</tt> string disables authentication,
8248	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8249	no matter what user name and password are supplied.
8250
8251	The initial value of this property is <tt>"VRDPAuth"</tt>,
8252	meaning that the webservice will use the same authentication
8253	library that is used by default for VBoxVRDP (again, see
8254	<link to="ISystemProperties::remoteDisplayAuthLibrary" />).
8255	The format and calling convention of authentication libraries
8256	is the same for the webservice as it is for VBoxVRDP.
8257
8258	<note>
8259	Setting this property to @c null or empty string will restore the
8260	initial value.
8261	</note>
8262	</desc>
8263	</attribute>
8264
8265	<attribute name="LogHistoryCount" type="unsigned long">
8266	<desc>
8267	This value specifies how many old release log files are kept.
8268	</desc>
8269	</attribute>
8270
8271	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8272	<desc>This value hold the default audio driver for the current
8273	system.</desc>
8274	</attribute>
8275
8276	<method name="getMaxDevicesPerPortForStorageBus">
8277	<desc>Returns the maximum number of devices which can be attached to a port
8278	for the given storage bus.</desc>
8279
8280	<param name="bus" type="StorageBus" dir="in">
8281	<desc>The storage bus type to get the value for.</desc>
8282	</param>
8283
8284	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8285	<desc>The maximum number of devices which can eb attached to the port for the given
8286	storage bus.</desc>
8287	</param>
8288	</method>
8289
8290	<method name="getMinPortCountForStorageBus">
8291	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8292
8293	<param name="bus" type="StorageBus" dir="in">
8294	<desc>The storage bus type to get the value for.</desc>
8295	</param>
8296
8297	<param name="minPortCount" type="unsigned long" dir="return">
8298	<desc>The minimum number of ports for the given storage bus.</desc>
8299	</param>
8300	</method>
8301
8302	<method name="getMaxPortCountForStorageBus">
8303	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8304
8305	<param name="bus" type="StorageBus" dir="in">
8306	<desc>The storage bus type to get the value for.</desc>
8307	</param>
8308
8309	<param name="maxPortCount" type="unsigned long" dir="return">
8310	<desc>The maximum number of ports for the given storage bus.</desc>
8311	</param>
8312	</method>
8313
8314	<method name="getMaxInstancesOfStorageBus">
8315	<desc>Returns the maximum number of storage bus instances which
8316	can be configured for each VM. This corresponds to the number of
8317	storage controllers one can have.</desc>
8318
8319	<param name="bus" type="StorageBus" dir="in">
8320	<desc>The storage bus type to get the value for.</desc>
8321	</param>
8322
8323	<param name="maxInstances" type="unsigned long" dir="return">
8324	<desc>The maximum number of instances for the given storage bus.</desc>
8325	</param>
8326	</method>
8327
8328	<method name="getDeviceTypesForStorageBus">
8329	<desc>Returns list of all the supported device types
8330	(<link to="DeviceType"/>) for the given type of storage
8331	bus.</desc>
8332
8333	<param name="bus" type="StorageBus" dir="in">
8334	<desc>The storage bus type to get the value for.</desc>
8335	</param>
8336
8337	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8338	<desc>The list of all supported device types for the given storage bus.</desc>
8339	</param>
8340	</method>
8341	</interface>
8342
8343	<!--
8344	// IGuest
8345	/////////////////////////////////////////////////////////////////////////
8346	-->
8347
8348	<interface
8349	name="IGuestOSType" extends="$unknown"
8350	uuid="c738a1de-3616-48d1-9ac5-8efd21e2560d"
8351	wsmap="struct"
8352	>
8353	<desc>
8354	</desc>
8355
8356	<attribute name="familyId" type="wstring" readonly="yes">
8357	<desc>Guest OS family identifier string.</desc>
8358	</attribute>
8359
8360	<attribute name="familyDescription" type="wstring" readonly="yes">
8361	<desc>Human readable description of the guest OS family.</desc>
8362	</attribute>
8363
8364	<attribute name="id" type="wstring" readonly="yes">
8365	<desc>Guest OS identifier string.</desc>
8366	</attribute>
8367
8368	<attribute name="description" type="wstring" readonly="yes">
8369	<desc>Human readable description of the guest OS.</desc>
8370	</attribute>
8371
8372	<attribute name="is64Bit" type="boolean" readonly="yes">
8373	<desc>Returns @c true if the given OS is 64-bit</desc>
8374	</attribute>
8375
8376	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8377	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8378	</attribute>
8379
8380	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8381	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8382	</attribute>
8383
8384	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8385	<desc>Recommended RAM size in Megabytes.</desc>
8386	</attribute>
8387
8388	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8389	<desc>Recommended video RAM size in Megabytes.</desc>
8390	</attribute>
8391
8392	<attribute name="recommendedHDD" type="unsigned long" readonly="yes">
8393	<desc>Recommended hard disk size in Megabytes.</desc>
8394	</attribute>
8395
8396	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8397	<desc>Returns recommended network adapter for this OS type.</desc>
8398	</attribute>
8399
8400	<attribute name="recommendedPae" type="boolean" readonly="yes">
8401	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8402	</attribute>
8403
8404	<attribute name="recommendedStorageController" type="StorageControllerType" readonly="yes">
8405	<desc>Recommended storage controller type.</desc>
8406	</attribute>
8407
8408	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8409	<desc>Recommended firmware type.</desc>
8410	</attribute>
8411
8412	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
8413	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8414	</attribute>
8415
8416	<attribute name="recommendedHpet" type="boolean" readonly="yes">
8417	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8418	</attribute>
8419
8420	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
8421	<desc>Returns @c true if using USB Tablet recommended (only relevant if using USB HIDs).</desc>
8422	</attribute>
8423
8424	</interface>
8425
8426	<interface
8427	name="IGuest" extends="$unknown"
8428	uuid="d8556fca-81bc-12af-fca3-365528fa38ca"
8429	wsmap="managed"
8430	>
8431	<desc>
8432	The IGuest interface represents information about the operating system
8433	running inside the virtual machine. Used in
8434	<link to="IConsole::guest"/>.
8435
8436	IGuest provides information about the guest operating system, whether
8437	Guest Additions are installed and other OS-specific virtual machine
8438	properties.
8439	</desc>
8440
8441	<attribute name="OSTypeId" type="wstring" readonly="yes">
8442	<desc>
8443	Identifier of the Guest OS type as reported by the Guest
8444	Additions.
8445	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8446	an IGuestOSType object representing details about the given
8447	Guest OS type.
8448	<note>
8449	If Guest Additions are not installed, this value will be
8450	the same as <link to="IMachine::OSTypeId"/>.
8451	</note>
8452	</desc>
8453	</attribute>
8454
8455	<attribute name="additionsActive" type="boolean" readonly="yes">
8456	<desc>
8457	Flag whether the Guest Additions are installed and active
8458	in which case their version will be returned by the
8459	<link to="#additionsVersion"/> property.
8460	</desc>
8461	</attribute>
8462
8463	<attribute name="additionsVersion" type="wstring" readonly="yes">
8464	<desc>
8465	Version of the Guest Additions (3 decimal numbers separated
8466	by dots) or empty when the Additions are not installed. The
8467	Additions may also report a version but yet not be active as
8468	the version might be refused by VirtualBox (incompatible) or
8469	other failures occurred.
8470	</desc>
8471	</attribute>
8472
8473	<attribute name="supportsSeamless" type="boolean" readonly="yes">
8474	<desc>
8475	Flag whether seamless guest display rendering (seamless desktop
8476	integration) is supported.
8477	</desc>
8478	</attribute>
8479
8480	<attribute name="supportsGraphics" type="boolean" readonly="yes">
8481	<desc>
8482	Flag whether the guest is in graphics mode. If it is not, then
8483	seamless rendering will not work, resize hints are not immediately
8484	acted on and guest display resizes are probably not initiated by
8485	the guest additions.
8486	</desc>
8487	</attribute>
8488
8489	<attribute name="memoryBalloonSize" type="unsigned long">
8490	<desc>Guest system memory balloon size in megabytes.</desc>
8491	</attribute>
8492
8493	<attribute name="statisticsUpdateInterval" type="unsigned long">
8494	<desc>Interval to update guest statistics in seconds.</desc>
8495	</attribute>
8496
8497	<method name="setCredentials">
8498	<desc>
8499	Store login credentials that can be queried by guest operating
8500	systems with Additions installed. The credentials are transient
8501	to the session and the guest may also choose to erase them. Note
8502	that the caller cannot determine whether the guest operating system
8503	has queried or made use of the credentials.
8504
8505	<result name="VBOX_E_VM_ERROR">
8506	VMM device is not available.
8507	</result>
8508
8509	</desc>
8510	<param name="userName" type="wstring" dir="in">
8511	<desc>User name string, can be empty</desc>
8512	</param>
8513	<param name="password" type="wstring" dir="in">
8514	<desc>Password string, can be empty</desc>
8515	</param>
8516	<param name="domain" type="wstring" dir="in">
8517	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8518	</param>
8519	<param name="allowInteractiveLogon" type="boolean" dir="in">
8520	<desc>
8521	Flag whether the guest should alternatively allow the user to
8522	interactively specify different credentials. This flag might
8523	not be supported by all versions of the Additions.
8524	</desc>
8525	</param>
8526	</method>
8527
8528	<method name="getStatistic">
8529	<desc>
8530	Query specified guest statistics as reported by the VirtualBox Additions.
8531	</desc>
8532	<param name="cpuId" type="unsigned long" dir="in">
8533	<desc>Virtual CPU id; not relevant for all statistic types</desc>
8534	</param>
8535	<param name="statistic" type="GuestStatisticType" dir="in">
8536	<desc>Statistic type.</desc>
8537	</param>
8538	<param name="statVal" type="unsigned long" dir="return">
8539	<desc>Statistics value</desc>
8540	</param>
8541	</method>
8542
8543	</interface>
8544
8545
8546	<!--
8547	// IProgress
8548	/////////////////////////////////////////////////////////////////////////
8549	-->
8550
8551	<interface
8552	name="IProgress" extends="$unknown"
8553	uuid="856aa038-853f-42e2-acf7-6e7b02dbe294"
8554	wsmap="managed"
8555	>
8556	<desc>
8557	The IProgress interface is used to track and control
8558	asynchronous tasks within VirtualBox.
8559
8560	An instance of this is returned every time VirtualBox starts
8561	an asynchronous task (in other words, a separate thread) which
8562	continues to run after a method call returns. For example,
8563	<link to="IConsole::saveState" />, which saves the state of
8564	a running virtual machine, can take a long time to complete.
8565	To be able to display a progress bar, a user interface such as
8566	the VirtualBox graphical user interface can use the IProgress
8567	object returned by that method.
8568
8569	Note that IProgress is a "read-only" interface in the sense
8570	that only the VirtualBox internals behind the Main API can
8571	create and manipulate progress objects, whereas client code
8572	can only use the IProgress object to monitor a task's
8573	progress and, if <link to="#cancelable" /> is @c true,
8574	cancel the task by calling <link to="#cancel" />.
8575
8576	A task represented by IProgress consists of either one or
8577	several sub-operations that run sequentially, one by one (see
8578	<link to="#operation" /> and <link to="#operationCount" />).
8579	Every operation is identified by a number (starting from 0)
8580	and has a separate description.
8581
8582	You can find the individual percentage of completion of the current
8583	operation in <link to="#operationPercent" /> and the
8584	percentage of completion of the task as a whole
8585	in <link to="#percent" />.
8586
8587	Similarly, you can wait for the completion of a particular
8588	operation via <link to="#waitForOperationCompletion" /> or
8589	for the completion of the whole task via
8590	<link to="#waitForCompletion" />.
8591	</desc>
8592
8593	<attribute name="id" type="uuid" mod="string" readonly="yes">
8594	<desc>ID of the task.</desc>
8595	</attribute>
8596
8597	<attribute name="description" type="wstring" readonly="yes">
8598	<desc>Description of the task.</desc>
8599	</attribute>
8600
8601	<attribute name="initiator" type="$unknown" readonly="yes">
8602	<desc>Initiator of the task.</desc>
8603	</attribute>
8604
8605	<attribute name="cancelable" type="boolean" readonly="yes">
8606	<desc>Whether the task can be interrupted.</desc>
8607	</attribute>
8608
8609	<attribute name="percent" type="unsigned long" readonly="yes">
8610	<desc>
8611	Current progress value of the task as a whole, in percent.
8612	This value depends on how many operations are already complete.
8613	Returns 100 if <link to="#completed" /> is @c true.
8614	</desc>
8615	</attribute>
8616
8617	<attribute name="timeRemaining" type="long" readonly="yes">
8618	<desc>
8619	Estimated remaining time until the task completes, in
8620	seconds. Returns 0 once the task has completed; returns -1
8621	if the remaining time cannot be computed, in particular if
8622	the current progress is 0.
8623
8624	Even if a value is returned, the estimate will be unreliable
8625	for low progress values. It will become more reliable as the
8626	task progresses; it is not recommended to display an ETA
8627	before at least 20% of a task have completed.
8628	</desc>
8629	</attribute>
8630
8631	<attribute name="completed" type="boolean" readonly="yes">
8632	<desc>Whether the task has been completed.</desc>
8633	</attribute>
8634
8635	<attribute name="canceled" type="boolean" readonly="yes">
8636	<desc>Whether the task has been canceled.</desc>
8637	</attribute>
8638
8639	<attribute name="resultCode" type="long" readonly="yes">
8640	<desc>
8641	Result code of the progress task.
8642	Valid only if <link to="#completed"/> is @c true.
8643	</desc>
8644	</attribute>
8645
8646	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8647	<desc>
8648	Extended information about the unsuccessful result of the
8649	progress operation. May be @c null if no extended information
8650	is available.
8651	Valid only if <link to="#completed"/> is @c true and
8652	<link to="#resultCode"/> indicates a failure.
8653	</desc>
8654	</attribute>
8655
8656	<attribute name="operationCount" type="unsigned long" readonly="yes">
8657	<desc>
8658	Number of sub-operations this task is divided into.
8659	Every task consists of at least one suboperation.
8660	</desc>
8661	</attribute>
8662
8663	<attribute name="operation" type="unsigned long" readonly="yes">
8664	<desc>Number of the sub-operation being currently executed.</desc>
8665	</attribute>
8666
8667	<attribute name="operationDescription" type="wstring" readonly="yes">
8668	<desc>
8669	Description of the sub-operation being currently executed.
8670	</desc>
8671	</attribute>
8672
8673	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8674	<desc>Progress value of the current sub-operation only, in percent.</desc>
8675	</attribute>
8676
8677	<attribute name="timeout" type="unsigned long">
8678	<desc>
8679	When non-zero, this specifies the number of milliseconds after which
8680	the operation will automatically be canceled. This can only be set on
8681	cancelable objects.
8682	</desc>
8683	</attribute>
8684
8685	<method name="setCurrentOperationProgress">
8686	<desc>Internal method, not to be called externally.</desc>
8687	<param name="percent" type="unsigned long" dir="in" />
8688	</method>
8689	<method name="setNextOperation">
8690	<desc>Internal method, not to be called externally.</desc>
8691	<param name="nextOperationDescription" type="wstring" dir="in" />
8692	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8693	</method>
8694
8695	<method name="waitForCompletion">
8696	<desc>
8697	Waits until the task is done (including all sub-operations)
8698	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8699
8700	<result name="VBOX_E_IPRT_ERROR">
8701	Failed to wait for task completion.
8702	</result>
8703	</desc>
8704
8705	<param name="timeout" type="long" dir="in">
8706	<desc>
8707	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8708	</desc>
8709	</param>
8710	</method>
8711
8712	<method name="waitForOperationCompletion">
8713	<desc>
8714	Waits until the given operation is done with a given timeout in
8715	milliseconds; specify -1 for an indefinite wait.
8716
8717	<result name="VBOX_E_IPRT_ERROR">
8718	Failed to wait for operation completion.
8719	</result>
8720
8721	</desc>
8722	<param name="operation" type="unsigned long" dir="in">
8723	<desc>
8724	Number of the operation to wait for.
8725	Must be less than <link to="#operationCount"/>.
8726	</desc>
8727	</param>
8728	<param name="timeout" type="long" dir="in">
8729	<desc>
8730	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8731	</desc>
8732	</param>
8733	</method>
8734
8735	<method name="cancel">
8736	<desc>
8737	Cancels the task.
8738	<note>
8739	If <link to="#cancelable"/> is @c false, then this method will fail.
8740	</note>
8741
8742	<result name="VBOX_E_INVALID_OBJECT_STATE">
8743	Operation cannot be canceled.
8744	</result>
8745
8746	</desc>
8747	</method>
8748
8749	</interface>
8750
8751
8752	<!--
8753	// ISnapshot
8754	/////////////////////////////////////////////////////////////////////////
8755	-->
8756
8757	<interface
8758	name="ISnapshot" extends="$unknown"
8759	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8760	wsmap="managed"
8761	>
8762	<desc>
8763	The ISnapshot interface represents a snapshot of the virtual
8764	machine.
8765
8766	Together with the differencing media that are created
8767	when a snapshot is taken, a machine can be brought back to
8768	the exact state it was in when the snapshot was taken.
8769
8770	The ISnapshot interface has no methods, only attributes; snapshots
8771	are controlled through methods of the <link to="IConsole" /> interface
8772	which also manage the media associated with the snapshot.
8773	The following operations exist:
8774
8775	<ul>
8776	<li><link to="IConsole::takeSnapshot"/>: creates a new snapshot
8777	by creating new, empty differencing images for the machine's
8778	media and saving the VM settings and (if the VM is running)
8779	the current VM state in the snapshot.
8780
8781	The differencing images will then receive all data written to
8782	the machine's media, while their parent (base) images
8783	remain unmodified after the snapshot has been taken (see
8784	<link to="IMedium" /> for details about differencing images).
8785	This simplifies restoring a machine to the state of a snapshot:
8786	only the differencing images need to be deleted.
8787
8788	The current machine state is not changed by taking a snapshot.
8789	If the machine is running, it will resume execution after the
8790	snapshot has been taken.
8791	</li>
8792
8793	<li><link to="IConsole::restoreSnapshot"/>: this goes back to
8794	a previous snapshot. This resets the machine's state to that of
8795	the previous snapshot by deleting the differencing image of each
8796	of the machine's media and setting the machine's settings
8797	and state to the state that was saved in the snapshot (if any).
8798
8799	This destroys the machine's current state.
8800	</li>
8801
8802	<li><link to="IConsole::deleteSnapshot"/>: deletes a snapshot
8803	without affecting the current machine state.
8804
8805	This does not change the machine, but instead frees the resources
8806	allocated when the snapshot was taken: the settings and machine state
8807	is deleted (if any), and the snapshot's differencing image for each
8808	of the machine's media gets merged with its parent image.
8809
8810	Neither the current machine state nor other snapshots are affected
8811	by this operation, except that parent media will be modified
8812	to contain the disk data associated with the snapshot being deleted.
8813	</li>
8814	</ul>
8815
8816	Each snapshot contains the settings of the virtual machine (hardware
8817	configuration etc.). In addition, if the machine was running when the
8818	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8819	the current VM state is saved in the snapshot (similarly to what happens
8820	when a VM's state is saved). The snapshot is then said to
8821	be <i>online</i> because when restoring it, the VM will be running.
8822
8823	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
8824	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8825
8826	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8827	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8828	it then contains a so-called "zero execution state", representing a
8829	machine that is powered off.
8830
8831	<h3>Snapshot branches and the "current" snapshot</h3>
8832
8833	Snapshots can be chained, whereby every next snapshot is based on the
8834	previous one. This chaining is related to medium branching
8835	(see the <link to="IMedium"/> description) in that every time
8836	a new snapshot is created, a new differencing medium is implicitly
8837	created for all normal media attached to the machine.
8838
8839	Each virtual machine has a "current snapshot", identified by
8840	<link to="IMachine::currentSnapshot"/>. Presently, this is always set
8841	to the last snapshot in the chain. In a future version of VirtualBox,
8842	it will be possible to reset a machine's current state to that of an
8843	earlier snapshot without discarding the current state so that it will be
8844	possible to create alternative snapshot paths in a snapshot tree.
8845
8846	In the current implementation, multiple snapshot branches within one
8847	virtual machine are not allowed. Every machine has a single branch,
8848	and <link to="IConsole::takeSnapshot"/> operation adds a new
8849	snapshot to the top of that branch.
8850	</desc>
8851
8852	<attribute name="id" type="uuid" mod="string" readonly="yes">
8853	<desc>UUID of the snapshot.</desc>
8854	</attribute>
8855
8856	<attribute name="name" type="wstring">
8857	<desc>Short name of the snapshot.</desc>
8858	</attribute>
8859
8860	<attribute name="description" type="wstring">
8861	<desc>Optional description of the snapshot.</desc>
8862	</attribute>
8863
8864	<attribute name="timeStamp" type="long long" readonly="yes">
8865	<desc>
8866	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8867	</desc>
8868	</attribute>
8869
8870	<attribute name="online" type="boolean" readonly="yes">
8871	<desc>
8872	@c true if this snapshot is an online snapshot and @c false otherwise.
8873
8874	When this attribute is @c true, the
8875	<link to="IMachine::stateFilePath"/> attribute of the
8876	<link to="#machine"/> object associated with this snapshot
8877	will point to the saved state file. Otherwise, it will be
8878	an empty string.
8879	</desc>
8880	</attribute>
8881
8882	<attribute name="machine" type="IMachine" readonly="yes">
8883	<desc>
8884	Virtual machine this snapshot is taken on. This object
8885	stores all settings the machine had when taking this snapshot.
8886	<note>
8887	The returned machine object is immutable, i.e. no
8888	any settings can be changed.
8889	</note>
8890	</desc>
8891	</attribute>
8892
8893	<attribute name="parent" type="ISnapshot" readonly="yes">
8894	<desc>
8895	Parent snapshot (a snapshot this one is based on), or
8896	@c null if the snapshot has no parent (i.e. is the first snapshot).
8897	</desc>
8898	</attribute>
8899
8900	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8901	<desc>
8902	Child snapshots (all snapshots having this one as a parent).
8903	</desc>
8904	</attribute>
8905
8906	</interface>
8907
8908
8909	<!--
8910	// IMedium
8911	/////////////////////////////////////////////////////////////////////////
8912	-->
8913
8914	<enum
8915	name="MediumState"
8916	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8917	>
8918	<desc>
8919	Virtual medium state.
8920	<see>IMedium</see>
8921	</desc>
8922
8923	<const name="NotCreated" value="0">
8924	<desc>
8925	Associated medium storage does not exist (either was not created yet or
8926	was deleted).
8927	</desc>
8928	</const>
8929	<const name="Created" value="1">
8930	<desc>
8931	Associated storage exists and accessible; this gets set if the
8932	accessibility check performed by <link to="IMedium::refreshState" />
8933	was successful.
8934	</desc>
8935	</const>
8936	<const name="LockedRead" value="2">
8937	<desc>
8938	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8939	no data modification is possible.
8940	</desc>
8941	</const>
8942	<const name="LockedWrite" value="3">
8943	<desc>
8944	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8945	no concurrent data reading or modification is possible.
8946	</desc>
8947	</const>
8948	<const name="Inaccessible" value="4">
8949	<desc>
8950	Medium accessiblity check (see <link to="IMedium::refreshState" />) has
8951	not yet been performed, or else, associated medium storage is not
8952	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8953	is empty, in the second case, it describes the error that occured.
8954	</desc>
8955	</const>
8956	<const name="Creating" value="5">
8957	<desc>
8958	Associated medium storage is being created.
8959	</desc>
8960	</const>
8961	<const name="Deleting" value="6">
8962	<desc>
8963	Associated medium storage is being deleted.
8964	</desc>
8965	</const>
8966	</enum>
8967
8968	<enum
8969	name="MediumType"
8970	uuid="11f6f7a5-0327-409a-9d42-7db6a0cec578"
8971	>
8972	<desc>
8973	Virtual medium type.
8974	<see>IMedium</see>
8975	</desc>
8976
8977	<const name="Normal" value="0">
8978	<desc>
8979	Normal medium (attached directly or indirectly, preserved
8980	when taking snapshots).
8981	</desc>
8982	</const>
8983	<const name="Immutable" value="1">
8984	<desc>
8985	Immutable medium (attached indirectly, changes are wiped out
8986	the next time the virtual machine is started).
8987	</desc>
8988	</const>
8989	<const name="Writethrough" value="2">
8990	<desc>
8991	Write through medium (attached directly, ignored when
8992	taking snapshots).
8993	</desc>
8994	</const>
8995	</enum>
8996
8997	<enum
8998	name="MediumVariant"
8999	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
9000	>
9001	<desc>
9002	Virtual medium image variant. More than one flag may be set.
9003	<see>IMedium</see>
9004	</desc>
9005
9006	<const name="Standard" value="0">
9007	<desc>
9008	No particular variant requested, results in using the backend default.
9009	</desc>
9010	</const>
9011	<const name="VmdkSplit2G" value="0x01">
9012	<desc>
9013	VMDK image split in chunks of less than 2GByte.
9014	</desc>
9015	</const>
9016	<const name="VmdkStreamOptimized" value="0x04">
9017	<desc>
9018	VMDK streamOptimized image. Special import/export format which is
9019	read-only/append-only.
9020	</desc>
9021	</const>
9022	<const name="VmdkESX" value="0x08">
9023	<desc>
9024	VMDK format variant used on ESX products.
9025	</desc>
9026	</const>
9027	<const name="Fixed" value="0x10000">
9028	<desc>
9029	Fixed image. Only allowed for base images.
9030	</desc>
9031	</const>
9032	<const name="Diff" value="0x20000">
9033	<desc>
9034	Fixed image. Only allowed for base images.
9035	</desc>
9036	</const>
9037	</enum>
9038
9039	<interface
9040	name="IMediumAttachment" extends="$unknown"
9041	uuid="e58eb3eb-8627-428b-bdf8-34487c848de5"
9042	wsmap="struct"
9043	>
9044	<desc>
9045	The IMediumAttachment interface represents the attachment
9046	of a storage medium to a virtual machine. Each machine contains
9047	an array of its medium attachments in <link to="IMachine::mediumAttachments"/>.
9048
9049	Each medium attachment specifies a storage controller as well as a port
9050	and device number. Fixed media (hard disks) will always also specify
9051	an instance of IMedium in <link to="#medium" />, referring to the hard disk
9052	medium. For removeable media, the IMedia instance is optional; it can be
9053	@c null if no media is mounted (see <link to="IMachine::mountMedium" />).
9054	</desc>
9055
9056	<attribute name="medium" type="IMedium" readonly="yes">
9057	<desc>Medium object associated with this attachment; it
9058	can be @c null for removable devices.</desc>
9059	</attribute>
9060
9061	<attribute name="controller" type="wstring" readonly="yes">
9062	<desc>Name of the storage controller of this attachment; this
9063	refers to one of the controllers in <link to="IMachine::storageControllers" />
9064	by name.</desc>
9065	</attribute>
9066
9067	<attribute name="port" type="long" readonly="yes">
9068	<desc>Port number of this attachment.</desc>
9069	</attribute>
9070
9071	<attribute name="device" type="long" readonly="yes">
9072	<desc>Device slot number of this attachment.</desc>
9073	</attribute>
9074
9075	<attribute name="type" type="DeviceType" readonly="yes">
9076	<desc>Device type of this attachment.</desc>
9077	</attribute>
9078
9079	<attribute name="passthrough" type="boolean" readonly="yes">
9080	<desc>Pass I/O requests through to a device on the host.</desc>
9081	</attribute>
9082
9083	</interface>
9084
9085	<interface
9086	name="IMedium" extends="$unknown"
9087	uuid="aa8167ba-df72-4738-b740-9b84377ba9f1"
9088	wsmap="managed"
9089	>
9090	<desc>
9091	The IMedium interface represents virtual storage for a machine's
9092	hard disks, CD/DVD or floppy drives. It will typically represent
9093	a disk image on the host, for example a VDI or VMDK file representing
9094	a virtual hard disk, or an ISO or RAW file representing virtual
9095	removable media, but can also point to a network location (e.g.
9096	for iSCSI targets).
9097
9098	Instances of IMedium are connected to virtual machines by way of
9099	medium attachments (see <link to="IMediumAttachment" />), which link
9100	the storage medium to a particular device slot of a storage controller
9101	of the virtual machine.
9102	In the VirtualBox API, virtual storage is therefore always represented
9103	by the following chain of object links:
9104
9105	<ul>
9106	<li><link to="IMachine::storageControllers"/> contains an array of
9107	storage controllers (IDE, SATA, SCSI or a floppy controller;
9108	these are instances of <link to="IStorageController"/>).</li>
9109	<li><link to="IMachine::mediumAttachments"/> contains an array of
9110	medium attachments (instances of <link to="IMediumAttachment"/>),
9111	each containing a storage controller from the above array, a
9112	port/device specification, and an instance of IMedium representing
9113	the medium storage (image file).
9114
9115	For removable media, the storage medium is optional; a medium
9116	attachment with no medium represents a CD/DVD or floppy drive
9117	with no medium inserted. By contrast, hard disk attachments
9118	will always have an IMedium object attached.</li>
9119	<li>Each IMedium in turn points to a storage unit (such as a file
9120	on the host computer or a network resource) that holds actual
9121	data. This location is represented by the <link to="#location"/>
9122	attribute.</li>
9123	</ul>
9124
9125	Existing media are opened using the following methods, depending on the
9126	media type:
9127	<ul>
9128	<li><link to="IVirtualBox::openHardDisk"/></li>
9129	<li><link to="IVirtualBox::openDVDImage"/></li>
9130	<li><link to="IVirtualBox::openFloppyImage"/></li>
9131	</ul>
9132
9133	New hard disk media can be created with the VirtualBox API using the
9134	<link to="IVirtualBox::createHardDisk"/> method.
9135
9136	CD/DVD and floppy images (ISO and RAW files) are usually created outside
9137	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
9138	type in a regular file.
9139
9140	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
9141	drive; in that case the <link to="#id" /> attribute contains the UUID of
9142	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
9143
9144	<h3>Known media</h3>
9145
9146	When an existing medium is opened for the first time, it is automatically
9147	remembered by the given VirtualBox installation or, in other words, becomes
9148	a <i>known medium</i>. Known media are stored in the media
9149	registry transparently maintained by VirtualBox and stored in settings
9150	files so that this registry is preserved when VirtualBox is not running.
9151
9152	Newly created virtual media are remembered only when the associated
9153	storage unit is actually created.
9154
9155	All known media can be enumerated using
9156	<link to="IVirtualBox::hardDisks"/>,
9157	<link to="IVirtualBox::DVDImages"/> and
9158	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
9159	quickly found by UUID using <link to="IVirtualBox::getHardDisk"/>
9160	and similar methods or by location using
9161	<link to="IVirtualBox::findHardDisk"/> and similar methods.
9162
9163	Only known media can be attached to virtual machines.
9164
9165	Removing known media from the media registry is performed when the given
9166	medium is closed using the <link to="#close"/> method or when its
9167	associated storage unit is deleted.
9168
9169	<h3>Accessibility checks</h3>
9170
9171	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
9172	method is called explicitly on a medium. This is done to make the VirtualBox object
9173	ready for serving requests as fast as possible and let the end-user
9174	application decide if it needs to check media accessibility right away or not.
9175
9176	As a result, when VirtualBox starts up (e.g. the VirtualBox
9177	object gets created for the first time), all known media are in the
9178	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
9179	attribute is an empty string because no actual accessibility check has
9180	been made yet.
9181
9182	After calling <link to="#refreshState" />, a medium is considered
9183	<i>accessible</i> if its storage unit can be read. In that case, the
9184	<link to="#state"/> attribute has a value of "Created". If the storage
9185	unit cannot be read (for example, because it is located on a disconnected
9186	network resource, or was accidentally deleted outside VirtualBox),
9187	the medium is considered <i>inaccessible</i>, which is indicated by the
9188	"Inaccessible" state. The exact reason why the medium is inaccessible can be
9189	obtained by reading the <link to="#lastAccessError"/> attribute.
9190
9191	<h3>Medium types</h3>
9192
9193	There are three types of medium behavior (see <link to="MediumType" />):
9194	"normal", "immutable" and "writethrough", represented by the
9195	<link to="#type"/> attribute. The type of the medium defines how the
9196	medium is attached to a virtual machine and what happens when a
9197	<link to="ISnapshot">snapshot</link> of the virtual machine with the
9198	attached medium is taken. At the moment DVD and floppy media are always
9199	of type "writethrough".
9200
9201	All media can be also divided in two groups: <i>base</i> media and
9202	<i>differencing</i> media. A base medium contains all sectors of the
9203	medium data in its own storage and therefore can be used independently.
9204	In contrast, a differencing mediun is a "delta" to some other medium and
9205	contains only those sectors which differ from that other medium, which is
9206	then called a <i>parent</i>. The differencing medium is said to be
9207	<i>linked to</i> that parent. The parent may be itself a differencing
9208	medium, thus forming a chain of linked media. The last element in that
9209	chain must always be a base medium. Note that several differencing
9210	media may be linked to the same parent medium.
9211
9212	Differencing media can be distinguished from base media by querying the
9213	<link to="#parent"/> attribute: base media do not have parents they would
9214	depend on, so the value of this attribute is always @c null for them.
9215	Using this attribute, it is possible to walk up the medium tree (from the
9216	child medium to its parent). It is also possible to walk down the tree
9217	using the <link to="#children"/> attribute.
9218
9219	Note that the type of all differencing media is "Normal"; all other
9220	values are meaningless for them. Base media may be of any type.
9221
9222	<h3>Creating hard disks</h3>
9223
9224	New base hard disks are created using
9225	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
9226	opened using <link to="IVirtualBox::openHardDisk"/>. Differencing hard
9227	disks are usually implicitly created by VirtualBox when needed but may
9228	also be created explicitly using <link to="#createDiffStorage"/>.
9229
9230	After the hard disk is successfully created (including the storage unit)
9231	or opened, it becomes a known hard disk (remembered in the internal media
9232	registry). Known hard disks can be attached to a virtual machine, accessed
9233	through <link to="IVirtualBox::getHardDisk"/> and
9234	<link to="IVirtualBox::findHardDisk"/> methods or enumerated using the
9235	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
9236
9237	The following methods, besides <link to="IMedium::close"/>,
9238	automatically remove the hard disk from the media registry:
9239	<ul>
9240	<li><link to="#deleteStorage"/></li>
9241	<li><link to="#mergeTo"/></li>
9242	</ul>
9243
9244	If the storage unit of the hard disk is a regular file in the host's
9245	file system then the rules stated in the description of the
9246	<link to="IMedium::location"/> attribute apply when setting its value. In
9247	addition, a plain file name without any path may be given, in which case
9248	the <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
9249	folder</link> will be prepended to it.
9250
9251	<h4>Automatic composition of the file name part</h4>
9252
9253	Another extension to the <link to="IMedium::location"/> attribute is that
9254	there is a possibility to cause VirtualBox to compose a unique value for
9255	the file name part of the location using the UUID of the hard disk. This
9256	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
9257	e.g. before the storage unit is created, and works as follows. You set the
9258	value of the <link to="IMedium::location"/> attribute to a location
9259	specification which only contains the path specification but not the file
9260	name part and ends with either a forward slash or a backslash character.
9261	In response, VirtualBox will generate a new UUID for the hard disk and
9262	compose the file name using the following pattern:
9263	<pre>
9264	<path>/{<uuid>}.<ext>
9265	</pre>
9266	where <tt><path></tt> is the supplied path specification,
9267	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
9268	is the default extension for the storage format of this hard disk. After
9269	that, you may call any of the methods that create a new hard disk storage
9270	unit and they will use the generated UUID and file name.
9271
9272	<h3>Attaching Hard Disks</h3>
9273
9274	Hard disks are attached to virtual machines using the
9275	<link to="IMachine::attachDevice"/> method and detached using the
9276	<link to="IMachine::detachDevice"/> method. Depending on their
9277	<link to="#type"/>, hard disks are attached either
9278	<i>directly</i> or <i>indirectly</i>.
9279
9280	When a hard disk is being attached directly, it is associated with the
9281	virtual machine and used for hard disk operations when the machine is
9282	running. When a hard disk is being attached indirectly, a new differencing
9283	hard disk linked to it is implicitly created and this differencing hard
9284	disk is associated with the machine and used for hard disk operations.
9285	This also means that if <link to="IMachine::attachDevice"/> performs
9286	a direct attachment then the same hard disk will be returned in response
9287	to the subsequent <link to="IMachine::getMedium"/> call; however if
9288	an indirect attachment is performed then
9289	<link to="IMachine::getMedium"/> will return the implicitly created
9290	differencing hard disk, not the original one passed to <link
9291	to="IMachine::attachDevice"/>. In detail:
9292
9293	<ul>
9294	<li><b>Normal base</b> hard disks that do not have children (i.e.
9295	differencing hard disks linked to them) and that are not already
9296	attached to virtual machines in snapshots are attached <b>directly</b>.
9297	Otherwise, they are attached <b>indirectly</b> because having
9298	dependent children or being part of the snapshot makes it impossible
9299	to modify hard disk contents without breaking the integrity of the
9300	dependent party. The <link to="#readOnly"/> attribute allows to
9301	quickly determine the kind of the attachment for the given hard
9302	disk. Note that if a normal base hard disk is to be indirectly
9303	attached to a virtual machine with snapshots then a special
9304	procedure called <i>smart attachment</i> is performed (see below).</li>
9305	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
9306	they are attached <b>directly</b> if they do not have children and are
9307	not attached to virtual machines in snapshots, and <b>indirectly</b>
9308	otherwise. Note that the smart attachment procedure is never performed
9309	for differencing hard disks.</li>
9310	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
9311	they are designed to be non-writable. If an immutable hard disk is
9312	attached to a virtual machine with snapshots then a special
9313	procedure called smart attachment is performed (see below).</li>
9314	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
9315	also as designed. This also means that writethrough hard disks cannot
9316	have other hard disks linked to them at all.</li>
9317	</ul>
9318
9319	Note that the same hard disk, regardless of its type, may be attached to
9320	more than one virtual machine at a time. In this case, the machine that is
9321	started first gains exclusive access to the hard disk and attempts to
9322	start other machines having this hard disk attached will fail until the
9323	first machine is powered down.
9324
9325	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
9326	that the given hard disk remains associated with the given machine after a
9327	successful <link to="IMachine::detachDevice"/> call until
9328	<link to="IMachine::saveSettings"/> is called to save all changes to
9329	machine settings to disk. This deferring is necessary to guarantee that
9330	the hard disk configuration may be restored at any time by a call to
9331	<link to="IMachine::discardSettings"/> before the settings
9332	are saved (committed).
9333
9334	Note that if <link to="IMachine::discardSettings"/> is called after
9335	indirectly attaching some hard disks to the machine but before a call to
9336	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
9337	all differencing hard disks implicitly created by
9338	<link to="IMachine::attachDevice"/> for these indirect attachments.
9339	Such implicitly created hard disks will also be immediately deleted when
9340	detached explicitly using the <link to="IMachine::detachDevice"/>
9341	call if it is made before <link to="IMachine::saveSettings"/>. This
9342	implicit deletion is safe because newly created differencing hard
9343	disks do not contain any user data.
9344
9345	However, keep in mind that detaching differencing hard disks that were
9346	implicitly created by <link to="IMachine::attachDevice"/>
9347	before the last <link to="IMachine::saveSettings"/> call will
9348	<b>not</b> implicitly delete them as they may already contain some data
9349	(for example, as a result of virtual machine execution). If these hard
9350	disks are no more necessary, the caller can always delete them explicitly
9351	using <link to="#deleteStorage"/> after they are actually de-associated
9352	from this machine by the <link to="IMachine::saveSettings"/> call.
9353
9354	<h3>Smart Attachment</h3>
9355
9356	When normal base or immutable hard disks are indirectly attached to a
9357	virtual machine then some additional steps are performed to make sure the
9358	virtual machine will have the most recent "view" of the hard disk being
9359	attached. These steps include walking through the machine's snapshots
9360	starting from the current one and going through ancestors up to the first
9361	snapshot. Hard disks attached to the virtual machine in all
9362	of the encountered snapshots are checked whether they are descendants of
9363	the given normal base or immutable hard disk. The first found child (which
9364	is the differencing hard disk) will be used instead of the normal base or
9365	immutable hard disk as a parent for creating a new differencing hard disk
9366	that will be actually attached to the machine. And only if no descendants
9367	are found or if the virtual machine does not have any snapshots then the
9368	normal base or immutable hard disk will be used itself as a parent for
9369	this differencing hard disk.
9370
9371	It is easier to explain what smart attachment does using the
9372	following example:
9373	<pre>
9374	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9375
9376	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9377	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9378	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9379	Snapshot 4 (none) Snapshot 4 (none)
9380	CurState (none) CurState (D3->D2.vdi)
9381
9382	NOT
9383	...
9384	CurState (D3->B.vdi)
9385	</pre>
9386	The first column is the virtual machine configuration before the base hard
9387	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9388	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9389	mean that the hard disk that is actually attached to the machine is a
9390	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9391	another hard disk, <tt>B.vdi</tt>.
9392
9393	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9394	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9395	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9396	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9397	it cannot be attached directly and needs an indirect attachment (i.e.
9398	implicit creation of a new differencing hard disk). Due to the smart
9399	attachment procedure, the new differencing hard disk
9400	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9401	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9402	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9403	machine.
9404
9405	Note that if there is more than one descendant hard disk of the given base
9406	hard disk found in a snapshot, and there is an exact device, channel and
9407	bus match, then this exact match will be used. Otherwise, the youngest
9408	descendant will be picked up.
9409
9410	There is one more important aspect of the smart attachment procedure which
9411	is not related to snapshots at all. Before walking through the snapshots
9412	as described above, the backup copy of the current list of hard disk
9413	attachment is searched for descendants. This backup copy is created when
9414	the hard disk configuration is changed for the first time after the last
9415	<link to="IMachine::saveSettings"/> call and used by
9416	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9417	changes. When such a descendant is found in this backup copy, it will be
9418	simply re-attached back, without creating a new differencing hard disk for
9419	it. This optimization is necessary to make it possible to re-attach the
9420	base or immutable hard disk to a different bus, channel or device slot
9421	without losing the contents of the differencing hard disk actually
9422	attached to the machine in place of it.
9423	</desc>
9424
9425	<attribute name="id" type="uuid" mod="string" readonly="yes">
9426	<desc>
9427	UUID of the medium. For a newly created medium, this value is a randomly
9428	generated UUID.
9429
9430	<note>
9431	For media in one of MediumState_NotCreated, MediumState_Creating or
9432	MediumState_Deleting states, the value of this property is undefined
9433	and will most likely be an empty UUID.
9434	</note>
9435	</desc>
9436	</attribute>
9437
9438	<attribute name="description" type="wstring">
9439	<desc>
9440	Optional description of the medium. For a newly created medium the value
9441	of this attribute is an empty string.
9442
9443	Medium types that don't support this attribute will return E_NOTIMPL in
9444	attempt to get or set this attribute's value.
9445
9446	<note>
9447	For some storage types, reading this attribute may return an outdated
9448	(last known) value when <link to="#state"/> is <link
9449	to="MediumState_Inaccessible"/> or <link
9450	to="MediumState_LockedWrite"/> because the value of this attribute is
9451	stored within the storage unit itself. Also note that changing the
9452	attribute value is not possible in such case, as well as when the
9453	medium is the <link to="MediumState_LockedRead"/> state.
9454	</note>
9455	</desc>
9456	</attribute>
9457
9458	<attribute name="state" type="MediumState" readonly="yes">
9459	<desc>
9460	Returns the current medium state, which is the last state set by
9461	the accessibility check performed by <link to="#refreshState"/>.
9462	If that method has not yet been called on the medium, the state
9463	is "Inaccessible"; as opposed to truly inaccessible media, the
9464	value of <link to="#lastAccessError"/> will be an empty string in
9465	that case.
9466
9467	<note>As of version 3.1, this no longer performs an accessibility check
9468	automatically; call <link to="#refreshState"/> for that.
9469	</note>
9470	</desc>
9471	</attribute>
9472
9473	<attribute name="location" type="wstring">
9474	<desc>
9475	Location of the storage unit holding medium data.
9476
9477	The format of the location string is medium type specific. For medium
9478	types using regular files in a host's file system, the location
9479	string is the full file name.
9480
9481	Some medium types may support changing the storage unit location by
9482	simply changing the value of this property. If this operation is not
9483	supported, the implementation will return E_NOTIMPL in attempt to set
9484	this attribute's value.
9485
9486	When setting a value of the location attribute which is a regular file
9487	in the host's file system, the given file name may be either relative to
9488	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9489	absolute. Note that if the given location specification does not contain
9490	the file extension part then a proper default extension will be
9491	automatically appended by the implementation depending on the medium type.
9492	</desc>
9493	</attribute>
9494
9495	<attribute name="name" type="wstring" readonly="yes">
9496	<desc>
9497	Name of the storage unit holding medium data.
9498
9499	The returned string is a short version of the <link to="#location"/>
9500	attribute that is suitable for representing the medium in situations
9501	where the full location specification is too long (such as lists
9502	and comboboxes in GUI frontends). This string is also used by frontends
9503	to sort the media list alphabetically when needed.
9504
9505	For example, for locations that are regular files in the host's file
9506	system, the value of this attribute is just the file name (+ extension),
9507	without the path specification.
9508
9509	Note that as opposed to the <link to="#location"/> attribute, the name
9510	attribute will not necessary be unique for a list of media of the
9511	given type and format.
9512	</desc>
9513	</attribute>
9514
9515	<attribute name="deviceType" type="DeviceType" readonly="yes">
9516	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9517	medium.</desc>
9518	</attribute>
9519
9520	<attribute name="hostDrive" type="boolean" readonly="yes">
9521	<desc>True if this corresponds to a drive on the host.</desc>
9522	</attribute>
9523
9524	<attribute name="size" type="unsigned long long" readonly="yes">
9525	<desc>
9526	Physical size of the storage unit used to hold medium data (in bytes).
9527
9528	<note>
9529	For media whose <link to="#state"/> is <link
9530	to="MediumState_Inaccessible"/>, the value of this property is the
9531	last known size. For <link to="MediumState_NotCreated"/> media,
9532	the returned value is zero.
9533	</note>
9534	</desc>
9535	</attribute>
9536
9537	<attribute name="format" type="wstring" readonly="yes">
9538	<desc>
9539	Storage format of this medium.
9540
9541	The value of this attribute is a string that specifies a backend used
9542	to store medium data. The storage format is defined when you create a
9543	new medium or automatically detected when you open an existing medium,
9544	and cannot be changed later.
9545
9546	The list of all storage formats supported by this VirtualBox
9547	installation can be obtained using
9548	<link to="ISystemProperties::mediumFormats"/>.
9549	</desc>
9550	</attribute>
9551
9552	<attribute name="type" type="MediumType">
9553	<desc>
9554	Type (role) of this medium.
9555
9556	The following constraints apply when changing the value of this
9557	attribute:
9558	<ul>
9559	<li>If a medium is attached to a virtual machine (either in the
9560	current state or in one of the snapshots), its type cannot be
9561	changed.
9562	</li>
9563	<li>As long as the medium has children, its type cannot be set
9564	to <link to="MediumType_Writethrough"/>.
9565	</li>
9566	<li>The type of all differencing media is
9567	<link to="MediumType_Normal"/> and cannot be changed.
9568	</li>
9569	</ul>
9570
9571	The type of a newly created or opened medium is set to
9572	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9573	which have a type of <link to="MediumType_Writethrough"/>.
9574	</desc>
9575	</attribute>
9576
9577	<attribute name="parent" type="IMedium" readonly="yes">
9578	<desc>
9579	Parent of this medium (the medium this medium is directly based
9580	on).
9581
9582	Only differencing media have parents. For base (non-differencing)
9583	media, @c null is returned.
9584	</desc>
9585	</attribute>
9586
9587	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9588	<desc>
9589	Children of this medium (all differencing media directly based
9590	on this medium). A @c null array is returned if this medium
9591	does not have any children.
9592	</desc>
9593	</attribute>
9594
9595	<attribute name="base" type="IMedium" readonly="yes">
9596	<desc>
9597	Base medium of this medium.
9598
9599	If this is a differencing medium, its base medium is the medium
9600	the given medium branch starts from. For all other types of media, this
9601	property returns the medium object itself (i.e. the same object this
9602	property is read on).
9603	</desc>
9604	</attribute>
9605
9606	<attribute name="readOnly" type="boolean" readonly="yes">
9607	<desc>
9608	Returns @c true if this medium is read-only and @c false otherwise.
9609
9610	A medium is considered to be read-only when its contents cannot be
9611	modified without breaking the integrity of other parties that depend on
9612	this medium such as its child media or snapshots of virtual machines
9613	where this medium is attached to these machines. If there are no
9614	children and no such snapshots then there is no dependency and the
9615	medium is not read-only.
9616
9617	The value of this attribute can be used to determine the kind of the
9618	attachment that will take place when attaching this medium to a
9619	virtual machine. If the value is @c false then the medium will
9620	be attached directly. If the value is @c true then the medium
9621	will be attached indirectly by creating a new differencing child
9622	medium for that. See the interface description for more information.
9623
9624	Note that all <link to="MediumType_Immutable">Immutable</link> media
9625	are always read-only while all
9626	<link to="MediumType_Writethrough">Writethrough</link> media are
9627	always not.
9628
9629	<note>
9630	The read-only condition represented by this attribute is related to
9631	the medium type and usage, not to the current
9632	<link to="IMedium::state">medium state</link> and not to the read-only
9633	state of the storage unit.
9634	</note>
9635	</desc>
9636	</attribute>
9637
9638	<attribute name="logicalSize" type="unsigned long long" readonly="yes">
9639	<desc>
9640	Logical size of this medium (in megabytes), as reported to the
9641	guest OS running inside the virtual machine this medium is
9642	attached to. The logical size is defined when the medium is created
9643	and cannot be changed later.
9644
9645	<note>
9646	Reading this property on a differencing medium will return the size
9647	of its <link to="#base"/> medium.
9648	</note>
9649	<note>
9650	For media whose state is <link to="#state"/> is <link
9651	to="MediumState_Inaccessible"/>, the value of this property is the
9652	last known logical size. For <link to="MediumaState_NotCreated"/>
9653	media, the returned value is zero.
9654	</note>
9655	</desc>
9656	</attribute>
9657
9658	<attribute name="autoReset" type="boolean">
9659	<desc>
9660	Whether this differencing medium will be automatically reset each
9661	time a virtual machine it is attached to is powered up. This
9662	attribute is automatically set to @c true for the last
9663	differencing image of an "immutable" medium (see
9664	<link to="MediumType" />).
9665
9666	See <link to="#reset"/> for more information about resetting
9667	differencing media.
9668
9669	<note>
9670	Reading this property on a base (non-differencing) medium will
9671	always @c false. Changing the value of this property in this
9672	case is not supported.
9673	</note>
9674
9675	<result name="VBOX_E_NOT_SUPPORTED">
9676	This is not a differencing medium (when changing the attribute
9677	value).
9678	</result>
9679	</desc>
9680	</attribute>
9681
9682	<attribute name="lastAccessError" type="wstring" readonly="yes">
9683	<desc>
9684	Text message that represents the result of the last accessibility
9685	check performed by <link to="#refreshState"/>.
9686
9687	An empty string is returned if the last accessibility check
9688	was successful or has not yet been called. As a result, if
9689	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9690	then <link to="#refreshState"/> has yet to be called; this is the
9691	default value of media after VirtualBox initialization.
9692	A non-empty string indicates a failure and should normally describe
9693	a reason of the failure (for example, a file read error).
9694	</desc>
9695	</attribute>
9696
9697	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9698	<desc>
9699	Array of UUIDs of all machines this medium is attached to.
9700
9701	A @c null array is returned if this medium is not attached to any
9702	machine or to any machine's snapshot.
9703
9704	<note>
9705	The returned array will include a machine even if this medium is not
9706	attached to that machine in the current state but attached to it in
9707	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9708	details.
9709	</note>
9710	</desc>
9711	</attribute>
9712
9713	<method name="refreshState">
9714	<desc>
9715	If the current medium state (see <link to="MediumState"/>) is one of
9716	"Created", "Inaccessible" or "LockedRead", then this performs an
9717	accessibility check on the medium and sets the value of the <link to="#state"/>
9718	attribute accordingly; that value is also returned for convenience.
9719
9720	For all other state values, this does not perform a refresh but returns
9721	the state only.
9722
9723	The refresh, if performed, may take a long time (several seconds or even
9724	minutes, depending on the storage unit location and format) because it performs an
9725	accessibility check of the storage unit. This check may cause a significant
9726	delay if the storage unit of the given medium is, for example, a file located
9727	on a network share which is not currently accessible due to connectivity
9728	problems. In that case, the call will not return until a timeout
9729	interval defined by the host OS for this operation expires. For this reason,
9730	it is recommended to never read this attribute on the main UI thread to avoid
9731	making the UI unresponsive.
9732
9733	If the last known state of the medium is "Created" and the accessibility
9734	check fails, then the state would be set to "Inaccessible", and
9735	<link to="#lastAccessError"/> may be used to get more details about the
9736	failure. If the state of the medium is "LockedRead", then it remains the
9737	same, and a non-empty value of <link to="#lastAccessError"/> will
9738	indicate a failed accessibility check in this case.
9739
9740	Note that not all medium states are applicable to all medium types.
9741	</desc>
9742	<param name="state" type="MediumState" dir="return">
9743	<desc>
9744	New medium state.
9745	</desc>
9746	</param>
9747	</method>
9748
9749	<method name="getSnapshotIds">
9750	<desc>
9751	Returns an array of UUIDs of all snapshots of the given machine where
9752	this medium is attached to.
9753
9754	If the medium is attached to the machine in the current state, then the
9755	first element in the array will always be the ID of the queried machine
9756	(i.e. the value equal to the @c machineId argument), followed by
9757	snapshot IDs (if any).
9758
9759	If the medium is not attached to the machine in the current state, then
9760	the array will contain only snapshot IDs.
9761
9762	The returned array may be @c null if this medium is not attached
9763	to the given machine at all, neither in the current state nor in one of
9764	the snapshots.
9765	</desc>
9766	<param name="machineId" type="uuid" mod="string" dir="in">
9767	<desc>
9768	UUID of the machine to query.
9769	</desc>
9770	</param>
9771	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9772	<desc>
9773	Array of snapshot UUIDs of the given machine using this medium.
9774	</desc>
9775	</param>
9776	</method>
9777
9778	<method name="lockRead">
9779	<desc>
9780	Locks this medium for reading.
9781
9782	A read lock is shared: many clients can simultaneously lock the
9783	same medium for reading unless it is already locked for writing (see
9784	<link to="#lockWrite"/>) in which case an error is returned.
9785
9786	When the medium is locked for reading, it cannot be modified
9787	from within VirtualBox. This means that any method that changes
9788	the properties of this medium or contents of the storage unit
9789	will return an error (unless explicitly stated otherwise). That
9790	includes an attempt to start a virtual machine that wants to
9791	write to the the medium.
9792
9793	When the virtual machine is started up, it locks for reading all
9794	media it uses in read-only mode. If some medium cannot be locked
9795	for reading, the startup procedure will fail.
9796	A medium is typically locked for reading while it is used by a running
9797	virtual machine but has a depending differencing image that receives
9798	the actual write operations. This way one base medium can have
9799	multiple child differencing images which can be written to
9800	simultaneously. Read-only media such as DVD and floppy images are
9801	also locked for reading only (so they can be in use by multiple
9802	machines simultaneously).
9803
9804	A medium is also locked for reading when it is the source of a
9805	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9806
9807	The medium locked for reading must be unlocked using the <link
9808	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9809	can be nested and must be followed by the same number of paired
9810	<link to="#unlockRead"/> calls.
9811
9812	This method sets the medium state (see <link to="#state"/>) to
9813	"LockedRead" on success. The medium's previous state must be
9814	one of "Created", "Inaccessible" or "LockedRead".
9815
9816	Locking an inaccessible medium is not an error; this method performs
9817	a logical lock that prevents modifications of this medium through
9818	the VirtualBox API, not a physical file-system lock of the underlying
9819	storage unit.
9820
9821	This method returns the current state of the medium
9822	<i>before</i> the operation.
9823
9824	<result name="VBOX_E_INVALID_OBJECT_STATE">
9825	Invalid medium state (e.g. not created, locked, inaccessible,
9826	creating, deleting).
9827	</result>
9828
9829	</desc>
9830	<param name="state" type="MediumState" dir="return">
9831	<desc>
9832	State of the medium after the operation.
9833	</desc>
9834	</param>
9835	</method>
9836
9837	<method name="unlockRead">
9838	<desc>
9839	Cancels the read lock previously set by <link to="#lockRead"/>.
9840
9841	For both success and failure, this method returns the current state
9842	of the medium <i>after</i> the operation.
9843
9844	See <link to="#lockRead"/> for more details.
9845
9846	<result name="VBOX_E_INVALID_OBJECT_STATE">
9847	Medium not locked for reading.
9848	</result>
9849
9850	</desc>
9851	<param name="state" type="MediumState" dir="return">
9852	<desc>
9853	State of the medium after the operation.
9854	</desc>
9855	</param>
9856	</method>
9857
9858	<method name="lockWrite">
9859	<desc>
9860	Locks this medium for writing.
9861
9862	A write lock, as opposed to <link to="#lockRead"/>, is
9863	exclusive: there may be only one client holding a write lock,
9864	and there may be no read locks while the write lock is held.
9865	As a result, read-locking fails if a write lock is held, and
9866	write-locking fails if either a read or another write lock is held.
9867
9868	When a medium is locked for writing, it cannot be modified
9869	from within VirtualBox, and it is not guaranteed that the values
9870	of its properties are up-to-date. Any method that changes the
9871	properties of this medium or contents of the storage unit will
9872	return an error (unless explicitly stated otherwise).
9873
9874	When a virtual machine is started up, it locks for writing all
9875	media it uses to write data to. If any medium could not be locked
9876	for writing, the startup procedure will fail. If a medium has
9877	differencing images, then while the machine is running, only
9878	the last ("leaf") differencing image is locked for writing,
9879	whereas its parents are locked for reading only.
9880
9881	A medium is also locked for writing when it is the target of a
9882	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9883
9884	The medium locked for writing must be unlocked using the <link
9885	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9886
9887	This method sets the medium state (see <link to="#state"/>) to
9888	"LockedWrite" on success. The medium's previous state must be
9889	either "Created" or "Inaccessible".
9890
9891	Locking an inaccessible medium is not an error; this method performs
9892	a logical lock that prevents modifications of this medium through
9893	the VirtualBox API, not a physical file-system lock of the underlying
9894	storage unit.
9895
9896	For both, success and failure, this method returns the current
9897	state of the medium <i>before</i> the operation.
9898
9899	<result name="VBOX_E_INVALID_OBJECT_STATE">
9900	Invalid medium state (e.g. not created, locked, inaccessible,
9901	creating, deleting).
9902	</result>
9903
9904	</desc>
9905	<param name="state" type="MediumState" dir="return">
9906	<desc>
9907	State of the medium after the operation.
9908	</desc>
9909	</param>
9910	</method>
9911
9912	<method name="unlockWrite">
9913	<desc>
9914	Cancels the write lock previously set by <link to="#lockWrite"/>.
9915
9916	For both success and failure, this method returns the current
9917	state of the medium <i>after</i> the operation.
9918
9919	See <link to="#lockWrite"/> for more details.
9920
9921	<result name="VBOX_E_INVALID_OBJECT_STATE">
9922	Medium not locked for writing.
9923	</result>
9924
9925	</desc>
9926	<param name="state" type="MediumState" dir="return">
9927	<desc>
9928	State of the medium after the operation.
9929	</desc>
9930	</param>
9931	</method>
9932
9933	<method name="close">
9934	<desc>
9935	Closes this medium.
9936
9937	The medium must not be attached to any known virtual machine
9938	and must not have any known child media, otherwise the
9939	operation will fail.
9940
9941	When the medium is successfully closed, it gets removed from
9942	the list of remembered media, but its storage unit is not
9943	deleted. In particular, this means that this medium can be
9944	later opened again using the <link
9945	to="IVirtualBox::openHardDisk"/> call.
9946
9947	Note that after this method successfully returns, the given medium
9948	object becomes uninitialized. This means that any attempt
9949	to call any of its methods or attributes will fail with the
9950	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9951
9952	<result name="VBOX_E_INVALID_OBJECT_STATE">
9953	Invalid medium state (other than not created, created or
9954	inaccessible).
9955	</result>
9956	<result name="VBOX_E_OBJECT_IN_USE">
9957	Medium attached to virtual machine.
9958	</result>
9959	<result name="VBOX_E_FILE_ERROR">
9960	Settings file not accessible.
9961	</result>
9962	<result name="VBOX_E_XML_ERROR">
9963	Could not parse the settings file.
9964	</result>
9965
9966	</desc>
9967	</method>
9968
9969	<!-- storage methods -->
9970
9971	<method name="getProperty">
9972	<desc>
9973	Returns the value of the custom medium property with the given name.
9974
9975	The list of all properties supported by the given medium format can
9976	be obtained with <link to="IMediumFormat::describeProperties"/>.
9977
9978	Note that if this method returns an empty string in @a value, the
9979	requested property is supported but currently not assigned any value.
9980
9981	<result name="VBOX_E_OBJECT_NOT_FOUND">
9982	Requested property does not exist (not supported by the format).
9983	</result>
9984	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9985	</desc>
9986	<param name="name" type="wstring" dir="in">
9987	<desc>Name of the property to get.</desc>
9988	</param>
9989	<param name="value" type="wstring" dir="return">
9990	<desc>Current property value.</desc>
9991	</param>
9992	</method>
9993
9994	<method name="setProperty">
9995	<desc>
9996	Sets the value of the custom medium property with the given name.
9997
9998	The list of all properties supported by the given medium format can
9999	be obtained with <link to="IMediumFormat::describeProperties"/>.
10000
10001	Note that setting the property value to @c null or an empty string is
10002	equivalent to deleting the existing value. A default value (if it is
10003	defined for this property) will be used by the format backend in this
10004	case.
10005
10006	<result name="VBOX_E_OBJECT_NOT_FOUND">
10007	Requested property does not exist (not supported by the format).
10008	</result>
10009	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10010	</desc>
10011	<param name="name" type="wstring" dir="in">
10012	<desc>Name of the property to set.</desc>
10013	</param>
10014	<param name="value" type="wstring" dir="in">
10015	<desc>Property value to set.</desc>
10016	</param>
10017	</method>
10018
10019	<method name="getProperties">
10020	<desc>
10021	Returns values for a group of properties in one call.
10022
10023	The names of the properties to get are specified using the @a names
10024	argument which is a list of comma-separated property names or
10025	an empty string if all properties are to be returned. Note that currently
10026	the value of this argument is ignored and the method always returns all
10027	existing properties.
10028
10029	The list of all properties supported by the given medium format can
10030	be obtained with <link to="IMediumFormat::describeProperties"/>.
10031
10032	The method returns two arrays, the array of property names corresponding
10033	to the @a names argument and the current values of these properties.
10034	Both arrays have the same number of elements with each elemend at the
10035	given index in the first array corresponds to an element at the same
10036	index in the second array.
10037
10038	Note that for properties that do not have assigned values,
10039	an empty string is returned at the appropriate index in the
10040	@a returnValues array.
10041
10042	</desc>
10043	<param name="names" type="wstring" dir="in">
10044	<desc>
10045	Names of properties to get.
10046	</desc>
10047	</param>
10048	<param name="returnNames" type="wstring" safearray="yes" dir="out">
10049	<desc>Names of returned properties.</desc>
10050	</param>
10051	<param name="returnValues" type="wstring" safearray="yes" dir="return">
10052	<desc>Values of returned properties.</desc>
10053	</param>
10054	</method>
10055
10056	<method name="setProperties">
10057	<desc>
10058	Sets values for a group of properties in one call.
10059
10060	The names of the properties to set are passed in the @a names
10061	array along with the new values for them in the @a values array. Both
10062	arrays have the same number of elements with each elemend at the given
10063	index in the first array corresponding to an element at the same index
10064	in the second array.
10065
10066	If there is at least one property name in @a names that is not valid,
10067	the method will fail before changing the values of any other properties
10068	from the @a names array.
10069
10070	Using this method over <link to="#setProperty"/> is preferred if you
10071	need to set several properties at once since it will result into less
10072	IPC calls.
10073
10074	The list of all properties supported by the given medium format can
10075	be obtained with <link to="IMediumFormat::describeProperties"/>.
10076
10077	Note that setting the property value to @c null or an empty string is
10078	equivalent to deleting the existing value. A default value (if it is
10079	defined for this property) will be used by the format backend in this
10080	case.
10081	</desc>
10082	<param name="names" type="wstring" safearray="yes" dir="in">
10083	<desc>Names of properties to set.</desc>
10084	</param>
10085	<param name="values" type="wstring" safearray="yes" dir="in">
10086	<desc>Values of properties to set.</desc>
10087	</param>
10088	</method>
10089
10090	<!-- storage methods -->
10091
10092	<method name="createBaseStorage">
10093	<desc>
10094	Starts creating a hard disk storage unit (fixed/dynamic, according
10095	to the variant flags) in in the background. The previous storage unit
10096	created for this object, if any, must first be deleted using
10097	<link to="#deleteStorage"/>, otherwise the operation will fail.
10098
10099	Before the operation starts, the medium is placed in
10100	<link to="MediumState_Creating"/> state. If the create operation
10101	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
10102	state.
10103
10104	After the returned progress object reports that the operation has
10105	successfully completed, the medium state will be set to <link
10106	to="MediumState_Created"/>, the medium will be remembered by this
10107	VirtualBox installation and may be attached to virtual machines.
10108
10109	<result name="VBOX_E_NOT_SUPPORTED">
10110	The variant of storage creation operation is not supported. See <link
10111	to="IMediumFormat::capabilities"/>.
10112	</result>
10113	</desc>
10114	<param name="logicalSize" type="unsigned long long" dir="in">
10115	<desc>Maximum logical size of the medium in megabytes.</desc>
10116	</param>
10117	<param name="variant" type="MediumVariant" dir="in">
10118	<desc>Exact image variant which should be created.</desc>
10119	</param>
10120	<param name="progress" type="IProgress" dir="return">
10121	<desc>Progress object to track the operation completion.</desc>
10122	</param>
10123	</method>
10124
10125	<method name="deleteStorage">
10126	<desc>
10127	Starts deleting the storage unit of this medium.
10128
10129	The medium must not be attached to any known virtual machine and must
10130	not have any known child media, otherwise the operation will fail.
10131	It will also fail if there is no storage unit to delete or if deletion
10132	is already in progress, or if the medium is being in use (locked for
10133	read or for write) or inaccessible. Therefore, the only valid state for
10134	this operation to succeed is <link to="MediumState_Created"/>.
10135
10136	Before the operation starts, the medium is placed in
10137	<link to="MediumState_Deleting"/> state and gets removed from the list
10138	of remembered hard disks (media registry). If the delete operation
10139	fails, the medium will be remembered again and placed back to
10140	<link to="MediumState_Created"/> state.
10141
10142	After the returned progress object reports that the operation is
10143	complete, the medium state will be set to
10144	<link to="MediumState_NotCreated"/> and you will be able to use one of
10145	the storage creation methods to create it again.
10146
10147	<see>#close()</see>
10148
10149	<result name="VBOX_E_OBJECT_IN_USE">
10150	Medium is attached to a virtual machine.
10151	</result>
10152	<result name="VBOX_E_NOT_SUPPORTED">
10153	Storage deletion is not allowed because neither of storage creation
10154	operations are supported. See
10155	<link to="IMediumFormat::capabilities"/>.
10156	</result>
10157
10158	<note>
10159	If the deletion operation fails, it is not guaranteed that the storage
10160	unit still exists. You may check the <link to="IMedium::state"/> value
10161	to answer this question.
10162	</note>
10163	</desc>
10164	<param name="progress" type="IProgress" dir="return">
10165	<desc>Progress object to track the operation completion.</desc>
10166	</param>
10167	</method>
10168
10169	<!-- diff methods -->
10170
10171	<method name="createDiffStorage">
10172	<desc>
10173	Starts creating an empty differencing storage unit based on this
10174	medium in the format and at the location defined by the @a target
10175	argument.
10176
10177	The target medium must be in <link to="MediumState_NotCreated"/>
10178	state (i.e. must not have an existing storage unit). Upon successful
10179	completion, this operation will set the type of the target medium to
10180	<link to="MediumType_Normal"/> and create a storage unit necessary to
10181	represent the differencing medium data in the given format (according
10182	to the storage format of the target object).
10183
10184	After the returned progress object reports that the operation is
10185	successfully complete, the target medium gets remembered by this
10186	VirtualBox installation and may be attached to virtual machines.
10187
10188	<note>
10189	The medium will be set to <link to="MediumState_LockedRead"/>
10190	state for the duration of this operation.
10191	</note>
10192	<result name="VBOX_E_OBJECT_IN_USE">
10193	Medium not in @c NotCreated state.
10194	</result>
10195	</desc>
10196	<param name="target" type="IMedium" dir="in">
10197	<desc>Target medium.</desc>
10198	</param>
10199	<param name="variant" type="MediumVariant" dir="in">
10200	<desc>Exact image variant which should be created.</desc>
10201	</param>
10202	<param name="progress" type="IProgress" dir="return">
10203	<desc>Progress object to track the operation completion.</desc>
10204	</param>
10205	</method>
10206
10207	<method name="mergeTo">
10208	<desc>
10209	Starts merging the contents of this medium and all intermediate
10210	differencing media in the chain to the given target medium.
10211
10212	The target medium must be either a descendant of this medium or
10213	its ancestor (otherwise this method will immediately return a failure).
10214	It follows that there are two logical directions of the merge operation:
10215	from ancestor to descendant (<i>forward merge</i>) and from descendant to
10216	ancestor (<i>backward merge</i>). Let us consider the following medium
10217	chain:
10218
10219	<pre>Base <- Diff_1 <- Diff_2</pre>
10220
10221	Here, calling this method on the <tt>Base</tt> medium object with
10222	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
10223	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
10224	merge. Note that in both cases the contents of the resulting medium
10225	will be the same, the only difference is the medium object that takes
10226	the result of the merge operation. In case of the forward merge in the
10227	above example, the result will be written to <tt>Diff_2</tt>; in case of
10228	the backward merge, the result will be written to <tt>Base</tt>. In
10229	other words, the result of the operation is always stored in the target
10230	medium.
10231
10232	Upon successful operation completion, the storage units of all media in
10233	the chain between this (source) medium and the target medium, including
10234	the source medium itself, will be automatically deleted and the
10235	relevant medium objects (including this medium) will become
10236	uninitialized. This means that any attempt to call any of
10237	their methods or attributes will fail with the
10238	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
10239	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
10240	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
10241	Note that <tt>Diff_2</tt> in this case will become a base medium
10242	itself since it will no longer be based on any other medium.
10243
10244	Considering the above, all of the following conditions must be met in
10245	order for the merge operation to succeed:
10246	<ul>
10247	<li>
10248	Neither this (source) medium nor any intermediate
10249	differencing medium in the chain between it and the target
10250	medium is attached to any virtual machine.
10251	</li>
10252	<li>
10253	Neither the source medium nor the target medium is an
10254	<link to="MediumType_Immutable"/> medium.
10255	</li>
10256	<li>
10257	The part of the medium tree from the source medium to the
10258	target medium is a linear chain, i.e. all medium in this
10259	chain have exactly one child which is the next medium in this
10260	chain. The only exception from this rule is the target medium in
10261	the forward merge operation; it is allowed to have any number of
10262	child media because the merge operation will not change its
10263	logical contents (as it is seen by the guest OS or by children).
10264	</li>
10265	<li>
10266	None of the involved media are in
10267	<link to="MediumState_LockedRead"/> or
10268	<link to="MediumState_LockedWrite"/> state.
10269	</li>
10270	</ul>
10271
10272	<note>
10273	This (source) medium and all intermediates will be placed to <link
10274	to="MediumState_Deleting"/> state and the target medium will be
10275	placed to <link to="MediumState_LockedWrite"/> state and for the
10276	duration of this operation.
10277	</note>
10278	</desc>
10279	<param name="targetId" type="uuid" mod="string" dir="in">
10280	<desc>UUID of the target ancestor or descendant medium.</desc>
10281	</param>
10282	<param name="progress" type="IProgress" dir="return">
10283	<desc>Progress object to track the operation completion.</desc>
10284	</param>
10285	</method>
10286
10287	<!-- clone method -->
10288
10289	<method name="cloneTo">
10290	<desc>
10291	Starts creating a clone of this medium in the format and at the
10292	location defined by the @a target argument.
10293
10294	The target medium must be either in <link to="MediumState_NotCreated"/>
10295	state (i.e. must not have an existing storage unit) or in
10296	<link to="MediumState_Created"/> state (i.e. created and not locked, and
10297	big enough to hold the data or else the copy will be partial). Upon
10298	successful completion, the cloned medium will contain exactly the
10299	same sector data as the medium being cloned, except that in the
10300	first case a new UUID for the clone will be randomly generated, and in
10301	the second case the UUID will remain unchanged.
10302
10303	The @a parent argument defines which medium will be the parent
10304	of the clone. Passing a @c null reference indicates that the clone will
10305	be a base image, i.e. completely independent. It is possible to specify
10306	an arbitrary medium for this parameter, including the parent of the
10307	medium which is being cloned. Even cloning to a child of the source
10308	medium is possible. Note that when cloning to an existing image, the
10309	@a parent irgument is ignored.
10310
10311	After the returned progress object reports that the operation is
10312	successfully complete, the target medium gets remembered by this
10313	VirtualBox installation and may be attached to virtual machines.
10314
10315	<note>
10316	This medium will be placed to <link to="MediumState_LockedRead"/>
10317	state for the duration of this operation.
10318	</note>
10319	<result name="E_NOTIMPL">
10320	The specified cloning variant is not supported at the moment.
10321	</result>
10322	</desc>
10323	<param name="target" type="IMedium" dir="in">
10324	<desc>Target medium.</desc>
10325	</param>
10326	<param name="variant" type="MediumVariant" dir="in">
10327	<desc>Exact image variant which should be created.</desc>
10328	</param>
10329	<param name="parent" type="IMedium" dir="in">
10330	<desc>Parent of the cloned medium.</desc>
10331	</param>
10332	<param name="progress" type="IProgress" dir="return">
10333	<desc>Progress object to track the operation completion.</desc>
10334	</param>
10335	</method>
10336
10337	<!-- other methods -->
10338
10339	<method name="compact">
10340	<desc>
10341	Starts compacting of this medium. This means that the medium is
10342	transformed into a possibly more compact storage representation.
10343	This potentially creates temporary images, which can require a
10344	substantial amount of additional disk space.
10345
10346	This medium will be placed to <link to="MediumState_LockedWrite"/>
10347	state and all its parent media (if any) will be placed to
10348	<link to="MediumState_LockedRead"/> state for the duration of this
10349	operation.
10350
10351	Please note that the results can be either returned straight away,
10352	or later as the result of the background operation via the object
10353	returned via the @a progress parameter.
10354
10355	<result name="VBOX_E_NOT_SUPPORTED">
10356	Medium format does not support compacting (but potentially
10357	needs it).
10358	</result>
10359	</desc>
10360	<param name="progress" type="IProgress" dir="return">
10361	<desc>Progress object to track the operation completion.</desc>
10362	</param>
10363	</method>
10364
10365	<method name="resize">
10366	<desc>
10367	Starts resizing this medium. This means that the nominal size of the
10368	medium is set to the new value. Both increasing and decreasing the
10369	size is possible, and there are no safety checks, since VirtualBox
10370	does not make any assumptions about the medium contents.
10371
10372	Resizing usually needs additional disk space, and possibly also
10373	some temporary disk space. Note that resize does not create a full
10374	temporary copy of the medium, so the additional disk space requirement
10375	is usually much lower than using the clone operation.
10376
10377	This medium will be placed to <link to="MediumState_LockedWrite"/>
10378	state for the duration of this operation.
10379
10380	Please note that the results can be either returned straight away,
10381	or later as the result of the background operation via the object
10382	returned via the @a progress parameter.
10383
10384	<result name="VBOX_E_NOT_SUPPORTED">
10385	Medium format does not support resizing.
10386	</result>
10387	</desc>
10388	<param name="logicalSize" type="unsigned long long" dir="in">
10389	<desc>New nominal capacity of the medium in megabytes.</desc>
10390	</param>
10391	<param name="progress" type="IProgress" dir="return">
10392	<desc>Progress object to track the operation completion.</desc>
10393	</param>
10394	</method>
10395
10396	<method name="reset">
10397	<desc>
10398	Starts erasing the contents of this differencing medium.
10399
10400	This operation will reset the differencing medium to its initial
10401	state when it does not contain any sector data and any read operation is
10402	redirected to its parent medium. This automatically gets called
10403	during VM power-up for every medium whose <link to="#autoReset" />
10404	attribute is @c true.
10405
10406	The medium will be write-locked for the duration of this operation (see
10407	<link to="#lockWrite" />).
10408
10409	<result name="VBOX_E_NOT_SUPPORTED">
10410	This is not a differencing medium.
10411	</result>
10412	<result name="VBOX_E_INVALID_OBJECT_STATE">
10413	Medium is not in <link to="MediumState_Created"/> or
10414	<link to="MediumState_Inaccessible"/> state.
10415	</result>
10416	</desc>
10417	<param name="progress" type="IProgress" dir="return">
10418	<desc>Progress object to track the operation completion.</desc>
10419	</param>
10420	</method>
10421
10422	</interface>
10423
10424
10425	<!--
10426	// IMediumFormat
10427	/////////////////////////////////////////////////////////////////////////
10428	-->
10429
10430	<enum
10431	name="DataType"
10432	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10433	>
10434	<const name="Int32" value="0"/>
10435	<const name="Int8" value="1"/>
10436	<const name="String" value="2"/>
10437	</enum>
10438
10439	<enum
10440	name="DataFlags"
10441	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10442	>
10443	<const name="None" value="0x00"/>
10444	<const name="Mandatory" value="0x01"/>
10445	<const name="Expert" value="0x02"/>
10446	<const name="Array" value="0x04"/>
10447	<const name="FlagMask" value="0x07"/>
10448	</enum>
10449
10450	<enum
10451	name="MediumFormatCapabilities"
10452	uuid="70fcf810-99e8-4edc-aee4-7f51d489e657"
10453	>
10454	<desc>
10455	Medium format capability flags.
10456	</desc>
10457
10458	<const name="Uuid" value="0x01">
10459	<desc>
10460	Supports UUIDs as expected by VirtualBox code.
10461	</desc>
10462	</const>
10463
10464	<const name="CreateFixed" value="0x02">
10465	<desc>
10466	Supports creating fixed size images, allocating all space instantly.
10467	</desc>
10468	</const>
10469
10470	<const name="CreateDynamic" value="0x04">
10471	<desc>
10472	Supports creating dynamically growing images, allocating space on
10473	demand.
10474	</desc>
10475	</const>
10476
10477	<const name="CreateSplit2G" value="0x08">
10478	<desc>
10479	Supports creating images split in chunks of a bit less than 2 GBytes.
10480	</desc>
10481	</const>
10482
10483	<const name="Differencing" value="0x10">
10484	<desc>
10485	Supports being used as a format for differencing media (see <link
10486	to="IMedium::createDiffStorage"/>).
10487	</desc>
10488	</const>
10489
10490	<const name="Asynchronous" value="0x20">
10491	<desc>
10492	Supports asynchronous I/O operations for at least some configurations.
10493	</desc>
10494	</const>
10495
10496	<const name="File" value="0x40">
10497	<desc>
10498	The format backend operates on files (the <link to="IMedium::location"/>
10499	attribute of the medium specifies a file used to store medium
10500	data; for a list of supported file extensions see
10501	<link to="IMediumFormat::fileExtensions"/>).
10502	</desc>
10503	</const>
10504
10505	<const name="Properties" value="0x80">
10506	<desc>
10507	The format backend uses the property interface to configure the storage
10508	location and properties (the <link to="IMediumFormat::describeProperties"/>
10509	method is used to get access to properties supported by the given medium format).
10510	</desc>
10511	</const>
10512
10513	<const name="CapabilityMask" value="0xFF"/>
10514	</enum>
10515
10516	<interface
10517	name="IMediumFormat" extends="$unknown"
10518	uuid="89f52554-d469-4799-9fad-1705e86a08b1"
10519	wsmap="managed"
10520	>
10521	<desc>
10522	The IMediumFormat interface represents a medium format.
10523
10524	Each medium format has an associated backend which is used to handle
10525	media stored in this format. This interface provides information
10526	about the properties of the associated backend.
10527
10528	Each medium format is identified by a string represented by the
10529	<link to="#id"/> attribute. This string is used in calls like
10530	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10531	format.
10532
10533	The list of all supported medium formats can be obtained using
10534	<link to="ISystemProperties::mediaFormats"/>.
10535
10536	<see>IMedium</see>
10537	</desc>
10538
10539	<attribute name="id" type="wstring" readonly="yes">
10540	<desc>
10541	Identifier of this format.
10542
10543	The format identifier is a non-@c null non-empty ASCII string. Note that
10544	this string is case-insensitive. This means that, for example, all of
10545	the following strings:
10546	<pre>
10547	"VDI"
10548	"vdi"
10549	"VdI"</pre>
10550	refer to the same medium format.
10551
10552	This string is used in methods of other interfaces where it is necessary
10553	to specify a medium format, such as
10554	<link to="IVirtualBox::createHardDisk"/>.
10555	</desc>
10556	</attribute>
10557
10558	<attribute name="name" type="wstring" readonly="yes">
10559	<desc>
10560	Human readable description of this format.
10561
10562	Mainly for use in file open dialogs.
10563	</desc>
10564	</attribute>
10565
10566	<attribute name="fileExtensions" type="wstring" safearray="yes" readonly="yes">
10567	<desc>
10568	Array of strings containing the supported file extensions.
10569
10570	The first extension in the array is the extension preferred by the
10571	backend. It is recommended to use this extension when specifying a
10572	location of the storage unit for a new medium.
10573
10574	Note that some backends do not work on files, so this array may be
10575	empty.
10576
10577	<see>IMediumFormat::capabilities</see>
10578	</desc>
10579	</attribute>
10580
10581	<attribute name="capabilities" type="unsigned long" readonly="yes">
10582	<desc>
10583	Capabilities of the format as a set of bit flags.
10584
10585	For the meaning of individual capability flags see
10586	<link to="MediumFormatCapabilities"/>.
10587	</desc>
10588	</attribute>
10589
10590	<method name="describeProperties">
10591	<desc>
10592	Returns several arrays describing the properties supported by this
10593	format.
10594
10595	An element with the given index in each array describes one
10596	property. Thus, the number of elements in each returned array is the
10597	same and corresponds to the number of supported properties.
10598
10599	The returned arrays are filled in only if the
10600	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10601	All arguments must be non-@c null.
10602
10603	<see>DataType</see>
10604	<see>DataFlags</see>
10605	</desc>
10606
10607	<param name="names" type="wstring" safearray="yes" dir="out">
10608	<desc>Array of property names.</desc>
10609	</param>
10610	<param name="description" type="wstring" safearray="yes" dir="out">
10611	<desc>Array of property descriptions.</desc>
10612	</param>
10613	<param name="types" type="DataType" safearray="yes" dir="out">
10614	<desc>Array of property types.</desc>
10615	</param>
10616	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10617	<desc>Array of property flags.</desc>
10618	</param>
10619	<param name="defaults" type="wstring" safearray="yes" dir="out">
10620	<desc>Array of default property values.</desc>
10621	</param>
10622	</method>
10623
10624	</interface>
10625
10626
10627	<!--
10628	// IKeyboard
10629	/////////////////////////////////////////////////////////////////////////
10630	-->
10631
10632	<interface
10633	name="IKeyboard" extends="$unknown"
10634	uuid="2d1a531b-4c6e-49cc-8af6-5c857b78b5d7"
10635	wsmap="managed"
10636	>
10637	<desc>
10638	The IKeyboard interface represents the virtual machine's keyboard. Used
10639	in <link to="IConsole::keyboard"/>.
10640
10641	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10642	to the virtual machine.
10643
10644	</desc>
10645	<method name="putScancode">
10646	<desc>Sends a scancode to the keyboard.
10647
10648	<result name="VBOX_E_IPRT_ERROR">
10649	Could not send scan code to virtual keyboard.
10650	</result>
10651
10652	</desc>
10653	<param name="scancode" type="long" dir="in"/>
10654	</method>
10655
10656	<method name="putScancodes">
10657	<desc>Sends an array of scancodes to the keyboard.
10658
10659	<result name="VBOX_E_IPRT_ERROR">
10660	Could not send all scan codes to virtual keyboard.
10661	</result>
10662
10663	</desc>
10664	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10665	<param name="codesStored" type="unsigned long" dir="return"/>
10666	</method>
10667
10668	<method name="putCAD">
10669	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10670	function is nothing special, it is just a convenience function
10671	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10672
10673	<result name="VBOX_E_IPRT_ERROR">
10674	Could not send all scan codes to virtual keyboard.
10675	</result>
10676
10677	</desc>
10678	</method>
10679
10680	</interface>
10681
10682
10683	<!--
10684	// IMouse
10685	/////////////////////////////////////////////////////////////////////////
10686	-->
10687
10688	<enum
10689	name="MouseButtonState"
10690	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10691	>
10692	<desc>
10693	Mouse button state.
10694	</desc>
10695
10696	<const name="LeftButton" value="0x01"/>
10697	<const name="RightButton" value="0x02"/>
10698	<const name="MiddleButton" value="0x04"/>
10699	<const name="WheelUp" value="0x08"/>
10700	<const name="WheelDown" value="0x10"/>
10701	<const name="XButton1" value="0x20"/>
10702	<const name="XButton2" value="0x40"/>
10703	<const name="MouseStateMask" value="0x7F"/>
10704	</enum>
10705
10706	<interface
10707	name="IMouse" extends="$unknown"
10708	uuid="7c0f2eae-f92d-498c-b802-e1a3763774dc"
10709	wsmap="managed"
10710	>
10711	<desc>
10712	The IMouse interface represents the virtual machine's mouse. Used in
10713	<link to="IConsole::mouse"/>.
10714
10715	Through this interface, the virtual machine's virtual mouse can be
10716	controlled.
10717	</desc>
10718
10719	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10720	<desc>
10721	Whether the guest OS supports absolute mouse pointer positioning
10722	or not.
10723	<note>
10724	You can use the <link to="IConsoleCallback::onMouseCapabilityChange"/>
10725	callback to be instantly informed about changes of this attribute
10726	during virtual machine execution.
10727	</note>
10728	<see><link to="#putMouseEventAbsolute"/></see>
10729	</desc>
10730	</attribute>
10731
10732	<attribute name="relativeSupported" type="boolean" readonly="yes">
10733	<desc>
10734	Whether the guest OS supports relative mouse pointer positioning
10735	or not.
10736	<note>
10737	You can use the <link to="IConsoleCallback::onMouseCapabilityChange"/>
10738	callback to be instantly informed about changes of this attribute
10739	during virtual machine execution.
10740	</note>
10741	<see><link to="#putMouseEvent"/></see>
10742	</desc>
10743	</attribute>
10744
10745	<attribute name="needsHostCursor" type="boolean" readonly="yes">
10746	<desc>
10747	Whether the guest OS can currently switch to drawing it's own mouse
10748	cursor on demand.
10749	<note>
10750	You can use the <link to="IConsoleCallback::onMouseCapabilityChange"/>
10751	callback to be instantly informed about changes of this attribute
10752	during virtual machine execution.
10753	</note>
10754	<see><link to="#putMouseEvent"/></see>
10755	</desc>
10756	</attribute>
10757
10758	<method name="putMouseEvent">
10759	<desc>
10760	Initiates a mouse event using relative pointer movements
10761	along x and y axis.
10762
10763	<result name="E_ACCESSDENIED">
10764	Console not powered up.
10765	</result>
10766	<result name="VBOX_E_IPRT_ERROR">
10767	Could not send mouse event to virtual mouse.
10768	</result>
10769
10770	</desc>
10771
10772	<param name="dx" type="long" dir="in">
10773	<desc>
10774	Amount of pixels the mouse should move to the right.
10775	Negative values move the mouse to the left.
10776	</desc>
10777	</param>
10778	<param name="dy" type="long" dir="in">
10779	<desc>
10780	Amount of pixels the mouse should move downwards.
10781	Negative values move the mouse upwards.
10782	</desc>
10783	</param>
10784	<param name="dz" type="long" dir="in">
10785	<desc>
10786	Amount of mouse wheel moves.
10787	Positive values describe clockwise wheel rotations,
10788	negative values describe counterclockwise rotations.
10789	</desc>
10790	</param>
10791	<param name="dw" type="long" dir="in">
10792	<desc>
10793	Amount of horizontal mouse wheel moves.
10794	Positive values describe a movement to the left,
10795	negative values describe a movement to the right.
10796	</desc>
10797	</param>
10798	<param name="buttonState" type="long" dir="in">
10799	<desc>
10800	The current state of mouse buttons. Every bit represents
10801	a mouse button as follows:
10802	<table>
10803	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10804	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10805	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10806	</table>
10807	A value of <tt>1</tt> means the corresponding button is pressed.
10808	otherwise it is released.
10809	</desc>
10810	</param>
10811	</method>
10812
10813	<method name="putMouseEventAbsolute">
10814	<desc>
10815	Positions the mouse pointer using absolute x and y coordinates.
10816	These coordinates are expressed in pixels and
10817	start from <tt>[1,1]</tt> which corresponds to the top left
10818	corner of the virtual display.
10819
10820	<result name="E_ACCESSDENIED">
10821	Console not powered up.
10822	</result>
10823	<result name="VBOX_E_IPRT_ERROR">
10824	Could not send mouse event to virtual mouse.
10825	</result>
10826
10827	<note>
10828	This method will have effect only if absolute mouse
10829	positioning is supported by the guest OS.
10830	</note>
10831
10832	<see><link to="#absoluteSupported"/></see>
10833	</desc>
10834
10835	<param name="x" type="long" dir="in">
10836	<desc>
10837	X coordinate of the pointer in pixels, starting from @c 1.
10838	</desc>
10839	</param>
10840	<param name="y" type="long" dir="in">
10841	<desc>
10842	Y coordinate of the pointer in pixels, starting from @c 1.
10843	</desc>
10844	</param>
10845	<param name="dz" type="long" dir="in">
10846	<desc>
10847	Amount of mouse wheel moves.
10848	Positive values describe clockwise wheel rotations,
10849	negative values describe counterclockwise rotations.
10850	</desc>
10851	</param>
10852	<param name="dw" type="long" dir="in">
10853	<desc>
10854	Amount of horizontal mouse wheel moves.
10855	Positive values describe a movement to the left,
10856	negative values describe a movement to the right.
10857	</desc>
10858	</param>
10859	<param name="buttonState" type="long" dir="in">
10860	<desc>
10861	The current state of mouse buttons. Every bit represents
10862	a mouse button as follows:
10863	<table>
10864	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10865	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10866	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10867	</table>
10868	A value of @c 1 means the corresponding button is pressed.
10869	otherwise it is released.
10870	</desc>
10871	</param>
10872	</method>
10873
10874	</interface>
10875
10876	<!--
10877	// IDisplay
10878	/////////////////////////////////////////////////////////////////////////
10879	-->
10880
10881	<enum
10882	name="FramebufferPixelFormat"
10883	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10884	>
10885	<desc>
10886	Format of the video memory buffer. Constants represented by this enum can
10887	be used to test for particular values of <link
10888	to="IFramebuffer::pixelFormat"/>. See also <link
10889	to="IFramebuffer::requestResize"/>.
10890
10891	See also www.fourcc.org for more information about FOURCC pixel formats.
10892	</desc>
10893
10894	<const name="Opaque" value="0">
10895	<desc>
10896	Unknown buffer format (the user may not assume any particular format of
10897	the buffer).
10898	</desc>
10899	</const>
10900	<const name="FOURCC_RGB" value="0x32424752">
10901	<desc>
10902	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10903	bit layout).
10904	</desc>
10905	</const>
10906	</enum>
10907
10908	<interface
10909	name="IFramebuffer" extends="$unknown"
10910	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10911	wsmap="suppress"
10912	>
10913	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10914	<desc>Address of the start byte of the frame buffer.</desc>
10915	</attribute>
10916
10917	<attribute name="width" type="unsigned long" readonly="yes">
10918	<desc>Frame buffer width, in pixels.</desc>
10919	</attribute>
10920
10921	<attribute name="height" type="unsigned long" readonly="yes">
10922	<desc>Frame buffer height, in pixels.</desc>
10923	</attribute>
10924
10925	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10926	<desc>
10927	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10928	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10929	are: 8, 15, 16, 24 and 32.
10930	</desc>
10931	</attribute>
10932
10933	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10934	<desc>
10935	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10936	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10937	size of the scan line must be aligned to 32 bits.
10938	</desc>
10939	</attribute>
10940
10941	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10942	<desc>
10943	Frame buffer pixel format. It's either one of the values defined by <link
10944	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10945	<note>
10946	This attribute must never return <link
10947	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10948	<link to="#address"/> points to must be always known.
10949	</note>
10950	</desc>
10951	</attribute>
10952
10953	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10954	<desc>
10955	Defines whether this frame buffer uses the virtual video card's memory
10956	buffer (guest VRAM) directly or not. See <link
10957	to="IFramebuffer::requestResize"/> for more information.
10958	</desc>
10959	</attribute>
10960
10961	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10962	<desc>
10963	Hint from the frame buffer about how much of the standard
10964	screen height it wants to use for itself. This information is
10965	exposed to the guest through the VESA BIOS and VMMDev interface
10966	so that it can use it for determining its video mode table. It
10967	is not guaranteed that the guest respects the value.
10968	</desc>
10969	</attribute>
10970
10971	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10972	<desc>
10973	An alpha-blended overlay which is superposed over the frame buffer.
10974	The initial purpose is to allow the display of icons providing
10975	information about the VM state, including disk activity, in front
10976	ends which do not have other means of doing that. The overlay is
10977	designed to controlled exclusively by IDisplay. It has no locking
10978	of its own, and any changes made to it are not guaranteed to be
10979	visible until the affected portion of IFramebuffer is updated. The
10980	overlay can be created lazily the first time it is requested. This
10981	attribute can also return @c null to signal that the overlay is not
10982	implemented.
10983	</desc>
10984	</attribute>
10985
10986	<attribute name="winId" type="unsigned long long" readonly="yes">
10987	<desc>
10988	Platform-dependent identifier of the window where context of this
10989	frame buffer is drawn, or zero if there's no such window.
10990	</desc>
10991	</attribute>
10992
10993	<method name="lock">
10994	<desc>
10995	Locks the frame buffer.
10996	Gets called by the IDisplay object where this frame buffer is
10997	bound to.
10998	</desc>
10999	</method>
11000
11001	<method name="unlock">
11002	<desc>
11003	Unlocks the frame buffer.
11004	Gets called by the IDisplay object where this frame buffer is
11005	bound to.
11006	</desc>
11007	</method>
11008
11009	<method name="notifyUpdate">
11010	<desc>
11011	Informs about an update.
11012	Gets called by the display object where this buffer is
11013	registered.
11014	</desc>
11015	<param name="x" type="unsigned long" dir="in"/>
11016	<param name="y" type="unsigned long" dir="in"/>
11017	<param name="width" type="unsigned long" dir="in"/>
11018	<param name="height" type="unsigned long" dir="in"/>
11019	</method>
11020
11021	<method name="requestResize">
11022	<desc>
11023	Requests a size and pixel format change.
11024
11025	There are two modes of working with the video buffer of the virtual
11026	machine. The <i>indirect</i> mode implies that the IFramebuffer
11027	implementation allocates a memory buffer for the requested display mode
11028	and provides it to the virtual machine. In <i>direct</i> mode, the
11029	IFramebuffer implementation uses the memory buffer allocated and owned
11030	by the virtual machine. This buffer represents the video memory of the
11031	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
11032	usually faster because the implementation gets a raw pointer to the
11033	guest VRAM buffer which it can directly use for visualizing the contents
11034	of the virtual display, as opposed to the indirect mode where the
11035	contents of guest VRAM are copied to the memory buffer provided by
11036	the implementation every time a display update occurs.
11037
11038	It is important to note that the direct mode is really fast only when
11039	the implementation uses the given guest VRAM buffer directly, for
11040	example, by blitting it to the window representing the virtual machine's
11041	display, which saves at least one copy operation comparing to the
11042	indirect mode. However, using the guest VRAM buffer directly is not
11043	always possible: the format and the color depth of this buffer may be
11044	not supported by the target window, or it may be unknown (opaque) as in
11045	case of text or non-linear multi-plane VGA video modes. In this case,
11046	the indirect mode (that is always available) should be used as a
11047	fallback: when the guest VRAM contents are copied to the
11048	implementation-provided memory buffer, color and format conversion is
11049	done automatically by the underlying code.
11050
11051	The @a pixelFormat parameter defines whether the direct mode is
11052	available or not. If @a pixelFormat is <link
11053	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
11054	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
11055	@a bytesPerLine parameters must be ignored and the implementation must use
11056	the indirect mode (where it provides its own buffer in one of the
11057	supported formats). In all other cases, @a pixelFormat together with
11058	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
11059	buffer pointed to by the @a VRAM parameter and the implementation is
11060	free to choose which mode to use. To indicate that this frame buffer uses
11061	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
11062	attribute must return @c true and <link to="#address"/> must
11063	return exactly the same address that is passed in the @a VRAM parameter
11064	of this method; otherwise it is assumed that the indirect strategy is
11065	chosen.
11066
11067	The @a width and @a height parameters represent the size of the
11068	requested display mode in both modes. In case of indirect mode, the
11069	provided memory buffer should be big enough to store data of the given
11070	display mode. In case of direct mode, it is guaranteed that the given
11071	@a VRAM buffer contains enough space to represent the display mode of the
11072	given size. Note that this frame buffer's <link to="#width"/> and <link
11073	to="#height"/> attributes must return exactly the same values as
11074	passed to this method after the resize is completed (see below).
11075
11076	The @a finished output parameter determines if the implementation has
11077	finished resizing the frame buffer or not. If, for some reason, the
11078	resize cannot be finished immediately during this call, @a finished
11079	must be set to @c false, and the implementation must call
11080	<link to="IDisplay::resizeCompleted"/> after it has returned from
11081	this method as soon as possible. If @a finished is @c false, the
11082	machine will not call any frame buffer methods until
11083	<link to="IDisplay::resizeCompleted"/> is called.
11084
11085	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
11086	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
11087	this frame buffer must return exactly the same values as specified in the
11088	parameters of this method, after the resize is completed. If the
11089	indirect mode is chosen, these attributes must return values describing
11090	the format of the implementation's own memory buffer <link
11091	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
11092	value must always correlate with <link to="#pixelFormat"/>. Note that
11093	the <link to="#pixelFormat"/> attribute must never return <link
11094	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
11095
11096	<note>
11097	This method is called by the IDisplay object under the
11098	<link to="#lock"/> provided by this IFramebuffer
11099	implementation. If this method returns @c false in @a finished, then
11100	this lock is not released until
11101	<link to="IDisplay::resizeCompleted"/> is called.
11102	</note>
11103	</desc>
11104	<param name="screenId" type="unsigned long" dir="in">
11105	<desc>
11106	Logical screen number. Must be used in the corresponding call to
11107	<link to="IDisplay::resizeCompleted"/> if this call is made.
11108	</desc>
11109	</param>
11110	<param name="pixelFormat" type="unsigned long" dir="in">
11111	<desc>
11112	Pixel format of the memory buffer pointed to by @a VRAM.
11113	See also <link to="FramebufferPixelFormat"/>.
11114	</desc>
11115	</param>
11116	<param name="VRAM" type="octet" mod="ptr" dir="in">
11117	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
11118	</param>
11119	<param name="bitsPerPixel" type="unsigned long" dir="in">
11120	<desc>Color depth, bits per pixel.</desc>
11121	</param>
11122	<param name="bytesPerLine" type="unsigned long" dir="in">
11123	<desc>Size of one scan line, in bytes.</desc>
11124	</param>
11125	<param name="width" type="unsigned long" dir="in">
11126	<desc>Width of the guest display, in pixels.</desc>
11127	</param>
11128	<param name="height" type="unsigned long" dir="in">
11129	<desc>Height of the guest display, in pixels.</desc>
11130	</param>
11131	<param name="finished" type="boolean" dir="return">
11132	<desc>
11133	Can the VM start using the new frame buffer immediately
11134	after this method returns or it should wait for
11135	<link to="IDisplay::resizeCompleted"/>.
11136	</desc>
11137	</param>
11138	</method>
11139
11140	<method name="videoModeSupported">
11141	<desc>
11142	Returns whether the frame buffer implementation is willing to
11143	support a given video mode. In case it is not able to render
11144	the video mode (or for some reason not willing), it should
11145	return @c false. Usually this method is called when the guest
11146	asks the VMM device whether a given video mode is supported
11147	so the information returned is directly exposed to the guest.
11148	It is important that this method returns very quickly.
11149	</desc>
11150	<param name="width" type="unsigned long" dir="in"/>
11151	<param name="height" type="unsigned long" dir="in"/>
11152	<param name="bpp" type="unsigned long" dir="in"/>
11153	<param name="supported" type="boolean" dir="return"/>
11154	</method>
11155
11156	<method name="getVisibleRegion">
11157	<desc>
11158	Returns the visible region of this frame buffer.
11159
11160	If the @a rectangles parameter is @c null then the value of the
11161	@a count parameter is ignored and the number of elements necessary to
11162	describe the current visible region is returned in @a countCopied.
11163
11164	If @a rectangles is not @c null but @a count is less
11165	than the required number of elements to store region data, the method
11166	will report a failure. If @a count is equal or greater than the
11167	required number of elements, then the actual number of elements copied
11168	to the provided array will be returned in @a countCopied.
11169
11170	<note>
11171	The address of the provided array must be in the process space of
11172	this IFramebuffer object.
11173	</note>
11174	<note>
11175	Method not yet implemented.
11176	</note>
11177	</desc>
11178	<param name="rectangles" type="octet" mod="ptr" dir="in">
11179	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
11180	</param>
11181	<param name="count" type="unsigned long" dir="in">
11182	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11183	</param>
11184	<param name="countCopied" type="unsigned long" dir="return">
11185	<desc>Number of elements copied to the @a rectangles array.</desc>
11186	</param>
11187	</method>
11188
11189	<method name="setVisibleRegion">
11190	<desc>
11191	Suggests a new visible region to this frame buffer. This region
11192	represents the area of the VM display which is a union of regions of
11193	all top-level windows of the guest operating system running inside the
11194	VM (if the Guest Additions for this system support this
11195	functionality). This information may be used by the frontends to
11196	implement the seamless desktop integration feature.
11197
11198	<note>
11199	The address of the provided array must be in the process space of
11200	this IFramebuffer object.
11201	</note>
11202	<note>
11203	The IFramebuffer implementation must make a copy of the provided
11204	array of rectangles.
11205	</note>
11206	<note>
11207	Method not yet implemented.
11208	</note>
11209	</desc>
11210	<param name="rectangles" type="octet" mod="ptr" dir="in">
11211	<desc>Pointer to the @c RTRECT array.</desc>
11212	</param>
11213	<param name="count" type="unsigned long" dir="in">
11214	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11215	</param>
11216	</method>
11217
11218	<method name="processVHWACommand">
11219	<desc>
11220	Posts a Video HW Acceleration Command to the frame buffer for processing.
11221	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color covnersion, overlaying, etc.)
11222	are posted from quest to the host to be processed by the host hardware.
11223
11224	<note>
11225	The address of the provided command must be in the process space of
11226	this IFramebuffer object.
11227	</note>
11228	</desc>
11229
11230	<param name="command" type="octet" mod="ptr" dir="in">
11231	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
11232	</param>
11233	</method>
11234
11235	</interface>
11236
11237	<interface
11238	name="IFramebufferOverlay" extends="IFramebuffer"
11239	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
11240	wsmap="suppress"
11241	>
11242	<desc>
11243	The IFramebufferOverlay interface represents an alpha blended overlay
11244	for displaying status icons above an IFramebuffer. It is always created
11245	not visible, so that it must be explicitly shown. It only covers a
11246	portion of the IFramebuffer, determined by its width, height and
11247	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
11248	that order) format, and may be written to directly. Do re-read the
11249	width though, after setting it, as it may be adjusted (increased) to
11250	make it more suitable for the front end.
11251	</desc>
11252	<attribute name="x" type="unsigned long" readonly="yes">
11253	<desc>X position of the overlay, relative to the frame buffer.</desc>
11254	</attribute>
11255
11256	<attribute name="y" type="unsigned long" readonly="yes">
11257	<desc>Y position of the overlay, relative to the frame buffer.</desc>
11258	</attribute>
11259
11260	<attribute name="visible" type="boolean" readonly="no">
11261	<desc>
11262	Whether the overlay is currently visible.
11263	</desc>
11264	</attribute>
11265
11266	<attribute name="alpha" type="unsigned long" readonly="no">
11267	<desc>
11268	The global alpha value for the overlay. This may or may not be
11269	supported by a given front end.
11270	</desc>
11271	</attribute>
11272
11273	<method name="move">
11274	<desc>
11275	Changes the overlay's position relative to the IFramebuffer.
11276	</desc>
11277	<param name="x" type="unsigned long" dir="in"/>
11278	<param name="y" type="unsigned long" dir="in"/>
11279	</method>
11280
11281	</interface>
11282
11283	<interface
11284	name="IDisplay" extends="$unknown"
11285	uuid="e2a38ebc-d854-4a3e-bc2e-fdf5ac4a0000"
11286	wsmap="managed"
11287	>
11288	<desc>
11289	The IDisplay interface represents the virtual machine's display.
11290
11291	The object implementing this interface is contained in each
11292	<link to="IConsole::display"/> attribute and represents the visual
11293	output of the virtual machine.
11294
11295	The virtual display supports pluggable output targets represented by the
11296	IFramebuffer interface. Examples of the output target are a window on
11297	the host computer or an RDP session's display on a remote computer.
11298	</desc>
11299	<attribute name="width" type="unsigned long" readonly="yes">
11300	<desc>Current display width.</desc>
11301	</attribute>
11302
11303	<attribute name="height" type="unsigned long" readonly="yes">
11304	<desc>Current display height.</desc>
11305	</attribute>
11306
11307	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
11308	<desc>
11309	Current guest display color depth. Note that this may differ
11310	from <link to="IFramebuffer::bitsPerPixel"/>.
11311	</desc>
11312	</attribute>
11313
11314	<method name="setFramebuffer">
11315	<desc>
11316	Sets the framebuffer for given screen.
11317	</desc>
11318	<param name="screenId" type="unsigned long" dir="in"/>
11319	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11320	</method>
11321
11322	<method name="getFramebuffer">
11323	<desc>
11324	Queries the framebuffer for given screen.
11325	</desc>
11326	<param name="screenId" type="unsigned long" dir="in"/>
11327	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11328	<param name="xOrigin" type="long" dir="out"/>
11329	<param name="yOrigin" type="long" dir="out"/>
11330	</method>
11331
11332	<method name="setVideoModeHint">
11333	<desc>
11334	Asks VirtualBox to request the given video mode from
11335	the guest. This is just a hint and it cannot be guaranteed
11336	that the requested resolution will be used. Guest Additions
11337	are required for the request to be seen by guests. The caller
11338	should issue the request and wait for a resolution change and
11339	after a timeout retry.
11340
11341	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11342	parameters means that the corresponding values should be taken from the
11343	current video mode (i.e. left unchanged).
11344
11345	If the guest OS supports multi-monitor configuration then the @a display
11346	parameter specifies the number of the guest display to send the hint to:
11347	@c 0 is the primary display, @c 1 is the first secondary and
11348	so on. If the multi-monitor configuration is not supported, @a display
11349	must be @c 0.
11350
11351	<result name="E_INVALIDARG">
11352	The @a display is not associated with any monitor.
11353	</result>
11354
11355	</desc>
11356	<param name="width" type="unsigned long" dir="in"/>
11357	<param name="height" type="unsigned long" dir="in"/>
11358	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11359	<param name="display" type="unsigned long" dir="in"/>
11360	</method>
11361
11362	<method name="setSeamlessMode">
11363	<desc>
11364	Enables or disables seamless guest display rendering (seamless desktop
11365	integration) mode.
11366	<note>
11367	Calling this method has no effect if <link
11368	to="IGuest::supportsSeamless"/> returns @c false.
11369	</note>
11370	</desc>
11371	<param name="enabled" type="boolean" dir="in"/>
11372	</method>
11373
11374	<method name="takeScreenShot">
11375	<desc>
11376	Takes a screen shot of the requested size and copies it to the
11377	32-bpp buffer allocated by the caller and pointed to by @a address.
11378	A pixel consists of 4 bytes in order: B, G, R, 0.
11379
11380	<note>This API can be used only by the COM/XPCOM C++ API as it
11381	requires pointer support. Use <link to="#takeScreenShotSlow" />
11382	with other language bindings.
11383	</note>
11384
11385	<result name="E_NOTIMPL">
11386	Feature not implemented.
11387	</result>
11388	<result name="VBOX_E_IPRT_ERROR">
11389	Could not take a screenshot.
11390	</result>
11391
11392	</desc>
11393	<param name="address" type="octet" mod="ptr" dir="in"/>
11394	<param name="width" type="unsigned long" dir="in"/>
11395	<param name="height" type="unsigned long" dir="in"/>
11396	</method>
11397
11398	<method name="takeScreenShotSlow">
11399	<desc>
11400	Takes a guest screen shot of the requested size and returns it as
11401	an array of bytes in uncompressed 32-bit RGBA format.
11402	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11403
11404	This API is slow, but could be the only option to get guest screenshot
11405	for scriptable languages not allowed to manipulate with addresses
11406	directly.
11407
11408	<result name="E_NOTIMPL">
11409	Feature not implemented.
11410	</result>
11411	<result name="VBOX_E_IPRT_ERROR">
11412	Could not take a screenshot.
11413	</result>
11414	</desc>
11415	<param name="width" type="unsigned long" dir="in">
11416	<desc>
11417	Desired image width.
11418	</desc>
11419	</param>
11420	<param name="height" type="unsigned long" dir="in">
11421	<desc>
11422	Desired image height.
11423	</desc>
11424	</param>
11425	<param name="screenData" type="octet" dir="return" safearray="yes">
11426	<desc>
11427	Array with resulting screen data.
11428	</desc>
11429	</param>
11430	</method>
11431
11432	<method name="drawToScreen">
11433	<desc>
11434	Draws a 32-bpp image of the specified size from the given buffer
11435	to the given point on the VM display.
11436
11437	<result name="E_NOTIMPL">
11438	Feature not implemented.
11439	</result>
11440	<result name="VBOX_E_IPRT_ERROR">
11441	Could not draw to screen.
11442	</result>
11443
11444	</desc>
11445	<param name="address" type="octet" mod="ptr" dir="in"/>
11446	<param name="x" type="unsigned long" dir="in"/>
11447	<param name="y" type="unsigned long" dir="in"/>
11448	<param name="width" type="unsigned long" dir="in"/>
11449	<param name="height" type="unsigned long" dir="in"/>
11450	</method>
11451
11452	<method name="invalidateAndUpdate">
11453	<desc>
11454	Does a full invalidation of the VM display and instructs the VM
11455	to update it.
11456
11457	<result name="VBOX_E_IPRT_ERROR">
11458	Could not invalidate and update screen.
11459	</result>
11460
11461	</desc>
11462	</method>
11463
11464	<method name="resizeCompleted">
11465	<desc>
11466	Signals that a framebuffer has completed the resize operation.
11467
11468	<result name="VBOX_E_NOT_SUPPORTED">
11469	Operation only valid for external frame buffers.
11470	</result>
11471
11472	</desc>
11473	<param name="screenId" type="unsigned long" dir="in"/>
11474	</method>
11475
11476	<method name="updateCompleted">
11477	<desc>
11478	Signals that a framebuffer has completed the update operation.
11479
11480	<result name="VBOX_E_NOT_SUPPORTED">
11481	Operation only valid for external frame buffers.
11482	</result>
11483
11484	</desc>
11485	</method>
11486
11487	<method name="completeVHWACommand">
11488	<desc>
11489	Signals that the Video HW Acceleration command has completed.
11490	</desc>
11491
11492	<param name="command" type="octet" mod="ptr" dir="in">
11493	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11494	</param>
11495	</method>
11496
11497	</interface>
11498
11499	<!--
11500	// INetworkAdapter
11501	/////////////////////////////////////////////////////////////////////////
11502	-->
11503
11504	<enum
11505	name="NetworkAttachmentType"
11506	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11507	>
11508	<desc>
11509	Network attachment type.
11510	</desc>
11511
11512	<const name="Null" value="0">
11513	<desc>Null value, also means "not attached".</desc>
11514	</const>
11515	<const name="NAT" value="1"/>
11516	<const name="Bridged" value="2"/>
11517	<const name="Internal" value="3"/>
11518	<const name="HostOnly" value="4"/>
11519	</enum>
11520
11521	<enum
11522	name="NetworkAdapterType"
11523	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11524	>
11525	<desc>
11526	Network adapter type.
11527	</desc>
11528
11529	<const name="Null" value="0">
11530	<desc>Null value (never used by the API).</desc>
11531	</const>
11532	<const name="Am79C970A" value="1">
11533	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11534	</const>
11535	<const name="Am79C973" value="2">
11536	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11537	</const>
11538	<const name="I82540EM" value="3">
11539	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11540	</const>
11541	<const name="I82543GC" value="4">
11542	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11543	</const>
11544	<const name="I82545EM" value="5">
11545	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11546	</const>
11547	<const name="Virtio" value="6">
11548	<desc>Virtio network device.</desc>
11549	</const>
11550	</enum>
11551
11552	<interface
11553	name="INetworkAdapter" extends="$unknown"
11554	uuid="65607a27-2b73-4d43-b4cc-0ba2c817fbde"
11555	wsmap="managed"
11556	>
11557	<desc>
11558	Represents a virtual network adapter that is attached to a virtual machine.
11559	Each virtual machine has a fixed number of network adapter slots with one
11560	instance of this attached to each of them. Call
11561	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11562	is attached to a given slot in a given machine.
11563
11564	Each network adapter can be in one of five attachment modes, which are
11565	represented by the <link to="NetworkAttachmentType" /> enumeration;
11566	see the <link to="#attachmentType" /> attribute.
11567	</desc>
11568
11569	<attribute name="adapterType" type="NetworkAdapterType">
11570	<desc>
11571	Type of the virtual network adapter. Depending on this value,
11572	VirtualBox will provide a different virtual network hardware
11573	to the guest.
11574	</desc>
11575	</attribute>
11576
11577	<attribute name="slot" type="unsigned long" readonly="yes">
11578	<desc>
11579	Slot number this adapter is plugged into. Corresponds to
11580	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11581	to obtain this instance.
11582	</desc>
11583	</attribute>
11584
11585	<attribute name="enabled" type="boolean">
11586	<desc>
11587	Flag whether the network adapter is present in the
11588	guest system. If disabled, the virtual guest hardware will
11589	not contain this network adapter. Can only be changed when
11590	the VM is not running.
11591	</desc>
11592	</attribute>
11593
11594	<attribute name="MACAddress" type="wstring">
11595	<desc>
11596	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11597	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11598	</desc>
11599	</attribute>
11600
11601	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11602
11603	<attribute name="hostInterface" type="wstring">
11604	<desc>
11605	Name of the host network interface the VM is attached to.
11606	</desc>
11607	</attribute>
11608
11609	<attribute name="internalNetwork" type="wstring">
11610	<desc>
11611	Name of the internal network the VM is attached to.
11612	</desc>
11613	</attribute>
11614
11615	<attribute name="NATNetwork" type="wstring">
11616	<desc>
11617	Name of the NAT network the VM is attached to.
11618	</desc>
11619	</attribute>
11620
11621	<attribute name="cableConnected" type="boolean">
11622	<desc>
11623	Flag whether the adapter reports the cable as connected or not.
11624	It can be used to report offline situations to a VM.
11625	</desc>
11626	</attribute>
11627
11628	<attribute name="lineSpeed" type="unsigned long">
11629	<desc>
11630	Line speed reported by custom drivers, in units of 1 kbps.
11631	</desc>
11632	</attribute>
11633
11634	<attribute name="traceEnabled" type="boolean">
11635	<desc>
11636	Flag whether network traffic from/to the network card should be traced.
11637	Can only be toggled when the VM is turned off.
11638	</desc>
11639	</attribute>
11640
11641	<attribute name="traceFile" type="wstring">
11642	<desc>
11643	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11644	will be used.
11645	</desc>
11646	</attribute>
11647
11648	<method name="attachToNAT">
11649	<desc>
11650	Attach the network adapter to the Network Address Translation (NAT) interface.
11651	</desc>
11652	</method>
11653
11654	<method name="attachToBridgedInterface">
11655	<desc>
11656	Attach the network adapter to a bridged host interface.
11657	</desc>
11658	</method>
11659
11660	<method name="attachToInternalNetwork">
11661	<desc>
11662	Attach the network adapter to an internal network.
11663	</desc>
11664	</method>
11665
11666	<method name="attachToHostOnlyInterface">
11667	<desc>
11668	Attach the network adapter to the host-only network.
11669	</desc>
11670	</method>
11671
11672	<method name="detach">
11673	<desc>
11674	Detach the network adapter
11675	</desc>
11676	</method>
11677	</interface>
11678
11679
11680	<!--
11681	// ISerialPort
11682	/////////////////////////////////////////////////////////////////////////
11683	-->
11684
11685	<enum
11686	name="PortMode"
11687	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11688	>
11689	<desc>
11690	The PortMode enumeration represents possible communication modes for
11691	the virtual serial port device.
11692	</desc>
11693
11694	<const name="Disconnected" value="0">
11695	<desc>Virtual device is not attached to any real host device.</desc>
11696	</const>
11697	<const name="HostPipe" value="1">
11698	<desc>Virtual device is attached to a host pipe.</desc>
11699	</const>
11700	<const name="HostDevice" value="2">
11701	<desc>Virtual device is attached to a host device.</desc>
11702	</const>
11703	<const name="RawFile" value="3">
11704	<desc>Virtual device is attached to a raw file.</desc>
11705	</const>
11706	</enum>
11707
11708	<interface
11709	name="ISerialPort" extends="$unknown"
11710	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11711	wsmap="managed"
11712	>
11713
11714	<desc>
11715	The ISerialPort interface represents the virtual serial port device.
11716
11717	The virtual serial port device acts like an ordinary serial port
11718	inside the virtual machine. This device communicates to the real
11719	serial port hardware in one of two modes: host pipe or host device.
11720
11721	In host pipe mode, the #path attribute specifies the path to the pipe on
11722	the host computer that represents a serial port. The #server attribute
11723	determines if this pipe is created by the virtual machine process at
11724	machine startup or it must already exist before starting machine
11725	execution.
11726
11727	In host device mode, the #path attribute specifies the name of the
11728	serial port device on the host computer.
11729
11730	There is also a third communication mode: the disconnected mode. In this
11731	mode, the guest OS running inside the virtual machine will be able to
11732	detect the serial port, but all port write operations will be discarded
11733	and all port read operations will return no data.
11734
11735	<see>IMachine::getSerialPort</see>
11736	</desc>
11737
11738	<attribute name="slot" type="unsigned long" readonly="yes">
11739	<desc>
11740	Slot number this serial port is plugged into. Corresponds to
11741	the value you pass to <link to="IMachine::getSerialPort"/>
11742	to obtain this instance.
11743	</desc>
11744	</attribute>
11745
11746	<attribute name="enabled" type="boolean">
11747	<desc>
11748	Flag whether the serial port is enabled. If disabled,
11749	the serial port will not be reported to the guest OS.
11750	</desc>
11751	</attribute>
11752
11753	<attribute name="IOBase" type="unsigned long">
11754	<desc>Base I/O address of the serial port.</desc>
11755	</attribute>
11756
11757	<attribute name="IRQ" type="unsigned long">
11758	<desc>IRQ number of the serial port.</desc>
11759	</attribute>
11760
11761	<attribute name="hostMode" type="PortMode">
11762	<desc>
11763	How is this port connected to the host.
11764	<note>
11765	Changing this attribute may fail if the conditions for
11766	<link to="#path"/> are not met.
11767	</note>
11768	</desc>
11769	</attribute>
11770
11771	<attribute name="server" type="boolean">
11772	<desc>
11773	Flag whether this serial port acts as a server (creates a new pipe on
11774	the host) or as a client (uses the existing pipe). This attribute is
11775	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11776	</desc>
11777	</attribute>
11778
11779	<attribute name="path" type="wstring">
11780	<desc>
11781	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11782	PortMode_HostPipe, or the host serial device name when
11783	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11784	cases, setting a @c null or empty string as the attribute's value
11785	is an error. Otherwise, the value of this property is ignored.
11786	</desc>
11787	</attribute>
11788
11789	</interface>
11790
11791	<!--
11792	// IParallelPort
11793	/////////////////////////////////////////////////////////////////////////
11794	-->
11795
11796	<interface
11797	name="IParallelPort" extends="$unknown"
11798	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11799	wsmap="managed"
11800	>
11801
11802	<desc>
11803	The IParallelPort interface represents the virtual parallel port device.
11804
11805	The virtual parallel port device acts like an ordinary parallel port
11806	inside the virtual machine. This device communicates to the real
11807	parallel port hardware using the name of the parallel device on the host
11808	computer specified in the #path attribute.
11809
11810	Each virtual parallel port device is assigned a base I/O address and an
11811	IRQ number that will be reported to the guest operating system and used
11812	to operate the given parallel port from within the virtual machine.
11813
11814	<see>IMachine::getParallelPort</see>
11815	</desc>
11816
11817	<attribute name="slot" type="unsigned long" readonly="yes">
11818	<desc>
11819	Slot number this parallel port is plugged into. Corresponds to
11820	the value you pass to <link to="IMachine::getParallelPort"/>
11821	to obtain this instance.
11822	</desc>
11823	</attribute>
11824
11825	<attribute name="enabled" type="boolean">
11826	<desc>
11827	Flag whether the parallel port is enabled. If disabled,
11828	the parallel port will not be reported to the guest OS.
11829	</desc>
11830	</attribute>
11831
11832	<attribute name="IOBase" type="unsigned long">
11833	<desc>Base I/O address of the parallel port.</desc>
11834	</attribute>
11835
11836	<attribute name="IRQ" type="unsigned long">
11837	<desc>IRQ number of the parallel port.</desc>
11838	</attribute>
11839
11840	<attribute name="path" type="wstring">
11841	<desc>
11842	Host parallel device name. If this parallel port is enabled, setting a
11843	@c null or an empty string as this attribute's value will result into
11844	an error.
11845	</desc>
11846	</attribute>
11847
11848	</interface>
11849
11850
11851	<!--
11852	// IMachineDebugger
11853	/////////////////////////////////////////////////////////////////////////
11854	-->
11855
11856	<interface
11857	name="IMachineDebugger" extends="$unknown"
11858	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
11859	wsmap="suppress"
11860	>
11861	<method name="resetStats">
11862	<desc>
11863	Reset VM statistics.
11864	</desc>
11865	<param name="pattern" type="wstring" dir="in">
11866	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11867	</param>
11868	</method>
11869
11870	<method name="dumpStats">
11871	<desc>
11872	Dumps VM statistics.
11873	</desc>
11874	<param name="pattern" type="wstring" dir="in">
11875	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11876	</param>
11877	</method>
11878
11879	<method name="getStats">
11880	<desc>
11881	Get the VM statistics in a XMLish format.
11882	</desc>
11883	<param name="pattern" type="wstring" dir="in">
11884	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11885	</param>
11886	<param name="withDescriptions" type="boolean" dir="in">
11887	<desc>Whether to include the descriptions.</desc>
11888	</param>
11889	<param name="stats" type="wstring" dir="out">
11890	<desc>The XML document containing the statistics.</desc>
11891	</param>
11892	</method>
11893
11894	<method name="injectNMI">
11895	<desc>
11896	Inject an NMI into a running VT-x/AMD-V VM.
11897	</desc>
11898	</method>
11899
11900	<attribute name="singlestep" type="boolean">
11901	<desc>Switch for enabling singlestepping.</desc>
11902	</attribute>
11903
11904	<attribute name="recompileUser" type="boolean">
11905	<desc>Switch for forcing code recompilation for user mode code.</desc>
11906	</attribute>
11907
11908	<attribute name="recompileSupervisor" type="boolean">
11909	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
11910	</attribute>
11911
11912	<attribute name="PATMEnabled" type="boolean">
11913	<desc>Switch for enabling and disabling the PATM component.</desc>
11914	</attribute>
11915
11916	<attribute name="CSAMEnabled" type="boolean">
11917	<desc>Switch for enabling and disabling the CSAM component.</desc>
11918	</attribute>
11919
11920	<attribute name="logEnabled" type="boolean">
11921	<desc>Switch for enabling and disabling logging.</desc>
11922	</attribute>
11923
11924	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
11925	<desc>
11926	Flag indicating whether the VM is currently making use of CPU hardware
11927	virtualization extensions.
11928	</desc>
11929	</attribute>
11930
11931	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
11932	<desc>
11933	Flag indicating whether the VM is currently making use of the nested paging
11934	CPU hardware virtualization extension.
11935	</desc>
11936	</attribute>
11937
11938	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11939	<desc>
11940	Flag indicating whether the VM is currently making use of the VPID
11941	VT-x extension.
11942	</desc>
11943	</attribute>
11944
11945	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11946	<desc>
11947	Flag indicating whether the VM is currently making use of the Physical
11948	Address Extension CPU feature.
11949	</desc>
11950	</attribute>
11951
11952	<attribute name="virtualTimeRate" type="unsigned long">
11953	<desc>
11954	The rate at which the virtual time runs expressed as a percentage.
11955	The accepted range is 2% to 20000%.
11956	</desc>
11957	</attribute>
11958
11959	<!-- @todo method for setting log flags, groups and destination! -->
11960
11961	<attribute name="VM" type="unsigned long long" readonly="yes">
11962	<desc>
11963	Gets the VM handle. This is only for internal use while
11964	we carve the details of this interface.
11965	</desc>
11966	</attribute>
11967
11968	</interface>
11969
11970	<!--
11971	// IUSBController
11972	/////////////////////////////////////////////////////////////////////////
11973	-->
11974
11975	<interface
11976	name="IUSBController" extends="$unknown"
11977	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
11978	wsmap="managed"
11979	>
11980	<attribute name="enabled" type="boolean">
11981	<desc>
11982	Flag whether the USB controller is present in the
11983	guest system. If disabled, the virtual guest hardware will
11984	not contain any USB controller. Can only be changed when
11985	the VM is powered off.
11986	</desc>
11987	</attribute>
11988
11989	<attribute name="enabledEhci" type="boolean">
11990	<desc>
11991	Flag whether the USB EHCI controller is present in the
11992	guest system. If disabled, the virtual guest hardware will
11993	not contain a USB EHCI controller. Can only be changed when
11994	the VM is powered off.
11995	</desc>
11996	</attribute>
11997
11998	<attribute name="proxyAvailable" type="boolean" readonly="yes">
11999	<desc>
12000	Flag whether there is an USB proxy available.
12001	</desc>
12002	</attribute>
12003
12004	<attribute name="USBStandard" type="unsigned short" readonly="yes">
12005	<desc>
12006	USB standard version which the controller implements.
12007	This is a BCD which means that the major version is in the
12008	high byte and minor version is in the low byte.
12009	</desc>
12010	</attribute>
12011
12012	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
12013	<desc>
12014	List of USB device filters associated with the machine.
12015
12016	If the machine is currently running, these filters are activated
12017	every time a new (supported) USB device is attached to the host
12018	computer that was not ignored by global filters
12019	(<link to="IHost::USBDeviceFilters"/>).
12020
12021	These filters are also activated when the machine is powered up.
12022	They are run against a list of all currently available USB
12023	devices (in states
12024	<link to="USBDeviceState_Available"/>,
12025	<link to="USBDeviceState_Busy"/>,
12026	<link to="USBDeviceState_Held"/>) that were not previously
12027	ignored by global filters.
12028
12029	If at least one filter matches the USB device in question, this
12030	device is automatically captured (attached to) the virtual USB
12031	controller of this machine.
12032
12033	<see>IUSBDeviceFilter, ::IUSBController</see>
12034	</desc>
12035	</attribute>
12036
12037	<method name="createDeviceFilter">
12038	<desc>
12039	Creates a new USB device filter. All attributes except
12040	the filter name are set to empty (any match),
12041	<i>active</i> is @c false (the filter is not active).
12042
12043	The created filter can then be added to the list of filters using
12044	<link to="#insertDeviceFilter"/>.
12045
12046	<result name="VBOX_E_INVALID_VM_STATE">
12047	The virtual machine is not mutable.
12048	</result>
12049
12050	<see>#deviceFilters</see>
12051	</desc>
12052	<param name="name" type="wstring" dir="in">
12053	<desc>
12054	Filter name. See <link to="IUSBDeviceFilter::name"/>
12055	for more info.
12056	</desc>
12057	</param>
12058	<param name="filter" type="IUSBDeviceFilter" dir="return">
12059	<desc>Created filter object.</desc>
12060	</param>
12061	</method>
12062
12063	<method name="insertDeviceFilter">
12064	<desc>
12065	Inserts the given USB device to the specified position
12066	in the list of filters.
12067
12068	Positions are numbered starting from <tt>0</tt>. If the specified
12069	position is equal to or greater than the number of elements in
12070	the list, the filter is added to the end of the collection.
12071
12072	<note>
12073	Duplicates are not allowed, so an attempt to insert a
12074	filter that is already in the collection, will return an
12075	error.
12076	</note>
12077
12078	<result name="VBOX_E_INVALID_VM_STATE">
12079	Virtual machine is not mutable.
12080	</result>
12081	<result name="E_INVALIDARG">
12082	USB device filter not created within this VirtualBox instance.
12083	</result>
12084	<result name="VBOX_E_INVALID_OBJECT_STATE">
12085	USB device filter already in list.
12086	</result>
12087
12088	<see>#deviceFilters</see>
12089	</desc>
12090	<param name="position" type="unsigned long" dir="in">
12091	<desc>Position to insert the filter to.</desc>
12092	</param>
12093	<param name="filter" type="IUSBDeviceFilter" dir="in">
12094	<desc>USB device filter to insert.</desc>
12095	</param>
12096	</method>
12097
12098	<method name="removeDeviceFilter">
12099	<desc>
12100	Removes a USB device filter from the specified position in the
12101	list of filters.
12102
12103	Positions are numbered starting from <tt>0</tt>. Specifying a
12104	position equal to or greater than the number of elements in
12105	the list will produce an error.
12106
12107	<see>#deviceFilters</see>
12108
12109	<result name="VBOX_E_INVALID_VM_STATE">
12110	Virtual machine is not mutable.
12111	</result>
12112	<result name="E_INVALIDARG">
12113	USB device filter list empty or invalid @a position.
12114	</result>
12115
12116	</desc>
12117	<param name="position" type="unsigned long" dir="in">
12118	<desc>Position to remove the filter from.</desc>
12119	</param>
12120	<param name="filter" type="IUSBDeviceFilter" dir="return">
12121	<desc>Removed USB device filter.</desc>
12122	</param>
12123	</method>
12124
12125	</interface>
12126
12127
12128	<!--
12129	// IUSBDevice
12130	/////////////////////////////////////////////////////////////////////////
12131	-->
12132
12133	<interface
12134	name="IUSBDevice" extends="$unknown"
12135	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
12136	wsmap="managed"
12137	>
12138	<desc>
12139	The IUSBDevice interface represents a virtual USB device attached to the
12140	virtual machine.
12141
12142	A collection of objects implementing this interface is stored in the
12143	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
12144	attached to a running virtual machine's USB controller.
12145	</desc>
12146
12147	<attribute name="id" type="uuid" mod="string" readonly="yes">
12148	<desc>
12149	Unique USB device ID. This ID is built from #vendorId,
12150	#productId, #revision and #serialNumber.
12151	</desc>
12152	</attribute>
12153
12154	<attribute name="vendorId" type="unsigned short" readonly="yes">
12155	<desc>Vendor ID.</desc>
12156	</attribute>
12157
12158	<attribute name="productId" type="unsigned short" readonly="yes">
12159	<desc>Product ID.</desc>
12160	</attribute>
12161
12162	<attribute name="revision" type="unsigned short" readonly="yes">
12163	<desc>
12164	Product revision number. This is a packed BCD represented as
12165	unsigned short. The high byte is the integer part and the low
12166	byte is the decimal.
12167	</desc>
12168	</attribute>
12169
12170	<attribute name="manufacturer" type="wstring" readonly="yes">
12171	<desc>Manufacturer string.</desc>
12172	</attribute>
12173
12174	<attribute name="product" type="wstring" readonly="yes">
12175	<desc>Product string.</desc>
12176	</attribute>
12177
12178	<attribute name="serialNumber" type="wstring" readonly="yes">
12179	<desc>Serial number string.</desc>
12180	</attribute>
12181
12182	<attribute name="address" type="wstring" readonly="yes">
12183	<desc>Host specific address of the device.</desc>
12184	</attribute>
12185
12186	<attribute name="port" type="unsigned short" readonly="yes">
12187	<desc>
12188	Host USB port number the device is physically
12189	connected to.
12190	</desc>
12191	</attribute>
12192
12193	<attribute name="version" type="unsigned short" readonly="yes">
12194	<desc>
12195	The major USB version of the device - 1 or 2.
12196	</desc>
12197	</attribute>
12198
12199	<attribute name="portVersion" type="unsigned short" readonly="yes">
12200	<desc>
12201	The major USB version of the host USB port the device is
12202	physically connected to - 1 or 2. For devices not connected to
12203	anything this will have the same value as the version attribute.
12204	</desc>
12205	</attribute>
12206
12207	<attribute name="remote" type="boolean" readonly="yes">
12208	<desc>
12209	Whether the device is physically connected to a remote VRDP
12210	client or to a local host machine.
12211	</desc>
12212	</attribute>
12213
12214	</interface>
12215
12216
12217	<!--
12218	// IUSBDeviceFilter
12219	/////////////////////////////////////////////////////////////////////////
12220	-->
12221
12222	<interface
12223	name="IUSBDeviceFilter" extends="$unknown"
12224	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
12225	wsmap="managed"
12226	>
12227	<desc>
12228	The IUSBDeviceFilter interface represents an USB device filter used
12229	to perform actions on a group of USB devices.
12230
12231	This type of filters is used by running virtual machines to
12232	automatically capture selected USB devices once they are physically
12233	attached to the host computer.
12234
12235	A USB device is matched to the given device filter if and only if all
12236	attributes of the device match the corresponding attributes of the
12237	filter (that is, attributes are joined together using the logical AND
12238	operation). On the other hand, all together, filters in the list of
12239	filters carry the semantics of the logical OR operation. So if it is
12240	desirable to create a match like "this vendor id OR this product id",
12241	one needs to create two filters and specify "any match" (see below)
12242	for unused attributes.
12243
12244	All filter attributes used for matching are strings. Each string
12245	is an expression representing a set of values of the corresponding
12246	device attribute, that will match the given filter. Currently, the
12247	following filtering expressions are supported:
12248
12249	<ul>
12250	<li><i>Interval filters</i>. Used to specify valid intervals for
12251	integer device attributes (Vendor ID, Product ID and Revision).
12252	The format of the string is:
12253
12254	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
12255
12256	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
12257	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
12258	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
12259	is omitted before a dash (<tt>-</tt>), the minimum possible integer
12260	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
12261	possible integer is assumed.
12262	</li>
12263	<li><i>Boolean filters</i>. Used to specify acceptable values for
12264	boolean device attributes. The format of the string is:
12265
12266	<tt>true\|false\|yes\|no\|0\|1</tt>
12267
12268	</li>
12269	<li><i>Exact match</i>. Used to specify a single value for the given
12270	device attribute. Any string that doesn't start with <tt>int:</tt>
12271	represents the exact match. String device attributes are compared to
12272	this string including case of symbols. Integer attributes are first
12273	converted to a string (see individual filter attributes) and then
12274	compared ignoring case.
12275
12276	</li>
12277	<li><i>Any match</i>. Any value of the corresponding device attribute
12278	will match the given filter. An empty or @c null string is
12279	used to construct this type of filtering expressions.
12280
12281	</li>
12282	</ul>
12283
12284	<note>
12285	On the Windows host platform, interval filters are not currently
12286	available. Also all string filter attributes
12287	(<link to="#manufacturer"/>, <link to="#product"/>,
12288	<link to="#serialNumber"/>) are ignored, so they behave as
12289	<i>any match</i> no matter what string expression is specified.
12290	</note>
12291
12292	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
12293	</desc>
12294
12295	<attribute name="name" type="wstring">
12296	<desc>
12297	Visible name for this filter.
12298	This name is used to visually distinguish one filter from another,
12299	so it can neither be @c null nor an empty string.
12300	</desc>
12301	</attribute>
12302
12303	<attribute name="active" type="boolean">
12304	<desc>Whether this filter active or has been temporarily disabled.</desc>
12305	</attribute>
12306
12307	<attribute name="vendorId" type="wstring">
12308	<desc>
12309	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12310	The string representation for the <i>exact matching</i>
12311	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12312	(including leading zeroes).
12313	</desc>
12314	</attribute>
12315
12316	<attribute name="productId" type="wstring">
12317	<desc>
12318	<link to="IUSBDevice::productId">Product ID</link> filter.
12319	The string representation for the <i>exact matching</i>
12320	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12321	(including leading zeroes).
12322	</desc>
12323	</attribute>
12324
12325	<attribute name="revision" type="wstring">
12326	<desc>
12327	<link to="IUSBDevice::productId">Product revision number</link>
12328	filter. The string representation for the <i>exact matching</i>
12329	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12330	of the integer part of the revision, and <tt>F</tt> is the
12331	decimal digit of its fractional part (including leading and
12332	trailing zeros).
12333	Note that for interval filters, it's best to use the hexadecimal
12334	form, because the revision is stored as a 16 bit packed BCD value;
12335	so the expression <tt>int:0x0100-0x0199</tt> will match any
12336	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12337	</desc>
12338	</attribute>
12339
12340	<attribute name="manufacturer" type="wstring">
12341	<desc>
12342	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12343	</desc>
12344	</attribute>
12345
12346	<attribute name="product" type="wstring">
12347	<desc>
12348	<link to="IUSBDevice::product">Product</link> filter.
12349	</desc>
12350	</attribute>
12351
12352	<attribute name="serialNumber" type="wstring">
12353	<desc>
12354	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12355	</desc>
12356	</attribute>
12357
12358	<attribute name="port" type="wstring">
12359	<desc>
12360	<link to="IUSBDevice::port">Host USB port</link> filter.
12361	</desc>
12362	</attribute>
12363
12364	<attribute name="remote" type="wstring">
12365	<desc>
12366	<link to="IUSBDevice::remote">Remote state</link> filter.
12367	<note>
12368	This filter makes sense only for machine USB filters,
12369	i.e. it is ignored by IHostUSBDeviceFilter objects.
12370	</note>
12371	</desc>
12372	</attribute>
12373
12374	<attribute name="maskedInterfaces" type="unsigned long">
12375	<desc>
12376	This is an advanced option for hiding one or more USB interfaces
12377	from the guest. The value is a bit mask where the bits that are set
12378	means the corresponding USB interface should be hidden, masked off
12379	if you like.
12380	This feature only works on Linux hosts.
12381	</desc>
12382	</attribute>
12383
12384	</interface>
12385
12386
12387	<!--
12388	// IHostUSBDevice
12389	/////////////////////////////////////////////////////////////////////////
12390	-->
12391
12392	<enum
12393	name="USBDeviceState"
12394	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12395	>
12396	<desc>
12397	USB device state. This enumeration represents all possible states
12398	of the USB device physically attached to the host computer regarding
12399	its state on the host computer and availability to guest computers
12400	(all currently running virtual machines).
12401
12402	Once a supported USB device is attached to the host, global USB
12403	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12404	either ignore the device, or put it to USBDeviceState_Held state, or do
12405	nothing. Unless the device is ignored by global filters, filters of all
12406	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12407	activated that can put it to USBDeviceState_Captured state.
12408
12409	If the device was ignored by global filters, or didn't match
12410	any filters at all (including guest ones), it is handled by the host
12411	in a normal way. In this case, the device state is determined by
12412	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12413	or USBDeviceState_Available, depending on the current device usage.
12414
12415	Besides auto-capturing based on filters, the device can be manually
12416	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12417	state is USBDeviceState_Busy, USBDeviceState_Available or
12418	USBDeviceState_Held.
12419
12420	<note>
12421	Due to differences in USB stack implementations in Linux and Win32,
12422	states USBDeviceState_Busy and USBDeviceState_vailable are applicable
12423	only to the Linux version of the product. This also means that (<link
12424	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12425	device state is USBDeviceState_Held.
12426	</note>
12427
12428	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12429	</desc>
12430
12431	<const name="NotSupported" value="0">
12432	<desc>
12433	Not supported by the VirtualBox server, not available to guests.
12434	</desc>
12435	</const>
12436	<const name="Unavailable" value="1">
12437	<desc>
12438	Being used by the host computer exclusively,
12439	not available to guests.
12440	</desc>
12441	</const>
12442	<const name="Busy" value="2">
12443	<desc>
12444	Being used by the host computer, potentially available to guests.
12445	</desc>
12446	</const>
12447	<const name="Available" value="3">
12448	<desc>
12449	Not used by the host computer, available to guests (the host computer
12450	can also start using the device at any time).
12451	</desc>
12452	</const>
12453	<const name="Held" value="4">
12454	<desc>
12455	Held by the VirtualBox server (ignored by the host computer),
12456	available to guests.
12457	</desc>
12458	</const>
12459	<const name="Captured" value="5">
12460	<desc>
12461	Captured by one of the guest computers, not available
12462	to anybody else.
12463	</desc>
12464	</const>
12465	</enum>
12466
12467	<interface
12468	name="IHostUSBDevice" extends="IUSBDevice"
12469	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12470	wsmap="managed"
12471	>
12472	<desc>
12473	The IHostUSBDevice interface represents a physical USB device attached
12474	to the host computer.
12475
12476	Besides properties inherited from IUSBDevice, this interface adds the
12477	<link to="#state"/> property that holds the current state of the USB
12478	device.
12479
12480	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12481	</desc>
12482
12483	<attribute name="state" type="USBDeviceState" readonly="yes">
12484	<desc>
12485	Current state of the device.
12486	</desc>
12487	</attribute>
12488
12489	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12490
12491	</interface>
12492
12493
12494	<!--
12495	// IHostUSBDeviceFilter
12496	/////////////////////////////////////////////////////////////////////////
12497	-->
12498
12499	<enum
12500	name="USBDeviceFilterAction"
12501	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12502	>
12503	<desc>
12504	Actions for host USB device filters.
12505	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12506	</desc>
12507
12508	<const name="Null" value="0">
12509	<desc>Null value (never used by the API).</desc>
12510	</const>
12511	<const name="Ignore" value="1">
12512	<desc>Ignore the matched USB device.</desc>
12513	</const>
12514	<const name="Hold" value="2">
12515	<desc>Hold the matched USB device.</desc>
12516	</const>
12517	</enum>
12518
12519	<interface
12520	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12521	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12522	wsmap="managed"
12523	>
12524	<desc>
12525	The IHostUSBDeviceFilter interface represents a global filter for a
12526	physical USB device used by the host computer. Used indirectly in
12527	<link to="IHost::USBDeviceFilters"/>.
12528
12529	Using filters of this type, the host computer determines the initial
12530	state of the USB device after it is physically attached to the
12531	host's USB controller.
12532
12533	<note>
12534	The <link to="#remote"/> attribute is ignored by this type of
12535	filters, because it makes sense only for
12536	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12537	</note>
12538
12539	<see>IHost::USBDeviceFilters</see>
12540	</desc>
12541
12542	<attribute name="action" type="USBDeviceFilterAction">
12543	<desc>
12544	Action performed by the host when an attached USB device
12545	matches this filter.
12546	</desc>
12547	</attribute>
12548
12549	</interface>
12550
12551	<!--
12552	// IAudioAdapter
12553	/////////////////////////////////////////////////////////////////////////
12554	-->
12555
12556	<enum
12557	name="AudioDriverType"
12558	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12559	>
12560	<desc>
12561	Host audio driver type.
12562	</desc>
12563
12564	<const name="Null" value="0">
12565	<desc>Null value, also means "dummy audio driver".</desc>
12566	</const>
12567	<const name="WinMM" value="1">
12568	<desc>Windows multimedia (Windows hosts only).</desc>
12569	</const>
12570	<const name="OSS" value="2">
12571	<desc>Open Sound System (Linux hosts only).</desc>
12572	</const>
12573	<const name="ALSA" value="3">
12574	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12575	</const>
12576	<const name="DirectSound" value="4">
12577	<desc>DirectSound (Windows hosts only).</desc>
12578	</const>
12579	<const name="CoreAudio" value="5">
12580	<desc>CoreAudio (Mac hosts only).</desc>
12581	</const>
12582	<const name="MMPM" value="6">
12583	<desc>Reserved for historical reasons.</desc>
12584	</const>
12585	<const name="Pulse" value="7">
12586	<desc>PulseAudio (Linux hosts only).</desc>
12587	</const>
12588	<const name="SolAudio" value="8">
12589	<desc>Solaris audio (Solaris hosts only).</desc>
12590	</const>
12591	</enum>
12592
12593	<enum
12594	name="AudioControllerType"
12595	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12596	>
12597	<desc>
12598	Virtual audio controller type.
12599	</desc>
12600
12601	<const name="AC97" value="0"/>
12602	<const name="SB16" value="1"/>
12603	</enum>
12604
12605	<interface
12606	name="IAudioAdapter" extends="$unknown"
12607	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12608	wsmap="managed"
12609	>
12610	<desc>
12611	The IAudioAdapter interface represents the virtual audio adapter of
12612	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12613	</desc>
12614	<attribute name="enabled" type="boolean">
12615	<desc>
12616	Flag whether the audio adapter is present in the
12617	guest system. If disabled, the virtual guest hardware will
12618	not contain any audio adapter. Can only be changed when
12619	the VM is not running.
12620	</desc>
12621	</attribute>
12622	<attribute name="audioController" type="AudioControllerType">
12623	<desc>
12624	The audio hardware we emulate.
12625	</desc>
12626	</attribute>
12627	<attribute name="audioDriver" type="AudioDriverType">
12628	<desc>
12629	Audio driver the adapter is connected to. This setting
12630	can only be changed when the VM is not running.
12631	</desc>
12632	</attribute>
12633	</interface>
12634
12635	<!--
12636	// IVRDPServer
12637	/////////////////////////////////////////////////////////////////////////
12638	-->
12639
12640	<enum
12641	name="VRDPAuthType"
12642	uuid="3d91887a-b67f-4b33-85bf-2da7ab1ea83a"
12643	>
12644	<desc>
12645	VRDP authentication type.
12646	</desc>
12647
12648	<const name="Null" value="0">
12649	<desc>Null value, also means "no authentication".</desc>
12650	</const>
12651	<const name="External" value="1"/>
12652	<const name="Guest" value="2"/>
12653	</enum>
12654
12655	<interface
12656	name="IVRDPServer" extends="$unknown"
12657	uuid="72e671bc-1712-4052-ad6b-e45e76d9d3e4"
12658	wsmap="managed"
12659	>
12660	<attribute name="enabled" type="boolean">
12661	<desc>VRDP server status.</desc>
12662	</attribute>
12663
12664	<attribute name="ports" type="wstring">
12665	<desc>
12666	VRDP server port numbers. The server will try to bind to one of free ports from the list.
12667	<note>
12668	This is a string of comma separated TCP port numbers or port number ranges.
12669	Example <tt>5000,5010-5012,5015</tt>
12670	</note>
12671	</desc>
12672	</attribute>
12673
12674	<attribute name="netAddress" type="wstring">
12675	<desc>VRDP server address.</desc>
12676	</attribute>
12677
12678	<attribute name="authType" type="VRDPAuthType">
12679	<desc>VRDP authentication method.</desc>
12680	</attribute>
12681
12682	<attribute name="authTimeout" type="unsigned long">
12683	<desc>Timeout for guest authentication. Milliseconds.</desc>
12684	</attribute>
12685
12686	<attribute name="allowMultiConnection" type="boolean">
12687	<desc>
12688	Flag whether multiple simultaneous connections to the VM are permitted.
12689	Note that this will be replaced by a more powerful mechanism in the future.
12690	</desc>
12691	</attribute>
12692
12693	<attribute name="reuseSingleConnection" type="boolean">
12694	<desc>
12695	Flag whether the existing connection must be dropped and a new connection
12696	must be established by the VRDP server, when a new client connects in single
12697	connection mode.
12698	</desc>
12699	</attribute>
12700
12701	</interface>
12702
12703
12704	<!--
12705	// ISharedFolder
12706	/////////////////////////////////////////////////////////////////////////
12707	-->
12708
12709	<interface
12710	name="ISharedFolder" extends="$unknown"
12711	uuid="64637bb2-9e17-471c-b8f3-f8968dd9884e"
12712	wsmap="struct"
12713	>
12714	<desc>
12715	The ISharedFolder interface represents a folder in the host computer's
12716	file system accessible from the guest OS running inside a virtual
12717	machine using an associated logical name.
12718
12719	There are three types of shared folders:
12720	<ul>
12721	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
12722	folders available to all virtual machines.</li>
12723	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
12724	VM-specific shared folders available to the given virtual machine at
12725	startup.</li>
12726	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
12727	VM-specific shared folders created in the session context (for
12728	example, when the virtual machine is running) and automatically
12729	discarded when the session is closed (the VM is powered off).</li>
12730	</ul>
12731
12732	Logical names of shared folders must be unique within the given scope
12733	(global, permanent or transient). However, they do not need to be unique
12734	across scopes. In this case, the definition of the shared folder in a
12735	more specific scope takes precedence over definitions in all other
12736	scopes. The order of precedence is (more specific to more general):
12737	<ol>
12738	<li>Transient definitions</li>
12739	<li>Permanent definitions</li>
12740	<li>Global definitions</li>
12741	</ol>
12742
12743	For example, if MyMachine has a shared folder named
12744	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
12745	transient shared folder named <tt>C_DRIVE</tt> (that points
12746	to <tt>C:\\\\WINDOWS</tt>) will change the definition
12747	of <tt>C_DRIVE</tt> in the guest OS so
12748	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
12749	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
12750	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
12751	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
12752	to <tt>C:\\</tt> if it still exists.
12753
12754	Note that permanent and transient shared folders of different machines
12755	are in different name spaces, so they don't overlap and don't need to
12756	have unique logical names.
12757
12758	<note>
12759	Global shared folders are not implemented in the current version of the
12760	product.
12761	</note>
12762	</desc>
12763
12764	<attribute name="name" type="wstring" readonly="yes">
12765	<desc>Logical name of the shared folder.</desc>
12766	</attribute>
12767
12768	<attribute name="hostPath" type="wstring" readonly="yes">
12769	<desc>Full path to the shared folder in the host file system.</desc>
12770	</attribute>
12771
12772	<attribute name="accessible" type="boolean" readonly="yes">
12773	<desc>
12774	Whether the folder defined by the host path is currently
12775	accessible or not.
12776	For example, the folder can be unaccessible if it is placed
12777	on the network share that is not available by the time
12778	this property is read.
12779	</desc>
12780	</attribute>
12781
12782	<attribute name="writable" type="boolean" readonly="yes">
12783	<desc>
12784	Whether the folder defined by the host path is writable or
12785	not.
12786	</desc>
12787	</attribute>
12788
12789	<attribute name="lastAccessError" type="wstring" readonly="yes">
12790	<desc>
12791	Text message that represents the result of the last accessibility
12792	check.
12793
12794	Accessibility checks are performed each time the <link to="#accessible"/>
12795	attribute is read. An empty string is returned if the last
12796	accessibility check was successful. A non-empty string indicates a
12797	failure and should normally describe a reason of the failure (for
12798	example, a file read error).
12799	</desc>
12800	</attribute>
12801
12802	</interface>
12803
12804	<!--
12805	// ISession
12806	/////////////////////////////////////////////////////////////////////////
12807	-->
12808
12809	<interface
12810	name="IInternalSessionControl" extends="$unknown"
12811	uuid="f9aac6d0-41b3-46b7-bea4-6370b4036de6"
12812	internal="yes"
12813	wsmap="suppress"
12814	>
12815	<method name="getPID">
12816	<desc>PID of the process that has created this Session object.
12817	</desc>
12818	<param name="pid" type="unsigned long" dir="return"/>
12819	</method>
12820
12821	<method name="getRemoteConsole">
12822	<desc>
12823	Returns the console object suitable for remote control.
12824
12825	<result name="VBOX_E_INVALID_VM_STATE">
12826	Session state prevents operation.
12827	</result>
12828	<result name="VBOX_E_INVALID_OBJECT_STATE">
12829	Session type prevents operation.
12830	</result>
12831
12832	</desc>
12833	<param name="console" type="IConsole" dir="return"/>
12834	</method>
12835
12836	<method name="assignMachine">
12837	<desc>
12838	Assigns the machine object associated with this direct-type
12839	session or informs the session that it will be a remote one
12840	(if @a machine == @c null).
12841
12842	<result name="VBOX_E_INVALID_VM_STATE">
12843	Session state prevents operation.
12844	</result>
12845	<result name="VBOX_E_INVALID_OBJECT_STATE">
12846	Session type prevents operation.
12847	</result>
12848
12849	</desc>
12850	<param name="machine" type="IMachine" dir="in"/>
12851	</method>
12852
12853	<method name="assignRemoteMachine">
12854	<desc>
12855	Assigns the machine and the (remote) console object associated with
12856	this remote-type session.
12857
12858	<result name="VBOX_E_INVALID_VM_STATE">
12859	Session state prevents operation.
12860	</result>
12861
12862	</desc>
12863	<param name="machine" type="IMachine" dir="in"/>
12864	<param name="console" type="IConsole" dir="in"/>
12865	</method>
12866
12867	<method name="updateMachineState">
12868	<desc>
12869	Updates the machine state in the VM process.
12870	Must be called only in certain cases
12871	(see the method implementation).
12872
12873	<result name="VBOX_E_INVALID_VM_STATE">
12874	Session state prevents operation.
12875	</result>
12876	<result name="VBOX_E_INVALID_OBJECT_STATE">
12877	Session type prevents operation.
12878	</result>
12879
12880	</desc>
12881	<param name="aMachineState" type="MachineState" dir="in"/>
12882	</method>
12883
12884	<method name="uninitialize">
12885	<desc>
12886	Uninitializes (closes) this session. Used by VirtualBox to close
12887	the corresponding remote session when the direct session dies
12888	or gets closed.
12889
12890	<result name="VBOX_E_INVALID_VM_STATE">
12891	Session state prevents operation.
12892	</result>
12893
12894	</desc>
12895	</method>
12896
12897	<method name="onNetworkAdapterChange">
12898	<desc>
12899	Triggered when settings of a network adapter of the
12900	associated virtual machine have changed.
12901
12902	<result name="VBOX_E_INVALID_VM_STATE">
12903	Session state prevents operation.
12904	</result>
12905	<result name="VBOX_E_INVALID_OBJECT_STATE">
12906	Session type prevents operation.
12907	</result>
12908
12909	</desc>
12910	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
12911	<param name="changeAdapter" type="boolean" dir="in"/>
12912	</method>
12913
12914	<method name="onSerialPortChange">
12915	<desc>
12916	Triggered when settings of a serial port of the
12917	associated virtual machine have changed.
12918
12919	<result name="VBOX_E_INVALID_VM_STATE">
12920	Session state prevents operation.
12921	</result>
12922	<result name="VBOX_E_INVALID_OBJECT_STATE">
12923	Session type prevents operation.
12924	</result>
12925
12926	</desc>
12927	<param name="serialPort" type="ISerialPort" dir="in"/>
12928	</method>
12929
12930	<method name="onParallelPortChange">
12931	<desc>
12932	Triggered when settings of a parallel port of the
12933	associated virtual machine have changed.
12934
12935	<result name="VBOX_E_INVALID_VM_STATE">
12936	Session state prevents operation.
12937	</result>
12938	<result name="VBOX_E_INVALID_OBJECT_STATE">
12939	Session type prevents operation.
12940	</result>
12941
12942	</desc>
12943	<param name="parallelPort" type="IParallelPort" dir="in"/>
12944	</method>
12945
12946	<method name="onStorageControllerChange">
12947	<desc>
12948	Triggered when settings of a storage controller of the
12949	associated virtual machine have changed.
12950
12951	<result name="VBOX_E_INVALID_VM_STATE">
12952	Session state prevents operation.
12953	</result>
12954	<result name="VBOX_E_INVALID_OBJECT_STATE">
12955	Session type prevents operation.
12956	</result>
12957
12958	</desc>
12959	</method>
12960
12961	<method name="onMediumChange">
12962	<desc>
12963	Triggered when attached media of the
12964	associated virtual machine have changed.
12965
12966	<result name="VBOX_E_INVALID_VM_STATE">
12967	Session state prevents operation.
12968	</result>
12969	<result name="VBOX_E_INVALID_OBJECT_STATE">
12970	Session type prevents operation.
12971	</result>
12972
12973	</desc>
12974
12975	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
12976	<param name="force" type="boolean" dir="in"/>
12977	</method>
12978
12979	<method name="onCPUChange">
12980	<desc>
12981	Notification when a CPU changes.
12982	</desc>
12983	<param name="cpu" type="unsigned long" dir="in">
12984	<desc>The CPU which changed</desc>
12985	</param>
12986	<param name="add" type="boolean" dir="in">
12987	<desc>Flag whether the CPU was added or removed</desc>
12988	</param>
12989	</method>
12990
12991	<method name="onVRDPServerChange">
12992	<desc>
12993	Triggered when settings of the VRDP server object of the
12994	associated virtual machine have changed.
12995
12996	<result name="VBOX_E_INVALID_VM_STATE">
12997	Session state prevents operation.
12998	</result>
12999	<result name="VBOX_E_INVALID_OBJECT_STATE">
13000	Session type prevents operation.
13001	</result>
13002
13003	</desc>
13004	</method>
13005
13006	<method name="onUSBControllerChange">
13007	<desc>
13008	Triggered when settings of the USB controller object of the
13009	associated virtual machine have changed.
13010
13011	<result name="VBOX_E_INVALID_VM_STATE">
13012	Session state prevents operation.
13013	</result>
13014	<result name="VBOX_E_INVALID_OBJECT_STATE">
13015	Session type prevents operation.
13016	</result>
13017
13018	</desc>
13019	</method>
13020
13021	<method name="onSharedFolderChange">
13022	<desc>
13023	Triggered when a permanent (global or machine) shared folder has been
13024	created or removed.
13025	<note>
13026	We don't pass shared folder parameters in this notification because
13027	the order in which parallel notifications are delivered is not defined,
13028	therefore it could happen that these parameters were outdated by the
13029	time of processing this notification.
13030	</note>
13031
13032	<result name="VBOX_E_INVALID_VM_STATE">
13033	Session state prevents operation.
13034	</result>
13035	<result name="VBOX_E_INVALID_OBJECT_STATE">
13036	Session type prevents operation.
13037	</result>
13038
13039	</desc>
13040	<param name="global" type="boolean" dir="in"/>
13041	</method>
13042
13043	<method name="onUSBDeviceAttach">
13044	<desc>
13045	Triggered when a request to capture a USB device (as a result
13046	of matched USB filters or direct call to
13047	<link to="IConsole::attachUSBDevice"/>) has completed.
13048	A @c null @a error object means success, otherwise it
13049	describes a failure.
13050
13051	<result name="VBOX_E_INVALID_VM_STATE">
13052	Session state prevents operation.
13053	</result>
13054	<result name="VBOX_E_INVALID_OBJECT_STATE">
13055	Session type prevents operation.
13056	</result>
13057
13058	</desc>
13059	<param name="device" type="IUSBDevice" dir="in"/>
13060	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13061	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
13062	</method>
13063
13064	<method name="onUSBDeviceDetach">
13065	<desc>
13066	Triggered when a request to release the USB device (as a result
13067	of machine termination or direct call to
13068	<link to="IConsole::detachUSBDevice"/>) has completed.
13069	A @c null @a error object means success, otherwise it
13070	describes a failure.
13071
13072	<result name="VBOX_E_INVALID_VM_STATE">
13073	Session state prevents operation.
13074	</result>
13075	<result name="VBOX_E_INVALID_OBJECT_STATE">
13076	Session type prevents operation.
13077	</result>
13078
13079	</desc>
13080	<param name="id" type="uuid" mod="string" dir="in"/>
13081	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13082	</method>
13083
13084	<method name="onShowWindow">
13085	<desc>
13086	Called by <link to="IMachine::canShowConsoleWindow"/> and by
13087	<link to="IMachine::showConsoleWindow"/> in order to notify
13088	console callbacks
13089	<link to="IConsoleCallback::onCanShowWindow"/>
13090	and <link to="IConsoleCallback::onShowWindow"/>.
13091
13092	<result name="VBOX_E_INVALID_OBJECT_STATE">
13093	Session type prevents operation.
13094	</result>
13095
13096	</desc>
13097	<param name="check" type="boolean" dir="in"/>
13098	<param name="canShow" type="boolean" dir="out"/>
13099	<param name="winId" type="unsigned long long" dir="out"/>
13100	</method>
13101
13102	<method name="accessGuestProperty">
13103	<desc>
13104	Called by <link to="IMachine::getGuestProperty"/> and by
13105	<link to="IMachine::setGuestProperty"/> in order to read and
13106	modify guest properties.
13107
13108	<result name="VBOX_E_INVALID_VM_STATE">
13109	Machine session is not open.
13110	</result>
13111	<result name="VBOX_E_INVALID_OBJECT_STATE">
13112	Session type is not direct.
13113	</result>
13114
13115	</desc>
13116	<param name="name" type="wstring" dir="in"/>
13117	<param name="value" type="wstring" dir="in"/>
13118	<param name="flags" type="wstring" dir="in"/>
13119	<param name="isSetter" type="boolean" dir="in"/>
13120	<param name="retValue" type="wstring" dir="out"/>
13121	<param name="retTimestamp" type="unsigned long long" dir="out"/>
13122	<param name="retFlags" type="wstring" dir="out"/>
13123	</method>
13124
13125	<method name="enumerateGuestProperties">
13126	<desc>
13127	Return a list of the guest properties matching a set of patterns along
13128	with their values, time stamps and flags.
13129
13130	<result name="VBOX_E_INVALID_VM_STATE">
13131	Machine session is not open.
13132	</result>
13133	<result name="VBOX_E_INVALID_OBJECT_STATE">
13134	Session type is not direct.
13135	</result>
13136
13137	</desc>
13138	<param name="patterns" type="wstring" dir="in">
13139	<desc>
13140	The patterns to match the properties against as a comma-separated
13141	string. If this is empty, all properties currently set will be
13142	returned.
13143	</desc>
13144	</param>
13145	<param name="key" type="wstring" dir="out" safearray="yes">
13146	<desc>
13147	The key names of the properties returned.
13148	</desc>
13149	</param>
13150	<param name="value" type="wstring" dir="out" safearray="yes">
13151	<desc>
13152	The values of the properties returned. The array entries match the
13153	corresponding entries in the @a key array.
13154	</desc>
13155	</param>
13156	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
13157	<desc>
13158	The time stamps of the properties returned. The array entries match
13159	the corresponding entries in the @a key array.
13160	</desc>
13161	</param>
13162	<param name="flags" type="wstring" dir="out" safearray="yes">
13163	<desc>
13164	The flags of the properties returned. The array entries match the
13165	corresponding entries in the @a key array.
13166	</desc>
13167	</param>
13168	</method>
13169
13170	</interface>
13171
13172	<interface
13173	name="ISession" extends="$dispatched"
13174	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
13175	wsmap="managed"
13176	>
13177	<desc>
13178	The ISession interface represents a serialization primitive for virtual
13179	machines.
13180
13181	With VirtualBox, every time one wishes to manipulate a virtual machine
13182	(e.g. change its settings or start execution), a session object is
13183	required. Such an object must be passed to one of the session methods
13184	that open the given session, which then initiates the machine manipulation.
13185
13186	A session serves several purposes: it identifies to the inter-process VirtualBox
13187	code which process is currently working with the virtual machine, and it ensures
13188	that there are no incompatible requests from several processes for the
13189	same virtual machine. Session objects can therefore be thought of as mutex
13190	semaphores that lock virtual machines to prevent conflicting accesses from
13191	several processes.
13192
13193	How sessions objects are used depends on whether you use the Main API
13194	via COM or via the webservice:
13195
13196	<ul>
13197	<li>When using the COM API directly, an object of the Session class from the
13198	VirtualBox type library needs to be created. In regular COM C++ client code,
13199	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
13200	This object will then act as a local session object in further calls to open
13201	a session.
13202	</li>
13203
13204	<li>In the webservice, the session manager (IWebsessionManager) instead creates
13205	one session object automatically when <link to="IWebsessionManager::logon" />
13206	is called. A managed object reference to that session object can be retrieved by
13207	calling <link to="IWebsessionManager::getSessionObject" />. This session object
13208	reference can then be used to open sessions.
13209	</li>
13210	</ul>
13211
13212	Sessions are mainly used in two variations:
13213
13214	<ul>
13215	<li>
13216	To start a virtual machine in a separate process, one would call
13217	<link to="IVirtualBox::openRemoteSession"/>, which requires a session
13218	object as its first parameter. This session then identifies the caller
13219	and lets him control the started machine (for example, pause machine
13220	execution or power it down) as well as be notified about machine
13221	execution state changes.
13222	</li>
13223
13224	<li>To alter machine settings, or to start machine execution within the
13225	current process, one needs to open a direct session for the machine first by
13226	calling <link to="IVirtualBox::openSession"/>. While a direct session
13227	is open within one process, no any other process may open another direct
13228	session for the same machine. This prevents the machine from being changed
13229	by other processes while it is running or while the machine is being configured.
13230	</li>
13231	</ul>
13232
13233	One also can attach to an existing direct session already opened by
13234	another process (for example, in order to send a control request to the
13235	virtual machine such as the pause or the reset request). This is done by
13236	calling <link to="IVirtualBox::openExistingSession"/>.
13237
13238	<note>
13239	Unless you are trying to write a new VirtualBox front-end that
13240	performs direct machine execution (like the VirtualBox or VBoxSDL
13241	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
13242	session opened by <link to="IVirtualBox::openSession"/> and use this
13243	session only to change virtual machine settings. If you simply want to
13244	start virtual machine execution using one of the existing front-ends
13245	(for example the VirtualBox GUI or headless server), simply use
13246	<link to="IVirtualBox::openRemoteSession"/>; these front-ends
13247	will power up the machine automatically for you.
13248	</note>
13249	</desc>
13250
13251	<attribute name="state" type="SessionState" readonly="yes">
13252	<desc>Current state of this session.</desc>
13253	</attribute>
13254
13255	<attribute name="type" type="SessionType" readonly="yes">
13256	<desc>
13257	Type of this session. The value of this attribute is valid only
13258	if the session is currently open (i.e. its #state is
13259	SessionType_SessionOpen), otherwise an error will be returned.
13260	</desc>
13261	</attribute>
13262
13263	<attribute name="machine" type="IMachine" readonly="yes">
13264	<desc>Machine object associated with this session.</desc>
13265	</attribute>
13266
13267	<attribute name="console" type="IConsole" readonly="yes">
13268	<desc>Console object associated with this session.</desc>
13269	</attribute>
13270
13271	<method name="close">
13272	<desc>
13273	Closes a session that was previously opened.
13274
13275	It is recommended that every time an "open session" method (such as
13276	<link to="IVirtualBox::openRemoteSession" /> or
13277	<link to="IVirtualBox::openSession" />) has been called to
13278	manipulate a virtual machine, the caller invoke
13279	ISession::close() when it's done doing so. Since sessions are
13280	serialization primitives much like ordinary mutexes, they are
13281	best used the same way: for each "open" call, there should be
13282	a matching "close" call, even when errors occur.
13283
13284	Otherwise, if a direct session for a machine opened with
13285	<link to="IVirtualBox::openSession"/> is not explicitly closed
13286	when the application terminates, the state of the machine will
13287	be set to <link to="MachineState_Aborted" /> on the server.
13288
13289	Generally, it is recommended to close all open sessions explicitly
13290	before terminating the application (regardless of the reason for
13291	the termination).
13292
13293	<note>
13294	Do not expect the session state (<link to="ISession::state" />
13295	to return to "Closed" immediately after you invoke
13296	ISession::close(), particularly if you have started a remote
13297	session to execute the VM in a new process. The session state will
13298	automatically return to "Closed" once the VM is no longer executing,
13299	which can of course take a very long time.
13300	</note>
13301
13302	<result name="E_UNEXPECTED">
13303	Session is not open.
13304	</result>
13305
13306	</desc>
13307	</method>
13308
13309	</interface>
13310
13311	<!--
13312	// IStorageController
13313	/////////////////////////////////////////////////////////////////////////
13314	-->
13315
13316	<enum
13317	name="StorageBus"
13318	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
13319	>
13320	<desc>
13321	The bus type of the storage controller (IDE, SATA, SCSI or Floppy);
13322	see <link to="IStorageController::bus" />.
13323	</desc>
13324	<const name="Null" value="0">
13325	<desc>@c null value. Never used by the API.</desc>
13326	</const>
13327	<const name="IDE" value="1"/>
13328	<const name="SATA" value="2"/>
13329	<const name="SCSI" value="3"/>
13330	<const name="Floppy" value="4"/>
13331	<const name="SAS" value="5"/>
13332	</enum>
13333
13334	<enum
13335	name="StorageControllerType"
13336	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13337	>
13338	<desc>
13339	The exact variant of storage controller hardware presented
13340	to the guest; see <link to="IStorageController::controllerType" />.
13341	</desc>
13342
13343	<const name="Null" value="0">
13344	<desc>@c null value. Never used by the API.</desc>
13345	</const>
13346	<const name="LsiLogic" value="1">
13347	<desc>A SCSI controller of the LsiLogic variant.</desc>
13348	</const>
13349	<const name="BusLogic" value="2">
13350	<desc>A SCSI controller of the BusLogic variant.</desc>
13351	</const>
13352	<const name="IntelAhci" value="3">
13353	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13354	</const>
13355	<const name="PIIX3" value="4">
13356	<desc>An IDE controller of the PIIX3 variant.</desc>
13357	</const>
13358	<const name="PIIX4" value="5">
13359	<desc>An IDE controller of the PIIX4 variant.</desc>
13360	</const>
13361	<const name="ICH6" value="6">
13362	<desc>An IDE controller of the ICH6 variant.</desc>
13363	</const>
13364	<const name="I82078" value="7">
13365	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
13366	</const>
13367	<const name="LsiLogicSas" value="8">
13368	<desc>A variant of the LsiLogic controller using SAS.</desc>
13369	</const>
13370	</enum>
13371
13372	<interface
13373	name="IStorageController" extends="$unknown"
13374	uuid="6bf8335b-d14a-44a5-9b45-ddc49ce7d5b2"
13375	wsmap="managed"
13376	>
13377	<desc>
13378	Represents a storage controller that is attached to a virtual machine
13379	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
13380	attached to storage controllers in a real computer, virtual drives
13381	(represented by <link to="IMediumAttachment" />) are attached to virtual
13382	storage controllers, represented by this interface.
13383
13384	As opposed to physical hardware, VirtualBox has a very generic concept
13385	of a storage controller, and for purposes of the Main API, all virtual
13386	storage is attached to virtual machines via instances of this interface.
13387	There are four types of such virtual storage controllers: IDE, SCSI, SATA
13388	and Floppy (see <link to="#bus" />). Depending on which of these four is
13389	used, certain sub-types may be available and can be selected in
13390	<link to="#controllerType" />.
13391
13392	Depending on these settings, the guest operating system might see
13393	significantly different virtual hardware.
13394	</desc>
13395
13396	<attribute name="name" type="wstring" readonly="yes">
13397	<desc>
13398	Name of the storage controller, as originally specified with
13399	<link to="IMachine::addStorageController" />. This then uniquely
13400	identifies this controller with other method calls such as
13401	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
13402	</desc>
13403	</attribute>
13404
13405	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
13406	<desc>
13407	Maximum number of devices which can be attached to one port.
13408	</desc>
13409	</attribute>
13410
13411	<attribute name="minPortCount" type="unsigned long" readonly="yes">
13412	<desc>
13413	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
13414	</desc>
13415	</attribute>
13416
13417	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
13418	<desc>
13419	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
13420	</desc>
13421	</attribute>
13422
13423	<attribute name="instance" type="unsigned long">
13424	<desc>
13425	The instance number of the device in the running VM.
13426	</desc>
13427	</attribute>
13428
13429	<attribute name="portCount" type="unsigned long">
13430	<desc>
13431	The number of currently usable ports on the controller.
13432	The minimum and maximum number of ports for one controller are
13433	stored in <link to="IStorageController::minPortCount"/>
13434	and <link to="IStorageController::maxPortCount"/>.
13435	</desc>
13436	</attribute>
13437
13438	<attribute name="bus" type="StorageBus" readonly="yes">
13439	<desc>
13440	The bus type of the storage controller (IDE, SATA, SCSI or Floppy).
13441	</desc>
13442	</attribute>
13443
13444	<attribute name="controllerType" type="StorageControllerType">
13445	<desc>
13446	The exact variant of storage controller hardware presented
13447	to the guest.
13448	Depending on this value, VirtualBox will provide a different
13449	virtual storage controller hardware to the guest.
13450	For SATA and floppy controllers, only one variant is available,
13451	but for IDE and SCSI, there are several.
13452
13453	For SCSI controllers, the default type is LsiLogic.
13454	</desc>
13455	</attribute>
13456
13457	<method name="GetIDEEmulationPort">
13458	<desc>
13459	Gets the corresponding port number which is emulated as an IDE device.
13460	Works only with SATA controllers.
13461
13462	<result name="E_INVALIDARG">
13463	The @a devicePosition is not in the range 0 to 3.
13464	</result>
13465	<result name="E_NOTIMPL">
13466	The storage controller type is not SATAIntelAhci.
13467	</result>
13468
13469	</desc>
13470	<param name="devicePosition" type="long" dir="in"/>
13471	<param name="portNumber" type="long" dir="return"/>
13472	</method>
13473
13474	<method name="SetIDEEmulationPort">
13475	<desc>
13476	Sets the port number which is emulated as an IDE device.
13477	Works only with SATA controllers.
13478
13479	<result name="E_INVALIDARG">
13480	The @a devicePosition is not in the range 0 to 3 or the
13481	@a portNumber is not in the range 0 to 29.
13482	</result>
13483	<result name="E_NOTIMPL">
13484	The storage controller type is not SATAIntelAhci.
13485	</result>
13486
13487	</desc>
13488	<param name="devicePosition" type="long" dir="in"/>
13489	<param name="portNumber" type="long" dir="in"/>
13490	</method>
13491
13492	</interface>
13493
13494	<if target="wsdl">
13495
13496	<!--
13497	// IManagedObjectRef
13498	/////////////////////////////////////////////////////////////////////////
13499	-->
13500
13501	<interface
13502	name="IManagedObjectRef" extends="$unknown"
13503	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13504	internal="yes"
13505	wsmap="managed"
13506	wscpp="hardcoded"
13507	>
13508	<desc>
13509	Managed object reference.
13510
13511	Only within the webservice, a managed object reference (which is really
13512	an opaque number) allows a webservice client to address an object
13513	that lives in the address space of the webservice server.
13514
13515	Behind each managed object reference, there is a COM object that lives
13516	in the webservice server's address space. The COM object is not freed
13517	until the managed object reference is released, either by an explicit
13518	call to <link to="IManagedObjectRef::release" /> or by logging off from
13519	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13520	all objects created during the webservice session.
13521
13522	Whenever a method call of the VirtualBox API returns a COM object, the
13523	webservice representation of that method will instead return a
13524	managed object reference, which can then be used to invoke methods
13525	on that object.
13526	</desc>
13527
13528	<method name="getInterfaceName">
13529	<desc>
13530	Returns the name of the interface that this managed object represents,
13531	for example, "IMachine", as a string.
13532	</desc>
13533	<param name="return" type="wstring" dir="return"/>
13534	</method>
13535
13536	<method name="release">
13537	<desc>
13538	Releases this managed object reference and frees the resources that
13539	were allocated for it in the webservice server process. After calling
13540	this method, the identifier of the reference can no longer be used.
13541	</desc>
13542	</method>
13543
13544	</interface>
13545
13546	<!--
13547	// IWebsessionManager
13548	/////////////////////////////////////////////////////////////////////////
13549	-->
13550
13551	<interface
13552	name="IWebsessionManager" extends="$unknown"
13553	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13554	internal="yes"
13555	wsmap="global"
13556	wscpp="hardcoded"
13557	>
13558	<desc>
13559	Websession manager. This provides essential services
13560	to webservice clients.
13561	</desc>
13562	<method name="logon">
13563	<desc>
13564	Logs a new client onto the webservice and returns a managed object reference to
13565	the IVirtualBox instance, which the client can then use as a basis to further
13566	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13567	interface, in one way or the other.
13568	</desc>
13569	<param name="username" type="wstring" dir="in"/>
13570	<param name="password" type="wstring" dir="in"/>
13571	<param name="return" type="IVirtualBox" dir="return"/>
13572	</method>
13573
13574	<method name="getSessionObject">
13575	<desc>
13576	Returns a managed object reference to the internal ISession object that was created
13577	for this web service session when the client logged on.
13578
13579	<see>ISession</see>
13580	</desc>
13581	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13582	<param name="return" type="ISession" dir="return"/>
13583	</method>
13584
13585	<method name="logoff">
13586	<desc>
13587	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13588	and destroys all resources associated with the session (most importantly, all
13589	managed objects created in the server while the session was active).
13590	</desc>
13591	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13592	</method>
13593
13594	</interface>
13595
13596	</if>
13597
13598	<!--
13599	// IPerformanceCollector & friends
13600	/////////////////////////////////////////////////////////////////////////
13601	-->
13602
13603	<interface
13604	name="IPerformanceMetric" extends="$unknown"
13605	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
13606	>
13607	<desc>
13608	The IPerformanceMetric interface represents parameters of the given
13609	performance metric.
13610	</desc>
13611
13612	<attribute name="metricName" type="wstring" readonly="yes">
13613	<desc>
13614	Name of the metric.
13615	</desc>
13616	</attribute>
13617
13618	<attribute name="object" type="$unknown" readonly="yes">
13619	<desc>
13620	Object this metric belongs to.
13621	</desc>
13622	</attribute>
13623
13624	<attribute name="description" type="wstring" readonly="yes">
13625	<desc>
13626	Textual description of the metric.
13627	</desc>
13628	</attribute>
13629
13630	<attribute name="period" type="unsigned long" readonly="yes">
13631	<desc>
13632	Time interval between samples, measured in seconds.
13633	</desc>
13634	</attribute>
13635
13636	<attribute name="count" type="unsigned long" readonly="yes">
13637	<desc>
13638	Number of recent samples retained by the performance collector for this
13639	metric.
13640
13641	When the collected sample count exceeds this number, older samples
13642	are discarded.
13643	</desc>
13644	</attribute>
13645
13646	<attribute name="unit" type="wstring" readonly="yes">
13647	<desc>
13648	Unit of measurement.
13649	</desc>
13650	</attribute>
13651
13652	<attribute name="minimumValue" type="long" readonly="yes">
13653	<desc>
13654	Minimum possible value of this metric.
13655	</desc>
13656	</attribute>
13657
13658	<attribute name="maximumValue" type="long" readonly="yes">
13659	<desc>
13660	Maximum possible value of this metric.
13661	</desc>
13662	</attribute>
13663	</interface>
13664
13665	<interface
13666	name="IPerformanceCollector" extends="$unknown"
13667	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
13668	wsmap="managed"
13669	>
13670	<desc>
13671	The IPerformanceCollector interface represents a service that collects and
13672	stores performance metrics data.
13673
13674	Performance metrics are associated with objects of interfaces like IHost and
13675	IMachine. Each object has a distinct set of performance metrics.
13676	The set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
13677
13678	Metric data is collected at the specified intervals and is retained
13679	internally. The interval and the number of retained samples can be set
13680	with <link to="IPerformanceCollector::setupMetrics" />.
13681
13682	Metrics are organized hierarchically, with each level separated by a
13683	slash (/) character. Generally, the scheme for metric names is like this:
13684
13685	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
13686
13687	"Category/Metric" together form the base metric name. A base metric is the
13688	smallest unit for which a sampling interval and the number of retained
13689	samples can be set. Only base metrics can be enabled and disabled. All
13690	sub-metrics are collected when their base metric is collected.
13691	Collected values for any set of sub-metrics can be queried with
13692	<link to="IPerformanceCollector::queryMetricsData" />.
13693
13694	For example "CPU/Load/User:avg"
13695	metric name stands for the "CPU" category, "Load" metric, "User" submetric,
13696	"average" aggregate. An aggregate function is computed over all retained
13697	data. Valid aggregate functions are:
13698
13699	<ul>
13700	<li>avg -- average</li>
13701	<li>min -- minimum</li>
13702	<li>max -- maximum</li>
13703	</ul>
13704
13705	When setting up
13706	metric parameters, querying metric data, enabling or disabling metrics
13707	wildcards can be used in metric names to specify a subset of metrics. For
13708	example, to select all CPU-related metrics use <tt>CPU/*</tt>, all
13709	averages can be queried using <tt>*:avg</tt> and so on. To query metric
13710	values without aggregates <tt>*:</tt> can be used.
13711
13712	The valid names for base metrics are:
13713
13714	<ul>
13715	<li>CPU/Load</li>
13716	<li>CPU/MHz</li>
13717	<li>RAM/Usage</li>
13718	</ul>
13719
13720	The general sequence for collecting and retrieving the metrics is:
13721	<ul>
13722	<li>
13723	Obtain an instance of IPerformanceCollector with
13724	<link to="IVirtualBox::performanceCollector" />
13725	</li>
13726	<li>
13727	Allocate and populate an array with references to objects the metrics
13728	will be collected for. Use references to IHost and IMachine objects.
13729	</li>
13730	<li>
13731	Allocate and populate an array with base metric names the data will be
13732	collected for.
13733	</li>
13734	<li>
13735	Call <link to="IPerformanceCollector::setupMetrics" />. From now on the
13736	metric data will be collected and stored.
13737	</li>
13738	<li>
13739	Wait for the data to get collected.
13740	</li>
13741	<li>
13742	Allocate and populate an array with references to objects the metric
13743	values will be queried for. You can re-use the object array used for
13744	setting base metrics.
13745	</li>
13746	<li>
13747	Allocate and populate an array with metric names the data will be
13748	collected for. Note that metric names differ from base metric names.
13749	</li>
13750	<li>
13751	Call <link to="IPerformanceCollector::queryMetricsData" />. The data that
13752	have been collected so far are returned. Note that the values are still
13753	retained internally and data collection continues.
13754	</li>
13755	</ul>
13756
13757	For an example of usage refer to the following files in VirtualBox SDK:
13758	<ul>
13759	<li>
13760	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
13761	</li>
13762	<li>
13763	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
13764	</li>
13765	</ul>
13766	</desc>
13767
13768	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
13769	<desc>
13770	Array of unique names of metrics.
13771
13772	This array represents all metrics supported by the performance
13773	collector. Individual objects do not necessarily support all of them.
13774	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
13775	list of supported metrics for a particular object.
13776	</desc>
13777	</attribute>
13778
13779	<method name="getMetrics">
13780	<desc>
13781	Returns parameters of specified metrics for a set of objects.
13782	<note>
13783	@c Null metrics array means all metrics. @c Null object array means
13784	all existing objects.
13785	</note>
13786	</desc>
13787	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13788	<desc>
13789	Metric name filter. Currently, only a comma-separated list of metrics
13790	is supported.
13791	</desc>
13792	</param>
13793	<param name="objects" type="$unknown" dir="in" safearray="yes">
13794	<desc>
13795	Set of objects to return metric parameters for.
13796	</desc>
13797	</param>
13798	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
13799	<desc>
13800	Array of returned metric parameters.
13801	</desc>
13802	</param>
13803	</method>
13804
13805	<method name="setupMetrics">
13806	<desc>
13807	Sets parameters of specified base metrics for a set of objects. Returns
13808	an array of <link to="IPerformanceMetric" /> describing the metrics have
13809	been affected.
13810	<note>
13811	@c Null or empty metric name array means all metrics. @c Null or empty
13812	object array means all existing objects. If metric name array contains
13813	a single element and object array contains many, the single metric
13814	name array element is applied to each object array element to form
13815	metric/object pairs.
13816	</note>
13817	</desc>
13818	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13819	<desc>
13820	Metric name filter. Comma-separated list of metrics with wildcard
13821	support.
13822	</desc>
13823	</param>
13824	<param name="objects" type="$unknown" dir="in" safearray="yes">
13825	<desc>
13826	Set of objects to setup metric parameters for.
13827	</desc>
13828	</param>
13829	<param name="period" type="unsigned long" dir="in">
13830	<desc>
13831	Time interval in seconds between two consecutive samples of performance
13832	data.
13833	</desc>
13834	</param>
13835	<param name="count" type="unsigned long" dir="in">
13836	<desc>
13837	Number of samples to retain in performance data history. Older samples
13838	get discarded.
13839	</desc>
13840	</param>
13841	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13842	<desc>
13843	Array of metrics that have been modified by the call to this method.
13844	</desc>
13845	</param>
13846	</method>
13847
13848	<method name="enableMetrics">
13849	<desc>
13850	Turns on collecting specified base metrics. Returns an array of
13851	<link to="IPerformanceMetric" /> describing the metrics have been
13852	affected.
13853	<note>
13854	@c Null or empty metric name array means all metrics. @c Null or empty
13855	object array means all existing objects. If metric name array contains
13856	a single element and object array contains many, the single metric
13857	name array element is applied to each object array element to form
13858	metric/object pairs.
13859	</note>
13860	</desc>
13861	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13862	<desc>
13863	Metric name filter. Comma-separated list of metrics with wildcard
13864	support.
13865	</desc>
13866	</param>
13867	<param name="objects" type="$unknown" dir="in" safearray="yes">
13868	<desc>
13869	Set of objects to enable metrics for.
13870	</desc>
13871	</param>
13872	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13873	<desc>
13874	Array of metrics that have been modified by the call to this method.
13875	</desc>
13876	</param>
13877	</method>
13878
13879	<method name="disableMetrics">
13880	<desc>
13881	Turns off collecting specified base metrics. Returns an array of
13882	<link to="IPerformanceMetric" /> describing the metrics have been
13883	affected.
13884	<note>
13885	@c Null or empty metric name array means all metrics. @c Null or empty
13886	object array means all existing objects. If metric name array contains
13887	a single element and object array contains many, the single metric
13888	name array element is applied to each object array element to form
13889	metric/object pairs.
13890	</note>
13891	</desc>
13892	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13893	<desc>
13894	Metric name filter. Comma-separated list of metrics with wildcard
13895	support.
13896	</desc>
13897	</param>
13898	<param name="objects" type="$unknown" dir="in" safearray="yes">
13899	<desc>
13900	Set of objects to disable metrics for.
13901	</desc>
13902	</param>
13903	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13904	<desc>
13905	Array of metrics that have been modified by the call to this method.
13906	</desc>
13907	</param>
13908	</method>
13909
13910	<method name="queryMetricsData">
13911	<desc>
13912	Queries collected metrics data for a set of objects.
13913
13914	The data itself and related metric information are returned in seven
13915	parallel and one flattened array of arrays. Elements of
13916	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
13917	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
13918	the same index describe one set of values corresponding to a single
13919	metric.
13920
13921	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
13922	start and length of a sub-array is indicated by
13923	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
13924	value for metric <tt>metricNames[i]</tt> is at
13925	<tt>returnData[returnIndices[i]]</tt>.
13926
13927	<note>
13928	@c Null or empty metric name array means all metrics. @c Null or empty
13929	object array means all existing objects. If metric name array contains
13930	a single element and object array contains many, the single metric
13931	name array element is applied to each object array element to form
13932	metric/object pairs.
13933	</note>
13934	<note>
13935	Data collection continues behind the scenes after call to
13936	@c queryMetricsData. The return data can be seen as the snapshot of
13937	the current state at the time of @c queryMetricsData call. The
13938	internally kept metric values are not cleared by the call. This makes
13939	possible querying different subsets of metrics or aggregates with
13940	subsequent calls. If periodic querying is needed it is highly
13941	suggested to query the values with @c interval*count period to avoid
13942	confusion. This way a completely new set of data values will be
13943	provided by each query.
13944	</note>
13945	</desc>
13946	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13947	<desc>
13948	Metric name filter. Comma-separated list of metrics with wildcard
13949	support.
13950	</desc>
13951	</param>
13952	<param name="objects" type="$unknown" dir="in" safearray="yes">
13953	<desc>
13954	Set of objects to query metrics for.
13955	</desc>
13956	</param>
13957	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
13958	<desc>
13959	Names of metrics returned in @c returnData.
13960	</desc>
13961	</param>
13962	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
13963	<desc>
13964	Objects associated with metrics returned in @c returnData.
13965	</desc>
13966	</param>
13967	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
13968	<desc>
13969	Units of measurement for each returned metric.
13970	</desc>
13971	</param>
13972	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
13973	<desc>
13974	Divisor that should be applied to return values in order to get
13975	floating point values. For example:
13976	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
13977	will retrieve the floating point value of i-th sample of the first
13978	metric.
13979	</desc>
13980	</param>
13981	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
13982	<desc>
13983	Sequence numbers of the first elements of value sequences of particular metrics
13984	returned in @c returnData. For aggregate metrics it is the sequence number of
13985	the sample the aggregate started calculation from.
13986	</desc>
13987	</param>
13988	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
13989	<desc>
13990	Indices of the first elements of value sequences of particular metrics
13991	returned in @c returnData.
13992	</desc>
13993	</param>
13994	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
13995	<desc>
13996	Lengths of value sequences of particular metrics.
13997	</desc>
13998	</param>
13999	<param name="returnData" type="long" dir="return" safearray="yes">
14000	<desc>
14001	Flattened array of all metric data containing sequences of values for
14002	each metric.
14003	</desc>
14004	</param>
14005	</method>
14006
14007	</interface>
14008
14009	<module name="VBoxSVC" context="LocalServer">
14010	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
14011	namespace="virtualbox.org">
14012	<interface name="IVirtualBox" default="yes"/>
14013	</class>
14014	</module>
14015
14016	<module name="VBoxC" context="InprocServer" threadingModel="Free">
14017	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
14018	namespace="virtualbox.org">
14019	<interface name="ISession" default="yes"/>
14020	</class>
14021	<class name="CallbackWrapper" uuid="49EE8561-5563-4715-B18C-A4B1A490DAFE"
14022	namespace="virtualbox.org">
14023	<interface name="ILocalOwner" default="yes"/>
14024	<interface name="IVirtualBoxCallback"/>
14025	<interface name="IConsoleCallback"/>
14026	</class>
14027	</module>
14028
14029	</library>
14030
14031	</idl>
14032
14033	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format