VirtualBox

source: vbox/trunk/src/VBox/Main/idl/VirtualBox.xidl@ 42841

Last change on this file since 42841 was 42838, checked in by vboxsync, 12 years ago

Main/EncodeAndVideoRecording Module and API implementation: Integrating an independent encoding and video recording module that will serve all the frontends.
Introducing settings settings and API implementation for accessing and modifying video recording parameters:
->target video capture file
->video capture width
->video capture height
->enable video capturing

  • Property svn:eol-style set to native
File size: 741.9 KB
Line 
1<?xml version="1.0" encoding="utf-8"?>
2
3<!--
4
5 Copyright (C) 2006-2012 Oracle Corporation
6
7 This file is part of VirtualBox Open Source Edition (OSE), as
8 available from http://www.virtualbox.org. This file is free software;
9 you can redistribute it and/or modify it under the terms of the GNU
10 General Public License (GPL) as published by the Free Software
11 Foundation, in version 2 as it comes in the "COPYING" file of the
12 VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13 hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14-->
15
16<!--
17 This is the master declaration for VirtualBox's Main API,
18 represented by COM/XPCOM and web service interfaces.
19
20 From this document, the build system generates several files
21 via XSLT that are then used during the build process.
22
23 Below is the list of XSL templates that operate on this file and
24 output files they generate. These XSL templates must be updated
25 whenever the schema of this file changes:
26
27 1. src/VBox/Main/idl/midl.xsl =>
28 out/<platform>/bin/sdk/idl/VirtualBox.idl
29 (MS COM interface definition file for Main API)
30
31 2. src/VBox/Main/idl/xpidl.xsl =>
32 out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33 (XPCOM interface definition file for Main API)
34
35 3. src/VBox/Main/idl/doxygen.xsl =>
36 out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37 (pseudo-IDL for Doxygen to generate the official Main API
38 documentation)
39
40 4. src/VBox/Main/webservice/*.xsl =>
41 a bunch of WSDL and C++ files
42 (VirtualBox web service sources and SOAP mappers;
43 see src/VBox/Main/webservice/Makefile.kmk for details)
44
45 5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46 out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47 (smart Qt-based C++ wrapper classes for COM interfaces
48 of the Main API)
49
50 6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51 out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52 (Main API TypeLib block for the WiX installer)
53
54 7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55 out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56 (<result> extraction for the %Rhrc format specifier)
57-->
58
59<idl>
60
61<desc>
62 Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63 describes the so-called <i>VirtualBox Main API</i> which comprises all public
64 COM interfaces and components provided by the VirtualBox server and by the
65 VirtualBox client library.
66
67 VirtualBox employs a client-server design, meaning that whenever any part of
68 VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69 interface or any virtual machine --, a dedicated server process named
70 VBoxSVC runs in the background. This allows multiple processes working with
71 VirtualBox to cooperate without conflicts. These processes communicate to each
72 other using inter-process communication facilities provided by the COM
73 implementation of the host computer.
74
75 On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76 implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77 implementation, is used.
78
79 All the parts that a typical VirtualBox user interacts with (the Qt GUI
80 and the VBoxManage command-line interface) are technically
81 front-ends to the Main API and only use the interfaces that are documented
82 in this Main API documentation. This ensures that, with any given release
83 version of VirtualBox, all capabilities of the product that could be useful
84 to an external client program are always exposed by way of this API.
85
86 The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87 contains two public component classes:
88 <tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89 implement IVirtualBox and ISession interfaces respectively. These two classes
90 are of supreme importance and will be needed in order for any front-end
91 program to do anything useful. It is recommended to read the documentation of
92 the mentioned interfaces first.
93
94 The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95 there can be only one object of this class on the local machine at any given
96 time. This object is a parent of many other objects in the VirtualBox COM
97 library and lives in the VBoxSVC process. In fact, when you create an instance
98 of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99 process is already running, starts it if not, and returns you a reference to
100 the <tt>VirtualBox</tt> object created in this process. When the last reference
101 to this object is released, the VBoxSVC process ends (with a 5 second delay to
102 protect from too frequent restarts).
103
104 The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105 as many <tt>Session</tt> objects as you need but all of them will live in a
106 process which issues the object instantiation call. <tt>Session</tt> objects
107 represent virtual machine sessions which are used to configure virtual
108 machines and control their execution.
109
110 The naming of methods and attributes is very clearly defined: they all start
111 with a lowercase letter (except if they start with an acronym), and are using
112 CamelCase style otherwise. This naming only applies to the IDL description,
113 and is modified by the various language bindings (some convert the first
114 character to upper case, some not). See the SDK reference for more details
115 about how to call a method or attribute from a specific programming language.
116</desc>
117
118<if target="midl">
119 <cpp line="enum {"/>
120 <cpp line=" kTypeLibraryMajorVersion = 1,"/>
121 <cpp line=" kTypeLibraryMinorVersion = 0"/>
122 <cpp line="};"/>
123</if>
124
125<if target="xpidl">
126 <!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
127 <cpp>
128/* currently, nsISupportsImpl.h lacks the below-like macros */
129
130#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
131#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
132#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
133#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
134
135
136#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
137# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
138 NS_IMPL_THREADSAFE_ADDREF(_class) \
139 NS_IMPL_THREADSAFE_RELEASE(_class) \
140 NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
141 NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
142#endif
143
144#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
145# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
146 NS_IMPL_THREADSAFE_ADDREF(_class) \
147 NS_IMPL_THREADSAFE_RELEASE(_class) \
148 NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
149 NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
150#endif
151
152#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
153# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
154 NS_IMPL_THREADSAFE_ADDREF(_class) \
155 NS_IMPL_THREADSAFE_RELEASE(_class) \
156 NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
157 NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
158#endif
159
160#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
161# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
162 NS_IMPL_THREADSAFE_ADDREF(_class) \
163 NS_IMPL_THREADSAFE_RELEASE(_class) \
164 NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
165 NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
166#endif
167
168#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
169# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
170 NS_INTERFACE_MAP_BEGIN(_class) \
171 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
172 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
173 NS_IMPL_QUERY_CLASSINFO(_class) \
174 NS_INTERFACE_MAP_END
175#endif
176
177#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
178# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
179 _i2, _ic2) \
180 NS_INTERFACE_MAP_BEGIN(_class) \
181 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
182 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
183 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
184 NS_IMPL_QUERY_CLASSINFO(_class) \
185 NS_INTERFACE_MAP_END
186#endif
187
188#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
189# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
190 _i2, _ic2, _i3, _ic3) \
191 NS_INTERFACE_MAP_BEGIN(_class) \
192 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
193 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
194 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
195 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
196 NS_IMPL_QUERY_CLASSINFO(_class) \
197 NS_INTERFACE_MAP_END
198#endif
199
200#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
201#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
202#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
203
204#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
205# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
206 NS_IMPL_THREADSAFE_ADDREF(_class) \
207 NS_IMPL_THREADSAFE_RELEASE(_class) \
208 NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
209 NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
210#endif
211
212#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
213# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
214 _i2, _ic2) \
215 NS_IMPL_THREADSAFE_ADDREF(_class) \
216 NS_IMPL_THREADSAFE_RELEASE(_class) \
217 NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
218 _i2, _ic2) \
219 NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
220#endif
221
222#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
223# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
224 _i2, _ic2, _i3, _ic3) \
225 NS_IMPL_THREADSAFE_ADDREF(_class) \
226 NS_IMPL_THREADSAFE_RELEASE(_class) \
227 NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
228 _i2, _ic2, _i3, _ic3) \
229 NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
230#endif
231
232 </cpp>
233</if>
234
235<library
236 name="VirtualBox"
237 uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
238 version="1.3"
239 desc="VirtualBox Type Library"
240 appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
241 supportsErrorInfo="yes"
242>
243
244
245 <!--
246 // COM result codes for VirtualBox
247 /////////////////////////////////////////////////////////////////////////
248 -->
249
250 <descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
251 <desc>
252 This section describes all VirtualBox-specific COM result codes that may
253 be returned by methods of VirtualBox COM interfaces in addition to
254 standard COM result codes.
255
256 Note that along with the result code, every VirtualBox method returns
257 extended error information through the IVirtualBoxErrorInfo interface on
258 failure. This interface is a preferred way to present the error to the end
259 user because it contains a human readable description of the error. Raw
260 result codes, both standard and described in this section, are intended to
261 be used by programs to analyze the reason of a failure and select an
262 appropriate course of action without involving the end user (for example,
263 retry the operation later or make a different call).
264
265 The standard COM result codes that may originate from our methods include:
266
267 <table>
268 <tr><td>E_INVALIDARG</td>
269 <td>
270 Returned when the value of the method's argument is not within the range
271 of valid values. This should not be confused with situations when the
272 value is within the range but simply doesn't suit the current object
273 state and there is a possibility that it will be accepted later (in such
274 cases VirtualBox-specific codes are returned, for example,
275 <link to="VBOX_E_OBJECT_NOT_FOUND"/>).
276 </td>
277 </tr>
278 <tr><td>E_POINTER</td>
279 <td>
280 Returned if a memory pointer for the output argument is invalid (for
281 example, @c null). When pointers representing input arguments (such
282 as strings) are invalid, E_INVALIDARG is returned.
283 </td>
284 </tr>
285 <tr><td>E_ACCESSDENIED</td>
286 <td>
287 Returned when the called object is not ready. Since the lifetime of a
288 public COM object cannot be fully controlled by the implementation,
289 VirtualBox maintains the readiness state for all objects it creates and
290 returns this code in response to any method call on the object that was
291 deactivated by VirtualBox and is not functioning any more.
292 </td>
293 </tr>
294 <tr><td>E_OUTOFMEMORY</td>
295 <td>
296 Returned when a memory allocation operation fails.
297 </td>
298 </tr>
299 </table>
300 </desc>
301 </descGroup>
302
303 <!--
304 Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
305 everything in <result>/<desc> after (and including) the first dot, so express
306 the matter of the error code in the first sentence and keep it short.
307 -->
308
309 <result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
310 <desc>
311 Object corresponding to the supplied arguments does not exist.
312 </desc>
313 </result>
314
315 <result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
316 <desc>
317 Current virtual machine state prevents the operation.
318 </desc>
319 </result>
320
321 <result name="VBOX_E_VM_ERROR" value="0x80BB0003">
322 <desc>
323 Virtual machine error occurred attempting the operation.
324 </desc>
325 </result>
326
327 <result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
328 <desc>
329 File not accessible or erroneous file contents.
330 </desc>
331 </result>
332
333 <result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
334 <desc>
335 Runtime subsystem error.
336 </desc>
337 </result>
338
339 <result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
340 <desc>
341 Pluggable Device Manager error.
342 </desc>
343 </result>
344
345 <result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
346 <desc>
347 Current object state prohibits operation.
348 </desc>
349 </result>
350
351 <result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
352 <desc>
353 Host operating system related error.
354 </desc>
355 </result>
356
357 <result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
358 <desc>
359 Requested operation is not supported.
360 </desc>
361 </result>
362
363 <result name="VBOX_E_XML_ERROR" value="0x80BB000A">
364 <desc>
365 Invalid XML found.
366 </desc>
367 </result>
368
369 <result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
370 <desc>
371 Current session state prohibits operation.
372 </desc>
373 </result>
374
375 <result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
376 <desc>
377 Object being in use prohibits operation.
378 </desc>
379 </result>
380
381 <!--
382 Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
383 everything in <result>/<desc> after (and including) the first dot, so express
384 the matter of the error code in the first sentence and keep it short.
385 -->
386
387 <descGroup/>
388
389 <!--
390 // all common enums
391 /////////////////////////////////////////////////////////////////////////
392 -->
393
394 <enum
395 name="SettingsVersion"
396 uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
397 >
398 <desc>
399 Settings version of VirtualBox settings files. This is written to
400 the "version" attribute of the root "VirtualBox" element in the settings
401 file XML and indicates which VirtualBox version wrote the file.
402 </desc>
403
404 <const name="Null" value="0">
405 <desc>Null value, indicates invalid version.</desc>
406 </const>
407 <const name="v1_0" value="1">
408 <desc>Legacy settings version, not currently supported.</desc>
409 </const>
410 <const name="v1_1" value="2">
411 <desc>Legacy settings version, not currently supported.</desc>
412 </const>
413 <const name="v1_2" value="3">
414 <desc>Legacy settings version, not currently supported.</desc>
415 </const>
416 <const name="v1_3pre" value="4">
417 <desc>Legacy settings version, not currently supported.</desc>
418 </const>
419 <const name="v1_3" value="5">
420 <desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
421 <!--
422 Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
423 -->
424 </const>
425 <const name="v1_4" value="6">
426 <desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
427 <!--
428 VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
429 (was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
430 -->
431 </const>
432 <const name="v1_5" value="7">
433 <desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
434 <!--
435 2008-09-04: 2.0.0 released
436 2008-11-20: settings version 1.5 introduced
437 2008-12-17: 2.1.0 released
438 Machine changes:
439 guest OS identifiers changed;
440 Machine/Hardware/Display/MonitorCount renamed to monitorCount;
441 Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
442 Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
443 -->
444 </const>
445 <const name="v1_6" value="8">
446 <desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
447 <!--
448 2008-12-17: 2.1.0 released
449 2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
450 2009-04-08: 2.2.0 released
451 Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
452 -->
453 </const>
454 <const name="v1_7" value="9">
455 <desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
456 <!--
457 2008-12-17: 2.1.0 released
458 2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
459 2009-04-08: 2.2.0 released
460 VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
461 Machine changes: HardDiskAttachments is now StorageControllers (done)
462 -->
463 </const>
464 <const name="v1_8" value="10">
465 <desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
466 <!--
467 Machine additions: Display/@accelerate2DVideo (done)
468 -->
469 </const>
470 <const name="v1_9" value="11">
471 <desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
472 <!--
473 The big storage controller / DVD / Floppy rework (done)
474 -->
475 </const>
476 <const name="v1_10" value="12">
477 <desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
478 <!--
479 Machine changes: RTC localOrUTC (done)
480 CPU hot-plug support
481 -->
482 </const>
483 <const name="v1_11" value="13">
484 <desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
485 <!--
486 Machine changes: HD Audio controller, per-machine disk registries,
487 /@format attribute for DVD and floppy images.
488 -->
489 </const>
490 <const name="v1_12" value="14">
491 <desc>Settings version "1.12", written by VirtualBox 4.1.x.</desc>
492 <!--
493 Machine changes: raw PCI device attachment;
494 NetworkAdapter changes: bandwidth group.
495 -->
496 </const>
497 <const name="v1_13" value="15">
498 <desc>Settings version "1.13", written by VirtualBox 4.2.x.</desc>
499 <!--
500 Machine changes: tracing config, groups, autostart;
501 NetworkAdapter changes: unit for bandwidth group limits.
502 -->
503 </const>
504
505 <const name="Future" value="99999">
506 <desc>Settings version greater than "1.13", written by a future VirtualBox version.</desc>
507 </const>
508 </enum>
509
510 <enum
511 name="AccessMode"
512 uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
513 >
514 <desc>
515 Access mode for opening files.
516 </desc>
517
518 <const name="ReadOnly" value="1"/>
519 <const name="ReadWrite" value="2"/>
520 </enum>
521
522 <enum
523 name="MachineState"
524 uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
525 >
526 <desc>
527 Virtual machine execution state.
528
529 This enumeration represents possible values of the <link
530 to="IMachine::state"/> attribute.
531
532 Below is the basic virtual machine state diagram. It shows how the state
533 changes during virtual machine execution. The text in square braces shows
534 a method of the IConsole interface that performs the given state
535 transition.
536
537 <pre>
538 +---------[powerDown()] &lt;- Stuck &lt;--[failure]-+
539 V |
540 +-&gt; PoweredOff --+--&gt;[powerUp()]--&gt; Starting --+ | +-----[resume()]-----+
541 | | | | V |
542 | Aborted -----+ +--&gt; Running --[pause()]--&gt; Paused
543 | | ^ | ^ |
544 | Saved -----------[powerUp()]--&gt; Restoring -+ | | | |
545 | ^ | | | |
546 | | +-----------------------------------------+-|-------------------+ +
547 | | | | |
548 | | +-- Saving &lt;--------[takeSnapshot()]&lt;-------+---------------------+
549 | | | |
550 | +-------- Saving &lt;--------[saveState()]&lt;----------+---------------------+
551 | | |
552 +-------------- Stopping -------[powerDown()]&lt;----------+---------------------+
553 </pre>
554
555 Note that states to the right from PoweredOff, Aborted and Saved in the
556 above diagram are called <i>online VM states</i>. These states
557 represent the virtual machine which is being executed in a dedicated
558 process (usually with a GUI window attached to it where you can see the
559 activity of the virtual machine and interact with it). There are two
560 special pseudo-states, FirstOnline and LastOnline, that can be used in
561 relational expressions to detect if the given machine state is online or
562 not:
563
564 <pre>
565 if (machine.GetState() &gt;= MachineState_FirstOnline &amp;&amp;
566 machine.GetState() &lt;= MachineState_LastOnline)
567 {
568 ...the machine is being executed...
569 }
570 </pre>
571
572 When the virtual machine is in one of the online VM states (that is, being
573 executed), only a few machine settings can be modified. Methods working
574 with such settings contain an explicit note about that. An attempt to
575 change any other setting or perform a modifying operation during this time
576 will result in the @c VBOX_E_INVALID_VM_STATE error.
577
578 All online states except Running, Paused and Stuck are transitional: they
579 represent temporary conditions of the virtual machine that will last as
580 long as the operation that initiated such a condition.
581
582 The Stuck state is a special case. It means that execution of the machine
583 has reached the "Guru Meditation" condition. This condition indicates an
584 internal VMM (virtual machine manager) failure which may happen as a
585 result of either an unhandled low-level virtual hardware exception or one
586 of the recompiler exceptions (such as the <i>too-many-traps</i>
587 condition).
588
589 Note also that any online VM state may transit to the Aborted state. This
590 happens if the process that is executing the virtual machine terminates
591 unexpectedly (for example, crashes). Other than that, the Aborted state is
592 equivalent to PoweredOff.
593
594 There are also a few additional state diagrams that do not deal with
595 virtual machine execution and therefore are shown separately. The states
596 shown on these diagrams are called <i>offline VM states</i> (this includes
597 PoweredOff, Aborted and Saved too).
598
599 The first diagram shows what happens when a lengthy setup operation is
600 being executed (such as <link to="IMachine::attachDevice"/>).
601
602 <pre>
603 +----------------------------------(same state as before the call)------+
604 | |
605 +-&gt; PoweredOff --+ |
606 | | |
607 |-&gt; Aborted -----+--&gt;[lengthy VM configuration call] --&gt; SettingUp -----+
608 | |
609 +-&gt; Saved -------+
610 </pre>
611
612 The next two diagrams demonstrate the process of taking a snapshot of a
613 powered off virtual machine, restoring the state to that as of a snapshot
614 or deleting a snapshot, respectively.
615
616 <pre>
617 +----------------------------------(same state as before the call)------+
618 | |
619 +-&gt; PoweredOff --+ |
620 | +--&gt;[takeSnapshot()] -------------------&gt; Saving ------+
621 +-&gt; Aborted -----+
622
623 +-&gt; PoweredOff --+
624 | |
625 | Aborted -----+--&gt;[restoreSnapshot() ]-------&gt; RestoringSnapshot -+
626 | | [deleteSnapshot() ]-------&gt; DeletingSnapshot --+
627 +-&gt; Saved -------+ |
628 | |
629 +---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
630 </pre>
631
632 Note that the Saving state is present in both the offline state group and
633 online state group. Currently, the only way to determine what group is
634 assumed in a particular case is to remember the previous machine state: if
635 it was Running or Paused, then Saving is an online state, otherwise it is
636 an offline state. This inconsistency may be removed in one of the future
637 versions of VirtualBox by adding a new state.
638
639 <note internal="yes">
640 For whoever decides to touch this enum: In order to keep the
641 comparisons involving FirstOnline and LastOnline pseudo-states valid,
642 the numeric values of these states must be correspondingly updated if
643 needed: for any online VM state, the condition
644 <tt>FirstOnline &lt;= state &lt;= LastOnline</tt> must be
645 @c true. The same relates to transient states for which
646 the condition <tt>FirstOnline &lt;= state &lt;= LastOnline</tt> must be
647 @c true.
648 </note>
649 </desc>
650
651 <const name="Null" value="0">
652 <desc>Null value (never used by the API).</desc>
653 </const>
654 <const name="PoweredOff" value="1">
655 <desc>
656 The machine is not running and has no saved execution state; it has
657 either never been started or been shut down successfully.
658 </desc>
659 </const>
660 <const name="Saved" value="2">
661 <desc>
662 The machine is not currently running, but the execution state of the machine
663 has been saved to an external file when it was running, from where
664 it can be resumed.
665 </desc>
666 </const>
667 <const name="Teleported" value="3">
668 <desc>
669 The machine was teleported to a different host (or process) and then
670 powered off. Take care when powering it on again may corrupt resources
671 it shares with the teleportation target (e.g. disk and network).
672 </desc>
673 </const>
674 <const name="Aborted" value="4">
675 <desc>
676 The process running the machine has terminated abnormally. This may
677 indicate a crash of the VM process in host execution context, or
678 the VM process has been terminated externally.
679 </desc>
680 </const>
681 <const name="Running" value="5">
682 <desc>
683 The machine is currently being executed.
684 <note internal="yes">
685 For whoever decides to touch this enum: In order to keep the
686 comparisons in the old source code valid, this state must immediately
687 precede the Paused state.
688 TODO: Lift this spectacularly wonderful restriction.
689 </note>
690 </desc>
691 </const>
692 <const name="Paused" value="6">
693 <desc>
694 Execution of the machine has been paused.
695 <note internal="yes">
696 For whoever decides to touch this enum: In order to keep the
697 comparisons in the old source code valid, this state must immediately
698 follow the Running state.
699 TODO: Lift this spectacularly wonderful restriction.
700 </note>
701 </desc>
702 </const>
703 <const name="Stuck" value="7">
704 <desc>
705 Execution of the machine has reached the "Guru Meditation"
706 condition. This indicates a severe error in the hypervisor itself.
707 <note internal="yes">
708 bird: Why this uncool name? Could we rename it to "GuruMeditation" or
709 "Guru", perhaps? Or are there some other VMM states that are
710 intended to be lumped in here as well?
711 </note>
712 </desc>
713 </const>
714 <const name="Teleporting" value="8">
715 <desc>
716 The machine is about to be teleported to a different host or process.
717 It is possible to pause a machine in this state, but it will go to the
718 @c TeleportingPausedVM state and it will not be
719 possible to resume it again unless the teleportation fails.
720 </desc>
721 </const>
722 <const name="LiveSnapshotting" value="9">
723 <desc>
724 A live snapshot is being taken. The machine is running normally, but
725 some of the runtime configuration options are inaccessible. Also, if
726 paused while in this state it will transition to
727 @c Saving and it will not be resume the
728 execution until the snapshot operation has completed.
729 </desc>
730 </const>
731 <const name="Starting" value="10">
732 <desc>
733 Machine is being started after powering it on from a
734 zero execution state.
735 </desc>
736 </const>
737 <const name="Stopping" value="11">
738 <desc>
739 Machine is being normally stopped powering it off, or after the guest OS
740 has initiated a shutdown sequence.
741 </desc>
742 </const>
743 <const name="Saving" value="12">
744 <desc>
745 Machine is saving its execution state to a file, or an online
746 snapshot of the machine is being taken.
747 </desc>
748 </const>
749 <const name="Restoring" value="13">
750 <desc>
751 Execution state of the machine is being restored from a file
752 after powering it on from the saved execution state.
753 </desc>
754 </const>
755 <const name="TeleportingPausedVM" value="14">
756 <desc>
757 The machine is being teleported to another host or process, but it is
758 not running. This is the paused variant of the
759 @c state.
760 </desc>
761 </const>
762 <const name="TeleportingIn" value="15">
763 <desc>
764 Teleporting the machine state in from another host or process.
765 </desc>
766 </const>
767 <const name="FaultTolerantSyncing" value="16">
768 <desc>
769 The machine is being synced with a fault tolerant VM running elsewhere.
770 </desc>
771 </const>
772 <const name="DeletingSnapshotOnline" value="17">
773 <desc>
774 Like @c DeletingSnapshot, but the merging of media is ongoing in
775 the background while the machine is running.
776 </desc>
777 </const>
778 <const name="DeletingSnapshotPaused" value="18">
779 <desc>
780 Like @c DeletingSnapshotOnline, but the machine was paused when the
781 merging of differencing media was started.
782 </desc>
783 </const>
784 <const name="RestoringSnapshot" value="19">
785 <desc>
786 A machine snapshot is being restored; this typically does not take long.
787 </desc>
788 </const>
789 <const name="DeletingSnapshot" value="20">
790 <desc>
791 A machine snapshot is being deleted; this can take a long time since this
792 may require merging differencing media. This value indicates that the
793 machine is not running while the snapshot is being deleted.
794 </desc>
795 </const>
796 <const name="SettingUp" value="21">
797 <desc>
798 Lengthy setup operation is in progress.
799 </desc>
800 </const>
801
802 <const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
803 <desc>
804 Pseudo-state: first online state (for use in relational expressions).
805 </desc>
806 </const>
807 <const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
808 <desc>
809 Pseudo-state: last online state (for use in relational expressions).
810 </desc>
811 </const>
812
813 <const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
814 <desc>
815 Pseudo-state: first transient state (for use in relational expressions).
816 </desc>
817 </const>
818 <const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
819 <desc>
820 Pseudo-state: last transient state (for use in relational expressions).
821 </desc>
822 </const>
823
824 </enum>
825
826 <enum
827 name="SessionState"
828 uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
829 >
830 <desc>
831 Session state. This enumeration represents possible values of
832 <link to="IMachine::sessionState"/> and <link to="ISession::state"/>
833 attributes.
834 </desc>
835
836 <const name="Null" value="0">
837 <desc>Null value (never used by the API).</desc>
838 </const>
839 <const name="Unlocked" value="1">
840 <desc>
841 In <link to="IMachine::sessionState"/>, this means that the machine
842 is not locked for any sessions.
843
844 In <link to="ISession::state"/>, this means that no machine is
845 currently locked for this session.
846 </desc>
847 </const>
848 <const name="Locked" value="2">
849 <desc>
850 In <link to="IMachine::sessionState"/>, this means that the machine
851 is currently locked for a session, whose process identifier can
852 then be found in the <link to="IMachine::sessionPID" /> attribute.
853
854 In <link to="ISession::state"/>, this means that a machine is
855 currently locked for this session, and the mutable machine object
856 can be found in the <link to="ISession::machine"/> attribute
857 (see <link to="IMachine::lockMachine" /> for details).
858 </desc>
859 </const>
860 <const name="Spawning" value="3">
861 <desc>
862 A new process is being spawned for the machine as a result of
863 <link to="IMachine::launchVMProcess"/> call. This state also occurs
864 as a short transient state during an <link to="IMachine::lockMachine"/>
865 call.
866 </desc>
867 </const>
868 <const name="Unlocking" value="4">
869 <desc>
870 The session is being unlocked.
871 </desc>
872 </const>
873 </enum>
874
875 <enum
876 name="CPUPropertyType"
877 uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
878 >
879 <desc>
880 Virtual CPU property type. This enumeration represents possible values of the
881 IMachine get- and setCPUProperty methods.
882 </desc>
883 <const name="Null" value="0">
884 <desc>Null value (never used by the API).</desc>
885 </const>
886 <const name="PAE" value="1">
887 <desc>
888 This setting determines whether VirtualBox will expose the Physical Address
889 Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
890 is not available, it will not be reported.
891 </desc>
892 </const>
893 <const name="Synthetic" value="2">
894 <desc>
895 This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
896 teleporting between host systems that differ significantly.
897 </desc>
898 </const>
899 </enum>
900
901
902 <enum
903 name="HWVirtExPropertyType"
904 uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
905 >
906 <desc>
907 Hardware virtualization property type. This enumeration represents possible values
908 for the <link to="IMachine::getHWVirtExProperty"/> and
909 <link to="IMachine::setHWVirtExProperty"/> methods.
910 </desc>
911 <const name="Null" value="0">
912 <desc>Null value (never used by the API).</desc>
913 </const>
914 <const name="Enabled" value="1">
915 <desc>
916 Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
917 such extensions are not available, they will not be used.
918 </desc>
919 </const>
920 <const name="Exclusive" value="2">
921 <desc>
922 Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
923 VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
924 feature of the host. To share these with other hypervisors, you must disable this property.
925 </desc>
926 </const>
927 <const name="VPID" value="3">
928 <desc>
929 Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
930 </desc>
931 </const>
932 <const name="NestedPaging" value="4">
933 <desc>
934 Whether Nested Paging is enabled. If this extension is not available, it will not be used.
935 </desc>
936 </const>
937 <const name="LargePages" value="5">
938 <desc>
939 Whether large page allocation is enabled; requires nested paging and a 64 bits host.
940 </desc>
941 </const>
942 <const name="Force" value="6">
943 <desc>
944 Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
945 not set, there will be an automatic fallback to software virtualization.
946 </desc>
947 </const>
948 </enum>
949
950 <enum
951 name="FaultToleranceState"
952 uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
953 >
954 <desc>
955 Used with <link to="IMachine::faultToleranceState" />.
956 </desc>
957 <const name="Inactive" value="1">
958 <desc>No fault tolerance enabled.</desc>
959 </const>
960 <const name="Master" value="2">
961 <desc>Fault tolerant master VM.</desc>
962 </const>
963 <const name="Standby" value="3">
964 <desc>Fault tolerant standby VM.</desc>
965 </const>
966 </enum>
967
968 <enum
969 name="LockType"
970 uuid="168a6a8e-12fd-4878-a1f9-38a750a56089"
971 >
972 <desc>
973 Used with <link to="IMachine::lockMachine" />.
974 </desc>
975 <const name="Write" value="2">
976 <desc>Lock the machine for writing.</desc>
977 </const>
978 <const name="Shared" value="1">
979 <desc>Request only a shared read lock for remote-controlling the machine.</desc>
980 </const>
981 <const name="VM" value="3">
982 <desc>Lock the machine for writing, and create objects necessary for
983 running a VM in this process.</desc>
984 </const>
985 </enum>
986
987 <enum
988 name="SessionType"
989 uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
990 >
991 <desc>
992 Session type. This enumeration represents possible values of the
993 <link to="ISession::type"/> attribute.
994 </desc>
995
996 <const name="Null" value="0">
997 <desc>Null value (never used by the API).</desc>
998 </const>
999 <const name="WriteLock" value="1">
1000 <desc>
1001 Session has acquired an exclusive write lock on a machine
1002 using <link to="IMachine::lockMachine"/>.
1003 </desc>
1004 </const>
1005 <const name="Remote" value="2">
1006 <desc>
1007 Session has launched a VM process using
1008 <link to="IMachine::launchVMProcess"/>
1009 </desc>
1010 </const>
1011 <const name="Shared" value="3">
1012 <desc>
1013 Session has obtained a link to another session using
1014 <link to="IMachine::lockMachine"/>
1015 </desc>
1016 </const>
1017 </enum>
1018
1019 <enum
1020 name="DeviceType"
1021 uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1022 >
1023 <desc>
1024 Device type.
1025 </desc>
1026 <const name="Null" value="0">
1027 <desc>
1028 Null value, may also mean "no device" (not allowed for
1029 <link to="IConsole::getDeviceActivity"/>).
1030 </desc>
1031 </const>
1032 <const name="Floppy" value="1">
1033 <desc>Floppy device.</desc>
1034 </const>
1035 <const name="DVD" value="2">
1036 <desc>CD/DVD-ROM device.</desc>
1037 </const>
1038 <const name="HardDisk" value="3">
1039 <desc>Hard disk device.</desc>
1040 </const>
1041 <const name="Network" value="4">
1042 <desc>Network device.</desc>
1043 </const>
1044 <const name="USB" value="5">
1045 <desc>USB device.</desc>
1046 </const>
1047 <const name="SharedFolder" value="6">
1048 <desc>Shared folder device.</desc>
1049 </const>
1050 </enum>
1051
1052 <enum
1053 name="DeviceActivity"
1054 uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1055 >
1056 <desc>
1057 Device activity for <link to="IConsole::getDeviceActivity"/>.
1058 </desc>
1059
1060 <const name="Null" value="0"/>
1061 <const name="Idle" value="1"/>
1062 <const name="Reading" value="2"/>
1063 <const name="Writing" value="3"/>
1064 </enum>
1065
1066 <enum
1067 name="ClipboardMode"
1068 uuid="33364716-4008-4701-8f14-be0fa3d62950"
1069 >
1070 <desc>
1071 Host-Guest clipboard interchange mode.
1072 </desc>
1073
1074 <const name="Disabled" value="0"/>
1075 <const name="HostToGuest" value="1"/>
1076 <const name="GuestToHost" value="2"/>
1077 <const name="Bidirectional" value="3"/>
1078 </enum>
1079
1080 <enum
1081 name="DragAndDropMode"
1082 uuid="b618ea0e-b6fb-4f8d-97f7-5e237e49b547"
1083 >
1084 <desc>
1085 Drag'n'Drop interchange mode.
1086 </desc>
1087
1088 <const name="Disabled" value="0"/>
1089 <const name="HostToGuest" value="1"/>
1090 <const name="GuestToHost" value="2"/>
1091 <const name="Bidirectional" value="3"/>
1092 </enum>
1093
1094 <enum
1095 name="Scope"
1096 uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1097 >
1098 <desc>
1099 Scope of the operation.
1100
1101 A generic enumeration used in various methods to define the action or
1102 argument scope.
1103 </desc>
1104
1105 <const name="Global" value="0"/>
1106 <const name="Machine" value="1"/>
1107 <const name="Session" value="2"/>
1108 </enum>
1109
1110 <enum
1111 name="BIOSBootMenuMode"
1112 uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1113 >
1114 <desc>
1115 BIOS boot menu mode.
1116 </desc>
1117
1118 <const name="Disabled" value="0"/>
1119 <const name="MenuOnly" value="1"/>
1120 <const name="MessageAndMenu" value="2"/>
1121 </enum>
1122
1123 <enum
1124 name="ProcessorFeature"
1125 uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1126 >
1127 <desc>
1128 CPU features.
1129 </desc>
1130
1131 <const name="HWVirtEx" value="0"/>
1132 <const name="PAE" value="1"/>
1133 <const name="LongMode" value="2"/>
1134 <const name="NestedPaging" value="3"/>
1135 </enum>
1136
1137 <enum
1138 name="FirmwareType"
1139 uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1140 >
1141 <desc>
1142 Firmware type.
1143 </desc>
1144 <const name="BIOS" value="1">
1145 <desc>BIOS Firmware.</desc>
1146 </const>
1147 <const name="EFI" value="2">
1148 <desc>EFI Firmware, bitness detected basing on OS type.</desc>
1149 </const>
1150 <const name="EFI32" value="3">
1151 <desc>Efi firmware, 32-bit.</desc>
1152 </const>
1153 <const name="EFI64" value="4">
1154 <desc>Efi firmware, 64-bit.</desc>
1155 </const>
1156 <const name="EFIDUAL" value="5">
1157 <desc>Efi firmware, combined 32 and 64-bit.</desc>
1158 </const>
1159 </enum>
1160
1161 <enum
1162 name="PointingHIDType"
1163 uuid="e44b2f7b-72ba-44fb-9e53-2186014f0d17"
1164 >
1165 <desc>
1166 Type of pointing device used in a virtual machine.
1167 </desc>
1168 <const name="None" value="1">
1169 <desc>No mouse.</desc>
1170 </const>
1171 <const name="PS2Mouse" value="2">
1172 <desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1173 </const>
1174 <const name="USBMouse" value="3">
1175 <desc>USB mouse (relative pointer).</desc>
1176 </const>
1177 <const name="USBTablet" value="4">
1178 <desc>USB tablet (absolute pointer).</desc>
1179 </const>
1180 <const name="ComboMouse" value="5">
1181 <desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1182 Using of such device can have negative performance implications. </desc>
1183 </const>
1184 </enum>
1185
1186 <enum
1187 name="KeyboardHIDType"
1188 uuid="383e43d7-5c7c-4ec8-9cb8-eda1bccd6699"
1189 >
1190 <desc>
1191 Type of keyboard device used in a virtual machine.
1192 </desc>
1193 <const name="None" value="1">
1194 <desc>No keyboard.</desc>
1195 </const>
1196 <const name="PS2Keyboard" value="2">
1197 <desc>PS/2 keyboard.</desc>
1198 </const>
1199 <const name="USBKeyboard" value="3">
1200 <desc>USB keyboard.</desc>
1201 </const>
1202 <const name="ComboKeyboard" value="4">
1203 <desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1204 Using of such device can have negative performance implications. </desc>
1205 </const>
1206 </enum>
1207
1208 <!--
1209 // IVirtualBoxErrorInfo
1210 /////////////////////////////////////////////////////////////////////////
1211 -->
1212
1213 <interface
1214 name="IVirtualBoxErrorInfo" extends="$errorinfo"
1215 uuid="f91e6e91-49e1-4fd2-b21e-269003350d06"
1216 supportsErrorInfo="no"
1217 wsmap="managed"
1218 >
1219 <desc>
1220 The IVirtualBoxErrorInfo interface represents extended error information.
1221
1222 Extended error information can be set by VirtualBox components after
1223 unsuccessful or partially successful method invocation. This information
1224 can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1225 and then shown to the client in addition to the plain 32-bit result code.
1226
1227 In MS COM, this interface extends the IErrorInfo interface,
1228 in XPCOM, it extends the nsIException interface. In both cases,
1229 it provides a set of common attributes to retrieve error
1230 information.
1231
1232 Sometimes invocation of some component's method may involve methods of
1233 other components that may also fail (independently of this method's
1234 failure), or a series of non-fatal errors may precede a fatal error that
1235 causes method failure. In cases like that, it may be desirable to preserve
1236 information about all errors happened during method invocation and deliver
1237 it to the caller. The <link to="#next"/> attribute is intended
1238 specifically for this purpose and allows to represent a chain of errors
1239 through a single IVirtualBoxErrorInfo object set after method invocation.
1240
1241 <note>errors are stored to a chain in the reverse order, i.e. the
1242 initial error object you query right after method invocation is the last
1243 error set by the callee, the object it points to in the @a next attribute
1244 is the previous error and so on, up to the first error (which is the last
1245 in the chain).</note>
1246 </desc>
1247
1248 <attribute name="resultCode" type="long" readonly="yes">
1249 <desc>
1250 Result code of the error.
1251 Usually, it will be the same as the result code returned
1252 by the method that provided this error information, but not
1253 always. For example, on Win32, CoCreateInstance() will most
1254 likely return E_NOINTERFACE upon unsuccessful component
1255 instantiation attempt, but not the value the component factory
1256 returned. Value is typed 'long', not 'result',
1257 to make interface usable from scripting languages.
1258 <note>
1259 In MS COM, there is no equivalent.
1260 In XPCOM, it is the same as nsIException::result.
1261 </note>
1262 </desc>
1263 </attribute>
1264
1265 <attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1266 <desc>
1267 UUID of the interface that defined the error.
1268 <note>
1269 In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1270 data type.
1271 In XPCOM, there is no equivalent.
1272 </note>
1273 </desc>
1274 </attribute>
1275
1276 <attribute name="component" type="wstring" readonly="yes">
1277 <desc>
1278 Name of the component that generated the error.
1279 <note>
1280 In MS COM, it is the same as IErrorInfo::GetSource.
1281 In XPCOM, there is no equivalent.
1282 </note>
1283 </desc>
1284 </attribute>
1285
1286 <attribute name="text" type="wstring" readonly="yes">
1287 <desc>
1288 Text description of the error.
1289 <note>
1290 In MS COM, it is the same as IErrorInfo::GetDescription.
1291 In XPCOM, it is the same as nsIException::message.
1292 </note>
1293 </desc>
1294 </attribute>
1295
1296 <attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1297 <desc>
1298 Next error object if there is any, or @c null otherwise.
1299 <note>
1300 In MS COM, there is no equivalent.
1301 In XPCOM, it is the same as nsIException::inner.
1302 </note>
1303 </desc>
1304 </attribute>
1305
1306 </interface>
1307
1308 <!--
1309 // IVirtualBox
1310 /////////////////////////////////////////////////////////////////////////
1311 -->
1312
1313 <interface
1314 name="IDHCPServer" extends="$unknown"
1315 uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1316 wsmap="managed"
1317 >
1318 <desc>
1319 The IDHCPServer interface represents the vbox DHCP server configuration.
1320
1321 To enumerate all the DHCP servers on the host, use the
1322 <link to="IVirtualBox::DHCPServers"/> attribute.
1323 </desc>
1324
1325 <attribute name="enabled" type="boolean">
1326 <desc>
1327 specifies if the DHCP server is enabled
1328 </desc>
1329 </attribute>
1330
1331 <attribute name="IPAddress" type="wstring" readonly="yes">
1332 <desc>
1333 specifies server IP
1334 </desc>
1335 </attribute>
1336
1337 <attribute name="networkMask" type="wstring" readonly="yes">
1338 <desc>
1339 specifies server network mask
1340 </desc>
1341 </attribute>
1342
1343 <attribute name="networkName" type="wstring" readonly="yes">
1344 <desc>
1345 specifies internal network name the server is used for
1346 </desc>
1347 </attribute>
1348
1349 <attribute name="lowerIP" type="wstring" readonly="yes">
1350 <desc>
1351 specifies from IP address in server address range
1352 </desc>
1353 </attribute>
1354
1355 <attribute name="upperIP" type="wstring" readonly="yes">
1356 <desc>
1357 specifies to IP address in server address range
1358 </desc>
1359 </attribute>
1360
1361 <method name="setConfiguration">
1362 <desc>
1363 configures the server
1364 <result name="E_INVALIDARG">
1365 invalid configuration supplied
1366 </result>
1367 </desc>
1368 <param name="IPAddress" type="wstring" dir="in">
1369 <desc>
1370 server IP address
1371 </desc>
1372 </param>
1373 <param name="networkMask" type="wstring" dir="in">
1374 <desc>
1375 server network mask
1376 </desc>
1377 </param>
1378 <param name="FromIPAddress" type="wstring" dir="in">
1379 <desc>
1380 server From IP address for address range
1381 </desc>
1382 </param>
1383 <param name="ToIPAddress" type="wstring" dir="in">
1384 <desc>
1385 server To IP address for address range
1386 </desc>
1387 </param>
1388 </method>
1389
1390 <method name="start">
1391 <desc>
1392 Starts DHCP server process.
1393 <result name="E_FAIL">
1394 Failed to start the process.
1395 </result>
1396 </desc>
1397 <param name="networkName" type="wstring" dir="in">
1398 <desc>
1399 Name of internal network DHCP server should attach to.
1400 </desc>
1401 </param>
1402 <param name="trunkName" type="wstring" dir="in">
1403 <desc>
1404 Name of internal network trunk.
1405 </desc>
1406 </param>
1407 <param name="trunkType" type="wstring" dir="in">
1408 <desc>
1409 Type of internal network trunk.
1410 </desc>
1411 </param>
1412 </method>
1413
1414 <method name="stop">
1415 <desc>
1416 Stops DHCP server process.
1417 <result name="E_FAIL">
1418 Failed to stop the process.
1419 </result>
1420 </desc>
1421 </method>
1422 </interface>
1423
1424 <interface
1425 name="IVirtualBox" extends="$unknown"
1426 uuid="5c8814a1-2a35-402d-8680-68e5cb4e72aa"
1427 wsmap="managed"
1428 >
1429 <desc>
1430 The IVirtualBox interface represents the main interface exposed by the
1431 product that provides virtual machine management.
1432
1433 An instance of IVirtualBox is required for the product to do anything
1434 useful. Even though the interface does not expose this, internally,
1435 IVirtualBox is implemented as a singleton and actually lives in the
1436 process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1437 IVirtualBox can track the state of all virtual machines on a particular
1438 host, regardless of which frontend started them.
1439
1440 To enumerate all the virtual machines on the host, use the
1441 <link to="IVirtualBox::machines"/> attribute.
1442 </desc>
1443
1444 <attribute name="version" type="wstring" readonly="yes">
1445 <desc>
1446 A string representing the version number of the product. The
1447 format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1448 last number represents the build number and will frequently change.
1449
1450 This may be followed by a _ALPHA[0-9]*, _BETA[0-9]* or _RC[0-9]* tag
1451 in prerelease builds. Non-Oracle builds may (/shall) also have a
1452 publisher tag, at the end. The publisher tag starts with an underscore
1453 just like the prerelease build type tag.
1454 </desc>
1455 </attribute>
1456
1457 <attribute name="versionNormalized" type="wstring" readonly="yes">
1458 <desc>
1459 A string representing the version number of the product,
1460 without the publisher information (but still with other tags).
1461 See <link to="#version" />.
1462 </desc>
1463 </attribute>
1464
1465 <attribute name="revision" type="unsigned long" readonly="yes">
1466 <desc>
1467 The internal build revision number of the product.
1468 </desc>
1469 </attribute>
1470
1471 <attribute name="packageType" type="wstring" readonly="yes">
1472 <desc>
1473 A string representing the package type of this product. The
1474 format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1475 SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1476 is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1477 this.
1478 </desc>
1479 </attribute>
1480
1481 <attribute name="APIVersion" type="wstring" readonly="yes">
1482 <desc>
1483 A string representing the VirtualBox API version number. The format is
1484 2 integer numbers divided by an underscore (e.g. 1_0). After the
1485 first public release of packages with a particular API version the
1486 API will not be changed in an incompatible way. Note that this
1487 guarantee does not apply to development builds, and also there is no
1488 guarantee that this version is identical to the first two integer
1489 numbers of the package version.
1490 </desc>
1491 </attribute>
1492
1493 <attribute name="homeFolder" type="wstring" readonly="yes">
1494 <desc>
1495 Full path to the directory where the global settings file,
1496 <tt>VirtualBox.xml</tt>, is stored.
1497
1498 In this version of VirtualBox, the value of this property is
1499 always <tt>&lt;user_dir&gt;/.VirtualBox</tt> (where
1500 <tt>&lt;user_dir&gt;</tt> is the path to the user directory,
1501 as determined by the host OS), and cannot be changed.
1502
1503 This path is also used as the base to resolve relative paths in
1504 places where relative paths are allowed (unless otherwise
1505 expressly indicated).
1506 </desc>
1507 </attribute>
1508
1509 <attribute name="settingsFilePath" type="wstring" readonly="yes">
1510 <desc>
1511 Full name of the global settings file.
1512 The value of this property corresponds to the value of
1513 <link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1514 </desc>
1515 </attribute>
1516
1517 <attribute name="host" type="IHost" readonly="yes">
1518 <desc>Associated host object.</desc>
1519 </attribute>
1520
1521 <attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1522 <desc>Associated system information object.</desc>
1523 </attribute>
1524
1525 <attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1526 <desc>
1527 Array of machine objects registered within this VirtualBox instance.
1528 </desc>
1529 </attribute>
1530
1531 <attribute name="machineGroups" type="wstring" readonly="yes" safearray="yes">
1532 <desc>
1533 Array of all machine group names which are used by the machines which
1534 are accessible. Each group is only listed once, however they are listed
1535 in no particular order and there is no guarantee that there are no gaps
1536 in the group hierarchy (i.e. <tt>"/"</tt>, <tt>"/group/subgroup"</tt>
1537 is a valid result).
1538 </desc>
1539 </attribute>
1540
1541 <attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1542 <desc>
1543 Array of medium objects known to this VirtualBox installation.
1544
1545 This array contains only base media. All differencing
1546 media of the given base medium can be enumerated using
1547 <link to="IMedium::children"/>.
1548 </desc>
1549 </attribute>
1550
1551 <attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1552 <desc>
1553 Array of CD/DVD image objects currently in use by this VirtualBox instance.
1554 </desc>
1555 </attribute>
1556
1557 <attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1558 <desc>
1559 Array of floppy image objects currently in use by this VirtualBox instance.
1560 </desc>
1561 </attribute>
1562
1563 <attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1564
1565 <attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1566
1567 <attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1568 <desc>
1569 Collection of global shared folders. Global shared folders are
1570 available to all virtual machines.
1571
1572 New shared folders are added to the collection using
1573 <link to="#createSharedFolder"/>. Existing shared folders can be
1574 removed using <link to="#removeSharedFolder"/>.
1575
1576 <note>
1577 In the current version of the product, global shared folders are not
1578 implemented and therefore this collection is always empty.
1579 </note>
1580 </desc>
1581 </attribute>
1582
1583 <attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1584 <desc>
1585 Associated performance collector object.
1586 </desc>
1587 </attribute>
1588
1589 <attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1590 <desc>
1591 DHCP servers.
1592 </desc>
1593 </attribute>
1594
1595 <attribute name="eventSource" type="IEventSource" readonly="yes">
1596 <desc>
1597 Event source for VirtualBox events.
1598 </desc>
1599 </attribute>
1600
1601 <attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1602 <desc>
1603 The extension pack manager.
1604 </desc>
1605 </attribute>
1606
1607
1608 <attribute name="internalNetworks" type="wstring" safearray="yes" readonly="yes">
1609 <desc>
1610 Names of all internal networks.
1611 </desc>
1612 </attribute>
1613
1614 <attribute name="genericNetworkDrivers" type="wstring" safearray="yes" readonly="yes">
1615 <desc>
1616 Names of all generic network drivers.
1617 </desc>
1618 </attribute>
1619
1620 <method name="composeMachineFilename">
1621 <desc>
1622 Returns a recommended full path of the settings file name for a new virtual
1623 machine.
1624
1625 This API serves two purposes:
1626
1627 <ul>
1628 <li>It gets called by <link to="#createMachine" /> if @c null or
1629 empty string (which is recommended) is specified for the
1630 @a settingsFile argument there, which means that API should use
1631 a recommended default file name.</li>
1632
1633 <li>It can be called manually by a client software before creating a machine,
1634 e.g. if that client wants to pre-create the machine directory to create
1635 virtual hard disks in that directory together with the new machine
1636 settings file. In that case, the file name should be stripped from the
1637 full settings file path returned by this function to obtain the
1638 machine directory.</li>
1639 </ul>
1640
1641 See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1642 details about the machine name.
1643
1644 @a groupName defines which additional subdirectory levels should be
1645 included. It must be either a valid group name or @c null or empty
1646 string which designates that the machine will not be related to a
1647 machine group.
1648
1649 If @a baseFolder is a @c null or empty string (which is recommended), the
1650 default machine settings folder
1651 (see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1652 a base folder for the created machine, resulting in a file name like
1653 "/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1654 will be used.
1655
1656 This method does not access the host disks. In particular, it does not check
1657 for whether a machine with this name already exists.
1658 </desc>
1659 <param name="name" type="wstring" dir="in">
1660 <desc>Suggested machine name.</desc>
1661 </param>
1662 <param name="group" type="wstring" dir="in">
1663 <desc>Machine group name for the new machine or machine group. It is
1664 used to determine the right subdirectory.</desc>
1665 </param>
1666 <param name="baseFolder" type="wstring" dir="in">
1667 <desc>Base machine folder (optional).</desc>
1668 </param>
1669 <param name="file" type="wstring" dir="return">
1670 <desc>Fully qualified path where the machine would be created.</desc>
1671 </param>
1672 </method>
1673
1674 <method name="createMachine">
1675 <desc>
1676 Creates a new virtual machine by creating a machine settings file at
1677 the given location.
1678
1679 VirtualBox machine settings files use a custom XML dialect. Starting
1680 with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1681 and machine files can be created at arbitrary locations.
1682
1683 However, it is recommended that machines are created in the default
1684 machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1685 <link to="ISystemProperties::defaultMachineFolder" />). If you specify
1686 @c null or empty string (which is recommended) for the @a settingsFile
1687 argument, <link to="#composeMachineFilename" /> is called automatically
1688 to have such a recommended name composed based on the machine name
1689 given in the @a name argument and the primary group.
1690
1691 If the resulting settings file already exists, this method will fail,
1692 unless @a forceOverwrite is set.
1693
1694 The new machine is created unregistered, with the initial configuration
1695 set according to the specified guest OS type. A typical sequence of
1696 actions to create a new virtual machine is as follows:
1697
1698 <ol>
1699 <li>
1700 Call this method to have a new machine created. The returned machine
1701 object will be "mutable" allowing to change any machine property.
1702 </li>
1703
1704 <li>
1705 Configure the machine using the appropriate attributes and methods.
1706 </li>
1707
1708 <li>
1709 Call <link to="IMachine::saveSettings" /> to write the settings
1710 to the machine's XML settings file. The configuration of the newly
1711 created machine will not be saved to disk until this method is
1712 called.
1713 </li>
1714
1715 <li>
1716 Call <link to="#registerMachine" /> to add the machine to the list
1717 of machines known to VirtualBox.
1718 </li>
1719 </ol>
1720
1721 The specified guest OS type identifier must match an ID of one of known
1722 guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1723 array.
1724
1725 Optionally, you may specify an UUID of to assign to the created machine.
1726 However, this is not recommended and you should normally pass an empty
1727 (@c null) UUID to this method so that a new UUID will be automatically
1728 generated for every created machine. You can use UUID
1729 00000000-0000-0000-0000-000000000000 as @c null value.
1730
1731 <note>
1732 There is no way to change the name of the settings file or
1733 subfolder of the created machine directly.
1734 </note>
1735
1736 <result name="VBOX_E_OBJECT_NOT_FOUND">
1737 @a osTypeId is invalid.
1738 </result>
1739 <result name="VBOX_E_FILE_ERROR">
1740 Resulting settings file name is invalid or the settings file already
1741 exists or could not be created due to an I/O error.
1742 </result>
1743 <result name="E_INVALIDARG">
1744 @a name is empty or @c null.
1745 </result>
1746 </desc>
1747
1748 <param name="settingsFile" type="wstring" dir="in">
1749 <desc>Fully qualified path where the settings file should be created,
1750 empty string or @c null for a default folder and file based on the
1751 @a name argument and the primary group.
1752 (see <link to="#composeMachineFilename" />).</desc>
1753 </param>
1754 <param name="name" type="wstring" dir="in">
1755 <desc>Machine name.</desc>
1756 </param>
1757 <param name="groups" type="wstring" safearray="yes" dir="in">
1758 <desc>Array of group names. @c null or an empty array have the same
1759 meaning as an array with just the empty string or <tt>"/"</tt>, i.e.
1760 create a machine without group association.</desc>
1761 </param>
1762 <param name="osTypeId" type="wstring" dir="in">
1763 <desc>Guest OS Type ID.</desc>
1764 </param>
1765 <param name="id" type="uuid" mod="string" dir="in">
1766 <desc>Machine UUID (optional).</desc>
1767 </param>
1768 <param name="forceOverwrite" type="boolean" dir="in">
1769 <desc>If true, an existing machine settings file will be overwritten.</desc>
1770 </param>
1771 <param name="machine" type="IMachine" dir="return">
1772 <desc>Created machine object.</desc>
1773 </param>
1774 </method>
1775
1776 <method name="openMachine">
1777 <desc>
1778 Opens a virtual machine from the existing settings file.
1779 The opened machine remains unregistered until you call
1780 <link to="#registerMachine"/>.
1781
1782 The specified settings file name must be fully qualified.
1783 The file must exist and be a valid machine XML settings file
1784 whose contents will be used to construct the machine object.
1785
1786 <result name="VBOX_E_FILE_ERROR">
1787 Settings file name invalid, not found or sharing violation.
1788 </result>
1789 </desc>
1790 <param name="settingsFile" type="wstring" dir="in">
1791 <desc>
1792 Name of the machine settings file.
1793 </desc>
1794 </param>
1795 <param name="machine" type="IMachine" dir="return">
1796 <desc>Opened machine object.</desc>
1797 </param>
1798 <note>
1799 <link to="IMachine::settingsModified"/> will return
1800 @c false for the created machine, until any of machine settings
1801 are changed.
1802 </note>
1803 </method>
1804
1805 <method name="registerMachine">
1806 <desc>
1807
1808 Registers the machine previously created using
1809 <link to="#createMachine"/> or opened using
1810 <link to="#openMachine"/> within this VirtualBox installation. After
1811 successful method invocation, the
1812 <link to="IMachineRegisteredEvent"/> event is fired.
1813
1814 <note>
1815 This method implicitly calls <link to="IMachine::saveSettings"/>
1816 to save all current machine settings before registering it.
1817 </note>
1818
1819 <result name="VBOX_E_OBJECT_NOT_FOUND">
1820 No matching virtual machine found.
1821 </result>
1822 <result name="VBOX_E_INVALID_OBJECT_STATE">
1823 Virtual machine was not created within this VirtualBox instance.
1824 </result>
1825
1826 </desc>
1827 <param name="machine" type="IMachine" dir="in"/>
1828 </method>
1829
1830 <method name="findMachine">
1831 <desc>
1832 Attempts to find a virtual machine given its name or UUID.
1833
1834 <note>Inaccessible machines cannot be found by name, only by UUID, because their name
1835 cannot safely be determined.</note>
1836
1837 <result name="VBOX_E_OBJECT_NOT_FOUND">
1838 Could not find registered machine matching @a nameOrId.
1839 </result>
1840
1841 </desc>
1842 <param name="nameOrId" type="wstring" dir="in">
1843 <desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1844 </param>
1845 <param name="machine" type="IMachine" dir="return">
1846 <desc>Machine object, if found.</desc>
1847 </param>
1848 </method>
1849
1850 <method name="getMachinesByGroups">
1851 <desc>
1852 Gets all machine references which are in one of the specified groups.
1853 </desc>
1854 <param name="groups" type="wstring" dir="in" safearray="yes">
1855 <desc>What groups to match. The usual group list rules apply, i.e.
1856 passing an empty list will match VMs in the toplevel group, likewise
1857 the empty string.</desc>
1858 </param>
1859 <param name="machines" type="IMachine" dir="return" safearray="yes">
1860 <desc>All machines which matched.</desc>
1861 </param>
1862 </method>
1863
1864 <method name="getMachineStates">
1865 <desc>
1866 Gets the state of several machines in a single operation.
1867 </desc>
1868 <param name="machines" type="IMachine" dir="in" safearray="yes">
1869 <desc>Array with the machine references.</desc>
1870 </param>
1871 <param name="states" type="MachineState" dir="return" safearray="yes">
1872 <desc>Machine states, corresponding to the machines.</desc>
1873 </param>
1874 </method>
1875
1876 <method name="createAppliance">
1877 <desc>
1878 Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1879 Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1880 machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1881 </desc>
1882 <param name="appliance" type="IAppliance" dir="return">
1883 <desc>New appliance.</desc>
1884 </param>
1885 </method>
1886
1887 <method name="createHardDisk">
1888 <desc>
1889 Creates a new base medium object that will use the given storage
1890 format and location for medium data.
1891
1892 The actual storage unit is not created by this method. In order to
1893 do it, and before you are able to attach the created medium to
1894 virtual machines, you must call one of the following methods to
1895 allocate a format-specific storage unit at the specified location:
1896 <ul>
1897 <li><link to="IMedium::createBaseStorage"/></li>
1898 <li><link to="IMedium::createDiffStorage"/></li>
1899 </ul>
1900
1901 Some medium attributes, such as <link to="IMedium::id"/>, may
1902 remain uninitialized until the medium storage unit is successfully
1903 created by one of the above methods.
1904
1905 After the storage unit is successfully created, it will be
1906 accessible through the <link to="#openMedium"/> method and can
1907 be found in the <link to="#hardDisks"/> array.
1908
1909 The list of all storage formats supported by this VirtualBox
1910 installation can be obtained using
1911 <link to="ISystemProperties::mediumFormats"/>. If the @a format
1912 attribute is empty or @c null then the default storage format
1913 specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1914 be used for creating a storage unit of the medium.
1915
1916 Note that the format of the location string is storage format specific.
1917 See <link to="IMedium::location"/> and IMedium for more details.
1918
1919 <result name="VBOX_E_OBJECT_NOT_FOUND">
1920 @a format identifier is invalid. See
1921 <link to="ISystemProperties::mediumFormats"/>.
1922 </result>
1923 <result name="VBOX_E_FILE_ERROR">
1924 @a location is a not valid file name (for file-based formats only).
1925 </result>
1926 </desc>
1927 <param name="format" type="wstring" dir="in">
1928 <desc>
1929 Identifier of the storage format to use for the new medium.
1930 </desc>
1931 </param>
1932 <param name="location" type="wstring" dir="in">
1933 <desc>
1934 Location of the storage unit for the new medium.
1935 </desc>
1936 </param>
1937 <param name="medium" type="IMedium" dir="return">
1938 <desc>Created medium object.</desc>
1939 </param>
1940 </method>
1941
1942 <method name="openMedium">
1943 <desc>
1944 Finds existing media or opens a medium from an existing storage location.
1945
1946 Once a medium has been opened, it can be passed to other VirtualBox
1947 methods, in particular to <link to="IMachine::attachDevice" />.
1948
1949 Depending on the given device type, the file at the storage location
1950 must be in one of the media formats understood by VirtualBox:
1951
1952 <ul>
1953 <li>With a "HardDisk" device type, the file must be a hard disk image
1954 in one of the formats supported by VirtualBox (see
1955 <link to="ISystemProperties::mediumFormats" />).
1956 After this method succeeds, if the medium is a base medium, it
1957 will be added to the <link to="#hardDisks"/> array attribute. </li>
1958 <li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1959 After this method succeeds, the medium will be added to the
1960 <link to="#DVDImages"/> array attribute.</li>
1961 <li>With a "Floppy" device type, the file must be an RAW floppy image.
1962 After this method succeeds, the medium will be added to the
1963 <link to="#floppyImages"/> array attribute.</li>
1964 </ul>
1965
1966 After having been opened, the medium can be re-found by this method
1967 and can be attached to virtual machines. See <link to="IMedium" /> for
1968 more details.
1969
1970 The UUID of the newly opened medium will either be retrieved from the
1971 storage location, if the format supports it (e.g. for hard disk images),
1972 or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1973 If for some reason you need to change the medium's UUID, use
1974 <link to="IMedium::setIds" />.
1975
1976 If a differencing hard disk medium is to be opened by this method, the
1977 operation will succeed only if its parent medium and all ancestors,
1978 if any, are already known to this VirtualBox installation (for example,
1979 were opened by this method before).
1980
1981 This method attempts to guess the storage format of the specified medium
1982 by reading medium data at the specified location.
1983
1984 If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1985 the image is opened for read/write access and must have according permissions,
1986 as VirtualBox may actually write status information into the disk's metadata
1987 sections.
1988
1989 Note that write access is required for all typical hard disk usage in VirtualBox,
1990 since VirtualBox may need to write metadata such as a UUID into the image.
1991 The only exception is opening a source image temporarily for copying and
1992 cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1993 again soon.
1994
1995 The format of the location string is storage format specific. See
1996 <link to="IMedium::location"/> and IMedium for more details.
1997
1998 <result name="VBOX_E_FILE_ERROR">
1999 Invalid medium storage file location or could not find the medium
2000 at the specified location.
2001 </result>
2002 <result name="VBOX_E_IPRT_ERROR">
2003 Could not get medium storage format.
2004 </result>
2005 <result name="E_INVALIDARG">
2006 Invalid medium storage format.
2007 </result>
2008 <result name="VBOX_E_INVALID_OBJECT_STATE">
2009 Medium has already been added to a media registry.
2010 </result>
2011 </desc>
2012 <param name="location" type="wstring" dir="in">
2013 <desc>
2014 Location of the storage unit that contains medium data in one of
2015 the supported storage formats.
2016 </desc>
2017 </param>
2018 <param name="deviceType" type="DeviceType" dir="in">
2019 <desc>
2020 Must be one of "HardDisk", "DVD" or "Floppy".
2021 </desc>
2022 </param>
2023 <param name="accessMode" type="AccessMode" dir="in">
2024 <desc>Whether to open the image in read/write or read-only mode. For
2025 a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
2026 </param>
2027 <param name="forceNewUuid" type="boolean" dir="in">
2028 <desc>Allows the caller to request a completely new medium UUID for
2029 the image which is to be opened. Useful if one intends to open an exact
2030 copy of a previously opened image, as this would normally fail due to
2031 the duplicate UUID.</desc>
2032 </param>
2033 <param name="medium" type="IMedium" dir="return">
2034 <desc>Opened medium object.</desc>
2035 </param>
2036 </method>
2037
2038 <method name="getGuestOSType">
2039 <desc>
2040 Returns an object describing the specified guest OS type.
2041
2042 The requested guest OS type is specified using a string which is a
2043 mnemonic identifier of the guest operating system, such as
2044 <tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2045 particular virtual machine can be read or set using the
2046 <link to="IMachine::OSTypeId"/> attribute.
2047
2048 The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2049 available guest OS type objects. Each object has an
2050 <link to="IGuestOSType::id"/> attribute which contains an identifier of
2051 the guest OS this object describes.
2052
2053 <result name="E_INVALIDARG">
2054 @a id is not a valid Guest OS type.
2055 </result>
2056
2057 </desc>
2058 <param name="id" type="uuid" mod="string" dir="in">
2059 <desc>Guest OS type ID string.</desc>
2060 </param>
2061 <param name="type" type="IGuestOSType" dir="return">
2062 <desc>Guest OS type object.</desc>
2063 </param>
2064 </method>
2065
2066 <method name="createSharedFolder">
2067 <desc>
2068 Creates a new global shared folder by associating the given logical
2069 name with the given host path, adds it to the collection of shared
2070 folders and starts sharing it. Refer to the description of
2071 <link to="ISharedFolder"/> to read more about logical names.
2072 <note>
2073 In the current implementation, this operation is not
2074 implemented.
2075 </note>
2076 </desc>
2077 <param name="name" type="wstring" dir="in">
2078 <desc>Unique logical name of the shared folder.</desc>
2079 </param>
2080 <param name="hostPath" type="wstring" dir="in">
2081 <desc>Full path to the shared folder in the host file system.</desc>
2082 </param>
2083 <param name="writable" type="boolean" dir="in">
2084 <desc>Whether the share is writable or readonly</desc>
2085 </param>
2086 <param name="automount" type="boolean" dir="in">
2087 <desc>Whether the share gets automatically mounted by the guest
2088 or not.</desc>
2089 </param>
2090 </method>
2091
2092 <method name="removeSharedFolder">
2093 <desc>
2094 Removes the global shared folder with the given name previously
2095 created by <link to="#createSharedFolder"/> from the collection of
2096 shared folders and stops sharing it.
2097 <note>
2098 In the current implementation, this operation is not
2099 implemented.
2100 </note>
2101 </desc>
2102 <param name="name" type="wstring" dir="in">
2103 <desc>Logical name of the shared folder to remove.</desc>
2104 </param>
2105 </method>
2106
2107 <method name="getExtraDataKeys">
2108 <desc>
2109 Returns an array representing the global extra data keys which currently
2110 have values defined.
2111 </desc>
2112 <param name="value" type="wstring" dir="return" safearray="yes">
2113 <desc>Array of extra data keys.</desc>
2114 </param>
2115 </method>
2116
2117 <method name="getExtraData">
2118 <desc>
2119 Returns associated global extra data.
2120
2121 If the requested data @a key does not exist, this function will
2122 succeed and return an empty string in the @a value argument.
2123
2124 <result name="VBOX_E_FILE_ERROR">
2125 Settings file not accessible.
2126 </result>
2127 <result name="VBOX_E_XML_ERROR">
2128 Could not parse the settings file.
2129 </result>
2130
2131 </desc>
2132 <param name="key" type="wstring" dir="in">
2133 <desc>Name of the data key to get.</desc>
2134 </param>
2135 <param name="value" type="wstring" dir="return">
2136 <desc>Value of the requested data key.</desc>
2137 </param>
2138 </method>
2139
2140 <method name="setExtraData">
2141 <desc>
2142 Sets associated global extra data.
2143
2144 If you pass @c null or empty string as a key @a value, the given @a key
2145 will be deleted.
2146
2147 <note>
2148 Before performing the actual data change, this method will ask all
2149 registered event listener using the
2150 <link to="IExtraDataCanChangeEvent"/>
2151 notification for a permission. If one of the listeners refuses the
2152 new value, the change will not be performed.
2153 </note>
2154 <note>
2155 On success, the
2156 <link to="IExtraDataChangedEvent"/> notification
2157 is called to inform all registered listeners about a successful data
2158 change.
2159 </note>
2160
2161 <result name="VBOX_E_FILE_ERROR">
2162 Settings file not accessible.
2163 </result>
2164 <result name="VBOX_E_XML_ERROR">
2165 Could not parse the settings file.
2166 </result>
2167 <result name="E_ACCESSDENIED">
2168 Modification request refused.
2169 </result>
2170
2171 </desc>
2172 <param name="key" type="wstring" dir="in">
2173 <desc>Name of the data key to set.</desc>
2174 </param>
2175 <param name="value" type="wstring" dir="in">
2176 <desc>Value to assign to the key.</desc>
2177 </param>
2178 </method>
2179
2180 <method name="setSettingsSecret">
2181 <desc>
2182 Unlocks the secret data by passing the unlock password to the
2183 server. The server will cache the password for that machine.
2184
2185 <result name="VBOX_E_INVALID_VM_STATE">
2186 Virtual machine is not mutable.
2187 </result>
2188
2189 </desc>
2190 <param name="password" type="wstring" dir="in">
2191 <desc>
2192 The cipher key.
2193 </desc>
2194 </param>
2195 </method>
2196
2197 <!--method name="createDHCPServerForInterface">
2198 <desc>
2199 Creates a DHCP server settings to be used for the given interface
2200 <result name="E_INVALIDARG">
2201 Host network interface @a name already exists.
2202 </result>
2203 </desc>
2204 <param name="interface" type="IHostNetworkInterface" dir="in">
2205 <desc>Network Interface</desc>
2206 </param>
2207 <param name="server" type="IDHCPServer" dir="out">
2208 <desc>DHCP server settings</desc>
2209 </param>
2210 </method-->
2211
2212 <method name="createDHCPServer">
2213 <desc>
2214 Creates a DHCP server settings to be used for the given internal network name
2215 <result name="E_INVALIDARG">
2216 Host network interface @a name already exists.
2217 </result>
2218 </desc>
2219 <param name="name" type="wstring" dir="in">
2220 <desc>server name</desc>
2221 </param>
2222 <param name="server" type="IDHCPServer" dir="return">
2223 <desc>DHCP server settings</desc>
2224 </param>
2225 </method>
2226
2227 <method name="findDHCPServerByNetworkName">
2228 <desc>
2229 Searches a DHCP server settings to be used for the given internal network name
2230 <result name="E_INVALIDARG">
2231 Host network interface @a name already exists.
2232 </result>
2233
2234 </desc>
2235 <param name="name" type="wstring" dir="in">
2236 <desc>server name</desc>
2237 </param>
2238 <param name="server" type="IDHCPServer" dir="return">
2239 <desc>DHCP server settings</desc>
2240 </param>
2241 </method>
2242
2243 <!--method name="findDHCPServerForInterface">
2244 <desc>
2245 Searches a DHCP server settings to be used for the given interface
2246 <result name="E_INVALIDARG">
2247 Host network interface @a name already exists.
2248 </result>
2249 </desc>
2250 <param name="interface" type="IHostNetworkInterface" dir="in">
2251 <desc>Network Interface</desc>
2252 </param>
2253 <param name="server" type="IDHCPServer" dir="out">
2254 <desc>DHCP server settings</desc>
2255 </param>
2256 </method-->
2257
2258 <method name="removeDHCPServer">
2259 <desc>
2260 Removes the DHCP server settings
2261 <result name="E_INVALIDARG">
2262 Host network interface @a name already exists.
2263 </result>
2264 </desc>
2265 <param name="server" type="IDHCPServer" dir="in">
2266 <desc>DHCP server settings to be removed</desc>
2267 </param>
2268 </method>
2269
2270
2271 <method name="checkFirmwarePresent">
2272 <desc>
2273 Check if this VirtualBox installation has a firmware
2274 of the given type available, either system-wide or per-user.
2275 Optionally, this may return a hint where this firmware can be
2276 downloaded from.
2277 </desc>
2278 <param name="firmwareType" type="FirmwareType" dir="in">
2279 <desc>
2280 Type of firmware to check.
2281 </desc>
2282 </param>
2283 <param name="version" type="wstring" dir="in">
2284 <desc>Expected version number, usually empty string (presently ignored).</desc>
2285 </param>
2286
2287 <param name="url" type="wstring" dir="out">
2288 <desc>
2289 Suggested URL to download this firmware from.
2290 </desc>
2291 </param>
2292
2293 <param name="file" type="wstring" dir="out">
2294 <desc>
2295 Filename of firmware, only valid if result == TRUE.
2296 </desc>
2297 </param>
2298
2299 <param name="result" type="boolean" dir="return">
2300 <desc>If firmware of this type and version is available.</desc>
2301 </param>
2302 </method>
2303
2304 </interface>
2305
2306 <!--
2307 // IVFSExplorer
2308 /////////////////////////////////////////////////////////////////////////
2309 -->
2310
2311 <enum
2312 name="VFSType"
2313 uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2314 >
2315 <desc>
2316 Virtual file systems supported by VFSExplorer.
2317 </desc>
2318
2319 <const name="File" value="1" />
2320 <const name="Cloud" value="2" />
2321 <const name="S3" value="3" />
2322 <const name="WebDav" value="4" />
2323 </enum>
2324
2325 <enum
2326 name="VFSFileType"
2327 uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2328 >
2329 <desc>
2330 File types known by VFSExplorer.
2331 </desc>
2332
2333 <const name="Unknown" value="1" />
2334 <const name="Fifo" value="2" />
2335 <const name="DevChar" value="3" />
2336 <const name="Directory" value="4" />
2337 <const name="DevBlock" value="5" />
2338 <const name="File" value="6" />
2339 <const name="SymLink" value="7" />
2340 <const name="Socket" value="8" />
2341 <const name="WhiteOut" value="9" />
2342 </enum>
2343
2344 <interface
2345 name="IVFSExplorer" extends="$unknown"
2346 uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2347 wsmap="managed"
2348 >
2349 <desc>
2350 The VFSExplorer interface unifies access to different file system
2351 types. This includes local file systems as well remote file systems like
2352 S3. For a list of supported types see <link to="VFSType" />.
2353 An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2354 </desc>
2355
2356 <attribute name="path" type="wstring" readonly="yes">
2357 <desc>Returns the current path in the virtual file system.</desc>
2358 </attribute>
2359
2360 <attribute name="type" type="VFSType" readonly="yes">
2361 <desc>Returns the file system type which is currently in use.</desc>
2362 </attribute>
2363
2364 <method name="update">
2365 <desc>Updates the internal list of files/directories from the
2366 current directory level. Use <link to="#entryList" /> to get the full list
2367 after a call to this method.</desc>
2368
2369 <param name="aProgress" type="IProgress" dir="return">
2370 <desc>Progress object to track the operation completion.</desc>
2371 </param>
2372 </method>
2373
2374 <method name="cd">
2375 <desc>Change the current directory level.</desc>
2376
2377 <param name="aDir" type="wstring" dir="in">
2378 <desc>The name of the directory to go in.</desc>
2379 </param>
2380
2381 <param name="aProgress" type="IProgress" dir="return">
2382 <desc>Progress object to track the operation completion.</desc>
2383 </param>
2384 </method>
2385
2386 <method name="cdUp">
2387 <desc>Go one directory upwards from the current directory level.</desc>
2388
2389 <param name="aProgress" type="IProgress" dir="return">
2390 <desc>Progress object to track the operation completion.</desc>
2391 </param>
2392 </method>
2393
2394 <method name="entryList">
2395 <desc>Returns a list of files/directories after a call to <link
2396 to="#update" />. The user is responsible for keeping this internal
2397 list up do date.</desc>
2398
2399 <param name="aNames" type="wstring" safearray="yes" dir="out">
2400 <desc>The list of names for the entries.</desc>
2401 </param>
2402
2403 <param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2404 <desc>The list of types for the entries.</desc>
2405 </param>
2406
2407 <param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2408 <desc>The list of sizes (in bytes) for the entries.</desc>
2409 </param>
2410
2411 <param name="aModes" type="unsigned long" safearray="yes" dir="out">
2412 <desc>The list of file modes (in octal form) for the entries.</desc>
2413 </param>
2414 </method>
2415
2416 <method name="exists">
2417 <desc>Checks if the given file list exists in the current directory
2418 level.</desc>
2419
2420 <param name="aNames" type="wstring" safearray="yes" dir="in">
2421 <desc>The names to check.</desc>
2422 </param>
2423
2424 <param name="aExists" type="wstring" safearray="yes" dir="return">
2425 <desc>The names which exist.</desc>
2426 </param>
2427 </method>
2428
2429 <method name="remove">
2430 <desc>Deletes the given files in the current directory level.</desc>
2431
2432 <param name="aNames" type="wstring" safearray="yes" dir="in">
2433 <desc>The names to remove.</desc>
2434 </param>
2435
2436 <param name="aProgress" type="IProgress" dir="return">
2437 <desc>Progress object to track the operation completion.</desc>
2438 </param>
2439 </method>
2440
2441 </interface>
2442
2443 <enum
2444 name="ImportOptions" extends="$unknown"
2445 uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2446 >
2447
2448 <desc>
2449 Import options, used with <link to="IAppliance::importMachines" />.
2450 </desc>
2451
2452 <const name="KeepAllMACs" value="1">
2453 <desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2454 </const>
2455 <const name="KeepNATMACs" value="2">
2456 <desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2457 </const>
2458
2459 </enum>
2460
2461
2462 <!--
2463 // IAppliance
2464 /////////////////////////////////////////////////////////////////////////
2465 -->
2466
2467 <interface
2468 name="IAppliance" extends="$unknown"
2469 uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2470 wsmap="managed"
2471 >
2472 <desc>
2473 Represents a platform-independent appliance in OVF format. An instance of this is returned
2474 by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2475 virtual machines within an appliance with VirtualBox.
2476
2477 The OVF standard suggests two different physical file formats:
2478
2479 <ol>
2480 <li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2481 file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2482 this descriptor file references other files such as disk images, as OVF appliances typically
2483 do, those additional files must be in the same directory as the descriptor file.</li>
2484
2485 <li>If the appliance is distributed as a single file, it must be in TAR format and have the
2486 <tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2487 files and optionally other files.
2488
2489 At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2490 be added with a later version.</li>
2491 </ol>
2492
2493 <b>Importing</b> an OVF appliance into VirtualBox as instances of
2494 <link to="IMachine" /> involves the following sequence of API calls:
2495
2496 <ol>
2497 <li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2498 </li>
2499
2500 <li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2501 would like to import. So long as this file is syntactically valid, this will succeed
2502 and fill the appliance object with the parsed data from the OVF file.
2503 </li>
2504
2505 <li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2506 contents of the IAppliance attributes accordingly. These can be inspected by a
2507 VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2508 user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2509 instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2510 systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2511 by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2512 The GUI can then give the user the option to confirm and/or change these suggestions.
2513 </li>
2514
2515 <li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2516 virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2517 </li>
2518
2519 <li>Finally, call <link to="#importMachines" /> to create virtual machines in
2520 VirtualBox as instances of <link to="IMachine" /> that match the information in the
2521 virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2522 can be found in the <link to="#machines" /> array attribute.
2523 </li>
2524 </ol>
2525
2526 <b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2527
2528 <ol>
2529 <li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2530 an empty IAppliance object.
2531 </li>
2532
2533 <li>For each machine you would like to export, call <link to="IMachine::export" />
2534 with the IAppliance object you just created. Each such call creates one instance of
2535 <link to="IVirtualSystemDescription" /> inside the appliance.
2536 </li>
2537
2538 <li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2539 virtual system (machine) to override the suggestions made by the <link to="IMachine::export"/> routine.
2540 </li>
2541
2542 <li>Finally, call <link to="#write" /> with a path specification to have the OVF
2543 file written.</li>
2544 </ol>
2545
2546 </desc>
2547
2548 <attribute name="path" type="wstring" readonly="yes">
2549 <desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2550 the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2551 <link to="#write" /> (for export).
2552 This attribute is empty until one of these methods has been called.
2553 </desc>
2554 </attribute>
2555
2556 <attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2557 <desc>
2558 Array of virtual disk definitions. One such description exists for each
2559 disk definition in the OVF; each string array item represents one such piece of
2560 disk information, with the information fields separated by tab (\\t) characters.
2561
2562 The caller should be prepared for additional fields being appended to
2563 this string in future versions of VirtualBox and therefore check for
2564 the number of tabs in the strings returned.
2565
2566 In the current version, the following eight fields are returned per string
2567 in the array:
2568
2569 <ol>
2570 <li>Disk ID (unique string identifier given to disk)</li>
2571
2572 <li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2573
2574 <li>Populated size (optional unsigned integer indicating the current size of the
2575 disk; can be approximate; -1 if unspecified)</li>
2576
2577 <li>Format (string identifying the disk format, typically
2578 "http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2579
2580 <li>Reference (where to find the disk image, typically a file name; if empty,
2581 then the disk should be created on import)</li>
2582
2583 <li>Image size (optional unsigned integer indicating the size of the image,
2584 which need not necessarily be the same as the values specified above, since
2585 the image may be compressed or sparse; -1 if not specified)</li>
2586
2587 <li>Chunk size (optional unsigned integer if the image is split into chunks;
2588 presently unsupported and always -1)</li>
2589
2590 <li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2591 </ol>
2592 </desc>
2593 </attribute>
2594
2595 <attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2596 <desc> Array of virtual system descriptions. One such description is created
2597 for each virtual system (machine) found in the OVF.
2598 This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2599 (for export) has been called.
2600 </desc>
2601 </attribute>
2602
2603 <attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2604 <desc>
2605 Contains the UUIDs of the machines created from the information in this appliances. This is only
2606 relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2607 succeeded.
2608 </desc>
2609 </attribute>
2610
2611 <method name="read">
2612 <desc>
2613 Reads an OVF file into the appliance object.
2614
2615 This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2616 mere fact that this method returns successfully does not mean that VirtualBox supports all
2617 features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2618 </desc>
2619 <param name="file" type="wstring" dir="in">
2620 <desc>
2621 Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2622 on whether the appliance is distributed as a set of files or as a single file, respectively).
2623 </desc>
2624 </param>
2625 <param name="aProgress" type="IProgress" dir="return">
2626 <desc>Progress object to track the operation completion.</desc>
2627 </param>
2628 </method>
2629
2630 <method name="interpret">
2631 <desc>
2632 Interprets the OVF data that was read when the appliance was constructed. After
2633 calling this method, one can inspect the
2634 <link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2635 one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2636 the appliance.
2637
2638 Calling this method is the second step of importing an appliance into VirtualBox;
2639 see <link to="IAppliance" /> for an overview.
2640
2641 After calling this method, one should call <link to="#getWarnings" /> to find out
2642 if problems were encountered during the processing which might later lead to
2643 errors.
2644 </desc>
2645 </method>
2646
2647 <method name="importMachines">
2648 <desc>
2649 Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2650 and other interfaces that match the information contained in the appliance as
2651 closely as possible, as represented by the import instructions in the
2652 <link to="#virtualSystemDescriptions" /> array.
2653
2654 Calling this method is the final step of importing an appliance into VirtualBox;
2655 see <link to="IAppliance" /> for an overview.
2656
2657 Since importing the appliance will most probably involve copying and converting
2658 disk images, which can take a long time, this method operates asynchronously and
2659 returns an IProgress object to allow the caller to monitor the progress.
2660
2661 After the import succeeded, the UUIDs of the IMachine instances created can be
2662 retrieved from the <link to="#machines" /> array attribute.
2663 </desc>
2664
2665 <param name="options" type="ImportOptions" dir="in" safearray="yes">
2666 <desc>Options for the importing operation.</desc>
2667 </param>
2668
2669 <param name="aProgress" type="IProgress" dir="return">
2670 <desc>Progress object to track the operation completion.</desc>
2671 </param>
2672 </method>
2673
2674 <method name="createVFSExplorer">
2675 <desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2676
2677 <param name="aUri" type="wstring" dir="in">
2678 <desc>The URI describing the file system to use.</desc>
2679 </param>
2680
2681 <param name="aExplorer" type="IVFSExplorer" dir="return">
2682 <desc></desc>
2683 </param>
2684 </method>
2685
2686 <method name="write">
2687 <desc>
2688 Writes the contents of the appliance exports into a new OVF file.
2689
2690 Calling this method is the final step of exporting an appliance from VirtualBox;
2691 see <link to="IAppliance" /> for an overview.
2692
2693 Since exporting the appliance will most probably involve copying and converting
2694 disk images, which can take a long time, this method operates asynchronously and
2695 returns an IProgress object to allow the caller to monitor the progress.
2696 </desc>
2697 <param name="format" type="wstring" dir="in">
2698 <desc>
2699 Output format, as a string. Currently supported formats are "ovf-0.9", "ovf-1.0"
2700 and "ovf-2.0"; future versions of VirtualBox may support additional formats.
2701 </desc>
2702 </param>
2703 <param name="manifest" type="boolean" dir="in">
2704 <desc>
2705 Indicate if the optional manifest file (.mf) should be written. The manifest file
2706 is used for integrity checks prior import.
2707 </desc>
2708 </param>
2709 <param name="path" type="wstring" dir="in">
2710 <desc>
2711 Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2712 on whether the appliance is distributed as a set of files or as a single file, respectively).
2713 </desc>
2714 </param>
2715 <param name="progress" type="IProgress" dir="return">
2716 <desc>Progress object to track the operation completion.</desc>
2717 </param>
2718 </method>
2719
2720 <method name="getWarnings">
2721 <desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2722
2723 <param name="aWarnings" type="wstring" dir="return" safearray="yes">
2724 <desc></desc>
2725 </param>
2726 </method>
2727
2728 </interface>
2729
2730 <enum
2731 name="VirtualSystemDescriptionType"
2732 uuid="303c0900-a746-4612-8c67-79003e91f459"
2733 >
2734 <desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2735 a configuration value.</desc>
2736
2737 <const name="Ignore" value="1" />
2738 <const name="OS" value="2" />
2739 <const name="Name" value="3" />
2740 <const name="Product" value="4" />
2741 <const name="Vendor" value="5" />
2742 <const name="Version" value="6" />
2743 <const name="ProductUrl" value="7" />
2744 <const name="VendorUrl" value="8" />
2745 <const name="Description" value="9" />
2746 <const name="License" value="10" />
2747 <const name="Miscellaneous" value="11" />
2748 <const name="CPU" value="12" />
2749 <const name="Memory" value="13" />
2750 <const name="HardDiskControllerIDE" value="14" />
2751 <const name="HardDiskControllerSATA" value="15" />
2752 <const name="HardDiskControllerSCSI" value="16" />
2753 <const name="HardDiskControllerSAS" value="17" />
2754 <const name="HardDiskImage" value="18" />
2755 <const name="Floppy" value="19" />
2756 <const name="CDROM" value="20" />
2757 <const name="NetworkAdapter" value="21" />
2758 <const name="USBController" value="22" />
2759 <const name="SoundCard" value="23" />
2760 <const name="SettingsFile" value="24">
2761 <desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2762 </const>
2763 </enum>
2764
2765 <enum
2766 name="VirtualSystemDescriptionValueType"
2767 uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2768 >
2769 <desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2770 type to fetch.</desc>
2771
2772 <const name="Reference" value="1" />
2773 <const name="Original" value="2" />
2774 <const name="Auto" value="3" />
2775 <const name="ExtraConfig" value="4" />
2776
2777 </enum>
2778
2779 <interface
2780 name="IVirtualSystemDescription" extends="$unknown"
2781 uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2782 wsmap="managed"
2783 >
2784
2785 <desc>Represents one virtual system (machine) in an appliance. This interface is used in
2786 the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2787 <link to="IAppliance::interpret" /> has been called, that array contains information
2788 about how the virtual systems described in the OVF should best be imported into
2789 VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2790 import an OVF into VirtualBox.
2791 </desc>
2792
2793 <attribute name="count" type="unsigned long" readonly="yes">
2794 <desc>Return the number of virtual system description entries.</desc>
2795 </attribute>
2796
2797 <method name="getDescription">
2798 <desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2799 items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2800
2801 The list below identifies the value sets that are possible depending on the
2802 <link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2803 the array item with the same index in @a aOvfValues[] will contain the original value as contained
2804 in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2805 will contain a suggested value to be used for VirtualBox. Depending on the description type,
2806 the @a aExtraConfigValues[] array item may also be used.
2807
2808 <ul>
2809 <li>
2810 "OS": the guest operating system type. There must be exactly one such array item on import. The
2811 corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2812 This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2813 item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2814 </li>
2815 <li>
2816 "Name": the name to give to the new virtual machine. There can be at most one such array item;
2817 if none is present on import, then an automatic name will be created from the operating system
2818 type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2819 from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2820 <link to="IMachine" /> name that does not exist yet.
2821 </li>
2822 <li>
2823 "Description": an arbitrary description.
2824 </li>
2825 <li>
2826 "License": the EULA section from the OVF, if present. It is the responsibility of the calling
2827 code to display such a license for agreement; the Main API does not enforce any such policy.
2828 </li>
2829 <li>
2830 Miscellaneous: reserved for future use.
2831 </li>
2832 <li>
2833 "CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2834 </li>
2835 <li>
2836 "Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2837 is present on import, then VirtualBox will set a meaningful default based on the operating system
2838 type.
2839 </li>
2840 <li>
2841 "HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2842 An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2843 the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2844 writes into the OVF.
2845 The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2846 type can use to specify which hard disk controller a virtual disk should be connected to.
2847 Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2848 in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2849 its virtual machines supports four channels (primary master, primary slave, secondary master,
2850 secondary slave) and thus maps to two IDE controllers in the OVF sense.
2851 </li>
2852 <li>
2853 "HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2854 has no value in @a aOvfValues[] or @a aVBoxValues[].
2855 The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2856 </li>
2857 <li>
2858 "HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2859 The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2860 "LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2861 whereas VirtualBox considers it a class of storage controllers of its own; see
2862 <link to="StorageControllerType" />).
2863 The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2864 </li>
2865 <li>
2866 "HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2867 arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2868
2869 The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2870 a path since the image file should be in the same location as the OVF file itself), whereas the
2871 item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2872 hard disk image. This means that on import the image will be copied and converted from the
2873 "ovf" location to the "vbox" location; on export, this will be handled the other way round.
2874
2875 The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2876 format: "controller=&lt;index&gt;;channel=&lt;c&gt;"
2877 In this string, &lt;index&gt; must be an integer specifying the hard disk controller to connect
2878 the image to. That number must be the index of an array item with one of the hard disk controller
2879 types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2880 In addition, &lt;c&gt; must specify the channel to use on that controller. For IDE controllers,
2881 this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2882 before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2883 no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2884 </li>
2885 <li>
2886 "CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2887 attachment information as with "HardDiskImage" items.
2888 </li>
2889 <li>
2890 "CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2891 attachment information as with "HardDiskImage" items.
2892 </li>
2893 <li>
2894 "NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2895 for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2896 of the "type=&lt;X&gt;" format, where &lt;X&gt; must be either "NAT" or "Bridged".
2897 </li>
2898 <li>
2899 "USBController": a USB controller. There can be at most one such item. If and only if such an
2900 item ispresent, USB support will be enabled for the new virtual machine.
2901 </li>
2902 <li>
2903 "SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2904 present, sound support will be enabled for the new virtual machine. Note that the virtual
2905 machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2906 may be different from the virtual soundcard expected by the appliance.
2907 </li>
2908 </ul>
2909
2910 </desc>
2911
2912 <param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2913 <desc></desc>
2914 </param>
2915
2916 <param name="aRefs" type="wstring" dir="out" safearray="yes">
2917 <desc></desc>
2918 </param>
2919
2920 <param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2921 <desc></desc>
2922 </param>
2923
2924 <param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2925 <desc></desc>
2926 </param>
2927
2928 <param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2929 <desc></desc>
2930 </param>
2931
2932 </method>
2933
2934 <method name="getDescriptionByType">
2935 <desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2936 should be returned.</desc>
2937
2938 <param name="aType" type="VirtualSystemDescriptionType" dir="in">
2939 <desc></desc>
2940 </param>
2941
2942 <param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2943 <desc></desc>
2944 </param>
2945
2946 <param name="aRefs" type="wstring" dir="out" safearray="yes">
2947 <desc></desc>
2948 </param>
2949
2950 <param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2951 <desc></desc>
2952 </param>
2953
2954 <param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2955 <desc></desc>
2956 </param>
2957
2958 <param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2959 <desc></desc>
2960 </param>
2961
2962 </method>
2963
2964 <method name="getValuesByType">
2965 <desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2966 value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2967 values.</desc>
2968
2969 <param name="aType" type="VirtualSystemDescriptionType" dir="in">
2970 <desc></desc>
2971 </param>
2972
2973 <param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2974 <desc></desc>
2975 </param>
2976
2977 <param name="aValues" type="wstring" dir="return" safearray="yes">
2978 <desc></desc>
2979 </param>
2980
2981 </method>
2982
2983 <method name="setFinalValues">
2984 <desc>
2985 This method allows the appliance's user to change the configuration for the virtual
2986 system descriptions. For each array item returned from <link to="#getDescription" />,
2987 you must pass in one boolean value and one configuration value.
2988
2989 Each item in the boolean array determines whether the particular configuration item
2990 should be enabled.
2991 You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2992 HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2993 and SoundCard.
2994
2995 For the "vbox" and "extra configuration" values, if you pass in the same arrays
2996 as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
2997 the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
2998 for valid configuration values for the individual array item types. If the
2999 corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3000 </desc>
3001
3002 <param name="aEnabled" type="boolean" dir="in" safearray="yes">
3003 <desc></desc>
3004 </param>
3005
3006 <param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
3007 <desc></desc>
3008 </param>
3009
3010 <param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
3011 <desc></desc>
3012 </param>
3013 </method>
3014
3015 <method name="addDescription">
3016 <desc>
3017 This method adds an additional description entry to the stack of already
3018 available descriptions for this virtual system. This is handy for writing
3019 values which aren't directly supported by VirtualBox. One example would
3020 be the License type of <link to="VirtualSystemDescriptionType" />.
3021 </desc>
3022
3023 <param name="aType" type="VirtualSystemDescriptionType" dir="in">
3024 <desc></desc>
3025 </param>
3026
3027 <param name="aVBoxValue" type="wstring" dir="in">
3028 <desc></desc>
3029 </param>
3030
3031 <param name="aExtraConfigValue" type="wstring" dir="in">
3032 <desc></desc>
3033 </param>
3034 </method>
3035 </interface>
3036
3037
3038 <!--
3039 // IMachine
3040 /////////////////////////////////////////////////////////////////////////
3041 -->
3042
3043 <interface
3044 name="IInternalMachineControl" extends="$unknown"
3045 uuid="ec824977-e43f-479c-81c9-ac6cae1423a5"
3046 internal="yes"
3047 wsmap="suppress"
3048 >
3049 <method name="setRemoveSavedStateFile">
3050 <desc>
3051 Updates the flag whether the saved state file is removed on a
3052 machine state change from Saved to PoweredOff.
3053 </desc>
3054 <param name="aRemove" type="boolean" dir="in"/>
3055 </method>
3056
3057 <method name="updateState">
3058 <desc>
3059 Updates the VM state.
3060 <note>
3061 This operation will also update the settings file with the correct
3062 information about the saved state file and delete this file from disk
3063 when appropriate.
3064 </note>
3065 </desc>
3066 <param name="state" type="MachineState" dir="in"/>
3067 </method>
3068
3069 <method name="getIPCId">
3070 <param name="id" type="wstring" dir="return"/>
3071 </method>
3072
3073 <method name="beginPowerUp">
3074 <desc>
3075 Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
3076 gives it the progress object that should be part of any pending
3077 <link to="IMachine::launchVMProcess"/> operations. The progress
3078 object may be called back to reflect an early cancelation, so some care
3079 have to be taken with respect to any cancelation callbacks. The console
3080 object will call <link to="IInternalMachineControl::endPowerUp"/>
3081 to signal the completion of the progress object.
3082 </desc>
3083 <param name="aProgress" type="IProgress" dir="in" />
3084 </method>
3085
3086 <method name="endPowerUp">
3087 <desc>
3088 Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3089 This method may query status information from the progress object it
3090 received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3091 it over to any in-progress <link to="IMachine::launchVMProcess"/>
3092 call in order to complete that progress object.
3093 </desc>
3094 <param name="result" type="long" dir="in"/>
3095 </method>
3096
3097 <method name="beginPoweringDown">
3098 <desc>
3099 Called by the VM process to inform the server it wants to
3100 stop the VM execution and power down.
3101 </desc>
3102 <param name="progress" type="IProgress" dir="out">
3103 <desc>
3104 Progress object created by VBoxSVC to wait until
3105 the VM is powered down.
3106 </desc>
3107 </param>
3108 </method>
3109
3110 <method name="endPoweringDown">
3111 <desc>
3112 Called by the VM process to inform the server that powering
3113 down previously requested by #beginPoweringDown is either
3114 successfully finished or there was a failure.
3115
3116 <result name="VBOX_E_FILE_ERROR">
3117 Settings file not accessible.
3118 </result>
3119 <result name="VBOX_E_XML_ERROR">
3120 Could not parse the settings file.
3121 </result>
3122
3123 </desc>
3124
3125 <param name="result" type="long" dir="in">
3126 <desc>@c S_OK to indicate success.
3127 </desc>
3128 </param>
3129 <param name="errMsg" type="wstring" dir="in">
3130 <desc>@c human readable error message in case of failure.
3131 </desc>
3132 </param>
3133 </method>
3134
3135 <method name="runUSBDeviceFilters">
3136 <desc>
3137 Asks the server to run USB devices filters of the associated
3138 machine against the given USB device and tell if there is
3139 a match.
3140 <note>
3141 Intended to be used only for remote USB devices. Local
3142 ones don't require to call this method (this is done
3143 implicitly by the Host and USBProxyService).
3144 </note>
3145 </desc>
3146 <param name="device" type="IUSBDevice" dir="in"/>
3147 <param name="matched" type="boolean" dir="out"/>
3148 <param name="maskedInterfaces" type="unsigned long" dir="out"/>
3149 </method>
3150
3151 <method name="captureUSBDevice">
3152 <desc>
3153 Requests a capture of the given host USB device.
3154 When the request is completed, the VM process will
3155 get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3156 notification.
3157 </desc>
3158 <param name="id" type="uuid" mod="string" dir="in"/>
3159 </method>
3160
3161 <method name="detachUSBDevice">
3162 <desc>
3163 Notification that a VM is going to detach (@a done = @c false) or has
3164 already detached (@a done = @c true) the given USB device.
3165 When the @a done = @c true request is completed, the VM process will
3166 get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3167 notification.
3168 <note>
3169 In the @a done = @c true case, the server must run its own filters
3170 and filters of all VMs but this one on the detached device
3171 as if it were just attached to the host computer.
3172 </note>
3173 </desc>
3174 <param name="id" type="uuid" mod="string" dir="in"/>
3175 <param name="done" type="boolean" dir="in"/>
3176 </method>
3177
3178 <method name="autoCaptureUSBDevices">
3179 <desc>
3180 Requests a capture all matching USB devices attached to the host.
3181 When the request is completed, the VM process will
3182 get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3183 notification per every captured device.
3184 </desc>
3185 </method>
3186
3187 <method name="detachAllUSBDevices">
3188 <desc>
3189 Notification that a VM that is being powered down. The done
3190 parameter indicates whether which stage of the power down
3191 we're at. When @a done = @c false the VM is announcing its
3192 intentions, while when @a done = @c true the VM is reporting
3193 what it has done.
3194 <note>
3195 In the @a done = @c true case, the server must run its own filters
3196 and filters of all VMs but this one on all detach devices as
3197 if they were just attached to the host computer.
3198 </note>
3199 </desc>
3200 <param name="done" type="boolean" dir="in"/>
3201 </method>
3202
3203 <method name="onSessionEnd">
3204 <desc>
3205 Triggered by the given session object when the session is about
3206 to close normally.
3207 </desc>
3208 <param name="session" type="ISession" dir="in">
3209 <desc>Session that is being closed</desc>
3210 </param>
3211 <param name="progress" type="IProgress" dir="return">
3212 <desc>
3213 Used to wait until the corresponding machine is actually
3214 dissociated from the given session on the server.
3215 Returned only when this session is a direct one.
3216 </desc>
3217 </param>
3218 </method>
3219
3220 <method name="beginSavingState">
3221 <desc>
3222 Called by the VM process to inform the server it wants to
3223 save the current state and stop the VM execution.
3224 </desc>
3225 <param name="progress" type="IProgress" dir="out">
3226 <desc>
3227 Progress object created by VBoxSVC to wait until
3228 the state is saved.
3229 </desc>
3230 </param>
3231 <param name="stateFilePath" type="wstring" dir="out">
3232 <desc>
3233 File path the VM process must save the execution state to.
3234 </desc>
3235 </param>
3236 </method>
3237
3238 <method name="endSavingState">
3239 <desc>
3240 Called by the VM process to inform the server that saving
3241 the state previously requested by #beginSavingState is either
3242 successfully finished or there was a failure.
3243
3244 <result name="VBOX_E_FILE_ERROR">
3245 Settings file not accessible.
3246 </result>
3247 <result name="VBOX_E_XML_ERROR">
3248 Could not parse the settings file.
3249 </result>
3250
3251 </desc>
3252
3253 <param name="result" type="long" dir="in">
3254 <desc>@c S_OK to indicate success.
3255 </desc>
3256 </param>
3257 <param name="errMsg" type="wstring" dir="in">
3258 <desc>@c human readable error message in case of failure.
3259 </desc>
3260 </param>
3261 </method>
3262
3263 <method name="adoptSavedState">
3264 <desc>
3265 Gets called by <link to="IConsole::adoptSavedState"/>.
3266 <result name="VBOX_E_FILE_ERROR">
3267 Invalid saved state file path.
3268 </result>
3269 </desc>
3270 <param name="savedStateFile" type="wstring" dir="in">
3271 <desc>Path to the saved state file to adopt.</desc>
3272 </param>
3273 </method>
3274
3275 <method name="beginTakingSnapshot">
3276 <desc>
3277 Called from the VM process to request from the server to perform the
3278 server-side actions of creating a snapshot (creating differencing images
3279 and the snapshot object).
3280
3281 <result name="VBOX_E_FILE_ERROR">
3282 Settings file not accessible.
3283 </result>
3284 <result name="VBOX_E_XML_ERROR">
3285 Could not parse the settings file.
3286 </result>
3287 </desc>
3288 <param name="initiator" type="IConsole" dir="in">
3289 <desc>The console object that initiated this call.</desc>
3290 </param>
3291 <param name="name" type="wstring" dir="in">
3292 <desc>Snapshot name.</desc>
3293 </param>
3294 <param name="description" type="wstring" dir="in">
3295 <desc>Snapshot description.</desc>
3296 </param>
3297 <param name="consoleProgress" type="IProgress" dir="in">
3298 <desc>
3299 Progress object created by the VM process tracking the
3300 snapshot's progress. This has the following sub-operations:
3301 <ul>
3302 <li>setting up (weight 1);</li>
3303 <li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3304 <li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3305 <li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3306 <li>finishing up (weight 1)</li>
3307 </ul>
3308 </desc>
3309 </param>
3310 <param name="fTakingSnapshotOnline" type="boolean" dir="in">
3311 <desc>
3312 Whether this is an online snapshot (i.e. the machine is running).
3313 </desc>
3314 </param>
3315 <param name="stateFilePath" type="wstring" dir="out">
3316 <desc>
3317 File path the VM process must save the execution state to.
3318 </desc>
3319 </param>
3320 </method>
3321
3322 <method name="endTakingSnapshot">
3323 <desc>
3324 Called by the VM process to inform the server that the snapshot
3325 previously requested by #beginTakingSnapshot is either
3326 successfully taken or there was a failure.
3327 </desc>
3328
3329 <param name="success" type="boolean" dir="in">
3330 <desc>@c true to indicate success and @c false otherwise</desc>
3331 </param>
3332 </method>
3333
3334 <method name="deleteSnapshot">
3335 <desc>
3336 Gets called by <link to="IConsole::deleteSnapshot"/>,
3337 <link to="IConsole::deleteSnapshotAndAllChildren"/> and
3338 <link to="IConsole::deleteSnapshotRange"/>.
3339 <result name="VBOX_E_INVALID_OBJECT_STATE">
3340 Snapshot has more than one child snapshot. Only possible if the
3341 delete operation does not delete all children or the range does
3342 not meet the linearity condition.
3343 </result>
3344 </desc>
3345 <param name="initiator" type="IConsole" dir="in">
3346 <desc>The console object that initiated this call.</desc>
3347 </param>
3348 <param name="startId" type="uuid" mod="string" dir="in">
3349 <desc>UUID of the first snapshot to delete.</desc>
3350 </param>
3351 <param name="endId" type="uuid" mod="string" dir="in">
3352 <desc>UUID of the last snapshot to delete.</desc>
3353 </param>
3354 <param name="deleteAllChildren" type="boolean" dir="in">
3355 <desc>Whether all children should be deleted.</desc>
3356 </param>
3357 <param name="machineState" type="MachineState" dir="out">
3358 <desc>New machine state after this operation is started.</desc>
3359 </param>
3360 <param name="progress" type="IProgress" dir="return">
3361 <desc>Progress object to track the operation completion.</desc>
3362 </param>
3363 </method>
3364
3365 <method name="finishOnlineMergeMedium">
3366 <desc>
3367 Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3368 </desc>
3369 <param name="mediumAttachment" type="IMediumAttachment" dir="in">
3370 <desc>The medium attachment which needs to be cleaned up.</desc>
3371 </param>
3372 <param name="source" type="IMedium" dir="in">
3373 <desc>Merge source medium.</desc>
3374 </param>
3375 <param name="target" type="IMedium" dir="in">
3376 <desc>Merge target medium.</desc>
3377 </param>
3378 <param name="mergeForward" type="boolean" dir="in">
3379 <desc>Merge direction.</desc>
3380 </param>
3381 <param name="parentForTarget" type="IMedium" dir="in">
3382 <desc>For forward merges: new parent for target medium.</desc>
3383 </param>
3384 <param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3385 <desc>For backward merges: list of media which need their parent UUID
3386 updated.</desc>
3387 </param>
3388 </method>
3389
3390 <method name="restoreSnapshot">
3391 <desc>
3392 Gets called by <link to="IConsole::restoreSnapshot"/>.
3393 </desc>
3394 <param name="initiator" type="IConsole" dir="in">
3395 <desc>The console object that initiated this call.</desc>
3396 </param>
3397 <param name="snapshot" type="ISnapshot" dir="in">
3398 <desc>The snapshot to restore the VM state from.</desc>
3399 </param>
3400 <param name="machineState" type="MachineState" dir="out">
3401 <desc>New machine state after this operation is started.</desc>
3402 </param>
3403 <param name="progress" type="IProgress" dir="return">
3404 <desc>Progress object to track the operation completion.</desc>
3405 </param>
3406 </method>
3407
3408 <method name="pullGuestProperties">
3409 <desc>
3410 Get the list of the guest properties matching a set of patterns along
3411 with their values, time stamps and flags and give responsibility for
3412 managing properties to the console.
3413 </desc>
3414 <param name="name" type="wstring" dir="out" safearray="yes">
3415 <desc>
3416 The names of the properties returned.
3417 </desc>
3418 </param>
3419 <param name="value" type="wstring" dir="out" safearray="yes">
3420 <desc>
3421 The values of the properties returned. The array entries match the
3422 corresponding entries in the @a name array.
3423 </desc>
3424 </param>
3425 <param name="timestamp" type="long long" dir="out" safearray="yes">
3426 <desc>
3427 The time stamps of the properties returned. The array entries match
3428 the corresponding entries in the @a name array.
3429 </desc>
3430 </param>
3431 <param name="flags" type="wstring" dir="out" safearray="yes">
3432 <desc>
3433 The flags of the properties returned. The array entries match the
3434 corresponding entries in the @a name array.
3435 </desc>
3436 </param>
3437 </method>
3438
3439 <method name="pushGuestProperty">
3440 <desc>
3441 Update a single guest property in IMachine.
3442 </desc>
3443 <param name="name" type="wstring" dir="in">
3444 <desc>
3445 The name of the property to be updated.
3446 </desc>
3447 </param>
3448 <param name="value" type="wstring" dir="in">
3449 <desc>
3450 The value of the property.
3451 </desc>
3452 </param>
3453 <param name="timestamp" type="long long" dir="in">
3454 <desc>
3455 The timestamp of the property.
3456 </desc>
3457 </param>
3458 <param name="flags" type="wstring" dir="in">
3459 <desc>
3460 The flags of the property.
3461 </desc>
3462 </param>
3463 </method>
3464
3465 <method name="lockMedia">
3466 <desc>
3467 Locks all media attached to the machine for writing and parents of
3468 attached differencing media (if any) for reading. This operation is
3469 atomic so that if it fails no media is actually locked.
3470
3471 This method is intended to be called when the machine is in Starting or
3472 Restoring state. The locked media will be automatically unlocked when
3473 the machine is powered off or crashed.
3474 </desc>
3475 </method>
3476 <method name="unlockMedia">
3477 <desc>
3478 Unlocks all media previously locked using
3479 <link to="IInternalMachineControl::lockMedia"/>.
3480
3481 This method is intended to be used with teleportation so that it is
3482 possible to teleport between processes on the same machine.
3483 </desc>
3484 </method>
3485
3486 <method name="ejectMedium">
3487 <desc>
3488 Tells VBoxSVC that the guest has ejected the medium associated with
3489 the medium attachment.
3490 </desc>
3491 <param name="attachment" type="IMediumAttachment" dir="in">
3492 <desc>
3493 The medium attachment where the eject happened.
3494 </desc>
3495 </param>
3496 <param name="newAttachment" type="IMediumAttachment" dir="return">
3497 <desc>
3498 A new reference to the medium attachment, as the config change can
3499 result in the creation of a new instance.
3500 </desc>
3501 </param>
3502 </method>
3503
3504 <method name="reportGuestStatistics">
3505 <desc>
3506 Passes collected guest statistics to VBoxSVC.
3507 </desc>
3508 <param name="validStats" type="unsigned long" dir="in">
3509 <desc>
3510 Mask defining which parameters are valid. For example: 0x11 means
3511 that cpuIdle and XXX are valid. Other parameters should be ignored.
3512 </desc>
3513 </param>
3514 <param name="cpuUser" type="unsigned long" dir="in">
3515 <desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
3516 </param>
3517 <param name="cpuKernel" type="unsigned long" dir="in">
3518 <desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
3519 </param>
3520 <param name="cpuIdle" type="unsigned long" dir="in">
3521 <desc>Percentage of processor time spent idling as seen by the guest.</desc>
3522 </param>
3523 <param name="memTotal" type="unsigned long" dir="in">
3524 <desc>Total amount of physical guest RAM.</desc>
3525 </param>
3526 <param name="memFree" type="unsigned long" dir="in">
3527 <desc>Free amount of physical guest RAM.</desc>
3528 </param>
3529 <param name="memBalloon" type="unsigned long" dir="in">
3530 <desc>Amount of ballooned physical guest RAM.</desc>
3531 </param>
3532 <param name="memShared" type="unsigned long" dir="in">
3533 <desc>Amount of shared physical guest RAM.</desc>
3534 </param>
3535 <param name="memCache" type="unsigned long" dir="in">
3536 <desc>Total amount of guest (disk) cache memory.</desc>
3537 </param>
3538 <param name="pagedTotal" type="unsigned long" dir="in">
3539 <desc>Total amount of space in the page file.</desc>
3540 </param>
3541 <param name="memAllocTotal" type="unsigned long" dir="in">
3542 <desc>Total amount of memory allocated by the hypervisor.</desc>
3543 </param>
3544 <param name="memFreeTotal" type="unsigned long" dir="in">
3545 <desc>Total amount of free memory available in the hypervisor.</desc>
3546 </param>
3547 <param name="memBalloonTotal" type="unsigned long" dir="in">
3548 <desc>Total amount of memory ballooned by the hypervisor.</desc>
3549 </param>
3550 <param name="memSharedTotal" type="unsigned long" dir="in">
3551 <desc>Total amount of shared memory in the hypervisor.</desc>
3552 </param>
3553 </method>
3554 </interface>
3555
3556 <interface
3557 name="IBIOSSettings" extends="$unknown"
3558 uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3559 wsmap="managed"
3560 >
3561 <desc>
3562 The IBIOSSettings interface represents BIOS settings of the virtual
3563 machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3564 </desc>
3565 <attribute name="logoFadeIn" type="boolean">
3566 <desc>Fade in flag for BIOS logo animation.</desc>
3567 </attribute>
3568
3569 <attribute name="logoFadeOut" type="boolean">
3570 <desc>Fade out flag for BIOS logo animation.</desc>
3571 </attribute>
3572
3573 <attribute name="logoDisplayTime" type="unsigned long">
3574 <desc>BIOS logo display time in milliseconds (0 = default).</desc>
3575 </attribute>
3576
3577 <attribute name="logoImagePath" type="wstring">
3578 <desc>
3579 Local file system path for external BIOS splash image. Empty string
3580 means the default image is shown on boot.
3581 </desc>
3582 </attribute>
3583
3584 <attribute name="bootMenuMode" type="BIOSBootMenuMode">
3585 <desc>Mode of the BIOS boot device menu.</desc>
3586 </attribute>
3587
3588 <attribute name="ACPIEnabled" type="boolean">
3589 <desc>ACPI support flag.</desc>
3590 </attribute>
3591
3592 <attribute name="IOAPICEnabled" type="boolean">
3593 <desc>
3594 IO APIC support flag. If set, VirtualBox will provide an IO APIC
3595 and support IRQs above 15.
3596 </desc>
3597 </attribute>
3598
3599 <attribute name="timeOffset" type="long long">
3600 <desc>
3601 Offset in milliseconds from the host system time. This allows for
3602 guests running with a different system date/time than the host.
3603 It is equivalent to setting the system date/time in the BIOS except
3604 it is not an absolute value but a relative one. Guest Additions
3605 time synchronization honors this offset.
3606 </desc>
3607 </attribute>
3608
3609 <attribute name="PXEDebugEnabled" type="boolean">
3610 <desc>
3611 PXE debug logging flag. If set, VirtualBox will write extensive
3612 PXE trace information to the release log.
3613 </desc>
3614 </attribute>
3615 </interface>
3616
3617 <enum
3618 name="CleanupMode"
3619 uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3620 >
3621 <desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3622 </desc>
3623 <const name="UnregisterOnly" value="1">
3624 <desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3625 </const>
3626 <const name="DetachAllReturnNone" value="2">
3627 <desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3628 </const>
3629 <const name="DetachAllReturnHardDisksOnly" value="3">
3630 <desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3631 </const>
3632 <const name="Full" value="4">
3633 <desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3634 </const>
3635 </enum>
3636
3637 <interface
3638 name="IPCIAddress" extends="$unknown"
3639 uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3640 wsmap="struct"
3641 >
3642
3643 <desc>
3644 Address on the PCI bus.
3645 </desc>
3646
3647 <attribute name="bus" type="short">
3648 <desc>
3649 Bus number.
3650 </desc>
3651 </attribute>
3652
3653 <attribute name="device" type="short">
3654 <desc>
3655 Device number.
3656 </desc>
3657 </attribute>
3658
3659 <attribute name="devFunction" type="short">
3660 <desc>
3661 Device function number.
3662 </desc>
3663 </attribute>
3664
3665 <method name="asLong">
3666 <desc>
3667 Convert PCI address into long.
3668 </desc>
3669 <param name="result" type="long" dir="return" />
3670 </method>
3671
3672 <method name="fromLong">
3673 <desc>
3674 Make PCI address from long.
3675 </desc>
3676 <param name="number" type="long" dir="in" />
3677 </method>
3678 </interface>
3679
3680 <interface
3681 name="IPCIDeviceAttachment" extends="$unknown"
3682 uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3683 wsmap="struct"
3684 >
3685
3686 <desc>
3687 Information about PCI attachments.
3688 </desc>
3689
3690 <attribute name="name" type="wstring" readonly="yes">
3691 <desc>
3692 Device name.
3693 </desc>
3694 </attribute>
3695
3696 <attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3697 <desc>
3698 If this is physical or virtual device.
3699 </desc>
3700 </attribute>
3701
3702 <attribute name="hostAddress" type="long" readonly="yes">
3703 <desc>
3704 Address of device on the host, applicable only to host devices.
3705 </desc>
3706 </attribute>
3707
3708 <attribute name="guestAddress" type="long" readonly="yes">
3709 <desc>
3710 Address of device on the guest.
3711 </desc>
3712 </attribute>
3713
3714 </interface>
3715
3716 <enum
3717 name="CloneMode" extends="$unknown"
3718 uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3719 >
3720
3721 <desc>
3722 Clone mode, used with <link to="IMachine::cloneTo" />.
3723 </desc>
3724
3725 <const name="MachineState" value="1">
3726 <desc>Clone the state of the selected machine.</desc>
3727 </const>
3728 <const name="MachineAndChildStates" value="2">
3729 <desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3730 </const>
3731 <const name="AllStates" value="3">
3732 <desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3733 </const>
3734
3735 </enum>
3736
3737 <enum
3738 name="CloneOptions" extends="$unknown"
3739 uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3740 >
3741
3742 <desc>
3743 Clone options, used with <link to="IMachine::cloneTo" />.
3744 </desc>
3745
3746 <const name="Link" value="1">
3747 <desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3748 </const>
3749 <const name="KeepAllMACs" value="2">
3750 <desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3751 </const>
3752 <const name="KeepNATMACs" value="3">
3753 <desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3754 </const>
3755 <const name="KeepDiskNames" value="4">
3756 <desc>Don't change the disk names.</desc>
3757 </const>
3758
3759 </enum>
3760
3761 <enum
3762 name="AutostopType" extends="$unknown"
3763 uuid="6bb96740-cf34-470d-aab2-2cd48ea2e10e"
3764 >
3765
3766 <desc>
3767 Autostop types, used with <link to="IMachine::autostopType" />.
3768 </desc>
3769
3770 <const name="Disabled" value="1">
3771 <desc>Stopping the VM during system shutdown is disabled.</desc>
3772 </const>
3773 <const name="SaveState" value="2">
3774 <desc>The state of the VM will be saved when the system shuts down.</desc>
3775 </const>
3776 <const name="PowerOff" value="3">
3777 <desc>The VM is powered off when the system shuts down.</desc>
3778 </const>
3779 <const name="AcpiShutdown" value="4">
3780 <desc>An ACPI shutdown event is generated.</desc>
3781 </const>
3782
3783 </enum>
3784
3785
3786 <interface
3787 name="IMachine" extends="$unknown"
3788 uuid="22781af3-1c96-4126-9edf-67a020e0e858"
3789 wsmap="managed"
3790 >
3791 <desc>
3792 The IMachine interface represents a virtual machine, or guest, created
3793 in VirtualBox.
3794
3795 This interface is used in two contexts. First of all, a collection of
3796 objects implementing this interface is stored in the
3797 <link to="IVirtualBox::machines"/> attribute which lists all the virtual
3798 machines that are currently registered with this VirtualBox
3799 installation. Also, once a session has been opened for the given virtual
3800 machine (e.g. the virtual machine is running), the machine object
3801 associated with the open session can be queried from the session object;
3802 see <link to="ISession"/> for details.
3803
3804 The main role of this interface is to expose the settings of the virtual
3805 machine and provide methods to change various aspects of the virtual
3806 machine's configuration. For machine objects stored in the
3807 <link to="IVirtualBox::machines"/> collection, all attributes are
3808 read-only unless explicitly stated otherwise in individual attribute
3809 and method descriptions.
3810
3811 In order to change a machine setting, a session for this machine must be
3812 opened using one of the <link to="IMachine::lockMachine" /> or
3813 <link to="IMachine::launchVMProcess"/> methods. After the
3814 machine has been successfully locked for a session, a mutable machine object
3815 needs to be queried from the session object and then the desired settings
3816 changes can be applied to the returned object using IMachine attributes and
3817 methods. See the <link to="ISession"/> interface description for more
3818 information about sessions.
3819
3820 Note that IMachine does not provide methods to control virtual machine
3821 execution (such as start the machine, or power it down) -- these methods
3822 are grouped in a separate interface called <link to="IConsole" />.
3823
3824 <see><link to="ISession"/>, <link to="IConsole"/></see>
3825 </desc>
3826
3827 <attribute name="parent" type="IVirtualBox" readonly="yes">
3828 <desc>Associated parent object.</desc>
3829 </attribute>
3830
3831 <attribute name="accessible" type="boolean" readonly="yes">
3832 <desc>
3833 Whether this virtual machine is currently accessible or not.
3834
3835 A machine is always deemed accessible unless it is registered <i>and</i>
3836 its settings file cannot be read or parsed (either because the file itself
3837 is unavailable or has invalid XML contents).
3838
3839 Every time this property is read, the accessibility state of
3840 this machine is re-evaluated. If the returned value is @c false,
3841 the <link to="#accessError"/> property may be used to get the
3842 detailed error information describing the reason of
3843 inaccessibility, including XML error messages.
3844
3845 When the machine is inaccessible, only the following properties
3846 can be used on it:
3847 <ul>
3848 <li><link to="#parent"/></li>
3849 <li><link to="#id"/></li>
3850 <li><link to="#settingsFilePath"/></li>
3851 <li><link to="#accessible"/></li>
3852 <li><link to="#accessError"/></li>
3853 </ul>
3854
3855 An attempt to access any other property or method will return
3856 an error.
3857
3858 The only possible action you can perform on an inaccessible
3859 machine is to unregister it using the
3860 <link to="IMachine::unregister"/> call (or, to check
3861 for the accessibility state once more by querying this
3862 property).
3863
3864 <note>
3865 In the current implementation, once this property returns
3866 @c true, the machine will never become inaccessible
3867 later, even if its settings file cannot be successfully
3868 read/written any more (at least, until the VirtualBox
3869 server is restarted). This limitation may be removed in
3870 future releases.
3871 </note>
3872 </desc>
3873 </attribute>
3874
3875 <attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3876 <desc>
3877 Error information describing the reason of machine
3878 inaccessibility.
3879
3880 Reading this property is only valid after the last call to
3881 <link to="#accessible"/> returned @c false (i.e. the
3882 machine is currently inaccessible). Otherwise, a @c null
3883 IVirtualBoxErrorInfo object will be returned.
3884 </desc>
3885 </attribute>
3886
3887 <attribute name="name" type="wstring">
3888 <desc>
3889 Name of the virtual machine.
3890
3891 Besides being used for human-readable identification purposes
3892 everywhere in VirtualBox, the virtual machine name is also used
3893 as a name of the machine's settings file and as a name of the
3894 subdirectory this settings file resides in. Thus, every time you
3895 change the value of this property, the settings file will be
3896 renamed once you call <link to="#saveSettings"/> to confirm the
3897 change. The containing subdirectory will be also renamed, but
3898 only if it has exactly the same name as the settings file
3899 itself prior to changing this property (for backward compatibility
3900 with previous API releases). The above implies the following
3901 limitations:
3902 <ul>
3903 <li>The machine name cannot be empty.</li>
3904 <li>The machine name can contain only characters that are valid
3905 file name characters according to the rules of the file
3906 system used to store VirtualBox configuration.</li>
3907 <li>You cannot have two or more machines with the same name
3908 if they use the same subdirectory for storing the machine
3909 settings files.</li>
3910 <li>You cannot change the name of the machine if it is running,
3911 or if any file in the directory containing the settings file
3912 is being used by another running machine or by any other
3913 process in the host operating system at a time when
3914 <link to="#saveSettings"/> is called.
3915 </li>
3916 </ul>
3917 If any of the above limitations are hit, <link to="#saveSettings"/>
3918 will return an appropriate error message explaining the exact
3919 reason and the changes you made to this machine will not be saved.
3920
3921 Starting with VirtualBox 4.0, a ".vbox" extension of the settings
3922 file is recommended, but not enforced. (Previous versions always
3923 used a generic ".xml" extension.)
3924 </desc>
3925 </attribute>
3926
3927 <attribute name="description" type="wstring">
3928 <desc>
3929 Description of the virtual machine.
3930
3931 The description attribute can contain any text and is
3932 typically used to describe the hardware and software
3933 configuration of the virtual machine in detail (i.e. network
3934 settings, versions of the installed software and so on).
3935 </desc>
3936 </attribute>
3937
3938 <attribute name="id" type="uuid" mod="string" readonly="yes">
3939 <desc>UUID of the virtual machine.</desc>
3940 </attribute>
3941
3942 <attribute name="groups" type="wstring" safearray="yes">
3943 <desc>
3944 Array of machine group names of which this machine is a member.
3945 <tt>""</tt> and <tt>"/"</tt> are synonyms for the toplevel group. Each
3946 group is only listed once, however they are listed in no particular
3947 order and there is no guarantee that there are no gaps in the group
3948 hierarchy (i.e. <tt>"/group"</tt>,
3949 <tt>"/group/subgroup/subsubgroup"</tt> is a valid result).
3950 </desc>
3951 </attribute>
3952
3953 <attribute name="OSTypeId" type="wstring">
3954 <desc>
3955 User-defined identifier of the Guest OS type.
3956 You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3957 an IGuestOSType object representing details about the given
3958 Guest OS type.
3959 <note>
3960 This value may differ from the value returned by
3961 <link to="IGuest::OSTypeId"/> if Guest Additions are
3962 installed to the guest OS.
3963 </note>
3964 </desc>
3965 </attribute>
3966
3967 <attribute name="hardwareVersion" type="wstring">
3968 <desc>Hardware version identifier. Internal use only for now.</desc>
3969 </attribute>
3970
3971 <attribute name="hardwareUUID" type="uuid" mod="string">
3972 <desc>
3973 The UUID presented to the guest via memory tables, hardware and guest
3974 properties. For most VMs this is the same as the @a id, but for VMs
3975 which have been cloned or teleported it may be the same as the source
3976 VM. The latter is because the guest shouldn't notice that it was
3977 cloned or teleported.
3978 </desc>
3979 </attribute>
3980
3981 <attribute name="CPUCount" type="unsigned long">
3982 <desc>Number of virtual CPUs in the VM.</desc>
3983 </attribute>
3984
3985 <attribute name="CPUHotPlugEnabled" type="boolean">
3986 <desc>
3987 This setting determines whether VirtualBox allows CPU
3988 hotplugging for this machine.</desc>
3989 </attribute>
3990
3991 <attribute name="CPUExecutionCap" type="unsigned long">
3992 <desc>
3993 Means to limit the number of CPU cycles a guest can use. The unit
3994 is percentage of host CPU cycles per second. The valid range
3995 is 1 - 100. 100 (the default) implies no limit.
3996 </desc>
3997 </attribute>
3998
3999 <attribute name="memorySize" type="unsigned long">
4000 <desc>System memory size in megabytes.</desc>
4001 </attribute>
4002
4003 <attribute name="memoryBalloonSize" type="unsigned long">
4004 <desc>Memory balloon size in megabytes.</desc>
4005 </attribute>
4006
4007 <attribute name="pageFusionEnabled" type="boolean">
4008 <desc>
4009 This setting determines whether VirtualBox allows page
4010 fusion for this machine (64 bits host only).
4011 </desc>
4012 </attribute>
4013
4014 <attribute name="VRAMSize" type="unsigned long">
4015 <desc>Video memory size in megabytes.</desc>
4016 </attribute>
4017
4018 <attribute name="accelerate3DEnabled" type="boolean" default="false">
4019 <desc>
4020 This setting determines whether VirtualBox allows this machine to make
4021 use of the 3D graphics support available on the host.</desc>
4022 </attribute>
4023
4024 <attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4025 <desc>
4026 This setting determines whether VirtualBox allows this machine to make
4027 use of the 2D video acceleration support available on the host.</desc>
4028 </attribute>
4029
4030 <attribute name="monitorCount" type="unsigned long">
4031 <desc>
4032 Number of virtual monitors.
4033 <note>
4034 Only effective on Windows XP and later guests with
4035 Guest Additions installed.
4036 </note>
4037 </desc>
4038 </attribute>
4039
4040 <attribute name="VideoCaptureEnabled" type="boolean" default="false">
4041 <desc>
4042 This setting determines whether VirtualBox uses video recording to
4043 record VM session.</desc>
4044 </attribute>
4045
4046 <attribute name="VideoCaptureFile" type="wstring" default="Test.webm">
4047 <desc>
4048 This setting determines what filename VirtualBox uses to save
4049 the recorded content.</desc>
4050 </attribute>
4051
4052 <attribute name="VideoCaptureWidth" type="unsigned long" default="640">
4053 <desc>
4054 This setting determines what should be the horizontal resolution of
4055 recorded video.</desc>
4056 </attribute>
4057
4058 <attribute name="VideoCaptureHeight" type="unsigned long" default="480">
4059 <desc>
4060 This setting determines what should be the vertical resolution
4061 of recorded video.</desc>
4062 </attribute>
4063
4064 <attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4065 <desc>Object containing all BIOS settings.</desc>
4066 </attribute>
4067
4068 <attribute name="firmwareType" type="FirmwareType">
4069 <desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4070 bootstrap in this VM.</desc>
4071 </attribute>
4072
4073 <attribute name="pointingHIDType" type="PointingHIDType">
4074 <desc>Type of pointing HID (such as mouse or tablet) used in this VM.
4075 The default is typically "PS2Mouse" but can vary depending on the
4076 requirements of the guest operating system.</desc>
4077 </attribute>
4078
4079 <attribute name="keyboardHIDType" type="KeyboardHIDType">
4080 <desc>Type of keyboard HID used in this VM.
4081 The default is typically "PS2Keyboard" but can vary depending on the
4082 requirements of the guest operating system.</desc>
4083 </attribute>
4084
4085 <attribute name="HPETEnabled" type="boolean">
4086 <desc>This attribute controls if High Precision Event Timer (HPET) is
4087 enabled in this VM. Use this property if you want to provide guests
4088 with additional time source, or if guest requires HPET to function correctly.
4089 Default is false.</desc>
4090 </attribute>
4091
4092 <attribute name="chipsetType" type="ChipsetType">
4093 <desc>Chipset type used in this VM.</desc>
4094 </attribute>
4095
4096 <attribute name="snapshotFolder" type="wstring">
4097 <desc>
4098 Full path to the directory used to store snapshot data
4099 (differencing media and saved state files) of this machine.
4100
4101 The initial value of this property is
4102 <tt>&lt;</tt><link to="#settingsFilePath">
4103 path_to_settings_file</link><tt>&gt;/&lt;</tt>
4104 <link to="#id">machine_uuid</link>
4105 <tt>&gt;</tt>.
4106
4107 Currently, it is an error to try to change this property on
4108 a machine that has snapshots (because this would require to
4109 move possibly large files to a different location).
4110 A separate method will be available for this purpose later.
4111
4112 <note>
4113 Setting this property to @c null or to an empty string will restore
4114 the initial value.
4115 </note>
4116 <note>
4117 When setting this property, the specified path can be
4118 absolute (full path) or relative to the directory where the
4119 <link to="#settingsFilePath">machine settings file</link>
4120 is located. When reading this property, a full path is
4121 always returned.
4122 </note>
4123 <note>
4124 The specified path may not exist, it will be created
4125 when necessary.
4126 </note>
4127 </desc>
4128 </attribute>
4129
4130 <attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
4131 <desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
4132 </attribute>
4133
4134 <attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
4135 <attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
4136
4137 <attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4138 <desc>Array of media attached to this machine.</desc>
4139 </attribute>
4140
4141 <attribute name="USBController" type="IUSBController" readonly="yes">
4142 <desc>
4143 Associated USB controller object.
4144
4145 <note>
4146 If USB functionality is not available in the given edition of
4147 VirtualBox, this method will set the result code to @c E_NOTIMPL.
4148 </note>
4149 </desc>
4150 </attribute>
4151
4152 <attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4153 <desc>Associated audio adapter, always present.</desc>
4154 </attribute>
4155
4156 <attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4157 <desc>Array of storage controllers attached to this machine.</desc>
4158 </attribute>
4159
4160 <attribute name="settingsFilePath" type="wstring" readonly="yes">
4161 <desc>
4162 Full name of the file containing machine settings data.
4163 </desc>
4164 </attribute>
4165
4166 <attribute name="settingsModified" type="boolean" readonly="yes">
4167 <desc>
4168 Whether the settings of this machine have been modified
4169 (but neither yet saved nor discarded).
4170 <note>
4171 Reading this property is only valid on instances returned
4172 by <link to="ISession::machine"/> and on new machines
4173 created by <link to="IVirtualBox::createMachine"/> or opened
4174 by <link to="IVirtualBox::openMachine"/> but not
4175 yet registered, or on unregistered machines after calling
4176 <link to="IMachine::unregister"/>. For all other
4177 cases, the settings can never be modified.
4178 </note>
4179 <note>
4180 For newly created unregistered machines, the value of this
4181 property is always @c true until <link to="#saveSettings"/>
4182 is called (no matter if any machine settings have been
4183 changed after the creation or not). For opened machines
4184 the value is set to @c false (and then follows to normal rules).
4185 </note>
4186 </desc>
4187 </attribute>
4188
4189 <attribute name="sessionState" type="SessionState" readonly="yes">
4190 <desc>Current session state for this machine.</desc>
4191 </attribute>
4192
4193 <attribute name="sessionType" type="wstring" readonly="yes">
4194 <desc>
4195 Type of the session. If <link to="#sessionState"/> is
4196 Spawning or Locked, this attribute contains the
4197 same value as passed to the
4198 <link to="IMachine::launchVMProcess"/> method in the
4199 @a type parameter. If the session was used with
4200 <link to="IMachine::lockMachine" />, or if
4201 <link to="#sessionState"/> is SessionClosed, the value of this
4202 attribute is an empty string.
4203 </desc>
4204 </attribute>
4205
4206 <attribute name="sessionPID" type="unsigned long" readonly="yes">
4207 <desc>
4208 Identifier of the session process. This attribute contains the
4209 platform-dependent identifier of the process whose session was
4210 used with <link to="IMachine::lockMachine" /> call. The returned
4211 value is only valid if <link to="#sessionState"/> is Locked or
4212 Unlocking by the time this property is read.
4213 </desc>
4214 </attribute>
4215
4216 <attribute name="state" type="MachineState" readonly="yes">
4217 <desc>Current execution state of this machine.</desc>
4218 </attribute>
4219
4220 <attribute name="lastStateChange" type="long long" readonly="yes">
4221 <desc>
4222 Time stamp of the last execution state change,
4223 in milliseconds since 1970-01-01 UTC.
4224 </desc>
4225 </attribute>
4226
4227 <attribute name="stateFilePath" type="wstring" readonly="yes">
4228 <desc>
4229 Full path to the file that stores the execution state of
4230 the machine when it is in the <link to="MachineState_Saved"/> state.
4231 <note>
4232 When the machine is not in the Saved state, this attribute is
4233 an empty string.
4234 </note>
4235 </desc>
4236 </attribute>
4237
4238 <attribute name="logFolder" type="wstring" readonly="yes">
4239 <desc>
4240 Full path to the folder that stores a set of rotated log files
4241 recorded during machine execution. The most recent log file is
4242 named <tt>VBox.log</tt>, the previous log file is
4243 named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4244 in the current version).
4245 </desc>
4246 </attribute>
4247
4248 <attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4249 <desc>
4250 Current snapshot of this machine. This is @c null if the machine
4251 currently has no snapshots. If it is not @c null, then it was
4252 set by one of <link to="IConsole::takeSnapshot" />,
4253 <link to="IConsole::deleteSnapshot" />
4254 or <link to="IConsole::restoreSnapshot" />, depending on which
4255 was called last. See <link to="ISnapshot"/> for details.
4256 </desc>
4257 </attribute>
4258
4259 <attribute name="snapshotCount" type="unsigned long" readonly="yes">
4260 <desc>
4261 Number of snapshots taken on this machine. Zero means the
4262 machine doesn't have any snapshots.
4263 </desc>
4264 </attribute>
4265
4266 <attribute name="currentStateModified" type="boolean" readonly="yes">
4267 <desc>
4268 Returns @c true if the current state of the machine is not
4269 identical to the state stored in the current snapshot.
4270
4271 The current state is identical to the current snapshot only
4272 directly after one of the following calls are made:
4273
4274 <ul>
4275 <li><link to="IConsole::restoreSnapshot"/>
4276 </li>
4277 <li><link to="IConsole::takeSnapshot"/> (issued on a
4278 "powered off" or "saved" machine, for which
4279 <link to="#settingsModified"/> returns @c false)
4280 </li>
4281 </ul>
4282
4283 The current state remains identical until one of the following
4284 happens:
4285 <ul>
4286 <li>settings of the machine are changed</li>
4287 <li>the saved state is deleted</li>
4288 <li>the current snapshot is deleted</li>
4289 <li>an attempt to execute the machine is made</li>
4290 </ul>
4291
4292 <note>
4293 For machines that don't have snapshots, this property is
4294 always @c false.
4295 </note>
4296 </desc>
4297 </attribute>
4298
4299 <attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4300 <desc>
4301 Collection of shared folders for this machine (permanent shared
4302 folders). These folders are shared automatically at machine startup
4303 and available only to the guest OS installed within this machine.
4304
4305 New shared folders are added to the collection using
4306 <link to="#createSharedFolder"/>. Existing shared folders can be
4307 removed using <link to="#removeSharedFolder"/>.
4308 </desc>
4309 </attribute>
4310
4311 <attribute name="clipboardMode" type="ClipboardMode">
4312 <desc>
4313 Synchronization mode between the host OS clipboard
4314 and the guest OS clipboard.
4315 </desc>
4316 </attribute>
4317
4318 <attribute name="dragAndDropMode" type="DragAndDropMode">
4319 <desc>
4320 Which mode is allowed for drag'n'drop.
4321 </desc>
4322 </attribute>
4323
4324 <attribute name="guestPropertyNotificationPatterns" type="wstring">
4325 <desc>
4326 A comma-separated list of simple glob patterns. Changes to guest
4327 properties whose name matches one of the patterns will generate an
4328 <link to="IGuestPropertyChangedEvent"/> signal.
4329 </desc>
4330 </attribute>
4331
4332 <attribute name="teleporterEnabled" type="boolean">
4333 <desc>
4334 When set to @a true, the virtual machine becomes a target teleporter
4335 the next time it is powered on. This can only set to @a true when the
4336 VM is in the @a PoweredOff or @a Aborted state.
4337
4338 <!-- This property is automatically set to @a false when the VM is powered
4339 on. (bird: This doesn't work yet ) -->
4340 </desc>
4341 </attribute>
4342
4343 <attribute name="teleporterPort" type="unsigned long">
4344 <desc>
4345 The TCP port the target teleporter will listen for incoming
4346 teleportations on.
4347
4348 0 means the port is automatically selected upon power on. The actual
4349 value can be read from this property while the machine is waiting for
4350 incoming teleportations.
4351 </desc>
4352 </attribute>
4353
4354 <attribute name="teleporterAddress" type="wstring">
4355 <desc>
4356 The address the target teleporter will listen on. If set to an empty
4357 string, it will listen on all addresses.
4358 </desc>
4359 </attribute>
4360
4361 <attribute name="teleporterPassword" type="wstring">
4362 <desc>
4363 The password to check for on the target teleporter. This is just a
4364 very basic measure to prevent simple hacks and operators accidentally
4365 beaming a virtual machine to the wrong place.
4366
4367 Note that you SET a plain text password while reading back a HASHED
4368 password. Setting a hashed password is currently not supported.
4369 </desc>
4370 </attribute>
4371
4372 <attribute name="faultToleranceState" type="FaultToleranceState">
4373 <desc>
4374 Fault tolerance state; disabled, source or target.
4375 This property can be changed at any time. If you change it for a running
4376 VM, then the fault tolerance address and port must be set beforehand.
4377 </desc>
4378 </attribute>
4379
4380 <attribute name="faultTolerancePort" type="unsigned long">
4381 <desc>
4382 The TCP port the fault tolerance source or target will use for
4383 communication.
4384 </desc>
4385 </attribute>
4386
4387 <attribute name="faultToleranceAddress" type="wstring">
4388 <desc>
4389 The address the fault tolerance source or target.
4390 </desc>
4391 </attribute>
4392
4393 <attribute name="faultTolerancePassword" type="wstring">
4394 <desc>
4395 The password to check for on the standby VM. This is just a
4396 very basic measure to prevent simple hacks and operators accidentally
4397 choosing the wrong standby VM.
4398 </desc>
4399 </attribute>
4400
4401 <attribute name="faultToleranceSyncInterval" type="unsigned long">
4402 <desc>
4403 The interval in ms used for syncing the state between source and target.
4404 </desc>
4405 </attribute>
4406
4407 <attribute name="RTCUseUTC" type="boolean">
4408 <desc>
4409 When set to @a true, the RTC device of the virtual machine will run
4410 in UTC time, otherwise in local time. Especially Unix guests prefer
4411 the time in UTC.
4412 </desc>
4413 </attribute>
4414
4415 <attribute name="IOCacheEnabled" type="boolean">
4416 <desc>
4417 When set to @a true, the builtin I/O cache of the virtual machine
4418 will be enabled.
4419 </desc>
4420 </attribute>
4421
4422 <attribute name="IOCacheSize" type="unsigned long">
4423 <desc>
4424 Maximum size of the I/O cache in MB.
4425 </desc>
4426 </attribute>
4427
4428 <attribute name="PCIDeviceAssignments" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
4429 <desc>Array of PCI devices assigned to this machine, to get list of all
4430 PCI devices attached to the machine use
4431 <link to="IConsole::attachedPCIDevices"/> attribute, as this attribute
4432 is intended to list only devices additional to what described in
4433 virtual hardware config. Usually, this list keeps host's physical
4434 devices assigned to the particular machine.
4435 </desc>
4436 </attribute>
4437
4438 <attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4439 <desc>
4440 Bandwidth control manager.
4441 </desc>
4442 </attribute>
4443
4444 <attribute name="tracingEnabled" type="boolean">
4445 <desc>
4446 Enables the tracing facility in the VMM (including PDM devices +
4447 drivers). The VMM will consume about 0.5MB of more memory when
4448 enabled and there may be some extra overhead from tracepoints that are
4449 always enabled.
4450 </desc>
4451 </attribute>
4452
4453 <attribute name="tracingConfig" type="wstring">
4454 <desc>
4455 Tracepoint configuration to apply at startup when
4456 <link to="IMachine::tracingEnabled" /> is true. The string specifies
4457 a space separated of tracepoint group names to enable. The special
4458 group 'all' enables all tracepoints. Check DBGFR3TracingConfig for
4459 more details on available tracepoint groups and such.
4460
4461 Note that on hosts supporting DTrace (or similar), a lot of the
4462 tracepoints may be implemented exclusivly as DTrace probes. So, the
4463 effect of the same config may differ between Solaris and Windows for
4464 example.
4465 </desc>
4466 </attribute>
4467
4468 <attribute name="allowTracingToAccessVM" type="boolean">
4469 <desc>
4470 Enables tracepoints in PDM devices and drivers to use the VMCPU or VM
4471 structures when firing off trace points. This is especially useful
4472 with DTrace tracepoints, as it allows you to use the VMCPU or VM
4473 pointer to obtain useful information such as guest register state.
4474
4475 This is disabled by default because devices and drivers normally has no
4476 business accessing the VMCPU or VM structures, and are therefore unable
4477 to get any pointers to these.
4478 </desc>
4479 </attribute>
4480
4481 <attribute name="autostartEnabled" type="boolean">
4482 <desc>
4483 Enables autostart of the VM during system boot.
4484 </desc>
4485 </attribute>
4486
4487 <attribute name="autostartDelay" type="unsigned long">
4488 <desc>
4489 Number of seconds to wait until the VM should be started during system boot.
4490 </desc>
4491 </attribute>
4492
4493 <attribute name="autostopType" type="AutostopType">
4494 <desc>
4495 Action type to do when the system is shutting down.
4496 </desc>
4497 </attribute>
4498
4499 <method name="lockMachine">
4500 <desc>
4501 Locks the machine for the given session to enable the caller
4502 to make changes to the machine or start the VM or control
4503 VM execution.
4504
4505 There are two ways to lock a machine for such uses:
4506
4507 <ul>
4508 <li>If you want to make changes to the machine settings,
4509 you must obtain an exclusive write lock on the machine
4510 by setting @a lockType to @c Write.
4511
4512 This will only succeed if no other process has locked
4513 the machine to prevent conflicting changes. Only after
4514 an exclusive write lock has been obtained using this method, one
4515 can change all VM settings or execute the VM in the process
4516 space of the session object. (Note that the latter is only of
4517 interest if you actually want to write a new front-end for
4518 virtual machines; but this API gets called internally by
4519 the existing front-ends such as VBoxHeadless and the VirtualBox
4520 GUI to acquire a write lock on the machine that they are running.)
4521
4522 On success, write-locking the machine for a session creates
4523 a second copy of the IMachine object. It is this second object
4524 upon which changes can be made; in VirtualBox terminology, the
4525 second copy is "mutable". It is only this second, mutable machine
4526 object upon which you can call methods that change the
4527 machine state. After having called this method, you can
4528 obtain this second, mutable machine object using the
4529 <link to="ISession::machine" /> attribute.
4530 </li>
4531 <li>If you only want to check the machine state or control
4532 machine execution without actually changing machine
4533 settings (e.g. to get access to VM statistics or take
4534 a snapshot or save the machine state), then set the
4535 @a lockType argument to @c Shared.
4536
4537 If no other session has obtained a lock, you will obtain an
4538 exclusive write lock as described above. However, if another
4539 session has already obtained such a lock, then a link to that
4540 existing session will be established which allows you
4541 to control that existing session.
4542
4543 To find out which type of lock was obtained, you can
4544 inspect <link to="ISession::type" />, which will have been
4545 set to either @c WriteLock or @c Shared.
4546 </li>
4547 </ul>
4548
4549 In either case, you can get access to the <link to="IConsole" />
4550 object which controls VM execution.
4551
4552 Also in all of the above cases, one must always call
4553 <link to="ISession::unlockMachine" /> to release the lock on the machine, or
4554 the machine's state will eventually be set to "Aborted".
4555
4556 To change settings on a machine, the following sequence is typically
4557 performed:
4558
4559 <ol>
4560 <li>Call this method to obtain an exclusive write lock for the current session.</li>
4561
4562 <li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4563
4564 <li>Change the settings of the machine by invoking IMachine methods.</li>
4565
4566 <li>Call <link to="IMachine::saveSettings" />.</li>
4567
4568 <li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4569 </ol>
4570
4571 <result name="E_UNEXPECTED">
4572 Virtual machine not registered.
4573 </result>
4574 <result name="E_ACCESSDENIED">
4575 Process not started by OpenRemoteSession.
4576 </result>
4577 <result name="VBOX_E_INVALID_OBJECT_STATE">
4578 Session already open or being opened.
4579 </result>
4580 <result name="VBOX_E_VM_ERROR">
4581 Failed to assign machine to session.
4582 </result>
4583 </desc>
4584 <param name="session" type="ISession" dir="in">
4585 <desc>
4586 Session object for which the machine will be locked.
4587 </desc>
4588 </param>
4589 <param name="lockType" type="LockType" dir="in">
4590 <desc>
4591 If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4592 If set to @c Shared, then either acquire an exclusive write lock or establish
4593 a link to an existing session.
4594 </desc>
4595 </param>
4596 </method>
4597
4598 <method name="launchVMProcess">
4599 <desc>
4600 Spawns a new process that will execute the virtual machine and obtains a shared
4601 lock on the machine for the calling session.
4602
4603 If launching the VM succeeds, the new VM process will create its own session
4604 and write-lock the machine for it, preventing conflicting changes from other
4605 processes. If the machine is already locked (because it is already running or
4606 because another session has a write lock), launching the VM process will therefore
4607 fail. Reversely, future attempts to obtain a write lock will also fail while the
4608 machine is running.
4609
4610 The caller's session object remains separate from the session opened by the new
4611 VM process. It receives its own <link to="IConsole" /> object which can be used
4612 to control machine execution, but it cannot be used to change all VM settings
4613 which would be available after a <link to="#lockMachine" /> call.
4614
4615 The caller must eventually release the session's shared lock by calling
4616 <link to="ISession::unlockMachine" /> on the local session object once this call
4617 has returned. However, the session's state (see <link to="ISession::state" />)
4618 will not return to "Unlocked" until the remote session has also unlocked
4619 the machine (i.e. the machine has stopped running).
4620
4621 Launching a VM process can take some time (a new VM is started in a new process,
4622 for which memory and other resources need to be set up). Because of this,
4623 an <link to="IProgress" /> object is returned to allow the caller to wait
4624 for this asynchronous operation to be completed. Until then, the caller's
4625 session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4626 and <link to="ISession::console" /> attributes cannot be accessed.
4627 It is recommended to use <link to="IProgress::waitForCompletion" /> or
4628 similar calls to wait for completion. Completion is signalled when the VM
4629 is powered on. If launching the VM fails, error messages can be queried
4630 via the progress object, if available.
4631
4632 The progress object will have at least 2 sub-operations. The first
4633 operation covers the period up to the new VM process calls powerUp.
4634 The subsequent operations mirror the <link to="IConsole::powerUp"/>
4635 progress object. Because <link to="IConsole::powerUp"/> may require
4636 some extra sub-operations, the <link to="IProgress::operationCount"/>
4637 may change at the completion of operation.
4638
4639 For details on the teleportation progress operation, see
4640 <link to="IConsole::powerUp"/>.
4641
4642 The @a environment argument is a string containing definitions of
4643 environment variables in the following format:
4644 <pre>
4645 NAME[=VALUE]\n
4646 NAME[=VALUE]\n
4647 ...
4648 </pre>
4649 where <tt>\\n</tt> is the new line character. These environment
4650 variables will be appended to the environment of the VirtualBox server
4651 process. If an environment variable exists both in the server process
4652 and in this list, the value from this list takes precedence over the
4653 server's variable. If the value of the environment variable is
4654 omitted, this variable will be removed from the resulting environment.
4655 If the environment string is @c null or empty, the server environment
4656 is inherited by the started process as is.
4657
4658 <result name="E_UNEXPECTED">
4659 Virtual machine not registered.
4660 </result>
4661 <result name="E_INVALIDARG">
4662 Invalid session type @a type.
4663 </result>
4664 <result name="VBOX_E_OBJECT_NOT_FOUND">
4665 No machine matching @a machineId found.
4666 </result>
4667 <result name="VBOX_E_INVALID_OBJECT_STATE">
4668 Session already open or being opened.
4669 </result>
4670 <result name="VBOX_E_IPRT_ERROR">
4671 Launching process for machine failed.
4672 </result>
4673 <result name="VBOX_E_VM_ERROR">
4674 Failed to assign machine to session.
4675 </result>
4676 </desc>
4677 <param name="session" type="ISession" dir="in">
4678 <desc>
4679 Client session object to which the VM process will be connected (this
4680 must be in "Unlocked" state).
4681 </desc>
4682 </param>
4683 <param name="type" type="wstring" dir="in">
4684 <desc>
4685 Front-end to use for the new VM process. The following are currently supported:
4686 <ul>
4687 <li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4688 <li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4689 <li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4690 <li><tt>"emergencystop"</tt>: reserved value, used for aborting
4691 the currently running VM or session owner. In this case the
4692 @a session parameter may be @c null (if it is non-null it isn't
4693 used in any way), and the @a progress return value will be always
4694 @c null. The operation completes immediately.</li>
4695 </ul>
4696 </desc>
4697 </param>
4698 <param name="environment" type="wstring" dir="in">
4699 <desc>
4700 Environment to pass to the VM process.
4701 </desc>
4702 </param>
4703 <param name="progress" type="IProgress" dir="return">
4704 <desc>Progress object to track the operation completion.</desc>
4705 </param>
4706 </method>
4707
4708 <method name="setBootOrder">
4709 <desc>
4710 Puts the given device to the specified position in
4711 the boot order.
4712
4713 To indicate that no device is associated with the given position,
4714 <link to="DeviceType_Null"/> should be used.
4715
4716 @todo setHardDiskBootOrder(), setNetworkBootOrder()
4717
4718 <result name="E_INVALIDARG">
4719 Boot @a position out of range.
4720 </result>
4721 <result name="E_NOTIMPL">
4722 Booting from USB @a device currently not supported.
4723 </result>
4724
4725 </desc>
4726 <param name="position" type="unsigned long" dir="in">
4727 <desc>
4728 Position in the boot order (@c 1 to the total number of
4729 devices the machine can boot from, as returned by
4730 <link to="ISystemProperties::maxBootPosition"/>).
4731 </desc>
4732 </param>
4733 <param name="device" type="DeviceType" dir="in">
4734 <desc>
4735 The type of the device used to boot at the given position.
4736 </desc>
4737 </param>
4738 </method>
4739
4740 <method name="getBootOrder" const="yes">
4741 <desc>
4742 Returns the device type that occupies the specified
4743 position in the boot order.
4744
4745 @todo [remove?]
4746 If the machine can have more than one device of the returned type
4747 (such as hard disks), then a separate method should be used to
4748 retrieve the individual device that occupies the given position.
4749
4750 If here are no devices at the given position, then
4751 <link to="DeviceType_Null"/> is returned.
4752
4753 @todo getHardDiskBootOrder(), getNetworkBootOrder()
4754
4755 <result name="E_INVALIDARG">
4756 Boot @a position out of range.
4757 </result>
4758
4759 </desc>
4760 <param name="position" type="unsigned long" dir="in">
4761 <desc>
4762 Position in the boot order (@c 1 to the total number of
4763 devices the machine can boot from, as returned by
4764 <link to="ISystemProperties::maxBootPosition"/>).
4765 </desc>
4766 </param>
4767 <param name="device" type="DeviceType" dir="return">
4768 <desc>
4769 Device at the given position.
4770 </desc>
4771 </param>
4772 </method>
4773
4774 <method name="attachDevice">
4775 <desc>
4776 Attaches a device and optionally mounts a medium to the given storage
4777 controller (<link to="IStorageController" />, identified by @a name),
4778 at the indicated port and device.
4779
4780 This method is intended for managing storage devices in general while a
4781 machine is powered off. It can be used to attach and detach fixed
4782 and removable media. The following kind of media can be attached
4783 to a machine:
4784
4785 <ul>
4786 <li>For fixed and removable media, you can pass in a medium that was
4787 previously opened using <link to="IVirtualBox::openMedium" />.
4788 </li>
4789
4790 <li>Only for storage devices supporting removable media (such as
4791 DVDs and floppies), you can also specify a null pointer to
4792 indicate an empty drive or one of the medium objects listed
4793 in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4794 arrays to indicate a host drive.
4795 For removable devices, you can also use <link to="IMachine::mountMedium"/>
4796 to change the media while the machine is running.
4797 </li>
4798 </ul>
4799
4800 In a VM's default configuration of virtual machines, the secondary
4801 master of the IDE controller is used for a CD/DVD drive.
4802
4803 After calling this returns successfully, a new instance of
4804 <link to="IMediumAttachment"/> will appear in the machine's list of medium
4805 attachments (see <link to="IMachine::mediumAttachments"/>).
4806
4807 See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4808 information about attaching media.
4809
4810 The specified device slot must not have a device attached to it,
4811 or this method will fail.
4812
4813 <note>
4814 You cannot attach a device to a newly created machine until
4815 this machine's settings are saved to disk using
4816 <link to="#saveSettings"/>.
4817 </note>
4818 <note>
4819 If the medium is being attached indirectly, a new differencing medium
4820 will implicitly be created for it and attached instead. If the
4821 changes made to the machine settings (including this indirect
4822 attachment) are later cancelled using <link to="#discardSettings"/>,
4823 this implicitly created differencing medium will implicitly
4824 be deleted.
4825 </note>
4826
4827 <result name="E_INVALIDARG">
4828 SATA device, SATA port, IDE port or IDE slot out of range, or
4829 file or UUID not found.
4830 </result>
4831 <result name="VBOX_E_INVALID_OBJECT_STATE">
4832 Machine must be registered before media can be attached.
4833 </result>
4834 <result name="VBOX_E_INVALID_VM_STATE">
4835 Invalid machine state.
4836 </result>
4837 <result name="VBOX_E_OBJECT_IN_USE">
4838 A medium is already attached to this or another virtual machine.
4839 </result>
4840
4841 </desc>
4842 <param name="name" type="wstring" dir="in">
4843 <desc>Name of the storage controller to attach the device to.</desc>
4844 </param>
4845 <param name="controllerPort" type="long" dir="in">
4846 <desc>Port to attach the device to. For an IDE controller, 0 specifies
4847 the primary controller and 1 specifies the secondary controller.
4848 For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4849 from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4850 </param>
4851 <param name="device" type="long" dir="in">
4852 <desc>Device slot in the given port to attach the device to. This is only
4853 relevant for IDE controllers, for which 0 specifies the master device and
4854 1 specifies the slave device. For all other controller types, this must
4855 be 0.</desc>
4856 </param>
4857 <param name="type" type="DeviceType" dir="in">
4858 <desc>Device type of the attached device. For media opened by
4859 <link to="IVirtualBox::openMedium" />, this must match the device type
4860 specified there.</desc>
4861 </param>
4862 <param name="medium" type="IMedium" dir="in">
4863 <desc>Medium to mount or @c null for an empty drive.</desc>
4864 </param>
4865 </method>
4866
4867 <method name="attachDeviceWithoutMedium">
4868 <desc>
4869 Attaches a device and optionally mounts a medium to the given storage
4870 controller (<link to="IStorageController" />, identified by @a name),
4871 at the indicated port and device.
4872
4873 This method is intended for managing storage devices in general while a
4874 machine is powered off. It can be used to attach and detach fixed
4875 and removable media. The following kind of media can be attached
4876 to a machine:
4877 <ul>
4878 <li>
4879 For fixed and removable media, you can pass in a medium that was
4880 previously opened using <link to="IVirtualBox::openMedium" />.
4881 </li>
4882
4883 <li>Only for storage devices supporting removable media (such as
4884 DVDs and floppies) with an empty drive or one of the medium objects listed
4885 in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4886 arrays to indicate a host drive.
4887 For removable devices, you can also use <link to="IMachine::mountMedium"/>
4888 to change the media while the machine is running.
4889 </li>
4890 </ul>
4891
4892 In a VM's default configuration of virtual machines, the secondary
4893 master of the IDE controller is used for a CD/DVD drive.
4894 <link to="IMediumAttachment"/> will appear in the machine's list of medium
4895 attachments (see <link to="IMachine::mediumAttachments"/>).
4896
4897 See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4898 information about attaching media.
4899
4900 The specified device slot must not have a device attached to it,
4901 or this method will fail.
4902 <note>
4903 You cannot attach a device to a newly created machine until
4904 this machine's settings are saved to disk using
4905 <link to="#saveSettings"/>.
4906 </note>
4907 <note>
4908 If the medium is being attached indirectly, a new differencing medium
4909 will implicitly be created for it and attached instead. If the
4910 changes made to the machine settings (including this indirect
4911 attachment) are later cancelled using <link to="#discardSettings"/>,
4912 this implicitly created differencing medium will implicitly
4913 be deleted.
4914 </note>
4915
4916 <result name="E_INVALIDARG">
4917 SATA device, SATA port, IDE port or IDE slot out of range, or
4918 file or UUID not found.
4919 </result>
4920 <result name="VBOX_E_INVALID_OBJECT_STATE">
4921 Machine must be registered before media can be attached.
4922 </result>
4923 <result name="VBOX_E_INVALID_VM_STATE">
4924 Invalid machine state.
4925 </result>
4926 <result name="VBOX_E_OBJECT_IN_USE">
4927 A medium is already attached to this or another virtual machine.
4928 </result>
4929 </desc>
4930 <param name="name" type="wstring" dir="in">
4931 <desc>Name of the storage controller to attach the device to.</desc>
4932 </param>
4933 <param name="controllerPort" type="long" dir="in">
4934 <desc>Port to attach the device to. For an IDE controller, 0 specifies
4935 the primary controller and 1 specifies the secondary controller.
4936 For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4937 from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4938 </param>
4939 <param name="device" type="long" dir="in">
4940 <desc>Device slot in the given port to attach the device to. This is only
4941 relevant for IDE controllers, for which 0 specifies the master device and
4942 1 specifies the slave device. For all other controller types, this must
4943 be 0.</desc>
4944 </param>
4945 <param name="type" type="DeviceType" dir="in">
4946 <desc>Device type of the attached device. For media opened by
4947 <link to="IVirtualBox::openMedium" />, this must match the device type
4948 specified there.</desc>
4949 </param>
4950 </method>
4951
4952 <method name="detachDevice">
4953 <desc>
4954 Detaches the device attached to a device slot of the specified bus.
4955
4956 Detaching the device from the virtual machine is deferred. This means
4957 that the medium remains associated with the machine when this method
4958 returns and gets actually de-associated only after a successful
4959 <link to="#saveSettings"/> call. See <link to="IMedium"/>
4960 for more detailed information about attaching media.
4961
4962 <note>
4963 You cannot detach a device from a running machine.
4964 </note>
4965 <note>
4966 Detaching differencing media implicitly created by <link
4967 to="#attachDevice"/> for the indirect attachment using this
4968 method will <b>not</b> implicitly delete them. The
4969 <link to="IMedium::deleteStorage"/> operation should be
4970 explicitly performed by the caller after the medium is successfully
4971 detached and the settings are saved with
4972 <link to="#saveSettings"/>, if it is the desired action.
4973 </note>
4974
4975 <result name="VBOX_E_INVALID_VM_STATE">
4976 Attempt to detach medium from a running virtual machine.
4977 </result>
4978 <result name="VBOX_E_OBJECT_NOT_FOUND">
4979 No medium attached to given slot/bus.
4980 </result>
4981 <result name="VBOX_E_NOT_SUPPORTED">
4982 Medium format does not support storage deletion (only for implicitly
4983 created differencing media, should not happen).
4984 </result>
4985
4986 </desc>
4987 <param name="name" type="wstring" dir="in">
4988 <desc>Name of the storage controller to detach the medium from.</desc>
4989 </param>
4990 <param name="controllerPort" type="long" dir="in">
4991 <desc>Port number to detach the medium from.</desc>
4992 </param>
4993 <param name="device" type="long" dir="in">
4994 <desc>Device slot number to detach the medium from.</desc>
4995 </param>
4996 </method>
4997
4998 <method name="passthroughDevice">
4999 <desc>
5000 Sets the passthrough mode of an existing DVD device. Changing the
5001 setting while the VM is running is forbidden. The setting is only used
5002 if at VM start the device is configured as a host DVD drive, in all
5003 other cases it is ignored. The device must already exist; see
5004 <link to="IMachine::attachDevice"/> for how to attach a new device.
5005
5006 The @a controllerPort and @a device parameters specify the device slot and
5007 have have the same meaning as with <link to="IMachine::attachDevice" />.
5008
5009 <result name="E_INVALIDARG">
5010 SATA device, SATA port, IDE port or IDE slot out of range.
5011 </result>
5012 <result name="VBOX_E_INVALID_OBJECT_STATE">
5013 Attempt to modify an unregistered virtual machine.
5014 </result>
5015 <result name="VBOX_E_INVALID_VM_STATE">
5016 Invalid machine state.
5017 </result>
5018
5019 </desc>
5020 <param name="name" type="wstring" dir="in">
5021 <desc>Name of the storage controller.</desc>
5022 </param>
5023 <param name="controllerPort" type="long" dir="in">
5024 <desc>Storage controller port.</desc>
5025 </param>
5026 <param name="device" type="long" dir="in">
5027 <desc>Device slot in the given port.</desc>
5028 </param>
5029 <param name="passthrough" type="boolean" dir="in">
5030 <desc>New value for the passthrough setting.</desc>
5031 </param>
5032 </method>
5033
5034 <method name="temporaryEjectDevice">
5035 <desc>
5036 Sets the behavior for guest-triggered medium eject. In some situations
5037 it is desirable that such ejects update the VM configuration, and in
5038 others the eject should keep the VM configuration. The device must
5039 already exist; see <link to="IMachine::attachDevice"/> for how to
5040 attach a new device.
5041
5042 The @a controllerPort and @a device parameters specify the device slot and
5043 have have the same meaning as with <link to="IMachine::attachDevice" />.
5044
5045 <result name="E_INVALIDARG">
5046 SATA device, SATA port, IDE port or IDE slot out of range.
5047 </result>
5048 <result name="VBOX_E_INVALID_OBJECT_STATE">
5049 Attempt to modify an unregistered virtual machine.
5050 </result>
5051 <result name="VBOX_E_INVALID_VM_STATE">
5052 Invalid machine state.
5053 </result>
5054
5055 </desc>
5056 <param name="name" type="wstring" dir="in">
5057 <desc>Name of the storage controller.</desc>
5058 </param>
5059 <param name="controllerPort" type="long" dir="in">
5060 <desc>Storage controller port.</desc>
5061 </param>
5062 <param name="device" type="long" dir="in">
5063 <desc>Device slot in the given port.</desc>
5064 </param>
5065 <param name="temporaryEject" type="boolean" dir="in">
5066 <desc>New value for the eject behavior.</desc>
5067 </param>
5068 </method>
5069
5070 <method name="nonRotationalDevice">
5071 <desc>
5072 Sets a flag in the device information which indicates that the medium
5073 is not based on rotational technology, i.e. that the access times are
5074 more or less independent of the position on the medium. This may or may
5075 not be supported by a particular drive, and is silently ignored in the
5076 latter case. At the moment only hard disks (which is a misnomer in this
5077 context) accept this setting. Changing the setting while the VM is
5078 running is forbidden. The device must already exist; see
5079 <link to="IMachine::attachDevice"/> for how to attach a new device.
5080
5081 The @a controllerPort and @a device parameters specify the device slot and
5082 have have the same meaning as with <link to="IMachine::attachDevice" />.
5083
5084 <result name="E_INVALIDARG">
5085 SATA device, SATA port, IDE port or IDE slot out of range.
5086 </result>
5087 <result name="VBOX_E_INVALID_OBJECT_STATE">
5088 Attempt to modify an unregistered virtual machine.
5089 </result>
5090 <result name="VBOX_E_INVALID_VM_STATE">
5091 Invalid machine state.
5092 </result>
5093
5094 </desc>
5095 <param name="name" type="wstring" dir="in">
5096 <desc>Name of the storage controller.</desc>
5097 </param>
5098 <param name="controllerPort" type="long" dir="in">
5099 <desc>Storage controller port.</desc>
5100 </param>
5101 <param name="device" type="long" dir="in">
5102 <desc>Device slot in the given port.</desc>
5103 </param>
5104 <param name="nonRotational" type="boolean" dir="in">
5105 <desc>New value for the non-rotational device flag.</desc>
5106 </param>
5107 </method>
5108
5109 <method name="setAutoDiscardForDevice">
5110 <desc>
5111 Sets a flag in the device information which indicates that the medium
5112 supports discarding unsused blocks (called trimming for SATA or unmap
5113 for SCSI devices) .This may or may not be supported by a particular drive,
5114 and is silently ignored in the latter case. At the moment only hard disks
5115 (which is a misnomer in this context) accept this setting. Changing the
5116 setting while the VM is running is forbidden. The device must already
5117 exist; see <link to="IMachine::attachDevice"/> for how to attach a new
5118 device.
5119
5120 The @a controllerPort and @a device parameters specify the device slot and
5121 have have the same meaning as with <link to="IMachine::attachDevice" />.
5122
5123 <result name="E_INVALIDARG">
5124 SATA device, SATA port, SCSI port out of range.
5125 </result>
5126 <result name="VBOX_E_INVALID_OBJECT_STATE">
5127 Attempt to modify an unregistered virtual machine.
5128 </result>
5129 <result name="VBOX_E_INVALID_VM_STATE">
5130 Invalid machine state.
5131 </result>
5132
5133 </desc>
5134 <param name="name" type="wstring" dir="in">
5135 <desc>Name of the storage controller.</desc>
5136 </param>
5137 <param name="controllerPort" type="long" dir="in">
5138 <desc>Storage controller port.</desc>
5139 </param>
5140 <param name="device" type="long" dir="in">
5141 <desc>Device slot in the given port.</desc>
5142 </param>
5143 <param name="discard" type="boolean" dir="in">
5144 <desc>New value for the discard device flag.</desc>
5145 </param>
5146 </method>
5147
5148 <method name="setBandwidthGroupForDevice">
5149 <desc>
5150 Sets the bandwidth group of an existing storage device.
5151 The device must already exist; see <link to="IMachine::attachDevice"/>
5152 for how to attach a new device.
5153
5154 The @a controllerPort and @a device parameters specify the device slot and
5155 have have the same meaning as with <link to="IMachine::attachDevice" />.
5156
5157 <result name="E_INVALIDARG">
5158 SATA device, SATA port, IDE port or IDE slot out of range.
5159 </result>
5160 <result name="VBOX_E_INVALID_OBJECT_STATE">
5161 Attempt to modify an unregistered virtual machine.
5162 </result>
5163 <result name="VBOX_E_INVALID_VM_STATE">
5164 Invalid machine state.
5165 </result>
5166
5167 </desc>
5168 <param name="name" type="wstring" dir="in">
5169 <desc>Name of the storage controller.</desc>
5170 </param>
5171 <param name="controllerPort" type="long" dir="in">
5172 <desc>Storage controller port.</desc>
5173 </param>
5174 <param name="device" type="long" dir="in">
5175 <desc>Device slot in the given port.</desc>
5176 </param>
5177 <param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
5178 <desc>New value for the bandwidth group or @c null for no group.</desc>
5179 </param>
5180 </method>
5181
5182 <method name="setNoBandwidthGroupForDevice">
5183 <desc>
5184 Sets no bandwidth group for an existing storage device.
5185 The device must already exist; see <link to="IMachine::attachDevice"/>
5186 for how to attach a new device.
5187 The @a controllerPort and @a device parameters specify the device slot and
5188 have have the same meaning as with <link to="IMachine::attachDevice" />.
5189 <result name="E_INVALIDARG">
5190 SATA device, SATA port, IDE port or IDE slot out of range.
5191 </result>
5192 <result name="VBOX_E_INVALID_OBJECT_STATE">
5193 Attempt to modify an unregistered virtual machine.
5194 </result>
5195 <result name="VBOX_E_INVALID_VM_STATE">
5196 Invalid machine state.
5197 </result>
5198
5199 </desc>
5200 <param name="name" type="wstring" dir="in">
5201 <desc>Name of the storage controller.</desc>
5202 </param>
5203 <param name="controllerPort" type="long" dir="in">
5204 <desc>Storage controller port.</desc>
5205 </param>
5206 <param name="device" type="long" dir="in">
5207 <desc>Device slot in the given port.</desc>
5208 </param>
5209 </method>
5210
5211
5212 <method name="unmountMedium">
5213 <desc>
5214 Unmounts any currently mounted medium (<link to="IMedium" />,
5215 identified by the given UUID @a id) to the given storage controller
5216 (<link to="IStorageController" />, identified by @a name),
5217 at the indicated port and device. The device must already exist;
5218
5219 This method is intended only for managing removable media, where the
5220 device is fixed but media is changeable at runtime (such as DVDs
5221 and floppies). It cannot be used for fixed media such as hard disks.
5222
5223 The @a controllerPort and @a device parameters specify the device slot
5224 and have have the same meaning as with
5225 <link to="IMachine::attachDevice" />.
5226
5227 The specified device slot must have a medium mounted, which will be
5228 unmounted. If there is no mounted medium it will do nothing.
5229 See <link to="IMedium"/> for more detailed information about
5230 attaching/unmounting media.
5231
5232 <result name="E_INVALIDARG">
5233 SATA device, SATA port, IDE port or IDE slot out of range.
5234 </result>
5235 <result name="VBOX_E_INVALID_OBJECT_STATE">
5236 Attempt to unmount medium that is not removeable - not dvd or floppy.
5237 </result>
5238 <result name="VBOX_E_INVALID_VM_STATE">
5239 Invalid machine state.
5240 </result>
5241 <result name="VBOX_E_OBJECT_IN_USE">
5242 Medium already attached to this or another virtual machine.
5243 </result>
5244 <result name="VBOX_E_OBJECT_NOT_FOUND">
5245 Medium not attached to specified port, device, controller.
5246 </result>
5247
5248 </desc>
5249 <param name="name" type="wstring" dir="in">
5250 <desc>Name of the storage controller to unmount the medium from.</desc>
5251 </param>
5252 <param name="controllerPort" type="long" dir="in">
5253 <desc>Port to unmount the medium from.</desc>
5254 </param>
5255 <param name="device" type="long" dir="in">
5256 <desc>Device slot in the given port to unmount the medium from.</desc>
5257 </param>
5258 <param name="force" type="boolean" dir="in">
5259 <desc>Allows to force unmount of a medium which is locked by
5260 the device slot in the given port medium is attached to.</desc>
5261 </param>
5262 </method>
5263
5264 <method name="mountMedium">
5265 <desc>
5266 Mounts a medium (<link to="IMedium" />, identified
5267 by the given UUID @a id) to the given storage controller
5268 (<link to="IStorageController" />, identified by @a name),
5269 at the indicated port and device. The device must already exist;
5270 see <link to="IMachine::attachDevice"/> for how to attach a new device.
5271
5272 This method is intended only for managing removable media, where the
5273 device is fixed but media is changeable at runtime (such as DVDs
5274 and floppies). It cannot be used for fixed media such as hard disks.
5275
5276 The @a controllerPort and @a device parameters specify the device slot and
5277 have have the same meaning as with <link to="IMachine::attachDevice" />.
5278
5279 The specified device slot can have a medium mounted, which will be
5280 unmounted first. Specifying a zero UUID (or an empty string) for
5281 @a medium does just an unmount.
5282
5283 See <link to="IMedium"/> for more detailed information about
5284 attaching media.
5285
5286 <result name="E_INVALIDARG">
5287 SATA device, SATA port, IDE port or IDE slot out of range.
5288 </result>
5289 <result name="VBOX_E_INVALID_OBJECT_STATE">
5290 Attempt to attach medium to an unregistered virtual machine.
5291 </result>
5292 <result name="VBOX_E_INVALID_VM_STATE">
5293 Invalid machine state.
5294 </result>
5295 <result name="VBOX_E_OBJECT_IN_USE">
5296 Medium already attached to this or another virtual machine.
5297 </result>
5298
5299 </desc>
5300 <param name="name" type="wstring" dir="in">
5301 <desc>Name of the storage controller to attach the medium to.</desc>
5302 </param>
5303 <param name="controllerPort" type="long" dir="in">
5304 <desc>Port to attach the medium to.</desc>
5305 </param>
5306 <param name="device" type="long" dir="in">
5307 <desc>Device slot in the given port to attach the medium to.</desc>
5308 </param>
5309 <param name="medium" type="IMedium" dir="in">
5310 <desc>Medium to mount or @c null for an empty drive.</desc>
5311 </param>
5312 <param name="force" type="boolean" dir="in">
5313 <desc>Allows to force unmount/mount of a medium which is locked by
5314 the device slot in the given port to attach the medium to.</desc>
5315 </param>
5316 </method>
5317
5318 <method name="getMedium" const="yes">
5319 <desc>
5320 Returns the virtual medium attached to a device slot of the specified
5321 bus.
5322
5323 Note that if the medium was indirectly attached by
5324 <link to="#mountMedium"/> to the given device slot then this
5325 method will return not the same object as passed to the
5326 <link to="#mountMedium"/> call. See <link to="IMedium"/> for
5327 more detailed information about mounting a medium.
5328
5329 <result name="VBOX_E_OBJECT_NOT_FOUND">
5330 No medium attached to given slot/bus.
5331 </result>
5332
5333 </desc>
5334 <param name="name" type="wstring" dir="in">
5335 <desc>Name of the storage controller the medium is attached to.</desc>
5336 </param>
5337 <param name="controllerPort" type="long" dir="in">
5338 <desc>Port to query.</desc>
5339 </param>
5340 <param name="device" type="long" dir="in">
5341 <desc>Device slot in the given port to query.</desc>
5342 </param>
5343 <param name="medium" type="IMedium" dir="return">
5344 <desc>Attached medium object.</desc>
5345 </param>
5346 </method>
5347
5348 <method name="getMediumAttachmentsOfController" const="yes">
5349 <desc>
5350 Returns an array of medium attachments which are attached to the
5351 the controller with the given name.
5352
5353 <result name="VBOX_E_OBJECT_NOT_FOUND">
5354 A storage controller with given name doesn't exist.
5355 </result>
5356 </desc>
5357 <param name="name" type="wstring" dir="in"/>
5358 <param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5359 </method>
5360
5361 <method name="getMediumAttachment" const="yes">
5362 <desc>
5363 Returns a medium attachment which corresponds to the controller with
5364 the given name, on the given port and device slot.
5365
5366 <result name="VBOX_E_OBJECT_NOT_FOUND">
5367 No attachment exists for the given controller/port/device combination.
5368 </result>
5369 </desc>
5370 <param name="name" type="wstring" dir="in"/>
5371 <param name="controllerPort" type="long" dir="in"/>
5372 <param name="device" type="long" dir="in"/>
5373 <param name="attachment" type="IMediumAttachment" dir="return"/>
5374 </method>
5375
5376 <method name="attachHostPCIDevice">
5377 <desc>
5378 Attaches host PCI device with the given (host) PCI address to the
5379 PCI bus of the virtual machine. Please note, that this operation
5380 is two phase, as real attachment will happen when VM will start,
5381 and most information will be delivered as IHostPCIDevicePlugEvent
5382 on IVirtualBox event source.
5383
5384 <see><link to="IHostPCIDevicePlugEvent"/></see>
5385
5386 <result name="VBOX_E_INVALID_VM_STATE">
5387 Virtual machine state is not stopped (PCI hotplug not yet implemented).
5388 </result>
5389 <result name="VBOX_E_PDM_ERROR">
5390 Virtual machine does not have a PCI controller allowing attachment of physical devices.
5391 </result>
5392 <result name="VBOX_E_NOT_SUPPORTED">
5393 Hardware or host OS doesn't allow PCI device passthrought.
5394 </result>
5395 </desc>
5396 <param name="hostAddress" type="long" dir="in">
5397 <desc>Address of the host PCI device.</desc>
5398 </param>
5399 <param name="desiredGuestAddress" type="long" dir="in">
5400 <desc>Desired position of this device on guest PCI bus.</desc>
5401 </param>
5402 <param name="tryToUnbind" type="boolean" dir="in">
5403 <desc>If VMM shall try to unbind existing drivers from the
5404 device before attaching it to the guest.</desc>
5405 </param>
5406 </method>
5407
5408 <method name="detachHostPCIDevice">
5409 <desc>
5410 Detach host PCI device from the virtual machine.
5411 Also HostPCIDevicePlugEvent on IVirtualBox event source
5412 will be delivered. As currently we don't support hot device
5413 unplug, IHostPCIDevicePlugEvent event is delivered immediately.
5414
5415 <see><link to="IHostPCIDevicePlugEvent"/></see>
5416
5417 <result name="VBOX_E_INVALID_VM_STATE">
5418 Virtual machine state is not stopped (PCI hotplug not yet implemented).
5419 </result>
5420 <result name="VBOX_E_OBJECT_NOT_FOUND">
5421 This host device is not attached to this machine.
5422 </result>
5423 <result name="VBOX_E_PDM_ERROR">
5424 Virtual machine does not have a PCI controller allowing attachment of physical devices.
5425 </result>
5426 <result name="VBOX_E_NOT_SUPPORTED">
5427 Hardware or host OS doesn't allow PCI device passthrought.
5428 </result>
5429 </desc>
5430 <param name="hostAddress" type="long" dir="in">
5431 <desc>Address of the host PCI device.</desc>
5432 </param>
5433 </method>
5434
5435 <method name="getNetworkAdapter" const="yes">
5436 <desc>
5437 Returns the network adapter associated with the given slot.
5438 Slots are numbered sequentially, starting with zero. The total
5439 number of adapters per machine is defined by the
5440 <link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5441 so the maximum slot number is one less than that property's value.
5442
5443 <result name="E_INVALIDARG">
5444 Invalid @a slot number.
5445 </result>
5446
5447 </desc>
5448 <param name="slot" type="unsigned long" dir="in"/>
5449 <param name="adapter" type="INetworkAdapter" dir="return"/>
5450 </method>
5451
5452 <method name="addStorageController">
5453 <desc>
5454 Adds a new storage controller (SCSI, SAS or SATA controller) to the
5455 machine and returns it as an instance of
5456 <link to="IStorageController" />.
5457
5458 @a name identifies the controller for subsequent calls such as
5459 <link to="#getStorageControllerByName" />,
5460 <link to="#getStorageControllerByInstance" />,
5461 <link to="#removeStorageController" />,
5462 <link to="#attachDevice" /> or <link to="#mountMedium" />.
5463
5464 After the controller has been added, you can set its exact
5465 type by setting the <link to="IStorageController::controllerType" />.
5466
5467 <result name="VBOX_E_OBJECT_IN_USE">
5468 A storage controller with given name exists already.
5469 </result>
5470 <result name="E_INVALIDARG">
5471 Invalid @a controllerType.
5472 </result>
5473 </desc>
5474 <param name="name" type="wstring" dir="in"/>
5475 <param name="connectionType" type="StorageBus" dir="in"/>
5476 <param name="controller" type="IStorageController" dir="return"/>
5477 </method>
5478
5479 <method name="getStorageControllerByName" const="yes">
5480 <desc>
5481 Returns a storage controller with the given name.
5482
5483 <result name="VBOX_E_OBJECT_NOT_FOUND">
5484 A storage controller with given name doesn't exist.
5485 </result>
5486 </desc>
5487 <param name="name" type="wstring" dir="in"/>
5488 <param name="storageController" type="IStorageController" dir="return"/>
5489 </method>
5490
5491 <method name="getStorageControllerByInstance" const="yes">
5492 <desc>
5493 Returns a storage controller with the given instance number.
5494
5495 <result name="VBOX_E_OBJECT_NOT_FOUND">
5496 A storage controller with given instance number doesn't exist.
5497 </result>
5498 </desc>
5499 <param name="instance" type="unsigned long" dir="in"/>
5500 <param name="storageController" type="IStorageController" dir="return"/>
5501 </method>
5502
5503 <method name="removeStorageController">
5504 <desc>
5505 Removes a storage controller from the machine with all devices attached to it.
5506
5507 <result name="VBOX_E_OBJECT_NOT_FOUND">
5508 A storage controller with given name doesn't exist.
5509 </result>
5510 <result name="VBOX_E_NOT_SUPPORTED">
5511 Medium format does not support storage deletion (only for implicitly
5512 created differencing media, should not happen).
5513 </result>
5514 </desc>
5515 <param name="name" type="wstring" dir="in"/>
5516 </method>
5517
5518 <method name="setStorageControllerBootable">
5519 <desc>
5520 Sets the bootable flag of the storage controller with the given name.
5521
5522 <result name="VBOX_E_OBJECT_NOT_FOUND">
5523 A storage controller with given name doesn't exist.
5524 </result>
5525 <result name="VBOX_E_OBJECT_IN_USE">
5526 Another storage controller is marked as bootable already.
5527 </result>
5528 </desc>
5529 <param name="name" type="wstring" dir="in"/>
5530 <param name="bootable" type="boolean" dir="in"/>
5531 </method>
5532
5533 <method name="getSerialPort" const="yes">
5534 <desc>
5535 Returns the serial port associated with the given slot.
5536 Slots are numbered sequentially, starting with zero. The total
5537 number of serial ports per machine is defined by the
5538 <link to="ISystemProperties::serialPortCount"/> property,
5539 so the maximum slot number is one less than that property's value.
5540
5541 <result name="E_INVALIDARG">
5542 Invalid @a slot number.
5543 </result>
5544
5545 </desc>
5546 <param name="slot" type="unsigned long" dir="in"/>
5547 <param name="port" type="ISerialPort" dir="return"/>
5548 </method>
5549
5550 <method name="getParallelPort" const="yes">
5551 <desc>
5552 Returns the parallel port associated with the given slot.
5553 Slots are numbered sequentially, starting with zero. The total
5554 number of parallel ports per machine is defined by the
5555 <link to="ISystemProperties::parallelPortCount"/> property,
5556 so the maximum slot number is one less than that property's value.
5557
5558 <result name="E_INVALIDARG">
5559 Invalid @a slot number.
5560 </result>
5561
5562 </desc>
5563 <param name="slot" type="unsigned long" dir="in"/>
5564 <param name="port" type="IParallelPort" dir="return"/>
5565 </method>
5566
5567 <method name="getExtraDataKeys">
5568 <desc>
5569 Returns an array representing the machine-specific extra data keys
5570 which currently have values defined.
5571 </desc>
5572 <param name="value" type="wstring" dir="return" safearray="yes">
5573 <desc>Array of extra data keys.</desc>
5574 </param>
5575 </method>
5576
5577 <method name="getExtraData">
5578 <desc>
5579 Returns associated machine-specific extra data.
5580
5581 If the requested data @a key does not exist, this function will
5582 succeed and return an empty string in the @a value argument.
5583
5584 <result name="VBOX_E_FILE_ERROR">
5585 Settings file not accessible.
5586 </result>
5587 <result name="VBOX_E_XML_ERROR">
5588 Could not parse the settings file.
5589 </result>
5590
5591 </desc>
5592 <param name="key" type="wstring" dir="in">
5593 <desc>Name of the data key to get.</desc>
5594 </param>
5595 <param name="value" type="wstring" dir="return">
5596 <desc>Value of the requested data key.</desc>
5597 </param>
5598 </method>
5599
5600 <method name="setExtraData">
5601 <desc>
5602 Sets associated machine-specific extra data.
5603
5604 If you pass @c null or an empty string as a key @a value, the given
5605 @a key will be deleted.
5606
5607 <note>
5608 Before performing the actual data change, this method will ask all
5609 registered listeners using the
5610 <link to="IExtraDataCanChangeEvent"/>
5611 notification for a permission. If one of the listeners refuses the
5612 new value, the change will not be performed.
5613 </note>
5614 <note>
5615 On success, the
5616 <link to="IExtraDataChangedEvent"/> notification
5617 is called to inform all registered listeners about a successful data
5618 change.
5619 </note>
5620 <note>
5621 This method can be called outside the machine session and therefore
5622 it's a caller's responsibility to handle possible race conditions
5623 when several clients change the same key at the same time.
5624 </note>
5625
5626 <result name="VBOX_E_FILE_ERROR">
5627 Settings file not accessible.
5628 </result>
5629 <result name="VBOX_E_XML_ERROR">
5630 Could not parse the settings file.
5631 </result>
5632
5633 </desc>
5634 <param name="key" type="wstring" dir="in">
5635 <desc>Name of the data key to set.</desc>
5636 </param>
5637 <param name="value" type="wstring" dir="in">
5638 <desc>Value to assign to the key.</desc>
5639 </param>
5640 </method>
5641
5642 <method name="getCPUProperty" const="yes">
5643 <desc>
5644 Returns the virtual CPU boolean value of the specified property.
5645
5646 <result name="E_INVALIDARG">
5647 Invalid property.
5648 </result>
5649
5650 </desc>
5651 <param name="property" type="CPUPropertyType" dir="in">
5652 <desc>
5653 Property type to query.
5654 </desc>
5655 </param>
5656 <param name="value" type="boolean" dir="return">
5657 <desc>
5658 Property value.
5659 </desc>
5660 </param>
5661 </method>
5662
5663 <method name="setCPUProperty">
5664 <desc>
5665 Sets the virtual CPU boolean value of the specified property.
5666
5667 <result name="E_INVALIDARG">
5668 Invalid property.
5669 </result>
5670
5671 </desc>
5672 <param name="property" type="CPUPropertyType" dir="in">
5673 <desc>
5674 Property type to query.
5675 </desc>
5676 </param>
5677 <param name="value" type="boolean" dir="in">
5678 <desc>
5679 Property value.
5680 </desc>
5681 </param>
5682 </method>
5683
5684 <method name="getCPUIDLeaf" const="yes">
5685 <desc>
5686 Returns the virtual CPU cpuid information for the specified leaf.
5687
5688 Currently supported index values for cpuid:
5689 Standard CPUID leafs: 0 - 0xA
5690 Extended CPUID leafs: 0x80000000 - 0x8000000A
5691
5692 See the Intel and AMD programmer's manuals for detailed information
5693 about the cpuid instruction and its leafs.
5694 <result name="E_INVALIDARG">
5695 Invalid id.
5696 </result>
5697
5698 </desc>
5699 <param name="id" type="unsigned long" dir="in">
5700 <desc>
5701 CPUID leaf index.
5702 </desc>
5703 </param>
5704 <param name="valEax" type="unsigned long" dir="out">
5705 <desc>
5706 CPUID leaf value for register eax.
5707 </desc>
5708 </param>
5709 <param name="valEbx" type="unsigned long" dir="out">
5710 <desc>
5711 CPUID leaf value for register ebx.
5712 </desc>
5713 </param>
5714 <param name="valEcx" type="unsigned long" dir="out">
5715 <desc>
5716 CPUID leaf value for register ecx.
5717 </desc>
5718 </param>
5719 <param name="valEdx" type="unsigned long" dir="out">
5720 <desc>
5721 CPUID leaf value for register edx.
5722 </desc>
5723 </param>
5724 </method>
5725
5726 <method name="setCPUIDLeaf">
5727 <desc>
5728 Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5729 are not passed unmodified. VirtualBox clears features that it doesn't support.
5730
5731 Currently supported index values for cpuid:
5732 Standard CPUID leafs: 0 - 0xA
5733 Extended CPUID leafs: 0x80000000 - 0x8000000A
5734
5735 See the Intel and AMD programmer's manuals for detailed information
5736 about the cpuid instruction and its leafs.
5737
5738 Do not use this method unless you know exactly what you're doing. Misuse can lead to
5739 random crashes inside VMs.
5740 <result name="E_INVALIDARG">
5741 Invalid id.
5742 </result>
5743
5744 </desc>
5745 <param name="id" type="unsigned long" dir="in">
5746 <desc>
5747 CPUID leaf index.
5748 </desc>
5749 </param>
5750 <param name="valEax" type="unsigned long" dir="in">
5751 <desc>
5752 CPUID leaf value for register eax.
5753 </desc>
5754 </param>
5755 <param name="valEbx" type="unsigned long" dir="in">
5756 <desc>
5757 CPUID leaf value for register ebx.
5758 </desc>
5759 </param>
5760 <param name="valEcx" type="unsigned long" dir="in">
5761 <desc>
5762 CPUID leaf value for register ecx.
5763 </desc>
5764 </param>
5765 <param name="valEdx" type="unsigned long" dir="in">
5766 <desc>
5767 CPUID leaf value for register edx.
5768 </desc>
5769 </param>
5770 </method>
5771
5772 <method name="removeCPUIDLeaf">
5773 <desc>
5774 Removes the virtual CPU cpuid leaf for the specified index
5775
5776 <result name="E_INVALIDARG">
5777 Invalid id.
5778 </result>
5779
5780 </desc>
5781 <param name="id" type="unsigned long" dir="in">
5782 <desc>
5783 CPUID leaf index.
5784 </desc>
5785 </param>
5786 </method>
5787
5788 <method name="removeAllCPUIDLeaves">
5789 <desc>
5790 Removes all the virtual CPU cpuid leaves
5791 </desc>
5792 </method>
5793
5794 <method name="getHWVirtExProperty" const="yes">
5795 <desc>
5796 Returns the value of the specified hardware virtualization boolean property.
5797
5798 <result name="E_INVALIDARG">
5799 Invalid property.
5800 </result>
5801
5802 </desc>
5803 <param name="property" type="HWVirtExPropertyType" dir="in">
5804 <desc>
5805 Property type to query.
5806 </desc>
5807 </param>
5808 <param name="value" type="boolean" dir="return">
5809 <desc>
5810 Property value.
5811 </desc>
5812 </param>
5813 </method>
5814
5815 <method name="setHWVirtExProperty">
5816 <desc>
5817 Sets a new value for the specified hardware virtualization boolean property.
5818
5819 <result name="E_INVALIDARG">
5820 Invalid property.
5821 </result>
5822
5823 </desc>
5824 <param name="property" type="HWVirtExPropertyType" dir="in">
5825 <desc>
5826 Property type to set.
5827 </desc>
5828 </param>
5829 <param name="value" type="boolean" dir="in">
5830 <desc>
5831 New property value.
5832 </desc>
5833 </param>
5834 </method>
5835
5836 <method name="saveSettings">
5837 <desc>
5838 Saves any changes to machine settings made since the session
5839 has been opened or a new machine has been created, or since the
5840 last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5841 For registered machines, new settings become visible to all
5842 other VirtualBox clients after successful invocation of this
5843 method.
5844 <note>
5845 The method sends <link to="IMachineDataChangedEvent"/>
5846 notification event after the configuration has been successfully
5847 saved (only for registered machines).
5848 </note>
5849 <note>
5850 Calling this method is only valid on instances returned
5851 by <link to="ISession::machine"/> and on new machines
5852 created by <link to="IVirtualBox::createMachine"/> but not
5853 yet registered, or on unregistered machines after calling
5854 <link to="IMachine::unregister"/>.
5855 </note>
5856
5857 <result name="VBOX_E_FILE_ERROR">
5858 Settings file not accessible.
5859 </result>
5860 <result name="VBOX_E_XML_ERROR">
5861 Could not parse the settings file.
5862 </result>
5863 <result name="E_ACCESSDENIED">
5864 Modification request refused.
5865 </result>
5866
5867 </desc>
5868 </method>
5869
5870 <method name="discardSettings">
5871 <desc>
5872 Discards any changes to the machine settings made since the session
5873 has been opened or since the last call to <link to="#saveSettings"/>
5874 or <link to="#discardSettings"/>.
5875 <note>
5876 Calling this method is only valid on instances returned
5877 by <link to="ISession::machine"/> and on new machines
5878 created by <link to="IVirtualBox::createMachine"/> or
5879 opened by <link to="IVirtualBox::openMachine"/> but not
5880 yet registered, or on unregistered machines after calling
5881 <link to="IMachine::unregister"/>.
5882 </note>
5883
5884 <result name="VBOX_E_INVALID_VM_STATE">
5885 Virtual machine is not mutable.
5886 </result>
5887
5888 </desc>
5889 </method>
5890
5891 <method name="unregister">
5892 <desc>
5893 Unregisters a machine previously registered with
5894 <link to="IVirtualBox::registerMachine"/> and optionally do additional
5895 cleanup before the machine is unregistered.
5896
5897 This method does not delete any files. It only changes the machine configuration and
5898 the list of registered machines in the VirtualBox object. To delete the files which
5899 belonged to the machine, including the XML file of the machine itself, call
5900 <link to="#delete"/>, optionally with the array of IMedium objects which was returned
5901 from this method.
5902
5903 How thoroughly this method cleans up the machine configuration before unregistering
5904 the machine depends on the @a cleanupMode argument.
5905
5906 <ul>
5907 <li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5908 cleanup will be performed. The call will fail if the machine is in "Saved" state
5909 or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5910 It is the responsibility of the caller to delete all such configuration in this mode.
5911 In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5912 which it replaces.</li>
5913 <li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5914 state or if it has snapshots or media attached. All media attached to the current machine
5915 state or in snapshots will be detached. No medium objects will be returned;
5916 all of the machine's media will remain open.</li>
5917 <li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5918 except that all the hard disk medium objects which were detached from the machine will
5919 be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5920 API for closing and deletion.</li>
5921 <li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5922 that all media will be returned in the array, including removable media like DVDs and
5923 floppies. This might be useful if the user wants to inspect in detail which media were
5924 attached to the machine. Be careful when passing the media array to <link to="#delete" />
5925 in that case because users will typically want to preserve ISO and RAW image files.</li>
5926 </ul>
5927
5928 A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5929 resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5930 deleted with all its saved states and hard disk images, but images for removable
5931 drives (such as ISO and RAW files) will remain on disk.
5932
5933 This API does not verify whether the media files returned in the array are still
5934 attached to other machines (i.e. shared between several machines). If such a shared
5935 image is passed to <link to="#delete" /> however, closing the image will fail there
5936 and the image will be silently skipped.
5937
5938 This API may, however, move media from this machine's media registry to other media
5939 registries (see <link to="IMedium" /> for details on media registries). For machines
5940 created with VirtualBox 4.0 or later, if media from this machine's media registry
5941 are also attached to another machine (shared attachments), each such medium will be
5942 moved to another machine's registry. This is because without this machine's media
5943 registry, the other machine cannot find its media any more and would become inaccessible.
5944
5945 This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5946 before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
5947 if media are moved to other machines' media registries.
5948
5949 After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5950 is fired.
5951
5952 The call will fail if the machine is currently locked (see <link to="ISession" />).
5953
5954 <note>
5955 If the given machine is inaccessible (see <link to="#accessible"/>), it
5956 will be unregistered and fully uninitialized right afterwards. As a result,
5957 the returned machine object will be unusable and an attempt to call
5958 <b>any</b> method will return the "Object not ready" error.
5959 </note>
5960
5961 <result name="VBOX_E_INVALID_OBJECT_STATE">
5962 Machine is currently locked for a session.
5963 </result>
5964 </desc>
5965
5966 <param name="cleanupMode" type="CleanupMode" dir="in">
5967 <desc>How to clean up after the machine has been unregistered.</desc>
5968 </param>
5969 <param name="aMedia" type="IMedium" safearray="yes" dir="return">
5970 <desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5971 </param>
5972 </method>
5973
5974 <method name="delete">
5975 <desc>
5976 Deletes the files associated with this machine from disk. If medium objects are passed
5977 in with the @a aMedia argument, they are closed and, if closing was successful, their
5978 storage files are deleted as well. For convenience, this array of media files can be
5979 the same as the one returned from a previous <link to="#unregister" /> call.
5980
5981 This method must only be called on machines which are either write-locked (i.e. on instances
5982 returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5983 registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5984 <link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5985
5986 The following files will be deleted by this method:
5987 <ul>
5988 <li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5989 argument other than "UnregisterOnly", this will delete all saved state files that
5990 the machine had in use; possibly one if the machine was in "Saved" state and one
5991 for each online snapshot that the machine had.</li>
5992 <li>On each medium object passed in the @a aMedia array, this will call
5993 <link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5994 medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
5995 in use, e.g. because it is still attached to a second machine; in that case the
5996 storage will not be deleted.</li>
5997 <li>Finally, the machine's own XML file will be deleted.</li>
5998 </ul>
5999
6000 Since deleting large disk image files can be a time-consuming I/O operation, this
6001 method operates asynchronously and returns an IProgress object to allow the caller
6002 to monitor the progress. There will be one sub-operation for each file that is
6003 being deleted (saved state or medium storage file).
6004
6005 <note>
6006 <link to="#settingsModified"/> will return @c true after this
6007 method successfully returns.
6008 </note>
6009
6010 <result name="VBOX_E_INVALID_VM_STATE">
6011 Machine is registered but not write-locked.
6012 </result>
6013 <result name="VBOX_E_IPRT_ERROR">
6014 Could not delete the settings file.
6015 </result>
6016 </desc>
6017 <param name="aMedia" type="IMedium" safearray="yes" dir="in">
6018 <desc>List of media to be closed and whose storage files will be deleted.</desc>
6019 </param>
6020 <param name="aProgress" type="IProgress" dir="return">
6021 <desc>Progress object to track the operation completion.</desc>
6022 </param>
6023 </method>
6024
6025 <method name="export">
6026 <desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
6027 steps required to export VirtualBox machines to OVF.
6028 </desc>
6029
6030 <param name="aAppliance" type="IAppliance" dir="in">
6031 <desc>Appliance to export this machine to.</desc>
6032 </param>
6033 <param name="location" type="wstring" dir="in">
6034 <desc>The target location.</desc>
6035 </param>
6036 <param name="aDescription" type="IVirtualSystemDescription" dir="return">
6037 <desc>VirtualSystemDescription object which is created for this machine.</desc>
6038 </param>
6039 </method >
6040
6041 <method name="findSnapshot">
6042 <desc>
6043 Returns a snapshot of this machine with the given name or UUID.
6044
6045 Returns a snapshot of this machine with the given UUID.
6046 A @c null argument can be used to obtain the first snapshot
6047 taken on this machine. To traverse the whole tree of snapshots
6048 starting from the root, inspect the root snapshot's
6049 <link to="ISnapshot::children" /> attribute and recurse over those children.
6050
6051 <result name="VBOX_E_OBJECT_NOT_FOUND">
6052 Virtual machine has no snapshots or snapshot not found.
6053 </result>
6054
6055 </desc>
6056 <param name="nameOrId" type="wstring" dir="in">
6057 <desc>What to search for. Name or UUID of the snapshot to find</desc>
6058 </param>
6059 <param name="snapshot" type="ISnapshot" dir="return">
6060 <desc>Snapshot object with the given name.</desc>
6061 </param>
6062 </method>
6063
6064 <method name="createSharedFolder">
6065 <desc>
6066 Creates a new permanent shared folder by associating the given logical
6067 name with the given host path, adds it to the collection of shared
6068 folders and starts sharing it. Refer to the description of
6069 <link to="ISharedFolder"/> to read more about logical names.
6070
6071 <result name="VBOX_E_OBJECT_IN_USE">
6072 Shared folder already exists.
6073 </result>
6074 <result name="VBOX_E_FILE_ERROR">
6075 Shared folder @a hostPath not accessible.
6076 </result>
6077
6078 </desc>
6079 <param name="name" type="wstring" dir="in">
6080 <desc>Unique logical name of the shared folder.</desc>
6081 </param>
6082 <param name="hostPath" type="wstring" dir="in">
6083 <desc>Full path to the shared folder in the host file system.</desc>
6084 </param>
6085 <param name="writable" type="boolean" dir="in">
6086 <desc>Whether the share is writable or readonly.</desc>
6087 </param>
6088 <param name="automount" type="boolean" dir="in">
6089 <desc>Whether the share gets automatically mounted by the guest
6090 or not.</desc>
6091 </param>
6092 </method>
6093
6094 <method name="removeSharedFolder">
6095 <desc>
6096 Removes the permanent shared folder with the given name previously
6097 created by <link to="#createSharedFolder"/> from the collection of
6098 shared folders and stops sharing it.
6099
6100 <result name="VBOX_E_INVALID_VM_STATE">
6101 Virtual machine is not mutable.
6102 </result>
6103 <result name="VBOX_E_OBJECT_NOT_FOUND">
6104 Shared folder @a name does not exist.
6105 </result>
6106
6107 </desc>
6108 <param name="name" type="wstring" dir="in">
6109 <desc>Logical name of the shared folder to remove.</desc>
6110 </param>
6111 </method>
6112
6113 <method name="canShowConsoleWindow">
6114 <desc>
6115 Returns @c true if the VM console process can activate the
6116 console window and bring it to foreground on the desktop of
6117 the host PC.
6118 <note>
6119 This method will fail if a session for this machine is not
6120 currently open.
6121 </note>
6122
6123 <result name="VBOX_E_INVALID_VM_STATE">
6124 Machine session is not open.
6125 </result>
6126
6127 </desc>
6128 <param name="canShow" type="boolean" dir="return">
6129 <desc>
6130 @c true if the console window can be shown and @c false otherwise.
6131 </desc>
6132 </param>
6133 </method>
6134
6135 <method name="showConsoleWindow">
6136 <desc>
6137 Activates the console window and brings it to foreground on
6138 the desktop of the host PC. Many modern window managers on
6139 many platforms implement some sort of focus stealing
6140 prevention logic, so that it may be impossible to activate
6141 a window without the help of the currently active
6142 application. In this case, this method will return a non-zero
6143 identifier that represents the top-level window of the VM
6144 console process. The caller, if it represents a currently
6145 active process, is responsible to use this identifier (in a
6146 platform-dependent manner) to perform actual window
6147 activation.
6148 <note>
6149 This method will fail if a session for this machine is not
6150 currently open.
6151 </note>
6152
6153 <result name="VBOX_E_INVALID_VM_STATE">
6154 Machine session is not open.
6155 </result>
6156
6157 </desc>
6158 <param name="winId" type="long long" dir="return">
6159 <desc>
6160 Platform-dependent identifier of the top-level VM console
6161 window, or zero if this method has performed all actions
6162 necessary to implement the <i>show window</i> semantics for
6163 the given platform and/or VirtualBox front-end.
6164 </desc>
6165 </param>
6166 </method>
6167
6168 <method name="getGuestProperty" const="yes">
6169 <desc>
6170 Reads an entry from the machine's guest property store.
6171
6172 <result name="VBOX_E_INVALID_VM_STATE">
6173 Machine session is not open.
6174 </result>
6175
6176 </desc>
6177 <param name="name" type="wstring" dir="in">
6178 <desc>
6179 The name of the property to read.
6180 </desc>
6181 </param>
6182 <param name="value" type="wstring" dir="out">
6183 <desc>
6184 The value of the property. If the property does not exist then this
6185 will be empty.
6186 </desc>
6187 </param>
6188 <param name="timestamp" type="long long" dir="out">
6189 <desc>
6190 The time at which the property was last modified, as seen by the
6191 server process.
6192 </desc>
6193 </param>
6194 <param name="flags" type="wstring" dir="out">
6195 <desc>
6196 Additional property parameters, passed as a comma-separated list of
6197 "name=value" type entries.
6198 </desc>
6199 </param>
6200 </method>
6201
6202 <method name="getGuestPropertyValue" const="yes">
6203 <desc>
6204 Reads a value from the machine's guest property store.
6205
6206 <result name="VBOX_E_INVALID_VM_STATE">
6207 Machine session is not open.
6208 </result>
6209
6210 </desc>
6211 <param name="property" type="wstring" dir="in">
6212 <desc>
6213 The name of the property to read.
6214 </desc>
6215 </param>
6216 <param name="value" type="wstring" dir="return">
6217 <desc>
6218 The value of the property. If the property does not exist then this
6219 will be empty.
6220 </desc>
6221 </param>
6222 </method>
6223
6224 <method name="getGuestPropertyTimestamp" const="yes">
6225 <desc>
6226 Reads a property timestamp from the machine's guest property store.
6227
6228 <result name="VBOX_E_INVALID_VM_STATE">
6229 Machine session is not open.
6230 </result>
6231
6232 </desc>
6233 <param name="property" type="wstring" dir="in">
6234 <desc>
6235 The name of the property to read.
6236 </desc>
6237 </param>
6238 <param name="value" type="long long" dir="return">
6239 <desc>
6240 The timestamp. If the property does not exist then this will be
6241 empty.
6242 </desc>
6243 </param>
6244 </method>
6245
6246 <method name="setGuestProperty">
6247 <desc>
6248 Sets, changes or deletes an entry in the machine's guest property
6249 store.
6250
6251 <result name="E_ACCESSDENIED">
6252 Property cannot be changed.
6253 </result>
6254 <result name="E_INVALIDARG">
6255 Invalid @a flags.
6256 </result>
6257 <result name="VBOX_E_INVALID_VM_STATE">
6258 Virtual machine is not mutable or session not open.
6259 </result>
6260 <result name="VBOX_E_INVALID_OBJECT_STATE">
6261 Cannot set transient property when machine not running.
6262 </result>
6263
6264 </desc>
6265 <param name="property" type="wstring" dir="in">
6266 <desc>
6267 The name of the property to set, change or delete.
6268 </desc>
6269 </param>
6270 <param name="value" type="wstring" dir="in">
6271 <desc>
6272 The new value of the property to set, change or delete. If the
6273 property does not yet exist and value is non-empty, it will be
6274 created. If the value is @c null or empty, the property will be
6275 deleted if it exists.
6276 </desc>
6277 </param>
6278 <param name="flags" type="wstring" dir="in">
6279 <desc>
6280 Additional property parameters, passed as a comma-separated list of
6281 "name=value" type entries.
6282 </desc>
6283 </param>
6284 </method>
6285
6286 <method name="setGuestPropertyValue">
6287 <desc>
6288 Sets, changes or deletes a value in the machine's guest property
6289 store. The flags field will be left unchanged or created empty for a
6290 new property.
6291
6292 <result name="E_ACCESSDENIED">
6293 Property cannot be changed.
6294 </result>
6295 <result name="VBOX_E_INVALID_VM_STATE">
6296 Virtual machine is not mutable or session not open.
6297 </result>
6298 <result name="VBOX_E_INVALID_OBJECT_STATE">
6299 Cannot set transient property when machine not running.
6300 </result>
6301 </desc>
6302
6303 <param name="property" type="wstring" dir="in">
6304 <desc>
6305 The name of the property to set, change or delete.
6306 </desc>
6307 </param>
6308 <param name="value" type="wstring" dir="in">
6309 <desc>
6310 The new value of the property to set, change or delete. If the
6311 property does not yet exist and value is non-empty, it will be
6312 created. If the value is @c null or empty, the property will be
6313 deleted if it exists.
6314 </desc>
6315 </param>
6316 </method>
6317
6318 <method name="deleteGuestProperty" const="yes">
6319 <desc>
6320 Deletes an entry from the machine's guest property store.
6321
6322 <result name="VBOX_E_INVALID_VM_STATE">
6323 Machine session is not open.
6324 </result>
6325
6326 </desc>
6327 <param name="name" type="wstring" dir="in">
6328 <desc>
6329 The name of the property to delete.
6330 </desc>
6331 </param>
6332 </method>
6333
6334 <method name="enumerateGuestProperties" const="yes">
6335 <desc>
6336 Return a list of the guest properties matching a set of patterns along
6337 with their values, time stamps and flags.
6338 </desc>
6339 <param name="patterns" type="wstring" dir="in">
6340 <desc>
6341 The patterns to match the properties against, separated by '|'
6342 characters. If this is empty or @c null, all properties will match.
6343 </desc>
6344 </param>
6345 <param name="name" type="wstring" dir="out" safearray="yes">
6346 <desc>
6347 The names of the properties returned.
6348 </desc>
6349 </param>
6350 <param name="value" type="wstring" dir="out" safearray="yes">
6351 <desc>
6352 The values of the properties returned. The array entries match the
6353 corresponding entries in the @a name array.
6354 </desc>
6355 </param>
6356 <param name="timestamp" type="long long" dir="out" safearray="yes">
6357 <desc>
6358 The time stamps of the properties returned. The array entries match
6359 the corresponding entries in the @a name array.
6360 </desc>
6361 </param>
6362 <param name="flags" type="wstring" dir="out" safearray="yes">
6363 <desc>
6364 The flags of the properties returned. The array entries match the
6365 corresponding entries in the @a name array.
6366 </desc>
6367 </param>
6368 </method>
6369
6370 <method name="querySavedGuestScreenInfo" const="yes">
6371 <desc>
6372 Returns the guest dimensions from the saved state.
6373 </desc>
6374 <param name="screenId" type="unsigned long" dir="in">
6375 <desc>
6376 Saved guest screen to query info from.
6377 </desc>
6378 </param>
6379 <param name="originX" type="unsigned long" dir="out">
6380 <desc>
6381 The X position of the guest monitor top left corner.
6382 </desc>
6383 </param>
6384 <param name="originY" type="unsigned long" dir="out">
6385 <desc>
6386 The Y position of the guest monitor top left corner.
6387 </desc>
6388 </param>
6389 <param name="width" type="unsigned long" dir="out">
6390 <desc>
6391 Guest width at the time of the saved state was taken.
6392 </desc>
6393 </param>
6394 <param name="height" type="unsigned long" dir="out">
6395 <desc>
6396 Guest height at the time of the saved state was taken.
6397 </desc>
6398 </param>
6399 <param name="enabled" type="boolean" dir="out">
6400 <desc>
6401 Whether the monitor is enabled in the guest.
6402 </desc>
6403 </param>
6404 </method>
6405
6406 <method name="querySavedThumbnailSize">
6407 <desc>
6408 Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
6409 </desc>
6410 <param name="screenId" type="unsigned long" dir="in">
6411 <desc>
6412 Saved guest screen to query info from.
6413 </desc>
6414 </param>
6415 <param name="size" type="unsigned long" dir="out">
6416 <desc>
6417 Size of buffer required to store the bitmap.
6418 </desc>
6419 </param>
6420 <param name="width" type="unsigned long" dir="out">
6421 <desc>
6422 Bitmap width.
6423 </desc>
6424 </param>
6425 <param name="height" type="unsigned long" dir="out">
6426 <desc>
6427 Bitmap height.
6428 </desc>
6429 </param>
6430 </method>
6431
6432 <method name="readSavedThumbnailToArray">
6433 <desc>
6434 Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
6435 </desc>
6436 <param name="screenId" type="unsigned long" dir="in">
6437 <desc>
6438 Saved guest screen to read from.
6439 </desc>
6440 </param>
6441 <param name="BGR" type="boolean" dir="in">
6442 <desc>
6443 How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6444 bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
6445 </desc>
6446 </param>
6447 <param name="width" type="unsigned long" dir="out">
6448 <desc>
6449 Bitmap width.
6450 </desc>
6451 </param>
6452 <param name="height" type="unsigned long" dir="out">
6453 <desc>
6454 Bitmap height.
6455 </desc>
6456 </param>
6457 <param name="data" type="octet" safearray="yes" dir="return">
6458 <desc>
6459 Array with resulting bitmap data.
6460 </desc>
6461 </param>
6462 </method>
6463
6464 <method name="readSavedThumbnailPNGToArray">
6465 <desc>
6466 Thumbnail in PNG format is retrieved to an array of bytes.
6467 </desc>
6468 <param name="screenId" type="unsigned long" dir="in">
6469 <desc>
6470 Saved guest screen to read from.
6471 </desc>
6472 </param>
6473 <param name="width" type="unsigned long" dir="out">
6474 <desc>
6475 Image width.
6476 </desc>
6477 </param>
6478 <param name="height" type="unsigned long" dir="out">
6479 <desc>
6480 Image height.
6481 </desc>
6482 </param>
6483 <param name="data" type="octet" dir="return" safearray="yes">
6484 <desc>
6485 Array with resulting PNG data.
6486 </desc>
6487 </param>
6488 </method>
6489
6490 <method name="querySavedScreenshotPNGSize">
6491 <desc>
6492 Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6493 </desc>
6494 <param name="screenId" type="unsigned long" dir="in">
6495 <desc>
6496 Saved guest screen to query info from.
6497 </desc>
6498 </param>
6499 <param name="size" type="unsigned long" dir="out">
6500 <desc>
6501 Size of buffer required to store the PNG binary data.
6502 </desc>
6503 </param>
6504 <param name="width" type="unsigned long" dir="out">
6505 <desc>
6506 Image width.
6507 </desc>
6508 </param>
6509 <param name="height" type="unsigned long" dir="out">
6510 <desc>
6511 Image height.
6512 </desc>
6513 </param>
6514 </method>
6515
6516 <method name="readSavedScreenshotPNGToArray">
6517 <desc>
6518 Screenshot in PNG format is retrieved to an array of bytes.
6519 </desc>
6520 <param name="screenId" type="unsigned long" dir="in">
6521 <desc>
6522 Saved guest screen to read from.
6523 </desc>
6524 </param>
6525 <param name="width" type="unsigned long" dir="out">
6526 <desc>
6527 Image width.
6528 </desc>
6529 </param>
6530 <param name="height" type="unsigned long" dir="out">
6531 <desc>
6532 Image height.
6533 </desc>
6534 </param>
6535 <param name="data" type="octet" dir="return" safearray="yes">
6536 <desc>
6537 Array with resulting PNG data.
6538 </desc>
6539 </param>
6540 </method>
6541
6542 <method name="hotPlugCPU">
6543 <desc>
6544 Plugs a CPU into the machine.
6545 </desc>
6546 <param name="cpu" type="unsigned long" dir="in">
6547 <desc>
6548 The CPU id to insert.
6549 </desc>
6550 </param>
6551 </method>
6552
6553 <method name="hotUnplugCPU">
6554 <desc>
6555 Removes a CPU from the machine.
6556 </desc>
6557 <param name="cpu" type="unsigned long" dir="in">
6558 <desc>
6559 The CPU id to remove.
6560 </desc>
6561 </param>
6562 </method>
6563
6564 <method name="getCPUStatus">
6565 <desc>
6566 Returns the current status of the given CPU.
6567 </desc>
6568 <param name="cpu" type="unsigned long" dir="in">
6569 <desc>
6570 The CPU id to check for.
6571 </desc>
6572 </param>
6573 <param name="attached" type="boolean" dir="return">
6574 <desc>
6575 Status of the CPU.
6576 </desc>
6577 </param>
6578 </method>
6579
6580 <method name="queryLogFilename">
6581 <desc>
6582 Queries for the VM log file name of an given index. Returns an empty
6583 string if a log file with that index doesn't exists.
6584 </desc>
6585 <param name="idx" type="unsigned long" dir="in">
6586 <desc>
6587 Which log file name to query. 0=current log file.
6588 </desc>
6589 </param>
6590 <param name="filename" type="wstring" dir="return">
6591 <desc>
6592 On return the full path to the log file or an empty string on error.
6593 </desc>
6594 </param>
6595 </method>
6596
6597 <method name="readLog">
6598 <desc>
6599 Reads the VM log file. The chunk size is limited, so even if you
6600 ask for a big piece there might be less data returned.
6601 </desc>
6602 <param name="idx" type="unsigned long" dir="in">
6603 <desc>
6604 Which log file to read. 0=current log file.
6605 </desc>
6606 </param>
6607 <param name="offset" type="long long" dir="in">
6608 <desc>
6609 Offset in the log file.
6610 </desc>
6611 </param>
6612 <param name="size" type="long long" dir="in">
6613 <desc>
6614 Chunk size to read in the log file.
6615 </desc>
6616 </param>
6617 <param name="data" type="octet" dir="return" safearray="yes">
6618 <desc>
6619 Data read from the log file. A data size of 0 means end of file
6620 if the requested chunk size was not 0. This is the unprocessed
6621 file data, i.e. the line ending style depends on the platform of
6622 the system the server is running on.
6623 </desc>
6624 </param>
6625 </method>
6626
6627 <method name="cloneTo">
6628 <desc>
6629 Creates a clone of this machine, either as a full clone (which means
6630 creating independent copies of the hard disk media, save states and so
6631 on), or as a linked clone (which uses its own differencing media,
6632 sharing the parent media with the source machine).
6633
6634 The target machine object must have been created previously with <link
6635 to="IVirtualBox::createMachine"/>, and all the settings will be
6636 transferred except the VM name and the hardware UUID. You can set the
6637 VM name and the new hardware UUID when creating the target machine. The
6638 network MAC addresses are newly created for all newtwork adapters. You
6639 can change that behaviour with the options parameter. The operation is
6640 performed asynchronously, so the machine object will be not be usable
6641 until the @a progress object signals completion.
6642
6643 <result name="E_INVALIDARG">
6644 @a target is @c null.
6645 </result>
6646 </desc>
6647
6648 <param name="target" type="IMachine" dir="in">
6649 <desc>Target machine object.</desc>
6650 </param>
6651 <param name="mode" type="CloneMode" dir="in">
6652 <desc>Which states should be cloned.</desc>
6653 </param>
6654 <param name="options" type="CloneOptions" dir="in" safearray="yes">
6655 <desc>Options for the cloning operation.</desc>
6656 </param>
6657 <param name="progress" type="IProgress" dir="return">
6658 <desc>Progress object to track the operation completion.</desc>
6659 </param>
6660 </method>
6661
6662 </interface>
6663
6664 <!--
6665 // IConsole
6666 /////////////////////////////////////////////////////////////////////////
6667 -->
6668
6669 <interface
6670 name="IVRDEServerInfo" extends="$unknown"
6671 uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6672 wsmap="struct"
6673 >
6674 <desc>
6675 Contains information about the remote desktop (VRDE) server capabilities and status.
6676 This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6677 </desc>
6678
6679 <attribute name="active" type="boolean" readonly="yes">
6680 <desc>
6681 Whether the remote desktop connection is active.
6682 </desc>
6683 </attribute>
6684
6685 <attribute name="port" type="long" readonly="yes">
6686 <desc>
6687 VRDE server port number. If this property is equal to <tt>0</tt>, then
6688 the VRDE server failed to start, usually because there are no free IP
6689 ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6690 server has not yet been started.
6691 </desc>
6692 </attribute>
6693
6694 <attribute name="numberOfClients" type="unsigned long" readonly="yes">
6695 <desc>
6696 How many times a client connected.
6697 </desc>
6698 </attribute>
6699
6700 <attribute name="beginTime" type="long long" readonly="yes">
6701 <desc>
6702 When the last connection was established, in milliseconds since 1970-01-01 UTC.
6703 </desc>
6704 </attribute>
6705
6706 <attribute name="endTime" type="long long" readonly="yes">
6707 <desc>
6708 When the last connection was terminated or the current time, if
6709 connection is still active, in milliseconds since 1970-01-01 UTC.
6710 </desc>
6711 </attribute>
6712
6713 <attribute name="bytesSent" type="long long" readonly="yes">
6714 <desc>
6715 How many bytes were sent in last or current, if still active, connection.
6716 </desc>
6717 </attribute>
6718
6719 <attribute name="bytesSentTotal" type="long long" readonly="yes">
6720 <desc>
6721 How many bytes were sent in all connections.
6722 </desc>
6723 </attribute>
6724
6725 <attribute name="bytesReceived" type="long long" readonly="yes">
6726 <desc>
6727 How many bytes were received in last or current, if still active, connection.
6728 </desc>
6729 </attribute>
6730
6731 <attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6732 <desc>
6733 How many bytes were received in all connections.
6734 </desc>
6735 </attribute>
6736
6737 <attribute name="user" type="wstring" readonly="yes">
6738 <desc>
6739 Login user name supplied by the client.
6740 </desc>
6741 </attribute>
6742
6743 <attribute name="domain" type="wstring" readonly="yes">
6744 <desc>
6745 Login domain name supplied by the client.
6746 </desc>
6747 </attribute>
6748
6749 <attribute name="clientName" type="wstring" readonly="yes">
6750 <desc>
6751 The client name supplied by the client.
6752 </desc>
6753 </attribute>
6754
6755 <attribute name="clientIP" type="wstring" readonly="yes">
6756 <desc>
6757 The IP address of the client.
6758 </desc>
6759 </attribute>
6760
6761 <attribute name="clientVersion" type="unsigned long" readonly="yes">
6762 <desc>
6763 The client software version number.
6764 </desc>
6765 </attribute>
6766
6767 <attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6768 <desc>
6769 Public key exchange method used when connection was established.
6770 Values: 0 - RDP4 public key exchange scheme.
6771 1 - X509 certificates were sent to client.
6772 </desc>
6773 </attribute>
6774
6775 </interface>
6776
6777 <interface
6778 name="IConsole" extends="$unknown"
6779 uuid="db7ab4ca-2a3f-4183-9243-c1208da92392"
6780 wsmap="managed"
6781 >
6782 <desc>
6783 The IConsole interface represents an interface to control virtual
6784 machine execution.
6785
6786 A console object gets created when a machine has been locked for a
6787 particular session (client process) using <link to="IMachine::lockMachine" />
6788 or <link to="IMachine::launchVMProcess"/>. The console object can
6789 then be found in the session's <link to="ISession::console" /> attribute.
6790
6791 Methods of the IConsole interface allow the caller to query the current
6792 virtual machine execution state, pause the machine or power it down, save
6793 the machine state or take a snapshot, attach and detach removable media
6794 and so on.
6795
6796 <see><link to="ISession"/></see>
6797 </desc>
6798
6799 <attribute name="machine" type="IMachine" readonly="yes">
6800 <desc>
6801 Machine object for this console session.
6802 <note>
6803 This is a convenience property, it has the same value as
6804 <link to="ISession::machine"/> of the corresponding session
6805 object.
6806 </note>
6807 </desc>
6808 </attribute>
6809
6810 <attribute name="state" type="MachineState" readonly="yes">
6811 <desc>
6812 Current execution state of the machine.
6813 <note>
6814 This property always returns the same value as the corresponding
6815 property of the IMachine object for this console session.
6816 For the process that owns (executes) the VM, this is the
6817 preferable way of querying the VM state, because no IPC
6818 calls are made.
6819 </note>
6820 </desc>
6821 </attribute>
6822
6823 <attribute name="guest" type="IGuest" readonly="yes">
6824 <desc>Guest object.</desc>
6825 </attribute>
6826
6827 <attribute name="keyboard" type="IKeyboard" readonly="yes">
6828 <desc>
6829 Virtual keyboard object.
6830 <note>
6831 If the machine is not running, any attempt to use
6832 the returned object will result in an error.
6833 </note>
6834 </desc>
6835 </attribute>
6836
6837 <attribute name="mouse" type="IMouse" readonly="yes">
6838 <desc>
6839 Virtual mouse object.
6840 <note>
6841 If the machine is not running, any attempt to use
6842 the returned object will result in an error.
6843 </note>
6844 </desc>
6845 </attribute>
6846
6847 <attribute name="display" type="IDisplay" readonly="yes">
6848 <desc>Virtual display object.
6849 <note>
6850 If the machine is not running, any attempt to use
6851 the returned object will result in an error.
6852 </note>
6853 </desc>
6854 </attribute>
6855
6856 <attribute name="debugger" type="IMachineDebugger" readonly="yes">
6857 <desc>Debugging interface.</desc>
6858 </attribute>
6859
6860 <attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6861 <desc>
6862 Collection of USB devices currently attached to the virtual
6863 USB controller.
6864 <note>
6865 The collection is empty if the machine is not running.
6866 </note>
6867 </desc>
6868 </attribute>
6869
6870 <attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6871 <desc>
6872 List of USB devices currently attached to the remote VRDE client.
6873 Once a new device is physically attached to the remote host computer,
6874 it appears in this list and remains there until detached.
6875 </desc>
6876 </attribute>
6877
6878 <attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6879 <desc>
6880 Collection of shared folders for the current session. These folders
6881 are called transient shared folders because they are available to the
6882 guest OS running inside the associated virtual machine only for the
6883 duration of the session (as opposed to
6884 <link to="IMachine::sharedFolders"/> which represent permanent shared
6885 folders). When the session is closed (e.g. the machine is powered down),
6886 these folders are automatically discarded.
6887
6888 New shared folders are added to the collection using
6889 <link to="#createSharedFolder"/>. Existing shared folders can be
6890 removed using <link to="#removeSharedFolder"/>.
6891 </desc>
6892 </attribute>
6893
6894 <attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6895 <desc>
6896 Interface that provides information on Remote Desktop Extension (VRDE) connection.
6897 </desc>
6898 </attribute>
6899
6900 <attribute name="eventSource" type="IEventSource" readonly="yes">
6901 <desc>
6902 Event source for console events.
6903 </desc>
6904 </attribute>
6905
6906 <attribute name="attachedPCIDevices" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
6907 <desc>Array of PCI devices attached to this machine.</desc>
6908 </attribute>
6909
6910 <attribute name="useHostClipboard" type="boolean">
6911 <desc>
6912 Whether the guest clipboard should be connected to the host one or
6913 whether it should only be allowed access to the VRDE clipboard. This
6914 setting may not affect existing guest clipboard connections which
6915 are already connected to the host clipboard.
6916 </desc>
6917 </attribute>
6918
6919 <method name="powerUp">
6920 <desc>
6921 Starts the virtual machine execution using the current machine
6922 state (that is, its current execution state, current settings and
6923 current storage devices).
6924
6925 <note>
6926 This method is only useful for front-ends that want to actually
6927 execute virtual machines in their own process (like the VirtualBox
6928 or VBoxSDL front-ends). Unless you are intending to write such a
6929 front-end, do not call this method. If you simply want to
6930 start virtual machine execution using one of the existing front-ends
6931 (for example the VirtualBox GUI or headless server), use
6932 <link to="IMachine::launchVMProcess"/> instead; these
6933 front-ends will power up the machine automatically for you.
6934 </note>
6935
6936 If the machine is powered off or aborted, the execution will
6937 start from the beginning (as if the real hardware were just
6938 powered on).
6939
6940 If the machine is in the <link to="MachineState_Saved"/> state,
6941 it will continue its execution the point where the state has
6942 been saved.
6943
6944 If the machine <link to="IMachine::teleporterEnabled"/> property is
6945 enabled on the machine being powered up, the machine will wait for an
6946 incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6947 state. The returned progress object will have at least three
6948 operations where the last three are defined as: (1) powering up and
6949 starting TCP server, (2) waiting for incoming teleportations, and
6950 (3) perform teleportation. These operations will be reflected as the
6951 last three operations of the progress objected returned by
6952 <link to="IMachine::launchVMProcess"/> as well.
6953
6954 <see><link to="#saveState"/></see>
6955
6956 <result name="VBOX_E_INVALID_VM_STATE">
6957 Virtual machine already running.
6958 </result>
6959 <result name="VBOX_E_HOST_ERROR">
6960 Host interface does not exist or name not set.
6961 </result>
6962 <result name="VBOX_E_FILE_ERROR">
6963 Invalid saved state file.
6964 </result>
6965 </desc>
6966 <param name="progress" type="IProgress" dir="return">
6967 <desc>Progress object to track the operation completion.</desc>
6968 </param>
6969 </method>
6970
6971 <method name="powerUpPaused">
6972 <desc>
6973 Identical to powerUp except that the VM will enter the
6974 <link to="MachineState_Paused"/> state, instead of
6975 <link to="MachineState_Running"/>.
6976
6977 <see><link to="#powerUp"/></see>
6978 <result name="VBOX_E_INVALID_VM_STATE">
6979 Virtual machine already running.
6980 </result>
6981 <result name="VBOX_E_HOST_ERROR">
6982 Host interface does not exist or name not set.
6983 </result>
6984 <result name="VBOX_E_FILE_ERROR">
6985 Invalid saved state file.
6986 </result>
6987 </desc>
6988 <param name="progress" type="IProgress" dir="return">
6989 <desc>Progress object to track the operation completion.</desc>
6990 </param>
6991 </method>
6992
6993 <method name="powerDown">
6994 <desc>
6995 Initiates the power down procedure to stop the virtual machine
6996 execution.
6997
6998 The completion of the power down procedure is tracked using the returned
6999 IProgress object. After the operation is complete, the machine will go
7000 to the PoweredOff state.
7001 <result name="VBOX_E_INVALID_VM_STATE">
7002 Virtual machine must be Running, Paused or Stuck to be powered down.
7003 </result>
7004 </desc>
7005 <param name="progress" type="IProgress" dir="return">
7006 <desc>Progress object to track the operation completion.</desc>
7007 </param>
7008 </method>
7009
7010 <method name="reset">
7011 <desc>Resets the virtual machine.
7012 <result name="VBOX_E_INVALID_VM_STATE">
7013 Virtual machine not in Running state.
7014 </result>
7015 <result name="VBOX_E_VM_ERROR">
7016 Virtual machine error in reset operation.
7017 </result>
7018 </desc>
7019 </method>
7020
7021 <method name="pause">
7022 <desc>Pauses the virtual machine execution.
7023 <result name="VBOX_E_INVALID_VM_STATE">
7024 Virtual machine not in Running state.
7025 </result>
7026 <result name="VBOX_E_VM_ERROR">
7027 Virtual machine error in suspend operation.
7028 </result>
7029 </desc>
7030 </method>
7031
7032 <method name="resume">
7033 <desc>Resumes the virtual machine execution.
7034 <result name="VBOX_E_INVALID_VM_STATE">
7035 Virtual machine not in Paused state.
7036 </result>
7037 <result name="VBOX_E_VM_ERROR">
7038 Virtual machine error in resume operation.
7039 </result>
7040 </desc>
7041 </method>
7042
7043 <method name="powerButton">
7044 <desc>Sends the ACPI power button event to the guest.
7045 <result name="VBOX_E_INVALID_VM_STATE">
7046 Virtual machine not in Running state.
7047 </result>
7048 <result name="VBOX_E_PDM_ERROR">
7049 Controlled power off failed.
7050 </result>
7051 </desc>
7052 </method>
7053
7054 <method name="sleepButton">
7055 <desc>Sends the ACPI sleep button event to the guest.
7056 <result name="VBOX_E_INVALID_VM_STATE">
7057 Virtual machine not in Running state.
7058 </result>
7059 <result name="VBOX_E_PDM_ERROR">
7060 Sending sleep button event failed.
7061 </result>
7062 </desc>
7063 </method>
7064
7065 <method name="getPowerButtonHandled">
7066 <desc>Checks if the last power button event was handled by guest.
7067 <result name="VBOX_E_PDM_ERROR">
7068 Checking if the event was handled by the guest OS failed.
7069 </result>
7070 </desc>
7071 <param name="handled" type="boolean" dir="return"/>
7072 </method>
7073
7074 <method name="getGuestEnteredACPIMode">
7075 <desc>Checks if the guest entered the ACPI mode G0 (working) or
7076 G1 (sleeping). If this method returns @c false, the guest will
7077 most likely not respond to external ACPI events.
7078 <result name="VBOX_E_INVALID_VM_STATE">
7079 Virtual machine not in Running state.
7080 </result>
7081 </desc>
7082 <param name="entered" type="boolean" dir="return"/>
7083 </method>
7084
7085 <method name="saveState">
7086 <desc>
7087 Saves the current execution state of a running virtual machine
7088 and stops its execution.
7089
7090 After this operation completes, the machine will go to the
7091 Saved state. Next time it is powered up, this state will
7092 be restored and the machine will continue its execution from
7093 the place where it was saved.
7094
7095 This operation differs from taking a snapshot to the effect
7096 that it doesn't create new differencing media. Also, once
7097 the machine is powered up from the state saved using this method,
7098 the saved state is deleted, so it will be impossible to return
7099 to this state later.
7100
7101 <note>
7102 On success, this method implicitly calls
7103 <link to="IMachine::saveSettings"/> to save all current machine
7104 settings (including runtime changes to the DVD medium, etc.).
7105 Together with the impossibility to change any VM settings when it is
7106 in the Saved state, this guarantees adequate hardware
7107 configuration of the machine when it is restored from the saved
7108 state file.
7109 </note>
7110
7111 <note>
7112 The machine must be in the Running or Paused state, otherwise
7113 the operation will fail.
7114 </note>
7115 <result name="VBOX_E_INVALID_VM_STATE">
7116 Virtual machine state neither Running nor Paused.
7117 </result>
7118 <result name="VBOX_E_FILE_ERROR">
7119 Failed to create directory for saved state file.
7120 </result>
7121
7122 <see><link to="#takeSnapshot"/></see>
7123 </desc>
7124 <param name="progress" type="IProgress" dir="return">
7125 <desc>Progress object to track the operation completion.</desc>
7126 </param>
7127 </method>
7128
7129 <method name="adoptSavedState">
7130 <desc>
7131 Associates the given saved state file to the virtual machine.
7132
7133 On success, the machine will go to the Saved state. Next time it is
7134 powered up, it will be restored from the adopted saved state and
7135 continue execution from the place where the saved state file was
7136 created.
7137
7138 The specified saved state file path may be absolute or relative to the
7139 folder the VM normally saves the state to (usually,
7140 <link to="IMachine::snapshotFolder"/>).
7141
7142 <note>
7143 It's a caller's responsibility to make sure the given saved state
7144 file is compatible with the settings of this virtual machine that
7145 represent its virtual hardware (memory size, storage disk configuration
7146 etc.). If there is a mismatch, the behavior of the virtual machine
7147 is undefined.
7148 </note>
7149 <result name="VBOX_E_INVALID_VM_STATE">
7150 Virtual machine state neither PoweredOff nor Aborted.
7151 </result>
7152 </desc>
7153 <param name="savedStateFile" type="wstring" dir="in">
7154 <desc>Path to the saved state file to adopt.</desc>
7155 </param>
7156 </method>
7157
7158 <method name="discardSavedState">
7159 <desc>
7160 Forcibly resets the machine to "Powered Off" state if it is
7161 currently in the "Saved" state (previously created by <link to="#saveState"/>).
7162 Next time the machine is powered up, a clean boot will occur.
7163 <note>
7164 This operation is equivalent to resetting or powering off
7165 the machine without doing a proper shutdown of the guest
7166 operating system; as with resetting a running phyiscal
7167 computer, it can can lead to data loss.
7168 </note>
7169 If @a fRemoveFile is @c true, the file in the machine directory
7170 into which the machine state was saved is also deleted. If
7171 this is @c false, then the state can be recovered and later
7172 re-inserted into a machine using <link to="#adoptSavedState" />.
7173 The location of the file can be found in the
7174 <link to="IMachine::stateFilePath" /> attribute.
7175 <result name="VBOX_E_INVALID_VM_STATE">
7176 Virtual machine not in state Saved.
7177 </result>
7178 </desc>
7179 <param name="fRemoveFile" type="boolean" dir="in" >
7180 <desc>Whether to also remove the saved state file.</desc>
7181 </param>
7182 </method>
7183
7184 <method name="getDeviceActivity">
7185 <desc>
7186 Gets the current activity type of a given device or device group.
7187 <result name="E_INVALIDARG">
7188 Invalid device type.
7189 </result>
7190 </desc>
7191 <param name="type" type="DeviceType" dir="in"/>
7192 <param name="activity" type="DeviceActivity" dir="return"/>
7193 </method>
7194
7195 <method name="attachUSBDevice">
7196 <desc>
7197 Attaches a host USB device with the given UUID to the
7198 USB controller of the virtual machine.
7199
7200 The device needs to be in one of the following states:
7201 <link to="USBDeviceState_Busy"/>,
7202 <link to="USBDeviceState_Available"/> or
7203 <link to="USBDeviceState_Held"/>,
7204 otherwise an error is immediately returned.
7205
7206 When the device state is
7207 <link to="USBDeviceState_Busy">Busy</link>, an error may also
7208 be returned if the host computer refuses to release it for some reason.
7209
7210 <see><link to="IUSBController::deviceFilters"/>,
7211 <link to="USBDeviceState"/></see>
7212 <result name="VBOX_E_INVALID_VM_STATE">
7213 Virtual machine state neither Running nor Paused.
7214 </result>
7215 <result name="VBOX_E_PDM_ERROR">
7216 Virtual machine does not have a USB controller.
7217 </result>
7218 </desc>
7219 <param name="id" type="uuid" mod="string" dir="in">
7220 <desc>UUID of the host USB device to attach.</desc>
7221 </param>
7222 </method>
7223
7224 <method name="detachUSBDevice">
7225 <desc>
7226 Detaches an USB device with the given UUID from the USB controller
7227 of the virtual machine.
7228
7229 After this method succeeds, the VirtualBox server re-initiates
7230 all USB filters as if the device were just physically attached
7231 to the host, but filters of this machine are ignored to avoid
7232 a possible automatic re-attachment.
7233
7234 <see><link to="IUSBController::deviceFilters"/>,
7235 <link to="USBDeviceState"/></see>
7236
7237 <result name="VBOX_E_PDM_ERROR">
7238 Virtual machine does not have a USB controller.
7239 </result>
7240 <result name="E_INVALIDARG">
7241 USB device not attached to this virtual machine.
7242 </result>
7243 </desc>
7244 <param name="id" type="uuid" mod="string" dir="in">
7245 <desc>UUID of the USB device to detach.</desc>
7246 </param>
7247 <param name="device" type="IUSBDevice" dir="return">
7248 <desc>Detached USB device.</desc>
7249 </param>
7250 </method>
7251
7252 <method name="findUSBDeviceByAddress">
7253 <desc>
7254 Searches for a USB device with the given host address.
7255
7256 <result name="VBOX_E_OBJECT_NOT_FOUND">
7257 Given @c name does not correspond to any USB device.
7258 </result>
7259
7260 <see><link to="IUSBDevice::address"/></see>
7261 </desc>
7262 <param name="name" type="wstring" dir="in">
7263 <desc>
7264 Address of the USB device (as assigned by the host) to
7265 search for.
7266 </desc>
7267 </param>
7268 <param name="device" type="IUSBDevice" dir="return">
7269 <desc>Found USB device object.</desc>
7270 </param>
7271 </method>
7272
7273 <method name="findUSBDeviceById">
7274 <desc>
7275 Searches for a USB device with the given UUID.
7276
7277 <result name="VBOX_E_OBJECT_NOT_FOUND">
7278 Given @c id does not correspond to any USB device.
7279 </result>
7280
7281 <see><link to="IUSBDevice::id"/></see>
7282 </desc>
7283 <param name="id" type="uuid" mod="string" dir="in">
7284 <desc>UUID of the USB device to search for.</desc>
7285 </param>
7286 <param name="device" type="IUSBDevice" dir="return">
7287 <desc>Found USB device object.</desc>
7288 </param>
7289 </method>
7290
7291 <method name="createSharedFolder">
7292 <desc>
7293 Creates a transient new shared folder by associating the given logical
7294 name with the given host path, adds it to the collection of shared
7295 folders and starts sharing it. Refer to the description of
7296 <link to="ISharedFolder"/> to read more about logical names.
7297
7298 <result name="VBOX_E_INVALID_VM_STATE">
7299 Virtual machine in Saved state or currently changing state.
7300 </result>
7301 <result name="VBOX_E_FILE_ERROR">
7302 Shared folder already exists or not accessible.
7303 </result>
7304 </desc>
7305 <param name="name" type="wstring" dir="in">
7306 <desc>Unique logical name of the shared folder.</desc>
7307 </param>
7308 <param name="hostPath" type="wstring" dir="in">
7309 <desc>Full path to the shared folder in the host file system.</desc>
7310 </param>
7311 <param name="writable" type="boolean" dir="in">
7312 <desc>Whether the share is writable or readonly</desc>
7313 </param>
7314 <param name="automount" type="boolean" dir="in">
7315 <desc>Whether the share gets automatically mounted by the guest
7316 or not.</desc>
7317 </param>
7318 </method>
7319
7320 <method name="removeSharedFolder">
7321 <desc>
7322 Removes a transient shared folder with the given name previously
7323 created by <link to="#createSharedFolder"/> from the collection of
7324 shared folders and stops sharing it.
7325 <result name="VBOX_E_INVALID_VM_STATE">
7326 Virtual machine in Saved state or currently changing state.
7327 </result>
7328 <result name="VBOX_E_FILE_ERROR">
7329 Shared folder does not exists.
7330 </result>
7331 </desc>
7332 <param name="name" type="wstring" dir="in">
7333 <desc>Logical name of the shared folder to remove.</desc>
7334 </param>
7335 </method>
7336
7337 <method name="takeSnapshot">
7338 <desc>
7339 Saves the current execution state
7340 and all settings of the machine and creates differencing images
7341 for all normal (non-independent) media.
7342 See <link to="ISnapshot" /> for an introduction to snapshots.
7343
7344 This method can be called for a PoweredOff, Saved (see
7345 <link to="#saveState"/>), Running or
7346 Paused virtual machine. When the machine is PoweredOff, an
7347 offline snapshot is created. When the machine is Running a live
7348 snapshot is created, and an online snapshot is created when Paused.
7349
7350 The taken snapshot is always based on the
7351 <link to="IMachine::currentSnapshot">current snapshot</link>
7352 of the associated virtual machine and becomes a new current snapshot.
7353
7354 <note>
7355 This method implicitly calls <link to="IMachine::saveSettings"/> to
7356 save all current machine settings before taking an offline snapshot.
7357 </note>
7358
7359 <result name="VBOX_E_INVALID_VM_STATE">
7360 Virtual machine currently changing state.
7361 </result>
7362 </desc>
7363 <param name="name" type="wstring" dir="in">
7364 <desc>Short name for the snapshot.</desc>
7365 </param>
7366 <param name="description" type="wstring" dir="in">
7367 <desc>Optional description of the snapshot.</desc>
7368 </param>
7369 <param name="progress" type="IProgress" dir="return">
7370 <desc>Progress object to track the operation completion.</desc>
7371 </param>
7372 </method>
7373
7374 <method name="deleteSnapshot">
7375 <desc>
7376 Starts deleting the specified snapshot asynchronously.
7377 See <link to="ISnapshot" /> for an introduction to snapshots.
7378
7379 The execution state and settings of the associated machine stored in
7380 the snapshot will be deleted. The contents of all differencing media of
7381 this snapshot will be merged with the contents of their dependent child
7382 media to keep the medium chain valid (in other words, all changes
7383 represented by media being deleted will be propagated to their child
7384 medium). After that, this snapshot's differencing medium will be
7385 deleted. The parent of this snapshot will become a new parent for all
7386 its child snapshots.
7387
7388 If the deleted snapshot is the current one, its parent snapshot will
7389 become a new current snapshot. The current machine state is not directly
7390 affected in this case, except that currently attached differencing
7391 media based on media of the deleted snapshot will be also merged as
7392 described above.
7393
7394 If the deleted snapshot is the first or current snapshot, then the
7395 respective IMachine attributes will be adjusted. Deleting the current
7396 snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7397 to make all current machine settings permanent.
7398
7399 Deleting a snapshot has the following preconditions:
7400
7401 <ul>
7402 <li>Child media of all normal media of the deleted snapshot
7403 must be accessible (see <link to="IMedium::state"/>) for this
7404 operation to succeed. If only one running VM refers to all images
7405 which participates in merging the operation can be performed while
7406 the VM is running. Otherwise all virtual machines whose media are
7407 directly or indirectly based on the media of deleted snapshot must
7408 be powered off. In any case, online snapshot deleting usually is
7409 slower than the same operation without any running VM.</li>
7410
7411 <li>You cannot delete the snapshot if a medium attached to it has
7412 more than one child medium (differencing images) because otherwise
7413 merging would be impossible. This might be the case if there is
7414 more than one child snapshot or differencing images were created
7415 for other reason (e.g. implicitly because of multiple machine
7416 attachments).</li>
7417 </ul>
7418
7419 The virtual machine's <link to="IMachine::state">state</link> is
7420 changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
7421 "DeletingSnapshotPaused" while this operation is in progress.
7422
7423 <note>
7424 Merging medium contents can be very time and disk space
7425 consuming, if these media are big in size and have many
7426 children. However, if the snapshot being deleted is the last
7427 (head) snapshot on the branch, the operation will be rather
7428 quick.
7429 </note>
7430 <result name="VBOX_E_INVALID_VM_STATE">
7431 The running virtual machine prevents deleting this snapshot. This
7432 happens only in very specific situations, usually snapshots can be
7433 deleted without trouble while a VM is running. The error message
7434 text explains the reason for the failure.
7435 </result>
7436 </desc>
7437 <param name="id" type="uuid" mod="string" dir="in">
7438 <desc>UUID of the snapshot to delete.</desc>
7439 </param>
7440 <param name="progress" type="IProgress" dir="return">
7441 <desc>Progress object to track the operation completion.</desc>
7442 </param>
7443 </method>
7444
7445 <method name="deleteSnapshotAndAllChildren">
7446 <desc>
7447 Starts deleting the specified snapshot and all its children
7448 asynchronously. See <link to="ISnapshot" /> for an introduction to
7449 snapshots. The conditions and many details are the same as with
7450 <link to="#deleteSnapshot"/>.
7451
7452 This operation is very fast if the snapshot subtree does not include
7453 the current state. It is still significantly faster than deleting the
7454 snapshots one by one if the current state is in the subtree and there
7455 are more than one snapshots from current state to the snapshot which
7456 marks the subtree, since it eliminates the incremental image merging.
7457
7458 <note>This API method is right now not implemented!</note>
7459
7460 <result name="VBOX_E_INVALID_VM_STATE">
7461 The running virtual machine prevents deleting this snapshot. This
7462 happens only in very specific situations, usually snapshots can be
7463 deleted without trouble while a VM is running. The error message
7464 text explains the reason for the failure.
7465 </result>
7466 <result name="E_NOTIMPL">
7467 The method is not implemented yet.
7468 </result>
7469 </desc>
7470 <param name="id" type="uuid" mod="string" dir="in">
7471 <desc>UUID of the snapshot to delete, including all its children.</desc>
7472 </param>
7473 <param name="progress" type="IProgress" dir="return">
7474 <desc>Progress object to track the operation completion.</desc>
7475 </param>
7476 </method>
7477
7478 <method name="deleteSnapshotRange">
7479 <desc>
7480 Starts deleting the specified snapshot range. This is limited to
7481 linear snapshot lists, which means there may not be any other child
7482 snapshots other than the direct sequence between the start and end
7483 snapshot. If the start and end snapshot point to the same snapshot this
7484 method is completely equivalent to <link to="#deleteSnapshot"/>. See
7485 <link to="ISnapshot" /> for an introduction to snapshots. The
7486 conditions and many details are the same as with
7487 <link to="#deleteSnapshot"/>.
7488
7489 This operation is generally faster than deleting snapshots one by one
7490 and often also needs less extra disk space before freeing up disk space
7491 by deleting the removed disk images corresponding to the snapshot.
7492
7493 <note>This API method is right now not implemented!</note>
7494
7495 <result name="VBOX_E_INVALID_VM_STATE">
7496 The running virtual machine prevents deleting this snapshot. This
7497 happens only in very specific situations, usually snapshots can be
7498 deleted without trouble while a VM is running. The error message
7499 text explains the reason for the failure.
7500 </result>
7501 <result name="E_NOTIMPL">
7502 The method is not implemented yet.
7503 </result>
7504 </desc>
7505 <param name="startId" type="uuid" mod="string" dir="in">
7506 <desc>UUID of the first snapshot to delete.</desc>
7507 </param>
7508 <param name="endId" type="uuid" mod="string" dir="in">
7509 <desc>UUID of the last snapshot to delete.</desc>
7510 </param>
7511 <param name="progress" type="IProgress" dir="return">
7512 <desc>Progress object to track the operation completion.</desc>
7513 </param>
7514 </method>
7515
7516 <method name="restoreSnapshot">
7517 <desc>
7518 Starts resetting the machine's current state to the state contained
7519 in the given snapshot, asynchronously. All current settings of the
7520 machine will be reset and changes stored in differencing media
7521 will be lost.
7522 See <link to="ISnapshot" /> for an introduction to snapshots.
7523
7524 After this operation is successfully completed, new empty differencing
7525 media are created for all normal media of the machine.
7526
7527 If the given snapshot is an online snapshot, the machine will go to
7528 the <link to="MachineState_Saved"> saved state</link>, so that the
7529 next time it is powered on, the execution state will be restored
7530 from the state of the snapshot.
7531
7532 <note>
7533 The machine must not be running, otherwise the operation will fail.
7534 </note>
7535
7536 <note>
7537 If the machine state is <link to="MachineState_Saved">Saved</link>
7538 prior to this operation, the saved state file will be implicitly
7539 deleted (as if <link to="IConsole::discardSavedState"/> were
7540 called).
7541 </note>
7542
7543 <result name="VBOX_E_INVALID_VM_STATE">
7544 Virtual machine is running.
7545 </result>
7546 </desc>
7547 <param name="snapshot" type="ISnapshot" dir="in">
7548 <desc>The snapshot to restore the VM state from.</desc>
7549 </param>
7550 <param name="progress" type="IProgress" dir="return">
7551 <desc>Progress object to track the operation completion.</desc>
7552 </param>
7553 </method>
7554
7555 <method name="teleport">
7556 <desc>
7557 Teleport the VM to a different host machine or process.
7558
7559 TODO explain the details.
7560
7561 <result name="VBOX_E_INVALID_VM_STATE">
7562 Virtual machine not running or paused.
7563 </result>
7564 </desc>
7565 <param name="hostname" type="wstring" dir="in">
7566 <desc>The name or IP of the host to teleport to.</desc>
7567 </param>
7568 <param name="tcpport" type="unsigned long" dir="in">
7569 <desc>The TCP port to connect to (1..65535).</desc>
7570 </param>
7571 <param name="password" type="wstring" dir="in">
7572 <desc>The password.</desc>
7573 </param>
7574 <param name="maxDowntime" type="unsigned long" dir="in">
7575 <desc>
7576 The maximum allowed downtime given as milliseconds. 0 is not a valid
7577 value. Recommended value: 250 ms.
7578
7579 The higher the value is, the greater the chance for a successful
7580 teleportation. A small value may easily result in the teleportation
7581 process taking hours and eventually fail.
7582
7583 <note>
7584 The current implementation treats this a guideline, not as an
7585 absolute rule.
7586 </note>
7587 </desc>
7588 </param>
7589 <param name="progress" type="IProgress" dir="return">
7590 <desc>Progress object to track the operation completion.</desc>
7591 </param>
7592 </method>
7593
7594 </interface>
7595
7596 <!--
7597 // IHost
7598 /////////////////////////////////////////////////////////////////////////
7599 -->
7600
7601 <enum
7602 name="HostNetworkInterfaceMediumType"
7603 uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7604 >
7605 <desc>
7606 Type of encapsulation. Ethernet encapsulation includes both wired and
7607 wireless Ethernet connections.
7608 <see><link to="IHostNetworkInterface"/></see>
7609 </desc>
7610
7611 <const name="Unknown" value="0">
7612 <desc>
7613 The type of interface cannot be determined.
7614 </desc>
7615 </const>
7616 <const name="Ethernet" value="1">
7617 <desc>
7618 Ethernet frame encapsulation.
7619 </desc>
7620 </const>
7621 <const name="PPP" value="2">
7622 <desc>
7623 Point-to-point protocol encapsulation.
7624 </desc>
7625 </const>
7626 <const name="SLIP" value="3">
7627 <desc>
7628 Serial line IP encapsulation.
7629 </desc>
7630 </const>
7631 </enum>
7632
7633 <enum
7634 name="HostNetworkInterfaceStatus"
7635 uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7636 >
7637 <desc>
7638 Current status of the interface.
7639 <see><link to="IHostNetworkInterface"/></see>
7640 </desc>
7641
7642 <const name="Unknown" value="0">
7643 <desc>
7644 The state of interface cannot be determined.
7645 </desc>
7646 </const>
7647 <const name="Up" value="1">
7648 <desc>
7649 The interface is fully operational.
7650 </desc>
7651 </const>
7652 <const name="Down" value="2">
7653 <desc>
7654 The interface is not functioning.
7655 </desc>
7656 </const>
7657 </enum>
7658
7659 <enum
7660 name="HostNetworkInterfaceType"
7661 uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7662 >
7663 <desc>
7664 Network interface type.
7665 </desc>
7666 <const name="Bridged" value="1"/>
7667 <const name="HostOnly" value="2"/>
7668 </enum>
7669
7670 <interface
7671 name="IHostNetworkInterface" extends="$unknown"
7672 uuid="87a4153d-6889-4dd6-9654-2e9ff0ae8dec"
7673 wsmap="managed"
7674 >
7675 <desc>
7676 Represents one of host's network interfaces. IP V6 address and network
7677 mask are strings of 32 hexdecimal digits grouped by four. Groups are
7678 separated by colons.
7679 For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7680 </desc>
7681 <attribute name="name" type="wstring" readonly="yes">
7682 <desc>Returns the host network interface name.</desc>
7683 </attribute>
7684
7685 <attribute name="id" type="uuid" mod="string" readonly="yes">
7686 <desc>Returns the interface UUID.</desc>
7687 </attribute>
7688
7689 <attribute name="networkName" type="wstring" readonly="yes">
7690 <desc>Returns the name of a virtual network the interface gets attached to.</desc>
7691 </attribute>
7692
7693 <attribute name="DHCPEnabled" type="boolean" readonly="yes">
7694 <desc>Specifies whether the DHCP is enabled for the interface.</desc>
7695 </attribute>
7696
7697 <attribute name="IPAddress" type="wstring" readonly="yes">
7698 <desc>Returns the IP V4 address of the interface.</desc>
7699 </attribute>
7700
7701 <attribute name="networkMask" type="wstring" readonly="yes">
7702 <desc>Returns the network mask of the interface.</desc>
7703 </attribute>
7704
7705 <attribute name="IPV6Supported" type="boolean" readonly="yes">
7706 <desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7707 </attribute>
7708
7709 <attribute name="IPV6Address" type="wstring" readonly="yes">
7710 <desc>Returns the IP V6 address of the interface.</desc>
7711 </attribute>
7712
7713 <attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7714 <desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7715 </attribute>
7716
7717 <attribute name="hardwareAddress" type="wstring" readonly="yes">
7718 <desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7719 </attribute>
7720
7721 <attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7722 <desc>Type of protocol encapsulation used.</desc>
7723 </attribute>
7724
7725 <attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7726 <desc>Status of the interface.</desc>
7727 </attribute>
7728
7729 <attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7730 <desc>specifies the host interface type.</desc>
7731 </attribute>
7732
7733 <method name="enableStaticIPConfig">
7734 <desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7735 <param name="IPAddress" type="wstring" dir="in">
7736 <desc>
7737 IP address.
7738 </desc>
7739 </param>
7740 <param name="networkMask" type="wstring" dir="in">
7741 <desc>
7742 network mask.
7743 </desc>
7744 </param>
7745 </method>
7746
7747 <method name="enableStaticIPConfigV6">
7748 <desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7749 <param name="IPV6Address" type="wstring" dir="in">
7750 <desc>
7751 IP address.
7752 </desc>
7753 </param>
7754 <param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7755 <desc>
7756 network mask.
7757 </desc>
7758 </param>
7759 </method>
7760
7761 <method name="enableDynamicIPConfig">
7762 <desc>enables the dynamic IP configuration.</desc>
7763 </method>
7764
7765 <method name="DHCPRediscover">
7766 <desc>refreshes the IP configuration for DHCP-enabled interface.</desc>
7767 </method>
7768
7769 </interface>
7770
7771 <interface
7772 name="IHost" extends="$unknown"
7773 uuid="30678943-32df-4830-b413-931b25ac86a0"
7774 wsmap="managed"
7775 >
7776 <desc>
7777 The IHost interface represents the physical machine that this VirtualBox
7778 installation runs on.
7779
7780 An object implementing this interface is returned by the
7781 <link to="IVirtualBox::host" /> attribute. This interface contains
7782 read-only information about the host's physical hardware (such as what
7783 processors and disks are available, what the host operating system is,
7784 and so on) and also allows for manipulating some of the host's hardware,
7785 such as global USB device filters and host interface networking.
7786
7787 </desc>
7788 <attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7789 <desc>List of DVD drives available on the host.</desc>
7790 </attribute>
7791
7792 <attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7793 <desc>List of floppy drives available on the host.</desc>
7794 </attribute>
7795
7796 <attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7797 <desc>
7798 List of USB devices currently attached to the host.
7799 Once a new device is physically attached to the host computer,
7800 it appears in this list and remains there until detached.
7801
7802 <note>
7803 If USB functionality is not available in the given edition of
7804 VirtualBox, this method will set the result code to @c E_NOTIMPL.
7805 </note>
7806 </desc>
7807 </attribute>
7808
7809 <attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7810 <desc>
7811 List of USB device filters in action.
7812 When a new device is physically attached to the host computer,
7813 filters from this list are applied to it (in order they are stored
7814 in the list). The first matched filter will determine the
7815 <link to="IHostUSBDeviceFilter::action">action</link>
7816 performed on the device.
7817
7818 Unless the device is ignored by these filters, filters of all
7819 currently running virtual machines
7820 (<link to="IUSBController::deviceFilters"/>) are applied to it.
7821
7822 <note>
7823 If USB functionality is not available in the given edition of
7824 VirtualBox, this method will set the result code to @c E_NOTIMPL.
7825 </note>
7826
7827 <see><link to="IHostUSBDeviceFilter"/>,
7828 <link to="USBDeviceState"/></see>
7829 </desc>
7830 </attribute>
7831
7832 <attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7833 <desc>List of host network interfaces currently defined on the host.</desc>
7834 </attribute>
7835
7836 <attribute name="processorCount" type="unsigned long" readonly="yes">
7837 <desc>Number of (logical) CPUs installed in the host system.</desc>
7838 </attribute>
7839
7840 <attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7841 <desc>Number of (logical) CPUs online in the host system.</desc>
7842 </attribute>
7843
7844 <attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7845 <desc>Number of physical processor cores installed in the host system.</desc>
7846 </attribute>
7847
7848 <method name="getProcessorSpeed">
7849 <desc>Query the (approximate) maximum speed of a specified host CPU in
7850 Megahertz.
7851 </desc>
7852 <param name="cpuId" type="unsigned long" dir="in">
7853 <desc>
7854 Identifier of the CPU.
7855 </desc>
7856 </param>
7857 <param name="speed" type="unsigned long" dir="return">
7858 <desc>
7859 Speed value. 0 is returned if value is not known or @a cpuId is
7860 invalid.
7861 </desc>
7862 </param>
7863 </method>
7864
7865 <method name="getProcessorFeature">
7866 <desc>Query whether a CPU feature is supported or not.</desc>
7867 <param name="feature" type="ProcessorFeature" dir="in">
7868 <desc>
7869 CPU Feature identifier.
7870 </desc>
7871 </param>
7872 <param name="supported" type="boolean" dir="return">
7873 <desc>
7874 Feature is supported or not.
7875 </desc>
7876 </param>
7877 </method>
7878
7879 <method name="getProcessorDescription">
7880 <desc>Query the model string of a specified host CPU.
7881 </desc>
7882 <param name="cpuId" type="unsigned long" dir="in">
7883 <desc>
7884 Identifier of the CPU.
7885 <note>
7886 The current implementation might not necessarily return the
7887 description for this exact CPU.
7888 </note>
7889 </desc>
7890 </param>
7891 <param name="description" type="wstring" dir="return">
7892 <desc>
7893 Model string. An empty string is returned if value is not known or
7894 @a cpuId is invalid.
7895 </desc>
7896 </param>
7897 </method>
7898
7899 <method name="getProcessorCPUIDLeaf">
7900 <desc>
7901 Returns the CPU cpuid information for the specified leaf.
7902 </desc>
7903 <param name="cpuId" type="unsigned long" dir="in">
7904 <desc>
7905 Identifier of the CPU. The CPU most be online.
7906 <note>
7907 The current implementation might not necessarily return the
7908 description for this exact CPU.
7909 </note>
7910 </desc>
7911 </param>
7912 <param name="leaf" type="unsigned long" dir="in">
7913 <desc>
7914 CPUID leaf index (eax).
7915 </desc>
7916 </param>
7917 <param name="subLeaf" type="unsigned long" dir="in">
7918 <desc>
7919 CPUID leaf sub index (ecx). This currently only applies to cache
7920 information on Intel CPUs. Use 0 if retrieving values for
7921 <link to="IMachine::setCPUIDLeaf"/>.
7922 </desc>
7923 </param>
7924 <param name="valEax" type="unsigned long" dir="out">
7925 <desc>
7926 CPUID leaf value for register eax.
7927 </desc>
7928 </param>
7929 <param name="valEbx" type="unsigned long" dir="out">
7930 <desc>
7931 CPUID leaf value for register ebx.
7932 </desc>
7933 </param>
7934 <param name="valEcx" type="unsigned long" dir="out">
7935 <desc>
7936 CPUID leaf value for register ecx.
7937 </desc>
7938 </param>
7939 <param name="valEdx" type="unsigned long" dir="out">
7940 <desc>
7941 CPUID leaf value for register edx.
7942 </desc>
7943 </param>
7944 </method>
7945
7946 <attribute name="memorySize" type="unsigned long" readonly="yes">
7947 <desc>Amount of system memory in megabytes installed in the host system.</desc>
7948 </attribute>
7949
7950 <attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7951 <desc>Available system memory in the host system.</desc>
7952 </attribute>
7953
7954 <attribute name="operatingSystem" type="wstring" readonly="yes">
7955 <desc>Name of the host system's operating system.</desc>
7956 </attribute>
7957
7958 <attribute name="OSVersion" type="wstring" readonly="yes">
7959 <desc>Host operating system's version string.</desc>
7960 </attribute>
7961
7962 <attribute name="UTCTime" type="long long" readonly="yes">
7963 <desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7964 </attribute>
7965
7966 <attribute name="acceleration3DAvailable" type="boolean" readonly="yes">
7967 <desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7968 </attribute>
7969
7970 <method name="createHostOnlyNetworkInterface">
7971 <desc>
7972 Creates a new adapter for Host Only Networking.
7973 <result name="E_INVALIDARG">
7974 Host network interface @a name already exists.
7975 </result>
7976 </desc>
7977 <param name="hostInterface" type="IHostNetworkInterface" dir="out">
7978 <desc>
7979 Created host interface object.
7980 </desc>
7981 </param>
7982 <param name="progress" type="IProgress" dir="return">
7983 <desc>
7984 Progress object to track the operation completion.
7985 </desc>
7986 </param>
7987 </method>
7988
7989 <method name="removeHostOnlyNetworkInterface">
7990 <desc>
7991 Removes the given Host Only Networking interface.
7992 <result name="VBOX_E_OBJECT_NOT_FOUND">
7993 No host network interface matching @a id found.
7994 </result>
7995 </desc>
7996 <param name="id" type="uuid" mod="string" dir="in">
7997 <desc>
7998 Adapter GUID.
7999 </desc>
8000 </param>
8001 <param name="progress" type="IProgress" dir="return">
8002 <desc>
8003 Progress object to track the operation completion.
8004 </desc>
8005 </param>
8006 </method>
8007
8008 <method name="createUSBDeviceFilter">
8009 <desc>
8010 Creates a new USB device filter. All attributes except
8011 the filter name are set to empty (any match),
8012 <i>active</i> is @c false (the filter is not active).
8013
8014 The created filter can be added to the list of filters using
8015 <link to="#insertUSBDeviceFilter"/>.
8016
8017 <see><link to="#USBDeviceFilters"/></see>
8018 </desc>
8019 <param name="name" type="wstring" dir="in">
8020 <desc>
8021 Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
8022 </desc>
8023 </param>
8024 <param name="filter" type="IHostUSBDeviceFilter" dir="return">
8025 <desc>Created filter object.</desc>
8026 </param>
8027 </method>
8028
8029 <method name="insertUSBDeviceFilter">
8030 <desc>
8031 Inserts the given USB device to the specified position
8032 in the list of filters.
8033
8034 Positions are numbered starting from @c 0. If the specified
8035 position is equal to or greater than the number of elements in
8036 the list, the filter is added at the end of the collection.
8037
8038 <note>
8039 Duplicates are not allowed, so an attempt to insert a
8040 filter already in the list is an error.
8041 </note>
8042 <note>
8043 If USB functionality is not available in the given edition of
8044 VirtualBox, this method will set the result code to @c E_NOTIMPL.
8045 </note>
8046
8047 <see><link to="#USBDeviceFilters"/></see>
8048
8049 <result name="VBOX_E_INVALID_OBJECT_STATE">
8050 USB device filter is not created within this VirtualBox instance.
8051 </result>
8052 <result name="E_INVALIDARG">
8053 USB device filter already in list.
8054 </result>
8055
8056 </desc>
8057 <param name="position" type="unsigned long" dir="in">
8058 <desc>Position to insert the filter to.</desc>
8059 </param>
8060 <param name="filter" type="IHostUSBDeviceFilter" dir="in">
8061 <desc>USB device filter to insert.</desc>
8062 </param>
8063 </method>
8064
8065 <method name="removeUSBDeviceFilter">
8066 <desc>
8067 Removes a USB device filter from the specified position in the
8068 list of filters.
8069
8070 Positions are numbered starting from @c 0. Specifying a
8071 position equal to or greater than the number of elements in
8072 the list will produce an error.
8073
8074 <note>
8075 If USB functionality is not available in the given edition of
8076 VirtualBox, this method will set the result code to @c E_NOTIMPL.
8077 </note>
8078
8079 <see><link to="#USBDeviceFilters"/></see>
8080
8081 <result name="E_INVALIDARG">
8082 USB device filter list empty or invalid @a position.
8083 </result>
8084
8085 </desc>
8086 <param name="position" type="unsigned long" dir="in">
8087 <desc>Position to remove the filter from.</desc>
8088 </param>
8089 </method>
8090
8091 <method name="findHostDVDDrive">
8092 <desc>
8093 Searches for a host DVD drive with the given @c name.
8094
8095 <result name="VBOX_E_OBJECT_NOT_FOUND">
8096 Given @c name does not correspond to any host drive.
8097 </result>
8098
8099 </desc>
8100 <param name="name" type="wstring" dir="in">
8101 <desc>Name of the host drive to search for</desc>
8102 </param>
8103 <param name="drive" type="IMedium" dir="return">
8104 <desc>Found host drive object</desc>
8105 </param>
8106 </method>
8107
8108 <method name="findHostFloppyDrive">
8109 <desc>
8110 Searches for a host floppy drive with the given @c name.
8111
8112 <result name="VBOX_E_OBJECT_NOT_FOUND">
8113 Given @c name does not correspond to any host floppy drive.
8114 </result>
8115
8116 </desc>
8117 <param name="name" type="wstring" dir="in">
8118 <desc>Name of the host floppy drive to search for</desc>
8119 </param>
8120 <param name="drive" type="IMedium" dir="return">
8121 <desc>Found host floppy drive object</desc>
8122 </param>
8123 </method>
8124
8125 <method name="findHostNetworkInterfaceByName">
8126 <desc>
8127 Searches through all host network interfaces for an interface with
8128 the given @c name.
8129 <note>
8130 The method returns an error if the given @c name does not
8131 correspond to any host network interface.
8132 </note>
8133 </desc>
8134 <param name="name" type="wstring" dir="in">
8135 <desc>Name of the host network interface to search for.</desc>
8136 </param>
8137 <param name="networkInterface" type="IHostNetworkInterface" dir="return">
8138 <desc>Found host network interface object.</desc>
8139 </param>
8140 </method>
8141 <method name="findHostNetworkInterfaceById">
8142 <desc>
8143 Searches through all host network interfaces for an interface with
8144 the given GUID.
8145 <note>
8146 The method returns an error if the given GUID does not
8147 correspond to any host network interface.
8148 </note>
8149 </desc>
8150 <param name="id" type="uuid" mod="string" dir="in">
8151 <desc>GUID of the host network interface to search for.</desc>
8152 </param>
8153 <param name="networkInterface" type="IHostNetworkInterface" dir="return">
8154 <desc>Found host network interface object.</desc>
8155 </param>
8156 </method>
8157 <method name="findHostNetworkInterfacesOfType">
8158 <desc>
8159 Searches through all host network interfaces and returns a list of interfaces of the specified type
8160 </desc>
8161 <param name="type" type="HostNetworkInterfaceType" dir="in">
8162 <desc>type of the host network interfaces to search for.</desc>
8163 </param>
8164 <param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
8165 <desc>Found host network interface objects.</desc>
8166 </param>
8167 </method>
8168
8169 <method name="findUSBDeviceById">
8170 <desc>
8171 Searches for a USB device with the given UUID.
8172
8173 <result name="VBOX_E_OBJECT_NOT_FOUND">
8174 Given @c id does not correspond to any USB device.
8175 </result>
8176
8177 <see><link to="IUSBDevice::id"/></see>
8178 </desc>
8179 <param name="id" type="uuid" mod="string" dir="in">
8180 <desc>UUID of the USB device to search for.</desc>
8181 </param>
8182 <param name="device" type="IHostUSBDevice" dir="return">
8183 <desc>Found USB device object.</desc>
8184 </param>
8185 </method>
8186
8187 <method name="findUSBDeviceByAddress">
8188 <desc>
8189 Searches for a USB device with the given host address.
8190
8191 <result name="VBOX_E_OBJECT_NOT_FOUND">
8192 Given @c name does not correspond to any USB device.
8193 </result>
8194
8195 <see><link to="IUSBDevice::address"/></see>
8196 </desc>
8197 <param name="name" type="wstring" dir="in">
8198 <desc>
8199 Address of the USB device (as assigned by the host) to
8200 search for.
8201 </desc>
8202 </param>
8203 <param name="device" type="IHostUSBDevice" dir="return">
8204 <desc>Found USB device object.</desc>
8205 </param>
8206 </method>
8207
8208 <method name="generateMACAddress">
8209 <desc>
8210 Generates a valid Ethernet MAC address, 12 hexadecimal characters.
8211 </desc>
8212 <param name="address" type="wstring" dir="return">
8213 <desc>New Ethernet MAC address.</desc>
8214 </param>
8215 </method>
8216
8217 </interface>
8218
8219 <!--
8220 // ISystemProperties
8221 /////////////////////////////////////////////////////////////////////////
8222 -->
8223
8224 <interface
8225 name="ISystemProperties"
8226 extends="$unknown"
8227 uuid="1d7aca29-97f0-4287-9874-a60ec4f80ea6"
8228 wsmap="managed"
8229 >
8230 <desc>
8231 The ISystemProperties interface represents global properties of the given
8232 VirtualBox installation.
8233
8234 These properties define limits and default values for various attributes
8235 and parameters. Most of the properties are read-only, but some can be
8236 changed by a user.
8237 </desc>
8238
8239 <attribute name="minGuestRAM" type="unsigned long" readonly="yes">
8240 <desc>Minimum guest system memory in Megabytes.</desc>
8241 </attribute>
8242
8243 <attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
8244 <desc>Maximum guest system memory in Megabytes.</desc>
8245 </attribute>
8246
8247 <attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
8248 <desc>Minimum guest video memory in Megabytes.</desc>
8249 </attribute>
8250
8251 <attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
8252 <desc>Maximum guest video memory in Megabytes.</desc>
8253 </attribute>
8254
8255 <attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
8256 <desc>Minimum CPU count.</desc>
8257 </attribute>
8258
8259 <attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
8260 <desc>Maximum CPU count.</desc>
8261 </attribute>
8262
8263 <attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
8264 <desc>Maximum of monitors which could be connected.</desc>
8265 </attribute>
8266
8267 <attribute name="infoVDSize" type="long long" readonly="yes">
8268 <desc>Maximum size of a virtual disk image in bytes. Informational value,
8269 does not reflect the limits of any virtual disk image format.</desc>
8270 </attribute>
8271
8272 <attribute name="serialPortCount" type="unsigned long" readonly="yes">
8273 <desc>
8274 Maximum number of serial ports associated with every
8275 <link to="IMachine"/> instance.
8276 </desc>
8277 </attribute>
8278
8279 <attribute name="parallelPortCount" type="unsigned long" readonly="yes">
8280 <desc>
8281 Maximum number of parallel ports associated with every
8282 <link to="IMachine"/> instance.
8283 </desc>
8284 </attribute>
8285
8286 <attribute name="maxBootPosition" type="unsigned long" readonly="yes">
8287 <desc>
8288 Maximum device position in the boot order. This value corresponds
8289 to the total number of devices a machine can boot from, to make it
8290 possible to include all possible devices to the boot list.
8291 <see><link to="IMachine::setBootOrder"/></see>
8292 </desc>
8293 </attribute>
8294
8295 <attribute name="defaultMachineFolder" type="wstring">
8296 <desc>
8297 Full path to the default directory used to create new or open
8298 existing machines when a machine settings file name contains no
8299 path.
8300
8301 Starting with VirtualBox 4.0, by default, this attribute contains
8302 the full path of folder named "VirtualBox VMs" in the user's
8303 home directory, which depends on the host platform.
8304
8305 When setting this attribute, a full path must be specified.
8306 Setting this property to @c null or an empty string or the
8307 special value "Machines" (for compatibility reasons) will restore
8308 that default value.
8309
8310 If the folder specified herein does not exist, it will be created
8311 automatically as needed.
8312
8313 <see>
8314 <link to="IVirtualBox::createMachine"/>,
8315 <link to="IVirtualBox::openMachine"/>
8316 </see>
8317 </desc>
8318 </attribute>
8319
8320 <attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
8321 <desc>
8322 List of all medium storage formats supported by this VirtualBox
8323 installation.
8324
8325 Keep in mind that the medium format identifier
8326 (<link to="IMediumFormat::id"/>) used in other API calls like
8327 <link to="IVirtualBox::createHardDisk"/> to refer to a particular
8328 medium format is a case-insensitive string. This means that, for
8329 example, all of the following strings:
8330 <pre>
8331 "VDI"
8332 "vdi"
8333 "VdI"</pre>
8334 refer to the same medium format.
8335
8336 Note that the virtual medium framework is backend-based, therefore
8337 the list of supported formats depends on what backends are currently
8338 installed.
8339
8340 <see><link to="IMediumFormat"/></see>
8341 </desc>
8342 </attribute>
8343
8344 <attribute name="defaultHardDiskFormat" type="wstring">
8345 <desc>
8346 Identifier of the default medium format used by VirtualBox.
8347
8348 The medium format set by this attribute is used by VirtualBox
8349 when the medium format was not specified explicitly. One example is
8350 <link to="IVirtualBox::createHardDisk"/> with the empty
8351 format argument. A more complex example is implicit creation of
8352 differencing media when taking a snapshot of a virtual machine:
8353 this operation will try to use a format of the parent medium first
8354 and if this format does not support differencing media the default
8355 format specified by this argument will be used.
8356
8357 The list of supported medium formats may be obtained by the
8358 <link to="#mediumFormats"/> call. Note that the default medium
8359 format must have a capability to create differencing media;
8360 otherwise operations that create media implicitly may fail
8361 unexpectedly.
8362
8363 The initial value of this property is <tt>"VDI"</tt> in the current
8364 version of the VirtualBox product, but may change in the future.
8365
8366 <note>
8367 Setting this property to @c null or empty string will restore the
8368 initial value.
8369 </note>
8370
8371 <see>
8372 <link to="#mediumFormats"/>,
8373 <link to="IMediumFormat::id"/>,
8374 <link to="IVirtualBox::createHardDisk"/>
8375 </see>
8376 </desc>
8377 </attribute>
8378
8379 <attribute name="freeDiskSpaceWarning" type="long long">
8380 <desc>Issue a warning if the free disk space is below (or in some disk
8381 intensive operation is expected to go below) the given size in
8382 bytes.</desc>
8383 </attribute>
8384
8385 <attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8386 <desc>Issue a warning if the free disk space is below (or in some disk
8387 intensive operation is expected to go below) the given percentage.</desc>
8388 </attribute>
8389
8390 <attribute name="freeDiskSpaceError" type="long long">
8391 <desc>Issue an error if the free disk space is below (or in some disk
8392 intensive operation is expected to go below) the given size in
8393 bytes.</desc>
8394 </attribute>
8395
8396 <attribute name="freeDiskSpacePercentError" type="unsigned long">
8397 <desc>Issue an error if the free disk space is below (or in some disk
8398 intensive operation is expected to go below) the given percentage.</desc>
8399 </attribute>
8400
8401 <attribute name="VRDEAuthLibrary" type="wstring">
8402 <desc>
8403 Library that provides authentication for Remote Desktop clients. The library
8404 is used if a virtual machine's authentication type is set to "external"
8405 in the VM RemoteDisplay configuration.
8406
8407 The system library extension (".DLL" or ".so") must be omitted.
8408 A full path can be specified; if not, then the library must reside on the
8409 system's default library path.
8410
8411 The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
8412 of that name in one of the default VirtualBox library directories.
8413
8414 For details about VirtualBox authentication libraries and how to implement
8415 them, please refer to the VirtualBox manual.
8416
8417 <note>
8418 Setting this property to @c null or empty string will restore the
8419 initial value.
8420 </note>
8421 </desc>
8422 </attribute>
8423
8424 <attribute name="webServiceAuthLibrary" type="wstring">
8425 <desc>
8426 Library that provides authentication for webservice clients. The library
8427 is used if a virtual machine's authentication type is set to "external"
8428 in the VM RemoteDisplay configuration and will be called from
8429 within the <link to="IWebsessionManager::logon" /> implementation.
8430
8431 As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
8432 there is no per-VM setting for this, as the webservice is a global
8433 resource (if it is running). Only for this setting (for the webservice),
8434 setting this value to a literal <tt>"null"</tt> string disables authentication,
8435 meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8436 no matter what user name and password are supplied.
8437
8438 The initial value of this property is <tt>"VBoxAuth"</tt>,
8439 meaning that the webservice will use the same authentication
8440 library that is used by default for VRDE (again, see
8441 <link to="ISystemProperties::VRDEAuthLibrary" />).
8442 The format and calling convention of authentication libraries
8443 is the same for the webservice as it is for VRDE.
8444
8445 <note>
8446 Setting this property to @c null or empty string will restore the
8447 initial value.
8448 </note>
8449 </desc>
8450 </attribute>
8451
8452 <attribute name="defaultVRDEExtPack" type="wstring">
8453 <desc>
8454 The name of the extension pack providing the default VRDE.
8455
8456 This attribute is for choosing between multiple extension packs
8457 providing VRDE. If only one is installed, it will automatically be the
8458 default one. The attribute value can be empty if no VRDE extension
8459 pack is installed.
8460
8461 For details about VirtualBox Remote Desktop Extension and how to
8462 implement one, please refer to the VirtualBox SDK.
8463 </desc>
8464 </attribute>
8465
8466 <attribute name="logHistoryCount" type="unsigned long">
8467 <desc>
8468 This value specifies how many old release log files are kept.
8469 </desc>
8470 </attribute>
8471
8472 <attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8473 <desc>This value hold the default audio driver for the current
8474 system.</desc>
8475 </attribute>
8476
8477 <attribute name="autostartDatabasePath" type="wstring">
8478 <desc>
8479 The path to the autostart database. Depending on the host this might
8480 be a filesystem path or something else.
8481 </desc>
8482 </attribute>
8483
8484 <attribute name="defaultAdditionsISO" type="wstring">
8485 <desc>
8486 The path to the default Guest Additions ISO image. Can be empty if
8487 the location is not known in this installation.
8488 </desc>
8489 </attribute>
8490
8491 <method name="getMaxNetworkAdapters">
8492 <desc>
8493 Maximum total number of network adapters associated with every
8494 <link to="IMachine"/> instance.
8495 </desc>
8496
8497 <param name="chipset" type="ChipsetType" dir="in">
8498 <desc>The chipset type to get the value for.</desc>
8499 </param>
8500
8501
8502 <param name="maxNetworkAdapters" type="unsigned long" dir="return">
8503 <desc>The maximum total number of network adapters allowed.</desc>
8504 </param>
8505
8506 </method>
8507
8508 <method name="getMaxNetworkAdaptersOfType">
8509 <desc>
8510 Maximum number of network adapters of a given attachment type,
8511 associated with every <link to="IMachine"/> instance.
8512 </desc>
8513
8514 <param name="chipset" type="ChipsetType" dir="in">
8515 <desc>The chipset type to get the value for.</desc>
8516 </param>
8517
8518 <param name="type" type="NetworkAttachmentType" dir="in">
8519 <desc>Type of attachment.</desc>
8520 </param>
8521
8522 <param name="maxNetworkAdapters" type="unsigned long" dir="return">
8523 <desc>The maximum number of network adapters allowed for
8524 particular chipset and attachment type.</desc>
8525 </param>
8526
8527 </method>
8528
8529
8530 <method name="getMaxDevicesPerPortForStorageBus">
8531 <desc>Returns the maximum number of devices which can be attached to a port
8532 for the given storage bus.</desc>
8533
8534 <param name="bus" type="StorageBus" dir="in">
8535 <desc>The storage bus type to get the value for.</desc>
8536 </param>
8537
8538 <param name="maxDevicesPerPort" type="unsigned long" dir="return">
8539 <desc>The maximum number of devices which can be attached to the port for the given
8540 storage bus.</desc>
8541 </param>
8542 </method>
8543
8544 <method name="getMinPortCountForStorageBus">
8545 <desc>Returns the minimum number of ports the given storage bus supports.</desc>
8546
8547 <param name="bus" type="StorageBus" dir="in">
8548 <desc>The storage bus type to get the value for.</desc>
8549 </param>
8550
8551 <param name="minPortCount" type="unsigned long" dir="return">
8552 <desc>The minimum number of ports for the given storage bus.</desc>
8553 </param>
8554 </method>
8555
8556 <method name="getMaxPortCountForStorageBus">
8557 <desc>Returns the maximum number of ports the given storage bus supports.</desc>
8558
8559 <param name="bus" type="StorageBus" dir="in">
8560 <desc>The storage bus type to get the value for.</desc>
8561 </param>
8562
8563 <param name="maxPortCount" type="unsigned long" dir="return">
8564 <desc>The maximum number of ports for the given storage bus.</desc>
8565 </param>
8566 </method>
8567
8568 <method name="getMaxInstancesOfStorageBus">
8569 <desc>Returns the maximum number of storage bus instances which
8570 can be configured for each VM. This corresponds to the number of
8571 storage controllers one can have. Value may depend on chipset type
8572 used.</desc>
8573
8574 <param name="chipset" type="ChipsetType" dir="in">
8575 <desc>The chipset type to get the value for.</desc>
8576 </param>
8577
8578 <param name="bus" type="StorageBus" dir="in">
8579 <desc>The storage bus type to get the value for.</desc>
8580 </param>
8581
8582 <param name="maxInstances" type="unsigned long" dir="return">
8583 <desc>The maximum number of instances for the given storage bus.</desc>
8584 </param>
8585 </method>
8586
8587 <method name="getDeviceTypesForStorageBus">
8588 <desc>Returns list of all the supported device types
8589 (<link to="DeviceType"/>) for the given type of storage
8590 bus.</desc>
8591
8592 <param name="bus" type="StorageBus" dir="in">
8593 <desc>The storage bus type to get the value for.</desc>
8594 </param>
8595
8596 <param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8597 <desc>The list of all supported device types for the given storage bus.</desc>
8598 </param>
8599 </method>
8600
8601 <method name="getDefaultIoCacheSettingForStorageController">
8602 <desc>Returns the default I/O cache setting for the
8603 given storage controller</desc>
8604
8605 <param name="controllerType" type="StorageControllerType" dir="in">
8606 <desc>The storage controller to the setting for.</desc>
8607 </param>
8608
8609 <param name="enabled" type="boolean" dir="return">
8610 <desc>Returned flag indicating the default value</desc>
8611 </param>
8612 </method>
8613 </interface>
8614
8615 <!--
8616 // IGuest
8617 /////////////////////////////////////////////////////////////////////////
8618 -->
8619
8620 <interface
8621 name="IGuestOSType" extends="$unknown"
8622 uuid="6d968f9a-858b-4c50-bf17-241f069e94c2"
8623 wsmap="struct"
8624 >
8625 <desc>
8626 </desc>
8627
8628 <attribute name="familyId" type="wstring" readonly="yes">
8629 <desc>Guest OS family identifier string.</desc>
8630 </attribute>
8631
8632 <attribute name="familyDescription" type="wstring" readonly="yes">
8633 <desc>Human readable description of the guest OS family.</desc>
8634 </attribute>
8635
8636 <attribute name="id" type="wstring" readonly="yes">
8637 <desc>Guest OS identifier string.</desc>
8638 </attribute>
8639
8640 <attribute name="description" type="wstring" readonly="yes">
8641 <desc>Human readable description of the guest OS.</desc>
8642 </attribute>
8643
8644 <attribute name="is64Bit" type="boolean" readonly="yes">
8645 <desc>Returns @c true if the given OS is 64-bit</desc>
8646 </attribute>
8647
8648 <attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8649 <desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8650 </attribute>
8651
8652 <attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8653 <desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8654 </attribute>
8655
8656 <attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8657 <desc>Recommended RAM size in Megabytes.</desc>
8658 </attribute>
8659
8660 <attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8661 <desc>Recommended video RAM size in Megabytes.</desc>
8662 </attribute>
8663
8664 <attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8665 <desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8666 </attribute>
8667
8668 <attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8669 <desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8670 </attribute>
8671
8672 <attribute name="recommendedHDD" type="long long" readonly="yes">
8673 <desc>Recommended hard disk size in bytes.</desc>
8674 </attribute>
8675
8676 <attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8677 <desc>Returns recommended network adapter for this OS type.</desc>
8678 </attribute>
8679
8680 <attribute name="recommendedPAE" type="boolean" readonly="yes">
8681 <desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8682 </attribute>
8683
8684 <attribute name="recommendedDVDStorageController" type="StorageControllerType" readonly="yes">
8685 <desc>Recommended storage controller type for DVD/CD drives.</desc>
8686 </attribute>
8687
8688 <attribute name="recommendedDVDStorageBus" type="StorageBus" readonly="yes">
8689 <desc>Recommended storage bus type for DVD/CD drives.</desc>
8690 </attribute>
8691
8692 <attribute name="recommendedHDStorageController" type="StorageControllerType" readonly="yes">
8693 <desc>Recommended storage controller type for HD drives.</desc>
8694 </attribute>
8695
8696 <attribute name="recommendedHDStorageBus" type="StorageBus" readonly="yes">
8697 <desc>Recommended storage bus type for HD drives.</desc>
8698 </attribute>
8699
8700 <attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8701 <desc>Recommended firmware type.</desc>
8702 </attribute>
8703
8704 <attribute name="recommendedUSBHID" type="boolean" readonly="yes">
8705 <desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8706 </attribute>
8707
8708 <attribute name="recommendedHPET" type="boolean" readonly="yes">
8709 <desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8710 </attribute>
8711
8712 <attribute name="recommendedUSBTablet" type="boolean" readonly="yes">
8713 <desc>Returns @c true if using a USB Tablet is recommended.</desc>
8714 </attribute>
8715
8716 <attribute name="recommendedRTCUseUTC" type="boolean" readonly="yes">
8717 <desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8718 </attribute>
8719
8720 <attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8721 <desc>Recommended chipset type.</desc>
8722 </attribute>
8723
8724 <attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8725 <desc>Recommended audio type.</desc>
8726 </attribute>
8727
8728 <attribute name="recommendedFloppy" type="boolean" readonly="yes">
8729 <desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8730 </attribute>
8731
8732 <attribute name="recommendedUSB" type="boolean" readonly="yes">
8733 <desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8734 </attribute>
8735
8736 </interface>
8737
8738 <enum
8739 name="AdditionsFacilityType"
8740 uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8741 >
8742 <desc>
8743 Guest Additions facility IDs.
8744 </desc>
8745
8746 <const name="None" value="0">
8747 <desc>No/invalid facility.</desc>
8748 </const>
8749 <const name="VBoxGuestDriver" value="20">
8750 <desc>VirtualBox base driver (VBoxGuest).</desc>
8751 </const>
8752 <const name="AutoLogon" value="90">
8753 <desc>Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).</desc>
8754 </const>
8755 <const name="VBoxService" value="100">
8756 <desc>VirtualBox system service (VBoxService).</desc>
8757 </const>
8758 <const name="VBoxTrayClient" value="101">
8759 <desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8760 </const>
8761 <const name="Seamless" value="1000">
8762 <desc>Seamless guest desktop integration.</desc>
8763 </const>
8764 <const name="Graphics" value="1100">
8765 <desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8766 are not immediately acted on and guest display resizes are probably not initiated by
8767 the guest additions.
8768 </desc>
8769 </const>
8770 <const name="All" value="2147483646">
8771 <desc>All facilities selected.</desc>
8772 </const>
8773 </enum>
8774
8775 <enum
8776 name="AdditionsFacilityClass"
8777 uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8778 >
8779 <desc>
8780 Guest Additions facility classes.
8781 </desc>
8782
8783 <const name="None" value="0">
8784 <desc>No/invalid class.</desc>
8785 </const>
8786 <const name="Driver" value="10">
8787 <desc>Driver.</desc>
8788 </const>
8789 <const name="Service" value="30">
8790 <desc>System service.</desc>
8791 </const>
8792 <const name="Program" value="50">
8793 <desc>Program.</desc>
8794 </const>
8795 <const name="Feature" value="100">
8796 <desc>Feature.</desc>
8797 </const>
8798 <const name="ThirdParty" value="999">
8799 <desc>Third party.</desc>
8800 </const>
8801 <const name="All" value="2147483646">
8802 <desc>All facility classes selected.</desc>
8803 </const>
8804 </enum>
8805
8806 <enum
8807 name="AdditionsFacilityStatus"
8808 uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
8809 >
8810 <desc>
8811 Guest Additions facility states.
8812 </desc>
8813
8814 <const name="Inactive" value="0">
8815 <desc>Facility is not active.</desc>
8816 </const>
8817 <const name="Paused" value="1">
8818 <desc>Facility has been paused.</desc>
8819 </const>
8820 <const name="PreInit" value="20">
8821 <desc>Facility is preparing to initialize.</desc>
8822 </const>
8823 <const name="Init" value="30">
8824 <desc>Facility is initializing.</desc>
8825 </const>
8826 <const name="Active" value="50">
8827 <desc>Facility is up and running.</desc>
8828 </const>
8829 <const name="Terminating" value="100">
8830 <desc>Facility is shutting down.</desc>
8831 </const>
8832 <const name="Terminated" value="101">
8833 <desc>Facility successfully shut down.</desc>
8834 </const>
8835 <const name="Failed" value="800">
8836 <desc>Facility failed to start.</desc>
8837 </const>
8838 <const name="Unknown" value="999">
8839 <desc>Facility status is unknown.</desc>
8840 </const>
8841 </enum>
8842
8843 <interface
8844 name="IAdditionsFacility" extends="$unknown"
8845 uuid="54992946-6af1-4e49-98ec-58b558b7291e"
8846 wsmap="struct"
8847 >
8848 <desc>
8849 Structure representing a Guest Additions facility.
8850 </desc>
8851
8852 <attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
8853 <desc>The class this facility is part of.</desc>
8854 </attribute>
8855
8856 <attribute name="lastUpdated" type="long long" readonly="yes">
8857 <desc>
8858 Time stamp of the last status update,
8859 in milliseconds since 1970-01-01 UTC.
8860 </desc>
8861 </attribute>
8862
8863 <attribute name="name" type="wstring" readonly="yes">
8864 <desc>The facility's friendly name.</desc>
8865 </attribute>
8866
8867 <attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8868 <desc>The current status.</desc>
8869 </attribute>
8870
8871 <attribute name="type" type="AdditionsFacilityType" readonly="yes">
8872 <desc>The facility's type ID.</desc>
8873 </attribute>
8874 </interface>
8875
8876 <enum
8877 name="AdditionsRunLevelType"
8878 uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8879 >
8880 <desc>
8881 Guest Additions run level type.
8882 </desc>
8883
8884 <const name="None" value="0">
8885 <desc>Guest Additions are not loaded.</desc>
8886 </const>
8887 <const name="System" value="1">
8888 <desc>Guest drivers are loaded.</desc>
8889 </const>
8890 <const name="Userland" value="2">
8891 <desc>Common components (such as application services) are loaded.</desc>
8892 </const>
8893 <const name="Desktop" value="3">
8894 <desc>Per-user desktop components are loaded.</desc>
8895 </const>
8896 </enum>
8897
8898 <enum
8899 name="AdditionsUpdateFlag"
8900 uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8901 >
8902 <desc>
8903 Guest Additions update flags.
8904 </desc>
8905
8906 <const name="None" value="0">
8907 <desc>No flag set.</desc>
8908 </const>
8909 <const name="WaitForUpdateStartOnly" value="1">
8910 <desc>Only wait for the update process being started and do not
8911 wait while peforming the actual update.</desc>
8912 </const>
8913 </enum>
8914
8915 <enum
8916 name="ExecuteProcessFlag"
8917 uuid="1c49b831-b2c7-4a30-97dd-999a2e2cbf90"
8918 >
8919 <desc>
8920 Guest process execution flags.
8921 </desc>
8922
8923 <const name="None" value="0">
8924 <desc>No flag set.</desc>
8925 </const>
8926 <const name="WaitForProcessStartOnly" value="1">
8927 <desc>Only use the specified timeout value to wait for starting the guest process - the guest
8928 process itself then uses an infinite timeout.</desc>
8929 </const>
8930 <const name="IgnoreOrphanedProcesses" value="2">
8931 <desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8932 </const>
8933 <const name="Hidden" value="4">
8934 <desc>Do not show the started process according to the guest OS guidelines.</desc>
8935 </const>
8936 <const name="NoProfile" value="8">
8937 <desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
8938 </const>
8939 <const name="WaitForStdOut" value="16">
8940 <desc>The guest process waits until all data from stdout is read out.</desc>
8941 </const>
8942 <const name="WaitForStdErr" value="32">
8943 <desc>The guest process waits until all data from stderr is read out.</desc>
8944 </const>
8945 </enum>
8946
8947 <enum
8948 name="ExecuteProcessStatus"
8949 uuid="153768d9-d971-4098-8b5a-c5cb1ab9ea88"
8950 >
8951 <desc>
8952 Guest process execution status.
8953 </desc>
8954 <const name="Undefined" value="0">
8955 <desc>Process is in an undefined state.</desc>
8956 </const>
8957
8958 <const name="Started" value="1">
8959 <desc>Process has been started.</desc>
8960 </const>
8961 <const name="TerminatedNormally" value="2">
8962 <desc>Process terminated normally.</desc>
8963 </const>
8964 <const name="TerminatedSignal" value="3">
8965 <desc>Process terminated via signal.</desc>
8966 </const>
8967 <const name="TerminatedAbnormally" value="4">
8968 <desc>Process terminated abnormally.</desc>
8969 </const>
8970 <const name="TimedOutKilled" value="5">
8971 <desc>Process timed out and was killed.</desc>
8972 </const>
8973 <const name="TimedOutAbnormally" value="6">
8974 <desc>Process timed out and was not killed successfully.</desc>
8975 </const>
8976 <const name="Down" value="7">
8977 <desc>Service/OS is stopping, process was killed.</desc>
8978 </const>
8979 <const name="Error" value="8">
8980 <desc>Something went wrong (error code in flags).</desc>
8981 </const>
8982 </enum>
8983
8984 <enum
8985 name="FileSeekType"
8986 uuid="1b73f4f3-3515-4073-a506-76878d9e2541"
8987 >
8988 <desc>
8989 File seeking types.
8990 </desc>
8991
8992 <const name="Set" value="0">
8993 <desc>Seek from the start of the file.</desc>
8994 </const>
8995 <const name="Current" value="1">
8996 <desc>Seek from the current file position.</desc>
8997 </const>
8998 </enum>
8999
9000 <enum
9001 name="ProcessInputFlag"
9002 uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
9003 >
9004 <desc>
9005 Guest process input flags.
9006 </desc>
9007 <const name="None" value="0">
9008 <desc>No flag set.</desc>
9009 </const>
9010 <const name="EndOfFile" value="1">
9011 <desc>End of file (input) reached.</desc>
9012 </const>
9013 </enum>
9014
9015 <enum
9016 name="ProcessOutputFlag"
9017 uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
9018 >
9019 <desc>
9020 Guest process output flags for specifying which
9021 type of output to retrieve.
9022 </desc>
9023 <const name="None" value="0">
9024 <desc>No flags set. Get output from stdout.</desc>
9025 </const>
9026 <const name="StdErr" value="1">
9027 <desc>Get output from stderr.</desc>
9028 </const>
9029 </enum>
9030
9031 <enum
9032 name="ProcessWaitForFlag"
9033 uuid="23b550c7-78e1-437e-98f0-65fd9757bcd2"
9034 >
9035 <desc>
9036 Process waiting flags. Multiple flags can be combined.
9037 </desc>
9038
9039 <const name="None" value="0">
9040 <desc>No waiting flags specified. Do not use this.</desc>
9041 </const>
9042 <const name="Start" value="1">
9043 <desc>Wait for the process being started.</desc>
9044 </const>
9045 <const name="Terminate" value="2">
9046 <desc>Wait for the process being terminated.</desc>
9047 </const>
9048 <const name="StdIn" value="4">
9049 <desc>Wait for stdin becoming available.</desc>
9050 </const>
9051 <const name="StdOut" value="8">
9052 <desc>Wait for data becoming available on stdout.</desc>
9053 </const>
9054 <const name="StdErr" value="16">
9055 <desc>Wait for data becoming available on stderr.</desc>
9056 </const>
9057 </enum>
9058
9059 <enum
9060 name="ProcessWaitResult"
9061 uuid="40719cbe-f192-4fe9-a231-6697b3c8e2b4"
9062 >
9063 <desc>
9064 Process waiting results. Depending on the process waiting flags (for
9065 more information see <link to="ProcessWaitForFlag"/>) the waiting result
9066 can vary based on the processes' current status.
9067
9068 To wait for a gust process to terminate after it has been
9069 created by <link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>
9070 one would specify ProcessWaitResult_Terminate.
9071
9072 If a guest process has been started with ProcessCreateFlag_WaitForStdOut
9073 a client can wait with ProcessWaitResult_StdOut for new data to arrive on
9074 stdout; same applies for ProcessCreateFlag_WaitForStdErr and
9075 ProcessWaitResult_StdErr.
9076 </desc>
9077
9078 <const name="None" value="0">
9079 <desc>No result was returned. Not being used.</desc>
9080 </const>
9081 <const name="Start" value="1">
9082 <desc>The process has been started.</desc>
9083 </const>
9084 <const name="Terminate" value="2">
9085 <desc>The process has been terminated.</desc>
9086 </const>
9087 <const name="Status" value="3">
9088 <desc>
9089 The process has changed its status. The status then can
9090 be retrieved via <link to="IProcess::status"/>.
9091 </desc>
9092 </const>
9093 <const name="Error" value="4">
9094 <desc>Error while executing the process.</desc>
9095 </const>
9096 <const name="Timeout" value="5">
9097 <desc>
9098 The waiting operation timed out. This also will happen
9099 when no event has been occured matching the specified the
9100 current waiting flags in the <link to="IProcess::waitFor"/> call.
9101 </desc>
9102 </const>
9103 <const name="StdIn" value="6">
9104 <desc>
9105 The process signalled that stdin became available for writing
9106 and that the process awaits input now.</desc>
9107 </const>
9108 <const name="StdOut" value="7">
9109 <desc>Data on stdout became available for reading.</desc>
9110 </const>
9111 <const name="StdErr" value="8">
9112 <desc>Data on stderr became available for reading.</desc>
9113 </const>
9114 <const name="WaitFlagNotSupported" value="9">
9115 <desc>
9116 A waiting flag specified in the <link to="IProcess::waitFor"/> call
9117 is not supported by the guest.
9118 </desc>
9119 </const>
9120 </enum>
9121
9122 <enum
9123 name="CopyFileFlag"
9124 uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
9125 >
9126 <desc>
9127 File copying flags.
9128 </desc>
9129 <const name="None" value="0">
9130 <desc>No flag set.</desc>
9131 </const>
9132 <const name="Recursive" value="1">
9133 <desc>Copy directories recursively.</desc>
9134 </const>
9135 <const name="Update" value="2">
9136 <desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
9137 </const>
9138 <const name="FollowLinks" value="4">
9139 <desc>Follow symbolic links.</desc>
9140 </const>
9141 </enum>
9142
9143 <enum
9144 name="DirectoryCreateFlag"
9145 uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
9146 >
9147 <desc>
9148 Directory creation flags.
9149 </desc>
9150 <const name="None" value="0">
9151 <desc>No flag set.</desc>
9152 </const>
9153 <const name="Parents" value="1">
9154 <desc>No error if existing, make parent directories as needed.</desc>
9155 </const>
9156 </enum>
9157
9158 <enum
9159 name="DirectoryRemoveRecFlag"
9160 uuid="455aabf0-7692-48f6-9061-f21579b65769"
9161 >
9162 <desc>
9163 Directory recursive removement flags.
9164 </desc>
9165
9166 <const name="None" value="0">
9167 <desc>No flag set.</desc>
9168 </const>
9169 <const name="ContentAndDir" value="1">
9170 <desc>Delete the content of the directory and the directory itself.</desc>
9171 </const>
9172 <const name="ContentOnly" value="2">
9173 <desc>Only delete the content of the directory, omit the directory it self.</desc>
9174 </const>
9175 </enum>
9176
9177 <enum
9178 name="PathRenameFlag"
9179 uuid="f3baa09f-c758-453d-b91c-c7787d76351d"
9180 >
9181 <desc>
9182 Path renaming flags.
9183 </desc>
9184
9185 <const name="None" value="0">
9186 <desc>No flag set.</desc>
9187 </const>
9188 <const name="NoReplace" value="1">
9189 <desc>Do not replace anything.</desc>
9190 </const>
9191 <const name="Replace" value="2">
9192 <desc>This will replace attempt any target which isn't a directory.</desc>
9193 </const>
9194 <const name="NoSymlinks" value="4">
9195 <desc>Don't allow symbolic links as part of the path.</desc>
9196 </const>
9197 </enum>
9198
9199 <enum
9200 name="ProcessCreateFlag"
9201 uuid="35192799-bfde-405d-9bea-c735ab9998e4"
9202 >
9203 <desc>
9204 Guest process execution flags.
9205 </desc>
9206
9207 <const name="None" value="0">
9208 <desc>No flag set.</desc>
9209 </const>
9210 <const name="WaitForProcessStartOnly" value="1">
9211 <desc>Only use the specified timeout value to wait for starting the guest process - the guest
9212 process itself then uses an infinite timeout.</desc>
9213 </const>
9214 <const name="IgnoreOrphanedProcesses" value="2">
9215 <desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
9216 </const>
9217 <const name="Hidden" value="4">
9218 <desc>Do not show the started process according to the guest OS guidelines.</desc>
9219 </const>
9220 <const name="NoProfile" value="8">
9221 <desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
9222 </const>
9223 <const name="WaitForStdOut" value="16">
9224 <desc>The guest process waits until all data from stdout is read out.</desc>
9225 </const>
9226 <const name="WaitForStdErr" value="32">
9227 <desc>The guest process waits until all data from stderr is read out.</desc>
9228 </const>
9229 <const name="ExpandArguments" value="64">
9230 <desc>Expands environment variables in process arguments.</desc>
9231 </const>
9232 </enum>
9233
9234 <enum
9235 name="ProcessPriority"
9236 uuid="ee8cac50-e232-49fe-806b-d1214d9c2e49"
9237 >
9238 <desc>
9239 Process priorities.
9240 </desc>
9241
9242 <const name="Invalid" value="0">
9243 <desc>Invalid priority, do not use.</desc>
9244 </const>
9245 <const name="Default" value="1">
9246 <desc>Default process priority determined by the OS.</desc>
9247 </const>
9248 </enum>
9249
9250 <enum
9251 name="SymlinkType"
9252 uuid="37794668-f8f1-4714-98a5-6f8fa2ed0118"
9253 >
9254 <desc>
9255 Symbolic link types.
9256 </desc>
9257
9258 <const name="Unknown" value="0">
9259 <desc>It is not known what is being targeted.</desc>
9260 </const>
9261 <const name="Directory" value="1">
9262 <desc>The link targets a directory.</desc>
9263 </const>
9264 <const name="File" value="2">
9265 <desc>The link targets a file (or whatever else).</desc>
9266 </const>
9267 </enum>
9268
9269 <enum
9270 name="SymlinkReadFlag"
9271 uuid="b7fe2b9d-790e-4b25-8adf-1ca33026931f"
9272 >
9273 <desc>
9274 Symbolic link reading flags.
9275 </desc>
9276
9277 <const name="None" value="0">
9278 <desc>No flags set.</desc>
9279 </const>
9280 <const name="NoSymlinks" value="1">
9281 <desc>Don't allow symbolic links as part of the path.</desc>
9282 </const>
9283 </enum>
9284
9285 <enum
9286 name="ProcessStatus"
9287 uuid="4d52368f-5b48-4bfe-b486-acf89139b52f"
9288 >
9289 <desc>
9290 Process execution statuses.
9291 </desc>
9292 <const name="Undefined" value="0">
9293 <desc>Process is in an undefined state.</desc>
9294 </const>
9295
9296 <const name="Starting" value="10">
9297 <desc>Process is being started.</desc>
9298 </const>
9299 <const name="Started" value="100">
9300 <desc>Process has been started.</desc>
9301 </const>
9302 <const name="Paused" value="110">
9303 <desc>Process has been paused.</desc>
9304 </const>
9305 <const name="Terminating" value="480">
9306 <desc>Process is being terminated.</desc>
9307 </const>
9308 <const name="TerminatedNormally" value="500">
9309 <desc>Process terminated normally.</desc>
9310 </const>
9311 <const name="TerminatedSignal" value="510">
9312 <desc>Process terminated via signal.</desc>
9313 </const>
9314 <const name="TerminatedAbnormally" value="511">
9315 <desc>Process terminated abnormally.</desc>
9316 </const>
9317 <const name="TimedOutKilled" value="512">
9318 <desc>Process timed out and was killed.</desc>
9319 </const>
9320 <const name="TimedOutAbnormally" value="513">
9321 <desc>Process timed out and was not killed successfully.</desc>
9322 </const>
9323 <const name="Down" value="600">
9324 <desc>Service/OS is stopping, process was killed.</desc>
9325 </const>
9326 <const name="Error" value="800">
9327 <desc>Something went wrong.</desc>
9328 </const>
9329 </enum>
9330
9331 <enum
9332 name="FsObjType"
9333 uuid="a1ed437c-b3c3-4ca2-b19c-4239d658d5e8"
9334 >
9335 <desc>
9336 File system object type.
9337 </desc>
9338
9339 <const name="Undefined" value="0">
9340 <desc>Type is undefined / unknown.</desc>
9341 </const>
9342 <const name="FIFO" value="1">
9343 <desc>Named pipe.</desc>
9344 </const>
9345 <const name="DevChar" value="10">
9346 <desc>Character device.</desc>
9347 </const>
9348 <const name="DevBlock" value="11">
9349 <desc>Block device.</desc>
9350 </const>
9351 <const name="Directory" value="50">
9352 <desc>Directory.</desc>
9353 </const>
9354 <const name="File" value="80">
9355 <desc>File.</desc>
9356 </const>
9357 <const name="Symlink" value="100">
9358 <desc>Symlink.</desc>
9359 </const>
9360 <const name="Socket" value="200">
9361 <desc>Socket.</desc>
9362 </const>
9363 <const name="Whiteout" value="400">
9364 <desc>Whiteout.</desc>
9365 </const>
9366 </enum>
9367
9368 <enum
9369 name="DragAndDropAction"
9370 uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
9371 >
9372 <desc>
9373 Possible actions within an Drag and Drop operation.
9374 </desc>
9375
9376 <const name="Ignore" value="0">
9377 <desc>Do nothing.</desc>
9378 </const>
9379
9380 <const name="Copy" value="1">
9381 <desc>Copy the item to the target.</desc>
9382 </const>
9383
9384 <const name="Move" value="2">
9385 <desc>Move the item to the target.</desc>
9386 </const>
9387
9388 <const name="Link" value="3">
9389 <desc>Link the item from within the target.</desc>
9390 </const>
9391 </enum>
9392
9393 <enum
9394 name="DirectoryOpenFlag"
9395 uuid="5138837a-8fd2-4194-a1b0-08f7bc3949d0"
9396 >
9397 <desc>
9398 Directory open flags.
9399 </desc>
9400 <const name="None" value="0">
9401 <desc>No flag set.</desc>
9402 </const>
9403 <const name="NoSymlinks" value="1">
9404 <desc>Don't allow symbolic links as part of the path.</desc>
9405 </const>
9406 </enum>
9407
9408 <enum
9409 name="GuestDirEntryType"
9410 uuid="6d19d924-1b77-4fc8-b369-a3b2c85c8241"
9411 >
9412 <desc>
9413 Guest directory entry type.
9414 </desc>
9415 <const name="Unknown" value="0">
9416 <desc>Unknown.</desc>
9417 </const>
9418 <const name="Directory" value="4">
9419 <desc>Regular file.</desc>
9420 </const>
9421 <const name="File" value="10">
9422 <desc>Regular file.</desc>
9423 </const>
9424 <const name="Symlink" value="12">
9425 <desc>Symbolic link.</desc>
9426 </const>
9427 </enum>
9428
9429 <interface
9430 name="IGuestDirEntry" extends="$unknown"
9431 uuid="20a66efc-c2f6-4438-826f-38454c04369e"
9432 wsmap="struct"
9433 >
9434 <desc>
9435 Structure representing a directory entry on the guest OS.
9436 </desc>
9437 <attribute name="nodeId" type="long long" readonly="yes">
9438 <desc>The unique identifier (within the guest's file system) of this file system object.</desc>
9439 </attribute>
9440 <attribute name="name" type="wstring" readonly="yes">
9441 <desc>The filename.</desc>
9442 </attribute>
9443 <attribute name="type" type="GuestDirEntryType" readonly="yes">
9444 <desc>The entry type.</desc>
9445 </attribute>
9446 </interface>
9447
9448 <interface
9449 name="IGuestSession" extends="$unknown"
9450 uuid="57eb82a8-822b-42c1-9d1c-5c54bc3d3250"
9451 wsmap="managed"
9452 >
9453 <desc>
9454 A guest session represents one impersonated user account on the guest, so
9455 every operation will use the same credentials specified when creating
9456 the session object via <link to="IGuest::createSession"/>.
9457
9458 There can be a maximum of 255 sessions at once per VM. Each session keeps
9459 track of its started guest processes, opened guest files or guest directories.
9460 To work on guest files or directories a guest session offers methods to open
9461 or create such objects (see <link to="IGuestSession::fileOpen"/> or
9462 <link to="IGuestSession::directoryOpen"/> for example).
9463
9464 When done with either of these objects, including the guest session itself,
9465 use the appropriate close() method to let the object do its cleanup work.
9466
9467 Every guest session has its own environment variable block which gets
9468 automatically applied when starting a new guest process via
9469 <link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>.
9470 To override (or unset) certain environment variables already set by the
9471 guest session, one can specify a per-process environment block when using
9472 one of the both above mentioned process creation calls.
9473 </desc>
9474
9475 <attribute name="user" type="wstring" readonly="yes">
9476 <desc>Returns the user name used by this session to impersonate
9477 users on the guest.
9478 </desc>
9479 </attribute>
9480
9481 <attribute name="domain" type="wstring" readonly="yes">
9482 <desc>Returns the domain name used by this session to impersonate
9483 users on the guest.
9484 </desc>
9485 </attribute>
9486
9487 <attribute name="name" type="wstring" readonly="yes">
9488 <desc>Returns the session's friendly name.</desc>
9489 </attribute>
9490
9491 <attribute name="id" type="unsigned long" readonly="yes">
9492 <desc>Returns the internal session ID.</desc>
9493 </attribute>
9494
9495 <attribute name="timeout" type="unsigned long" readonly="no">
9496 <desc>
9497 Returns the session timeout (in ms).
9498 <result name="E_NOTIMPL">
9499 The method is not implemented yet.
9500 </result>
9501 </desc>
9502 </attribute>
9503
9504 <attribute name="environment" type="wstring" safearray="yes">
9505 <desc>
9506 Returns the current session environment.
9507 </desc>
9508 </attribute>
9509
9510 <attribute name="processes" type="IGuestProcess" readonly="yes" safearray="yes">
9511 <desc>
9512 Returns all current guest processes.
9513 </desc>
9514 </attribute>
9515
9516 <attribute name="directories" type="IGuestDirectory" readonly="yes" safearray="yes">
9517 <desc>
9518 Returns all currently opened guest directories.
9519 </desc>
9520 </attribute>
9521
9522 <attribute name="files" type="IGuestFile" readonly="yes" safearray="yes">
9523 <desc>
9524 Returns all currently opened guest files.
9525 </desc>
9526 </attribute>
9527
9528 <method name="close">
9529 <desc>
9530 Closes this session. All opened guest directories, files and
9531 processes which are not referenced by clients anymore will be
9532 uninitialized.
9533 </desc>
9534 </method>
9535
9536 <method name="copyFrom">
9537 <desc>
9538 Copies a file from guest to the host.
9539
9540 <result name="VBOX_E_IPRT_ERROR">
9541 Error starting the copy operation.
9542 </result>
9543 </desc>
9544 <param name="source" type="wstring" dir="in">
9545 <desc>Source file on the guest to copy to the host.</desc>
9546 </param>
9547 <param name="dest" type="wstring" dir="in">
9548 <desc>Destination file name on the host.</desc>
9549 </param>
9550 <param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9551 <desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
9552 </param>
9553 <param name="progress" type="IProgress" dir="return">
9554 <desc>Progress object to track the operation completion.</desc>
9555 </param>
9556 </method>
9557
9558 <method name="copyTo">
9559 <desc>
9560 Copies a file from host to the guest.
9561
9562 <result name="VBOX_E_IPRT_ERROR">
9563 Error starting the copy operation.
9564 </result>
9565 </desc>
9566 <param name="source" type="wstring" dir="in">
9567 <desc>Source file on the host to copy to the guest.</desc>
9568 </param>
9569 <param name="dest" type="wstring" dir="in">
9570 <desc>Destination file name on the guest.</desc>
9571 </param>
9572 <param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9573 <desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
9574 </param>
9575 <param name="progress" type="IProgress" dir="return">
9576 <desc>Progress object to track the operation completion.</desc>
9577 </param>
9578 </method>
9579
9580 <method name="directoryCreate">
9581 <desc>
9582 Create a directory on the guest.
9583
9584 <result name="VBOX_E_IPRT_ERROR">
9585 Error while creating the directory.
9586 </result>
9587 </desc>
9588 <param name="path" type="wstring" dir="in">
9589 <desc>Full path of directory to create.</desc>
9590 </param>
9591 <param name="mode" type="unsigned long" dir="in">
9592 <desc>File creation mode.</desc>
9593 </param>
9594 <param name="flags" type="DirectoryCreateFlag" dir="in" safearray="yes">
9595 <desc>Creation flags; see <link to="DirectoryCreateFlag"/> for more information.</desc>
9596 </param>
9597 </method>
9598
9599 <method name="directoryCreateTemp">
9600 <desc>
9601 Create a temporary directory on the guest.
9602
9603 <result name="VBOX_E_NOT_SUPPORTED">
9604 The operation is not possible as requested on this particular
9605 guest type.
9606 </result>
9607 <result name="E_INVALIDARG">
9608 Invalid argument. This includes an incorrectly formatted template,
9609 or a non-absolute path.
9610 </result>
9611 <result name="VBOX_E_IPRT_ERROR">
9612 The temporary directory could not be created. Possible reasons
9613 include a non-existing path or an insecure path when the secure
9614 option was requested.
9615 </result>
9616 </desc>
9617 <param name="templateName" type="wstring" dir="in">
9618 <desc>Template for the name of the directory to create. This must
9619 contain at least one 'X' character. The first group of consecutive
9620 'X' characters in the template will be replaced by a random
9621 alphanumeric string to produce a unique name.</desc>
9622 </param>
9623 <param name="mode" type="unsigned long" dir="in">
9624 <desc>The mode of the directory to create. Use 0700 unless there are
9625 reasons not to. This parameter is ignored if "secure" is specified.
9626 </desc>
9627 </param>
9628 <param name="path" type="wstring" dir="in">
9629 <desc>The absolute path to create the temporary directory in.</desc>
9630 </param>
9631 <param name="secure" type="boolean" dir="in">
9632 <desc>Whether to fail if the directory can not be securely created.
9633 Currently this means that another unprivileged user cannot
9634 manipulate the path specified or remove the temporary directory
9635 after it has been created. Also causes the mode specified to be
9636 ignored. May not be supported on all guest types.</desc>
9637 </param>
9638 <param name="directory" type="wstring" dir="return">
9639 <desc>On success this will contain the name of the directory created
9640 with full path.</desc>
9641 </param>
9642 </method>
9643
9644 <method name="directoryExists">
9645 <desc>
9646 Checks whether a directory exists on the guest or not.
9647
9648 <result name="VBOX_E_IPRT_ERROR">
9649 Error while checking existence of the directory specified.
9650 </result>
9651 </desc>
9652 <param name="path" type="wstring" dir="in">
9653 <desc>Directory to check existence for.</desc>
9654 </param>
9655 <param name="exists" type="boolean" dir="return">
9656 <desc>Returns @c true if the directory exists, @c false if not.</desc>
9657 </param>
9658 </method>
9659
9660 <method name="directoryOpen">
9661 <desc>
9662 Opens a directory and creates a <link to="IGuestDirectory"/> object that
9663 can be used for further operations.
9664
9665 <result name="VBOX_E_OBJECT_NOT_FOUND">
9666 Directory to open was not found.
9667 </result>
9668 <result name="VBOX_E_IPRT_ERROR">
9669 Error while opening the directory.
9670 </result>
9671 </desc>
9672 <param name="path" type="wstring" dir="in">
9673 <desc>Full path to file to open.</desc>
9674 </param>
9675 <param name="filter" type="wstring" dir="in">
9676 <desc>Open filter to apply. This can include wildcards like ? and *.</desc>
9677 </param>
9678 <param name="flags" type="DirectoryOpenFlag" dir="in" safearray="yes">
9679 <desc>Open flags; see <link to="DirectoryOpenFlag"/> for more information.</desc>
9680 </param>
9681 <param name="directory" type="IGuestDirectory" dir="return">
9682 <desc><link to="IGuestDirectory"/> object containing the opened directory.</desc>
9683 </param>
9684 </method>
9685
9686 <method name="directoryQueryInfo">
9687 <desc>
9688 Queries information of a directory on the guest.
9689
9690 <result name="VBOX_E_OBJECT_NOT_FOUND">
9691 Directory to query information for was not found.
9692 </result>
9693 <result name="VBOX_E_IPRT_ERROR">
9694 Error querying information.
9695 </result>
9696 </desc>
9697 <param name="path" type="wstring" dir="in">
9698 <desc>Directory to query information for.</desc>
9699 </param>
9700 <param name="info" type="IGuestFsObjInfo" dir="return">
9701 <desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
9702 </param>
9703 </method>
9704
9705 <method name="directoryRemove">
9706 <desc>
9707 Removes a guest directory if not empty.
9708
9709 <result name="E_NOTIMPL">
9710 The method is not implemented yet.
9711 </result>
9712 </desc>
9713 <param name="path" type="wstring" dir="in">
9714 <desc>Full path of directory to remove.</desc>
9715 </param>
9716 </method>
9717
9718 <method name="directoryRemoveRecursive">
9719 <desc>
9720 Removes a guest directory recursively.
9721
9722 <result name="E_NOTIMPL">
9723 The method is not implemented yet.
9724 </result>
9725 </desc>
9726 <param name="path" type="wstring" dir="in">
9727 <desc>Full path of directory to remove recursively.</desc>
9728 </param>
9729 <param name="flags" type="DirectoryRemoveRecFlag" dir="in" safearray="yes">
9730 <desc>Remove flags; see <link to="DirectoryRemoveRecFlag"/> for more information.</desc>
9731 </param>
9732 <param name="progress" type="IProgress" dir="return">
9733 <desc>Progress object to track the operation completion.</desc>
9734 </param>
9735 </method>
9736
9737 <method name="directoryRename">
9738 <desc>
9739 Renames a directory on the guest.
9740
9741 <result name="E_NOTIMPL">
9742 The method is not implemented yet.
9743 </result>
9744 </desc>
9745 <param name="source" type="wstring" dir="in">
9746 <desc>Source directory to rename.</desc>
9747 </param>
9748 <param name="dest" type="wstring" dir="in">
9749 <desc>Destination directory to rename the source to.</desc>
9750 </param>
9751 <param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
9752 <desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
9753 </param>
9754 </method>
9755
9756 <method name="directorySetACL">
9757 <desc>
9758 Sets the ACL (Access Control List) of a guest directory.
9759
9760 <result name="E_NOTIMPL">
9761 The method is not implemented yet.
9762 </result>
9763 </desc>
9764 <param name="path" type="wstring" dir="in">
9765 <desc>Full path of directory to set the ACL for.</desc>
9766 </param>
9767 <param name="acl" type="wstring" dir="in">
9768 <desc>Actual ACL string to set. Must comply with the guest OS.</desc>
9769 </param>
9770 </method>
9771
9772 <method name="environmentClear">
9773 <desc>
9774 Clears (deletes) all session environment variables.
9775
9776 <result name="VBOX_E_IPRT_ERROR">
9777 Error while clearing the session environment variables.
9778 </result>
9779 </desc>
9780 </method>
9781
9782 <method name="environmentGet">
9783 <desc>
9784 Gets the value of a session environment variable.
9785
9786 <result name="VBOX_E_IPRT_ERROR">
9787 Error while getting the value of the session environment variable.
9788 </result>
9789 </desc>
9790 <param name="name" type="wstring" dir="in">
9791 <desc>Name of session environment variable to get the value for.</desc>
9792 </param>
9793 <param name="value" type="wstring" dir="return">
9794 <desc>
9795 Value of the session environment variable specified. If this variable
9796 does not exist and empty value will be returned.
9797 </desc>
9798 </param>
9799 </method>
9800
9801 <method name="environmentSet">
9802 <desc>
9803 Sets a session environment variable.
9804
9805 <result name="VBOX_E_IPRT_ERROR">
9806 Error while setting the session environment variable.
9807 </result>
9808 </desc>
9809 <param name="name" type="wstring" dir="in">
9810 <desc>Name of session environment variable to set.</desc>
9811 </param>
9812 <param name="value" type="wstring" dir="in">
9813 <desc>Value to set the session environment variable to.</desc>
9814 </param>
9815 </method>
9816
9817 <method name="environmentUnset">
9818 <desc>
9819 Unsets session environment variable.
9820
9821 <result name="VBOX_E_IPRT_ERROR">
9822 Error while unsetting the session environment variable.
9823 </result>
9824 </desc>
9825 <param name="name" type="wstring" dir="in">
9826 <desc>Name of session environment variable to unset (clear).</desc>
9827 </param>
9828 </method>
9829
9830 <method name="fileCreateTemp">
9831 <desc>
9832 Creates a temporary file on the guest.
9833
9834 <result name="VBOX_E_NOT_SUPPORTED">
9835 The operation is not possible as requested on this particular
9836 guest type.
9837 </result>
9838 <result name="E_INVALIDARG">
9839 Invalid argument. This includes an incorrectly formatted template,
9840 or a non-absolute path.
9841 </result>
9842 <result name="VBOX_E_IPRT_ERROR">
9843 The temporary file could not be created. Possible reasons include
9844 a non-existing path or an insecure path when the secure
9845 option was requested.
9846 </result>
9847 </desc>
9848 <param name="templateName" type="wstring" dir="in">
9849 <desc>Template for the name of the file to create. This must contain
9850 at least one 'X' character. The first group of consecutive 'X'
9851 characters in the template will be replaced by a random
9852 alphanumeric string to produce a unique name.
9853 </desc>
9854 </param>
9855 <param name="mode" type="unsigned long" dir="in">
9856 <desc>The mode of the file to create. Use 0700 unless there are
9857 reasons not to. This parameter is ignored if "secure" is specified.
9858 </desc>
9859 </param>
9860 <param name="path" type="wstring" dir="in">
9861 <desc>The absolute path to create the temporary file in.</desc>
9862 </param>
9863 <param name="secure" type="boolean" dir="in">
9864 <desc>Whether to fail if the file can not be securely created.
9865 Currently this means that another unprivileged user cannot
9866 manipulate the path specified or remove the temporary file after
9867 it has been created. Also causes the mode specified to be ignored.
9868 May not be supported on all guest types.</desc>
9869 </param>
9870 <param name="file" type="IGuestFile" dir="return">
9871 <desc>On success this will contain an open file object for the new
9872 temporary file.
9873 </desc>
9874 </param>
9875 </method>
9876
9877 <method name="fileExists">
9878 <desc>
9879 Checks whether a file exists on the guest or not.
9880
9881 <result name="VBOX_E_IPRT_ERROR">
9882 Error while checking existence of the file specified.
9883 </result>
9884 </desc>
9885 <param name="path" type="wstring" dir="in">
9886 <desc>File to check existence for.</desc>
9887 </param>
9888 <param name="exists" type="boolean" dir="return">
9889 <desc>Returns @c true if the file exists, @c false if not.</desc>
9890 </param>
9891 </method>
9892
9893 <method name="fileRemove">
9894 <desc>
9895 Removes a single file on the guest.
9896
9897 <result name="VBOX_E_OBJECT_NOT_FOUND">
9898 File to remove was not found.
9899 </result>
9900 <result name="VBOX_E_IPRT_ERROR">
9901 Error while removing the file.
9902 </result>
9903 </desc>
9904 <param name="path" type="wstring" dir="in">
9905 <desc>Path to the file to remove.</desc>
9906 </param>
9907 </method>
9908
9909 <method name="fileOpen">
9910 <desc>
9911 Opens a file and creates a <link to="IGuestFile"/> object that
9912 can be used for further operations.
9913
9914 <result name="VBOX_E_OBJECT_NOT_FOUND">
9915 File to open was not found.
9916 </result>
9917 <result name="VBOX_E_IPRT_ERROR">
9918 Error while opening the file.
9919 </result>
9920 </desc>
9921 <param name="path" type="wstring" dir="in">
9922 <desc>Full path to file to open.</desc>
9923 </param>
9924 <param name="openMode" type="wstring" dir="in">
9925 <desc>The file open mode.</desc>
9926 </param>
9927 <param name="disposition" type="wstring" dir="in">
9928 <desc>The file disposition.</desc>
9929 </param>
9930 <param name="creationMode" type="unsigned long" dir="in">
9931 <desc>The file creation mode.</desc>
9932 </param>
9933 <param name="offset" type="long long" dir="in">
9934 <desc>The initial read/write offset.</desc>
9935 </param>
9936 <param name="file" type="IGuestFile" dir="return">
9937 <desc><link to="IGuestFile"/> object representing the opened file.</desc>
9938 </param>
9939 </method>
9940
9941 <method name="fileQueryInfo">
9942 <desc>
9943 Queries information of a file on the guest.
9944
9945 <result name="VBOX_E_OBJECT_NOT_FOUND">
9946 File to query information for was not found.
9947 </result>
9948 <result name="VBOX_E_IPRT_ERROR">
9949 Error querying information.
9950 </result>
9951 </desc>
9952 <param name="path" type="wstring" dir="in">
9953 <desc>File to query information for.</desc>
9954 </param>
9955 <param name="info" type="IGuestFsObjInfo" dir="return">
9956 <desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
9957 </param>
9958 </method>
9959
9960 <method name="fileQuerySize">
9961 <desc>
9962 Queries the size of a file on the guest.
9963
9964 <result name="VBOX_E_OBJECT_NOT_FOUND">
9965 File to rename was not found.
9966 </result>
9967 <result name="VBOX_E_IPRT_ERROR">
9968 Error querying file size.
9969 </result>
9970 </desc>
9971 <param name="path" type="wstring" dir="in">
9972 <desc>File to query the size for.</desc>
9973 </param>
9974 <param name="size" type="long long" dir="return">
9975 <desc>Queried file size.</desc>
9976 </param>
9977 </method>
9978
9979 <method name="fileRename">
9980 <desc>
9981 Renames a file on the guest.
9982
9983 <result name="E_NOTIMPL">
9984 The method is not implemented yet.
9985 </result>
9986 </desc>
9987 <param name="source" type="wstring" dir="in">
9988 <desc>Source file to rename.</desc>
9989 </param>
9990 <param name="dest" type="wstring" dir="in">
9991 <desc>Destination file to rename the source to.</desc>
9992 </param>
9993 <param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
9994 <desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
9995 </param>
9996 </method>
9997
9998 <method name="fileSetACL">
9999 <desc>
10000 Sets the ACL (Access Control List) of a file on the guest.
10001
10002 <result name="E_NOTIMPL">
10003 The method is not implemented yet.
10004 </result>
10005 </desc>
10006 <param name="file" type="wstring" dir="in">
10007 <desc>Full path of file to set the ACL for.</desc>
10008 </param>
10009 <param name="acl" type="wstring" dir="in">
10010 <desc>Actual ACL string to set. Must comply with the guest OS.</desc>
10011 </param>
10012 </method>
10013
10014 <method name="processCreate">
10015 <desc>
10016 Executes an existing program inside the guest VM.
10017
10018 <note>
10019 Starting at VirtualBox 4.2 guest process execution by default is limited
10020 to serve up to 255 guest processes at a time. If all 255 guest processes
10021 are still active and running, starting a new guest process will result in an
10022 appropriate error message.
10023
10024 If ProcessCreateFlag_WaitForStdOut and / or respectively ProcessCreateFlag_WaitForStdErr
10025 is / are set, the guest process will not exit until all data from the specified
10026 stream(s) is / are read out.
10027
10028 To raise or lower the guest process execution limit, either the guest property
10029 "/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
10030 command line by specifying "--control-procs-max-kept" needs to be modified.
10031 A restart of the guest OS is required afterwards. To serve unlimited guest
10032 processes, a value of "0" needs to be set (not recommended).
10033 </note>
10034
10035 <result name="VBOX_E_IPRT_ERROR">
10036 Could not create process.
10037 </result>
10038 </desc>
10039 <param name="command" type="wstring" dir="in">
10040 <desc>
10041 Full path name of the command to execute on the guest; the
10042 commands has to exists in the guest VM in order to be executed.
10043 </desc>
10044 </param>
10045 <param name="arguments" type="wstring" dir="in" safearray="yes">
10046 <desc>Array of arguments passed to the execution command.</desc>
10047 </param>
10048 <param name="environment" type="wstring" dir="in" safearray="yes">
10049 <desc>
10050 Environment variables that can be set while the command is being
10051 executed, in form of "NAME=VALUE"; one pair per entry. To unset a
10052 variable just set its name ("NAME") without a value.
10053
10054 This parameter can be used to override environment variables set by
10055 the guest session, which will be applied to the newly started process
10056 in any case.
10057 </desc>
10058 </param>
10059 <param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
10060 <desc>
10061 Process creation flags;
10062 see <link to="ProcessCreateFlag"/> for more information.
10063 </desc>
10064 </param>
10065 <param name="timeoutMS" type="unsigned long" dir="in">
10066 <desc>
10067 Timeout (in ms) to wait for the operation to complete.
10068 Pass 0 for an infinite timeout.
10069 </desc>
10070 </param>
10071 <param name="guestProcess" type="IGuestProcess" dir="return">
10072 <desc>Guest process object of the newly created process.</desc>
10073 </param>
10074 </method>
10075
10076 <method name="processCreateEx">
10077 <desc>
10078 Executes an existing program inside the guest VM. Extended version for
10079 also setting the process priority and affinity.
10080
10081 <note>
10082 Starting at VirtualBox 4.2 guest process execution by default is limited
10083 to serve up to 255 guest processes at a time. If all 255 guest processes
10084 are still active and running, starting a new guest process will result in an
10085 appropriate error message.
10086
10087 If ProcessCreateFlag_WaitForStdOut and / or respectively ProcessCreateFlag_WaitForStdErr
10088 is / are set, the guest process will not exit until all data from the specified
10089 stream(s) is / are read out.
10090
10091 To raise or lower the guest process execution limit, either the guest property
10092 "/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
10093 command line by specifying "--control-procs-max-kept" needs to be modified.
10094 A restart of the guest OS is required afterwards. To serve unlimited guest
10095 processes, a value of "0" needs to be set (not recommended).
10096 </note>
10097
10098 <result name="VBOX_E_IPRT_ERROR">
10099 Could not create process.
10100 </result>
10101 </desc>
10102 <param name="command" type="wstring" dir="in">
10103 <desc>
10104 Full path name of the command to execute on the guest; the
10105 commands has to exists in the guest VM in order to be executed.
10106 </desc>
10107 </param>
10108 <param name="arguments" type="wstring" dir="in" safearray="yes">
10109 <desc>Array of arguments passed to the execution command.</desc>
10110 </param>
10111 <param name="environment" type="wstring" dir="in" safearray="yes">
10112 <desc>
10113 Environment variables that can be set while the command is being
10114 executed, in form of "NAME=VALUE"; one pair per entry. To unset a
10115 variable just set its name ("NAME") without a value.
10116
10117 This parameter can be used to override environment variables set by
10118 the guest session, which will be applied to the newly started process
10119 in any case.
10120 </desc>
10121 </param>
10122 <param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
10123 <desc>
10124 Process creation flags;
10125 see <link to="ProcessCreateFlag"/> for more information.
10126 </desc>
10127 </param>
10128 <param name="timeoutMS" type="unsigned long" dir="in">
10129 <desc>
10130 Timeout (in ms) to wait for the operation to complete.
10131 Pass 0 for an infinite timeout.
10132 </desc>
10133 </param>
10134 <param name="priority" type="ProcessPriority" dir="in">
10135 <desc>
10136 Process priority to use for execution;
10137 see see <link to="ProcessPriority"/> for more information.</desc>
10138 </param>
10139 <param name="affinity" type="long" dir="in" safearray="yes">
10140 <desc>
10141 Process affinity to use for execution. This parameter
10142 is not implemented yet.
10143 </desc>
10144 </param>
10145 <param name="guestProcess" type="IGuestProcess" dir="return">
10146 <desc>Guest process object of the newly created process.</desc>
10147 </param>
10148 </method>
10149
10150 <method name="processGet">
10151 <desc>
10152 Gets a certain guest process by its process ID (PID).
10153 </desc>
10154 <param name="pid" type="unsigned long" dir="in">
10155 <desc>Process ID (PID) to get guest process for.</desc>
10156 </param>
10157 <param name="guestProcess" type="IGuestProcess" dir="return">
10158 <desc>Guest process of specified process ID (PID).</desc>
10159 </param>
10160 </method>
10161
10162 <method name="symlinkCreate">
10163 <desc>
10164 Creates a symbolic link on the guest.
10165
10166 <result name="E_NOTIMPL">
10167 The method is not implemented yet.
10168 </result>
10169 </desc>
10170 <param name="source" type="wstring" dir="in">
10171 <desc>The name of the symbolic link.</desc>
10172 </param>
10173 <param name="target" type="wstring" dir="in">
10174 <desc>The path to the symbolic link target.</desc>
10175 </param>
10176 <param name="type" type="SymlinkType" dir="in">
10177 <desc>
10178 The symbolic link type;
10179 see <link to="SymlinkReadFlag"/> for more information.
10180 </desc>
10181 </param>
10182 </method>
10183
10184 <method name="symlinkExists">
10185 <desc>
10186 Checks whether a symbolic link exists on the guest or not.
10187
10188 <result name="E_NOTIMPL">
10189 The method is not implemented yet.
10190 </result>
10191 </desc>
10192 <param name="symlink" type="wstring" dir="in">
10193 <desc>Symbolic link to check existence for.</desc>
10194 </param>
10195 <param name="exists" type="boolean" dir="return">
10196 <desc>Returns @c true if the symbolic link exists, @c false if not.</desc>
10197 </param>
10198 </method>
10199
10200 <method name="symlinkRead">
10201 <desc>
10202 Reads a symbolic link on the guest.
10203
10204 <result name="E_NOTIMPL">
10205 The method is not implemented yet.
10206 </result>
10207 </desc>
10208 <param name="symlink" type="wstring" dir="in">
10209 <desc>Full path to symbolic link to read.</desc>
10210 </param>
10211 <param name="flags" type="SymlinkReadFlag" dir="in" safearray="yes">
10212 <desc>
10213 Read flags; see <link to="SymlinkReadFlag"/> for more information.
10214 </desc>
10215 </param>
10216 <param name="target" type="wstring" dir="return">
10217 <desc>
10218 Target of the symbolic link pointing to, if found.
10219 </desc>
10220 </param>
10221 </method>
10222
10223 <method name="symlinkRemoveDirectory">
10224 <desc>
10225 Removes a symbolic link on the guest if it's a directory.
10226
10227 <result name="E_NOTIMPL">
10228 The method is not implemented yet.
10229 </result>
10230 </desc>
10231 <param name="path" type="wstring" dir="in">
10232 <desc>Symbolic link to remove.</desc>
10233 </param>
10234 </method>
10235
10236 <method name="symlinkRemoveFile">
10237 <desc>
10238 Removes a symbolic link on the guest if it's a file.
10239
10240 <result name="E_NOTIMPL">
10241 The method is not implemented yet.
10242 </result>
10243 </desc>
10244 <param name="file" type="wstring" dir="in">
10245 <desc>Symbolic link to remove.</desc>
10246 </param>
10247 </method>
10248
10249 </interface>
10250
10251 <interface
10252 name="IProcess" extends="$unknown"
10253 uuid="08864d56-96ab-418b-adbc-5a679532aeb0"
10254 wsmap="managed"
10255 >
10256 <desc>
10257 Abstract parent interface for processes handled by VirtualBox.
10258 </desc>
10259 <attribute name="PID" type="unsigned long" readonly="yes">
10260 <desc>
10261 The process ID (PID).
10262 </desc>
10263 </attribute>
10264 <attribute name="status" type="ProcessStatus" readonly="yes">
10265 <desc>
10266 The current process status; see <link to="ProcessStatus"/>
10267 for more information.
10268 </desc>
10269 </attribute>
10270 <attribute name="exitCode" type="long" readonly="yes">
10271 <desc>
10272 The exit code. Only available when the process has been
10273 terminated normally.
10274 </desc>
10275 </attribute>
10276 <attribute name="environment" type="wstring" readonly="yes" safearray="yes">
10277 <desc>
10278 The environment block this process is using during execution.
10279 </desc>
10280 </attribute>
10281 <attribute name="arguments" type="wstring" readonly="yes" safearray="yes">
10282 <desc>
10283 The arguments this process is using for execution.
10284 </desc>
10285 </attribute>
10286 <attribute name="executablePath" type="wstring" readonly="yes">
10287 <desc>Full path of the actual executable image.</desc>
10288 </attribute>
10289 <attribute name="name" type="wstring" readonly="yes">
10290 <desc>The friendly name of this process.</desc>
10291 </attribute>
10292
10293 <method name="waitFor">
10294 <desc>
10295 Waits for one more events to happen.
10296 </desc>
10297 <param name="waitFor" type="unsigned long" dir="in">
10298 <desc>
10299 Specifies what to wait for;
10300 see <link to="ProcessWaitForFlag"/> for more information.
10301 </desc>
10302 </param>
10303 <param name="timeoutMS" type="unsigned long" dir="in">
10304 <desc>
10305 Timeout (in ms) to wait for the operation to complete.
10306 Pass 0 for an infinite timeout.
10307 </desc>
10308 </param>
10309 <param name="reason" type="ProcessWaitResult" dir="return">
10310 <desc>
10311 The overall wait result;
10312 see <link to="ProcessWaitResult"/> for more information.
10313 </desc>
10314 </param>
10315 </method>
10316
10317 <method name="waitForArray">
10318 <desc>
10319 Waits for one more events to happen.
10320 Scriptable version of <link to="#waitFor" />.
10321 </desc>
10322 <param name="waitFor" type="ProcessWaitForFlag" dir="in" safearray="yes">
10323 <desc>
10324 Specifies what to wait for;
10325 see <link to="ProcessWaitForFlag"/> for more information.
10326 </desc>
10327 </param>
10328 <param name="timeoutMS" type="unsigned long" dir="in">
10329 <desc>
10330 Timeout (in ms) to wait for the operation to complete.
10331 Pass 0 for an infinite timeout.
10332 </desc>
10333 </param>
10334 <param name="reason" type="ProcessWaitResult" dir="return">
10335 <desc>
10336 The overall wait result;
10337 see <link to="ProcessWaitResult"/> for more information.
10338 </desc>
10339 </param>
10340 </method>
10341
10342 <method name="read">
10343 <desc>
10344 Reads data from a running process.
10345 </desc>
10346 <param name="handle" type="unsigned long" dir="in">
10347 <desc>Handle to read from. Usually 0 is stdin.</desc>
10348 </param>
10349 <param name="toRead" type="unsigned long" dir="in">
10350 <desc>Number of bytes to read.</desc>
10351 </param>
10352 <param name="timeoutMS" type="unsigned long" dir="in">
10353 <desc>
10354 Timeout (in ms) to wait for the operation to complete.
10355 Pass 0 for an infinite timeout.
10356 </desc>
10357 </param>
10358 <param name="data" type="octet" dir="return" safearray="yes">
10359 <desc>Array of data read.</desc>
10360 </param>
10361 </method>
10362
10363 <method name="write">
10364 <desc>
10365 Writes data to a running process.
10366 </desc>
10367 <param name="handle" type="unsigned long" dir="in">
10368 <desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
10369 </param>
10370 <param name="flags" type="unsigned long" dir="in">
10371 <desc>
10372 A combination of <link to="ProcessInputFlag"/> flags.
10373 </desc>
10374 </param>
10375 <param name="data" type="octet" dir="in" safearray="yes">
10376 <desc>
10377 Array of bytes to write. The size of the array also specifies
10378 how much to write.
10379 </desc>
10380 </param>
10381 <param name="timeoutMS" type="unsigned long" dir="in">
10382 <desc>
10383 Timeout (in ms) to wait for the operation to complete.
10384 Pass 0 for an infinite timeout.
10385 </desc>
10386 </param>
10387 <param name="written" type="unsigned long" dir="return">
10388 <desc>How much bytes were written.</desc>
10389 </param>
10390 </method>
10391
10392 <method name="writeArray">
10393 <desc>
10394 Writes data to a running process.
10395 Scriptable version of <link to="#write" />.
10396 </desc>
10397 <param name="handle" type="unsigned long" dir="in">
10398 <desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
10399 </param>
10400 <param name="flags" type="ProcessInputFlag" dir="in" safearray="yes">
10401 <desc>
10402 A combination of <link to="ProcessInputFlag"/> flags.
10403 </desc>
10404 </param>
10405 <param name="data" type="octet" dir="in" safearray="yes">
10406 <desc>
10407 Array of bytes to write. The size of the array also specifies
10408 how much to write.
10409 </desc>
10410 </param>
10411 <param name="timeoutMS" type="unsigned long" dir="in">
10412 <desc>
10413 Timeout (in ms) to wait for the operation to complete.
10414 Pass 0 for an infinite timeout.
10415 </desc>
10416 </param>
10417 <param name="written" type="unsigned long" dir="return">
10418 <desc>How much bytes were written.</desc>
10419 </param>
10420 </method>
10421
10422 <method name="terminate">
10423 <desc>
10424 Terminates (kills) a running process.
10425 </desc>
10426 </method>
10427 </interface>
10428
10429 <interface
10430 name="IGuestProcess" extends="IProcess"
10431 uuid="dfa39a36-5d43-4840-a025-67ea956b3111"
10432 wsmap="managed"
10433 >
10434 <desc>
10435 Implementation of the <link to="IProcess" /> object
10436 for processes on the guest.
10437 </desc>
10438 </interface>
10439
10440 <interface
10441 name="IDirectory" extends="$unknown"
10442 uuid="1b70dd03-26d7-483a-8877-89bbb0f87b70"
10443 wsmap="managed"
10444 >
10445 <desc>
10446 Abstract parent interface for directories handled by VirtualBox.
10447 </desc>
10448
10449 <attribute name="directoryName" type="wstring" readonly="yes">
10450 <desc>
10451 Full path of directory.
10452 </desc>
10453 </attribute>
10454
10455 <attribute name="filter" type="wstring" readonly="yes">
10456 <desc>
10457 The open filter.
10458 </desc>
10459 </attribute>
10460
10461 <method name="close">
10462 <desc>
10463 Closes this directory. After closing operations like reading the next
10464 directory entry will not be possible anymore.
10465 </desc>
10466 </method>
10467
10468 <method name="read">
10469 <desc>
10470 Reads the next directory entry of this directory.
10471 <result name="VBOX_E_OBJECT_NOT_FOUND">
10472 No more directory entries to read.
10473 </result>
10474 </desc>
10475 <param name="objInfo" type="IFsObjInfo" dir="return">
10476 <desc>Object information of the current directory entry read. Also see <link to="IFsObjInfo"/>.</desc>
10477 </param>
10478 </method>
10479 </interface>
10480
10481 <interface
10482 name="IGuestDirectory" extends="IDirectory"
10483 uuid="af4a8ce0-0725-42b7-8826-46e3c7ba7357"
10484 wsmap="managed"
10485 >
10486 <desc>
10487 Implementation of the <link to="IDirectory" /> object
10488 for directories on the guest.
10489 </desc>
10490 </interface>
10491
10492 <interface
10493 name="IFile" extends="$unknown"
10494 uuid="b702a560-6139-4a8e-a892-bbf14b97bf97"
10495 wsmap="managed"
10496 >
10497 <desc>
10498 Abstract parent interface for files handled by VirtualBox.
10499 </desc>
10500 <attribute name="creationMode" type="unsigned long" readonly="yes">
10501 <desc>
10502 The creation mode.
10503
10504 <result name="E_NOTIMPL">
10505 The method is not implemented yet.
10506 </result>
10507 </desc>
10508 </attribute>
10509 <attribute name="disposition" type="unsigned long" readonly="yes">
10510 <desc>
10511 The disposition mode.
10512
10513 <result name="E_NOTIMPL">
10514 The method is not implemented yet.
10515 </result>
10516 </desc>
10517 </attribute>
10518 <attribute name="fileName" type="wstring" readonly="yes">
10519 <desc>
10520 Full path of the actual file name of this file.
10521 </desc>
10522 </attribute>
10523 <attribute name="initialSize" type="long long" readonly="yes">
10524 <desc>
10525 The initial size in bytes when opened.
10526
10527 <result name="E_NOTIMPL">
10528 The method is not implemented yet.
10529 </result>
10530 </desc>
10531 </attribute>
10532 <attribute name="openMode" type="unsigned long" readonly="yes">
10533 <desc>
10534 The open mode.
10535
10536 <result name="E_NOTIMPL">
10537 The method is not implemented yet.
10538 </result>
10539 </desc>
10540 </attribute>
10541 <attribute name="offset" type="long long" readonly="yes">
10542 <desc>
10543 Current read/write offset in bytes.
10544
10545 <result name="E_NOTIMPL">
10546 The method is not implemented yet.
10547 </result>
10548 </desc>
10549 </attribute>
10550
10551 <method name="close">
10552 <desc>
10553 Closes this file. After closing operations like reading data,
10554 writing data or querying information will not be possible anymore.
10555
10556 <result name="E_NOTIMPL">
10557 The method is not implemented yet.
10558 </result>
10559 </desc>
10560 </method>
10561
10562 <method name="queryInfo">
10563 <desc>
10564 Queries information about this file.
10565
10566 <result name="E_NOTIMPL">
10567 The method is not implemented yet.
10568 </result>
10569 </desc>
10570 <param name="objInfo" type="IFsObjInfo" dir="return">
10571 <desc>Object information of this file. Also see <link to="IFsObjInfo"/>.</desc>
10572 </param>
10573 </method>
10574
10575 <method name="read">
10576 <desc>
10577 Reads data from this file.
10578
10579 <result name="E_NOTIMPL">
10580 The method is not implemented yet.
10581 </result>
10582 </desc>
10583 <param name="toRead" type="unsigned long" dir="in">
10584 <desc>Number of bytes to read.</desc>
10585 </param>
10586 <param name="timeoutMS" type="unsigned long" dir="in">
10587 <desc>
10588 Timeout (in ms) to wait for the operation to complete.
10589 Pass 0 for an infinite timeout.
10590 </desc>
10591 </param>
10592 <param name="data" type="octet" dir="return" safearray="yes">
10593 <desc>Array of data read.</desc>
10594 </param>
10595 </method>
10596
10597 <method name="readAt">
10598 <desc>
10599 Reads data from an offset of this file.
10600
10601 <result name="E_NOTIMPL">
10602 The method is not implemented yet.
10603 </result>
10604 </desc>
10605 <param name="offset" type="long long" dir="in">
10606 <desc>Offset in bytes to start reading.</desc>
10607 </param>
10608 <param name="toRead" type="unsigned long" dir="in">
10609 <desc>Number of bytes to read.</desc>
10610 </param>
10611 <param name="timeoutMS" type="unsigned long" dir="in">
10612 <desc>
10613 Timeout (in ms) to wait for the operation to complete.
10614 Pass 0 for an infinite timeout.
10615 </desc>
10616 </param>
10617 <param name="data" type="octet" dir="return" safearray="yes">
10618 <desc>Array of data read.</desc>
10619 </param>
10620 </method>
10621
10622 <method name="seek">
10623 <desc>
10624 Changes the read and write position of this file.
10625
10626 <result name="E_NOTIMPL">
10627 The method is not implemented yet.
10628 </result>
10629 </desc>
10630 <param name="offset" type="long long" dir="in">
10631 <desc>Offset to seek.</desc>
10632 </param>
10633 <param name="whence" type="FileSeekType" dir="in">
10634 <desc>
10635 Seek mode; see <link to="FileSeekType"/> for more information.
10636 </desc>
10637 </param>
10638 </method>
10639
10640 <method name="setACL">
10641 <desc>
10642 Sets the ACL of this file.
10643
10644 <result name="E_NOTIMPL">
10645 The method is not implemented yet.
10646 </result>
10647 </desc>
10648 <param name="acl" type="wstring" dir="in">
10649 <desc>ACL string to set.</desc>
10650 </param>
10651 </method>
10652
10653 <method name="write">
10654 <desc>
10655 Writes bytes to this file.
10656 </desc>
10657 <param name="data" type="octet" dir="in" safearray="yes">
10658 <desc>
10659 Array of bytes to write. The size of the array also specifies
10660 how much to write.
10661 </desc>
10662 </param>
10663 <param name="timeoutMS" type="unsigned long" dir="in">
10664 <desc>
10665 Timeout (in ms) to wait for the operation to complete.
10666 Pass 0 for an infinite timeout.
10667 </desc>
10668 </param>
10669 <param name="written" type="unsigned long" dir="return">
10670 <desc>How much bytes were written.</desc>
10671 </param>
10672 </method>
10673
10674 <method name="writeAt">
10675 <desc>
10676 Writes bytes at a certain offset to this file.
10677
10678 <result name="E_NOTIMPL">
10679 The method is not implemented yet.
10680 </result>
10681 </desc>
10682 <param name="offset" type="long long" dir="in">
10683 <desc>Offset in bytes to start writing.</desc>
10684 </param>
10685 <param name="data" type="octet" dir="in" safearray="yes">
10686 <desc>
10687 Array of bytes to write. The size of the array also specifies
10688 how much to write.
10689 </desc>
10690 </param>
10691 <param name="timeoutMS" type="unsigned long" dir="in">
10692 <desc>
10693 Timeout (in ms) to wait for the operation to complete.
10694 Pass 0 for an infinite timeout.
10695 </desc>
10696 </param>
10697 <param name="written" type="unsigned long" dir="return">
10698 <desc>How much bytes were written.</desc>
10699 </param>
10700 </method>
10701
10702 </interface>
10703
10704 <interface
10705 name="IGuestFile" extends="IFile"
10706 uuid="60661aec-145f-4d11-b80e-8ea151598093"
10707 wsmap="managed"
10708 >
10709 <desc>
10710 Implementation of the <link to="IFile" /> object
10711 for files on the guest.
10712 </desc>
10713 </interface>
10714
10715 <interface
10716 name="IFsObjInfo" extends="$unknown"
10717 uuid="4047ba30-7006-4966-ae86-94164e5e20eb"
10718 wsmap="managed"
10719 >
10720 <desc>
10721 Abstract parent interface for VirtualBox file system object information.
10722 This can be information about a file or a directory, for example.
10723 </desc>
10724
10725 <attribute name="accessTime" type="long long" readonly="yes">
10726 <desc>
10727 Time of last access (st_atime).
10728 </desc>
10729 </attribute>
10730 <attribute name="allocatedSize" type="long long" readonly="yes">
10731 <desc>
10732 Disk allocation size (st_blocks * DEV_BSIZE).
10733 </desc>
10734 </attribute>
10735 <attribute name="birthTime" type="long long" readonly="yes">
10736 <desc>
10737 Time of file birth (st_birthtime).
10738 </desc>
10739 </attribute>
10740 <attribute name="changeTime" type="long long" readonly="yes">
10741 <desc>
10742 Time of last status change (st_ctime).
10743 </desc>
10744 </attribute>
10745 <attribute name="deviceNumber" type="unsigned long" readonly="yes">
10746 <desc>
10747 The device number of a character or block device type object (st_rdev).
10748 </desc>
10749 </attribute>
10750 <attribute name="fileAttributes" type="wstring" readonly="yes">
10751 <desc>
10752 File attributes. Not implemented yet.
10753 </desc>
10754 </attribute>
10755 <attribute name="generationId" type="unsigned long" readonly="yes">
10756 <desc>
10757 The current generation number (st_gen).
10758 </desc>
10759 </attribute>
10760 <attribute name="GID" type="unsigned long" readonly="yes">
10761 <desc>
10762 The group the filesystem object is assigned (st_gid).
10763 </desc>
10764 </attribute>
10765 <attribute name="groupName" type="wstring" readonly="yes">
10766 <desc>
10767 The group name.
10768 </desc>
10769 </attribute>
10770 <attribute name="hardLinks" type="unsigned long" readonly="yes">
10771 <desc>
10772 Number of hard links to this filesystem object (st_nlink).
10773 </desc>
10774 </attribute>
10775 <attribute name="modificationTime" type="long long" readonly="yes">
10776 <desc>
10777 Time of last data modification (st_mtime).
10778 </desc>
10779 </attribute>
10780 <attribute name="name" type="wstring" readonly="yes">
10781 <desc>
10782 The object's name.
10783 </desc>
10784 </attribute>
10785 <attribute name="nodeId" type="long long" readonly="yes">
10786 <desc>
10787 The unique identifier (within the filesystem) of this filesystem object (st_ino).
10788 </desc>
10789 </attribute>
10790 <attribute name="nodeIdDevice" type="unsigned long" readonly="yes">
10791 <desc>
10792 The device number of the device which this filesystem object resides on (st_dev).
10793 </desc>
10794 </attribute>
10795 <attribute name="objectSize" type="long long" readonly="yes">
10796 <desc>
10797 The logical size (st_size). For normal files this is the size of the file.
10798 For symbolic links, this is the length of the path name contained in the
10799 symbolic link. For other objects this fields needs to be specified.
10800 </desc>
10801 </attribute>
10802 <attribute name="type" type="FsObjType" readonly="yes">
10803 <desc>
10804 The object type. See <link to="FsObjType" /> for more.
10805 </desc>
10806 </attribute>
10807 <attribute name="UID" type="unsigned long" readonly="yes">
10808 <desc>
10809 The user owning the filesystem object (st_uid).
10810 </desc>
10811 </attribute>
10812 <attribute name="userFlags" type="unsigned long" readonly="yes">
10813 <desc>
10814 User flags (st_flags).
10815 </desc>
10816 </attribute>
10817 <attribute name="userName" type="wstring" readonly="yes">
10818 <desc>
10819 The user name.
10820 </desc>
10821 </attribute>
10822
10823 </interface>
10824
10825 <interface
10826 name="IGuestFsObjInfo" extends="IFsObjInfo"
10827 uuid="d5cf678e-3484-4e4a-ac55-329e15462e18"
10828 wsmap="managed"
10829 >
10830 <desc>
10831 Represents the guest implementation of the
10832 <link to="IFsObjInfo" /> object.
10833 </desc>
10834 </interface>
10835
10836 <interface
10837 name="IGuest" extends="$unknown"
10838 uuid="19c32350-0618-4ede-b0c3-2b4311bf0d9b"
10839 wsmap="managed"
10840 >
10841 <desc>
10842 The IGuest interface represents information about the operating system
10843 running inside the virtual machine. Used in
10844 <link to="IConsole::guest"/>.
10845
10846 IGuest provides information about the guest operating system, whether
10847 Guest Additions are installed and other OS-specific virtual machine
10848 properties.
10849 </desc>
10850
10851 <attribute name="OSTypeId" type="wstring" readonly="yes">
10852 <desc>
10853 Identifier of the Guest OS type as reported by the Guest
10854 Additions.
10855 You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
10856 an IGuestOSType object representing details about the given
10857 Guest OS type.
10858 <note>
10859 If Guest Additions are not installed, this value will be
10860 the same as <link to="IMachine::OSTypeId"/>.
10861 </note>
10862 </desc>
10863 </attribute>
10864
10865 <attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
10866 <desc>
10867 Current run level of the Guest Additions.
10868 </desc>
10869 </attribute>
10870
10871 <attribute name="additionsVersion" type="wstring" readonly="yes">
10872 <desc>
10873 Version of the Guest Additions in the same format as
10874 <link to="IVirtualBox::version"/>.
10875 </desc>
10876 </attribute>
10877
10878 <attribute name="additionsRevision" type="unsigned long" readonly="yes">
10879 <desc>
10880 The internal build revision number of the additions.
10881
10882 See also <link to="IVirtualBox::revision"/>.
10883 </desc>
10884 </attribute>
10885
10886 <attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
10887 <desc>
10888 Array of current known facilities. Only returns facilities where a status is known,
10889 e.g. facilities with an unknown status will not be returned.
10890 </desc>
10891 </attribute>
10892
10893 <attribute name="sessions" type="IGuestSession" readonly="yes" safearray="yes">
10894 <desc>Returns a collection of all opened guest sessions.</desc>
10895 </attribute>
10896
10897 <attribute name="memoryBalloonSize" type="unsigned long">
10898 <desc>Guest system memory balloon size in megabytes (transient property).</desc>
10899 </attribute>
10900
10901 <attribute name="statisticsUpdateInterval" type="unsigned long">
10902 <desc>Interval to update guest statistics in seconds.</desc>
10903 </attribute>
10904
10905 <method name="internalGetStatistics">
10906 <desc>
10907 Internal method; do not use as it might change at any time.
10908 </desc>
10909 <param name="cpuUser" type="unsigned long" dir="out">
10910 <desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
10911 </param>
10912 <param name="cpuKernel" type="unsigned long" dir="out">
10913 <desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
10914 </param>
10915 <param name="cpuIdle" type="unsigned long" dir="out">
10916 <desc>Percentage of processor time spent idling as seen by the guest.</desc>
10917 </param>
10918 <param name="memTotal" type="unsigned long" dir="out">
10919 <desc>Total amount of physical guest RAM.</desc>
10920 </param>
10921 <param name="memFree" type="unsigned long" dir="out">
10922 <desc>Free amount of physical guest RAM.</desc>
10923 </param>
10924 <param name="memBalloon" type="unsigned long" dir="out">
10925 <desc>Amount of ballooned physical guest RAM.</desc>
10926 </param>
10927 <param name="memShared" type="unsigned long" dir="out">
10928 <desc>Amount of shared physical guest RAM.</desc>
10929 </param>
10930 <param name="memCache" type="unsigned long" dir="out">
10931 <desc>Total amount of guest (disk) cache memory.</desc>
10932 </param>
10933 <param name="pagedTotal" type="unsigned long" dir="out">
10934 <desc>Total amount of space in the page file.</desc>
10935 </param>
10936 <param name="memAllocTotal" type="unsigned long" dir="out">
10937 <desc>Total amount of memory allocated by the hypervisor.</desc>
10938 </param>
10939 <param name="memFreeTotal" type="unsigned long" dir="out">
10940 <desc>Total amount of free memory available in the hypervisor.</desc>
10941 </param>
10942 <param name="memBalloonTotal" type="unsigned long" dir="out">
10943 <desc>Total amount of memory ballooned by the hypervisor.</desc>
10944 </param>
10945 <param name="memSharedTotal" type="unsigned long" dir="out">
10946 <desc>Total amount of shared memory in the hypervisor.</desc>
10947 </param>
10948 </method>
10949
10950 <method name="getFacilityStatus">
10951 <desc>
10952 Get the current status of a Guest Additions facility.
10953 </desc>
10954 <param name="facility" type="AdditionsFacilityType" dir="in">
10955 <desc>Facility to check status for.</desc>
10956 </param>
10957 <param name="timestamp" type="long long" dir="out">
10958 <desc>Timestamp (in ms) of last status update seen by the host.</desc>
10959 </param>
10960 <param name="status" type="AdditionsFacilityStatus" dir="return">
10961 <desc>The current (latest) facility status.</desc>
10962 </param>
10963 </method>
10964
10965 <method name="getAdditionsStatus">
10966 <desc>
10967 Retrieve the current status of a certain Guest Additions run level.
10968
10969 <result name="VBOX_E_NOT_SUPPORTED">
10970 Wrong status level specified.
10971 </result>
10972
10973 </desc>
10974 <param name="level" type="AdditionsRunLevelType" dir="in">
10975 <desc>Status level to check</desc>
10976 </param>
10977 <param name="active" type="boolean" dir="return">
10978 <desc>Flag whether the status level has been reached or not</desc>
10979 </param>
10980 </method>
10981
10982 <method name="setCredentials">
10983 <desc>
10984 Store login credentials that can be queried by guest operating
10985 systems with Additions installed. The credentials are transient
10986 to the session and the guest may also choose to erase them. Note
10987 that the caller cannot determine whether the guest operating system
10988 has queried or made use of the credentials.
10989
10990 <result name="VBOX_E_VM_ERROR">
10991 VMM device is not available.
10992 </result>
10993
10994 </desc>
10995 <param name="userName" type="wstring" dir="in">
10996 <desc>User name string, can be empty</desc>
10997 </param>
10998 <param name="password" type="wstring" dir="in">
10999 <desc>Password string, can be empty</desc>
11000 </param>
11001 <param name="domain" type="wstring" dir="in">
11002 <desc>Domain name (guest logon scheme specific), can be empty</desc>
11003 </param>
11004 <param name="allowInteractiveLogon" type="boolean" dir="in">
11005 <desc>
11006 Flag whether the guest should alternatively allow the user to
11007 interactively specify different credentials. This flag might
11008 not be supported by all versions of the Additions.
11009 </desc>
11010 </param>
11011 </method>
11012
11013 <method name="dragHGEnter">
11014 <desc>
11015 Informs the guest about a Drag and Drop enter event.
11016
11017 This is used in Host - Guest direction.
11018
11019 <result name="VBOX_E_VM_ERROR">
11020 VMM device is not available.
11021 </result>
11022
11023 </desc>
11024 <param name="screenId" type="unsigned long" dir="in">
11025 <desc>The screen id where the Drag and Drop event occured.</desc>
11026 </param>
11027 <param name="y" type="unsigned long" dir="in">
11028 <desc>y-position of the event.</desc>
11029 </param>
11030 <param name="x" type="unsigned long" dir="in">
11031 <desc>x-position of the event.</desc>
11032 </param>
11033 <param name="defaultAction" type="DragAndDropAction" dir="in">
11034 <desc>The default action to use.</desc>
11035 </param>
11036 <param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11037 <desc>The actions which are allowed.</desc>
11038 </param>
11039 <param name="formats" type="wstring" dir="in" safearray="yes">
11040 <desc>The supported mime types.</desc>
11041 </param>
11042 <param name="resultAction" type="DragAndDropAction" dir="return">
11043 <desc>The resulting action of this event.</desc>
11044 </param>
11045 </method>
11046
11047 <method name="dragHGMove">
11048 <desc>
11049 Informs the guest about a Drag and Drop move event.
11050
11051 This is used in Host - Guest direction.
11052
11053 <result name="VBOX_E_VM_ERROR">
11054 VMM device is not available.
11055 </result>
11056
11057 </desc>
11058 <param name="screenId" type="unsigned long" dir="in">
11059 <desc>The screen id where the Drag and Drop event occured.</desc>
11060 </param>
11061 <param name="x" type="unsigned long" dir="in">
11062 <desc>x-position of the event.</desc>
11063 </param>
11064 <param name="y" type="unsigned long" dir="in">
11065 <desc>y-position of the event.</desc>
11066 </param>
11067 <param name="defaultAction" type="DragAndDropAction" dir="in">
11068 <desc>The default action to use.</desc>
11069 </param>
11070 <param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11071 <desc>The actions which are allowed.</desc>
11072 </param>
11073 <param name="formats" type="wstring" dir="in" safearray="yes">
11074 <desc>The supported mime types.</desc>
11075 </param>
11076 <param name="resultAction" type="DragAndDropAction" dir="return">
11077 <desc>The resulting action of this event.</desc>
11078 </param>
11079 </method>
11080
11081 <method name="dragHGLeave">
11082 <desc>
11083 Informs the guest about a Drag and Drop leave event.
11084
11085 This is used in Host - Guest direction.
11086
11087 <result name="VBOX_E_VM_ERROR">
11088 VMM device is not available.
11089 </result>
11090
11091 </desc>
11092 <param name="screenId" type="unsigned long" dir="in">
11093 <desc>The screen id where the Drag and Drop event occured.</desc>
11094 </param>
11095 </method>
11096
11097 <method name="dragHGDrop">
11098 <desc>
11099 Informs the guest about a drop event.
11100
11101 This is used in Host - Guest direction.
11102
11103 <result name="VBOX_E_VM_ERROR">
11104 VMM device is not available.
11105 </result>
11106
11107 </desc>
11108 <param name="screenId" type="unsigned long" dir="in">
11109 <desc>The screen id where the Drag and Drop event occured.</desc>
11110 </param>
11111 <param name="x" type="unsigned long" dir="in">
11112 <desc>x-position of the event.</desc>
11113 </param>
11114 <param name="y" type="unsigned long" dir="in">
11115 <desc>y-position of the event.</desc>
11116 </param>
11117 <param name="defaultAction" type="DragAndDropAction" dir="in">
11118 <desc>The default action to use.</desc>
11119 </param>
11120 <param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11121 <desc>The actions which are allowed.</desc>
11122 </param>
11123 <param name="formats" type="wstring" dir="in" safearray="yes">
11124 <desc>The supported mime types.</desc>
11125 </param>
11126 <param name="format" type="wstring" dir="out">
11127 <desc>The resulting format of this event.</desc>
11128 </param>
11129 <param name="resultAction" type="DragAndDropAction" dir="return">
11130 <desc>The resulting action of this event.</desc>
11131 </param>
11132 </method>
11133
11134 <method name="dragHGPutData">
11135 <desc>
11136 Informs the guest about a drop data event.
11137
11138 This is used in Host - Guest direction.
11139
11140 <result name="VBOX_E_VM_ERROR">
11141 VMM device is not available.
11142 </result>
11143
11144 </desc>
11145 <param name="screenId" type="unsigned long" dir="in">
11146 <desc>The screen id where the Drag and Drop event occured.</desc>
11147 </param>
11148 <param name="format" type="wstring" dir="in">
11149 <desc>The mime type the data is in.</desc>
11150 </param>
11151 <param name="data" type="octet" dir="in" safearray="yes">
11152 <desc>The actual data.</desc>
11153 </param>
11154 <param name="progress" type="IProgress" dir="return">
11155 <desc>Progress object to track the operation completion.</desc>
11156 </param>
11157 </method>
11158
11159 <method name="dragGHPending">
11160 <desc>
11161 Ask the guest if there is any Drag and Drop operation pending in the guest.
11162
11163 If no Drag and Drop operation is pending currently, Ignore is returned.
11164
11165 This is used in Guest - Host direction.
11166
11167 <result name="VBOX_E_VM_ERROR">
11168 VMM device is not available.
11169 </result>
11170
11171 </desc>
11172 <param name="screenId" type="unsigned long" dir="in">
11173 <desc>The screen id where the Drag and Drop event occured.</desc>
11174 </param>
11175 <param name="format" type="wstring" dir="out" safearray="yes">
11176 <desc>On return the supported mime types.</desc>
11177 </param>
11178 <param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
11179 <desc>On return the actions which are allowed.</desc>
11180 </param>
11181 <param name="defaultAction" type="DragAndDropAction" dir="return">
11182 <desc>On return the default action to use.</desc>
11183 </param>
11184 </method>
11185
11186 <method name="dragGHDropped">
11187 <desc>
11188 Informs the guest that a drop event occured for a pending Drag and Drop event.
11189
11190 This is used in Guest - Host direction.
11191
11192 <result name="VBOX_E_VM_ERROR">
11193 VMM device is not available.
11194 </result>
11195
11196 </desc>
11197
11198 <param name="format" type="wstring" dir="in">
11199 <desc>The mime type the data must be in.</desc>
11200 </param>
11201 <param name="action" type="DragAndDropAction" dir="in">
11202 <desc>The action to use.</desc>
11203 </param>
11204 <param name="progress" type="IProgress" dir="return">
11205 <desc>Progress object to track the operation completion.</desc>
11206 </param>
11207 </method>
11208
11209 <method name="dragGHGetData">
11210 <desc>
11211 Fetch the data of a previously Drag and Drop event from the guest.
11212
11213 This is used in Guest - Host direction.
11214
11215 <result name="VBOX_E_VM_ERROR">
11216 VMM device is not available.
11217 </result>
11218
11219 </desc>
11220
11221 <param name="data" type="octet" safearray="yes" dir="return">
11222 <desc>The actual data.</desc>
11223 </param>
11224 </method>
11225
11226 <method name="createSession">
11227 <desc>
11228 Creates a new guest session for controlling the guest. All operations
11229 of a session object are using the same credentials specified with this
11230 call. Anonymous sessions, that is, sessions without specifying a valid
11231 user account on the guest are not allowed due to security reasons. Per
11232 VM there can be 255 sessions at once. Using sessions across VMs is not
11233 possible.
11234
11235 A guest session holds all started or opened guest processes, guest
11236 directories and guest files.
11237
11238 Closing a session via <link to="IGuestSession::close" /> will try to close
11239 all the mentioned objects above unless these objects are still used by
11240 a client.
11241 </desc>
11242 <param name="user" type="wstring" dir="in">
11243 <desc>
11244 User name this session will be using to control the guest; has to exist
11245 and have the appropriate rights to execute programs in the VM. Must not
11246 be empty.
11247 </desc>
11248 </param>
11249 <param name="password" type="wstring" dir="in">
11250 <desc>
11251 Password of the user account to be used. Empty passwords are allowed.
11252 </desc>
11253 </param>
11254 <param name="domain" type="wstring" dir="in">
11255 <desc>
11256 Domain name of the user account to be used if the guest is part of
11257 a domain. Optional. This feature is not implemented yet.
11258 </desc>
11259 </param>
11260 <param name="sessionName" type="wstring" dir="in">
11261 <desc>
11262 The session's friendly name. Optional, can be empty.
11263 </desc>
11264 </param>
11265 <param name="guestSession" type="IGuestSession" dir="return">
11266 <desc>
11267 The newly created session object.
11268 </desc>
11269 </param>
11270 </method>
11271
11272 <method name="findSession">
11273 <desc>
11274 Finds guest sessions by their friendly name and returns an interface
11275 array with all found guest sessions.
11276 </desc>
11277 <param name="sessionName" type="wstring" dir="in">
11278 <desc>
11279 The session's friendly name to find. Wildcards like ? and * are allowed.
11280 </desc>
11281 </param>
11282 <param name="sessions" type="IGuestSession" safearray="yes" dir="return">
11283 <desc>
11284 Array with all guest sessions found matching the name specified.
11285 </desc>
11286 </param>
11287 </method>
11288
11289 <method name="executeProcess">
11290 <desc>
11291 Executes an existing program inside the guest VM.
11292
11293 <note>
11294 Starting at VirtualBox 4.1.8 guest process execution by default is limited
11295 to serve up to 25 guest processes at a time. If all 25 guest processes
11296 are still active and running, starting a new guest process will result in an
11297 appropriate error message.
11298
11299 If ExecuteProcessFlag_WaitForStdOut and/or respectively
11300 ExecuteProcessFlag_WaitForStdErr of <link to="ExecuteProcessFlag"/> is
11301 set, the guest process will not exit until all data from the specified
11302 stream(s) is/are read out.
11303
11304 To raise or lower the guest process execution limit, either the guest property
11305 "/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
11306 command line by specifying "--control-procs-max-kept" needs to be modified.
11307 A restart of the guest OS is required afterwards. To serve unlimited guest
11308 processes, a value of "0" needs to be set (not recommended).
11309 </note>
11310
11311 <result name="VBOX_E_IPRT_ERROR">
11312 Could not execute process.
11313 </result>
11314
11315 </desc>
11316 <param name="execName" type="wstring" dir="in">
11317 <desc>
11318 Full path name of the command to execute on the guest; the
11319 commands has to exists in the guest VM in order to be executed.
11320 </desc>
11321 </param>
11322 <param name="flags" type="unsigned long" dir="in">
11323 <desc>
11324 <link to="ExecuteProcessFlag"/> flags.
11325 </desc>
11326 </param>
11327 <param name="arguments" type="wstring" safearray="yes" dir="in">
11328 <desc>
11329 Array of arguments passed to the execution command.
11330 </desc>
11331 </param>
11332 <param name="environment" type="wstring" safearray="yes" dir="in">
11333 <desc>
11334 Environment variables that can be set while the command is being
11335 executed, in form of "NAME=VALUE"; one pair per entry. To unset a
11336 variable just set its name ("NAME") without a value.
11337 </desc>
11338 </param>
11339 <param name="userName" type="wstring" dir="in">
11340 <desc>
11341 User name under which the command will be executed; has to exist
11342 and have the appropriate rights to execute programs in the VM.
11343 </desc>
11344 </param>
11345 <param name="password" type="wstring" dir="in">
11346 <desc>
11347 Password of the user account specified.
11348 </desc>
11349 </param>
11350 <param name="timeoutMS" type="unsigned long" dir="in">
11351 <desc>
11352 The maximum timeout value (in msec) to wait for finished program
11353 execution. Pass 0 for an infinite timeout.
11354 </desc>
11355 </param>
11356 <param name="pid" type="unsigned long" dir="out">
11357 <desc>
11358 The PID (process ID) of the started command for later reference.
11359 </desc>
11360 </param>
11361 <param name="progress" type="IProgress" dir="return">
11362 <desc>Progress object to track the operation completion.</desc>
11363 </param>
11364 </method>
11365
11366 <method name="getProcessOutput">
11367 <desc>
11368 Retrieves output of a formerly started and running guest process.
11369
11370 <note>
11371 Starting with VirtualBox 4.1.8 this only will return output data
11372 from stdout or stderr if flag ExecuteProcessFlag_WaitForStdOut
11373 and/or respectively ExecuteProcessFlag_WaitForStdErr of
11374 <link to="ExecuteProcessFlag"/> is set in the
11375 former <link to="#executeProcess"/> call for this guest process.
11376 </note>
11377
11378 <result name="VBOX_E_IPRT_ERROR">
11379 Could not retrieve output.
11380 </result>
11381
11382 </desc>
11383 <param name="pid" type="unsigned long" dir="in">
11384 <desc>
11385 Process id returned by earlier <link to="#executeProcess"/> call.
11386 </desc>
11387 </param>
11388 <param name="flags" type="unsigned long" dir="in">
11389 <desc>
11390 <link to="ProcessOutputFlag"/> flags.
11391 </desc>
11392 </param>
11393 <param name="timeoutMS" type="unsigned long" dir="in">
11394 <desc>
11395 The maximum timeout value (in msec) to wait for output
11396 data. Pass 0 for an infinite timeout.
11397 </desc>
11398 </param>
11399 <param name="size" type="long long" dir="in">
11400 <desc>
11401 Size in bytes to read in the buffer.
11402 </desc>
11403 </param>
11404 <param name="data" type="octet" safearray="yes" dir="return">
11405 <desc>
11406 Buffer for retrieving the actual output. A data size of 0 means end of file
11407 if the requested size was not 0. This is the unprocessed
11408 output data, i.e. the line ending style depends on the platform of
11409 the system the server is running on.
11410 </desc>
11411 </param>
11412 </method>
11413
11414 <method name="getProcessStatus">
11415 <desc>
11416 Retrieves status, exit code and the exit reason of a formerly started
11417 guest process. If a guest process exited or got terminated this function
11418 returns its final status and removes this process from the list of
11419 known guest processes for further retrieval.
11420
11421 <result name="VBOX_E_IPRT_ERROR">
11422 Process with specified PID was not found.
11423 </result>
11424
11425 </desc>
11426 <param name="pid" type="unsigned long" dir="in">
11427 <desc>
11428 Process id returned by earlier <link to="#executeProcess"/> call.
11429 </desc>
11430 </param>
11431 <param name="exitcode" type="unsigned long" dir="out">
11432 <desc>
11433 The exit code (if available).
11434 </desc>
11435 </param>
11436 <param name="flags" type="unsigned long" dir="out">
11437 <desc>
11438 Additional flags of process status. Not used at the moment and
11439 must be set to 0.
11440 </desc>
11441 </param>
11442 <param name="reason" type="ExecuteProcessStatus" dir="return">
11443 <desc>
11444 The current process status.
11445 </desc>
11446 </param>
11447 </method>
11448
11449 <method name="copyFromGuest">
11450 <desc>
11451 Copies files/directories from guest to the host.
11452
11453 <result name="VBOX_E_IPRT_ERROR">
11454 Error while copying.
11455 </result>
11456
11457 </desc>
11458 <param name="source" type="wstring" dir="in">
11459 <desc>
11460 Source file on the guest to copy.
11461 </desc>
11462 </param>
11463 <param name="dest" type="wstring" dir="in">
11464 <desc>
11465 Destination path on the host.
11466 </desc>
11467 </param>
11468 <param name="userName" type="wstring" dir="in">
11469 <desc>
11470 User name under which the copy command will be executed; the
11471 user has to exist and have the appropriate rights to read from
11472 the source path.
11473 </desc>
11474 </param>
11475 <param name="password" type="wstring" dir="in">
11476 <desc>
11477 Password of the user account specified.
11478 </desc>
11479 </param>
11480 <param name="flags" type="unsigned long" dir="in">
11481 <desc>
11482 <link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
11483 </desc>
11484 </param>
11485 <param name="progress" type="IProgress" dir="return">
11486 <desc>Progress object to track the operation completion.</desc>
11487 </param>
11488 </method>
11489
11490 <method name="copyToGuest">
11491 <desc>
11492 Copies files/directories from host to the guest.
11493
11494 <result name="VBOX_E_IPRT_ERROR">
11495 Error while copying.
11496 </result>
11497
11498 </desc>
11499 <param name="source" type="wstring" dir="in">
11500 <desc>
11501 Source file on the host to copy.
11502 </desc>
11503 </param>
11504 <param name="dest" type="wstring" dir="in">
11505 <desc>
11506 Destination path on the guest.
11507 </desc>
11508 </param>
11509 <param name="userName" type="wstring" dir="in">
11510 <desc>
11511 User name under which the copy command will be executed; the
11512 user has to exist and have the appropriate rights to write to
11513 the destination path.
11514 </desc>
11515 </param>
11516 <param name="password" type="wstring" dir="in">
11517 <desc>
11518 Password of the user account specified.
11519 </desc>
11520 </param>
11521 <param name="flags" type="unsigned long" dir="in">
11522 <desc>
11523 <link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
11524 </desc>
11525 </param>
11526 <param name="progress" type="IProgress" dir="return">
11527 <desc>Progress object to track the operation completion.</desc>
11528 </param>
11529 </method>
11530
11531 <method name="directoryClose">
11532 <desc>
11533 Closes a formerly opened guest directory.
11534
11535 <result name="VBOX_E_IPRT_ERROR">
11536 Error while closing directory.
11537 </result>
11538
11539 </desc>
11540 <param name="handle" type="unsigned long" dir="in">
11541 <desc>
11542 Handle of opened directory to close.
11543 </desc>
11544 </param>
11545 </method>
11546
11547 <method name="directoryCreate">
11548 <desc>
11549 Creates a directory on the guest.
11550
11551 <result name="VBOX_E_IPRT_ERROR">
11552 Error while creating directory.
11553 </result>
11554
11555 </desc>
11556 <param name="directory" type="wstring" dir="in">
11557 <desc>
11558 Directory to create.
11559 </desc>
11560 </param>
11561 <param name="userName" type="wstring" dir="in">
11562 <desc>
11563 User name under which the directory creation will be executed; the
11564 user has to exist and have the appropriate rights to create the
11565 desired directory.
11566 </desc>
11567 </param>
11568 <param name="password" type="wstring" dir="in">
11569 <desc>
11570 Password of the user account specified.
11571 </desc>
11572 </param>
11573 <param name="mode" type="unsigned long" dir="in">
11574 <desc>
11575 File mode.
11576 </desc>
11577 </param>
11578 <param name="flags" type="unsigned long" dir="in">
11579 <desc>
11580 <link to="DirectoryCreateFlag"/> flags.
11581 </desc>
11582 </param>
11583 </method>
11584
11585 <method name="directoryOpen">
11586 <desc>
11587 Opens a directory on the guest.
11588
11589 <result name="VBOX_E_IPRT_ERROR">
11590 Error while opening / reading directory.
11591 </result>
11592
11593 </desc>
11594 <param name="directory" type="wstring" dir="in">
11595 <desc>
11596 Directory to read.
11597 </desc>
11598 </param>
11599 <param name="filter" type="wstring" dir="in">
11600 <desc>
11601 Directory filter (DOS style wildcards). Set to empty
11602 string if no filter required.
11603 </desc>
11604 </param>
11605 <param name="flags" type="unsigned long" dir="in">
11606 <desc>
11607 <link to="DirectoryOpenFlag"/> flags.
11608 </desc>
11609 </param>
11610 <param name="userName" type="wstring" dir="in">
11611 <desc>
11612 User name under which the directory reading will be performed; the
11613 user has to exist and have the appropriate rights to access / read the
11614 desired directory.
11615 </desc>
11616 </param>
11617 <param name="password" type="wstring" dir="in">
11618 <desc>
11619 Password of the user account specified.
11620 </desc>
11621 </param>
11622 <param name="handle" type="unsigned long" dir="return">
11623 <desc>
11624 Handle of opened directory returned by openDirectory.
11625 </desc>
11626 </param>
11627 </method>
11628
11629 <method name="directoryRead">
11630 <desc>
11631 Reads the next directory entry of an opened guest directory.
11632
11633 <result name="E_ABORT">
11634 When the end of the directory has been reached.
11635 </result>
11636
11637 <result name="VBOX_E_IPRT_ERROR">
11638 Error while opening / reading directory.
11639 </result>
11640
11641 </desc>
11642 <param name="handle" type="unsigned long" dir="in">
11643 <desc>
11644 Handle of opened directory returned by openDirectory.
11645 </desc>
11646 </param>
11647 <param name="entry" type="IGuestDirEntry" dir="return">
11648 <desc>
11649 Information about next directory entry on success.
11650 </desc>
11651 </param>
11652 </method>
11653
11654 <method name="fileExists">
11655 <desc>
11656 Checks if the specified file name exists and is a regular file.
11657
11658 If the file name ends with a slash or backslash, the function assumes
11659 it's a directory and will check if the specified directory exists and
11660 is a regular directory.
11661
11662 <result name="VBOX_E_IPRT_ERROR">
11663 Error while looking up information.
11664 </result>
11665
11666 </desc>
11667 <param name="file" type="wstring" dir="in">
11668 <desc>
11669 Full path of file to check.
11670 </desc>
11671 </param>
11672 <param name="userName" type="wstring" dir="in">
11673 <desc>
11674 User name under which the lookup will be performed; the
11675 user has to exist and have the appropriate rights to access / read the
11676 desired directory.
11677 </desc>
11678 </param>
11679 <param name="password" type="wstring" dir="in">
11680 <desc>
11681 Password of the user account specified.
11682 </desc>
11683 </param>
11684 <param name="exists" type="boolean" dir="return">
11685 <desc>
11686 True if it's a regular file, false if it isn't (or doesn't exist).
11687 </desc>
11688 </param>
11689 </method>
11690
11691 <method name="fileQuerySize">
11692 <desc>
11693 Queries the size of a file, given the path to it.
11694
11695 <result name="VBOX_E_IPRT_ERROR">
11696 Error while looking up information.
11697 </result>
11698
11699 </desc>
11700 <param name="file" type="wstring" dir="in">
11701 <desc>
11702 Full path of file to query file size for.
11703 </desc>
11704 </param>
11705 <param name="userName" type="wstring" dir="in">
11706 <desc>
11707 User name under which the lookup will be performed; the
11708 user has to exist and have the appropriate rights to access / read the
11709 desired directory.
11710 </desc>
11711 </param>
11712 <param name="password" type="wstring" dir="in">
11713 <desc>
11714 Password of the user account specified.
11715 </desc>
11716 </param>
11717 <param name="size" type="long long" dir="return">
11718 <desc>
11719 Size (in bytes) of file specified.
11720 </desc>
11721 </param>
11722 </method>
11723
11724 <method name="setProcessInput">
11725 <desc>
11726 Sends input into a formerly started process.
11727
11728 <result name="VBOX_E_IPRT_ERROR">
11729 Could not send input.
11730 </result>
11731
11732 </desc>
11733 <param name="pid" type="unsigned long" dir="in">
11734 <desc>
11735 Process id returned by earlier <link to="#executeProcess"/> call.
11736 </desc>
11737 </param>
11738 <param name="flags" type="unsigned long" dir="in">
11739 <desc>
11740 <link to="ProcessInputFlag"/> flags.
11741 </desc>
11742 </param>
11743 <param name="timeoutMS" type="unsigned long" dir="in">
11744 <desc>
11745 The maximum timeout value (in msec) to wait for getting the
11746 data transfered to the guest. Pass 0 for an infinite timeout.
11747 </desc>
11748 </param>
11749 <param name="data" type="octet" dir="in" safearray="yes">
11750 <desc>
11751 Buffer of input data to send to the started process to.
11752 </desc>
11753 </param>
11754 <param name="written" type="unsigned long" dir="return">
11755 <desc>
11756 Number of bytes written.
11757 </desc>
11758 </param>
11759 </method>
11760
11761 <method name="updateGuestAdditions">
11762 <desc>
11763 Updates already installed Guest Additions in a VM
11764 (Windows guests only).
11765
11766 <result name="VBOX_E_IPRT_ERROR">
11767 Error while updating.
11768 </result>
11769
11770 </desc>
11771 <param name="source" type="wstring" dir="in">
11772 <desc>
11773 Path to the Guest Additions .ISO file to use for the upate.
11774 </desc>
11775 </param>
11776 <param name="flags" type="AdditionsUpdateFlag" dir="in" safearray="yes">
11777 <desc>
11778 <link to="AdditionsUpdateFlag"/> flags.
11779 </desc>
11780 </param>
11781 <param name="progress" type="IProgress" dir="return">
11782 <desc>Progress object to track the operation completion.</desc>
11783 </param>
11784 </method>
11785
11786 </interface>
11787
11788
11789 <!--
11790 // IProgress
11791 /////////////////////////////////////////////////////////////////////////
11792 -->
11793
11794 <interface
11795 name="IProgress" extends="$unknown"
11796 uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
11797 wsmap="managed"
11798 >
11799 <desc>
11800 The IProgress interface is used to track and control
11801 asynchronous tasks within VirtualBox.
11802
11803 An instance of this is returned every time VirtualBox starts
11804 an asynchronous task (in other words, a separate thread) which
11805 continues to run after a method call returns. For example,
11806 <link to="IConsole::saveState" />, which saves the state of
11807 a running virtual machine, can take a long time to complete.
11808 To be able to display a progress bar, a user interface such as
11809 the VirtualBox graphical user interface can use the IProgress
11810 object returned by that method.
11811
11812 Note that IProgress is a "read-only" interface in the sense
11813 that only the VirtualBox internals behind the Main API can
11814 create and manipulate progress objects, whereas client code
11815 can only use the IProgress object to monitor a task's
11816 progress and, if <link to="#cancelable" /> is @c true,
11817 cancel the task by calling <link to="#cancel" />.
11818
11819 A task represented by IProgress consists of either one or
11820 several sub-operations that run sequentially, one by one (see
11821 <link to="#operation" /> and <link to="#operationCount" />).
11822 Every operation is identified by a number (starting from 0)
11823 and has a separate description.
11824
11825 You can find the individual percentage of completion of the current
11826 operation in <link to="#operationPercent" /> and the
11827 percentage of completion of the task as a whole
11828 in <link to="#percent" />.
11829
11830 Similarly, you can wait for the completion of a particular
11831 operation via <link to="#waitForOperationCompletion" /> or
11832 for the completion of the whole task via
11833 <link to="#waitForCompletion" />.
11834 </desc>
11835
11836 <attribute name="id" type="uuid" mod="string" readonly="yes">
11837 <desc>ID of the task.</desc>
11838 </attribute>
11839
11840 <attribute name="description" type="wstring" readonly="yes">
11841 <desc>Description of the task.</desc>
11842 </attribute>
11843
11844 <attribute name="initiator" type="$unknown" readonly="yes">
11845 <desc>Initiator of the task.</desc>
11846 </attribute>
11847
11848 <attribute name="cancelable" type="boolean" readonly="yes">
11849 <desc>Whether the task can be interrupted.</desc>
11850 </attribute>
11851
11852 <attribute name="percent" type="unsigned long" readonly="yes">
11853 <desc>
11854 Current progress value of the task as a whole, in percent.
11855 This value depends on how many operations are already complete.
11856 Returns 100 if <link to="#completed" /> is @c true.
11857 </desc>
11858 </attribute>
11859
11860 <attribute name="timeRemaining" type="long" readonly="yes">
11861 <desc>
11862 Estimated remaining time until the task completes, in
11863 seconds. Returns 0 once the task has completed; returns -1
11864 if the remaining time cannot be computed, in particular if
11865 the current progress is 0.
11866
11867 Even if a value is returned, the estimate will be unreliable
11868 for low progress values. It will become more reliable as the
11869 task progresses; it is not recommended to display an ETA
11870 before at least 20% of a task have completed.
11871 </desc>
11872 </attribute>
11873
11874 <attribute name="completed" type="boolean" readonly="yes">
11875 <desc>Whether the task has been completed.</desc>
11876 </attribute>
11877
11878 <attribute name="canceled" type="boolean" readonly="yes">
11879 <desc>Whether the task has been canceled.</desc>
11880 </attribute>
11881
11882 <attribute name="resultCode" type="long" readonly="yes">
11883 <desc>
11884 Result code of the progress task.
11885 Valid only if <link to="#completed"/> is @c true.
11886 </desc>
11887 </attribute>
11888
11889 <attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
11890 <desc>
11891 Extended information about the unsuccessful result of the
11892 progress operation. May be @c null if no extended information
11893 is available.
11894 Valid only if <link to="#completed"/> is @c true and
11895 <link to="#resultCode"/> indicates a failure.
11896 </desc>
11897 </attribute>
11898
11899 <attribute name="operationCount" type="unsigned long" readonly="yes">
11900 <desc>
11901 Number of sub-operations this task is divided into.
11902 Every task consists of at least one suboperation.
11903 </desc>
11904 </attribute>
11905
11906 <attribute name="operation" type="unsigned long" readonly="yes">
11907 <desc>Number of the sub-operation being currently executed.</desc>
11908 </attribute>
11909
11910 <attribute name="operationDescription" type="wstring" readonly="yes">
11911 <desc>
11912 Description of the sub-operation being currently executed.
11913 </desc>
11914 </attribute>
11915
11916 <attribute name="operationPercent" type="unsigned long" readonly="yes">
11917 <desc>Progress value of the current sub-operation only, in percent.</desc>
11918 </attribute>
11919
11920 <attribute name="operationWeight" type="unsigned long" readonly="yes">
11921 <desc>Weight value of the current sub-operation only.</desc>
11922 </attribute>
11923
11924 <attribute name="timeout" type="unsigned long">
11925 <desc>
11926 When non-zero, this specifies the number of milliseconds after which
11927 the operation will automatically be canceled. This can only be set on
11928 cancelable objects.
11929 </desc>
11930 </attribute>
11931
11932 <method name="setCurrentOperationProgress">
11933 <desc>Internal method, not to be called externally.</desc>
11934 <param name="percent" type="unsigned long" dir="in" />
11935 </method>
11936 <method name="setNextOperation">
11937 <desc>Internal method, not to be called externally.</desc>
11938 <param name="nextOperationDescription" type="wstring" dir="in" />
11939 <param name="nextOperationsWeight" type="unsigned long" dir="in" />
11940 </method>
11941
11942 <method name="waitForCompletion">
11943 <desc>
11944 Waits until the task is done (including all sub-operations)
11945 with a given timeout in milliseconds; specify -1 for an indefinite wait.
11946
11947 Note that the VirtualBox/XPCOM/COM/native event queues of the calling
11948 thread are not processed while waiting. Neglecting event queues may
11949 have dire consequences (degrade performance, resource hogs,
11950 deadlocks, etc.), this is specially so for the main thread on
11951 platforms using XPCOM. Callers are adviced wait for short periods
11952 and service their event queues between calls, or to create a worker
11953 thread to do the waiting.
11954
11955 <result name="VBOX_E_IPRT_ERROR">
11956 Failed to wait for task completion.
11957 </result>
11958 </desc>
11959
11960 <param name="timeout" type="long" dir="in">
11961 <desc>
11962 Maximum time in milliseconds to wait or -1 to wait indefinitely.
11963 </desc>
11964 </param>
11965 </method>
11966
11967 <method name="waitForOperationCompletion">
11968 <desc>
11969 Waits until the given operation is done with a given timeout in
11970 milliseconds; specify -1 for an indefinite wait.
11971
11972 See <link to="#waitForCompletion"> for event queue considerations.</link>
11973
11974 <result name="VBOX_E_IPRT_ERROR">
11975 Failed to wait for operation completion.
11976 </result>
11977
11978 </desc>
11979 <param name="operation" type="unsigned long" dir="in">
11980 <desc>
11981 Number of the operation to wait for.
11982 Must be less than <link to="#operationCount"/>.
11983 </desc>
11984 </param>
11985 <param name="timeout" type="long" dir="in">
11986 <desc>
11987 Maximum time in milliseconds to wait or -1 to wait indefinitely.
11988 </desc>
11989 </param>
11990 </method>
11991
11992 <method name="waitForAsyncProgressCompletion">
11993 <desc>
11994 Waits until the other task is completed (including all
11995 sub-operations) and forward all changes from the other progress to
11996 this progress. This means sub-operation number, description, percent
11997 and so on.
11998
11999 You have to take care on setting up at least the same count on
12000 sub-operations in this progress object like there are in the other
12001 progress object.
12002
12003 If the other progress object supports cancel and this object gets any
12004 cancel request (when here enabled as well), it will be forwarded to
12005 the other progress object.
12006
12007 If there is an error in the other progress, this error isn't
12008 automatically transfered to this progress object. So you have to
12009 check any operation error within the other progress object, after
12010 this method returns.
12011 </desc>
12012
12013 <param name="pProgressAsync" type="IProgress" dir="in">
12014 <desc>
12015 The progress object of the asynchrony process.
12016 </desc>
12017 </param>
12018 </method>
12019
12020 <method name="cancel">
12021 <desc>
12022 Cancels the task.
12023 <note>
12024 If <link to="#cancelable"/> is @c false, then this method will fail.
12025 </note>
12026
12027 <result name="VBOX_E_INVALID_OBJECT_STATE">
12028 Operation cannot be canceled.
12029 </result>
12030
12031 </desc>
12032 </method>
12033
12034 </interface>
12035
12036 <!--
12037 // ISnapshot
12038 /////////////////////////////////////////////////////////////////////////
12039 -->
12040
12041 <interface
12042 name="ISnapshot" extends="$unknown"
12043 uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
12044 wsmap="managed"
12045 >
12046 <desc>
12047 The ISnapshot interface represents a snapshot of the virtual
12048 machine.
12049
12050 Together with the differencing media that are created
12051 when a snapshot is taken, a machine can be brought back to
12052 the exact state it was in when the snapshot was taken.
12053
12054 The ISnapshot interface has no methods, only attributes; snapshots
12055 are controlled through methods of the <link to="IConsole" /> interface
12056 which also manage the media associated with the snapshot.
12057 The following operations exist:
12058
12059 <ul>
12060 <li><link to="IConsole::takeSnapshot"/> creates a new snapshot
12061 by creating new, empty differencing images for the machine's
12062 media and saving the VM settings and (if the VM is running)
12063 the current VM state in the snapshot.
12064
12065 The differencing images will then receive all data written to
12066 the machine's media, while their parent (base) images
12067 remain unmodified after the snapshot has been taken (see
12068 <link to="IMedium" /> for details about differencing images).
12069 This simplifies restoring a machine to the state of a snapshot:
12070 only the differencing images need to be deleted.
12071
12072 The current machine state is not changed by taking a snapshot
12073 except that <link to="IMachine::currentSnapshot" /> is set to
12074 the newly created snapshot, which is also added to the machine's
12075 snapshots tree.
12076 </li>
12077
12078 <li><link to="IConsole::restoreSnapshot"/> resets a machine to
12079 the state of a previous snapshot by deleting the differencing
12080 image of each of the machine's media and setting the machine's
12081 settings and state to the state that was saved in the snapshot (if any).
12082
12083 This destroys the machine's current state. After calling this,
12084 <link to="IMachine::currentSnapshot" /> points to the snapshot
12085 that was restored.
12086 </li>
12087
12088 <li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
12089 without affecting the current machine state.
12090
12091 This does not change the current machine state, but instead frees the
12092 resources allocated when the snapshot was taken: the settings and machine
12093 state file are deleted (if any), and the snapshot's differencing image for
12094 each of the machine's media gets merged with its parent image.
12095
12096 Neither the current machine state nor other snapshots are affected
12097 by this operation, except that parent media will be modified
12098 to contain the disk data associated with the snapshot being deleted.
12099
12100 When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
12101 attribute is set to the current snapshot's parent or @c null if it
12102 has no parent. Otherwise the attribute is unchanged.
12103 </li>
12104 </ul>
12105
12106 Each snapshot contains a copy of virtual machine's settings (hardware
12107 configuration etc.). This copy is contained in an immutable (read-only)
12108 instance of <link to="IMachine" /> which is available from the snapshot's
12109 <link to="#machine" /> attribute. When restoring the snapshot, these
12110 settings are copied back to the original machine.
12111
12112 In addition, if the machine was running when the
12113 snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
12114 the current VM state is saved in the snapshot (similarly to what happens
12115 when a VM's state is saved). The snapshot is then said to be <i>online</i>
12116 because when restoring it, the VM will be running.
12117
12118 If the machine was in <link to="MachineState_Saved">saved</link> saved,
12119 the snapshot receives a copy of the execution state file
12120 (<link to="IMachine::stateFilePath"/>).
12121
12122 Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
12123 or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
12124 it then contains a so-called "zero execution state", representing a
12125 machine that is powered off.
12126 </desc>
12127
12128 <attribute name="id" type="uuid" mod="string" readonly="yes">
12129 <desc>UUID of the snapshot.</desc>
12130 </attribute>
12131
12132 <attribute name="name" type="wstring">
12133 <desc>Short name of the snapshot.
12134 <note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
12135 be called implicitly.</note>
12136 </desc>
12137 </attribute>
12138
12139 <attribute name="description" type="wstring">
12140 <desc>Optional description of the snapshot.
12141 <note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
12142 be called implicitly.</note>
12143 </desc>
12144 </attribute>
12145
12146 <attribute name="timeStamp" type="long long" readonly="yes">
12147 <desc>
12148 Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
12149 </desc>
12150 </attribute>
12151
12152 <attribute name="online" type="boolean" readonly="yes">
12153 <desc>
12154 @c true if this snapshot is an online snapshot and @c false otherwise.
12155
12156 When this attribute is @c true, the
12157 <link to="IMachine::stateFilePath"/> attribute of the
12158 <link to="#machine"/> object associated with this snapshot
12159 will point to the saved state file. Otherwise, it will be
12160 an empty string.
12161 </desc>
12162 </attribute>
12163
12164 <attribute name="machine" type="IMachine" readonly="yes">
12165 <desc>
12166 Virtual machine this snapshot is taken on. This object
12167 stores all settings the machine had when taking this snapshot.
12168 <note>
12169 The returned machine object is immutable, i.e. no
12170 any settings can be changed.
12171 </note>
12172 </desc>
12173 </attribute>
12174
12175 <attribute name="parent" type="ISnapshot" readonly="yes">
12176 <desc>
12177 Parent snapshot (a snapshot this one is based on), or
12178 @c null if the snapshot has no parent (i.e. is the first snapshot).
12179 </desc>
12180 </attribute>
12181
12182 <attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
12183 <desc>
12184 Child snapshots (all snapshots having this one as a parent).
12185 By inspecting this attribute starting with a machine's root snapshot
12186 (which can be obtained by calling <link to="IMachine::findSnapshot" />
12187 with a @c null UUID), a machine's snapshots tree can be iterated over.
12188 </desc>
12189 </attribute>
12190
12191 <method name="getChildrenCount" const="yes">
12192 <desc>
12193 Returns the number of direct childrens of this snapshot.
12194 </desc>
12195 <param name="childrenCount" type="unsigned long" dir="return">
12196 <desc>
12197 </desc>
12198 </param>
12199 </method>
12200
12201 </interface>
12202
12203
12204 <!--
12205 // IMedium
12206 /////////////////////////////////////////////////////////////////////////
12207 -->
12208
12209 <enum
12210 name="MediumState"
12211 uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
12212 >
12213 <desc>
12214 Virtual medium state.
12215 <see><link to="IMedium"/></see>
12216 </desc>
12217
12218 <const name="NotCreated" value="0">
12219 <desc>
12220 Associated medium storage does not exist (either was not created yet or
12221 was deleted).
12222 </desc>
12223 </const>
12224 <const name="Created" value="1">
12225 <desc>
12226 Associated storage exists and accessible; this gets set if the
12227 accessibility check performed by <link to="IMedium::refreshState" />
12228 was successful.
12229 </desc>
12230 </const>
12231 <const name="LockedRead" value="2">
12232 <desc>
12233 Medium is locked for reading (see <link to="IMedium::lockRead"/>),
12234 no data modification is possible.
12235 </desc>
12236 </const>
12237 <const name="LockedWrite" value="3">
12238 <desc>
12239 Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
12240 no concurrent data reading or modification is possible.
12241 </desc>
12242 </const>
12243 <const name="Inaccessible" value="4">
12244 <desc>
12245 Medium accessibility check (see <link to="IMedium::refreshState" />) has
12246 not yet been performed, or else, associated medium storage is not
12247 accessible. In the first case, <link to="IMedium::lastAccessError"/>
12248 is empty, in the second case, it describes the error that occurred.
12249 </desc>
12250 </const>
12251 <const name="Creating" value="5">
12252 <desc>
12253 Associated medium storage is being created.
12254 </desc>
12255 </const>
12256 <const name="Deleting" value="6">
12257 <desc>
12258 Associated medium storage is being deleted.
12259 </desc>
12260 </const>
12261 </enum>
12262
12263 <enum
12264 name="MediumType"
12265 uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
12266 >
12267 <desc>
12268 Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
12269 attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
12270 when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
12271 the medium attached. At the moment DVD and floppy media are always of type "writethrough".
12272 </desc>
12273
12274 <const name="Normal" value="0">
12275 <desc>
12276 Normal medium (attached directly or indirectly, preserved
12277 when taking snapshots).
12278 </desc>
12279 </const>
12280 <const name="Immutable" value="1">
12281 <desc>
12282 Immutable medium (attached indirectly, changes are wiped out
12283 the next time the virtual machine is started).
12284 </desc>
12285 </const>
12286 <const name="Writethrough" value="2">
12287 <desc>
12288 Write through medium (attached directly, ignored when
12289 taking snapshots).
12290 </desc>
12291 </const>
12292 <const name="Shareable" value="3">
12293 <desc>
12294 Allow using this medium concurrently by several machines.
12295 <note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
12296 </desc>
12297 </const>
12298 <const name="Readonly" value="4">
12299 <desc>
12300 A readonly medium, which can of course be used by several machines.
12301 <note>Present and accepted since VirtualBox 4.0.</note>
12302 </desc>
12303 </const>
12304 <const name="MultiAttach" value="5">
12305 <desc>
12306 A medium which is indirectly attached, so that one base medium can
12307 be used for several VMs which have their own differencing medium to
12308 store their modifications. In some sense a variant of Immutable
12309 with unset AutoReset flag in each differencing medium.
12310 <note>Present and accepted since VirtualBox 4.0.</note>
12311 </desc>
12312 </const>
12313 </enum>
12314
12315 <enum
12316 name="MediumVariant"
12317 uuid="80685b6b-e42f-497d-8271-e77bf3c61ada"
12318 >
12319 <desc>
12320 Virtual medium image variant. More than one flag may be set.
12321 <see><link to="IMedium"/></see>
12322 </desc>
12323
12324 <const name="Standard" value="0">
12325 <desc>
12326 No particular variant requested, results in using the backend default.
12327 </desc>
12328 </const>
12329 <const name="VmdkSplit2G" value="0x01">
12330 <desc>
12331 VMDK image split in chunks of less than 2GByte.
12332 </desc>
12333 </const>
12334 <const name="VmdkRawDisk" value="0x02">
12335 <desc>
12336 VMDK image representing a raw disk.
12337 </desc>
12338 </const>
12339 <const name="VmdkStreamOptimized" value="0x04">
12340 <desc>
12341 VMDK streamOptimized image. Special import/export format which is
12342 read-only/append-only.
12343 </desc>
12344 </const>
12345 <const name="VmdkESX" value="0x08">
12346 <desc>
12347 VMDK format variant used on ESX products.
12348 </desc>
12349 </const>
12350 <const name="Fixed" value="0x10000">
12351 <desc>
12352 Fixed image. Only allowed for base images.
12353 </desc>
12354 </const>
12355 <const name="Diff" value="0x20000">
12356 <desc>
12357 Differencing image. Only allowed for child images.
12358 </desc>
12359 </const>
12360 <const name="NoCreateDir" value="0x40000000">
12361 <desc>
12362 Special flag which suppresses automatic creation of the subdirectory.
12363 Only used when passing the medium variant as an input parameter.
12364 </desc>
12365 </const>
12366 </enum>
12367
12368 <interface
12369 name="IMediumAttachment" extends="$unknown"
12370 uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
12371 wsmap="struct"
12372 >
12373 <desc>
12374 The IMediumAttachment interface links storage media to virtual machines.
12375 For each medium (<link to="IMedium"/>) which has been attached to a
12376 storage controller (<link to="IStorageController"/>) of a machine
12377 (<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
12378 method, one instance of IMediumAttachment is added to the machine's
12379 <link to="IMachine::mediumAttachments"/> array attribute.
12380
12381 Each medium attachment specifies the storage controller as well as a
12382 port and device number and the IMedium instance representing a virtual
12383 hard disk or floppy or DVD image.
12384
12385 For removable media (DVDs or floppies), there are two additional
12386 options. For one, the IMedium instance can be @c null to represent
12387 an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
12388 secondly, the medium can be one of the pseudo-media for host drives
12389 listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
12390
12391 <h3>Attaching Hard Disks</h3>
12392
12393 Hard disks are attached to virtual machines using the
12394 <link to="IMachine::attachDevice"/> method and detached using the
12395 <link to="IMachine::detachDevice"/> method. Depending on a medium's
12396 type (see <link to="IMedium::type" />), hard disks are attached either
12397 <i>directly</i> or <i>indirectly</i>.
12398
12399 When a hard disk is being attached directly, it is associated with the
12400 virtual machine and used for hard disk operations when the machine is
12401 running. When a hard disk is being attached indirectly, a new differencing
12402 hard disk linked to it is implicitly created and this differencing hard
12403 disk is associated with the machine and used for hard disk operations.
12404 This also means that if <link to="IMachine::attachDevice"/> performs
12405 a direct attachment then the same hard disk will be returned in response
12406 to the subsequent <link to="IMachine::getMedium"/> call; however if
12407 an indirect attachment is performed then
12408 <link to="IMachine::getMedium"/> will return the implicitly created
12409 differencing hard disk, not the original one passed to <link
12410 to="IMachine::attachDevice"/>. In detail:
12411
12412 <ul>
12413 <li><b>Normal base</b> hard disks that do not have children (i.e.
12414 differencing hard disks linked to them) and that are not already
12415 attached to virtual machines in snapshots are attached <b>directly</b>.
12416 Otherwise, they are attached <b>indirectly</b> because having
12417 dependent children or being part of the snapshot makes it impossible
12418 to modify hard disk contents without breaking the integrity of the
12419 dependent party. The <link to="IMedium::readOnly"/> attribute allows to
12420 quickly determine the kind of the attachment for the given hard
12421 disk. Note that if a normal base hard disk is to be indirectly
12422 attached to a virtual machine with snapshots then a special
12423 procedure called <i>smart attachment</i> is performed (see below).</li>
12424 <li><b>Normal differencing</b> hard disks are like normal base hard disks:
12425 they are attached <b>directly</b> if they do not have children and are
12426 not attached to virtual machines in snapshots, and <b>indirectly</b>
12427 otherwise. Note that the smart attachment procedure is never performed
12428 for differencing hard disks.</li>
12429 <li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
12430 they are designed to be non-writable. If an immutable hard disk is
12431 attached to a virtual machine with snapshots then a special
12432 procedure called smart attachment is performed (see below).</li>
12433 <li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
12434 also as designed. This also means that writethrough hard disks cannot
12435 have other hard disks linked to them at all.</li>
12436 <li><b>Shareable</b> hard disks are always attached <b>directly</b>,
12437 also as designed. This also means that shareable hard disks cannot
12438 have other hard disks linked to them at all. They behave almost
12439 like writethrough hard disks, except that shareable hard disks can
12440 be attached to several virtual machines which are running, allowing
12441 concurrent accesses. You need special cluster software running in
12442 the virtual machines to make use of such disks.</li>
12443 </ul>
12444
12445 Note that the same hard disk, regardless of its type, may be attached to
12446 more than one virtual machine at a time. In this case, the machine that is
12447 started first gains exclusive access to the hard disk and attempts to
12448 start other machines having this hard disk attached will fail until the
12449 first machine is powered down.
12450
12451 Detaching hard disks is performed in a <i>deferred</i> fashion. This means
12452 that the given hard disk remains associated with the given machine after a
12453 successful <link to="IMachine::detachDevice"/> call until
12454 <link to="IMachine::saveSettings"/> is called to save all changes to
12455 machine settings to disk. This deferring is necessary to guarantee that
12456 the hard disk configuration may be restored at any time by a call to
12457 <link to="IMachine::discardSettings"/> before the settings
12458 are saved (committed).
12459
12460 Note that if <link to="IMachine::discardSettings"/> is called after
12461 indirectly attaching some hard disks to the machine but before a call to
12462 <link to="IMachine::saveSettings"/> is made, it will implicitly delete
12463 all differencing hard disks implicitly created by
12464 <link to="IMachine::attachDevice"/> for these indirect attachments.
12465 Such implicitly created hard disks will also be immediately deleted when
12466 detached explicitly using the <link to="IMachine::detachDevice"/>
12467 call if it is made before <link to="IMachine::saveSettings"/>. This
12468 implicit deletion is safe because newly created differencing hard
12469 disks do not contain any user data.
12470
12471 However, keep in mind that detaching differencing hard disks that were
12472 implicitly created by <link to="IMachine::attachDevice"/>
12473 before the last <link to="IMachine::saveSettings"/> call will
12474 <b>not</b> implicitly delete them as they may already contain some data
12475 (for example, as a result of virtual machine execution). If these hard
12476 disks are no more necessary, the caller can always delete them explicitly
12477 using <link to="IMedium::deleteStorage"/> after they are actually de-associated
12478 from this machine by the <link to="IMachine::saveSettings"/> call.
12479
12480 <h3>Smart Attachment</h3>
12481
12482 When normal base or immutable hard disks are indirectly attached to a
12483 virtual machine then some additional steps are performed to make sure the
12484 virtual machine will have the most recent "view" of the hard disk being
12485 attached. These steps include walking through the machine's snapshots
12486 starting from the current one and going through ancestors up to the first
12487 snapshot. Hard disks attached to the virtual machine in all
12488 of the encountered snapshots are checked whether they are descendants of
12489 the given normal base or immutable hard disk. The first found child (which
12490 is the differencing hard disk) will be used instead of the normal base or
12491 immutable hard disk as a parent for creating a new differencing hard disk
12492 that will be actually attached to the machine. And only if no descendants
12493 are found or if the virtual machine does not have any snapshots then the
12494 normal base or immutable hard disk will be used itself as a parent for
12495 this differencing hard disk.
12496
12497 It is easier to explain what smart attachment does using the
12498 following example:
12499 <pre>
12500BEFORE attaching B.vdi: AFTER attaching B.vdi:
12501
12502Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
12503 Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
12504 Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
12505 Snapshot 4 (none) Snapshot 4 (none)
12506 CurState (none) CurState (D3->D2.vdi)
12507
12508 NOT
12509 ...
12510 CurState (D3->B.vdi)
12511 </pre>
12512 The first column is the virtual machine configuration before the base hard
12513 disk <tt>B.vdi</tt> is attached, the second column shows the machine after
12514 this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
12515 mean that the hard disk that is actually attached to the machine is a
12516 differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
12517 another hard disk, <tt>B.vdi</tt>.
12518
12519 As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
12520 from the machine before taking Snapshot 4. Later, after Snapshot 4 was
12521 taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
12522 dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
12523 it cannot be attached directly and needs an indirect attachment (i.e.
12524 implicit creation of a new differencing hard disk). Due to the smart
12525 attachment procedure, the new differencing hard disk
12526 (<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
12527 <tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
12528 <tt>B.vdi</tt> existing for this snapshot branch of the given virtual
12529 machine.
12530
12531 Note that if there is more than one descendant hard disk of the given base
12532 hard disk found in a snapshot, and there is an exact device, channel and
12533 bus match, then this exact match will be used. Otherwise, the youngest
12534 descendant will be picked up.
12535
12536 There is one more important aspect of the smart attachment procedure which
12537 is not related to snapshots at all. Before walking through the snapshots
12538 as described above, the backup copy of the current list of hard disk
12539 attachment is searched for descendants. This backup copy is created when
12540 the hard disk configuration is changed for the first time after the last
12541 <link to="IMachine::saveSettings"/> call and used by
12542 <link to="IMachine::discardSettings"/> to undo the recent hard disk
12543 changes. When such a descendant is found in this backup copy, it will be
12544 simply re-attached back, without creating a new differencing hard disk for
12545 it. This optimization is necessary to make it possible to re-attach the
12546 base or immutable hard disk to a different bus, channel or device slot
12547 without losing the contents of the differencing hard disk actually
12548 attached to the machine in place of it.
12549
12550 </desc>
12551
12552 <attribute name="medium" type="IMedium" readonly="yes">
12553 <desc>Medium object associated with this attachment; it
12554 can be @c null for removable devices.</desc>
12555 </attribute>
12556
12557 <attribute name="controller" type="wstring" readonly="yes">
12558 <desc>Name of the storage controller of this attachment; this
12559 refers to one of the controllers in <link to="IMachine::storageControllers" />
12560 by name.</desc>
12561 </attribute>
12562
12563 <attribute name="port" type="long" readonly="yes">
12564 <desc>Port number of this attachment.
12565 See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
12566 </desc>
12567 </attribute>
12568
12569 <attribute name="device" type="long" readonly="yes">
12570 <desc>Device slot number of this attachment.
12571 See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
12572 </desc>
12573 </attribute>
12574
12575 <attribute name="type" type="DeviceType" readonly="yes">
12576 <desc>Device type of this attachment.</desc>
12577 </attribute>
12578
12579 <attribute name="passthrough" type="boolean" readonly="yes">
12580 <desc>Pass I/O requests through to a device on the host.</desc>
12581 </attribute>
12582
12583 <attribute name="temporaryEject" type="boolean" readonly="yes">
12584 <desc>Whether guest-triggered eject results in unmounting the medium.</desc>
12585 </attribute>
12586
12587 <attribute name="isEjected" type="boolean" readonly="yes">
12588 <desc>Signals that the removable medium has been ejected. This is not
12589 necessarily equivalent to having a @c null medium association.</desc>
12590 </attribute>
12591
12592 <attribute name="nonRotational" type="boolean" readonly="yes">
12593 <desc>Whether the associated medium is non-rotational.</desc>
12594 </attribute>
12595
12596 <attribute name="discard" type="boolean" readonly="yes">
12597 <desc>Whether the associated medium supports discarding unused blocks.</desc>
12598 </attribute>
12599
12600 <attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
12601 <desc>The bandwidth group this medium attachment is assigned to.</desc>
12602 </attribute>
12603
12604 </interface>
12605
12606 <interface
12607 name="IMedium" extends="$unknown"
12608 uuid="29989373-b111-4654-8493-2e1176cba890"
12609 wsmap="managed"
12610 >
12611 <desc>
12612 The IMedium interface represents virtual storage for a machine's
12613 hard disks, CD/DVD or floppy drives. It will typically represent
12614 a disk image on the host, for example a VDI or VMDK file representing
12615 a virtual hard disk, or an ISO or RAW file representing virtual
12616 removable media, but can also point to a network location (e.g.
12617 for iSCSI targets).
12618
12619 Instances of IMedium are connected to virtual machines by way of medium
12620 attachments, which link the storage medium to a particular device slot
12621 of a storage controller of the virtual machine.
12622 In the VirtualBox API, virtual storage is therefore always represented
12623 by the following chain of object links:
12624
12625 <ul>
12626 <li><link to="IMachine::storageControllers"/> contains an array of
12627 storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
12628 these are instances of <link to="IStorageController"/>).</li>
12629 <li><link to="IMachine::mediumAttachments"/> contains an array of
12630 medium attachments (instances of <link to="IMediumAttachment"/>
12631 created by <link to="IMachine::attachDevice" />),
12632 each containing a storage controller from the above array, a
12633 port/device specification, and an instance of IMedium representing
12634 the medium storage (image file).
12635
12636 For removable media, the storage medium is optional; a medium
12637 attachment with no medium represents a CD/DVD or floppy drive
12638 with no medium inserted. By contrast, hard disk attachments
12639 will always have an IMedium object attached.</li>
12640 <li>Each IMedium in turn points to a storage unit (such as a file
12641 on the host computer or a network resource) that holds actual
12642 data. This location is represented by the <link to="#location"/>
12643 attribute.</li>
12644 </ul>
12645
12646 Existing media are opened using <link to="IVirtualBox::openMedium"/>;
12647 new hard disk media can be created with the VirtualBox API using the
12648 <link to="IVirtualBox::createHardDisk"/> method. Differencing hard
12649 disks (see below) are usually implicitly created by VirtualBox as
12650 needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
12651 VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
12652 should be created with external tools and then opened from within VirtualBox.
12653
12654 Only for CD/DVDs and floppies, an IMedium instance can also represent a host
12655 drive. In that case the <link to="#id" /> attribute contains the UUID of
12656 one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
12657
12658 <h3>Media registries</h3>
12659
12660 When a medium has been opened or created using one of the aforementioned
12661 APIs, it becomes "known" to VirtualBox. Known media can be attached
12662 to virtual machines and re-found through <link to="IVirtualBox::openMedium"/>.
12663 They also appear in the global
12664 <link to="IVirtualBox::hardDisks" />,
12665 <link to="IVirtualBox::DVDImages" /> and
12666 <link to="IVirtualBox::floppyImages" /> arrays.
12667
12668 Prior to VirtualBox 4.0, opening a medium added it to a global media registry
12669 in the VirtualBox.xml file, which was shared between all machines and made
12670 transporting machines and their media from one host to another difficult.
12671
12672 Starting with VirtualBox 4.0, media are only added to a registry when they are
12673 <i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
12674 backwards compatibility, which registry a medium is added to depends on which
12675 VirtualBox version created a machine:
12676
12677 <ul>
12678 <li>If the medium has first been attached to a machine which was created by
12679 VirtualBox 4.0 or later, it is added to that machine's media registry in
12680 the machine XML settings file. This way all information about a machine's
12681 media attachments is contained in a single file and can be transported
12682 easily.</li>
12683 <li>For older media attachments (i.e. if the medium was first attached to a
12684 machine which was created with a VirtualBox version before 4.0), media
12685 continue to be registered in the global VirtualBox settings file, for
12686 backwards compatibility.</li>
12687 </ul>
12688
12689 See <link to="IVirtualBox::openMedium" /> for more information.
12690
12691 Media are removed from media registries by the <link to="IMedium::close"/>,
12692 <link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
12693
12694 <h3>Accessibility checks</h3>
12695
12696 VirtualBox defers media accessibility checks until the <link to="#refreshState" />
12697 method is called explicitly on a medium. This is done to make the VirtualBox object
12698 ready for serving requests as fast as possible and let the end-user
12699 application decide if it needs to check media accessibility right away or not.
12700
12701 As a result, when VirtualBox starts up (e.g. the VirtualBox
12702 object gets created for the first time), all known media are in the
12703 "Inaccessible" state, but the value of the <link to="#lastAccessError"/>
12704 attribute is an empty string because no actual accessibility check has
12705 been made yet.
12706
12707 After calling <link to="#refreshState" />, a medium is considered
12708 <i>accessible</i> if its storage unit can be read. In that case, the
12709 <link to="#state"/> attribute has a value of "Created". If the storage
12710 unit cannot be read (for example, because it is located on a disconnected
12711 network resource, or was accidentally deleted outside VirtualBox),
12712 the medium is considered <i>inaccessible</i>, which is indicated by the
12713 "Inaccessible" state. The exact reason why the medium is inaccessible can be
12714 obtained by reading the <link to="#lastAccessError"/> attribute.
12715
12716 <h3>Medium types</h3>
12717
12718 There are five types of medium behavior which are stored in the
12719 <link to="#type"/> attribute (see <link to="MediumType" />) and
12720 which define the medium's behavior with attachments and snapshots.
12721
12722 All media can be also divided in two groups: <i>base</i> media and
12723 <i>differencing</i> media. A base medium contains all sectors of the
12724 medium data in its own storage and therefore can be used independently.
12725 In contrast, a differencing medium is a "delta" to some other medium and
12726 contains only those sectors which differ from that other medium, which is
12727 then called a <i>parent</i>. The differencing medium is said to be
12728 <i>linked to</i> that parent. The parent may be itself a differencing
12729 medium, thus forming a chain of linked media. The last element in that
12730 chain must always be a base medium. Note that several differencing
12731 media may be linked to the same parent medium.
12732
12733 Differencing media can be distinguished from base media by querying the
12734 <link to="#parent"/> attribute: base media do not have parents they would
12735 depend on, so the value of this attribute is always @c null for them.
12736 Using this attribute, it is possible to walk up the medium tree (from the
12737 child medium to its parent). It is also possible to walk down the tree
12738 using the <link to="#children"/> attribute.
12739
12740 Note that the type of all differencing media is "normal"; all other
12741 values are meaningless for them. Base media may be of any type.
12742
12743 <h3>Automatic composition of the file name part</h3>
12744
12745 Another extension to the <link to="IMedium::location"/> attribute is that
12746 there is a possibility to cause VirtualBox to compose a unique value for
12747 the file name part of the location using the UUID of the hard disk. This
12748 applies only to hard disks in <link to="MediumState_NotCreated"/> state,
12749 e.g. before the storage unit is created, and works as follows. You set the
12750 value of the <link to="IMedium::location"/> attribute to a location
12751 specification which only contains the path specification but not the file
12752 name part and ends with either a forward slash or a backslash character.
12753 In response, VirtualBox will generate a new UUID for the hard disk and
12754 compose the file name using the following pattern:
12755 <pre>
12756 &lt;path&gt;/{&lt;uuid&gt;}.&lt;ext&gt;
12757 </pre>
12758 where <tt>&lt;path&gt;</tt> is the supplied path specification,
12759 <tt>&lt;uuid&gt;</tt> is the newly generated UUID and <tt>&lt;ext&gt;</tt>
12760 is the default extension for the storage format of this hard disk. After
12761 that, you may call any of the methods that create a new hard disk storage
12762 unit and they will use the generated UUID and file name.
12763 </desc>
12764
12765 <attribute name="id" type="uuid" mod="string" readonly="yes">
12766 <desc>
12767 UUID of the medium. For a newly created medium, this value is a randomly
12768 generated UUID.
12769
12770 <note>
12771 For media in one of MediumState_NotCreated, MediumState_Creating or
12772 MediumState_Deleting states, the value of this property is undefined
12773 and will most likely be an empty UUID.
12774 </note>
12775 </desc>
12776 </attribute>
12777
12778 <attribute name="description" type="wstring">
12779 <desc>
12780 Optional description of the medium. For a newly created medium the value
12781 of this attribute is an empty string.
12782
12783 Medium types that don't support this attribute will return E_NOTIMPL in
12784 attempt to get or set this attribute's value.
12785
12786 <note>
12787 For some storage types, reading this attribute may return an outdated
12788 (last known) value when <link to="#state"/> is <link
12789 to="MediumState_Inaccessible"/> or <link
12790 to="MediumState_LockedWrite"/> because the value of this attribute is
12791 stored within the storage unit itself. Also note that changing the
12792 attribute value is not possible in such case, as well as when the
12793 medium is the <link to="MediumState_LockedRead"/> state.
12794 </note>
12795 </desc>
12796 </attribute>
12797
12798 <attribute name="state" type="MediumState" readonly="yes">
12799 <desc>
12800 Returns the current medium state, which is the last state set by
12801 the accessibility check performed by <link to="#refreshState"/>.
12802 If that method has not yet been called on the medium, the state
12803 is "Inaccessible"; as opposed to truly inaccessible media, the
12804 value of <link to="#lastAccessError"/> will be an empty string in
12805 that case.
12806
12807 <note>As of version 3.1, this no longer performs an accessibility check
12808 automatically; call <link to="#refreshState"/> for that.
12809 </note>
12810 </desc>
12811 </attribute>
12812
12813 <attribute name="variant" type="unsigned long" readonly="yes">
12814 <desc>
12815 Returns the storage format variant information for this medium
12816 as a combination of the flags described at <link to="MediumVariant" />.
12817 Before <link to="#refreshState"/> is called this method returns
12818 an undefined value.
12819 </desc>
12820 </attribute>
12821
12822 <attribute name="location" type="wstring">
12823 <desc>
12824 Location of the storage unit holding medium data.
12825
12826 The format of the location string is medium type specific. For medium
12827 types using regular files in a host's file system, the location
12828 string is the full file name.
12829
12830 Some medium types may support changing the storage unit location by
12831 simply changing the value of this property. If this operation is not
12832 supported, the implementation will return E_NOTIMPL in attempt to set
12833 this attribute's value.
12834
12835 When setting a value of the location attribute which is a regular file
12836 in the host's file system, the given file name may be either relative to
12837 the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
12838 absolute. Note that if the given location specification does not contain
12839 the file extension part then a proper default extension will be
12840 automatically appended by the implementation depending on the medium type.
12841 </desc>
12842 </attribute>
12843
12844 <attribute name="name" type="wstring" readonly="yes">
12845 <desc>
12846 Name of the storage unit holding medium data.
12847
12848 The returned string is a short version of the <link to="#location"/>
12849 attribute that is suitable for representing the medium in situations
12850 where the full location specification is too long (such as lists
12851 and comboboxes in GUI frontends). This string is also used by frontends
12852 to sort the media list alphabetically when needed.
12853
12854 For example, for locations that are regular files in the host's file
12855 system, the value of this attribute is just the file name (+ extension),
12856 without the path specification.
12857
12858 Note that as opposed to the <link to="#location"/> attribute, the name
12859 attribute will not necessary be unique for a list of media of the
12860 given type and format.
12861 </desc>
12862 </attribute>
12863
12864 <attribute name="deviceType" type="DeviceType" readonly="yes">
12865 <desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
12866 medium.</desc>
12867 </attribute>
12868
12869 <attribute name="hostDrive" type="boolean" readonly="yes">
12870 <desc>True if this corresponds to a drive on the host.</desc>
12871 </attribute>
12872
12873 <attribute name="size" type="long long" readonly="yes">
12874 <desc>
12875 Physical size of the storage unit used to hold medium data (in bytes).
12876
12877 <note>
12878 For media whose <link to="#state"/> is <link
12879 to="MediumState_Inaccessible"/>, the value of this property is the
12880 last known size. For <link to="MediumState_NotCreated"/> media,
12881 the returned value is zero.
12882 </note>
12883 </desc>
12884 </attribute>
12885
12886 <attribute name="format" type="wstring" readonly="yes">
12887 <desc>
12888 Storage format of this medium.
12889
12890 The value of this attribute is a string that specifies a backend used
12891 to store medium data. The storage format is defined when you create a
12892 new medium or automatically detected when you open an existing medium,
12893 and cannot be changed later.
12894
12895 The list of all storage formats supported by this VirtualBox
12896 installation can be obtained using
12897 <link to="ISystemProperties::mediumFormats"/>.
12898 </desc>
12899 </attribute>
12900
12901 <attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
12902 <desc>
12903 Storage medium format object corresponding to this medium.
12904
12905 The value of this attribute is a reference to the medium format object
12906 that specifies the backend properties used to store medium data. The
12907 storage format is defined when you create a new medium or automatically
12908 detected when you open an existing medium, and cannot be changed later.
12909
12910 <note>@c null is returned if there is no associated medium format
12911 object. This can e.g. happen for medium objects representing host
12912 drives and other special medium objects.</note>
12913 </desc>
12914 </attribute>
12915
12916 <attribute name="type" type="MediumType">
12917 <desc>
12918 Type (role) of this medium.
12919
12920 The following constraints apply when changing the value of this
12921 attribute:
12922 <ul>
12923 <li>If a medium is attached to a virtual machine (either in the
12924 current state or in one of the snapshots), its type cannot be
12925 changed.
12926 </li>
12927 <li>As long as the medium has children, its type cannot be set
12928 to <link to="MediumType_Writethrough"/>.
12929 </li>
12930 <li>The type of all differencing media is
12931 <link to="MediumType_Normal"/> and cannot be changed.
12932 </li>
12933 </ul>
12934
12935 The type of a newly created or opened medium is set to
12936 <link to="MediumType_Normal"/>, except for DVD and floppy media,
12937 which have a type of <link to="MediumType_Writethrough"/>.
12938 </desc>
12939 </attribute>
12940
12941 <attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
12942 <desc>
12943 Returns which medium types can selected for this medium.
12944
12945 <result name="E_NOTIMPL">
12946 This attribute is not implemented at the moment.
12947 </result>
12948 </desc>
12949 </attribute>
12950
12951 <attribute name="parent" type="IMedium" readonly="yes">
12952 <desc>
12953 Parent of this medium (the medium this medium is directly based
12954 on).
12955
12956 Only differencing media have parents. For base (non-differencing)
12957 media, @c null is returned.
12958 </desc>
12959 </attribute>
12960
12961 <attribute name="children" type="IMedium" safearray="yes" readonly="yes">
12962 <desc>
12963 Children of this medium (all differencing media directly based
12964 on this medium). A @c null array is returned if this medium
12965 does not have any children.
12966 </desc>
12967 </attribute>
12968
12969 <attribute name="base" type="IMedium" readonly="yes">
12970 <desc>
12971 Base medium of this medium.
12972
12973 If this is a differencing medium, its base medium is the medium
12974 the given medium branch starts from. For all other types of media, this
12975 property returns the medium object itself (i.e. the same object this
12976 property is read on).
12977 </desc>
12978 </attribute>
12979
12980 <attribute name="readOnly" type="boolean" readonly="yes">
12981 <desc>
12982 Returns @c true if this medium is read-only and @c false otherwise.
12983
12984 A medium is considered to be read-only when its contents cannot be
12985 modified without breaking the integrity of other parties that depend on
12986 this medium such as its child media or snapshots of virtual machines
12987 where this medium is attached to these machines. If there are no
12988 children and no such snapshots then there is no dependency and the
12989 medium is not read-only.
12990
12991 The value of this attribute can be used to determine the kind of the
12992 attachment that will take place when attaching this medium to a
12993 virtual machine. If the value is @c false then the medium will
12994 be attached directly. If the value is @c true then the medium
12995 will be attached indirectly by creating a new differencing child
12996 medium for that. See the interface description for more information.
12997
12998 Note that all <link to="MediumType_Immutable">Immutable</link> media
12999 are always read-only while all
13000 <link to="MediumType_Writethrough">Writethrough</link> media are
13001 always not.
13002
13003 <note>
13004 The read-only condition represented by this attribute is related to
13005 the medium type and usage, not to the current
13006 <link to="IMedium::state">medium state</link> and not to the read-only
13007 state of the storage unit.
13008 </note>
13009 </desc>
13010 </attribute>
13011
13012 <attribute name="logicalSize" type="long long" readonly="yes">
13013 <desc>
13014 Logical size of this medium (in bytes), as reported to the
13015 guest OS running inside the virtual machine this medium is
13016 attached to. The logical size is defined when the medium is created
13017 and cannot be changed later.
13018
13019 <note>
13020 Reading this property on a differencing medium will return the size
13021 of its <link to="#base"/> medium.
13022 </note>
13023 <note>
13024 For media whose state is <link to="#state"/> is <link
13025 to="MediumState_Inaccessible"/>, the value of this property is the
13026 last known logical size. For <link to="MediumState_NotCreated"/>
13027 media, the returned value is zero.
13028 </note>
13029 </desc>
13030 </attribute>
13031
13032 <attribute name="autoReset" type="boolean">
13033 <desc>
13034 Whether this differencing medium will be automatically reset each
13035 time a virtual machine it is attached to is powered up. This
13036 attribute is automatically set to @c true for the last
13037 differencing image of an "immutable" medium (see
13038 <link to="MediumType" />).
13039
13040 See <link to="#reset"/> for more information about resetting
13041 differencing media.
13042
13043 <note>
13044 Reading this property on a base (non-differencing) medium will
13045 always @c false. Changing the value of this property in this
13046 case is not supported.
13047 </note>
13048
13049 <result name="VBOX_E_NOT_SUPPORTED">
13050 This is not a differencing medium (when changing the attribute
13051 value).
13052 </result>
13053 </desc>
13054 </attribute>
13055
13056 <attribute name="lastAccessError" type="wstring" readonly="yes">
13057 <desc>
13058 Text message that represents the result of the last accessibility
13059 check performed by <link to="#refreshState"/>.
13060
13061 An empty string is returned if the last accessibility check
13062 was successful or has not yet been called. As a result, if
13063 <link to="#state" /> is "Inaccessible" and this attribute is empty,
13064 then <link to="#refreshState"/> has yet to be called; this is the
13065 default value of media after VirtualBox initialization.
13066 A non-empty string indicates a failure and should normally describe
13067 a reason of the failure (for example, a file read error).
13068 </desc>
13069 </attribute>
13070
13071 <attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
13072 <desc>
13073 Array of UUIDs of all machines this medium is attached to.
13074
13075 A @c null array is returned if this medium is not attached to any
13076 machine or to any machine's snapshot.
13077
13078 <note>
13079 The returned array will include a machine even if this medium is not
13080 attached to that machine in the current state but attached to it in
13081 one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
13082 details.
13083 </note>
13084 </desc>
13085 </attribute>
13086
13087 <method name="setIds">
13088 <desc>
13089 Changes the UUID and parent UUID for a hard disk medium.
13090 </desc>
13091 <param name="setImageId" type="boolean" dir="in">
13092 <desc>
13093 Select whether a new image UUID is set or not.
13094 </desc>
13095 </param>
13096 <param name="imageId" type="uuid" mod="string" dir="in">
13097 <desc>
13098 New UUID for the image. If an empty string is passed, then a new
13099 UUID is automatically created, provided that @a setImageId is @c true.
13100 Specifying a zero UUID is not allowed.
13101 </desc>
13102 </param>
13103 <param name="setParentId" type="boolean" dir="in">
13104 <desc>
13105 Select whether a new parent UUID is set or not.
13106 </desc>
13107 </param>
13108 <param name="parentId" type="uuid" mod="string" dir="in">
13109 <desc>
13110 New parent UUID for the image. If an empty string is passed, then a
13111 new UUID is automatically created, provided @a setParentId is
13112 @c true. A zero UUID is valid.
13113 </desc>
13114 </param>
13115 <result name="E_INVALIDARG">
13116 Invalid parameter combination.
13117 </result>
13118 <result name="VBOX_E_NOT_SUPPORTED">
13119 Medium is not a hard disk medium.
13120 </result>
13121 </method>
13122
13123 <method name="refreshState">
13124 <desc>
13125 If the current medium state (see <link to="MediumState"/>) is one of
13126 "Created", "Inaccessible" or "LockedRead", then this performs an
13127 accessibility check on the medium and sets the value of the <link to="#state"/>
13128 attribute accordingly; that value is also returned for convenience.
13129
13130 For all other state values, this does not perform a refresh but returns
13131 the state only.
13132
13133 The refresh, if performed, may take a long time (several seconds or even
13134 minutes, depending on the storage unit location and format) because it performs an
13135 accessibility check of the storage unit. This check may cause a significant
13136 delay if the storage unit of the given medium is, for example, a file located
13137 on a network share which is not currently accessible due to connectivity
13138 problems. In that case, the call will not return until a timeout
13139 interval defined by the host OS for this operation expires. For this reason,
13140 it is recommended to never read this attribute on the main UI thread to avoid
13141 making the UI unresponsive.
13142
13143 If the last known state of the medium is "Created" and the accessibility
13144 check fails, then the state would be set to "Inaccessible", and
13145 <link to="#lastAccessError"/> may be used to get more details about the
13146 failure. If the state of the medium is "LockedRead", then it remains the
13147 same, and a non-empty value of <link to="#lastAccessError"/> will
13148 indicate a failed accessibility check in this case.
13149
13150 Note that not all medium states are applicable to all medium types.
13151 </desc>
13152 <param name="state" type="MediumState" dir="return">
13153 <desc>
13154 New medium state.
13155 </desc>
13156 </param>
13157 </method>
13158
13159 <method name="getSnapshotIds">
13160 <desc>
13161 Returns an array of UUIDs of all snapshots of the given machine where
13162 this medium is attached to.
13163
13164 If the medium is attached to the machine in the current state, then the
13165 first element in the array will always be the ID of the queried machine
13166 (i.e. the value equal to the @c machineId argument), followed by
13167 snapshot IDs (if any).
13168
13169 If the medium is not attached to the machine in the current state, then
13170 the array will contain only snapshot IDs.
13171
13172 The returned array may be @c null if this medium is not attached
13173 to the given machine at all, neither in the current state nor in one of
13174 the snapshots.
13175 </desc>
13176 <param name="machineId" type="uuid" mod="string" dir="in">
13177 <desc>
13178 UUID of the machine to query.
13179 </desc>
13180 </param>
13181 <param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
13182 <desc>
13183 Array of snapshot UUIDs of the given machine using this medium.
13184 </desc>
13185 </param>
13186 </method>
13187
13188 <method name="lockRead">
13189 <desc>
13190 Locks this medium for reading.
13191
13192 A read lock is shared: many clients can simultaneously lock the
13193 same medium for reading unless it is already locked for writing (see
13194 <link to="#lockWrite"/>) in which case an error is returned.
13195
13196 When the medium is locked for reading, it cannot be modified
13197 from within VirtualBox. This means that any method that changes
13198 the properties of this medium or contents of the storage unit
13199 will return an error (unless explicitly stated otherwise). That
13200 includes an attempt to start a virtual machine that wants to
13201 write to the the medium.
13202
13203 When the virtual machine is started up, it locks for reading all
13204 media it uses in read-only mode. If some medium cannot be locked
13205 for reading, the startup procedure will fail.
13206 A medium is typically locked for reading while it is used by a running
13207 virtual machine but has a depending differencing image that receives
13208 the actual write operations. This way one base medium can have
13209 multiple child differencing images which can be written to
13210 simultaneously. Read-only media such as DVD and floppy images are
13211 also locked for reading only (so they can be in use by multiple
13212 machines simultaneously).
13213
13214 A medium is also locked for reading when it is the source of a
13215 write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
13216
13217 The medium locked for reading must be unlocked using the <link
13218 to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
13219 can be nested and must be followed by the same number of paired
13220 <link to="#unlockRead"/> calls.
13221
13222 This method sets the medium state (see <link to="#state"/>) to
13223 "LockedRead" on success. The medium's previous state must be
13224 one of "Created", "Inaccessible" or "LockedRead".
13225
13226 Locking an inaccessible medium is not an error; this method performs
13227 a logical lock that prevents modifications of this medium through
13228 the VirtualBox API, not a physical file-system lock of the underlying
13229 storage unit.
13230
13231 This method returns the current state of the medium
13232 <i>before</i> the operation.
13233
13234 <result name="VBOX_E_INVALID_OBJECT_STATE">
13235 Invalid medium state (e.g. not created, locked, inaccessible,
13236 creating, deleting).
13237 </result>
13238
13239 </desc>
13240 <param name="state" type="MediumState" dir="return">
13241 <desc>
13242 State of the medium after the operation.
13243 </desc>
13244 </param>
13245 </method>
13246
13247 <method name="unlockRead">
13248 <desc>
13249 Cancels the read lock previously set by <link to="#lockRead"/>.
13250
13251 For both success and failure, this method returns the current state
13252 of the medium <i>after</i> the operation.
13253
13254 See <link to="#lockRead"/> for more details.
13255
13256 <result name="VBOX_E_INVALID_OBJECT_STATE">
13257 Medium not locked for reading.
13258 </result>
13259
13260 </desc>
13261 <param name="state" type="MediumState" dir="return">
13262 <desc>
13263 State of the medium after the operation.
13264 </desc>
13265 </param>
13266 </method>
13267
13268 <method name="lockWrite">
13269 <desc>
13270 Locks this medium for writing.
13271
13272 A write lock, as opposed to <link to="#lockRead"/>, is
13273 exclusive: there may be only one client holding a write lock,
13274 and there may be no read locks while the write lock is held.
13275 As a result, read-locking fails if a write lock is held, and
13276 write-locking fails if either a read or another write lock is held.
13277
13278 When a medium is locked for writing, it cannot be modified
13279 from within VirtualBox, and it is not guaranteed that the values
13280 of its properties are up-to-date. Any method that changes the
13281 properties of this medium or contents of the storage unit will
13282 return an error (unless explicitly stated otherwise).
13283
13284 When a virtual machine is started up, it locks for writing all
13285 media it uses to write data to. If any medium could not be locked
13286 for writing, the startup procedure will fail. If a medium has
13287 differencing images, then while the machine is running, only
13288 the last ("leaf") differencing image is locked for writing,
13289 whereas its parents are locked for reading only.
13290
13291 A medium is also locked for writing when it is the target of a
13292 write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
13293
13294 The medium locked for writing must be unlocked using the <link
13295 to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
13296
13297 This method sets the medium state (see <link to="#state"/>) to
13298 "LockedWrite" on success. The medium's previous state must be
13299 either "Created" or "Inaccessible".
13300
13301 Locking an inaccessible medium is not an error; this method performs
13302 a logical lock that prevents modifications of this medium through
13303 the VirtualBox API, not a physical file-system lock of the underlying
13304 storage unit.
13305
13306 For both, success and failure, this method returns the current
13307 state of the medium <i>before</i> the operation.
13308
13309 <result name="VBOX_E_INVALID_OBJECT_STATE">
13310 Invalid medium state (e.g. not created, locked, inaccessible,
13311 creating, deleting).
13312 </result>
13313
13314 </desc>
13315 <param name="state" type="MediumState" dir="return">
13316 <desc>
13317 State of the medium after the operation.
13318 </desc>
13319 </param>
13320 </method>
13321
13322 <method name="unlockWrite">
13323 <desc>
13324 Cancels the write lock previously set by <link to="#lockWrite"/>.
13325
13326 For both success and failure, this method returns the current
13327 state of the medium <i>after</i> the operation.
13328
13329 See <link to="#lockWrite"/> for more details.
13330
13331 <result name="VBOX_E_INVALID_OBJECT_STATE">
13332 Medium not locked for writing.
13333 </result>
13334
13335 </desc>
13336 <param name="state" type="MediumState" dir="return">
13337 <desc>
13338 State of the medium after the operation.
13339 </desc>
13340 </param>
13341 </method>
13342
13343 <method name="close">
13344 <desc>
13345 Closes this medium.
13346
13347 The medium must not be attached to any known virtual machine
13348 and must not have any known child media, otherwise the
13349 operation will fail.
13350
13351 When the medium is successfully closed, it is removed from
13352 the list of registered media, but its storage unit is not
13353 deleted. In particular, this means that this medium can
13354 later be opened again using the <link to="IVirtualBox::openMedium"/>
13355 call.
13356
13357 Note that after this method successfully returns, the given medium
13358 object becomes uninitialized. This means that any attempt
13359 to call any of its methods or attributes will fail with the
13360 <tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
13361
13362 <result name="VBOX_E_INVALID_OBJECT_STATE">
13363 Invalid medium state (other than not created, created or
13364 inaccessible).
13365 </result>
13366 <result name="VBOX_E_OBJECT_IN_USE">
13367 Medium attached to virtual machine.
13368 </result>
13369 <result name="VBOX_E_FILE_ERROR">
13370 Settings file not accessible.
13371 </result>
13372 <result name="VBOX_E_XML_ERROR">
13373 Could not parse the settings file.
13374 </result>
13375
13376 </desc>
13377 </method>
13378
13379 <!-- property methods -->
13380
13381 <method name="getProperty" const="yes">
13382 <desc>
13383 Returns the value of the custom medium property with the given name.
13384
13385 The list of all properties supported by the given medium format can
13386 be obtained with <link to="IMediumFormat::describeProperties"/>.
13387
13388 <note>If this method returns an empty string in @a value, the requested
13389 property is supported but currently not assigned any value.</note>
13390
13391 <result name="VBOX_E_OBJECT_NOT_FOUND">
13392 Requested property does not exist (not supported by the format).
13393 </result>
13394 <result name="E_INVALIDARG">@a name is @c null or empty.</result>
13395 </desc>
13396 <param name="name" type="wstring" dir="in">
13397 <desc>Name of the property to get.</desc>
13398 </param>
13399 <param name="value" type="wstring" dir="return">
13400 <desc>Current property value.</desc>
13401 </param>
13402 </method>
13403
13404 <method name="setProperty">
13405 <desc>
13406 Sets the value of the custom medium property with the given name.
13407
13408 The list of all properties supported by the given medium format can
13409 be obtained with <link to="IMediumFormat::describeProperties"/>.
13410
13411 <note>Setting the property value to @c null or an empty string is
13412 equivalent to deleting the existing value. A default value (if it is
13413 defined for this property) will be used by the format backend in this
13414 case.</note>
13415
13416 <result name="VBOX_E_OBJECT_NOT_FOUND">
13417 Requested property does not exist (not supported by the format).
13418 </result>
13419 <result name="E_INVALIDARG">@a name is @c null or empty.</result>
13420 </desc>
13421 <param name="name" type="wstring" dir="in">
13422 <desc>Name of the property to set.</desc>
13423 </param>
13424 <param name="value" type="wstring" dir="in">
13425 <desc>Property value to set.</desc>
13426 </param>
13427 </method>
13428
13429 <method name="getProperties" const="yes">
13430 <desc>
13431 Returns values for a group of properties in one call.
13432
13433 The names of the properties to get are specified using the @a names
13434 argument which is a list of comma-separated property names or
13435 an empty string if all properties are to be returned.
13436 <note>Currently the value of this argument is ignored and the method
13437 always returns all existing properties.</note>
13438
13439 The list of all properties supported by the given medium format can
13440 be obtained with <link to="IMediumFormat::describeProperties"/>.
13441
13442 The method returns two arrays, the array of property names corresponding
13443 to the @a names argument and the current values of these properties.
13444 Both arrays have the same number of elements with each element at the
13445 given index in the first array corresponds to an element at the same
13446 index in the second array.
13447
13448 For properties that do not have assigned values, an empty string is
13449 returned at the appropriate index in the @a returnValues array.
13450
13451 </desc>
13452 <param name="names" type="wstring" dir="in">
13453 <desc>
13454 Names of properties to get.
13455 </desc>
13456 </param>
13457 <param name="returnNames" type="wstring" safearray="yes" dir="out">
13458 <desc>Names of returned properties.</desc>
13459 </param>
13460 <param name="returnValues" type="wstring" safearray="yes" dir="return">
13461 <desc>Values of returned properties.</desc>
13462 </param>
13463 </method>
13464
13465 <method name="setProperties">
13466 <desc>
13467 Sets values for a group of properties in one call.
13468
13469 The names of the properties to set are passed in the @a names
13470 array along with the new values for them in the @a values array. Both
13471 arrays have the same number of elements with each element at the given
13472 index in the first array corresponding to an element at the same index
13473 in the second array.
13474
13475 If there is at least one property name in @a names that is not valid,
13476 the method will fail before changing the values of any other properties
13477 from the @a names array.
13478
13479 Using this method over <link to="#setProperty"/> is preferred if you
13480 need to set several properties at once since it is more efficient.
13481
13482 The list of all properties supported by the given medium format can
13483 be obtained with <link to="IMediumFormat::describeProperties"/>.
13484
13485 Setting the property value to @c null or an empty string is equivalent
13486 to deleting the existing value. A default value (if it is defined for
13487 this property) will be used by the format backend in this case.
13488 </desc>
13489 <param name="names" type="wstring" safearray="yes" dir="in">
13490 <desc>Names of properties to set.</desc>
13491 </param>
13492 <param name="values" type="wstring" safearray="yes" dir="in">
13493 <desc>Values of properties to set.</desc>
13494 </param>
13495 </method>
13496
13497 <!-- storage methods -->
13498
13499 <method name="createBaseStorage">
13500 <desc>
13501 Starts creating a hard disk storage unit (fixed/dynamic, according
13502 to the variant flags) in in the background. The previous storage unit
13503 created for this object, if any, must first be deleted using
13504 <link to="#deleteStorage"/>, otherwise the operation will fail.
13505
13506 Before the operation starts, the medium is placed in
13507 <link to="MediumState_Creating"/> state. If the create operation
13508 fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
13509 state.
13510
13511 After the returned progress object reports that the operation has
13512 successfully completed, the medium state will be set to <link
13513 to="MediumState_Created"/>, the medium will be remembered by this
13514 VirtualBox installation and may be attached to virtual machines.
13515
13516 <result name="VBOX_E_NOT_SUPPORTED">
13517 The variant of storage creation operation is not supported. See <link
13518 to="IMediumFormat::capabilities"/>.
13519 </result>
13520 </desc>
13521 <param name="logicalSize" type="long long" dir="in">
13522 <desc>Maximum logical size of the medium in bytes.</desc>
13523 </param>
13524 <param name="variant" type="unsigned long" dir="in">
13525 <desc>Exact image variant which should be created (as a combination of
13526 <link to="MediumVariant" /> flags).</desc>
13527 </param>
13528 <param name="progress" type="IProgress" dir="return">
13529 <desc>Progress object to track the operation completion.</desc>
13530 </param>
13531 </method>
13532
13533 <method name="deleteStorage">
13534 <desc>
13535 Starts deleting the storage unit of this medium.
13536
13537 The medium must not be attached to any known virtual machine and must
13538 not have any known child media, otherwise the operation will fail.
13539 It will also fail if there is no storage unit to delete or if deletion
13540 is already in progress, or if the medium is being in use (locked for
13541 read or for write) or inaccessible. Therefore, the only valid state for
13542 this operation to succeed is <link to="MediumState_Created"/>.
13543
13544 Before the operation starts, the medium is placed in
13545 <link to="MediumState_Deleting"/> state and gets removed from the list
13546 of remembered hard disks (media registry). If the delete operation
13547 fails, the medium will be remembered again and placed back to
13548 <link to="MediumState_Created"/> state.
13549
13550 After the returned progress object reports that the operation is
13551 complete, the medium state will be set to
13552 <link to="MediumState_NotCreated"/> and you will be able to use one of
13553 the storage creation methods to create it again.
13554
13555 <see><link to="#close"/></see>
13556
13557 <result name="VBOX_E_OBJECT_IN_USE">
13558 Medium is attached to a virtual machine.
13559 </result>
13560 <result name="VBOX_E_NOT_SUPPORTED">
13561 Storage deletion is not allowed because neither of storage creation
13562 operations are supported. See
13563 <link to="IMediumFormat::capabilities"/>.
13564 </result>
13565
13566 <note>
13567 If the deletion operation fails, it is not guaranteed that the storage
13568 unit still exists. You may check the <link to="IMedium::state"/> value
13569 to answer this question.
13570 </note>
13571 </desc>
13572 <param name="progress" type="IProgress" dir="return">
13573 <desc>Progress object to track the operation completion.</desc>
13574 </param>
13575 </method>
13576
13577 <!-- diff methods -->
13578
13579 <method name="createDiffStorage">
13580 <desc>
13581 Starts creating an empty differencing storage unit based on this
13582 medium in the format and at the location defined by the @a target
13583 argument.
13584
13585 The target medium must be in <link to="MediumState_NotCreated"/>
13586 state (i.e. must not have an existing storage unit). Upon successful
13587 completion, this operation will set the type of the target medium to
13588 <link to="MediumType_Normal"/> and create a storage unit necessary to
13589 represent the differencing medium data in the given format (according
13590 to the storage format of the target object).
13591
13592 After the returned progress object reports that the operation is
13593 successfully complete, the target medium gets remembered by this
13594 VirtualBox installation and may be attached to virtual machines.
13595
13596 <note>
13597 The medium will be set to <link to="MediumState_LockedRead"/>
13598 state for the duration of this operation.
13599 </note>
13600 <result name="VBOX_E_OBJECT_IN_USE">
13601 Medium not in @c NotCreated state.
13602 </result>
13603 </desc>
13604 <param name="target" type="IMedium" dir="in">
13605 <desc>Target medium.</desc>
13606 </param>
13607 <param name="variant" type="unsigned long" dir="in">
13608 <desc>Exact image variant which should be created (as a combination of
13609 <link to="MediumVariant" /> flags).</desc>
13610 </param>
13611 <param name="progress" type="IProgress" dir="return">
13612 <desc>Progress object to track the operation completion.</desc>
13613 </param>
13614 </method>
13615
13616 <method name="mergeTo">
13617 <desc>
13618 Starts merging the contents of this medium and all intermediate
13619 differencing media in the chain to the given target medium.
13620
13621 The target medium must be either a descendant of this medium or
13622 its ancestor (otherwise this method will immediately return a failure).
13623 It follows that there are two logical directions of the merge operation:
13624 from ancestor to descendant (<i>forward merge</i>) and from descendant to
13625 ancestor (<i>backward merge</i>). Let us consider the following medium
13626 chain:
13627
13628 <pre>Base &lt;- Diff_1 &lt;- Diff_2</pre>
13629
13630 Here, calling this method on the <tt>Base</tt> medium object with
13631 <tt>Diff_2</tt> as an argument will be a forward merge; calling it on
13632 <tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
13633 merge. Note that in both cases the contents of the resulting medium
13634 will be the same, the only difference is the medium object that takes
13635 the result of the merge operation. In case of the forward merge in the
13636 above example, the result will be written to <tt>Diff_2</tt>; in case of
13637 the backward merge, the result will be written to <tt>Base</tt>. In
13638 other words, the result of the operation is always stored in the target
13639 medium.
13640
13641 Upon successful operation completion, the storage units of all media in
13642 the chain between this (source) medium and the target medium, including
13643 the source medium itself, will be automatically deleted and the
13644 relevant medium objects (including this medium) will become
13645 uninitialized. This means that any attempt to call any of
13646 their methods or attributes will fail with the
13647 <tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
13648 example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
13649 delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
13650 Note that <tt>Diff_2</tt> in this case will become a base medium
13651 itself since it will no longer be based on any other medium.
13652
13653 Considering the above, all of the following conditions must be met in
13654 order for the merge operation to succeed:
13655 <ul>
13656 <li>
13657 Neither this (source) medium nor any intermediate
13658 differencing medium in the chain between it and the target
13659 medium is attached to any virtual machine.
13660 </li>
13661 <li>
13662 Neither the source medium nor the target medium is an
13663 <link to="MediumType_Immutable"/> medium.
13664 </li>
13665 <li>
13666 The part of the medium tree from the source medium to the
13667 target medium is a linear chain, i.e. all medium in this
13668 chain have exactly one child which is the next medium in this
13669 chain. The only exception from this rule is the target medium in
13670 the forward merge operation; it is allowed to have any number of
13671 child media because the merge operation will not change its
13672 logical contents (as it is seen by the guest OS or by children).
13673 </li>
13674 <li>
13675 None of the involved media are in
13676 <link to="MediumState_LockedRead"/> or
13677 <link to="MediumState_LockedWrite"/> state.
13678 </li>
13679 </ul>
13680
13681 <note>
13682 This (source) medium and all intermediates will be placed to <link
13683 to="MediumState_Deleting"/> state and the target medium will be
13684 placed to <link to="MediumState_LockedWrite"/> state and for the
13685 duration of this operation.
13686 </note>
13687 </desc>
13688 <param name="target" type="IMedium" dir="in">
13689 <desc>Target medium.</desc>
13690 </param>
13691 <param name="progress" type="IProgress" dir="return">
13692 <desc>Progress object to track the operation completion.</desc>
13693 </param>
13694 </method>
13695
13696 <!-- clone method -->
13697
13698 <method name="cloneTo">
13699 <desc>
13700 Starts creating a clone of this medium in the format and at the
13701 location defined by the @a target argument.
13702
13703 The target medium must be either in <link to="MediumState_NotCreated"/>
13704 state (i.e. must not have an existing storage unit) or in
13705 <link to="MediumState_Created"/> state (i.e. created and not locked, and
13706 big enough to hold the data or else the copy will be partial). Upon
13707 successful completion, the cloned medium will contain exactly the
13708 same sector data as the medium being cloned, except that in the
13709 first case a new UUID for the clone will be randomly generated, and in
13710 the second case the UUID will remain unchanged.
13711
13712 The @a parent argument defines which medium will be the parent
13713 of the clone. Passing a @c null reference indicates that the clone will
13714 be a base image, i.e. completely independent. It is possible to specify
13715 an arbitrary medium for this parameter, including the parent of the
13716 medium which is being cloned. Even cloning to a child of the source
13717 medium is possible. Note that when cloning to an existing image, the
13718 @a parent argument is ignored.
13719
13720 After the returned progress object reports that the operation is
13721 successfully complete, the target medium gets remembered by this
13722 VirtualBox installation and may be attached to virtual machines.
13723
13724 <note>
13725 This medium will be placed to <link to="MediumState_LockedRead"/>
13726 state for the duration of this operation.
13727 </note>
13728 <result name="E_NOTIMPL">
13729 The specified cloning variant is not supported at the moment.
13730 </result>
13731 </desc>
13732 <param name="target" type="IMedium" dir="in">
13733 <desc>Target medium.</desc>
13734 </param>
13735 <param name="variant" type="unsigned long" dir="in">
13736 <desc>Exact image variant which should be created (as a combination of
13737 <link to="MediumVariant" /> flags).</desc>
13738 </param>
13739 <param name="parent" type="IMedium" dir="in">
13740 <desc>Parent of the cloned medium.</desc>
13741 </param>
13742 <param name="progress" type="IProgress" dir="return">
13743 <desc>Progress object to track the operation completion.</desc>
13744 </param>
13745 </method>
13746
13747 <method name="cloneToBase">
13748 <desc>
13749 Starts creating a clone of this medium in the format and at the
13750 location defined by the @a target argument.
13751
13752 The target medium must be either in <link to="MediumState_NotCreated"/>
13753 state (i.e. must not have an existing storage unit) or in
13754 <link to="MediumState_Created"/> state (i.e. created and not locked, and
13755 big enough to hold the data or else the copy will be partial). Upon
13756 successful completion, the cloned medium will contain exactly the
13757 same sector data as the medium being cloned, except that in the
13758 first case a new UUID for the clone will be randomly generated, and in
13759 the second case the UUID will remain unchanged.
13760
13761 The @a parent argument defines which medium will be the parent
13762 of the clone. In this case the clone will be a base image, i.e.
13763 completely independent. It is possible to specify an arbitrary
13764 medium for this parameter, including the parent of the
13765 medium which is being cloned. Even cloning to a child of the source
13766 medium is possible. Note that when cloning to an existing image, the
13767 @a parent argument is ignored.
13768
13769 After the returned progress object reports that the operation is
13770 successfully complete, the target medium gets remembered by this
13771 VirtualBox installation and may be attached to virtual machines.
13772
13773 <note>
13774 This medium will be placed to <link to="MediumState_LockedRead"/>
13775 state for the duration of this operation.
13776 </note>
13777 <result name="E_NOTIMPL">
13778 The specified cloning variant is not supported at the moment.
13779 </result>
13780 </desc>
13781 <param name="target" type="IMedium" dir="in">
13782 <desc>Target medium.</desc>
13783 </param>
13784 <param name="variant" type="unsigned long" dir="in">
13785 <desc>Exact image variant which should be created (as a combination of
13786 <link to="MediumVariant" /> flags).</desc>
13787 </param>
13788 <param name="progress" type="IProgress" dir="return">
13789 <desc>Progress object to track the operation completion.</desc>
13790 </param>
13791 </method>
13792
13793 <!-- other methods -->
13794
13795 <method name="compact">
13796 <desc>
13797 Starts compacting of this medium. This means that the medium is
13798 transformed into a possibly more compact storage representation.
13799 This potentially creates temporary images, which can require a
13800 substantial amount of additional disk space.
13801
13802 This medium will be placed to <link to="MediumState_LockedWrite"/>
13803 state and all its parent media (if any) will be placed to
13804 <link to="MediumState_LockedRead"/> state for the duration of this
13805 operation.
13806
13807 Please note that the results can be either returned straight away,
13808 or later as the result of the background operation via the object
13809 returned via the @a progress parameter.
13810
13811 <result name="VBOX_E_NOT_SUPPORTED">
13812 Medium format does not support compacting (but potentially
13813 needs it).
13814 </result>
13815 </desc>
13816 <param name="progress" type="IProgress" dir="return">
13817 <desc>Progress object to track the operation completion.</desc>
13818 </param>
13819 </method>
13820
13821 <method name="resize">
13822 <desc>
13823 Starts resizing this medium. This means that the nominal size of the
13824 medium is set to the new value. Both increasing and decreasing the
13825 size is possible, and there are no safety checks, since VirtualBox
13826 does not make any assumptions about the medium contents.
13827
13828 Resizing usually needs additional disk space, and possibly also
13829 some temporary disk space. Note that resize does not create a full
13830 temporary copy of the medium, so the additional disk space requirement
13831 is usually much lower than using the clone operation.
13832
13833 This medium will be placed to <link to="MediumState_LockedWrite"/>
13834 state for the duration of this operation.
13835
13836 Please note that the results can be either returned straight away,
13837 or later as the result of the background operation via the object
13838 returned via the @a progress parameter.
13839
13840 <result name="VBOX_E_NOT_SUPPORTED">
13841 Medium format does not support resizing.
13842 </result>
13843 </desc>
13844 <param name="logicalSize" type="long long" dir="in">
13845 <desc>New nominal capacity of the medium in bytes.</desc>
13846 </param>
13847 <param name="progress" type="IProgress" dir="return">
13848 <desc>Progress object to track the operation completion.</desc>
13849 </param>
13850 </method>
13851
13852 <method name="reset">
13853 <desc>
13854 Starts erasing the contents of this differencing medium.
13855
13856 This operation will reset the differencing medium to its initial
13857 state when it does not contain any sector data and any read operation is
13858 redirected to its parent medium. This automatically gets called
13859 during VM power-up for every medium whose <link to="#autoReset" />
13860 attribute is @c true.
13861
13862 The medium will be write-locked for the duration of this operation (see
13863 <link to="#lockWrite" />).
13864
13865 <result name="VBOX_E_NOT_SUPPORTED">
13866 This is not a differencing medium.
13867 </result>
13868 <result name="VBOX_E_INVALID_OBJECT_STATE">
13869 Medium is not in <link to="MediumState_Created"/> or
13870 <link to="MediumState_Inaccessible"/> state.
13871 </result>
13872 </desc>
13873 <param name="progress" type="IProgress" dir="return">
13874 <desc>Progress object to track the operation completion.</desc>
13875 </param>
13876 </method>
13877
13878 </interface>
13879
13880
13881 <!--
13882 // IMediumFormat
13883 /////////////////////////////////////////////////////////////////////////
13884 -->
13885
13886 <enum
13887 name="DataType"
13888 uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
13889 >
13890 <const name="Int32" value="0"/>
13891 <const name="Int8" value="1"/>
13892 <const name="String" value="2"/>
13893 </enum>
13894
13895 <enum
13896 name="DataFlags"
13897 uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
13898 >
13899 <const name="None" value="0x00"/>
13900 <const name="Mandatory" value="0x01"/>
13901 <const name="Expert" value="0x02"/>
13902 <const name="Array" value="0x04"/>
13903 <const name="FlagMask" value="0x07"/>
13904 </enum>
13905
13906 <enum
13907 name="MediumFormatCapabilities"
13908 uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
13909 >
13910 <desc>
13911 Medium format capability flags.
13912 </desc>
13913
13914 <const name="Uuid" value="0x01">
13915 <desc>
13916 Supports UUIDs as expected by VirtualBox code.
13917 </desc>
13918 </const>
13919
13920 <const name="CreateFixed" value="0x02">
13921 <desc>
13922 Supports creating fixed size images, allocating all space instantly.
13923 </desc>
13924 </const>
13925
13926 <const name="CreateDynamic" value="0x04">
13927 <desc>
13928 Supports creating dynamically growing images, allocating space on
13929 demand.
13930 </desc>
13931 </const>
13932
13933 <const name="CreateSplit2G" value="0x08">
13934 <desc>
13935 Supports creating images split in chunks of a bit less than 2 GBytes.
13936 </desc>
13937 </const>
13938
13939 <const name="Differencing" value="0x10">
13940 <desc>
13941 Supports being used as a format for differencing media (see <link
13942 to="IMedium::createDiffStorage"/>).
13943 </desc>
13944 </const>
13945
13946 <const name="Asynchronous" value="0x20">
13947 <desc>
13948 Supports asynchronous I/O operations for at least some configurations.
13949 </desc>
13950 </const>
13951
13952 <const name="File" value="0x40">
13953 <desc>
13954 The format backend operates on files (the <link to="IMedium::location"/>
13955 attribute of the medium specifies a file used to store medium
13956 data; for a list of supported file extensions see
13957 <link to="IMediumFormat::describeFileExtensions"/>).
13958 </desc>
13959 </const>
13960
13961 <const name="Properties" value="0x80">
13962 <desc>
13963 The format backend uses the property interface to configure the storage
13964 location and properties (the <link to="IMediumFormat::describeProperties"/>
13965 method is used to get access to properties supported by the given medium format).
13966 </desc>
13967 </const>
13968
13969 <const name="TcpNetworking" value="0x100">
13970 <desc>
13971 The format backend uses the TCP networking interface for network access.
13972 </desc>
13973 </const>
13974
13975 <const name="VFS" value="0x200">
13976 <desc>
13977 The format backend supports virtual filesystem functionality.
13978 </desc>
13979 </const>
13980
13981 <const name="CapabilityMask" value="0x3FF"/>
13982 </enum>
13983
13984 <interface
13985 name="IMediumFormat" extends="$unknown"
13986 uuid="9bd5b655-ea47-4637-99f3-aad0948be35b"
13987 wsmap="managed"
13988 >
13989 <desc>
13990 The IMediumFormat interface represents a medium format.
13991
13992 Each medium format has an associated backend which is used to handle
13993 media stored in this format. This interface provides information
13994 about the properties of the associated backend.
13995
13996 Each medium format is identified by a string represented by the
13997 <link to="#id"/> attribute. This string is used in calls like
13998 <link to="IVirtualBox::createHardDisk"/> to specify the desired
13999 format.
14000
14001 The list of all supported medium formats can be obtained using
14002 <link to="ISystemProperties::mediumFormats"/>.
14003
14004 <see><link to="IMedium"/></see>
14005 </desc>
14006
14007 <attribute name="id" type="wstring" readonly="yes">
14008 <desc>
14009 Identifier of this format.
14010
14011 The format identifier is a non-@c null non-empty ASCII string. Note that
14012 this string is case-insensitive. This means that, for example, all of
14013 the following strings:
14014 <pre>
14015 "VDI"
14016 "vdi"
14017 "VdI"</pre>
14018 refer to the same medium format.
14019
14020 This string is used in methods of other interfaces where it is necessary
14021 to specify a medium format, such as
14022 <link to="IVirtualBox::createHardDisk"/>.
14023 </desc>
14024 </attribute>
14025
14026 <attribute name="name" type="wstring" readonly="yes">
14027 <desc>
14028 Human readable description of this format.
14029
14030 Mainly for use in file open dialogs.
14031 </desc>
14032 </attribute>
14033
14034 <attribute name="capabilities" type="unsigned long" readonly="yes">
14035 <desc>
14036 Capabilities of the format as a set of bit flags.
14037
14038 For the meaning of individual capability flags see
14039 <link to="MediumFormatCapabilities"/>.
14040 </desc>
14041 </attribute>
14042
14043 <method name="describeFileExtensions">
14044 <desc>
14045 Returns two arrays describing the supported file extensions.
14046
14047 The first array contains the supported extensions and the seconds one
14048 the type each extension supports. Both have the same size.
14049
14050 Note that some backends do not work on files, so this array may be
14051 empty.
14052
14053 <see><link to="IMediumFormat::capabilities"/></see>
14054 </desc>
14055 <param name="extensions" type="wstring" safearray="yes" dir="out">
14056 <desc>The array of supported extensions.</desc>
14057 </param>
14058 <param name="type" type="DeviceType" safearray="yes" dir="out">
14059 <desc>The array which indicates the device type for every given extension.</desc>
14060 </param>
14061 </method>
14062
14063 <method name="describeProperties" const="yes">
14064 <desc>
14065 Returns several arrays describing the properties supported by this
14066 format.
14067
14068 An element with the given index in each array describes one
14069 property. Thus, the number of elements in each returned array is the
14070 same and corresponds to the number of supported properties.
14071
14072 The returned arrays are filled in only if the
14073 <link to="MediumFormatCapabilities_Properties"/> flag is set.
14074 All arguments must be non-@c null.
14075
14076 <see><link to="DataType"/>, <link to="DataFlags"/></see>
14077 </desc>
14078
14079 <param name="names" type="wstring" safearray="yes" dir="out">
14080 <desc>Array of property names.</desc>
14081 </param>
14082 <param name="description" type="wstring" safearray="yes" dir="out">
14083 <desc>Array of property descriptions.</desc>
14084 </param>
14085 <param name="types" type="DataType" safearray="yes" dir="out">
14086 <desc>Array of property types.</desc>
14087 </param>
14088 <param name="flags" type="unsigned long" safearray="yes" dir="out">
14089 <desc>Array of property flags.</desc>
14090 </param>
14091 <param name="defaults" type="wstring" safearray="yes" dir="out">
14092 <desc>Array of default property values.</desc>
14093 </param>
14094 </method>
14095
14096 </interface>
14097
14098
14099 <!--
14100 // IKeyboard
14101 /////////////////////////////////////////////////////////////////////////
14102 -->
14103
14104 <interface
14105 name="IKeyboard" extends="$unknown"
14106 uuid="f6916ec5-a881-4237-898f-7de58cf88672"
14107 wsmap="managed"
14108 >
14109 <desc>
14110 The IKeyboard interface represents the virtual machine's keyboard. Used
14111 in <link to="IConsole::keyboard"/>.
14112
14113 Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
14114 to the virtual machine.
14115
14116 </desc>
14117 <method name="putScancode">
14118 <desc>Sends a scancode to the keyboard.
14119
14120 <result name="VBOX_E_IPRT_ERROR">
14121 Could not send scan code to virtual keyboard.
14122 </result>
14123
14124 </desc>
14125 <param name="scancode" type="long" dir="in"/>
14126 </method>
14127
14128 <method name="putScancodes">
14129 <desc>Sends an array of scancodes to the keyboard.
14130
14131 <result name="VBOX_E_IPRT_ERROR">
14132 Could not send all scan codes to virtual keyboard.
14133 </result>
14134
14135 </desc>
14136 <param name="scancodes" type="long" dir="in" safearray="yes"/>
14137 <param name="codesStored" type="unsigned long" dir="return"/>
14138 </method>
14139
14140 <method name="putCAD">
14141 <desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
14142 function is nothing special, it is just a convenience function
14143 calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
14144
14145 <result name="VBOX_E_IPRT_ERROR">
14146 Could not send all scan codes to virtual keyboard.
14147 </result>
14148
14149 </desc>
14150 </method>
14151
14152 <attribute name="eventSource" type="IEventSource" readonly="yes">
14153 <desc>
14154 Event source for keyboard events.
14155 </desc>
14156 </attribute>
14157
14158 </interface>
14159
14160
14161 <!--
14162 // IMouse
14163 /////////////////////////////////////////////////////////////////////////
14164 -->
14165
14166 <enum
14167 name="MouseButtonState"
14168 uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
14169 >
14170 <desc>
14171 Mouse button state.
14172 </desc>
14173
14174 <const name="LeftButton" value="0x01"/>
14175 <const name="RightButton" value="0x02"/>
14176 <const name="MiddleButton" value="0x04"/>
14177 <const name="WheelUp" value="0x08"/>
14178 <const name="WheelDown" value="0x10"/>
14179 <const name="XButton1" value="0x20"/>
14180 <const name="XButton2" value="0x40"/>
14181 <const name="MouseStateMask" value="0x7F"/>
14182 </enum>
14183
14184 <interface
14185 name="IMouse" extends="$unknown"
14186 uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
14187 wsmap="managed"
14188 >
14189 <desc>
14190 The IMouse interface represents the virtual machine's mouse. Used in
14191 <link to="IConsole::mouse"/>.
14192
14193 Through this interface, the virtual machine's virtual mouse can be
14194 controlled.
14195 </desc>
14196
14197 <attribute name="absoluteSupported" type="boolean" readonly="yes">
14198 <desc>
14199 Whether the guest OS supports absolute mouse pointer positioning
14200 or not.
14201 <note>
14202 You can use the <link to="IMouseCapabilityChangedEvent"/>
14203 event to be instantly informed about changes of this attribute
14204 during virtual machine execution.
14205 </note>
14206 <see><link to="#putMouseEventAbsolute"/></see>
14207 </desc>
14208 </attribute>
14209
14210 <attribute name="relativeSupported" type="boolean" readonly="yes">
14211 <desc>
14212 Whether the guest OS supports relative mouse pointer positioning
14213 or not.
14214 <note>
14215 You can use the <link to="IMouseCapabilityChangedEvent"/>
14216 event to be instantly informed about changes of this attribute
14217 during virtual machine execution.
14218 </note>
14219 <see><link to="#putMouseEvent"/></see>
14220 </desc>
14221 </attribute>
14222
14223 <attribute name="needsHostCursor" type="boolean" readonly="yes">
14224 <desc>
14225 Whether the guest OS can currently switch to drawing it's own mouse
14226 cursor on demand.
14227 <note>
14228 You can use the <link to="IMouseCapabilityChangedEvent"/>
14229 event to be instantly informed about changes of this attribute
14230 during virtual machine execution.
14231 </note>
14232 <see><link to="#putMouseEvent"/></see>
14233 </desc>
14234 </attribute>
14235
14236 <method name="putMouseEvent">
14237 <desc>
14238 Initiates a mouse event using relative pointer movements
14239 along x and y axis.
14240
14241 <result name="E_ACCESSDENIED">
14242 Console not powered up.
14243 </result>
14244 <result name="VBOX_E_IPRT_ERROR">
14245 Could not send mouse event to virtual mouse.
14246 </result>
14247
14248 </desc>
14249
14250 <param name="dx" type="long" dir="in">
14251 <desc>
14252 Amount of pixels the mouse should move to the right.
14253 Negative values move the mouse to the left.
14254 </desc>
14255 </param>
14256 <param name="dy" type="long" dir="in">
14257 <desc>
14258 Amount of pixels the mouse should move downwards.
14259 Negative values move the mouse upwards.
14260 </desc>
14261 </param>
14262 <param name="dz" type="long" dir="in">
14263 <desc>
14264 Amount of mouse wheel moves.
14265 Positive values describe clockwise wheel rotations,
14266 negative values describe counterclockwise rotations.
14267 </desc>
14268 </param>
14269 <param name="dw" type="long" dir="in">
14270 <desc>
14271 Amount of horizontal mouse wheel moves.
14272 Positive values describe a movement to the left,
14273 negative values describe a movement to the right.
14274 </desc>
14275 </param>
14276 <param name="buttonState" type="long" dir="in">
14277 <desc>
14278 The current state of mouse buttons. Every bit represents
14279 a mouse button as follows:
14280 <table>
14281 <tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
14282 <tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
14283 <tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
14284 </table>
14285 A value of <tt>1</tt> means the corresponding button is pressed.
14286 otherwise it is released.
14287 </desc>
14288 </param>
14289 </method>
14290
14291 <method name="putMouseEventAbsolute">
14292 <desc>
14293 Positions the mouse pointer using absolute x and y coordinates.
14294 These coordinates are expressed in pixels and
14295 start from <tt>[1,1]</tt> which corresponds to the top left
14296 corner of the virtual display.
14297
14298 <result name="E_ACCESSDENIED">
14299 Console not powered up.
14300 </result>
14301 <result name="VBOX_E_IPRT_ERROR">
14302 Could not send mouse event to virtual mouse.
14303 </result>
14304
14305 <note>
14306 This method will have effect only if absolute mouse
14307 positioning is supported by the guest OS.
14308 </note>
14309
14310 <see><link to="#absoluteSupported"/></see>
14311 </desc>
14312
14313 <param name="x" type="long" dir="in">
14314 <desc>
14315 X coordinate of the pointer in pixels, starting from @c 1.
14316 </desc>
14317 </param>
14318 <param name="y" type="long" dir="in">
14319 <desc>
14320 Y coordinate of the pointer in pixels, starting from @c 1.
14321 </desc>
14322 </param>
14323 <param name="dz" type="long" dir="in">
14324 <desc>
14325 Amount of mouse wheel moves.
14326 Positive values describe clockwise wheel rotations,
14327 negative values describe counterclockwise rotations.
14328 </desc>
14329 </param>
14330 <param name="dw" type="long" dir="in">
14331 <desc>
14332 Amount of horizontal mouse wheel moves.
14333 Positive values describe a movement to the left,
14334 negative values describe a movement to the right.
14335 </desc>
14336 </param>
14337 <param name="buttonState" type="long" dir="in">
14338 <desc>
14339 The current state of mouse buttons. Every bit represents
14340 a mouse button as follows:
14341 <table>
14342 <tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
14343 <tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
14344 <tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
14345 </table>
14346 A value of @c 1 means the corresponding button is pressed.
14347 otherwise it is released.
14348 </desc>
14349 </param>
14350 </method>
14351
14352 <attribute name="eventSource" type="IEventSource" readonly="yes">
14353 <desc>
14354 Event source for mouse events.
14355 </desc>
14356 </attribute>
14357
14358 </interface>
14359
14360 <!--
14361 // IDisplay
14362 /////////////////////////////////////////////////////////////////////////
14363 -->
14364
14365 <enum
14366 name="FramebufferPixelFormat"
14367 uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
14368 >
14369 <desc>
14370 Format of the video memory buffer. Constants represented by this enum can
14371 be used to test for particular values of <link
14372 to="IFramebuffer::pixelFormat"/>. See also <link
14373 to="IFramebuffer::requestResize"/>.
14374
14375 See also www.fourcc.org for more information about FOURCC pixel formats.
14376 </desc>
14377
14378 <const name="Opaque" value="0">
14379 <desc>
14380 Unknown buffer format (the user may not assume any particular format of
14381 the buffer).
14382 </desc>
14383 </const>
14384 <const name="FOURCC_RGB" value="0x32424752">
14385 <desc>
14386 Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
14387 bit layout).
14388 </desc>
14389 </const>
14390 </enum>
14391
14392 <interface
14393 name="IFramebuffer" extends="$unknown"
14394 uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
14395 wsmap="suppress"
14396 >
14397 <attribute name="address" type="octet" mod="ptr" readonly="yes">
14398 <desc>Address of the start byte of the frame buffer.</desc>
14399 </attribute>
14400
14401 <attribute name="width" type="unsigned long" readonly="yes">
14402 <desc>Frame buffer width, in pixels.</desc>
14403 </attribute>
14404
14405 <attribute name="height" type="unsigned long" readonly="yes">
14406 <desc>Frame buffer height, in pixels.</desc>
14407 </attribute>
14408
14409 <attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
14410 <desc>
14411 Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
14412 to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
14413 are: 8, 15, 16, 24 and 32.
14414 </desc>
14415 </attribute>
14416
14417 <attribute name="bytesPerLine" type="unsigned long" readonly="yes">
14418 <desc>
14419 Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
14420 to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
14421 size of the scan line must be aligned to 32 bits.
14422 </desc>
14423 </attribute>
14424
14425 <attribute name="pixelFormat" type="unsigned long" readonly="yes">
14426 <desc>
14427 Frame buffer pixel format. It's either one of the values defined by <link
14428 to="FramebufferPixelFormat"/> or a raw FOURCC code.
14429 <note>
14430 This attribute must never return <link
14431 to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
14432 <link to="#address"/> points to must be always known.
14433 </note>
14434 </desc>
14435 </attribute>
14436
14437 <attribute name="usesGuestVRAM" type="boolean" readonly="yes">
14438 <desc>
14439 Defines whether this frame buffer uses the virtual video card's memory
14440 buffer (guest VRAM) directly or not. See <link
14441 to="IFramebuffer::requestResize"/> for more information.
14442 </desc>
14443 </attribute>
14444
14445 <attribute name="heightReduction" type="unsigned long" readonly="yes">
14446 <desc>
14447 Hint from the frame buffer about how much of the standard
14448 screen height it wants to use for itself. This information is
14449 exposed to the guest through the VESA BIOS and VMMDev interface
14450 so that it can use it for determining its video mode table. It
14451 is not guaranteed that the guest respects the value.
14452 </desc>
14453 </attribute>
14454
14455 <attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
14456 <desc>
14457 An alpha-blended overlay which is superposed over the frame buffer.
14458 The initial purpose is to allow the display of icons providing
14459 information about the VM state, including disk activity, in front
14460 ends which do not have other means of doing that. The overlay is
14461 designed to controlled exclusively by IDisplay. It has no locking
14462 of its own, and any changes made to it are not guaranteed to be
14463 visible until the affected portion of IFramebuffer is updated. The
14464 overlay can be created lazily the first time it is requested. This
14465 attribute can also return @c null to signal that the overlay is not
14466 implemented.
14467 </desc>
14468 </attribute>
14469
14470 <attribute name="winId" type="long long" readonly="yes">
14471 <desc>
14472 Platform-dependent identifier of the window where context of this
14473 frame buffer is drawn, or zero if there's no such window.
14474 </desc>
14475 </attribute>
14476
14477 <method name="lock">
14478 <desc>
14479 Locks the frame buffer.
14480 Gets called by the IDisplay object where this frame buffer is
14481 bound to.
14482 </desc>
14483 </method>
14484
14485 <method name="unlock">
14486 <desc>
14487 Unlocks the frame buffer.
14488 Gets called by the IDisplay object where this frame buffer is
14489 bound to.
14490 </desc>
14491 </method>
14492
14493 <method name="notifyUpdate">
14494 <desc>
14495 Informs about an update.
14496 Gets called by the display object where this buffer is
14497 registered.
14498 </desc>
14499 <param name="x" type="unsigned long" dir="in"/>
14500 <param name="y" type="unsigned long" dir="in"/>
14501 <param name="width" type="unsigned long" dir="in"/>
14502 <param name="height" type="unsigned long" dir="in"/>
14503 </method>
14504
14505 <method name="requestResize">
14506 <desc>
14507 Requests a size and pixel format change.
14508
14509 There are two modes of working with the video buffer of the virtual
14510 machine. The <i>indirect</i> mode implies that the IFramebuffer
14511 implementation allocates a memory buffer for the requested display mode
14512 and provides it to the virtual machine. In <i>direct</i> mode, the
14513 IFramebuffer implementation uses the memory buffer allocated and owned
14514 by the virtual machine. This buffer represents the video memory of the
14515 emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
14516 usually faster because the implementation gets a raw pointer to the
14517 guest VRAM buffer which it can directly use for visualizing the contents
14518 of the virtual display, as opposed to the indirect mode where the
14519 contents of guest VRAM are copied to the memory buffer provided by
14520 the implementation every time a display update occurs.
14521
14522 It is important to note that the direct mode is really fast only when
14523 the implementation uses the given guest VRAM buffer directly, for
14524 example, by blitting it to the window representing the virtual machine's
14525 display, which saves at least one copy operation comparing to the
14526 indirect mode. However, using the guest VRAM buffer directly is not
14527 always possible: the format and the color depth of this buffer may be
14528 not supported by the target window, or it may be unknown (opaque) as in
14529 case of text or non-linear multi-plane VGA video modes. In this case,
14530 the indirect mode (that is always available) should be used as a
14531 fallback: when the guest VRAM contents are copied to the
14532 implementation-provided memory buffer, color and format conversion is
14533 done automatically by the underlying code.
14534
14535 The @a pixelFormat parameter defines whether the direct mode is
14536 available or not. If @a pixelFormat is <link
14537 to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
14538 VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
14539 @a bytesPerLine parameters must be ignored and the implementation must use
14540 the indirect mode (where it provides its own buffer in one of the
14541 supported formats). In all other cases, @a pixelFormat together with
14542 @a bitsPerPixel and @a bytesPerLine define the format of the video memory
14543 buffer pointed to by the @a VRAM parameter and the implementation is
14544 free to choose which mode to use. To indicate that this frame buffer uses
14545 the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
14546 attribute must return @c true and <link to="#address"/> must
14547 return exactly the same address that is passed in the @a VRAM parameter
14548 of this method; otherwise it is assumed that the indirect strategy is
14549 chosen.
14550
14551 The @a width and @a height parameters represent the size of the
14552 requested display mode in both modes. In case of indirect mode, the
14553 provided memory buffer should be big enough to store data of the given
14554 display mode. In case of direct mode, it is guaranteed that the given
14555 @a VRAM buffer contains enough space to represent the display mode of the
14556 given size. Note that this frame buffer's <link to="#width"/> and <link
14557 to="#height"/> attributes must return exactly the same values as
14558 passed to this method after the resize is completed (see below).
14559
14560 The @a finished output parameter determines if the implementation has
14561 finished resizing the frame buffer or not. If, for some reason, the
14562 resize cannot be finished immediately during this call, @a finished
14563 must be set to @c false, and the implementation must call
14564 <link to="IDisplay::resizeCompleted"/> after it has returned from
14565 this method as soon as possible. If @a finished is @c false, the
14566 machine will not call any frame buffer methods until
14567 <link to="IDisplay::resizeCompleted"/> is called.
14568
14569 Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
14570 <link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
14571 this frame buffer must return exactly the same values as specified in the
14572 parameters of this method, after the resize is completed. If the
14573 indirect mode is chosen, these attributes must return values describing
14574 the format of the implementation's own memory buffer <link
14575 to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
14576 value must always correlate with <link to="#pixelFormat"/>. Note that
14577 the <link to="#pixelFormat"/> attribute must never return <link
14578 to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
14579
14580 <note>
14581 This method is called by the IDisplay object under the
14582 <link to="#lock"/> provided by this IFramebuffer
14583 implementation. If this method returns @c false in @a finished, then
14584 this lock is not released until
14585 <link to="IDisplay::resizeCompleted"/> is called.
14586 </note>
14587 </desc>
14588 <param name="screenId" type="unsigned long" dir="in">
14589 <desc>
14590 Logical screen number. Must be used in the corresponding call to
14591 <link to="IDisplay::resizeCompleted"/> if this call is made.
14592 </desc>
14593 </param>
14594 <param name="pixelFormat" type="unsigned long" dir="in">
14595 <desc>
14596 Pixel format of the memory buffer pointed to by @a VRAM.
14597 See also <link to="FramebufferPixelFormat"/>.
14598 </desc>
14599 </param>
14600 <param name="VRAM" type="octet" mod="ptr" dir="in">
14601 <desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
14602 </param>
14603 <param name="bitsPerPixel" type="unsigned long" dir="in">
14604 <desc>Color depth, bits per pixel.</desc>
14605 </param>
14606 <param name="bytesPerLine" type="unsigned long" dir="in">
14607 <desc>Size of one scan line, in bytes.</desc>
14608 </param>
14609 <param name="width" type="unsigned long" dir="in">
14610 <desc>Width of the guest display, in pixels.</desc>
14611 </param>
14612 <param name="height" type="unsigned long" dir="in">
14613 <desc>Height of the guest display, in pixels.</desc>
14614 </param>
14615 <param name="finished" type="boolean" dir="return">
14616 <desc>
14617 Can the VM start using the new frame buffer immediately
14618 after this method returns or it should wait for
14619 <link to="IDisplay::resizeCompleted"/>.
14620 </desc>
14621 </param>
14622 </method>
14623
14624 <method name="videoModeSupported">
14625 <desc>
14626 Returns whether the frame buffer implementation is willing to
14627 support a given video mode. In case it is not able to render
14628 the video mode (or for some reason not willing), it should
14629 return @c false. Usually this method is called when the guest
14630 asks the VMM device whether a given video mode is supported
14631 so the information returned is directly exposed to the guest.
14632 It is important that this method returns very quickly.
14633 </desc>
14634 <param name="width" type="unsigned long" dir="in"/>
14635 <param name="height" type="unsigned long" dir="in"/>
14636 <param name="bpp" type="unsigned long" dir="in"/>
14637 <param name="supported" type="boolean" dir="return"/>
14638 </method>
14639
14640 <method name="getVisibleRegion">
14641 <desc>
14642 Returns the visible region of this frame buffer.
14643
14644 If the @a rectangles parameter is @c null then the value of the
14645 @a count parameter is ignored and the number of elements necessary to
14646 describe the current visible region is returned in @a countCopied.
14647
14648 If @a rectangles is not @c null but @a count is less
14649 than the required number of elements to store region data, the method
14650 will report a failure. If @a count is equal or greater than the
14651 required number of elements, then the actual number of elements copied
14652 to the provided array will be returned in @a countCopied.
14653
14654 <note>
14655 The address of the provided array must be in the process space of
14656 this IFramebuffer object.
14657 </note>
14658 <note>
14659 Method not yet implemented.
14660 </note>
14661 </desc>
14662 <param name="rectangles" type="octet" mod="ptr" dir="in">
14663 <desc>Pointer to the @c RTRECT array to receive region data.</desc>
14664 </param>
14665 <param name="count" type="unsigned long" dir="in">
14666 <desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14667 </param>
14668 <param name="countCopied" type="unsigned long" dir="return">
14669 <desc>Number of elements copied to the @a rectangles array.</desc>
14670 </param>
14671 </method>
14672
14673 <method name="setVisibleRegion">
14674 <desc>
14675 Suggests a new visible region to this frame buffer. This region
14676 represents the area of the VM display which is a union of regions of
14677 all top-level windows of the guest operating system running inside the
14678 VM (if the Guest Additions for this system support this
14679 functionality). This information may be used by the frontends to
14680 implement the seamless desktop integration feature.
14681
14682 <note>
14683 The address of the provided array must be in the process space of
14684 this IFramebuffer object.
14685 </note>
14686 <note>
14687 The IFramebuffer implementation must make a copy of the provided
14688 array of rectangles.
14689 </note>
14690 <note>
14691 Method not yet implemented.
14692 </note>
14693 </desc>
14694 <param name="rectangles" type="octet" mod="ptr" dir="in">
14695 <desc>Pointer to the @c RTRECT array.</desc>
14696 </param>
14697 <param name="count" type="unsigned long" dir="in">
14698 <desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14699 </param>
14700 </method>
14701
14702 <method name="processVHWACommand">
14703 <desc>
14704 Posts a Video HW Acceleration Command to the frame buffer for processing.
14705 The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
14706 are posted from quest to the host to be processed by the host hardware.
14707
14708 <note>
14709 The address of the provided command must be in the process space of
14710 this IFramebuffer object.
14711 </note>
14712 </desc>
14713
14714 <param name="command" type="octet" mod="ptr" dir="in">
14715 <desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
14716 </param>
14717 </method>
14718
14719 </interface>
14720
14721 <interface
14722 name="IFramebufferOverlay" extends="IFramebuffer"
14723 uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
14724 wsmap="suppress"
14725 >
14726 <desc>
14727 The IFramebufferOverlay interface represents an alpha blended overlay
14728 for displaying status icons above an IFramebuffer. It is always created
14729 not visible, so that it must be explicitly shown. It only covers a
14730 portion of the IFramebuffer, determined by its width, height and
14731 co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
14732 that order) format, and may be written to directly. Do re-read the
14733 width though, after setting it, as it may be adjusted (increased) to
14734 make it more suitable for the front end.
14735 </desc>
14736 <attribute name="x" type="unsigned long" readonly="yes">
14737 <desc>X position of the overlay, relative to the frame buffer.</desc>
14738 </attribute>
14739
14740 <attribute name="y" type="unsigned long" readonly="yes">
14741 <desc>Y position of the overlay, relative to the frame buffer.</desc>
14742 </attribute>
14743
14744 <attribute name="visible" type="boolean" readonly="no">
14745 <desc>
14746 Whether the overlay is currently visible.
14747 </desc>
14748 </attribute>
14749
14750 <attribute name="alpha" type="unsigned long" readonly="no">
14751 <desc>
14752 The global alpha value for the overlay. This may or may not be
14753 supported by a given front end.
14754 </desc>
14755 </attribute>
14756
14757 <method name="move">
14758 <desc>
14759 Changes the overlay's position relative to the IFramebuffer.
14760 </desc>
14761 <param name="x" type="unsigned long" dir="in"/>
14762 <param name="y" type="unsigned long" dir="in"/>
14763 </method>
14764
14765 </interface>
14766
14767 <interface
14768 name="IDisplay" extends="$unknown"
14769 uuid="b83ee395-8679-40ca-8d60-1a0cbe724930"
14770 wsmap="managed"
14771 >
14772 <desc>
14773 The IDisplay interface represents the virtual machine's display.
14774
14775 The object implementing this interface is contained in each
14776 <link to="IConsole::display"/> attribute and represents the visual
14777 output of the virtual machine.
14778
14779 The virtual display supports pluggable output targets represented by the
14780 IFramebuffer interface. Examples of the output target are a window on
14781 the host computer or an RDP session's display on a remote computer.
14782 </desc>
14783 <method name="getScreenResolution">
14784 <desc>Queries display width, height and color depth for given screen.</desc>
14785 <param name="screenId" type="unsigned long" dir="in"/>
14786 <param name="width" type="unsigned long" dir="out"/>
14787 <param name="height" type="unsigned long" dir="out"/>
14788 <param name="bitsPerPixel" type="unsigned long" dir="out"/>
14789 </method>
14790
14791 <method name="setFramebuffer">
14792 <desc>
14793 Sets the framebuffer for given screen.
14794 </desc>
14795 <param name="screenId" type="unsigned long" dir="in"/>
14796 <param name="framebuffer" type="IFramebuffer" dir="in"/>
14797 </method>
14798
14799 <method name="getFramebuffer">
14800 <desc>
14801 Queries the framebuffer for given screen.
14802 </desc>
14803 <param name="screenId" type="unsigned long" dir="in"/>
14804 <param name="framebuffer" type="IFramebuffer" dir="out"/>
14805 <param name="xOrigin" type="long" dir="out"/>
14806 <param name="yOrigin" type="long" dir="out"/>
14807 </method>
14808
14809 <method name="setVideoModeHint">
14810 <desc>
14811 Asks VirtualBox to request the given video mode from
14812 the guest. This is just a hint and it cannot be guaranteed
14813 that the requested resolution will be used. Guest Additions
14814 are required for the request to be seen by guests. The caller
14815 should issue the request and wait for a resolution change and
14816 after a timeout retry.
14817
14818 Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
14819 parameters means that the corresponding values should be taken from the
14820 current video mode (i.e. left unchanged).
14821
14822 If the guest OS supports multi-monitor configuration then the @a display
14823 parameter specifies the number of the guest display to send the hint to:
14824 @c 0 is the primary display, @c 1 is the first secondary and
14825 so on. If the multi-monitor configuration is not supported, @a display
14826 must be @c 0.
14827
14828 <result name="E_INVALIDARG">
14829 The @a display is not associated with any monitor.
14830 </result>
14831
14832 </desc>
14833 <param name="display" type="unsigned long" dir="in">
14834 <desc>
14835 The number of the guest display to send the hint to.
14836 </desc>
14837 </param>
14838 <param name="enabled" type="boolean" dir="in">
14839 <desc>
14840 @c True, if this guest screen is enabled,
14841 @c False otherwise.
14842 </desc>
14843 </param>
14844 <param name="changeOrigin" type="boolean" dir="in">
14845 <desc>
14846 @c True, if the origin of the guest screen should be changed,
14847 @c False otherwise.
14848 </desc>
14849 </param>
14850 <param name="originX" type="long" dir="in">
14851 <desc>
14852 The X origin of the guest screen.
14853 </desc>
14854 </param>
14855 <param name="originY" type="long" dir="in">
14856 <desc>
14857 The Y origin of the guest screen.
14858 </desc>
14859 </param>
14860 <param name="width" type="unsigned long" dir="in"/>
14861 <param name="height" type="unsigned long" dir="in"/>
14862 <param name="bitsPerPixel" type="unsigned long" dir="in"/>
14863 </method>
14864
14865 <method name="setSeamlessMode">
14866 <desc>
14867 Enables or disables seamless guest display rendering (seamless desktop
14868 integration) mode.
14869 <note>
14870 Calling this method has no effect if <link
14871 to="IGuest::getFacilityStatus"/> with facility @c Seamless
14872 does not return @c Active.
14873 </note>
14874 </desc>
14875 <param name="enabled" type="boolean" dir="in"/>
14876 </method>
14877
14878 <method name="takeScreenShot">
14879 <desc>
14880 Takes a screen shot of the requested size and copies it to the
14881 32-bpp buffer allocated by the caller and pointed to by @a address.
14882 A pixel consists of 4 bytes in order: B, G, R, 0.
14883
14884 <note>This API can be used only locally by a VM process through the
14885 COM/XPCOM C++ API as it requires pointer support. It is not
14886 available for scripting langages, Java or any webservice clients.
14887 Unless you are writing a new VM frontend use
14888 <link to="#takeScreenShotToArray" />.
14889 </note>
14890
14891 <result name="E_NOTIMPL">
14892 Feature not implemented.
14893 </result>
14894 <result name="VBOX_E_IPRT_ERROR">
14895 Could not take a screenshot.
14896 </result>
14897
14898 </desc>
14899 <param name="screenId" type="unsigned long" dir="in"/>
14900 <param name="address" type="octet" mod="ptr" dir="in"/>
14901 <param name="width" type="unsigned long" dir="in"/>
14902 <param name="height" type="unsigned long" dir="in"/>
14903 </method>
14904
14905 <method name="takeScreenShotToArray">
14906 <desc>
14907 Takes a guest screen shot of the requested size and returns it as
14908 an array of bytes in uncompressed 32-bit RGBA format.
14909 A pixel consists of 4 bytes in order: R, G, B, 0xFF.
14910
14911 This API is slow, but could be the only option to get guest screenshot
14912 for scriptable languages not allowed to manipulate with addresses
14913 directly.
14914
14915 <result name="E_NOTIMPL">
14916 Feature not implemented.
14917 </result>
14918 <result name="VBOX_E_IPRT_ERROR">
14919 Could not take a screenshot.
14920 </result>
14921 </desc>
14922 <param name="screenId" type="unsigned long" dir="in">
14923 <desc>
14924 Monitor to take screenshot from.
14925 </desc>
14926 </param>
14927 <param name="width" type="unsigned long" dir="in">
14928 <desc>
14929 Desired image width.
14930 </desc>
14931 </param>
14932 <param name="height" type="unsigned long" dir="in">
14933 <desc>
14934 Desired image height.
14935 </desc>
14936 </param>
14937 <param name="screenData" type="octet" dir="return" safearray="yes">
14938 <desc>
14939 Array with resulting screen data.
14940 </desc>
14941 </param>
14942 </method>
14943
14944 <method name="takeScreenShotPNGToArray">
14945 <desc>
14946 Takes a guest screen shot of the requested size and returns it as
14947 PNG image in array.
14948
14949 <result name="E_NOTIMPL">
14950 Feature not implemented.
14951 </result>
14952 <result name="VBOX_E_IPRT_ERROR">
14953 Could not take a screenshot.
14954 </result>
14955 </desc>
14956 <param name="screenId" type="unsigned long" dir="in">
14957 <desc>
14958 Monitor to take the screenshot from.
14959 </desc>
14960 </param>
14961 <param name="width" type="unsigned long" dir="in">
14962 <desc>
14963 Desired image width.
14964 </desc>
14965 </param>
14966 <param name="height" type="unsigned long" dir="in">
14967 <desc>
14968 Desired image height.
14969 </desc>
14970 </param>
14971 <param name="screenData" type="octet" dir="return" safearray="yes">
14972 <desc>
14973 Array with resulting screen data.
14974 </desc>
14975 </param>
14976 </method>
14977
14978 <method name="drawToScreen">
14979 <desc>
14980 Draws a 32-bpp image of the specified size from the given buffer
14981 to the given point on the VM display.
14982
14983 <result name="E_NOTIMPL">
14984 Feature not implemented.
14985 </result>
14986 <result name="VBOX_E_IPRT_ERROR">
14987 Could not draw to screen.
14988 </result>
14989
14990 </desc>
14991 <param name="screenId" type="unsigned long" dir="in">
14992 <desc>
14993 Monitor to take the screenshot from.
14994 </desc>
14995 </param>
14996 <param name="address" type="octet" mod="ptr" dir="in">
14997 <desc>
14998 Address to store the screenshot to
14999 </desc>
15000 </param>
15001 <param name="x" type="unsigned long" dir="in">
15002 <desc>
15003 Relative to the screen top left corner.
15004 </desc>
15005 </param>
15006 <param name="y" type="unsigned long" dir="in">
15007 <desc>
15008 Relative to the screen top left corner.
15009 </desc>
15010 </param>
15011 <param name="width" type="unsigned long" dir="in">
15012 <desc>
15013 Desired image width.
15014 </desc>
15015 </param>
15016 <param name="height" type="unsigned long" dir="in">
15017 <desc>
15018 Desired image height.
15019 </desc>
15020 </param>
15021 </method>
15022
15023 <method name="invalidateAndUpdate">
15024 <desc>
15025 Does a full invalidation of the VM display and instructs the VM
15026 to update it.
15027
15028 <result name="VBOX_E_IPRT_ERROR">
15029 Could not invalidate and update screen.
15030 </result>
15031
15032 </desc>
15033 </method>
15034
15035 <method name="resizeCompleted">
15036 <desc>
15037 Signals that a framebuffer has completed the resize operation.
15038
15039 <result name="VBOX_E_NOT_SUPPORTED">
15040 Operation only valid for external frame buffers.
15041 </result>
15042
15043 </desc>
15044 <param name="screenId" type="unsigned long" dir="in"/>
15045 </method>
15046
15047 <method name="completeVHWACommand">
15048 <desc>
15049 Signals that the Video HW Acceleration command has completed.
15050 </desc>
15051
15052 <param name="command" type="octet" mod="ptr" dir="in">
15053 <desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
15054 </param>
15055 </method>
15056
15057 <method name="viewportChanged">
15058 <desc>
15059 Signals that framebuffer window viewport has changed.
15060
15061 <result name="E_INVALIDARG">
15062 The specified viewport data is invalid.
15063 </result>
15064
15065 </desc>
15066
15067 <param name="screenId" type="unsigned long" dir="in">
15068 <desc>
15069 Monitor to take the screenshot from.
15070 </desc>
15071 </param>
15072 <param name="x" type="unsigned long" dir="in">
15073 <desc>
15074 Framebuffer x offset.
15075 </desc>
15076 </param>
15077 <param name="y" type="unsigned long" dir="in">
15078 <desc>
15079 Framebuffer y offset.
15080 </desc>
15081 </param>
15082 <param name="width" type="unsigned long" dir="in">
15083 <desc>
15084 Viewport width.
15085 </desc>
15086 </param>
15087 <param name="height" type="unsigned long" dir="in">
15088 <desc>
15089 Viewport height.
15090 </desc>
15091 </param>
15092 </method>
15093 </interface>
15094
15095 <!--
15096 // INetworkAdapter
15097 /////////////////////////////////////////////////////////////////////////
15098 -->
15099
15100 <enum
15101 name="NetworkAttachmentType"
15102 uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
15103 >
15104 <desc>
15105 Network attachment type.
15106 </desc>
15107
15108 <const name="Null" value="0">
15109 <desc>Null value, also means "not attached".</desc>
15110 </const>
15111 <const name="NAT" value="1"/>
15112 <const name="Bridged" value="2"/>
15113 <const name="Internal" value="3"/>
15114 <const name="HostOnly" value="4"/>
15115 <const name="Generic" value="5"/>
15116 </enum>
15117
15118 <enum
15119 name="NetworkAdapterType"
15120 uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
15121 >
15122 <desc>
15123 Network adapter type.
15124 </desc>
15125
15126 <const name="Null" value="0">
15127 <desc>Null value (never used by the API).</desc>
15128 </const>
15129 <const name="Am79C970A" value="1">
15130 <desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
15131 </const>
15132 <const name="Am79C973" value="2">
15133 <desc>AMD PCNet-FAST III network card (Am79C973).</desc>
15134 </const>
15135 <const name="I82540EM" value="3">
15136 <desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
15137 </const>
15138 <const name="I82543GC" value="4">
15139 <desc>Intel PRO/1000 T Server network card (82543GC).</desc>
15140 </const>
15141 <const name="I82545EM" value="5">
15142 <desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
15143 </const>
15144 <const name="Virtio" value="6">
15145 <desc>Virtio network device.</desc>
15146 </const>
15147 </enum>
15148
15149 <enum
15150 name="NetworkAdapterPromiscModePolicy"
15151 uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
15152 >
15153 <desc>
15154 The promiscuous mode policy of an interface.
15155 </desc>
15156
15157 <const name="Deny" value="1">
15158 <desc>Deny promiscuous mode requests.</desc>
15159 </const>
15160 <const name="AllowNetwork" value="2">
15161 <desc>
15162 Allow promicuous mode, but restrict the scope it to the internal
15163 network so that it only applies to other VMs.
15164 </desc>
15165 </const>
15166 <const name="AllowAll" value="3">
15167 <desc>
15168 Allow promicuous mode, include unrelated traffic going over the wire
15169 and internally on the host.
15170 </desc>
15171 </const>
15172 </enum>
15173
15174 <interface
15175 name="INetworkAdapter" extends="$unknown"
15176 uuid="efa0f965-63c7-4c60-afdf-b1cc9943b9c0"
15177 wsmap="managed"
15178 >
15179 <desc>
15180 Represents a virtual network adapter that is attached to a virtual machine.
15181 Each virtual machine has a fixed number of network adapter slots with one
15182 instance of this attached to each of them. Call
15183 <link to="IMachine::getNetworkAdapter" /> to get the network adapter that
15184 is attached to a given slot in a given machine.
15185
15186 Each network adapter can be in one of five attachment modes, which are
15187 represented by the <link to="NetworkAttachmentType" /> enumeration;
15188 see the <link to="#attachmentType" /> attribute.
15189 </desc>
15190
15191 <attribute name="adapterType" type="NetworkAdapterType">
15192 <desc>
15193 Type of the virtual network adapter. Depending on this value,
15194 VirtualBox will provide a different virtual network hardware
15195 to the guest.
15196 </desc>
15197 </attribute>
15198
15199 <attribute name="slot" type="unsigned long" readonly="yes">
15200 <desc>
15201 Slot number this adapter is plugged into. Corresponds to
15202 the value you pass to <link to="IMachine::getNetworkAdapter"/>
15203 to obtain this instance.
15204 </desc>
15205 </attribute>
15206
15207 <attribute name="enabled" type="boolean">
15208 <desc>
15209 Flag whether the network adapter is present in the
15210 guest system. If disabled, the virtual guest hardware will
15211 not contain this network adapter. Can only be changed when
15212 the VM is not running.
15213 </desc>
15214 </attribute>
15215
15216 <attribute name="MACAddress" type="wstring">
15217 <desc>
15218 Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
15219 it to @c null or an empty string, VirtualBox will generate a unique MAC address.
15220 </desc>
15221 </attribute>
15222
15223 <attribute name="attachmentType" type="NetworkAttachmentType">
15224 <desc>
15225 Sets/Gets network attachment type of this network adapter.
15226 </desc>
15227 </attribute>
15228
15229 <attribute name="bridgedInterface" type="wstring">
15230 <desc>
15231 Name of the network interface the VM should be bridged to.
15232 </desc>
15233 </attribute>
15234
15235 <attribute name="hostOnlyInterface" type="wstring">
15236 <desc>
15237 Name of the host only network interface the VM is attached to.
15238 </desc>
15239 </attribute>
15240
15241 <attribute name="internalNetwork" type="wstring">
15242 <desc>
15243 Name of the internal network the VM is attached to.
15244 </desc>
15245 </attribute>
15246
15247 <attribute name="NATNetwork" type="wstring">
15248 <desc>
15249 Name of the NAT network the VM is attached to.
15250 </desc>
15251 </attribute>
15252
15253 <attribute name="genericDriver" type="wstring">
15254 <desc>
15255 Name of the driver to use for the "Generic" network attachment type.
15256 </desc>
15257 </attribute>
15258
15259 <attribute name="cableConnected" type="boolean">
15260 <desc>
15261 Flag whether the adapter reports the cable as connected or not.
15262 It can be used to report offline situations to a VM.
15263 </desc>
15264 </attribute>
15265
15266 <attribute name="lineSpeed" type="unsigned long">
15267 <desc>
15268 Line speed reported by custom drivers, in units of 1 kbps.
15269 </desc>
15270 </attribute>
15271
15272 <attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
15273 <desc>
15274 The promiscuous mode policy of the network adapter when attached to an
15275 internal network, host only network or a bridge.
15276 </desc>
15277 </attribute>
15278
15279 <attribute name="traceEnabled" type="boolean">
15280 <desc>
15281 Flag whether network traffic from/to the network card should be traced.
15282 Can only be toggled when the VM is turned off.
15283 </desc>
15284 </attribute>
15285
15286 <attribute name="traceFile" type="wstring">
15287 <desc>
15288 Filename where a network trace will be stored. If not set, VBox-pid.pcap
15289 will be used.
15290 </desc>
15291 </attribute>
15292
15293 <attribute name="NATEngine" type="INATEngine" readonly="yes">
15294 <desc>
15295 Points to the NAT engine which handles the network address translation
15296 for this interface. This is active only when the interface actually uses
15297 NAT.
15298 </desc>
15299 </attribute>
15300
15301 <attribute name="bootPriority" type="unsigned long">
15302 <desc>
15303 Network boot priority of the adapter. Priority 1 is highest. If not set,
15304 the priority is considered to be at the lowest possible setting.
15305 </desc>
15306 </attribute>
15307
15308 <attribute name="bandwidthGroup" type="IBandwidthGroup">
15309 <desc>The bandwidth group this network adapter is assigned to.</desc>
15310 </attribute>
15311
15312 <!-- property methods -->
15313
15314 <method name="getProperty" const="yes">
15315 <desc>
15316 Returns the value of the network attachment property with the given name.
15317
15318 If the requested data @a key does not exist, this function will
15319 succeed and return an empty string in the @a value argument.
15320
15321 <result name="E_INVALIDARG">@a name is @c null or empty.</result>
15322 </desc>
15323 <param name="key" type="wstring" dir="in">
15324 <desc>Name of the property to get.</desc>
15325 </param>
15326 <param name="value" type="wstring" dir="return">
15327 <desc>Current property value.</desc>
15328 </param>
15329 </method>
15330
15331 <method name="setProperty">
15332 <desc>
15333 Sets the value of the network attachment property with the given name.
15334
15335 Setting the property value to @c null or an empty string is equivalent
15336 to deleting the existing value.
15337
15338 <result name="E_INVALIDARG">@a name is @c null or empty.</result>
15339 </desc>
15340 <param name="key" type="wstring" dir="in">
15341 <desc>Name of the property to set.</desc>
15342 </param>
15343 <param name="value" type="wstring" dir="in">
15344 <desc>Property value to set.</desc>
15345 </param>
15346 </method>
15347
15348 <method name="getProperties" const="yes">
15349 <desc>
15350 Returns values for a group of properties in one call.
15351
15352 The names of the properties to get are specified using the @a names
15353 argument which is a list of comma-separated property names or
15354 an empty string if all properties are to be returned.
15355 <note>Currently the value of this argument is ignored and the method
15356 always returns all existing properties.</note>
15357
15358 The method returns two arrays, the array of property names corresponding
15359 to the @a names argument and the current values of these properties.
15360 Both arrays have the same number of elements with each element at the
15361 given index in the first array corresponds to an element at the same
15362 index in the second array.
15363 </desc>
15364 <param name="names" type="wstring" dir="in">
15365 <desc>
15366 Names of properties to get.
15367 </desc>
15368 </param>
15369 <param name="returnNames" type="wstring" safearray="yes" dir="out">
15370 <desc>Names of returned properties.</desc>
15371 </param>
15372 <param name="returnValues" type="wstring" safearray="yes" dir="return">
15373 <desc>Values of returned properties.</desc>
15374 </param>
15375 </method>
15376
15377 </interface>
15378
15379
15380 <!--
15381 // ISerialPort
15382 /////////////////////////////////////////////////////////////////////////
15383 -->
15384
15385 <enum
15386 name="PortMode"
15387 uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
15388 >
15389 <desc>
15390 The PortMode enumeration represents possible communication modes for
15391 the virtual serial port device.
15392 </desc>
15393
15394 <const name="Disconnected" value="0">
15395 <desc>Virtual device is not attached to any real host device.</desc>
15396 </const>
15397 <const name="HostPipe" value="1">
15398 <desc>Virtual device is attached to a host pipe.</desc>
15399 </const>
15400 <const name="HostDevice" value="2">
15401 <desc>Virtual device is attached to a host device.</desc>
15402 </const>
15403 <const name="RawFile" value="3">
15404 <desc>Virtual device is attached to a raw file.</desc>
15405 </const>
15406 </enum>
15407
15408 <interface
15409 name="ISerialPort" extends="$unknown"
15410 uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
15411 wsmap="managed"
15412 >
15413
15414 <desc>
15415 The ISerialPort interface represents the virtual serial port device.
15416
15417 The virtual serial port device acts like an ordinary serial port
15418 inside the virtual machine. This device communicates to the real
15419 serial port hardware in one of two modes: host pipe or host device.
15420
15421 In host pipe mode, the #path attribute specifies the path to the pipe on
15422 the host computer that represents a serial port. The #server attribute
15423 determines if this pipe is created by the virtual machine process at
15424 machine startup or it must already exist before starting machine
15425 execution.
15426
15427 In host device mode, the #path attribute specifies the name of the
15428 serial port device on the host computer.
15429
15430 There is also a third communication mode: the disconnected mode. In this
15431 mode, the guest OS running inside the virtual machine will be able to
15432 detect the serial port, but all port write operations will be discarded
15433 and all port read operations will return no data.
15434
15435 <see><link to="IMachine::getSerialPort"/></see>
15436 </desc>
15437
15438 <attribute name="slot" type="unsigned long" readonly="yes">
15439 <desc>
15440 Slot number this serial port is plugged into. Corresponds to
15441 the value you pass to <link to="IMachine::getSerialPort"/>
15442 to obtain this instance.
15443 </desc>
15444 </attribute>
15445
15446 <attribute name="enabled" type="boolean">
15447 <desc>
15448 Flag whether the serial port is enabled. If disabled,
15449 the serial port will not be reported to the guest OS.
15450 </desc>
15451 </attribute>
15452
15453 <attribute name="IOBase" type="unsigned long">
15454 <desc>Base I/O address of the serial port.</desc>
15455 </attribute>
15456
15457 <attribute name="IRQ" type="unsigned long">
15458 <desc>IRQ number of the serial port.</desc>
15459 </attribute>
15460
15461 <attribute name="hostMode" type="PortMode">
15462 <desc>
15463 How is this port connected to the host.
15464 <note>
15465 Changing this attribute may fail if the conditions for
15466 <link to="#path"/> are not met.
15467 </note>
15468 </desc>
15469 </attribute>
15470
15471 <attribute name="server" type="boolean">
15472 <desc>
15473 Flag whether this serial port acts as a server (creates a new pipe on
15474 the host) or as a client (uses the existing pipe). This attribute is
15475 used only when <link to="#hostMode"/> is PortMode_HostPipe.
15476 </desc>
15477 </attribute>
15478
15479 <attribute name="path" type="wstring">
15480 <desc>
15481 Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
15482 PortMode_HostPipe, or the host serial device name when
15483 <link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
15484 cases, setting a @c null or empty string as the attribute's value
15485 is an error. Otherwise, the value of this property is ignored.
15486 </desc>
15487 </attribute>
15488
15489 </interface>
15490
15491 <!--
15492 // IParallelPort
15493 /////////////////////////////////////////////////////////////////////////
15494 -->
15495
15496 <interface
15497 name="IParallelPort" extends="$unknown"
15498 uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
15499 wsmap="managed"
15500 >
15501
15502 <desc>
15503 The IParallelPort interface represents the virtual parallel port device.
15504
15505 The virtual parallel port device acts like an ordinary parallel port
15506 inside the virtual machine. This device communicates to the real
15507 parallel port hardware using the name of the parallel device on the host
15508 computer specified in the #path attribute.
15509
15510 Each virtual parallel port device is assigned a base I/O address and an
15511 IRQ number that will be reported to the guest operating system and used
15512 to operate the given parallel port from within the virtual machine.
15513
15514 <see><link to="IMachine::getParallelPort"/></see>
15515 </desc>
15516
15517 <attribute name="slot" type="unsigned long" readonly="yes">
15518 <desc>
15519 Slot number this parallel port is plugged into. Corresponds to
15520 the value you pass to <link to="IMachine::getParallelPort"/>
15521 to obtain this instance.
15522 </desc>
15523 </attribute>
15524
15525 <attribute name="enabled" type="boolean">
15526 <desc>
15527 Flag whether the parallel port is enabled. If disabled,
15528 the parallel port will not be reported to the guest OS.
15529 </desc>
15530 </attribute>
15531
15532 <attribute name="IOBase" type="unsigned long">
15533 <desc>Base I/O address of the parallel port.</desc>
15534 </attribute>
15535
15536 <attribute name="IRQ" type="unsigned long">
15537 <desc>IRQ number of the parallel port.</desc>
15538 </attribute>
15539
15540 <attribute name="path" type="wstring">
15541 <desc>
15542 Host parallel device name. If this parallel port is enabled, setting a
15543 @c null or an empty string as this attribute's value will result in
15544 an error.
15545 </desc>
15546 </attribute>
15547
15548 </interface>
15549
15550
15551 <!--
15552 // IMachineDebugger
15553 /////////////////////////////////////////////////////////////////////////
15554 -->
15555
15556 <interface
15557 name="IMachineDebugger" extends="$unknown"
15558 uuid="a9abbb7c-d678-43b2-bed2-19ec0e32303d"
15559 wsmap="suppress"
15560 >
15561 <method name="dumpGuestCore">
15562 <desc>
15563 Takes a core dump of the guest.
15564
15565 See include/VBox/dbgfcorefmt.h for details on the file format.
15566 </desc>
15567 <param name="filename" type="wstring" dir="in">
15568 <desc>
15569 The name of the output file. The file must not exist.
15570 </desc>
15571 </param>
15572 <param name="compression" type="wstring" dir="in">
15573 <desc>
15574 Reserved for future compression method indicator.
15575 </desc>
15576 </param>
15577 </method>
15578
15579 <method name="dumpHostProcessCore">
15580 <desc>
15581 Takes a core dump of the VM process on the host.
15582
15583 This feature is not implemented in the 4.0.0 release but it may show up
15584 in a dot release.
15585 </desc>
15586 <param name="filename" type="wstring" dir="in">
15587 <desc>
15588 The name of the output file. The file must not exist.
15589 </desc>
15590 </param>
15591 <param name="compression" type="wstring" dir="in">
15592 <desc>
15593 Reserved for future compression method indicator.
15594 </desc>
15595 </param>
15596 </method>
15597
15598 <method name="info">
15599 <desc>
15600 Interfaces with the info dumpers (DBGFInfo).
15601
15602 This feature is not implemented in the 4.0.0 release but it may show up
15603 in a dot release.
15604 </desc>
15605 <param name="name" type="wstring" dir="in">
15606 <desc>
15607 The name of the info item.
15608 </desc>
15609 </param>
15610 <param name="args" type="wstring" dir="in">
15611 <desc>
15612 Arguments to the info dumper.
15613 </desc>
15614 </param>
15615 <param name="info" type="wstring" dir="return">
15616 <desc>
15617 The into string.
15618 </desc>
15619 </param>
15620 </method>
15621
15622 <method name="injectNMI">
15623 <desc>
15624 Inject an NMI into a running VT-x/AMD-V VM.
15625 </desc>
15626 </method>
15627
15628 <method name="modifyLogGroups">
15629 <desc>
15630 Modifies the group settings of the debug or release logger.
15631 </desc>
15632 <param name="settings" type="wstring" dir="in">
15633 <desc>
15634 The group settings string. See iprt/log.h for details. To target the
15635 release logger, prefix the string with "release:".
15636 </desc>
15637 </param>
15638 </method>
15639
15640 <method name="modifyLogFlags">
15641 <desc>
15642 Modifies the debug or release logger flags.
15643 </desc>
15644 <param name="settings" type="wstring" dir="in">
15645 <desc>
15646 The flags settings string. See iprt/log.h for details. To target the
15647 release logger, prefix the string with "release:".
15648 </desc>
15649 </param>
15650 </method>
15651
15652 <method name="modifyLogDestinations">
15653 <desc>
15654 Modifies the debug or release logger destinations.
15655 </desc>
15656 <param name="settings" type="wstring" dir="in">
15657 <desc>
15658 The destination settings string. See iprt/log.h for details. To target the
15659 release logger, prefix the string with "release:".
15660 </desc>
15661 </param>
15662 </method>
15663
15664 <method name="readPhysicalMemory">
15665 <desc>
15666 Reads guest physical memory, no side effects (MMIO++).
15667
15668 This feature is not implemented in the 4.0.0 release but may show up
15669 in a dot release.
15670 </desc>
15671 <param name="address" type="long long" dir="in">
15672 <desc>The guest physical address.</desc>
15673 </param>
15674 <param name="size" type="unsigned long" dir="in">
15675 <desc>The number of bytes to read.</desc>
15676 </param>
15677 <param name="bytes" type="octet" safearray="yes" dir="return">
15678 <desc>The bytes read.</desc>
15679 </param>
15680 </method>
15681
15682 <method name="writePhysicalMemory">
15683 <desc>
15684 Writes guest physical memory, access handles (MMIO++) are ignored.
15685
15686 This feature is not implemented in the 4.0.0 release but may show up
15687 in a dot release.
15688 </desc>
15689 <param name="address" type="long long" dir="in">
15690 <desc>The guest physical address.</desc>
15691 </param>
15692 <param name="size" type="unsigned long" dir="in">
15693 <desc>The number of bytes to read.</desc>
15694 </param>
15695 <param name="bytes" type="octet" safearray="yes" dir="in">
15696 <desc>The bytes to write.</desc>
15697 </param>
15698 </method>
15699
15700 <method name="readVirtualMemory">
15701 <desc>
15702 Reads guest virtual memory, no side effects (MMIO++).
15703
15704 This feature is not implemented in the 4.0.0 release but may show up
15705 in a dot release.
15706 </desc>
15707 <param name="cpuId" type="unsigned long" dir="in">
15708 <desc>The identifier of the Virtual CPU.</desc>
15709 </param>
15710 <param name="address" type="long long" dir="in">
15711 <desc>The guest virtual address.</desc>
15712 </param>
15713 <param name="size" type="unsigned long" dir="in">
15714 <desc>The number of bytes to read.</desc>
15715 </param>
15716 <param name="bytes" type="octet" safearray="yes" dir="return">
15717 <desc>The bytes read.</desc>
15718 </param>
15719 </method>
15720
15721 <method name="writeVirtualMemory">
15722 <desc>
15723 Writes guest virtual memory, access handles (MMIO++) are ignored.
15724
15725 This feature is not implemented in the 4.0.0 release but may show up
15726 in a dot release.
15727 </desc>
15728 <param name="cpuId" type="unsigned long" dir="in">
15729 <desc>The identifier of the Virtual CPU.</desc>
15730 </param>
15731 <param name="address" type="long long" dir="in">
15732 <desc>The guest virtual address.</desc>
15733 </param>
15734 <param name="size" type="unsigned long" dir="in">
15735 <desc>The number of bytes to read.</desc>
15736 </param>
15737 <param name="bytes" type="octet" safearray="yes" dir="in">
15738 <desc>The bytes to write.</desc>
15739 </param>
15740 </method>
15741
15742 <method name="detectOS">
15743 <desc>
15744 Tries to (re-)detect the guest OS kernel.
15745
15746 This feature is not implemented in the 4.0.0 release but may show up
15747 in a dot release.
15748 </desc>
15749 <param name="os" type="wstring" dir="return">
15750 <desc>
15751 The detected OS kernel on success.
15752 </desc>
15753 </param>
15754 </method>
15755
15756 <method name="getRegister">
15757 <desc>
15758 Gets one register.
15759
15760 This feature is not implemented in the 4.0.0 release but may show up
15761 in a dot release.
15762 </desc>
15763 <param name="cpuId" type="unsigned long" dir="in">
15764 <desc>The identifier of the Virtual CPU.</desc>
15765 </param>
15766 <param name="name" type="wstring" dir="in">
15767 <desc>The register name, case is ignored.</desc>
15768 </param>
15769 <param name="value" type="wstring" dir="return">
15770 <desc>
15771 The register value. This is usually a hex value (always 0x prefixed)
15772 but other format may be used for floating point registers (TBD).
15773 </desc>
15774 </param>
15775 </method>
15776
15777 <method name="getRegisters">
15778 <desc>
15779 Gets all the registers for the given CPU.
15780
15781 This feature is not implemented in the 4.0.0 release but may show up
15782 in a dot release.
15783 </desc>
15784 <param name="cpuId" type="unsigned long" dir="in">
15785 <desc>The identifier of the Virtual CPU.</desc>
15786 </param>
15787 <param name="names" type="wstring" dir="out" safearray="yes">
15788 <desc>Array containing the lowercase register names.</desc>
15789 </param>
15790 <param name="values" type="wstring" dir="out" safearray="yes">
15791 <desc>
15792 Array paralell to the names holding the register values as if the
15793 register was returned by <link to="IMachineDebugger::getRegister"/>.
15794 </desc>
15795 </param>
15796 </method>
15797
15798 <method name="setRegister">
15799 <desc>
15800 Gets one register.
15801
15802 This feature is not implemented in the 4.0.0 release but may show up
15803 in a dot release.
15804 </desc>
15805 <param name="cpuId" type="unsigned long" dir="in">
15806 <desc>The identifier of the Virtual CPU.</desc>
15807 </param>
15808 <param name="name" type="wstring" dir="in">
15809 <desc>The register name, case is ignored.</desc>
15810 </param>
15811 <param name="value" type="wstring" dir="in">
15812 <desc>
15813 The new register value. Hexadecimal, decimal and octal formattings
15814 are supported in addition to any special formattings returned by
15815 the getters.
15816 </desc>
15817 </param>
15818 </method>
15819
15820 <method name="setRegisters">
15821 <desc>
15822 Sets zero or more registers atomically.
15823
15824 This feature is not implemented in the 4.0.0 release but may show up
15825 in a dot release.
15826 </desc>
15827 <param name="cpuId" type="unsigned long" dir="in">
15828 <desc>The identifier of the Virtual CPU.</desc>
15829 </param>
15830 <param name="names" type="wstring" dir="in" safearray="yes">
15831 <desc>Array containing the register names, case ignored.</desc>
15832 </param>
15833 <param name="values" type="wstring" dir="in" safearray="yes">
15834 <desc>
15835 Array paralell to the names holding the register values. See
15836 <link to="IMachineDebugger::setRegister"/> for formatting
15837 guidelines.
15838 </desc>
15839 </param>
15840 </method>
15841
15842 <method name="dumpGuestStack">
15843 <desc>
15844 Produce a simple stack dump using the current guest state.
15845
15846 This feature is not implemented in the 4.0.0 release but may show up
15847 in a dot release.
15848 </desc>
15849 <param name="cpuId" type="unsigned long" dir="in">
15850 <desc>The identifier of the Virtual CPU.</desc>
15851 </param>
15852 <param name="stack" type="wstring" dir="return">
15853 <desc>String containing the formatted stack dump.</desc>
15854 </param>
15855 </method>
15856
15857 <method name="resetStats">
15858 <desc>
15859 Reset VM statistics.
15860 </desc>
15861 <param name="pattern" type="wstring" dir="in">
15862 <desc>The selection pattern. A bit similar to filename globbing.</desc>
15863 </param>
15864 </method>
15865
15866 <method name="dumpStats">
15867 <desc>
15868 Dumps VM statistics.
15869 </desc>
15870 <param name="pattern" type="wstring" dir="in">
15871 <desc>The selection pattern. A bit similar to filename globbing.</desc>
15872 </param>
15873 </method>
15874
15875 <method name="getStats">
15876 <desc>
15877 Get the VM statistics in a XMLish format.
15878 </desc>
15879 <param name="pattern" type="wstring" dir="in">
15880 <desc>The selection pattern. A bit similar to filename globbing.</desc>
15881 </param>
15882 <param name="withDescriptions" type="boolean" dir="in">
15883 <desc>Whether to include the descriptions.</desc>
15884 </param>
15885 <param name="stats" type="wstring" dir="out">
15886 <desc>The XML document containing the statistics.</desc>
15887 </param>
15888 </method>
15889
15890 <attribute name="singleStep" type="boolean">
15891 <desc>Switch for enabling single-stepping.</desc>
15892 </attribute>
15893
15894 <attribute name="recompileUser" type="boolean">
15895 <desc>Switch for forcing code recompilation for user mode code.</desc>
15896 </attribute>
15897
15898 <attribute name="recompileSupervisor" type="boolean">
15899 <desc>Switch for forcing code recompilation for supervisor mode code.</desc>
15900 </attribute>
15901
15902 <attribute name="PATMEnabled" type="boolean">
15903 <desc>Switch for enabling and disabling the PATM component.</desc>
15904 </attribute>
15905
15906 <attribute name="CSAMEnabled" type="boolean">
15907 <desc>Switch for enabling and disabling the CSAM component.</desc>
15908 </attribute>
15909
15910 <attribute name="logEnabled" type="boolean">
15911 <desc>Switch for enabling and disabling the debug logger.</desc>
15912 </attribute>
15913
15914 <attribute name="logDbgFlags" type="wstring" readonly="yes">
15915 <desc>The debug logger flags.</desc>
15916 </attribute>
15917
15918 <attribute name="logDbgGroups" type="wstring" readonly="yes">
15919 <desc>The debug logger's group settings.</desc>
15920 </attribute>
15921
15922 <attribute name="logDbgDestinations" type="wstring" readonly="yes">
15923 <desc>The debug logger's destination settings.</desc>
15924 </attribute>
15925
15926 <attribute name="logRelFlags" type="wstring" readonly="yes">
15927 <desc>The release logger flags.</desc>
15928 </attribute>
15929
15930 <attribute name="logRelGroups" type="wstring" readonly="yes">
15931 <desc>The release logger's group settings.</desc>
15932 </attribute>
15933
15934 <attribute name="logRelDestinations" type="wstring" readonly="yes">
15935 <desc>The relase logger's destination settings.</desc>
15936 </attribute>
15937
15938 <attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
15939 <desc>
15940 Flag indicating whether the VM is currently making use of CPU hardware
15941 virtualization extensions.
15942 </desc>
15943 </attribute>
15944
15945 <attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
15946 <desc>
15947 Flag indicating whether the VM is currently making use of the nested paging
15948 CPU hardware virtualization extension.
15949 </desc>
15950 </attribute>
15951
15952 <attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
15953 <desc>
15954 Flag indicating whether the VM is currently making use of the VPID
15955 VT-x extension.
15956 </desc>
15957 </attribute>
15958
15959 <attribute name="OSName" type="wstring" readonly="yes">
15960 <desc>
15961 Query the guest OS kernel name as detected by the DBGF.
15962
15963 This feature is not implemented in the 4.0.0 release but may show up
15964 in a dot release.
15965 </desc>
15966 </attribute>
15967
15968 <attribute name="OSVersion" type="wstring" readonly="yes">
15969 <desc>
15970 Query the guest OS kernel version string as detected by the DBGF.
15971
15972 This feature is not implemented in the 4.0.0 release but may show up
15973 in a dot release.
15974 </desc>
15975 </attribute>
15976
15977 <attribute name="PAEEnabled" type="boolean" readonly="yes">
15978 <desc>
15979 Flag indicating whether the VM is currently making use of the Physical
15980 Address Extension CPU feature.
15981 </desc>
15982 </attribute>
15983
15984 <attribute name="virtualTimeRate" type="unsigned long">
15985 <desc>
15986 The rate at which the virtual time runs expressed as a percentage.
15987 The accepted range is 2% to 20000%.
15988 </desc>
15989 </attribute>
15990
15991 <attribute name="VM" type="long long" readonly="yes">
15992 <desc>
15993 Gets the VM handle. This is only for internal use while
15994 we carve the details of this interface.
15995 </desc>
15996 </attribute>
15997
15998 </interface>
15999
16000 <!--
16001 // IUSBController
16002 /////////////////////////////////////////////////////////////////////////
16003 -->
16004
16005 <interface
16006 name="IUSBController" extends="$unknown"
16007 uuid="01e6f13a-0580-452f-a40f-74e32a5e4921"
16008 wsmap="managed"
16009 >
16010 <attribute name="enabled" type="boolean">
16011 <desc>
16012 Flag whether the USB controller is present in the
16013 guest system. If disabled, the virtual guest hardware will
16014 not contain any USB controller. Can only be changed when
16015 the VM is powered off.
16016 </desc>
16017 </attribute>
16018
16019 <attribute name="enabledEHCI" type="boolean">
16020 <desc>
16021 Flag whether the USB EHCI controller is present in the
16022 guest system. If disabled, the virtual guest hardware will
16023 not contain a USB EHCI controller. Can only be changed when
16024 the VM is powered off.
16025 </desc>
16026 </attribute>
16027
16028 <attribute name="proxyAvailable" type="boolean" readonly="yes">
16029 <desc>
16030 Flag whether there is an USB proxy available.
16031 </desc>
16032 </attribute>
16033
16034 <attribute name="USBStandard" type="unsigned short" readonly="yes">
16035 <desc>
16036 USB standard version which the controller implements.
16037 This is a BCD which means that the major version is in the
16038 high byte and minor version is in the low byte.
16039 </desc>
16040 </attribute>
16041
16042 <attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
16043 <desc>
16044 List of USB device filters associated with the machine.
16045
16046 If the machine is currently running, these filters are activated
16047 every time a new (supported) USB device is attached to the host
16048 computer that was not ignored by global filters
16049 (<link to="IHost::USBDeviceFilters"/>).
16050
16051 These filters are also activated when the machine is powered up.
16052 They are run against a list of all currently available USB
16053 devices (in states
16054 <link to="USBDeviceState_Available"/>,
16055 <link to="USBDeviceState_Busy"/>,
16056 <link to="USBDeviceState_Held"/>) that were not previously
16057 ignored by global filters.
16058
16059 If at least one filter matches the USB device in question, this
16060 device is automatically captured (attached to) the virtual USB
16061 controller of this machine.
16062
16063 <see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
16064 </desc>
16065 </attribute>
16066
16067 <method name="createDeviceFilter">
16068 <desc>
16069 Creates a new USB device filter. All attributes except
16070 the filter name are set to empty (any match),
16071 <i>active</i> is @c false (the filter is not active).
16072
16073 The created filter can then be added to the list of filters using
16074 <link to="#insertDeviceFilter"/>.
16075
16076 <result name="VBOX_E_INVALID_VM_STATE">
16077 The virtual machine is not mutable.
16078 </result>
16079
16080 <see><link to="#deviceFilters"/></see>
16081 </desc>
16082 <param name="name" type="wstring" dir="in">
16083 <desc>
16084 Filter name. See <link to="IUSBDeviceFilter::name"/>
16085 for more info.
16086 </desc>
16087 </param>
16088 <param name="filter" type="IUSBDeviceFilter" dir="return">
16089 <desc>Created filter object.</desc>
16090 </param>
16091 </method>
16092
16093 <method name="insertDeviceFilter">
16094 <desc>
16095 Inserts the given USB device to the specified position
16096 in the list of filters.
16097
16098 Positions are numbered starting from <tt>0</tt>. If the specified
16099 position is equal to or greater than the number of elements in
16100 the list, the filter is added to the end of the collection.
16101
16102 <note>
16103 Duplicates are not allowed, so an attempt to insert a
16104 filter that is already in the collection, will return an
16105 error.
16106 </note>
16107
16108 <result name="VBOX_E_INVALID_VM_STATE">
16109 Virtual machine is not mutable.
16110 </result>
16111 <result name="E_INVALIDARG">
16112 USB device filter not created within this VirtualBox instance.
16113 </result>
16114 <result name="VBOX_E_INVALID_OBJECT_STATE">
16115 USB device filter already in list.
16116 </result>
16117
16118 <see><link to="#deviceFilters"/></see>
16119 </desc>
16120 <param name="position" type="unsigned long" dir="in">
16121 <desc>Position to insert the filter to.</desc>
16122 </param>
16123 <param name="filter" type="IUSBDeviceFilter" dir="in">
16124 <desc>USB device filter to insert.</desc>
16125 </param>
16126 </method>
16127
16128 <method name="removeDeviceFilter">
16129 <desc>
16130 Removes a USB device filter from the specified position in the
16131 list of filters.
16132
16133 Positions are numbered starting from <tt>0</tt>. Specifying a
16134 position equal to or greater than the number of elements in
16135 the list will produce an error.
16136
16137 <see><link to="#deviceFilters"/></see>
16138
16139 <result name="VBOX_E_INVALID_VM_STATE">
16140 Virtual machine is not mutable.
16141 </result>
16142 <result name="E_INVALIDARG">
16143 USB device filter list empty or invalid @a position.
16144 </result>
16145
16146 </desc>
16147 <param name="position" type="unsigned long" dir="in">
16148 <desc>Position to remove the filter from.</desc>
16149 </param>
16150 <param name="filter" type="IUSBDeviceFilter" dir="return">
16151 <desc>Removed USB device filter.</desc>
16152 </param>
16153 </method>
16154
16155 </interface>
16156
16157
16158 <!--
16159 // IUSBDevice
16160 /////////////////////////////////////////////////////////////////////////
16161 -->
16162
16163 <interface
16164 name="IUSBDevice" extends="$unknown"
16165 uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
16166 wsmap="managed"
16167 >
16168 <desc>
16169 The IUSBDevice interface represents a virtual USB device attached to the
16170 virtual machine.
16171
16172 A collection of objects implementing this interface is stored in the
16173 <link to="IConsole::USBDevices"/> attribute which lists all USB devices
16174 attached to a running virtual machine's USB controller.
16175 </desc>
16176
16177 <attribute name="id" type="uuid" mod="string" readonly="yes">
16178 <desc>
16179 Unique USB device ID. This ID is built from #vendorId,
16180 #productId, #revision and #serialNumber.
16181 </desc>
16182 </attribute>
16183
16184 <attribute name="vendorId" type="unsigned short" readonly="yes">
16185 <desc>Vendor ID.</desc>
16186 </attribute>
16187
16188 <attribute name="productId" type="unsigned short" readonly="yes">
16189 <desc>Product ID.</desc>
16190 </attribute>
16191
16192 <attribute name="revision" type="unsigned short" readonly="yes">
16193 <desc>
16194 Product revision number. This is a packed BCD represented as
16195 unsigned short. The high byte is the integer part and the low
16196 byte is the decimal.
16197 </desc>
16198 </attribute>
16199
16200 <attribute name="manufacturer" type="wstring" readonly="yes">
16201 <desc>Manufacturer string.</desc>
16202 </attribute>
16203
16204 <attribute name="product" type="wstring" readonly="yes">
16205 <desc>Product string.</desc>
16206 </attribute>
16207
16208 <attribute name="serialNumber" type="wstring" readonly="yes">
16209 <desc>Serial number string.</desc>
16210 </attribute>
16211
16212 <attribute name="address" type="wstring" readonly="yes">
16213 <desc>Host specific address of the device.</desc>
16214 </attribute>
16215
16216 <attribute name="port" type="unsigned short" readonly="yes">
16217 <desc>
16218 Host USB port number the device is physically
16219 connected to.
16220 </desc>
16221 </attribute>
16222
16223 <attribute name="version" type="unsigned short" readonly="yes">
16224 <desc>
16225 The major USB version of the device - 1 or 2.
16226 </desc>
16227 </attribute>
16228
16229 <attribute name="portVersion" type="unsigned short" readonly="yes">
16230 <desc>
16231 The major USB version of the host USB port the device is
16232 physically connected to - 1 or 2. For devices not connected to
16233 anything this will have the same value as the version attribute.
16234 </desc>
16235 </attribute>
16236
16237 <attribute name="remote" type="boolean" readonly="yes">
16238 <desc>
16239 Whether the device is physically connected to a remote VRDE
16240 client or to a local host machine.
16241 </desc>
16242 </attribute>
16243
16244 </interface>
16245
16246
16247 <!--
16248 // IUSBDeviceFilter
16249 /////////////////////////////////////////////////////////////////////////
16250 -->
16251
16252 <interface
16253 name="IUSBDeviceFilter" extends="$unknown"
16254 uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
16255 wsmap="managed"
16256 >
16257 <desc>
16258 The IUSBDeviceFilter interface represents an USB device filter used
16259 to perform actions on a group of USB devices.
16260
16261 This type of filters is used by running virtual machines to
16262 automatically capture selected USB devices once they are physically
16263 attached to the host computer.
16264
16265 A USB device is matched to the given device filter if and only if all
16266 attributes of the device match the corresponding attributes of the
16267 filter (that is, attributes are joined together using the logical AND
16268 operation). On the other hand, all together, filters in the list of
16269 filters carry the semantics of the logical OR operation. So if it is
16270 desirable to create a match like "this vendor id OR this product id",
16271 one needs to create two filters and specify "any match" (see below)
16272 for unused attributes.
16273
16274 All filter attributes used for matching are strings. Each string
16275 is an expression representing a set of values of the corresponding
16276 device attribute, that will match the given filter. Currently, the
16277 following filtering expressions are supported:
16278
16279 <ul>
16280 <li><i>Interval filters</i>. Used to specify valid intervals for
16281 integer device attributes (Vendor ID, Product ID and Revision).
16282 The format of the string is:
16283
16284 <tt>int:((m)|([m]-[n]))(,(m)|([m]-[n]))*</tt>
16285
16286 where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
16287 (starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
16288 or decimal (otherwise) form, so that <tt>m &lt; n</tt>. If <tt>m</tt>
16289 is omitted before a dash (<tt>-</tt>), the minimum possible integer
16290 is assumed; if <tt>n</tt> is omitted after a dash, the maximum
16291 possible integer is assumed.
16292 </li>
16293 <li><i>Boolean filters</i>. Used to specify acceptable values for
16294 boolean device attributes. The format of the string is:
16295
16296 <tt>true|false|yes|no|0|1</tt>
16297
16298 </li>
16299 <li><i>Exact match</i>. Used to specify a single value for the given
16300 device attribute. Any string that doesn't start with <tt>int:</tt>
16301 represents the exact match. String device attributes are compared to
16302 this string including case of symbols. Integer attributes are first
16303 converted to a string (see individual filter attributes) and then
16304 compared ignoring case.
16305
16306 </li>
16307 <li><i>Any match</i>. Any value of the corresponding device attribute
16308 will match the given filter. An empty or @c null string is
16309 used to construct this type of filtering expressions.
16310
16311 </li>
16312 </ul>
16313
16314 <note>
16315 On the Windows host platform, interval filters are not currently
16316 available. Also all string filter attributes
16317 (<link to="#manufacturer"/>, <link to="#product"/>,
16318 <link to="#serialNumber"/>) are ignored, so they behave as
16319 <i>any match</i> no matter what string expression is specified.
16320 </note>
16321
16322 <see><link to="IUSBController::deviceFilters"/>,
16323 <link to="IHostUSBDeviceFilter"/></see>
16324 </desc>
16325
16326 <attribute name="name" type="wstring">
16327 <desc>
16328 Visible name for this filter.
16329 This name is used to visually distinguish one filter from another,
16330 so it can neither be @c null nor an empty string.
16331 </desc>
16332 </attribute>
16333
16334 <attribute name="active" type="boolean">
16335 <desc>Whether this filter active or has been temporarily disabled.</desc>
16336 </attribute>
16337
16338 <attribute name="vendorId" type="wstring">
16339 <desc>
16340 <link to="IUSBDevice::vendorId">Vendor ID</link> filter.
16341 The string representation for the <i>exact matching</i>
16342 has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
16343 (including leading zeroes).
16344 </desc>
16345 </attribute>
16346
16347 <attribute name="productId" type="wstring">
16348 <desc>
16349 <link to="IUSBDevice::productId">Product ID</link> filter.
16350 The string representation for the <i>exact matching</i>
16351 has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
16352 (including leading zeroes).
16353 </desc>
16354 </attribute>
16355
16356 <attribute name="revision" type="wstring">
16357 <desc>
16358 <link to="IUSBDevice::productId">Product revision number</link>
16359 filter. The string representation for the <i>exact matching</i>
16360 has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
16361 of the integer part of the revision, and <tt>F</tt> is the
16362 decimal digit of its fractional part (including leading and
16363 trailing zeros).
16364 Note that for interval filters, it's best to use the hexadecimal
16365 form, because the revision is stored as a 16 bit packed BCD value;
16366 so the expression <tt>int:0x0100-0x0199</tt> will match any
16367 revision from <tt>1.0</tt> to <tt>1.99</tt>.
16368 </desc>
16369 </attribute>
16370
16371 <attribute name="manufacturer" type="wstring">
16372 <desc>
16373 <link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
16374 </desc>
16375 </attribute>
16376
16377 <attribute name="product" type="wstring">
16378 <desc>
16379 <link to="IUSBDevice::product">Product</link> filter.
16380 </desc>
16381 </attribute>
16382
16383 <attribute name="serialNumber" type="wstring">
16384 <desc>
16385 <link to="IUSBDevice::serialNumber">Serial number</link> filter.
16386 </desc>
16387 </attribute>
16388
16389 <attribute name="port" type="wstring">
16390 <desc>
16391 <link to="IUSBDevice::port">Host USB port</link> filter.
16392 </desc>
16393 </attribute>
16394
16395 <attribute name="remote" type="wstring">
16396 <desc>
16397 <link to="IUSBDevice::remote">Remote state</link> filter.
16398 <note>
16399 This filter makes sense only for machine USB filters,
16400 i.e. it is ignored by IHostUSBDeviceFilter objects.
16401 </note>
16402 </desc>
16403 </attribute>
16404
16405 <attribute name="maskedInterfaces" type="unsigned long">
16406 <desc>
16407 This is an advanced option for hiding one or more USB interfaces
16408 from the guest. The value is a bit mask where the bits that are set
16409 means the corresponding USB interface should be hidden, masked off
16410 if you like.
16411 This feature only works on Linux hosts.
16412 </desc>
16413 </attribute>
16414
16415 </interface>
16416
16417
16418 <!--
16419 // IHostUSBDevice
16420 /////////////////////////////////////////////////////////////////////////
16421 -->
16422
16423 <enum
16424 name="USBDeviceState"
16425 uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
16426 >
16427 <desc>
16428 USB device state. This enumeration represents all possible states
16429 of the USB device physically attached to the host computer regarding
16430 its state on the host computer and availability to guest computers
16431 (all currently running virtual machines).
16432
16433 Once a supported USB device is attached to the host, global USB
16434 filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
16435 either ignore the device, or put it to USBDeviceState_Held state, or do
16436 nothing. Unless the device is ignored by global filters, filters of all
16437 currently running guests (<link to="IUSBController::deviceFilters"/>) are
16438 activated that can put it to USBDeviceState_Captured state.
16439
16440 If the device was ignored by global filters, or didn't match
16441 any filters at all (including guest ones), it is handled by the host
16442 in a normal way. In this case, the device state is determined by
16443 the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
16444 or USBDeviceState_Available, depending on the current device usage.
16445
16446 Besides auto-capturing based on filters, the device can be manually
16447 captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
16448 state is USBDeviceState_Busy, USBDeviceState_Available or
16449 USBDeviceState_Held.
16450
16451 <note>
16452 Due to differences in USB stack implementations in Linux and Win32,
16453 states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
16454 only to the Linux version of the product. This also means that (<link
16455 to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
16456 device state is USBDeviceState_Held.
16457 </note>
16458
16459 <see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
16460 </desc>
16461
16462 <const name="NotSupported" value="0">
16463 <desc>
16464 Not supported by the VirtualBox server, not available to guests.
16465 </desc>
16466 </const>
16467 <const name="Unavailable" value="1">
16468 <desc>
16469 Being used by the host computer exclusively,
16470 not available to guests.
16471 </desc>
16472 </const>
16473 <const name="Busy" value="2">
16474 <desc>
16475 Being used by the host computer, potentially available to guests.
16476 </desc>
16477 </const>
16478 <const name="Available" value="3">
16479 <desc>
16480 Not used by the host computer, available to guests (the host computer
16481 can also start using the device at any time).
16482 </desc>
16483 </const>
16484 <const name="Held" value="4">
16485 <desc>
16486 Held by the VirtualBox server (ignored by the host computer),
16487 available to guests.
16488 </desc>
16489 </const>
16490 <const name="Captured" value="5">
16491 <desc>
16492 Captured by one of the guest computers, not available
16493 to anybody else.
16494 </desc>
16495 </const>
16496 </enum>
16497
16498 <interface
16499 name="IHostUSBDevice" extends="IUSBDevice"
16500 uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
16501 wsmap="managed"
16502 >
16503 <desc>
16504 The IHostUSBDevice interface represents a physical USB device attached
16505 to the host computer.
16506
16507 Besides properties inherited from IUSBDevice, this interface adds the
16508 <link to="#state"/> property that holds the current state of the USB
16509 device.
16510
16511 <see><link to="IHost::USBDevices"/>,
16512 <link to="IHost::USBDeviceFilters"/></see>
16513 </desc>
16514
16515 <attribute name="state" type="USBDeviceState" readonly="yes">
16516 <desc>
16517 Current state of the device.
16518 </desc>
16519 </attribute>
16520
16521 <!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
16522
16523 </interface>
16524
16525
16526 <!--
16527 // IHostUSBDeviceFilter
16528 /////////////////////////////////////////////////////////////////////////
16529 -->
16530
16531 <enum
16532 name="USBDeviceFilterAction"
16533 uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
16534 >
16535 <desc>
16536 Actions for host USB device filters.
16537 <see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
16538 </desc>
16539
16540 <const name="Null" value="0">
16541 <desc>Null value (never used by the API).</desc>
16542 </const>
16543 <const name="Ignore" value="1">
16544 <desc>Ignore the matched USB device.</desc>
16545 </const>
16546 <const name="Hold" value="2">
16547 <desc>Hold the matched USB device.</desc>
16548 </const>
16549 </enum>
16550
16551 <interface
16552 name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
16553 uuid="4cc70246-d74a-400f-8222-3900489c0374"
16554 wsmap="managed"
16555 >
16556 <desc>
16557 The IHostUSBDeviceFilter interface represents a global filter for a
16558 physical USB device used by the host computer. Used indirectly in
16559 <link to="IHost::USBDeviceFilters"/>.
16560
16561 Using filters of this type, the host computer determines the initial
16562 state of the USB device after it is physically attached to the
16563 host's USB controller.
16564
16565 <note>
16566 The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
16567 filters, because it makes sense only for
16568 <link to="IUSBController::deviceFilters">machine USB filters</link>.
16569 </note>
16570
16571 <see><link to="IHost::USBDeviceFilters"/></see>
16572 </desc>
16573
16574 <attribute name="action" type="USBDeviceFilterAction">
16575 <desc>
16576 Action performed by the host when an attached USB device
16577 matches this filter.
16578 </desc>
16579 </attribute>
16580
16581 </interface>
16582
16583 <!--
16584 // IAudioAdapter
16585 /////////////////////////////////////////////////////////////////////////
16586 -->
16587
16588 <enum
16589 name="AudioDriverType"
16590 uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
16591 >
16592 <desc>
16593 Host audio driver type.
16594 </desc>
16595
16596 <const name="Null" value="0">
16597 <desc>Null value, also means "dummy audio driver".</desc>
16598 </const>
16599 <const name="WinMM" value="1">
16600 <desc>Windows multimedia (Windows hosts only).</desc>
16601 </const>
16602 <const name="OSS" value="2">
16603 <desc>Open Sound System (Linux hosts only).</desc>
16604 </const>
16605 <const name="ALSA" value="3">
16606 <desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
16607 </const>
16608 <const name="DirectSound" value="4">
16609 <desc>DirectSound (Windows hosts only).</desc>
16610 </const>
16611 <const name="CoreAudio" value="5">
16612 <desc>CoreAudio (Mac hosts only).</desc>
16613 </const>
16614 <const name="MMPM" value="6">
16615 <desc>Reserved for historical reasons.</desc>
16616 </const>
16617 <const name="Pulse" value="7">
16618 <desc>PulseAudio (Linux hosts only).</desc>
16619 </const>
16620 <const name="SolAudio" value="8">
16621 <desc>Solaris audio (Solaris hosts only).</desc>
16622 </const>
16623 </enum>
16624
16625 <enum
16626 name="AudioControllerType"
16627 uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
16628 >
16629 <desc>
16630 Virtual audio controller type.
16631 </desc>
16632
16633 <const name="AC97" value="0"/>
16634 <const name="SB16" value="1"/>
16635 <const name="HDA" value="2"/>
16636 </enum>
16637
16638 <interface
16639 name="IAudioAdapter" extends="$unknown"
16640 uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
16641 wsmap="managed"
16642 >
16643 <desc>
16644 The IAudioAdapter interface represents the virtual audio adapter of
16645 the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
16646 </desc>
16647 <attribute name="enabled" type="boolean">
16648 <desc>
16649 Flag whether the audio adapter is present in the
16650 guest system. If disabled, the virtual guest hardware will
16651 not contain any audio adapter. Can only be changed when
16652 the VM is not running.
16653 </desc>
16654 </attribute>
16655 <attribute name="audioController" type="AudioControllerType">
16656 <desc>
16657 The audio hardware we emulate.
16658 </desc>
16659 </attribute>
16660 <attribute name="audioDriver" type="AudioDriverType">
16661 <desc>
16662 Audio driver the adapter is connected to. This setting
16663 can only be changed when the VM is not running.
16664 </desc>
16665 </attribute>
16666 </interface>
16667
16668 <enum
16669 name="AuthType"
16670 uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
16671 >
16672 <desc>
16673 VirtualBox authentication type.
16674 </desc>
16675
16676 <const name="Null" value="0">
16677 <desc>Null value, also means "no authentication".</desc>
16678 </const>
16679 <const name="External" value="1"/>
16680 <const name="Guest" value="2"/>
16681 </enum>
16682
16683 <!--
16684 // IVRDEServer
16685 /////////////////////////////////////////////////////////////////////////
16686 -->
16687
16688 <interface
16689 name="IVRDEServer" extends="$unknown"
16690 uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
16691 wsmap="managed"
16692 >
16693 <attribute name="enabled" type="boolean">
16694 <desc>VRDE server status.</desc>
16695 </attribute>
16696
16697 <attribute name="authType" type="AuthType">
16698 <desc>VRDE authentication method.</desc>
16699 </attribute>
16700
16701 <attribute name="authTimeout" type="unsigned long">
16702 <desc>Timeout for guest authentication. Milliseconds.</desc>
16703 </attribute>
16704
16705 <attribute name="allowMultiConnection" type="boolean">
16706 <desc>
16707 Flag whether multiple simultaneous connections to the VM are permitted.
16708 Note that this will be replaced by a more powerful mechanism in the future.
16709 </desc>
16710 </attribute>
16711
16712 <attribute name="reuseSingleConnection" type="boolean">
16713 <desc>
16714 Flag whether the existing connection must be dropped and a new connection
16715 must be established by the VRDE server, when a new client connects in single
16716 connection mode.
16717 </desc>
16718 </attribute>
16719
16720 <attribute name="VRDEExtPack" type="wstring">
16721 <desc>
16722 The name of Extension Pack providing VRDE for this VM. Overrides
16723 <link to="ISystemProperties::defaultVRDEExtPack"/>.
16724 </desc>
16725 </attribute>
16726
16727 <attribute name="authLibrary" type="wstring">
16728 <desc>
16729 Library used for authentication of RDP clients by this VM. Overrides
16730 <link to="ISystemProperties::VRDEAuthLibrary"/>.
16731 </desc>
16732 </attribute>
16733
16734 <attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
16735 <desc>
16736 Array of names of properties, which are supported by this VRDE server.
16737 </desc>
16738 </attribute>
16739
16740 <method name="setVRDEProperty">
16741 <desc>
16742 Sets a VRDE specific property string.
16743
16744 If you pass @c null or empty string as a key @a value, the given @a key
16745 will be deleted.
16746
16747 </desc>
16748 <param name="key" type="wstring" dir="in">
16749 <desc>Name of the key to set.</desc>
16750 </param>
16751 <param name="value" type="wstring" dir="in">
16752 <desc>Value to assign to the key.</desc>
16753 </param>
16754 </method>
16755
16756 <method name="getVRDEProperty" const="yes">
16757 <desc>
16758 Returns a VRDE specific property string.
16759
16760 If the requested data @a key does not exist, this function will
16761 succeed and return an empty string in the @a value argument.
16762
16763 </desc>
16764 <param name="key" type="wstring" dir="in">
16765 <desc>Name of the key to get.</desc>
16766 </param>
16767 <param name="value" type="wstring" dir="return">
16768 <desc>Value of the requested key.</desc>
16769 </param>
16770 </method>
16771
16772 </interface>
16773
16774
16775 <!--
16776 // ISharedFolder
16777 /////////////////////////////////////////////////////////////////////////
16778 -->
16779
16780 <interface
16781 name="ISharedFolder" extends="$unknown"
16782 uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
16783 wsmap="struct"
16784 >
16785 <desc>
16786 The ISharedFolder interface represents a folder in the host computer's
16787 file system accessible from the guest OS running inside a virtual
16788 machine using an associated logical name.
16789
16790 There are three types of shared folders:
16791 <ul>
16792 <li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
16793 folders available to all virtual machines.</li>
16794 <li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
16795 VM-specific shared folders available to the given virtual machine at
16796 startup.</li>
16797 <li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
16798 VM-specific shared folders created in the session context (for
16799 example, when the virtual machine is running) and automatically
16800 discarded when the session is closed (the VM is powered off).</li>
16801 </ul>
16802
16803 Logical names of shared folders must be unique within the given scope
16804 (global, permanent or transient). However, they do not need to be unique
16805 across scopes. In this case, the definition of the shared folder in a
16806 more specific scope takes precedence over definitions in all other
16807 scopes. The order of precedence is (more specific to more general):
16808 <ol>
16809 <li>Transient definitions</li>
16810 <li>Permanent definitions</li>
16811 <li>Global definitions</li>
16812 </ol>
16813
16814 For example, if MyMachine has a shared folder named
16815 <tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
16816 transient shared folder named <tt>C_DRIVE</tt> (that points
16817 to <tt>C:\\\\WINDOWS</tt>) will change the definition
16818 of <tt>C_DRIVE</tt> in the guest OS so
16819 that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
16820 to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
16821 PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
16822 the previous (permanent) definition of <tt>C_DRIVE</tt> that points
16823 to <tt>C:\\</tt> if it still exists.
16824
16825 Note that permanent and transient shared folders of different machines
16826 are in different name spaces, so they don't overlap and don't need to
16827 have unique logical names.
16828
16829 <note>
16830 Global shared folders are not implemented in the current version of the
16831 product.
16832 </note>
16833 </desc>
16834
16835 <attribute name="name" type="wstring" readonly="yes">
16836 <desc>Logical name of the shared folder.</desc>
16837 </attribute>
16838
16839 <attribute name="hostPath" type="wstring" readonly="yes">
16840 <desc>Full path to the shared folder in the host file system.</desc>
16841 </attribute>
16842
16843 <attribute name="accessible" type="boolean" readonly="yes">
16844 <desc>
16845 Whether the folder defined by the host path is currently
16846 accessible or not.
16847 For example, the folder can be inaccessible if it is placed
16848 on the network share that is not available by the time
16849 this property is read.
16850 </desc>
16851 </attribute>
16852
16853 <attribute name="writable" type="boolean" readonly="yes">
16854 <desc>
16855 Whether the folder defined by the host path is writable or
16856 not.
16857 </desc>
16858 </attribute>
16859
16860 <attribute name="autoMount" type="boolean" readonly="yes">
16861 <desc>
16862 Whether the folder gets automatically mounted by the guest or not.
16863 </desc>
16864 </attribute>
16865
16866 <attribute name="lastAccessError" type="wstring" readonly="yes">
16867 <desc>
16868 Text message that represents the result of the last accessibility
16869 check.
16870
16871 Accessibility checks are performed each time the <link to="#accessible"/>
16872 attribute is read. An empty string is returned if the last
16873 accessibility check was successful. A non-empty string indicates a
16874 failure and should normally describe a reason of the failure (for
16875 example, a file read error).
16876 </desc>
16877 </attribute>
16878
16879 </interface>
16880
16881 <!--
16882 // ISession
16883 /////////////////////////////////////////////////////////////////////////
16884 -->
16885
16886 <interface
16887 name="IInternalSessionControl" extends="$unknown"
16888 uuid="3e83963a-1c3b-400d-8c5f-f2d077b0a597"
16889 internal="yes"
16890 wsmap="suppress"
16891 >
16892 <method name="getPID">
16893 <desc>PID of the process that has created this Session object.
16894 </desc>
16895 <param name="pid" type="unsigned long" dir="return"/>
16896 </method>
16897
16898 <method name="getRemoteConsole">
16899 <desc>
16900 Returns the console object suitable for remote control.
16901
16902 <result name="VBOX_E_INVALID_VM_STATE">
16903 Session state prevents operation.
16904 </result>
16905 <result name="VBOX_E_INVALID_OBJECT_STATE">
16906 Session type prevents operation.
16907 </result>
16908
16909 </desc>
16910 <param name="console" type="IConsole" dir="return"/>
16911 </method>
16912
16913 <method name="assignMachine">
16914 <desc>
16915 Assigns the machine object associated with this direct-type
16916 session or informs the session that it will be a remote one
16917 (if @a machine == @c null).
16918
16919 <result name="VBOX_E_INVALID_VM_STATE">
16920 Session state prevents operation.
16921 </result>
16922 <result name="VBOX_E_INVALID_OBJECT_STATE">
16923 Session type prevents operation.
16924 </result>
16925
16926 </desc>
16927 <param name="machine" type="IMachine" dir="in"/>
16928 <param name="lockType" type="LockType" dir="in"/>
16929 </method>
16930
16931 <method name="assignRemoteMachine">
16932 <desc>
16933 Assigns the machine and the (remote) console object associated with
16934 this remote-type session.
16935
16936 <result name="VBOX_E_INVALID_VM_STATE">
16937 Session state prevents operation.
16938 </result>
16939
16940 </desc>
16941 <param name="machine" type="IMachine" dir="in"/>
16942 <param name="console" type="IConsole" dir="in"/>
16943 </method>
16944
16945 <method name="updateMachineState">
16946 <desc>
16947 Updates the machine state in the VM process.
16948 Must be called only in certain cases
16949 (see the method implementation).
16950
16951 <result name="VBOX_E_INVALID_VM_STATE">
16952 Session state prevents operation.
16953 </result>
16954 <result name="VBOX_E_INVALID_OBJECT_STATE">
16955 Session type prevents operation.
16956 </result>
16957
16958 </desc>
16959 <param name="aMachineState" type="MachineState" dir="in"/>
16960 </method>
16961
16962 <method name="uninitialize">
16963 <desc>
16964 Uninitializes (closes) this session. Used by VirtualBox to close
16965 the corresponding remote session when the direct session dies
16966 or gets closed.
16967
16968 <result name="VBOX_E_INVALID_VM_STATE">
16969 Session state prevents operation.
16970 </result>
16971
16972 </desc>
16973 </method>
16974
16975 <method name="onNetworkAdapterChange">
16976 <desc>
16977 Triggered when settings of a network adapter of the
16978 associated virtual machine have changed.
16979
16980 <result name="VBOX_E_INVALID_VM_STATE">
16981 Session state prevents operation.
16982 </result>
16983 <result name="VBOX_E_INVALID_OBJECT_STATE">
16984 Session type prevents operation.
16985 </result>
16986
16987 </desc>
16988 <param name="networkAdapter" type="INetworkAdapter" dir="in"/>
16989 <param name="changeAdapter" type="boolean" dir="in"/>
16990 </method>
16991
16992 <method name="onSerialPortChange">
16993 <desc>
16994 Triggered when settings of a serial port of the
16995 associated virtual machine have changed.
16996
16997 <result name="VBOX_E_INVALID_VM_STATE">
16998 Session state prevents operation.
16999 </result>
17000 <result name="VBOX_E_INVALID_OBJECT_STATE">
17001 Session type prevents operation.
17002 </result>
17003
17004 </desc>
17005 <param name="serialPort" type="ISerialPort" dir="in"/>
17006 </method>
17007
17008 <method name="onParallelPortChange">
17009 <desc>
17010 Triggered when settings of a parallel port of the
17011 associated virtual machine have changed.
17012
17013 <result name="VBOX_E_INVALID_VM_STATE">
17014 Session state prevents operation.
17015 </result>
17016 <result name="VBOX_E_INVALID_OBJECT_STATE">
17017 Session type prevents operation.
17018 </result>
17019
17020 </desc>
17021 <param name="parallelPort" type="IParallelPort" dir="in"/>
17022 </method>
17023
17024 <method name="onStorageControllerChange">
17025 <desc>
17026 Triggered when settings of a storage controller of the
17027 associated virtual machine have changed.
17028
17029 <result name="VBOX_E_INVALID_VM_STATE">
17030 Session state prevents operation.
17031 </result>
17032 <result name="VBOX_E_INVALID_OBJECT_STATE">
17033 Session type prevents operation.
17034 </result>
17035
17036 </desc>
17037 </method>
17038
17039 <method name="onMediumChange">
17040 <desc>
17041 Triggered when attached media of the
17042 associated virtual machine have changed.
17043
17044 <result name="VBOX_E_INVALID_VM_STATE">
17045 Session state prevents operation.
17046 </result>
17047 <result name="VBOX_E_INVALID_OBJECT_STATE">
17048 Session type prevents operation.
17049 </result>
17050
17051 </desc>
17052
17053 <param name="mediumAttachment" type="IMediumAttachment" dir="in">
17054 <desc>The medium attachment which changed.</desc>
17055 </param>
17056 <param name="force" type="boolean" dir="in">
17057 <desc>If the medium change was forced.</desc>
17058 </param>
17059 </method>
17060
17061 <method name="onStorageDeviceChange">
17062 <desc>
17063 Triggered when attached storage devices of the
17064 associated virtual machine have changed.
17065
17066 <result name="VBOX_E_INVALID_VM_STATE">
17067 Session state prevents operation.
17068 </result>
17069 <result name="VBOX_E_INVALID_OBJECT_STATE">
17070 Session type prevents operation.
17071 </result>
17072
17073 </desc>
17074
17075 <param name="mediumAttachment" type="IMediumAttachment" dir="in">
17076 <desc>The medium attachment which changed.</desc>
17077 </param>
17078 <param name="remove" type="boolean" dir="in">
17079 <desc>TRUE if the device is removed, FALSE if it was added.</desc>
17080 </param>
17081 </method>
17082
17083 <method name="onClipboardModeChange">
17084 <desc>
17085 Notification when the shared clipboard mode changes.
17086 </desc>
17087 <param name="clipboardMode" type="ClipboardMode" dir="in">
17088 <desc>The new shared clipboard mode.</desc>
17089 </param>
17090 </method>
17091
17092 <method name="onDragAndDropModeChange">
17093 <desc>
17094 Notification when the drag'n'drop mode changes.
17095 </desc>
17096 <param name="dragAndDropMode" type="DragAndDropMode" dir="in">
17097 <desc>The new mode for drag'n'drop.</desc>
17098 </param>
17099 </method>
17100
17101 <method name="onCPUChange">
17102 <desc>
17103 Notification when a CPU changes.
17104 </desc>
17105 <param name="cpu" type="unsigned long" dir="in">
17106 <desc>The CPU which changed</desc>
17107 </param>
17108 <param name="add" type="boolean" dir="in">
17109 <desc>Flag whether the CPU was added or removed</desc>
17110 </param>
17111 </method>
17112
17113 <method name="onCPUExecutionCapChange">
17114 <desc>
17115 Notification when the CPU execution cap changes.
17116 </desc>
17117 <param name="executionCap" type="unsigned long" dir="in">
17118 <desc>The new CPU execution cap value. (1-100)</desc>
17119 </param>
17120 </method>
17121
17122 <method name="onVRDEServerChange">
17123 <desc>
17124 Triggered when settings of the VRDE server object of the
17125 associated virtual machine have changed.
17126
17127 <result name="VBOX_E_INVALID_VM_STATE">
17128 Session state prevents operation.
17129 </result>
17130 <result name="VBOX_E_INVALID_OBJECT_STATE">
17131 Session type prevents operation.
17132 </result>
17133
17134 </desc>
17135 <param name="restart" type="boolean" dir="in">
17136 <desc>Flag whether the server must be restarted</desc>
17137 </param>
17138 </method>
17139
17140 <method name="onUSBControllerChange">
17141 <desc>
17142 Triggered when settings of the USB controller object of the
17143 associated virtual machine have changed.
17144
17145 <result name="VBOX_E_INVALID_VM_STATE">
17146 Session state prevents operation.
17147 </result>
17148 <result name="VBOX_E_INVALID_OBJECT_STATE">
17149 Session type prevents operation.
17150 </result>
17151
17152 </desc>
17153 </method>
17154
17155 <method name="onSharedFolderChange">
17156 <desc>
17157 Triggered when a permanent (global or machine) shared folder has been
17158 created or removed.
17159 <note>
17160 We don't pass shared folder parameters in this notification because
17161 the order in which parallel notifications are delivered is not defined,
17162 therefore it could happen that these parameters were outdated by the
17163 time of processing this notification.
17164 </note>
17165
17166 <result name="VBOX_E_INVALID_VM_STATE">
17167 Session state prevents operation.
17168 </result>
17169 <result name="VBOX_E_INVALID_OBJECT_STATE">
17170 Session type prevents operation.
17171 </result>
17172
17173 </desc>
17174 <param name="global" type="boolean" dir="in"/>
17175 </method>
17176
17177 <method name="onUSBDeviceAttach">
17178 <desc>
17179 Triggered when a request to capture a USB device (as a result
17180 of matched USB filters or direct call to
17181 <link to="IConsole::attachUSBDevice"/>) has completed.
17182 A @c null @a error object means success, otherwise it
17183 describes a failure.
17184
17185 <result name="VBOX_E_INVALID_VM_STATE">
17186 Session state prevents operation.
17187 </result>
17188 <result name="VBOX_E_INVALID_OBJECT_STATE">
17189 Session type prevents operation.
17190 </result>
17191
17192 </desc>
17193 <param name="device" type="IUSBDevice" dir="in"/>
17194 <param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
17195 <param name="maskedInterfaces" type="unsigned long" dir="in"/>
17196 </method>
17197
17198 <method name="onUSBDeviceDetach">
17199 <desc>
17200 Triggered when a request to release the USB device (as a result
17201 of machine termination or direct call to
17202 <link to="IConsole::detachUSBDevice"/>) has completed.
17203 A @c null @a error object means success, otherwise it
17204 describes a failure.
17205
17206 <result name="VBOX_E_INVALID_VM_STATE">
17207 Session state prevents operation.
17208 </result>
17209 <result name="VBOX_E_INVALID_OBJECT_STATE">
17210 Session type prevents operation.
17211 </result>
17212
17213 </desc>
17214 <param name="id" type="uuid" mod="string" dir="in"/>
17215 <param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
17216 </method>
17217
17218 <method name="onShowWindow">
17219 <desc>
17220 Called by <link to="IMachine::canShowConsoleWindow"/> and by
17221 <link to="IMachine::showConsoleWindow"/> in order to notify
17222 console listeners
17223 <link to="ICanShowWindowEvent"/>
17224 and <link to="IShowWindowEvent"/>.
17225
17226 <result name="VBOX_E_INVALID_OBJECT_STATE">
17227 Session type prevents operation.
17228 </result>
17229
17230 </desc>
17231 <param name="check" type="boolean" dir="in"/>
17232 <param name="canShow" type="boolean" dir="out"/>
17233 <param name="winId" type="long long" dir="out"/>
17234 </method>
17235
17236 <method name="onBandwidthGroupChange">
17237 <desc>
17238 Notification when one of the bandwidth groups change.
17239 </desc>
17240 <param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
17241 <desc>The bandwidth group which changed.</desc>
17242 </param>
17243 </method>
17244
17245 <method name="accessGuestProperty">
17246 <desc>
17247 Called by <link to="IMachine::getGuestProperty"/> and by
17248 <link to="IMachine::setGuestProperty"/> in order to read and
17249 modify guest properties.
17250
17251 <result name="VBOX_E_INVALID_VM_STATE">
17252 Machine session is not open.
17253 </result>
17254 <result name="VBOX_E_INVALID_OBJECT_STATE">
17255 Session type is not direct.
17256 </result>
17257
17258 </desc>
17259 <param name="name" type="wstring" dir="in"/>
17260 <param name="value" type="wstring" dir="in"/>
17261 <param name="flags" type="wstring" dir="in"/>
17262 <param name="isSetter" type="boolean" dir="in"/>
17263 <param name="retValue" type="wstring" dir="out"/>
17264 <param name="retTimestamp" type="long long" dir="out"/>
17265 <param name="retFlags" type="wstring" dir="out"/>
17266 </method>
17267
17268 <method name="enumerateGuestProperties" const="yes">
17269 <desc>
17270 Return a list of the guest properties matching a set of patterns along
17271 with their values, time stamps and flags.
17272
17273 <result name="VBOX_E_INVALID_VM_STATE">
17274 Machine session is not open.
17275 </result>
17276 <result name="VBOX_E_INVALID_OBJECT_STATE">
17277 Session type is not direct.
17278 </result>
17279
17280 </desc>
17281 <param name="patterns" type="wstring" dir="in">
17282 <desc>
17283 The patterns to match the properties against as a comma-separated
17284 string. If this is empty, all properties currently set will be
17285 returned.
17286 </desc>
17287 </param>
17288 <param name="key" type="wstring" dir="out" safearray="yes">
17289 <desc>
17290 The key names of the properties returned.
17291 </desc>
17292 </param>
17293 <param name="value" type="wstring" dir="out" safearray="yes">
17294 <desc>
17295 The values of the properties returned. The array entries match the
17296 corresponding entries in the @a key array.
17297 </desc>
17298 </param>
17299 <param name="timestamp" type="long long" dir="out" safearray="yes">
17300 <desc>
17301 The time stamps of the properties returned. The array entries match
17302 the corresponding entries in the @a key array.
17303 </desc>
17304 </param>
17305 <param name="flags" type="wstring" dir="out" safearray="yes">
17306 <desc>
17307 The flags of the properties returned. The array entries match the
17308 corresponding entries in the @a key array.
17309 </desc>
17310 </param>
17311 </method>
17312
17313 <method name="onlineMergeMedium">
17314 <desc>
17315 Triggers online merging of a hard disk. Used internally when deleting
17316 a snapshot while a VM referring to the same hard disk chain is running.
17317
17318 <result name="VBOX_E_INVALID_VM_STATE">
17319 Machine session is not open.
17320 </result>
17321 <result name="VBOX_E_INVALID_OBJECT_STATE">
17322 Session type is not direct.
17323 </result>
17324
17325 </desc>
17326 <param name="mediumAttachment" type="IMediumAttachment" dir="in">
17327 <desc>The medium attachment to identify the medium chain.</desc>
17328 </param>
17329 <param name="sourceIdx" type="unsigned long" dir="in">
17330 <desc>The index of the source image in the chain.
17331 Redundant, but drastically reduces IPC.</desc>
17332 </param>
17333 <param name="targetIdx" type="unsigned long" dir="in">
17334 <desc>The index of the target image in the chain.
17335 Redundant, but drastically reduces IPC.</desc>
17336 </param>
17337 <param name="source" type="IMedium" dir="in">
17338 <desc>Merge source medium.</desc>
17339 </param>
17340 <param name="target" type="IMedium" dir="in">
17341 <desc>Merge target medium.</desc>
17342 </param>
17343 <param name="mergeForward" type="boolean" dir="in">
17344 <desc>Merge direction.</desc>
17345 </param>
17346 <param name="parentForTarget" type="IMedium" dir="in">
17347 <desc>For forward merges: new parent for target medium.</desc>
17348 </param>
17349 <param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
17350 <desc>For backward merges: list of media which need their parent UUID
17351 updated.</desc>
17352 </param>
17353 <param name="progress" type="IProgress" dir="in">
17354 <desc>
17355 Progress object for this operation.
17356 </desc>
17357 </param>
17358 </method>
17359
17360 <method name="enableVMMStatistics">
17361 <desc>
17362 Enables or disables collection of VMM RAM statistics.
17363
17364 <result name="VBOX_E_INVALID_VM_STATE">
17365 Machine session is not open.
17366 </result>
17367 <result name="VBOX_E_INVALID_OBJECT_STATE">
17368 Session type is not direct.
17369 </result>
17370
17371 </desc>
17372 <param name="enable" type="boolean" dir="in">
17373 <desc>True enables statistics collection.</desc>
17374 </param>
17375 </method>
17376
17377 </interface>
17378
17379 <interface
17380 name="ISession" extends="$unknown"
17381 uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
17382 wsmap="managed"
17383 >
17384 <desc>
17385 The ISession interface represents a client process and allows for locking
17386 virtual machines (represented by IMachine objects) to prevent conflicting
17387 changes to the machine.
17388
17389 Any caller wishing to manipulate a virtual machine needs to create a session
17390 object first, which lives in its own process space. Such session objects are
17391 then associated with <link to="IMachine" /> objects living in the VirtualBox
17392 server process to coordinate such changes.
17393
17394 There are two typical scenarios in which sessions are used:
17395
17396 <ul>
17397 <li>To alter machine settings or control a running virtual machine, one
17398 needs to lock a machine for a given session (client process) by calling
17399 <link to="IMachine::lockMachine"/>.
17400
17401 Whereas multiple sessions may control a running virtual machine, only
17402 one process can obtain a write lock on the machine to prevent conflicting
17403 changes. A write lock is also needed if a process wants to actually run a
17404 virtual machine in its own context, such as the VirtualBox GUI or
17405 VBoxHeadless front-ends. They must also lock a machine for their own
17406 sessions before they are allowed to power up the virtual machine.
17407
17408 As a result, no machine settings can be altered while another process is
17409 already using it, either because that process is modifying machine settings
17410 or because the machine is running.
17411 </li>
17412 <li>
17413 To start a VM using one of the existing VirtualBox front-ends (e.g. the
17414 VirtualBox GUI or VBoxHeadless), one would use
17415 <link to="IMachine::launchVMProcess"/>, which also takes a session object
17416 as its first parameter. This session then identifies the caller and lets the
17417 caller control the started machine (for example, pause machine execution or
17418 power it down) as well as be notified about machine execution state changes.
17419 </li>
17420 </ul>
17421
17422 How sessions objects are created in a client process depends on whether you use
17423 the Main API via COM or via the webservice:
17424
17425 <ul>
17426 <li>When using the COM API directly, an object of the Session class from the
17427 VirtualBox type library needs to be created. In regular COM C++ client code,
17428 this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
17429 This object will then act as a local session object in further calls to open
17430 a session.
17431 </li>
17432
17433 <li>In the webservice, the session manager (IWebsessionManager) instead creates
17434 a session object automatically whenever <link to="IWebsessionManager::logon" />
17435 is called. A managed object reference to that session object can be retrieved by
17436 calling <link to="IWebsessionManager::getSessionObject" />.
17437 </li>
17438 </ul>
17439 </desc>
17440
17441 <attribute name="state" type="SessionState" readonly="yes">
17442 <desc>Current state of this session.</desc>
17443 </attribute>
17444
17445 <attribute name="type" type="SessionType" readonly="yes">
17446 <desc>
17447 Type of this session. The value of this attribute is valid only
17448 if the session currently has a machine locked (i.e. its
17449 <link to="#state" /> is Locked), otherwise an error will be returned.
17450 </desc>
17451 </attribute>
17452
17453 <attribute name="machine" type="IMachine" readonly="yes">
17454 <desc>Machine object associated with this session.</desc>
17455 </attribute>
17456
17457 <attribute name="console" type="IConsole" readonly="yes">
17458 <desc>Console object associated with this session.</desc>
17459 </attribute>
17460
17461 <method name="unlockMachine">
17462 <desc>
17463 Unlocks a machine that was previously locked for the current session.
17464
17465 Calling this method is required every time a machine has been locked
17466 for a particular session using the <link to="IMachine::launchVMProcess" />
17467 or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
17468 the machine will be set to <link to="MachineState_Aborted" /> on the
17469 server, and changes made to the machine settings will be lost.
17470
17471 Generally, it is recommended to unlock all machines explicitly
17472 before terminating the application (regardless of the reason for
17473 the termination).
17474
17475 <note>
17476 Do not expect the session state (<link to="ISession::state" />
17477 to return to "Unlocked" immediately after you invoke this method,
17478 particularly if you have started a new VM process. The session
17479 state will automatically return to "Unlocked" once the VM is no
17480 longer executing, which can of course take a very long time.
17481 </note>
17482
17483 <result name="E_UNEXPECTED">
17484 Session is not locked.
17485 </result>
17486
17487 </desc>
17488 </method>
17489
17490 </interface>
17491
17492 <!--
17493 // IStorageController
17494 /////////////////////////////////////////////////////////////////////////
17495 -->
17496
17497 <enum
17498 name="StorageBus"
17499 uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
17500 >
17501 <desc>
17502 The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
17503 see <link to="IStorageController::bus" />.
17504 </desc>
17505 <const name="Null" value="0">
17506 <desc>@c null value. Never used by the API.</desc>
17507 </const>
17508 <const name="IDE" value="1"/>
17509 <const name="SATA" value="2"/>
17510 <const name="SCSI" value="3"/>
17511 <const name="Floppy" value="4"/>
17512 <const name="SAS" value="5"/>
17513 </enum>
17514
17515 <enum
17516 name="StorageControllerType"
17517 uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
17518 >
17519 <desc>
17520 The exact variant of storage controller hardware presented
17521 to the guest; see <link to="IStorageController::controllerType" />.
17522 </desc>
17523
17524 <const name="Null" value="0">
17525 <desc>@c null value. Never used by the API.</desc>
17526 </const>
17527 <const name="LsiLogic" value="1">
17528 <desc>A SCSI controller of the LsiLogic variant.</desc>
17529 </const>
17530 <const name="BusLogic" value="2">
17531 <desc>A SCSI controller of the BusLogic variant.</desc>
17532 </const>
17533 <const name="IntelAhci" value="3">
17534 <desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
17535 </const>
17536 <const name="PIIX3" value="4">
17537 <desc>An IDE controller of the PIIX3 variant.</desc>
17538 </const>
17539 <const name="PIIX4" value="5">
17540 <desc>An IDE controller of the PIIX4 variant.</desc>
17541 </const>
17542 <const name="ICH6" value="6">
17543 <desc>An IDE controller of the ICH6 variant.</desc>
17544 </const>
17545 <const name="I82078" value="7">
17546 <desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
17547 </const>
17548 <const name="LsiLogicSas" value="8">
17549 <desc>A variant of the LsiLogic controller using SAS.</desc>
17550 </const>
17551 </enum>
17552
17553 <enum
17554 name="ChipsetType"
17555 uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
17556 >
17557 <desc>
17558 Type of emulated chipset (mostly southbridge).
17559 </desc>
17560
17561 <const name="Null" value="0">
17562 <desc>@c null value. Never used by the API.</desc>
17563 </const>
17564 <const name="PIIX3" value="1">
17565 <desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
17566 </const>
17567 <const name="ICH9" value="2">
17568 <desc>A ICH9 (I/O Controller Hub) chipset.</desc>
17569 </const>
17570 </enum>
17571
17572 <interface
17573 name="IStorageController" extends="$unknown"
17574 uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
17575 wsmap="managed"
17576 >
17577 <desc>
17578 Represents a storage controller that is attached to a virtual machine
17579 (<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
17580 attached to storage controllers in a real computer, virtual drives
17581 (represented by <link to="IMediumAttachment" />) are attached to virtual
17582 storage controllers, represented by this interface.
17583
17584 As opposed to physical hardware, VirtualBox has a very generic concept
17585 of a storage controller, and for purposes of the Main API, all virtual
17586 storage is attached to virtual machines via instances of this interface.
17587 There are five types of such virtual storage controllers: IDE, SCSI, SATA,
17588 SAS and Floppy (see <link to="#bus" />). Depending on which of these four
17589 is used, certain sub-types may be available and can be selected in
17590 <link to="#controllerType" />.
17591
17592 Depending on these settings, the guest operating system might see
17593 significantly different virtual hardware.
17594 </desc>
17595
17596 <attribute name="name" type="wstring" readonly="yes">
17597 <desc>
17598 Name of the storage controller, as originally specified with
17599 <link to="IMachine::addStorageController" />. This then uniquely
17600 identifies this controller with other method calls such as
17601 <link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
17602 </desc>
17603 </attribute>
17604
17605 <attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
17606 <desc>
17607 Maximum number of devices which can be attached to one port.
17608 </desc>
17609 </attribute>
17610
17611 <attribute name="minPortCount" type="unsigned long" readonly="yes">
17612 <desc>
17613 Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
17614 </desc>
17615 </attribute>
17616
17617 <attribute name="maxPortCount" type="unsigned long" readonly="yes">
17618 <desc>
17619 Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
17620 </desc>
17621 </attribute>
17622
17623 <attribute name="instance" type="unsigned long">
17624 <desc>
17625 The instance number of the device in the running VM.
17626 </desc>
17627 </attribute>
17628
17629 <attribute name="portCount" type="unsigned long">
17630 <desc>
17631 The number of currently usable ports on the controller.
17632 The minimum and maximum number of ports for one controller are
17633 stored in <link to="IStorageController::minPortCount"/>
17634 and <link to="IStorageController::maxPortCount"/>.
17635 </desc>
17636 </attribute>
17637
17638 <attribute name="bus" type="StorageBus" readonly="yes">
17639 <desc>
17640 The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
17641 </desc>
17642 </attribute>
17643
17644 <attribute name="controllerType" type="StorageControllerType">
17645 <desc>
17646 The exact variant of storage controller hardware presented
17647 to the guest.
17648 Depending on this value, VirtualBox will provide a different
17649 virtual storage controller hardware to the guest.
17650 For SATA, SAS and floppy controllers, only one variant is
17651 available, but for IDE and SCSI, there are several.
17652
17653 For SCSI controllers, the default type is LsiLogic.
17654 </desc>
17655 </attribute>
17656
17657 <attribute name="useHostIOCache" type="boolean">
17658 <desc>
17659 If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
17660 caches and use synchronous file APIs on the host. This was the only option in the API before
17661 VirtualBox 3.2 and is still the default for IDE controllers.
17662
17663 If false, the host I/O cache will be disabled for image files attached to this storage controller.
17664 Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
17665 it possible to turn off the host I/O caches because the emulation can handle unaligned access to
17666 the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
17667 virtual machines are running at the same time to prevent I/O cache related hangs.
17668 This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
17669 </desc>
17670 </attribute>
17671
17672 <attribute name="bootable" type="boolean" readonly="yes">
17673 <desc>
17674 Returns whether it is possible to boot from disks attached to this controller.
17675 </desc>
17676 </attribute>
17677
17678 <method name="getIDEEmulationPort">
17679 <desc>
17680 Gets the corresponding port number which is emulated as an IDE device.
17681 Works only with SATA controllers.
17682
17683 <result name="E_INVALIDARG">
17684 The @a devicePosition is not in the range 0 to 3.
17685 </result>
17686 <result name="E_NOTIMPL">
17687 The storage controller type is not SATAIntelAhci.
17688 </result>
17689
17690 </desc>
17691 <param name="devicePosition" type="long" dir="in"/>
17692 <param name="portNumber" type="long" dir="return"/>
17693 </method>
17694
17695 <method name="setIDEEmulationPort">
17696 <desc>
17697 Sets the port number which is emulated as an IDE device.
17698 Works only with SATA controllers.
17699
17700 <result name="E_INVALIDARG">
17701 The @a devicePosition is not in the range 0 to 3 or the
17702 @a portNumber is not in the range 0 to 29.
17703 </result>
17704 <result name="E_NOTIMPL">
17705 The storage controller type is not SATAIntelAhci.
17706 </result>
17707
17708 </desc>
17709 <param name="devicePosition" type="long" dir="in"/>
17710 <param name="portNumber" type="long" dir="in"/>
17711 </method>
17712
17713 </interface>
17714
17715<if target="wsdl">
17716
17717 <!--
17718 // IManagedObjectRef
17719 /////////////////////////////////////////////////////////////////////////
17720 -->
17721
17722 <interface
17723 name="IManagedObjectRef" extends="$unknown"
17724 uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
17725 internal="yes"
17726 wsmap="managed"
17727 wscpp="hardcoded"
17728 >
17729 <desc>
17730 Managed object reference.
17731
17732 Only within the webservice, a managed object reference (which is really
17733 an opaque number) allows a webservice client to address an object
17734 that lives in the address space of the webservice server.
17735
17736 Behind each managed object reference, there is a COM object that lives
17737 in the webservice server's address space. The COM object is not freed
17738 until the managed object reference is released, either by an explicit
17739 call to <link to="IManagedObjectRef::release" /> or by logging off from
17740 the webservice (<link to="IWebsessionManager::logoff" />), which releases
17741 all objects created during the webservice session.
17742
17743 Whenever a method call of the VirtualBox API returns a COM object, the
17744 webservice representation of that method will instead return a
17745 managed object reference, which can then be used to invoke methods
17746 on that object.
17747 </desc>
17748
17749 <method name="getInterfaceName">
17750 <desc>
17751 Returns the name of the interface that this managed object represents,
17752 for example, "IMachine", as a string.
17753 </desc>
17754 <param name="return" type="wstring" dir="return"/>
17755 </method>
17756
17757 <method name="release">
17758 <desc>
17759 Releases this managed object reference and frees the resources that
17760 were allocated for it in the webservice server process. After calling
17761 this method, the identifier of the reference can no longer be used.
17762 </desc>
17763 </method>
17764
17765 </interface>
17766
17767 <!--
17768 // IWebsessionManager
17769 /////////////////////////////////////////////////////////////////////////
17770 -->
17771
17772 <interface
17773 name="IWebsessionManager" extends="$unknown"
17774 uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
17775 internal="yes"
17776 wsmap="global"
17777 wscpp="hardcoded"
17778 >
17779 <desc>
17780 Websession manager. This provides essential services
17781 to webservice clients.
17782 </desc>
17783 <method name="logon">
17784 <desc>
17785 Logs a new client onto the webservice and returns a managed object reference to
17786 the IVirtualBox instance, which the client can then use as a basis to further
17787 queries, since all calls to the VirtualBox API are based on the IVirtualBox
17788 interface, in one way or the other.
17789 </desc>
17790 <param name="username" type="wstring" dir="in"/>
17791 <param name="password" type="wstring" dir="in"/>
17792 <param name="return" type="IVirtualBox" dir="return"/>
17793 </method>
17794
17795 <method name="getSessionObject">
17796 <desc>
17797 Returns a managed object reference to the internal ISession object that was created
17798 for this web service session when the client logged on.
17799
17800 <see><link to="ISession"/></see>
17801 </desc>
17802 <param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17803 <param name="return" type="ISession" dir="return"/>
17804 </method>
17805
17806 <method name="logoff">
17807 <desc>
17808 Logs off the client who has previously logged on with <link to="IWebsessionManager::logon" />
17809 and destroys all resources associated with the session (most importantly, all
17810 managed objects created in the server while the session was active).
17811 </desc>
17812 <param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17813 </method>
17814
17815 </interface>
17816
17817</if>
17818
17819 <!--
17820 // IPerformanceCollector & friends
17821 /////////////////////////////////////////////////////////////////////////
17822 -->
17823
17824 <interface
17825 name="IPerformanceMetric" extends="$unknown"
17826 uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
17827 >
17828 <desc>
17829 The IPerformanceMetric interface represents parameters of the given
17830 performance metric.
17831 </desc>
17832
17833 <attribute name="metricName" type="wstring" readonly="yes">
17834 <desc>
17835 Name of the metric.
17836 </desc>
17837 </attribute>
17838
17839 <attribute name="object" type="$unknown" readonly="yes">
17840 <desc>
17841 Object this metric belongs to.
17842 </desc>
17843 </attribute>
17844
17845 <attribute name="description" type="wstring" readonly="yes">
17846 <desc>
17847 Textual description of the metric.
17848 </desc>
17849 </attribute>
17850
17851 <attribute name="period" type="unsigned long" readonly="yes">
17852 <desc>
17853 Time interval between samples, measured in seconds.
17854 </desc>
17855 </attribute>
17856
17857 <attribute name="count" type="unsigned long" readonly="yes">
17858 <desc>
17859 Number of recent samples retained by the performance collector for this
17860 metric.
17861
17862 When the collected sample count exceeds this number, older samples
17863 are discarded.
17864 </desc>
17865 </attribute>
17866
17867 <attribute name="unit" type="wstring" readonly="yes">
17868 <desc>
17869 Unit of measurement.
17870 </desc>
17871 </attribute>
17872
17873 <attribute name="minimumValue" type="long" readonly="yes">
17874 <desc>
17875 Minimum possible value of this metric.
17876 </desc>
17877 </attribute>
17878
17879 <attribute name="maximumValue" type="long" readonly="yes">
17880 <desc>
17881 Maximum possible value of this metric.
17882 </desc>
17883 </attribute>
17884 </interface>
17885
17886 <interface
17887 name="IPerformanceCollector" extends="$unknown"
17888 uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
17889 wsmap="managed"
17890 >
17891 <desc>
17892 The IPerformanceCollector interface represents a service that collects
17893 and stores performance metrics data.
17894
17895 Performance metrics are associated with objects of interfaces like IHost
17896 and IMachine. Each object has a distinct set of performance metrics. The
17897 set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
17898
17899 Metric data is collected at the specified intervals and is retained
17900 internally. The interval and the number of retained samples can be set
17901 with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
17902 and collection settings are not persistent, they are discarded as soon as
17903 VBoxSVC process terminates. Moreover, metric settings and data associated
17904 with a particular VM only exist while VM is running. They disappear as
17905 soon as VM shuts down. It is not possible to set up metrics for machines
17906 that are powered off. One needs to start VM first, then set up metric
17907 collection parameters.
17908
17909 Metrics are organized hierarchically, with each level separated by a
17910 slash (/) character. Generally, the scheme for metric names is like this:
17911
17912 <tt>Category/Metric[/SubMetric][:aggregation]</tt>
17913
17914 "Category/Metric" together form the base metric name. A base metric is
17915 the smallest unit for which a sampling interval and the number of
17916 retained samples can be set. Only base metrics can be enabled and
17917 disabled. All sub-metrics are collected when their base metric is
17918 collected. Collected values for any set of sub-metrics can be queried
17919 with <link to="IPerformanceCollector::queryMetricsData" />.
17920
17921 For example "CPU/Load/User:avg" metric name stands for the "CPU"
17922 category, "Load" metric, "User" submetric, "average" aggregate. An
17923 aggregate function is computed over all retained data. Valid aggregate
17924 functions are:
17925
17926 <ul>
17927 <li>avg -- average</li>
17928 <li>min -- minimum</li>
17929 <li>max -- maximum</li>
17930 </ul>
17931
17932 When setting up metric parameters, querying metric data, enabling or
17933 disabling metrics wildcards can be used in metric names to specify a
17934 subset of metrics. For example, to select all CPU-related metrics
17935 use <tt>CPU/*</tt>, all averages can be queried using <tt>*:avg</tt> and
17936 so on. To query metric values without aggregates <tt>*:</tt> can be used.
17937
17938 The valid names for base metrics are:
17939
17940 <ul>
17941 <li>CPU/Load</li>
17942 <li>CPU/MHz</li>
17943 <li>RAM/Usage</li>
17944 <li>RAM/VMM</li>
17945 </ul>
17946
17947 The general sequence for collecting and retrieving the metrics is:
17948 <ul>
17949 <li>
17950 Obtain an instance of IPerformanceCollector with
17951 <link to="IVirtualBox::performanceCollector" />
17952 </li>
17953 <li>
17954 Allocate and populate an array with references to objects the metrics
17955 will be collected for. Use references to IHost and IMachine objects.
17956 </li>
17957 <li>
17958 Allocate and populate an array with base metric names the data will
17959 be collected for.
17960 </li>
17961 <li>
17962 Call <link to="IPerformanceCollector::setupMetrics" />. From now on
17963 the metric data will be collected and stored.
17964 </li>
17965 <li>
17966 Wait for the data to get collected.
17967 </li>
17968 <li>
17969 Allocate and populate an array with references to objects the metric
17970 values will be queried for. You can re-use the object array used for
17971 setting base metrics.
17972 </li>
17973 <li>
17974 Allocate and populate an array with metric names the data will be
17975 collected for. Note that metric names differ from base metric names.
17976 </li>
17977 <li>
17978 Call <link to="IPerformanceCollector::queryMetricsData" />. The data
17979 that have been collected so far are returned. Note that the values
17980 are still retained internally and data collection continues.
17981 </li>
17982 </ul>
17983
17984 For an example of usage refer to the following files in VirtualBox SDK:
17985 <ul>
17986 <li>
17987 Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
17988 </li>
17989 <li>
17990 Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
17991 </li>
17992 </ul>
17993 </desc>
17994
17995 <attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
17996 <desc>
17997 Array of unique names of metrics.
17998
17999 This array represents all metrics supported by the performance
18000 collector. Individual objects do not necessarily support all of them.
18001 <link to="IPerformanceCollector::getMetrics"/> can be used to get the
18002 list of supported metrics for a particular object.
18003 </desc>
18004 </attribute>
18005
18006 <method name="getMetrics">
18007 <desc>
18008 Returns parameters of specified metrics for a set of objects.
18009 <note>
18010 @c Null metrics array means all metrics. @c Null object array means
18011 all existing objects.
18012 </note>
18013 </desc>
18014 <param name="metricNames" type="wstring" dir="in" safearray="yes">
18015 <desc>
18016 Metric name filter. Currently, only a comma-separated list of metrics
18017 is supported.
18018 </desc>
18019 </param>
18020 <param name="objects" type="$unknown" dir="in" safearray="yes">
18021 <desc>
18022 Set of objects to return metric parameters for.
18023 </desc>
18024 </param>
18025 <param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
18026 <desc>
18027 Array of returned metric parameters.
18028 </desc>
18029 </param>
18030 </method>
18031
18032 <method name="setupMetrics">
18033 <desc>
18034 Sets parameters of specified base metrics for a set of objects. Returns
18035 an array of <link to="IPerformanceMetric" /> describing the metrics
18036 have been affected.
18037 <note>
18038 @c Null or empty metric name array means all metrics. @c Null or
18039 empty object array means all existing objects. If metric name array
18040 contains a single element and object array contains many, the single
18041 metric name array element is applied to each object array element to
18042 form metric/object pairs.
18043 </note>
18044 </desc>
18045 <param name="metricNames" type="wstring" dir="in" safearray="yes">
18046 <desc>
18047 Metric name filter. Comma-separated list of metrics with wildcard
18048 support.
18049 </desc>
18050 </param>
18051 <param name="objects" type="$unknown" dir="in" safearray="yes">
18052 <desc>
18053 Set of objects to setup metric parameters for.
18054 </desc>
18055 </param>
18056 <param name="period" type="unsigned long" dir="in">
18057 <desc>
18058 Time interval in seconds between two consecutive samples of
18059 performance data.
18060 </desc>
18061 </param>
18062 <param name="count" type="unsigned long" dir="in">
18063 <desc>
18064 Number of samples to retain in performance data history. Older
18065 samples get discarded.
18066 </desc>
18067 </param>
18068 <param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
18069 <desc>
18070 Array of metrics that have been modified by the call to this method.
18071 </desc>
18072 </param>
18073 </method>
18074
18075 <method name="enableMetrics">
18076 <desc>
18077 Turns on collecting specified base metrics. Returns an array of
18078 <link to="IPerformanceMetric" /> describing the metrics have been
18079 affected.
18080 <note>
18081 @c Null or empty metric name array means all metrics. @c Null or
18082 empty object array means all existing objects. If metric name array
18083 contains a single element and object array contains many, the single
18084 metric name array element is applied to each object array element to
18085 form metric/object pairs.
18086 </note>
18087 </desc>
18088 <param name="metricNames" type="wstring" dir="in" safearray="yes">
18089 <desc>
18090 Metric name filter. Comma-separated list of metrics with wildcard
18091 support.
18092 </desc>
18093 </param>
18094 <param name="objects" type="$unknown" dir="in" safearray="yes">
18095 <desc>
18096 Set of objects to enable metrics for.
18097 </desc>
18098 </param>
18099 <param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
18100 <desc>
18101 Array of metrics that have been modified by the call to this method.
18102 </desc>
18103 </param>
18104 </method>
18105
18106 <method name="disableMetrics">
18107 <desc>
18108 Turns off collecting specified base metrics. Returns an array of
18109 <link to="IPerformanceMetric" /> describing the metrics have been
18110 affected.
18111 <note>
18112 @c Null or empty metric name array means all metrics. @c Null or
18113 empty object array means all existing objects. If metric name array
18114 contains a single element and object array contains many, the single
18115 metric name array element is applied to each object array element to
18116 form metric/object pairs.
18117 </note>
18118 </desc>
18119 <param name="metricNames" type="wstring" dir="in" safearray="yes">
18120 <desc>
18121 Metric name filter. Comma-separated list of metrics with wildcard
18122 support.
18123 </desc>
18124 </param>
18125 <param name="objects" type="$unknown" dir="in" safearray="yes">
18126 <desc>
18127 Set of objects to disable metrics for.
18128 </desc>
18129 </param>
18130 <param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
18131 <desc>
18132 Array of metrics that have been modified by the call to this method.
18133 </desc>
18134 </param>
18135 </method>
18136
18137 <method name="queryMetricsData">
18138 <desc>
18139 Queries collected metrics data for a set of objects.
18140
18141 The data itself and related metric information are returned in seven
18142 parallel and one flattened array of arrays. Elements of
18143 <tt>returnMetricNames, returnObjects, returnUnits, returnScales,
18144 returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
18145 the same index describe one set of values corresponding to a single
18146 metric.
18147
18148 The <tt>returnData</tt> parameter is a flattened array of arrays. Each
18149 start and length of a sub-array is indicated by
18150 <tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
18151 value for metric <tt>metricNames[i]</tt> is at
18152 <tt>returnData[returnIndices[i]]</tt>.
18153
18154 <note>
18155 @c Null or empty metric name array means all metrics. @c Null or
18156 empty object array means all existing objects. If metric name array
18157 contains a single element and object array contains many, the single
18158 metric name array element is applied to each object array element to
18159 form metric/object pairs.
18160 </note>
18161 <note>
18162 Data collection continues behind the scenes after call to @c
18163 queryMetricsData. The return data can be seen as the snapshot of the
18164 current state at the time of @c queryMetricsData call. The internally
18165 kept metric values are not cleared by the call. This makes possible
18166 querying different subsets of metrics or aggregates with subsequent
18167 calls. If periodic querying is needed it is highly suggested to query
18168 the values with @c interval*count period to avoid confusion. This way
18169 a completely new set of data values will be provided by each query.
18170 </note>
18171 </desc>
18172 <param name="metricNames" type="wstring" dir="in" safearray="yes">
18173 <desc>
18174 Metric name filter. Comma-separated list of metrics with wildcard
18175 support.
18176 </desc>
18177 </param>
18178 <param name="objects" type="$unknown" dir="in" safearray="yes">
18179 <desc>
18180 Set of objects to query metrics for.
18181 </desc>
18182 </param>
18183 <param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
18184 <desc>
18185 Names of metrics returned in @c returnData.
18186 </desc>
18187 </param>
18188 <param name="returnObjects" type="$unknown" dir="out" safearray="yes">
18189 <desc>
18190 Objects associated with metrics returned in @c returnData.
18191 </desc>
18192 </param>
18193 <param name="returnUnits" type="wstring" dir="out" safearray="yes">
18194 <desc>
18195 Units of measurement for each returned metric.
18196 </desc>
18197 </param>
18198 <param name="returnScales" type="unsigned long" dir="out" safearray="yes">
18199 <desc>
18200 Divisor that should be applied to return values in order to get
18201 floating point values. For example:
18202 <tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
18203 will retrieve the floating point value of i-th sample of the first
18204 metric.
18205 </desc>
18206 </param>
18207 <param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
18208 <desc>
18209 Sequence numbers of the first elements of value sequences of
18210 particular metrics returned in @c returnData. For aggregate metrics
18211 it is the sequence number of the sample the aggregate started
18212 calculation from.
18213 </desc>
18214 </param>
18215 <param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
18216 <desc>
18217 Indices of the first elements of value sequences of particular
18218 metrics returned in @c returnData.
18219 </desc>
18220 </param>
18221 <param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
18222 <desc>
18223 Lengths of value sequences of particular metrics.
18224 </desc>
18225 </param>
18226 <param name="returnData" type="long" dir="return" safearray="yes">
18227 <desc>
18228 Flattened array of all metric data containing sequences of values for
18229 each metric.
18230 </desc>
18231 </param>
18232 </method>
18233
18234 </interface>
18235
18236 <enum
18237 name="NATAliasMode"
18238 uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
18239 >
18240 <desc></desc>
18241 <const name="AliasLog" value="0x1">
18242 <desc></desc>
18243 </const>
18244 <const name="AliasProxyOnly" value="0x02">
18245 <desc></desc>
18246 </const>
18247 <const name="AliasUseSamePorts" value="0x04">
18248 <desc></desc>
18249 </const>
18250 </enum>
18251
18252 <enum
18253 name="NATProtocol"
18254 uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
18255 >
18256 <desc>Protocol definitions used with NAT port-forwarding rules.</desc>
18257 <const name="UDP" value="0">
18258 <desc>Port-forwarding uses UDP protocol.</desc>
18259 </const>
18260 <const name="TCP" value="1">
18261 <desc>Port-forwarding uses TCP protocol.</desc>
18262 </const>
18263 </enum>
18264
18265 <interface
18266 name="INATEngine" extends="$unknown"
18267 uuid="26451b99-3b2d-4dcb-8e4b-d63654218175"
18268 wsmap="managed"
18269 >
18270 <desc>Interface for managing a NAT engine which is used with a virtual machine. This
18271 allows for changing NAT behavior such as port-forwarding rules. This interface is
18272 used in the <link to="INetworkAdapter::NATEngine" /> attribute.</desc>
18273 <attribute name="network" type="wstring">
18274 <desc>The network attribute of the NAT engine (the same value is used with built-in
18275 DHCP server to fill corresponding fields of DHCP leases).</desc>
18276 </attribute>
18277 <attribute name="hostIP" type="wstring">
18278 <desc>IP of host interface to bind all opened sockets to.
18279 <note>Changing this does not change binding of port forwarding.</note>
18280 </desc>
18281 </attribute>
18282 <attribute name="TFTPPrefix" type="wstring">
18283 <desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
18284 the corresponding fields of DHCP leases.</desc>
18285 </attribute>
18286 <attribute name="TFTPBootFile" type="wstring">
18287 <desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
18288 the corresponding fields of DHCP leases.</desc>
18289 </attribute>
18290 <attribute name="TFTPNextServer" type="wstring">
18291 <desc>TFTP server attribute which is used with the built-in DHCP server to fill
18292 the corresponding fields of DHCP leases.
18293 <note>The preferred form is IPv4 addresses.</note>
18294 </desc>
18295 </attribute>
18296 <attribute name="aliasMode" type="unsigned long">
18297 <desc></desc>
18298 </attribute>
18299 <attribute name="DNSPassDomain" type="boolean">
18300 <desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
18301 </attribute>
18302 <attribute name="DNSProxy" type="boolean">
18303 <desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
18304 of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
18305 </attribute>
18306 <attribute name="DNSUseHostResolver" type="boolean">
18307 <desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
18308 of the DNS proxy and process traffic using the host resolver mechanism.</desc>
18309 </attribute>
18310 <attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
18311 <desc>Array of NAT port-forwarding rules in string representation, in the following
18312 format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
18313 </attribute>
18314 <method name="setNetworkSettings">
18315 <desc>Sets network configuration of the NAT engine.</desc>
18316 <param name="mtu" type="unsigned long" dir="in">
18317 <desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
18318 </param>
18319 <param name="sockSnd" type="unsigned long" dir="in">
18320 <desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
18321 </param>
18322 <param name="sockRcv" type="unsigned long" dir="in">
18323 <desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
18324 </param>
18325 <param name="TcpWndSnd" type="unsigned long" dir="in">
18326 <desc>Initial size of the NAT engine's sending TCP window in bytes when
18327 establishing a new TCP connection.</desc>
18328 </param>
18329 <param name="TcpWndRcv" type="unsigned long" dir="in">
18330 <desc>Initial size of the NAT engine's receiving TCP window in bytes when
18331 establishing a new TCP connection.</desc>
18332 </param>
18333 </method>
18334 <method name="getNetworkSettings">
18335 <desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
18336 for parameter descriptions.</desc>
18337 <param name="mtu" type="unsigned long" dir="out" />
18338 <param name="sockSnd" type="unsigned long" dir="out" />
18339 <param name="sockRcv" type="unsigned long" dir="out" />
18340 <param name="TcpWndSnd" type="unsigned long" dir="out" />
18341 <param name="TcpWndRcv" type="unsigned long" dir="out" />
18342 </method>
18343 <method name="addRedirect">
18344 <desc>Adds a new NAT port-forwarding rule.</desc>
18345 <param name="name" type="wstring" dir="in">
18346 <desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
18347 auto-generates one using the other parameters.</desc>
18348 </param>
18349 <param name="proto" type="NATProtocol" dir="in">
18350 <desc>Protocol handled with the rule.</desc>
18351 </param>
18352 <param name="hostIP" type="wstring" dir="in">
18353 <desc>IP of the host interface to which the rule should apply. An empty ip address is
18354 acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
18355 </param>
18356 <param name="hostPort" type="unsigned short" dir="in">
18357 <desc>The port number to listen on.</desc>
18358 </param>
18359 <param name="guestIP" type="wstring" dir="in">
18360 <desc>The IP address of the guest which the NAT engine will forward matching packets
18361 to. An empty IP address is acceptable, in which case the NAT engine will forward
18362 packets to the first DHCP lease (x.x.x.15).</desc>
18363 </param>
18364 <param name="guestPort" type="unsigned short" dir="in">
18365 <desc>The port number to forward.</desc>
18366 </param>
18367 </method>
18368 <method name="removeRedirect">
18369 <desc>Removes a port-forwarding rule that was previously registered.</desc>
18370 <param name="name" type="wstring" dir="in">
18371 <desc>The name of the rule to delete.</desc>
18372 </param>
18373 </method>
18374 </interface>
18375
18376 <!--
18377 // IExtPackManager
18378 /////////////////////////////////////////////////////////////////////////
18379 -->
18380
18381 <interface
18382 name="IExtPackPlugIn" extends="$unknown"
18383 uuid="58000040-e718-4746-bbce-4b86d96da461"
18384 wsmap="suppress"
18385 >
18386 <desc>
18387 Interface for keeping information about a plug-in that ships with an
18388 extension pack.
18389 </desc>
18390 <attribute name="name" type="wstring" readonly="yes">
18391 <desc>The plug-in name.</desc>
18392 </attribute>
18393 <attribute name="description" type="wstring" readonly="yes">
18394 <desc>The plug-in description.</desc>
18395 </attribute>
18396 <attribute name="frontend" type="wstring" readonly="yes">
18397 <desc>
18398 The name of the frontend or component name this plug-in plugs into.
18399 </desc>
18400 </attribute>
18401 <attribute name="modulePath" type="wstring" readonly="yes">
18402 <desc> The module path. </desc>
18403 </attribute>
18404 </interface>
18405
18406 <interface
18407 name="IExtPackBase" extends="$unknown"
18408 uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
18409 wsmap="suppress"
18410 >
18411 <desc>
18412 Interface for querying information about an extension pack as well as
18413 accessing COM objects within it.
18414 </desc>
18415 <attribute name="name" type="wstring" readonly="yes">
18416 <desc>The extension pack name. This is unique.</desc>
18417 </attribute>
18418 <attribute name="description" type="wstring" readonly="yes">
18419 <desc>The extension pack description.</desc>
18420 </attribute>
18421 <attribute name="version" type="wstring" readonly="yes">
18422 <desc>
18423 The extension pack version string. This is restricted to the dotted
18424 version number and optionally a build indicator. No tree revision or
18425 tag will be included in the string as those things are available as
18426 separate properties. An optional publisher tag may be present like for
18427 <link to="IVirtualBox::version"/>.
18428
18429 Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
18430 </desc>
18431 </attribute>
18432 <attribute name="revision" type="unsigned long" readonly="yes">
18433 <desc>The extension pack internal revision number.</desc>
18434 </attribute>
18435 <attribute name="edition" type="wstring" readonly="yes">
18436 <desc>
18437 Edition indicator. This is usually empty.
18438
18439 Can for instance be used to help distinguishing between two editions
18440 of the same extension pack where only the license, service contract or
18441 something differs.
18442 </desc>
18443 </attribute>
18444 <attribute name="VRDEModule" type="wstring" readonly="yes">
18445 <desc>The name of the VRDE module if the extension pack sports one.</desc>
18446 </attribute>
18447 <attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
18448 <desc>Plug-ins provided by this extension pack.</desc>
18449 </attribute>
18450 <attribute name="usable" type="boolean" readonly="yes">
18451 <desc>
18452 Indicates whether the extension pack is usable or not.
18453
18454 There are a number of reasons why an extension pack might be unusable,
18455 typical examples would be broken installation/file or that it is
18456 incompatible with the current VirtualBox version.
18457 </desc>
18458 </attribute>
18459 <attribute name="whyUnusable" type="wstring" readonly="yes">
18460 <desc>
18461 String indicating why the extension pack is not usable. This is an
18462 empty string if usable and always a non-empty string if not usable.
18463 </desc>
18464 </attribute>
18465 <attribute name="showLicense" type="boolean" readonly="yes">
18466 <desc>Whether to show the license before installation</desc>
18467 </attribute>
18468 <attribute name="license" type="wstring" readonly="yes">
18469 <desc>
18470 The default HTML license text for the extension pack. Same as
18471 calling <link to="#queryLicense">queryLicense</link> with
18472 preferredLocale and preferredLanguage as empty strings and format set
18473 to html.
18474 </desc>
18475 </attribute>
18476
18477 <method name="queryLicense">
18478 <desc>
18479 Full feature version of the license attribute.
18480 </desc>
18481 <param name="preferredLocale" type="wstring" dir="in">
18482 <desc>
18483 The preferred license locale. Pass an empty string to get the default
18484 license.
18485 </desc>
18486 </param>
18487 <param name="preferredLanguage" type="wstring" dir="in">
18488 <desc>
18489 The preferred license language. Pass an empty string to get the
18490 default language for the locale.
18491 </desc>
18492 </param>
18493 <param name="format" type="wstring" dir="in">
18494 <desc>
18495 The license format: html, rtf or txt. If a license is present there
18496 will always be an HTML of it, the rich text format (RTF) and plain
18497 text (txt) versions are optional. If
18498 </desc>
18499 </param>
18500 <param name="licenseText" type="wstring" dir="return">
18501 <desc>The license text.</desc>
18502 </param>
18503 </method>
18504
18505 </interface>
18506
18507 <interface
18508 name="IExtPack" extends="IExtPackBase"
18509 uuid="431685da-3618-4ebc-b038-833ba829b4b2"
18510 wsmap="suppress"
18511 >
18512 <desc>
18513 Interface for querying information about an extension pack as well as
18514 accessing COM objects within it.
18515 </desc>
18516 <method name="queryObject">
18517 <desc>
18518 Queries the IUnknown interface to an object in the extension pack
18519 main module. This allows plug-ins and others to talk directly to an
18520 extension pack.
18521 </desc>
18522 <param name="objUuid" type="wstring" dir="in">
18523 <desc>The object ID. What exactly this is </desc>
18524 </param>
18525 <param name="returnInterface" type="$unknown" dir="return">
18526 <desc>The queried interface.</desc>
18527 </param>
18528 </method>
18529 </interface>
18530
18531 <interface
18532 name="IExtPackFile" extends="IExtPackBase"
18533 uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
18534 wsmap="suppress"
18535 >
18536 <desc>
18537 Extension pack file (aka tarball, .vbox-extpack) representation returned
18538 by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
18539 extension pack information with the addition of the file name.
18540 </desc>
18541 <attribute name="filePath" type="wstring" readonly="yes">
18542 <desc>
18543 The path to the extension pack file.
18544 </desc>
18545 </attribute>
18546
18547 <method name="install">
18548 <desc>
18549 Install the extension pack.
18550 </desc>
18551 <param name="replace" type="boolean" dir="in">
18552 <desc>
18553 Set this to automatically uninstall any existing extension pack with
18554 the same name as the one being installed.
18555 </desc>
18556 </param>
18557 <param name="displayInfo" type="wstring" dir="in">
18558 <desc>
18559 Platform specific display information. Reserved for future hacks.
18560 </desc>
18561 </param>
18562 <param name="progess" type="IProgress" dir="return">
18563 <desc>
18564 Progress object for the operation.
18565 </desc>
18566 </param>
18567 </method>
18568 </interface>
18569
18570 <interface
18571 name="IExtPackManager" extends="$unknown"
18572 uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
18573 wsmap="suppress"
18574 >
18575 <desc>
18576 Interface for managing VirtualBox Extension Packs.
18577
18578 TODO: Describe extension packs, how they are managed and how to create
18579 one.
18580 </desc>
18581
18582 <attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
18583 <desc>
18584 List of the installed extension packs.
18585 </desc>
18586 </attribute>
18587
18588 <method name="find">
18589 <desc>
18590 Returns the extension pack with the specified name if found.
18591
18592 <result name="VBOX_E_OBJECT_NOT_FOUND">
18593 No extension pack matching @a name was found.
18594 </result>
18595 </desc>
18596 <param name="name" type="wstring" dir="in">
18597 <desc>The name of the extension pack to locate.</desc>
18598 </param>
18599 <param name="returnData" type="IExtPack" dir="return">
18600 <desc>The extension pack if found.</desc>
18601 </param>
18602 </method>
18603
18604 <method name="openExtPackFile">
18605 <desc>
18606 Attempts to open an extension pack file in preparation for
18607 installation.
18608 </desc>
18609 <param name="path" type="wstring" dir="in">
18610 <desc>The path of the extension pack tarball. This can optionally be
18611 followed by a "::SHA-256=hex-digit" of the tarball. </desc>
18612 </param>
18613 <param name="file" type="IExtPackFile" dir="return">
18614 <desc>The interface of the extension pack file object.</desc>
18615 </param>
18616 </method>
18617
18618 <method name="uninstall">
18619 <desc>Uninstalls an extension pack, removing all related files.</desc>
18620 <param name="name" type="wstring" dir="in">
18621 <desc>The name of the extension pack to uninstall.</desc>
18622 </param>
18623 <param name="forcedRemoval" type="boolean" dir="in">
18624 <desc>
18625 Forced removal of the extension pack. This means that the uninstall
18626 hook will not be called.
18627 </desc>
18628 </param>
18629 <param name="displayInfo" type="wstring" dir="in">
18630 <desc>
18631 Platform specific display information. Reserved for future hacks.
18632 </desc>
18633 </param>
18634 <param name="progess" type="IProgress" dir="return">
18635 <desc>
18636 Progress object for the operation.
18637 </desc>
18638 </param>
18639 </method>
18640
18641 <method name="cleanup">
18642 <desc>Cleans up failed installs and uninstalls</desc>
18643 </method>
18644
18645 <method name="queryAllPlugInsForFrontend">
18646 <desc>
18647 Gets the path to all the plug-in modules for a given frontend.
18648
18649 This is a convenience method that is intended to simplify the plug-in
18650 loading process for a frontend.
18651 </desc>
18652 <param name="frontendName" type="wstring" dir="in">
18653 <desc>The name of the frontend or component.</desc>
18654 </param>
18655 <param name="plugInModules" type="wstring" dir="return" safearray="yes">
18656 <desc>Array containing the plug-in modules (full paths).</desc>
18657 </param>
18658 </method>
18659
18660 <method name="isExtPackUsable">
18661 <desc>Check if the given extension pack is loaded and usable.</desc>
18662 <param name="name" type="wstring" dir="in">
18663 <desc>The name of the extension pack to check for.</desc>
18664 </param>
18665 <param name="usable" type="boolean" dir="return">
18666 <desc>Is the given extension pack loaded and usable.</desc>
18667 </param>
18668 </method>
18669
18670 </interface>
18671
18672 <!--
18673 // BandwidthGroupType
18674 /////////////////////////////////////////////////////////////////////////
18675 -->
18676 <enum
18677 name="BandwidthGroupType"
18678 uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
18679
18680 <desc>
18681 Type of a bandwidth control group.
18682 </desc>
18683
18684 <const name="Null" value="0">
18685 <desc>
18686 Null type, must be first.
18687 </desc>
18688 </const>
18689
18690 <const name="Disk" value="1">
18691 <desc>
18692 The bandwidth group controls disk I/O.
18693 </desc>
18694 </const>
18695
18696 <const name="Network" value="2">
18697 <desc>
18698 The bandwidth group controls network I/O.
18699 </desc>
18700 </const>
18701
18702 </enum>
18703
18704 <!--
18705 // IBandwidthGroup
18706 /////////////////////////////////////////////////////////////////////////
18707 -->
18708 <interface
18709 name="IBandwidthGroup" extends="$unknown"
18710 uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
18711 wsmap="managed"
18712 >
18713 <desc>Represents one bandwidth group.</desc>
18714
18715 <attribute name="name" type="wstring" readonly="yes">
18716 <desc>Name of the group.</desc>
18717 </attribute>
18718
18719 <attribute name="type" type="BandwidthGroupType" readonly="yes">
18720 <desc>Type of the group.</desc>
18721 </attribute>
18722
18723 <attribute name="reference" type="unsigned long" readonly="yes">
18724 <desc>How many devices/medium attachements use this group.</desc>
18725 </attribute>
18726
18727 <attribute name="maxBytesPerSec" type="long long">
18728 <desc>The maximum number of bytes which can be transfered by all
18729 entities attached to this group during one second.</desc>
18730 </attribute>
18731
18732 </interface>
18733
18734 <!--
18735 // IBandwidthControl
18736 /////////////////////////////////////////////////////////////////////////
18737 -->
18738 <interface
18739 name="IBandwidthControl" extends="$unknown"
18740 uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
18741 wsmap="managed"
18742 >
18743 <desc>
18744 Controls the bandwidth groups of one machine used to cap I/O done by a VM.
18745 This includes network and disk I/O.
18746 </desc>
18747
18748 <attribute name="numGroups" type="unsigned long" readonly="yes">
18749 <desc>
18750 The current number of existing bandwidth groups managed.
18751 </desc>
18752 </attribute>
18753
18754 <method name="createBandwidthGroup">
18755 <desc>
18756 Creates a new bandwidth group.
18757 </desc>
18758
18759 <param name="name" type="wstring" dir="in">
18760 <desc>Name of the bandwidth group.</desc>
18761 </param>
18762 <param name="type" type="BandwidthGroupType" dir="in">
18763 <desc>The type of the bandwidth group (network or disk).</desc>
18764 </param>
18765 <param name="maxBytesPerSec" type="long long" dir="in">
18766 <desc>The maximum number of bytes which can be transfered by all
18767 entities attached to this group during one second.</desc>
18768 </param>
18769 </method>
18770
18771 <method name="deleteBandwidthGroup">
18772 <desc>
18773 Deletes a new bandwidth group.
18774 </desc>
18775
18776 <param name="name" type="wstring" dir="in">
18777 <desc>Name of the bandwidth group to delete.</desc>
18778 </param>
18779 </method>
18780
18781 <method name="getBandwidthGroup" const="yes">
18782 <desc>
18783 Get a bandwidth group by name.
18784 </desc>
18785
18786 <param name="name" type="wstring" dir="in">
18787 <desc>Name of the bandwidth group to get.</desc>
18788 </param>
18789 <param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
18790 <desc>Where to store the bandwidth group on success.</desc>
18791 </param>
18792 </method>
18793
18794 <method name="getAllBandwidthGroups" const="yes">
18795 <desc>
18796 Get all managed bandwidth groups.
18797 </desc>
18798
18799 <param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
18800 <desc>The array of managed bandwidth groups.</desc>
18801 </param>
18802 </method>
18803 </interface>
18804
18805 <!--
18806 // IVirtualBoxClient
18807 /////////////////////////////////////////////////////////////////////////
18808 -->
18809
18810 <interface
18811 name="IVirtualBoxClient" extends="$unknown"
18812 uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
18813 wsmap="suppress"
18814 >
18815 <desc>
18816 Convenience interface for client applications. Treat this as a
18817 singleton, i.e. never create more than one instance of this interface.
18818
18819 At the moment only available for clients of the local API (not usable
18820 via the webservice). Once the session logic is redesigned this might
18821 change.
18822 </desc>
18823
18824 <attribute name="virtualBox" type="IVirtualBox" readonly="yes">
18825 <desc>
18826 Reference to the server-side API root object.
18827 </desc>
18828 </attribute>
18829
18830 <attribute name="session" type="ISession" readonly="yes">
18831 <desc>
18832 Create a new session object and return the reference to it.
18833 </desc>
18834 </attribute>
18835
18836 <attribute name="eventSource" type="IEventSource" readonly="yes">
18837 <desc>
18838 Event source for VirtualBoxClient events.
18839 </desc>
18840 </attribute>
18841
18842 </interface>
18843
18844 <!--
18845 // Events
18846 /////////////////////////////////////////////////////////////////////////
18847 -->
18848 <enum
18849 name="VBoxEventType"
18850 uuid="0d67e79e-b7b1-4919-aab3-b36866075515"
18851 >
18852
18853 <desc>
18854 Type of an event.
18855 See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18856 </desc>
18857
18858 <const name="Invalid" value="0">
18859 <desc>
18860 Invalid event, must be first.
18861 </desc>
18862 </const>
18863
18864 <const name="Any" value="1">
18865 <desc>
18866 Wildcard for all events.
18867 Events of this type are never delivered, and only used in
18868 <link to="IEventSource::registerListener"/> call to simplify registration.
18869 </desc>
18870 </const>
18871
18872 <const name="Vetoable" value="2">
18873 <desc>
18874 Wildcard for all vetoable events. Events of this type are never delivered, and only
18875 used in <link to="IEventSource::registerListener"/> call to simplify registration.
18876 </desc>
18877 </const>
18878
18879 <const name="MachineEvent" value="3">
18880 <desc>
18881 Wildcard for all machine events. Events of this type are never delivered, and only used in
18882 <link to="IEventSource::registerListener"/> call to simplify registration.
18883 </desc>
18884 </const>
18885
18886 <const name="SnapshotEvent" value="4">
18887 <desc>
18888 Wildcard for all snapshot events. Events of this type are never delivered, and only used in
18889 <link to="IEventSource::registerListener"/> call to simplify registration.
18890 </desc>
18891 </const>
18892
18893 <const name="InputEvent" value="5">
18894 <desc>
18895 Wildcard for all input device (keyboard, mouse) events.
18896 Events of this type are never delivered, and only used in
18897 <link to="IEventSource::registerListener"/> call to simplify registration.
18898 </desc>
18899 </const>
18900
18901 <const name="LastWildcard" value="31">
18902 <desc>
18903 Last wildcard.
18904 </desc>
18905 </const>
18906
18907 <const name="OnMachineStateChanged" value="32">
18908 <desc>
18909 See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
18910 </desc>
18911 </const>
18912 <const name="OnMachineDataChanged" value="33">
18913 <desc>
18914 See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
18915 </desc>
18916 </const>
18917 <const name="OnExtraDataChanged" value="34">
18918 <desc>
18919 See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
18920 </desc>
18921 </const>
18922 <const name="OnExtraDataCanChange" value="35">
18923 <desc>
18924 See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
18925 </desc>
18926 </const>
18927 <const name="OnMediumRegistered" value="36">
18928 <desc>
18929 See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
18930 </desc>
18931 </const>
18932 <const name="OnMachineRegistered" value="37">
18933 <desc>
18934 See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
18935 </desc>
18936 </const>
18937 <const name="OnSessionStateChanged" value="38">
18938 <desc>
18939 See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
18940 </desc>
18941 </const>
18942 <const name="OnSnapshotTaken" value="39">
18943 <desc>
18944 See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
18945 </desc>
18946 </const>
18947 <const name="OnSnapshotDeleted" value="40">
18948 <desc>
18949 See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
18950 </desc>
18951 </const>
18952 <const name="OnSnapshotChanged" value="41">
18953 <desc>
18954 See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
18955 </desc>
18956 </const>
18957 <const name="OnGuestPropertyChanged" value="42">
18958 <desc>
18959 See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
18960 </desc>
18961 </const>
18962 <!-- Console events -->
18963 <const name="OnMousePointerShapeChanged" value="43">
18964 <desc>
18965 See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
18966 </desc>
18967 </const>
18968 <const name="OnMouseCapabilityChanged" value="44">
18969 <desc>
18970 See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
18971 </desc>
18972 </const>
18973 <const name="OnKeyboardLedsChanged" value="45">
18974 <desc>
18975 See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
18976 </desc>
18977 </const>
18978 <const name="OnStateChanged" value="46">
18979 <desc>
18980 See <link to="IStateChangedEvent">IStateChangedEvent</link>.
18981 </desc>
18982 </const>
18983 <const name="OnAdditionsStateChanged" value="47">
18984 <desc>
18985 See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
18986 </desc>
18987 </const>
18988 <const name="OnNetworkAdapterChanged" value="48">
18989 <desc>
18990 See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
18991 </desc>
18992 </const>
18993 <const name="OnSerialPortChanged" value="49">
18994 <desc>
18995 See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
18996 </desc>
18997 </const>
18998 <const name="OnParallelPortChanged" value="50">
18999 <desc>
19000 See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
19001 </desc>
19002 </const>
19003 <const name="OnStorageControllerChanged" value="51">
19004 <desc>
19005 See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
19006 </desc>
19007 </const>
19008 <const name="OnMediumChanged" value="52">
19009 <desc>
19010 See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
19011 </desc>
19012 </const>
19013 <const name="OnVRDEServerChanged" value="53">
19014 <desc>
19015 See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
19016 </desc>
19017 </const>
19018 <const name="OnUSBControllerChanged" value="54">
19019 <desc>
19020 See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
19021 </desc>
19022 </const>
19023 <const name="OnUSBDeviceStateChanged" value="55">
19024 <desc>
19025 See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
19026 </desc>
19027 </const>
19028 <const name="OnSharedFolderChanged" value="56">
19029 <desc>
19030 See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
19031 </desc>
19032 </const>
19033 <const name="OnRuntimeError" value="57">
19034 <desc>
19035 See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
19036 </desc>
19037 </const>
19038 <const name="OnCanShowWindow" value="58">
19039 <desc>
19040 See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
19041 </desc>
19042 </const>
19043 <const name="OnShowWindow" value="59">
19044 <desc>
19045 See <link to="IShowWindowEvent">IShowWindowEvent</link>.
19046 </desc>
19047 </const>
19048 <const name="OnCPUChanged" value="60">
19049 <desc>
19050 See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
19051 </desc>
19052 </const>
19053 <const name="OnVRDEServerInfoChanged" value="61">
19054 <desc>
19055 See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
19056 </desc>
19057 </const>
19058 <const name="OnEventSourceChanged" value="62">
19059 <desc>
19060 See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
19061 </desc>
19062 </const>
19063 <const name="OnCPUExecutionCapChanged" value="63">
19064 <desc>
19065 See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
19066 </desc>
19067 </const>
19068 <const name="OnGuestKeyboard" value="64">
19069 <desc>
19070 See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
19071 </desc>
19072 </const>
19073 <const name="OnGuestMouse" value="65">
19074 <desc>
19075 See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
19076 </desc>
19077 </const>
19078 <const name="OnNATRedirect" value="66">
19079 <desc>
19080 See <link to="INATRedirectEvent">INATRedirectEvent</link>.
19081 </desc>
19082 </const>
19083 <const name="OnHostPCIDevicePlug" value="67">
19084 <desc>
19085 See <link to="IHostPCIDevicePlugEvent">IHostPCIDevicePlugEvent</link>.
19086 </desc>
19087 </const>
19088 <const name="OnVBoxSVCAvailabilityChanged" value="68">
19089 <desc>
19090 See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
19091 </desc>
19092 </const>
19093 <const name="OnBandwidthGroupChanged" value="69">
19094 <desc>
19095 See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
19096 </desc>
19097 </const>
19098 <const name="OnGuestMonitorChanged" value="70">
19099 <desc>
19100 See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
19101 </desc>
19102 </const>
19103 <const name="OnStorageDeviceChanged" value="71">
19104 <desc>
19105 See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
19106 </desc>
19107 </const>
19108 <const name="OnClipboardModeChanged" value="72">
19109 <desc>
19110 See <link to="IClipboardModeChangedEvent">IClipboardModeChangedEvent</link>.
19111 </desc>
19112 </const>
19113 <const name="OnDragAndDropModeChanged" value="73">
19114 <desc>
19115 See <link to="IDragAndDropModeChangedEvent">IDragAndDropModeChangedEvent</link>.
19116 </desc>
19117 </const>
19118
19119 <!-- Last event marker -->
19120 <const name="Last" value="74">
19121 <desc>
19122 Must be last event, used for iterations and structures relying on numerical event values.
19123 </desc>
19124 </const>
19125
19126 </enum>
19127
19128 <interface
19129 name="IEventSource" extends="$unknown"
19130 uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
19131 wsmap="managed"
19132 >
19133 <desc>
19134 Event source. Generally, any object which could generate events can be an event source,
19135 or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
19136 an event source can work with listeners in either active or passive mode. In active mode it is up to
19137 the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
19138 event source keeps track of pending events for each listener and returns available events on demand.
19139
19140 See <link to="IEvent" /> for an introduction to VirtualBox event handling.
19141 </desc>
19142
19143 <method name="createListener">
19144 <desc>
19145 Creates a new listener object, useful for passive mode.
19146 </desc>
19147 <param name="listener" type="IEventListener" dir="return"/>
19148 </method>
19149
19150 <method name="createAggregator">
19151 <desc>
19152 Creates an aggregator event source, collecting events from multiple sources.
19153 This way a single listener can listen for events coming from multiple sources,
19154 using a single blocking <link to="#getEvent"/> on the returned aggregator.
19155 </desc>
19156 <param name="subordinates" type="IEventSource" dir="in" safearray="yes">
19157 <desc>
19158 Subordinate event source this one aggregatres.
19159 </desc>
19160 </param>
19161 <param name="result" type="IEventSource" dir="return">
19162 <desc>
19163 Event source aggregating passed sources.
19164 </desc>
19165 </param>
19166 </method>
19167
19168 <method name="registerListener">
19169 <desc>
19170 Register an event listener.
19171
19172 <note>
19173 To avoid system overload, the VirtualBox server process checks if passive event
19174 listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
19175 current implementation, if more than 500 pending events are detected for a passive
19176 event listener, it is forcefully unregistered by the system, and further
19177 <link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
19178 </note>
19179 </desc>
19180 <param name="listener" type="IEventListener" dir="in">
19181 <desc>Listener to register.</desc>
19182 </param>
19183 <param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
19184 <desc>
19185 Event types listener is interested in. One can use wildcards like -
19186 <link to="VBoxEventType_Any"/> to specify wildcards, matching more
19187 than one event.
19188 </desc>
19189 </param>
19190 <param name="active" type="boolean" dir="in">
19191 <desc>
19192 Which mode this listener is operating in.
19193 In active mode, <link to="IEventListener::handleEvent" /> is called directly.
19194 In passive mode, an internal event queue is created for this this IEventListener.
19195 For each event coming in, it is added to queues for all interested registered passive
19196 listeners. It is then up to the external code to call the listener's
19197 <link to="IEventListener::handleEvent" /> method. When done with an event, the
19198 external code must call <link to="#eventProcessed" />.
19199 </desc>
19200 </param>
19201 </method>
19202
19203 <method name="unregisterListener">
19204 <desc>
19205 Unregister an event listener. If listener is passive, and some waitable events are still
19206 in queue they are marked as processed automatically.
19207 </desc>
19208 <param name="listener" type="IEventListener" dir="in">
19209 <desc>Listener to unregister.</desc>
19210 </param>
19211 </method>
19212
19213 <method name="fireEvent">
19214 <desc>
19215 Fire an event for this source.
19216 </desc>
19217 <param name="event" type="IEvent" dir="in">
19218 <desc>Event to deliver.</desc>
19219 </param>
19220 <param name="timeout" type="long" dir="in">
19221 <desc>
19222 Maximum time to wait for event processing (if event is waitable), in ms;
19223 0 = no wait, -1 = indefinite wait.
19224 </desc>
19225 </param>
19226 <param name="result" type="boolean" dir="return">
19227 <desc>true if an event was delivered to all targets, or is non-waitable.</desc>
19228 </param>
19229 </method>
19230
19231 <method name="getEvent">
19232 <desc>
19233 Get events from this peer's event queue (for passive mode). Calling this method
19234 regularly is required for passive event listeners to avoid system overload;
19235 see <link to="IEventSource::registerListener" /> for details.
19236
19237 <result name="VBOX_E_OBJECT_NOT_FOUND">
19238 Listener is not registered, or autounregistered.
19239 </result>
19240 </desc>
19241 <param name="listener" type="IEventListener" dir="in">
19242 <desc>Which listener to get data for.</desc>
19243 </param>
19244 <param name="timeout" type="long" dir="in">
19245 <desc>
19246 Maximum time to wait for events, in ms;
19247 0 = no wait, -1 = indefinite wait.
19248 </desc>
19249 </param>
19250 <param name="event" type="IEvent" dir="return">
19251 <desc>Event retrieved, or null if none available.</desc>
19252 </param>
19253 </method>
19254
19255 <method name="eventProcessed">
19256 <desc>
19257 Must be called for waitable events after a particular listener finished its
19258 event processing. When all listeners of a particular event have called this
19259 method, the system will then call <link to="IEvent::setProcessed" />.
19260 </desc>
19261 <param name="listener" type="IEventListener" dir="in">
19262 <desc>Which listener processed event.</desc>
19263 </param>
19264 <param name="event" type="IEvent" dir="in">
19265 <desc>Which event.</desc>
19266 </param>
19267 </method>
19268
19269 </interface>
19270
19271 <interface
19272 name="IEventListener" extends="$unknown"
19273 uuid="67099191-32e7-4f6c-85ee-422304c71b90"
19274 wsmap="managed"
19275 >
19276 <desc>
19277 Event listener. An event listener can work in either active or passive mode, depending on the way
19278 it was registered.
19279 See <link to="IEvent" /> for an introduction to VirtualBox event handling.
19280 </desc>
19281
19282 <method name="handleEvent">
19283 <desc>
19284 Handle event callback for active listeners. It is not called for
19285 passive listeners. After calling <link to="#handleEvent"/> on all active listeners
19286 and having received acknowledgement from all passive listeners via
19287 <link to="IEventSource::eventProcessed"/>, the event is marked as
19288 processed and <link to="IEvent::waitProcessed"/> will return
19289 immediately.
19290 </desc>
19291 <param name="event" type="IEvent" dir="in">
19292 <desc>Event available.</desc>
19293 </param>
19294 </method>
19295
19296 </interface>
19297
19298 <interface
19299 name="IEvent" extends="$unknown"
19300 uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
19301 wsmap="managed"
19302 >
19303 <desc>
19304 Abstract parent interface for VirtualBox events. Actual events will typically implement
19305 a more specific interface which derives from this (see below).
19306
19307 <b>Introduction to VirtualBox events</b>
19308
19309 Generally speaking, an event (represented by this interface) signals that something
19310 happened, while an event listener (see <link to="IEventListener" />) represents an
19311 entity that is interested in certain events. In order for this to work with
19312 unidirectional protocols (i.e. web services), the concepts of passive and active
19313 listener are used.
19314
19315 Event consumers can register themselves as listeners, providing an array of
19316 events they are interested in (see <link to="IEventSource::registerListener" />).
19317 When an event triggers, the listener is notified about the event. The exact
19318 mechanism of the notification depends on whether the listener was registered as
19319 an active or passive listener:
19320
19321 <ul>
19322 <li>An active listener is very similar to a callback: it is a function invoked
19323 by the API. As opposed to the callbacks that were used in the API before
19324 VirtualBox 4.0 however, events are now objects with an interface hierarchy.
19325 </li>
19326
19327 <li>Passive listeners are somewhat trickier to implement, but do not require
19328 a client function to be callable, which is not an option with scripting
19329 languages or web service clients. Internally the <link to="IEventSource" />
19330 implementation maintains an event queue for each passive listener, and
19331 newly arrived events are put in this queue. When the listener calls
19332 <link to="IEventSource::getEvent"/>, first element from its internal event
19333 queue is returned. When the client completes processing of an event,
19334 the <link to="IEventSource::eventProcessed" /> function must be called,
19335 acknowledging that the event was processed. It supports implementing
19336 waitable events. On passive listener unregistration, all events from its
19337 queue are auto-acknowledged.
19338 </li>
19339 </ul>
19340
19341 Waitable events are useful in situations where the event generator wants to track
19342 delivery or a party wants to wait until all listeners have completed the event. A
19343 typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
19344 listeners might veto a certain action, and thus the event producer has to make
19345 sure that all listeners have processed the event and not vetoed before taking
19346 the action.
19347
19348 A given event may have both passive and active listeners at the same time.
19349
19350 <b>Using events</b>
19351
19352 Any VirtualBox object capable of producing externally visible events provides an
19353 @c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
19354 This event source object is notified by VirtualBox once something has happened, so
19355 consumers may register event listeners with this event source. To register a listener,
19356 an object implementing the <link to="IEventListener" /> interface must be provided.
19357 For active listeners, such an object is typically created by the consumer, while for
19358 passive listeners <link to="IEventSource::createListener" /> should be used. Please
19359 note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
19360
19361 Once created, the listener must be registered to listen for the desired events
19362 (see <link to="IEventSource::registerListener" />), providing an array of
19363 <link to="VBoxEventType" /> enums. Those elements can either be the individual
19364 event IDs or wildcards matching multiple event IDs.
19365
19366 After registration, the callback's <link to="IEventListener::handleEvent" /> method is
19367 called automatically when the event is triggered, while passive listeners have to call
19368 <link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
19369 an event processing loop.
19370
19371 The IEvent interface is an abstract parent interface for all such VirtualBox events
19372 coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
19373 or the event processing loop is to check the <link to="#type" /> attribute of the event and
19374 then cast to the appropriate specific interface using @c QueryInterface().
19375 </desc>
19376
19377 <attribute name="type" readonly="yes" type="VBoxEventType">
19378 <desc>
19379 Event type.
19380 </desc>
19381 </attribute>
19382
19383 <attribute name="source" readonly="yes" type="IEventSource">
19384 <desc>
19385 Source of this event.
19386 </desc>
19387 </attribute>
19388
19389 <attribute name="waitable" readonly="yes" type="boolean">
19390 <desc>
19391 If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
19392 and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
19393 as no additional overhead associated with waitability imposed.
19394 Waitable events are needed when one need to be able to wait for particular event processed,
19395 for example for vetoable changes, or if event refers to some resource which need to be kept immutable
19396 until all consumers confirmed events.
19397 </desc>
19398 </attribute>
19399
19400 <method name="setProcessed">
19401 <desc>
19402 Internal method called by the system when all listeners of a particular event have called
19403 <link to="IEventSource::eventProcessed" />. This should not be called by client code.
19404 </desc>
19405 </method>
19406
19407 <method name="waitProcessed">
19408 <desc>
19409 Wait until time outs, or this event is processed. Event must be waitable for this operation to have
19410 described semantics, for non-waitable returns true immediately.
19411 </desc>
19412 <param name="timeout" type="long" dir="in">
19413 <desc>
19414 Maximum time to wait for event processeing, in ms;
19415 0 = no wait, -1 = indefinite wait.
19416 </desc>
19417 </param>
19418 <param name="result" type="boolean" dir="return">
19419 <desc>If this event was processed before timeout.</desc>
19420 </param>
19421 </method>
19422 </interface>
19423
19424
19425 <interface
19426 name="IReusableEvent" extends="IEvent"
19427 uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
19428 wsmap="managed"
19429 >
19430 <desc>Base abstract interface for all reusable events.</desc>
19431
19432 <attribute name="generation" readonly="yes" type="unsigned long">
19433 <desc>Current generation of event, incremented on reuse.</desc>
19434 </attribute>
19435
19436 <method name="reuse">
19437 <desc>
19438 Marks an event as reused, increments 'generation', fields shall no
19439 longer be considered valid.
19440 </desc>
19441 </method>
19442 </interface>
19443
19444 <interface
19445 name="IMachineEvent" extends="IEvent"
19446 uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
19447 wsmap="managed" id="MachineEvent"
19448 >
19449 <desc>Base abstract interface for all machine events.</desc>
19450
19451 <attribute name="machineId" readonly="yes" type="uuid" mod="string">
19452 <desc>ID of the machine this event relates to.</desc>
19453 </attribute>
19454
19455 </interface>
19456
19457 <interface
19458 name="IMachineStateChangedEvent" extends="IMachineEvent"
19459 uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
19460 wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
19461 >
19462 <desc>Machine state change event.</desc>
19463
19464 <attribute name="state" readonly="yes" type="MachineState">
19465 <desc>New execution state.</desc>
19466 </attribute>
19467 </interface>
19468
19469 <interface
19470 name="IMachineDataChangedEvent" extends="IMachineEvent"
19471 uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
19472 wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
19473 >
19474 <desc>
19475 Any of the settings of the given machine has changed.
19476 </desc>
19477
19478 <attribute name="temporary" readonly="yes" type="boolean">
19479 <desc>@c true if the settings change is temporary. All permanent
19480 settings changes will trigger an event, and only temporary settings
19481 changes for running VMs will trigger an event. Note: sending events
19482 for temporary changes is NOT IMPLEMENTED.</desc>
19483 </attribute>
19484 </interface>
19485
19486 <interface
19487 name="IMediumRegisteredEvent" extends="IEvent"
19488 uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
19489 wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
19490 >
19491 <desc>
19492 The given medium was registered or unregistered
19493 within this VirtualBox installation.
19494 </desc>
19495
19496 <attribute name="mediumId" readonly="yes" type="uuid" mod="string">
19497 <desc>ID of the medium this event relates to.</desc>
19498 </attribute>
19499
19500 <attribute name="mediumType" readonly="yes" type="DeviceType">
19501 <desc>Type of the medium this event relates to.</desc>
19502 </attribute>
19503
19504 <attribute name="registered" type="boolean" readonly="yes">
19505 <desc>
19506 If @c true, the medium was registered, otherwise it was
19507 unregistered.
19508 </desc>
19509 </attribute>
19510 </interface>
19511
19512 <interface
19513 name="IMachineRegisteredEvent" extends="IMachineEvent"
19514 uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
19515 wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
19516 >
19517 <desc>
19518 The given machine was registered or unregistered
19519 within this VirtualBox installation.
19520 </desc>
19521
19522 <attribute name="registered" type="boolean" readonly="yes">
19523 <desc>
19524 If @c true, the machine was registered, otherwise it was
19525 unregistered.
19526 </desc>
19527 </attribute>
19528 </interface>
19529
19530 <interface
19531 name="ISessionStateChangedEvent" extends="IMachineEvent"
19532 uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
19533 wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
19534 >
19535 <desc>
19536 The state of the session for the given machine was changed.
19537 <see><link to="IMachine::sessionState"/></see>
19538 </desc>
19539
19540 <attribute name="state" type="SessionState" readonly="yes">
19541 <desc>
19542 New session state.
19543 </desc>
19544 </attribute>
19545 </interface>
19546
19547 <interface
19548 name="IGuestPropertyChangedEvent" extends="IMachineEvent"
19549 uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
19550 wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
19551 >
19552 <desc>
19553 Notification when a guest property has changed.
19554 </desc>
19555
19556 <attribute name="name" readonly="yes" type="wstring">
19557 <desc>
19558 The name of the property that has changed.
19559 </desc>
19560 </attribute>
19561
19562 <attribute name="value" readonly="yes" type="wstring">
19563 <desc>
19564 The new property value.
19565 </desc>
19566 </attribute>
19567
19568 <attribute name="flags" readonly="yes" type="wstring">
19569 <desc>
19570 The new property flags.
19571 </desc>
19572 </attribute>
19573
19574 </interface>
19575
19576 <interface
19577 name="ISnapshotEvent" extends="IMachineEvent"
19578 uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
19579 wsmap="managed" id="SnapshotEvent"
19580 >
19581 <desc>Base interface for all snapshot events.</desc>
19582
19583 <attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
19584 <desc>ID of the snapshot this event relates to.</desc>
19585 </attribute>
19586
19587 </interface>
19588
19589 <interface
19590 name="ISnapshotTakenEvent" extends="ISnapshotEvent"
19591 uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
19592 wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
19593 >
19594 <desc>
19595 A new snapshot of the machine has been taken.
19596 <see><link to="ISnapshot"/></see>
19597 </desc>
19598 </interface>
19599
19600 <interface
19601 name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
19602 uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
19603 wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
19604 >
19605 <desc>
19606 Snapshot of the given machine has been deleted.
19607
19608 <note>
19609 This notification is delivered <b>after</b> the snapshot
19610 object has been uninitialized on the server (so that any
19611 attempt to call its methods will return an error).
19612 </note>
19613
19614 <see><link to="ISnapshot"/></see>
19615 </desc>
19616 </interface>
19617
19618 <interface
19619 name="ISnapshotChangedEvent" extends="ISnapshotEvent"
19620 uuid="07541941-8079-447a-a33e-47a69c7980db"
19621 wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
19622 >
19623 <desc>
19624 Snapshot properties (name and/or description) have been changed.
19625 <see><link to="ISnapshot"/></see>
19626 </desc>
19627 </interface>
19628
19629 <interface
19630 name="IMousePointerShapeChangedEvent" extends="IEvent"
19631 uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
19632 wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
19633 >
19634 <desc>
19635 Notification when the guest mouse pointer shape has
19636 changed. The new shape data is given.
19637 </desc>
19638
19639 <attribute name="visible" type="boolean" readonly="yes">
19640 <desc>
19641 Flag whether the pointer is visible.
19642 </desc>
19643 </attribute>
19644 <attribute name="alpha" type="boolean" readonly="yes">
19645 <desc>
19646 Flag whether the pointer has an alpha channel.
19647 </desc>
19648 </attribute>
19649 <attribute name="xhot" type="unsigned long" readonly="yes">
19650 <desc>
19651 The pointer hot spot X coordinate.
19652 </desc>
19653 </attribute>
19654 <attribute name="yhot" type="unsigned long" readonly="yes">
19655 <desc>
19656 The pointer hot spot Y coordinate.
19657 </desc>
19658 </attribute>
19659 <attribute name="width" type="unsigned long" readonly="yes">
19660 <desc>
19661 Width of the pointer shape in pixels.
19662 </desc>
19663 </attribute>
19664 <attribute name="height" type="unsigned long" readonly="yes">
19665 <desc>
19666 Height of the pointer shape in pixels.
19667 </desc>
19668 </attribute>
19669 <attribute name="shape" type="octet" safearray="yes" readonly="yes">
19670 <desc>
19671 Shape buffer arrays.
19672
19673 The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
19674 followed by a 32-bpp XOR (color) mask.
19675
19676 For pointers without alpha channel the XOR mask pixels are 32
19677 bit values: (lsb)BGR0(msb). For pointers with alpha channel
19678 the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
19679
19680 An AND mask is used for pointers with alpha channel, so if the
19681 callback does not support alpha, the pointer could be
19682 displayed as a normal color pointer.
19683
19684 The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
19685 size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
19686 height</tt>. The padding bits at the end of each scanline are
19687 undefined.
19688
19689 The XOR mask follows the AND mask on the next 4-byte aligned
19690 offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) &amp; ~3</tt>.
19691 Bytes in the gap between the AND and the XOR mask are undefined.
19692 The XOR mask scanlines have no gap between them and the size of
19693 the XOR mask is: <tt>cXor = width * 4 * height</tt>.
19694
19695 <note>
19696 If @a shape is 0, only the pointer visibility is changed.
19697 </note>
19698 </desc>
19699 </attribute>
19700 </interface>
19701
19702 <interface
19703 name="IMouseCapabilityChangedEvent" extends="IEvent"
19704 uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
19705 wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
19706 >
19707 <desc>
19708 Notification when the mouse capabilities reported by the
19709 guest have changed. The new capabilities are passed.
19710 </desc>
19711 <attribute name="supportsAbsolute" type="boolean" readonly="yes">
19712 <desc>
19713 Supports absolute coordinates.
19714 </desc>
19715 </attribute>
19716 <attribute name="supportsRelative" type="boolean" readonly="yes">
19717 <desc>
19718 Supports relative coordinates.
19719 </desc>
19720 </attribute>
19721 <attribute name="needsHostCursor" type="boolean" readonly="yes">
19722 <desc>
19723 If host cursor is needed.
19724 </desc>
19725 </attribute>
19726 </interface>
19727
19728 <interface
19729 name="IKeyboardLedsChangedEvent" extends="IEvent"
19730 uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
19731 wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
19732 >
19733 <desc>
19734 Notification when the guest OS executes the KBD_CMD_SET_LEDS command
19735 to alter the state of the keyboard LEDs.
19736 </desc>
19737 <attribute name="numLock" type="boolean" readonly="yes">
19738 <desc>
19739 NumLock status.
19740 </desc>
19741 </attribute>
19742 <attribute name="capsLock" type="boolean" readonly="yes">
19743 <desc>
19744 CapsLock status.
19745 </desc>
19746 </attribute>
19747 <attribute name="scrollLock" type="boolean" readonly="yes">
19748 <desc>
19749 ScrollLock status.
19750 </desc>
19751 </attribute>
19752 </interface>
19753
19754 <interface
19755 name="IStateChangedEvent" extends="IEvent"
19756 uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
19757 wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
19758 >
19759 <desc>
19760 Notification when the execution state of the machine has changed.
19761 The new state is given.
19762 </desc>
19763 <attribute name="state" type="MachineState" readonly="yes">
19764 <desc>
19765 New machine state.
19766 </desc>
19767 </attribute>
19768 </interface>
19769
19770 <interface
19771 name="IAdditionsStateChangedEvent" extends="IEvent"
19772 uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
19773 wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
19774 >
19775 <desc>
19776 Notification when a Guest Additions property changes.
19777 Interested callees should query IGuest attributes to
19778 find out what has changed.
19779 </desc>
19780 </interface>
19781
19782 <interface
19783 name="INetworkAdapterChangedEvent" extends="IEvent"
19784 uuid="08889892-1EC6-4883-801D-77F56CFD0103"
19785 wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
19786 >
19787 <desc>
19788 Notification when a property of one of the
19789 virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
19790 changes. Interested callees should use INetworkAdapter methods and
19791 attributes to find out what has changed.
19792 </desc>
19793 <attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
19794 <desc>
19795 Network adapter that is subject to change.
19796 </desc>
19797 </attribute>
19798 </interface>
19799
19800 <interface
19801 name="ISerialPortChangedEvent" extends="IEvent"
19802 uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
19803 wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
19804 >
19805 <desc>
19806 Notification when a property of one of the
19807 virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
19808 Interested callees should use ISerialPort methods and attributes
19809 to find out what has changed.
19810 </desc>
19811 <attribute name="serialPort" type="ISerialPort" readonly="yes">
19812 <desc>
19813 Serial port that is subject to change.
19814 </desc>
19815 </attribute>
19816 </interface>
19817
19818 <interface
19819 name="IParallelPortChangedEvent" extends="IEvent"
19820 uuid="813C99FC-9849-4F47-813E-24A75DC85615"
19821 wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
19822 >
19823 <desc>
19824 Notification when a property of one of the
19825 virtual <link to="IMachine::getParallelPort">parallel ports</link>
19826 changes. Interested callees should use ISerialPort methods and
19827 attributes to find out what has changed.
19828 </desc>
19829 <attribute name="parallelPort" type="IParallelPort" readonly="yes">
19830 <desc>
19831 Parallel port that is subject to change.
19832 </desc>
19833 </attribute>
19834 </interface>
19835
19836 <interface
19837 name="IStorageControllerChangedEvent" extends="IEvent"
19838 uuid="715212BF-DA59-426E-8230-3831FAA52C56"
19839 wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
19840 >
19841 <desc>
19842 Notification when a
19843 <link to="IMachine::mediumAttachments">medium attachment</link>
19844 changes.
19845 </desc>
19846 </interface>
19847
19848 <interface
19849 name="IMediumChangedEvent" extends="IEvent"
19850 uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
19851 wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
19852 >
19853 <desc>
19854 Notification when a
19855 <link to="IMachine::mediumAttachments">medium attachment</link>
19856 changes.
19857 </desc>
19858 <attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
19859 <desc>
19860 Medium attachment that is subject to change.
19861 </desc>
19862 </attribute>
19863 </interface>
19864
19865 <interface
19866 name="IClipboardModeChangedEvent" extends="IEvent"
19867 uuid="cac21692-7997-4595-a731-3a509db604e5"
19868 wsmap="managed" autogen="VBoxEvent" id="OnClipboardModeChanged"
19869 >
19870 <desc>
19871 Notification when the shared clipboard mode changes.
19872 </desc>
19873 <attribute name="clipboardMode" type="ClipboardMode" readonly="yes">
19874 <desc>
19875 The new clipboard mode.
19876 </desc>
19877 </attribute>
19878 </interface>
19879
19880 <interface
19881 name="IDragAndDropModeChangedEvent" extends="IEvent"
19882 uuid="e90b8850-ac8e-4dff-8059-4100ae2c3c3d"
19883 wsmap="managed" autogen="VBoxEvent" id="OnDragAndDropModeChanged"
19884 >
19885 <desc>
19886 Notification when the drag'n'drop mode changes.
19887 </desc>
19888 <attribute name="dragAndDropMode" type="DragAndDropMode" readonly="yes">
19889 <desc>
19890 The new drag'n'drop mode.
19891 </desc>
19892 </attribute>
19893 </interface>
19894
19895 <interface
19896 name="ICPUChangedEvent" extends="IEvent"
19897 uuid="4da2dec7-71b2-4817-9a64-4ed12c17388e"
19898 wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
19899 >
19900 <desc>
19901 Notification when a CPU changes.
19902 </desc>
19903 <attribute name="CPU" type="unsigned long" readonly="yes">
19904 <desc>
19905 The CPU which changed.
19906 </desc>
19907 </attribute>
19908 <attribute name="add" type="boolean" readonly="yes">
19909 <desc>
19910 Flag whether the CPU was added or removed.
19911 </desc>
19912 </attribute>
19913 </interface>
19914
19915 <interface
19916 name="ICPUExecutionCapChangedEvent" extends="IEvent"
19917 uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
19918 wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
19919 >
19920 <desc>
19921 Notification when the CPU execution cap changes.
19922 </desc>
19923 <attribute name="executionCap" type="unsigned long" readonly="yes">
19924 <desc>
19925 The new CPU execution cap value. (1-100)
19926 </desc>
19927 </attribute>
19928 </interface>
19929
19930 <interface
19931 name="IGuestKeyboardEvent" extends="IEvent"
19932 uuid="88394258-7006-40d4-b339-472ee3801844"
19933 wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
19934 >
19935 <desc>
19936 Notification when guest keyboard event happens.
19937 </desc>
19938 <attribute name="scancodes" type="long" safearray="yes" readonly="yes">
19939 <desc>
19940 Array of scancodes.
19941 </desc>
19942 </attribute>
19943 </interface>
19944
19945 <interface
19946 name="IGuestMouseEvent" extends="IReusableEvent"
19947 uuid="1f85d35c-c524-40ff-8e98-307000df0992"
19948 wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
19949 >
19950 <desc>
19951 Notification when guest mouse event happens.
19952 </desc>
19953
19954 <attribute name="absolute" type="boolean" readonly="yes">
19955 <desc>
19956 If this event is relative or absolute.
19957 </desc>
19958 </attribute>
19959
19960 <attribute name="x" type="long" readonly="yes">
19961 <desc>
19962 New X position, or X delta.
19963 </desc>
19964 </attribute>
19965
19966 <attribute name="y" type="long" readonly="yes">
19967 <desc>
19968 New Y position, or Y delta.
19969 </desc>
19970 </attribute>
19971
19972 <attribute name="z" type="long" readonly="yes">
19973 <desc>
19974 Z delta.
19975 </desc>
19976 </attribute>
19977
19978 <attribute name="w" type="long" readonly="yes">
19979 <desc>
19980 W delta.
19981 </desc>
19982 </attribute>
19983
19984 <attribute name="buttons" type="long" readonly="yes">
19985 <desc>
19986 Button state bitmask.
19987 </desc>
19988 </attribute>
19989
19990 </interface>
19991
19992
19993 <interface
19994 name="IVRDEServerChangedEvent" extends="IEvent"
19995 uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
19996 wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
19997 >
19998 <desc>
19999 Notification when a property of the
20000 <link to="IMachine::VRDEServer">VRDE server</link> changes.
20001 Interested callees should use IVRDEServer methods and attributes to
20002 find out what has changed.
20003 </desc>
20004 </interface>
20005
20006 <interface
20007 name="IVRDEServerInfoChangedEvent" extends="IEvent"
20008 uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
20009 wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
20010 >
20011 <desc>
20012 Notification when the status of the VRDE server changes. Interested callees
20013 should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
20014 attributes to find out what is the current status.
20015 </desc>
20016 </interface>
20017
20018 <interface
20019 name="IUSBControllerChangedEvent" extends="IEvent"
20020 uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
20021 wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
20022 >
20023 <desc>
20024 Notification when a property of the virtual
20025 <link to="IMachine::USBController">USB controller</link> changes.
20026 Interested callees should use IUSBController methods and attributes to
20027 find out what has changed.
20028 </desc>
20029 </interface>
20030
20031 <interface
20032 name="IUSBDeviceStateChangedEvent" extends="IEvent"
20033 uuid="806da61b-6679-422a-b629-51b06b0c6d93"
20034 wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
20035 >
20036 <desc>
20037 Notification when a USB device is attached to or detached from
20038 the virtual USB controller.
20039
20040 This notification is sent as a result of the indirect
20041 request to attach the device because it matches one of the
20042 machine USB filters, or as a result of the direct request
20043 issued by <link to="IConsole::attachUSBDevice"/> or
20044 <link to="IConsole::detachUSBDevice"/>.
20045
20046 This notification is sent in case of both a succeeded and a
20047 failed request completion. When the request succeeds, the
20048 @a error parameter is @c null, and the given device has been
20049 already added to (when @a attached is @c true) or removed from
20050 (when @a attached is @c false) the collection represented by
20051 <link to="IConsole::USBDevices"/>. On failure, the collection
20052 doesn't change and the @a error parameter represents the error
20053 message describing the failure.
20054 </desc>
20055 <attribute name="device" type="IUSBDevice" readonly="yes">
20056 <desc>
20057 Device that is subject to state change.
20058 </desc>
20059 </attribute>
20060 <attribute name="attached" type="boolean" readonly="yes">
20061 <desc>
20062 @c true if the device was attached and @c false otherwise.
20063 </desc>
20064 </attribute>
20065 <attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
20066 <desc>
20067 @c null on success or an error message object on failure.
20068 </desc>
20069 </attribute>
20070 </interface>
20071
20072 <interface
20073 name="ISharedFolderChangedEvent" extends="IEvent"
20074 uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
20075 wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
20076 >
20077 <desc>
20078 Notification when a shared folder is added or removed.
20079 The @a scope argument defines one of three scopes:
20080 <link to="IVirtualBox::sharedFolders">global shared folders</link>
20081 (<link to="Scope_Global">Global</link>),
20082 <link to="IMachine::sharedFolders">permanent shared folders</link> of
20083 the machine (<link to="Scope_Machine">Machine</link>) or <link
20084 to="IConsole::sharedFolders">transient shared folders</link> of the
20085 machine (<link to="Scope_Session">Session</link>). Interested callees
20086 should use query the corresponding collections to find out what has
20087 changed.
20088 </desc>
20089 <attribute name="scope" type="Scope" readonly="yes">
20090 <desc>
20091 Scope of the notification.
20092 </desc>
20093 </attribute>
20094 </interface>
20095
20096 <interface
20097 name="IRuntimeErrorEvent" extends="IEvent"
20098 uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
20099 wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
20100 >
20101 <desc>
20102 Notification when an error happens during the virtual
20103 machine execution.
20104
20105 There are three kinds of runtime errors:
20106 <ul>
20107 <li><i>fatal</i></li>
20108 <li><i>non-fatal with retry</i></li>
20109 <li><i>non-fatal warnings</i></li>
20110 </ul>
20111
20112 <b>Fatal</b> errors are indicated by the @a fatal parameter set
20113 to @c true. In case of fatal errors, the virtual machine
20114 execution is always paused before calling this notification, and
20115 the notification handler is supposed either to immediately save
20116 the virtual machine state using <link to="IConsole::saveState"/>
20117 or power it off using <link to="IConsole::powerDown"/>.
20118 Resuming the execution can lead to unpredictable results.
20119
20120 <b>Non-fatal</b> errors and warnings are indicated by the
20121 @a fatal parameter set to @c false. If the virtual machine
20122 is in the Paused state by the time the error notification is
20123 received, it means that the user can <i>try to resume</i> the machine
20124 execution after attempting to solve the problem that caused the
20125 error. In this case, the notification handler is supposed
20126 to show an appropriate message to the user (depending on the
20127 value of the @a id parameter) that offers several actions such
20128 as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
20129 wants to retry, the notification handler should continue
20130 the machine execution using the <link to="IConsole::resume"/>
20131 call. If the machine execution is not Paused during this
20132 notification, then it means this notification is a <i>warning</i>
20133 (for example, about a fatal condition that can happen very soon);
20134 no immediate action is required from the user, the machine
20135 continues its normal execution.
20136
20137 Note that in either case the notification handler
20138 <b>must not</b> perform any action directly on a thread
20139 where this notification is called. Everything it is allowed to
20140 do is to post a message to another thread that will then talk
20141 to the user and take the corresponding action.
20142
20143 Currently, the following error identifiers are known:
20144 <ul>
20145 <li><tt>"HostMemoryLow"</tt></li>
20146 <li><tt>"HostAudioNotResponding"</tt></li>
20147 <li><tt>"VDIStorageFull"</tt></li>
20148 <li><tt>"3DSupportIncompatibleAdditions"</tt></li>
20149 </ul>
20150 </desc>
20151 <attribute name="fatal" type="boolean" readonly="yes">
20152 <desc>
20153 Whether the error is fatal or not.
20154 </desc>
20155 </attribute>
20156 <attribute name="id" type="wstring" readonly="yes">
20157 <desc>
20158 Error identifier.
20159 </desc>
20160 </attribute>
20161 <attribute name="message" type="wstring" readonly="yes">
20162 <desc>
20163 Optional error message.
20164 </desc>
20165 </attribute>
20166 </interface>
20167
20168
20169 <interface
20170 name="IEventSourceChangedEvent" extends="IEvent"
20171 uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
20172 waitable="yes"
20173 wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
20174 >
20175 <desc>
20176 Notification when an event source state changes (listener added or removed).
20177 </desc>
20178
20179 <attribute name="listener" type="IEventListener" readonly="yes">
20180 <desc>
20181 Event listener which has changed.
20182 </desc>
20183 </attribute>
20184
20185 <attribute name="add" type="boolean" readonly="yes">
20186 <desc>
20187 Flag whether listener was added or removed.
20188 </desc>
20189 </attribute>
20190 </interface>
20191
20192 <interface
20193 name="IExtraDataChangedEvent" extends="IEvent"
20194 uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
20195 wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
20196 >
20197 <desc>
20198 Notification when machine specific or global extra data
20199 has changed.
20200 </desc>
20201 <attribute name="machineId" type="uuid" mod="string" readonly="yes">
20202 <desc>
20203 ID of the machine this event relates to.
20204 Null for global extra data changes.
20205 </desc>
20206 </attribute>
20207 <attribute name="key" type="wstring" readonly="yes">
20208 <desc>
20209 Extra data key that has changed.
20210 </desc>
20211 </attribute>
20212 <attribute name="value" type="wstring" readonly="yes">
20213 <desc>
20214 Extra data value for the given key.
20215 </desc>
20216 </attribute>
20217 </interface>
20218
20219 <interface
20220 name="IVetoEvent" extends="IEvent"
20221 uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
20222 wsmap="managed"
20223 >
20224 <desc>Base abstract interface for veto events.</desc>
20225
20226 <method name="addVeto">
20227 <desc>
20228 Adds a veto on this event.
20229 </desc>
20230 <param name="reason" type="wstring" dir="in">
20231 <desc>
20232 Reason for veto, could be null or empty string.
20233 </desc>
20234 </param>
20235 </method>
20236
20237 <method name="isVetoed">
20238 <desc>
20239 If this event was vetoed.
20240 </desc>
20241 <param name="result" type="boolean" dir="return">
20242 <desc>
20243 Reason for veto.
20244 </desc>
20245 </param>
20246 </method>
20247
20248 <method name="getVetos">
20249 <desc>
20250 Current veto reason list, if size is 0 - no veto.
20251 </desc>
20252 <param name="result" type="wstring" dir="return" safearray="yes">
20253 <desc>
20254 Array of reasons for veto provided by different event handlers.
20255 </desc>
20256 </param>
20257 </method>
20258
20259 </interface>
20260
20261 <interface
20262 name="IExtraDataCanChangeEvent" extends="IVetoEvent"
20263 uuid="245d88bd-800a-40f8-87a6-170d02249a55"
20264 wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
20265 waitable="true"
20266 >
20267 <desc>
20268 Notification when someone tries to change extra data for
20269 either the given machine or (if @c null) global extra data.
20270 This gives the chance to veto against changes.
20271 </desc>
20272 <attribute name="machineId" type="uuid" mod="string" readonly="yes">
20273 <desc>
20274 ID of the machine this event relates to.
20275 Null for global extra data changes.
20276 </desc>
20277 </attribute>
20278 <attribute name="key" type="wstring" readonly="yes">
20279 <desc>
20280 Extra data key that has changed.
20281 </desc>
20282 </attribute>
20283 <attribute name="value" type="wstring" readonly="yes">
20284 <desc>
20285 Extra data value for the given key.
20286 </desc>
20287 </attribute>
20288 </interface>
20289
20290 <interface
20291 name="ICanShowWindowEvent" extends="IVetoEvent"
20292 uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
20293 wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
20294 waitable="true"
20295 >
20296 <desc>
20297 Notification when a call to
20298 <link to="IMachine::canShowConsoleWindow"/> is made by a
20299 front-end to check if a subsequent call to
20300 <link to="IMachine::showConsoleWindow"/> can succeed.
20301
20302 The callee should give an answer appropriate to the current
20303 machine state using event veto. This answer must
20304 remain valid at least until the next
20305 <link to="IConsole::state">machine state</link> change.
20306 </desc>
20307 </interface>
20308
20309 <interface
20310 name="IShowWindowEvent" extends="IEvent"
20311 uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
20312 wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
20313 waitable="true"
20314 >
20315 <desc>
20316 Notification when a call to
20317 <link to="IMachine::showConsoleWindow"/>
20318 requests the console window to be activated and brought to
20319 foreground on the desktop of the host PC.
20320
20321 This notification should cause the VM console process to
20322 perform the requested action as described above. If it is
20323 impossible to do it at a time of this notification, this
20324 method should return a failure.
20325
20326 Note that many modern window managers on many platforms
20327 implement some sort of focus stealing prevention logic, so
20328 that it may be impossible to activate a window without the
20329 help of the currently active application (which is supposedly
20330 an initiator of this notification). In this case, this method
20331 must return a non-zero identifier that represents the
20332 top-level window of the VM console process. The caller, if it
20333 represents a currently active process, is responsible to use
20334 this identifier (in a platform-dependent manner) to perform
20335 actual window activation.
20336
20337 This method must set @a winId to zero if it has performed all
20338 actions necessary to complete the request and the console
20339 window is now active and in foreground, to indicate that no
20340 further action is required on the caller's side.
20341 </desc>
20342 <attribute name="winId" type="long long">
20343 <desc>
20344 Platform-dependent identifier of the top-level VM console
20345 window, or zero if this method has performed all actions
20346 necessary to implement the <i>show window</i> semantics for
20347 the given platform and/or this VirtualBox front-end.
20348 </desc>
20349 </attribute>
20350 </interface>
20351
20352 <interface
20353 name="INATRedirectEvent" extends="IMachineEvent"
20354 uuid="24eef068-c380-4510-bc7c-19314a7352f1"
20355 wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
20356 >
20357 <desc>
20358 Notification when NAT redirect rule added or removed.
20359 </desc>
20360 <attribute name="slot" type="unsigned long" readonly="yes">
20361 <desc>
20362 Adapter which NAT attached to.
20363 </desc>
20364 </attribute>
20365 <attribute name="remove" type="boolean" readonly="yes">
20366 <desc>
20367 Whether rule remove or add.
20368 </desc>
20369 </attribute>
20370 <attribute name="name" type="wstring" readonly="yes">
20371 <desc>
20372 Name of the rule.
20373 </desc>
20374 </attribute>
20375 <attribute name="proto" type="NATProtocol" readonly="yes">
20376 <desc>
20377 Protocol (TCP or UDP) of the redirect rule.
20378 </desc>
20379 </attribute>
20380 <attribute name="hostIP" type="wstring" readonly="yes">
20381 <desc>
20382 Host ip address to bind socket on.
20383 </desc>
20384 </attribute>
20385 <attribute name="hostPort" type="long" readonly="yes">
20386 <desc>
20387 Host port to bind socket on.
20388 </desc>
20389 </attribute>
20390 <attribute name="guestIP" type="wstring" readonly="yes">
20391 <desc>
20392 Guest ip address to redirect to.
20393 </desc>
20394 </attribute>
20395 <attribute name="guestPort" type="long" readonly="yes">
20396 <desc>
20397 Guest port to redirect to.
20398 </desc>
20399 </attribute>
20400 </interface>
20401
20402 <interface
20403 name="IHostPCIDevicePlugEvent" extends="IMachineEvent"
20404 waitable="yes"
20405 uuid="a0bad6df-d612-47d3-89d4-db3992533948"
20406 wsmap="managed" autogen="VBoxEvent" id="OnHostPCIDevicePlug"
20407 >
20408 <desc>
20409 Notification when host PCI device is plugged/unplugged. Plugging
20410 usually takes place on VM startup, unplug - when
20411 <link to="IMachine::detachHostPCIDevice"/> is called.
20412
20413 <see><link to="IMachine::detachHostPCIDevice"/></see>
20414
20415 </desc>
20416
20417 <attribute name="plugged" type="boolean" readonly="yes">
20418 <desc>
20419 If device successfully plugged or unplugged.
20420 </desc>
20421 </attribute>
20422
20423 <attribute name="success" type="boolean" readonly="yes">
20424 <desc>
20425 If operation was successful, if false - 'message' attribute
20426 may be of interest.
20427 </desc>
20428 </attribute>
20429
20430 <attribute name="attachment" type="IPCIDeviceAttachment" readonly="yes">
20431 <desc>
20432 Attachment info for this device.
20433 </desc>
20434 </attribute>
20435
20436 <attribute name="message" type="wstring" readonly="yes">
20437 <desc>
20438 Optional error message.
20439 </desc>
20440 </attribute>
20441
20442 </interface>
20443
20444 <interface
20445 name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
20446 uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
20447 wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
20448 >
20449 <desc>
20450 Notification when VBoxSVC becomes unavailable (due to a crash or similar
20451 unexpected circumstances) or available again.
20452 </desc>
20453
20454 <attribute name="available" type="boolean" readonly="yes">
20455 <desc>
20456 Whether VBoxSVC is available now.
20457 </desc>
20458 </attribute>
20459 </interface>
20460
20461 <interface
20462 name="IBandwidthGroupChangedEvent" extends="IEvent"
20463 uuid="334df94a-7556-4cbc-8c04-043096b02d82"
20464 wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
20465 >
20466 <desc>
20467 Notification when one of the bandwidth groups changed
20468 </desc>
20469 <attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
20470 <desc>
20471 The changed bandwidth group.
20472 </desc>
20473 </attribute>
20474 </interface>
20475
20476 <enum
20477 name="GuestMonitorChangedEventType"
20478 uuid="ef172985-7e36-4297-95be-e46396968d66"
20479 >
20480
20481 <desc>
20482 How the guest monitor has been changed.
20483 </desc>
20484
20485 <const name="Enabled" value="0">
20486 <desc>
20487 The guest monitor has been enabled by the guest.
20488 </desc>
20489 </const>
20490
20491 <const name="Disabled" value="1">
20492 <desc>
20493 The guest monitor has been disabled by the guest.
20494 </desc>
20495 </const>
20496
20497 <const name="NewOrigin" value="2">
20498 <desc>
20499 The guest monitor origin has changed in the guest.
20500 </desc>
20501 </const>
20502 </enum>
20503
20504 <interface
20505 name="IGuestMonitorChangedEvent" extends="IEvent"
20506 uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
20507 wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
20508 >
20509 <desc>
20510 Notification when the guest enables one of its monitors.
20511 </desc>
20512
20513 <attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
20514 <desc>
20515 What was changed for this guest monitor.
20516 </desc>
20517 </attribute>
20518
20519 <attribute name="screenId" type="unsigned long" readonly="yes">
20520 <desc>
20521 The monitor which was changed.
20522 </desc>
20523 </attribute>
20524
20525 <attribute name="originX" type="unsigned long" readonly="yes">
20526 <desc>
20527 Physical X origin relative to the primary screen.
20528 Valid for Enabled and NewOrigin.
20529 </desc>
20530 </attribute>
20531
20532 <attribute name="originY" type="unsigned long" readonly="yes">
20533 <desc>
20534 Physical Y origin relative to the primary screen.
20535 Valid for Enabled and NewOrigin.
20536 </desc>
20537 </attribute>
20538
20539 <attribute name="width" type="unsigned long" readonly="yes">
20540 <desc>
20541 Width of the screen.
20542 Valid for Enabled.
20543 </desc>
20544 </attribute>
20545
20546 <attribute name="height" type="unsigned long" readonly="yes">
20547 <desc>
20548 Height of the screen.
20549 Valid for Enabled.
20550 </desc>
20551 </attribute>
20552
20553 </interface>
20554
20555 <interface
20556 name="IStorageDeviceChangedEvent" extends="IEvent"
20557 uuid="8a5c2dce-e341-49d4-afce-c95979f7d70c"
20558 wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
20559 >
20560 <desc>
20561 Notification when a
20562 <link to="IMachine::mediumAttachments">storage device</link>
20563 is attached or removed.
20564 </desc>
20565 <attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
20566 <desc>
20567 Storage device that is subject to change.
20568 </desc>
20569 </attribute>
20570 <attribute name="removed" type="boolean" readonly="yes">
20571 <desc>
20572 Flag whether the device was removed or added to the VM.
20573 </desc>
20574 </attribute>
20575 </interface>
20576
20577 <module name="VBoxSVC" context="LocalServer">
20578 <class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
20579 namespace="virtualbox.org">
20580 <interface name="IVirtualBox" default="yes"/>
20581 </class>
20582 </module>
20583
20584 <module name="VBoxC" context="InprocServer" threadingModel="Free">
20585 <class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
20586 namespace="virtualbox.org">
20587 <interface name="IVirtualBoxClient" default="yes"/>
20588 </class>
20589
20590 <class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
20591 namespace="virtualbox.org">
20592 <interface name="ISession" default="yes"/>
20593 </class>
20594 </module>
20595
20596</library>
20597
20598</idl>
20599
20600<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette