VirtualBox.xidl@ 30308

Last change on this file since 30308 was 30207, checked in by vboxsync, 15 years ago
Main: console COM events, cleanup, locking
Property svn:eol-style set to `native`
File size: 539.1 KB

Line
1	<?xml version="1.0" ?>
2
3	<!--
4
5	Copyright (C) 2006-2010 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI,
80	the VBoxManage command-line interface and the VBoxVRDP server) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109	</desc>
110
111	<if target="midl">
112	<cpp line="enum {"/>
113	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
114	<cpp line=" kTypeLibraryMinorVersion = 0"/>
115	<cpp line="};"/>
116	</if>
117
118	<if target="xpidl">
119	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
120	<cpp>
121	/* currently, nsISupportsImpl.h lacks the below-like macros */
122
123	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
124	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
125	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
126
127	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
128	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
129	NS_IMPL_THREADSAFE_ADDREF(_class) \
130	NS_IMPL_THREADSAFE_RELEASE(_class) \
131	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
132	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
133	#endif
134
135	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
136	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
137	NS_IMPL_THREADSAFE_ADDREF(_class) \
138	NS_IMPL_THREADSAFE_RELEASE(_class) \
139	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
140	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
141	#endif
142
143	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
144	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
145	NS_IMPL_THREADSAFE_ADDREF(_class) \
146	NS_IMPL_THREADSAFE_RELEASE(_class) \
147	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
148	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
149	#endif
150
151	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
152	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
153	NS_INTERFACE_MAP_BEGIN(_class) \
154	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
155	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
156	NS_IMPL_QUERY_CLASSINFO(_class) \
157	NS_INTERFACE_MAP_END
158	#endif
159
160	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
161	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
162	_i2, _ic2) \
163	NS_INTERFACE_MAP_BEGIN(_class) \
164	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
165	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
166	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
167	NS_IMPL_QUERY_CLASSINFO(_class) \
168	NS_INTERFACE_MAP_END
169	#endif
170
171	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
172	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
173	_i2, _ic2, _i3, _ic3) \
174	NS_INTERFACE_MAP_BEGIN(_class) \
175	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
176	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
177	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
178	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
179	NS_IMPL_QUERY_CLASSINFO(_class) \
180	NS_INTERFACE_MAP_END
181	#endif
182
183	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
184	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
185	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
186
187	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
188	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
189	NS_IMPL_THREADSAFE_ADDREF(_class) \
190	NS_IMPL_THREADSAFE_RELEASE(_class) \
191	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
192	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
193	#endif
194
195	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
196	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
197	_i2, _ic2) \
198	NS_IMPL_THREADSAFE_ADDREF(_class) \
199	NS_IMPL_THREADSAFE_RELEASE(_class) \
200	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
201	_i2, _ic2) \
202	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
203	#endif
204
205	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
206	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
207	_i2, _ic2, _i3, _ic3) \
208	NS_IMPL_THREADSAFE_ADDREF(_class) \
209	NS_IMPL_THREADSAFE_RELEASE(_class) \
210	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2, _i3, _ic3) \
212	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
213	#endif
214
215	</cpp>
216	</if>
217
218	<library
219	name="VirtualBox"
220	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
221	version="1.3"
222	desc="VirtualBox Type Library"
223	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
224	supportsErrorInfo="yes"
225	>
226
227
228	<!--
229	// COM result codes for VirtualBox
230	/////////////////////////////////////////////////////////////////////////
231	-->
232
233	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
234	<desc>
235	This section describes all VirtualBox-specific COM result codes that may
236	be returned by methods of VirtualBox COM interfaces in addition to
237	standard COM result codes.
238
239	Note that along with the result code, every VirtualBox method returns
240	extended error information through the IVirtualBoxErrorInfo interface on
241	failure. This interface is a preferred way to present the error to the end
242	user because it contains a human readable description of the error. Raw
243	result codes, both standard and described in this section, are intended to
244	be used by programs to analyze the reason of a failure and select an
245	appropriate course of action without involving the end user (for example,
246	retry the operation later or make a different call).
247
248	The standard COM result codes that may originate from our methods include:
249
250	<table>
251	<tr><td>E_INVALIDARG</td>
252	<td>
253	Returned when the value of the method's argument is not within the range
254	of valid values. This should not be confused with situations when the
255	value is within the range but simply doesn't suit the current object
256	state and there is a possibility that it will be accepted later (in such
257	cases VirtualBox-specific codes are returned, for example,
258	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
259	</td>
260	</tr>
261	<tr><td>E_POINTER</td>
262	<td>
263	Returned if a memory pointer for the output argument is invalid (for
264	example, @c null). Note that when pointers representing input
265	arguments (such as strings) are invalid, E_INVALIDARG is returned.
266	</td>
267	</tr>
268	<tr><td>E_ACCESSDENIED</td>
269	<td>
270	Returned when the called object is not ready. Since the lifetime of a
271	public COM object cannot be fully controlled by the implementation,
272	VirtualBox maintains the readiness state for all objects it creates and
273	returns this code in response to any method call on the object that was
274	deactivated by VirtualBox and is not functioning any more.
275	</td>
276	</tr>
277	<tr><td>E_OUTOFMEMORY</td>
278	<td>
279	Returned when a memory allocation operation fails.
280	</td>
281	</tr>
282	</table>
283	</desc>
284	</descGroup>
285
286	<!--
287	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
288	everything in <result>/<desc> after (and including) the first dot, so express
289	the matter of the error code in the first sentence and keep it short.
290	-->
291
292	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
293	<desc>
294	Object corresponding to the supplied arguments does not exist.
295	</desc>
296	</result>
297
298	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
299	<desc>
300	Current virtual machine state prevents the operation.
301	</desc>
302	</result>
303
304	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
305	<desc>
306	Virtual machine error occurred attempting the operation.
307	</desc>
308	</result>
309
310	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
311	<desc>
312	File not accessible or erroneous file contents.
313	</desc>
314	</result>
315
316	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
317	<desc>
318	Runtime subsystem error.
319	</desc>
320	</result>
321
322	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
323	<desc>
324	Pluggable Device Manager error.
325	</desc>
326	</result>
327
328	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
329	<desc>
330	Current object state prohibits operation.
331	</desc>
332	</result>
333
334	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
335	<desc>
336	Host operating system related error.
337	</desc>
338	</result>
339
340	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
341	<desc>
342	Requested operation is not supported.
343	</desc>
344	</result>
345
346	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
347	<desc>
348	Invalid XML found.
349	</desc>
350	</result>
351
352	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
353	<desc>
354	Current session state prohibits operation.
355	</desc>
356	</result>
357
358	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
359	<desc>
360	Object being in use prohibits operation.
361	</desc>
362	</result>
363
364	<result name="VBOX_E_DONT_CALL_AGAIN" value="0x80BB000D">
365	<desc>
366	Returned by callback methods which does not need to be called again
367	because the client does not actually make use of them.
368	</desc>
369	</result>
370
371	<!--
372	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
373	everything in <result>/<desc> after (and including) the first dot, so express
374	the matter of the error code in the first sentence and keep it short.
375	-->
376
377	<descGroup/>
378
379	<!--
380	// all common enums
381	/////////////////////////////////////////////////////////////////////////
382	-->
383
384	<enum name="SettingsVersion"
385	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
386	>
387	<desc>Settings version of VirtualBox settings files. This is written to
388	the "version" attribute of the root "VirtualBox" element in the settings
389	file XML and indicates which VirtualBox version wrote the file.
390	</desc>
391
392	<const name="Null" value="0">
393	<desc>Null value, indicates invalid version.</desc>
394	</const>
395	<const name="v1_0" value="1">
396	<desc>Legacy settings version, not currently supported.</desc>
397	</const>
398	<const name="v1_1" value="2">
399	<desc>Legacy settings version, not currently supported.</desc>
400	</const>
401	<const name="v1_2" value="3">
402	<desc>Legacy settings version, not currently supported.</desc>
403	</const>
404	<const name="v1_3pre" value="4">
405	<desc>Legacy settings version, not currently supported.</desc>
406	</const>
407	<const name="v1_3" value="5">
408	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
409	<!--
410	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
411	-->
412	</const>
413	<const name="v1_4" value="6">
414	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
415	<!--
416	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
417	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
418	-->
419	</const>
420	<const name="v1_5" value="7">
421	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
422	<!-- 2008-09-04: 2.0.0 released
423	2008-11-20: settings version 1.5 introduced
424	2008-12-17: 2.1.0 released
425	Machine changes:
426	guest OS identifiers changed;
427	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
428	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
429	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
430	-->
431	</const>
432	<const name="v1_6" value="8">
433	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
434	<!-- 2008-12-17: 2.1.0 released
435	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
436	2009-04-08: 2.2.0 released
437	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
438	-->
439	</const>
440	<const name="v1_7" value="9">
441	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
442	<!-- 2008-12-17: 2.1.0 released
443	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
444	2009-04-08: 2.2.0 released
445	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
446	Machine changes: HardDiskAttachments is now StorageControllers (done)
447	-->
448	</const>
449	<const name="v1_8" value="10">
450	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
451	<!-- Machine additions: Display/@accelerate2DVideo (done)
452	-->
453	</const>
454	<const name="v1_9" value="11">
455	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
456	<!-- The big storage controller / DVD / Floppy rework (done)
457	-->
458	</const>
459	<const name="v1_10" value="12">
460	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
461	<!-- Machine changes: RTC localOrUTC (done)
462	CPU hot-plug support
463	-->
464	</const>
465	<const name="Future" value="13">
466	<desc>Settings version greater than "1.10", written by a future VirtualBox version.</desc>
467	</const>
468	</enum>
469
470	<enum
471	name="AccessMode"
472	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
473	>
474	<desc>
475	Access mode for opening files.
476	</desc>
477
478	<const name="ReadOnly" value="1"/>
479	<const name="ReadWrite" value="2"/>
480	</enum>
481
482	<enum
483	name="MachineState"
484	uuid="e998d075-543a-41fc-8aa9-5ca3e92393fd"
485	>
486	<desc>
487	Virtual machine execution state.
488
489	This enumeration represents possible values of the <link
490	to="IMachine::state"/> attribute.
491
492	Below is the basic virtual machine state diagram. It shows how the state
493	changes during virtual machine execution. The text in square braces shows
494	a method of the IConsole interface that performs the given state
495	transition.
496
497	<pre>
498	+---------[powerDown()] <- Stuck <--[failure]-+
499	V \|
500	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
501	\| \| \| \| V \|
502	\| Aborted -----+ +--> Running --[pause()]--> Paused
503	\| \| ^ \| ^ \|
504	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
505	\| ^ \| \| \| \|
506	\| \| +-----------------------------------------+-\|-------------------+ +
507	\| \| \| \| \|
508	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
509	\| \| \| \|
510	\| +-------- Saving <--------[saveState()]<----------+---------------------+
511	\| \| \|
512	+-------------- Stopping -------[powerDown()]<----------+---------------------+
513	</pre>
514
515	Note that states to the right from PoweredOff, Aborted and Saved in the
516	above diagram are called <i>online VM states</i>. These states
517	represent the virtual machine which is being executed in a dedicated
518	process (usually with a GUI window attached to it where you can see the
519	activity of the virtual machine and interact with it). There are two
520	special pseudo-states, FirstOnline and LastOnline, that can be used in
521	relational expressions to detect if the given machine state is online or
522	not:
523
524	<pre>
525	if (machine.GetState() >= MachineState_FirstOnline &&
526	machine.GetState() <= MachineState_LastOnline)
527	{
528	...the machine is being executed...
529	}
530	</pre>
531
532	When the virtual machine is in one of the online VM states (that is, being
533	executed), only a few machine settings can be modified. Methods working
534	with such settings contain an explicit note about that. An attempt to
535	change any oter setting or perform a modifying operation during this time
536	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
537
538	All online states except Running, Paused and Stuck are transitional: they
539	represent temporary conditions of the virtual machine that will last as
540	long as the operation that initiated such a condition.
541
542	The Stuck state is a special case. It means that execution of the machine
543	has reached the "Guru Meditation" condition. This condition indicates an
544	internal VMM (virtual machine manager) failure which may happen as a
545	result of either an unhandled low-level virtual hardware exception or one
546	of the recompiler exceptions (such as the <i>too-many-traps</i>
547	condition).
548
549	Note also that any online VM state may transit to the Aborted state. This
550	happens if the process that is executing the virtual machine terminates
551	unexpectedly (for example, crashes). Other than that, the Aborted state is
552	equivalent to PoweredOff.
553
554	There are also a few additional state diagrams that do not deal with
555	virtual machine execution and therefore are shown separately. The states
556	shown on these diagrams are called <i>offline VM states</i> (this includes
557	PoweredOff, Aborted and Saved too).
558
559	The first diagram shows what happens when a lengthy setup operation is
560	being executed (such as <link to="IMachine::attachDevice"/>).
561
562	<pre>
563	+----------------------------------(same state as before the call)------+
564	\| \|
565	+-> PoweredOff --+ \|
566	\| \| \|
567	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
568	\| \|
569	+-> Saved -------+
570	</pre>
571
572	The next two diagrams demonstrate the process of taking a snapshot of a
573	powered off virtual machine, restoring the state to that as of a snapshot
574	or deleting a snapshot, respectively.
575
576	<pre>
577	+----------------------------------(same state as before the call)------+
578	\| \|
579	+-> PoweredOff --+ \|
580	\| +-->[takeSnapshot()] -------------------> Saving ------+
581	+-> Aborted -----+
582
583	+-> PoweredOff --+
584	\| \|
585	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
586	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
587	+-> Saved -------+ \|
588	\| \|
589	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
590	</pre>
591
592	Note that the Saving state is present in both the offline state group and
593	online state group. Currently, the only way to determine what group is
594	assumed in a particular case is to remember the previous machine state: if
595	it was Running or Paused, then Saving is an online state, otherwise it is
596	an offline state. This inconsistency may be removed in one of the future
597	versions of VirtualBox by adding a new state.
598
599	<note internal="yes">
600	For whoever decides to touch this enum: In order to keep the
601	comparisons involving FirstOnline and LastOnline pseudo-states valid,
602	the numeric values of these states must be correspondingly updated if
603	needed: for any online VM state, the condition
604	<tt>FirstOnline <= state <= LastOnline</tt> must be
605	@c true. The same relates to transient states for which
606	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
607	@c true.
608	</note>
609	</desc>
610
611	<const name="Null" value="0">
612	<desc>Null value (never used by the API).</desc>
613	</const>
614	<const name="PoweredOff" value="1">
615	<desc>
616	The machine is not running and has no saved execution state; it has
617	either never been started or been shut down successfully.
618	</desc>
619	</const>
620	<const name="Saved" value="2">
621	<desc>
622	The machine is not currently running, but the execution state of the machine
623	has been saved to an external file when it was running, from where
624	it can be resumed.
625	</desc>
626	</const>
627	<const name="Teleported" value="3">
628	<desc>
629	The machine was teleported to a different host (or process) and then
630	powered off. Take care when powering it on again may corrupt resources
631	it shares with the teleportation target (e.g. disk and network).
632	</desc>
633	</const>
634	<const name="Aborted" value="4">
635	<desc>
636	The process running the machine has terminated abnormally. This may
637	indicate a crash of the VM process in host execution context, or
638	the VM process has been terminated externally.
639	</desc>
640	</const>
641	<const name="Running" value="5">
642	<desc>
643	The machine is currently being executed.
644	<note internal="yes">
645	For whoever decides to touch this enum: In order to keep the
646	comparisons in the old source code valid, this state must immediately
647	precede the Paused state.
648	TODO: Lift this spectacularly wonderful restriction.
649	</note>
650	</desc>
651	</const>
652	<const name="Paused" value="6">
653	<desc>
654	Execution of the machine has been paused.
655	<note internal="yes">
656	For whoever decides to touch this enum: In order to keep the
657	comparisons in the old source code valid, this state must immediately
658	follow the Running state.
659	TODO: Lift this spectacularly wonderful restriction.
660	</note>
661	</desc>
662	</const>
663	<const name="Stuck" value="7">
664	<desc>
665	Execution of the machine has reached the "Guru Meditation"
666	condition. This indicates a severe error in the hypervisor itself.
667	<note internal="yes">
668	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
669	"Guru", perhaps? Or are there some other VMM states that are
670	intended to be lumped in here as well?
671	</note>
672	</desc>
673	</const>
674	<const name="Teleporting" value="8">
675	<desc>
676	The machine is about to be teleported to a different host or process.
677	It is possible to pause a machine in this state, but it will go to the
678	<link to="MachineState::PausedTeleporting"/> state and it will not be
679	possible to resume it again unless the teleportation fails.
680	</desc>
681	</const>
682	<const name="LiveSnapshotting" value="9">
683	<desc>
684	A live snapshot is being taken. The machine is running normally, but
685	some of the runtime configuration options are inaccessible. Also, if
686	paused while in this state it will transition to
687	<link to="MachineState::Saving"/> and it will not be resume the
688	execution until the snapshot operation has completed.
689	</desc>
690	</const>
691	<const name="Starting" value="10">
692	<desc>
693	Machine is being started after powering it on from a
694	zero execution state.
695	</desc>
696	</const>
697	<const name="Stopping" value="11">
698	<desc>
699	Machine is being normally stopped powering it off, or after the guest OS
700	has initiated a shutdown sequence.
701	</desc>
702	</const>
703	<const name="Saving" value="12">
704	<desc>
705	Machine is saving its execution state to a file, or an online
706	snapshot of the machine is being taken.
707	</desc>
708	</const>
709	<const name="Restoring" value="13">
710	<desc>
711	Execution state of the machine is being restored from a file
712	after powering it on from the saved execution state.
713	</desc>
714	</const>
715	<const name="TeleportingPausedVM" value="14">
716	<desc>
717	The machine is being teleported to another host or process, but it is
718	not running. This is the paused variant of the
719	<link to="MachineState::Teleporting"/> state.
720	</desc>
721	</const>
722	<const name="TeleportingIn" value="15">
723	<desc>
724	Teleporting the machine state in from another host or process.
725	</desc>
726	</const>
727	<const name="DeletingSnapshotOnline" value="16">
728	<desc>
729	Teleporting the machine state in from another host or process.
730	</desc>
731	</const>
732	<const name="DeletingSnapshotPaused" value="17">
733	<desc>
734	Teleporting the machine state in from another host or process.
735	</desc>
736	</const>
737	<const name="RestoringSnapshot" value="18">
738	<desc>
739	A machine snapshot is being restored; this typically does not take long.
740	</desc>
741	</const>
742	<const name="DeletingSnapshot" value="19">
743	<desc>
744	A machine snapshot is being deleted; this can take a long time since this
745	may require merging differencing media.
746	</desc>
747	</const>
748	<const name="SettingUp" value="20">
749	<desc>
750	Lengthy setup operation is in progress.
751	</desc>
752	</const>
753
754	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
755	<desc>
756	Pseudo-state: first online state (for use in relational expressions).
757	</desc>
758	</const>
759	<const name="LastOnline" value="17" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
760	<desc>
761	Pseudo-state: last online state (for use in relational expressions).
762	</desc>
763	</const>
764
765	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
766	<desc>
767	Pseudo-state: first transient state (for use in relational expressions).
768	</desc>
769	</const>
770	<const name="LastTransient" value="20" wsmap="suppress"> <!-- SettingUp -->
771	<desc>
772	Pseudo-state: last transient state (for use in relational expressions).
773	</desc>
774	</const>
775
776	</enum>
777
778	<enum
779	name="SessionState"
780	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
781	>
782	<desc>
783	Session state. This enumeration represents possible values of
784	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
785	attributes. See individual enumerator descriptions for the meaning for
786	every value.
787	</desc>
788
789	<const name="Null" value="0">
790	<desc>Null value (never used by the API).</desc>
791	</const>
792	<const name="Closed" value="1">
793	<desc>
794	The machine has no open sessions (<link to="IMachine::sessionState"/>);
795	the session is closed (<link to="ISession::state"/>)
796	</desc>
797	</const>
798	<const name="Open" value="2">
799	<desc>
800	The machine has an open direct session (<link to="IMachine::sessionState"/>);
801	the session is open (<link to="ISession::state"/>)
802	</desc>
803	</const>
804	<const name="Spawning" value="3">
805	<desc>
806	A new (direct) session is being opened for the machine as a result of
807	<link to="IVirtualBox::openRemoteSession"/> call
808	(<link to="IMachine::sessionState"/> or <link to="ISession::state"/>).
809	This state also occurs as a short transient state when a new direct
810	session is opened by calling <link to="IVirtualBox::openSession"/>.
811	</desc>
812	</const>
813	<const name="Closing" value="4">
814	<desc>
815	The direct session is being closed (<link to="IMachine::sessionState"/>);
816	the session is being closed (<link to="ISession::state"/>)
817	</desc>
818	</const>
819	</enum>
820
821	<enum
822	name="CPUPropertyType"
823	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
824	>
825	<desc>
826	Virtual CPU property type. This enumeration represents possible values of the
827	IMachine get- and setCPUProperty methods.
828	</desc>
829	<const name="Null" value="0">
830	<desc>Null value (never used by the API).</desc>
831	</const>
832	<const name="PAE" value="1">
833	<desc>
834	This setting determines whether VirtualBox will expose the Physical Address
835	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
836	is not available, it will not be reported.
837	</desc>
838	</const>
839	<const name="Synthetic" value="2">
840	<desc>
841	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
842	teleporting between host systems that differ significantly.
843	</desc>
844	</const>
845	</enum>
846
847
848	<enum
849	name="HWVirtExPropertyType"
850	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
851	>
852	<desc>
853	Hardware virtualization property type. This enumeration represents possible values
854	for the <link to="IMachine::getHWVirtExProperty"/> and
855	<link to="IMachine::setHWVirtExProperty"/> methods.
856	</desc>
857	<const name="Null" value="0">
858	<desc>Null value (never used by the API).</desc>
859	</const>
860	<const name="Enabled" value="1">
861	<desc>
862	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
863	such extensions are not available, they will not be used.
864	</desc>
865	</const>
866	<const name="Exclusive" value="2">
867	<desc>
868	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
869	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
870	feature of the host. To share these with other hypervisors, you must disable this property.
871	</desc>
872	</const>
873	<const name="VPID" value="3">
874	<desc>
875	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
876	</desc>
877	</const>
878	<const name="NestedPaging" value="4">
879	<desc>
880	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
881	</desc>
882	</const>
883	<const name="LargePages" value="5">
884	<desc>
885	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
886	</desc>
887	</const>
888	</enum>
889
890	<enum
891	name="SessionType"
892	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
893	>
894	<desc>
895	Session type. This enumeration represents possible values of the
896	<link to="ISession::type"/> attribute.
897	</desc>
898
899	<const name="Null" value="0">
900	<desc>Null value (never used by the API).</desc>
901	</const>
902	<const name="Direct" value="1">
903	<desc>
904	Direct session
905	(opened by <link to="IVirtualBox::openSession"/>)
906	</desc>
907	</const>
908	<const name="Remote" value="2">
909	<desc>
910	Remote session
911	(opened by <link to="IVirtualBox::openRemoteSession"/>)
912	</desc>
913	</const>
914	<const name="Existing" value="3">
915	<desc>
916	Existing session
917	(opened by <link to="IVirtualBox::openExistingSession"/>)
918	</desc>
919	</const>
920	</enum>
921
922	<enum
923	name="DeviceType"
924	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
925	>
926	<desc>
927	Device type.
928	</desc>
929	<const name="Null" value="0">
930	<desc>
931	Null value, may also mean "no device" (not allowed for
932	<link to="IConsole::getDeviceActivity"/>).
933	</desc>
934	</const>
935	<const name="Floppy" value="1">
936	<desc>Floppy device.</desc>
937	</const>
938	<const name="DVD" value="2">
939	<desc>CD/DVD-ROM device.</desc>
940	</const>
941	<const name="HardDisk" value="3">
942	<desc>Hard disk device.</desc>
943	</const>
944	<const name="Network" value="4">
945	<desc>Network device.</desc>
946	</const>
947	<const name="USB" value="5">
948	<desc>USB device.</desc>
949	</const>
950	<const name="SharedFolder" value="6">
951	<desc>Shared folder device.</desc>
952	</const>
953	</enum>
954
955	<enum
956	name="DeviceActivity"
957	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
958	>
959	<desc>
960	Device activity for <link to="IConsole::getDeviceActivity"/>.
961	</desc>
962
963	<const name="Null" value="0"/>
964	<const name="Idle" value="1"/>
965	<const name="Reading" value="2"/>
966	<const name="Writing" value="3"/>
967	</enum>
968
969	<enum
970	name="ClipboardMode"
971	uuid="33364716-4008-4701-8f14-be0fa3d62950"
972	>
973	<desc>
974	Host-Guest clipboard interchange mode.
975	</desc>
976
977	<const name="Disabled" value="0"/>
978	<const name="HostToGuest" value="1"/>
979	<const name="GuestToHost" value="2"/>
980	<const name="Bidirectional" value="3"/>
981	</enum>
982
983	<enum
984	name="Scope"
985	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
986	>
987	<desc>
988	Scope of the operation.
989
990	A generic enumeration used in various methods to define the action or
991	argument scope.
992	</desc>
993
994	<const name="Global" value="0"/>
995	<const name="Machine" value="1"/>
996	<const name="Session" value="2"/>
997	</enum>
998
999	<enum
1000	name="BIOSBootMenuMode"
1001	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1002	>
1003	<desc>
1004	BIOS boot menu mode.
1005	</desc>
1006
1007	<const name="Disabled" value="0"/>
1008	<const name="MenuOnly" value="1"/>
1009	<const name="MessageAndMenu" value="2"/>
1010	</enum>
1011
1012	<enum
1013	name="ProcessorFeature"
1014	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1015	>
1016	<desc>
1017	CPU features.
1018	</desc>
1019
1020	<const name="HWVirtEx" value="0"/>
1021	<const name="PAE" value="1"/>
1022	<const name="LongMode" value="2"/>
1023	<const name="NestedPaging" value="3"/>
1024	</enum>
1025
1026	<enum
1027	name="FirmwareType"
1028	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1029	>
1030	<desc>
1031	Firmware type.
1032	</desc>
1033	<const name="BIOS" value="1">
1034	<desc>BIOS Firmware.</desc>
1035	</const>
1036	<const name="EFI" value="2">
1037	<desc>EFI Firmware, bitness detetced basing on OS type.</desc>
1038	</const>
1039	<const name="EFI32" value="3">
1040	<desc>Efi firmware, 32-bit.</desc>
1041	</const>
1042	<const name="EFI64" value="4">
1043	<desc>Efi firmware, 64-bit.</desc>
1044	</const>
1045	<const name="EFIDUAL" value="5">
1046	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1047	</const>
1048	</enum>
1049
1050	<enum
1051	name="PointingHidType"
1052	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1053	>
1054	<desc>
1055	Type of pointing device used in a virtual machine.
1056	</desc>
1057	<const name="None" value="1">
1058	<desc>No mouse.</desc>
1059	</const>
1060	<const name="PS2Mouse" value="2">
1061	<desc>PS/2 auxillary device, a.k.a. mouse.</desc>
1062	</const>
1063	<const name="USBMouse" value="3">
1064	<desc>USB mouse (relative pointer).</desc>
1065	</const>
1066	<const name="USBTablet" value="4">
1067	<desc>USB tablet (absolute pointer).</desc>
1068	</const>
1069	<const name="ComboMouse" value="5">
1070	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1071	Using of such device can have negative performance implications. </desc>
1072	</const>
1073	</enum>
1074
1075	<enum
1076	name="KeyboardHidType"
1077	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1078	>
1079	<desc>
1080	Type of keyboard device used in a virtual machine.
1081	</desc>
1082	<const name="None" value="1">
1083	<desc>No keyboard.</desc>
1084	</const>
1085	<const name="PS2Keyboard" value="2">
1086	<desc>PS/2 keyboard.</desc>
1087	</const>
1088	<const name="USBKeyboard" value="3">
1089	<desc>USB keyboard.</desc>
1090	</const>
1091	<const name="ComboKeyboard" value="4">
1092	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1093	Using of such device can have negative performance implications. </desc>
1094	</const>
1095	</enum>
1096
1097	<!--
1098	// IVirtualBoxErrorInfo
1099	/////////////////////////////////////////////////////////////////////////
1100	-->
1101
1102	<interface
1103	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1104	uuid="4b86d186-407e-4f9e-8be8-e50061be8725"
1105	supportsErrorInfo="no"
1106	wsmap="managed"
1107	>
1108	<desc>
1109	The IVirtualBoxErrorInfo interface represents extended error information.
1110
1111	Extended error information can be set by VirtualBox components after
1112	unsuccessful or partially successful method invocation. This information
1113	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1114	and then shown to the client in addition to the plain 32-bit result code.
1115
1116	In MS COM, this interface extends the IErrorInfo interface,
1117	in XPCOM, it extends the nsIException interface. In both cases,
1118	it provides a set of common attributes to retrieve error
1119	information.
1120
1121	Sometimes invocation of some component's method may involve methods of
1122	other components that may also fail (independently of this method's
1123	failure), or a series of non-fatal errors may precede a fatal error that
1124	causes method failure. In cases like that, it may be desirable to preserve
1125	information about all errors happened during method invocation and deliver
1126	it to the caller. The <link to="#next"/> attribute is intended
1127	specifically for this purpose and allows to represent a chain of errors
1128	through a single IVirtualBoxErrorInfo object set after method invocation.
1129
1130	Note that errors are stored to a chain in the reverse order, i.e. the
1131	initial error object you query right after method invocation is the last
1132	error set by the callee, the object it points to in the @a next attribute
1133	is the previous error and so on, up to the first error (which is the last
1134	in the chain).
1135	</desc>
1136
1137	<attribute name="resultCode" type="long" readonly="yes">
1138	<desc>
1139	Result code of the error.
1140	Usually, it will be the same as the result code returned
1141	by the method that provided this error information, but not
1142	always. For example, on Win32, CoCreateInstance() will most
1143	likely return E_NOINTERFACE upon unsuccessful component
1144	instantiation attempt, but not the value the component factory
1145	returned. Value is typed 'long', not 'result',
1146	to make interface usable from scripting languages.
1147	<note>
1148	In MS COM, there is no equivalent.
1149	In XPCOM, it is the same as nsIException::result.
1150	</note>
1151	</desc>
1152	</attribute>
1153
1154	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1155	<desc>
1156	UUID of the interface that defined the error.
1157	<note>
1158	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1159	data type.
1160	In XPCOM, there is no equivalent.
1161	</note>
1162	</desc>
1163	</attribute>
1164
1165	<attribute name="component" type="wstring" readonly="yes">
1166	<desc>
1167	Name of the component that generated the error.
1168	<note>
1169	In MS COM, it is the same as IErrorInfo::GetSource.
1170	In XPCOM, there is no equivalent.
1171	</note>
1172	</desc>
1173	</attribute>
1174
1175	<attribute name="text" type="wstring" readonly="yes">
1176	<desc>
1177	Text description of the error.
1178	<note>
1179	In MS COM, it is the same as IErrorInfo::GetDescription.
1180	In XPCOM, it is the same as nsIException::message.
1181	</note>
1182	</desc>
1183	</attribute>
1184
1185	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1186	<desc>
1187	Next error object if there is any, or @c null otherwise.
1188	<note>
1189	In MS COM, there is no equivalent.
1190	In XPCOM, it is the same as nsIException::inner.
1191	</note>
1192	</desc>
1193	</attribute>
1194
1195	</interface>
1196
1197	<interface
1198	name="ILocalOwner" extends="$unknown"
1199	uuid="308FF42A-DC45-49D4-A950-B1EEE5E00BB5" wsmap="suppress"
1200	>
1201	<desc>
1202	The ILocalOwner interface allows to register local objects
1203	(created without COM calls, but with new()).
1204	Once registered, calls to methods of such objects can be made
1205	from remote COM processes.
1206	The main usecase is the event callback implementation where
1207	API clients provide callback objects.
1208	</desc>
1209	<method name="setLocalObject">
1210	<desc>
1211	Set local object.
1212	</desc>
1213	<param name="object" type="$unknown" dir="in">
1214	<desc>Local object to forward requests to.
1215	If null, clears currently set local object.</desc>
1216	</param>
1217	</method>
1218	</interface>
1219
1220	<!--
1221	// IVirtualBox
1222	/////////////////////////////////////////////////////////////////////////
1223	-->
1224
1225	<interface
1226	name="IVirtualBoxCallback" extends="$unknown"
1227	uuid="7f6a65b6-ad5d-4a67-8872-0b11cb7ea95c"
1228	wsmap="suppress"
1229	>
1230
1231	<method name="onMachineStateChange">
1232	<desc>
1233	The execution state of the given machine has changed.
1234	<see>IMachine::state</see>
1235	<result name="VBOX_E_DONT_CALL_AGAIN">
1236	Do not call again, this method is a NOP.
1237	</result>
1238	</desc>
1239	<param name="machineId" type="uuid" mod="string" dir="in">
1240	<desc>ID of the machine this event relates to.</desc>
1241	</param>
1242	<param name="state" type="MachineState" dir="in">
1243	<desc>New execution state.</desc>
1244	</param>
1245	</method>
1246
1247	<method name="onMachineDataChange">
1248	<desc>
1249	Any of the settings of the given machine has changed.
1250	<result name="VBOX_E_DONT_CALL_AGAIN">
1251	Do not call again, this method is a NOP.
1252	</result>
1253	</desc>
1254	<param name="machineId" type="uuid" mod="string" dir="in">
1255	<desc>ID of the machine this event relates to.</desc>
1256	</param>
1257	</method>
1258
1259	<method name="onExtraDataCanChange">
1260	<desc>
1261	Notification when someone tries to change extra data for
1262	either the given machine or (if @c null) global extra data.
1263	This gives the chance to veto against changes.
1264	<result name="VBOX_E_DONT_CALL_AGAIN">
1265	Do not call again, this method is a NOP. Change is allowed.
1266	</result>
1267	</desc>
1268	<param name="machineId" type="uuid" mod="string" dir="in">
1269	<desc>
1270	ID of the machine this event relates to
1271	(@c null ID for global extra data change requests).
1272	</desc>
1273	</param>
1274	<param name="key" type="wstring" dir="in">
1275	<desc>
1276	Extra data key for the attempted write.
1277	</desc>
1278	</param>
1279	<param name="value" type="wstring" dir="in">
1280	<desc>
1281	Extra data value for the given key.
1282	</desc>
1283	</param>
1284	<param name="error" type="wstring" dir="out">
1285	<desc>
1286	Optional error message describing the reason of the
1287	veto (ignored if this notification returns @c true).
1288	</desc>
1289	</param>
1290	<param name="allowChange" type="boolean" dir="return">
1291	<desc>
1292	Flag to indicate whether the callee agrees (@c true)
1293	or vetoes against the change (@c false).
1294	</desc>
1295	</param>
1296	</method>
1297
1298	<method name="onExtraDataChange">
1299	<desc>
1300	Notification when machine specific or global extra data
1301	has changed.
1302	<result name="VBOX_E_DONT_CALL_AGAIN">
1303	Do not call again, this method is a NOP.
1304	</result>
1305	</desc>
1306	<param name="machineId" type="uuid" mod="string" dir="in">
1307	<desc>
1308	ID of the machine this event relates to.
1309	Null for global extra data changes.
1310	</desc>
1311	</param>
1312	<param name="key" type="wstring" dir="in">
1313	<desc>
1314	Extra data key that has changed.
1315	</desc>
1316	</param>
1317	<param name="value" type="wstring" dir="in">
1318	<desc>
1319	Extra data value for the given key.
1320	</desc>
1321	</param>
1322	</method>
1323
1324	<method name="onMediumRegistered">
1325	<desc>
1326	The given medium was registered or unregistered
1327	within this VirtualBox installation.
1328
1329	The @a mediumType parameter describes what type of
1330	medium the specified @a mediumId refers to. Possible
1331	values are:
1332
1333	<ul>
1334	<li><link to="DeviceType_HardDisk"/>: the medium is a hard disk
1335	that, if registered, can be obtained using the
1336	<link to="IVirtualBox::getHardDisk"/> call.</li>
1337	<li><link to="DeviceType_DVD"/>: the medium is a CD/DVD image
1338	that, if registered, can be obtained using the
1339	<link to="IVirtualBox::getDVDImage"/> call.</li>
1340	<li><link to="DeviceType_Floppy"/>: the medium is a Floppy image
1341	that, if registered, can be obtained using the
1342	<link to="IVirtualBox::getFloppyImage"/> call.</li>
1343	</ul>
1344
1345	Note that if this is a deregistration notification,
1346	there is no way to access the object representing the
1347	unregistered medium. It is supposed that the
1348	application will do required cleanup based on the
1349	@a mediumId value.
1350
1351	<result name="VBOX_E_DONT_CALL_AGAIN">
1352	Do not call again, this method is a NOP.
1353	</result>
1354	</desc>
1355	<param name="mediumId" type="uuid" mod="string" dir="in">
1356	<desc>ID of the medium this event relates to.</desc>
1357	</param>
1358	<param name="mediumType" type="DeviceType" dir="in">
1359	<desc>Type of the medium this event relates to.</desc>
1360	</param>
1361	<param name="registered" type="boolean" dir="in">
1362	<desc>
1363	If @c true, the medium was registered, otherwise it was
1364	unregistered.
1365	</desc>
1366	</param>
1367	</method>
1368
1369	<method name="onMachineRegistered">
1370	<desc>
1371	The given machine was registered or unregistered
1372	within this VirtualBox installation.
1373	<result name="VBOX_E_DONT_CALL_AGAIN">
1374	Do not call again, this method is a NOP.
1375	</result>
1376	</desc>
1377	<param name="machineId" type="uuid" mod="string" dir="in">
1378	<desc>ID of the machine this event relates to.</desc>
1379	</param>
1380	<param name="registered" type="boolean" dir="in">
1381	<desc>
1382	If @c true, the machine was registered, otherwise it was
1383	unregistered.
1384	</desc>
1385	</param>
1386	</method>
1387
1388	<method name="onSessionStateChange">
1389	<desc>
1390	The state of the session for the given machine was changed.
1391	<see>IMachine::sessionState</see>
1392	<result name="VBOX_E_DONT_CALL_AGAIN">
1393	Do not call again, this method is a NOP.
1394	</result>
1395	</desc>
1396	<param name="machineId" type="uuid" mod="string" dir="in">
1397	<desc>ID of the machine this event relates to.</desc>
1398	</param>
1399	<param name="state" type="SessionState" dir="in">
1400	<desc>New session state.</desc>
1401	</param>
1402	</method>
1403
1404	<method name="onSnapshotTaken">
1405	<desc>
1406	A new snapshot of the machine has been taken.
1407	<see>ISnapshot</see>
1408	<result name="VBOX_E_DONT_CALL_AGAIN">
1409	Do not call again, this method is a NOP.
1410	</result>
1411	</desc>
1412	<param name="machineId" type="uuid" mod="string" dir="in">
1413	<desc>ID of the machine this event relates to.</desc>
1414	</param>
1415	<param name="snapshotId" type="uuid" mod="string" dir="in">
1416	<desc>ID of the new snapshot.</desc>
1417	</param>
1418	</method>
1419
1420	<method name="onSnapshotDeleted">
1421	<desc>
1422	Snapshot of the given machine has been deleted.
1423
1424	<note>
1425	This notification is delivered <b>after</b> the snapshot
1426	object has been uninitialized on the server (so that any
1427	attempt to call its methods will return an error).
1428	</note>
1429
1430	<see>ISnapshot</see>
1431
1432	<result name="VBOX_E_DONT_CALL_AGAIN">
1433	Do not call again, this method is a NOP.
1434	</result>
1435	</desc>
1436	<param name="machineId" type="uuid" mod="string" dir="in">
1437	<desc>ID of the machine this event relates to.</desc>
1438	</param>
1439	<param name="snapshotId" type="uuid" mod="string" dir="in">
1440	<desc>
1441	ID of the deleted snapshot. @c null means the current machine
1442	state has been deleted (restored from the current snapshot).
1443	</desc>
1444	</param>
1445	</method>
1446
1447	<method name="onSnapshotChange">
1448	<desc>
1449	Snapshot properties (name and/or description) have been changed.
1450	<see>ISnapshot</see>
1451	<result name="VBOX_E_DONT_CALL_AGAIN">
1452	Do not call again, this method is a NOP.
1453	</result>
1454	</desc>
1455	<param name="machineId" type="uuid" mod="string" dir="in">
1456	<desc>ID of the machine this event relates to.</desc>
1457	</param>
1458	<param name="snapshotId" type="uuid" mod="string" dir="in">
1459	<desc>ID of the changed snapshot.</desc>
1460	</param>
1461	</method>
1462
1463	<method name="onGuestPropertyChange">
1464	<desc>
1465	Notification when a guest property has changed.
1466	<result name="VBOX_E_DONT_CALL_AGAIN">
1467	Do not call again, this method is a NOP.
1468	</result>
1469	</desc>
1470	<param name="machineId" type="uuid" mod="string" dir="in">
1471	<desc>
1472	ID of the machine this event relates to.
1473	</desc>
1474	</param>
1475	<param name="name" type="wstring" dir="in">
1476	<desc>
1477	The name of the property that has changed.
1478	</desc>
1479	</param>
1480	<param name="value" type="wstring" dir="in">
1481	<desc>
1482	The new property value.
1483	</desc>
1484	</param>
1485	<param name="flags" type="wstring" dir="in">
1486	<desc>
1487	The new property flags.
1488	</desc>
1489	</param>
1490	</method>
1491
1492	</interface>
1493
1494	<interface
1495	name="IDHCPServer" extends="$unknown"
1496	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1497	wsmap="managed"
1498	>
1499	<desc>
1500	The IDHCPServer interface represents the vbox dhcp server configuration.
1501
1502	To enumerate all the dhcp servers on the host, use the
1503	<link to="IVirtualBox::DHCPServers"/> attribute.
1504	</desc>
1505
1506	<attribute name="enabled" type="boolean">
1507	<desc>
1508	specifies if the dhcp server is enabled
1509	</desc>
1510	</attribute>
1511
1512	<attribute name="IPAddress" type="wstring" readonly="yes">
1513	<desc>
1514	specifies server IP
1515	</desc>
1516	</attribute>
1517
1518	<attribute name="networkMask" type="wstring" readonly="yes">
1519	<desc>
1520	specifies server network mask
1521	</desc>
1522	</attribute>
1523
1524	<attribute name="networkName" type="wstring" readonly="yes">
1525	<desc>
1526	specifies internal network name the server is used for
1527	</desc>
1528	</attribute>
1529
1530	<attribute name="lowerIP" type="wstring" readonly="yes">
1531	<desc>
1532	specifies from IP adrres in server address range
1533	</desc>
1534	</attribute>
1535
1536	<attribute name="upperIP" type="wstring" readonly="yes">
1537	<desc>
1538	specifies to IP adrres in server address range
1539	</desc>
1540	</attribute>
1541
1542	<method name="setConfiguration">
1543	<desc>
1544	configures the server
1545	<result name="E_INVALIDARG">
1546	invalid configuration supplied
1547	</result>
1548	</desc>
1549	<param name="IPAddress" type="wstring" dir="in">
1550	<desc>
1551	server IP address
1552	</desc>
1553	</param>
1554	<param name="networkMask" type="wstring" dir="in">
1555	<desc>
1556	server network mask
1557	</desc>
1558	</param>
1559	<param name="FromIPAddress" type="wstring" dir="in">
1560	<desc>
1561	server From IP address for address range
1562	</desc>
1563	</param>
1564	<param name="ToIPAddress" type="wstring" dir="in">
1565	<desc>
1566	server To IP address for address range
1567	</desc>
1568	</param>
1569	</method>
1570
1571	<method name="start">
1572	<desc>
1573	Starts DHCP server process.
1574	<result name="E_FAIL">
1575	Failed to start the process.
1576	</result>
1577	</desc>
1578	<param name="networkName" type="wstring" dir="in">
1579	<desc>
1580	Name of internal network DHCP server should attach to.
1581	</desc>
1582	</param>
1583	<param name="trunkName" type="wstring" dir="in">
1584	<desc>
1585	Name of internal network trunk.
1586	</desc>
1587	</param>
1588	<param name="trunkType" type="wstring" dir="in">
1589	<desc>
1590	Type of internal network trunk.
1591	</desc>
1592	</param>
1593	</method>
1594
1595	<method name="stop">
1596	<desc>
1597	Stops DHCP server process.
1598	<result name="E_FAIL">
1599	Failed to stop the process.
1600	</result>
1601	</desc>
1602	</method>
1603	</interface>
1604
1605	<interface
1606	name="IVirtualBox" extends="$unknown"
1607	uuid="3f36e024-7fed-4f20-a02c-9158a82b44e6"
1608	wsmap="managed"
1609	>
1610	<desc>
1611	The IVirtualBox interface represents the main interface exposed by the
1612	product that provides virtual machine management.
1613
1614	An instance of IVirtualBox is required for the product to do anything
1615	useful. Even though the interface does not expose this, internally,
1616	IVirtualBox is implemented as a singleton and actually lives in the
1617	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1618	IVirtualBox can track the state of all virtual machines on a particular
1619	host, regardless of which frontend started them.
1620
1621	To enumerate all the virtual machines on the host, use the
1622	<link to="IVirtualBox::machines"/> attribute.
1623	</desc>
1624
1625	<attribute name="version" type="wstring" readonly="yes">
1626	<desc>
1627	A string representing the version number of the product. The
1628	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1629	last number represents the build number and will frequently change.
1630	</desc>
1631	</attribute>
1632
1633	<attribute name="revision" type="unsigned long" readonly="yes">
1634	<desc>
1635	The internal build revision number of the product.
1636	</desc>
1637	</attribute>
1638
1639	<attribute name="packageType" type="wstring" readonly="yes">
1640	<desc>
1641	A string representing the package type of this product. The
1642	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1643	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1644	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1645	this.
1646	</desc>
1647	</attribute>
1648
1649	<attribute name="homeFolder" type="wstring" readonly="yes">
1650	<desc>
1651	Full path to the directory where the global settings file,
1652	<tt>VirtualBox.xml</tt>, is stored.
1653
1654	In this version of VirtualBox, the value of this property is
1655	always <tt><user_dir>/.VirtualBox</tt> (where
1656	<tt><user_dir></tt> is the path to the user directory,
1657	as determined by the host OS), and cannot be changed.
1658
1659	This path is also used as the base to resolve relative paths in
1660	places where relative paths are allowed (unless otherwise
1661	expressly indicated).
1662	</desc>
1663	</attribute>
1664
1665	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1666	<desc>
1667	Full name of the global settings file.
1668	The value of this property corresponds to the value of
1669	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1670	</desc>
1671	</attribute>
1672
1673	<attribute name="host" type="IHost" readonly="yes">
1674	<desc>Associated host object.</desc>
1675	</attribute>
1676
1677	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1678	<desc>Associated system information object.</desc>
1679	</attribute>
1680
1681	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1682	<desc>
1683	Array of machine objects registered within this VirtualBox instance.
1684	</desc>
1685	</attribute>
1686
1687	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1688	<desc>
1689	Array of medium objects known to this VirtualBox installation.
1690
1691	This array contains only base media. All differencing
1692	media of the given base medium can be enumerated using
1693	<link to="IMedium::children"/>.
1694	</desc>
1695	</attribute>
1696
1697	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1698	<desc>
1699	Array of CD/DVD image objects registered with this VirtualBox instance.
1700	</desc>
1701	</attribute>
1702
1703	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1704	<desc>
1705	Array of floppy image objects registered with this VirtualBox instance.
1706	</desc>
1707	</attribute>
1708
1709	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1710
1711	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1712
1713	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1714	<desc>
1715	Collection of global shared folders. Global shared folders are
1716	available to all virtual machines.
1717
1718	New shared folders are added to the collection using
1719	<link to="#createSharedFolder"/>. Existing shared folders can be
1720	removed using <link to="#removeSharedFolder"/>.
1721
1722	<note>
1723	In the current version of the product, global shared folders are not
1724	implemented and therefore this collection is always empty.
1725	</note>
1726	</desc>
1727	</attribute>
1728
1729	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1730	<desc>
1731	Associated performance collector object.
1732	</desc>
1733	</attribute>
1734
1735	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1736	<desc>
1737	dhcp server settings.
1738	</desc>
1739	</attribute>
1740
1741	<method name="createMachine">
1742	<desc>
1743	Creates a new virtual machine.
1744
1745	The new machine is created unregistered, with the initial configuration
1746	set according to the specified guest OS type. A typical sequence of
1747	actions to create a new virtual machine is as follows:
1748
1749	<ol>
1750	<li>
1751	Call this method to have a new machine created. The returned machine
1752	object will be "mutable" allowing to change any machine property.
1753	</li>
1754
1755	<li>
1756	Configure the machine using the appropriate attributes and methods.
1757	</li>
1758
1759	<li>
1760	Call <link to="IMachine::saveSettings" /> to write the settings
1761	to the machine's XML settings file. The configuration of the newly
1762	created machine will not be saved to disk until this method is
1763	called.
1764	</li>
1765
1766	<li>
1767	Call <link to="#registerMachine" /> to add the machine to the list
1768	of machines known to VirtualBox.
1769	</li>
1770	</ol>
1771
1772	You should specify valid name for the newly created machine when calling
1773	this method. See the <link to="IMachine::name"/> attribute description
1774	for more details about the machine name.
1775
1776	The specified guest OS type identifier must match an ID of one of known
1777	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1778	array.
1779
1780	Every machine has a <i>settings file</i> that is used to store
1781	the machine configuration. This file is stored in a directory called the
1782	<i>machine settings subfolder</i>. Both the settings subfolder and file
1783	will have a name that corresponds to the name of the virtual machine.
1784	You can specify where to create the machine setting subfolder using the
1785	@a baseFolder argument. The base folder can be absolute (full path) or
1786	relative to the <link to="IVirtualBox::homeFolder">VirtualBox home
1787	directory</link>.
1788
1789	If @a baseFolder is a @c null or empty string (which is recommended), the
1790	<link to="ISystemProperties::defaultMachineFolder">default machine
1791	settings folder</link> will be used as a base folder for the created
1792	machine. Otherwise the given base folder will be used. In either case,
1793	the full path to the resulting settings file has the following
1794	structure:
1795	<pre>
1796	<base_folder>/<machine_name>/<machine_name>.xml
1797	</pre>
1798
1799	Note that if the resulting settings file already exists, this method
1800	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1801
1802	Optionally, you may specify an UUID of to assign to the created machine.
1803	However, this is not recommended and you should normally pass an empty
1804	(@c null) UUID to this method so that a new UUID will be automatically
1805	generated for every created machine. You can use UUID
1806	00000000-0000-0000-0000-000000000000 as @c null value.
1807
1808	<note>
1809	There is no way to change the name of the settings file or
1810	subfolder of the created machine directly.
1811	</note>
1812
1813	<result name="VBOX_E_OBJECT_NOT_FOUND">
1814	@a osTypeId is invalid.
1815	</result>
1816	<result name="VBOX_E_FILE_ERROR">
1817	Resulting settings file name is invalid or the settings file already
1818	exists or could not be created due to an I/O error.
1819	</result>
1820	<result name="E_INVALIDARG">
1821	@a name is empty or @c null.
1822	</result>
1823	</desc>
1824
1825	<param name="name" type="wstring" dir="in">
1826	<desc>Machine name.</desc>
1827	</param>
1828	<param name="osTypeId" type="wstring" dir="in">
1829	<desc>Guest OS Type ID.</desc>
1830	</param>
1831	<param name="baseFolder" type="wstring" dir="in">
1832	<desc>Base machine folder (optional).</desc>
1833	</param>
1834	<param name="id" type="uuid" mod="string" dir="in">
1835	<desc>Machine UUID (optional).</desc>
1836	</param>
1837	<param name="override" type="boolean" dir="in">
1838	<desc>Create the VM even if there are conflicting files.</desc>
1839	</param>
1840	<param name="machine" type="IMachine" dir="return">
1841	<desc>Created machine object.</desc>
1842	</param>
1843	</method>
1844
1845	<method name="createLegacyMachine">
1846	<desc>
1847	Creates a new virtual machine in "legacy" mode, using the specified
1848	settings file to store machine settings.
1849
1850	As opposed to machines created by <link to="#createMachine"/>,
1851	the settings file of the machine created in "legacy" mode is not
1852	automatically renamed when the machine name is changed -- it will always
1853	remain the same as specified in this method call.
1854
1855	The specified settings file name can be absolute (full path) or relative
1856	to the <link to="IVirtualBox::homeFolder">VirtualBox home
1857	directory</link>. If the file name doesn't contain an extension, the
1858	default extension (.xml) will be appended.
1859
1860	Note that the configuration of the newly created machine is not
1861	saved to disk (and therefore no settings file is created)
1862	until <link to="IMachine::saveSettings"/> is called. If the
1863	specified settings file already exists, this method
1864	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1865
1866	See <link to="#createMachine"/> for more information.
1867
1868	@deprecated This method may be removed later. Use <link
1869	to="IVirtualBox::createMachine"/> instead.
1870
1871	<note>
1872	There is no way to change the name of the settings file
1873	of the machine created in "legacy" mode.
1874	</note>
1875
1876	<result name="VBOX_E_OBJECT_NOT_FOUND">
1877	@a osTypeId is invalid.
1878	</result>
1879	<result name="VBOX_E_FILE_ERROR">
1880	@a settingsFile is invalid or the settings file already exists or
1881	could not be created due to an I/O error.
1882	</result>
1883	<result name="E_INVALIDARG">
1884	@a name or @a settingsFile is empty or @c null.
1885	</result>
1886	</desc>
1887
1888	<param name="name" type="wstring" dir="in">
1889	<desc>Machine name.</desc>
1890	</param>
1891	<param name="osTypeId" type="wstring" dir="in">
1892	<desc>Machine OS Type ID.</desc>
1893	</param>
1894	<param name="settingsFile" type="wstring" dir="in">
1895	<desc>Name of the machine settings file.</desc>
1896	</param>
1897	<param name="id" type="uuid" mod="string" dir="in">
1898	<desc>Machine UUID (optional).</desc>
1899	</param>
1900	<param name="machine" type="IMachine" dir="return">
1901	<desc>Created machine object.</desc>
1902	</param>
1903	</method>
1904
1905	<method name="openMachine">
1906	<desc>
1907	Opens a virtual machine from the existing settings file.
1908	The opened machine remains unregistered until you call
1909	<link to="#registerMachine"/>.
1910
1911	The specified settings file name can be absolute
1912	(full path) or relative to the <link to="IVirtualBox::homeFolder">
1913	VirtualBox home directory</link>. This file must exist
1914	and must be a valid machine settings file whose contents
1915	will be used to construct the machine object.
1916
1917	@deprecated Will be removed soon.
1918	<result name="VBOX_E_FILE_ERROR">
1919	Settings file name invalid, not found or sharing violation.
1920	</result>
1921	</desc>
1922	<param name="settingsFile" type="wstring" dir="in">
1923	<desc>
1924	Name of the machine settings file.
1925	</desc>
1926	</param>
1927	<param name="machine" type="IMachine" dir="return">
1928	<desc>Opened machine object.</desc>
1929	</param>
1930	<note>
1931	<link to="IMachine::settingsModified"/> will return
1932	@c false for the created machine, until any of machine settings
1933	are changed.
1934	</note>
1935	</method>
1936
1937	<method name="registerMachine">
1938	<desc>
1939
1940	Registers the machine previously created using
1941	<link to="#createMachine"/> or opened using
1942	<link to="#openMachine"/> within this VirtualBox installation. After
1943	successful method invocation, the
1944	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1945	to all registered callbacks.
1946
1947	<note>
1948	This method implicitly calls <link to="IMachine::saveSettings"/>
1949	to save all current machine settings before registering it.
1950	</note>
1951
1952	<result name="VBOX_E_OBJECT_NOT_FOUND">
1953	No matching virtual machine found.
1954	</result>
1955	<result name="VBOX_E_INVALID_OBJECT_STATE">
1956	Virtual machine was not created within this VirtualBox instance.
1957	</result>
1958
1959	</desc>
1960	<param name="machine" type="IMachine" dir="in"/>
1961	</method>
1962
1963	<method name="getMachine">
1964	<desc>
1965	Attempts to find a virtual machine given its UUID.
1966	To look up a machine by name, use <link to="IVirtualBox::findMachine" />
1967	instead.
1968
1969	<result name="VBOX_E_OBJECT_NOT_FOUND">
1970	Could not find registered machine matching @a id.
1971	</result>
1972
1973	</desc>
1974	<param name="id" type="uuid" mod="string" dir="in"/>
1975	<param name="machine" type="IMachine" dir="return"/>
1976	</method>
1977
1978	<method name="findMachine">
1979	<desc>
1980	Attempts to find a virtual machine given its name.
1981	To look up a machine by UUID, use <link to="IVirtualBox::getMachine" />
1982	instead.
1983
1984	<result name="VBOX_E_OBJECT_NOT_FOUND">
1985	Could not find registered machine matching @a name.
1986	</result>
1987
1988	</desc>
1989	<param name="name" type="wstring" dir="in"/>
1990	<param name="machine" type="IMachine" dir="return"/>
1991	</method>
1992
1993	<method name="unregisterMachine">
1994	<desc>
1995
1996	Unregisters the machine previously registered using
1997	<link to="#registerMachine"/>. After successful method invocation, the
1998	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1999	to all registered callbacks.
2000
2001	<note>
2002	The specified machine must not be in the Saved state, have an open
2003	(or a spawning) direct session associated with it, have snapshots or
2004	have any medium attached.
2005	</note>
2006
2007	<note>
2008	This method implicitly calls <link to="IMachine::saveSettings"/> to
2009	save all current machine settings before unregistering it.
2010	</note>
2011
2012	<note>
2013	If the given machine is inaccessible (see
2014	<link to="IMachine::accessible"/>), it will be unregistered and
2015	fully uninitialized right afterwards. As a result, the returned
2016	machine object will be unusable and an attempt to call
2017	<b>any</b> method will return the "Object not ready" error.
2018	</note>
2019
2020	<result name="VBOX_E_OBJECT_NOT_FOUND">
2021	Could not find registered machine matching @a id.
2022	</result>
2023	<result name="VBOX_E_INVALID_VM_STATE">
2024	Machine is in Saved state.
2025	</result>
2026	<result name="VBOX_E_INVALID_OBJECT_STATE">
2027	Machine has snapshot or open session or medium attached.
2028	</result>
2029
2030	</desc>
2031	<param name="id" type="uuid" mod="string" dir="in">
2032	<desc>UUID of the machine to unregister.</desc>
2033	</param>
2034	<param name="machine" type="IMachine" dir="return">
2035	<desc>Unregistered machine object.</desc>
2036	</param>
2037	</method>
2038
2039	<method name="createAppliance">
2040	<desc>
2041	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
2042	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
2043	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
2044	</desc>
2045	<param name="appliance" type="IAppliance" dir="return">
2046	<desc>New appliance.</desc>
2047	</param>
2048	</method>
2049
2050	<method name="createHardDisk">
2051	<desc>
2052	Creates a new base medium object that will use the given storage
2053	format and location for medium data.
2054
2055	Note that the actual storage unit is not created by this method. In
2056	order to do it, and before you are able to attach the created medium
2057	to virtual machines, you must call one of the following methods to
2058	allocate a format-specific storage unit at the specified location:
2059	<ul>
2060	<li><link to="IMedium::createBaseStorage"/></li>
2061	<li><link to="IMedium::createDiffStorage"/></li>
2062	</ul>
2063
2064	Some medium attributes, such as <link to="IMedium::id"/>, may
2065	remain uninitialized until the medium storage unit is successfully
2066	created by one of the above methods.
2067
2068	After the storage unit is successfully created, the medium gets
2069	remembered by this VirtualBox installation and will be accessible
2070	through <link to="#getHardDisk"/> and <link to="#findHardDisk"/>
2071	methods. Remembered base medium are also returned as part of
2072	the <link to="#hardDisks"/> array. See IMedium for more details.
2073
2074	The list of all storage formats supported by this VirtualBox
2075	installation can be obtained using
2076	<link to="ISystemProperties::mediumFormats"/>. If the @a format
2077	attribute is empty or @c null then the default storage format
2078	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
2079	be used for creating a storage unit of the medium.
2080
2081	Note that the format of the location string is storage format specific.
2082	See <link to="IMedium::location"/>, IMedium and
2083	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
2084
2085	<result name="VBOX_E_OBJECT_NOT_FOUND">
2086	@a format identifier is invalid. See
2087	<link to="ISystemProperties::mediumFormats"/>.
2088	</result>
2089	<result name="VBOX_E_FILE_ERROR">
2090	@a location is a not valid file name (for file-based formats only).
2091	</result>
2092	</desc>
2093	<param name="format" type="wstring" dir="in">
2094	<desc>
2095	Identifier of the storage format to use for the new medium.
2096	</desc>
2097	</param>
2098	<param name="location" type="wstring" dir="in">
2099	<desc>
2100	Location of the storage unit for the new medium.
2101	</desc>
2102	</param>
2103	<param name="medium" type="IMedium" dir="return">
2104	<desc>Created medium object.</desc>
2105	</param>
2106	</method>
2107
2108	<method name="openHardDisk">
2109	<desc>
2110	Opens a medium from an existing location, optionally replacing
2111	the image UUID and/or parent UUID.
2112
2113	After the medium is successfully opened by this method, it gets
2114	remembered by (known to) this VirtualBox installation and will be
2115	accessible through <link to="#getHardDisk"/> and
2116	<link to="#findHardDisk"/> methods. Remembered base media
2117	are also returned as part of the <link to="#hardDisks"/> array and can
2118	be attached to virtual machines. See IMedium for more details.
2119
2120	If a differencing medium is to be opened by this method, the
2121	operation will succeed only if its parent medium and all ancestors,
2122	if any, are already known to this VirtualBox installation (for example,
2123	were opened by this method before).
2124
2125	This method tries to guess the storage format of the specified medium
2126	by reading medium data at the specified location.
2127
2128	If @a accessMode is ReadWrite (which it should be), the image is opened
2129	for read/write access and must have according permissions, as VirtualBox
2130	may actually write status information into the disk's metadata sections.
2131
2132	Note that write access is required for all typical image usage in VirtualBox,
2133	since VirtualBox may need to write metadata such as a UUID into the image.
2134	The only exception is opening a source image temporarily for copying and
2135	cloning when the image will quickly be closed again.
2136
2137	Note that the format of the location string is storage format specific.
2138	See <link to="IMedium::location"/>, IMedium and
2139	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
2140
2141	<result name="VBOX_E_FILE_ERROR">
2142	Invalid medium storage file location or could not find the medium
2143	at the specified location.
2144	</result>
2145	<result name="VBOX_E_IPRT_ERROR">
2146	Could not get medium storage format.
2147	</result>
2148	<result name="E_INVALIDARG">
2149	Invalid medium storage format.
2150	</result>
2151
2152	</desc>
2153	<param name="location" type="wstring" dir="in">
2154	<desc>
2155	Location of the storage unit that contains medium data in one of
2156	the supported storage formats.
2157	</desc>
2158	</param>
2159	<param name="accessMode" type="AccessMode" dir="in">
2160	<desc>
2161	Determines whether to open the image in read/write or read-only mode.
2162	</desc>
2163	</param>
2164	<param name="setImageId" type="boolean" dir="in">
2165	<desc>
2166	Select whether a new image UUID is set or not.
2167	</desc>
2168	</param>
2169	<param name="imageId" type="uuid" mod="string" dir="in">
2170	<desc>
2171	New UUID for the image. If an empty string is passed, then a new
2172	UUID is automatically created. Specifying a zero UUIDs is not valid.
2173	</desc>
2174	</param>
2175	<param name="setParentId" type="boolean" dir="in">
2176	<desc>
2177	Select whether a new parent UUID is set or not.
2178	</desc>
2179	</param>
2180	<param name="parentId" type="uuid" mod="string" dir="in">
2181	<desc>
2182	New parent UUID for the image. If an empty string is passed, then a
2183	new UUID is automatically created, provided @a setParentId is
2184	@c true. A zero UUID is valid.
2185	</desc>
2186	</param>
2187	<param name="medium" type="IMedium" dir="return">
2188	<desc>Opened medium object.</desc>
2189	</param>
2190	</method>
2191
2192	<method name="getHardDisk" const="yes">
2193	<desc>
2194	Returns a medium with the given UUID.
2195
2196	The medium with the given UUID must be known to this VirtualBox
2197	installation, i.e. it must be previously created by
2198	<link to="#createHardDisk"/> or opened by <link
2199	to="#openHardDisk"/>, or attached to some known virtual machine.
2200
2201	<result name="VBOX_E_OBJECT_NOT_FOUND">
2202	No medium object matching @a id found.
2203	</result>
2204
2205	</desc>
2206	<param name="id" type="uuid" mod="string" dir="in">
2207	<desc>UUID of the medium to look for.</desc>
2208	</param>
2209	<param name="medium" type="IMedium" dir="return">
2210	<desc>Found medium object.</desc>
2211	</param>
2212	</method>
2213
2214	<method name="findHardDisk">
2215	<desc>
2216	Returns a medium that uses the given location to store medium data.
2217
2218	The given medium must be known to this VirtualBox installation, i.e.
2219	it must be previously created by
2220	<link to="#createHardDisk"/> or opened by <link
2221	to="#openHardDisk"/>, or attached to some known virtual machine.
2222
2223	The search is done by comparing the value of the @a location argument to
2224	the <link to="IMedium::location"/> attribute of each known medium.
2225
2226	For locations represented by file names in the host's file system, the
2227	requested location can be a path relative to the
2228	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2229	only a file name without any path is given, the
2230	<link to="ISystemProperties::defaultHardDiskFolder"> default medium
2231	folder</link> will be prepended to the file name before searching. Note
2232	that on case sensitive file systems, a case sensitive comparison is
2233	performed, otherwise the case of symbols in the file path is ignored.
2234
2235	<result name="VBOX_E_OBJECT_NOT_FOUND">
2236	No medium object matching @a location found.
2237	</result>
2238
2239	</desc>
2240	<param name="location" type="wstring" dir="in">
2241	<desc>Location string to search for.</desc>
2242	</param>
2243	<param name="medium" type="IMedium" dir="return">
2244	<desc>Found medium object.</desc>
2245	</param>
2246	</method>
2247
2248	<method name="openDVDImage">
2249	<desc>
2250	Opens a CD/DVD image contained in the specified file of the supported
2251	format and assigns it the given UUID.
2252
2253	After the image is successfully opened by this method, it gets
2254	remembered by (known to) this VirtualBox installation and will be
2255	accessible through <link to="#getDVDImage"/> and
2256	<link to="#findDVDImage"/> methods. Remembered images are also
2257	returned as part of the <link to="#DVDImages"/> array and can be mounted
2258	to virtual machines. See IMedium for more details.
2259
2260	See <link to="IMedium::location"/> to get more details about the format
2261	of the location string.
2262
2263	<note>
2264	Currently only ISO 9960 CD/DVD images are supported by VirtualBox.
2265	</note>
2266
2267	<result name="VBOX_E_FILE_ERROR">
2268	Invalid CD/DVD image file location or could not find the CD/DVD
2269	image at the specified location.
2270	</result>
2271	<result name="VBOX_E_INVALID_OBJECT_STATE">
2272	CD/DVD image already exists in the media registry.
2273	</result>
2274
2275	</desc>
2276	<param name="location" type="wstring" dir="in">
2277	<desc>
2278	Full path to the file that contains a valid CD/DVD image.
2279	</desc>
2280	</param>
2281	<param name="id" type="uuid" mod="string" dir="in">
2282	<desc>
2283	UUID to assign to the given image within this VirtualBox installation.
2284	If an empty (@c null) UUID is specified, the system will randomly
2285	generate a new UUID.
2286	</desc>
2287	</param>
2288	<param name="image" type="IMedium" dir="return">
2289	<desc>Opened CD/DVD image object.</desc>
2290	</param>
2291	</method>
2292
2293	<method name="getDVDImage">
2294	<desc>
2295	Returns a CD/DVD image with the given UUID.
2296
2297	The image with the given UUID must be known to this VirtualBox
2298	installation, i.e. it must be previously opened by <link
2299	to="#openDVDImage"/>, or mounted to some known virtual machine.
2300
2301	<result name="VBOX_E_OBJECT_NOT_FOUND">
2302	No matching DVD image found in the media registry.
2303	</result>
2304
2305	</desc>
2306	<param name="id" type="uuid" mod="string" dir="in">
2307	<desc>UUID of the image to look for.</desc>
2308	</param>
2309	<param name="image" type="IMedium" dir="return">
2310	<desc>Found CD/DVD image object.</desc>
2311	</param>
2312	</method>
2313
2314	<method name="findDVDImage">
2315	<desc>
2316	Returns a CD/DVD image with the given image location.
2317
2318	The image with the given UUID must be known to this VirtualBox
2319	installation, i.e. it must be previously opened by <link
2320	to="#openDVDImage"/>, or mounted to some known virtual machine.
2321
2322	The search is done by comparing the value of the @a location argument to
2323	the <link to="IMedium::location"/> attribute of each known CD/DVD image.
2324
2325	The requested location can be a path relative to the
2326	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2327	only a file name without any path is given, the
2328	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2329	folder</link> will be prepended to the file name before searching. Note
2330	that on case sensitive file systems, a case sensitive comparison is
2331	performed, otherwise the case in the file path is ignored.
2332
2333	<result name="VBOX_E_FILE_ERROR">
2334	Invalid image file location.
2335	</result>
2336	<result name="VBOX_E_OBJECT_NOT_FOUND">
2337	No matching DVD image found in the media registry.
2338	</result>
2339
2340	</desc>
2341	<param name="location" type="wstring" dir="in">
2342	<desc>CD/DVD image file path to look for.</desc>
2343	</param>
2344	<param name="image" type="IMedium" dir="return">
2345	<desc>Found CD/DVD image object.</desc>
2346	</param>
2347	</method>
2348
2349	<method name="openFloppyImage">
2350	<desc>
2351	Opens a floppy image contained in the specified file of the supported
2352	format and assigns it the given UUID.
2353
2354	After the image is successfully opened by this method, it gets
2355	remembered by (known to) this VirtualBox installation and will be
2356	accessible through <link to="#getFloppyImage"/> and
2357	<link to="#findFloppyImage"/> methods. Remembered images are also
2358	returned as part of the <link to="#floppyImages"/> array and can be
2359	mounted to virtual machines. See IMedium for more details.
2360
2361	See <link to="IMedium::location"/> to get more details about the format
2362	of the location string.
2363
2364	<result name="VBOX_E_FILE_ERROR">
2365	Invalid floppy image file location or could not find the floppy
2366	image at the specified location.
2367	</result>
2368	<result name="VBOX_E_INVALID_OBJECT_STATE">
2369	Floppy image already exists in the media registry.
2370	</result>
2371
2372	<note>
2373	Currently, only raw floppy images are supported by VirtualBox.
2374	</note>
2375	</desc>
2376	<param name="location" type="wstring" dir="in">
2377	<desc>
2378	Full path to the file that contains a valid floppy image.
2379	</desc>
2380	</param>
2381	<param name="id" type="uuid" mod="string" dir="in">
2382	<desc>
2383	UUID to assign to the given image file within this VirtualBox
2384	installation. If an empty (@c null) UUID is specified, the system will
2385	randomly generate a new UUID.
2386	</desc>
2387	</param>
2388	<param name="image" type="IMedium" dir="return">
2389	<desc>Opened floppy image object.</desc>
2390	</param>
2391	</method>
2392
2393	<method name="getFloppyImage">
2394	<desc>
2395	Returns a floppy image with the given UUID.
2396
2397	The image with the given UUID must be known to this VirtualBox
2398	installation, i.e. it must be previously opened by <link
2399	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2400
2401	<result name="VBOX_E_OBJECT_NOT_FOUND">
2402	No matching floppy image found in the media registry.
2403	</result>
2404
2405	</desc>
2406	<param name="id" type="uuid" mod="string" dir="in">
2407	<desc>UUID of the image to look for.</desc>
2408	</param>
2409	<param name="image" type="IMedium" dir="return">
2410	<desc>Found floppy image object.</desc>
2411	</param>
2412	</method>
2413
2414	<method name="findFloppyImage">
2415	<desc>
2416	Returns a floppy image with the given image location.
2417
2418	The image with the given UUID must be known to this VirtualBox
2419	installation, i.e. it must be previously opened by <link
2420	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2421
2422	The search is done by comparing the value of the @a location argument to
2423	the <link to="IMedium::location"/> attribute of each known floppy image.
2424
2425	The requested location can be a path relative to the
2426	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2427	only a file name without any path is given, the
2428	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2429	folder</link> will be prepended to the file name before searching. Note
2430	that on case sensitive file systems, a case sensitive comparison is
2431	performed, otherwise the case of symbols in the file path is ignored.
2432
2433	<result name="VBOX_E_FILE_ERROR">
2434	Invalid image file location.
2435	</result>
2436	<result name="VBOX_E_OBJECT_NOT_FOUND">
2437	No matching floppy image found in the media registry.
2438	</result>
2439
2440	</desc>
2441	<param name="location" type="wstring" dir="in">
2442	<desc>Floppy image file path to look for.</desc>
2443	</param>
2444	<param name="image" type="IMedium" dir="return">
2445	<desc>Found floppy image object.</desc>
2446	</param>
2447	</method>
2448
2449	<method name="getGuestOSType">
2450	<desc>
2451	Returns an object describing the specified guest OS type.
2452
2453	The requested guest OS type is specified using a string which is a
2454	mnemonic identifier of the guest operating system, such as
2455	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2456	particular virtual machine can be read or set using the
2457	<link to="IMachine::OSTypeId"/> attribute.
2458
2459	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2460	available guest OS type objects. Each object has an
2461	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2462	the guest OS this object describes.
2463
2464	<result name="E_INVALIDARG">
2465	@a id is not a valid Guest OS type.
2466	</result>
2467
2468	</desc>
2469	<param name="id" type="uuid" mod="string" dir="in">
2470	<desc>Guest OS type ID string.</desc>
2471	</param>
2472	<param name="type" type="IGuestOSType" dir="return">
2473	<desc>Guest OS type object.</desc>
2474	</param>
2475	</method>
2476
2477	<method name="createSharedFolder">
2478	<desc>
2479	Creates a new global shared folder by associating the given logical
2480	name with the given host path, adds it to the collection of shared
2481	folders and starts sharing it. Refer to the description of
2482	<link to="ISharedFolder"/> to read more about logical names.
2483	<note>
2484	In the current implementation, this operation is not
2485	implemented.
2486	</note>
2487	</desc>
2488	<param name="name" type="wstring" dir="in">
2489	<desc>Unique logical name of the shared folder.</desc>
2490	</param>
2491	<param name="hostPath" type="wstring" dir="in">
2492	<desc>Full path to the shared folder in the host file system.</desc>
2493	</param>
2494	<param name="writable" type="boolean" dir="in">
2495	<desc>Whether the share is writable or readonly</desc>
2496	</param>
2497	</method>
2498
2499	<method name="removeSharedFolder">
2500	<desc>
2501	Removes the global shared folder with the given name previously
2502	created by <link to="#createSharedFolder"/> from the collection of
2503	shared folders and stops sharing it.
2504	<note>
2505	In the current implementation, this operation is not
2506	implemented.
2507	</note>
2508	</desc>
2509	<param name="name" type="wstring" dir="in">
2510	<desc>Logical name of the shared folder to remove.</desc>
2511	</param>
2512	</method>
2513
2514	<method name="getExtraDataKeys">
2515	<desc>
2516	Returns an array representing the global extra data keys which currently
2517	have values defined.
2518	</desc>
2519	<param name="value" type="wstring" dir="return" safearray="yes">
2520	<desc>Array of extra data keys.</desc>
2521	</param>
2522	</method>
2523
2524	<method name="getExtraData">
2525	<desc>
2526	Returns associated global extra data.
2527
2528	If the requested data @a key does not exist, this function will
2529	succeed and return an empty string in the @a value argument.
2530
2531	<result name="VBOX_E_FILE_ERROR">
2532	Settings file not accessible.
2533	</result>
2534	<result name="VBOX_E_XML_ERROR">
2535	Could not parse the settings file.
2536	</result>
2537
2538	</desc>
2539	<param name="key" type="wstring" dir="in">
2540	<desc>Name of the data key to get.</desc>
2541	</param>
2542	<param name="value" type="wstring" dir="return">
2543	<desc>Value of the requested data key.</desc>
2544	</param>
2545	</method>
2546
2547	<method name="setExtraData">
2548	<desc>
2549	Sets associated global extra data.
2550
2551	If you pass @c null or empty string as a key @a value, the given @a key
2552	will be deleted.
2553
2554	<note>
2555	Before performing the actual data change, this method will ask all
2556	registered callbacks using the
2557	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
2558	notification for a permission. If one of the callbacks refuses the
2559	new value, the change will not be performed.
2560	</note>
2561	<note>
2562	On success, the
2563	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
2564	is called to inform all registered callbacks about a successful data
2565	change.
2566	</note>
2567
2568	<result name="VBOX_E_FILE_ERROR">
2569	Settings file not accessible.
2570	</result>
2571	<result name="VBOX_E_XML_ERROR">
2572	Could not parse the settings file.
2573	</result>
2574	<result name="E_ACCESSDENIED">
2575	Modification request refused.
2576	</result>
2577
2578	</desc>
2579	<param name="key" type="wstring" dir="in">
2580	<desc>Name of the data key to set.</desc>
2581	</param>
2582	<param name="value" type="wstring" dir="in">
2583	<desc>Value to assign to the key.</desc>
2584	</param>
2585	</method>
2586
2587	<method name="openSession">
2588	<desc>
2589	Opens a new direct session with the given virtual machine.
2590
2591	A direct session acts as a local lock on the given VM.
2592	There can be only one direct session open at a time for every
2593	virtual machine, protecting the VM from being manipulated by
2594	conflicting actions from different processes. Only after a
2595	direct session has been opened, one can change all VM settings
2596	and execute the VM in the process space of the session object.
2597
2598	Sessions therefore can be compared to mutex semaphores that
2599	lock a given VM for modification and execution.
2600	See <link to="ISession">ISession</link> for details.
2601
2602	<note>Unless you are writing a new VM frontend, you will not
2603	want to execute a VM in the current process. To spawn a new
2604	process that executes a VM, use
2605	<link to="IVirtualBox::openRemoteSession" />
2606	instead.</note>
2607
2608	Upon successful return, the session object can be used to
2609	get access to the machine and to the VM console.
2610
2611	In VirtualBox terminology, the machine becomes "mutable" after
2612	a session has been opened. Note that the "mutable" machine
2613	object, on which you may invoke IMachine methods to change its
2614	settings, will be a different object from the immutable IMachine
2615	objects returned by various IVirtualBox methods. To obtain a
2616	mutable IMachine object (upon which you can invoke settings methods),
2617	use the <link to="ISession::machine" /> attribute.
2618
2619	One must always call <link to="ISession::close" /> to release the
2620	lock on the machine, or the machine's state will eventually be
2621	set to "Aborted".
2622
2623	In other words, to change settings on a machine, the following
2624	sequence is typically performed:
2625
2626	<ol>
2627	<li>Call this method (openSession) to have a machine locked for
2628	the current session.</li>
2629
2630	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
2631
2632	<li>Change the settings of the machine.</li>
2633
2634	<li>Call <link to="IMachine::saveSettings" />.</li>
2635
2636	<li>Close the session by calling <link to="ISession::close"/>.</li>
2637	</ol>
2638
2639	<result name="E_UNEXPECTED">
2640	Virtual machine not registered.
2641	</result>
2642	<result name="E_ACCESSDENIED">
2643	Process not started by OpenRemoteSession.
2644	</result>
2645	<result name="VBOX_E_OBJECT_NOT_FOUND">
2646	No matching virtual machine found.
2647	</result>
2648	<result name="VBOX_E_INVALID_OBJECT_STATE">
2649	Session already open or being opened.
2650	</result>
2651	<result name="VBOX_E_VM_ERROR">
2652	Failed to assign machine to session.
2653	</result>
2654
2655	</desc>
2656	<param name="session" type="ISession" dir="in">
2657	<desc>
2658	Session object that will represent the opened session after
2659	successful method invocation. This object must not represent
2660	the already open session.
2661	<note>
2662	This session will be automatically closed if the
2663	VirtualBox server is terminated for some reason.
2664	</note>
2665	</desc>
2666	</param>
2667	<param name="machineId" type="uuid" mod="string" dir="in">
2668	<desc>ID of the virtual machine to open a session with.</desc>
2669	</param>
2670	</method>
2671
2672	<method name="openRemoteSession">
2673	<desc>
2674	Spawns a new process that executes a virtual machine (called a
2675	"remote session").
2676
2677	Opening a remote session causes the VirtualBox server to start a new
2678	process that opens a direct session with the given VM. As a result, the
2679	VM is locked by that direct session in the new process, preventing
2680	conflicting changes from other processes. Since sessions act as locks
2681	that prevent conflicting changes, one cannot open a remote session
2682	for a VM that already has another open session (direct or remote), or
2683	is currently in the process of opening one (see <link
2684	to="IMachine::sessionState"/>).
2685
2686	While the remote session still provides some level of control over the
2687	VM execution to the caller (using the <link to="IConsole" /> interface),
2688	not all VM settings are available for modification within the remote
2689	session context.
2690
2691	This operation can take some time (a new VM is started in a new process,
2692	for which memory and other resources need to be set up). Because of this,
2693	an <link to="IProgress" /> is returned to allow the caller to wait for this
2694	asynchronous operation to be completed. Until then, the remote session
2695	object remains in the closed state, and accessing the machine or its
2696	console through it is invalid. It is recommended to use
2697	<link to="IProgress::waitForCompletion" /> or similar calls to wait for
2698	completion. Completion is signalled when the VM is powered on. Error
2699	messages etc. can be queried via the progress object, if available.
2700
2701	As with all <link to="ISession" /> objects, it is recommended to call
2702	<link to="ISession::close" /> on the local session object once openRemoteSession()
2703	has been called. However, the session's state (see <link to="ISession::state" />)
2704	will not return to "Closed" until the remote session has also closed (i.e.
2705	until the VM is no longer running). In that case, however, the state of
2706	the session will automatically change back to "Closed".
2707
2708	Currently supported session types (values of the @a type
2709	argument) are:
2710	<ul>
2711	<li><tt>"gui"</tt>: VirtualBox Qt GUI session</li>
2712	<li><tt>"vrdp"</tt>: VirtualBox VRDP Server session</li>
2713	<li><tt>"sdl"</tt>: VirtualBox SDL GUI session</li>
2714	</ul>
2715
2716	The @a environment argument is a string containing definitions of
2717	environment variables in the following format:
2718	@code
2719	NAME[=VALUE]\n
2720	NAME[=VALUE]\n
2721	...
2722	@endcode
2723	where <tt>\\n</tt> is the new line character. These environment
2724	variables will be appended to the environment of the VirtualBox server
2725	process. If an environment variable exists both in the server process
2726	and in this list, the value from this list takes precedence over the
2727	server's variable. If the value of the environment variable is
2728	omitted, this variable will be removed from the resulting environment.
2729	If the environment string is @c null or empty, the server environment
2730	is inherited by the started process as is.
2731
2732	The progress object will have at least 2 operation. The first operation
2733	covers the period up to the new VM process calls powerUp. The
2734	subsequent operations mirrors the <link to="IConsole::powerUp"/>
2735	progress object. Because <link to="IConsole::powerUp"/> may require
2736	some extra operation, the <link to="IProgress::operationCount"/> may
2737	change at the completion of operation1.
2738
2739	For details on the teleportation progress operation, see
2740	<link to="IConsole::powerUp"/>.
2741
2742	<see>openExistingSession</see>
2743
2744	<result name="E_UNEXPECTED">
2745	Virtual machine not registered.
2746	</result>
2747	<result name="E_INVALIDARG">
2748	Invalid session type @a type.
2749	</result>
2750	<result name="VBOX_E_OBJECT_NOT_FOUND">
2751	No machine matching @a machineId found.
2752	</result>
2753	<result name="VBOX_E_INVALID_OBJECT_STATE">
2754	Session already open or being opened.
2755	</result>
2756	<result name="VBOX_E_IPRT_ERROR">
2757	Launching process for machine failed.
2758	</result>
2759	<result name="VBOX_E_VM_ERROR">
2760	Failed to assign machine to session.
2761	</result>
2762
2763	</desc>
2764	<param name="session" type="ISession" dir="in">
2765	<desc>
2766	Session object that will represent the opened remote session
2767	after successful method invocation (this object must not
2768	represent an already open session).
2769	</desc>
2770	</param>
2771	<param name="machineId" type="uuid" mod="string" dir="in">
2772	<desc>ID of the virtual machine to open a session with.</desc>
2773	</param>
2774	<param name="type" type="wstring" dir="in">
2775	<desc>
2776	Type of the remote session (case sensitive).
2777	</desc>
2778	</param>
2779	<param name="environment" type="wstring" dir="in">
2780	<desc>
2781	Environment to pass to the opened session.
2782	</desc>
2783	</param>
2784	<param name="progress" type="IProgress" dir="return">
2785	<desc>Progress object to track the operation completion.</desc>
2786	</param>
2787	</method>
2788
2789	<method name="openExistingSession">
2790	<desc>
2791	Opens a new remote session with the virtual machine for
2792	which a direct session is already open.
2793
2794	The remote session provides some level of control over the VM
2795	execution (using the IConsole interface) to the caller; however,
2796	within the remote session context, not all VM settings are available
2797	for modification.
2798
2799	As opposed to <link to="#openRemoteSession"/>, the number of
2800	remote sessions opened this way is not limited by the API
2801
2802	<note>
2803	It is an error to open a remote session with the machine that
2804	doesn't have an open direct session.
2805	</note>
2806
2807	<result name="E_UNEXPECTED">
2808	Virtual machine not registered.
2809	</result>
2810	<result name="VBOX_E_OBJECT_NOT_FOUND">
2811	No machine matching @a machineId found.
2812	</result>
2813	<result name="VBOX_E_INVALID_OBJECT_STATE">
2814	Session already open or being opened.
2815	</result>
2816	<result name="VBOX_E_INVALID_SESSION_STATE">
2817	Direct session state not Open.
2818	</result>
2819	<result name="VBOX_E_VM_ERROR">
2820	Failed to get console object from direct session or assign
2821	machine to session.
2822	</result>
2823
2824	<see>openRemoteSession</see>
2825	</desc>
2826	<param name="session" type="ISession" dir="in">
2827	<desc>
2828	Session object that will represent the open remote session
2829	after successful method invocation. This object must not
2830	represent an already open session.
2831	<note>
2832	This session will be automatically closed when the peer
2833	(direct) session dies or gets closed.
2834	</note>
2835	</desc>
2836	</param>
2837	<param name="machineId" type="uuid" mod="string" dir="in">
2838	<desc>ID of the virtual machine to open a session with.</desc>
2839	</param>
2840	</method>
2841
2842	<method name="registerCallback">
2843	<desc>
2844	Registers a new global VirtualBox callback. The methods of the given
2845	callback object will be called by VirtualBox when an appropriate
2846	event occurs.
2847
2848	<result name="E_INVALIDARG">
2849	A @c null callback cannot be registered.
2850	</result>
2851
2852	</desc>
2853	<param name="callback" type="IVirtualBoxCallback" dir="in">
2854	<desc>Callback object to register.</desc>
2855	</param>
2856	</method>
2857
2858	<method name="unregisterCallback">
2859	<desc>
2860	Unregisters the previously registered global VirtualBox callback.
2861
2862	<result name="E_INVALIDARG">
2863	Specified @a callback not registered.
2864	</result>
2865
2866	</desc>
2867	<param name="callback" type="IVirtualBoxCallback" dir="in">
2868	<desc>Callback object to unregister.</desc>
2869	</param>
2870	</method>
2871
2872	<method name="waitForPropertyChange">
2873	<desc>
2874	Blocks the caller until any of the properties represented by the
2875	@a what argument changes the value or until the given timeout interval
2876	expires.
2877
2878	The @a what argument is a comma separated list of property masks that
2879	describe properties the caller is interested in. The property mask is
2880	a string in the following format:
2881
2882	<pre>
2883	[[group.]subgroup.]name
2884	</pre>
2885
2886	where @c name is the property name and @c group, @c subgroup are zero
2887	or more property group specifiers. Each element (group or name) in
2888	the property mask may be either a Latin string or an asterisk symbol
2889	(@c "*") which is used to match any string for the given element. A
2890	property mask that doesn't contain asterisk symbols represents a
2891	single fully qualified property name.
2892
2893	Groups in the fully qualified property name go from more generic (the
2894	left-most part) to more specific (the right-most part). The first
2895	element is usually a name of the object the property belongs to. The
2896	second element may be either a property name, or a child object name,
2897	or an index if the preceding element names an object which is one of
2898	many objects of the same type. This way, property names form a
2899	hierarchy of properties. Here are some examples of property names:
2900
2901	<table>
2902	<tr>
2903	<td><tt>VirtualBox.version</tt></td>
2904	<td><link to="IVirtualBox::version"/> property</td>
2905	</tr>
2906	<tr>
2907	<td><tt>Machine.<UUID>.name</tt></td>
2908	<td><link to="IMachine::name"/> property of the machine with the
2909	given UUID</td>
2910	</tr>
2911	</table>
2912
2913	Most property names directly correspond to the properties of objects
2914	(components) provided by the VirtualBox library and may be used to
2915	track changes to these properties. However, there may be
2916	pseudo-property names that don't correspond to any existing object's
2917	property directly, as well as there may be object properties that
2918	don't have a corresponding property name that is understood by this
2919	method, and therefore changes to such properties cannot be
2920	tracked. See individual object's property descriptions to get a
2921	fully qualified property name that can be used with this method (if
2922	any).
2923
2924	There is a special property mask @c "*" (i.e. a string consisting of a
2925	single asterisk symbol) that can be used to match all properties.
2926	Below are more examples of property masks:
2927
2928	<table>
2929	<tr>
2930	<td><tt>VirtualBox.*</tt></td>
2931	<td>Track all properties of the VirtualBox object</td>
2932	</tr>
2933	<tr>
2934	<td><tt>Machine.*.name</tt></td>
2935	<td>Track changes to the <link to="IMachine::name"/> property of
2936	all registered virtual machines</td>
2937	</tr>
2938	</table>
2939
2940	<note>
2941	This function is not implemented in the current version of the
2942	product.
2943	</note>
2944	</desc>
2945	<param name="what" type="wstring" dir="in">
2946	<desc>Comma separated list of property masks.</desc>
2947	</param>
2948	<param name="timeout" type="unsigned long" dir="in">
2949	<desc>
2950	Wait timeout in milliseconds.
2951	Specify -1 for an indefinite wait.
2952	</desc>
2953	</param>
2954	<param name="changed" type="wstring" dir="out">
2955	<desc>
2956	Comma separated list of properties that have been changed and caused
2957	this method to return to the caller.
2958	</desc>
2959	</param>
2960	<param name="values" type="wstring" dir="out">
2961	<desc>Reserved, not currently used.</desc>
2962	</param>
2963	</method>
2964
2965	<!--method name="createDHCPServerForInterface">
2966	<desc>
2967	Creates a dhcp server settings to be used for the given interface
2968	<result name="E_INVALIDARG">
2969	Host network interface @a name already exists.
2970	</result>
2971	</desc>
2972	<param name="interface" type="IHostNetworkInterface" dir="in">
2973	<desc>Network Interface</desc>
2974	</param>
2975	<param name="server" type="IDHCPServer" dir="out">
2976	<desc>Dhcp server settings</desc>
2977	</param>
2978	</method-->
2979
2980	<method name="createDHCPServer">
2981	<desc>
2982	Creates a dhcp server settings to be used for the given internal network name
2983	<result name="E_INVALIDARG">
2984	Host network interface @a name already exists.
2985	</result>
2986	</desc>
2987	<param name="name" type="wstring" dir="in">
2988	<desc>server name</desc>
2989	</param>
2990	<param name="server" type="IDHCPServer" dir="return">
2991	<desc>Dhcp server settings</desc>
2992	</param>
2993	</method>
2994
2995	<method name="findDHCPServerByNetworkName">
2996	<desc>
2997	Searches a dhcp server settings to be used for the given internal network name
2998	<result name="E_INVALIDARG">
2999	Host network interface @a name already exists.
3000	</result>
3001
3002	</desc>
3003	<param name="name" type="wstring" dir="in">
3004	<desc>server name</desc>
3005	</param>
3006	<param name="server" type="IDHCPServer" dir="return">
3007	<desc>Dhcp server settings</desc>
3008	</param>
3009	</method>
3010
3011	<!--method name="findDHCPServerForInterface">
3012	<desc>
3013	Searches a dhcp server settings to be used for the given interface
3014	<result name="E_INVALIDARG">
3015	Host network interface @a name already exists.
3016	</result>
3017	</desc>
3018	<param name="interface" type="IHostNetworkInterface" dir="in">
3019	<desc>Network Interface</desc>
3020	</param>
3021	<param name="server" type="IDHCPServer" dir="out">
3022	<desc>Dhcp server settings</desc>
3023	</param>
3024	</method-->
3025
3026	<method name="removeDHCPServer">
3027	<desc>
3028	Removes the dhcp server settings
3029	<result name="E_INVALIDARG">
3030	Host network interface @a name already exists.
3031	</result>
3032	</desc>
3033	<param name="server" type="IDHCPServer" dir="in">
3034	<desc>Dhcp server settings to be removed</desc>
3035	</param>
3036	</method>
3037
3038
3039	<method name="checkFirmwarePresent">
3040	<desc>
3041	Check if this VirtualBox installation has a firmware
3042	of the given type available, either system-wide or per-user.
3043	Optionally, this may return a hint where this firmware can be
3044	downloaded from.
3045	</desc>
3046	<param name="firmwareType" type="FirmwareType" dir="in">
3047	<desc>
3048	Type of firmware to check.
3049	</desc>
3050	</param>
3051	<param name="version" type="wstring" dir="in">
3052	<desc>Expected version number, usually empty string (presently ignored).</desc>
3053	</param>
3054
3055	<param name="url" type="wstring" dir="out">
3056	<desc>
3057	Suggested URL to download this firmware from.
3058	</desc>
3059	</param>
3060
3061	<param name="file" type="wstring" dir="out">
3062	<desc>
3063	Filename of firmware, only valid if result == TRUE.
3064	</desc>
3065	</param>
3066
3067	<param name="result" type="boolean" dir="return">
3068	<desc>If firmware of this type and version is available.</desc>
3069	</param>
3070	</method>
3071
3072	</interface>
3073
3074	<!--
3075	// IVFSExplorer
3076	/////////////////////////////////////////////////////////////////////////
3077	-->
3078
3079	<enum
3080	name="VFSType"
3081	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
3082	>
3083	<desc>
3084	Virtual file systems supported by VFSExplorer.
3085	</desc>
3086
3087	<const name="File" value="1" />
3088	<const name="Cloud" value="2" />
3089	<const name="S3" value="3" />
3090	<const name="WebDav" value="4" />
3091	</enum>
3092
3093	<enum
3094	name="VFSFileType"
3095	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
3096	>
3097	<desc>
3098	File types known by VFSExplorer.
3099	</desc>
3100
3101	<const name="Unknown" value="1" />
3102	<const name="Fifo" value="2" />
3103	<const name="DevChar" value="3" />
3104	<const name="Directory" value="4" />
3105	<const name="DevBlock" value="5" />
3106	<const name="File" value="6" />
3107	<const name="SymLink" value="7" />
3108	<const name="Socket" value="8" />
3109	<const name="WhiteOut" value="9" />
3110	</enum>
3111
3112	<interface
3113	name="IVFSExplorer" extends="$unknown"
3114	uuid="2bb864a1-02a3-4474-a1d4-fb5f23b742e1"
3115	wsmap="managed"
3116	>
3117	<desc>
3118	The VFSExplorer interface unifies access to different file system
3119	types. This includes local file systems as well remote file systems like
3120	S3. For a list of supported types see <link to="VFSType" />.
3121	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
3122	</desc>
3123
3124	<attribute name="path" type="wstring" readonly="yes">
3125	<desc>Returns the current path in the virtual file system.</desc>
3126	</attribute>
3127
3128	<attribute name="type" type="VFSType" readonly="yes">
3129	<desc>Returns the file system type which is currently in use.</desc>
3130	</attribute>
3131
3132	<method name="update">
3133	<desc>Updates the internal list of files/directories from the
3134	current directory level. Use <link to="#entryList" /> to get the full list
3135	after a call to this method.</desc>
3136
3137	<param name="aProgress" type="IProgress" dir="return">
3138	<desc>Progress object to track the operation completion.</desc>
3139	</param>
3140	</method>
3141
3142	<method name="cd">
3143	<desc>Change the current directory level.</desc>
3144
3145	<param name="aDir" type="wstring" dir="in">
3146	<desc>The name of the directory to go in.</desc>
3147	</param>
3148
3149	<param name="aProgress" type="IProgress" dir="return">
3150	<desc>Progress object to track the operation completion.</desc>
3151	</param>
3152	</method>
3153
3154	<method name="cdUp">
3155	<desc>Go one directory upwards from the current directory level.</desc>
3156
3157	<param name="aProgress" type="IProgress" dir="return">
3158	<desc>Progress object to track the operation completion.</desc>
3159	</param>
3160	</method>
3161
3162	<method name="entryList">
3163	<desc>Returns a list of files/directories after a call to <link
3164	to="#update" />. The user is responsible for keeping this internal
3165	list up do date.</desc>
3166
3167	<param name="aNames" type="wstring" safearray="yes" dir="out">
3168	<desc>The list of names for the entries.</desc>
3169	</param>
3170
3171	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
3172	<desc>The list of types for the entries.</desc>
3173	</param>
3174	</method>
3175
3176	<method name="exists">
3177	<desc>Checks if the given file list exists in the current directory
3178	level.</desc>
3179
3180	<param name="aNames" type="wstring" safearray="yes" dir="in">
3181	<desc>The names to check.</desc>
3182	</param>
3183
3184	<param name="aExists" type="wstring" safearray="yes" dir="return">
3185	<desc>The names which exist.</desc>
3186	</param>
3187	</method>
3188
3189	<method name="remove">
3190	<desc>Deletes the given files in the current directory level.</desc>
3191
3192	<param name="aNames" type="wstring" safearray="yes" dir="in">
3193	<desc>The names to remove.</desc>
3194	</param>
3195
3196	<param name="aProgress" type="IProgress" dir="return">
3197	<desc>Progress object to track the operation completion.</desc>
3198	</param>
3199	</method>
3200
3201	</interface>
3202
3203	<!--
3204	// IAppliance
3205	/////////////////////////////////////////////////////////////////////////
3206	-->
3207
3208	<interface
3209	name="IAppliance" extends="$unknown"
3210	uuid="e3ba9ab9-ac2c-4266-8bd2-91c4bf721ceb"
3211	wsmap="managed"
3212	>
3213	<desc>
3214	Represents a platform-independent appliance in OVF format. An instance of this is returned
3215	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
3216	virtual machines within an appliance with VirtualBox.
3217
3218	The OVF standard suggests two different physical file formats:
3219
3220	<ol>
3221	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
3222	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
3223	this descriptor file references other files such as disk images, as OVF appliances typically
3224	do, those additional files must be in the same directory as the descriptor file.</li>
3225
3226	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
3227	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
3228	files and optionally other files.
3229
3230	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
3231	be added with a later version.</li>
3232	</ol>
3233
3234	<b>Importing</b> an OVF appliance into VirtualBox as instances of
3235	<link to="IMachine" /> involves the following sequence of API calls:
3236
3237	<ol>
3238	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
3239	</li>
3240
3241	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
3242	would like to import. So long as this file is syntactically valid, this will succeed
3243	and fill the appliance object with the parsed data from the OVF file.
3244	</li>
3245
3246	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
3247	contents of the IAppliance attributes accordingly. These can be inspected by a
3248	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
3249	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
3250	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
3251	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
3252	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
3253	The GUI can then give the user the option to confirm and/or change these suggestions.
3254	</li>
3255
3256	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3257	virtual system (machine) to override the suggestions made by the interpret() routine.
3258	</li>
3259
3260	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
3261	VirtualBox as instances of <link to="IMachine" /> that match the information in the
3262	virtual system descriptions.
3263	</li>
3264	</ol>
3265
3266	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
3267
3268	<ol>
3269	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
3270	an empty IAppliance object.
3271	</li>
3272
3273	<li>For each machine you would like to export, call <link to="IMachine::export" />
3274	with the IAppliance object you just created. Each such call creates one instance of
3275	<link to="IVirtualSystemDescription" /> inside the appliance.
3276	</li>
3277
3278	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3279	virtual system (machine) to override the suggestions made by the export() routine.
3280	</li>
3281
3282	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
3283	file written.</li>
3284	</ol>
3285
3286	</desc>
3287
3288	<attribute name="path" type="wstring" readonly="yes">
3289	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
3290	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
3291	<link to="#write" /> (for export).
3292	This attribute is empty until one of these methods has been called.
3293	</desc>
3294	</attribute>
3295
3296	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
3297	<desc>
3298	Array of virtual disk definitions. One such description exists for each
3299	disk definition in the OVF; each string array item represents one such piece of
3300	disk information, with the information fields separated by tab (\t) characters.
3301
3302	The caller should be prepared for additional fields being appended to
3303	this string in future versions of VirtualBox and therefore check for
3304	the number of tabs in the strings returned.
3305
3306	In the current version, the following eight fields are returned per string
3307	in the array:
3308
3309	<ol>
3310	<li>Disk ID (unique string identifier given to disk)</li>
3311
3312	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
3313
3314	<li>Populated size (optional unsigned integer indicating the current size of the
3315	disk; can be approximate; -1 if unspecified)</li>
3316
3317	<li>Format (string identifying the disk format, typically
3318	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
3319
3320	<li>Reference (where to find the disk image, typically a file name; if empty,
3321	then the disk should be created on import)</li>
3322
3323	<li>Image size (optional unsigned integer indicating the size of the image,
3324	which need not necessarily be the same as the values specified above, since
3325	the image may be compressed or sparse; -1 if not specified)</li>
3326
3327	<li>Chunk size (optional unsigned integer if the image is split into chunks;
3328	presently unsupported and always -1)</li>
3329
3330	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
3331	</ol>
3332	</desc>
3333	</attribute>
3334
3335	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
3336	<desc> Array of virtual system descriptions. One such description is created
3337	for each virtual system (machine) found in the OVF.
3338	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
3339	(for export) has been called.
3340	</desc>
3341	</attribute>
3342
3343	<method name="read">
3344	<desc>
3345	Reads an OVF file into the appliance object.
3346
3347	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
3348	mere fact that this method returns successfully does not mean that VirtualBox supports all
3349	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
3350	</desc>
3351	<param name="file" type="wstring" dir="in">
3352	<desc>
3353	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3354	on whether the appliance is distributed as a set of files or as a single file, respectively).
3355	</desc>
3356	</param>
3357	<param name="aProgress" type="IProgress" dir="return">
3358	<desc></desc>
3359	</param>
3360	</method>
3361
3362	<method name="interpret">
3363	<desc>
3364	Interprets the OVF data that was read when the appliance was constructed. After
3365	calling this method, one can inspect the
3366	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
3367	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
3368	the appliance.
3369
3370	Calling this method is the second step of importing an appliance into VirtualBox;
3371	see <link to="IAppliance" /> for an overview.
3372
3373	After calling this method, one should call <link to="#getWarnings" /> to find out
3374	if problems were encountered during the processing which might later lead to
3375	errors.
3376	</desc>
3377	</method>
3378
3379	<method name="importMachines">
3380	<desc>
3381	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
3382	and other interfaces that match the information contained in the appliance as
3383	closely as possible, as represented by the import instructions in the
3384	<link to="#virtualSystemDescriptions" /> array.
3385
3386	Calling this method is the final step of importing an appliance into VirtualBox;
3387	see <link to="IAppliance" /> for an overview.
3388
3389	Since importing the appliance will most probably involve copying and converting
3390	disk images, which can take a long time, this method operates asynchronously and
3391	returns an IProgress object to allow the caller to monitor the progress.
3392	</desc>
3393
3394	<param name="aProgress" type="IProgress" dir="return">
3395	<desc></desc>
3396	</param>
3397	</method>
3398
3399	<method name="createVFSExplorer">
3400	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
3401
3402	<param name="aUri" type="wstring" dir="in">
3403	<desc>The URI describing the file system to use.</desc>
3404	</param>
3405
3406	<param name="aExplorer" type="IVFSExplorer" dir="return">
3407	<desc></desc>
3408	</param>
3409	</method>
3410
3411	<method name="write">
3412	<desc>
3413	Writes the contents of the appliance exports into a new OVF file.
3414
3415	Calling this method is the final step of exporting an appliance from VirtualBox;
3416	see <link to="IAppliance" /> for an overview.
3417
3418	Since exporting the appliance will most probably involve copying and converting
3419	disk images, which can take a long time, this method operates asynchronously and
3420	returns an IProgress object to allow the caller to monitor the progress.
3421	</desc>
3422	<param name="format" type="wstring" dir="in">
3423	<desc>
3424	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
3425	future versions of VirtualBox may support additional formats.
3426	</desc>
3427	</param>
3428	<param name="path" type="wstring" dir="in">
3429	<desc>
3430	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3431	on whether the appliance is distributed as a set of files or as a single file, respectively).
3432	</desc>
3433	</param>
3434	<param name="aProgress" type="IProgress" dir="return">
3435	<desc>Progress object to track the operation completion.</desc>
3436	</param>
3437	</method>
3438
3439	<method name="getWarnings">
3440	<desc>Returns textual warnings which occured during execution of <link to="#interpret" />.</desc>
3441
3442	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
3443	<desc></desc>
3444	</param>
3445	</method>
3446
3447	</interface>
3448
3449	<enum
3450	name="VirtualSystemDescriptionType"
3451	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
3452	>
3453	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
3454	a configuration value.</desc>
3455
3456	<const name="Ignore" value="1" />
3457	<const name="OS" value="2" />
3458	<const name="Name" value="3" />
3459	<const name="Product" value="4" />
3460	<const name="Vendor" value="5" />
3461	<const name="Version" value="6" />
3462	<const name="ProductUrl" value="7" />
3463	<const name="VendorUrl" value="8" />
3464	<const name="Description" value="9" />
3465	<const name="License" value="10" />
3466	<const name="Miscellaneous" value="11" />
3467	<const name="CPU" value="12" />
3468	<const name="Memory" value="13" />
3469	<const name="HardDiskControllerIDE" value="14" />
3470	<const name="HardDiskControllerSATA" value="15" />
3471	<const name="HardDiskControllerSCSI" value="16" />
3472	<const name="HardDiskControllerSAS" value="17" />
3473	<const name="HardDiskImage" value="18" />
3474	<const name="Floppy" value="19" />
3475	<const name="CDROM" value="20" />
3476	<const name="NetworkAdapter" value="21" />
3477	<const name="USBController" value="22" />
3478	<const name="SoundCard" value="23" />
3479
3480	</enum>
3481
3482	<enum
3483	name="VirtualSystemDescriptionValueType"
3484	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
3485	>
3486	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
3487	type to fetch.</desc>
3488
3489	<const name="Reference" value="1" />
3490	<const name="Original" value="2" />
3491	<const name="Auto" value="3" />
3492	<const name="ExtraConfig" value="4" />
3493
3494	</enum>
3495
3496	<interface
3497	name="IVirtualSystemDescription" extends="$unknown"
3498	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
3499	wsmap="managed"
3500	>
3501
3502	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
3503	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
3504	<link to="IAppliance::interpret" /> has been called, that array contains information
3505	about how the virtual systems described in the OVF should best be imported into
3506	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
3507	import an OVF into VirtualBox.
3508	</desc>
3509
3510	<attribute name="count" type="unsigned long" readonly="yes">
3511	<desc>Return the number of virtual system description entries.</desc>
3512	</attribute>
3513
3514	<method name="getDescription">
3515	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
3516	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
3517
3518	The list below identifies the value sets that are possible depending on the
3519	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
3520	the array item with the same index in @a aOvfValues[] will contain the original value as contained
3521	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
3522	will contain a suggested value to be used for VirtualBox. Depending on the description type,
3523	the @a aExtraConfigValues[] array item may also be used.
3524
3525	<ul>
3526	<li>
3527	"OS": the guest operating system type. There must be exactly one such array item on import. The
3528	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
3529	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
3530	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
3531	</li>
3532	<li>
3533	"Name": the name to give to the new virtual machine. There can be at most one such array item;
3534	if none is present on import, then an automatic name will be created from the operating system
3535	type. The correponding item im @a aOvfValues[] will contain the suggested virtual machine name
3536	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
3537	<link to="IMachine" /> name that does not exist yet.
3538	</li>
3539	<li>
3540	"Description": an arbitrary description.
3541	</li>
3542	<li>
3543	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
3544	code to display such a license for agreement; the Main API does not enforce any such policy.
3545	</li>
3546	<li>
3547	Miscellaneous: reserved for future use.
3548	</li>
3549	<li>
3550	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
3551	</li>
3552	<li>
3553	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
3554	is present on import, then VirtualBox will set a meaningful default based on the operating system
3555	type.
3556	</li>
3557	<li>
3558	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
3559	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
3560	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
3561	writes into the OVF.
3562	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
3563	type can use to specify which hard disk controller a virtual disk should be connected to.
3564	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
3565	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
3566	its virtual machines supports four channels (primary master, primary slave, secondary master,
3567	secondary slave) and thus maps to two IDE controllers in the OVF sense.
3568	</li>
3569	<li>
3570	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
3571	has no value in @a aOvfValues[] or @a aVBoxValues[].
3572	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
3573	</li>
3574	<li>
3575	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
3576	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
3577	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
3578	whereas VirtualBox considers it a class of storage controllers of its own; see
3579	<link to="StorageControllerType" />).
3580	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
3581	</li>
3582	<li>
3583	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
3584	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
3585
3586	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
3587	a path since the image file should be in the same location as the OVF file itself), whereas the
3588	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
3589	hard disk image. This means that on import the image will be copied and converted from the
3590	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
3591	On import, the target image will also be registered with VirtualBox.
3592
3593	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
3594	format: "controller=<index>;channel=<c>"
3595	In this string, <index> must be an integer specifying the hard disk controller to connect
3596	the image to. That number must be the index of an array item with one of the hard disk controller
3597	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
3598	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
3599	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
3600	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
3601	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
3602	</li>
3603	<li>
3604	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
3605	attachment information as with "HardDiskImage" items.
3606	</li>
3607	<li>
3608	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
3609	attachment information as with "HardDiskImage" items.
3610	</li>
3611	<li>
3612	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
3613	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
3614	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
3615	</li>
3616	<li>
3617	"USBController": a USB controller. There can be at most one such item. If and only if such an
3618	item ispresent, USB support will be enabled for the new virtual machine.
3619	</li>
3620	<li>
3621	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
3622	present, sound support will be enabled for the new virtual machine. Note that the virtual
3623	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
3624	may be different from the virtual soundcard expected by the appliance.
3625	</li>
3626	</ul>
3627
3628	</desc>
3629
3630	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3631	<desc></desc>
3632	</param>
3633
3634	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3635	<desc></desc>
3636	</param>
3637
3638	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3639	<desc></desc>
3640	</param>
3641
3642	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3643	<desc></desc>
3644	</param>
3645
3646	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3647	<desc></desc>
3648	</param>
3649
3650	</method>
3651
3652	<method name="getDescriptionByType">
3653	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
3654	should be returned.</desc>
3655
3656	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3657	<desc></desc>
3658	</param>
3659
3660	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3661	<desc></desc>
3662	</param>
3663
3664	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3665	<desc></desc>
3666	</param>
3667
3668	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3669	<desc></desc>
3670	</param>
3671
3672	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3673	<desc></desc>
3674	</param>
3675
3676	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3677	<desc></desc>
3678	</param>
3679
3680	</method>
3681
3682	<method name="getValuesByType">
3683	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
3684	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
3685	values.</desc>
3686
3687	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3688	<desc></desc>
3689	</param>
3690
3691	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
3692	<desc></desc>
3693	</param>
3694
3695	<param name="aValues" type="wstring" dir="return" safearray="yes">
3696	<desc></desc>
3697	</param>
3698
3699	</method>
3700
3701	<method name="setFinalValues">
3702	<desc>
3703	This method allows the appliance's user to change the configuration for the virtual
3704	system descriptions. For each array item returned from <link to="#getDescription" />,
3705	you must pass in one boolean value and one configuration value.
3706
3707	Each item in the boolean array determines whether the particular configuration item
3708	should be enabled.
3709	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
3710	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
3711	and SoundCard.
3712
3713	For the "vbox" and "extra configuration" values, if you pass in the same arrays
3714	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
3715	the configuration remains unchanged. Please see the documentation for getDescription()
3716	for valid configuration values for the individual array item types. If the
3717	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3718	</desc>
3719
3720	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
3721	<desc></desc>
3722	</param>
3723
3724	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
3725	<desc></desc>
3726	</param>
3727
3728	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
3729	<desc></desc>
3730	</param>
3731	</method>
3732
3733	<method name="addDescription">
3734	<desc>
3735	This method adds an additional description entry to the stack of already
3736	available descriptions for this virtual system. This is handy for writing
3737	values which aren't directly supported by VirtualBox. One example would
3738	be the License type of <link to="VirtualSystemDescriptionType" />.
3739	</desc>
3740
3741	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3742	<desc></desc>
3743	</param>
3744
3745	<param name="aVBoxValue" type="wstring" dir="in">
3746	<desc></desc>
3747	</param>
3748
3749	<param name="aExtraConfigValue" type="wstring" dir="in">
3750	<desc></desc>
3751	</param>
3752	</method>
3753	</interface>
3754
3755
3756	<!--
3757	// IMachine
3758	/////////////////////////////////////////////////////////////////////////
3759	-->
3760
3761	<interface
3762	name="IInternalMachineControl" extends="$unknown"
3763	uuid="26604a54-8628-491b-a0ea-e1392a16d13b"
3764	internal="yes"
3765	wsmap="suppress"
3766	>
3767	<method name="setRemoveSavedState">
3768	<desc>
3769	Updates the flag whether saved state is removed on a machine state
3770	change from Saved to PoweredOff.
3771	</desc>
3772	<param name="aRemove" type="boolean" dir="in"/>
3773	</method>
3774
3775	<method name="updateState">
3776	<desc>
3777	Updates the VM state.
3778	<note>
3779	This operation will also update the settings file with
3780	the correct information about the saved state file
3781	and delete this file from disk when appropriate.
3782	</note>
3783	</desc>
3784	<param name="state" type="MachineState" dir="in"/>
3785	</method>
3786
3787	<method name="getIPCId">
3788	<param name="id" type="wstring" dir="return"/>
3789	</method>
3790
3791	<method name="beginPowerUp">
3792	<desc>
3793	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
3794	gives it the progress object that should be part of any pending
3795	<link to="IVirtualBox::openRemoteSession"/> operations. The progress
3796	object may be called back to reflect an early cancelation, so some care
3797	have to be taken with respect to any cancelation callbacks. The console
3798	object will call <link to="IInternalMachineControl::endPowerUp"/>
3799	to signal the completion of the progress object.
3800	</desc>
3801	<param name="progress" type="IProgress" dir="in"/>
3802	</method>
3803
3804	<method name="endPowerUp">
3805	<desc>
3806	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3807	This method may query status information from the progress object it
3808	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3809	it over to any in progress <link to="IVirtualBox::openRemoteSession"/>
3810	call in order to complete that progress object.
3811	</desc>
3812	<param name="result" type="long" dir="in"/>
3813	</method>
3814
3815	<method name="runUSBDeviceFilters">
3816	<desc>
3817	Asks the server to run USB devices filters of the associated
3818	machine against the given USB device and tell if there is
3819	a match.
3820	<note>
3821	Intended to be used only for remote USB devices. Local
3822	ones don't require to call this method (this is done
3823	implicitly by the Host and USBProxyService).
3824	</note>
3825	</desc>
3826	<param name="device" type="IUSBDevice" dir="in"/>
3827	<param name="matched" type="boolean" dir="out"/>
3828	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3829	</method>
3830
3831	<method name="captureUSBDevice">
3832	<desc>
3833	Requests a capture of the given host USB device.
3834	When the request is completed, the VM process will
3835	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3836	notification.
3837	</desc>
3838	<param name="id" type="uuid" mod="string" dir="in"/>
3839	</method>
3840
3841	<method name="detachUSBDevice">
3842	<desc>
3843	Notification that a VM is going to detach (@a done = @c false) or has
3844	already detached (@a done = @c true) the given USB device.
3845	When the @a done = @c true request is completed, the VM process will
3846	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3847	notification.
3848	<note>
3849	In the @a done = @c true case, the server must run its own filters
3850	and filters of all VMs but this one on the detached device
3851	as if it were just attached to the host computer.
3852	</note>
3853	</desc>
3854	<param name="id" type="uuid" mod="string" dir="in"/>
3855	<param name="done" type="boolean" dir="in"/>
3856	</method>
3857
3858	<method name="autoCaptureUSBDevices">
3859	<desc>
3860	Requests a capture all matching USB devices attached to the host.
3861	When the request is completed, the VM process will
3862	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3863	notification per every captured device.
3864	</desc>
3865	</method>
3866
3867	<method name="detachAllUSBDevices">
3868	<desc>
3869	Notification that a VM that is being powered down. The done
3870	parameter indicates whether which stage of the power down
3871	we're at. When @a done = @c false the VM is announcing its
3872	intentions, while when @a done = @c true the VM is reporting
3873	what it has done.
3874	<note>
3875	In the @a done = @c true case, the server must run its own filters
3876	and filters of all VMs but this one on all detach devices as
3877	if they were just attached to the host computer.
3878	</note>
3879	</desc>
3880	<param name="done" type="boolean" dir="in"/>
3881	</method>
3882
3883	<method name="onSessionEnd">
3884	<desc>
3885	Triggered by the given session object when the session is about
3886	to close normally.
3887	</desc>
3888	<param name="session" type="ISession" dir="in">
3889	<desc>Session that is being closed</desc>
3890	</param>
3891	<param name="progress" type="IProgress" dir="return">
3892	<desc>
3893	Used to wait until the corresponding machine is actually
3894	dissociated from the given session on the server.
3895	Returned only when this session is a direct one.
3896	</desc>
3897	</param>
3898	</method>
3899
3900	<method name="beginSavingState">
3901	<desc>
3902	Called by the VM process to inform the server it wants to
3903	save the current state and stop the VM execution.
3904	</desc>
3905	<param name="progress" type="IProgress" dir="in">
3906	<desc>
3907	Progress object created by the VM process to wait until
3908	the state is saved.
3909	</desc>
3910	</param>
3911	<param name="stateFilePath" type="wstring" dir="out">
3912	<desc>
3913	File path the VM process must save the execution state to.
3914	</desc>
3915	</param>
3916	</method>
3917
3918	<method name="endSavingState">
3919	<desc>
3920	Called by the VM process to inform the server that saving
3921	the state previously requested by #beginSavingState is either
3922	successfully finished or there was a failure.
3923
3924	<result name="VBOX_E_FILE_ERROR">
3925	Settings file not accessible.
3926	</result>
3927	<result name="VBOX_E_XML_ERROR">
3928	Could not parse the settings file.
3929	</result>
3930
3931	</desc>
3932
3933	<param name="success" type="boolean" dir="in">
3934	<desc>@c true to indicate success and @c false otherwise.
3935	</desc>
3936	</param>
3937	</method>
3938
3939	<method name="adoptSavedState">
3940	<desc>
3941	Gets called by IConsole::adoptSavedState.
3942	<result name="VBOX_E_FILE_ERROR">
3943	Invalid saved state file path.
3944	</result>
3945	</desc>
3946	<param name="savedStateFile" type="wstring" dir="in">
3947	<desc>Path to the saved state file to adopt.</desc>
3948	</param>
3949	</method>
3950
3951	<method name="beginTakingSnapshot">
3952	<desc>
3953	Called from the VM process to request from the server to perform the
3954	server-side actions of creating a snapshot (creating differencing images
3955	and the snapshot object).
3956
3957	<result name="VBOX_E_FILE_ERROR">
3958	Settings file not accessible.
3959	</result>
3960	<result name="VBOX_E_XML_ERROR">
3961	Could not parse the settings file.
3962	</result>
3963	</desc>
3964	<param name="initiator" type="IConsole" dir="in">
3965	<desc>The console object that initiated this call.</desc>
3966	</param>
3967	<param name="name" type="wstring" dir="in">
3968	<desc>Snapshot name.</desc>
3969	</param>
3970	<param name="description" type="wstring" dir="in">
3971	<desc>Snapshot description.</desc>
3972	</param>
3973	<param name="consoleProgress" type="IProgress" dir="in">
3974	<desc>
3975	Progress object created by the VM process tracking the
3976	snapshot's progress. This has the following sub-operations:
3977	<ul>
3978	<li>setting up (weight 1);</li>
3979	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3980	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3981	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3982	<li>finishing up (weight 1)</li>
3983	</ul>
3984	</desc>
3985	</param>
3986	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3987	<desc>
3988	Whether this is an online snapshot (i.e. the machine is running).
3989	</desc>
3990	</param>
3991	<param name="stateFilePath" type="wstring" dir="out">
3992	<desc>
3993	File path the VM process must save the execution state to.
3994	</desc>
3995	</param>
3996	</method>
3997
3998	<method name="endTakingSnapshot">
3999	<desc>
4000	Called by the VM process to inform the server that the snapshot
4001	previously requested by #beginTakingSnapshot is either
4002	successfully taken or there was a failure.
4003	</desc>
4004
4005	<param name="success" type="boolean" dir="in">
4006	<desc>@c true to indicate success and @c false otherwise</desc>
4007	</param>
4008	</method>
4009
4010	<method name="deleteSnapshot">
4011	<desc>
4012	Gets called by IConsole::deleteSnapshot.
4013	<result name="VBOX_E_INVALID_OBJECT_STATE">
4014	Snapshot has more than one child snapshot.
4015	</result>
4016	</desc>
4017	<param name="initiator" type="IConsole" dir="in">
4018	<desc>The console object that initiated this call.</desc>
4019	</param>
4020	<param name="id" type="uuid" mod="string" dir="in">
4021	<desc>UUID of the snapshot to delete.</desc>
4022	</param>
4023	<param name="machineState" type="MachineState" dir="out">
4024	<desc>New machine state after this operation is started.</desc>
4025	</param>
4026	<param name="progress" type="IProgress" dir="return">
4027	<desc>Progress object to track the operation completion.</desc>
4028	</param>
4029	</method>
4030
4031	<method name="finishOnlineMergeMedium">
4032	<desc>
4033	Gets called by IConsole::onlineMergeMedium.
4034	</desc>
4035	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
4036	<desc>The medium attachment which needs to be cleaned up.</desc>
4037	</param>
4038	<param name="source" type="IMedium" dir="in">
4039	<desc>Merge source medium.</desc>
4040	</param>
4041	<param name="target" type="IMedium" dir="in">
4042	<desc>Merge target medium.</desc>
4043	</param>
4044	<param name="mergeForward" type="boolean" dir="in">
4045	<desc>Merge direction.</desc>
4046	</param>
4047	<param name="parentForTarget" type="IMedium" dir="in">
4048	<desc>For forward merges: new parent for target medium.</desc>
4049	</param>
4050	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
4051	<desc>For backward merges: list of media which need their parent UUID
4052	updated.</desc>
4053	</param>
4054	</method>
4055
4056	<method name="restoreSnapshot">
4057	<desc>
4058	Gets called by IConsole::RestoreSnapshot.
4059	</desc>
4060	<param name="initiator" type="IConsole" dir="in">
4061	<desc>The console object that initiated this call.</desc>
4062	</param>
4063	<param name="snapshot" type="ISnapshot" dir="in">
4064	<desc>The snapshot to restore the VM state from.</desc>
4065	</param>
4066	<param name="machineState" type="MachineState" dir="out">
4067	<desc>New machine state after this operation is started.</desc>
4068	</param>
4069	<param name="progress" type="IProgress" dir="return">
4070	<desc>Progress object to track the operation completion.</desc>
4071	</param>
4072	</method>
4073
4074	<method name="pullGuestProperties">
4075	<desc>
4076	Get the list of the guest properties matching a set of patterns along
4077	with their values, time stamps and flags and give responsibility for
4078	managing properties to the console.
4079	</desc>
4080	<param name="name" type="wstring" dir="out" safearray="yes">
4081	<desc>
4082	The names of the properties returned.
4083	</desc>
4084	</param>
4085	<param name="value" type="wstring" dir="out" safearray="yes">
4086	<desc>
4087	The values of the properties returned. The array entries match the
4088	corresponding entries in the @a name array.
4089	</desc>
4090	</param>
4091	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
4092	<desc>
4093	The time stamps of the properties returned. The array entries match
4094	the corresponding entries in the @a name array.
4095	</desc>
4096	</param>
4097	<param name="flags" type="wstring" dir="out" safearray="yes">
4098	<desc>
4099	The flags of the properties returned. The array entries match the
4100	corresponding entries in the @a name array.
4101	</desc>
4102	</param>
4103	</method>
4104
4105	<method name="pushGuestProperty">
4106	<desc>
4107	Update a single guest property in IMachine.
4108	</desc>
4109	<param name="name" type="wstring" dir="in">
4110	<desc>
4111	The name of the property to be updated.
4112	</desc>
4113	</param>
4114	<param name="value" type="wstring" dir="in">
4115	<desc>
4116	The value of the property.
4117	</desc>
4118	</param>
4119	<param name="timestamp" type="unsigned long long" dir="in">
4120	<desc>
4121	The timestamp of the property.
4122	</desc>
4123	</param>
4124	<param name="flags" type="wstring" dir="in">
4125	<desc>
4126	The flags of the property.
4127	</desc>
4128	</param>
4129	</method>
4130
4131	<method name="lockMedia">
4132	<desc>
4133	Locks all media attached to the machine for writing and parents of
4134	attached differencing media (if any) for reading. This operation is
4135	atomic so that if it fails no media is actually locked.
4136
4137	This method is intended to be called when the machine is in Starting or
4138	Restoring state. The locked media will be automatically unlocked when
4139	the machine is powered off or crashed.
4140	</desc>
4141	</method>
4142	<method name="unlockMedia">
4143	<desc>
4144	Unlocks all media previously locked using
4145	<link to="IInternalMachineControl::lockMedia"/>.
4146
4147	This method is intended to be used with teleportation so that it is
4148	possible to teleport between processes on the same machine.
4149	</desc>
4150	</method>
4151	</interface>
4152
4153	<interface
4154	name="IBIOSSettings" extends="$unknown"
4155	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
4156	wsmap="managed"
4157	>
4158	<desc>
4159	The IBIOSSettings interface represents BIOS settings of the virtual
4160	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
4161	</desc>
4162	<attribute name="logoFadeIn" type="boolean">
4163	<desc>Fade in flag for BIOS logo animation.</desc>
4164	</attribute>
4165
4166	<attribute name="logoFadeOut" type="boolean">
4167	<desc>Fade out flag for BIOS logo animation.</desc>
4168	</attribute>
4169
4170	<attribute name="logoDisplayTime" type="unsigned long">
4171	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
4172	</attribute>
4173
4174	<attribute name="logoImagePath" type="wstring">
4175	<desc>
4176	Local file system path for external BIOS splash image. Empty string
4177	means the default image is shown on boot.
4178	</desc>
4179	</attribute>
4180
4181	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
4182	<desc>Mode of the BIOS boot device menu.</desc>
4183	</attribute>
4184
4185	<attribute name="ACPIEnabled" type="boolean">
4186	<desc>ACPI support flag.</desc>
4187	</attribute>
4188
4189	<attribute name="IOAPICEnabled" type="boolean">
4190	<desc>
4191	IO APIC support flag. If set, VirtualBox will provide an IO APIC
4192	and support IRQs above 15.
4193	</desc>
4194	</attribute>
4195
4196	<attribute name="timeOffset" type="long long">
4197	<desc>
4198	Offset in milliseconds from the host system time. This allows for
4199	guests running with a different system date/time than the host.
4200	It is equivalent to setting the system date/time in the BIOS except
4201	it is not an absolute value but a relative one. Guest Additions
4202	time synchronization honors this offset.
4203	</desc>
4204	</attribute>
4205
4206	<attribute name="PXEDebugEnabled" type="boolean">
4207	<desc>
4208	PXE debug logging flag. If set, VirtualBox will write extensive
4209	PXE trace information to the release log.
4210	</desc>
4211	</attribute>
4212
4213	</interface>
4214
4215	<interface
4216	name="IMachine" extends="$unknown"
4217	uuid="6d9212cb-a5c0-48b7-bbc1-3fa2ba2ee6d2"
4218	wsmap="managed"
4219	>
4220	<desc>
4221	The IMachine interface represents a virtual machine, or guest, created
4222	in VirtualBox.
4223
4224	This interface is used in two contexts. First of all, a collection of
4225	objects implementing this interface is stored in the
4226	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
4227	machines that are currently registered with this VirtualBox
4228	installation. Also, once a session has been opened for the given virtual
4229	machine (e.g. the virtual machine is running), the machine object
4230	associated with the open session can be queried from the session object;
4231	see <link to="ISession"/> for details.
4232
4233	The main role of this interface is to expose the settings of the virtual
4234	machine and provide methods to change various aspects of the virtual
4235	machine's configuration. For machine objects stored in the
4236	<link to="IVirtualBox::machines"/> collection, all attributes are
4237	read-only unless explicitly stated otherwise in individual attribute
4238	and method descriptions. In order to change a machine setting, a session
4239	for this machine must be opened using one of
4240	<link to="IVirtualBox::openSession"/>,
4241	<link to="IVirtualBox::openRemoteSession"/> or
4242	<link to="IVirtualBox::openExistingSession"/> methods. After the
4243	session has been successfully opened, a mutable machine object needs to
4244	be queried from the session object and then the desired settings changes
4245	can be applied to the returned object using IMachine attributes and
4246	methods. See the <link to="ISession"/> interface description for more
4247	information about sessions.
4248
4249	Note that IMachine does not provide methods to control virtual machine
4250	execution (such as start the machine, or power it down) -- these methods
4251	are grouped in a separate interface called <link to="IConsole" />.
4252
4253	<see>ISession, IConsole</see>
4254	</desc>
4255
4256	<attribute name="parent" type="IVirtualBox" readonly="yes">
4257	<desc>Associated parent object.</desc>
4258	</attribute>
4259
4260	<attribute name="accessible" type="boolean" readonly="yes">
4261	<desc>
4262	Whether this virtual machine is currently accessible or not.
4263
4264	A machine is always deemed accessible unless it is registered <i>and</i>
4265	its settings file cannot be read or parsed (either because the file itself
4266	is unavailable or has invalid XML contents).
4267
4268	Every time this property is read, the accessibility state of
4269	this machine is re-evaluated. If the returned value is @c false,
4270	the <link to="#accessError"/> property may be used to get the
4271	detailed error information describing the reason of
4272	inaccessibility, including XML error messages.
4273
4274	When the machine is inaccessible, only the following properties
4275	can be used on it:
4276	<ul>
4277	<li><link to="#parent"/></li>
4278	<li><link to="#id"/></li>
4279	<li><link to="#settingsFilePath"/></li>
4280	<li><link to="#accessible"/></li>
4281	<li><link to="#accessError"/></li>
4282	</ul>
4283
4284	An attempt to access any other property or method will return
4285	an error.
4286
4287	The only possible action you can perform on an inaccessible
4288	machine is to unregister it using the
4289	<link to="IVirtualBox::unregisterMachine"/> call (or, to check
4290	for the accessibility state once more by querying this
4291	property).
4292
4293	<note>
4294	In the current implementation, once this property returns
4295	@c true, the machine will never become inaccessible
4296	later, even if its settings file cannot be successfully
4297	read/written any more (at least, until the VirtualBox
4298	server is restarted). This limitation may be removed in
4299	future releases.
4300	</note>
4301	</desc>
4302	</attribute>
4303
4304	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
4305	<desc>
4306	Error information describing the reason of machine
4307	inaccessibility.
4308
4309	Reading this property is only valid after the last call to
4310	<link to="#accessible"/> returned @c false (i.e. the
4311	machine is currently unaccessible). Otherwise, a @c null
4312	IVirtualBoxErrorInfo object will be returned.
4313	</desc>
4314	</attribute>
4315
4316	<attribute name="name" type="wstring">
4317	<desc>
4318	Name of the virtual machine.
4319
4320	Besides being used for human-readable identification purposes
4321	everywhere in VirtualBox, the virtual machine name is also used
4322	as a name of the machine's settings file and as a name of the
4323	subdirectory this settings file resides in. Thus, every time you
4324	change the value of this property, the settings file will be
4325	renamed once you call <link to="#saveSettings"/> to confirm the
4326	change. The containing subdirectory will be also renamed, but
4327	only if it has exactly the same name as the settings file
4328	itself prior to changing this property (for backward compatibility
4329	with previous API releases). The above implies the following
4330	limitations:
4331	<ul>
4332	<li>The machine name cannot be empty.</li>
4333	<li>The machine name can contain only characters that are valid
4334	file name characters according to the rules of the file
4335	system used to store VirtualBox configuration.</li>
4336	<li>You cannot have two or more machines with the same name
4337	if they use the same subdirectory for storing the machine
4338	settings files.</li>
4339	<li>You cannot change the name of the machine if it is running,
4340	or if any file in the directory containing the settings file
4341	is being used by another running machine or by any other
4342	process in the host operating system at a time when
4343	<link to="#saveSettings"/> is called.
4344	</li>
4345	</ul>
4346	If any of the above limitations are hit, <link to="#saveSettings"/>
4347	will return an appropriate error message explaining the exact
4348	reason and the changes you made to this machine will not be
4349	saved.
4350	<note>
4351	For "legacy" machines created using the
4352	<link to="IVirtualBox::createLegacyMachine"/> call,
4353	the above naming limitations do not apply because the
4354	machine name does not affect the settings file name.
4355	The settings file name remains the same as it was specified
4356	during machine creation and never changes.
4357	</note>
4358	</desc>
4359	</attribute>
4360
4361	<attribute name="description" type="wstring">
4362	<desc>
4363	Description of the virtual machine.
4364
4365	The description attribute can contain any text and is
4366	typically used to describe the hardware and software
4367	configuration of the virtual machine in detail (i.e. network
4368	settings, versions of the installed software and so on).
4369	</desc>
4370	</attribute>
4371
4372	<attribute name="id" type="uuid" mod="string" readonly="yes">
4373	<desc>UUID of the virtual machine.</desc>
4374	</attribute>
4375
4376	<attribute name="OSTypeId" type="wstring">
4377	<desc>
4378	User-defined identifier of the Guest OS type.
4379	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
4380	an IGuestOSType object representing details about the given
4381	Guest OS type.
4382	<note>
4383	This value may differ from the value returned by
4384	<link to="IGuest::OSTypeId"/> if Guest Additions are
4385	installed to the guest OS.
4386	</note>
4387	</desc>
4388	</attribute>
4389
4390	<attribute name="HardwareVersion" type="wstring">
4391	<desc>Hardware version identifier. Internal use only for now.</desc>
4392	</attribute>
4393
4394	<attribute name="hardwareUUID" type="uuid" mod="string">
4395	<desc>
4396	The UUID presented to the guest via memory tables, hardware and guest
4397	properties. For most VMs this is the same as the @a id, but for VMs
4398	which have been cloned or teleported it may be the same as the source
4399	VM. This latter is because the guest shouldn't notice that it was
4400	cloned or teleported.
4401	</desc>
4402	</attribute>
4403
4404	<attribute name="CPUCount" type="unsigned long">
4405	<desc>Number of virtual CPUs in the VM.</desc>
4406	</attribute>
4407
4408	<attribute name="CPUHotPlugEnabled" type="boolean">
4409	<desc>
4410	This setting determines whether VirtualBox allows CPU
4411	hotplugging for this machine.</desc>
4412	</attribute>
4413
4414	<attribute name="memorySize" type="unsigned long">
4415	<desc>System memory size in megabytes.</desc>
4416	</attribute>
4417
4418	<attribute name="memoryBalloonSize" type="unsigned long">
4419	<desc>Memory balloon size in megabytes.</desc>
4420	</attribute>
4421
4422	<attribute name="PageFusionEnabled" type="boolean">
4423	<desc>
4424	This setting determines whether VirtualBox allows page
4425	fusion for this machine (64 bits host only).
4426	</desc>
4427	</attribute>
4428
4429	<attribute name="VRAMSize" type="unsigned long">
4430	<desc>Video memory size in megabytes.</desc>
4431	</attribute>
4432
4433	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4434	<desc>
4435	This setting determines whether VirtualBox allows this machine to make
4436	use of the 3D graphics support available on the host.</desc>
4437	</attribute>
4438
4439	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4440	<desc>
4441	This setting determines whether VirtualBox allows this machine to make
4442	use of the 2D video acceleration support available on the host.</desc>
4443	</attribute>
4444
4445	<attribute name="monitorCount" type="unsigned long">
4446	<desc>
4447	Number of virtual monitors.
4448	<note>
4449	Only effective on Windows XP and later guests with
4450	Guest Additions installed.
4451	</note>
4452	</desc>
4453	</attribute>
4454
4455	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4456	<desc>Object containing all BIOS settings.</desc>
4457	</attribute>
4458
4459	<attribute name="firmwareType" type="FirmwareType">
4460	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4461	bootstrap in this VM.</desc>
4462	</attribute>
4463
4464	<attribute name="pointingHidType" type="PointingHidType">
4465	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
4466	The default is typically "PS2Mouse" but can vary depending on the
4467	requirements of the guest operating system.</desc>
4468	</attribute>
4469
4470	<attribute name="keyboardHidType" type="KeyboardHidType">
4471	<desc>Type of keyboard HID used in this VM.
4472	The default is typically "PS2Keyboard" but can vary depending on the
4473	requirements of the guest operating system.</desc>
4474	</attribute>
4475
4476	<attribute name="hpetEnabled" type="boolean">
4477	<desc>This attribute controls if High Precision Event Timer (HPET) is
4478	enabled in this VM. Use this property if you want to provide guests
4479	with additional time source, or if guest requires HPET to function correctly.
4480	Default is false.</desc>
4481	</attribute>
4482
4483	<attribute name="snapshotFolder" type="wstring">
4484	<desc>
4485	Full path to the directory used to store snapshot data
4486	(differencing media and saved state files) of this machine.
4487
4488	The initial value of this property is
4489	<tt><</tt><link to="#settingsFilePath">
4490	path_to_settings_file</link><tt>>/<</tt>
4491	<link to="#id">machine_uuid</link>
4492	<tt>></tt>.
4493
4494	Currently, it is an error to try to change this property on
4495	a machine that has snapshots (because this would require to
4496	move possibly large files to a different location).
4497	A separate method will be available for this purpose later.
4498
4499	<note>
4500	Setting this property to @c null or to an empty string will restore
4501	the initial value.
4502	</note>
4503	<note>
4504	When setting this property, the specified path can be
4505	absolute (full path) or relative to the directory where the
4506	<link to="#settingsFilePath">machine settings file</link>
4507	is located. When reading this property, a full path is
4508	always returned.
4509	</note>
4510	<note>
4511	The specified path may not exist, it will be created
4512	when necessary.
4513	</note>
4514	</desc>
4515	</attribute>
4516
4517	<attribute name="VRDPServer" type="IVRDPServer" readonly="yes">
4518	<desc>VRDP server object.</desc>
4519	</attribute>
4520
4521	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4522	<desc>Array of media attached to this machine.</desc>
4523	</attribute>
4524
4525	<attribute name="USBController" type="IUSBController" readonly="yes">
4526	<desc>
4527	Associated USB controller object.
4528
4529	<note>
4530	If USB functionality is not available in the given edition of
4531	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4532	</note>
4533	</desc>
4534	</attribute>
4535
4536	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4537	<desc>Associated audio adapter, always present.</desc>
4538	</attribute>
4539
4540	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4541	<desc>Array of storage controllers attached to this machine.</desc>
4542	</attribute>
4543
4544	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4545	<desc>
4546	Full name of the file containing machine settings data.
4547	</desc>
4548	</attribute>
4549
4550	<attribute name="settingsModified" type="boolean" readonly="yes">
4551	<desc>
4552	Whether the settings of this machine have been modified
4553	(but neither yet saved nor discarded).
4554	<note>
4555	Reading this property is only valid on instances returned
4556	by <link to="ISession::machine"/> and on new machines
4557	created by <link to="IVirtualBox::createMachine"/> or opened
4558	by <link to="IVirtualBox::openMachine"/> but not
4559	yet registered, or on unregistered machines after calling
4560	<link to="IVirtualBox::unregisterMachine"/>. For all other
4561	cases, the settings can never be modified.
4562	</note>
4563	<note>
4564	For newly created unregistered machines, the value of this
4565	property is always @c true until <link to="#saveSettings"/>
4566	is called (no matter if any machine settings have been
4567	changed after the creation or not). For opened machines
4568	the value is set to @c false (and then follows to normal rules).
4569	</note>
4570	</desc>
4571	</attribute>
4572
4573	<attribute name="sessionState" type="SessionState" readonly="yes">
4574	<desc>Current session state for this machine.</desc>
4575	</attribute>
4576
4577	<attribute name="sessionType" type="wstring" readonly="yes">
4578	<desc>
4579	Type of the session. If <link to="#sessionState"/> is
4580	SessionSpawning or SessionOpen, this attribute contains the
4581	same value as passed to the
4582	<link to="IVirtualBox::openRemoteSession"/> method in the
4583	@a type parameter. If the session was opened directly using
4584	<link to="IVirtualBox::openSession"/>, or if
4585	<link to="#sessionState"/> is SessionClosed, the value of this
4586	attribute is an empty string.
4587	</desc>
4588	</attribute>
4589
4590	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4591	<desc>
4592	Identifier of the session process. This attribute contains the
4593	platform-dependent identifier of the process that has opened a
4594	direct session for this machine using the
4595	<link to="IVirtualBox::openSession"/> call. The returned value
4596	is only valid if <link to="#sessionState"/> is SessionOpen or
4597	SessionClosing (i.e. a session is currently open or being
4598	closed) by the time this property is read.
4599	</desc>
4600	</attribute>
4601
4602	<attribute name="state" type="MachineState" readonly="yes">
4603	<desc>Current execution state of this machine.</desc>
4604	</attribute>
4605
4606	<attribute name="lastStateChange" type="long long" readonly="yes">
4607	<desc>
4608	Time stamp of the last execution state change,
4609	in milliseconds since 1970-01-01 UTC.
4610	</desc>
4611	</attribute>
4612
4613	<attribute name="stateFilePath" type="wstring" readonly="yes">
4614	<desc>
4615	Full path to the file that stores the execution state of
4616	the machine when it is in the <link to="MachineState_Saved"/> state.
4617	<note>
4618	When the machine is not in the Saved state, this attribute is
4619	an empty string.
4620	</note>
4621	</desc>
4622	</attribute>
4623
4624	<attribute name="logFolder" type="wstring" readonly="yes">
4625	<desc>
4626	Full path to the folder that stores a set of rotated log files
4627	recorded during machine execution. The most recent log file is
4628	named <tt>VBox.log</tt>, the previous log file is
4629	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4630	in the current version).
4631	</desc>
4632	</attribute>
4633
4634	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4635	<desc>
4636	Current snapshot of this machine. This is @c null if the machine
4637	currently has no snapshots. If it is not @c null, then it was
4638	set by one of <link to="Console::takeSnapshot" />,
4639	<link to="Console::deleteSnapshot" />
4640	or <link to="Console::restoreSnapshot" />, depending on which
4641	was called last. See <link to="ISnapshot"/> for details.
4642	</desc>
4643	</attribute>
4644
4645	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4646	<desc>
4647	Number of snapshots taken on this machine. Zero means the
4648	machine doesn't have any snapshots.
4649	</desc>
4650	</attribute>
4651
4652	<attribute name="currentStateModified" type="boolean" readonly="yes">
4653	<desc>
4654	Returns @c true if the current state of the machine is not
4655	identical to the state stored in the current snapshot.
4656
4657	The current state is identical to the current snapshot only
4658	directly after one of the following calls are made:
4659
4660	<ul>
4661	<li><link to="IConsole::restoreSnapshot"/>
4662	</li>
4663	<li><link to="IConsole::takeSnapshot"/> (issued on a
4664	"powered off" or "saved" machine, for which
4665	<link to="#settingsModified"/> returns @c false)
4666	</li>
4667	<li><link to="IMachine::setCurrentSnapshot"/>
4668	</li>
4669	</ul>
4670
4671	The current state remains identical until one of the following
4672	happens:
4673	<ul>
4674	<li>settings of the machine are changed</li>
4675	<li>the saved state is deleted</li>
4676	<li>the current snapshot is deleted</li>
4677	<li>an attempt to execute the machine is made</li>
4678	</ul>
4679
4680	<note>
4681	For machines that don't have snapshots, this property is
4682	always @c false.
4683	</note>
4684	</desc>
4685	</attribute>
4686
4687	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4688	<desc>
4689	Collection of shared folders for this machine (permanent shared
4690	folders). These folders are shared automatically at machine startup
4691	and available only to the guest OS installed within this machine.
4692
4693	New shared folders are added to the collection using
4694	<link to="#createSharedFolder"/>. Existing shared folders can be
4695	removed using <link to="#removeSharedFolder"/>.
4696	</desc>
4697	</attribute>
4698
4699	<attribute name="clipboardMode" type="ClipboardMode">
4700	<desc>
4701	Synchronization mode between the host OS clipboard
4702	and the guest OS clipboard.
4703	</desc>
4704	</attribute>
4705
4706	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4707	<desc>
4708	A comma-separated list of simple glob patterns. Changes to guest
4709	properties whose name matches one of the patterns will generate an
4710	<link to="IVirtualBoxCallback::onGuestPropertyChange"/> signal.
4711	</desc>
4712	</attribute>
4713
4714	<attribute name="teleporterEnabled" type="boolean">
4715	<desc>
4716	When set to @a true, the virtual machine becomes a target teleporter
4717	the next time it is powered on. This can only set to @a true when the
4718	VM is in the @a PoweredOff or @a Aborted state.
4719
4720	<!-- This property is automatically set to @a false when the VM is powered
4721	on. (bird: This doesn't work yet ) -->
4722	</desc>
4723	</attribute>
4724
4725	<attribute name="teleporterPort" type="unsigned long">
4726	<desc>
4727	The TCP port the target teleporter will listen for incoming
4728	teleportations on.
4729
4730	0 means the port is automatically selected upon power on. The actual
4731	value can be read from this property while the machine is waiting for
4732	incoming teleportations.
4733	</desc>
4734	</attribute>
4735
4736	<attribute name="teleporterAddress" type="wstring">
4737	<desc>
4738	The address the target teleporter will listen on. If set to an empty
4739	string, it will listen on all addresses.
4740	</desc>
4741	</attribute>
4742
4743	<attribute name="teleporterPassword" type="wstring">
4744	<desc>
4745	The password the to check for on the target teleporter. This is just a
4746	very basic measure to prevent simple hacks and operators accidentally
4747	beaming a virtual machine to the wrong place.
4748	</desc>
4749	</attribute>
4750
4751	<attribute name="RTCUseUTC" type="boolean">
4752	<desc>
4753	When set to @a true, the RTC device of the virtual machine will run
4754	in UTC time, otherwise in local time. Especially Unix guests prefer
4755	the time in UTC.
4756	</desc>
4757	</attribute>
4758
4759	<attribute name="ioCacheEnabled" type="boolean">
4760	<desc>
4761	When set to @a true, the builtin I/O cache of the virtual machine
4762	will be enabled.
4763	</desc>
4764	</attribute>
4765
4766	<attribute name="ioCacheSize" type="unsigned long">
4767	<desc>
4768	Maximum size of the I/O cache in MB.
4769	</desc>
4770	</attribute>
4771
4772	<attribute name="ioBandwidthMax" type="unsigned long">
4773	<desc>
4774	The maximum number of MB the VM is allowed to transfer per second.
4775	0 means unlimited bandwidth.
4776	</desc>
4777	</attribute>
4778
4779	<method name="setBootOrder">
4780	<desc>
4781	Puts the given device to the specified position in
4782	the boot order.
4783
4784	To indicate that no device is associated with the given position,
4785	<link to="DeviceType_Null"/> should be used.
4786
4787	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4788
4789	<result name="E_INVALIDARG">
4790	Boot @a position out of range.
4791	</result>
4792	<result name="E_NOTIMPL">
4793	Booting from USB @a device currently not supported.
4794	</result>
4795
4796	</desc>
4797	<param name="position" type="unsigned long" dir="in">
4798	<desc>
4799	Position in the boot order (@c 1 to the total number of
4800	devices the machine can boot from, as returned by
4801	<link to="ISystemProperties::maxBootPosition"/>).
4802	</desc>
4803	</param>
4804	<param name="device" type="DeviceType" dir="in">
4805	<desc>
4806	The type of the device used to boot at the given position.
4807	</desc>
4808	</param>
4809	</method>
4810
4811	<method name="getBootOrder" const="yes">
4812	<desc>
4813	Returns the device type that occupies the specified
4814	position in the boot order.
4815
4816	@todo [remove?]
4817	If the machine can have more than one device of the returned type
4818	(such as hard disks), then a separate method should be used to
4819	retrieve the individual device that occupies the given position.
4820
4821	If here are no devices at the given position, then
4822	<link to="DeviceType_Null"/> is returned.
4823
4824	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4825
4826	<result name="E_INVALIDARG">
4827	Boot @a position out of range.
4828	</result>
4829
4830	</desc>
4831	<param name="position" type="unsigned long" dir="in">
4832	<desc>
4833	Position in the boot order (@c 1 to the total number of
4834	devices the machine can boot from, as returned by
4835	<link to="ISystemProperties::maxBootPosition"/>).
4836	</desc>
4837	</param>
4838	<param name="device" type="DeviceType" dir="return">
4839	<desc>
4840	Device at the given position.
4841	</desc>
4842	</param>
4843	</method>
4844
4845	<method name="attachDevice">
4846	<desc>
4847	Attaches a device and optionally mounts a medium to the given storage
4848	controller (<link to="IStorageController" />, identified by @a name),
4849	at the indicated port and device.
4850
4851	This method is intended for managing storage devices in general (it works
4852	for both fixed and removable media). For storage devices supporting removable
4853	media (such as DVDs and floppies), you can also use <link to="IMedium::mountMedium"/>
4854	for changing the media while the machine is running.
4855
4856	In a VM's default configuration of virtual machines, the secondary
4857	master of the IDE controller is used for a CD/DVD drive.
4858
4859	For fixed media such as hard disks, the given medium identifier cannot
4860	be a zero UUID. It may be a zero UUID for removable media such as DVDs
4861	and floppies.
4862
4863	After calling this returns successfully, a new instance of
4864	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4865	attachments (<link to="IMachine::mediumAttachments"/>).
4866
4867	The specified device slot must not have a device attached to it,
4868	or this method will fail.
4869
4870	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4871	information about attaching media.
4872
4873	<note>
4874	You cannot attach a device to a running machine. Also, you cannot
4875	attach a device to a newly created machine until this machine's
4876	settings are saved to disk using <link to="#saveSettings"/>.
4877	</note>
4878	<note>
4879	If the medium is being attached indirectly, a new differencing medium
4880	will implicitly be created for it and attached instead. If the
4881	changes made to the machine settings (including this indirect
4882	attachment) are later cancelled using <link to="#discardSettings"/>,
4883	this implicitly created differencing medium will implicitly
4884	be deleted.
4885	</note>
4886
4887	<result name="E_INVALIDARG">
4888	SATA device, SATA port, IDE port or IDE slot out of range.
4889	</result>
4890	<result name="VBOX_E_INVALID_OBJECT_STATE">
4891	Attempt to attach medium to an unregistered virtual machine.
4892	</result>
4893	<result name="VBOX_E_INVALID_VM_STATE">
4894	Invalid machine state.
4895	</result>
4896	<result name="VBOX_E_OBJECT_IN_USE">
4897	Hard disk already attached to this or another virtual machine.
4898	</result>
4899
4900	</desc>
4901	<param name="name" type="wstring" dir="in">
4902	<desc>Name of the storage controller to attach the device to.</desc>
4903	</param>
4904	<param name="controllerPort" type="long" dir="in">
4905	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4906	the primary controller and 1 specifies the secondary controller.
4907	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4908	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4909	</param>
4910	<param name="device" type="long" dir="in">
4911	<desc>Device slot in the given port to attach the device to. This is only
4912	relevant for IDE controllers, for which 0 specifies the master device and
4913	1 specifies the slave device. For all other controller types, this must
4914	be 0.</desc>
4915	</param>
4916	<param name="type" type="DeviceType" dir="in">
4917	<desc>Device type of the attached device.</desc>
4918	</param>
4919	<param name="id" type="uuid" mod="string" dir="in">
4920	<desc>UUID of the medium to mount. Zero UUID means do not mount any
4921	medium.</desc>
4922	</param>
4923	</method>
4924
4925	<method name="detachDevice">
4926	<desc>
4927	Detaches the device attached to a device slot of the specified bus.
4928
4929	Detaching the device from the virtual machine is deferred. This means
4930	that the medium remains associated with the machine when this method
4931	returns and gets actually de-associated only after a successful
4932	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4933	for more detailed information about attaching media.
4934
4935	<note>
4936	You cannot detach a device from a running machine.
4937	</note>
4938	<note>
4939	Detaching differencing media implicitly created by <link
4940	to="#attachDevice"/> for the indirect attachment using this
4941	method will <b>not</b> implicitly delete them. The
4942	<link to="IMedium::deleteStorage"/> operation should be
4943	explicitly performed by the caller after the medium is successfully
4944	detached and the settings are saved with
4945	<link to="#saveSettings"/>, if it is the desired action.
4946	</note>
4947
4948	<result name="VBOX_E_INVALID_VM_STATE">
4949	Attempt to detach medium from a running virtual machine.
4950	</result>
4951	<result name="VBOX_E_OBJECT_NOT_FOUND">
4952	No medium attached to given slot/bus.
4953	</result>
4954	<result name="VBOX_E_NOT_SUPPORTED">
4955	Medium format does not support storage deletion.
4956	</result>
4957
4958	</desc>
4959	<param name="name" type="wstring" dir="in">
4960	<desc>Name of the storage controller to detach the medium from.</desc>
4961	</param>
4962	<param name="controllerPort" type="long" dir="in">
4963	<desc>Port number to detach the medium from.</desc>
4964	</param>
4965	<param name="device" type="long" dir="in">
4966	<desc>Device slot number to detach the medium from.</desc>
4967	</param>
4968	</method>
4969
4970	<method name="passthroughDevice">
4971	<desc>
4972	Sets the passthrough mode of an existing DVD device. Changing the
4973	setting while the VM is running is forbidden. The setting is only used
4974	if at VM start the device is configured as a host DVD drive, in all
4975	other cases it is ignored. The device must already exist; see
4976	<link to="IMachine::attachDevice"/> for how to attach a new device.
4977
4978	The @a controllerPort and @a device parameters specify the device slot and
4979	have have the same meaning as with <link to="IMachine::attachDevice" />.
4980
4981	<result name="E_INVALIDARG">
4982	SATA device, SATA port, IDE port or IDE slot out of range.
4983	</result>
4984	<result name="VBOX_E_INVALID_OBJECT_STATE">
4985	Attempt to modify an unregistered virtual machine.
4986	</result>
4987	<result name="VBOX_E_INVALID_VM_STATE">
4988	Invalid machine state.
4989	</result>
4990
4991	</desc>
4992	<param name="name" type="wstring" dir="in">
4993	<desc>Name of the storage controller.</desc>
4994	</param>
4995	<param name="controllerPort" type="long" dir="in">
4996	<desc>Storage controller port.</desc>
4997	</param>
4998	<param name="device" type="long" dir="in">
4999	<desc>Device slot in the given port.</desc>
5000	</param>
5001	<param name="passthrough" type="boolean" dir="in">
5002	<desc>New value for the passthrough setting.</desc>
5003	</param>
5004	</method>
5005
5006	<method name="mountMedium">
5007	<desc>
5008	Mounts a medium (<link to="IMedium" />, identified
5009	by the given UUID @a id) to the given storage controller
5010	(<link to="IStorageController" />, identified by @a name),
5011	at the indicated port and device. The device must already exist;
5012	see <link to="IMachine::attachDevice"/> for how to attach a new device.
5013
5014	This method is intended only for managing removable media, where the
5015	device is fixed but media is changeable at runtime (such as DVDs
5016	and floppies). It cannot be used for fixed media such as hard disks.
5017
5018	The @a controllerPort and @a device parameters specify the device slot and
5019	have have the same meaning as with <link to="IMachine::attachDevice" />.
5020
5021	The specified device slot can have a medium mounted, which will be
5022	unmounted first. Specifying a zero UUID (or an empty string) for
5023	@a medium does just an unmount.
5024
5025	See <link to="IMedium"/> for more detailed information about
5026	attaching media.
5027
5028	<result name="E_INVALIDARG">
5029	SATA device, SATA port, IDE port or IDE slot out of range.
5030	</result>
5031	<result name="VBOX_E_INVALID_OBJECT_STATE">
5032	Attempt to attach medium to an unregistered virtual machine.
5033	</result>
5034	<result name="VBOX_E_INVALID_VM_STATE">
5035	Invalid machine state.
5036	</result>
5037	<result name="VBOX_E_OBJECT_IN_USE">
5038	Medium already attached to this or another virtual machine.
5039	</result>
5040
5041	</desc>
5042	<param name="name" type="wstring" dir="in">
5043	<desc>Name of the storage controller to attach the medium to.</desc>
5044	</param>
5045	<param name="controllerPort" type="long" dir="in">
5046	<desc>Port to attach the medium to.</desc>
5047	</param>
5048	<param name="device" type="long" dir="in">
5049	<desc>Device slot in the given port to attach the medium to.</desc>
5050	</param>
5051	<param name="medium" type="uuid" mod="string" dir="in">
5052	<desc>UUID of the medium to attach. A zero UUID means unmount the
5053	currently mounted medium.</desc>
5054	</param>
5055	<param name="force" type="boolean" dir="in">
5056	<desc>Allows to force unmount/mount of a medium which is locked by
5057	theDevice slot in the given port to attach the medium to.</desc>
5058	</param>
5059	</method>
5060
5061	<method name="getMedium" const="yes">
5062	<desc>
5063	Returns the virtual medium attached to a device slot of the specified
5064	bus.
5065
5066	Note that if the medium was indirectly attached by
5067	<link to="#mountMedium"/> to the given device slot then this
5068	method will return not the same object as passed to the
5069	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5070	more detailed information about mounting a medium.
5071
5072	<result name="VBOX_E_OBJECT_NOT_FOUND">
5073	No medium attached to given slot/bus.
5074	</result>
5075
5076	</desc>
5077	<param name="name" type="wstring" dir="in">
5078	<desc>Name of the storage controller the medium is attached to.</desc>
5079	</param>
5080	<param name="controllerPort" type="long" dir="in">
5081	<desc>Port to query.</desc>
5082	</param>
5083	<param name="device" type="long" dir="in">
5084	<desc>Device slot in the given port to query.</desc>
5085	</param>
5086	<param name="medium" type="IMedium" dir="return">
5087	<desc>Attached medium object.</desc>
5088	</param>
5089	</method>
5090
5091	<method name="getMediumAttachmentsOfController" const="yes">
5092	<desc>
5093	Returns an array of medium attachments which are attached to the
5094	the controller with the given name.
5095
5096	<result name="VBOX_E_OBJECT_NOT_FOUND">
5097	A storage controller with given name doesn't exist.
5098	</result>
5099	</desc>
5100	<param name="name" type="wstring" dir="in"/>
5101	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5102	</method>
5103
5104	<method name="getMediumAttachment" const="yes">
5105	<desc>
5106	Returns a medium attachment which corresponds to the controller with
5107	the given name, on the given port and device slot.
5108
5109	<result name="VBOX_E_OBJECT_NOT_FOUND">
5110	No attachment exists for the given controller/port/device combination.
5111	</result>
5112	</desc>
5113	<param name="name" type="wstring" dir="in"/>
5114	<param name="controllerPort" type="long" dir="in"/>
5115	<param name="device" type="long" dir="in"/>
5116	<param name="attachment" type="IMediumAttachment" dir="return"/>
5117	</method>
5118
5119	<method name="getNetworkAdapter" const="yes">
5120	<desc>
5121	Returns the network adapter associated with the given slot.
5122	Slots are numbered sequentially, starting with zero. The total
5123	number of adapters per machine is defined by the
5124	<link to="ISystemProperties::networkAdapterCount"/> property,
5125	so the maximum slot number is one less than that property's value.
5126
5127	<result name="E_INVALIDARG">
5128	Invalid @a slot number.
5129	</result>
5130
5131	</desc>
5132	<param name="slot" type="unsigned long" dir="in"/>
5133	<param name="adapter" type="INetworkAdapter" dir="return"/>
5134	</method>
5135
5136	<method name="addStorageController">
5137	<desc>
5138	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5139	machine and returns it as an instance of
5140	<link to="IStorageController" />.
5141
5142	@a name identifies the controller for subsequent calls such as
5143	<link to="#getStorageControllerByName" />,
5144	<link to="#getStorageControllerByInstance" />,
5145	<link to="#removeStorageController" />,
5146	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5147
5148	After the controller has been added, you can set its exact
5149	type by setting the <link to="IStorageController::controllerType" />.
5150
5151	<result name="VBOX_E_OBJECT_IN_USE">
5152	A storage controller with given name exists already.
5153	</result>
5154	<result name="E_INVALIDARG">
5155	Invalid @a controllerType.
5156	</result>
5157	</desc>
5158	<param name="name" type="wstring" dir="in"/>
5159	<param name="connectionType" type="StorageBus" dir="in"/>
5160	<param name="controller" type="IStorageController" dir="return"/>
5161	</method>
5162
5163	<method name="getStorageControllerByName" const="yes">
5164	<desc>
5165	Returns a storage controller with the given name.
5166
5167	<result name="VBOX_E_OBJECT_NOT_FOUND">
5168	A storage controller with given name doesn't exist.
5169	</result>
5170	</desc>
5171	<param name="name" type="wstring" dir="in"/>
5172	<param name="storageController" type="IStorageController" dir="return"/>
5173	</method>
5174
5175	<method name="getStorageControllerByInstance" const="yes">
5176	<desc>
5177	Returns a storage controller with the given instance number.
5178
5179	<result name="VBOX_E_OBJECT_NOT_FOUND">
5180	A storage controller with given instance number doesn't exist.
5181	</result>
5182	</desc>
5183	<param name="instance" type="unsigned long" dir="in"/>
5184	<param name="storageController" type="IStorageController" dir="return"/>
5185	</method>
5186
5187	<method name="removeStorageController">
5188	<desc>
5189	Removes a storage controller from the machine.
5190
5191	<result name="VBOX_E_OBJECT_NOT_FOUND">
5192	A storage controller with given name doesn't exist.
5193	</result>
5194	</desc>
5195	<param name="name" type="wstring" dir="in"/>
5196	</method>
5197
5198	<method name="getSerialPort" const="yes">
5199	<desc>
5200	Returns the serial port associated with the given slot.
5201	Slots are numbered sequentially, starting with zero. The total
5202	number of serial ports per machine is defined by the
5203	<link to="ISystemProperties::serialPortCount"/> property,
5204	so the maximum slot number is one less than that property's value.
5205
5206	<result name="E_INVALIDARG">
5207	Invalid @a slot number.
5208	</result>
5209
5210	</desc>
5211	<param name="slot" type="unsigned long" dir="in"/>
5212	<param name="port" type="ISerialPort" dir="return"/>
5213	</method>
5214
5215	<method name="getParallelPort" const="yes">
5216	<desc>
5217	Returns the parallel port associated with the given slot.
5218	Slots are numbered sequentially, starting with zero. The total
5219	number of parallel ports per machine is defined by the
5220	<link to="ISystemProperties::parallelPortCount"/> property,
5221	so the maximum slot number is one less than that property's value.
5222
5223	<result name="E_INVALIDARG">
5224	Invalid @a slot number.
5225	</result>
5226
5227	</desc>
5228	<param name="slot" type="unsigned long" dir="in"/>
5229	<param name="port" type="IParallelPort" dir="return"/>
5230	</method>
5231
5232	<method name="getExtraDataKeys">
5233	<desc>
5234	Returns an array representing the machine-specific extra data keys
5235	which currently have values defined.
5236	</desc>
5237	<param name="value" type="wstring" dir="return" safearray="yes">
5238	<desc>Array of extra data keys.</desc>
5239	</param>
5240	</method>
5241
5242	<method name="getExtraData">
5243	<desc>
5244	Returns associated machine-specific extra data.
5245
5246	If the requested data @a key does not exist, this function will
5247	succeed and return an empty string in the @a value argument.
5248
5249	<result name="VBOX_E_FILE_ERROR">
5250	Settings file not accessible.
5251	</result>
5252	<result name="VBOX_E_XML_ERROR">
5253	Could not parse the settings file.
5254	</result>
5255
5256	</desc>
5257	<param name="key" type="wstring" dir="in">
5258	<desc>Name of the data key to get.</desc>
5259	</param>
5260	<param name="value" type="wstring" dir="return">
5261	<desc>Value of the requested data key.</desc>
5262	</param>
5263	</method>
5264
5265	<method name="setExtraData">
5266	<desc>
5267	Sets associated machine-specific extra data.
5268
5269	If you pass @c null or an empty string as a key @a value, the given
5270	@a key will be deleted.
5271
5272	<note>
5273	Before performing the actual data change, this method will ask all
5274	registered callbacks using the
5275	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
5276	notification for a permission. If one of the callbacks refuses the
5277	new value, the change will not be performed.
5278	</note>
5279	<note>
5280	On success, the
5281	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
5282	is called to inform all registered callbacks about a successful data
5283	change.
5284	</note>
5285	<note>
5286	This method can be called outside the machine session and therefore
5287	it's a caller's responsibility to handle possible race conditions
5288	when several clients change the same key at the same time.
5289	</note>
5290
5291	<result name="VBOX_E_FILE_ERROR">
5292	Settings file not accessible.
5293	</result>
5294	<result name="VBOX_E_XML_ERROR">
5295	Could not parse the settings file.
5296	</result>
5297
5298	</desc>
5299	<param name="key" type="wstring" dir="in">
5300	<desc>Name of the data key to set.</desc>
5301	</param>
5302	<param name="value" type="wstring" dir="in">
5303	<desc>Value to assign to the key.</desc>
5304	</param>
5305	</method>
5306
5307	<method name="getCPUProperty" const="yes">
5308	<desc>
5309	Returns the virtual CPU boolean value of the specified property.
5310
5311	<result name="E_INVALIDARG">
5312	Invalid property.
5313	</result>
5314
5315	</desc>
5316	<param name="property" type="CPUPropertyType" dir="in">
5317	<desc>
5318	Property type to query.
5319	</desc>
5320	</param>
5321	<param name="value" type="boolean" dir="return">
5322	<desc>
5323	Property value.
5324	</desc>
5325	</param>
5326	</method>
5327
5328	<method name="setCPUProperty">
5329	<desc>
5330	Sets the virtual CPU boolean value of the specified property.
5331
5332	<result name="E_INVALIDARG">
5333	Invalid property.
5334	</result>
5335
5336	</desc>
5337	<param name="property" type="CPUPropertyType" dir="in">
5338	<desc>
5339	Property type to query.
5340	</desc>
5341	</param>
5342	<param name="value" type="boolean" dir="in">
5343	<desc>
5344	Property value.
5345	</desc>
5346	</param>
5347	</method>
5348
5349	<method name="getCPUIDLeaf" const="yes">
5350	<desc>
5351	Returns the virtual CPU cpuid information for the specified leaf.
5352
5353	Currently supported index values for cpuid:
5354	Standard CPUID leafs: 0 - 0xA
5355	Extended CPUID leafs: 0x80000000 - 0x8000000A
5356
5357	See the Intel and AMD programmer's manuals for detailed information
5358	about the cpuid instruction and its leafs.
5359	<result name="E_INVALIDARG">
5360	Invalid id.
5361	</result>
5362
5363	</desc>
5364	<param name="id" type="unsigned long" dir="in">
5365	<desc>
5366	CPUID leaf index.
5367	</desc>
5368	</param>
5369	<param name="valEax" type="unsigned long" dir="out">
5370	<desc>
5371	CPUID leaf value for register eax.
5372	</desc>
5373	</param>
5374	<param name="valEbx" type="unsigned long" dir="out">
5375	<desc>
5376	CPUID leaf value for register ebx.
5377	</desc>
5378	</param>
5379	<param name="valEcx" type="unsigned long" dir="out">
5380	<desc>
5381	CPUID leaf value for register ecx.
5382	</desc>
5383	</param>
5384	<param name="valEdx" type="unsigned long" dir="out">
5385	<desc>
5386	CPUID leaf value for register edx.
5387	</desc>
5388	</param>
5389	</method>
5390
5391	<method name="setCPUIDLeaf">
5392	<desc>
5393	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5394	are not passed unmodified. VirtualBox clears features that it doesn't support.
5395
5396	Currently supported index values for cpuid:
5397	Standard CPUID leafs: 0 - 0xA
5398	Extended CPUID leafs: 0x80000000 - 0x8000000A
5399
5400	See the Intel and AMD programmer's manuals for detailed information
5401	about the cpuid instruction and its leafs.
5402
5403	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5404	random crashes inside VMs.
5405	<result name="E_INVALIDARG">
5406	Invalid id.
5407	</result>
5408
5409	</desc>
5410	<param name="id" type="unsigned long" dir="in">
5411	<desc>
5412	CPUID leaf index.
5413	</desc>
5414	</param>
5415	<param name="valEax" type="unsigned long" dir="in">
5416	<desc>
5417	CPUID leaf value for register eax.
5418	</desc>
5419	</param>
5420	<param name="valEbx" type="unsigned long" dir="in">
5421	<desc>
5422	CPUID leaf value for register ebx.
5423	</desc>
5424	</param>
5425	<param name="valEcx" type="unsigned long" dir="in">
5426	<desc>
5427	CPUID leaf value for register ecx.
5428	</desc>
5429	</param>
5430	<param name="valEdx" type="unsigned long" dir="in">
5431	<desc>
5432	CPUID leaf value for register edx.
5433	</desc>
5434	</param>
5435	</method>
5436
5437	<method name="removeCPUIDLeaf">
5438	<desc>
5439	Removes the virtual CPU cpuid leaf for the specified index
5440
5441	<result name="E_INVALIDARG">
5442	Invalid id.
5443	</result>
5444
5445	</desc>
5446	<param name="id" type="unsigned long" dir="in">
5447	<desc>
5448	CPUID leaf index.
5449	</desc>
5450	</param>
5451	</method>
5452
5453	<method name="removeAllCPUIDLeaves">
5454	<desc>
5455	Removes all the virtual CPU cpuid leaves
5456	</desc>
5457	</method>
5458
5459	<method name="getHWVirtExProperty" const="yes">
5460	<desc>
5461	Returns the value of the specified hardware virtualization boolean property.
5462
5463	<result name="E_INVALIDARG">
5464	Invalid property.
5465	</result>
5466
5467	</desc>
5468	<param name="property" type="HWVirtExPropertyType" dir="in">
5469	<desc>
5470	Property type to query.
5471	</desc>
5472	</param>
5473	<param name="value" type="boolean" dir="return">
5474	<desc>
5475	Property value.
5476	</desc>
5477	</param>
5478	</method>
5479
5480	<method name="setHWVirtExProperty">
5481	<desc>
5482	Sets a new value for the specified hardware virtualization boolean property.
5483
5484	<result name="E_INVALIDARG">
5485	Invalid property.
5486	</result>
5487
5488	</desc>
5489	<param name="property" type="HWVirtExPropertyType" dir="in">
5490	<desc>
5491	Property type to set.
5492	</desc>
5493	</param>
5494	<param name="value" type="boolean" dir="in">
5495	<desc>
5496	New property value.
5497	</desc>
5498	</param>
5499	</method>
5500
5501	<method name="saveSettings">
5502	<desc>
5503	Saves any changes to machine settings made since the session
5504	has been opened or a new machine has been created, or since the
5505	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5506	For registered machines, new settings become visible to all
5507	other VirtualBox clients after successful invocation of this
5508	method.
5509	<note>
5510	The method sends <link to="IVirtualBoxCallback::onMachineDataChange"/>
5511	notification event after the configuration has been successfully
5512	saved (only for registered machines).
5513	</note>
5514	<note>
5515	Calling this method is only valid on instances returned
5516	by <link to="ISession::machine"/> and on new machines
5517	created by <link to="IVirtualBox::createMachine"/> but not
5518	yet registered, or on unregistered machines after calling
5519	<link to="IVirtualBox::unregisterMachine"/>.
5520	</note>
5521
5522	<result name="VBOX_E_FILE_ERROR">
5523	Settings file not accessible.
5524	</result>
5525	<result name="VBOX_E_XML_ERROR">
5526	Could not parse the settings file.
5527	</result>
5528	<result name="E_ACCESSDENIED">
5529	Modification request refused.
5530	</result>
5531
5532	</desc>
5533	</method>
5534
5535	<method name="discardSettings">
5536	<desc>
5537	Discards any changes to the machine settings made since the session
5538	has been opened or since the last call to <link to="#saveSettings"/>
5539	or <link to="#discardSettings"/>.
5540	<note>
5541	Calling this method is only valid on instances returned
5542	by <link to="ISession::machine"/> and on new machines
5543	created by <link to="IVirtualBox::createMachine"/> or
5544	opened by <link to="IVirtualBox::openMachine"/> but not
5545	yet registered, or on unregistered machines after calling
5546	<link to="IVirtualBox::unregisterMachine"/>.
5547	</note>
5548
5549	<result name="VBOX_E_INVALID_VM_STATE">
5550	Virtual machine is not mutable.
5551	</result>
5552
5553	</desc>
5554	</method>
5555
5556	<method name="deleteSettings">
5557	<desc>
5558	Deletes the settings file of this machine from disk.
5559	The machine must not be registered in order for this operation
5560	to succeed.
5561	<note>
5562	<link to="#settingsModified"/> will return @c true after this
5563	method successfully returns.
5564	</note>
5565	<note>
5566	Calling this method is only valid on instances returned
5567	by <link to="ISession::machine"/> and on new machines
5568	created by <link to="IVirtualBox::createMachine"/> or
5569	opened by <link to="IVirtualBox::openMachine"/> but not
5570	yet registered, or on unregistered machines after calling
5571	<link to="IVirtualBox::unregisterMachine"/>.
5572	</note>
5573	<note>
5574	The deleted machine settings file can be restored (saved again)
5575	by calling <link to="#saveSettings"/>.
5576	</note>
5577
5578	<result name="VBOX_E_INVALID_VM_STATE">
5579	Cannot delete settings of a registered machine or
5580	machine not mutable.
5581	</result>
5582	<result name="VBOX_E_IPRT_ERROR">
5583	Could not delete the settings file.
5584	</result>
5585
5586	</desc>
5587	</method>
5588
5589	<method name="export">
5590	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5591	steps required to export VirtualBox machines to OVF.
5592	</desc>
5593
5594	<param name="aAppliance" type="IAppliance" dir="in">
5595	<desc>Appliance to export this machine to.</desc>
5596	</param>
5597	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5598	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5599	</param>
5600	</method >
5601
5602	<method name="getSnapshot">
5603	<desc>
5604	Returns a snapshot of this machine with the given UUID.
5605	A @c null UUID can be used to obtain the first snapshot
5606	taken on this machine. This is useful if you want to traverse
5607	the whole tree of snapshots starting from the root.
5608
5609	<result name="VBOX_E_OBJECT_NOT_FOUND">
5610	Virtual machine has no snapshots or snapshot not found.
5611	</result>
5612
5613	</desc>
5614	<param name="id" type="uuid" mod="string" dir="in">
5615	<desc>UUID of the snapshot to get</desc>
5616	</param>
5617	<param name="snapshot" type="ISnapshot" dir="return">
5618	<desc>Snapshot object with the given UUID.</desc>
5619	</param>
5620	</method>
5621
5622	<method name="findSnapshot">
5623	<desc>
5624	Returns a snapshot of this machine with the given name.
5625
5626	<result name="VBOX_E_OBJECT_NOT_FOUND">
5627	Virtual machine has no snapshots or snapshot not found.
5628	</result>
5629
5630	</desc>
5631	<param name="name" type="wstring" dir="in">
5632	<desc>Name of the snapshot to find</desc>
5633	</param>
5634	<param name="snapshot" type="ISnapshot" dir="return">
5635	<desc>Snapshot object with the given name.</desc>
5636	</param>
5637	</method>
5638
5639	<method name="setCurrentSnapshot">
5640	<desc>
5641	Sets the current snapshot of this machine.
5642	<note>
5643	In the current implementation, this operation is not
5644	implemented.
5645	</note>
5646	</desc>
5647	<param name="id" type="uuid" mod="string" dir="in">
5648	<desc>UUID of the snapshot to set as the current snapshot.</desc>
5649	</param>
5650	</method>
5651
5652	<method name="createSharedFolder">
5653	<desc>
5654	Creates a new permanent shared folder by associating the given logical
5655	name with the given host path, adds it to the collection of shared
5656	folders and starts sharing it. Refer to the description of
5657	<link to="ISharedFolder"/> to read more about logical names.
5658
5659	<result name="VBOX_E_OBJECT_IN_USE">
5660	Shared folder already exists.
5661	</result>
5662	<result name="VBOX_E_FILE_ERROR">
5663	Shared folder @a hostPath not accessible.
5664	</result>
5665
5666	</desc>
5667	<param name="name" type="wstring" dir="in">
5668	<desc>Unique logical name of the shared folder.</desc>
5669	</param>
5670	<param name="hostPath" type="wstring" dir="in">
5671	<desc>Full path to the shared folder in the host file system.</desc>
5672	</param>
5673	<param name="writable" type="boolean" dir="in">
5674	<desc>Whether the share is writable or readonly</desc>
5675	</param>
5676	</method>
5677
5678	<method name="removeSharedFolder">
5679	<desc>
5680	Removes the permanent shared folder with the given name previously
5681	created by <link to="#createSharedFolder"/> from the collection of
5682	shared folders and stops sharing it.
5683
5684	<result name="VBOX_E_INVALID_VM_STATE">
5685	Virtual machine is not mutable.
5686	</result>
5687	<result name="VBOX_E_OBJECT_NOT_FOUND">
5688	Shared folder @a name does not exist.
5689	</result>
5690
5691	</desc>
5692	<param name="name" type="wstring" dir="in">
5693	<desc>Logical name of the shared folder to remove.</desc>
5694	</param>
5695	</method>
5696
5697	<method name="canShowConsoleWindow">
5698	<desc>
5699	Returns @c true if the VM console process can activate the
5700	console window and bring it to foreground on the desktop of
5701	the host PC.
5702	<note>
5703	This method will fail if a session for this machine is not
5704	currently open.
5705	</note>
5706
5707	<result name="VBOX_E_INVALID_VM_STATE">
5708	Machine session is not open.
5709	</result>
5710
5711	</desc>
5712	<param name="canShow" type="boolean" dir="return">
5713	<desc>
5714	@c true if the console window can be shown and @c false otherwise.
5715	</desc>
5716	</param>
5717	</method>
5718
5719	<method name="showConsoleWindow">
5720	<desc>
5721	Activates the console window and brings it to foreground on
5722	the desktop of the host PC. Many modern window managers on
5723	many platforms implement some sort of focus stealing
5724	prevention logic, so that it may be impossible to activate
5725	a window without the help of the currently active
5726	application. In this case, this method will return a non-zero
5727	identifier that represents the top-level window of the VM
5728	console process. The caller, if it represents a currently
5729	active process, is responsible to use this identifier (in a
5730	platform-dependent manner) to perform actual window
5731	activation.
5732	<note>
5733	This method will fail if a session for this machine is not
5734	currently open.
5735	</note>
5736
5737	<result name="VBOX_E_INVALID_VM_STATE">
5738	Machine session is not open.
5739	</result>
5740
5741	</desc>
5742	<param name="winId" type="unsigned long long" dir="return">
5743	<desc>
5744	Platform-dependent identifier of the top-level VM console
5745	window, or zero if this method has performed all actions
5746	necessary to implement the <i>show window</i> semantics for
5747	the given platform and/or VirtualBox front-end.
5748	</desc>
5749	</param>
5750	</method>
5751
5752	<method name="getGuestProperty" const="yes">
5753	<desc>
5754	Reads an entry from the machine's guest property store.
5755
5756	<result name="VBOX_E_INVALID_VM_STATE">
5757	Machine session is not open.
5758	</result>
5759
5760	</desc>
5761	<param name="name" type="wstring" dir="in">
5762	<desc>
5763	The name of the property to read.
5764	</desc>
5765	</param>
5766	<param name="value" type="wstring" dir="out">
5767	<desc>
5768	The value of the property. If the property does not exist then this
5769	will be empty.
5770	</desc>
5771	</param>
5772	<param name="timestamp" type="unsigned long long" dir="out">
5773	<desc>
5774	The time at which the property was last modified, as seen by the
5775	server process.
5776	</desc>
5777	</param>
5778	<param name="flags" type="wstring" dir="out">
5779	<desc>
5780	Additional property parameters, passed as a comma-separated list of
5781	"name=value" type entries.
5782	</desc>
5783	</param>
5784	</method>
5785
5786	<method name="getGuestPropertyValue" const="yes">
5787	<desc>
5788	Reads a value from the machine's guest property store.
5789
5790	<result name="VBOX_E_INVALID_VM_STATE">
5791	Machine session is not open.
5792	</result>
5793
5794	</desc>
5795	<param name="property" type="wstring" dir="in">
5796	<desc>
5797	The name of the property to read.
5798	</desc>
5799	</param>
5800	<param name="value" type="wstring" dir="return">
5801	<desc>
5802	The value of the property. If the property does not exist then this
5803	will be empty.
5804	</desc>
5805	</param>
5806	</method>
5807
5808	<method name="getGuestPropertyTimestamp" const="yes">
5809	<desc>
5810	Reads a property timestamp from the machine's guest property store.
5811
5812	<result name="VBOX_E_INVALID_VM_STATE">
5813	Machine session is not open.
5814	</result>
5815
5816	</desc>
5817	<param name="property" type="wstring" dir="in">
5818	<desc>
5819	The name of the property to read.
5820	</desc>
5821	</param>
5822	<param name="value" type="unsigned long long" dir="return">
5823	<desc>
5824	The timestamp. If the property does not exist then this will be
5825	empty.
5826	</desc>
5827	</param>
5828	</method>
5829
5830	<method name="setGuestProperty">
5831	<desc>
5832	Sets, changes or deletes an entry in the machine's guest property
5833	store.
5834
5835	<result name="E_ACCESSDENIED">
5836	Property cannot be changed.
5837	</result>
5838	<result name="E_INVALIDARG">
5839	Invalid @a flags.
5840	</result>
5841	<result name="VBOX_E_INVALID_VM_STATE">
5842	Virtual machine is not mutable or session not open.
5843	</result>
5844	<result name="VBOX_E_INVALID_OBJECT_STATE">
5845	Cannot set transient property when machine not running.
5846	</result>
5847
5848	</desc>
5849	<param name="property" type="wstring" dir="in">
5850	<desc>
5851	The name of the property to set, change or delete.
5852	</desc>
5853	</param>
5854	<param name="value" type="wstring" dir="in">
5855	<desc>
5856	The new value of the property to set, change or delete. If the
5857	property does not yet exist and value is non-empty, it will be
5858	created. If the value is @c null or empty, the property will be
5859	deleted if it exists.
5860	</desc>
5861	</param>
5862	<param name="flags" type="wstring" dir="in">
5863	<desc>
5864	Additional property parameters, passed as a comma-separated list of
5865	"name=value" type entries.
5866	</desc>
5867	</param>
5868	</method>
5869
5870	<method name="setGuestPropertyValue">
5871	<desc>
5872	Sets, changes or deletes a value in the machine's guest property
5873	store. The flags field will be left unchanged or created empty for a
5874	new property.
5875
5876	<result name="E_ACCESSDENIED">
5877	Property cannot be changed.
5878	</result>
5879	<result name="VBOX_E_INVALID_VM_STATE">
5880	Virtual machine is not mutable or session not open.
5881	</result>
5882	<result name="VBOX_E_INVALID_OBJECT_STATE">
5883	Cannot set transient property when machine not running.
5884	</result>
5885	</desc>
5886
5887	<param name="property" type="wstring" dir="in">
5888	<desc>
5889	The name of the property to set, change or delete.
5890	</desc>
5891	</param>
5892	<param name="value" type="wstring" dir="in">
5893	<desc>
5894	The new value of the property to set, change or delete. If the
5895	property does not yet exist and value is non-empty, it will be
5896	created. If the value is @c null or empty, the property will be
5897	deleted if it exists.
5898	</desc>
5899	</param>
5900	</method>
5901
5902	<method name="enumerateGuestProperties">
5903	<desc>
5904	Return a list of the guest properties matching a set of patterns along
5905	with their values, time stamps and flags.
5906	</desc>
5907	<param name="patterns" type="wstring" dir="in">
5908	<desc>
5909	The patterns to match the properties against, separated by '\|'
5910	characters. If this is empty or @c null, all properties will match.
5911	</desc>
5912	</param>
5913	<param name="name" type="wstring" dir="out" safearray="yes">
5914	<desc>
5915	The names of the properties returned.
5916	</desc>
5917	</param>
5918	<param name="value" type="wstring" dir="out" safearray="yes">
5919	<desc>
5920	The values of the properties returned. The array entries match the
5921	corresponding entries in the @a name array.
5922	</desc>
5923	</param>
5924	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
5925	<desc>
5926	The time stamps of the properties returned. The array entries match
5927	the corresponding entries in the @a name array.
5928	</desc>
5929	</param>
5930	<param name="flags" type="wstring" dir="out" safearray="yes">
5931	<desc>
5932	The flags of the properties returned. The array entries match the
5933	corresponding entries in the @a name array.
5934	</desc>
5935	</param>
5936	</method>
5937
5938	<method name="querySavedThumbnailSize">
5939	<desc>
5940	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5941	</desc>
5942	<param name="screenId" type="unsigned long" dir="in">
5943	<desc>
5944	Saved guest screen to query info from.
5945	</desc>
5946	</param>
5947	<param name="size" type="unsigned long" dir="out">
5948	<desc>
5949	Size of buffer required to store the bitmap.
5950	</desc>
5951	</param>
5952	<param name="width" type="unsigned long" dir="out">
5953	<desc>
5954	Bitmap width.
5955	</desc>
5956	</param>
5957	<param name="height" type="unsigned long" dir="out">
5958	<desc>
5959	Bitmap height.
5960	</desc>
5961	</param>
5962	</method>
5963
5964	<method name="readSavedThumbnailToArray">
5965	<desc>
5966	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5967	</desc>
5968	<param name="screenId" type="unsigned long" dir="in">
5969	<desc>
5970	Saved guest screen to read from.
5971	</desc>
5972	</param>
5973	<param name="BGR" type="boolean" dir="in">
5974	<desc>
5975	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5976	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5977	</desc>
5978	</param>
5979	<param name="width" type="unsigned long" dir="out">
5980	<desc>
5981	Bitmap width.
5982	</desc>
5983	</param>
5984	<param name="height" type="unsigned long" dir="out">
5985	<desc>
5986	Bitmap height.
5987	</desc>
5988	</param>
5989	<param name="data" type="octet" dir="return" safearray="yes">
5990	<desc>
5991	Array with resulting bitmap data.
5992	</desc>
5993	</param>
5994	</method>
5995
5996	<method name="querySavedScreenshotPNGSize">
5997	<desc>
5998	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5999	</desc>
6000	<param name="screenId" type="unsigned long" dir="in">
6001	<desc>
6002	Saved guest screen to query info from.
6003	</desc>
6004	</param>
6005	<param name="size" type="unsigned long" dir="out">
6006	<desc>
6007	Size of buffer required to store the PNG binary data.
6008	</desc>
6009	</param>
6010	<param name="width" type="unsigned long" dir="out">
6011	<desc>
6012	Image width.
6013	</desc>
6014	</param>
6015	<param name="height" type="unsigned long" dir="out">
6016	<desc>
6017	Image height.
6018	</desc>
6019	</param>
6020	</method>
6021
6022	<method name="readSavedScreenshotPNGToArray">
6023	<desc>
6024	Screenshot in PNG format is retrieved to an array of bytes.
6025	</desc>
6026	<param name="screenId" type="unsigned long" dir="in">
6027	<desc>
6028	Saved guest screen to read from.
6029	</desc>
6030	</param>
6031	<param name="width" type="unsigned long" dir="out">
6032	<desc>
6033	Image width.
6034	</desc>
6035	</param>
6036	<param name="height" type="unsigned long" dir="out">
6037	<desc>
6038	Image height.
6039	</desc>
6040	</param>
6041	<param name="data" type="octet" dir="return" safearray="yes">
6042	<desc>
6043	Array with resulting PNG data.
6044	</desc>
6045	</param>
6046	</method>
6047
6048	<method name="hotPlugCPU">
6049	<desc>
6050	Plugs a CPU into the machine.
6051	</desc>
6052	<param name="cpu" type="unsigned long" dir="in">
6053	<desc>
6054	The CPU id to insert.
6055	</desc>
6056	</param>
6057	</method>
6058
6059	<method name="hotUnplugCPU">
6060	<desc>
6061	Removes a CPU from the machine.
6062	</desc>
6063	<param name="cpu" type="unsigned long" dir="in">
6064	<desc>
6065	The CPU id to remove.
6066	</desc>
6067	</param>
6068	</method>
6069
6070	<method name="getCPUStatus">
6071	<desc>
6072	Returns the current status of the given CPU.
6073	</desc>
6074	<param name="cpu" type="unsigned long" dir="in">
6075	<desc>
6076	The CPU id to check for.
6077	</desc>
6078	</param>
6079	<param name="attached" type="boolean" dir="return">
6080	<desc>
6081	Status of the CPU.
6082	</desc>
6083	</param>
6084	</method>
6085
6086	<method name="queryLogFilename">
6087	<desc>
6088	Queries for the VM log file name of an given index. Returns an empty
6089	string if a log file with that index doesn't exists.
6090	</desc>
6091	<param name="idx" type="unsigned long" dir="in">
6092	<desc>
6093	Which log file name to query. 0=current log file.
6094	</desc>
6095	</param>
6096	<param name="filename" type="wstring" dir="return">
6097	<desc>
6098	On return the full path to the log file or an empty string on error.
6099	</desc>
6100	</param>
6101	</method>
6102
6103	<method name="readLog">
6104	<desc>
6105	Reads the VM log file. The chunk size is limited, so even if you
6106	ask for a big piece there might be less data returned.
6107	</desc>
6108	<param name="idx" type="unsigned long" dir="in">
6109	<desc>
6110	Which log file to read. 0=current log file.
6111	</desc>
6112	</param>
6113	<param name="offset" type="unsigned long long" dir="in">
6114	<desc>
6115	Offset in the log file.
6116	</desc>
6117	</param>
6118	<param name="size" type="unsigned long long" dir="in">
6119	<desc>
6120	Chunk size to read in the log file.
6121	</desc>
6122	</param>
6123	<param name="data" type="octet" dir="return" safearray="yes">
6124	<desc>
6125	Data read from the log file. A data size of 0 means end of file
6126	if the requested chunk size was not 0. This is the unprocessed
6127	file data, i.e. the line ending style depends on the platform of
6128	the system the server is running on.
6129	</desc>
6130	</param>
6131	</method>
6132	</interface>
6133
6134	<!--
6135	// IConsole
6136	/////////////////////////////////////////////////////////////////////////
6137	-->
6138
6139	<interface
6140	name="IConsoleCallback" extends="$unknown"
6141	uuid="60703f8d-81e4-4b45-a147-dcfd07692b19"
6142	wsmap="suppress"
6143	>
6144
6145	<desc>
6146	This interface is used by a client of the Main API that need to
6147	be notified of events. For example, a graphical user interface
6148	can use this to learn about machine state changes so they can
6149	update the list of virtual machines without having to rely
6150	on polling.
6151
6152	Whenever relevant events occur in VirtualBox, the callbacks in
6153	objects of this interface are called. In order for this to be
6154	useful, a client needs to create its own subclass that implements
6155	this interface in which the methods for the relevant callbacks
6156	are overridden. An instance of this subclass interface can then
6157	be passed to <link to="IConsole::registerCallback" />.
6158	</desc>
6159
6160	<method name="onMousePointerShapeChange">
6161	<desc>
6162	Notification when the guest mouse pointer shape has
6163	changed. The new shape data is given.
6164	<result name="VBOX_E_DONT_CALL_AGAIN">
6165	Do not call again, this method is a NOP.
6166	</result>
6167	</desc>
6168	<param name="visible" type="boolean" dir="in">
6169	<desc>
6170	Flag whether the pointer is visible.
6171	</desc>
6172	</param>
6173	<param name="alpha" type="boolean" dir="in">
6174	<desc>
6175	Flag whether the pointer has an alpha channel.
6176	</desc>
6177	</param>
6178	<param name="xHot" type="unsigned long" dir="in">
6179	<desc>
6180	The pointer hot spot x coordinate.
6181	</desc>
6182	</param>
6183	<param name="yHot" type="unsigned long" dir="in">
6184	<desc>
6185	The pointer hot spot y coordinate.
6186	</desc>
6187	</param>
6188	<param name="width" type="unsigned long" dir="in">
6189	<desc>
6190	Width of the pointer shape in pixels.
6191	</desc>
6192	</param>
6193	<param name="height" type="unsigned long" dir="in">
6194	<desc>
6195	Height of the pointer shape in pixels.
6196	</desc>
6197	</param>
6198	<param name="shape" type="octet" safearray="yes" dir="in">
6199	<desc>
6200	Shape buffer arrays.
6201
6202	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
6203	followed by a 32-bpp XOR (color) mask.
6204
6205	For pointers without alpha channel the XOR mask pixels are 32
6206	bit values: (lsb)BGR0(msb). For pointers with alpha channel
6207	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
6208
6209	An AND mask is used for pointers with alpha channel, so if the
6210	callback does not support alpha, the pointer could be
6211	displayed as a normal color pointer.
6212
6213	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
6214	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
6215	height</tt>. The padding bits at the end of each scanline are
6216	undefined.
6217
6218	The XOR mask follows the AND mask on the next 4-byte aligned
6219	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
6220	Bytes in the gap between the AND and the XOR mask are undefined.
6221	The XOR mask scanlines have no gap between them and the size of
6222	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
6223
6224	<note>
6225	If @a shape is 0, only the pointer visibility is changed.
6226	</note>
6227	</desc>
6228	</param>
6229	</method>
6230
6231	<method name="onMouseCapabilityChange">
6232	<desc>
6233	Notification when the mouse capabilities reported by the
6234	guest have changed. The new capabilities are passed.
6235	<result name="VBOX_E_DONT_CALL_AGAIN">
6236	Do not call again, this method is a NOP.
6237	</result>
6238	</desc>
6239	<param name="supportsAbsolute" type="boolean" dir="in"/>
6240	<param name="supportsRelative" type="boolean" dir="in"/>
6241	<param name="needsHostCursor" type="boolean" dir="in"/>
6242	</method>
6243
6244	<method name="onKeyboardLedsChange">
6245	<desc>
6246	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
6247	to alter the state of the keyboard LEDs.
6248	<result name="VBOX_E_DONT_CALL_AGAIN">
6249	Do not call again, this method is a NOP.
6250	</result>
6251	</desc>
6252	<param name="numLock" type="boolean" dir="in"/>
6253	<param name="capsLock" type="boolean" dir="in"/>
6254	<param name="scrollLock" type="boolean" dir="in"/>
6255	</method>
6256
6257	<method name="onStateChange">
6258	<desc>
6259	Notification when the execution state of the machine has changed.
6260	The new state will be given.
6261	<result name="VBOX_E_DONT_CALL_AGAIN">
6262	Do not call again, this method is a NOP.
6263	</result>
6264	</desc>
6265	<param name="state" type="MachineState" dir="in"/>
6266	</method>
6267
6268	<method name="onAdditionsStateChange">
6269	<desc>
6270	Notification when a Guest Additions property changes.
6271	Interested callees should query IGuest attributes to
6272	find out what has changed.
6273	</desc>
6274	</method>
6275
6276	<method name="onNetworkAdapterChange">
6277	<desc>
6278	Notification when a property of one of the
6279	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
6280	changes. Interested callees should use INetworkAdapter methods and
6281	attributes to find out what has changed.
6282	<result name="VBOX_E_DONT_CALL_AGAIN">
6283	Do not call again, this method is a NOP.
6284	</result>
6285	</desc>
6286	<param name="networkAdapter" type="INetworkAdapter" dir="in">
6287	<desc>Network adapter that is subject to change.</desc>
6288	</param>
6289	</method>
6290
6291	<method name="onSerialPortChange">
6292	<desc>
6293	Notification when a property of one of the
6294	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
6295	Interested callees should use ISerialPort methods and attributes
6296	to find out what has changed.
6297	<result name="VBOX_E_DONT_CALL_AGAIN">
6298	Do not call again, this method is a NOP.
6299	</result>
6300	</desc>
6301	<param name="serialPort" type="ISerialPort" dir="in">
6302	<desc>Serial port that is subject to change.</desc>
6303	</param>
6304	</method>
6305
6306	<method name="onParallelPortChange">
6307	<desc>
6308	Notification when a property of one of the
6309	virtual <link to="IMachine::getParallelPort">parallel ports</link>
6310	changes. Interested callees should use ISerialPort methods and
6311	attributes to find out what has changed.
6312	<result name="VBOX_E_DONT_CALL_AGAIN">
6313	Do not call again, this method is a NOP.
6314	</result>
6315	</desc>
6316	<param name="parallelPort" type="IParallelPort" dir="in">
6317	<desc>Parallel port that is subject to change.</desc>
6318	</param>
6319	</method>
6320
6321	<method name="onStorageControllerChange">
6322	<desc>
6323	Notification when a property of one of the
6324	virtual <link to="IMachine::storageControllers">storage controllers</link>
6325	changes. Interested callees should query the corresponding collections
6326	to find out what has changed.
6327	<result name="VBOX_E_DONT_CALL_AGAIN">
6328	Do not call again, this method is a NOP.
6329	</result>
6330	</desc>
6331	</method>
6332
6333	<method name="onMediumChange">
6334	<desc>
6335	Notification when a
6336	<link to="IMachine::mediumAttachments">medium attachment</link>
6337	changes.
6338	<result name="VBOX_E_DONT_CALL_AGAIN">
6339	Do not call again, this method is a NOP.
6340	</result>
6341	</desc>
6342	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
6343	<desc>Medium attachment that is subject to change.</desc>
6344	</param>
6345	</method>
6346
6347	<method name="onCPUChange">
6348	<desc>
6349	Notification when a CPU changes.
6350	<result name="VBOX_E_DONT_CALL_AGAIN">
6351	Do not call again, this method is a NOP.
6352	</result>
6353	</desc>
6354	<param name="cpu" type="unsigned long" dir="in">
6355	<desc>The CPU which changed</desc>
6356	</param>
6357	<param name="add" type="boolean" dir="in">
6358	<desc>Flag whether the CPU was added or removed</desc>
6359	</param>
6360	</method>
6361
6362	<method name="onVRDPServerChange">
6363	<desc>
6364	Notification when a property of the
6365	<link to="IMachine::VRDPServer">VRDP server</link> changes.
6366	Interested callees should use IVRDPServer methods and attributes to
6367	find out what has changed.
6368	<result name="VBOX_E_DONT_CALL_AGAIN">
6369	Do not call again, this method is a NOP.
6370	</result>
6371	</desc>
6372	</method>
6373
6374	<method name="onRemoteDisplayInfoChange">
6375	<desc>
6376	Notification when the status of the VRDP server changes. Interested callees
6377	should use <link to="IConsole::RemoteDisplayInfo">IRemoteDisplayInfo</link>
6378	attributes to find out what is the current status.
6379	<result name="VBOX_E_DONT_CALL_AGAIN">
6380	Do not call again, this method is a NOP.
6381	</result>
6382	</desc>
6383	</method>
6384
6385	<method name="onUSBControllerChange">
6386	<desc>
6387	Notification when a property of the virtual
6388	<link to="IMachine::USBController">USB controller</link> changes.
6389	Interested callees should use IUSBController methods and attributes to
6390	find out what has changed.
6391	<result name="VBOX_E_DONT_CALL_AGAIN">
6392	Do not call again, this method is a NOP.
6393	</result>
6394	</desc>
6395	</method>
6396
6397	<method name="onUSBDeviceStateChange">
6398	<desc>
6399	Notification when a USB device is attached to or detached from
6400	the virtual USB controller.
6401
6402	This notification is sent as a result of the indirect
6403	request to attach the device because it matches one of the
6404	machine USB filters, or as a result of the direct request
6405	issued by <link to="IConsole::attachUSBDevice"/> or
6406	<link to="IConsole::detachUSBDevice"/>.
6407
6408	This notification is sent in case of both a succeeded and a
6409	failed request completion. When the request succeeds, the
6410	@a error parameter is @c null, and the given device has been
6411	already added to (when @a attached is @c true) or removed from
6412	(when @a attached is @c false) the collection represented by
6413	<link to="IConsole::USBDevices"/>. On failure, the collection
6414	doesn't change and the @a error parameter represents the error
6415	message describing the failure.
6416
6417	<result name="VBOX_E_DONT_CALL_AGAIN">
6418	Do not call again, this method is a NOP.
6419	</result>
6420	</desc>
6421	<param name="device" type="IUSBDevice" dir="in">
6422	<desc>Device that is subject to state change.</desc>
6423	</param>
6424	<param name="attached" type="boolean" dir="in">
6425	<desc>
6426	@c true if the device was attached and @c false otherwise.
6427	</desc>
6428	</param>
6429	<param name="error" type="IVirtualBoxErrorInfo" dir="in">
6430	<desc>
6431	@c null on success or an error message object on failure.
6432	</desc>
6433	</param>
6434	</method>
6435
6436	<method name="onSharedFolderChange">
6437	<desc>
6438	Notification when a shared folder is added or removed.
6439	The @a scope argument defines one of three scopes:
6440	<link to="IVirtualBox::sharedFolders">global shared folders</link>
6441	(<link to="Scope_Global">Global</link>),
6442	<link to="IMachine::sharedFolders">permanent shared folders</link> of
6443	the machine (<link to="Scope_Machine">Machine</link>) or <link
6444	to="IConsole::sharedFolders">transient shared folders</link> of the
6445	machine (<link to="Scope_Session">Session</link>). Interested callees
6446	should use query the corresponding collections to find out what has
6447	changed.
6448	<result name="VBOX_E_DONT_CALL_AGAIN">
6449	Do not call again, this method is a NOP.
6450	</result>
6451	</desc>
6452	<param name="scope" type="Scope" dir="in">
6453	<desc>Scope of the notification.</desc>
6454	</param>
6455	</method>
6456
6457	<method name="onRuntimeError">
6458	<desc>
6459	Notification when an error happens during the virtual
6460	machine execution.
6461
6462	There are three kinds of runtime errors:
6463	<ul>
6464	<li><i>fatal</i></li>
6465	<li><i>non-fatal with retry</i></li>
6466	<li><i>non-fatal warnings</i></li>
6467	</ul>
6468
6469	<b>Fatal</b> errors are indicated by the @a fatal parameter set
6470	to @c true. In case of fatal errors, the virtual machine
6471	execution is always paused before calling this notification, and
6472	the notification handler is supposed either to immediately save
6473	the virtual machine state using <link to="IConsole::saveState"/>
6474	or power it off using <link to="IConsole::powerDown"/>.
6475	Resuming the execution can lead to unpredictable results.
6476
6477	<b>Non-fatal</b> errors and warnings are indicated by the
6478	@a fatal parameter set to @c false. If the virtual machine
6479	is in the Paused state by the time the error notification is
6480	received, it means that the user can <i>try to resume</i> the machine
6481	execution after attempting to solve the problem that caused the
6482	error. In this case, the notification handler is supposed
6483	to show an appropriate message to the user (depending on the
6484	value of the @a id parameter) that offers several actions such
6485	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
6486	wants to retry, the notification handler should continue
6487	the machine execution using the <link to="IConsole::resume"/>
6488	call. If the machine execution is not Paused during this
6489	notification, then it means this notification is a <i>warning</i>
6490	(for example, about a fatal condition that can happen very soon);
6491	no immediate action is required from the user, the machine
6492	continues its normal execution.
6493
6494	Note that in either case the notification handler
6495	<b>must not</b> perform any action directly on a thread
6496	where this notification is called. Everything it is allowed to
6497	do is to post a message to another thread that will then talk
6498	to the user and take the corresponding action.
6499
6500	Currently, the following error identifiers are known:
6501	<ul>
6502	<li><tt>"HostMemoryLow"</tt></li>
6503	<li><tt>"HostAudioNotResponding"</tt></li>
6504	<li><tt>"VDIStorageFull"</tt></li>
6505	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
6506	</ul>
6507
6508	<note>
6509	This notification is not designed to be implemented by
6510	more than one callback at a time. If you have multiple
6511	IConsoleCallback instances registered on the given
6512	IConsole object, make sure you simply do nothing but
6513	return @c S_OK from all but one of them that does actual
6514	user notification and performs necessary actions.
6515	</note>
6516
6517	<result name="VBOX_E_DONT_CALL_AGAIN">
6518	Do not call again, this method is a NOP.
6519	</result>
6520	</desc>
6521	<param name="fatal" type="boolean" dir="in">
6522	<desc>Whether the error is fatal or not</desc>
6523	</param>
6524	<param name="id" type="wstring" dir="in">
6525	<desc>Error identifier</desc>
6526	</param>
6527	<param name="message" type="wstring" dir="in">
6528	<desc>Optional error message</desc>
6529	</param>
6530	</method>
6531
6532	<method name="onCanShowWindow">
6533	<desc>
6534	Notification when a call to
6535	<link to="IMachine::canShowConsoleWindow"/> is made by a
6536	front-end to check if a subsequent call to
6537	<link to="IMachine::showConsoleWindow"/> can succeed.
6538
6539	The callee should give an answer appropriate to the current
6540	machine state in the @a canShow argument. This answer must
6541	remain valid at least until the next
6542	<link to="IConsole::state">machine state</link> change.
6543
6544	<note>
6545	This notification is not designed to be implemented by
6546	more than one callback at a time. If you have multiple
6547	IConsoleCallback instances registered on the given
6548	IConsole object, make sure you simply do nothing but
6549	return @c true and @c S_OK from all but one of them that
6550	actually manages console window activation.
6551	</note>
6552
6553	<result name="VBOX_E_DONT_CALL_AGAIN">
6554	Do not call again, this method is a NOP.
6555	</result>
6556	</desc>
6557	<param name="canShow" type="boolean" dir="return">
6558	<desc>
6559	@c true if the console window can be shown and @c false otherwise.
6560	</desc>
6561	</param>
6562	</method>
6563
6564	<method name="onShowWindow">
6565	<desc>
6566	Notification when a call to
6567	<link to="IMachine::showConsoleWindow"/>
6568	requests the console window to be activated and brought to
6569	foreground on the desktop of the host PC.
6570
6571	This notification should cause the VM console process to
6572	perform the requested action as described above. If it is
6573	impossible to do it at a time of this notification, this
6574	method should return a failure.
6575
6576	Note that many modern window managers on many platforms
6577	implement some sort of focus stealing prevention logic, so
6578	that it may be impossible to activate a window without the
6579	help of the currently active application (which is supposedly
6580	an initiator of this notification). In this case, this method
6581	must return a non-zero identifier that represents the
6582	top-level window of the VM console process. The caller, if it
6583	represents a currently active process, is responsible to use
6584	this identifier (in a platform-dependent manner) to perform
6585	actual window activation.
6586
6587	This method must set @a winId to zero if it has performed all
6588	actions necessary to complete the request and the console
6589	window is now active and in foreground, to indicate that no
6590	further action is required on the caller's side.
6591
6592	<note>
6593	This notification is not designed to be implemented by
6594	more than one callback at a time. If you have multiple
6595	IConsoleCallback instances registered on the given
6596	IConsole object, make sure you simply do nothing but
6597	return @c S_OK from all but one of them that actually
6598	manages console window activation.
6599	</note>
6600
6601	<result name="VBOX_E_DONT_CALL_AGAIN">
6602	Do not call again, this method is a NOP.
6603	</result>
6604	</desc>
6605	<param name="winId" type="unsigned long long" dir="return">
6606	<desc>
6607	Platform-dependent identifier of the top-level VM console
6608	window, or zero if this method has performed all actions
6609	necessary to implement the <i>show window</i> semantics for
6610	the given platform and/or this VirtualBox front-end.
6611	</desc>
6612	</param>
6613	</method>
6614
6615	</interface>
6616
6617	<interface
6618	name="IRemoteDisplayInfo" extends="$unknown"
6619	uuid="b3741084-806f-4c3b-8c42-ebad1a81e45a"
6620	wsmap="struct"
6621	>
6622	<desc>
6623	Contains information about the remote display (VRDP) capabilities and status.
6624	This is used in the <link to="IConsole::remoteDisplayInfo" /> attribute.
6625	</desc>
6626
6627	<attribute name="active" type="boolean" readonly="yes">
6628	<desc>
6629	Whether the remote display connection is active.
6630	</desc>
6631	</attribute>
6632
6633	<attribute name="port" type="long" readonly="yes">
6634	<desc>
6635	VRDP server port number. If this property is equal to <tt>0</tt>, then
6636	the VRDP server failed to start, usually because there are no free TCP
6637	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDP
6638	server has not yet been started.
6639	</desc>
6640	</attribute>
6641
6642	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6643	<desc>
6644	How many times a client connected.
6645	</desc>
6646	</attribute>
6647
6648	<attribute name="beginTime" type="long long" readonly="yes">
6649	<desc>
6650	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6651	</desc>
6652	</attribute>
6653
6654	<attribute name="endTime" type="long long" readonly="yes">
6655	<desc>
6656	When the last connection was terminated or the current time, if
6657	connection is still active, in milliseconds since 1970-01-01 UTC.
6658	</desc>
6659	</attribute>
6660
6661	<attribute name="bytesSent" type="unsigned long long" readonly="yes">
6662	<desc>
6663	How many bytes were sent in last or current, if still active, connection.
6664	</desc>
6665	</attribute>
6666
6667	<attribute name="bytesSentTotal" type="unsigned long long" readonly="yes">
6668	<desc>
6669	How many bytes were sent in all connections.
6670	</desc>
6671	</attribute>
6672
6673	<attribute name="bytesReceived" type="unsigned long long" readonly="yes">
6674	<desc>
6675	How many bytes were received in last or current, if still active, connection.
6676	</desc>
6677	</attribute>
6678
6679	<attribute name="bytesReceivedTotal" type="unsigned long long" readonly="yes">
6680	<desc>
6681	How many bytes were received in all connections.
6682	</desc>
6683	</attribute>
6684
6685	<attribute name="user" type="wstring" readonly="yes">
6686	<desc>
6687	Login user name supplied by the client.
6688	</desc>
6689	</attribute>
6690
6691	<attribute name="domain" type="wstring" readonly="yes">
6692	<desc>
6693	Login domain name supplied by the client.
6694	</desc>
6695	</attribute>
6696
6697	<attribute name="clientName" type="wstring" readonly="yes">
6698	<desc>
6699	The client name supplied by the client.
6700	</desc>
6701	</attribute>
6702
6703	<attribute name="clientIP" type="wstring" readonly="yes">
6704	<desc>
6705	The IP address of the client.
6706	</desc>
6707	</attribute>
6708
6709	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6710	<desc>
6711	The client software version number.
6712	</desc>
6713	</attribute>
6714
6715	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6716	<desc>
6717	Public key exchange method used when connection was established.
6718	Values: 0 - RDP4 public key exchange scheme.
6719	1 - X509 certificates were sent to client.
6720	</desc>
6721	</attribute>
6722
6723	</interface>
6724
6725	<interface
6726	name="IConsole" extends="$unknown"
6727	uuid="6375231a-c17c-464b-92cb-ae9e128d71c3"
6728	wsmap="managed"
6729	>
6730	<desc>
6731	The IConsole interface represents an interface to control virtual
6732	machine execution.
6733
6734	The console object that implements the IConsole interface is obtained
6735	from a session object after the session for the given machine has been
6736	opened using one of <link to="IVirtualBox::openSession"/>,
6737	<link to="IVirtualBox::openRemoteSession"/> or
6738	<link to="IVirtualBox::openExistingSession"/> methods.
6739
6740	Methods of the IConsole interface allow the caller to query the current
6741	virtual machine execution state, pause the machine or power it down, save
6742	the machine state or take a snapshot, attach and detach removable media
6743	and so on.
6744
6745	<see>ISession</see>
6746	</desc>
6747
6748	<attribute name="machine" type="IMachine" readonly="yes">
6749	<desc>
6750	Machine object this console is sessioned with.
6751	<note>
6752	This is a convenience property, it has the same value as
6753	<link to="ISession::machine"/> of the corresponding session
6754	object.
6755	</note>
6756	</desc>
6757	</attribute>
6758
6759	<attribute name="state" type="MachineState" readonly="yes">
6760	<desc>
6761	Current execution state of the machine.
6762	<note>
6763	This property always returns the same value as the corresponding
6764	property of the IMachine object this console is sessioned with.
6765	For the process that owns (executes) the VM, this is the
6766	preferable way of querying the VM state, because no IPC
6767	calls are made.
6768	</note>
6769	</desc>
6770	</attribute>
6771
6772	<attribute name="guest" type="IGuest" readonly="yes">
6773	<desc>Guest object.</desc>
6774	</attribute>
6775
6776	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6777	<desc>
6778	Virtual keyboard object.
6779	<note>
6780	If the machine is not running, any attempt to use
6781	the returned object will result in an error.
6782	</note>
6783	</desc>
6784	</attribute>
6785
6786	<attribute name="mouse" type="IMouse" readonly="yes">
6787	<desc>
6788	Virtual mouse object.
6789	<note>
6790	If the machine is not running, any attempt to use
6791	the returned object will result in an error.
6792	</note>
6793	</desc>
6794	</attribute>
6795
6796	<attribute name="display" type="IDisplay" readonly="yes">
6797	<desc>Virtual display object.
6798	<note>
6799	If the machine is not running, any attempt to use
6800	the returned object will result in an error.
6801	</note>
6802	</desc>
6803	</attribute>
6804
6805	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6806	<desc>Debugging interface.</desc>
6807	</attribute>
6808
6809	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6810	<desc>
6811	Collection of USB devices currently attached to the virtual
6812	USB controller.
6813	<note>
6814	The collection is empty if the machine is not running.
6815	</note>
6816	</desc>
6817	</attribute>
6818
6819	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6820	<desc>
6821	List of USB devices currently attached to the remote VRDP client.
6822	Once a new device is physically attached to the remote host computer,
6823	it appears in this list and remains there until detached.
6824	</desc>
6825	</attribute>
6826
6827	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6828	<desc>
6829	Collection of shared folders for the current session. These folders
6830	are called transient shared folders because they are available to the
6831	guest OS running inside the associated virtual machine only for the
6832	duration of the session (as opposed to
6833	<link to="IMachine::sharedFolders"/> which represent permanent shared
6834	folders). When the session is closed (e.g. the machine is powered down),
6835	these folders are automatically discarded.
6836
6837	New shared folders are added to the collection using
6838	<link to="#createSharedFolder"/>. Existing shared folders can be
6839	removed using <link to="#removeSharedFolder"/>.
6840	</desc>
6841	</attribute>
6842
6843	<attribute name="remoteDisplayInfo" type="IRemoteDisplayInfo" readonly="yes">
6844	<desc>
6845	Interface that provides information on Remote Display (VRDP) connection.
6846	</desc>
6847	</attribute>
6848
6849	<method name="powerUp">
6850	<desc>
6851	Starts the virtual machine execution using the current machine
6852	state (that is, its current execution state, current settings and
6853	current storage devices).
6854
6855	If the machine is powered off or aborted, the execution will
6856	start from the beginning (as if the real hardware were just
6857	powered on).
6858
6859	If the machine is in the <link to="MachineState_Saved"/> state,
6860	it will continue its execution the point where the state has
6861	been saved.
6862
6863	If the machine <link to="IMachine::teleporterEnabled"/> property is
6864	enabled on the machine being powered up, the machine will wait for an
6865	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6866	state. The returned progress object will have at least three
6867	operations where the last three are defined as: (1) powering up and
6868	starting TCP server, (2) waiting for incoming teleportations, and
6869	(3) perform teleportation. These operations will be reflected as the
6870	last three operations of the progress objected returned by
6871	<link to="IVirtualBox::openRemoteSession"/> as well.
6872
6873	<note>
6874	Unless you are trying to write a new VirtualBox front-end that
6875	performs direct machine execution (like the VirtualBox or VBoxSDL
6876	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
6877	session opened by <link to="IVirtualBox::openSession"/> and use this
6878	session only to change virtual machine settings. If you simply want to
6879	start virtual machine execution using one of the existing front-ends
6880	(for example the VirtualBox GUI or headless server), simply use
6881	<link to="IVirtualBox::openRemoteSession"/>; these front-ends will
6882	power up the machine automatically for you.
6883	</note>
6884
6885	<see>#saveState</see>
6886	<result name="VBOX_E_INVALID_VM_STATE">
6887	Virtual machine already running.
6888	</result>
6889	<result name="VBOX_E_HOST_ERROR">
6890	Host interface does not exist or name not set.
6891	</result>
6892	<result name="VBOX_E_FILE_ERROR">
6893	Invalid saved state file.
6894	</result>
6895	</desc>
6896	<param name="progress" type="IProgress" dir="return">
6897	<desc>Progress object to track the operation completion.</desc>
6898	</param>
6899	</method>
6900
6901	<method name="powerUpPaused">
6902	<desc>
6903	Identical to powerUp except that the VM will enter the
6904	<link to="MachineState_Paused"/> state, instead of
6905	<link to="MachineState_Running"/>.
6906
6907	<see>#powerUp</see>
6908	<result name="VBOX_E_INVALID_VM_STATE">
6909	Virtual machine already running.
6910	</result>
6911	<result name="VBOX_E_HOST_ERROR">
6912	Host interface does not exist or name not set.
6913	</result>
6914	<result name="VBOX_E_FILE_ERROR">
6915	Invalid saved state file.
6916	</result>
6917	</desc>
6918	<param name="progress" type="IProgress" dir="return">
6919	<desc>Progress object to track the operation completion.</desc>
6920	</param>
6921	</method>
6922
6923	<method name="powerDown">
6924	<desc>
6925	Initiates the power down procedure to stop the virtual machine
6926	execution.
6927
6928	The completion of the power down procedure is tracked using the returned
6929	IProgress object. After the operation is complete, the machine will go
6930	to the PoweredOff state.
6931	<result name="VBOX_E_INVALID_VM_STATE">
6932	Virtual machine must be Running, Paused or Stuck to be powered down.
6933	</result>
6934	</desc>
6935	<param name="progress" type="IProgress" dir="return">
6936	<desc>Progress object to track the operation completion.</desc>
6937	</param>
6938	</method>
6939
6940	<method name="reset">
6941	<desc>Resets the virtual machine.
6942	<result name="VBOX_E_INVALID_VM_STATE">
6943	Virtual machine not in Running state.
6944	</result>
6945	<result name="VBOX_E_VM_ERROR">
6946	Virtual machine error in reset operation.
6947	</result>
6948	</desc>
6949	</method>
6950
6951	<method name="pause">
6952	<desc>Pauses the virtual machine execution.
6953	<result name="VBOX_E_INVALID_VM_STATE">
6954	Virtual machine not in Running state.
6955	</result>
6956	<result name="VBOX_E_VM_ERROR">
6957	Virtual machine error in suspend operation.
6958	</result>
6959	</desc>
6960	</method>
6961
6962	<method name="resume">
6963	<desc>Resumes the virtual machine execution.
6964	<result name="VBOX_E_INVALID_VM_STATE">
6965	Virtual machine not in Paused state.
6966	</result>
6967	<result name="VBOX_E_VM_ERROR">
6968	Virtual machine error in resume operation.
6969	</result>
6970	</desc>
6971	</method>
6972
6973	<method name="powerButton">
6974	<desc>Sends the ACPI power button event to the guest.
6975	<result name="VBOX_E_INVALID_VM_STATE">
6976	Virtual machine not in Running state.
6977	</result>
6978	<result name="VBOX_E_PDM_ERROR">
6979	Controlled power off failed.
6980	</result>
6981	</desc>
6982	</method>
6983
6984	<method name="sleepButton">
6985	<desc>Sends the ACPI sleep button event to the guest.
6986	<result name="VBOX_E_INVALID_VM_STATE">
6987	Virtual machine not in Running state.
6988	</result>
6989	<result name="VBOX_E_PDM_ERROR">
6990	Sending sleep button event failed.
6991	</result>
6992	</desc>
6993	</method>
6994
6995	<method name="getPowerButtonHandled">
6996	<desc>Checks if the last power button event was handled by guest.
6997	<result name="VBOX_E_PDM_ERROR">
6998	Checking if the event was handled by the guest OS failed.
6999	</result>
7000	</desc>
7001	<param name="handled" type="boolean" dir="return"/>
7002	</method>
7003
7004	<method name="getGuestEnteredACPIMode">
7005	<desc>Checks if the guest entered the ACPI mode G0 (working) or
7006	G1 (sleeping). If this method returns @c false, the guest will
7007	most likely not respond to external ACPI events.
7008	<result name="VBOX_E_INVALID_VM_STATE">
7009	Virtual machine not in Running state.
7010	</result>
7011	</desc>
7012	<param name="entered" type="boolean" dir="return"/>
7013	</method>
7014
7015	<method name="saveState">
7016	<desc>
7017	Saves the current execution state of a running virtual machine
7018	and stops its execution.
7019
7020	After this operation completes, the machine will go to the
7021	Saved state. Next time it is powered up, this state will
7022	be restored and the machine will continue its execution from
7023	the place where it was saved.
7024
7025	This operation differs from taking a snapshot to the effect
7026	that it doesn't create new differencing media. Also, once
7027	the machine is powered up from the state saved using this method,
7028	the saved state is deleted, so it will be impossible to return
7029	to this state later.
7030
7031	<note>
7032	On success, this method implicitly calls
7033	<link to="IMachine::saveSettings"/> to save all current machine
7034	settings (including runtime changes to the DVD medium, etc.).
7035	Together with the impossibility to change any VM settings when it is
7036	in the Saved state, this guarantees adequate hardware
7037	configuration of the machine when it is restored from the saved
7038	state file.
7039	</note>
7040
7041	<note>
7042	The machine must be in the Running or Paused state, otherwise
7043	the operation will fail.
7044	</note>
7045	<result name="VBOX_E_INVALID_VM_STATE">
7046	Virtual machine state neither Running nor Paused.
7047	</result>
7048	<result name="VBOX_E_FILE_ERROR">
7049	Failed to create directory for saved state file.
7050	</result>
7051
7052	<see><link to="#takeSnapshot"/></see>
7053	</desc>
7054	<param name="progress" type="IProgress" dir="return">
7055	<desc>Progress object to track the operation completion.</desc>
7056	</param>
7057	</method>
7058
7059	<method name="adoptSavedState">
7060	<desc>
7061	Associates the given saved state file to the virtual machine.
7062
7063	On success, the machine will go to the Saved state. Next time it is
7064	powered up, it will be restored from the adopted saved state and
7065	continue execution from the place where the saved state file was
7066	created.
7067
7068	The specified saved state file path may be absolute or relative to the
7069	folder the VM normally saves the state to (usually,
7070	<link to="IMachine::snapshotFolder"/>).
7071
7072	<note>
7073	It's a caller's responsibility to make sure the given saved state
7074	file is compatible with the settings of this virtual machine that
7075	represent its virtual hardware (memory size, storage disk configuration
7076	etc.). If there is a mismatch, the behavior of the virtual machine
7077	is undefined.
7078	</note>
7079	<result name="VBOX_E_INVALID_VM_STATE">
7080	Virtual machine state neither PoweredOff nor Aborted.
7081	</result>
7082	</desc>
7083	<param name="savedStateFile" type="wstring" dir="in">
7084	<desc>Path to the saved state file to adopt.</desc>
7085	</param>
7086	</method>
7087
7088	<method name="forgetSavedState">
7089	<desc>
7090	Forgets the saved state of the virtual machine previously created
7091	by <link to="#saveState"/>. Next time the machine is powered up, a
7092	clean boot will occur. If @a remove is @c true the saved state file
7093	is deleted.
7094	<note>
7095	This operation is equivalent to resetting or powering off
7096	the machine without doing a proper shutdown in the guest OS.
7097	</note>
7098	<result name="VBOX_E_INVALID_VM_STATE">
7099	Virtual machine not in state Saved.
7100	</result>
7101	</desc>
7102	<param name="remove" type="boolean" dir="in">
7103	<desc>If @c true remove the saved state file.</desc>
7104	</param>
7105	</method>
7106
7107	<method name="getDeviceActivity">
7108	<desc>
7109	Gets the current activity type of a given device or device group.
7110	<result name="E_INVALIDARG">
7111	Invalid device type.
7112	</result>
7113	</desc>
7114	<param name="type" type="DeviceType" dir="in"/>
7115	<param name="activity" type="DeviceActivity" dir="return"/>
7116	</method>
7117
7118	<method name="attachUSBDevice">
7119	<desc>
7120	Attaches a host USB device with the given UUID to the
7121	USB controller of the virtual machine.
7122
7123	The device needs to be in one of the following states:
7124	<link to="USBDeviceState_Busy"/>,
7125	<link to="USBDeviceState_Available"/> or
7126	<link to="USBDeviceState_Held"/>,
7127	otherwise an error is immediately returned.
7128
7129	When the device state is
7130	<link to="USBDeviceState_Busy">Busy</link>, an error may also
7131	be returned if the host computer refuses to release it for some reason.
7132
7133	<see>IUSBController::deviceFilters, USBDeviceState</see>
7134	<result name="VBOX_E_INVALID_VM_STATE">
7135	Virtual machine state neither Running nor Paused.
7136	</result>
7137	<result name="VBOX_E_PDM_ERROR">
7138	Virtual machine does not have a USB controller.
7139	</result>
7140	</desc>
7141	<param name="id" type="uuid" mod="string" dir="in">
7142	<desc>UUID of the host USB device to attach.</desc>
7143	</param>
7144	</method>
7145
7146	<method name="detachUSBDevice">
7147	<desc>
7148	Detaches an USB device with the given UUID from the USB controller
7149	of the virtual machine.
7150
7151	After this method succeeds, the VirtualBox server re-initiates
7152	all USB filters as if the device were just physically attached
7153	to the host, but filters of this machine are ignored to avoid
7154	a possible automatic re-attachment.
7155
7156	<see>IUSBController::deviceFilters, USBDeviceState</see>
7157
7158	<result name="VBOX_E_PDM_ERROR">
7159	Virtual machine does not have a USB controller.
7160	</result>
7161	<result name="E_INVALIDARG">
7162	USB device not attached to this virtual machine.
7163	</result>
7164	</desc>
7165	<param name="id" type="uuid" mod="string" dir="in">
7166	<desc>UUID of the USB device to detach.</desc>
7167	</param>
7168	<param name="device" type="IUSBDevice" dir="return">
7169	<desc>Detached USB device.</desc>
7170	</param>
7171	</method>
7172
7173	<method name="findUSBDeviceByAddress">
7174	<desc>
7175	Searches for a USB device with the given host address.
7176
7177	<result name="VBOX_E_OBJECT_NOT_FOUND">
7178	Given @c name does not correspond to any USB device.
7179	</result>
7180
7181	<see>IUSBDevice::address</see>
7182	</desc>
7183	<param name="name" type="wstring" dir="in">
7184	<desc>
7185	Address of the USB device (as assigned by the host) to
7186	search for.
7187	</desc>
7188	</param>
7189	<param name="device" type="IUSBDevice" dir="return">
7190	<desc>Found USB device object.</desc>
7191	</param>
7192	</method>
7193
7194	<method name="findUSBDeviceById">
7195	<desc>
7196	Searches for a USB device with the given UUID.
7197
7198	<result name="VBOX_E_OBJECT_NOT_FOUND">
7199	Given @c id does not correspond to any USB device.
7200	</result>
7201
7202	<see>IUSBDevice::id</see>
7203	</desc>
7204	<param name="id" type="uuid" mod="string" dir="in">
7205	<desc>UUID of the USB device to search for.</desc>
7206	</param>
7207	<param name="device" type="IUSBDevice" dir="return">
7208	<desc>Found USB device object.</desc>
7209	</param>
7210	</method>
7211
7212	<method name="createSharedFolder">
7213	<desc>
7214	Creates a transient new shared folder by associating the given logical
7215	name with the given host path, adds it to the collection of shared
7216	folders and starts sharing it. Refer to the description of
7217	<link to="ISharedFolder"/> to read more about logical names.
7218
7219	<result name="VBOX_E_INVALID_VM_STATE">
7220	Virtual machine in Saved state or currently changing state.
7221	</result>
7222	<result name="VBOX_E_FILE_ERROR">
7223	Shared folder already exists or not accessible.
7224	</result>
7225	</desc>
7226	<param name="name" type="wstring" dir="in">
7227	<desc>Unique logical name of the shared folder.</desc>
7228	</param>
7229	<param name="hostPath" type="wstring" dir="in">
7230	<desc>Full path to the shared folder in the host file system.</desc>
7231	</param>
7232	<param name="writable" type="boolean" dir="in">
7233	<desc>Whether the share is writable or readonly</desc>
7234	</param>
7235	</method>
7236
7237	<method name="removeSharedFolder">
7238	<desc>
7239	Removes a transient shared folder with the given name previously
7240	created by <link to="#createSharedFolder"/> from the collection of
7241	shared folders and stops sharing it.
7242	<result name="VBOX_E_INVALID_VM_STATE">
7243	Virtual machine in Saved state or currently changing state.
7244	</result>
7245	<result name="VBOX_E_FILE_ERROR">
7246	Shared folder does not exists.
7247	</result>
7248	</desc>
7249	<param name="name" type="wstring" dir="in">
7250	<desc>Logical name of the shared folder to remove.</desc>
7251	</param>
7252	</method>
7253
7254	<method name="takeSnapshot">
7255	<desc>
7256	Saves the current execution state
7257	and all settings of the machine and creates differencing images
7258	for all normal (non-independent) media.
7259	See <link to="ISnapshot" /> for an introduction to snapshots.
7260
7261	This method can be called for a PoweredOff, Saved (see
7262	<link to="#saveState"/>), Running or
7263	Paused virtual machine. When the machine is PoweredOff, an
7264	offline snapshot is created. When the machine is Running a live
7265	snapshot is created, and an online snapshot is is created when Paused.
7266
7267	The taken snapshot is always based on the
7268	<link to="IMachine::currentSnapshot">current snapshot</link>
7269	of the associated virtual machine and becomes a new current snapshot.
7270
7271	<note>
7272	This method implicitly calls <link to="IMachine::saveSettings"/> to
7273	save all current machine settings before taking an offline snapshot.
7274	</note>
7275
7276	<result name="VBOX_E_INVALID_VM_STATE">
7277	Virtual machine currently changing state.
7278	</result>
7279	</desc>
7280	<param name="name" type="wstring" dir="in">
7281	<desc>Short name for the snapshot.</desc>
7282	</param>
7283	<param name="description" type="wstring" dir="in">
7284	<desc>Optional description of the snapshot.</desc>
7285	</param>
7286	<param name="progress" type="IProgress" dir="return">
7287	<desc>Progress object to track the operation completion.</desc>
7288	</param>
7289	</method>
7290
7291	<method name="deleteSnapshot">
7292	<desc>
7293	Starts deleting the specified snapshot asynchronously.
7294	See <link to="ISnapshot" /> for an introduction to snapshots.
7295
7296	The execution state and settings of the associated machine stored in
7297	the snapshot will be deleted. The contents of all differencing media of
7298	this snapshot will be merged with the contents of their dependent child
7299	media to keep the medium chain valid (in other words, all changes
7300	represented by media being deleted will be propagated to their child
7301	medium). After that, this snapshot's differencing medium will be
7302	deleted. The parent of this snapshot will become a new parent for all
7303	its child snapshots.
7304
7305	If the deleted snapshot is the current one, its parent snapshot will
7306	become a new current snapshot. The current machine state is not directly
7307	affected in this case, except that currently attached differencing
7308	media based on media of the deleted snapshot will be also merged as
7309	described above.
7310
7311	If the deleted snapshot is the first or current snapshot, then the
7312	respective IMachine attributes will be adjusted. Deleting the current
7313	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7314	to make all current machine settings permanent.
7315
7316	Deleting a snapshot has the following preconditions:
7317
7318	<ul>
7319	<li>Child media of all normal media of the deleted snapshot
7320	must be accessible (see <link to="IMedium::state"/>) for this
7321	operation to succeed. In particular, this means that all virtual
7322	machines, whose media are directly or indirectly based on the
7323	media of deleted snapshot, must be powered off.</li>
7324
7325	<li>You cannot delete the snapshot if a medium attached to it has
7326	more than once child medium (differencing images) because otherwise
7327	merging would be impossible. This might be the case if there is
7328	more than one child snapshot or differencing images were created
7329	for other reason (e.g. implicitly because of multiple machine
7330	attachments).</li>
7331	</ul>
7332
7333
7334	The virtual machine's <link to="IMachine::state">state</link> is changed to "DeletingSnapshot"
7335	while this operation is in progress.
7336
7337	<note>
7338	Merging medium contents can be very time and disk space
7339	consuming, if these media are big in size and have many
7340	children. However, if the snapshot being deleted is the last
7341	(head) snapshot on the branch, the operation will be rather
7342	quick.
7343	</note>
7344	<result name="VBOX_E_INVALID_VM_STATE">
7345	Virtual machine is running.
7346	</result>
7347	</desc>
7348	<param name="id" type="uuid" mod="string" dir="in">
7349	<desc>UUID of the snapshot to delete.</desc>
7350	</param>
7351	<param name="progress" type="IProgress" dir="return">
7352	<desc>Progress object to track the operation completion.</desc>
7353	</param>
7354	</method>
7355
7356	<method name="restoreSnapshot">
7357	<desc>
7358	Starts resetting the machine's current state to the state contained
7359	in the given snapshot, asynchronously. All current settings of the
7360	machine will be reset and changes stored in differencing media
7361	will be lost.
7362	See <link to="ISnapshot" /> for an introduction to snapshots.
7363
7364	After this operation is successfully completed, new empty differencing
7365	media are created for all normal media of the machine.
7366
7367	If the given snapshot is an online snapshot, the machine will go to
7368	the <link to="MachineState_Saved"> saved state</link>, so that the
7369	next time it is powered on, the execution state will be restored
7370	from the state of the snapshot.
7371
7372	<note>
7373	The machine must not be running, otherwise the operation will fail.
7374	</note>
7375
7376	<note>
7377	If the machine state is <link to="MachineState_Saved">Saved</link>
7378	prior to this operation, the saved state file will be implicitly
7379	deleted (as if <link to="IConsole::forgetSavedState"/> were
7380	called).
7381	</note>
7382
7383	<result name="VBOX_E_INVALID_VM_STATE">
7384	Virtual machine is running.
7385	</result>
7386	</desc>
7387	<param name="snapshot" type="ISnapshot" dir="in">
7388	<desc>The snapshot to restore the VM state from.</desc>
7389	</param>
7390	<param name="progress" type="IProgress" dir="return">
7391	<desc>Progress object to track the operation completion.</desc>
7392	</param>
7393	</method>
7394
7395	<method name="teleport">
7396	<desc>
7397	Teleport the VM to a different host machine or process.
7398
7399	TODO explain the details.
7400
7401	<result name="VBOX_E_INVALID_VM_STATE">
7402	Virtual machine not running or paused.
7403	</result>
7404	</desc>
7405	<param name="hostname" type="wstring" dir="in">
7406	<desc>The name or IP of the host to teleport to.</desc>
7407	</param>
7408	<param name="tcpport" type="unsigned long" dir="in">
7409	<desc>The TCP port to connect to (1..65535).</desc>
7410	</param>
7411	<param name="password" type="wstring" dir="in">
7412	<desc>The password.</desc>
7413	</param>
7414	<param name="maxDowntime" type="unsigned long" dir="in">
7415	<desc>
7416	The maximum allowed downtime given as milliseconds. 0 is not a valid
7417	value. Recommended value: 250 ms.
7418
7419	The higher the value is, the greater the chance for a successful
7420	teleportation. A small value may easily result in the teleportation
7421	process taking hours and eventually fail.
7422
7423	<note>
7424	The current implementation treats this a guideline, not as an
7425	absolute rule.
7426	</note>
7427	</desc>
7428	</param>
7429	<param name="progress" type="IProgress" dir="return">
7430	<desc>Progress object to track the operation completion.</desc>
7431	</param>
7432	</method>
7433
7434	<method name="registerCallback">
7435	<desc>
7436	Registers a new console callback on this instance. The methods of the
7437	callback interface will be called by this instance when the appropriate
7438	event occurs.
7439	</desc>
7440	<param name="callback" type="IConsoleCallback" dir="in"/>
7441	</method>
7442
7443	<method name="unregisterCallback">
7444	<desc>
7445	Unregisters the console callback previously registered using
7446	<link to="#registerCallback"/>.
7447	<result name="E_INVALIDARG">
7448	Given @a callback handler is not registered.
7449	</result>
7450	</desc>
7451	<param name="callback" type="IConsoleCallback" dir="in"/>
7452	</method>
7453	</interface>
7454
7455	<!--
7456	// IHost
7457	/////////////////////////////////////////////////////////////////////////
7458	-->
7459
7460	<enum
7461	name="HostNetworkInterfaceMediumType"
7462	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7463	>
7464	<desc>
7465	Type of encapsulation. Ethernet encapsulation includes both wired and
7466	wireless Ethernet connections.
7467	<see>IHostNetworkInterface</see>
7468	</desc>
7469
7470	<const name="Unknown" value="0">
7471	<desc>
7472	The type of interface cannot be determined.
7473	</desc>
7474	</const>
7475	<const name="Ethernet" value="1">
7476	<desc>
7477	Ethernet frame encapsulation.
7478	</desc>
7479	</const>
7480	<const name="PPP" value="2">
7481	<desc>
7482	Point-to-point protocol encapsulation.
7483	</desc>
7484	</const>
7485	<const name="SLIP" value="3">
7486	<desc>
7487	Serial line IP encapsulation.
7488	</desc>
7489	</const>
7490	</enum>
7491
7492	<enum
7493	name="HostNetworkInterfaceStatus"
7494	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7495	>
7496	<desc>
7497	Current status of the interface.
7498	<see>IHostNetworkInterface</see>
7499	</desc>
7500
7501	<const name="Unknown" value="0">
7502	<desc>
7503	The state of interface cannot be determined.
7504	</desc>
7505	</const>
7506	<const name="Up" value="1">
7507	<desc>
7508	The interface is fully operational.
7509	</desc>
7510	</const>
7511	<const name="Down" value="2">
7512	<desc>
7513	The interface is not functioning.
7514	</desc>
7515	</const>
7516	</enum>
7517
7518	<enum
7519	name="HostNetworkInterfaceType"
7520	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7521	>
7522	<desc>
7523	Network interface type.
7524	</desc>
7525	<const name="Bridged" value="1"/>
7526	<const name="HostOnly" value="2"/>
7527	</enum>
7528
7529	<interface
7530	name="IHostNetworkInterface" extends="$unknown"
7531	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7532	wsmap="managed"
7533	>
7534	<desc>
7535	Represents one of host's network interfaces. IP V6 address and network
7536	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7537	separated by colons.
7538	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7539	</desc>
7540	<attribute name="name" type="wstring" readonly="yes">
7541	<desc>Returns the host network interface name.</desc>
7542	</attribute>
7543
7544	<attribute name="id" type="uuid" mod="string" readonly="yes">
7545	<desc>Returns the interface UUID.</desc>
7546	</attribute>
7547
7548	<attribute name="networkName" type="wstring" readonly="yes">
7549	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7550	</attribute>
7551
7552	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7553	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7554	</attribute>
7555
7556	<attribute name="IPAddress" type="wstring" readonly="yes">
7557	<desc>Returns the IP V4 address of the interface.</desc>
7558	</attribute>
7559
7560	<attribute name="networkMask" type="wstring" readonly="yes">
7561	<desc>Returns the network mask of the interface.</desc>
7562	</attribute>
7563
7564	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7565	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7566	</attribute>
7567
7568	<attribute name="IPV6Address" type="wstring" readonly="yes">
7569	<desc>Returns the IP V6 address of the interface.</desc>
7570	</attribute>
7571
7572	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7573	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7574	</attribute>
7575
7576	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7577	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7578	</attribute>
7579
7580	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7581	<desc>Type of protocol encapsulation used.</desc>
7582	</attribute>
7583
7584	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7585	<desc>Status of the interface.</desc>
7586	</attribute>
7587
7588	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7589	<desc>specifies the host interface type.</desc>
7590	</attribute>
7591
7592	<method name="enableStaticIpConfig">
7593	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7594	<param name="IPAddress" type="wstring" dir="in">
7595	<desc>
7596	IP address.
7597	</desc>
7598	</param>
7599	<param name="networkMask" type="wstring" dir="in">
7600	<desc>
7601	network mask.
7602	</desc>
7603	</param>
7604	</method>
7605
7606	<method name="enableStaticIpConfigV6">
7607	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7608	<param name="IPV6Address" type="wstring" dir="in">
7609	<desc>
7610	IP address.
7611	</desc>
7612	</param>
7613	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7614	<desc>
7615	network mask.
7616	</desc>
7617	</param>
7618	</method>
7619
7620	<method name="enableDynamicIpConfig">
7621	<desc>enables the dynamic IP configuration.</desc>
7622	</method>
7623
7624	<method name="dhcpRediscover">
7625	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7626	</method>
7627
7628	</interface>
7629
7630	<interface
7631	name="IHost" extends="$unknown"
7632	uuid="35b004f4-7806-4009-bfa8-d1308adba7e5"
7633	wsmap="managed"
7634	>
7635	<desc>
7636	The IHost interface represents the physical machine that this VirtualBox
7637	installation runs on.
7638
7639	An object implementing this interface is returned by the
7640	<link to="IVirtualBox::host" /> attribute. This interface contains
7641	read-only information about the host's physical hardware (such as what
7642	processors and disks are available, what the host operating system is,
7643	and so on) and also allows for manipulating some of the host's hardware,
7644	such as global USB device filters and host interface networking.
7645
7646	</desc>
7647	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7648	<desc>List of DVD drives available on the host.</desc>
7649	</attribute>
7650
7651	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7652	<desc>List of floppy drives available on the host.</desc>
7653	</attribute>
7654
7655	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7656	<desc>
7657	List of USB devices currently attached to the host.
7658	Once a new device is physically attached to the host computer,
7659	it appears in this list and remains there until detached.
7660
7661	<note>
7662	If USB functionality is not available in the given edition of
7663	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7664	</note>
7665	</desc>
7666	</attribute>
7667
7668	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7669	<desc>
7670	List of USB device filters in action.
7671	When a new device is physically attached to the host computer,
7672	filters from this list are applied to it (in order they are stored
7673	in the list). The first matched filter will determine the
7674	<link to="IHostUSBDeviceFilter::action">action</link>
7675	performed on the device.
7676
7677	Unless the device is ignored by these filters, filters of all
7678	currently running virtual machines
7679	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7680
7681	<note>
7682	If USB functionality is not available in the given edition of
7683	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7684	</note>
7685
7686	<see>IHostUSBDeviceFilter, USBDeviceState</see>
7687	</desc>
7688	</attribute>
7689
7690	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7691	<desc>List of host network interfaces currently defined on the host.</desc>
7692	</attribute>
7693
7694	<attribute name="processorCount" type="unsigned long" readonly="yes">
7695	<desc>Number of (logical) CPUs installed in the host system.</desc>
7696	</attribute>
7697
7698	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7699	<desc>Number of (logical) CPUs online in the host system.</desc>
7700	</attribute>
7701
7702	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7703	<desc>Number of physical processor cores installed in the host system.</desc>
7704	</attribute>
7705
7706	<method name="getProcessorSpeed">
7707	<desc>Query the (approximate) maximum speed of a specified host CPU in
7708	Megahertz.
7709	</desc>
7710	<param name="cpuId" type="unsigned long" dir="in">
7711	<desc>
7712	Identifier of the CPU.
7713	</desc>
7714	</param>
7715	<param name="speed" type="unsigned long" dir="return">
7716	<desc>
7717	Speed value. 0 is returned if value is not known or @a cpuId is
7718	invalid.
7719	</desc>
7720	</param>
7721	</method>
7722
7723	<method name="getProcessorFeature">
7724	<desc>Query whether a CPU feature is supported or not.</desc>
7725	<param name="feature" type="ProcessorFeature" dir="in">
7726	<desc>
7727	CPU Feature identifier.
7728	</desc>
7729	</param>
7730	<param name="supported" type="boolean" dir="return">
7731	<desc>
7732	Feature is supported or not.
7733	</desc>
7734	</param>
7735	</method>
7736
7737	<method name="getProcessorDescription">
7738	<desc>Query the model string of a specified host CPU.
7739	</desc>
7740	<param name="cpuId" type="unsigned long" dir="in">
7741	<desc>
7742	Identifier of the CPU.
7743	<note>
7744	The current implementation might not necessarily return the
7745	description for this exact CPU.
7746	</note>
7747	</desc>
7748	</param>
7749	<param name="description" type="wstring" dir="return">
7750	<desc>
7751	Model string. An empty string is returned if value is not known or
7752	@a cpuId is invalid.
7753	</desc>
7754	</param>
7755	</method>
7756
7757	<method name="getProcessorCPUIDLeaf">
7758	<desc>
7759	Returns the CPU cpuid information for the specified leaf.
7760	</desc>
7761	<param name="cpuId" type="unsigned long" dir="in">
7762	<desc>
7763	Identifier of the CPU. The CPU most be online.
7764	<note>
7765	The current implementation might not necessarily return the
7766	description for this exact CPU.
7767	</note>
7768	</desc>
7769	</param>
7770	<param name="leaf" type="unsigned long" dir="in">
7771	<desc>
7772	CPUID leaf index (eax).
7773	</desc>
7774	</param>
7775	<param name="subLeaf" type="unsigned long" dir="in">
7776	<desc>
7777	CPUID leaf sub index (ecx). This currently only applies to cache
7778	information on Intel CPUs. Use 0 if retriving values for
7779	<link to="IMachine::setCPUIDLeaf"/>.
7780	</desc>
7781	</param>
7782	<param name="valEax" type="unsigned long" dir="out">
7783	<desc>
7784	CPUID leaf value for register eax.
7785	</desc>
7786	</param>
7787	<param name="valEbx" type="unsigned long" dir="out">
7788	<desc>
7789	CPUID leaf value for register ebx.
7790	</desc>
7791	</param>
7792	<param name="valEcx" type="unsigned long" dir="out">
7793	<desc>
7794	CPUID leaf value for register ecx.
7795	</desc>
7796	</param>
7797	<param name="valEdx" type="unsigned long" dir="out">
7798	<desc>
7799	CPUID leaf value for register edx.
7800	</desc>
7801	</param>
7802	</method>
7803
7804	<attribute name="memorySize" type="unsigned long" readonly="yes">
7805	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7806	</attribute>
7807
7808	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7809	<desc>Available system memory in the host system.</desc>
7810	</attribute>
7811
7812	<attribute name="operatingSystem" type="wstring" readonly="yes">
7813	<desc>Name of the host system's operating system.</desc>
7814	</attribute>
7815
7816	<attribute name="OSVersion" type="wstring" readonly="yes">
7817	<desc>Host operating system's version string.</desc>
7818	</attribute>
7819
7820	<attribute name="UTCTime" type="long long" readonly="yes">
7821	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7822	</attribute>
7823
7824	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7825	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7826	</attribute>
7827
7828	<method name="createHostOnlyNetworkInterface">
7829	<desc>
7830	Creates a new adapter for Host Only Networking.
7831	<result name="E_INVALIDARG">
7832	Host network interface @a name already exists.
7833	</result>
7834	</desc>
7835	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7836	<desc>
7837	Created host interface object.
7838	</desc>
7839	</param>
7840	<param name="progress" type="IProgress" dir="return">
7841	<desc>
7842	Progress object to track the operation completion.
7843	</desc>
7844	</param>
7845	</method>
7846
7847	<method name="removeHostOnlyNetworkInterface">
7848	<desc>
7849	Removes the given Host Only Networking interface.
7850	<result name="VBOX_E_OBJECT_NOT_FOUND">
7851	No host network interface matching @a id found.
7852	</result>
7853	</desc>
7854	<param name="id" type="uuid" mod="string" dir="in">
7855	<desc>
7856	Adapter GUID.
7857	</desc>
7858	</param>
7859	<param name="progress" type="IProgress" dir="return">
7860	<desc>
7861	Progress object to track the operation completion.
7862	</desc>
7863	</param>
7864	</method>
7865
7866	<method name="createUSBDeviceFilter">
7867	<desc>
7868	Creates a new USB device filter. All attributes except
7869	the filter name are set to empty (any match),
7870	<i>active</i> is @c false (the filter is not active).
7871
7872	The created filter can be added to the list of filters using
7873	<link to="#insertUSBDeviceFilter"/>.
7874
7875	<see>#USBDeviceFilters</see>
7876	</desc>
7877	<param name="name" type="wstring" dir="in">
7878	<desc>
7879	Filter name. See <link to="IHostUSBDeviceFilter::name"/>
7880	for more info.
7881	</desc>
7882	</param>
7883	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7884	<desc>Created filter object.</desc>
7885	</param>
7886	</method>
7887
7888	<method name="insertUSBDeviceFilter">
7889	<desc>
7890	Inserts the given USB device to the specified position
7891	in the list of filters.
7892
7893	Positions are numbered starting from @c 0. If the specified
7894	position is equal to or greater than the number of elements in
7895	the list, the filter is added at the end of the collection.
7896
7897	<note>
7898	Duplicates are not allowed, so an attempt to insert a
7899	filter already in the list is an error.
7900	</note>
7901	<note>
7902	If USB functionality is not available in the given edition of
7903	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7904	</note>
7905
7906	<see>#USBDeviceFilters</see>
7907
7908	<result name="VBOX_E_INVALID_OBJECT_STATE">
7909	USB device filter is not created within this VirtualBox instance.
7910	</result>
7911	<result name="E_INVALIDARG">
7912	USB device filter already in list.
7913	</result>
7914
7915	</desc>
7916	<param name="position" type="unsigned long" dir="in">
7917	<desc>Position to insert the filter to.</desc>
7918	</param>
7919	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7920	<desc>USB device filter to insert.</desc>
7921	</param>
7922	</method>
7923
7924	<method name="removeUSBDeviceFilter">
7925	<desc>
7926	Removes a USB device filter from the specified position in the
7927	list of filters.
7928
7929	Positions are numbered starting from @c 0. Specifying a
7930	position equal to or greater than the number of elements in
7931	the list will produce an error.
7932
7933	<note>
7934	If USB functionality is not available in the given edition of
7935	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7936	</note>
7937
7938	<see>#USBDeviceFilters</see>
7939
7940	<result name="E_INVALIDARG">
7941	USB device filter list empty or invalid @a position.
7942	</result>
7943
7944	</desc>
7945	<param name="position" type="unsigned long" dir="in">
7946	<desc>Position to remove the filter from.</desc>
7947	</param>
7948	</method>
7949
7950	<method name="findHostDVDDrive">
7951	<desc>
7952	Searches for a host DVD drive with the given @c name.
7953
7954	<result name="VBOX_E_OBJECT_NOT_FOUND">
7955	Given @c name does not correspond to any host drive.
7956	</result>
7957
7958	</desc>
7959	<param name="name" type="wstring" dir="in">
7960	<desc>Name of the host drive to search for</desc>
7961	</param>
7962	<param name="drive" type="IMedium" dir="return">
7963	<desc>Found host drive object</desc>
7964	</param>
7965	</method>
7966
7967	<method name="findHostFloppyDrive">
7968	<desc>
7969	Searches for a host floppy drive with the given @c name.
7970
7971	<result name="VBOX_E_OBJECT_NOT_FOUND">
7972	Given @c name does not correspond to any host floppy drive.
7973	</result>
7974
7975	</desc>
7976	<param name="name" type="wstring" dir="in">
7977	<desc>Name of the host floppy drive to search for</desc>
7978	</param>
7979	<param name="drive" type="IMedium" dir="return">
7980	<desc>Found host floppy drive object</desc>
7981	</param>
7982	</method>
7983
7984	<method name="findHostNetworkInterfaceByName">
7985	<desc>
7986	Searches through all host network interfaces for an interface with
7987	the given @c name.
7988	<note>
7989	The method returns an error if the given @c name does not
7990	correspond to any host network interface.
7991	</note>
7992	</desc>
7993	<param name="name" type="wstring" dir="in">
7994	<desc>Name of the host network interface to search for.</desc>
7995	</param>
7996	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7997	<desc>Found host network interface object.</desc>
7998	</param>
7999	</method>
8000	<method name="findHostNetworkInterfaceById">
8001	<desc>
8002	Searches through all host network interfaces for an interface with
8003	the given GUID.
8004	<note>
8005	The method returns an error if the given GUID does not
8006	correspond to any host network interface.
8007	</note>
8008	</desc>
8009	<param name="id" type="uuid" mod="string" dir="in">
8010	<desc>GUID of the host network interface to search for.</desc>
8011	</param>
8012	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8013	<desc>Found host network interface object.</desc>
8014	</param>
8015	</method>
8016	<method name="findHostNetworkInterfacesOfType">
8017	<desc>
8018	Searches through all host network interfaces and returns a list of interfaces of the specified type
8019	</desc>
8020	<param name="type" type="HostNetworkInterfaceType" dir="in">
8021	<desc>type of the host network interfaces to search for.</desc>
8022	</param>
8023	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
8024	<desc>Found host network interface objects.</desc>
8025	</param>
8026	</method>
8027
8028	<method name="findUSBDeviceById">
8029	<desc>
8030	Searches for a USB device with the given UUID.
8031
8032	<result name="VBOX_E_OBJECT_NOT_FOUND">
8033	Given @c id does not correspond to any USB device.
8034	</result>
8035
8036	<see>IHostUSBDevice::id</see>
8037	</desc>
8038	<param name="id" type="uuid" mod="string" dir="in">
8039	<desc>UUID of the USB device to search for.</desc>
8040	</param>
8041	<param name="device" type="IHostUSBDevice" dir="return">
8042	<desc>Found USB device object.</desc>
8043	</param>
8044	</method>
8045
8046	<method name="findUSBDeviceByAddress">
8047	<desc>
8048	Searches for a USB device with the given host address.
8049
8050	<result name="VBOX_E_OBJECT_NOT_FOUND">
8051	Given @c name does not correspond to any USB device.
8052	</result>
8053
8054	<see>IHostUSBDevice::address</see>
8055	</desc>
8056	<param name="name" type="wstring" dir="in">
8057	<desc>
8058	Address of the USB device (as assigned by the host) to
8059	search for.
8060	</desc>
8061	</param>
8062	<param name="device" type="IHostUSBDevice" dir="return">
8063	<desc>Found USB device object.</desc>
8064	</param>
8065	</method>
8066
8067	</interface>
8068
8069	<!--
8070	// ISystemProperties
8071	/////////////////////////////////////////////////////////////////////////
8072	-->
8073
8074	<interface
8075	name="ISystemProperties"
8076	extends="$unknown"
8077	uuid="07c3ffd8-8f59-49cc-b608-53a332e85cc3"
8078	wsmap="managed"
8079	>
8080	<desc>
8081	The ISystemProperties interface represents global properties of the given
8082	VirtualBox installation.
8083
8084	These properties define limits and default values for various attributes
8085	and parameters. Most of the properties are read-only, but some can be
8086	changed by a user.
8087	</desc>
8088
8089	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
8090	<desc>Minimum guest system memory in Megabytes.</desc>
8091	</attribute>
8092
8093	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
8094	<desc>Maximum guest system memory in Megabytes.</desc>
8095	</attribute>
8096
8097	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
8098	<desc>Minimum guest video memory in Megabytes.</desc>
8099	</attribute>
8100
8101	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
8102	<desc>Maximum guest video memory in Megabytes.</desc>
8103	</attribute>
8104
8105	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
8106	<desc>Minimum CPU count.</desc>
8107	</attribute>
8108
8109	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
8110	<desc>Maximum CPU count.</desc>
8111	</attribute>
8112
8113	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
8114	<desc>Maximum of monitors which could be connected.</desc>
8115	</attribute>
8116
8117	<attribute name="maxVDISize" type="unsigned long long" readonly="yes">
8118	<desc>Maximum size of a virtual disk image in Megabytes.</desc>
8119	</attribute>
8120
8121	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
8122	<desc>
8123	Number of network adapters associated with every
8124	<link to="IMachine"/> instance.
8125	</desc>
8126	</attribute>
8127
8128	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
8129	<desc>
8130	Number of serial ports associated with every
8131	<link to="IMachine"/> instance.
8132	</desc>
8133	</attribute>
8134
8135	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
8136	<desc>
8137	Number of parallel ports associated with every
8138	<link to="IMachine"/> instance.
8139	</desc>
8140	</attribute>
8141
8142	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
8143	<desc>
8144	Maximum device position in the boot order. This value corresponds
8145	to the total number of devices a machine can boot from, to make it
8146	possible to include all possible devices to the boot list.
8147	<see><link to="IMachine::setBootOrder"/></see>
8148	</desc>
8149	</attribute>
8150
8151	<attribute name="defaultMachineFolder" type="wstring">
8152	<desc>
8153	Full path to the default directory used to create new or open
8154	existing machines when a settings file name contains no
8155	path.
8156
8157	The initial value of this property is
8158	<tt><</tt><link to="IVirtualBox::homeFolder">
8159	VirtualBox_home</link><tt>>/Machines</tt>.
8160
8161	<note>
8162	Setting this property to @c null or an empty string will restore the
8163	initial value.
8164	</note>
8165	<note>
8166	When settings this property, the specified path can be
8167	absolute (full path) or relative
8168	to the <link to="IVirtualBox::homeFolder">
8169	VirtualBox home directory</link>.
8170	When reading this property, a full path is
8171	always returned.
8172	</note>
8173	<note>
8174	The specified path may not exist, it will be created
8175	when necessary.
8176	</note>
8177
8178	<see>
8179	<link to="IVirtualBox::createMachine"/>,
8180	<link to="IVirtualBox::openMachine"/>
8181	</see>
8182	</desc>
8183	</attribute>
8184
8185	<attribute name="defaultHardDiskFolder" type="wstring">
8186	<desc>
8187	Full path to the default directory used to create new or open existing
8188	virtual disks.
8189
8190	This path is used when the storage unit of a hard disk is a regular file
8191	in the host's file system and only a file name that contains no path is
8192	given.
8193
8194	The initial value of this property is
8195	<tt><</tt>
8196	<link to="IVirtualBox::homeFolder">VirtualBox_home</link>
8197	<tt>>/HardDisks</tt>.
8198
8199	<note>
8200	Setting this property to @c null or empty string will restore the
8201	initial value.
8202	</note>
8203	<note>
8204	When settings this property, the specified path can be relative
8205	to the
8206	<link to="IVirtualBox::homeFolder">VirtualBox home directory</link> or
8207	absolute. When reading this property, a full path is
8208	always returned.
8209	</note>
8210	<note>
8211	The specified path may not exist, it will be created
8212	when necessary.
8213	</note>
8214
8215	<see>
8216	IMedium,
8217	<link to="IVirtualBox::createHardDisk"/>,
8218	<link to="IVirtualBox::openHardDisk"/>,
8219	<link to="IMedium::location"/>
8220	</see>
8221	</desc>
8222	</attribute>
8223
8224	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
8225	<desc>
8226	List of all medium storage formats supported by this VirtualBox
8227	installation.
8228
8229	Keep in mind that the medium format identifier
8230	(<link to="IMediumFormat::id"/>) used in other API calls like
8231	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
8232	medium format is a case-insensitive string. This means that, for
8233	example, all of the following strings:
8234	<pre>
8235	"VDI"
8236	"vdi"
8237	"VdI"</pre>
8238	refer to the same medium format.
8239
8240	Note that the virtual medium framework is backend-based, therefore
8241	the list of supported formats depends on what backends are currently
8242	installed.
8243
8244	<see>
8245	<link to="IMediumFormat"/>,
8246	</see>
8247	</desc>
8248	</attribute>
8249
8250	<attribute name="defaultHardDiskFormat" type="wstring">
8251	<desc>
8252	Identifier of the default medium format used by VirtualBox.
8253
8254	The medium format set by this attribute is used by VirtualBox
8255	when the medium format was not specified explicitly. One example is
8256	<link to="IVirtualBox::createHardDisk"/> with the empty
8257	format argument. A more complex example is implicit creation of
8258	differencing media when taking a snapshot of a virtual machine:
8259	this operation will try to use a format of the parent medium first
8260	and if this format does not support differencing media the default
8261	format specified by this argument will be used.
8262
8263	The list of supported medium formats may be obtained by the
8264	<link to="#mediaFormats"/> call. Note that the default medium
8265	format must have a capability to create differencing media;
8266	otherwise operations that create media implicitly may fail
8267	unexpectedly.
8268
8269	The initial value of this property is <tt>"VDI"</tt> in the current
8270	version of the VirtualBox product, but may change in the future.
8271
8272	<note>
8273	Setting this property to @c null or empty string will restore the
8274	initial value.
8275	</note>
8276
8277	<see>
8278	<link to="#mediaFormats"/>,
8279	<link to="IMediumFormat::id"/>,
8280	<link to="IVirtualBox::createHardDisk"/>
8281	</see>
8282	</desc>
8283	</attribute>
8284
8285	<attribute name="freeDiskSpaceWarning" type="unsigned long long">
8286	<desc>Issue a warning if the free disk space is below (or in some disk
8287	intensive operation is expected to go below) the given size in
8288	Megabytes.</desc>
8289	</attribute>
8290
8291	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8292	<desc>Issue a warning if the free disk space is below (or in some disk
8293	intensive operation is expected to go below) the given percentage.</desc>
8294	</attribute>
8295
8296	<attribute name="freeDiskSpaceError" type="unsigned long long">
8297	<desc>Issue an error if the free disk space is below (or in some disk
8298	intensive operation is expected to go below) the given size in
8299	Megabytes.</desc>
8300	</attribute>
8301
8302	<attribute name="freeDiskSpacePercentError" type="unsigned long">
8303	<desc>Issue an error if the free disk space is below (or in some disk
8304	intensive operation is expected to go below) the given percentage.</desc>
8305	</attribute>
8306
8307	<attribute name="remoteDisplayAuthLibrary" type="wstring">
8308	<desc>
8309	Library that provides authentication for VRDP clients. The library
8310	is used if a virtual machine's authentication type is set to "external"
8311	in the VM RemoteDisplay configuration.
8312
8313	The system library extension (".DLL" or ".so") must be omitted.
8314	A full path can be specified; if not, then the library must reside on the
8315	system's default library path.
8316
8317	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
8318	of that name in one of the default VirtualBox library directories.
8319
8320	For details about VirtualBox authentication libraries and how to implement
8321	them, please refer to the VirtualBox manual.
8322
8323	<note>
8324	Setting this property to @c null or empty string will restore the
8325	initial value.
8326	</note>
8327	</desc>
8328	</attribute>
8329
8330	<attribute name="webServiceAuthLibrary" type="wstring">
8331	<desc>
8332	Library that provides authentication for webservice clients. The library
8333	is used if a virtual machine's authentication type is set to "external"
8334	in the VM RemoteDisplay configuration and will be called from
8335	within the <link to="IWebsessionManager::logon" /> implementation.
8336
8337	As opposed to <link to="ISystemProperties::remoteDisplayAuthLibrary" />,
8338	there is no per-VM setting for this, as the webservice is a global
8339	resource (if it is running). Only for this setting (for the webservice),
8340	setting this value to a literal <tt>"null"</tt> string disables authentication,
8341	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8342	no matter what user name and password are supplied.
8343
8344	The initial value of this property is <tt>"VRDPAuth"</tt>,
8345	meaning that the webservice will use the same authentication
8346	library that is used by default for VBoxVRDP (again, see
8347	<link to="ISystemProperties::remoteDisplayAuthLibrary" />).
8348	The format and calling convention of authentication libraries
8349	is the same for the webservice as it is for VBoxVRDP.
8350
8351	<note>
8352	Setting this property to @c null or empty string will restore the
8353	initial value.
8354	</note>
8355	</desc>
8356	</attribute>
8357
8358	<attribute name="LogHistoryCount" type="unsigned long">
8359	<desc>
8360	This value specifies how many old release log files are kept.
8361	</desc>
8362	</attribute>
8363
8364	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8365	<desc>This value hold the default audio driver for the current
8366	system.</desc>
8367	</attribute>
8368
8369	<method name="getMaxDevicesPerPortForStorageBus">
8370	<desc>Returns the maximum number of devices which can be attached to a port
8371	for the given storage bus.</desc>
8372
8373	<param name="bus" type="StorageBus" dir="in">
8374	<desc>The storage bus type to get the value for.</desc>
8375	</param>
8376
8377	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8378	<desc>The maximum number of devices which can eb attached to the port for the given
8379	storage bus.</desc>
8380	</param>
8381	</method>
8382
8383	<method name="getMinPortCountForStorageBus">
8384	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8385
8386	<param name="bus" type="StorageBus" dir="in">
8387	<desc>The storage bus type to get the value for.</desc>
8388	</param>
8389
8390	<param name="minPortCount" type="unsigned long" dir="return">
8391	<desc>The minimum number of ports for the given storage bus.</desc>
8392	</param>
8393	</method>
8394
8395	<method name="getMaxPortCountForStorageBus">
8396	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8397
8398	<param name="bus" type="StorageBus" dir="in">
8399	<desc>The storage bus type to get the value for.</desc>
8400	</param>
8401
8402	<param name="maxPortCount" type="unsigned long" dir="return">
8403	<desc>The maximum number of ports for the given storage bus.</desc>
8404	</param>
8405	</method>
8406
8407	<method name="getMaxInstancesOfStorageBus">
8408	<desc>Returns the maximum number of storage bus instances which
8409	can be configured for each VM. This corresponds to the number of
8410	storage controllers one can have.</desc>
8411
8412	<param name="bus" type="StorageBus" dir="in">
8413	<desc>The storage bus type to get the value for.</desc>
8414	</param>
8415
8416	<param name="maxInstances" type="unsigned long" dir="return">
8417	<desc>The maximum number of instances for the given storage bus.</desc>
8418	</param>
8419	</method>
8420
8421	<method name="getDeviceTypesForStorageBus">
8422	<desc>Returns list of all the supported device types
8423	(<link to="DeviceType"/>) for the given type of storage
8424	bus.</desc>
8425
8426	<param name="bus" type="StorageBus" dir="in">
8427	<desc>The storage bus type to get the value for.</desc>
8428	</param>
8429
8430	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8431	<desc>The list of all supported device types for the given storage bus.</desc>
8432	</param>
8433	</method>
8434	</interface>
8435
8436	<!--
8437	// IGuest
8438	/////////////////////////////////////////////////////////////////////////
8439	-->
8440
8441	<interface
8442	name="IGuestOSType" extends="$unknown"
8443	uuid="e3f6727e-a09b-41ea-a824-864a176472f3"
8444	wsmap="struct"
8445	>
8446	<desc>
8447	</desc>
8448
8449	<attribute name="familyId" type="wstring" readonly="yes">
8450	<desc>Guest OS family identifier string.</desc>
8451	</attribute>
8452
8453	<attribute name="familyDescription" type="wstring" readonly="yes">
8454	<desc>Human readable description of the guest OS family.</desc>
8455	</attribute>
8456
8457	<attribute name="id" type="wstring" readonly="yes">
8458	<desc>Guest OS identifier string.</desc>
8459	</attribute>
8460
8461	<attribute name="description" type="wstring" readonly="yes">
8462	<desc>Human readable description of the guest OS.</desc>
8463	</attribute>
8464
8465	<attribute name="is64Bit" type="boolean" readonly="yes">
8466	<desc>Returns @c true if the given OS is 64-bit</desc>
8467	</attribute>
8468
8469	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8470	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8471	</attribute>
8472
8473	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8474	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8475	</attribute>
8476
8477	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8478	<desc>Recommended RAM size in Megabytes.</desc>
8479	</attribute>
8480
8481	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8482	<desc>Recommended video RAM size in Megabytes.</desc>
8483	</attribute>
8484
8485	<attribute name="recommendedHDD" type="unsigned long" readonly="yes">
8486	<desc>Recommended hard disk size in Megabytes.</desc>
8487	</attribute>
8488
8489	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8490	<desc>Returns recommended network adapter for this OS type.</desc>
8491	</attribute>
8492
8493	<attribute name="recommendedPae" type="boolean" readonly="yes">
8494	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8495	</attribute>
8496
8497	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
8498	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8499	</attribute>
8500
8501	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
8502	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8503	</attribute>
8504
8505	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
8506	<desc>Recommended storage controller type for HD drives.</desc>
8507	</attribute>
8508
8509	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
8510	<desc>Recommended storage bus type for HD drives.</desc>
8511	</attribute>
8512
8513	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8514	<desc>Recommended firmware type.</desc>
8515	</attribute>
8516
8517	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
8518	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8519	</attribute>
8520
8521	<attribute name="recommendedHpet" type="boolean" readonly="yes">
8522	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8523	</attribute>
8524
8525	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
8526	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8527	</attribute>
8528
8529	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
8530	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8531	</attribute>
8532
8533	</interface>
8534
8535	<interface
8536	name="IGuest" extends="$unknown"
8537	uuid="d915dff1-ed38-495a-91f1-ab6c53932468"
8538	wsmap="managed"
8539	>
8540	<desc>
8541	The IGuest interface represents information about the operating system
8542	running inside the virtual machine. Used in
8543	<link to="IConsole::guest"/>.
8544
8545	IGuest provides information about the guest operating system, whether
8546	Guest Additions are installed and other OS-specific virtual machine
8547	properties.
8548	</desc>
8549
8550	<attribute name="OSTypeId" type="wstring" readonly="yes">
8551	<desc>
8552	Identifier of the Guest OS type as reported by the Guest
8553	Additions.
8554	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8555	an IGuestOSType object representing details about the given
8556	Guest OS type.
8557	<note>
8558	If Guest Additions are not installed, this value will be
8559	the same as <link to="IMachine::OSTypeId"/>.
8560	</note>
8561	</desc>
8562	</attribute>
8563
8564	<attribute name="additionsActive" type="boolean" readonly="yes">
8565	<desc>
8566	Flag whether the Guest Additions are installed and active
8567	in which case their version will be returned by the
8568	<link to="#additionsVersion"/> property.
8569	</desc>
8570	</attribute>
8571
8572	<attribute name="additionsVersion" type="wstring" readonly="yes">
8573	<desc>
8574	Version of the Guest Additions (3 decimal numbers separated
8575	by dots) or empty when the Additions are not installed. The
8576	Additions may also report a version but yet not be active as
8577	the version might be refused by VirtualBox (incompatible) or
8578	other failures occurred.
8579	</desc>
8580	</attribute>
8581
8582	<attribute name="supportsSeamless" type="boolean" readonly="yes">
8583	<desc>
8584	Flag whether seamless guest display rendering (seamless desktop
8585	integration) is supported.
8586	</desc>
8587	</attribute>
8588
8589	<attribute name="supportsGraphics" type="boolean" readonly="yes">
8590	<desc>
8591	Flag whether the guest is in graphics mode. If it is not, then
8592	seamless rendering will not work, resize hints are not immediately
8593	acted on and guest display resizes are probably not initiated by
8594	the guest additions.
8595	</desc>
8596	</attribute>
8597
8598	<attribute name="memoryBalloonSize" type="unsigned long">
8599	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8600	</attribute>
8601
8602	<attribute name="pageFusionEnabled" type="boolean">
8603	<desc>Flag whether page fusion is enabled or not.</desc>
8604	</attribute>
8605
8606	<attribute name="statisticsUpdateInterval" type="unsigned long">
8607	<desc>Interval to update guest statistics in seconds.</desc>
8608	</attribute>
8609
8610	<method name="internalGetStatistics">
8611	<desc>
8612	Internal method; do not use as it might change at any time
8613	</desc>
8614	<param name="cpuUser" type="unsigned long" dir="out">
8615	<desc>Percentage of processor time spent in user mode as seen by the guest</desc>
8616	</param>
8617	<param name="cpuKernel" type="unsigned long" dir="out">
8618	<desc>Percentage of processor time spent in kernel mode as seen by the guest</desc>
8619	</param>
8620	<param name="cpuIdle" type="unsigned long" dir="out">
8621	<desc>Percentage of processor time spent idling as seen by the guest</desc>
8622	</param>
8623	<param name="memTotal" type="unsigned long" dir="out">
8624	<desc>Total amount of physical guest RAM</desc>
8625	</param>
8626	<param name="memFree" type="unsigned long" dir="out">
8627	<desc>Free amount of physical guest RAM</desc>
8628	</param>
8629	<param name="memBalloon" type="unsigned long" dir="out">
8630	<desc>Amount of ballooned physical guest RAM</desc>
8631	</param>
8632	<param name="memShared" type="unsigned long" dir="out">
8633	<desc>Amount of shared physical guest RAM</desc>
8634	</param>
8635	<param name="memCache" type="unsigned long" dir="out">
8636	<desc>Total amount of guest (disk) cache memory</desc>
8637	</param>
8638	<param name="pagedTotal" type="unsigned long" dir="out">
8639	<desc>Total amount of space in the page file</desc>
8640	</param>
8641	<param name="memAllocTotal" type="unsigned long" dir="out">
8642	<desc>Total amount of memory allocated by the hypervisor</desc>
8643	</param>
8644	<param name="memFreeTotal" type="unsigned long" dir="out">
8645	<desc>Total amount of free memory available in the hypervisor</desc>
8646	</param>
8647	<param name="memBalloonTotal" type="unsigned long" dir="out">
8648	<desc>Total amount of memory ballooned by the hypervisor</desc>
8649	</param>
8650	<param name="memSharedTotal" type="unsigned long" dir="out">
8651	<desc>Total amount of shared memory in the hypervisor</desc>
8652	</param>
8653	</method>
8654
8655	<method name="setCredentials">
8656	<desc>
8657	Store login credentials that can be queried by guest operating
8658	systems with Additions installed. The credentials are transient
8659	to the session and the guest may also choose to erase them. Note
8660	that the caller cannot determine whether the guest operating system
8661	has queried or made use of the credentials.
8662
8663	<result name="VBOX_E_VM_ERROR">
8664	VMM device is not available.
8665	</result>
8666
8667	</desc>
8668	<param name="userName" type="wstring" dir="in">
8669	<desc>User name string, can be empty</desc>
8670	</param>
8671	<param name="password" type="wstring" dir="in">
8672	<desc>Password string, can be empty</desc>
8673	</param>
8674	<param name="domain" type="wstring" dir="in">
8675	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8676	</param>
8677	<param name="allowInteractiveLogon" type="boolean" dir="in">
8678	<desc>
8679	Flag whether the guest should alternatively allow the user to
8680	interactively specify different credentials. This flag might
8681	not be supported by all versions of the Additions.
8682	</desc>
8683	</param>
8684	</method>
8685
8686	<method name="executeProcess">
8687	<desc>
8688	Executes an existing program inside the guest VM.
8689
8690	<result name="VBOX_E_IPRT_ERROR">
8691	Could not execute process.
8692	</result>
8693
8694	</desc>
8695	<param name="execName" type="wstring" dir="in">
8696	<desc>
8697	Full path name of the command to execute on the guest; the
8698	commands has to exists in the guest VM in order to be executed.
8699	</desc>
8700	</param>
8701	<param name="flags" type="unsigned long" dir="in">
8702	<desc>
8703	Execution flags - currently not supported and therefore
8704	has to be set to 0.
8705	</desc>
8706	</param>
8707	<param name="arguments" type="wstring" safearray="yes" dir="in">
8708	<desc>
8709	Array of arguments passed to the execution command.
8710	</desc>
8711	</param>
8712	<param name="environment" type="wstring" safearray="yes" dir="in">
8713	<desc>
8714	Environment variables that can be set while the command is being
8715	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
8716	variable just set its name ("NAME") without a value.
8717	</desc>
8718	</param>
8719	<param name="userName" type="wstring" dir="in">
8720	<desc>
8721	User name under which the command will be executed; has to exist
8722	and have the appropriate rights to execute programs in the VM.
8723	</desc>
8724	</param>
8725	<param name="password" type="wstring" dir="in">
8726	<desc>
8727	Password of the user account specified.
8728	</desc>
8729	</param>
8730	<param name="timeoutMS" type="unsigned long" dir="in">
8731	<desc>
8732	The maximum timeout value (in msec) to wait for finished program
8733	execution. Pass 0 for an infinite timeout.
8734	</desc>
8735	</param>
8736	<param name="pid" type="unsigned long" dir="out">
8737	<desc>
8738	The PID (process ID) of the started command for later reference.
8739	</desc>
8740	</param>
8741	<param name="progress" type="IProgress" dir="return">
8742	<desc>Progress object to track the operation completion.</desc>
8743	</param>
8744	</method>
8745
8746	<method name="getProcessOutput">
8747	<desc>
8748	Retrieves output of a formerly started process.
8749
8750	<result name="VBOX_E_IPRT_ERROR">
8751	Could not retrieve output.
8752	</result>
8753
8754	</desc>
8755	<param name="pid" type="unsigned long" dir="in">
8756	<desc>
8757	Process id returned by earlier executeProcess() call.
8758	</desc>
8759	</param>
8760	<param name="flags" type="unsigned long" dir="in">
8761	<desc>
8762	Flags describing which output to retrieve.
8763	</desc>
8764	</param>
8765	<param name="timeoutMS" type="unsigned long" dir="in">
8766	<desc>
8767	The maximum timeout value (in msec) to wait for output
8768	data. Pass 0 for an infinite timeout.
8769	</desc>
8770	</param>
8771	<param name="size" type="unsigned long long" dir="in">
8772	<desc>
8773	Size in bytes to read in the buffer.
8774	</desc>
8775	</param>
8776	<param name="data" type="octet" dir="return" safearray="yes">
8777	<desc>
8778	Buffer for retrieving the actual output. A data size of 0 means end of file
8779	if the requested size was not 0. This is the unprocessed
8780	output data, i.e. the line ending style depends on the platform of
8781	the system the server is running on.
8782	</desc>
8783	</param>
8784	</method>
8785
8786	<method name="getProcessStatus">
8787	<desc>
8788	Retrieves status, exit code and the exit reason of a formerly started process.
8789
8790	<result name="VBOX_E_IPRT_ERROR">
8791	Process with specified PID was not found.
8792	</result>
8793
8794	</desc>
8795	<param name="pid" type="unsigned long" dir="in">
8796	<desc>
8797	Process id returned by earlier executeProcess() call.
8798	</desc>
8799	</param>
8800	<param name="exitcode" type="unsigned long" dir="out">
8801	<desc>
8802	The exit code (if available).
8803	</desc>
8804	</param>
8805	<param name="flags" type="unsigned long" dir="out">
8806	<desc>
8807	Additional flags of process status (not used at the moment).
8808	</desc>
8809	</param>
8810	<param name="reason" type="unsigned long" dir="return">
8811	<desc>
8812	The current process status.
8813	</desc>
8814	</param>
8815	</method>
8816
8817	</interface>
8818
8819
8820	<!--
8821	// IProgress
8822	/////////////////////////////////////////////////////////////////////////
8823	-->
8824
8825	<interface
8826	name="IProgress" extends="$unknown"
8827	uuid="856aa038-853f-42e2-acf7-6e7b02dbe294"
8828	wsmap="managed"
8829	>
8830	<desc>
8831	The IProgress interface is used to track and control
8832	asynchronous tasks within VirtualBox.
8833
8834	An instance of this is returned every time VirtualBox starts
8835	an asynchronous task (in other words, a separate thread) which
8836	continues to run after a method call returns. For example,
8837	<link to="IConsole::saveState" />, which saves the state of
8838	a running virtual machine, can take a long time to complete.
8839	To be able to display a progress bar, a user interface such as
8840	the VirtualBox graphical user interface can use the IProgress
8841	object returned by that method.
8842
8843	Note that IProgress is a "read-only" interface in the sense
8844	that only the VirtualBox internals behind the Main API can
8845	create and manipulate progress objects, whereas client code
8846	can only use the IProgress object to monitor a task's
8847	progress and, if <link to="#cancelable" /> is @c true,
8848	cancel the task by calling <link to="#cancel" />.
8849
8850	A task represented by IProgress consists of either one or
8851	several sub-operations that run sequentially, one by one (see
8852	<link to="#operation" /> and <link to="#operationCount" />).
8853	Every operation is identified by a number (starting from 0)
8854	and has a separate description.
8855
8856	You can find the individual percentage of completion of the current
8857	operation in <link to="#operationPercent" /> and the
8858	percentage of completion of the task as a whole
8859	in <link to="#percent" />.
8860
8861	Similarly, you can wait for the completion of a particular
8862	operation via <link to="#waitForOperationCompletion" /> or
8863	for the completion of the whole task via
8864	<link to="#waitForCompletion" />.
8865	</desc>
8866
8867	<attribute name="id" type="uuid" mod="string" readonly="yes">
8868	<desc>ID of the task.</desc>
8869	</attribute>
8870
8871	<attribute name="description" type="wstring" readonly="yes">
8872	<desc>Description of the task.</desc>
8873	</attribute>
8874
8875	<attribute name="initiator" type="$unknown" readonly="yes">
8876	<desc>Initiator of the task.</desc>
8877	</attribute>
8878
8879	<attribute name="cancelable" type="boolean" readonly="yes">
8880	<desc>Whether the task can be interrupted.</desc>
8881	</attribute>
8882
8883	<attribute name="percent" type="unsigned long" readonly="yes">
8884	<desc>
8885	Current progress value of the task as a whole, in percent.
8886	This value depends on how many operations are already complete.
8887	Returns 100 if <link to="#completed" /> is @c true.
8888	</desc>
8889	</attribute>
8890
8891	<attribute name="timeRemaining" type="long" readonly="yes">
8892	<desc>
8893	Estimated remaining time until the task completes, in
8894	seconds. Returns 0 once the task has completed; returns -1
8895	if the remaining time cannot be computed, in particular if
8896	the current progress is 0.
8897
8898	Even if a value is returned, the estimate will be unreliable
8899	for low progress values. It will become more reliable as the
8900	task progresses; it is not recommended to display an ETA
8901	before at least 20% of a task have completed.
8902	</desc>
8903	</attribute>
8904
8905	<attribute name="completed" type="boolean" readonly="yes">
8906	<desc>Whether the task has been completed.</desc>
8907	</attribute>
8908
8909	<attribute name="canceled" type="boolean" readonly="yes">
8910	<desc>Whether the task has been canceled.</desc>
8911	</attribute>
8912
8913	<attribute name="resultCode" type="long" readonly="yes">
8914	<desc>
8915	Result code of the progress task.
8916	Valid only if <link to="#completed"/> is @c true.
8917	</desc>
8918	</attribute>
8919
8920	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8921	<desc>
8922	Extended information about the unsuccessful result of the
8923	progress operation. May be @c null if no extended information
8924	is available.
8925	Valid only if <link to="#completed"/> is @c true and
8926	<link to="#resultCode"/> indicates a failure.
8927	</desc>
8928	</attribute>
8929
8930	<attribute name="operationCount" type="unsigned long" readonly="yes">
8931	<desc>
8932	Number of sub-operations this task is divided into.
8933	Every task consists of at least one suboperation.
8934	</desc>
8935	</attribute>
8936
8937	<attribute name="operation" type="unsigned long" readonly="yes">
8938	<desc>Number of the sub-operation being currently executed.</desc>
8939	</attribute>
8940
8941	<attribute name="operationDescription" type="wstring" readonly="yes">
8942	<desc>
8943	Description of the sub-operation being currently executed.
8944	</desc>
8945	</attribute>
8946
8947	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8948	<desc>Progress value of the current sub-operation only, in percent.</desc>
8949	</attribute>
8950
8951	<attribute name="timeout" type="unsigned long">
8952	<desc>
8953	When non-zero, this specifies the number of milliseconds after which
8954	the operation will automatically be canceled. This can only be set on
8955	cancelable objects.
8956	</desc>
8957	</attribute>
8958
8959	<method name="setCurrentOperationProgress">
8960	<desc>Internal method, not to be called externally.</desc>
8961	<param name="percent" type="unsigned long" dir="in" />
8962	</method>
8963	<method name="setNextOperation">
8964	<desc>Internal method, not to be called externally.</desc>
8965	<param name="nextOperationDescription" type="wstring" dir="in" />
8966	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8967	</method>
8968
8969	<method name="waitForCompletion">
8970	<desc>
8971	Waits until the task is done (including all sub-operations)
8972	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8973
8974	<result name="VBOX_E_IPRT_ERROR">
8975	Failed to wait for task completion.
8976	</result>
8977	</desc>
8978
8979	<param name="timeout" type="long" dir="in">
8980	<desc>
8981	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8982	</desc>
8983	</param>
8984	</method>
8985
8986	<method name="waitForOperationCompletion">
8987	<desc>
8988	Waits until the given operation is done with a given timeout in
8989	milliseconds; specify -1 for an indefinite wait.
8990
8991	<result name="VBOX_E_IPRT_ERROR">
8992	Failed to wait for operation completion.
8993	</result>
8994
8995	</desc>
8996	<param name="operation" type="unsigned long" dir="in">
8997	<desc>
8998	Number of the operation to wait for.
8999	Must be less than <link to="#operationCount"/>.
9000	</desc>
9001	</param>
9002	<param name="timeout" type="long" dir="in">
9003	<desc>
9004	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9005	</desc>
9006	</param>
9007	</method>
9008
9009	<method name="cancel">
9010	<desc>
9011	Cancels the task.
9012	<note>
9013	If <link to="#cancelable"/> is @c false, then this method will fail.
9014	</note>
9015
9016	<result name="VBOX_E_INVALID_OBJECT_STATE">
9017	Operation cannot be canceled.
9018	</result>
9019
9020	</desc>
9021	</method>
9022
9023	</interface>
9024
9025
9026	<!--
9027	// ISnapshot
9028	/////////////////////////////////////////////////////////////////////////
9029	-->
9030
9031	<interface
9032	name="ISnapshot" extends="$unknown"
9033	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
9034	wsmap="managed"
9035	>
9036	<desc>
9037	The ISnapshot interface represents a snapshot of the virtual
9038	machine.
9039
9040	Together with the differencing media that are created
9041	when a snapshot is taken, a machine can be brought back to
9042	the exact state it was in when the snapshot was taken.
9043
9044	The ISnapshot interface has no methods, only attributes; snapshots
9045	are controlled through methods of the <link to="IConsole" /> interface
9046	which also manage the media associated with the snapshot.
9047	The following operations exist:
9048
9049	<ul>
9050	<li><link to="IConsole::takeSnapshot"/>: creates a new snapshot
9051	by creating new, empty differencing images for the machine's
9052	media and saving the VM settings and (if the VM is running)
9053	the current VM state in the snapshot.
9054
9055	The differencing images will then receive all data written to
9056	the machine's media, while their parent (base) images
9057	remain unmodified after the snapshot has been taken (see
9058	<link to="IMedium" /> for details about differencing images).
9059	This simplifies restoring a machine to the state of a snapshot:
9060	only the differencing images need to be deleted.
9061
9062	The current machine state is not changed by taking a snapshot.
9063	If the machine is running, it will resume execution after the
9064	snapshot has been taken.
9065	</li>
9066
9067	<li><link to="IConsole::restoreSnapshot"/>: this goes back to
9068	a previous snapshot. This resets the machine's state to that of
9069	the previous snapshot by deleting the differencing image of each
9070	of the machine's media and setting the machine's settings
9071	and state to the state that was saved in the snapshot (if any).
9072
9073	This destroys the machine's current state.
9074	</li>
9075
9076	<li><link to="IConsole::deleteSnapshot"/>: deletes a snapshot
9077	without affecting the current machine state.
9078
9079	This does not change the machine, but instead frees the resources
9080	allocated when the snapshot was taken: the settings and machine state
9081	is deleted (if any), and the snapshot's differencing image for each
9082	of the machine's media gets merged with its parent image.
9083
9084	Neither the current machine state nor other snapshots are affected
9085	by this operation, except that parent media will be modified
9086	to contain the disk data associated with the snapshot being deleted.
9087	</li>
9088	</ul>
9089
9090	Each snapshot contains the settings of the virtual machine (hardware
9091	configuration etc.). In addition, if the machine was running when the
9092	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
9093	the current VM state is saved in the snapshot (similarly to what happens
9094	when a VM's state is saved). The snapshot is then said to
9095	be <i>online</i> because when restoring it, the VM will be running.
9096
9097	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
9098	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
9099
9100	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
9101	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
9102	it then contains a so-called "zero execution state", representing a
9103	machine that is powered off.
9104
9105	<h3>Snapshot branches and the "current" snapshot</h3>
9106
9107	Snapshots can be chained, whereby every next snapshot is based on the
9108	previous one. This chaining is related to medium branching
9109	(see the <link to="IMedium"/> description) in that every time
9110	a new snapshot is created, a new differencing medium is implicitly
9111	created for all normal media attached to the machine.
9112
9113	Each virtual machine has a "current snapshot", identified by
9114	<link to="IMachine::currentSnapshot"/>. Presently, this is always set
9115	to the last snapshot in the chain. In a future version of VirtualBox,
9116	it will be possible to reset a machine's current state to that of an
9117	earlier snapshot without deleting the current state so that it will be
9118	possible to create alternative snapshot paths in a snapshot tree.
9119
9120	In the current implementation, multiple snapshot branches within one
9121	virtual machine are not allowed. Every machine has a single branch,
9122	and <link to="IConsole::takeSnapshot"/> operation adds a new
9123	snapshot to the top of that branch.
9124	</desc>
9125
9126	<attribute name="id" type="uuid" mod="string" readonly="yes">
9127	<desc>UUID of the snapshot.</desc>
9128	</attribute>
9129
9130	<attribute name="name" type="wstring">
9131	<desc>Short name of the snapshot.</desc>
9132	</attribute>
9133
9134	<attribute name="description" type="wstring">
9135	<desc>Optional description of the snapshot.</desc>
9136	</attribute>
9137
9138	<attribute name="timeStamp" type="long long" readonly="yes">
9139	<desc>
9140	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
9141	</desc>
9142	</attribute>
9143
9144	<attribute name="online" type="boolean" readonly="yes">
9145	<desc>
9146	@c true if this snapshot is an online snapshot and @c false otherwise.
9147
9148	When this attribute is @c true, the
9149	<link to="IMachine::stateFilePath"/> attribute of the
9150	<link to="#machine"/> object associated with this snapshot
9151	will point to the saved state file. Otherwise, it will be
9152	an empty string.
9153	</desc>
9154	</attribute>
9155
9156	<attribute name="machine" type="IMachine" readonly="yes">
9157	<desc>
9158	Virtual machine this snapshot is taken on. This object
9159	stores all settings the machine had when taking this snapshot.
9160	<note>
9161	The returned machine object is immutable, i.e. no
9162	any settings can be changed.
9163	</note>
9164	</desc>
9165	</attribute>
9166
9167	<attribute name="parent" type="ISnapshot" readonly="yes">
9168	<desc>
9169	Parent snapshot (a snapshot this one is based on), or
9170	@c null if the snapshot has no parent (i.e. is the first snapshot).
9171	</desc>
9172	</attribute>
9173
9174	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
9175	<desc>
9176	Child snapshots (all snapshots having this one as a parent).
9177	</desc>
9178	</attribute>
9179
9180	</interface>
9181
9182
9183	<!--
9184	// IMedium
9185	/////////////////////////////////////////////////////////////////////////
9186	-->
9187
9188	<enum
9189	name="MediumState"
9190	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
9191	>
9192	<desc>
9193	Virtual medium state.
9194	<see>IMedium</see>
9195	</desc>
9196
9197	<const name="NotCreated" value="0">
9198	<desc>
9199	Associated medium storage does not exist (either was not created yet or
9200	was deleted).
9201	</desc>
9202	</const>
9203	<const name="Created" value="1">
9204	<desc>
9205	Associated storage exists and accessible; this gets set if the
9206	accessibility check performed by <link to="IMedium::refreshState" />
9207	was successful.
9208	</desc>
9209	</const>
9210	<const name="LockedRead" value="2">
9211	<desc>
9212	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
9213	no data modification is possible.
9214	</desc>
9215	</const>
9216	<const name="LockedWrite" value="3">
9217	<desc>
9218	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
9219	no concurrent data reading or modification is possible.
9220	</desc>
9221	</const>
9222	<const name="Inaccessible" value="4">
9223	<desc>
9224	Medium accessiblity check (see <link to="IMedium::refreshState" />) has
9225	not yet been performed, or else, associated medium storage is not
9226	accessible. In the first case, <link to="IMedium::lastAccessError"/>
9227	is empty, in the second case, it describes the error that occured.
9228	</desc>
9229	</const>
9230	<const name="Creating" value="5">
9231	<desc>
9232	Associated medium storage is being created.
9233	</desc>
9234	</const>
9235	<const name="Deleting" value="6">
9236	<desc>
9237	Associated medium storage is being deleted.
9238	</desc>
9239	</const>
9240	</enum>
9241
9242	<enum
9243	name="MediumType"
9244	uuid="46bf1fd4-ad86-4ded-8c49-28bd2d148e5a"
9245	>
9246	<desc>
9247	Virtual medium type.
9248	<see>IMedium</see>
9249	</desc>
9250
9251	<const name="Normal" value="0">
9252	<desc>
9253	Normal medium (attached directly or indirectly, preserved
9254	when taking snapshots).
9255	</desc>
9256	</const>
9257	<const name="Immutable" value="1">
9258	<desc>
9259	Immutable medium (attached indirectly, changes are wiped out
9260	the next time the virtual machine is started).
9261	</desc>
9262	</const>
9263	<const name="Writethrough" value="2">
9264	<desc>
9265	Write through medium (attached directly, ignored when
9266	taking snapshots).
9267	</desc>
9268	</const>
9269	<const name="Shareable" value="3">
9270	<desc>
9271	Allow using this medium concurrently by several machines.
9272	<note>This is a stub value. Not usable until this note is removed.</note>
9273	</desc>
9274	</const>
9275	</enum>
9276
9277	<enum
9278	name="MediumVariant"
9279	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
9280	>
9281	<desc>
9282	Virtual medium image variant. More than one flag may be set.
9283	<see>IMedium</see>
9284	</desc>
9285
9286	<const name="Standard" value="0">
9287	<desc>
9288	No particular variant requested, results in using the backend default.
9289	</desc>
9290	</const>
9291	<const name="VmdkSplit2G" value="0x01">
9292	<desc>
9293	VMDK image split in chunks of less than 2GByte.
9294	</desc>
9295	</const>
9296	<const name="VmdkStreamOptimized" value="0x04">
9297	<desc>
9298	VMDK streamOptimized image. Special import/export format which is
9299	read-only/append-only.
9300	</desc>
9301	</const>
9302	<const name="VmdkESX" value="0x08">
9303	<desc>
9304	VMDK format variant used on ESX products.
9305	</desc>
9306	</const>
9307	<const name="Fixed" value="0x10000">
9308	<desc>
9309	Fixed image. Only allowed for base images.
9310	</desc>
9311	</const>
9312	<const name="Diff" value="0x20000">
9313	<desc>
9314	Fixed image. Only allowed for base images.
9315	</desc>
9316	</const>
9317	</enum>
9318
9319	<interface
9320	name="IMediumAttachment" extends="$unknown"
9321	uuid="e58eb3eb-8627-428b-bdf8-34487c848de5"
9322	wsmap="struct"
9323	>
9324	<desc>
9325	The IMediumAttachment interface represents the attachment
9326	of a storage medium to a virtual machine. Each machine contains
9327	an array of its medium attachments in <link to="IMachine::mediumAttachments"/>.
9328
9329	Each medium attachment specifies a storage controller as well as a port
9330	and device number. Fixed media (hard disks) will always also specify
9331	an instance of IMedium in <link to="#medium" />, referring to the hard disk
9332	medium. For removeable media, the IMedia instance is optional; it can be
9333	@c null if no media is mounted (see <link to="IMachine::mountMedium" />).
9334	</desc>
9335
9336	<attribute name="medium" type="IMedium" readonly="yes">
9337	<desc>Medium object associated with this attachment; it
9338	can be @c null for removable devices.</desc>
9339	</attribute>
9340
9341	<attribute name="controller" type="wstring" readonly="yes">
9342	<desc>Name of the storage controller of this attachment; this
9343	refers to one of the controllers in <link to="IMachine::storageControllers" />
9344	by name.</desc>
9345	</attribute>
9346
9347	<attribute name="port" type="long" readonly="yes">
9348	<desc>Port number of this attachment.
9349	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
9350	</desc>
9351	</attribute>
9352
9353	<attribute name="device" type="long" readonly="yes">
9354	<desc>Device slot number of this attachment.
9355	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
9356	</desc>
9357	</attribute>
9358
9359	<attribute name="type" type="DeviceType" readonly="yes">
9360	<desc>Device type of this attachment.</desc>
9361	</attribute>
9362
9363	<attribute name="passthrough" type="boolean" readonly="yes">
9364	<desc>Pass I/O requests through to a device on the host.</desc>
9365	</attribute>
9366
9367	</interface>
9368
9369	<interface
9370	name="IMedium" extends="$unknown"
9371	uuid="1d578f43-5ef1-4415-b556-7592d3ccdc8f"
9372	wsmap="managed"
9373	>
9374	<desc>
9375	The IMedium interface represents virtual storage for a machine's
9376	hard disks, CD/DVD or floppy drives. It will typically represent
9377	a disk image on the host, for example a VDI or VMDK file representing
9378	a virtual hard disk, or an ISO or RAW file representing virtual
9379	removable media, but can also point to a network location (e.g.
9380	for iSCSI targets).
9381
9382	Instances of IMedium are connected to virtual machines by way of
9383	medium attachments (see <link to="IMediumAttachment" />), which link
9384	the storage medium to a particular device slot of a storage controller
9385	of the virtual machine.
9386	In the VirtualBox API, virtual storage is therefore always represented
9387	by the following chain of object links:
9388
9389	<ul>
9390	<li><link to="IMachine::storageControllers"/> contains an array of
9391	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
9392	these are instances of <link to="IStorageController"/>).</li>
9393	<li><link to="IMachine::mediumAttachments"/> contains an array of
9394	medium attachments (instances of <link to="IMediumAttachment"/>),
9395	each containing a storage controller from the above array, a
9396	port/device specification, and an instance of IMedium representing
9397	the medium storage (image file).
9398
9399	For removable media, the storage medium is optional; a medium
9400	attachment with no medium represents a CD/DVD or floppy drive
9401	with no medium inserted. By contrast, hard disk attachments
9402	will always have an IMedium object attached.</li>
9403	<li>Each IMedium in turn points to a storage unit (such as a file
9404	on the host computer or a network resource) that holds actual
9405	data. This location is represented by the <link to="#location"/>
9406	attribute.</li>
9407	</ul>
9408
9409	Existing media are opened using the following methods, depending on the
9410	media type:
9411	<ul>
9412	<li><link to="IVirtualBox::openHardDisk"/></li>
9413	<li><link to="IVirtualBox::openDVDImage"/></li>
9414	<li><link to="IVirtualBox::openFloppyImage"/></li>
9415	</ul>
9416
9417	New hard disk media can be created with the VirtualBox API using the
9418	<link to="IVirtualBox::createHardDisk"/> method.
9419
9420	CD/DVD and floppy images (ISO and RAW files) are usually created outside
9421	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
9422	type in a regular file.
9423
9424	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
9425	drive; in that case the <link to="#id" /> attribute contains the UUID of
9426	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
9427
9428	<h3>Known media</h3>
9429
9430	When an existing medium is opened for the first time, it is automatically
9431	remembered by the given VirtualBox installation or, in other words, becomes
9432	a <i>known medium</i>. Known media are stored in the media
9433	registry transparently maintained by VirtualBox and stored in settings
9434	files so that this registry is preserved when VirtualBox is not running.
9435
9436	Newly created virtual media are remembered only when the associated
9437	storage unit is actually created.
9438
9439	All known media can be enumerated using
9440	<link to="IVirtualBox::hardDisks"/>,
9441	<link to="IVirtualBox::DVDImages"/> and
9442	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
9443	quickly found by UUID using <link to="IVirtualBox::getHardDisk"/>
9444	and similar methods or by location using
9445	<link to="IVirtualBox::findHardDisk"/> and similar methods.
9446
9447	Only known media can be attached to virtual machines.
9448
9449	Removing known media from the media registry is performed when the given
9450	medium is closed using the <link to="#close"/> method or when its
9451	associated storage unit is deleted.
9452
9453	<h3>Accessibility checks</h3>
9454
9455	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
9456	method is called explicitly on a medium. This is done to make the VirtualBox object
9457	ready for serving requests as fast as possible and let the end-user
9458	application decide if it needs to check media accessibility right away or not.
9459
9460	As a result, when VirtualBox starts up (e.g. the VirtualBox
9461	object gets created for the first time), all known media are in the
9462	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
9463	attribute is an empty string because no actual accessibility check has
9464	been made yet.
9465
9466	After calling <link to="#refreshState" />, a medium is considered
9467	<i>accessible</i> if its storage unit can be read. In that case, the
9468	<link to="#state"/> attribute has a value of "Created". If the storage
9469	unit cannot be read (for example, because it is located on a disconnected
9470	network resource, or was accidentally deleted outside VirtualBox),
9471	the medium is considered <i>inaccessible</i>, which is indicated by the
9472	"Inaccessible" state. The exact reason why the medium is inaccessible can be
9473	obtained by reading the <link to="#lastAccessError"/> attribute.
9474
9475	<h3>Medium types</h3>
9476
9477	There are three types of medium behavior (see <link to="MediumType" />):
9478	"normal", "immutable" and "writethrough", represented by the
9479	<link to="#type"/> attribute. The type of the medium defines how the
9480	medium is attached to a virtual machine and what happens when a
9481	<link to="ISnapshot">snapshot</link> of the virtual machine with the
9482	attached medium is taken. At the moment DVD and floppy media are always
9483	of type "writethrough".
9484
9485	All media can be also divided in two groups: <i>base</i> media and
9486	<i>differencing</i> media. A base medium contains all sectors of the
9487	medium data in its own storage and therefore can be used independently.
9488	In contrast, a differencing mediun is a "delta" to some other medium and
9489	contains only those sectors which differ from that other medium, which is
9490	then called a <i>parent</i>. The differencing medium is said to be
9491	<i>linked to</i> that parent. The parent may be itself a differencing
9492	medium, thus forming a chain of linked media. The last element in that
9493	chain must always be a base medium. Note that several differencing
9494	media may be linked to the same parent medium.
9495
9496	Differencing media can be distinguished from base media by querying the
9497	<link to="#parent"/> attribute: base media do not have parents they would
9498	depend on, so the value of this attribute is always @c null for them.
9499	Using this attribute, it is possible to walk up the medium tree (from the
9500	child medium to its parent). It is also possible to walk down the tree
9501	using the <link to="#children"/> attribute.
9502
9503	Note that the type of all differencing media is "Normal"; all other
9504	values are meaningless for them. Base media may be of any type.
9505
9506	<h3>Creating hard disks</h3>
9507
9508	New base hard disks are created using
9509	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
9510	opened using <link to="IVirtualBox::openHardDisk"/>. Differencing hard
9511	disks are usually implicitly created by VirtualBox when needed but may
9512	also be created explicitly using <link to="#createDiffStorage"/>.
9513
9514	After the hard disk is successfully created (including the storage unit)
9515	or opened, it becomes a known hard disk (remembered in the internal media
9516	registry). Known hard disks can be attached to a virtual machine, accessed
9517	through <link to="IVirtualBox::getHardDisk"/> and
9518	<link to="IVirtualBox::findHardDisk"/> methods or enumerated using the
9519	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
9520
9521	The following methods, besides <link to="IMedium::close"/>,
9522	automatically remove the hard disk from the media registry:
9523	<ul>
9524	<li><link to="#deleteStorage"/></li>
9525	<li><link to="#mergeTo"/></li>
9526	</ul>
9527
9528	If the storage unit of the hard disk is a regular file in the host's
9529	file system then the rules stated in the description of the
9530	<link to="IMedium::location"/> attribute apply when setting its value. In
9531	addition, a plain file name without any path may be given, in which case
9532	the <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
9533	folder</link> will be prepended to it.
9534
9535	<h4>Automatic composition of the file name part</h4>
9536
9537	Another extension to the <link to="IMedium::location"/> attribute is that
9538	there is a possibility to cause VirtualBox to compose a unique value for
9539	the file name part of the location using the UUID of the hard disk. This
9540	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
9541	e.g. before the storage unit is created, and works as follows. You set the
9542	value of the <link to="IMedium::location"/> attribute to a location
9543	specification which only contains the path specification but not the file
9544	name part and ends with either a forward slash or a backslash character.
9545	In response, VirtualBox will generate a new UUID for the hard disk and
9546	compose the file name using the following pattern:
9547	<pre>
9548	<path>/{<uuid>}.<ext>
9549	</pre>
9550	where <tt><path></tt> is the supplied path specification,
9551	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
9552	is the default extension for the storage format of this hard disk. After
9553	that, you may call any of the methods that create a new hard disk storage
9554	unit and they will use the generated UUID and file name.
9555
9556	<h3>Attaching Hard Disks</h3>
9557
9558	Hard disks are attached to virtual machines using the
9559	<link to="IMachine::attachDevice"/> method and detached using the
9560	<link to="IMachine::detachDevice"/> method. Depending on their
9561	<link to="#type"/>, hard disks are attached either
9562	<i>directly</i> or <i>indirectly</i>.
9563
9564	When a hard disk is being attached directly, it is associated with the
9565	virtual machine and used for hard disk operations when the machine is
9566	running. When a hard disk is being attached indirectly, a new differencing
9567	hard disk linked to it is implicitly created and this differencing hard
9568	disk is associated with the machine and used for hard disk operations.
9569	This also means that if <link to="IMachine::attachDevice"/> performs
9570	a direct attachment then the same hard disk will be returned in response
9571	to the subsequent <link to="IMachine::getMedium"/> call; however if
9572	an indirect attachment is performed then
9573	<link to="IMachine::getMedium"/> will return the implicitly created
9574	differencing hard disk, not the original one passed to <link
9575	to="IMachine::attachDevice"/>. In detail:
9576
9577	<ul>
9578	<li><b>Normal base</b> hard disks that do not have children (i.e.
9579	differencing hard disks linked to them) and that are not already
9580	attached to virtual machines in snapshots are attached <b>directly</b>.
9581	Otherwise, they are attached <b>indirectly</b> because having
9582	dependent children or being part of the snapshot makes it impossible
9583	to modify hard disk contents without breaking the integrity of the
9584	dependent party. The <link to="#readOnly"/> attribute allows to
9585	quickly determine the kind of the attachment for the given hard
9586	disk. Note that if a normal base hard disk is to be indirectly
9587	attached to a virtual machine with snapshots then a special
9588	procedure called <i>smart attachment</i> is performed (see below).</li>
9589	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
9590	they are attached <b>directly</b> if they do not have children and are
9591	not attached to virtual machines in snapshots, and <b>indirectly</b>
9592	otherwise. Note that the smart attachment procedure is never performed
9593	for differencing hard disks.</li>
9594	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
9595	they are designed to be non-writable. If an immutable hard disk is
9596	attached to a virtual machine with snapshots then a special
9597	procedure called smart attachment is performed (see below).</li>
9598	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
9599	also as designed. This also means that writethrough hard disks cannot
9600	have other hard disks linked to them at all.</li>
9601	</ul>
9602
9603	Note that the same hard disk, regardless of its type, may be attached to
9604	more than one virtual machine at a time. In this case, the machine that is
9605	started first gains exclusive access to the hard disk and attempts to
9606	start other machines having this hard disk attached will fail until the
9607	first machine is powered down.
9608
9609	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
9610	that the given hard disk remains associated with the given machine after a
9611	successful <link to="IMachine::detachDevice"/> call until
9612	<link to="IMachine::saveSettings"/> is called to save all changes to
9613	machine settings to disk. This deferring is necessary to guarantee that
9614	the hard disk configuration may be restored at any time by a call to
9615	<link to="IMachine::discardSettings"/> before the settings
9616	are saved (committed).
9617
9618	Note that if <link to="IMachine::discardSettings"/> is called after
9619	indirectly attaching some hard disks to the machine but before a call to
9620	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
9621	all differencing hard disks implicitly created by
9622	<link to="IMachine::attachDevice"/> for these indirect attachments.
9623	Such implicitly created hard disks will also be immediately deleted when
9624	detached explicitly using the <link to="IMachine::detachDevice"/>
9625	call if it is made before <link to="IMachine::saveSettings"/>. This
9626	implicit deletion is safe because newly created differencing hard
9627	disks do not contain any user data.
9628
9629	However, keep in mind that detaching differencing hard disks that were
9630	implicitly created by <link to="IMachine::attachDevice"/>
9631	before the last <link to="IMachine::saveSettings"/> call will
9632	<b>not</b> implicitly delete them as they may already contain some data
9633	(for example, as a result of virtual machine execution). If these hard
9634	disks are no more necessary, the caller can always delete them explicitly
9635	using <link to="#deleteStorage"/> after they are actually de-associated
9636	from this machine by the <link to="IMachine::saveSettings"/> call.
9637
9638	<h3>Smart Attachment</h3>
9639
9640	When normal base or immutable hard disks are indirectly attached to a
9641	virtual machine then some additional steps are performed to make sure the
9642	virtual machine will have the most recent "view" of the hard disk being
9643	attached. These steps include walking through the machine's snapshots
9644	starting from the current one and going through ancestors up to the first
9645	snapshot. Hard disks attached to the virtual machine in all
9646	of the encountered snapshots are checked whether they are descendants of
9647	the given normal base or immutable hard disk. The first found child (which
9648	is the differencing hard disk) will be used instead of the normal base or
9649	immutable hard disk as a parent for creating a new differencing hard disk
9650	that will be actually attached to the machine. And only if no descendants
9651	are found or if the virtual machine does not have any snapshots then the
9652	normal base or immutable hard disk will be used itself as a parent for
9653	this differencing hard disk.
9654
9655	It is easier to explain what smart attachment does using the
9656	following example:
9657	<pre>
9658	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9659
9660	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9661	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9662	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9663	Snapshot 4 (none) Snapshot 4 (none)
9664	CurState (none) CurState (D3->D2.vdi)
9665
9666	NOT
9667	...
9668	CurState (D3->B.vdi)
9669	</pre>
9670	The first column is the virtual machine configuration before the base hard
9671	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9672	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9673	mean that the hard disk that is actually attached to the machine is a
9674	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9675	another hard disk, <tt>B.vdi</tt>.
9676
9677	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9678	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9679	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9680	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9681	it cannot be attached directly and needs an indirect attachment (i.e.
9682	implicit creation of a new differencing hard disk). Due to the smart
9683	attachment procedure, the new differencing hard disk
9684	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9685	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9686	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9687	machine.
9688
9689	Note that if there is more than one descendant hard disk of the given base
9690	hard disk found in a snapshot, and there is an exact device, channel and
9691	bus match, then this exact match will be used. Otherwise, the youngest
9692	descendant will be picked up.
9693
9694	There is one more important aspect of the smart attachment procedure which
9695	is not related to snapshots at all. Before walking through the snapshots
9696	as described above, the backup copy of the current list of hard disk
9697	attachment is searched for descendants. This backup copy is created when
9698	the hard disk configuration is changed for the first time after the last
9699	<link to="IMachine::saveSettings"/> call and used by
9700	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9701	changes. When such a descendant is found in this backup copy, it will be
9702	simply re-attached back, without creating a new differencing hard disk for
9703	it. This optimization is necessary to make it possible to re-attach the
9704	base or immutable hard disk to a different bus, channel or device slot
9705	without losing the contents of the differencing hard disk actually
9706	attached to the machine in place of it.
9707	</desc>
9708
9709	<attribute name="id" type="uuid" mod="string" readonly="yes">
9710	<desc>
9711	UUID of the medium. For a newly created medium, this value is a randomly
9712	generated UUID.
9713
9714	<note>
9715	For media in one of MediumState_NotCreated, MediumState_Creating or
9716	MediumState_Deleting states, the value of this property is undefined
9717	and will most likely be an empty UUID.
9718	</note>
9719	</desc>
9720	</attribute>
9721
9722	<attribute name="description" type="wstring">
9723	<desc>
9724	Optional description of the medium. For a newly created medium the value
9725	of this attribute is an empty string.
9726
9727	Medium types that don't support this attribute will return E_NOTIMPL in
9728	attempt to get or set this attribute's value.
9729
9730	<note>
9731	For some storage types, reading this attribute may return an outdated
9732	(last known) value when <link to="#state"/> is <link
9733	to="MediumState_Inaccessible"/> or <link
9734	to="MediumState_LockedWrite"/> because the value of this attribute is
9735	stored within the storage unit itself. Also note that changing the
9736	attribute value is not possible in such case, as well as when the
9737	medium is the <link to="MediumState_LockedRead"/> state.
9738	</note>
9739	</desc>
9740	</attribute>
9741
9742	<attribute name="state" type="MediumState" readonly="yes">
9743	<desc>
9744	Returns the current medium state, which is the last state set by
9745	the accessibility check performed by <link to="#refreshState"/>.
9746	If that method has not yet been called on the medium, the state
9747	is "Inaccessible"; as opposed to truly inaccessible media, the
9748	value of <link to="#lastAccessError"/> will be an empty string in
9749	that case.
9750
9751	<note>As of version 3.1, this no longer performs an accessibility check
9752	automatically; call <link to="#refreshState"/> for that.
9753	</note>
9754	</desc>
9755	</attribute>
9756
9757	<attribute name="location" type="wstring">
9758	<desc>
9759	Location of the storage unit holding medium data.
9760
9761	The format of the location string is medium type specific. For medium
9762	types using regular files in a host's file system, the location
9763	string is the full file name.
9764
9765	Some medium types may support changing the storage unit location by
9766	simply changing the value of this property. If this operation is not
9767	supported, the implementation will return E_NOTIMPL in attempt to set
9768	this attribute's value.
9769
9770	When setting a value of the location attribute which is a regular file
9771	in the host's file system, the given file name may be either relative to
9772	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9773	absolute. Note that if the given location specification does not contain
9774	the file extension part then a proper default extension will be
9775	automatically appended by the implementation depending on the medium type.
9776	</desc>
9777	</attribute>
9778
9779	<attribute name="name" type="wstring" readonly="yes">
9780	<desc>
9781	Name of the storage unit holding medium data.
9782
9783	The returned string is a short version of the <link to="#location"/>
9784	attribute that is suitable for representing the medium in situations
9785	where the full location specification is too long (such as lists
9786	and comboboxes in GUI frontends). This string is also used by frontends
9787	to sort the media list alphabetically when needed.
9788
9789	For example, for locations that are regular files in the host's file
9790	system, the value of this attribute is just the file name (+ extension),
9791	without the path specification.
9792
9793	Note that as opposed to the <link to="#location"/> attribute, the name
9794	attribute will not necessary be unique for a list of media of the
9795	given type and format.
9796	</desc>
9797	</attribute>
9798
9799	<attribute name="deviceType" type="DeviceType" readonly="yes">
9800	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9801	medium.</desc>
9802	</attribute>
9803
9804	<attribute name="hostDrive" type="boolean" readonly="yes">
9805	<desc>True if this corresponds to a drive on the host.</desc>
9806	</attribute>
9807
9808	<attribute name="size" type="unsigned long long" readonly="yes">
9809	<desc>
9810	Physical size of the storage unit used to hold medium data (in bytes).
9811
9812	<note>
9813	For media whose <link to="#state"/> is <link
9814	to="MediumState_Inaccessible"/>, the value of this property is the
9815	last known size. For <link to="MediumState_NotCreated"/> media,
9816	the returned value is zero.
9817	</note>
9818	</desc>
9819	</attribute>
9820
9821	<attribute name="format" type="wstring" readonly="yes">
9822	<desc>
9823	Storage format of this medium.
9824
9825	The value of this attribute is a string that specifies a backend used
9826	to store medium data. The storage format is defined when you create a
9827	new medium or automatically detected when you open an existing medium,
9828	and cannot be changed later.
9829
9830	The list of all storage formats supported by this VirtualBox
9831	installation can be obtained using
9832	<link to="ISystemProperties::mediumFormats"/>.
9833	</desc>
9834	</attribute>
9835
9836	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9837	<desc>
9838	Storage medium format object corresponding to this medium.
9839
9840	The value of this attribute is a reference to the medium format object
9841	that specifies the backend properties used to store medium data. The
9842	storage format is defined when you create a new medium or automatically
9843	detected when you open an existing medium, and cannot be changed later.
9844
9845	<note>@c null is returned if there is no associated medium format
9846	object. This can e.g. happen for medium objects representing host
9847	drives and other special medium objects.</note>
9848	</desc>
9849	</attribute>
9850
9851	<attribute name="type" type="MediumType">
9852	<desc>
9853	Type (role) of this medium.
9854
9855	The following constraints apply when changing the value of this
9856	attribute:
9857	<ul>
9858	<li>If a medium is attached to a virtual machine (either in the
9859	current state or in one of the snapshots), its type cannot be
9860	changed.
9861	</li>
9862	<li>As long as the medium has children, its type cannot be set
9863	to <link to="MediumType_Writethrough"/>.
9864	</li>
9865	<li>The type of all differencing media is
9866	<link to="MediumType_Normal"/> and cannot be changed.
9867	</li>
9868	</ul>
9869
9870	The type of a newly created or opened medium is set to
9871	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9872	which have a type of <link to="MediumType_Writethrough"/>.
9873	</desc>
9874	</attribute>
9875
9876	<attribute name="parent" type="IMedium" readonly="yes">
9877	<desc>
9878	Parent of this medium (the medium this medium is directly based
9879	on).
9880
9881	Only differencing media have parents. For base (non-differencing)
9882	media, @c null is returned.
9883	</desc>
9884	</attribute>
9885
9886	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9887	<desc>
9888	Children of this medium (all differencing media directly based
9889	on this medium). A @c null array is returned if this medium
9890	does not have any children.
9891	</desc>
9892	</attribute>
9893
9894	<attribute name="base" type="IMedium" readonly="yes">
9895	<desc>
9896	Base medium of this medium.
9897
9898	If this is a differencing medium, its base medium is the medium
9899	the given medium branch starts from. For all other types of media, this
9900	property returns the medium object itself (i.e. the same object this
9901	property is read on).
9902	</desc>
9903	</attribute>
9904
9905	<attribute name="readOnly" type="boolean" readonly="yes">
9906	<desc>
9907	Returns @c true if this medium is read-only and @c false otherwise.
9908
9909	A medium is considered to be read-only when its contents cannot be
9910	modified without breaking the integrity of other parties that depend on
9911	this medium such as its child media or snapshots of virtual machines
9912	where this medium is attached to these machines. If there are no
9913	children and no such snapshots then there is no dependency and the
9914	medium is not read-only.
9915
9916	The value of this attribute can be used to determine the kind of the
9917	attachment that will take place when attaching this medium to a
9918	virtual machine. If the value is @c false then the medium will
9919	be attached directly. If the value is @c true then the medium
9920	will be attached indirectly by creating a new differencing child
9921	medium for that. See the interface description for more information.
9922
9923	Note that all <link to="MediumType_Immutable">Immutable</link> media
9924	are always read-only while all
9925	<link to="MediumType_Writethrough">Writethrough</link> media are
9926	always not.
9927
9928	<note>
9929	The read-only condition represented by this attribute is related to
9930	the medium type and usage, not to the current
9931	<link to="IMedium::state">medium state</link> and not to the read-only
9932	state of the storage unit.
9933	</note>
9934	</desc>
9935	</attribute>
9936
9937	<attribute name="logicalSize" type="unsigned long long" readonly="yes">
9938	<desc>
9939	Logical size of this medium (in megabytes), as reported to the
9940	guest OS running inside the virtual machine this medium is
9941	attached to. The logical size is defined when the medium is created
9942	and cannot be changed later.
9943
9944	<note>
9945	Reading this property on a differencing medium will return the size
9946	of its <link to="#base"/> medium.
9947	</note>
9948	<note>
9949	For media whose state is <link to="#state"/> is <link
9950	to="MediumState_Inaccessible"/>, the value of this property is the
9951	last known logical size. For <link to="MediumaState_NotCreated"/>
9952	media, the returned value is zero.
9953	</note>
9954	</desc>
9955	</attribute>
9956
9957	<attribute name="autoReset" type="boolean">
9958	<desc>
9959	Whether this differencing medium will be automatically reset each
9960	time a virtual machine it is attached to is powered up. This
9961	attribute is automatically set to @c true for the last
9962	differencing image of an "immutable" medium (see
9963	<link to="MediumType" />).
9964
9965	See <link to="#reset"/> for more information about resetting
9966	differencing media.
9967
9968	<note>
9969	Reading this property on a base (non-differencing) medium will
9970	always @c false. Changing the value of this property in this
9971	case is not supported.
9972	</note>
9973
9974	<result name="VBOX_E_NOT_SUPPORTED">
9975	This is not a differencing medium (when changing the attribute
9976	value).
9977	</result>
9978	</desc>
9979	</attribute>
9980
9981	<attribute name="lastAccessError" type="wstring" readonly="yes">
9982	<desc>
9983	Text message that represents the result of the last accessibility
9984	check performed by <link to="#refreshState"/>.
9985
9986	An empty string is returned if the last accessibility check
9987	was successful or has not yet been called. As a result, if
9988	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9989	then <link to="#refreshState"/> has yet to be called; this is the
9990	default value of media after VirtualBox initialization.
9991	A non-empty string indicates a failure and should normally describe
9992	a reason of the failure (for example, a file read error).
9993	</desc>
9994	</attribute>
9995
9996	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9997	<desc>
9998	Array of UUIDs of all machines this medium is attached to.
9999
10000	A @c null array is returned if this medium is not attached to any
10001	machine or to any machine's snapshot.
10002
10003	<note>
10004	The returned array will include a machine even if this medium is not
10005	attached to that machine in the current state but attached to it in
10006	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
10007	details.
10008	</note>
10009	</desc>
10010	</attribute>
10011
10012	<method name="refreshState">
10013	<desc>
10014	If the current medium state (see <link to="MediumState"/>) is one of
10015	"Created", "Inaccessible" or "LockedRead", then this performs an
10016	accessibility check on the medium and sets the value of the <link to="#state"/>
10017	attribute accordingly; that value is also returned for convenience.
10018
10019	For all other state values, this does not perform a refresh but returns
10020	the state only.
10021
10022	The refresh, if performed, may take a long time (several seconds or even
10023	minutes, depending on the storage unit location and format) because it performs an
10024	accessibility check of the storage unit. This check may cause a significant
10025	delay if the storage unit of the given medium is, for example, a file located
10026	on a network share which is not currently accessible due to connectivity
10027	problems. In that case, the call will not return until a timeout
10028	interval defined by the host OS for this operation expires. For this reason,
10029	it is recommended to never read this attribute on the main UI thread to avoid
10030	making the UI unresponsive.
10031
10032	If the last known state of the medium is "Created" and the accessibility
10033	check fails, then the state would be set to "Inaccessible", and
10034	<link to="#lastAccessError"/> may be used to get more details about the
10035	failure. If the state of the medium is "LockedRead", then it remains the
10036	same, and a non-empty value of <link to="#lastAccessError"/> will
10037	indicate a failed accessibility check in this case.
10038
10039	Note that not all medium states are applicable to all medium types.
10040	</desc>
10041	<param name="state" type="MediumState" dir="return">
10042	<desc>
10043	New medium state.
10044	</desc>
10045	</param>
10046	</method>
10047
10048	<method name="getSnapshotIds">
10049	<desc>
10050	Returns an array of UUIDs of all snapshots of the given machine where
10051	this medium is attached to.
10052
10053	If the medium is attached to the machine in the current state, then the
10054	first element in the array will always be the ID of the queried machine
10055	(i.e. the value equal to the @c machineId argument), followed by
10056	snapshot IDs (if any).
10057
10058	If the medium is not attached to the machine in the current state, then
10059	the array will contain only snapshot IDs.
10060
10061	The returned array may be @c null if this medium is not attached
10062	to the given machine at all, neither in the current state nor in one of
10063	the snapshots.
10064	</desc>
10065	<param name="machineId" type="uuid" mod="string" dir="in">
10066	<desc>
10067	UUID of the machine to query.
10068	</desc>
10069	</param>
10070	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
10071	<desc>
10072	Array of snapshot UUIDs of the given machine using this medium.
10073	</desc>
10074	</param>
10075	</method>
10076
10077	<method name="lockRead">
10078	<desc>
10079	Locks this medium for reading.
10080
10081	A read lock is shared: many clients can simultaneously lock the
10082	same medium for reading unless it is already locked for writing (see
10083	<link to="#lockWrite"/>) in which case an error is returned.
10084
10085	When the medium is locked for reading, it cannot be modified
10086	from within VirtualBox. This means that any method that changes
10087	the properties of this medium or contents of the storage unit
10088	will return an error (unless explicitly stated otherwise). That
10089	includes an attempt to start a virtual machine that wants to
10090	write to the the medium.
10091
10092	When the virtual machine is started up, it locks for reading all
10093	media it uses in read-only mode. If some medium cannot be locked
10094	for reading, the startup procedure will fail.
10095	A medium is typically locked for reading while it is used by a running
10096	virtual machine but has a depending differencing image that receives
10097	the actual write operations. This way one base medium can have
10098	multiple child differencing images which can be written to
10099	simultaneously. Read-only media such as DVD and floppy images are
10100	also locked for reading only (so they can be in use by multiple
10101	machines simultaneously).
10102
10103	A medium is also locked for reading when it is the source of a
10104	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
10105
10106	The medium locked for reading must be unlocked using the <link
10107	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
10108	can be nested and must be followed by the same number of paired
10109	<link to="#unlockRead"/> calls.
10110
10111	This method sets the medium state (see <link to="#state"/>) to
10112	"LockedRead" on success. The medium's previous state must be
10113	one of "Created", "Inaccessible" or "LockedRead".
10114
10115	Locking an inaccessible medium is not an error; this method performs
10116	a logical lock that prevents modifications of this medium through
10117	the VirtualBox API, not a physical file-system lock of the underlying
10118	storage unit.
10119
10120	This method returns the current state of the medium
10121	<i>before</i> the operation.
10122
10123	<result name="VBOX_E_INVALID_OBJECT_STATE">
10124	Invalid medium state (e.g. not created, locked, inaccessible,
10125	creating, deleting).
10126	</result>
10127
10128	</desc>
10129	<param name="state" type="MediumState" dir="return">
10130	<desc>
10131	State of the medium after the operation.
10132	</desc>
10133	</param>
10134	</method>
10135
10136	<method name="unlockRead">
10137	<desc>
10138	Cancels the read lock previously set by <link to="#lockRead"/>.
10139
10140	For both success and failure, this method returns the current state
10141	of the medium <i>after</i> the operation.
10142
10143	See <link to="#lockRead"/> for more details.
10144
10145	<result name="VBOX_E_INVALID_OBJECT_STATE">
10146	Medium not locked for reading.
10147	</result>
10148
10149	</desc>
10150	<param name="state" type="MediumState" dir="return">
10151	<desc>
10152	State of the medium after the operation.
10153	</desc>
10154	</param>
10155	</method>
10156
10157	<method name="lockWrite">
10158	<desc>
10159	Locks this medium for writing.
10160
10161	A write lock, as opposed to <link to="#lockRead"/>, is
10162	exclusive: there may be only one client holding a write lock,
10163	and there may be no read locks while the write lock is held.
10164	As a result, read-locking fails if a write lock is held, and
10165	write-locking fails if either a read or another write lock is held.
10166
10167	When a medium is locked for writing, it cannot be modified
10168	from within VirtualBox, and it is not guaranteed that the values
10169	of its properties are up-to-date. Any method that changes the
10170	properties of this medium or contents of the storage unit will
10171	return an error (unless explicitly stated otherwise).
10172
10173	When a virtual machine is started up, it locks for writing all
10174	media it uses to write data to. If any medium could not be locked
10175	for writing, the startup procedure will fail. If a medium has
10176	differencing images, then while the machine is running, only
10177	the last ("leaf") differencing image is locked for writing,
10178	whereas its parents are locked for reading only.
10179
10180	A medium is also locked for writing when it is the target of a
10181	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
10182
10183	The medium locked for writing must be unlocked using the <link
10184	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
10185
10186	This method sets the medium state (see <link to="#state"/>) to
10187	"LockedWrite" on success. The medium's previous state must be
10188	either "Created" or "Inaccessible".
10189
10190	Locking an inaccessible medium is not an error; this method performs
10191	a logical lock that prevents modifications of this medium through
10192	the VirtualBox API, not a physical file-system lock of the underlying
10193	storage unit.
10194
10195	For both, success and failure, this method returns the current
10196	state of the medium <i>before</i> the operation.
10197
10198	<result name="VBOX_E_INVALID_OBJECT_STATE">
10199	Invalid medium state (e.g. not created, locked, inaccessible,
10200	creating, deleting).
10201	</result>
10202
10203	</desc>
10204	<param name="state" type="MediumState" dir="return">
10205	<desc>
10206	State of the medium after the operation.
10207	</desc>
10208	</param>
10209	</method>
10210
10211	<method name="unlockWrite">
10212	<desc>
10213	Cancels the write lock previously set by <link to="#lockWrite"/>.
10214
10215	For both success and failure, this method returns the current
10216	state of the medium <i>after</i> the operation.
10217
10218	See <link to="#lockWrite"/> for more details.
10219
10220	<result name="VBOX_E_INVALID_OBJECT_STATE">
10221	Medium not locked for writing.
10222	</result>
10223
10224	</desc>
10225	<param name="state" type="MediumState" dir="return">
10226	<desc>
10227	State of the medium after the operation.
10228	</desc>
10229	</param>
10230	</method>
10231
10232	<method name="close">
10233	<desc>
10234	Closes this medium.
10235
10236	The medium must not be attached to any known virtual machine
10237	and must not have any known child media, otherwise the
10238	operation will fail.
10239
10240	When the medium is successfully closed, it gets removed from
10241	the list of remembered media, but its storage unit is not
10242	deleted. In particular, this means that this medium can be
10243	later opened again using the <link
10244	to="IVirtualBox::openHardDisk"/> call.
10245
10246	Note that after this method successfully returns, the given medium
10247	object becomes uninitialized. This means that any attempt
10248	to call any of its methods or attributes will fail with the
10249	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
10250
10251	<result name="VBOX_E_INVALID_OBJECT_STATE">
10252	Invalid medium state (other than not created, created or
10253	inaccessible).
10254	</result>
10255	<result name="VBOX_E_OBJECT_IN_USE">
10256	Medium attached to virtual machine.
10257	</result>
10258	<result name="VBOX_E_FILE_ERROR">
10259	Settings file not accessible.
10260	</result>
10261	<result name="VBOX_E_XML_ERROR">
10262	Could not parse the settings file.
10263	</result>
10264
10265	</desc>
10266	</method>
10267
10268	<!-- storage methods -->
10269
10270	<method name="getProperty">
10271	<desc>
10272	Returns the value of the custom medium property with the given name.
10273
10274	The list of all properties supported by the given medium format can
10275	be obtained with <link to="IMediumFormat::describeProperties"/>.
10276
10277	Note that if this method returns an empty string in @a value, the
10278	requested property is supported but currently not assigned any value.
10279
10280	<result name="VBOX_E_OBJECT_NOT_FOUND">
10281	Requested property does not exist (not supported by the format).
10282	</result>
10283	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10284	</desc>
10285	<param name="name" type="wstring" dir="in">
10286	<desc>Name of the property to get.</desc>
10287	</param>
10288	<param name="value" type="wstring" dir="return">
10289	<desc>Current property value.</desc>
10290	</param>
10291	</method>
10292
10293	<method name="setProperty">
10294	<desc>
10295	Sets the value of the custom medium property with the given name.
10296
10297	The list of all properties supported by the given medium format can
10298	be obtained with <link to="IMediumFormat::describeProperties"/>.
10299
10300	Note that setting the property value to @c null or an empty string is
10301	equivalent to deleting the existing value. A default value (if it is
10302	defined for this property) will be used by the format backend in this
10303	case.
10304
10305	<result name="VBOX_E_OBJECT_NOT_FOUND">
10306	Requested property does not exist (not supported by the format).
10307	</result>
10308	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10309	</desc>
10310	<param name="name" type="wstring" dir="in">
10311	<desc>Name of the property to set.</desc>
10312	</param>
10313	<param name="value" type="wstring" dir="in">
10314	<desc>Property value to set.</desc>
10315	</param>
10316	</method>
10317
10318	<method name="getProperties">
10319	<desc>
10320	Returns values for a group of properties in one call.
10321
10322	The names of the properties to get are specified using the @a names
10323	argument which is a list of comma-separated property names or
10324	an empty string if all properties are to be returned. Note that currently
10325	the value of this argument is ignored and the method always returns all
10326	existing properties.
10327
10328	The list of all properties supported by the given medium format can
10329	be obtained with <link to="IMediumFormat::describeProperties"/>.
10330
10331	The method returns two arrays, the array of property names corresponding
10332	to the @a names argument and the current values of these properties.
10333	Both arrays have the same number of elements with each elemend at the
10334	given index in the first array corresponds to an element at the same
10335	index in the second array.
10336
10337	Note that for properties that do not have assigned values,
10338	an empty string is returned at the appropriate index in the
10339	@a returnValues array.
10340
10341	</desc>
10342	<param name="names" type="wstring" dir="in">
10343	<desc>
10344	Names of properties to get.
10345	</desc>
10346	</param>
10347	<param name="returnNames" type="wstring" safearray="yes" dir="out">
10348	<desc>Names of returned properties.</desc>
10349	</param>
10350	<param name="returnValues" type="wstring" safearray="yes" dir="return">
10351	<desc>Values of returned properties.</desc>
10352	</param>
10353	</method>
10354
10355	<method name="setProperties">
10356	<desc>
10357	Sets values for a group of properties in one call.
10358
10359	The names of the properties to set are passed in the @a names
10360	array along with the new values for them in the @a values array. Both
10361	arrays have the same number of elements with each elemend at the given
10362	index in the first array corresponding to an element at the same index
10363	in the second array.
10364
10365	If there is at least one property name in @a names that is not valid,
10366	the method will fail before changing the values of any other properties
10367	from the @a names array.
10368
10369	Using this method over <link to="#setProperty"/> is preferred if you
10370	need to set several properties at once since it will result into less
10371	IPC calls.
10372
10373	The list of all properties supported by the given medium format can
10374	be obtained with <link to="IMediumFormat::describeProperties"/>.
10375
10376	Note that setting the property value to @c null or an empty string is
10377	equivalent to deleting the existing value. A default value (if it is
10378	defined for this property) will be used by the format backend in this
10379	case.
10380	</desc>
10381	<param name="names" type="wstring" safearray="yes" dir="in">
10382	<desc>Names of properties to set.</desc>
10383	</param>
10384	<param name="values" type="wstring" safearray="yes" dir="in">
10385	<desc>Values of properties to set.</desc>
10386	</param>
10387	</method>
10388
10389	<!-- storage methods -->
10390
10391	<method name="createBaseStorage">
10392	<desc>
10393	Starts creating a hard disk storage unit (fixed/dynamic, according
10394	to the variant flags) in in the background. The previous storage unit
10395	created for this object, if any, must first be deleted using
10396	<link to="#deleteStorage"/>, otherwise the operation will fail.
10397
10398	Before the operation starts, the medium is placed in
10399	<link to="MediumState_Creating"/> state. If the create operation
10400	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
10401	state.
10402
10403	After the returned progress object reports that the operation has
10404	successfully completed, the medium state will be set to <link
10405	to="MediumState_Created"/>, the medium will be remembered by this
10406	VirtualBox installation and may be attached to virtual machines.
10407
10408	<result name="VBOX_E_NOT_SUPPORTED">
10409	The variant of storage creation operation is not supported. See <link
10410	to="IMediumFormat::capabilities"/>.
10411	</result>
10412	</desc>
10413	<param name="logicalSize" type="unsigned long long" dir="in">
10414	<desc>Maximum logical size of the medium in megabytes.</desc>
10415	</param>
10416	<param name="variant" type="MediumVariant" dir="in">
10417	<desc>Exact image variant which should be created.</desc>
10418	</param>
10419	<param name="progress" type="IProgress" dir="return">
10420	<desc>Progress object to track the operation completion.</desc>
10421	</param>
10422	</method>
10423
10424	<method name="deleteStorage">
10425	<desc>
10426	Starts deleting the storage unit of this medium.
10427
10428	The medium must not be attached to any known virtual machine and must
10429	not have any known child media, otherwise the operation will fail.
10430	It will also fail if there is no storage unit to delete or if deletion
10431	is already in progress, or if the medium is being in use (locked for
10432	read or for write) or inaccessible. Therefore, the only valid state for
10433	this operation to succeed is <link to="MediumState_Created"/>.
10434
10435	Before the operation starts, the medium is placed in
10436	<link to="MediumState_Deleting"/> state and gets removed from the list
10437	of remembered hard disks (media registry). If the delete operation
10438	fails, the medium will be remembered again and placed back to
10439	<link to="MediumState_Created"/> state.
10440
10441	After the returned progress object reports that the operation is
10442	complete, the medium state will be set to
10443	<link to="MediumState_NotCreated"/> and you will be able to use one of
10444	the storage creation methods to create it again.
10445
10446	<see>#close()</see>
10447
10448	<result name="VBOX_E_OBJECT_IN_USE">
10449	Medium is attached to a virtual machine.
10450	</result>
10451	<result name="VBOX_E_NOT_SUPPORTED">
10452	Storage deletion is not allowed because neither of storage creation
10453	operations are supported. See
10454	<link to="IMediumFormat::capabilities"/>.
10455	</result>
10456
10457	<note>
10458	If the deletion operation fails, it is not guaranteed that the storage
10459	unit still exists. You may check the <link to="IMedium::state"/> value
10460	to answer this question.
10461	</note>
10462	</desc>
10463	<param name="progress" type="IProgress" dir="return">
10464	<desc>Progress object to track the operation completion.</desc>
10465	</param>
10466	</method>
10467
10468	<!-- diff methods -->
10469
10470	<method name="createDiffStorage">
10471	<desc>
10472	Starts creating an empty differencing storage unit based on this
10473	medium in the format and at the location defined by the @a target
10474	argument.
10475
10476	The target medium must be in <link to="MediumState_NotCreated"/>
10477	state (i.e. must not have an existing storage unit). Upon successful
10478	completion, this operation will set the type of the target medium to
10479	<link to="MediumType_Normal"/> and create a storage unit necessary to
10480	represent the differencing medium data in the given format (according
10481	to the storage format of the target object).
10482
10483	After the returned progress object reports that the operation is
10484	successfully complete, the target medium gets remembered by this
10485	VirtualBox installation and may be attached to virtual machines.
10486
10487	<note>
10488	The medium will be set to <link to="MediumState_LockedRead"/>
10489	state for the duration of this operation.
10490	</note>
10491	<result name="VBOX_E_OBJECT_IN_USE">
10492	Medium not in @c NotCreated state.
10493	</result>
10494	</desc>
10495	<param name="target" type="IMedium" dir="in">
10496	<desc>Target medium.</desc>
10497	</param>
10498	<param name="variant" type="MediumVariant" dir="in">
10499	<desc>Exact image variant which should be created.</desc>
10500	</param>
10501	<param name="progress" type="IProgress" dir="return">
10502	<desc>Progress object to track the operation completion.</desc>
10503	</param>
10504	</method>
10505
10506	<method name="mergeTo">
10507	<desc>
10508	Starts merging the contents of this medium and all intermediate
10509	differencing media in the chain to the given target medium.
10510
10511	The target medium must be either a descendant of this medium or
10512	its ancestor (otherwise this method will immediately return a failure).
10513	It follows that there are two logical directions of the merge operation:
10514	from ancestor to descendant (<i>forward merge</i>) and from descendant to
10515	ancestor (<i>backward merge</i>). Let us consider the following medium
10516	chain:
10517
10518	<pre>Base <- Diff_1 <- Diff_2</pre>
10519
10520	Here, calling this method on the <tt>Base</tt> medium object with
10521	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
10522	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
10523	merge. Note that in both cases the contents of the resulting medium
10524	will be the same, the only difference is the medium object that takes
10525	the result of the merge operation. In case of the forward merge in the
10526	above example, the result will be written to <tt>Diff_2</tt>; in case of
10527	the backward merge, the result will be written to <tt>Base</tt>. In
10528	other words, the result of the operation is always stored in the target
10529	medium.
10530
10531	Upon successful operation completion, the storage units of all media in
10532	the chain between this (source) medium and the target medium, including
10533	the source medium itself, will be automatically deleted and the
10534	relevant medium objects (including this medium) will become
10535	uninitialized. This means that any attempt to call any of
10536	their methods or attributes will fail with the
10537	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
10538	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
10539	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
10540	Note that <tt>Diff_2</tt> in this case will become a base medium
10541	itself since it will no longer be based on any other medium.
10542
10543	Considering the above, all of the following conditions must be met in
10544	order for the merge operation to succeed:
10545	<ul>
10546	<li>
10547	Neither this (source) medium nor any intermediate
10548	differencing medium in the chain between it and the target
10549	medium is attached to any virtual machine.
10550	</li>
10551	<li>
10552	Neither the source medium nor the target medium is an
10553	<link to="MediumType_Immutable"/> medium.
10554	</li>
10555	<li>
10556	The part of the medium tree from the source medium to the
10557	target medium is a linear chain, i.e. all medium in this
10558	chain have exactly one child which is the next medium in this
10559	chain. The only exception from this rule is the target medium in
10560	the forward merge operation; it is allowed to have any number of
10561	child media because the merge operation will not change its
10562	logical contents (as it is seen by the guest OS or by children).
10563	</li>
10564	<li>
10565	None of the involved media are in
10566	<link to="MediumState_LockedRead"/> or
10567	<link to="MediumState_LockedWrite"/> state.
10568	</li>
10569	</ul>
10570
10571	<note>
10572	This (source) medium and all intermediates will be placed to <link
10573	to="MediumState_Deleting"/> state and the target medium will be
10574	placed to <link to="MediumState_LockedWrite"/> state and for the
10575	duration of this operation.
10576	</note>
10577	</desc>
10578	<param name="target" type="IMedium" dir="in">
10579	<desc>Target medium.</desc>
10580	</param>
10581	<param name="progress" type="IProgress" dir="return">
10582	<desc>Progress object to track the operation completion.</desc>
10583	</param>
10584	</method>
10585
10586	<!-- clone method -->
10587
10588	<method name="cloneTo">
10589	<desc>
10590	Starts creating a clone of this medium in the format and at the
10591	location defined by the @a target argument.
10592
10593	The target medium must be either in <link to="MediumState_NotCreated"/>
10594	state (i.e. must not have an existing storage unit) or in
10595	<link to="MediumState_Created"/> state (i.e. created and not locked, and
10596	big enough to hold the data or else the copy will be partial). Upon
10597	successful completion, the cloned medium will contain exactly the
10598	same sector data as the medium being cloned, except that in the
10599	first case a new UUID for the clone will be randomly generated, and in
10600	the second case the UUID will remain unchanged.
10601
10602	The @a parent argument defines which medium will be the parent
10603	of the clone. Passing a @c null reference indicates that the clone will
10604	be a base image, i.e. completely independent. It is possible to specify
10605	an arbitrary medium for this parameter, including the parent of the
10606	medium which is being cloned. Even cloning to a child of the source
10607	medium is possible. Note that when cloning to an existing image, the
10608	@a parent irgument is ignored.
10609
10610	After the returned progress object reports that the operation is
10611	successfully complete, the target medium gets remembered by this
10612	VirtualBox installation and may be attached to virtual machines.
10613
10614	<note>
10615	This medium will be placed to <link to="MediumState_LockedRead"/>
10616	state for the duration of this operation.
10617	</note>
10618	<result name="E_NOTIMPL">
10619	The specified cloning variant is not supported at the moment.
10620	</result>
10621	</desc>
10622	<param name="target" type="IMedium" dir="in">
10623	<desc>Target medium.</desc>
10624	</param>
10625	<param name="variant" type="MediumVariant" dir="in">
10626	<desc>Exact image variant which should be created.</desc>
10627	</param>
10628	<param name="parent" type="IMedium" dir="in">
10629	<desc>Parent of the cloned medium.</desc>
10630	</param>
10631	<param name="progress" type="IProgress" dir="return">
10632	<desc>Progress object to track the operation completion.</desc>
10633	</param>
10634	</method>
10635
10636	<!-- other methods -->
10637
10638	<method name="compact">
10639	<desc>
10640	Starts compacting of this medium. This means that the medium is
10641	transformed into a possibly more compact storage representation.
10642	This potentially creates temporary images, which can require a
10643	substantial amount of additional disk space.
10644
10645	This medium will be placed to <link to="MediumState_LockedWrite"/>
10646	state and all its parent media (if any) will be placed to
10647	<link to="MediumState_LockedRead"/> state for the duration of this
10648	operation.
10649
10650	Please note that the results can be either returned straight away,
10651	or later as the result of the background operation via the object
10652	returned via the @a progress parameter.
10653
10654	<result name="VBOX_E_NOT_SUPPORTED">
10655	Medium format does not support compacting (but potentially
10656	needs it).
10657	</result>
10658	</desc>
10659	<param name="progress" type="IProgress" dir="return">
10660	<desc>Progress object to track the operation completion.</desc>
10661	</param>
10662	</method>
10663
10664	<method name="resize">
10665	<desc>
10666	Starts resizing this medium. This means that the nominal size of the
10667	medium is set to the new value. Both increasing and decreasing the
10668	size is possible, and there are no safety checks, since VirtualBox
10669	does not make any assumptions about the medium contents.
10670
10671	Resizing usually needs additional disk space, and possibly also
10672	some temporary disk space. Note that resize does not create a full
10673	temporary copy of the medium, so the additional disk space requirement
10674	is usually much lower than using the clone operation.
10675
10676	This medium will be placed to <link to="MediumState_LockedWrite"/>
10677	state for the duration of this operation.
10678
10679	Please note that the results can be either returned straight away,
10680	or later as the result of the background operation via the object
10681	returned via the @a progress parameter.
10682
10683	<result name="VBOX_E_NOT_SUPPORTED">
10684	Medium format does not support resizing.
10685	</result>
10686	</desc>
10687	<param name="logicalSize" type="unsigned long long" dir="in">
10688	<desc>New nominal capacity of the medium in megabytes.</desc>
10689	</param>
10690	<param name="progress" type="IProgress" dir="return">
10691	<desc>Progress object to track the operation completion.</desc>
10692	</param>
10693	</method>
10694
10695	<method name="reset">
10696	<desc>
10697	Starts erasing the contents of this differencing medium.
10698
10699	This operation will reset the differencing medium to its initial
10700	state when it does not contain any sector data and any read operation is
10701	redirected to its parent medium. This automatically gets called
10702	during VM power-up for every medium whose <link to="#autoReset" />
10703	attribute is @c true.
10704
10705	The medium will be write-locked for the duration of this operation (see
10706	<link to="#lockWrite" />).
10707
10708	<result name="VBOX_E_NOT_SUPPORTED">
10709	This is not a differencing medium.
10710	</result>
10711	<result name="VBOX_E_INVALID_OBJECT_STATE">
10712	Medium is not in <link to="MediumState_Created"/> or
10713	<link to="MediumState_Inaccessible"/> state.
10714	</result>
10715	</desc>
10716	<param name="progress" type="IProgress" dir="return">
10717	<desc>Progress object to track the operation completion.</desc>
10718	</param>
10719	</method>
10720
10721	</interface>
10722
10723
10724	<!--
10725	// IMediumFormat
10726	/////////////////////////////////////////////////////////////////////////
10727	-->
10728
10729	<enum
10730	name="DataType"
10731	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10732	>
10733	<const name="Int32" value="0"/>
10734	<const name="Int8" value="1"/>
10735	<const name="String" value="2"/>
10736	</enum>
10737
10738	<enum
10739	name="DataFlags"
10740	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10741	>
10742	<const name="None" value="0x00"/>
10743	<const name="Mandatory" value="0x01"/>
10744	<const name="Expert" value="0x02"/>
10745	<const name="Array" value="0x04"/>
10746	<const name="FlagMask" value="0x07"/>
10747	</enum>
10748
10749	<enum
10750	name="MediumFormatCapabilities"
10751	uuid="70fcf810-99e8-4edc-aee4-7f51d489e657"
10752	>
10753	<desc>
10754	Medium format capability flags.
10755	</desc>
10756
10757	<const name="Uuid" value="0x01">
10758	<desc>
10759	Supports UUIDs as expected by VirtualBox code.
10760	</desc>
10761	</const>
10762
10763	<const name="CreateFixed" value="0x02">
10764	<desc>
10765	Supports creating fixed size images, allocating all space instantly.
10766	</desc>
10767	</const>
10768
10769	<const name="CreateDynamic" value="0x04">
10770	<desc>
10771	Supports creating dynamically growing images, allocating space on
10772	demand.
10773	</desc>
10774	</const>
10775
10776	<const name="CreateSplit2G" value="0x08">
10777	<desc>
10778	Supports creating images split in chunks of a bit less than 2 GBytes.
10779	</desc>
10780	</const>
10781
10782	<const name="Differencing" value="0x10">
10783	<desc>
10784	Supports being used as a format for differencing media (see <link
10785	to="IMedium::createDiffStorage"/>).
10786	</desc>
10787	</const>
10788
10789	<const name="Asynchronous" value="0x20">
10790	<desc>
10791	Supports asynchronous I/O operations for at least some configurations.
10792	</desc>
10793	</const>
10794
10795	<const name="File" value="0x40">
10796	<desc>
10797	The format backend operates on files (the <link to="IMedium::location"/>
10798	attribute of the medium specifies a file used to store medium
10799	data; for a list of supported file extensions see
10800	<link to="IMediumFormat::fileExtensions"/>).
10801	</desc>
10802	</const>
10803
10804	<const name="Properties" value="0x80">
10805	<desc>
10806	The format backend uses the property interface to configure the storage
10807	location and properties (the <link to="IMediumFormat::describeProperties"/>
10808	method is used to get access to properties supported by the given medium format).
10809	</desc>
10810	</const>
10811
10812	<const name="CapabilityMask" value="0xFF"/>
10813	</enum>
10814
10815	<interface
10816	name="IMediumFormat" extends="$unknown"
10817	uuid="89f52554-d469-4799-9fad-1705e86a08b1"
10818	wsmap="managed"
10819	>
10820	<desc>
10821	The IMediumFormat interface represents a medium format.
10822
10823	Each medium format has an associated backend which is used to handle
10824	media stored in this format. This interface provides information
10825	about the properties of the associated backend.
10826
10827	Each medium format is identified by a string represented by the
10828	<link to="#id"/> attribute. This string is used in calls like
10829	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10830	format.
10831
10832	The list of all supported medium formats can be obtained using
10833	<link to="ISystemProperties::mediaFormats"/>.
10834
10835	<see>IMedium</see>
10836	</desc>
10837
10838	<attribute name="id" type="wstring" readonly="yes">
10839	<desc>
10840	Identifier of this format.
10841
10842	The format identifier is a non-@c null non-empty ASCII string. Note that
10843	this string is case-insensitive. This means that, for example, all of
10844	the following strings:
10845	<pre>
10846	"VDI"
10847	"vdi"
10848	"VdI"</pre>
10849	refer to the same medium format.
10850
10851	This string is used in methods of other interfaces where it is necessary
10852	to specify a medium format, such as
10853	<link to="IVirtualBox::createHardDisk"/>.
10854	</desc>
10855	</attribute>
10856
10857	<attribute name="name" type="wstring" readonly="yes">
10858	<desc>
10859	Human readable description of this format.
10860
10861	Mainly for use in file open dialogs.
10862	</desc>
10863	</attribute>
10864
10865	<attribute name="fileExtensions" type="wstring" safearray="yes" readonly="yes">
10866	<desc>
10867	Array of strings containing the supported file extensions.
10868
10869	The first extension in the array is the extension preferred by the
10870	backend. It is recommended to use this extension when specifying a
10871	location of the storage unit for a new medium.
10872
10873	Note that some backends do not work on files, so this array may be
10874	empty.
10875
10876	<see>IMediumFormat::capabilities</see>
10877	</desc>
10878	</attribute>
10879
10880	<attribute name="capabilities" type="unsigned long" readonly="yes">
10881	<desc>
10882	Capabilities of the format as a set of bit flags.
10883
10884	For the meaning of individual capability flags see
10885	<link to="MediumFormatCapabilities"/>.
10886	</desc>
10887	</attribute>
10888
10889	<method name="describeProperties">
10890	<desc>
10891	Returns several arrays describing the properties supported by this
10892	format.
10893
10894	An element with the given index in each array describes one
10895	property. Thus, the number of elements in each returned array is the
10896	same and corresponds to the number of supported properties.
10897
10898	The returned arrays are filled in only if the
10899	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10900	All arguments must be non-@c null.
10901
10902	<see>DataType</see>
10903	<see>DataFlags</see>
10904	</desc>
10905
10906	<param name="names" type="wstring" safearray="yes" dir="out">
10907	<desc>Array of property names.</desc>
10908	</param>
10909	<param name="description" type="wstring" safearray="yes" dir="out">
10910	<desc>Array of property descriptions.</desc>
10911	</param>
10912	<param name="types" type="DataType" safearray="yes" dir="out">
10913	<desc>Array of property types.</desc>
10914	</param>
10915	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10916	<desc>Array of property flags.</desc>
10917	</param>
10918	<param name="defaults" type="wstring" safearray="yes" dir="out">
10919	<desc>Array of default property values.</desc>
10920	</param>
10921	</method>
10922
10923	</interface>
10924
10925
10926	<!--
10927	// IKeyboard
10928	/////////////////////////////////////////////////////////////////////////
10929	-->
10930
10931	<interface
10932	name="IKeyboard" extends="$unknown"
10933	uuid="2d1a531b-4c6e-49cc-8af6-5c857b78b5d7"
10934	wsmap="managed"
10935	>
10936	<desc>
10937	The IKeyboard interface represents the virtual machine's keyboard. Used
10938	in <link to="IConsole::keyboard"/>.
10939
10940	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10941	to the virtual machine.
10942
10943	</desc>
10944	<method name="putScancode">
10945	<desc>Sends a scancode to the keyboard.
10946
10947	<result name="VBOX_E_IPRT_ERROR">
10948	Could not send scan code to virtual keyboard.
10949	</result>
10950
10951	</desc>
10952	<param name="scancode" type="long" dir="in"/>
10953	</method>
10954
10955	<method name="putScancodes">
10956	<desc>Sends an array of scancodes to the keyboard.
10957
10958	<result name="VBOX_E_IPRT_ERROR">
10959	Could not send all scan codes to virtual keyboard.
10960	</result>
10961
10962	</desc>
10963	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10964	<param name="codesStored" type="unsigned long" dir="return"/>
10965	</method>
10966
10967	<method name="putCAD">
10968	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10969	function is nothing special, it is just a convenience function
10970	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10971
10972	<result name="VBOX_E_IPRT_ERROR">
10973	Could not send all scan codes to virtual keyboard.
10974	</result>
10975
10976	</desc>
10977	</method>
10978
10979	</interface>
10980
10981
10982	<!--
10983	// IMouse
10984	/////////////////////////////////////////////////////////////////////////
10985	-->
10986
10987	<enum
10988	name="MouseButtonState"
10989	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10990	>
10991	<desc>
10992	Mouse button state.
10993	</desc>
10994
10995	<const name="LeftButton" value="0x01"/>
10996	<const name="RightButton" value="0x02"/>
10997	<const name="MiddleButton" value="0x04"/>
10998	<const name="WheelUp" value="0x08"/>
10999	<const name="WheelDown" value="0x10"/>
11000	<const name="XButton1" value="0x20"/>
11001	<const name="XButton2" value="0x40"/>
11002	<const name="MouseStateMask" value="0x7F"/>
11003	</enum>
11004
11005	<interface
11006	name="IMouse" extends="$unknown"
11007	uuid="7c0f2eae-f92d-498c-b802-e1a3763774dc"
11008	wsmap="managed"
11009	>
11010	<desc>
11011	The IMouse interface represents the virtual machine's mouse. Used in
11012	<link to="IConsole::mouse"/>.
11013
11014	Through this interface, the virtual machine's virtual mouse can be
11015	controlled.
11016	</desc>
11017
11018	<attribute name="absoluteSupported" type="boolean" readonly="yes">
11019	<desc>
11020	Whether the guest OS supports absolute mouse pointer positioning
11021	or not.
11022	<note>
11023	You can use the <link to="IConsoleCallback::onMouseCapabilityChange"/>
11024	callback to be instantly informed about changes of this attribute
11025	during virtual machine execution.
11026	</note>
11027	<see><link to="#putMouseEventAbsolute"/></see>
11028	</desc>
11029	</attribute>
11030
11031	<attribute name="relativeSupported" type="boolean" readonly="yes">
11032	<desc>
11033	Whether the guest OS supports relative mouse pointer positioning
11034	or not.
11035	<note>
11036	You can use the <link to="IConsoleCallback::onMouseCapabilityChange"/>
11037	callback to be instantly informed about changes of this attribute
11038	during virtual machine execution.
11039	</note>
11040	<see><link to="#putMouseEvent"/></see>
11041	</desc>
11042	</attribute>
11043
11044	<attribute name="needsHostCursor" type="boolean" readonly="yes">
11045	<desc>
11046	Whether the guest OS can currently switch to drawing it's own mouse
11047	cursor on demand.
11048	<note>
11049	You can use the <link to="IConsoleCallback::onMouseCapabilityChange"/>
11050	callback to be instantly informed about changes of this attribute
11051	during virtual machine execution.
11052	</note>
11053	<see><link to="#putMouseEvent"/></see>
11054	</desc>
11055	</attribute>
11056
11057	<method name="putMouseEvent">
11058	<desc>
11059	Initiates a mouse event using relative pointer movements
11060	along x and y axis.
11061
11062	<result name="E_ACCESSDENIED">
11063	Console not powered up.
11064	</result>
11065	<result name="VBOX_E_IPRT_ERROR">
11066	Could not send mouse event to virtual mouse.
11067	</result>
11068
11069	</desc>
11070
11071	<param name="dx" type="long" dir="in">
11072	<desc>
11073	Amount of pixels the mouse should move to the right.
11074	Negative values move the mouse to the left.
11075	</desc>
11076	</param>
11077	<param name="dy" type="long" dir="in">
11078	<desc>
11079	Amount of pixels the mouse should move downwards.
11080	Negative values move the mouse upwards.
11081	</desc>
11082	</param>
11083	<param name="dz" type="long" dir="in">
11084	<desc>
11085	Amount of mouse wheel moves.
11086	Positive values describe clockwise wheel rotations,
11087	negative values describe counterclockwise rotations.
11088	</desc>
11089	</param>
11090	<param name="dw" type="long" dir="in">
11091	<desc>
11092	Amount of horizontal mouse wheel moves.
11093	Positive values describe a movement to the left,
11094	negative values describe a movement to the right.
11095	</desc>
11096	</param>
11097	<param name="buttonState" type="long" dir="in">
11098	<desc>
11099	The current state of mouse buttons. Every bit represents
11100	a mouse button as follows:
11101	<table>
11102	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
11103	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
11104	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
11105	</table>
11106	A value of <tt>1</tt> means the corresponding button is pressed.
11107	otherwise it is released.
11108	</desc>
11109	</param>
11110	</method>
11111
11112	<method name="putMouseEventAbsolute">
11113	<desc>
11114	Positions the mouse pointer using absolute x and y coordinates.
11115	These coordinates are expressed in pixels and
11116	start from <tt>[1,1]</tt> which corresponds to the top left
11117	corner of the virtual display.
11118
11119	<result name="E_ACCESSDENIED">
11120	Console not powered up.
11121	</result>
11122	<result name="VBOX_E_IPRT_ERROR">
11123	Could not send mouse event to virtual mouse.
11124	</result>
11125
11126	<note>
11127	This method will have effect only if absolute mouse
11128	positioning is supported by the guest OS.
11129	</note>
11130
11131	<see><link to="#absoluteSupported"/></see>
11132	</desc>
11133
11134	<param name="x" type="long" dir="in">
11135	<desc>
11136	X coordinate of the pointer in pixels, starting from @c 1.
11137	</desc>
11138	</param>
11139	<param name="y" type="long" dir="in">
11140	<desc>
11141	Y coordinate of the pointer in pixels, starting from @c 1.
11142	</desc>
11143	</param>
11144	<param name="dz" type="long" dir="in">
11145	<desc>
11146	Amount of mouse wheel moves.
11147	Positive values describe clockwise wheel rotations,
11148	negative values describe counterclockwise rotations.
11149	</desc>
11150	</param>
11151	<param name="dw" type="long" dir="in">
11152	<desc>
11153	Amount of horizontal mouse wheel moves.
11154	Positive values describe a movement to the left,
11155	negative values describe a movement to the right.
11156	</desc>
11157	</param>
11158	<param name="buttonState" type="long" dir="in">
11159	<desc>
11160	The current state of mouse buttons. Every bit represents
11161	a mouse button as follows:
11162	<table>
11163	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
11164	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
11165	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
11166	</table>
11167	A value of @c 1 means the corresponding button is pressed.
11168	otherwise it is released.
11169	</desc>
11170	</param>
11171	</method>
11172
11173	</interface>
11174
11175	<!--
11176	// IDisplay
11177	/////////////////////////////////////////////////////////////////////////
11178	-->
11179
11180	<enum
11181	name="FramebufferPixelFormat"
11182	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
11183	>
11184	<desc>
11185	Format of the video memory buffer. Constants represented by this enum can
11186	be used to test for particular values of <link
11187	to="IFramebuffer::pixelFormat"/>. See also <link
11188	to="IFramebuffer::requestResize"/>.
11189
11190	See also www.fourcc.org for more information about FOURCC pixel formats.
11191	</desc>
11192
11193	<const name="Opaque" value="0">
11194	<desc>
11195	Unknown buffer format (the user may not assume any particular format of
11196	the buffer).
11197	</desc>
11198	</const>
11199	<const name="FOURCC_RGB" value="0x32424752">
11200	<desc>
11201	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
11202	bit layout).
11203	</desc>
11204	</const>
11205	</enum>
11206
11207	<interface
11208	name="IFramebuffer" extends="$unknown"
11209	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
11210	wsmap="suppress"
11211	>
11212	<attribute name="address" type="octet" mod="ptr" readonly="yes">
11213	<desc>Address of the start byte of the frame buffer.</desc>
11214	</attribute>
11215
11216	<attribute name="width" type="unsigned long" readonly="yes">
11217	<desc>Frame buffer width, in pixels.</desc>
11218	</attribute>
11219
11220	<attribute name="height" type="unsigned long" readonly="yes">
11221	<desc>Frame buffer height, in pixels.</desc>
11222	</attribute>
11223
11224	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
11225	<desc>
11226	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
11227	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
11228	are: 8, 15, 16, 24 and 32.
11229	</desc>
11230	</attribute>
11231
11232	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
11233	<desc>
11234	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
11235	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
11236	size of the scan line must be aligned to 32 bits.
11237	</desc>
11238	</attribute>
11239
11240	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
11241	<desc>
11242	Frame buffer pixel format. It's either one of the values defined by <link
11243	to="FramebufferPixelFormat"/> or a raw FOURCC code.
11244	<note>
11245	This attribute must never return <link
11246	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
11247	<link to="#address"/> points to must be always known.
11248	</note>
11249	</desc>
11250	</attribute>
11251
11252	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
11253	<desc>
11254	Defines whether this frame buffer uses the virtual video card's memory
11255	buffer (guest VRAM) directly or not. See <link
11256	to="IFramebuffer::requestResize"/> for more information.
11257	</desc>
11258	</attribute>
11259
11260	<attribute name="heightReduction" type="unsigned long" readonly="yes">
11261	<desc>
11262	Hint from the frame buffer about how much of the standard
11263	screen height it wants to use for itself. This information is
11264	exposed to the guest through the VESA BIOS and VMMDev interface
11265	so that it can use it for determining its video mode table. It
11266	is not guaranteed that the guest respects the value.
11267	</desc>
11268	</attribute>
11269
11270	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
11271	<desc>
11272	An alpha-blended overlay which is superposed over the frame buffer.
11273	The initial purpose is to allow the display of icons providing
11274	information about the VM state, including disk activity, in front
11275	ends which do not have other means of doing that. The overlay is
11276	designed to controlled exclusively by IDisplay. It has no locking
11277	of its own, and any changes made to it are not guaranteed to be
11278	visible until the affected portion of IFramebuffer is updated. The
11279	overlay can be created lazily the first time it is requested. This
11280	attribute can also return @c null to signal that the overlay is not
11281	implemented.
11282	</desc>
11283	</attribute>
11284
11285	<attribute name="winId" type="unsigned long long" readonly="yes">
11286	<desc>
11287	Platform-dependent identifier of the window where context of this
11288	frame buffer is drawn, or zero if there's no such window.
11289	</desc>
11290	</attribute>
11291
11292	<method name="lock">
11293	<desc>
11294	Locks the frame buffer.
11295	Gets called by the IDisplay object where this frame buffer is
11296	bound to.
11297	</desc>
11298	</method>
11299
11300	<method name="unlock">
11301	<desc>
11302	Unlocks the frame buffer.
11303	Gets called by the IDisplay object where this frame buffer is
11304	bound to.
11305	</desc>
11306	</method>
11307
11308	<method name="notifyUpdate">
11309	<desc>
11310	Informs about an update.
11311	Gets called by the display object where this buffer is
11312	registered.
11313	</desc>
11314	<param name="x" type="unsigned long" dir="in"/>
11315	<param name="y" type="unsigned long" dir="in"/>
11316	<param name="width" type="unsigned long" dir="in"/>
11317	<param name="height" type="unsigned long" dir="in"/>
11318	</method>
11319
11320	<method name="requestResize">
11321	<desc>
11322	Requests a size and pixel format change.
11323
11324	There are two modes of working with the video buffer of the virtual
11325	machine. The <i>indirect</i> mode implies that the IFramebuffer
11326	implementation allocates a memory buffer for the requested display mode
11327	and provides it to the virtual machine. In <i>direct</i> mode, the
11328	IFramebuffer implementation uses the memory buffer allocated and owned
11329	by the virtual machine. This buffer represents the video memory of the
11330	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
11331	usually faster because the implementation gets a raw pointer to the
11332	guest VRAM buffer which it can directly use for visualizing the contents
11333	of the virtual display, as opposed to the indirect mode where the
11334	contents of guest VRAM are copied to the memory buffer provided by
11335	the implementation every time a display update occurs.
11336
11337	It is important to note that the direct mode is really fast only when
11338	the implementation uses the given guest VRAM buffer directly, for
11339	example, by blitting it to the window representing the virtual machine's
11340	display, which saves at least one copy operation comparing to the
11341	indirect mode. However, using the guest VRAM buffer directly is not
11342	always possible: the format and the color depth of this buffer may be
11343	not supported by the target window, or it may be unknown (opaque) as in
11344	case of text or non-linear multi-plane VGA video modes. In this case,
11345	the indirect mode (that is always available) should be used as a
11346	fallback: when the guest VRAM contents are copied to the
11347	implementation-provided memory buffer, color and format conversion is
11348	done automatically by the underlying code.
11349
11350	The @a pixelFormat parameter defines whether the direct mode is
11351	available or not. If @a pixelFormat is <link
11352	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
11353	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
11354	@a bytesPerLine parameters must be ignored and the implementation must use
11355	the indirect mode (where it provides its own buffer in one of the
11356	supported formats). In all other cases, @a pixelFormat together with
11357	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
11358	buffer pointed to by the @a VRAM parameter and the implementation is
11359	free to choose which mode to use. To indicate that this frame buffer uses
11360	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
11361	attribute must return @c true and <link to="#address"/> must
11362	return exactly the same address that is passed in the @a VRAM parameter
11363	of this method; otherwise it is assumed that the indirect strategy is
11364	chosen.
11365
11366	The @a width and @a height parameters represent the size of the
11367	requested display mode in both modes. In case of indirect mode, the
11368	provided memory buffer should be big enough to store data of the given
11369	display mode. In case of direct mode, it is guaranteed that the given
11370	@a VRAM buffer contains enough space to represent the display mode of the
11371	given size. Note that this frame buffer's <link to="#width"/> and <link
11372	to="#height"/> attributes must return exactly the same values as
11373	passed to this method after the resize is completed (see below).
11374
11375	The @a finished output parameter determines if the implementation has
11376	finished resizing the frame buffer or not. If, for some reason, the
11377	resize cannot be finished immediately during this call, @a finished
11378	must be set to @c false, and the implementation must call
11379	<link to="IDisplay::resizeCompleted"/> after it has returned from
11380	this method as soon as possible. If @a finished is @c false, the
11381	machine will not call any frame buffer methods until
11382	<link to="IDisplay::resizeCompleted"/> is called.
11383
11384	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
11385	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
11386	this frame buffer must return exactly the same values as specified in the
11387	parameters of this method, after the resize is completed. If the
11388	indirect mode is chosen, these attributes must return values describing
11389	the format of the implementation's own memory buffer <link
11390	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
11391	value must always correlate with <link to="#pixelFormat"/>. Note that
11392	the <link to="#pixelFormat"/> attribute must never return <link
11393	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
11394
11395	<note>
11396	This method is called by the IDisplay object under the
11397	<link to="#lock"/> provided by this IFramebuffer
11398	implementation. If this method returns @c false in @a finished, then
11399	this lock is not released until
11400	<link to="IDisplay::resizeCompleted"/> is called.
11401	</note>
11402	</desc>
11403	<param name="screenId" type="unsigned long" dir="in">
11404	<desc>
11405	Logical screen number. Must be used in the corresponding call to
11406	<link to="IDisplay::resizeCompleted"/> if this call is made.
11407	</desc>
11408	</param>
11409	<param name="pixelFormat" type="unsigned long" dir="in">
11410	<desc>
11411	Pixel format of the memory buffer pointed to by @a VRAM.
11412	See also <link to="FramebufferPixelFormat"/>.
11413	</desc>
11414	</param>
11415	<param name="VRAM" type="octet" mod="ptr" dir="in">
11416	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
11417	</param>
11418	<param name="bitsPerPixel" type="unsigned long" dir="in">
11419	<desc>Color depth, bits per pixel.</desc>
11420	</param>
11421	<param name="bytesPerLine" type="unsigned long" dir="in">
11422	<desc>Size of one scan line, in bytes.</desc>
11423	</param>
11424	<param name="width" type="unsigned long" dir="in">
11425	<desc>Width of the guest display, in pixels.</desc>
11426	</param>
11427	<param name="height" type="unsigned long" dir="in">
11428	<desc>Height of the guest display, in pixels.</desc>
11429	</param>
11430	<param name="finished" type="boolean" dir="return">
11431	<desc>
11432	Can the VM start using the new frame buffer immediately
11433	after this method returns or it should wait for
11434	<link to="IDisplay::resizeCompleted"/>.
11435	</desc>
11436	</param>
11437	</method>
11438
11439	<method name="videoModeSupported">
11440	<desc>
11441	Returns whether the frame buffer implementation is willing to
11442	support a given video mode. In case it is not able to render
11443	the video mode (or for some reason not willing), it should
11444	return @c false. Usually this method is called when the guest
11445	asks the VMM device whether a given video mode is supported
11446	so the information returned is directly exposed to the guest.
11447	It is important that this method returns very quickly.
11448	</desc>
11449	<param name="width" type="unsigned long" dir="in"/>
11450	<param name="height" type="unsigned long" dir="in"/>
11451	<param name="bpp" type="unsigned long" dir="in"/>
11452	<param name="supported" type="boolean" dir="return"/>
11453	</method>
11454
11455	<method name="getVisibleRegion">
11456	<desc>
11457	Returns the visible region of this frame buffer.
11458
11459	If the @a rectangles parameter is @c null then the value of the
11460	@a count parameter is ignored and the number of elements necessary to
11461	describe the current visible region is returned in @a countCopied.
11462
11463	If @a rectangles is not @c null but @a count is less
11464	than the required number of elements to store region data, the method
11465	will report a failure. If @a count is equal or greater than the
11466	required number of elements, then the actual number of elements copied
11467	to the provided array will be returned in @a countCopied.
11468
11469	<note>
11470	The address of the provided array must be in the process space of
11471	this IFramebuffer object.
11472	</note>
11473	<note>
11474	Method not yet implemented.
11475	</note>
11476	</desc>
11477	<param name="rectangles" type="octet" mod="ptr" dir="in">
11478	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
11479	</param>
11480	<param name="count" type="unsigned long" dir="in">
11481	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11482	</param>
11483	<param name="countCopied" type="unsigned long" dir="return">
11484	<desc>Number of elements copied to the @a rectangles array.</desc>
11485	</param>
11486	</method>
11487
11488	<method name="setVisibleRegion">
11489	<desc>
11490	Suggests a new visible region to this frame buffer. This region
11491	represents the area of the VM display which is a union of regions of
11492	all top-level windows of the guest operating system running inside the
11493	VM (if the Guest Additions for this system support this
11494	functionality). This information may be used by the frontends to
11495	implement the seamless desktop integration feature.
11496
11497	<note>
11498	The address of the provided array must be in the process space of
11499	this IFramebuffer object.
11500	</note>
11501	<note>
11502	The IFramebuffer implementation must make a copy of the provided
11503	array of rectangles.
11504	</note>
11505	<note>
11506	Method not yet implemented.
11507	</note>
11508	</desc>
11509	<param name="rectangles" type="octet" mod="ptr" dir="in">
11510	<desc>Pointer to the @c RTRECT array.</desc>
11511	</param>
11512	<param name="count" type="unsigned long" dir="in">
11513	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11514	</param>
11515	</method>
11516
11517	<method name="processVHWACommand">
11518	<desc>
11519	Posts a Video HW Acceleration Command to the frame buffer for processing.
11520	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color covnersion, overlaying, etc.)
11521	are posted from quest to the host to be processed by the host hardware.
11522
11523	<note>
11524	The address of the provided command must be in the process space of
11525	this IFramebuffer object.
11526	</note>
11527	</desc>
11528
11529	<param name="command" type="octet" mod="ptr" dir="in">
11530	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
11531	</param>
11532	</method>
11533
11534	</interface>
11535
11536	<interface
11537	name="IFramebufferOverlay" extends="IFramebuffer"
11538	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
11539	wsmap="suppress"
11540	>
11541	<desc>
11542	The IFramebufferOverlay interface represents an alpha blended overlay
11543	for displaying status icons above an IFramebuffer. It is always created
11544	not visible, so that it must be explicitly shown. It only covers a
11545	portion of the IFramebuffer, determined by its width, height and
11546	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
11547	that order) format, and may be written to directly. Do re-read the
11548	width though, after setting it, as it may be adjusted (increased) to
11549	make it more suitable for the front end.
11550	</desc>
11551	<attribute name="x" type="unsigned long" readonly="yes">
11552	<desc>X position of the overlay, relative to the frame buffer.</desc>
11553	</attribute>
11554
11555	<attribute name="y" type="unsigned long" readonly="yes">
11556	<desc>Y position of the overlay, relative to the frame buffer.</desc>
11557	</attribute>
11558
11559	<attribute name="visible" type="boolean" readonly="no">
11560	<desc>
11561	Whether the overlay is currently visible.
11562	</desc>
11563	</attribute>
11564
11565	<attribute name="alpha" type="unsigned long" readonly="no">
11566	<desc>
11567	The global alpha value for the overlay. This may or may not be
11568	supported by a given front end.
11569	</desc>
11570	</attribute>
11571
11572	<method name="move">
11573	<desc>
11574	Changes the overlay's position relative to the IFramebuffer.
11575	</desc>
11576	<param name="x" type="unsigned long" dir="in"/>
11577	<param name="y" type="unsigned long" dir="in"/>
11578	</method>
11579
11580	</interface>
11581
11582	<interface
11583	name="IDisplay" extends="$unknown"
11584	uuid="1fa79e39-0cc9-4ab3-9df3-ed3e96b42496"
11585	wsmap="managed"
11586	>
11587	<desc>
11588	The IDisplay interface represents the virtual machine's display.
11589
11590	The object implementing this interface is contained in each
11591	<link to="IConsole::display"/> attribute and represents the visual
11592	output of the virtual machine.
11593
11594	The virtual display supports pluggable output targets represented by the
11595	IFramebuffer interface. Examples of the output target are a window on
11596	the host computer or an RDP session's display on a remote computer.
11597	</desc>
11598	<method name="getScreenResolution">
11599	<desc>Queries display width, height and color depth for given screen.</desc>
11600	<param name="screenId" type="unsigned long" dir="in"/>
11601	<param name="width" type="unsigned long" dir="out"/>
11602	<param name="height" type="unsigned long" dir="out"/>
11603	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
11604	</method>
11605
11606	<method name="setFramebuffer">
11607	<desc>
11608	Sets the framebuffer for given screen.
11609	</desc>
11610	<param name="screenId" type="unsigned long" dir="in"/>
11611	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11612	</method>
11613
11614	<method name="getFramebuffer">
11615	<desc>
11616	Queries the framebuffer for given screen.
11617	</desc>
11618	<param name="screenId" type="unsigned long" dir="in"/>
11619	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11620	<param name="xOrigin" type="long" dir="out"/>
11621	<param name="yOrigin" type="long" dir="out"/>
11622	</method>
11623
11624	<method name="setVideoModeHint">
11625	<desc>
11626	Asks VirtualBox to request the given video mode from
11627	the guest. This is just a hint and it cannot be guaranteed
11628	that the requested resolution will be used. Guest Additions
11629	are required for the request to be seen by guests. The caller
11630	should issue the request and wait for a resolution change and
11631	after a timeout retry.
11632
11633	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11634	parameters means that the corresponding values should be taken from the
11635	current video mode (i.e. left unchanged).
11636
11637	If the guest OS supports multi-monitor configuration then the @a display
11638	parameter specifies the number of the guest display to send the hint to:
11639	@c 0 is the primary display, @c 1 is the first secondary and
11640	so on. If the multi-monitor configuration is not supported, @a display
11641	must be @c 0.
11642
11643	<result name="E_INVALIDARG">
11644	The @a display is not associated with any monitor.
11645	</result>
11646
11647	</desc>
11648	<param name="width" type="unsigned long" dir="in"/>
11649	<param name="height" type="unsigned long" dir="in"/>
11650	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11651	<param name="display" type="unsigned long" dir="in"/>
11652	</method>
11653
11654	<method name="setSeamlessMode">
11655	<desc>
11656	Enables or disables seamless guest display rendering (seamless desktop
11657	integration) mode.
11658	<note>
11659	Calling this method has no effect if <link
11660	to="IGuest::supportsSeamless"/> returns @c false.
11661	</note>
11662	</desc>
11663	<param name="enabled" type="boolean" dir="in"/>
11664	</method>
11665
11666	<method name="takeScreenShot">
11667	<desc>
11668	Takes a screen shot of the requested size and copies it to the
11669	32-bpp buffer allocated by the caller and pointed to by @a address.
11670	A pixel consists of 4 bytes in order: B, G, R, 0.
11671
11672	<note>This API can be used only by the COM/XPCOM C++ API as it
11673	requires pointer support. Use <link to="#takeScreenShotToArray" />
11674	with other language bindings.
11675	</note>
11676
11677	<result name="E_NOTIMPL">
11678	Feature not implemented.
11679	</result>
11680	<result name="VBOX_E_IPRT_ERROR">
11681	Could not take a screenshot.
11682	</result>
11683
11684	</desc>
11685	<param name="screenId" type="unsigned long" dir="in"/>
11686	<param name="address" type="octet" mod="ptr" dir="in"/>
11687	<param name="width" type="unsigned long" dir="in"/>
11688	<param name="height" type="unsigned long" dir="in"/>
11689	</method>
11690
11691	<method name="takeScreenShotToArray">
11692	<desc>
11693	Takes a guest screen shot of the requested size and returns it as
11694	an array of bytes in uncompressed 32-bit RGBA format.
11695	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11696
11697	This API is slow, but could be the only option to get guest screenshot
11698	for scriptable languages not allowed to manipulate with addresses
11699	directly.
11700
11701	<result name="E_NOTIMPL">
11702	Feature not implemented.
11703	</result>
11704	<result name="VBOX_E_IPRT_ERROR">
11705	Could not take a screenshot.
11706	</result>
11707	</desc>
11708	<param name="screenId" type="unsigned long" dir="in">
11709	<desc>
11710	Monitor to take screenshot from.
11711	</desc>
11712	</param>
11713	<param name="width" type="unsigned long" dir="in">
11714	<desc>
11715	Desired image width.
11716	</desc>
11717	</param>
11718	<param name="height" type="unsigned long" dir="in">
11719	<desc>
11720	Desired image height.
11721	</desc>
11722	</param>
11723	<param name="screenData" type="octet" dir="return" safearray="yes">
11724	<desc>
11725	Array with resulting screen data.
11726	</desc>
11727	</param>
11728	</method>
11729
11730	<method name="drawToScreen">
11731	<desc>
11732	Draws a 32-bpp image of the specified size from the given buffer
11733	to the given point on the VM display.
11734
11735	<result name="E_NOTIMPL">
11736	Feature not implemented.
11737	</result>
11738	<result name="VBOX_E_IPRT_ERROR">
11739	Could not draw to screen.
11740	</result>
11741
11742	</desc>
11743	<param name="screenId" type="unsigned long" dir="in"/>
11744	<param name="address" type="octet" mod="ptr" dir="in"/>
11745	<param name="x" type="unsigned long" dir="in">
11746	<desc>Relative to the screen top left corner.</desc>
11747	</param>
11748	<param name="y" type="unsigned long" dir="in">
11749	<desc>Relative to the screen top left corner.</desc>
11750	</param>
11751	<param name="width" type="unsigned long" dir="in"/>
11752	<param name="height" type="unsigned long" dir="in"/>
11753	</method>
11754
11755	<method name="invalidateAndUpdate">
11756	<desc>
11757	Does a full invalidation of the VM display and instructs the VM
11758	to update it.
11759
11760	<result name="VBOX_E_IPRT_ERROR">
11761	Could not invalidate and update screen.
11762	</result>
11763
11764	</desc>
11765	</method>
11766
11767	<method name="resizeCompleted">
11768	<desc>
11769	Signals that a framebuffer has completed the resize operation.
11770
11771	<result name="VBOX_E_NOT_SUPPORTED">
11772	Operation only valid for external frame buffers.
11773	</result>
11774
11775	</desc>
11776	<param name="screenId" type="unsigned long" dir="in"/>
11777	</method>
11778
11779	<method name="completeVHWACommand">
11780	<desc>
11781	Signals that the Video HW Acceleration command has completed.
11782	</desc>
11783
11784	<param name="command" type="octet" mod="ptr" dir="in">
11785	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11786	</param>
11787	</method>
11788
11789	</interface>
11790
11791	<!--
11792	// INetworkAdapter
11793	/////////////////////////////////////////////////////////////////////////
11794	-->
11795
11796	<enum
11797	name="NetworkAttachmentType"
11798	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11799	>
11800	<desc>
11801	Network attachment type.
11802	</desc>
11803
11804	<const name="Null" value="0">
11805	<desc>Null value, also means "not attached".</desc>
11806	</const>
11807	<const name="NAT" value="1"/>
11808	<const name="Bridged" value="2"/>
11809	<const name="Internal" value="3"/>
11810	<const name="HostOnly" value="4"/>
11811	<const name="VDE" value="5"/>
11812	</enum>
11813
11814	<enum
11815	name="NetworkAdapterType"
11816	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11817	>
11818	<desc>
11819	Network adapter type.
11820	</desc>
11821
11822	<const name="Null" value="0">
11823	<desc>Null value (never used by the API).</desc>
11824	</const>
11825	<const name="Am79C970A" value="1">
11826	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11827	</const>
11828	<const name="Am79C973" value="2">
11829	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11830	</const>
11831	<const name="I82540EM" value="3">
11832	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11833	</const>
11834	<const name="I82543GC" value="4">
11835	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11836	</const>
11837	<const name="I82545EM" value="5">
11838	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11839	</const>
11840	<const name="Virtio" value="6">
11841	<desc>Virtio network device.</desc>
11842	</const>
11843	</enum>
11844
11845	<interface
11846	name="INetworkAdapter" extends="$unknown"
11847	uuid="5bdb9df8-a5e1-4322-a139-b7a4a734c790"
11848	wsmap="managed"
11849	>
11850	<desc>
11851	Represents a virtual network adapter that is attached to a virtual machine.
11852	Each virtual machine has a fixed number of network adapter slots with one
11853	instance of this attached to each of them. Call
11854	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11855	is attached to a given slot in a given machine.
11856
11857	Each network adapter can be in one of five attachment modes, which are
11858	represented by the <link to="NetworkAttachmentType" /> enumeration;
11859	see the <link to="#attachmentType" /> attribute.
11860	</desc>
11861
11862	<attribute name="adapterType" type="NetworkAdapterType">
11863	<desc>
11864	Type of the virtual network adapter. Depending on this value,
11865	VirtualBox will provide a different virtual network hardware
11866	to the guest.
11867	</desc>
11868	</attribute>
11869
11870	<attribute name="slot" type="unsigned long" readonly="yes">
11871	<desc>
11872	Slot number this adapter is plugged into. Corresponds to
11873	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11874	to obtain this instance.
11875	</desc>
11876	</attribute>
11877
11878	<attribute name="enabled" type="boolean">
11879	<desc>
11880	Flag whether the network adapter is present in the
11881	guest system. If disabled, the virtual guest hardware will
11882	not contain this network adapter. Can only be changed when
11883	the VM is not running.
11884	</desc>
11885	</attribute>
11886
11887	<attribute name="MACAddress" type="wstring">
11888	<desc>
11889	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11890	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11891	</desc>
11892	</attribute>
11893
11894	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11895
11896	<attribute name="hostInterface" type="wstring">
11897	<desc>
11898	Name of the host network interface the VM is attached to.
11899	</desc>
11900	</attribute>
11901
11902	<attribute name="internalNetwork" type="wstring">
11903	<desc>
11904	Name of the internal network the VM is attached to.
11905	</desc>
11906	</attribute>
11907
11908	<attribute name="NATNetwork" type="wstring">
11909	<desc>
11910	Name of the NAT network the VM is attached to.
11911	</desc>
11912	</attribute>
11913
11914	<attribute name="VDENetwork" type="wstring">
11915	<desc>
11916	Name of the VDE switch the VM is attached to.
11917	</desc>
11918	</attribute>
11919
11920	<attribute name="cableConnected" type="boolean">
11921	<desc>
11922	Flag whether the adapter reports the cable as connected or not.
11923	It can be used to report offline situations to a VM.
11924	</desc>
11925	</attribute>
11926
11927	<attribute name="lineSpeed" type="unsigned long">
11928	<desc>
11929	Line speed reported by custom drivers, in units of 1 kbps.
11930	</desc>
11931	</attribute>
11932
11933	<attribute name="traceEnabled" type="boolean">
11934	<desc>
11935	Flag whether network traffic from/to the network card should be traced.
11936	Can only be toggled when the VM is turned off.
11937	</desc>
11938	</attribute>
11939
11940	<attribute name="traceFile" type="wstring">
11941	<desc>
11942	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11943	will be used.
11944	</desc>
11945	</attribute>
11946
11947	<attribute name="natDriver" type="INATEngine" readonly="yes">
11948	<desc>
11949	Points to the NAT engine which handles the network address translation
11950	for this interface. This is active only when the interface actually uses
11951	NAT (see <link to="#attachToNAT" />).
11952	</desc>
11953	</attribute>
11954
11955	<attribute name="bootPriority" type="unsigned long">
11956	<desc>
11957	Network boot priority of the adapter. Priority 1 is highest. If not set,
11958	the priority is considered to be at the lowest possible setting.
11959	</desc>
11960	</attribute>
11961
11962	<method name="attachToNAT">
11963	<desc>
11964	Attach the network adapter to the Network Address Translation (NAT) interface.
11965	</desc>
11966	</method>
11967
11968	<method name="attachToBridgedInterface">
11969	<desc>
11970	Attach the network adapter to a bridged host interface.
11971	</desc>
11972	</method>
11973
11974	<method name="attachToInternalNetwork">
11975	<desc>
11976	Attach the network adapter to an internal network.
11977	</desc>
11978	</method>
11979
11980	<method name="attachToHostOnlyInterface">
11981	<desc>
11982	Attach the network adapter to the host-only network.
11983	</desc>
11984	</method>
11985
11986	<method name="attachToVDE">
11987	<desc>
11988	Attach the network adapter to a VDE network.
11989	</desc>
11990	</method>
11991
11992	<method name="detach">
11993	<desc>
11994	Detach the network adapter
11995	</desc>
11996	</method>
11997	</interface>
11998
11999
12000	<!--
12001	// ISerialPort
12002	/////////////////////////////////////////////////////////////////////////
12003	-->
12004
12005	<enum
12006	name="PortMode"
12007	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
12008	>
12009	<desc>
12010	The PortMode enumeration represents possible communication modes for
12011	the virtual serial port device.
12012	</desc>
12013
12014	<const name="Disconnected" value="0">
12015	<desc>Virtual device is not attached to any real host device.</desc>
12016	</const>
12017	<const name="HostPipe" value="1">
12018	<desc>Virtual device is attached to a host pipe.</desc>
12019	</const>
12020	<const name="HostDevice" value="2">
12021	<desc>Virtual device is attached to a host device.</desc>
12022	</const>
12023	<const name="RawFile" value="3">
12024	<desc>Virtual device is attached to a raw file.</desc>
12025	</const>
12026	</enum>
12027
12028	<interface
12029	name="ISerialPort" extends="$unknown"
12030	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
12031	wsmap="managed"
12032	>
12033
12034	<desc>
12035	The ISerialPort interface represents the virtual serial port device.
12036
12037	The virtual serial port device acts like an ordinary serial port
12038	inside the virtual machine. This device communicates to the real
12039	serial port hardware in one of two modes: host pipe or host device.
12040
12041	In host pipe mode, the #path attribute specifies the path to the pipe on
12042	the host computer that represents a serial port. The #server attribute
12043	determines if this pipe is created by the virtual machine process at
12044	machine startup or it must already exist before starting machine
12045	execution.
12046
12047	In host device mode, the #path attribute specifies the name of the
12048	serial port device on the host computer.
12049
12050	There is also a third communication mode: the disconnected mode. In this
12051	mode, the guest OS running inside the virtual machine will be able to
12052	detect the serial port, but all port write operations will be discarded
12053	and all port read operations will return no data.
12054
12055	<see>IMachine::getSerialPort</see>
12056	</desc>
12057
12058	<attribute name="slot" type="unsigned long" readonly="yes">
12059	<desc>
12060	Slot number this serial port is plugged into. Corresponds to
12061	the value you pass to <link to="IMachine::getSerialPort"/>
12062	to obtain this instance.
12063	</desc>
12064	</attribute>
12065
12066	<attribute name="enabled" type="boolean">
12067	<desc>
12068	Flag whether the serial port is enabled. If disabled,
12069	the serial port will not be reported to the guest OS.
12070	</desc>
12071	</attribute>
12072
12073	<attribute name="IOBase" type="unsigned long">
12074	<desc>Base I/O address of the serial port.</desc>
12075	</attribute>
12076
12077	<attribute name="IRQ" type="unsigned long">
12078	<desc>IRQ number of the serial port.</desc>
12079	</attribute>
12080
12081	<attribute name="hostMode" type="PortMode">
12082	<desc>
12083	How is this port connected to the host.
12084	<note>
12085	Changing this attribute may fail if the conditions for
12086	<link to="#path"/> are not met.
12087	</note>
12088	</desc>
12089	</attribute>
12090
12091	<attribute name="server" type="boolean">
12092	<desc>
12093	Flag whether this serial port acts as a server (creates a new pipe on
12094	the host) or as a client (uses the existing pipe). This attribute is
12095	used only when <link to="#hostMode"/> is PortMode_HostPipe.
12096	</desc>
12097	</attribute>
12098
12099	<attribute name="path" type="wstring">
12100	<desc>
12101	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
12102	PortMode_HostPipe, or the host serial device name when
12103	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
12104	cases, setting a @c null or empty string as the attribute's value
12105	is an error. Otherwise, the value of this property is ignored.
12106	</desc>
12107	</attribute>
12108
12109	</interface>
12110
12111	<!--
12112	// IParallelPort
12113	/////////////////////////////////////////////////////////////////////////
12114	-->
12115
12116	<interface
12117	name="IParallelPort" extends="$unknown"
12118	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
12119	wsmap="managed"
12120	>
12121
12122	<desc>
12123	The IParallelPort interface represents the virtual parallel port device.
12124
12125	The virtual parallel port device acts like an ordinary parallel port
12126	inside the virtual machine. This device communicates to the real
12127	parallel port hardware using the name of the parallel device on the host
12128	computer specified in the #path attribute.
12129
12130	Each virtual parallel port device is assigned a base I/O address and an
12131	IRQ number that will be reported to the guest operating system and used
12132	to operate the given parallel port from within the virtual machine.
12133
12134	<see>IMachine::getParallelPort</see>
12135	</desc>
12136
12137	<attribute name="slot" type="unsigned long" readonly="yes">
12138	<desc>
12139	Slot number this parallel port is plugged into. Corresponds to
12140	the value you pass to <link to="IMachine::getParallelPort"/>
12141	to obtain this instance.
12142	</desc>
12143	</attribute>
12144
12145	<attribute name="enabled" type="boolean">
12146	<desc>
12147	Flag whether the parallel port is enabled. If disabled,
12148	the parallel port will not be reported to the guest OS.
12149	</desc>
12150	</attribute>
12151
12152	<attribute name="IOBase" type="unsigned long">
12153	<desc>Base I/O address of the parallel port.</desc>
12154	</attribute>
12155
12156	<attribute name="IRQ" type="unsigned long">
12157	<desc>IRQ number of the parallel port.</desc>
12158	</attribute>
12159
12160	<attribute name="path" type="wstring">
12161	<desc>
12162	Host parallel device name. If this parallel port is enabled, setting a
12163	@c null or an empty string as this attribute's value will result into
12164	an error.
12165	</desc>
12166	</attribute>
12167
12168	</interface>
12169
12170
12171	<!--
12172	// IMachineDebugger
12173	/////////////////////////////////////////////////////////////////////////
12174	-->
12175
12176	<interface
12177	name="IMachineDebugger" extends="$unknown"
12178	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
12179	wsmap="suppress"
12180	>
12181	<method name="resetStats">
12182	<desc>
12183	Reset VM statistics.
12184	</desc>
12185	<param name="pattern" type="wstring" dir="in">
12186	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12187	</param>
12188	</method>
12189
12190	<method name="dumpStats">
12191	<desc>
12192	Dumps VM statistics.
12193	</desc>
12194	<param name="pattern" type="wstring" dir="in">
12195	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12196	</param>
12197	</method>
12198
12199	<method name="getStats">
12200	<desc>
12201	Get the VM statistics in a XMLish format.
12202	</desc>
12203	<param name="pattern" type="wstring" dir="in">
12204	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12205	</param>
12206	<param name="withDescriptions" type="boolean" dir="in">
12207	<desc>Whether to include the descriptions.</desc>
12208	</param>
12209	<param name="stats" type="wstring" dir="out">
12210	<desc>The XML document containing the statistics.</desc>
12211	</param>
12212	</method>
12213
12214	<method name="injectNMI">
12215	<desc>
12216	Inject an NMI into a running VT-x/AMD-V VM.
12217	</desc>
12218	</method>
12219
12220	<attribute name="singlestep" type="boolean">
12221	<desc>Switch for enabling singlestepping.</desc>
12222	</attribute>
12223
12224	<attribute name="recompileUser" type="boolean">
12225	<desc>Switch for forcing code recompilation for user mode code.</desc>
12226	</attribute>
12227
12228	<attribute name="recompileSupervisor" type="boolean">
12229	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
12230	</attribute>
12231
12232	<attribute name="PATMEnabled" type="boolean">
12233	<desc>Switch for enabling and disabling the PATM component.</desc>
12234	</attribute>
12235
12236	<attribute name="CSAMEnabled" type="boolean">
12237	<desc>Switch for enabling and disabling the CSAM component.</desc>
12238	</attribute>
12239
12240	<attribute name="logEnabled" type="boolean">
12241	<desc>Switch for enabling and disabling logging.</desc>
12242	</attribute>
12243
12244	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
12245	<desc>
12246	Flag indicating whether the VM is currently making use of CPU hardware
12247	virtualization extensions.
12248	</desc>
12249	</attribute>
12250
12251	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
12252	<desc>
12253	Flag indicating whether the VM is currently making use of the nested paging
12254	CPU hardware virtualization extension.
12255	</desc>
12256	</attribute>
12257
12258	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
12259	<desc>
12260	Flag indicating whether the VM is currently making use of the VPID
12261	VT-x extension.
12262	</desc>
12263	</attribute>
12264
12265	<attribute name="PAEEnabled" type="boolean" readonly="yes">
12266	<desc>
12267	Flag indicating whether the VM is currently making use of the Physical
12268	Address Extension CPU feature.
12269	</desc>
12270	</attribute>
12271
12272	<attribute name="virtualTimeRate" type="unsigned long">
12273	<desc>
12274	The rate at which the virtual time runs expressed as a percentage.
12275	The accepted range is 2% to 20000%.
12276	</desc>
12277	</attribute>
12278
12279	<!-- @todo method for setting log flags, groups and destination! -->
12280
12281	<attribute name="VM" type="unsigned long long" readonly="yes">
12282	<desc>
12283	Gets the VM handle. This is only for internal use while
12284	we carve the details of this interface.
12285	</desc>
12286	</attribute>
12287
12288	</interface>
12289
12290	<!--
12291	// IUSBController
12292	/////////////////////////////////////////////////////////////////////////
12293	-->
12294
12295	<interface
12296	name="IUSBController" extends="$unknown"
12297	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
12298	wsmap="managed"
12299	>
12300	<attribute name="enabled" type="boolean">
12301	<desc>
12302	Flag whether the USB controller is present in the
12303	guest system. If disabled, the virtual guest hardware will
12304	not contain any USB controller. Can only be changed when
12305	the VM is powered off.
12306	</desc>
12307	</attribute>
12308
12309	<attribute name="enabledEhci" type="boolean">
12310	<desc>
12311	Flag whether the USB EHCI controller is present in the
12312	guest system. If disabled, the virtual guest hardware will
12313	not contain a USB EHCI controller. Can only be changed when
12314	the VM is powered off.
12315	</desc>
12316	</attribute>
12317
12318	<attribute name="proxyAvailable" type="boolean" readonly="yes">
12319	<desc>
12320	Flag whether there is an USB proxy available.
12321	</desc>
12322	</attribute>
12323
12324	<attribute name="USBStandard" type="unsigned short" readonly="yes">
12325	<desc>
12326	USB standard version which the controller implements.
12327	This is a BCD which means that the major version is in the
12328	high byte and minor version is in the low byte.
12329	</desc>
12330	</attribute>
12331
12332	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
12333	<desc>
12334	List of USB device filters associated with the machine.
12335
12336	If the machine is currently running, these filters are activated
12337	every time a new (supported) USB device is attached to the host
12338	computer that was not ignored by global filters
12339	(<link to="IHost::USBDeviceFilters"/>).
12340
12341	These filters are also activated when the machine is powered up.
12342	They are run against a list of all currently available USB
12343	devices (in states
12344	<link to="USBDeviceState_Available"/>,
12345	<link to="USBDeviceState_Busy"/>,
12346	<link to="USBDeviceState_Held"/>) that were not previously
12347	ignored by global filters.
12348
12349	If at least one filter matches the USB device in question, this
12350	device is automatically captured (attached to) the virtual USB
12351	controller of this machine.
12352
12353	<see>IUSBDeviceFilter, ::IUSBController</see>
12354	</desc>
12355	</attribute>
12356
12357	<method name="createDeviceFilter">
12358	<desc>
12359	Creates a new USB device filter. All attributes except
12360	the filter name are set to empty (any match),
12361	<i>active</i> is @c false (the filter is not active).
12362
12363	The created filter can then be added to the list of filters using
12364	<link to="#insertDeviceFilter"/>.
12365
12366	<result name="VBOX_E_INVALID_VM_STATE">
12367	The virtual machine is not mutable.
12368	</result>
12369
12370	<see>#deviceFilters</see>
12371	</desc>
12372	<param name="name" type="wstring" dir="in">
12373	<desc>
12374	Filter name. See <link to="IUSBDeviceFilter::name"/>
12375	for more info.
12376	</desc>
12377	</param>
12378	<param name="filter" type="IUSBDeviceFilter" dir="return">
12379	<desc>Created filter object.</desc>
12380	</param>
12381	</method>
12382
12383	<method name="insertDeviceFilter">
12384	<desc>
12385	Inserts the given USB device to the specified position
12386	in the list of filters.
12387
12388	Positions are numbered starting from <tt>0</tt>. If the specified
12389	position is equal to or greater than the number of elements in
12390	the list, the filter is added to the end of the collection.
12391
12392	<note>
12393	Duplicates are not allowed, so an attempt to insert a
12394	filter that is already in the collection, will return an
12395	error.
12396	</note>
12397
12398	<result name="VBOX_E_INVALID_VM_STATE">
12399	Virtual machine is not mutable.
12400	</result>
12401	<result name="E_INVALIDARG">
12402	USB device filter not created within this VirtualBox instance.
12403	</result>
12404	<result name="VBOX_E_INVALID_OBJECT_STATE">
12405	USB device filter already in list.
12406	</result>
12407
12408	<see>#deviceFilters</see>
12409	</desc>
12410	<param name="position" type="unsigned long" dir="in">
12411	<desc>Position to insert the filter to.</desc>
12412	</param>
12413	<param name="filter" type="IUSBDeviceFilter" dir="in">
12414	<desc>USB device filter to insert.</desc>
12415	</param>
12416	</method>
12417
12418	<method name="removeDeviceFilter">
12419	<desc>
12420	Removes a USB device filter from the specified position in the
12421	list of filters.
12422
12423	Positions are numbered starting from <tt>0</tt>. Specifying a
12424	position equal to or greater than the number of elements in
12425	the list will produce an error.
12426
12427	<see>#deviceFilters</see>
12428
12429	<result name="VBOX_E_INVALID_VM_STATE">
12430	Virtual machine is not mutable.
12431	</result>
12432	<result name="E_INVALIDARG">
12433	USB device filter list empty or invalid @a position.
12434	</result>
12435
12436	</desc>
12437	<param name="position" type="unsigned long" dir="in">
12438	<desc>Position to remove the filter from.</desc>
12439	</param>
12440	<param name="filter" type="IUSBDeviceFilter" dir="return">
12441	<desc>Removed USB device filter.</desc>
12442	</param>
12443	</method>
12444
12445	</interface>
12446
12447
12448	<!--
12449	// IUSBDevice
12450	/////////////////////////////////////////////////////////////////////////
12451	-->
12452
12453	<interface
12454	name="IUSBDevice" extends="$unknown"
12455	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
12456	wsmap="managed"
12457	>
12458	<desc>
12459	The IUSBDevice interface represents a virtual USB device attached to the
12460	virtual machine.
12461
12462	A collection of objects implementing this interface is stored in the
12463	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
12464	attached to a running virtual machine's USB controller.
12465	</desc>
12466
12467	<attribute name="id" type="uuid" mod="string" readonly="yes">
12468	<desc>
12469	Unique USB device ID. This ID is built from #vendorId,
12470	#productId, #revision and #serialNumber.
12471	</desc>
12472	</attribute>
12473
12474	<attribute name="vendorId" type="unsigned short" readonly="yes">
12475	<desc>Vendor ID.</desc>
12476	</attribute>
12477
12478	<attribute name="productId" type="unsigned short" readonly="yes">
12479	<desc>Product ID.</desc>
12480	</attribute>
12481
12482	<attribute name="revision" type="unsigned short" readonly="yes">
12483	<desc>
12484	Product revision number. This is a packed BCD represented as
12485	unsigned short. The high byte is the integer part and the low
12486	byte is the decimal.
12487	</desc>
12488	</attribute>
12489
12490	<attribute name="manufacturer" type="wstring" readonly="yes">
12491	<desc>Manufacturer string.</desc>
12492	</attribute>
12493
12494	<attribute name="product" type="wstring" readonly="yes">
12495	<desc>Product string.</desc>
12496	</attribute>
12497
12498	<attribute name="serialNumber" type="wstring" readonly="yes">
12499	<desc>Serial number string.</desc>
12500	</attribute>
12501
12502	<attribute name="address" type="wstring" readonly="yes">
12503	<desc>Host specific address of the device.</desc>
12504	</attribute>
12505
12506	<attribute name="port" type="unsigned short" readonly="yes">
12507	<desc>
12508	Host USB port number the device is physically
12509	connected to.
12510	</desc>
12511	</attribute>
12512
12513	<attribute name="version" type="unsigned short" readonly="yes">
12514	<desc>
12515	The major USB version of the device - 1 or 2.
12516	</desc>
12517	</attribute>
12518
12519	<attribute name="portVersion" type="unsigned short" readonly="yes">
12520	<desc>
12521	The major USB version of the host USB port the device is
12522	physically connected to - 1 or 2. For devices not connected to
12523	anything this will have the same value as the version attribute.
12524	</desc>
12525	</attribute>
12526
12527	<attribute name="remote" type="boolean" readonly="yes">
12528	<desc>
12529	Whether the device is physically connected to a remote VRDP
12530	client or to a local host machine.
12531	</desc>
12532	</attribute>
12533
12534	</interface>
12535
12536
12537	<!--
12538	// IUSBDeviceFilter
12539	/////////////////////////////////////////////////////////////////////////
12540	-->
12541
12542	<interface
12543	name="IUSBDeviceFilter" extends="$unknown"
12544	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
12545	wsmap="managed"
12546	>
12547	<desc>
12548	The IUSBDeviceFilter interface represents an USB device filter used
12549	to perform actions on a group of USB devices.
12550
12551	This type of filters is used by running virtual machines to
12552	automatically capture selected USB devices once they are physically
12553	attached to the host computer.
12554
12555	A USB device is matched to the given device filter if and only if all
12556	attributes of the device match the corresponding attributes of the
12557	filter (that is, attributes are joined together using the logical AND
12558	operation). On the other hand, all together, filters in the list of
12559	filters carry the semantics of the logical OR operation. So if it is
12560	desirable to create a match like "this vendor id OR this product id",
12561	one needs to create two filters and specify "any match" (see below)
12562	for unused attributes.
12563
12564	All filter attributes used for matching are strings. Each string
12565	is an expression representing a set of values of the corresponding
12566	device attribute, that will match the given filter. Currently, the
12567	following filtering expressions are supported:
12568
12569	<ul>
12570	<li><i>Interval filters</i>. Used to specify valid intervals for
12571	integer device attributes (Vendor ID, Product ID and Revision).
12572	The format of the string is:
12573
12574	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
12575
12576	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
12577	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
12578	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
12579	is omitted before a dash (<tt>-</tt>), the minimum possible integer
12580	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
12581	possible integer is assumed.
12582	</li>
12583	<li><i>Boolean filters</i>. Used to specify acceptable values for
12584	boolean device attributes. The format of the string is:
12585
12586	<tt>true\|false\|yes\|no\|0\|1</tt>
12587
12588	</li>
12589	<li><i>Exact match</i>. Used to specify a single value for the given
12590	device attribute. Any string that doesn't start with <tt>int:</tt>
12591	represents the exact match. String device attributes are compared to
12592	this string including case of symbols. Integer attributes are first
12593	converted to a string (see individual filter attributes) and then
12594	compared ignoring case.
12595
12596	</li>
12597	<li><i>Any match</i>. Any value of the corresponding device attribute
12598	will match the given filter. An empty or @c null string is
12599	used to construct this type of filtering expressions.
12600
12601	</li>
12602	</ul>
12603
12604	<note>
12605	On the Windows host platform, interval filters are not currently
12606	available. Also all string filter attributes
12607	(<link to="#manufacturer"/>, <link to="#product"/>,
12608	<link to="#serialNumber"/>) are ignored, so they behave as
12609	<i>any match</i> no matter what string expression is specified.
12610	</note>
12611
12612	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
12613	</desc>
12614
12615	<attribute name="name" type="wstring">
12616	<desc>
12617	Visible name for this filter.
12618	This name is used to visually distinguish one filter from another,
12619	so it can neither be @c null nor an empty string.
12620	</desc>
12621	</attribute>
12622
12623	<attribute name="active" type="boolean">
12624	<desc>Whether this filter active or has been temporarily disabled.</desc>
12625	</attribute>
12626
12627	<attribute name="vendorId" type="wstring">
12628	<desc>
12629	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12630	The string representation for the <i>exact matching</i>
12631	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12632	(including leading zeroes).
12633	</desc>
12634	</attribute>
12635
12636	<attribute name="productId" type="wstring">
12637	<desc>
12638	<link to="IUSBDevice::productId">Product ID</link> filter.
12639	The string representation for the <i>exact matching</i>
12640	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12641	(including leading zeroes).
12642	</desc>
12643	</attribute>
12644
12645	<attribute name="revision" type="wstring">
12646	<desc>
12647	<link to="IUSBDevice::productId">Product revision number</link>
12648	filter. The string representation for the <i>exact matching</i>
12649	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12650	of the integer part of the revision, and <tt>F</tt> is the
12651	decimal digit of its fractional part (including leading and
12652	trailing zeros).
12653	Note that for interval filters, it's best to use the hexadecimal
12654	form, because the revision is stored as a 16 bit packed BCD value;
12655	so the expression <tt>int:0x0100-0x0199</tt> will match any
12656	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12657	</desc>
12658	</attribute>
12659
12660	<attribute name="manufacturer" type="wstring">
12661	<desc>
12662	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12663	</desc>
12664	</attribute>
12665
12666	<attribute name="product" type="wstring">
12667	<desc>
12668	<link to="IUSBDevice::product">Product</link> filter.
12669	</desc>
12670	</attribute>
12671
12672	<attribute name="serialNumber" type="wstring">
12673	<desc>
12674	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12675	</desc>
12676	</attribute>
12677
12678	<attribute name="port" type="wstring">
12679	<desc>
12680	<link to="IUSBDevice::port">Host USB port</link> filter.
12681	</desc>
12682	</attribute>
12683
12684	<attribute name="remote" type="wstring">
12685	<desc>
12686	<link to="IUSBDevice::remote">Remote state</link> filter.
12687	<note>
12688	This filter makes sense only for machine USB filters,
12689	i.e. it is ignored by IHostUSBDeviceFilter objects.
12690	</note>
12691	</desc>
12692	</attribute>
12693
12694	<attribute name="maskedInterfaces" type="unsigned long">
12695	<desc>
12696	This is an advanced option for hiding one or more USB interfaces
12697	from the guest. The value is a bit mask where the bits that are set
12698	means the corresponding USB interface should be hidden, masked off
12699	if you like.
12700	This feature only works on Linux hosts.
12701	</desc>
12702	</attribute>
12703
12704	</interface>
12705
12706
12707	<!--
12708	// IHostUSBDevice
12709	/////////////////////////////////////////////////////////////////////////
12710	-->
12711
12712	<enum
12713	name="USBDeviceState"
12714	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12715	>
12716	<desc>
12717	USB device state. This enumeration represents all possible states
12718	of the USB device physically attached to the host computer regarding
12719	its state on the host computer and availability to guest computers
12720	(all currently running virtual machines).
12721
12722	Once a supported USB device is attached to the host, global USB
12723	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12724	either ignore the device, or put it to USBDeviceState_Held state, or do
12725	nothing. Unless the device is ignored by global filters, filters of all
12726	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12727	activated that can put it to USBDeviceState_Captured state.
12728
12729	If the device was ignored by global filters, or didn't match
12730	any filters at all (including guest ones), it is handled by the host
12731	in a normal way. In this case, the device state is determined by
12732	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12733	or USBDeviceState_Available, depending on the current device usage.
12734
12735	Besides auto-capturing based on filters, the device can be manually
12736	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12737	state is USBDeviceState_Busy, USBDeviceState_Available or
12738	USBDeviceState_Held.
12739
12740	<note>
12741	Due to differences in USB stack implementations in Linux and Win32,
12742	states USBDeviceState_Busy and USBDeviceState_vailable are applicable
12743	only to the Linux version of the product. This also means that (<link
12744	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12745	device state is USBDeviceState_Held.
12746	</note>
12747
12748	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12749	</desc>
12750
12751	<const name="NotSupported" value="0">
12752	<desc>
12753	Not supported by the VirtualBox server, not available to guests.
12754	</desc>
12755	</const>
12756	<const name="Unavailable" value="1">
12757	<desc>
12758	Being used by the host computer exclusively,
12759	not available to guests.
12760	</desc>
12761	</const>
12762	<const name="Busy" value="2">
12763	<desc>
12764	Being used by the host computer, potentially available to guests.
12765	</desc>
12766	</const>
12767	<const name="Available" value="3">
12768	<desc>
12769	Not used by the host computer, available to guests (the host computer
12770	can also start using the device at any time).
12771	</desc>
12772	</const>
12773	<const name="Held" value="4">
12774	<desc>
12775	Held by the VirtualBox server (ignored by the host computer),
12776	available to guests.
12777	</desc>
12778	</const>
12779	<const name="Captured" value="5">
12780	<desc>
12781	Captured by one of the guest computers, not available
12782	to anybody else.
12783	</desc>
12784	</const>
12785	</enum>
12786
12787	<interface
12788	name="IHostUSBDevice" extends="IUSBDevice"
12789	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12790	wsmap="managed"
12791	>
12792	<desc>
12793	The IHostUSBDevice interface represents a physical USB device attached
12794	to the host computer.
12795
12796	Besides properties inherited from IUSBDevice, this interface adds the
12797	<link to="#state"/> property that holds the current state of the USB
12798	device.
12799
12800	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12801	</desc>
12802
12803	<attribute name="state" type="USBDeviceState" readonly="yes">
12804	<desc>
12805	Current state of the device.
12806	</desc>
12807	</attribute>
12808
12809	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12810
12811	</interface>
12812
12813
12814	<!--
12815	// IHostUSBDeviceFilter
12816	/////////////////////////////////////////////////////////////////////////
12817	-->
12818
12819	<enum
12820	name="USBDeviceFilterAction"
12821	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12822	>
12823	<desc>
12824	Actions for host USB device filters.
12825	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12826	</desc>
12827
12828	<const name="Null" value="0">
12829	<desc>Null value (never used by the API).</desc>
12830	</const>
12831	<const name="Ignore" value="1">
12832	<desc>Ignore the matched USB device.</desc>
12833	</const>
12834	<const name="Hold" value="2">
12835	<desc>Hold the matched USB device.</desc>
12836	</const>
12837	</enum>
12838
12839	<interface
12840	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12841	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12842	wsmap="managed"
12843	>
12844	<desc>
12845	The IHostUSBDeviceFilter interface represents a global filter for a
12846	physical USB device used by the host computer. Used indirectly in
12847	<link to="IHost::USBDeviceFilters"/>.
12848
12849	Using filters of this type, the host computer determines the initial
12850	state of the USB device after it is physically attached to the
12851	host's USB controller.
12852
12853	<note>
12854	The <link to="#remote"/> attribute is ignored by this type of
12855	filters, because it makes sense only for
12856	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12857	</note>
12858
12859	<see>IHost::USBDeviceFilters</see>
12860	</desc>
12861
12862	<attribute name="action" type="USBDeviceFilterAction">
12863	<desc>
12864	Action performed by the host when an attached USB device
12865	matches this filter.
12866	</desc>
12867	</attribute>
12868
12869	</interface>
12870
12871	<!--
12872	// IAudioAdapter
12873	/////////////////////////////////////////////////////////////////////////
12874	-->
12875
12876	<enum
12877	name="AudioDriverType"
12878	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12879	>
12880	<desc>
12881	Host audio driver type.
12882	</desc>
12883
12884	<const name="Null" value="0">
12885	<desc>Null value, also means "dummy audio driver".</desc>
12886	</const>
12887	<const name="WinMM" value="1">
12888	<desc>Windows multimedia (Windows hosts only).</desc>
12889	</const>
12890	<const name="OSS" value="2">
12891	<desc>Open Sound System (Linux hosts only).</desc>
12892	</const>
12893	<const name="ALSA" value="3">
12894	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12895	</const>
12896	<const name="DirectSound" value="4">
12897	<desc>DirectSound (Windows hosts only).</desc>
12898	</const>
12899	<const name="CoreAudio" value="5">
12900	<desc>CoreAudio (Mac hosts only).</desc>
12901	</const>
12902	<const name="MMPM" value="6">
12903	<desc>Reserved for historical reasons.</desc>
12904	</const>
12905	<const name="Pulse" value="7">
12906	<desc>PulseAudio (Linux hosts only).</desc>
12907	</const>
12908	<const name="SolAudio" value="8">
12909	<desc>Solaris audio (Solaris hosts only).</desc>
12910	</const>
12911	</enum>
12912
12913	<enum
12914	name="AudioControllerType"
12915	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12916	>
12917	<desc>
12918	Virtual audio controller type.
12919	</desc>
12920
12921	<const name="AC97" value="0"/>
12922	<const name="SB16" value="1"/>
12923	</enum>
12924
12925	<interface
12926	name="IAudioAdapter" extends="$unknown"
12927	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12928	wsmap="managed"
12929	>
12930	<desc>
12931	The IAudioAdapter interface represents the virtual audio adapter of
12932	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12933	</desc>
12934	<attribute name="enabled" type="boolean">
12935	<desc>
12936	Flag whether the audio adapter is present in the
12937	guest system. If disabled, the virtual guest hardware will
12938	not contain any audio adapter. Can only be changed when
12939	the VM is not running.
12940	</desc>
12941	</attribute>
12942	<attribute name="audioController" type="AudioControllerType">
12943	<desc>
12944	The audio hardware we emulate.
12945	</desc>
12946	</attribute>
12947	<attribute name="audioDriver" type="AudioDriverType">
12948	<desc>
12949	Audio driver the adapter is connected to. This setting
12950	can only be changed when the VM is not running.
12951	</desc>
12952	</attribute>
12953	</interface>
12954
12955	<!--
12956	// IVRDPServer
12957	/////////////////////////////////////////////////////////////////////////
12958	-->
12959
12960	<enum
12961	name="VRDPAuthType"
12962	uuid="3d91887a-b67f-4b33-85bf-2da7ab1ea83a"
12963	>
12964	<desc>
12965	VRDP authentication type.
12966	</desc>
12967
12968	<const name="Null" value="0">
12969	<desc>Null value, also means "no authentication".</desc>
12970	</const>
12971	<const name="External" value="1"/>
12972	<const name="Guest" value="2"/>
12973	</enum>
12974
12975	<interface
12976	name="IVRDPServer" extends="$unknown"
12977	uuid="7aeeb530-0b08-41fe-835d-9be9ec1dbe5c"
12978	wsmap="managed"
12979	>
12980	<attribute name="enabled" type="boolean">
12981	<desc>VRDP server status.</desc>
12982	</attribute>
12983
12984	<attribute name="ports" type="wstring">
12985	<desc>
12986	VRDP server port numbers. The server will try to bind to one of free ports from the list.
12987	<note>
12988	This is a string of comma separated TCP port numbers or port number ranges.
12989	Example <tt>5000,5010-5012,5015</tt>
12990	</note>
12991	</desc>
12992	</attribute>
12993
12994	<attribute name="netAddress" type="wstring">
12995	<desc>VRDP server address.</desc>
12996	</attribute>
12997
12998	<attribute name="authType" type="VRDPAuthType">
12999	<desc>VRDP authentication method.</desc>
13000	</attribute>
13001
13002	<attribute name="authTimeout" type="unsigned long">
13003	<desc>Timeout for guest authentication. Milliseconds.</desc>
13004	</attribute>
13005
13006	<attribute name="allowMultiConnection" type="boolean">
13007	<desc>
13008	Flag whether multiple simultaneous connections to the VM are permitted.
13009	Note that this will be replaced by a more powerful mechanism in the future.
13010	</desc>
13011	</attribute>
13012
13013	<attribute name="reuseSingleConnection" type="boolean">
13014	<desc>
13015	Flag whether the existing connection must be dropped and a new connection
13016	must be established by the VRDP server, when a new client connects in single
13017	connection mode.
13018	</desc>
13019	</attribute>
13020
13021	<attribute name="videoChannel" type="boolean">
13022	<desc>
13023	Flag whether RDP video channel is supported.
13024	</desc>
13025	</attribute>
13026
13027	<attribute name="videoChannelQuality" type="unsigned long">
13028	<desc>
13029	Image quality in percents.
13030	</desc>
13031	</attribute>
13032
13033	</interface>
13034
13035
13036	<!--
13037	// ISharedFolder
13038	/////////////////////////////////////////////////////////////////////////
13039	-->
13040
13041	<interface
13042	name="ISharedFolder" extends="$unknown"
13043	uuid="64637bb2-9e17-471c-b8f3-f8968dd9884e"
13044	wsmap="struct"
13045	>
13046	<desc>
13047	The ISharedFolder interface represents a folder in the host computer's
13048	file system accessible from the guest OS running inside a virtual
13049	machine using an associated logical name.
13050
13051	There are three types of shared folders:
13052	<ul>
13053	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
13054	folders available to all virtual machines.</li>
13055	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
13056	VM-specific shared folders available to the given virtual machine at
13057	startup.</li>
13058	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
13059	VM-specific shared folders created in the session context (for
13060	example, when the virtual machine is running) and automatically
13061	discarded when the session is closed (the VM is powered off).</li>
13062	</ul>
13063
13064	Logical names of shared folders must be unique within the given scope
13065	(global, permanent or transient). However, they do not need to be unique
13066	across scopes. In this case, the definition of the shared folder in a
13067	more specific scope takes precedence over definitions in all other
13068	scopes. The order of precedence is (more specific to more general):
13069	<ol>
13070	<li>Transient definitions</li>
13071	<li>Permanent definitions</li>
13072	<li>Global definitions</li>
13073	</ol>
13074
13075	For example, if MyMachine has a shared folder named
13076	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
13077	transient shared folder named <tt>C_DRIVE</tt> (that points
13078	to <tt>C:\\\\WINDOWS</tt>) will change the definition
13079	of <tt>C_DRIVE</tt> in the guest OS so
13080	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
13081	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
13082	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
13083	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
13084	to <tt>C:\\</tt> if it still exists.
13085
13086	Note that permanent and transient shared folders of different machines
13087	are in different name spaces, so they don't overlap and don't need to
13088	have unique logical names.
13089
13090	<note>
13091	Global shared folders are not implemented in the current version of the
13092	product.
13093	</note>
13094	</desc>
13095
13096	<attribute name="name" type="wstring" readonly="yes">
13097	<desc>Logical name of the shared folder.</desc>
13098	</attribute>
13099
13100	<attribute name="hostPath" type="wstring" readonly="yes">
13101	<desc>Full path to the shared folder in the host file system.</desc>
13102	</attribute>
13103
13104	<attribute name="accessible" type="boolean" readonly="yes">
13105	<desc>
13106	Whether the folder defined by the host path is currently
13107	accessible or not.
13108	For example, the folder can be unaccessible if it is placed
13109	on the network share that is not available by the time
13110	this property is read.
13111	</desc>
13112	</attribute>
13113
13114	<attribute name="writable" type="boolean" readonly="yes">
13115	<desc>
13116	Whether the folder defined by the host path is writable or
13117	not.
13118	</desc>
13119	</attribute>
13120
13121	<attribute name="lastAccessError" type="wstring" readonly="yes">
13122	<desc>
13123	Text message that represents the result of the last accessibility
13124	check.
13125
13126	Accessibility checks are performed each time the <link to="#accessible"/>
13127	attribute is read. An empty string is returned if the last
13128	accessibility check was successful. A non-empty string indicates a
13129	failure and should normally describe a reason of the failure (for
13130	example, a file read error).
13131	</desc>
13132	</attribute>
13133
13134	</interface>
13135
13136	<!--
13137	// ISession
13138	/////////////////////////////////////////////////////////////////////////
13139	-->
13140
13141	<interface
13142	name="IInternalSessionControl" extends="$unknown"
13143	uuid="ab161f72-e4b3-44e6-a919-2256474bda66"
13144	internal="yes"
13145	wsmap="suppress"
13146	>
13147	<method name="getPID">
13148	<desc>PID of the process that has created this Session object.
13149	</desc>
13150	<param name="pid" type="unsigned long" dir="return"/>
13151	</method>
13152
13153	<method name="getRemoteConsole">
13154	<desc>
13155	Returns the console object suitable for remote control.
13156
13157	<result name="VBOX_E_INVALID_VM_STATE">
13158	Session state prevents operation.
13159	</result>
13160	<result name="VBOX_E_INVALID_OBJECT_STATE">
13161	Session type prevents operation.
13162	</result>
13163
13164	</desc>
13165	<param name="console" type="IConsole" dir="return"/>
13166	</method>
13167
13168	<method name="assignMachine">
13169	<desc>
13170	Assigns the machine object associated with this direct-type
13171	session or informs the session that it will be a remote one
13172	(if @a machine == @c null).
13173
13174	<result name="VBOX_E_INVALID_VM_STATE">
13175	Session state prevents operation.
13176	</result>
13177	<result name="VBOX_E_INVALID_OBJECT_STATE">
13178	Session type prevents operation.
13179	</result>
13180
13181	</desc>
13182	<param name="machine" type="IMachine" dir="in"/>
13183	</method>
13184
13185	<method name="assignRemoteMachine">
13186	<desc>
13187	Assigns the machine and the (remote) console object associated with
13188	this remote-type session.
13189
13190	<result name="VBOX_E_INVALID_VM_STATE">
13191	Session state prevents operation.
13192	</result>
13193
13194	</desc>
13195	<param name="machine" type="IMachine" dir="in"/>
13196	<param name="console" type="IConsole" dir="in"/>
13197	</method>
13198
13199	<method name="updateMachineState">
13200	<desc>
13201	Updates the machine state in the VM process.
13202	Must be called only in certain cases
13203	(see the method implementation).
13204
13205	<result name="VBOX_E_INVALID_VM_STATE">
13206	Session state prevents operation.
13207	</result>
13208	<result name="VBOX_E_INVALID_OBJECT_STATE">
13209	Session type prevents operation.
13210	</result>
13211
13212	</desc>
13213	<param name="aMachineState" type="MachineState" dir="in"/>
13214	</method>
13215
13216	<method name="uninitialize">
13217	<desc>
13218	Uninitializes (closes) this session. Used by VirtualBox to close
13219	the corresponding remote session when the direct session dies
13220	or gets closed.
13221
13222	<result name="VBOX_E_INVALID_VM_STATE">
13223	Session state prevents operation.
13224	</result>
13225
13226	</desc>
13227	</method>
13228
13229	<method name="onNetworkAdapterChange">
13230	<desc>
13231	Triggered when settings of a network adapter of the
13232	associated virtual machine have changed.
13233
13234	<result name="VBOX_E_INVALID_VM_STATE">
13235	Session state prevents operation.
13236	</result>
13237	<result name="VBOX_E_INVALID_OBJECT_STATE">
13238	Session type prevents operation.
13239	</result>
13240
13241	</desc>
13242	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
13243	<param name="changeAdapter" type="boolean" dir="in"/>
13244	</method>
13245
13246	<method name="onSerialPortChange">
13247	<desc>
13248	Triggered when settings of a serial port of the
13249	associated virtual machine have changed.
13250
13251	<result name="VBOX_E_INVALID_VM_STATE">
13252	Session state prevents operation.
13253	</result>
13254	<result name="VBOX_E_INVALID_OBJECT_STATE">
13255	Session type prevents operation.
13256	</result>
13257
13258	</desc>
13259	<param name="serialPort" type="ISerialPort" dir="in"/>
13260	</method>
13261
13262	<method name="onParallelPortChange">
13263	<desc>
13264	Triggered when settings of a parallel port of the
13265	associated virtual machine have changed.
13266
13267	<result name="VBOX_E_INVALID_VM_STATE">
13268	Session state prevents operation.
13269	</result>
13270	<result name="VBOX_E_INVALID_OBJECT_STATE">
13271	Session type prevents operation.
13272	</result>
13273
13274	</desc>
13275	<param name="parallelPort" type="IParallelPort" dir="in"/>
13276	</method>
13277
13278	<method name="onStorageControllerChange">
13279	<desc>
13280	Triggered when settings of a storage controller of the
13281	associated virtual machine have changed.
13282
13283	<result name="VBOX_E_INVALID_VM_STATE">
13284	Session state prevents operation.
13285	</result>
13286	<result name="VBOX_E_INVALID_OBJECT_STATE">
13287	Session type prevents operation.
13288	</result>
13289
13290	</desc>
13291	</method>
13292
13293	<method name="onMediumChange">
13294	<desc>
13295	Triggered when attached media of the
13296	associated virtual machine have changed.
13297
13298	<result name="VBOX_E_INVALID_VM_STATE">
13299	Session state prevents operation.
13300	</result>
13301	<result name="VBOX_E_INVALID_OBJECT_STATE">
13302	Session type prevents operation.
13303	</result>
13304
13305	</desc>
13306
13307	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
13308	<param name="force" type="boolean" dir="in"/>
13309	</method>
13310
13311	<method name="onCPUChange">
13312	<desc>
13313	Notification when a CPU changes.
13314	</desc>
13315	<param name="cpu" type="unsigned long" dir="in">
13316	<desc>The CPU which changed</desc>
13317	</param>
13318	<param name="add" type="boolean" dir="in">
13319	<desc>Flag whether the CPU was added or removed</desc>
13320	</param>
13321	</method>
13322
13323	<method name="onVRDPServerChange">
13324	<desc>
13325	Triggered when settings of the VRDP server object of the
13326	associated virtual machine have changed.
13327
13328	<result name="VBOX_E_INVALID_VM_STATE">
13329	Session state prevents operation.
13330	</result>
13331	<result name="VBOX_E_INVALID_OBJECT_STATE">
13332	Session type prevents operation.
13333	</result>
13334
13335	</desc>
13336	<param name="restart" type="boolean" dir="in">
13337	<desc>Flag whether the server must be restarted</desc>
13338	</param>
13339	</method>
13340
13341	<method name="onUSBControllerChange">
13342	<desc>
13343	Triggered when settings of the USB controller object of the
13344	associated virtual machine have changed.
13345
13346	<result name="VBOX_E_INVALID_VM_STATE">
13347	Session state prevents operation.
13348	</result>
13349	<result name="VBOX_E_INVALID_OBJECT_STATE">
13350	Session type prevents operation.
13351	</result>
13352
13353	</desc>
13354	</method>
13355
13356	<method name="onSharedFolderChange">
13357	<desc>
13358	Triggered when a permanent (global or machine) shared folder has been
13359	created or removed.
13360	<note>
13361	We don't pass shared folder parameters in this notification because
13362	the order in which parallel notifications are delivered is not defined,
13363	therefore it could happen that these parameters were outdated by the
13364	time of processing this notification.
13365	</note>
13366
13367	<result name="VBOX_E_INVALID_VM_STATE">
13368	Session state prevents operation.
13369	</result>
13370	<result name="VBOX_E_INVALID_OBJECT_STATE">
13371	Session type prevents operation.
13372	</result>
13373
13374	</desc>
13375	<param name="global" type="boolean" dir="in"/>
13376	</method>
13377
13378	<method name="onUSBDeviceAttach">
13379	<desc>
13380	Triggered when a request to capture a USB device (as a result
13381	of matched USB filters or direct call to
13382	<link to="IConsole::attachUSBDevice"/>) has completed.
13383	A @c null @a error object means success, otherwise it
13384	describes a failure.
13385
13386	<result name="VBOX_E_INVALID_VM_STATE">
13387	Session state prevents operation.
13388	</result>
13389	<result name="VBOX_E_INVALID_OBJECT_STATE">
13390	Session type prevents operation.
13391	</result>
13392
13393	</desc>
13394	<param name="device" type="IUSBDevice" dir="in"/>
13395	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13396	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
13397	</method>
13398
13399	<method name="onUSBDeviceDetach">
13400	<desc>
13401	Triggered when a request to release the USB device (as a result
13402	of machine termination or direct call to
13403	<link to="IConsole::detachUSBDevice"/>) has completed.
13404	A @c null @a error object means success, otherwise it
13405	describes a failure.
13406
13407	<result name="VBOX_E_INVALID_VM_STATE">
13408	Session state prevents operation.
13409	</result>
13410	<result name="VBOX_E_INVALID_OBJECT_STATE">
13411	Session type prevents operation.
13412	</result>
13413
13414	</desc>
13415	<param name="id" type="uuid" mod="string" dir="in"/>
13416	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13417	</method>
13418
13419	<method name="onShowWindow">
13420	<desc>
13421	Called by <link to="IMachine::canShowConsoleWindow"/> and by
13422	<link to="IMachine::showConsoleWindow"/> in order to notify
13423	console callbacks
13424	<link to="IConsoleCallback::onCanShowWindow"/>
13425	and <link to="IConsoleCallback::onShowWindow"/>.
13426
13427	<result name="VBOX_E_INVALID_OBJECT_STATE">
13428	Session type prevents operation.
13429	</result>
13430
13431	</desc>
13432	<param name="check" type="boolean" dir="in"/>
13433	<param name="canShow" type="boolean" dir="out"/>
13434	<param name="winId" type="unsigned long long" dir="out"/>
13435	</method>
13436
13437	<method name="accessGuestProperty">
13438	<desc>
13439	Called by <link to="IMachine::getGuestProperty"/> and by
13440	<link to="IMachine::setGuestProperty"/> in order to read and
13441	modify guest properties.
13442
13443	<result name="VBOX_E_INVALID_VM_STATE">
13444	Machine session is not open.
13445	</result>
13446	<result name="VBOX_E_INVALID_OBJECT_STATE">
13447	Session type is not direct.
13448	</result>
13449
13450	</desc>
13451	<param name="name" type="wstring" dir="in"/>
13452	<param name="value" type="wstring" dir="in"/>
13453	<param name="flags" type="wstring" dir="in"/>
13454	<param name="isSetter" type="boolean" dir="in"/>
13455	<param name="retValue" type="wstring" dir="out"/>
13456	<param name="retTimestamp" type="unsigned long long" dir="out"/>
13457	<param name="retFlags" type="wstring" dir="out"/>
13458	</method>
13459
13460	<method name="enumerateGuestProperties">
13461	<desc>
13462	Return a list of the guest properties matching a set of patterns along
13463	with their values, time stamps and flags.
13464
13465	<result name="VBOX_E_INVALID_VM_STATE">
13466	Machine session is not open.
13467	</result>
13468	<result name="VBOX_E_INVALID_OBJECT_STATE">
13469	Session type is not direct.
13470	</result>
13471
13472	</desc>
13473	<param name="patterns" type="wstring" dir="in">
13474	<desc>
13475	The patterns to match the properties against as a comma-separated
13476	string. If this is empty, all properties currently set will be
13477	returned.
13478	</desc>
13479	</param>
13480	<param name="key" type="wstring" dir="out" safearray="yes">
13481	<desc>
13482	The key names of the properties returned.
13483	</desc>
13484	</param>
13485	<param name="value" type="wstring" dir="out" safearray="yes">
13486	<desc>
13487	The values of the properties returned. The array entries match the
13488	corresponding entries in the @a key array.
13489	</desc>
13490	</param>
13491	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
13492	<desc>
13493	The time stamps of the properties returned. The array entries match
13494	the corresponding entries in the @a key array.
13495	</desc>
13496	</param>
13497	<param name="flags" type="wstring" dir="out" safearray="yes">
13498	<desc>
13499	The flags of the properties returned. The array entries match the
13500	corresponding entries in the @a key array.
13501	</desc>
13502	</param>
13503	</method>
13504
13505	<method name="onlineMergeMedium">
13506	<desc>
13507	Triggers online merging of a hard disk. Used internally when deleting
13508	a snapshot while a VM referring to the same hard disk chain is running.
13509
13510	<result name="VBOX_E_INVALID_VM_STATE">
13511	Machine session is not open.
13512	</result>
13513	<result name="VBOX_E_INVALID_OBJECT_STATE">
13514	Session type is not direct.
13515	</result>
13516
13517	</desc>
13518	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
13519	<desc>The medium attachment to identify the medium chain.</desc>
13520	</param>
13521	<param name="sourceIdx" type="unsigned long" dir="in">
13522	<desc>The index of the source image in the chain.
13523	Redundant, but drastically reduces IPC.</desc>
13524	</param>
13525	<param name="targetIdx" type="unsigned long" dir="in">
13526	<desc>The index of the target image in the chain.
13527	Redundant, but drastically reduces IPC.</desc>
13528	</param>
13529	<param name="source" type="IMedium" dir="in">
13530	<desc>Merge source medium.</desc>
13531	</param>
13532	<param name="target" type="IMedium" dir="in">
13533	<desc>Merge target medium.</desc>
13534	</param>
13535	<param name="mergeForward" type="boolean" dir="in">
13536	<desc>Merge direction.</desc>
13537	</param>
13538	<param name="parentForTarget" type="IMedium" dir="in">
13539	<desc>For forward merges: new parent for target medium.</desc>
13540	</param>
13541	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
13542	<desc>For backward merges: list of media which need their parent UUID
13543	updated.</desc>
13544	</param>
13545	<param name="progress" type="IProgress" dir="in">
13546	<desc>
13547	Progress object for this operation.
13548	</desc>
13549	</param>
13550	</method>
13551
13552	</interface>
13553
13554	<interface
13555	name="ISession" extends="$unknown"
13556	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
13557	wsmap="managed"
13558	>
13559	<desc>
13560	The ISession interface represents a serialization primitive for virtual
13561	machines.
13562
13563	With VirtualBox, every time one wishes to manipulate a virtual machine
13564	(e.g. change its settings or start execution), a session object is
13565	required. Such an object must be passed to one of the session methods
13566	that open the given session, which then initiates the machine manipulation.
13567
13568	A session serves several purposes: it identifies to the inter-process VirtualBox
13569	code which process is currently working with the virtual machine, and it ensures
13570	that there are no incompatible requests from several processes for the
13571	same virtual machine. Session objects can therefore be thought of as mutex
13572	semaphores that lock virtual machines to prevent conflicting accesses from
13573	several processes.
13574
13575	How sessions objects are used depends on whether you use the Main API
13576	via COM or via the webservice:
13577
13578	<ul>
13579	<li>When using the COM API directly, an object of the Session class from the
13580	VirtualBox type library needs to be created. In regular COM C++ client code,
13581	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
13582	This object will then act as a local session object in further calls to open
13583	a session.
13584	</li>
13585
13586	<li>In the webservice, the session manager (IWebsessionManager) instead creates
13587	one session object automatically when <link to="IWebsessionManager::logon" />
13588	is called. A managed object reference to that session object can be retrieved by
13589	calling <link to="IWebsessionManager::getSessionObject" />. This session object
13590	reference can then be used to open sessions.
13591	</li>
13592	</ul>
13593
13594	Sessions are mainly used in two variations:
13595
13596	<ul>
13597	<li>
13598	To start a virtual machine in a separate process, one would call
13599	<link to="IVirtualBox::openRemoteSession"/>, which requires a session
13600	object as its first parameter. This session then identifies the caller
13601	and lets him control the started machine (for example, pause machine
13602	execution or power it down) as well as be notified about machine
13603	execution state changes.
13604	</li>
13605
13606	<li>To alter machine settings, or to start machine execution within the
13607	current process, one needs to open a direct session for the machine first by
13608	calling <link to="IVirtualBox::openSession"/>. While a direct session
13609	is open within one process, no any other process may open another direct
13610	session for the same machine. This prevents the machine from being changed
13611	by other processes while it is running or while the machine is being configured.
13612	</li>
13613	</ul>
13614
13615	One also can attach to an existing direct session already opened by
13616	another process (for example, in order to send a control request to the
13617	virtual machine such as the pause or the reset request). This is done by
13618	calling <link to="IVirtualBox::openExistingSession"/>.
13619
13620	<note>
13621	Unless you are trying to write a new VirtualBox front-end that
13622	performs direct machine execution (like the VirtualBox or VBoxSDL
13623	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
13624	session opened by <link to="IVirtualBox::openSession"/> and use this
13625	session only to change virtual machine settings. If you simply want to
13626	start virtual machine execution using one of the existing front-ends
13627	(for example the VirtualBox GUI or headless server), simply use
13628	<link to="IVirtualBox::openRemoteSession"/>; these front-ends
13629	will power up the machine automatically for you.
13630	</note>
13631	</desc>
13632
13633	<attribute name="state" type="SessionState" readonly="yes">
13634	<desc>Current state of this session.</desc>
13635	</attribute>
13636
13637	<attribute name="type" type="SessionType" readonly="yes">
13638	<desc>
13639	Type of this session. The value of this attribute is valid only
13640	if the session is currently open (i.e. its #state is
13641	SessionType_SessionOpen), otherwise an error will be returned.
13642	</desc>
13643	</attribute>
13644
13645	<attribute name="machine" type="IMachine" readonly="yes">
13646	<desc>Machine object associated with this session.</desc>
13647	</attribute>
13648
13649	<attribute name="console" type="IConsole" readonly="yes">
13650	<desc>Console object associated with this session.</desc>
13651	</attribute>
13652
13653	<method name="close">
13654	<desc>
13655	Closes a session that was previously opened.
13656
13657	It is recommended that every time an "open session" method (such as
13658	<link to="IVirtualBox::openRemoteSession" /> or
13659	<link to="IVirtualBox::openSession" />) has been called to
13660	manipulate a virtual machine, the caller invoke
13661	ISession::close() when it's done doing so. Since sessions are
13662	serialization primitives much like ordinary mutexes, they are
13663	best used the same way: for each "open" call, there should be
13664	a matching "close" call, even when errors occur.
13665
13666	Otherwise, if a direct session for a machine opened with
13667	<link to="IVirtualBox::openSession"/> is not explicitly closed
13668	when the application terminates, the state of the machine will
13669	be set to <link to="MachineState_Aborted" /> on the server.
13670
13671	Generally, it is recommended to close all open sessions explicitly
13672	before terminating the application (regardless of the reason for
13673	the termination).
13674
13675	<note>
13676	Do not expect the session state (<link to="ISession::state" />
13677	to return to "Closed" immediately after you invoke
13678	ISession::close(), particularly if you have started a remote
13679	session to execute the VM in a new process. The session state will
13680	automatically return to "Closed" once the VM is no longer executing,
13681	which can of course take a very long time.
13682	</note>
13683
13684	<result name="E_UNEXPECTED">
13685	Session is not open.
13686	</result>
13687
13688	</desc>
13689	</method>
13690
13691	</interface>
13692
13693	<!--
13694	// IStorageController
13695	/////////////////////////////////////////////////////////////////////////
13696	-->
13697
13698	<enum
13699	name="StorageBus"
13700	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
13701	>
13702	<desc>
13703	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
13704	see <link to="IStorageController::bus" />.
13705	</desc>
13706	<const name="Null" value="0">
13707	<desc>@c null value. Never used by the API.</desc>
13708	</const>
13709	<const name="IDE" value="1"/>
13710	<const name="SATA" value="2"/>
13711	<const name="SCSI" value="3"/>
13712	<const name="Floppy" value="4"/>
13713	<const name="SAS" value="5"/>
13714	</enum>
13715
13716	<enum
13717	name="StorageControllerType"
13718	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13719	>
13720	<desc>
13721	The exact variant of storage controller hardware presented
13722	to the guest; see <link to="IStorageController::controllerType" />.
13723	</desc>
13724
13725	<const name="Null" value="0">
13726	<desc>@c null value. Never used by the API.</desc>
13727	</const>
13728	<const name="LsiLogic" value="1">
13729	<desc>A SCSI controller of the LsiLogic variant.</desc>
13730	</const>
13731	<const name="BusLogic" value="2">
13732	<desc>A SCSI controller of the BusLogic variant.</desc>
13733	</const>
13734	<const name="IntelAhci" value="3">
13735	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13736	</const>
13737	<const name="PIIX3" value="4">
13738	<desc>An IDE controller of the PIIX3 variant.</desc>
13739	</const>
13740	<const name="PIIX4" value="5">
13741	<desc>An IDE controller of the PIIX4 variant.</desc>
13742	</const>
13743	<const name="ICH6" value="6">
13744	<desc>An IDE controller of the ICH6 variant.</desc>
13745	</const>
13746	<const name="I82078" value="7">
13747	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
13748	</const>
13749	<const name="LsiLogicSas" value="8">
13750	<desc>A variant of the LsiLogic controller using SAS.</desc>
13751	</const>
13752	</enum>
13753
13754	<interface
13755	name="IStorageController" extends="$unknown"
13756	uuid="fd93adc0-bbaa-4256-9e6e-00e29f9151c9"
13757	wsmap="managed"
13758	>
13759	<desc>
13760	Represents a storage controller that is attached to a virtual machine
13761	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
13762	attached to storage controllers in a real computer, virtual drives
13763	(represented by <link to="IMediumAttachment" />) are attached to virtual
13764	storage controllers, represented by this interface.
13765
13766	As opposed to physical hardware, VirtualBox has a very generic concept
13767	of a storage controller, and for purposes of the Main API, all virtual
13768	storage is attached to virtual machines via instances of this interface.
13769	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
13770	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
13771	is used, certain sub-types may be available and can be selected in
13772	<link to="#controllerType" />.
13773
13774	Depending on these settings, the guest operating system might see
13775	significantly different virtual hardware.
13776	</desc>
13777
13778	<attribute name="name" type="wstring" readonly="yes">
13779	<desc>
13780	Name of the storage controller, as originally specified with
13781	<link to="IMachine::addStorageController" />. This then uniquely
13782	identifies this controller with other method calls such as
13783	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
13784	</desc>
13785	</attribute>
13786
13787	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
13788	<desc>
13789	Maximum number of devices which can be attached to one port.
13790	</desc>
13791	</attribute>
13792
13793	<attribute name="minPortCount" type="unsigned long" readonly="yes">
13794	<desc>
13795	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
13796	</desc>
13797	</attribute>
13798
13799	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
13800	<desc>
13801	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
13802	</desc>
13803	</attribute>
13804
13805	<attribute name="instance" type="unsigned long">
13806	<desc>
13807	The instance number of the device in the running VM.
13808	</desc>
13809	</attribute>
13810
13811	<attribute name="portCount" type="unsigned long">
13812	<desc>
13813	The number of currently usable ports on the controller.
13814	The minimum and maximum number of ports for one controller are
13815	stored in <link to="IStorageController::minPortCount"/>
13816	and <link to="IStorageController::maxPortCount"/>.
13817	</desc>
13818	</attribute>
13819
13820	<attribute name="bus" type="StorageBus" readonly="yes">
13821	<desc>
13822	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
13823	</desc>
13824	</attribute>
13825
13826	<attribute name="controllerType" type="StorageControllerType">
13827	<desc>
13828	The exact variant of storage controller hardware presented
13829	to the guest.
13830	Depending on this value, VirtualBox will provide a different
13831	virtual storage controller hardware to the guest.
13832	For SATA, SAS and floppy controllers, only one variant is
13833	available, but for IDE and SCSI, there are several.
13834
13835	For SCSI controllers, the default type is LsiLogic.
13836	</desc>
13837	</attribute>
13838
13839	<attribute name="useHostIOCache" type="boolean">
13840	<desc>
13841	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
13842	caches and use synchronous file APIs on the host. This was the only option in the API before
13843	VirtualBox 3.2 and is still the default for IDE controllers.
13844
13845	If false, the host I/O cache will be disabled for image files attached to this storage controller.
13846	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
13847	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
13848	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
13849	virtual machines are running at the same time to prevent I/O cache related hangs.
13850	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
13851	</desc>
13852	</attribute>
13853
13854	<method name="getIDEEmulationPort">
13855	<desc>
13856	Gets the corresponding port number which is emulated as an IDE device.
13857	Works only with SATA controllers.
13858
13859	<result name="E_INVALIDARG">
13860	The @a devicePosition is not in the range 0 to 3.
13861	</result>
13862	<result name="E_NOTIMPL">
13863	The storage controller type is not SATAIntelAhci.
13864	</result>
13865
13866	</desc>
13867	<param name="devicePosition" type="long" dir="in"/>
13868	<param name="portNumber" type="long" dir="return"/>
13869	</method>
13870
13871	<method name="setIDEEmulationPort">
13872	<desc>
13873	Sets the port number which is emulated as an IDE device.
13874	Works only with SATA controllers.
13875
13876	<result name="E_INVALIDARG">
13877	The @a devicePosition is not in the range 0 to 3 or the
13878	@a portNumber is not in the range 0 to 29.
13879	</result>
13880	<result name="E_NOTIMPL">
13881	The storage controller type is not SATAIntelAhci.
13882	</result>
13883
13884	</desc>
13885	<param name="devicePosition" type="long" dir="in"/>
13886	<param name="portNumber" type="long" dir="in"/>
13887	</method>
13888
13889	</interface>
13890
13891	<if target="wsdl">
13892
13893	<!--
13894	// IManagedObjectRef
13895	/////////////////////////////////////////////////////////////////////////
13896	-->
13897
13898	<interface
13899	name="IManagedObjectRef" extends="$unknown"
13900	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13901	internal="yes"
13902	wsmap="managed"
13903	wscpp="hardcoded"
13904	>
13905	<desc>
13906	Managed object reference.
13907
13908	Only within the webservice, a managed object reference (which is really
13909	an opaque number) allows a webservice client to address an object
13910	that lives in the address space of the webservice server.
13911
13912	Behind each managed object reference, there is a COM object that lives
13913	in the webservice server's address space. The COM object is not freed
13914	until the managed object reference is released, either by an explicit
13915	call to <link to="IManagedObjectRef::release" /> or by logging off from
13916	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13917	all objects created during the webservice session.
13918
13919	Whenever a method call of the VirtualBox API returns a COM object, the
13920	webservice representation of that method will instead return a
13921	managed object reference, which can then be used to invoke methods
13922	on that object.
13923	</desc>
13924
13925	<method name="getInterfaceName">
13926	<desc>
13927	Returns the name of the interface that this managed object represents,
13928	for example, "IMachine", as a string.
13929	</desc>
13930	<param name="return" type="wstring" dir="return"/>
13931	</method>
13932
13933	<method name="release">
13934	<desc>
13935	Releases this managed object reference and frees the resources that
13936	were allocated for it in the webservice server process. After calling
13937	this method, the identifier of the reference can no longer be used.
13938	</desc>
13939	</method>
13940
13941	</interface>
13942
13943	<!--
13944	// IWebsessionManager
13945	/////////////////////////////////////////////////////////////////////////
13946	-->
13947
13948	<interface
13949	name="IWebsessionManager" extends="$unknown"
13950	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13951	internal="yes"
13952	wsmap="global"
13953	wscpp="hardcoded"
13954	>
13955	<desc>
13956	Websession manager. This provides essential services
13957	to webservice clients.
13958	</desc>
13959	<method name="logon">
13960	<desc>
13961	Logs a new client onto the webservice and returns a managed object reference to
13962	the IVirtualBox instance, which the client can then use as a basis to further
13963	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13964	interface, in one way or the other.
13965	</desc>
13966	<param name="username" type="wstring" dir="in"/>
13967	<param name="password" type="wstring" dir="in"/>
13968	<param name="return" type="IVirtualBox" dir="return"/>
13969	</method>
13970
13971	<method name="getSessionObject">
13972	<desc>
13973	Returns a managed object reference to the internal ISession object that was created
13974	for this web service session when the client logged on.
13975
13976	<see>ISession</see>
13977	</desc>
13978	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13979	<param name="return" type="ISession" dir="return"/>
13980	</method>
13981
13982	<method name="logoff">
13983	<desc>
13984	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13985	and destroys all resources associated with the session (most importantly, all
13986	managed objects created in the server while the session was active).
13987	</desc>
13988	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13989	</method>
13990
13991	</interface>
13992
13993	</if>
13994
13995	<!--
13996	// IPerformanceCollector & friends
13997	/////////////////////////////////////////////////////////////////////////
13998	-->
13999
14000	<interface
14001	name="IPerformanceMetric" extends="$unknown"
14002	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
14003	>
14004	<desc>
14005	The IPerformanceMetric interface represents parameters of the given
14006	performance metric.
14007	</desc>
14008
14009	<attribute name="metricName" type="wstring" readonly="yes">
14010	<desc>
14011	Name of the metric.
14012	</desc>
14013	</attribute>
14014
14015	<attribute name="object" type="$unknown" readonly="yes">
14016	<desc>
14017	Object this metric belongs to.
14018	</desc>
14019	</attribute>
14020
14021	<attribute name="description" type="wstring" readonly="yes">
14022	<desc>
14023	Textual description of the metric.
14024	</desc>
14025	</attribute>
14026
14027	<attribute name="period" type="unsigned long" readonly="yes">
14028	<desc>
14029	Time interval between samples, measured in seconds.
14030	</desc>
14031	</attribute>
14032
14033	<attribute name="count" type="unsigned long" readonly="yes">
14034	<desc>
14035	Number of recent samples retained by the performance collector for this
14036	metric.
14037
14038	When the collected sample count exceeds this number, older samples
14039	are discarded.
14040	</desc>
14041	</attribute>
14042
14043	<attribute name="unit" type="wstring" readonly="yes">
14044	<desc>
14045	Unit of measurement.
14046	</desc>
14047	</attribute>
14048
14049	<attribute name="minimumValue" type="long" readonly="yes">
14050	<desc>
14051	Minimum possible value of this metric.
14052	</desc>
14053	</attribute>
14054
14055	<attribute name="maximumValue" type="long" readonly="yes">
14056	<desc>
14057	Maximum possible value of this metric.
14058	</desc>
14059	</attribute>
14060	</interface>
14061
14062	<interface
14063	name="IPerformanceCollector" extends="$unknown"
14064	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
14065	wsmap="managed"
14066	>
14067	<desc>
14068	The IPerformanceCollector interface represents a service that collects
14069	and stores performance metrics data.
14070
14071	Performance metrics are associated with objects of interfaces like IHost
14072	and IMachine. Each object has a distinct set of performance metrics. The
14073	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
14074
14075	Metric data is collected at the specified intervals and is retained
14076	internally. The interval and the number of retained samples can be set
14077	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
14078	and collection settings are not persistent, they are discarded as soon as
14079	VBoxSVC process terminates. Moreover, metric settings and data associated
14080	with a particular VM only exist while VM is running. They disappear as
14081	soon as VM shuts down. It is not possible to set up metrics for machines
14082	that are powered off. One needs to start VM first, then set up metric
14083	collection parameters.
14084
14085	Metrics are organized hierarchically, with each level separated by a
14086	slash (/) character. Generally, the scheme for metric names is like this:
14087
14088	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
14089
14090	"Category/Metric" together form the base metric name. A base metric is
14091	the smallest unit for which a sampling interval and the number of
14092	retained samples can be set. Only base metrics can be enabled and
14093	disabled. All sub-metrics are collected when their base metric is
14094	collected. Collected values for any set of sub-metrics can be queried
14095	with <link to="IPerformanceCollector::queryMetricsData" />.
14096
14097	For example "CPU/Load/User:avg" metric name stands for the "CPU"
14098	category, "Load" metric, "User" submetric, "average" aggregate. An
14099	aggregate function is computed over all retained data. Valid aggregate
14100	functions are:
14101
14102	<ul>
14103	<li>avg -- average</li>
14104	<li>min -- minimum</li>
14105	<li>max -- maximum</li>
14106	</ul>
14107
14108	When setting up metric parameters, querying metric data, enabling or
14109	disabling metrics wildcards can be used in metric names to specify a
14110	subset of metrics. For example, to select all CPU-related metrics
14111	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
14112	so on. To query metric values without aggregates <tt>*:</tt> can be used.
14113
14114	The valid names for base metrics are:
14115
14116	<ul>
14117	<li>CPU/Load</li>
14118	<li>CPU/MHz</li>
14119	<li>RAM/Usage</li>
14120	</ul>
14121
14122	The general sequence for collecting and retrieving the metrics is:
14123	<ul>
14124	<li>
14125	Obtain an instance of IPerformanceCollector with
14126	<link to="IVirtualBox::performanceCollector" />
14127	</li>
14128	<li>
14129	Allocate and populate an array with references to objects the metrics
14130	will be collected for. Use references to IHost and IMachine objects.
14131	</li>
14132	<li>
14133	Allocate and populate an array with base metric names the data will
14134	be collected for.
14135	</li>
14136	<li>
14137	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
14138	the metric data will be collected and stored.
14139	</li>
14140	<li>
14141	Wait for the data to get collected.
14142	</li>
14143	<li>
14144	Allocate and populate an array with references to objects the metric
14145	values will be queried for. You can re-use the object array used for
14146	setting base metrics.
14147	</li>
14148	<li>
14149	Allocate and populate an array with metric names the data will be
14150	collected for. Note that metric names differ from base metric names.
14151	</li>
14152	<li>
14153	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
14154	that have been collected so far are returned. Note that the values
14155	are still retained internally and data collection continues.
14156	</li>
14157	</ul>
14158
14159	For an example of usage refer to the following files in VirtualBox SDK:
14160	<ul>
14161	<li>
14162	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
14163	</li>
14164	<li>
14165	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
14166	</li>
14167	</ul>
14168	</desc>
14169
14170	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
14171	<desc>
14172	Array of unique names of metrics.
14173
14174	This array represents all metrics supported by the performance
14175	collector. Individual objects do not necessarily support all of them.
14176	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
14177	list of supported metrics for a particular object.
14178	</desc>
14179	</attribute>
14180
14181	<method name="getMetrics">
14182	<desc>
14183	Returns parameters of specified metrics for a set of objects.
14184	<note>
14185	@c Null metrics array means all metrics. @c Null object array means
14186	all existing objects.
14187	</note>
14188	</desc>
14189	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14190	<desc>
14191	Metric name filter. Currently, only a comma-separated list of metrics
14192	is supported.
14193	</desc>
14194	</param>
14195	<param name="objects" type="$unknown" dir="in" safearray="yes">
14196	<desc>
14197	Set of objects to return metric parameters for.
14198	</desc>
14199	</param>
14200	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
14201	<desc>
14202	Array of returned metric parameters.
14203	</desc>
14204	</param>
14205	</method>
14206
14207	<method name="setupMetrics">
14208	<desc>
14209	Sets parameters of specified base metrics for a set of objects. Returns
14210	an array of <link to="IPerformanceMetric" /> describing the metrics
14211	have been affected.
14212	<note>
14213	@c Null or empty metric name array means all metrics. @c Null or
14214	empty object array means all existing objects. If metric name array
14215	contains a single element and object array contains many, the single
14216	metric name array element is applied to each object array element to
14217	form metric/object pairs.
14218	</note>
14219	</desc>
14220	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14221	<desc>
14222	Metric name filter. Comma-separated list of metrics with wildcard
14223	support.
14224	</desc>
14225	</param>
14226	<param name="objects" type="$unknown" dir="in" safearray="yes">
14227	<desc>
14228	Set of objects to setup metric parameters for.
14229	</desc>
14230	</param>
14231	<param name="period" type="unsigned long" dir="in">
14232	<desc>
14233	Time interval in seconds between two consecutive samples of
14234	performance data.
14235	</desc>
14236	</param>
14237	<param name="count" type="unsigned long" dir="in">
14238	<desc>
14239	Number of samples to retain in performance data history. Older
14240	samples get discarded.
14241	</desc>
14242	</param>
14243	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14244	<desc>
14245	Array of metrics that have been modified by the call to this method.
14246	</desc>
14247	</param>
14248	</method>
14249
14250	<method name="enableMetrics">
14251	<desc>
14252	Turns on collecting specified base metrics. Returns an array of
14253	<link to="IPerformanceMetric" /> describing the metrics have been
14254	affected.
14255	<note>
14256	@c Null or empty metric name array means all metrics. @c Null or
14257	empty object array means all existing objects. If metric name array
14258	contains a single element and object array contains many, the single
14259	metric name array element is applied to each object array element to
14260	form metric/object pairs.
14261	</note>
14262	</desc>
14263	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14264	<desc>
14265	Metric name filter. Comma-separated list of metrics with wildcard
14266	support.
14267	</desc>
14268	</param>
14269	<param name="objects" type="$unknown" dir="in" safearray="yes">
14270	<desc>
14271	Set of objects to enable metrics for.
14272	</desc>
14273	</param>
14274	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14275	<desc>
14276	Array of metrics that have been modified by the call to this method.
14277	</desc>
14278	</param>
14279	</method>
14280
14281	<method name="disableMetrics">
14282	<desc>
14283	Turns off collecting specified base metrics. Returns an array of
14284	<link to="IPerformanceMetric" /> describing the metrics have been
14285	affected.
14286	<note>
14287	@c Null or empty metric name array means all metrics. @c Null or
14288	empty object array means all existing objects. If metric name array
14289	contains a single element and object array contains many, the single
14290	metric name array element is applied to each object array element to
14291	form metric/object pairs.
14292	</note>
14293	</desc>
14294	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14295	<desc>
14296	Metric name filter. Comma-separated list of metrics with wildcard
14297	support.
14298	</desc>
14299	</param>
14300	<param name="objects" type="$unknown" dir="in" safearray="yes">
14301	<desc>
14302	Set of objects to disable metrics for.
14303	</desc>
14304	</param>
14305	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14306	<desc>
14307	Array of metrics that have been modified by the call to this method.
14308	</desc>
14309	</param>
14310	</method>
14311
14312	<method name="queryMetricsData">
14313	<desc>
14314	Queries collected metrics data for a set of objects.
14315
14316	The data itself and related metric information are returned in seven
14317	parallel and one flattened array of arrays. Elements of
14318	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
14319	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
14320	the same index describe one set of values corresponding to a single
14321	metric.
14322
14323	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
14324	start and length of a sub-array is indicated by
14325	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
14326	value for metric <tt>metricNames[i]</tt> is at
14327	<tt>returnData[returnIndices[i]]</tt>.
14328
14329	<note>
14330	@c Null or empty metric name array means all metrics. @c Null or
14331	empty object array means all existing objects. If metric name array
14332	contains a single element and object array contains many, the single
14333	metric name array element is applied to each object array element to
14334	form metric/object pairs.
14335	</note>
14336	<note>
14337	Data collection continues behind the scenes after call to @c
14338	queryMetricsData. The return data can be seen as the snapshot of the
14339	current state at the time of @c queryMetricsData call. The internally
14340	kept metric values are not cleared by the call. This makes possible
14341	querying different subsets of metrics or aggregates with subsequent
14342	calls. If periodic querying is needed it is highly suggested to query
14343	the values with @c interval*count period to avoid confusion. This way
14344	a completely new set of data values will be provided by each query.
14345	</note>
14346	</desc>
14347	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14348	<desc>
14349	Metric name filter. Comma-separated list of metrics with wildcard
14350	support.
14351	</desc>
14352	</param>
14353	<param name="objects" type="$unknown" dir="in" safearray="yes">
14354	<desc>
14355	Set of objects to query metrics for.
14356	</desc>
14357	</param>
14358	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
14359	<desc>
14360	Names of metrics returned in @c returnData.
14361	</desc>
14362	</param>
14363	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
14364	<desc>
14365	Objects associated with metrics returned in @c returnData.
14366	</desc>
14367	</param>
14368	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
14369	<desc>
14370	Units of measurement for each returned metric.
14371	</desc>
14372	</param>
14373	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
14374	<desc>
14375	Divisor that should be applied to return values in order to get
14376	floating point values. For example:
14377	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
14378	will retrieve the floating point value of i-th sample of the first
14379	metric.
14380	</desc>
14381	</param>
14382	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
14383	<desc>
14384	Sequence numbers of the first elements of value sequences of
14385	particular metrics returned in @c returnData. For aggregate metrics
14386	it is the sequence number of the sample the aggregate started
14387	calculation from.
14388	</desc>
14389	</param>
14390	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
14391	<desc>
14392	Indices of the first elements of value sequences of particular
14393	metrics returned in @c returnData.
14394	</desc>
14395	</param>
14396	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
14397	<desc>
14398	Lengths of value sequences of particular metrics.
14399	</desc>
14400	</param>
14401	<param name="returnData" type="long" dir="return" safearray="yes">
14402	<desc>
14403	Flattened array of all metric data containing sequences of values for
14404	each metric.
14405	</desc>
14406	</param>
14407	</method>
14408
14409	</interface>
14410	<enum
14411	name="NATAliasMode"
14412	uuid="67772168-50d9-11df-9669-7fb714ee4fa1">
14413	<desc></desc>
14414	<const name="AliasLog" value="0x1">
14415	<desc></desc>
14416	</const>
14417	<const name="AliasProxyOnly" value="0x02">
14418	<desc></desc>
14419	</const>
14420	<const name="AliasUseSamePorts" value="0x04">
14421	<desc></desc>
14422	</const>
14423	</enum>
14424	<enum
14425	name="NATProtocol"
14426	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
14427	>
14428	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
14429	<const name="UDP" value="0">
14430	<desc>Port-forwarding uses UDP protocol.</desc>
14431	</const>
14432	<const name="TCP" value="1">
14433	<desc>Port-forwarding uses TCP protocol.</desc>
14434	</const>
14435	</enum>
14436
14437	<interface
14438	name="INATEngine" extends="$unknown"
14439	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
14440	wsmap="managed"
14441	>
14442	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
14443	allows for changing NAT behavior such as port-forwarding rules. This interface is
14444	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
14445	<attribute name="network" type="wstring">
14446	<desc>The network attribute of the NAT engine (the same value is used with built-in
14447	DHCP server to fill corresponding fields of DHCP leases).</desc>
14448	</attribute>
14449	<attribute name="hostIP" type="wstring">
14450	<desc>IP of host interface to bind all opened sockets to.
14451	<note>Changing this does not change binding of port forwarding.</note>
14452	</desc>
14453	</attribute>
14454	<attribute name="tftpPrefix" type="wstring">
14455	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
14456	the corresponding fields of DHCP leases.</desc>
14457	</attribute>
14458	<attribute name="tftpBootFile" type="wstring">
14459	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
14460	the corresponding fields of DHCP leases.</desc>
14461	</attribute>
14462	<attribute name="tftpNextServer" type="wstring">
14463	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
14464	the corresponding fields of DHCP leases.
14465	<note>The preferred form is IPv4 addresses.</note>
14466	</desc>
14467	</attribute>
14468	<attribute name="aliasMode" type="unsigned long">
14469	<desc></desc>
14470	</attribute>
14471	<attribute name="dnsPassDomain" type="boolean">
14472	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
14473	</attribute>
14474	<attribute name="dnsProxy" type="boolean">
14475	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14476	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
14477	</attribute>
14478	<attribute name="dnsUseHostResolver" type="boolean">
14479	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14480	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
14481	</attribute>
14482	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
14483	<desc>Array of NAT port-forwarding rules in string representation, in the following
14484	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
14485	</attribute>
14486	<method name="setNetworkSettings">
14487	<desc>Sets network configuration of the NAT engine.</desc>
14488	<param name="mtu" type="unsigned long" dir="in">
14489	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
14490	</param>
14491	<param name="sockSnd" type="unsigned long" dir="in">
14492	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
14493	</param>
14494	<param name="sockRcv" type="unsigned long" dir="in">
14495	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
14496	</param>
14497	<param name="TcpWndSnd" type="unsigned long" dir="in">
14498	<desc>Initial size of the NAT engine's sending TCP window in bytes when
14499	establishing a new TCP connection.</desc>
14500	</param>
14501	<param name="TcpWndRcv" type="unsigned long" dir="in">
14502	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
14503	establishing a new TCP connection.</desc>
14504	</param>
14505	</method>
14506	<method name="getNetworkSettings">
14507	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
14508	for parameter descriptions.</desc>
14509	<param name="mtu" type="unsigned long" dir="out" />
14510	<param name="sockSnd" type="unsigned long" dir="out" />
14511	<param name="sockRcv" type="unsigned long" dir="out" />
14512	<param name="TcpWndSnd" type="unsigned long" dir="out" />
14513	<param name="TcpWndRcv" type="unsigned long" dir="out" />
14514	</method>
14515	<method name="addRedirect">
14516	<desc>Adds a new NAT port-forwarding rule.</desc>
14517	<param name="name" type="wstring" dir="in">
14518	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
14519	auto-generates one using the other parameters.</desc>
14520	</param>
14521	<param name="proto" type="NATProtocol" dir="in">
14522	<desc>Protocol handled with the rule.</desc>
14523	</param>
14524	<param name="hostIp" type="wstring" dir="in">
14525	<desc>IP of the host interface to which the rule should apply. An empty ip address is
14526	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
14527	</param>
14528	<param name="hostPort" type="unsigned short" dir="in">
14529	<desc>The port number to listen on.</desc>
14530	</param>
14531	<param name="guestIp" type="wstring" dir="in">
14532	<desc>The IP address of the guest which the NAT engine will forward matching packets
14533	to. An empty IP address is acceptable, in which case the NAT engine will forward
14534	packets to the first DHCP lease (x.x.x.15).</desc>
14535	</param>
14536	<param name="guestPort" type="unsigned short" dir="in">
14537	<desc>The port number to forward.</desc>
14538	</param>
14539	</method>
14540	<method name="removeRedirect">
14541	<desc>Removes a port-forwarding rule that was previously registered.</desc>
14542	<param name="name" type="wstring" dir="in">
14543	<desc>The name of the rule to delete.</desc>
14544	</param>
14545	</method>
14546	</interface>
14547
14548	<module name="VBoxSVC" context="LocalServer">
14549	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
14550	namespace="virtualbox.org">
14551	<interface name="IVirtualBox" default="yes"/>
14552	<eventsink name="IVirtualBoxCallback" default="yes"/>
14553	</class>
14554	</module>
14555
14556	<module name="VBoxC" context="InprocServer" threadingModel="Free">
14557	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
14558	namespace="virtualbox.org">
14559	<interface name="ISession" default="yes"/>
14560	</class>
14561
14562	<class name="Console" uuid="577230FF-164F-4CAC-8548-312D8275A4A7"
14563	namespace="virtualbox.org">
14564	<interface name="IConsole" default="yes"/>
14565	<eventsink name="IConsoleCallback" default="yes"/>
14566	</class>
14567
14568	<class name="CallbackWrapper" uuid="49EE8561-5563-4715-B18C-A4B1A490DAFE"
14569	namespace="virtualbox.org">
14570	<interface name="ILocalOwner" default="yes"/>
14571	<interface name="IVirtualBoxCallback"/>
14572	<interface name="IConsoleCallback"/>
14573	</class>
14574	</module>
14575
14576	</library>
14577
14578	</idl>
14579
14580	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format