VirtualBox

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

Last change on this file since 17282 was 17275, checked in by vboxsync, 16 years ago

networking API renaming

  • Property svn:eol-style set to native
File size: 471.2 KB
Line 
1<?xml version="1.0" ?>
2
3<!--
4 * :tabSize=2:indentSize=2:noTabs=true:
5 * :folding=explicit:collapseFolds=1:
6 *
7 * Master declaration for VirtualBox's Main API, represented
8 * by COM/XPCOM and web service interfaces.
9 *
10 * From this document, the build system generates several files
11 * via XSLT that are then used during the build process.
12 *
13 * Below is the list of XSL templates that operate on this file and
14 * output files they generate. These XSL templates must be updated
15 * whenever the schema of this file changes:
16 *
17 * 1. src/VBox/Main/idl/midl.xsl =>
18 * out/<platform>/bin/sdk/idl/VirtualBox.idl
19 * (MS COM interface definition file for Main API)
20 *
21 * 2. src/VBox/Main/idl/xpidl.xsl =>
22 * out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
23 * (XPCOM interface definition file for Main API)
24 *
25 * 3. src/VBox/Main/idl/doxygen.xsl =>
26 * out/<platform>/obj/src/VBox/Main/VirtualBox.idl
27 * (pseudo-IDL for Doxygen to generate the official Main API
28 * documentation)
29 *
30 * 4. src/VBox/Main/webservice/*.xsl =>
31 * a bunch of WSDL and C++ files
32 * (VirtualBox web service sources and SOAP mappers;
33 * see src/VBox/Main/webservice/Makefile.kmk for details)
34 *
35 * 5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
36 * out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
37 * (smart Qt-based C++ wrapper classes for COM interfaces
38 * of the Main API)
39 *
40 * 6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
41 * out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
42 * (Main API TypeLib block for the WiX installer)
43 *
44 * 7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
45 * out/<platform>/obj/Runtime/errmsgvboxcomdata.h
46 * (<result> extraction for the %Rhrc format specifier)
47 *
48 Copyright (C) 2006-2009 Sun Microsystems, Inc.
49
50 This file is part of VirtualBox Open Source Edition (OSE), as
51 available from http://www.virtualbox.org. This file is free software;
52 you can redistribute it and/or modify it under the terms of the GNU
53 General Public License (GPL) as published by the Free Software
54 Foundation, in version 2 as it comes in the "COPYING" file of the
55 VirtualBox OSE distribution. VirtualBox OSE is distributed in the
56 hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
57
58 Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
59 Clara, CA 95054 USA or visit http://www.sun.com if you need
60 additional information or have any questions.
61-->
62
63<idl>
64
65<desc>
66 Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
67 describes the so-called <i>VirtualBox Main API</i> which comprises all public
68 COM interfaces and components provided by the VirtualBox server and by the
69 VirtualBox client library.
70
71 VirtualBox employs a client-server design, meaning that whenever any part of
72 VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
73 interface or any virtual machine --, a dedicated server process named
74 VBoxSVC runs in the background. This allows multiple processes working with
75 VirtualBox to cooperate without conflicts. These processes communicate to each
76 other using inter-process communication facilities provided by the COM
77 implementation of the host computer.
78
79 On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
80 implementation. On all other platforms, Mozilla XPCOM, an open-source COM
81 implementation, is used.
82
83 All the parts that a typical VirtualBox user interacts with (the Qt GUI,
84 the VBoxManage command-line interface and the VBoxVRDP server) are technically
85 front-ends to the Main API and only use the interfaces that are documented
86 in this Main API documentation. This ensures that, with any given release
87 version of VirtualBox, all capabilities of the product that could be useful
88 to an external client program are always exposed by way of this API.
89
90 The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
91 contains two public component classes:
92 <tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
93 implement IVirtualBox and ISession interfaces respectively. These two classes
94 are of supreme importance and will be needed in order for any front-end
95 program to do anything useful. It is recommended to read the documentation of
96 the mentioned interfaces first.
97
98 The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
99 there can be only one object of this class on the local machine at any given
100 time. This object is a parent of many other objects in the VirtualBox COM
101 library and lives in the VBoxSVC process. In fact, when you create an instance
102 of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
103 process is already running, starts it if not, and returns you a reference to
104 the <tt>VirtualBox</tt> object created in this process. When the last reference
105 to this object is released, the VBoxSVC process ends (with a 5 second delay to
106 protect from too frequent restarts).
107
108 The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
109 as many <tt>Session</tt> objects as you need but all of them will live in a
110 process which issues the object instantiation call. <tt>Session</tt> objects
111 represent virtual machine sessions which are used to configure virtual
112 machines and control their execution.
113</desc>
114
115<if target="midl">
116 <cpp line="enum {"/>
117 <cpp line=" kTypeLibraryMajorVersion = 1,"/>
118 <cpp line=" kTypeLibraryMinorVersion = 0"/>
119 <cpp line="};"/>
120</if>
121
122<if target="xpidl">
123 <!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
124 <cpp>
125/* currently, nsISupportsImpl.h lacks the below-like macros */
126
127#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
128#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
129
130#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
131# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
132 NS_IMPL_THREADSAFE_ADDREF(_class) \
133 NS_IMPL_THREADSAFE_RELEASE(_class) \
134 NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
135 NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
136#endif
137
138#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
139# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
140 NS_IMPL_THREADSAFE_ADDREF(_class) \
141 NS_IMPL_THREADSAFE_RELEASE(_class) \
142 NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
143 NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
144#endif
145
146#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
147# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
148 NS_INTERFACE_MAP_BEGIN(_class) \
149 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
150 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
151 NS_IMPL_QUERY_CLASSINFO(_class) \
152 NS_INTERFACE_MAP_END
153#endif
154
155#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
156# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
157 _i2, _ic2) \
158 NS_INTERFACE_MAP_BEGIN(_class) \
159 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
160 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
161 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
162 NS_IMPL_QUERY_CLASSINFO(_class) \
163 NS_INTERFACE_MAP_END
164#endif
165
166#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
167#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
168
169#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
170# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
171 NS_IMPL_THREADSAFE_ADDREF(_class) \
172 NS_IMPL_THREADSAFE_RELEASE(_class) \
173 NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
174 NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
175#endif
176
177#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
178# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
179 _i2, _ic2) \
180 NS_IMPL_THREADSAFE_ADDREF(_class) \
181 NS_IMPL_THREADSAFE_RELEASE(_class) \
182 NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
183 _i2, _ic2) \
184 NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
185#endif
186 </cpp>
187</if>
188
189<library
190 name="VirtualBox"
191 uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
192 version="1.3"
193 desc="VirtualBox Type Library"
194 appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
195 supportsErrorInfo="yes"
196>
197
198
199 <!--
200 // COM result codes for VirtualBox
201 /////////////////////////////////////////////////////////////////////////
202 -->
203
204 <descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
205 <desc>
206 This section describes all VirtualBox-specific COM result codes that may
207 be returned by methods of VirtualBox COM interfaces in addition to
208 standard COM result codes.
209
210 Note that along with the result code, every VirtualBox method returns
211 extended error information through the IVirtualBoxErrorInfo interface on
212 failure. This interface is a preferred way to present the error to the end
213 user because it contains a human readable description of the error. Raw
214 result codes, both standard and described in this section, are intended to
215 be used by programs to analyze the reason of a failure and select an
216 appropriate course of action without involving the end user (for example,
217 retry the operation later or make a different call).
218
219 The standard COM result codes that may originate from our methods include:
220
221 <table>
222 <tr><td>E_INVALIDARG</td>
223 <td>
224 Returned when the value of the method's argument is not within the range
225 of valid values. This should not be confused with situations when the
226 value is within the range but simply doesn't suit the current object
227 state and there is a possibility that it will be accepted later (in such
228 cases VirtualBox-specific codes are returned, for example,
229 <link to="VBOX_E_OBJECT_NOT_FOUND"/>).
230 </td>
231 </tr>
232 <tr><td>E_POINTER</td>
233 <td>
234 Returned if a memory pointer for the output argument is invalid (for
235 example, <tt>NULL</tt>). Note that when pointers representing input
236 arguments (such as strings) are invalid, E_INVALIDARG is returned.
237 </td>
238 </tr>
239 <tr><td>E_ACCESSDENIED</td>
240 <td>
241 Returned when the called object is not ready. Since the lifetime of a
242 public COM object cannot be fully controlled by the implementation,
243 VirtualBox maintains the readiness state for all objects it creates and
244 returns this code in response to any method call on the object that was
245 deactivated by VirtualBox and is not functioning any more.
246 </td>
247 </tr>
248 <tr><td>E_OUTOFMEMORY</td>
249 <td>
250 Returned when a memory allocation operation fails.
251 </td>
252 </tr>
253 </table>
254 </desc>
255 </descGroup>
256
257 <!--
258 Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
259 everything in <result>/<desc> after (and including) the first dot, so express
260 the matter of the error code in the first sentence and keep it short.
261 -->
262
263 <result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
264 <desc>
265 Object corresponding to the supplied arguments does not exist.
266 </desc>
267 </result>
268
269 <result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
270 <desc>
271 Current virtual machine state prevents the operation.
272 </desc>
273 </result>
274
275 <result name="VBOX_E_VM_ERROR" value="0x80BB0003">
276 <desc>
277 Virtual machine error occurred attempting the operation.
278 </desc>
279 </result>
280
281 <result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
282 <desc>
283 File not accessible or erroneous file contents.
284 </desc>
285 </result>
286
287 <result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
288 <desc>
289 Runtime subsystem error.
290 </desc>
291 </result>
292
293 <result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
294 <desc>
295 Pluggable Device Manager error.
296 </desc>
297 </result>
298
299 <result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
300 <desc>
301 Current object state prohibits operation.
302 </desc>
303 </result>
304
305 <result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
306 <desc>
307 Host operating system related error.
308 </desc>
309 </result>
310
311 <result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
312 <desc>
313 Requested operation is not supported.
314 </desc>
315 </result>
316
317 <result name="VBOX_E_XML_ERROR" value="0x80BB000A">
318 <desc>
319 Invalid XML found.
320 </desc>
321 </result>
322
323 <result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
324 <desc>
325 Current session state prohibits operation.
326 </desc>
327 </result>
328
329 <result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
330 <desc>
331 Object being in use prohibits operation.
332 </desc>
333 </result>
334
335 <!--
336 Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
337 everything in <result>/<desc> after (and including) the first dot, so express
338 the matter of the error code in the first sentence and keep it short.
339 -->
340
341 <descGroup/>
342
343 <!--
344 // all common enums
345 /////////////////////////////////////////////////////////////////////////
346 -->
347
348 <enum
349 name="TSBool"
350 uuid="523ff64d-842a-4b1a-80e7-c311b028cb3a"
351 >
352 <desc>
353 Boolean variable having a third state, default.
354 </desc>
355
356 <const name="False" value="0"/>
357 <const name="True" value="1"/>
358 <const name="Default" value="2"/>
359 </enum>
360
361 <enum
362 name="MachineState"
363 uuid="73bf04d0-7c4f-4684-9abf-d65a9ad74343"
364 >
365 <desc>
366 Virtual machine execution state.
367
368 This enumeration represents possible values of the <link
369 to="IMachine::state"/> attribute.
370
371 Below is the basic virtual machine state diagram. It shows how the state
372 changes during virtual machine execution. The text in square braces shows
373 a method of the IConsole interface that performs the given state
374 transition.
375
376 <pre>
377 +---------[powerDown()] &lt;- Stuck &lt;--[failure]-+
378 V |
379 +-&gt; PoweredOff --+--&gt;[powerUp()]--&gt; Starting --+ | +-----[resume()]-----+
380 | | | | V |
381 | Aborted -----+ +--&gt; Running --[pause()]--&gt; Paused
382 | | ^ | ^ |
383 | Saved -----------[powerUp()]--&gt; Restoring -+ | | | |
384 | ^ | | | |
385 | | +-----------------------------------------+-|-------------------+ +
386 | | | | |
387 | | +-- Saving &lt;--------[takeSnapshot()]&lt;-------+---------------------+
388 | | | |
389 | +-------- Saving &lt;--------[saveState()]&lt;----------+---------------------+
390 | | |
391 +-------------- Stopping -------[powerDown()]&lt;----------+---------------------+
392 </pre>
393
394 Note that states to the right from PoweredOff, Aborted and Saved in the
395 above diagram are called <i>online VM states</i>. These states
396 represent the virtual machine which is being executed in a dedicated
397 process (usually with a GUI window attached to it where you can see the
398 activity of the virtual machine and interact with it). There are two
399 special pseudo-states, FirstOnline and LastOnline, that can be used in
400 relational expressions to detect if the given machine state is online or
401 not:
402
403 <pre>
404 if (machine.GetState() &gt;= MachineState_FirstOnline &amp;&amp;
405 machine.GetState() &lt;= MachineState_LastOnline)
406 {
407 ...the machine is being executed...
408 }
409 </pre>
410
411 When the virtual machine is in one of the online VM states (that is, being
412 executed), only a few machine settings can be modified. Methods working
413 with such settings contain an explicit note about that. An attempt to
414 change any oter setting or perform a modifying operation during this time
415 will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
416
417 All online states except Running, Paused and Stuck are transitional: they
418 represent temporary conditions of the virtual machine that will last as
419 long as the operation that initiated such a condition.
420
421 The Stuck state is a special case. It means that execution of the machine
422 has reached the "Guru Meditation" condition. This condition indicates an
423 internal VMM (virtual machine manager) failure which may happen as a
424 result of either an unhandled low-level virtual hardware exception or one
425 of the recompiler exceptions (such as the <i>too-many-traps</i>
426 condition).
427
428 Note also that any online VM state may transit to the Aborted state. This
429 happens if the process that is executing the virtual machine terminates
430 unexpectedly (for example, crashes). Other than that, the Aborted state is
431 equivalent to PoweredOff.
432
433 There are also a few additional state diagrams that do not deal with
434 virtual machine execution and therefore are shown separately. The states
435 shown on these diagrams are called <i>offline VM states</i> (this includes
436 PoweredOff, Aborted and Saved too).
437
438 The first diagram shows what happens when a lengthy setup operation is
439 being executed (such as <link to="IMachine::attachHardDisk"/>).
440
441 <pre>
442 +-----------------------------------(same sate as before the call)------+
443 | |
444 +-&gt; PoweredOff --+ |
445 | | |
446 |-&gt; Aborted -----+--&gt;[lengthy VM configuration call] --&gt; SettingUp -----+
447 | |
448 +-&gt; Saved -------+
449 </pre>
450
451 The next two diagrams demonstrate the process of taking a snapshot of a
452 powered off virtual machine and performing one of the "discard..."
453 operations, respectively.
454
455 <pre>
456 +-----------------------------------(same sate as before the call)------+
457 | |
458 +-&gt; PoweredOff --+ |
459 | +--&gt;[takeSnapshot()] -------------------&gt; Saving ------+
460 +-&gt; Aborted -----+
461
462 +-&gt; PoweredOff --+
463 | |
464 | Aborted -----+--&gt;[discardSnapshot() ]-------------&gt; Discarding --+
465 | | [discardCurrentState()] |
466 +-&gt; Saved -------+ [discardCurrentSnapshotAndState()] |
467 | |
468 +---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
469 </pre>
470
471 Note that the Saving state is present in both the offline state group and
472 online state group. Currently, the only way to determine what group is
473 assumed in a particular case is to remember the previous machine state: if
474 it was Running or Paused, then Saving is an online state, otherwise it is
475 an offline state. This inconsistency may be removed in one of the future
476 versions of VirtualBox by adding a new state.
477
478 <note internal="yes">
479 For whoever decides to touch this enum: In order to keep the
480 comparisons involving FirstOnline and LastOnline pseudo-states valid,
481 the numeric values of these states must be correspondingly updated if
482 needed: for any online VM state, the condition
483 <tt>FirstOnline &lt;= state &lt;= LastOnline</tt> must be
484 <tt>true</tt>. The same relates to transient states for which
485 the condition <tt>FirstOnline &lt;= state &lt;= LastOnline</tt> must be
486 <tt>true</tt>.
487 </note>
488 </desc>
489
490 <const name="Null" value="0">
491 <desc>Null value (nver used by the API).</desc>
492 </const>
493 <const name="PoweredOff" value="1">
494 <desc>
495 The machine is not running.
496 </desc>
497 </const>
498 <const name="Saved" value="2">
499 <desc>
500 The machine is not currently running, but the execution state of the machine
501 has been saved to an external file when it was running.
502 </desc>
503 </const>
504 <const name="Aborted" value="3">
505 <desc>
506 The process running the machine has terminated abnormally.
507 </desc>
508 </const>
509 <const name="Running" value="4">
510 <desc>
511 The machine is currently being executed.
512 <note internal="yes">
513 For whoever decides to touch this enum: In order to keep the
514 comparisons in the old source code valid, this state must immediately
515 precede the Paused state.
516 </note>
517 </desc>
518 </const>
519 <const name="Paused" value="5">
520 <desc>
521 Execution of the machine has been paused.
522 <note internal="yes">
523 For whoever decides to touch this enum: In order to keep the
524 comparisons in the old source code valid, this state must immediately
525 follow the Running state.
526 </note>
527 </desc>
528 </const>
529 <const name="Stuck" value="6">
530 <desc>
531 Execution of the machine has reached the "Guru Meditation"
532 condition.
533 </desc>
534 </const>
535 <const name="Starting" value="7">
536 <desc>
537 Machine is being started after powering it on from a
538 zero execution state.
539 </desc>
540 </const>
541 <const name="Stopping" value="8">
542 <desc>
543 Machine is being normally stopped powering it off, or after the guest OS
544 has initiated a shutdown sequence.
545 </desc>
546 </const>
547 <const name="Saving" value="9">
548 <desc>
549 Machine is saving its execution state to a file or an online
550 snapshot of the machine is being taken.
551 </desc>
552 </const>
553 <const name="Restoring" value="10">
554 <desc>
555 Execution state of the machine is being restored from a file
556 after powering it on from the saved execution state.
557 </desc>
558 </const>
559 <const name="Discarding" value="11">
560 <desc>
561 Snapshot of the machine is being discarded.
562 </desc>
563 </const>
564 <const name="SettingUp" value="12">
565 <desc>
566 Lengthy setup operation is in progress.
567 </desc>
568 </const>
569
570 <const name="FirstOnline" value="4" wsmap="suppress"> <!-- Running -->
571 <desc>
572 Pseudo-state: first online state (for use in relational expressions).
573 </desc>
574 </const>
575 <const name="LastOnline" value="10" wsmap="suppress"> <!-- Restoring -->
576 <desc>
577 Pseudo-state: last online state (for use in relational expressions).
578 </desc>
579 </const>
580
581 <const name="FirstTransient" value="7" wsmap="suppress"> <!-- Starting -->
582 <desc>
583 Pseudo-state: first transient state (for use in relational expressions).
584 </desc>
585 </const>
586 <const name="LastTransient" value="12" wsmap="suppress"> <!-- SettingUp -->
587 <desc>
588 Pseudo-state: last transient state (for use in relational expressions).
589 </desc>
590 </const>
591
592 </enum>
593
594 <enum
595 name="SessionState"
596 uuid="CF2700C0-EA4B-47ae-9725-7810114B94D8"
597 >
598 <desc>
599 Session state. This enumeration represents possible values of
600 <link to="IMachine::sessionState"/> and <link to="ISession::state"/>
601 attributes. See individual enumerator descriptions for the meaning for
602 every value.
603 </desc>
604
605 <const name="Null" value="0">
606 <desc>Null value (never used by the API).</desc>
607 </const>
608 <const name="Closed" value="1">
609 <desc>
610 The machine has no open sessions (<link to="IMachine::sessionState"/>);
611 the session is closed (<link to="ISession::state"/>)
612 </desc>
613 </const>
614 <const name="Open" value="2">
615 <desc>
616 The machine has an open direct session (<link to="IMachine::sessionState"/>);
617 the session is open (<link to="ISession::state"/>)
618 </desc>
619 </const>
620 <const name="Spawning" value="3">
621 <desc>
622 A new (direct) session is being opened for the machine
623 as a result of <link to="IVirtualBox::openRemoteSession"/>
624 call (<link to="IMachine::sessionState"/>);
625 the session is currently being opened
626 as a result of <link to="IVirtualBox::openRemoteSession"/>
627 call (<link to="ISession::state"/>)
628 </desc>
629 </const>
630 <const name="Closing" value="4">
631 <desc>
632 The direct session is being closed (<link to="IMachine::sessionState"/>);
633 the session is being closed (<link to="ISession::state"/>)
634 </desc>
635 </const>
636 </enum>
637
638 <enum
639 name="SessionType"
640 uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
641 >
642 <desc>
643 Session type. This enumeration represents possible values of the
644 <link to="ISession::type"/> attribute.
645 </desc>
646
647 <const name="Null" value="0">
648 <desc>Null value (never used by the API).</desc>
649 </const>
650 <const name="Direct" value="1">
651 <desc>
652 Direct session
653 (opened by <link to="IVirtualBox::openSession"/>)
654 </desc>
655 </const>
656 <const name="Remote" value="2">
657 <desc>
658 Remote session
659 (opened by <link to="IVirtualBox::openRemoteSession"/>)
660 </desc>
661 </const>
662 <const name="Existing" value="3">
663 <desc>
664 Existing session
665 (opened by <link to="IVirtualBox::openExistingSession"/>)
666 </desc>
667 </const>
668 </enum>
669
670 <enum
671 name="DeviceType"
672 uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
673 >
674 <desc>
675 Device type.
676 </desc>
677 <const name="Null" value="0">
678 <desc>
679 Null value, may also mean "no device" (not allowed for
680 <link to="IConsole::getDeviceActivity"/>).
681 </desc>
682 </const>
683 <const name="Floppy" value="1">
684 <desc>Floppy device.</desc>
685 </const>
686 <const name="DVD" value="2">
687 <desc>CD/DVD-ROM device.</desc>
688 </const>
689 <const name="HardDisk" value="3">
690 <desc>Hard disk device.</desc>
691 </const>
692 <const name="Network" value="4">
693 <desc>Network device.</desc>
694 </const>
695 <const name="USB" value="5">
696 <desc>USB device.</desc>
697 </const>
698 <const name="SharedFolder" value="6">
699 <desc>Shared folder device.</desc>
700 </const>
701 </enum>
702
703 <enum
704 name="DeviceActivity"
705 uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
706 >
707 <desc>
708 Device activity for <link to="IConsole::getDeviceActivity"/>.
709 </desc>
710
711 <const name="Null" value="0"/>
712 <const name="Idle" value="1"/>
713 <const name="Reading" value="2"/>
714 <const name="Writing" value="3"/>
715 </enum>
716
717 <enum
718 name="StorageBus"
719 uuid="715984a5-093c-43bb-aa42-a16ed16828dd"
720 >
721 <desc>Interface bus type for storage devices.</desc>
722
723 <const name="Null" value="0">
724 <desc>Null value (never used by the API).</desc>
725 </const>
726
727 <const name="IDE" value="1"/>
728 <const name="SATA" value="2"/>
729 </enum>
730
731 <enum
732 name="ClipboardMode"
733 uuid="33364716-4008-4701-8f14-be0fa3d62950"
734 >
735 <desc>
736 Host-Guest clipboard interchange mode.
737 </desc>
738
739 <const name="Disabled" value="0"/>
740 <const name="HostToGuest" value="1"/>
741 <const name="GuestToHost" value="2"/>
742 <const name="Bidirectional" value="3"/>
743 </enum>
744
745 <enum
746 name="Scope"
747 uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
748 >
749 <desc>
750 Scope of the operation.
751
752 A generic enumeration used in various methods to define the action or
753 argument scope.
754 </desc>
755
756 <const name="Global" value="0"/>
757 <const name="Machine" value="1"/>
758 <const name="Session" value="2"/>
759 </enum>
760
761 <enum
762 name="GuestStatisticType"
763 uuid="aa7c1d71-aafe-47a8-9608-27d2d337cf55"
764 >
765 <desc>
766 Statistics type for <link to="IGuest::getStatistic"/>.
767 </desc>
768
769 <const name="CPULoad_Idle" value="0">
770 <desc>
771 Idle CPU load (0-100%) for last interval.
772 </desc>
773 </const>
774 <const name="CPULoad_Kernel" value="1">
775 <desc>
776 Kernel CPU load (0-100%) for last interval.
777 </desc>
778 </const>
779 <const name="CPULoad_User" value="2">
780 <desc>
781 User CPU load (0-100%) for last interval.
782 </desc>
783 </const>
784 <const name="Threads" value="3">
785 <desc>
786 Total number of threads in the system.
787 </desc>
788 </const>
789 <const name="Processes" value="4">
790 <desc>
791 Total number of processes in the system.
792 </desc>
793 </const>
794 <const name="Handles" value="5">
795 <desc>
796 Total number of handles in the system.
797 </desc>
798 </const>
799 <const name="MemoryLoad" value="6">
800 <desc>
801 Memory load (0-100%).
802 </desc>
803 </const>
804 <const name="PhysMemTotal" value="7">
805 <desc>
806 Total physical memory in megabytes.
807 </desc>
808 </const>
809 <const name="PhysMemAvailable" value="8">
810 <desc>
811 Free physical memory in megabytes.
812 </desc>
813 </const>
814 <const name="PhysMemBalloon" value="9">
815 <desc>
816 Ballooned physical memory in megabytes.
817 </desc>
818 </const>
819 <const name="MemCommitTotal" value="10">
820 <desc>
821 Total amount of memory in the committed state in megabytes.
822 </desc>
823 </const>
824 <const name="MemKernelTotal" value="11">
825 <desc>
826 Total amount of memory used by the guest OS's kernel in megabytes.
827 </desc>
828 </const>
829 <const name="MemKernelPaged" value="12">
830 <desc>
831 Total amount of paged memory used by the guest OS's kernel in megabytes.
832 </desc>
833 </const>
834 <const name="MemKernelNonpaged" value="13">
835 <desc>
836 Total amount of non-paged memory used by the guest OS's kernel in megabytes.
837 </desc>
838 </const>
839 <const name="MemSystemCache" value="14">
840 <desc>
841 Total amount of memory used by the guest OS's system cache in megabytes.
842 </desc>
843 </const>
844 <const name="PageFileSize" value="15">
845 <desc>
846 Pagefile size in megabytes.
847 </desc>
848 </const>
849 <const name="SampleNumber" value="16">
850 <desc>
851 Statistics sample number
852 </desc>
853 </const>
854 <const name="MaxVal" value="17"/>
855 </enum>
856
857 <enum
858 name="BIOSBootMenuMode"
859 uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
860 >
861 <desc>
862 BIOS boot menu mode.
863 </desc>
864
865 <const name="Disabled" value="0"/>
866 <const name="MenuOnly" value="1"/>
867 <const name="MessageAndMenu" value="2"/>
868 </enum>
869
870 <enum
871 name="IDEControllerType"
872 uuid="445330e3-202a-4dab-854f-ce22e6cb9715"
873 >
874 <desc>
875 IDE controller type.
876 </desc>
877
878 <const name="Null" value="0">
879 <desc>Null value (never used by the API).</desc>
880 </const>
881 <const name="PIIX3" value="1"/>
882 <const name="PIIX4" value="2"/>
883 <const name="ICH6" value="3"/>
884 </enum>
885
886 <enum
887 name="DriveState"
888 uuid="cb7233b7-c519-42a5-8310-1830953cacbc"
889 >
890 <const name="Null" value="0">
891 <desc>Null value (never used by the API).</desc>
892 </const>
893 <const name="NotMounted" value="1"/>
894 <const name="ImageMounted" value="2"/>
895 <const name="HostDriveCaptured" value="3"/>
896 </enum>
897
898 <enum
899 name="ProcessorFeature"
900 uuid="b8353b35-705d-4796-9967-ebfb7ba54af4"
901 >
902 <desc>
903 CPU features.
904 </desc>
905
906 <const name="HWVirtEx" value="0"/>
907 <const name="PAE" value="1"/>
908 <const name="LongMode" value="2"/>
909 </enum>
910
911
912 <!--
913 // IVirtualBoxErrorInfo
914 /////////////////////////////////////////////////////////////////////////
915 -->
916
917 <interface
918 name="IVirtualBoxErrorInfo" extends="$errorinfo"
919 uuid="e98b5376-8eb4-4eea-812a-3964bf3bb26f"
920 supportsErrorInfo="no"
921 wsmap="suppress"
922 >
923 <desc>
924 The IVirtualBoxErrorInfo interface represents extended error information.
925
926 Extended error information can be set by VirtualBox components after
927 unsuccessful or partially successful method invocation. This information
928 can be retrieved by the calling party as an IVirtualBoxErrorInfo object
929 and then shown to the client in addition to the plain 32-bit result code.
930
931 In MS COM, this interface extends the IErrorInfo interface,
932 in XPCOM, it extends the nsIException interface. In both cases,
933 it provides a set of common attributes to retrieve error
934 information.
935
936 Sometimes invocation of some component's method may involve methods of
937 other components that may also fail (independently of this method's
938 failure), or a series of non-fatal errors may precede a fatal error that
939 causes method failure. In cases like that, it may be desirable to preserve
940 information about all errors happened during method invocation and deliver
941 it to the caller. The <link to="#next"/> attribute is intended
942 specifically for this purpose and allows to represent a chain of errors
943 through a single IVirtualBoxErrorInfo object set after method invocation.
944
945 Note that errors are stored to a chain in the reverse order, i.e. the
946 initial error object you query right after method invocation is the last
947 error set by the callee, the object it points to in the @a next attribute
948 is the previous error and so on, up to the first error (which is the last
949 in the chain).
950 </desc>
951
952 <attribute name="resultCode" type="result" readonly="yes">
953 <desc>
954 Result code of the error.
955 Usually, it will be the same as the result code returned
956 by the method that provided this error information, but not
957 always. For example, on Win32, CoCreateInstance() will most
958 likely return E_NOINTERFACE upon unsuccessful component
959 instantiation attempt, but not the value the component factory
960 returned.
961 <note>
962 In MS COM, there is no equivalent.
963 In XPCOM, it is the same as nsIException::result.
964 </note>
965 </desc>
966 </attribute>
967
968 <attribute name="interfaceID" type="uuid" readonly="yes">
969 <desc>
970 UUID of the interface that defined the error.
971 <note>
972 In MS COM, it is the same as IErrorInfo::GetGUID.
973 In XPCOM, there is no equivalent.
974 </note>
975 </desc>
976 </attribute>
977
978 <attribute name="component" type="wstring" readonly="yes">
979 <desc>
980 Name of the component that generated the error.
981 <note>
982 In MS COM, it is the same as IErrorInfo::GetSource.
983 In XPCOM, there is no equivalent.
984 </note>
985 </desc>
986 </attribute>
987
988 <attribute name="text" type="wstring" readonly="yes">
989 <desc>
990 Text description of the error.
991 <note>
992 In MS COM, it is the same as IErrorInfo::GetDescription.
993 In XPCOM, it is the same as nsIException::message.
994 </note>
995 </desc>
996 </attribute>
997
998 <attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
999 <desc>
1000 Next error object if there is any, or @c null otherwise.
1001 <note>
1002 In MS COM, there is no equivalent.
1003 In XPCOM, it is the same as nsIException::inner.
1004 </note>
1005 </desc>
1006 </attribute>
1007
1008 </interface>
1009
1010
1011 <!--
1012 // IVirtualBox
1013 /////////////////////////////////////////////////////////////////////////
1014 -->
1015
1016 <interface
1017 name="IVirtualBoxCallback" extends="$unknown"
1018 uuid="5516cc08-fb81-47a6-b184-031e7bbd2997"
1019 wsmap="suppress"
1020 >
1021 <method name="onMachineStateChange">
1022 <desc>
1023 The execution state of the given machine has changed.
1024 <see>IMachine::state</see>
1025 </desc>
1026 <param name="machineId" type="uuid" dir="in">
1027 <desc>ID of the machine this event relates to.</desc>
1028 </param>
1029 <param name="state" type="MachineState" dir="in">
1030 <desc>New execution state.</desc>
1031 </param>
1032 </method>
1033
1034 <method name="onMachineDataChange">
1035 <desc>
1036 Any of the settings of the given machine has changed.
1037 </desc>
1038 <param name="machineId" type="uuid" dir="in">
1039 <desc>ID of the machine this event relates to.</desc>
1040 </param>
1041 </method>
1042
1043 <method name="onExtraDataCanChange">
1044 <desc>
1045 Notification when someone tries to change extra data for
1046 either the given machine or (if null) global extra data.
1047 This gives the chance to veto against changes.
1048 </desc>
1049 <param name="machineId" type="uuid" dir="in">
1050 <desc>
1051 ID of the machine this event relates to
1052 (null ID for global extra data change requests).
1053 </desc>
1054 </param>
1055 <param name="key" type="wstring" dir="in">
1056 <desc>
1057 Extra data key for the attempted write.
1058 </desc>
1059 </param>
1060 <param name="value" type="wstring" dir="in">
1061 <desc>
1062 Extra data value for the given key.
1063 </desc>
1064 </param>
1065 <param name="error" type="wstring" dir="out">
1066 <desc>
1067 Optional error message describing the reason of the
1068 veto (ignored if this notification returns @c true).
1069 </desc>
1070 </param>
1071 <param name="allowChange" type="boolean" dir="return">
1072 <desc>
1073 Flag to indicate whether the callee agrees (@c true)
1074 or vetoes against the change (@c false).
1075 </desc>
1076 </param>
1077 </method>
1078
1079 <method name="onExtraDataChange">
1080 <desc>
1081 Notification when machine specific or global extra data
1082 has changed.
1083 </desc>
1084 <param name="machineId" type="uuid" dir="in">
1085 <desc>
1086 ID of the machine this event relates to.
1087 Null for global extra data changes.
1088 </desc>
1089 </param>
1090 <param name="key" type="wstring" dir="in">
1091 <desc>
1092 Extra data key that has changed.
1093 </desc>
1094 </param>
1095 <param name="value" type="wstring" dir="in">
1096 <desc>
1097 Extra data value for the given key.
1098 </desc>
1099 </param>
1100 </method>
1101
1102 <method name="onMediaRegistered">
1103 <desc>
1104 The given media was registered or unregistered
1105 within this VirtualBox installation.
1106
1107 The @a mediaType parameter describes what type of
1108 media the specified @a mediaId refers to. Possible
1109 values are:
1110
1111 <ul>
1112 <li><link to="DeviceType_HardDisk"/>: the media is a hard disk
1113 that, if registered, can be obtained using the
1114 <link to="IVirtualBox::getHardDisk"/> call.</li>
1115 <li><link to="DeviceType_DVD"/>: the media is a CD/DVD image
1116 that, if registered, can be obtained using the
1117 <link to="IVirtualBox::getDVDImage"/> call.</li>
1118 <li><link to="DeviceType_Floppy"/>: the media is a Floppy image
1119 that, if registered, can be obtained using the
1120 <link to="IVirtualBox::getFloppyImage"/> call.</li>
1121 </ul>
1122
1123 Note that if this is a deregistration notification,
1124 there is no way to access the object representing the
1125 unregistered media. It is supposed that the
1126 application will do required cleanup based on the
1127 @a mediaId value.
1128 </desc>
1129 <param name="mediaId" type="uuid" dir="in">
1130 <desc>ID of the media this event relates to.</desc>
1131 </param>
1132 <param name="mediaType" type="DeviceType" dir="in">
1133 <desc>Type of the media this event relates to.</desc>
1134 </param>
1135 <param name="registered" type="boolean" dir="in">
1136 <desc>
1137 If true, the media was registered, otherwise it was
1138 unregistered.
1139 </desc>
1140 </param>
1141 </method>
1142
1143 <method name="onMachineRegistered">
1144 <desc>
1145 The given machine was registered or unregistered
1146 within this VirtualBox installation.
1147 </desc>
1148 <param name="machineId" type="uuid" dir="in">
1149 <desc>ID of the machine this event relates to.</desc>
1150 </param>
1151 <param name="registered" type="boolean" dir="in">
1152 <desc>
1153 If true, the machine was registered, otherwise it was
1154 unregistered.
1155 </desc>
1156 </param>
1157 </method>
1158
1159 <method name="onSessionStateChange">
1160 <desc>
1161 The state of the session for the given machine was changed.
1162 <see>IMachine::sessionState</see>
1163 </desc>
1164 <param name="machineId" type="uuid" dir="in">
1165 <desc>ID of the machine this event relates to.</desc>
1166 </param>
1167 <param name="state" type="SessionState" dir="in">
1168 <desc>New session state.</desc>
1169 </param>
1170 </method>
1171
1172 <method name="onSnapshotTaken">
1173 <desc>
1174 A new snapshot of the machine has been taken.
1175 <see>ISnapshot</see>
1176 </desc>
1177 <param name="machineId" type="uuid" dir="in">
1178 <desc>ID of the machine this event relates to.</desc>
1179 </param>
1180 <param name="snapshotId" type="uuid" dir="in">
1181 <desc>ID of the new snapshot.</desc>
1182 </param>
1183 </method>
1184
1185 <method name="onSnapshotDiscarded">
1186 <desc>
1187 Snapshot of the given machine has been discarded.
1188
1189 <note>
1190 This notification is delivered <b>after</b> the snapshot
1191 object has been uninitialized on the server (so that any
1192 attempt to call its methods will return an error).
1193 </note>
1194
1195 <see>ISnapshot</see>
1196 </desc>
1197 <param name="machineId" type="uuid" dir="in">
1198 <desc>ID of the machine this event relates to.</desc>
1199 </param>
1200 <param name="snapshotId" type="uuid" dir="in">
1201 <desc>
1202 ID of the discarded snapshot. <tt>null</tt> means the
1203 current machine state has been discarded (restored from
1204 the current snapshot).
1205 </desc>
1206 </param>
1207 </method>
1208
1209 <method name="onSnapshotChange">
1210 <desc>
1211 Snapshot properties (name and/or description) have been changed.
1212 <see>ISnapshot</see>
1213 </desc>
1214 <param name="machineId" type="uuid" dir="in">
1215 <desc>ID of the machine this event relates to.</desc>
1216 </param>
1217 <param name="snapshotId" type="uuid" dir="in">
1218 <desc>ID of the changed snapshot.</desc>
1219 </param>
1220 </method>
1221
1222 <method name="onGuestPropertyChange">
1223 <desc>
1224 Notification when a guest property has changed.
1225 </desc>
1226 <param name="machineId" type="uuid" dir="in">
1227 <desc>
1228 ID of the machine this event relates to.
1229 </desc>
1230 </param>
1231 <param name="name" type="wstring" dir="in">
1232 <desc>
1233 The name of the property that has changed.
1234 </desc>
1235 </param>
1236 <param name="value" type="wstring" dir="in">
1237 <desc>
1238 The new property value.
1239 </desc>
1240 </param>
1241 <param name="flags" type="wstring" dir="in">
1242 <desc>
1243 The new property flags.
1244 </desc>
1245 </param>
1246 </method>
1247
1248 </interface>
1249
1250 <interface
1251 name="IVirtualBox" extends="$dispatched"
1252 uuid="339abca2-f47a-4302-87f5-7bc324e6bbde"
1253 wsmap="managed"
1254 >
1255 <desc>
1256 The IVirtualBox interface represents the main interface exposed by the
1257 product that provides virtual machine management.
1258
1259 An instance of IVirtualBox is required for the product to do anything
1260 useful. Even though the interface does not expose this, internally,
1261 IVirtualBox is implemented as a singleton and actually lives in the
1262 process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1263 IVirtualBox can track the state of all virtual machines on a particular
1264 host, regardless of which frontend started them.
1265
1266 To enumerate all the virtual machines on the host, use the
1267 <link to="IVirtualBox::machines2"/> attribute.
1268 </desc>
1269
1270 <attribute name="version" type="wstring" readonly="yes">
1271 <desc>
1272 A string representing the version number of the product. The
1273 format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1274 last number represents the build number and will frequently change.
1275 </desc>
1276 </attribute>
1277
1278 <attribute name="revision" type="unsigned long" readonly="yes">
1279 <desc>
1280 The internal build revision number of the product.
1281 </desc>
1282 </attribute>
1283
1284 <attribute name="packageType" type="wstring" readonly="yes">
1285 <desc>
1286 A string representing the package type of this product. The
1287 format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1288 SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1289 is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1290 this.
1291 </desc>
1292 </attribute>
1293
1294 <attribute name="homeFolder" type="wstring" readonly="yes">
1295 <desc>
1296 Full path to the directory where the global settings file,
1297 <tt>VirtualBox.xml</tt>, is stored.
1298
1299 In this version of VirtualBox, the value of this property is
1300 always <tt>&lt;user_dir&gt;/.VirtualBox</tt> (where
1301 <tt>&lt;user_dir&gt;</tt> is the path to the user directory,
1302 as determined by the host OS), and cannot be changed.
1303
1304 This path is also used as the base to resolve relative paths in
1305 places where relative paths are allowed (unless otherwise
1306 expressly indicated).
1307 </desc>
1308 </attribute>
1309
1310 <attribute name="settingsFilePath" type="wstring" readonly="yes">
1311 <desc>
1312 Full name of the global settings file.
1313 The value of this property corresponds to the value of
1314 <link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1315 </desc>
1316 </attribute>
1317
1318 <attribute name="settingsFileVersion" type="wstring" readonly="yes">
1319 <desc>
1320 Current version of the format of the global VirtualBox settings file
1321 (<tt>VirtualBox.xml</tt>).
1322
1323 The version string has the following format:
1324 <pre>
1325 x.y-platform
1326 </pre>
1327 where <tt>x</tt> and <tt>y</tt> are the major and the minor format
1328 versions, and <tt>platform</tt> is the platform identifier.
1329
1330 The current version usually matches the value of the
1331 <link to="#settingsFormatVersion"/> attribute unless the
1332 settings file was created by an older version of VirtualBox and there
1333 was a change of the settings file format since then.
1334
1335 Note that VirtualBox automatically converts settings files from older
1336 versions to the most recent version when reading them (usually at
1337 VirtualBox startup) but it doesn't save the changes back until
1338 you call a method that implicitly saves settings (such as
1339 <link to="#setExtraData"/>) or call <link to="#saveSettings"/>
1340 explicitly. Therefore, if the value of this attribute differs from the
1341 value of <link to="#settingsFormatVersion"/>, then it
1342 means that the settings file was converted but the result of the
1343 conversion is not yet saved to disk.
1344
1345 The above feature may be used by interactive front-ends to inform users
1346 about the settings file format change and offer them to explicitly save
1347 all converted settings files (the global and VM-specific ones),
1348 optionally create backup copies of the old settings files before saving,
1349 etc.
1350
1351 <see>settingsFormatVersion, saveSettingsWithBackup()</see>
1352 </desc>
1353 </attribute>
1354
1355 <attribute name="settingsFormatVersion" type="wstring" readonly="yes">
1356 <desc>
1357 Most recent version of the settings file format.
1358
1359 The version string has the following format:
1360 <pre>
1361 x.y-platform
1362 </pre>
1363 where <tt>x</tt> and <tt>y</tt> are the major and the minor format
1364 versions, and <tt>platform</tt> is the platform identifier.
1365
1366 VirtualBox uses this version of the format when saving settings files
1367 (either as a result of method calls that require to save settings or as
1368 a result of an explicit call to <link to="#saveSettings"/>).
1369
1370 <see>settingsFileVersion</see>
1371 </desc>
1372 </attribute>
1373
1374 <attribute name="host" type="IHost" readonly="yes">
1375 <desc>Associated host object.</desc>
1376 </attribute>
1377
1378 <attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1379 <desc>Associated system information object.</desc>
1380 </attribute>
1381
1382 <attribute name="machines2" type="IMachine" readonly="yes" safearray="yes">
1383 <desc>
1384 Array of machine objects registered within this VirtualBox instance.
1385 </desc>
1386 </attribute>
1387
1388 <attribute name="hardDisks" type="IHardDisk" readonly="yes" safearray="yes">
1389 <desc>
1390 Array of hard disk objects known to this VirtualBox installation.
1391
1392 This array contains only base (root) hard disks. All differencing
1393 hard disks of the given base hard disk can be enumerated using
1394 <link to="IHardDisk::children"/>.
1395 </desc>
1396 </attribute>
1397
1398 <attribute name="DVDImages" type="IDVDImage" readonly="yes" safearray="yes">
1399 <desc>
1400 Array of CD/DVD image objects registered with this VirtualBox instance.
1401 </desc>
1402 </attribute>
1403
1404 <attribute name="floppyImages" type="IFloppyImage" readonly="yes" safearray="yes">
1405 <desc>
1406 Array of floppy image objects registered with this VirtualBox instance.
1407 </desc>
1408 </attribute>
1409
1410 <attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1411
1412 <attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1413
1414 <attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1415 <desc>
1416 Collection of global shared folders. Global shared folders are
1417 available to all virtual machines.
1418
1419 New shared folders are added to the collection using
1420 <link to="#createSharedFolder"/>. Existing shared folders can be
1421 removed using <link to="#removeSharedFolder"/>.
1422
1423 <note>
1424 In the current version of the product, global shared folders are not
1425 implemented and therefore this collection is always empty.
1426 </note>
1427 </desc>
1428 </attribute>
1429
1430 <attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1431 <desc>
1432 Associated performance collector object.
1433 </desc>
1434 </attribute>
1435
1436 <method name="createMachine">
1437 <desc>
1438 Creates a new virtual machine.
1439
1440 The new machine is created unregistered, with the initial configuration
1441 set according to the specified guest OS type. A typical sequence of
1442 actions to create a new virtual machine is as follows:
1443
1444 <ol>
1445 <li>
1446 Call this method to have a new machine created. The returned machine
1447 object will be "mutable" allowing to change any machine property.
1448 </li>
1449
1450 <li>
1451 Configure the machine using the appropriate attributes and methods.
1452 </li>
1453
1454 <li>
1455 Call <link to="IMachine::saveSettings" /> to write the settings
1456 to the machine's XML settings file. The configuration of the newly
1457 created machine will not be saved to disk until this method is
1458 called.
1459 </li>
1460
1461 <li>
1462 Call <link to="#registerMachine" /> to add the machine to the list
1463 of machines known to VirtualBox.
1464 </li>
1465 </ol>
1466
1467 You should specify valid name for the newly created machine when calling
1468 this method. See the <link to="IMachine::name"/> attribute description
1469 for more details about the machine name.
1470
1471 The specified guest OS type identifier must match an ID of one of known
1472 guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1473 array.
1474
1475 Every machine has a <i>settings file</i> that is used to store
1476 the machine configuration. This file is stored in a directory called the
1477 <i>machine settings subfolder</i>. Both the settings subfolder and file
1478 will have a name that corresponds to the name of the virtual machine.
1479 You can specify where to create the machine setting subfolder using the
1480 @a baseFolder argument. The base folder can be absolute (full path) or
1481 relative to the <link to="IVirtualBox::homeFolder">VirtualBox home
1482 directory</link>.
1483
1484 If @a baseFolder is a null or empty string (which is recommended), the
1485 <link to="ISystemProperties::defaultMachineFolder">default machine
1486 settings folder</link> will be used as a base folder for the created
1487 machine. Otherwise the given base folder will be used. In either case,
1488 the full path to the resulting settings file has the following
1489 structure:
1490 <pre>
1491 &lt;base_folder&gt;/&lt;machine_name&gt;/&lt;machine_name&gt;.xml
1492 </pre>
1493
1494 Note that if the resulting settings file already exists, this method
1495 will fail with <link to="VBOX_E_FILE_ERROR"/>.
1496
1497 Optionally, you may specify an UUID of to assign to the created machine.
1498 However, this is not recommended and you should normally pass an empty
1499 (null) UUID to this method so that a new UUID will be automatically
1500 generated for every created machine. You can use UUID
1501 00000000-0000-0000-0000-000000000000 as null value.
1502
1503 <note>
1504 There is no way to change the name of the settings file or
1505 subfolder of the created machine directly.
1506 </note>
1507
1508 <result name="VBOX_E_OBJECT_NOT_FOUND">
1509 @a osTypeId is invalid.
1510 </result>
1511 <result name="VBOX_E_FILE_ERROR">
1512 Resulting settings file name is invalid or the settings file already
1513 exists or could not be created due to an I/O error.
1514 </result>
1515 <result name="E_INVALIDARG">
1516 @a name is empty or null.
1517 </result>
1518 </desc>
1519
1520 <param name="name" type="wstring" dir="in">
1521 <desc>Machine name.</desc>
1522 </param>
1523 <param name="osTypeId" type="wstring" dir="in">
1524 <desc>Guest OS Type ID.</desc>
1525 </param>
1526 <param name="baseFolder" type="wstring" dir="in">
1527 <desc>Base machine folder (optional).</desc>
1528 </param>
1529 <param name="id" type="uuid" dir="in">
1530 <desc>Machine UUID (optional).</desc>
1531 </param>
1532 <param name="machine" type="IMachine" dir="return">
1533 <desc>Created machine object.</desc>
1534 </param>
1535 </method>
1536
1537 <method name="createLegacyMachine">
1538 <desc>
1539 Creates a new virtual machine in "legacy" mode, using the specified
1540 settings file to store machine settings.
1541
1542 As opposed to machines created by <link to="#createMachine"/>,
1543 the settings file of the machine created in "legacy" mode is not
1544 automatically renamed when the machine name is changed -- it will always
1545 remain the same as specified in this method call.
1546
1547 The specified settings file name can be absolute (full path) or relative
1548 to the <link to="IVirtualBox::homeFolder">VirtualBox home
1549 directory</link>. If the file name doesn't contain an extension, the
1550 default extension (.xml) will be appended.
1551
1552 Note that the configuration of the newly created machine is not
1553 saved to disk (and therefore no settings file is created)
1554 until <link to="IMachine::saveSettings"/> is called. If the
1555 specified settings file already exists, this method
1556 will fail with <link to="VBOX_E_FILE_ERROR"/>..
1557
1558 See <link to="#createMachine"/> for more information.
1559
1560 @deprecated This method may be removed later. Use <link
1561 to="IVirtualBox::createMachine"/> instead.
1562
1563 <note>
1564 There is no way to change the name of the settings file
1565 of the machine created in "legacy" mode.
1566 </note>
1567
1568 <result name="VBOX_E_OBJECT_NOT_FOUND">
1569 @a osTypeId is invalid.
1570 </result>
1571 <result name="VBOX_E_FILE_ERROR">
1572 @a settingsFile is invalid or the settings file already exists or
1573 could not be created due to an I/O error.
1574 </result>
1575 <result name="E_INVALIDARG">
1576 @a name or @a settingsFile is empty or null.
1577 </result>
1578 </desc>
1579
1580 <param name="name" type="wstring" dir="in">
1581 <desc>Machine name.</desc>
1582 </param>
1583 <param name="osTypeId" type="wstring" dir="in">
1584 <desc>Machine OS Type ID.</desc>
1585 </param>
1586 <param name="settingsFile" type="wstring" dir="in">
1587 <desc>Name of the machine settings file.</desc>
1588 </param>
1589 <param name="id" type="uuid" dir="in">
1590 <desc>Machine UUID (optional).</desc>
1591 </param>
1592 <param name="machine" type="IMachine" dir="return">
1593 <desc>Created machine object.</desc>
1594 </param>
1595 </method>
1596
1597 <method name="openMachine">
1598 <desc>
1599 Opens a virtual machine from the existing settings file.
1600 The opened machine remains unregistered until you call
1601 <link to="#registerMachine"/>.
1602
1603 The specified settings file name can be absolute
1604 (full path) or relative to the <link to="IVirtualBox::homeFolder">
1605 VirtualBox home directory</link>. This file must exist
1606 and must be a valid machine settings file whose contents
1607 will be used to construct the machine object.
1608
1609 @deprecated Will be removed soon.
1610 <result name="VBOX_E_FILE_ERROR">
1611 Settings file name invalid, not found or sharing violation.
1612 </result>
1613 </desc>
1614 <param name="settingsFile" type="wstring" dir="in">
1615 <desc>
1616 Name of the machine settings file.
1617 </desc>
1618 </param>
1619 <param name="machine" type="IMachine" dir="return">
1620 <desc>Opened machine object.</desc>
1621 </param>
1622 <note>
1623 <link to="IMachine::settingsModified"/> will return
1624 false for the created machine, until any of machine settings
1625 are changed.
1626 </note>
1627 </method>
1628
1629 <method name="registerMachine">
1630 <desc>
1631
1632 Registers the machine previously created using
1633 <link to="#createMachine"/> or opened using
1634 <link to="#openMachine"/> within this VirtualBox installation. After
1635 successful method invocation, the
1636 <link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1637 to all registered callbacks.
1638
1639 <note>
1640 This method implicitly calls <link to="IMachine::saveSettings"/>
1641 to save all current machine settings before registering it.
1642 </note>
1643
1644 <result name="VBOX_E_OBJECT_NOT_FOUND">
1645 No matching virtual machine found.
1646 </result>
1647 <result name="VBOX_E_INVALID_OBJECT_STATE">
1648 Virtual machine was not created within this VirtualBox instance.
1649 </result>
1650
1651 </desc>
1652 <param name="machine" type="IMachine" dir="in"/>
1653 </method>
1654
1655 <method name="getMachine">
1656 <desc>
1657 Attempts to find a virtual machine given its UUID.
1658 To look up a machine by name, use <link to="IVirtualBox::findMachine" />
1659 instead.
1660
1661 <result name="VBOX_E_OBJECT_NOT_FOUND">
1662 Could not find registered machine matching @a id.
1663 </result>
1664
1665 </desc>
1666 <param name="id" type="uuid" dir="in"/>
1667 <param name="machine" type="IMachine" dir="return"/>
1668 </method>
1669
1670 <method name="findMachine">
1671 <desc>
1672 Attempts to find a virtual machine given its name.
1673 To look up a machine by UUID, use <link to="IVirtualBox::getMachine" />
1674 instead.
1675
1676 <result name="VBOX_E_OBJECT_NOT_FOUND">
1677 Could not find registered machine matching @a name.
1678 </result>
1679
1680 </desc>
1681 <param name="name" type="wstring" dir="in"/>
1682 <param name="machine" type="IMachine" dir="return"/>
1683 </method>
1684
1685 <method name="unregisterMachine">
1686 <desc>
1687
1688 Unregisters the machine previously registered using
1689 <link to="#registerMachine"/>. After successful method invocation, the
1690 <link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1691 to all registered callbacks.
1692
1693 <note>
1694 The specified machine must not be in the Saved state, have an open
1695 (or a spawning) direct session associated with it, have snapshots or
1696 have hard disks attached.
1697 </note>
1698
1699 <note>
1700 This method implicitly calls <link to="IMachine::saveSettings"/> to
1701 save all current machine settings before unregistering it.
1702 </note>
1703
1704 <note>
1705 If the given machine is inaccessible (see
1706 <link to="IMachine::accessible"/>), it will be unregistered and
1707 fully uninitialized right afterwards. As a result, the returned
1708 machine object will be unusable and an attempt to call
1709 <b>any</b> method will return the "Object not ready" error.
1710 </note>
1711
1712 <result name="VBOX_E_OBJECT_NOT_FOUND">
1713 Could not find registered machine matching @a id.
1714 </result>
1715 <result name="VBOX_E_INVALID_VM_STATE">
1716 Machine is in Saved state.
1717 </result>
1718 <result name="VBOX_E_INVALID_OBJECT_STATE">
1719 Machine has snapshot or open session or hard disk attached.
1720 </result>
1721
1722 </desc>
1723 <param name="id" type="uuid" dir="in">
1724 <desc>UUID of the machine to unregister.</desc>
1725 </param>
1726 <param name="machine" type="IMachine" dir="return">
1727 <desc>Unregistered machine object.</desc>
1728 </param>
1729 </method>
1730
1731 <method name="createAppliance">
1732 <desc>
1733 Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1734 Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1735 machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1736 </desc>
1737 <param name="appliance" type="IAppliance" dir="return">
1738 <desc>New appliance.</desc>
1739 </param>
1740 </method>
1741
1742 <method name="createHardDisk">
1743 <desc>
1744 Creates a new base hard disk object that will use the given storage
1745 format and location for hard disk data.
1746
1747 Note that the actual storage unit is not created by this method. In
1748 order to do it, and before you are able to attach the created hard disk
1749 to virtual machines, you must call one of the following methods to
1750 allocate a format-specific storage unit at the specified location:
1751 <ul>
1752 <li><link to="IHardDisk::createDynamicStorage"/></li>
1753 <li><link to="IHardDisk::createFixedStorage"/></li>
1754 <li><link to="IHardDisk::createDiffStorage"/></li>
1755 </ul>
1756
1757 Some hard disk attributes, such as <link to="IHardDisk::id"/>, may
1758 remain uninitialized until the hard disk storage unit is successfully
1759 created by one of the above methods.
1760
1761 After the storage unit is successfully created, the hard disk gets
1762 remembered by this VirtualBox installation and will be accessible
1763 through <link to="#getHardDisk"/> and <link to="#findHardDisk"/>
1764 methods. Remembered root (base) hard disks are also returned as part of
1765 the <link to="#hardDisks"/> array. See IHardDisk for more details.
1766
1767 The list of all storage formats supported by this VirtualBox
1768 installation can be obtained using
1769 <link to="ISystemProperties::hardDiskFormats"/>. If the @a format
1770 attribute is empty or <tt>null</tt> then the default storage format
1771 specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1772 be used for creating a storage unit of the hard disk.
1773
1774 Note that the format of the location string is storage format specific.
1775 See <link to="IMedium::location"/>, IHardDisk and
1776 <link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
1777
1778 <result name="VBOX_E_OBJECT_NOT_FOUND">
1779 @a format identifier is invalid. See
1780 <link to="ISystemProperties::hardDiskFormats"/>.
1781 </result>
1782 <result name="VBOX_E_FILE_ERROR">
1783 @a location is a not valid file name (for file-based formats only).
1784 </result>
1785 <result name="E_INVALIDARG">
1786 @a format is a null or empty string.
1787 </result>
1788 </desc>
1789 <param name="format" type="wstring" dir="in">
1790 <desc>
1791 Identifier of the storage format to use for the new hard disk.
1792 </desc>
1793 </param>
1794 <param name="location" type="wstring" dir="in">
1795 <desc>
1796 Location of the storage unit for the new hard disk.
1797 </desc>
1798 </param>
1799 <param name="hardDisk" type="IHardDisk" dir="return">
1800 <desc>Created hard disk object.</desc>
1801 </param>
1802 </method>
1803
1804 <method name="openHardDisk">
1805 <desc>
1806 Opens a hard disk from an existing location.
1807
1808 After the hard disk is successfully opened by this method, it gets
1809 remembered by (known to) this VirtualBox installation and will be
1810 accessible through <link to="#getHardDisk"/> and
1811 <link to="#findHardDisk"/> methods. Remembered root (base) hard disks
1812 are also returned as part of the <link to="#hardDisks"/> array and can
1813 be attached to virtual machines. See IHardDisk for more details.
1814
1815 If a differencing hard disk is to be opened by this method, the
1816 operation will succeed only if its parent hard disk and all ancestors,
1817 if any, are already known to this VirtualBox installation (for example,
1818 were opened by this method before).
1819
1820 This method tries to guess the storage format of the specified hard disk
1821 by reading hard disk data at the specified location.
1822
1823 Note that the format of the location string is storage format specific.
1824 See <link to="IMedium::location"/>, IHardDisk and
1825 <link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
1826
1827
1828 <result name="VBOX_E_FILE_ERROR">
1829 Invalid hard disk storage file location.
1830 </result>
1831 <result name="VBOX_E_IPRT_ERROR">
1832 Could not get hard disk storage format.
1833 </result>
1834 <result name="E_INVALIDARG">
1835 Invalid hard disk storage format.
1836 </result>
1837
1838 </desc>
1839 <param name="location" type="wstring" dir="in">
1840 <desc>
1841 Location of the storage unit that contains hard disk data in one of
1842 the supported storage formats.
1843 </desc>
1844 </param>
1845 <param name="hardDisk" type="IHardDisk" dir="return">
1846 <desc>Opened hard disk object.</desc>
1847 </param>
1848 </method>
1849
1850 <method name="getHardDisk" const="yes">
1851 <desc>
1852 Returns a hard disk with the given UUID.
1853
1854 The hard disk with the given UUID must be known to this VirtualBox
1855 installation, i.e. it must be previously created by
1856 <link to="#createHardDisk"/> or opened by <link
1857 to="#openHardDisk"/>, or attached to some known virtual machine.
1858
1859 <result name="VBOX_E_OBJECT_NOT_FOUND">
1860 No hard disk object matching @a id found.
1861 </result>
1862
1863 </desc>
1864 <param name="id" type="uuid" dir="in">
1865 <desc>UUID of the hard disk to look for.</desc>
1866 </param>
1867 <param name="hardDisk" type="IHardDisk" dir="return">
1868 <desc>Found hard disk object.</desc>
1869 </param>
1870 </method>
1871
1872 <method name="findHardDisk">
1873 <desc>
1874 Returns a hard disk that uses the given location to store hard
1875 disk data.
1876
1877 The given hard disk must be known to this VirtualBox installation, i.e.
1878 it must be previously created by
1879 <link to="#createHardDisk"/> or opened by <link
1880 to="#openHardDisk"/>, or attached to some known virtual machine.
1881
1882 The search is done by comparing the value of the @a location argument to
1883 the <link to="IHardDisk::location"/> attribute of each known hard
1884 disk.
1885
1886 For locations represented by file names in the host's file system, the
1887 requested location can be a path relative to the
1888 <link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
1889 only a file name without any path is given, the
1890 <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
1891 folder</link> will be prepended to the file name before searching. Note
1892 that on case sensitive file systems, a case sensitive comparison is
1893 performed, otherwise the case of symbols in the file path is ignored.
1894
1895 <result name="VBOX_E_OBJECT_NOT_FOUND">
1896 No hard disk object matching @a location found.
1897 </result>
1898
1899 </desc>
1900 <param name="location" type="wstring" dir="in">
1901 <desc>Location string to search for.</desc>
1902 </param>
1903 <param name="hardDisk" type="IHardDisk" dir="return">
1904 <desc>Found hard disk object.</desc>
1905 </param>
1906 </method>
1907
1908 <method name="openDVDImage">
1909 <desc>
1910 Opens a CD/DVD image contained in the specified file of the supported
1911 format and assigns it the given UUID.
1912
1913 After the image is successfully opened by this method, it gets
1914 remembered by (known to) this VirtualBox installation and will be
1915 accessible through <link to="#getDVDImage"/> and
1916 <link to="#findDVDImage"/> methods. Remembered images are also
1917 returned as part of the <link to="#DVDImages"/> array and can be mounted
1918 to virtual machines. See IMedium for more details.
1919
1920 See <link to="IMedium::location"/> to get more details about the format
1921 of the location string.
1922
1923 <note>
1924 Currently only ISO 9960 CD/DVD images are supported by VirtualBox.
1925 </note>
1926
1927 <result name="VBOX_E_INVALID_OBJECT_STATE">
1928 CD/DVD image already exists in the media registry.
1929 </result>
1930
1931 </desc>
1932 <param name="location" type="wstring" dir="in">
1933 <desc>
1934 Full path to the file that contains a valid CD/DVD image.
1935 </desc>
1936 </param>
1937 <param name="id" type="uuid" dir="in">
1938 <desc>
1939 UUID to assign to the given image within this VirtualBox installation.
1940 If an empty (null) UUID is specified, the system will randomly
1941 generate a new UUID.
1942 </desc>
1943 </param>
1944 <param name="image" type="IDVDImage" dir="return">
1945 <desc>Opened CD/DVD image object.</desc>
1946 </param>
1947 </method>
1948
1949 <method name="getDVDImage">
1950 <desc>
1951 Returns a CD/DVD image with the given UUID.
1952
1953 The image with the given UUID must be known to this VirtualBox
1954 installation, i.e. it must be previously opened by <link
1955 to="#openDVDImage"/>, or mounted to some known virtual machine.
1956
1957 <result name="VBOX_E_OBJECT_NOT_FOUND">
1958 No matching DVD image found in the media registry.
1959 </result>
1960
1961 </desc>
1962 <param name="id" type="uuid" dir="in">
1963 <desc>UUID of the image to look for.</desc>
1964 </param>
1965 <param name="image" type="IDVDImage" dir="return">
1966 <desc>Found CD/DVD image object.</desc>
1967 </param>
1968 </method>
1969
1970 <method name="findDVDImage">
1971 <desc>
1972 Returns a CD/DVD image with the given image location.
1973
1974 The image with the given UUID must be known to this VirtualBox
1975 installation, i.e. it must be previously opened by <link
1976 to="#openDVDImage"/>, or mounted to some known virtual machine.
1977
1978 The search is done by comparing the value of the @a location argument to
1979 the <link to="IMedium::location"/> attribute of each known CD/DVD image.
1980
1981 The requested location can be a path relative to the
1982 <link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
1983 only a file name without any path is given, the
1984 <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
1985 folder</link> will be prepended to the file name before searching. Note
1986 that on case sensitive file systems, a case sensitive comparison is
1987 performed, otherwise the case in the file path is ignored.
1988
1989 <result name="VBOX_E_FILE_ERROR">
1990 Invalid image file location.
1991 </result>
1992 <result name="VBOX_E_OBJECT_NOT_FOUND">
1993 No matching DVD image found in the media registry.
1994 </result>
1995
1996 </desc>
1997 <param name="location" type="wstring" dir="in">
1998 <desc>CD/DVD image file path to look for.</desc>
1999 </param>
2000 <param name="image" type="IDVDImage" dir="return">
2001 <desc>Found CD/DVD image object.</desc>
2002 </param>
2003 </method>
2004
2005 <method name="openFloppyImage">
2006 <desc>
2007 Opens a floppy image contained in the specified file of the supported
2008 format and assigns it the given UUID.
2009
2010 After the image is successfully opened by this method, it gets
2011 remembered by (known to) this VirtualBox installation and will be
2012 accessible through <link to="#getFloppyImage"/> and
2013 <link to="#findFloppyImage"/> methods. Remembered images are also
2014 returned as part of the <link to="#floppyImages"/> array and can be
2015 mounted to virtual machines. See IMedium for more details.
2016
2017 See <link to="IMedium::location"/> to get more details about the format
2018 of the location string.
2019
2020 <result name="VBOX_E_FILE_ERROR">
2021 Floppy image specified by @a location not accessible.
2022 </result>
2023 <result name="VBOX_E_INVALID_OBJECT_STATE">
2024 Floppy image already exists in the media registry.
2025 </result>
2026
2027 <note>
2028 Currently, only raw floppy images are supported by VirtualBox.
2029 </note>
2030 </desc>
2031 <param name="location" type="wstring" dir="in">
2032 <desc>
2033 Full path to the file that contains a valid floppy image.
2034 </desc>
2035 </param>
2036 <param name="id" type="uuid" dir="in">
2037 <desc>
2038 UUID to assign to the given image file within this VirtualBox
2039 installation. If an empty (null) UUID is specified, the system will
2040 randomly generate a new UUID.
2041 </desc>
2042 </param>
2043 <param name="image" type="IFloppyImage" dir="return">
2044 <desc>Opened floppy image object.</desc>
2045 </param>
2046 </method>
2047
2048 <method name="getFloppyImage">
2049 <desc>
2050 Returns a floppy image with the given UUID.
2051
2052 The image with the given UUID must be known to this VirtualBox
2053 installation, i.e. it must be previously opened by <link
2054 to="#openFloppyImage"/>, or mounted to some known virtual machine.
2055
2056 <result name="VBOX_E_OBJECT_NOT_FOUND">
2057 No matching floppy image found in the media registry.
2058 </result>
2059
2060 </desc>
2061 <param name="id" type="uuid" dir="in">
2062 <desc>UUID of the image to look for.</desc>
2063 </param>
2064 <param name="image" type="IFloppyImage" dir="return">
2065 <desc>Found floppy image object.</desc>
2066 </param>
2067 </method>
2068
2069 <method name="findFloppyImage">
2070 <desc>
2071 Returns a floppy image with the given image location.
2072
2073 The image with the given UUID must be known to this VirtualBox
2074 installation, i.e. it must be previously opened by <link
2075 to="#openFloppyImage"/>, or mounted to some known virtual machine.
2076
2077 The search is done by comparing the value of the @a location argument to
2078 the <link to="IMedium::location"/> attribute of each known floppy image.
2079
2080 The requested location can be a path relative to the
2081 <link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2082 only a file name without any path is given, the
2083 <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2084 folder</link> will be prepended to the file name before searching. Note
2085 that on case sensitive file systems, a case sensitive comparison is
2086 performed, otherwise the case of symbols in the file path is ignored.
2087
2088 <result name="VBOX_E_FILE_ERROR">
2089 Invalid image file location.
2090 </result>
2091 <result name="VBOX_E_OBJECT_NOT_FOUND">
2092 No matching floppy image found in the media registry.
2093 </result>
2094
2095 </desc>
2096 <param name="location" type="wstring" dir="in">
2097 <desc>Floppy image file path to look for.</desc>
2098 </param>
2099 <param name="image" type="IFloppyImage" dir="return">
2100 <desc>Found floppy image object.</desc>
2101 </param>
2102 </method>
2103
2104 <method name="getGuestOSType">
2105 <desc>
2106 Returns an object describing the specified guest OS type.
2107
2108 The requested guest OS type is specified using a string which is a
2109 mnemonic identifier of the guest operating system, such as
2110 <tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2111 particular virtual machine can be read or set using the
2112 <link to="IMachine::OSTypeId"/> attribute.
2113
2114 The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2115 available guest OS type objects. Each object has an
2116 <link to="IGuestOSType::id"/> attribute which contains an identifier of
2117 the guest OS this object describes.
2118
2119 <result name="E_INVALIDARG">
2120 @a id is not a valid Guest OS type.
2121 </result>
2122
2123 </desc>
2124 <param name="id" type="wstring" dir="in">
2125 <desc>Guest OS type ID string.</desc>
2126 </param>
2127 <param name="type" type="IGuestOSType" dir="return">
2128 <desc>Guest OS type object.</desc>
2129 </param>
2130 </method>
2131
2132 <method name="createSharedFolder">
2133 <desc>
2134 Creates a new global shared folder by associating the given logical
2135 name with the given host path, adds it to the collection of shared
2136 folders and starts sharing it. Refer to the description of
2137 <link to="ISharedFolder"/> to read more about logical names.
2138 <note>
2139 In the current implementation, this operation is not
2140 implemented.
2141 </note>
2142 </desc>
2143 <param name="name" type="wstring" dir="in">
2144 <desc>Unique logical name of the shared folder.</desc>
2145 </param>
2146 <param name="hostPath" type="wstring" dir="in">
2147 <desc>Full path to the shared folder in the host file system.</desc>
2148 </param>
2149 <param name="writable" type="boolean" dir="in">
2150 <desc>Whether the share is writable or readonly</desc>
2151 </param>
2152 </method>
2153
2154 <method name="removeSharedFolder">
2155 <desc>
2156 Removes the global shared folder with the given name previously
2157 created by <link to="#createSharedFolder"/> from the collection of
2158 shared folders and stops sharing it.
2159 <note>
2160 In the current implementation, this operation is not
2161 implemented.
2162 </note>
2163 </desc>
2164 <param name="name" type="wstring" dir="in">
2165 <desc>Logical name of the shared folder to remove.</desc>
2166 </param>
2167 </method>
2168
2169 <method name="getNextExtraDataKey">
2170 <desc>
2171 Returns the global extra data key name following the supplied key.
2172
2173 An error is returned if the supplied @a key does not exist. @c NULL is
2174 returned in @a nextKey if the supplied key is the last key. When
2175 supplying @c NULL for the @a key, the first key item is returned in
2176 @a nextKey (if there is any). @a nextValue is an optional parameter and
2177 if supplied, the next key's value is returned in it.
2178
2179 <result name="VBOX_E_OBJECT_NOT_FOUND">
2180 Extra data @a key not found.
2181 </result>
2182
2183 </desc>
2184 <param name="key" type="wstring" dir="in">
2185 <desc>Name of the data key to follow.</desc>
2186 </param>
2187 <param name="nextKey" type="wstring" dir="out">
2188 <desc>Name of the next data key.</desc>
2189 </param>
2190 <param name="nextValue" type="wstring" dir="out">
2191 <desc>Value of the next data key.</desc>
2192 </param>
2193 </method>
2194
2195 <method name="getExtraData">
2196 <desc>
2197 Returns associated global extra data.
2198
2199 If the requested data @a key does not exist, this function will
2200 succeed and return @c NULL in the @a value argument.
2201
2202 <result name="VBOX_E_FILE_ERROR">
2203 Settings file not accessible.
2204 </result>
2205 <result name="VBOX_E_XML_ERROR">
2206 Could not parse the settings file.
2207 </result>
2208
2209 </desc>
2210 <param name="key" type="wstring" dir="in">
2211 <desc>Name of the data key to get.</desc>
2212 </param>
2213 <param name="value" type="wstring" dir="return">
2214 <desc>Value of the requested data key.</desc>
2215 </param>
2216 </method>
2217
2218 <method name="setExtraData">
2219 <desc>
2220 Sets associated global extra data.
2221
2222 If you pass @c NULL as a key @a value, the given @a key will be
2223 deleted.
2224
2225 <note>
2226 Before performing the actual data change, this method will ask all
2227 registered callbacks using the
2228 <link to="IVirtualBoxCallback::onExtraDataCanChange"/>
2229 notification for a permission. If one of the callbacks refuses the
2230 new value, the change will not be performed.
2231 </note>
2232 <note>
2233 On success, the
2234 <link to="IVirtualBoxCallback::onExtraDataChange"/> notification
2235 is called to inform all registered callbacks about a successful data
2236 change.
2237 </note>
2238
2239 <result name="VBOX_E_FILE_ERROR">
2240 Settings file not accessible.
2241 </result>
2242 <result name="VBOX_E_XML_ERROR">
2243 Could not parse the settings file.
2244 </result>
2245 <result name="E_ACCESSDENIED">
2246 Modification request refused.
2247 </result>
2248
2249 </desc>
2250 <param name="key" type="wstring" dir="in">
2251 <desc>Name of the data key to set.</desc>
2252 </param>
2253 <param name="value" type="wstring" dir="in">
2254 <desc>Value to assign to the key.</desc>
2255 </param>
2256 </method>
2257
2258 <method name="openSession">
2259 <desc>
2260 Opens a new direct session with the given virtual machine.
2261
2262 A direct session acts as a local lock on the given VM.
2263 There can be only one direct session open at a time for every
2264 virtual machine, protecting the VM from being manipulated by
2265 conflicting actions from different processes. Only after a
2266 direct session has been opened, one can change all VM settings
2267 and execute the VM in the process space of the session object.
2268
2269 Sessions therefore can be compared to mutex semaphores that
2270 lock a given VM for modification and execution.
2271 See <link to="ISession">ISession</link> for details.
2272
2273 <note>Unless you are writing a new VM frontend, you will not
2274 want to execute a VM in the current process. To spawn a new
2275 process that executes a VM, use
2276 <link to="IVirtualBox::openRemoteSession" />
2277 instead.</note>
2278
2279 Upon successful return, the session object can be used to
2280 get access to the machine and to the VM console.
2281
2282 In VirtualBox terminology, the machine becomes "mutable" after
2283 a session has been opened. Note that the "mutable" machine
2284 object, on which you may invoke IMachine methods to change its
2285 settings, will be a different object from the immutable IMachine
2286 objects returned by various IVirtualBox methods. To obtain a
2287 mutable IMachine object (upon which you can invoke settings methods),
2288 use the <link to="ISession::machine" /> attribute.
2289
2290 One must always call <link to="ISession::close" /> to release the
2291 lock on the machine, or the machine's state will eventually be
2292 set to "Aborted".
2293
2294 In other words, to change settings on a machine, the following
2295 sequence is typically performed:
2296
2297 <ol>
2298 <li>Call this method (openSession) to have a machine locked for
2299 the current session.</li>
2300
2301 <li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
2302
2303 <li>Change the settings of the machine.</li>
2304
2305 <li>Call <link to="IMachine::saveSettings" />.</li>
2306
2307 <li>Close the session by calling <link to="ISession::close"/>.</li>
2308 </ol>
2309
2310 <result name="E_UNEXPECTED">
2311 Virtual machine not registered.
2312 </result>
2313 <result name="E_ACCESSDENIED">
2314 Process not started by OpenRemoteSession.
2315 </result>
2316 <result name="VBOX_E_OBJECT_NOT_FOUND">
2317 No matching virtual machine found.
2318 </result>
2319 <result name="VBOX_E_INVALID_OBJECT_STATE">
2320 Session already open or being opened.
2321 </result>
2322 <result name="VBOX_E_VM_ERROR">
2323 Failed to assign machine to session.
2324 </result>
2325
2326 </desc>
2327 <param name="session" type="ISession" dir="in">
2328 <desc>
2329 Session object that will represent the opened session after
2330 successful method invocation. This object must not represent
2331 the already open session.
2332 <note>
2333 This session will be automatically closed if the
2334 VirtualBox server is terminated for some reason.
2335 </note>
2336 </desc>
2337 </param>
2338 <param name="machineId" type="uuid" dir="in">
2339 <desc>ID of the virtual machine to open a session with.</desc>
2340 </param>
2341 </method>
2342
2343 <method name="openRemoteSession">
2344 <desc>
2345 Spawns a new process that executes a virtual machine (called a
2346 "remote session").
2347
2348 Opening a remote session causes the VirtualBox server to start a new
2349 process that opens a direct session with the given VM. As a result, the
2350 VM is locked by that direct session in the new process, preventing
2351 conflicting changes from other processes. Since sessions act as locks
2352 that prevent conflicting changes, one cannot open a remote session
2353 for a VM that already has another open session (direct or remote), or
2354 is currently in the process of opening one (see <link
2355 to="IMachine::sessionState"/>).
2356
2357 While the remote session still provides some level of control over the
2358 VM execution to the caller (using the <link to="IConsole" /> interface),
2359 not all VM settings are available for modification within the remote
2360 session context.
2361
2362 This operation can take some time (a new VM is started in a new process,
2363 for which memory and other resources need to be set up). Because of this,
2364 an <link to="IProgress" /> is returned to allow the caller to wait for this
2365 asynchronous operation to be completed. Until then, the remote session
2366 object remains in the closed state, and accessing the machine or its
2367 console through it is invalid. It is recommended to use
2368 <link to="IProgress::waitForCompletion" /> or similar calls to wait for
2369 completion.
2370
2371 As with all <link to="ISession" /> objects, it is recommended to call
2372 <link to="ISession::close" /> on the local session object once openRemoteSession()
2373 has been called. However, the session's state (see <link to="ISession::state" />)
2374 will not return to "Closed" until the remote session has also closed (i.e.
2375 until the VM is no longer running). In that case, however, the state of
2376 the session will automatically change back to "Closed".
2377
2378 Currently supported session types (values of the @a type
2379 argument) are:
2380 <ul>
2381 <li><tt>gui</tt>: VirtualBox Qt GUI session</li>
2382 <li><tt>vrdp</tt>: VirtualBox VRDP Server session</li>
2383 </ul>
2384
2385 The @a environment argument is a string containing definitions of
2386 environment variables in the following format:
2387 @code
2388 NAME[=VALUE]\n
2389 NAME[=VALUE]\n
2390 ...
2391 @endcode
2392 where <tt>\\n</tt> is the new line character. These environment
2393 variables will be appended to the environment of the VirtualBox server
2394 process. If an environment variable exists both in the server process
2395 and in this list, the value from this list takes precedence over the
2396 server's variable. If the value of the environment variable is
2397 omitted, this variable will be removed from the resulting environment.
2398 If the environment string is @c null, the server environment is
2399 inherited by the started process as is.
2400
2401 <see>openExistingSession</see>
2402
2403 <result name="E_UNEXPECTED">
2404 Virtual machine not registered.
2405 </result>
2406 <result name="E_INVALIDARG">
2407 Invalid session type @a type.
2408 </result>
2409 <result name="VBOX_E_OBJECT_NOT_FOUND">
2410 No machine matching @a machineId found.
2411 </result>
2412 <result name="VBOX_E_INVALID_OBJECT_STATE">
2413 Session already open or being opened.
2414 </result>
2415 <result name="VBOX_E_IPRT_ERROR">
2416 Launching process for machine failed.
2417 </result>
2418 <result name="VBOX_E_VM_ERROR">
2419 Failed to assign machine to session.
2420 </result>
2421
2422 </desc>
2423 <param name="session" type="ISession" dir="in">
2424 <desc>
2425 Session object that will represent the opened remote session
2426 after successful method invocation (this object must not
2427 represent an already open session).
2428 </desc>
2429 </param>
2430 <param name="machineId" type="uuid" dir="in">
2431 <desc>ID of the virtual machine to open a session with.</desc>
2432 </param>
2433 <param name="type" type="wstring" dir="in">
2434 <desc>
2435 Type of the remote session (case sensitive).
2436 </desc>
2437 </param>
2438 <param name="environment" type="wstring" dir="in">
2439 <desc>
2440 Environment to pass to the opened session (may be @c null).
2441 </desc>
2442 </param>
2443 <param name="progress" type="IProgress" dir="return">
2444 <desc>Progress object to track the operation completion.</desc>
2445 </param>
2446 </method>
2447
2448 <method name="openExistingSession">
2449 <desc>
2450 Opens a new remote session with the virtual machine for
2451 which a direct session is already open.
2452
2453 The remote session provides some level of control over the VM
2454 execution (using the IConsole interface) to the caller; however,
2455 within the remote session context, not all VM settings are available
2456 for modification.
2457
2458 As opposed to <link to="#openRemoteSession"/>, the number of
2459 remote sessions opened this way is not limited by the API
2460
2461 <note>
2462 It is an error to open a remote session with the machine that
2463 doesn't have an open direct session.
2464 </note>
2465
2466 <result name="E_UNEXPECTED">
2467 Virtual machine not registered.
2468 </result>
2469 <result name="VBOX_E_OBJECT_NOT_FOUND">
2470 No machine matching @a machineId found.
2471 </result>
2472 <result name="VBOX_E_INVALID_OBJECT_STATE">
2473 Session already open or being opened.
2474 </result>
2475 <result name="VBOX_E_INVALID_SESSION_STATE">
2476 Direct session state not Open.
2477 </result>
2478 <result name="VBOX_E_VM_ERROR">
2479 Failed to get console object from direct session or assign
2480 machine to session.
2481 </result>
2482
2483 <see>openRemoteSession</see>
2484 </desc>
2485 <param name="session" type="ISession" dir="in">
2486 <desc>
2487 Session object that will represent the open remote session
2488 after successful method invocation. This object must not
2489 represent an already open session.
2490 <note>
2491 This session will be automatically closed when the peer
2492 (direct) session dies or gets closed.
2493 </note>
2494 </desc>
2495 </param>
2496 <param name="machineId" type="uuid" dir="in">
2497 <desc>ID of the virtual machine to open a session with.</desc>
2498 </param>
2499 </method>
2500
2501 <method name="registerCallback">
2502 <desc>
2503 Registers a new global VirtualBox callback. The methods of the given
2504 callback object will be called by VirtualBox when an appropriate
2505 event occurs.
2506
2507 <result name="E_INVALIDARG">
2508 A @c NULL callback cannot be registered.
2509 </result>
2510
2511 </desc>
2512 <param name="callback" type="IVirtualBoxCallback" dir="in">
2513 <desc>Callback object to register.</desc>
2514 </param>
2515 </method>
2516
2517 <method name="unregisterCallback">
2518 <desc>
2519 Unregisters the previously registered global VirtualBox callback.
2520
2521 <result name="E_INVALIDARG">
2522 Specified @a callback not registered.
2523 </result>
2524
2525 </desc>
2526 <param name="callback" type="IVirtualBoxCallback" dir="in">
2527 <desc>Callback object to unregister.</desc>
2528 </param>
2529 </method>
2530
2531 <method name="waitForPropertyChange">
2532 <desc>
2533 Blocks the caller until any of the properties represented by the
2534 @a what argument changes the value or until the given timeout interval
2535 expires.
2536
2537 The @a what argument is a comma separated list of property masks that
2538 describe properties the caller is interested in. The property mask is
2539 a string in the following format:
2540
2541 <pre>
2542 [[group.]subgroup.]name
2543 </pre>
2544
2545 where @c name is the property name and @c group, @c subgroup are zero
2546 or more property group specifiers. Each element (group or name) in
2547 the property mask may be either a Latin string or an asterisk symbol
2548 (@c "*") which is used to match any string for the given element. A
2549 property mask that doesn't contain asterisk symbols represents a
2550 single fully qualified property name.
2551
2552 Groups in the fully qualified property name go from more generic (the
2553 left-most part) to more specific (the right-most part). The first
2554 element is usually a name of the object the property belongs to. The
2555 second element may be either a property name, or a child object name,
2556 or an index if the preceding element names an object which is one of
2557 many objects of the same type. This way, property names form a
2558 hierarchy of properties. Here are some examples of property names:
2559
2560 <table>
2561 <tr>
2562 <td><tt>VirtualBox.version</tt></td>
2563 <td><link to="IVirtualBox::version"/> property</td>
2564 </tr>
2565 <tr>
2566 <td><tt>Machine.&lt;UUID&gt;.name</tt></td>
2567 <td><link to="IMachine::name"/> property of the machine with the
2568 given UUID</td>
2569 </tr>
2570 </table>
2571
2572 Most property names directly correspond to the properties of objects
2573 (components) provided by the VirtualBox library and may be used to
2574 track changes to these properties. However, there may be
2575 pseudo-property names that don't correspond to any existing object's
2576 property directly, as well as there may be object properties that
2577 don't have a corresponding property name that is understood by this
2578 method, and therefore changes to such properties cannot be
2579 tracked. See individual object's property descriptions to get a
2580 fully qualified property name that can be used with this method (if
2581 any).
2582
2583 There is a special property mask @c "*" (i.e. a string consisting of a
2584 single asterisk symbol) that can be used to match all properties.
2585 Below are more examples of property masks:
2586
2587 <table>
2588 <tr>
2589 <td><tt>VirtualBox.*</tt></td>
2590 <td>Track all properties of the VirtualBox object</td>
2591 </tr>
2592 <tr>
2593 <td><tt>Machine.*.name</tt></td>
2594 <td>Track changes to the <link to="IMachine::name"/> property of
2595 all registered virtual machines</td>
2596 </tr>
2597 </table>
2598
2599 <note>
2600 This function is not implemented in the current version of the
2601 product.
2602 </note>
2603 </desc>
2604 <param name="what" type="wstring" dir="in">
2605 <desc>Comma separated list of property masks.</desc>
2606 </param>
2607 <param name="timeout" type="unsigned long" dir="in">
2608 <desc>
2609 Wait timeout in milliseconds.
2610 Specify -1 for an indefinite wait.
2611 </desc>
2612 </param>
2613 <param name="changed" type="wstring" dir="out">
2614 <desc>
2615 Comma separated list of properties that have been changed and caused
2616 this method to return to the caller.
2617 </desc>
2618 </param>
2619 <param name="values" type="wstring" dir="out">
2620 <desc>Reserved, not currently used.</desc>
2621 </param>
2622 </method>
2623
2624 <method name="saveSettings">
2625 <desc>
2626 Saves the global settings to the global settings file
2627 (<link to="#settingsFilePath"/>).
2628
2629 This method is only useful for explicitly saving the global settings
2630 file after it has been auto-converted from the old format to the most
2631 recent format (see <link to="#settingsFileVersion"/> for details).
2632 Normally, the global settings file is implicitly saved when a global
2633 setting is changed.
2634
2635 <result name="VBOX_E_FILE_ERROR">
2636 Settings file not accessible.
2637 </result>
2638 <result name="VBOX_E_XML_ERROR">
2639 Could not parse the settings file.
2640 </result>
2641
2642 </desc>
2643 </method>
2644
2645 <method name="saveSettingsWithBackup">
2646 <desc>
2647 Creates a backup copy of the global settings file
2648 (<link to="#settingsFilePath"/>) in case of auto-conversion, and then
2649 calls <link to="#saveSettings"/>.
2650
2651 Note that the backup copy is created <b>only</b> if the settings file
2652 auto-conversion took place (see <link to="#settingsFileVersion"/> for
2653 details). Otherwise, this call is fully equivalent to
2654 <link to="#saveSettings"/> and no backup copying is done.
2655
2656 The backup copy is created in the same directory where the original
2657 settings file is located. It is given the following file name:
2658 <pre>
2659 original.xml.x.y-platform.bak
2660 </pre>
2661 where <tt>original.xml</tt> is the original settings file name
2662 (excluding path), and <tt>x.y-platform</tt> is the version of the old
2663 format of the settings file (before auto-conversion).
2664
2665 If the given backup file already exists, this method will try to add the
2666 <tt>.N</tt> suffix to the backup file name (where <tt>N</tt> counts from
2667 0 to 9) and copy it again until it succeeds. If all suffixes are
2668 occupied, or if any other copy error occurs, this method will return a
2669 failure.
2670
2671 If the copy operation succeeds, the @a bakFileName return argument will
2672 receive a full path to the created backup file (for informational
2673 purposes). Note that this will happen even if the subsequent
2674 <link to="#saveSettings"/> call performed by this method after the
2675 copy operation, fails.
2676
2677 <note>
2678 The VirtualBox API never calls this method. It is intended purely for
2679 the purposes of creating backup copies of the settings files by
2680 front-ends before saving the results of the automatically performed
2681 settings conversion to disk.
2682 </note>
2683
2684 <see>settingsFileVersion</see>
2685
2686 <result name="VBOX_E_FILE_ERROR">
2687 Settings file not accessible.
2688 </result>
2689 <result name="VBOX_E_XML_ERROR">
2690 Could not parse the settings file.
2691 </result>
2692 <result name="VBOX_E_IPRT_ERROR">
2693 Could not copy the settings file.
2694 </result>
2695
2696 </desc>
2697 <param name="bakFileName" type="wstring" dir="return">
2698 <desc>Full path to the created backup copy.</desc>
2699 </param>
2700 </method>
2701
2702 </interface>
2703
2704 <!--
2705 // IAppliance
2706 /////////////////////////////////////////////////////////////////////////
2707 -->
2708
2709 <enum
2710 name="CIMOSType"
2711 uuid="86ef5f8c-18b2-4db8-a314-33721b59f89b"
2712 >
2713 <desc>
2714 OVF operating system values according to CIM V2.20 (as of Nov 2008); http://www.dmtf.org/standards/cim/cim_schema_v220
2715 </desc>
2716
2717 <const name="CIMOS_Unknown" value="0" /> <!-- "Unknown" -->
2718 <const name="CIMOS_Other" value="1" /> <!-- "Other" -->
2719 <const name="CIMOS_MACOS" value="2" /> <!-- "MACOS" -->
2720 <const name="CIMOS_ATTUNIX" value="3" /> <!-- "ATTUNIX" -->
2721 <const name="CIMOS_DGUX" value="4" /> <!-- "DGUX" -->
2722 <const name="CIMOS_DECNT" value="5" /> <!-- "DECNT" -->
2723 <const name="CIMOS_Tru64UNIX" value="6" /> <!-- "Tru64 UNIX" -->
2724 <const name="CIMOS_OpenVMS" value="7" /> <!-- "OpenVMS" -->
2725 <const name="CIMOS_HPUX" value="8" /> <!-- "HPUX" -->
2726 <const name="CIMOS_AIX" value="9" /> <!-- "AIX" -->
2727 <const name="CIMOS_MVS" value="10" /> <!-- "MVS" -->
2728 <const name="CIMOS_OS400" value="11" /> <!-- "OS400" -->
2729 <const name="CIMOS_OS2" value="12" /> <!-- "OS/2" -->
2730 <const name="CIMOS_JavaVM" value="13" /> <!-- "JavaVM" -->
2731 <const name="CIMOS_MSDOS" value="14" /> <!-- "MSDOS" -->
2732 <const name="CIMOS_WIN3x" value="15" /> <!-- "WIN3x" -->
2733 <const name="CIMOS_WIN95" value="16" /> <!-- "WIN95" -->
2734 <const name="CIMOS_WIN98" value="17" /> <!-- "WIN98" -->
2735 <const name="CIMOS_WINNT" value="18" /> <!-- "WINNT" -->
2736 <const name="CIMOS_WINCE" value="19" /> <!-- "WINCE" -->
2737 <const name="CIMOS_NCR3000" value="20" /> <!-- "NCR3000" -->
2738 <const name="CIMOS_NetWare" value="21" /> <!-- "NetWare" -->
2739 <const name="CIMOS_OSF" value="22" /> <!-- "OSF" -->
2740 <const name="CIMOS_DCOS" value="23" /> <!-- "DC/OS" -->
2741 <const name="CIMOS_ReliantUNIX" value="24" /> <!-- "Reliant UNIX" -->
2742 <const name="CIMOS_SCOUnixWare" value="25" /> <!-- "SCO UnixWare" -->
2743 <const name="CIMOS_SCOOpenServer" value="26" /> <!-- "SCO OpenServer" -->
2744 <const name="CIMOS_Sequent" value="27" /> <!-- "Sequent" -->
2745 <const name="CIMOS_IRIX" value="28" /> <!-- "IRIX" -->
2746 <const name="CIMOS_Solaris" value="29" /> <!-- "Solaris" -->
2747 <const name="CIMOS_SunOS" value="30" /> <!-- "SunOS" -->
2748 <const name="CIMOS_U6000" value="31" /> <!-- "U6000" -->
2749 <const name="CIMOS_ASERIES" value="32" /> <!-- "ASERIES" -->
2750 <const name="CIMOS_HPNonStopOS" value="33" /> <!-- "HP NonStop OS" -->
2751 <const name="CIMOS_HPNonStopOSS" value="34" /> <!-- "HP NonStop OSS" -->
2752 <const name="CIMOS_BS2000" value="35" /> <!-- "BS2000" -->
2753 <const name="CIMOS_LINUX" value="36" /> <!-- "LINUX" -->
2754 <const name="CIMOS_Lynx" value="37" /> <!-- "Lynx" -->
2755 <const name="CIMOS_XENIX" value="38" /> <!-- "XENIX" -->
2756 <const name="CIMOS_VM" value="39" /> <!-- "VM" -->
2757 <const name="CIMOS_InteractiveUNIX" value="40" /> <!-- "Interactive UNIX" -->
2758 <const name="CIMOS_BSDUNIX" value="41" /> <!-- "BSDUNIX" -->
2759 <const name="CIMOS_FreeBSD" value="42" /> <!-- "FreeBSD" -->
2760 <const name="CIMOS_NetBSD" value="43" /> <!-- "NetBSD" -->
2761 <const name="CIMOS_GNUHurd" value="44" /> <!-- "GNU Hurd" -->
2762 <const name="CIMOS_OS9" value="45" /> <!-- "OS9" -->
2763 <const name="CIMOS_MACHKernel" value="46" /> <!-- "MACH Kernel" -->
2764 <const name="CIMOS_Inferno" value="47" /> <!-- "Inferno" -->
2765 <const name="CIMOS_QNX" value="48" /> <!-- "QNX" -->
2766 <const name="CIMOS_EPOC" value="49" /> <!-- "EPOC" -->
2767 <const name="CIMOS_IxWorks" value="50" /> <!-- "IxWorks" -->
2768 <const name="CIMOS_VxWorks" value="51" /> <!-- "VxWorks" -->
2769 <const name="CIMOS_MiNT" value="52" /> <!-- "MiNT" -->
2770 <const name="CIMOS_BeOS" value="53" /> <!-- "BeOS" -->
2771 <const name="CIMOS_HPMPE" value="54" /> <!-- "HP MPE" -->
2772 <const name="CIMOS_NextStep" value="55" /> <!-- "NextStep" -->
2773 <const name="CIMOS_PalmPilot" value="56" /> <!-- "PalmPilot" -->
2774 <const name="CIMOS_Rhapsody" value="57" /> <!-- "Rhapsody" -->
2775 <const name="CIMOS_Windows2000" value="58" /> <!-- "Windows 2000" -->
2776 <const name="CIMOS_Dedicated" value="59" /> <!-- "Dedicated" -->
2777 <const name="CIMOS_OS390" value="60" /> <!-- "OS/390" -->
2778 <const name="CIMOS_VSE" value="61" /> <!-- "VSE" -->
2779 <const name="CIMOS_TPF" value="62" /> <!-- "TPF" -->
2780 <const name="CIMOS_WindowsMe" value="63" /> <!-- "Windows (R) Me" -->
2781 <const name="CIMOS_CalderaOpenUNIX" value="64" /> <!-- "Caldera Open UNIX" -->
2782 <const name="CIMOS_OpenBSD" value="65" /> <!-- "OpenBSD" -->
2783 <const name="CIMOS_NotApplicable" value="66" /> <!-- "Not Applicable" -->
2784 <const name="CIMOS_WindowsXP" value="67" /> <!-- "Windows XP" -->
2785 <const name="CIMOS_zOS" value="68" /> <!-- "z/OS" -->
2786 <const name="CIMOS_MicrosoftWindowsServer2003" value="69" /> <!-- "Microsoft Windows Server 2003" -->
2787 <const name="CIMOS_MicrosoftWindowsServer2003_64" value="70" /> <!-- "Microsoft Windows Server 2003 64-Bit" -->
2788 <const name="CIMOS_WindowsXP_64" value="71" /> <!-- "Windows XP 64-Bit" -->
2789 <const name="CIMOS_WindowsXPEmbedded" value="72" /> <!-- "Windows XP Embedded" -->
2790 <const name="CIMOS_WindowsVista" value="73" /> <!-- "Windows Vista" -->
2791 <const name="CIMOS_WindowsVista_64" value="74" /> <!-- "Windows Vista 64-Bit" -->
2792 <const name="CIMOS_WindowsEmbeddedforPointofService" value="75" /> <!-- "Windows Embedded for Point of Service" -->
2793 <const name="CIMOS_MicrosoftWindowsServer2008" value="76" /> <!-- "Microsoft Windows Server 2008" -->
2794 <const name="CIMOS_MicrosoftWindowsServer2008_64" value="77" /> <!-- "Microsoft Windows Server 2008 64-Bit" -->
2795 <const name="CIMOS_FreeBSD_64" value="78" /> <!-- "FreeBSD 64-Bit" -->
2796 <const name="CIMOS_RedHatEnterpriseLinux" value="79" /> <!-- "RedHat Enterprise Linux" -->
2797 <const name="CIMOS_RedHatEnterpriseLinux_64" value="80" /> <!-- "RedHat Enterprise Linux 64-Bit" -->
2798 <const name="CIMOS_Solaris_64" value="81" /> <!-- "Solaris 64-Bit" -->
2799 <const name="CIMOS_SUSE" value="82" /> <!-- "SUSE" -->
2800 <const name="CIMOS_SUSE_64" value="83" /> <!-- "SUSE 64-Bit" -->
2801 <const name="CIMOS_SLES" value="84" /> <!-- "SLES" -->
2802 <const name="CIMOS_SLES_64" value="85" /> <!-- "SLES 64-Bit" -->
2803 <const name="CIMOS_NovellOES" value="86" /> <!-- "Novell OES" -->
2804 <const name="CIMOS_NovellLinuxDesktop" value="87" /> <!-- "Novell Linux Desktop" -->
2805 <const name="CIMOS_SunJavaDesktopSystem" value="88" /> <!-- "Sun Java Desktop System" -->
2806 <const name="CIMOS_Mandriva" value="89" /> <!-- "Mandriva" -->
2807 <const name="CIMOS_Mandriva_64" value="90" /> <!-- "Mandriva 64-Bit" -->
2808 <const name="CIMOS_TurboLinux" value="91" /> <!-- "TurboLinux" -->
2809 <const name="CIMOS_TurboLinux_64" value="92" /> <!-- "TurboLinux 64-Bit" -->
2810 <const name="CIMOS_Ubuntu" value="93" /> <!-- "Ubuntu" -->
2811 <const name="CIMOS_Ubuntu_64" value="94" /> <!-- "Ubuntu 64-Bit" -->
2812 <const name="CIMOS_Debian" value="95" /> <!-- "Debian" -->
2813 <const name="CIMOS_Debian_64" value="96" /> <!-- "Debian 64-Bit" -->
2814 <const name="CIMOS_Linux_2_4_x" value="97" /> <!-- "Linux 2.4.x" -->
2815 <const name="CIMOS_Linux_2_4_x_64" value="98" /> <!-- "Linux 2.4.x 64-Bit" -->
2816 <const name="CIMOS_Linux_2_6_x" value="99" /> <!-- "Linux 2.6.x" -->
2817 <const name="CIMOS_Linux_2_6_x_64" value="100" /> <!-- "Linux 2.6.x 64-Bit" -->
2818 <const name="CIMOS_Linux_64" value="101" /> <!-- "Linux 64-Bit" -->
2819 <const name="CIMOS_Other_64" value="102" /> <!-- "Other 64-Bit" -->
2820 </enum>
2821
2822 <enum
2823 name="OVFResourceType"
2824 uuid="646a78d7-6f04-49f4-82c4-75c28a75a4cd"
2825 >
2826 <desc>
2827 OVF resource type.
2828 </desc>
2829
2830 <const name="Other" value="1" />
2831 <const name="ComputerSystem" value="2" />
2832 <const name="Processor" value="3" />
2833 <const name="Memory" value="4" />
2834 <const name="IdeController" value="5" />
2835 <const name="ParallelScsiHba" value="6" />
2836 <const name="FcHba" value="7" />
2837 <const name="iScsiHba" value="8" />
2838 <const name="IbHca" value="9" />
2839 <const name="EthernetAdapter" value="10" />
2840 <const name="OtherNetworkAdapter" value="11" />
2841 <const name="IoSlot" value="12" />
2842 <const name="IoDevice" value="13" />
2843 <const name="FloppyDrive" value="14" />
2844 <const name="CdDrive" value="15" />
2845 <const name="DvdDrive" value="16" />
2846 <const name="HardDisk" value="17" />
2847 <const name="UsbController" value="23" />
2848 <const name="SoundCard" value="35" />
2849 </enum>
2850
2851 <interface
2852 name="IAppliance" extends="$unknown"
2853 uuid="a7a71c1f-20d3-4483-95c0-7357dda77f50"
2854 wsmap="managed"
2855 >
2856 <desc>
2857 Represents a platform-independent appliance in OVF format. An instance of this is returned
2858 by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2859 appliances with VirtualBox.
2860
2861 The OVF standard suggests two different physical file formats:
2862
2863 <ol>
2864 <li>If the OVF is distributed as a set of files, then @a file must be a fully qualified
2865 path name to an existing OVF descriptor file with an <tt>.ovf</tt> file extension. If
2866 this descriptor file references other files, as OVF appliances distributed as a set of
2867 files most likely do, those files must be in the same directory as the descriptor file.</li>
2868
2869 <li>If the OVF is distributed as a single file, it must be in TAR format and have the
2870 <tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2871 files and optionally other files.
2872
2873 At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2874 be added with a later version.</li>
2875 </ol>
2876
2877 <b>Importing</b> an OVF appliance into VirtualBox as instances of
2878 <link to="IMachine" /> involves the following sequence of API calls:
2879
2880 <ol>
2881 <li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2882 </li>
2883
2884 <li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2885 would like to import. So long as this file is syntactically valid, this will succeed
2886 and return an instance of IAppliance that contains the parsed data from the OVF file.
2887 </li>
2888
2889 <li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2890 contents of the IAppliance attributes accordingly. These can be inspected by a
2891 VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2892 user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2893 instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2894 systems in the OVF, which in turn describe the virtual hardware prescribed by the
2895 OVF (network and hardware adapters, virtual disk images, memory size and so on).
2896 The GUI can then give the user the option to confirm and/or change these suggestions.
2897 </li>
2898
2899 <li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2900 virtual system to override the suggestions made by VirtualBox.
2901 </li>
2902
2903 <li>Finally, call <link to="#importMachines" /> to create virtual machines in
2904 VirtualBox as instances of <link to="IMachine" /> that match the information in the
2905 virtual system descriptions.
2906 </li>
2907 </ol>
2908
2909 <b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2910
2911 <ol>
2912 <li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2913 an empty IAppliance object.
2914 </li>
2915
2916 <li>For each machine you would like to export, call <link to="IMachine::export" />
2917 with the IAppliance object you just created. This creates an instance of
2918 <link to="IVirtualSystemDescription" /> inside the appliance.
2919 </li>
2920
2921 <li>Finally, call <link to="#write" /> with a path specification to have the OVF
2922 file written.</li>
2923 </ol>
2924
2925 </desc>
2926
2927 <attribute name="path" type="wstring" readonly="yes">
2928 <desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2929 the <tt>.ova</tt> file passed to <link to="IAppliance::read" />.</desc>
2930 </attribute>
2931
2932 <attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2933 <desc>
2934 Array of virtual disk definitions. One such description exists for each
2935 disk definition in the OVF; each string array item represents one such piece of
2936 disk information, with the information fields separated by tab (\t) characters.
2937
2938 The caller should be prepared for additional fields being appended to
2939 this string in future versions of VirtualBox and therefore check for
2940 the number of tabs in the strings returned.
2941
2942 In the current version, the following eight fields are returned per string
2943 in the array:
2944
2945 <ol>
2946 <li>Disk ID (unique string identifier given to disk)</li>
2947
2948 <li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2949
2950 <li>Populated size (optional unsigned integer indicating the current size of the
2951 disk; can be approximate; -1 if unspecified)</li>
2952
2953 <li>Format (string identifying the disk format, typically
2954 "http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2955
2956 <li>Reference (where to find the disk image, typically a file name; if empty,
2957 then the disk should be created on import)</li>
2958
2959 <li>Image size (optional unsigned integer indicating the size of the image,
2960 which need not necessarily be the same as the values specified above, since
2961 the image may be compressed or sparse; -1 if not specified)</li>
2962
2963 <li>Chunk size (optional unsigned integer if the image is split into chunks;
2964 presently unsupported and always -1)</li>
2965
2966 <li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2967 </ol>
2968 </desc>
2969 </attribute>
2970
2971 <attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2972 <desc> Array of virtual system descriptions. One such description is created
2973 for each virtual system found in the OVF. The array is empty until after <link to="#interpret" />
2974 has been called.
2975 </desc>
2976 </attribute>
2977
2978 <method name="read">
2979 <desc>
2980 Reads an OVF file into the appliance object.
2981
2982 This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2983 mere fact that this method returns successfully does not mean that VirtualBox supports all
2984 features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2985 </desc>
2986 <param name="file" type="wstring" dir="in">
2987 <desc>
2988 Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2989 on whether the appliance is distributed as a set of files or as a single file, respectively).
2990 </desc>
2991 </param>
2992 </method>
2993
2994 <method name="interpret">
2995 <desc>
2996 Interprets the OVF data that was read when the appliance was constructed. After
2997 calling this method, one can inspect the
2998 <link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2999 one <link to="IVirtualSystemDescription" /> for each virtual machine found in
3000 the appliance.
3001
3002 Calling this method is the second step of importing an appliance into VirtualBox;
3003 see <link to="IAppliance" /> for an overview.
3004 </desc>
3005 </method>
3006
3007 <method name="importMachines">
3008 <desc>
3009 Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
3010 and other interfaces that match the information contained in the appliance as
3011 closely as possible, as represented by the import instructions in the
3012 <link to="#virtualSystemDescriptions" /> array.
3013
3014 Calling this method is the final step of importing an appliance into VirtualBox;
3015 see <link to="IAppliance" /> for an overview.
3016
3017 Since importing the appliance may imply copying disk images, which can take a long
3018 time, this method operates asynchronously and returns an IProgress object to allow
3019 the caller to monitor the progress.
3020 </desc>
3021
3022 <param name="aProgress" type="IProgress" dir="return">
3023 <desc></desc>
3024 </param>
3025 </method>
3026
3027 <method name="write">
3028 <desc>
3029 Writes the contents of the appliance exports into a new OVF file.
3030
3031 Calling this method is the final step of exporting an appliance from VirtualBox;
3032 see <link to="IAppliance" /> for an overview.
3033 </desc>
3034 <param name="path" type="wstring" dir="in">
3035 <desc>
3036 Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3037 on whether the appliance is distributed as a set of files or as a single file, respectively).
3038 </desc>
3039 </param>
3040 </method>
3041
3042 </interface>
3043
3044 <enum
3045 name="VirtualSystemDescriptionType"
3046 uuid="8ac36d00-bb7c-4a35-a835-3f004b27427b"
3047 >
3048 <desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
3049 a configuration value.</desc>
3050
3051 <const name="Ignore" value="1" />
3052 <const name="OS" value="2" />
3053 <const name="Name" value="3" />
3054 <const name="CPU" value="4" />
3055 <const name="Memory" value="5" />
3056 <const name="HardDiskControllerIDE" value="6" />
3057 <const name="HardDiskControllerSATA" value="7" />
3058 <const name="HardDiskControllerSCSI" value="8" />
3059 <const name="HardDiskImage" value="9" />
3060 <const name="Floppy" value="10" />
3061 <const name="CDROM" value="11" />
3062 <const name="LogicalNetwork" value="12" />
3063 <const name="NetworkAdapter" value="13" />
3064 <const name="USBController" value="14" />
3065 <const name="SoundCard" value="15" />
3066
3067 </enum>
3068
3069 <interface
3070 name="IVirtualSystemDescription" extends="$unknown"
3071 uuid="8606c2ae-c06f-487f-9573-1465b44f9524"
3072 wsmap="managed"
3073 >
3074
3075 <desc>This interface is used in the <link to="IAppliance::virtualSystemDescriptions" /> array.
3076 After <link to="IAppliance::interpret" /> has been called, that array contains
3077 information about how the virtual systems described in the OVF should best be imported into VirtualBox
3078 virtual machines. See <link to="IAppliance" /> for the steps required to import an OVF
3079 into VirtualBox.
3080 </desc>
3081
3082 <attribute name="count" type="unsigned long" readonly="yes">
3083 <desc>Return the number of virtual system description entries.</desc>
3084 </attribute>
3085
3086 <method name="getDescription">
3087 <desc>Returns information about the virtual system as arrays of instruction items. In each array, the
3088 items with the same indices correspond and jointly represent an import instruction for VirtualBox.
3089
3090 The list below identifies the value sets that are possible depending on the
3091 <link to="VirtualSystemDescriptionType" /> enum value in the array item in aTypes[]. In each case,
3092 the array item with the same index in aOrigValue[] will contain the original value as contained
3093 in the OVF file (just for informational purposes), and the corresponding item in aConfigValues[]
3094 will contain a suggested value to be used for VirtualBox. Depending on the description type,
3095 the aExtraConfigValues[] array item may also be used.
3096
3097 <ul>
3098 <li>
3099 "OS": the guest operating system type. There must be exactly one such array item on import. The
3100 corresponding item in aConfigValues[] contains the suggested guest operating system for VirtualBox.
3101 This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
3102 item in aOrigValues[] will contain a numerical value that described the operating system in the OVF
3103 (see <link to="CIMOSType" />).
3104 </li>
3105 <li>
3106 "Name": the name to give to the new virtual machine. There can be at most one such array item;
3107 if none is present on import, then an automatic name will be created from the operating system
3108 type. The correponding item im aOrigValues[] will contain the suggested virtual machine name
3109 from the OVF file, and aConfigValues[] will contain a suggestion for a unique VirtualBox
3110 <link to="IMachine" /> name that does not exist yet.
3111 </li>
3112 <li>
3113 "CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
3114 </li>
3115 <li>
3116 "Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
3117 is present on import, then VirtualBox will set a meaningful default based on the operating system
3118 type.
3119 </li>
3120 <li>
3121 "HarddiskControllerIDE": an IDE hard disk controller. There can be at most one such item. This
3122 has no value in aOrigValues[] or aConfigValues[].
3123 The matching item in the aRefs[] array will contain an integer that items of the "Harddisk"
3124 type can use to specify which hard disk controller a virtual disk should be connected to.
3125 </li>
3126 <li>
3127 "HarddiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
3128 has no value in aOrigValues[] or aConfigValues[].
3129 The matching item in the aRefs[] array will be used as with IDE controllers (see above).
3130 </li>
3131 <li>
3132 "HarddiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
3133 The items in aOrigValues[] and aConfigValues[] will either be "LsiLogic" or "BusLogic".
3134 The matching item in the aRefs[] array will be used as with IDE controllers (see above).
3135 </li>
3136 <li>
3137 "Harddisk": a virtual hard disk, most probably as a reference to an image file. There can be an
3138 arbitrary number of these items, one for each virtual disk image that accompanies the OVF. The
3139 array item in aOrigValues[] will contain the file specification from the OVF file, whereas the
3140 item in aConfigValues[] will contain a qualified path specification to where the hard disk image
3141 should be copied; this target image will then be registered with VirtualBox.
3142 The matching item in the aExtraConfigValues[] array must contain a string of the following
3143 format: "controller=&lt;index&gt;;channel=&lt;c&gt;"
3144 In this string, &lt;index&gt; must be an integer specifying the hard disk controller to connect
3145 the image to. That number must be the index of an array item with one of the hard disk controller
3146 types (HarddiskControllerSCSI, HarddiskControllerSATA, HarddiskControllerIDE).
3147 In addition, &lt;c&gt; must specify the channel to use on that controller. For IDE controllers,
3148 this can range from 0-2 (which VirtualBox will interpret as primary master, primary slave,
3149 secondary slave; VirtualBox reserves the secondary master for the CD-ROM drive). For SATA and
3150 SCSI conrollers, the channel can range from 0-29.
3151 </li>
3152 <li>
3153 "LogicalNetwork": a logical network to which virtual machines can connect. This is taken from
3154 the Network section in the OVF that is shared between several virtual systems. OVF has no
3155 formal description of how the network shall be set up (e.g. whether to use NAT or host interface
3156 networking), but OVFs typically name the logical networks "nat" or "bridged" to suggest such
3157 a configuration.
3158 </li>
3159 <li>
3160 "NetworkAdapter": a network adapter. The array item in aConfigValues[] will specify the hardware
3161 for the network adapter, whereas the array item in aExtraConfigValues[] will have a string
3162 of the "network=&lt;nw&gt;" format, where &lt;nw&gt; must be one of the networks as specified with the
3163 LogicalNetwork type.
3164 </li>
3165 <li>
3166 "SoundCard": a sound card. There can be at most one such item. If and only if such an item is
3167 present, sound support will be enabled for the new virtual machine. Note that the virtual
3168 machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
3169 may be different from the virtual soundcard expected by the appliance.
3170 </li>
3171 </ul>
3172
3173 </desc>
3174
3175 <param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3176 <desc></desc>
3177 </param>
3178
3179 <param name="aRefs" type="wstring" dir="out" safearray="yes">
3180 <desc></desc>
3181 </param>
3182
3183 <param name="aOrigValues" type="wstring" dir="out" safearray="yes">
3184 <desc></desc>
3185 </param>
3186
3187 <param name="aConfigValues" type="wstring" dir="out" safearray="yes">
3188 <desc></desc>
3189 </param>
3190
3191 <param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3192 <desc></desc>
3193 </param>
3194
3195 </method>
3196
3197 <method name="setFinalValues">
3198 <desc>
3199 This method allows the appliance's user to change the configuration for the virtual
3200 system descriptions. For each array item returned from <link to="getDescription" />,
3201 you must pass in one boolean value and one configuration value.
3202
3203 Each item in the boolean array determines whether the particular configuration item
3204 should be enabled.
3205 You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
3206 HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
3207 and SoundCard.
3208
3209 For the configuration and "extra" configuration values, if you pass in the same arrays
3210 as returned in the aConfigValues and aExtraConfigValues arrays from getDescription(),
3211 the configuration remains unchanged. Please see the documentation for getDescription()
3212 for valid configuration values for the individual array item types. If the
3213 corresponding item in the aEnabled array is false, the configuration value is ignored.
3214 </desc>
3215
3216 <param name="aEnabled" type="boolean" dir="in" safearray="yes">
3217 <desc></desc>
3218 </param>
3219
3220 <param name="aConfigValues" type="wstring" dir="in" safearray="yes">
3221 <desc></desc>
3222 </param>
3223
3224 <param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
3225 <desc></desc>
3226 </param>
3227 </method>
3228
3229 <method name="getWarnings">
3230 <desc>Returns textual warnings which occurs on the virtual system
3231 interpretion.</desc>
3232
3233 <param name="aWarnings" type="wstring" dir="return" safearray="yes">
3234 <desc></desc>
3235 </param>
3236 </method>
3237
3238 </interface>
3239
3240
3241 <!--
3242 // IMachine
3243 /////////////////////////////////////////////////////////////////////////
3244 -->
3245
3246 <interface
3247 name="IInternalMachineControl" extends="$unknown"
3248 uuid="4042ddf2-93d3-4749-8517-dde3f17ea630"
3249 internal="yes"
3250 wsmap="suppress"
3251 >
3252 <method name="updateState">
3253 <desc>
3254 Updates the VM state.
3255 <note>
3256 This operation will also update the settings file with
3257 the correct information about the saved state file
3258 and delete this file from disk when appropriate.
3259 </note>
3260 </desc>
3261 <param name="state" type="MachineState" dir="in"/>
3262 </method>
3263
3264 <method name="getIPCId">
3265 <param name="id" type="wstring" dir="return"/>
3266 </method>
3267
3268 <method name="runUSBDeviceFilters">
3269 <desc>
3270 Asks the server to run USB devices filters of the associated
3271 machine against the given USB device and tell if there is
3272 a match.
3273 <note>
3274 Intended to be used only for remote USB devices. Local
3275 ones don't require to call this method (this is done
3276 implicitly by the Host and USBProxyService).
3277 </note>
3278 </desc>
3279 <param name="device" type="IUSBDevice" dir="in"/>
3280 <param name="matched" type="boolean" dir="out"/>
3281 <param name="maskedInterfaces" type="unsigned long" dir="out"/>
3282 </method>
3283
3284 <method name="captureUSBDevice">
3285 <desc>
3286 Requests a capture of the given host USB device.
3287 When the request is completed, the VM process will
3288 get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3289 notification.
3290 </desc>
3291 <param name="id" type="uuid" dir="in"/>
3292 </method>
3293
3294 <method name="detachUSBDevice">
3295 <desc>
3296 Notification that a VM is going to detach (done = false) or has
3297 already detached (done = true) the given USB device.
3298 When the done = true request is completed, the VM process will
3299 get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3300 notification.
3301 <note>
3302 In the done = true case, the server must run its own filters
3303 and filters of all VMs but this one on the detached device
3304 as if it were just attached to the host computer.
3305 </note>
3306 </desc>
3307 <param name="id" type="uuid" dir="in"/>
3308 <param name="done" type="boolean" dir="in"/>
3309 </method>
3310
3311 <method name="autoCaptureUSBDevices">
3312 <desc>
3313 Requests a capture all matching USB devices attached to the host.
3314 When the request is completed, the VM process will
3315 get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3316 notification per every captured device.
3317 </desc>
3318 </method>
3319
3320 <method name="detachAllUSBDevices">
3321 <desc>
3322 Notification that a VM that is being powered down. The done
3323 parameter indicates whether which stage of the power down
3324 we're at. When done = false the VM is announcing its
3325 intentions, while when done = true the VM is reporting
3326 what it has done.
3327 <note>
3328 In the done = true case, the server must run its own filters
3329 and filters of all VMs but this one on all detach devices as
3330 if they were just attached to the host computer.
3331 </note>
3332 </desc>
3333 <param name="done" type="boolean" dir="in"/>
3334 </method>
3335
3336 <method name="onSessionEnd">
3337 <desc>
3338 Triggered by the given session object when the session is about
3339 to close normally.
3340 </desc>
3341 <param name="session" type="ISession" dir="in">
3342 <desc>Session that is being closed</desc>
3343 </param>
3344 <param name="progress" type="IProgress" dir="return">
3345 <desc>
3346 Used to wait until the corresponding machine is actually
3347 dissociated from the given session on the server.
3348 Returned only when this session is a direct one.
3349 </desc>
3350 </param>
3351 </method>
3352
3353 <method name="beginSavingState">
3354 <desc>
3355 Called by the VM process to inform the server it wants to
3356 save the current state and stop the VM execution.
3357 </desc>
3358 <param name="progress" type="IProgress" dir="in">
3359 <desc>
3360 Progress object created by the VM process to wait until
3361 the state is saved.
3362 </desc>
3363 </param>
3364 <param name="stateFilePath" type="wstring" dir="out">
3365 <desc>
3366 File path the VM process must save the execution state to.
3367 </desc>
3368 </param>
3369 </method>
3370
3371 <method name="endSavingState">
3372 <desc>
3373 Called by the VM process to inform the server that saving
3374 the state previously requested by #beginSavingState is either
3375 successfully finished or there was a failure.
3376
3377 <result name="VBOX_E_FILE_ERROR">
3378 Settings file not accessible.
3379 </result>
3380 <result name="VBOX_E_XML_ERROR">
3381 Could not parse the settings file.
3382 </result>
3383
3384 </desc>
3385
3386 <param name="success" type="boolean" dir="in">
3387 <desc><tt>true</tt> to indicate success and <tt>false</tt>
3388 otherwise.
3389 </desc>
3390 </param>
3391 </method>
3392
3393 <method name="adoptSavedState">
3394 <desc>
3395 Gets called by IConsole::adoptSavedState.
3396 <result name="VBOX_E_FILE_ERROR">
3397 Invalid saved state file path.
3398 </result>
3399 </desc>
3400 <param name="savedStateFile" type="wstring" dir="in">
3401 <desc>Path to the saved state file to adopt.</desc>
3402 </param>
3403 </method>
3404
3405 <method name="beginTakingSnapshot">
3406 <desc>
3407 Called by the VM process to inform the server it wants to
3408 take a snapshot.
3409
3410 <result name="VBOX_E_FILE_ERROR">
3411 Settings file not accessible.
3412 </result>
3413 <result name="VBOX_E_XML_ERROR">
3414 Could not parse the settings file.
3415 </result>
3416 </desc>
3417 <param name="initiator" type="IConsole" dir="in">
3418 <desc>The console object that initiated this call.</desc>
3419 </param>
3420 <param name="name" type="wstring" dir="in">
3421 <desc>Snapshot name.</desc>
3422 </param>
3423 <param name="description" type="wstring" dir="in">
3424 <desc>Snapshot description.</desc>
3425 </param>
3426 <param name="progress" type="IProgress" dir="in">
3427 <desc>
3428 Progress object created by the VM process to wait until
3429 the state is saved (only for online snapshots).
3430 </desc>
3431 </param>
3432 <param name="stateFilePath" type="wstring" dir="out">
3433 <desc>
3434 File path the VM process must save the execution state to.
3435 </desc>
3436 </param>
3437 <param name="serverProgress" type="IProgress" dir="out">
3438 <desc>
3439 Progress object created by the server process to wait until
3440 the snapshot is taken (VDI diff creation, etc.).
3441 </desc>
3442 </param>
3443 </method>
3444
3445 <method name="endTakingSnapshot">
3446 <desc>
3447 Called by the VM process to inform the server that the snapshot
3448 previously requested by #beginTakingSnapshot is either
3449 successfully taken or there was a failure.
3450 </desc>
3451
3452 <param name="success" type="boolean" dir="in">
3453 <desc><tt>true</tt> to indicate success and <tt>false</tt> otherwise</desc>
3454 </param>
3455 </method>
3456
3457 <method name="discardSnapshot">
3458 <desc>
3459 Gets called by IConsole::discardSnapshot.
3460 <result name="VBOX_E_INVALID_OBJECT_STATE">
3461 Snapshot has more than one child snapshot.
3462 </result>
3463 </desc>
3464 <param name="initiator" type="IConsole" dir="in">
3465 <desc>The console object that initiated this call.</desc>
3466 </param>
3467 <param name="id" type="uuid" dir="in">
3468 <desc>UUID of the snapshot to discard.</desc>
3469 </param>
3470 <param name="machineState" type="MachineState" dir="out">
3471 <desc>New machine state after this operation is started.</desc>
3472 </param>
3473 <param name="progress" type="IProgress" dir="return">
3474 <desc>Progress object to track the operation completion.</desc>
3475 </param>
3476 </method>
3477
3478 <method name="discardCurrentState">
3479 <desc>
3480 Gets called by IConsole::discardCurrentState.
3481 <result name="VBOX_E_INVALID_OBJECT_STATE">
3482 Virtual machine does not have any snapshot.
3483 </result>
3484 </desc>
3485 <param name="initiator" type="IConsole" dir="in">
3486 <desc>The console object that initiated this call.</desc>
3487 </param>
3488 <param name="machineState" type="MachineState" dir="out">
3489 <desc>New machine state after this operation is started.</desc>
3490 </param>
3491 <param name="progress" type="IProgress" dir="return">
3492 <desc>Progress object to track the operation completion.</desc>
3493 </param>
3494 </method>
3495
3496 <method name="discardCurrentSnapshotAndState">
3497 <desc>
3498 Gets called by IConsole::discardCurrentSnapshotAndState.
3499 <result name="VBOX_E_INVALID_OBJECT_STATE">
3500 Virtual machine does not have any snapshot.
3501 </result>
3502 </desc>
3503 <param name="initiator" type="IConsole" dir="in">
3504 <desc>The console object that initiated this call.</desc>
3505 </param>
3506 <param name="machineState" type="MachineState" dir="out">
3507 <desc>New machine state after this operation is started.</desc>
3508 </param>
3509 <param name="progress" type="IProgress" dir="return">
3510 <desc>Progress object to track the operation completion.</desc>
3511 </param>
3512 </method>
3513
3514 <method name="pullGuestProperties">
3515 <desc>
3516 Get the list of the guest properties matching a set of patterns along
3517 with their values, time stamps and flags and give responsibility for
3518 managing properties to the console.
3519 </desc>
3520 <param name="name" type="wstring" dir="out" safearray="yes">
3521 <desc>
3522 The names of the properties returned.
3523 </desc>
3524 </param>
3525 <param name="value" type="wstring" dir="out" safearray="yes">
3526 <desc>
3527 The values of the properties returned. The array entries match the
3528 corresponding entries in the @a name array.
3529 </desc>
3530 </param>
3531 <param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
3532 <desc>
3533 The time stamps of the properties returned. The array entries match
3534 the corresponding entries in the @a name array.
3535 </desc>
3536 </param>
3537 <param name="flags" type="wstring" dir="out" safearray="yes">
3538 <desc>
3539 The flags of the properties returned. The array entries match the
3540 corresponding entries in the @a name array.
3541 </desc>
3542 </param>
3543 </method>
3544
3545 <method name="pushGuestProperties">
3546 <desc>
3547 Set the list of the guest properties matching a set of patterns along
3548 with their values, time stamps and flags and return responsibility for
3549 managing properties to IMachine.
3550 </desc>
3551 <param name="name" type="wstring" dir="in" safearray="yes">
3552 <desc>
3553 The names of the properties.
3554 </desc>
3555 </param>
3556 <param name="value" type="wstring" dir="in" safearray="yes">
3557 <desc>
3558 The values of the properties. The array entries match the
3559 corresponding entries in the @a name array.
3560 </desc>
3561 </param>
3562 <param name="timestamp" type="unsigned long long" dir="in" safearray="yes">
3563 <desc>
3564 The time stamps of the properties. The array entries match
3565 the corresponding entries in the @a name array.
3566 </desc>
3567 </param>
3568 <param name="flags" type="wstring" dir="in" safearray="yes">
3569 <desc>
3570 The flags of the properties. The array entries match the
3571 corresponding entries in the @a name array.
3572 </desc>
3573 </param>
3574 </method>
3575 <method name="pushGuestProperty">
3576 <desc>
3577 Update a single guest property in IMachine.
3578 </desc>
3579 <param name="name" type="wstring" dir="in">
3580 <desc>
3581 The name of the property to be updated.
3582 </desc>
3583 </param>
3584 <param name="value" type="wstring" dir="in">
3585 <desc>
3586 The value of the property.
3587 </desc>
3588 </param>
3589 <param name="timestamp" type="unsigned long long" dir="in">
3590 <desc>
3591 The timestamp of the property.
3592 </desc>
3593 </param>
3594 <param name="flags" type="wstring" dir="in">
3595 <desc>
3596 The flags of the property.
3597 </desc>
3598 </param>
3599 </method>
3600 </interface>
3601
3602 <interface
3603 name="IBIOSSettings" extends="$unknown"
3604 uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3605 wsmap="managed"
3606 >
3607 <desc>
3608 The IBIOSSettings interface represents BIOS settings of the virtual
3609 machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3610 </desc>
3611 <attribute name="logoFadeIn" type="boolean">
3612 <desc>Fade in flag for BIOS logo animation.</desc>
3613 </attribute>
3614
3615 <attribute name="logoFadeOut" type="boolean">
3616 <desc>Fade out flag for BIOS logo animation.</desc>
3617 </attribute>
3618
3619 <attribute name="logoDisplayTime" type="unsigned long">
3620 <desc>BIOS logo display time in milliseconds (0 = default).</desc>
3621 </attribute>
3622
3623 <attribute name="logoImagePath" type="wstring">
3624 <desc>Local file system path for external BIOS image.</desc>
3625 </attribute>
3626
3627 <attribute name="bootMenuMode" type="BIOSBootMenuMode">
3628 <desc>Mode of the BIOS boot device menu.</desc>
3629 </attribute>
3630
3631 <attribute name="ACPIEnabled" type="boolean">
3632 <desc>ACPI support flag.</desc>
3633 </attribute>
3634
3635 <attribute name="IOAPICEnabled" type="boolean">
3636 <desc>
3637 IO APIC support flag. If set, VirtualBox will provide an IO APIC
3638 and support IRQs above 15.
3639 </desc>
3640 </attribute>
3641
3642 <attribute name="timeOffset" type="long long">
3643 <desc>
3644 Offset in milliseconds from the host system time. This allows for
3645 guests running with a different system date/time than the host.
3646 It is equivalent to setting the system date/time in the BIOS except
3647 it is not an absolute value but a relative one. Guest Additions
3648 time synchronization honors this offset.
3649 </desc>
3650 </attribute>
3651
3652 <attribute name="PXEDebugEnabled" type="boolean">
3653 <desc>
3654 PXE debug logging flag. If set, VirtualBox will write extensive
3655 PXE trace information to the release log.
3656 </desc>
3657 </attribute>
3658
3659 <attribute name="IDEControllerType" type="IDEControllerType">
3660 <desc>
3661 Type of the virtual IDE controller. Depending on this value,
3662 VirtualBox will provide different virtual IDE hardware
3663 devices to the guest.
3664 </desc>
3665 </attribute>
3666
3667 </interface>
3668
3669 <interface
3670 name="IMachine" extends="$unknown"
3671 uuid="ea6fb7ea-1993-4642-b113-f29eb39e0df0"
3672 wsmap="managed"
3673 >
3674 <desc>
3675 The IMachine interface represents a virtual machine, or guest, created
3676 in VirtualBox.
3677
3678 This interface is used in two contexts. First of all, a collection of
3679 objects implementing this interface is stored in the
3680 <link to="IVirtualBox::machines2"/> attribute which lists all the virtual
3681 machines that are currently registered with this VirtualBox
3682 installation. Also, once a session has been opened for the given virtual
3683 machine (e.g. the virtual machine is running), the machine object
3684 associated with the open session can be queried from the session object;
3685 see <link to="ISession"/> for details.
3686
3687 The main role of this interface is to expose the settings of the virtual
3688 machine and provide methods to change various aspects of the virtual
3689 machine's configuration. For machine objects stored in the
3690 <link to="IVirtualBox::machines2"/> collection, all attributes are
3691 read-only unless explicitly stated otherwise in individual attribute
3692 and method descriptions. In order to change a machine setting, a session
3693 for this machine must be opened using one of
3694 <link to="IVirtualBox::openSession"/>,
3695 <link to="IVirtualBox::openRemoteSession"/> or
3696 <link to="IVirtualBox::openExistingSession"/> methods. After the
3697 session has been successfully opened, a mutable machine object needs to
3698 be queried from the session object and then the desired settings changes
3699 can be applied to the returned object using IMachine attributes and
3700 methods. See the ISession interface description for more information
3701 about sessions.
3702
3703 Note that the IMachine interface does not provide methods to control
3704 virtual machine execution (such as start the machine, or power it
3705 down) -- these methods are grouped in a separate IConsole
3706 interface. Refer to the IConsole interface description to get more
3707 information about this topic.
3708
3709 <see>ISession, IConsole</see>
3710 </desc>
3711
3712 <attribute name="parent" type="IVirtualBox" readonly="yes">
3713 <desc>Associated parent object.</desc>
3714 </attribute>
3715
3716 <attribute name="accessible" type="boolean" readonly="yes">
3717 <desc>
3718 Whether this virtual machine is currently accessible or not.
3719
3720 The machine is considered to be inaccessible when:
3721 <ul>
3722 <li>It is a registered virtual machine, and
3723 </li>
3724 <li>Its settings file is inaccessible (for example, it is
3725 located on a network share that is not accessible during
3726 VirtualBox startup, or becomes inaccessible later, or if
3727 the settings file can be read but is invalid).
3728 </li>
3729 </ul>
3730
3731 Otherwise, the value of this property is always <tt>true</tt>.
3732
3733 Every time this property is read, the accessibility state of
3734 this machine is re-evaluated. If the returned value is |false|,
3735 the <link to="#accessError"/> property may be used to get the
3736 detailed error information describing the reason of
3737 inaccessibility.
3738
3739 When the machine is inaccessible, only the following properties
3740 can be used on it:
3741 <ul>
3742 <li><link to="#parent"/></li>
3743 <li><link to="#id"/></li>
3744 <li><link to="#settingsFilePath"/></li>
3745 <li><link to="#accessible"/></li>
3746 <li><link to="#accessError"/></li>
3747 </ul>
3748
3749 An attempt to access any other property or method will return
3750 an error.
3751
3752 The only possible action you can perform on an inaccessible
3753 machine is to unregister it using the
3754 <link to="IVirtualBox::unregisterMachine"/> call (or, to check
3755 for the accessibility state once more by querying this
3756 property).
3757
3758 <note>
3759 In the current implementation, once this property returns
3760 <tt>true</tt>, the machine will never become inaccessible
3761 later, even if its settings file cannot be successfully
3762 read/written any more (at least, until the VirtualBox
3763 server is restarted). This limitation may be removed in
3764 future releases.
3765 </note>
3766 </desc>
3767 </attribute>
3768
3769 <attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3770 <desc>
3771 Error information describing the reason of machine
3772 inaccessibility.
3773
3774 Reading this property is only valid after the last call to
3775 <link to="#accessible"/> returned <tt>false</tt> (i.e. the
3776 machine is currently unaccessible). Otherwise, a null
3777 IVirtualBoxErrorInfo object will be returned.
3778 </desc>
3779 </attribute>
3780
3781 <attribute name="name" type="wstring">
3782 <desc>
3783 Name of the virtual machine.
3784
3785 Besides being used for human-readable identification purposes
3786 everywhere in VirtualBox, the virtual machine name is also used
3787 as a name of the machine's settings file and as a name of the
3788 subdirectory this settings file resides in. Thus, every time you
3789 change the value of this property, the settings file will be
3790 renamed once you call <link to="#saveSettings"/> to confirm the
3791 change. The containing subdirectory will be also renamed, but
3792 only if it has exactly the same name as the settings file
3793 itself prior to changing this property (for backward compatibility
3794 with previous API releases). The above implies the following
3795 limitations:
3796 <ul>
3797 <li>The machine name cannot be empty.</li>
3798 <li>The machine name can contain only characters that are valid
3799 file name characters according to the rules of the file
3800 system used to store VirtualBox configuration.</li>
3801 <li>You cannot have two or more machines with the same name
3802 if they use the same subdirectory for storing the machine
3803 settings files.</li>
3804 <li>You cannot change the name of the machine if it is running,
3805 or if any file in the directory containing the settings file
3806 is being used by another running machine or by any other
3807 process in the host operating system at a time when
3808 <link to="#saveSettings"/> is called.
3809 </li>
3810 </ul>
3811 If any of the above limitations are hit, <link to="#saveSettings"/>
3812 will return an appropriate error message explaining the exact
3813 reason and the changes you made to this machine will not be
3814 saved.
3815 <note>
3816 For "legacy" machines created using the
3817 <link to="IVirtualBox::createLegacyMachine"/> call,
3818 the above naming limitations do not apply because the
3819 machine name does not affect the settings file name.
3820 The settings file name remains the same as it was specified
3821 during machine creation and never changes.
3822 </note>
3823 </desc>
3824 </attribute>
3825
3826 <attribute name="description" type="wstring">
3827 <desc>
3828 Description of the virtual machine.
3829
3830 The description attribute can contain any text and is
3831 typically used to describe the hardware and software
3832 configuration of the virtual machine in detail (i.e. network
3833 settings, versions of the installed software and so on).
3834 </desc>
3835 </attribute>
3836
3837 <attribute name="id" type="uuid" readonly="yes">
3838 <desc>UUID of the virtual machine.</desc>
3839 </attribute>
3840
3841 <attribute name="OSTypeId" type="wstring">
3842 <desc>
3843 User-defined identifier of the Guest OS type.
3844 You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3845 an IGuestOSType object representing details about the given
3846 Guest OS type.
3847 <note>
3848 This value may differ from the value returned by
3849 <link to="IGuest::OSTypeId"/> if Guest Additions are
3850 installed to the guest OS.
3851 </note>
3852 </desc>
3853 </attribute>
3854
3855 <attribute name="HardwareVersion" type="wstring">
3856 <desc>Hardware version identifier. Internal use only for now.</desc>
3857 </attribute>
3858
3859 <attribute name="CPUCount" type="unsigned long">
3860 <desc>Number of virtual CPUs in the VM. In the current version of the product, this is always 1.</desc>
3861 </attribute>
3862
3863 <attribute name="memorySize" type="unsigned long">
3864 <desc>System memory size in megabytes.</desc>
3865 </attribute>
3866
3867 <attribute name="memoryBalloonSize" type="unsigned long">
3868 <desc>Initial memory balloon size in megabytes.</desc>
3869 </attribute>
3870
3871 <attribute name="statisticsUpdateInterval" type="unsigned long">
3872 <desc>Initial interval to update guest statistics in seconds.</desc>
3873 </attribute>
3874
3875 <attribute name="VRAMSize" type="unsigned long">
3876 <desc>Video memory size in megabytes.</desc>
3877 </attribute>
3878
3879 <attribute name="accelerate3DEnabled" type="boolean" default="false">
3880 <desc>
3881 This setting determines whether VirtualBox allows guests to make use
3882 of the 3D graphics support available on the host. Currently limited
3883 to OpenGL only. </desc>
3884 </attribute>
3885
3886 <attribute name="monitorCount" type="unsigned long">
3887 <desc>
3888 Number of virtual monitors.
3889 <note>
3890 Only effective on Windows XP and later guests with
3891 Guest Additions installed.
3892 </note>
3893 </desc>
3894 </attribute>
3895
3896 <attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3897 <desc>Object containing all BIOS settings.</desc>
3898 </attribute>
3899
3900 <attribute name="HWVirtExEnabled" type="TSBool">
3901 <desc>
3902 This setting determines whether VirtualBox will try to make use of
3903 the host CPU's hardware virtualization extensions such as Intel VT-x
3904 and AMD-V. Note that in case such extensions are not available,
3905 they will not be used.
3906 </desc>
3907 </attribute>
3908
3909 <attribute name="HWVirtExNestedPagingEnabled" type="boolean" default="false">
3910 <desc>
3911 This setting determines whether VirtualBox will try to make use of
3912 the nested paging extension of Intel VT-x and AMD-V. Note that in case
3913 such extensions are not available, they will not be used.
3914 </desc>
3915 </attribute>
3916
3917 <attribute name="HWVirtExVPIDEnabled" type="boolean" default="false">
3918 <desc>
3919 This setting determines whether VirtualBox will try to make use of
3920 the VPID extension of Intel VT-x. Note that in case such extensions are
3921 not available, they will not be used.
3922 </desc>
3923 </attribute>
3924
3925 <attribute name="PAEEnabled" type="boolean" default="false">
3926 <desc>
3927 This setting determines whether VirtualBox will expose the Physical Address
3928 Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
3929 is not available, it will not be reported.
3930 </desc>
3931 </attribute>
3932
3933 <attribute name="snapshotFolder" type="wstring">
3934 <desc>
3935 Full path to the directory used to store snapshot data
3936 (differencing hard disks and saved state files) of this machine.
3937
3938 The initial value of this property is
3939 <tt>&lt;</tt><link to="#settingsFilePath">
3940 path_to_settings_file</link><tt>&gt;/&lt;</tt>
3941 <link to="#id">machine_uuid</link>
3942 <tt>&gt;</tt>.
3943
3944 Currently, it is an error to try to change this property on
3945 a machine that has snapshots (because this would require to
3946 move possibly large files to a different location).
3947 A separate method will be available for this purpose later.
3948
3949 <note>
3950 Setting this property to <tt>null</tt> will restore the
3951 initial value.
3952 </note>
3953 <note>
3954 When setting this property, the specified path can be
3955 absolute (full path) or relative to the directory where the
3956 <link to="#settingsFilePath">machine settings file</link>
3957 is located. When reading this property, a full path is
3958 always returned.
3959 </note>
3960 <note>
3961 The specified path may not exist, it will be created
3962 when necessary.
3963 </note>
3964 </desc>
3965 </attribute>
3966
3967 <attribute name="VRDPServer" type="IVRDPServer" readonly="yes">
3968 <desc>VRDP server object.</desc>
3969 </attribute>
3970
3971 <attribute name="hardDiskAttachments" type="IHardDiskAttachment" readonly="yes" safearray="yes">
3972 <desc>Array of hard disks attached to this machine.</desc>
3973 </attribute>
3974
3975 <attribute name="DVDDrive" type="IDVDDrive" readonly="yes">
3976 <desc>Associated DVD drive object.</desc>
3977 </attribute>
3978
3979 <attribute name="floppyDrive" type="IFloppyDrive" readonly="yes">
3980 <desc>Associated floppy drive object.</desc>
3981 </attribute>
3982
3983 <attribute name="USBController" type="IUSBController" readonly="yes">
3984 <desc>
3985 Associated USB controller object.
3986
3987 <note>
3988 This method may set a @ref com_warnings "warning result code".
3989 </note>
3990 <note>
3991 If USB functionality is not available in the given edition of
3992 VirtualBox, this method will set the result code to @c E_NOTIMPL.
3993 </note>
3994 </desc>
3995 </attribute>
3996
3997 <attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3998 <desc>Associated audio adapter, always present.</desc>
3999 </attribute>
4000
4001 <attribute name="SATAController" type="ISATAController" readonly="yes">
4002 <desc>
4003 Associated SATA controller object.
4004 </desc>
4005 </attribute>
4006
4007 <attribute name="settingsFilePath" type="wstring" readonly="yes">
4008 <desc>
4009 Full name of the file containing machine settings data.
4010 </desc>
4011 </attribute>
4012
4013 <attribute name="settingsFileVersion" type="wstring" readonly="yes">
4014 <desc>
4015 Current version of the format of the settings file of this machine
4016 (<link to="#settingsFilePath"/>).
4017
4018 The version string has the following format:
4019 <pre>
4020 x.y-platform
4021 </pre>
4022 where <tt>x</tt> and <tt>y</tt> are the major and the minor format
4023 versions, and <tt>platform</tt> is the platform identifier.
4024
4025 The current version usually matches the value of the
4026 <link to="IVirtualBox::settingsFormatVersion"/> attribute unless the
4027 settings file was created by an older version of VirtualBox and there
4028 was a change of the settings file format since then.
4029
4030 Note that VirtualBox automatically converts settings files from older
4031 versions to the most recent version when reading them (usually at
4032 VirtualBox startup) but it doesn't save the changes back until
4033 you call a method that implicitly saves settings (such as
4034 <link to="#setExtraData"/>) or call <link to="#saveSettings"/>
4035 explicitly. Therefore, if the value of this attribute differs from the
4036 value of <link to="IVirtualBox::settingsFormatVersion"/>, then it
4037 means that the settings file was converted but the result of the
4038 conversion is not yet saved to disk.
4039
4040 The above feature may be used by interactive front-ends to inform users
4041 about the settings file format change and offer them to explicitly save
4042 all converted settings files (the global and VM-specific ones),
4043 optionally create backup copies of the old settings files before saving,
4044 etc.
4045
4046 <see>IVirtualBox::settingsFormatVersion, saveSettingsWithBackup()</see>
4047 </desc>
4048 </attribute>
4049
4050 <attribute name="settingsModified" type="boolean" readonly="yes">
4051 <desc>
4052 Whether the settings of this machine have been modified
4053 (but neither yet saved nor discarded).
4054 <note>
4055 Reading this property is only valid on instances returned
4056 by <link to="ISession::machine"/> and on new machines
4057 created by <link to="IVirtualBox::createMachine"/> or opened
4058 by <link to="IVirtualBox::openMachine"/> but not
4059 yet registered, or on unregistered machines after calling
4060 <link to="IVirtualBox::unregisterMachine"/>. For all other
4061 cases, the settings can never be modified.
4062 </note>
4063 <note>
4064 For newly created unregistered machines, the value of this
4065 property is always TRUE until <link to="#saveSettings"/>
4066 is called (no matter if any machine settings have been
4067 changed after the creation or not). For opened machines
4068 the value is set to FALSE (and then follows to normal rules).
4069 </note>
4070 </desc>
4071 </attribute>
4072
4073 <attribute name="sessionState" type="SessionState" readonly="yes">
4074 <desc>Current session state for this machine.</desc>
4075 </attribute>
4076
4077 <attribute name="sessionType" type="wstring" readonly="yes">
4078 <desc>
4079 Type of the session. If <link to="#sessionState"/> is
4080 SessionSpawning or SessionOpen, this attribute contains the
4081 same value as passed to the
4082 <link to="IVirtualBox::openRemoteSession"/> method in the
4083 @a type parameter. If the session was opened directly using
4084 <link to="IVirtualBox::openSession"/>, or if
4085 <link to="#sessionState"/> is SessionClosed, the value of this
4086 attribute is @c null.
4087 </desc>
4088 </attribute>
4089
4090 <attribute name="sessionPid" type="unsigned long" readonly="yes">
4091 <desc>
4092 Identifier of the session process. This attribute contains the
4093 platform-dependent identifier of the process that has opened a
4094 direct session for this machine using the
4095 <link to="IVirtualBox::openSession"/> call. The returned value
4096 is only valid if <link to="#sessionState"/> is SessionOpen or
4097 SessionClosing (i.e. a session is currently open or being
4098 closed) by the time this property is read.
4099 </desc>
4100 </attribute>
4101
4102 <attribute name="state" type="MachineState" readonly="yes">
4103 <desc>Current execution state of this machine.</desc>
4104 </attribute>
4105
4106 <attribute name="lastStateChange" type="long long" readonly="yes">
4107 <desc>
4108 Time stamp of the last execution state change,
4109 in milliseconds since 1970-01-01 UTC.
4110 </desc>
4111 </attribute>
4112
4113 <attribute name="stateFilePath" type="wstring" readonly="yes">
4114 <desc>
4115 Full path to the file that stores the execution state of
4116 the machine when it is in the <link to="MachineState_Saved"/> state.
4117 <note>
4118 When the machine is not in the Saved state, this attribute
4119 <tt>null</tt>.
4120 </note>
4121 </desc>
4122 </attribute>
4123
4124 <attribute name="logFolder" type="wstring" readonly="yes">
4125 <desc>
4126 Full path to the folder that stores a set of rotated log files
4127 recorded during machine execution. The most recent log file is
4128 named <tt>VBox.log</tt>, the previous log file is
4129 named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4130 in the current version).
4131 </desc>
4132 </attribute>
4133
4134 <attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4135 <desc>
4136 Current snapshot of this machine.
4137 <note>
4138 A <tt>null</tt> object is returned if the machine doesn't
4139 have snapshots.
4140 </note>
4141 <see><link to="ISnapshot"/></see>
4142 </desc>
4143 </attribute>
4144
4145 <attribute name="snapshotCount" type="unsigned long" readonly="yes">
4146 <desc>
4147 Number of snapshots taken on this machine. Zero means the
4148 machine doesn't have any snapshots.
4149 </desc>
4150 </attribute>
4151
4152 <attribute name="currentStateModified" type="boolean" readonly="yes">
4153 <desc>
4154 Returns <tt>true</tt> if the current state of the machine is not
4155 identical to the state stored in the current snapshot.
4156
4157 The current state is identical to the current snapshot right
4158 after one of the following calls are made:
4159 <ul>
4160 <li><link to="IConsole::discardCurrentState"/> or
4161 <link to="IConsole::discardCurrentSnapshotAndState"/>
4162 </li>
4163 <li><link to="IConsole::takeSnapshot"/> (issued on a
4164 powered off or saved machine, for which
4165 <link to="#settingsModified"/> returns <tt>false</tt>)
4166 </li>
4167 <li><link to="IMachine::setCurrentSnapshot"/>
4168 </li>
4169 </ul>
4170
4171 The current state remains identical until one of the following
4172 happens:
4173 <ul>
4174 <li>settings of the machine are changed</li>
4175 <li>the saved state is discarded</li>
4176 <li>the current snapshot is discarded</li>
4177 <li>an attempt to execute the machine is made</li>
4178 </ul>
4179
4180 <note>
4181 For machines that don't have snapshots, this property is
4182 always <tt>false</tt>.
4183 </note>
4184 </desc>
4185 </attribute>
4186
4187 <attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4188 <desc>
4189 Collection of shared folders for this machine (permanent shared
4190 folders). These folders are shared automatically at machine startup
4191 and available only to the guest OS installed within this machine.
4192
4193 New shared folders are added to the collection using
4194 <link to="#createSharedFolder"/>. Existing shared folders can be
4195 removed using <link to="#removeSharedFolder"/>.
4196 </desc>
4197 </attribute>
4198
4199 <attribute name="clipboardMode" type="ClipboardMode">
4200 <desc>
4201 Synchronization mode between the host OS clipboard
4202 and the guest OS clipboard.
4203 </desc>
4204 </attribute>
4205
4206 <attribute name="guestPropertyNotificationPatterns" type="wstring">
4207 <desc>
4208 A comma-separated list of simple glob patterns. Changes to guest
4209 properties whose name matches one of the patterns will generate an
4210 <link to="IVirtualBoxCallback::onGuestPropertyChange"/> signal.
4211 </desc>
4212 </attribute>
4213
4214 <method name="setBootOrder">
4215 <desc>
4216 Puts the given device to the specified position in
4217 the boot order.
4218
4219 To indicate that no device is associated with the given position,
4220 <link to="DeviceType_Null"/> should be used.
4221
4222 @todo setHardDiskBootOrder(), setNetworkBootOrder()
4223
4224 <result name="E_INVALIDARG">
4225 Boot @a position out of range.
4226 </result>
4227 <result name="E_NOTIMPL">
4228 Booting from USB @a device currently not supported.
4229 </result>
4230
4231 </desc>
4232 <param name="position" type="unsigned long" dir="in">
4233 <desc>
4234 Position in the boot order (<tt>1</tt> to the total number of
4235 devices the machine can boot from, as returned by
4236 <link to="ISystemProperties::maxBootPosition"/>).
4237 </desc>
4238 </param>
4239 <param name="device" type="DeviceType" dir="in">
4240 <desc>
4241 The type of the device used to boot at the given position.
4242 </desc>
4243 </param>
4244 </method>
4245
4246 <method name="getBootOrder" const="yes">
4247 <desc>
4248 Returns the device type that occupies the specified
4249 position in the boot order.
4250
4251 @todo [remove?]
4252 If the machine can have more than one device of the returned type
4253 (such as hard disks), then a separate method should be used to
4254 retrieve the individual device that occupies the given position.
4255
4256 If here are no devices at the given position, then
4257 <link to="DeviceType_Null"/> is returned.
4258
4259 @todo getHardDiskBootOrder(), getNetworkBootOrder()
4260
4261 <result name="E_INVALIDARG">
4262 Boot @a position out of range.
4263 </result>
4264
4265 </desc>
4266 <param name="position" type="unsigned long" dir="in">
4267 <desc>
4268 Position in the boot order (<tt>1</tt> to the total number of
4269 devices the machine can boot from, as returned by
4270 <link to="ISystemProperties::maxBootPosition"/>).
4271 </desc>
4272 </param>
4273 <param name="device" type="DeviceType" dir="return">
4274 <desc>
4275 Device at the given position.
4276 </desc>
4277 </param>
4278 </method>
4279
4280 <method name="attachHardDisk">
4281 <desc>
4282 Attaches a virtual hard disk identified by the given UUID @a id
4283 to a device slot of the specified bus.
4284
4285 For the IDE bus, the @a channel parameter can be either @c 0 or @c 1, to
4286 specify the primary or secondary IDE controller, respectively. The
4287 SATA bus supports 30 channels, so this parameter can be a number
4288 ranging from @c 0 to @c 29.
4289
4290 For the primary controller of the IDE bus, the @a device number can be
4291 either @c 0 or @c 1, to specify the master or the slave device,
4292 respectively. For the secondary IDE controller, the device number is
4293 always @c 1 because the master device is reserved for the CD-ROM drive.
4294
4295 For the SATA bus, the @a device parameter is currently unused and
4296 must be @c 0.
4297
4298 The specified device slot must not have another disk attached to it, or
4299 this method will fail.
4300
4301 See <link to="IHardDisk"/> for more detailed information about
4302 attaching hard disks.
4303
4304 <note>
4305 You cannot attach a hard disk to a running machine. Also, you cannot
4306 attach a hard disk to a newly created machine until this machine's
4307 settings are saved to disk using <link to="#saveSettings"/>.
4308 </note>
4309 <note>
4310 If the hard disk is being attached indirectly, a new differencing hard
4311 disk will implicitly be created for it and attached instead. If the
4312 changes made to the machine settings (including this indirect
4313 attachment) are later cancelled using <link to="#discardSettings"/>,
4314 this implicitly created differencing hard disk will implicitly
4315 be deleted.
4316 </note>
4317
4318 <result name="E_INVALIDARG">
4319 SATA device, SATA channel, IDE channel or IDE slot out of range.
4320 </result>
4321 <result name="VBOX_E_INVALID_OBJECT_STATE">
4322 Attempt to attach hard disk to an unregistered virtual machine.
4323 </result>
4324 <result name="VBOX_E_INVALID_VM_STATE">
4325 Invalid machine state.
4326 </result>
4327 <result name="VBOX_E_OBJECT_IN_USE">
4328 Hard disk already attached to this or another virtual machine.
4329 </result>
4330
4331 </desc>
4332 <param name="id" type="uuid" dir="in">
4333 <desc>UUID of the hard disk to attach.</desc>
4334 </param>
4335 <param name="bus" type="StorageBus" dir="in">
4336 <desc>Type of the storage bus to use (IDE or SATA).</desc>
4337 </param>
4338 <param name="channel" type="long" dir="in">
4339 <desc>Channel to attach the hard disk to.</desc>
4340 </param>
4341 <param name="device" type="long" dir="in">
4342 <desc>
4343 Device slot in the given channel to attach the hard disk to.
4344 </desc>
4345 </param>
4346 </method>
4347
4348 <method name="getHardDisk" const="yes">
4349 <desc>
4350 Returns the virtual hard disk attached to a device slot of the specified
4351 bus.
4352
4353 Note that if the hard disk was indirectly attached by
4354 <link to="#attachHardDisk"/> to the given device slot then this
4355 method will return not the same object as passed to the
4356 <link to="#attachHardDisk"/> call. See <link to="IHardDisk"/> for
4357 more detailed information about attaching hard disks.
4358
4359 <result name="VBOX_E_OBJECT_NOT_FOUND">
4360 No hard disk attached to given slot/bus.
4361 </result>
4362
4363 </desc>
4364 <param name="bus" type="StorageBus" dir="in">
4365 <desc>Type of the storage bus to query (IDE or SATA).</desc>
4366 </param>
4367 <param name="channel" type="long" dir="in">
4368 <desc>Channel to query.</desc>
4369 </param>
4370 <param name="device" type="long" dir="in">
4371 <desc>Device slot in the given channel to query.</desc>
4372 </param>
4373 <param name="hardDisk" type="IHardDisk" dir="return">
4374 <desc>Attached hard disk object.</desc>
4375 </param>
4376 </method>
4377
4378 <method name="detachHardDisk">
4379 <desc>
4380 Detaches the virtual hard disk attached to a device slot of the
4381 specified bus.
4382
4383 Detaching the hard disk from the virtual machine is deferred. This means
4384 that the hard disk remains associated with the machine when this method
4385 returns and gets actually de-associated only after a successful
4386 <link to="#saveSettings"/> call. See <link to="IHardDisk"/>
4387 for more detailed information about attaching hard disks.
4388
4389 <note>
4390 You cannot detach the hard disk from a running machine.
4391 </note>
4392 <note>
4393 Detaching differencing hard disks implicitly created by <link
4394 to="#attachHardDisk"/> for the indirect attachment using this
4395 method will <b>not</b> implicitly delete them. The
4396 <link to="IHardDisk::deleteStorage"/> operation should be
4397 explicitly performed by the caller after the hard disk is successfully
4398 detached and the settings are saved with
4399 <link to="#saveSettings"/>, if it is the desired action.
4400 </note>
4401
4402 <result name="VBOX_E_INVALID_VM_STATE">
4403 Attempt to detach hard disk from a running virtual machine.
4404 </result>
4405 <result name="VBOX_E_OBJECT_NOT_FOUND">
4406 No hard disk attached to given slot/bus.
4407 </result>
4408 <result name="VBOX_E_NOT_SUPPORTED">
4409 Hard disk format does not support storage deletion.
4410 </result>
4411
4412 </desc>
4413 <param name="bus" type="StorageBus" dir="in">
4414 <desc>Bus to detach the hard disk from.</desc>
4415 </param>
4416 <param name="channel" type="long" dir="in">
4417 <desc>Channel number to detach the hard disk from.</desc>
4418 </param>
4419 <param name="device" type="long" dir="in">
4420 <desc>Device slot number to detach the hard disk from.</desc>
4421 </param>
4422 </method>
4423
4424 <method name="getNetworkAdapter" const="yes">
4425 <desc>
4426 Returns the network adapter associated with the given slot.
4427 Slots are numbered sequentially, starting with zero. The total
4428 number of adapters per machine is defined by the
4429 <link to="ISystemProperties::networkAdapterCount"/> property,
4430 so the maximum slot number is one less than that property's value.
4431
4432 <result name="E_INVALIDARG">
4433 Invalid @a slot number.
4434 </result>
4435
4436 </desc>
4437 <param name="slot" type="unsigned long" dir="in"/>
4438 <param name="adapter" type="INetworkAdapter" dir="return"/>
4439 </method>
4440
4441 <method name="getSerialPort" const="yes">
4442 <desc>
4443 Returns the serial port associated with the given slot.
4444 Slots are numbered sequentially, starting with zero. The total
4445 number of serial ports per machine is defined by the
4446 <link to="ISystemProperties::serialPortCount"/> property,
4447 so the maximum slot number is one less than that property's value.
4448
4449 <result name="E_INVALIDARG">
4450 Invalid @a slot number.
4451 </result>
4452
4453 </desc>
4454 <param name="slot" type="unsigned long" dir="in"/>
4455 <param name="port" type="ISerialPort" dir="return"/>
4456 </method>
4457
4458 <method name="getParallelPort" const="yes">
4459 <desc>
4460 Returns the parallel port associated with the given slot.
4461 Slots are numbered sequentially, starting with zero. The total
4462 number of parallel ports per machine is defined by the
4463 <link to="ISystemProperties::parallelPortCount"/> property,
4464 so the maximum slot number is one less than that property's value.
4465
4466 <result name="E_INVALIDARG">
4467 Invalid @a slot number.
4468 </result>
4469
4470 </desc>
4471 <param name="slot" type="unsigned long" dir="in"/>
4472 <param name="port" type="IParallelPort" dir="return"/>
4473 </method>
4474
4475 <method name="getNextExtraDataKey">
4476 <desc>
4477 Returns the machine-specific extra data key name following the
4478 supplied key.
4479
4480 An error is returned if the supplied @a key does not exist. @c NULL is
4481 returned in @a nextKey if the supplied key is the last key. When
4482 supplying @c NULL for the @a key, the first key item is returned in
4483 @a nextKey (if there is any). @a nextValue is an optional parameter and
4484 if supplied, the next key's value is returned in it.
4485
4486 <result name="VBOX_E_OBJECT_NOT_FOUND">
4487 Extra data @a key not found.
4488 </result>
4489
4490 </desc>
4491 <param name="key" type="wstring" dir="in">
4492 <desc>Name of the data key to follow.</desc>
4493 </param>
4494 <param name="nextKey" type="wstring" dir="out">
4495 <desc>Name of the next data key.</desc>
4496 </param>
4497 <param name="nextValue" type="wstring" dir="out">
4498 <desc>Value of the next data key.</desc>
4499 </param>
4500 </method>
4501
4502 <method name="getExtraData">
4503 <desc>
4504 Returns associated machine-specific extra data.
4505
4506 If the requested data @a key does not exist, this function will
4507 succeed and return @c NULL in the @a value argument.
4508
4509 <result name="VBOX_E_FILE_ERROR">
4510 Settings file not accessible.
4511 </result>
4512 <result name="VBOX_E_XML_ERROR">
4513 Could not parse the settings file.
4514 </result>
4515
4516 </desc>
4517 <param name="key" type="wstring" dir="in">
4518 <desc>Name of the data key to get.</desc>
4519 </param>
4520 <param name="value" type="wstring" dir="return">
4521 <desc>Value of the requested data key.</desc>
4522 </param>
4523 </method>
4524
4525 <method name="setExtraData">
4526 <desc>
4527 Sets associated machine-specific extra data.
4528
4529 If you pass @c NULL as a key @a value, the given @a key will be
4530 deleted.
4531
4532 <note>
4533 Before performing the actual data change, this method will ask all
4534 registered callbacks using the
4535 <link to="IVirtualBoxCallback::onExtraDataCanChange"/>
4536 notification for a permission. If one of the callbacks refuses the
4537 new value, the change will not be performed.
4538 </note>
4539 <note>
4540 On success, the
4541 <link to="IVirtualBoxCallback::onExtraDataChange"/> notification
4542 is called to inform all registered callbacks about a successful data
4543 change.
4544 </note>
4545 <note>
4546 This method can be called outside the machine session and therefore
4547 it's a caller's responsibility to handle possible race conditions
4548 when several clients change the same key at the same time.
4549 </note>
4550
4551 <result name="VBOX_E_FILE_ERROR">
4552 Settings file not accessible.
4553 </result>
4554 <result name="VBOX_E_XML_ERROR">
4555 Could not parse the settings file.
4556 </result>
4557
4558 </desc>
4559 <param name="key" type="wstring" dir="in">
4560 <desc>Name of the data key to set.</desc>
4561 </param>
4562 <param name="value" type="wstring" dir="in">
4563 <desc>Value to assign to the key.</desc>
4564 </param>
4565 </method>
4566
4567 <method name="saveSettings">
4568 <desc>
4569 Saves any changes to machine settings made since the session
4570 has been opened or a new machine has been created, or since the
4571 last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
4572 For registered machines, new settings become visible to all
4573 other VirtualBox clients after successful invocation of this
4574 method.
4575 <note>
4576 The method sends <link to="IVirtualBoxCallback::onMachineDataChange"/>
4577 notification event after the configuration has been successfully
4578 saved (only for registered machines).
4579 </note>
4580 <note>
4581 Calling this method is only valid on instances returned
4582 by <link to="ISession::machine"/> and on new machines
4583 created by <link to="IVirtualBox::createMachine"/> but not
4584 yet registered, or on unregistered machines after calling
4585 <link to="IVirtualBox::unregisterMachine"/>.
4586 </note>
4587
4588 <result name="VBOX_E_FILE_ERROR">
4589 Settings file not accessible.
4590 </result>
4591 <result name="VBOX_E_XML_ERROR">
4592 Could not parse the settings file.
4593 </result>
4594 <result name="E_ACCESSDENIED">
4595 Modification request refused.
4596 </result>
4597
4598 </desc>
4599 </method>
4600
4601 <method name="saveSettingsWithBackup">
4602 <desc>
4603 Creates a backup copy of the machine settings file (<link
4604 to="#settingsFilePath"/>) in case of auto-conversion, and then calls
4605 <link to="#saveSettings"/>.
4606
4607 Note that the backup copy is created <b>only</b> if the settings file
4608 auto-conversion took place (see <link to="#settingsFileVersion"/> for
4609 details). Otherwise, this call is fully equivalent to
4610 <link to="#saveSettings"/> and no backup copying is done.
4611
4612 The backup copy is created in the same directory where the original
4613 settings file is located. It is given the following file name:
4614 <pre>
4615 original.xml.x.y-platform.bak
4616 </pre>
4617 where <tt>original.xml</tt> is the original settings file name
4618 (excluding path), and <tt>x.y-platform</tt> is the version of the old
4619 format of the settings file (before auto-conversion).
4620
4621 If the given backup file already exists, this method will try to add the
4622 <tt>.N</tt> suffix to the backup file name (where <tt>N</tt> counts from
4623 0 to 9) and copy it again until it succeeds. If all suffixes are
4624 occupied, or if any other copy error occurs, this method will return a
4625 failure.
4626
4627 If the copy operation succeeds, the @a bakFileName return argument will
4628 receive a full path to the created backup file (for informational
4629 purposes). Note that this will happen even if the subsequent
4630 <link to="#saveSettings"/> call performed by this method after the
4631 copy operation, fails.
4632
4633 <note>
4634 The VirtualBox API never calls this method. It is intended purely for
4635 the purposes of creating backup copies of the settings files by
4636 front-ends before saving the results of the automatically performed
4637 settings conversion to disk.
4638 </note>
4639
4640 <see>settingsFileVersion</see>
4641
4642 <result name="VBOX_E_FILE_ERROR">
4643 Settings file not accessible.
4644 </result>
4645 <result name="VBOX_E_XML_ERROR">
4646 Could not parse the settings file.
4647 </result>
4648 <result name="VBOX_E_INVALID_VM_STATE">
4649 Virtual machine is not mutable.
4650 </result>
4651 <result name="E_ACCESSDENIED">
4652 Modification request refused.
4653 </result>
4654
4655 </desc>
4656 <param name="bakFileName" type="wstring" dir="return">
4657 <desc>Full path to the created backup copy.</desc>
4658 </param>
4659 </method>
4660
4661 <method name="discardSettings">
4662 <desc>
4663 Discards any changes to the machine settings made since the session
4664 has been opened or since the last call to <link to="#saveSettings"/>
4665 or <link to="#discardSettings"/>.
4666 <note>
4667 Calling this method is only valid on instances returned
4668 by <link to="ISession::machine"/> and on new machines
4669 created by <link to="IVirtualBox::createMachine"/> or
4670 opened by <link to="IVirtualBox::openMachine"/> but not
4671 yet registered, or on unregistered machines after calling
4672 <link to="IVirtualBox::unregisterMachine"/>.
4673 </note>
4674
4675 <result name="VBOX_E_INVALID_VM_STATE">
4676 Virtual machine is not mutable.
4677 </result>
4678
4679 </desc>
4680 </method>
4681
4682 <method name="deleteSettings">
4683 <desc>
4684 Deletes the settings file of this machine from disk.
4685 The machine must not be registered in order for this operation
4686 to succeed.
4687 <note>
4688 <link to="#settingsModified"/> will return TRUE after this
4689 method successfully returns.
4690 </note>
4691 <note>
4692 Calling this method is only valid on instances returned
4693 by <link to="ISession::machine"/> and on new machines
4694 created by <link to="IVirtualBox::createMachine"/> or
4695 opened by <link to="IVirtualBox::openMachine"/> but not
4696 yet registered, or on unregistered machines after calling
4697 <link to="IVirtualBox::unregisterMachine"/>.
4698 </note>
4699 <note>
4700 The deleted machine settings file can be restored (saved again)
4701 by calling <link to="#saveSettings"/>.
4702 </note>
4703
4704 <result name="VBOX_E_INVALID_VM_STATE">
4705 Cannot delete settings of a registered machine or
4706 machine not mutable.
4707 </result>
4708 <result name="VBOX_E_IPRT_ERROR">
4709 Could not delete the settings file.
4710 </result>
4711
4712 </desc>
4713 </method>
4714
4715 <method name="export">
4716 <desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
4717 steps required to export VirtualBox machines to OVF.
4718 </desc>
4719
4720 <param name="appliance" type="IAppliance" dir="in">
4721 <desc>Appliance to export this machine to.</desc>
4722 </param>
4723 </method >
4724
4725 <method name="getSnapshot">
4726 <desc>
4727 Returns a snapshot of this machine with the given UUID.
4728 A <tt>null</tt> UUID can be used to obtain the first snapshot
4729 taken on this machine. This is useful if you want to traverse
4730 the whole tree of snapshots starting from the root.
4731
4732 <result name="VBOX_E_OBJECT_NOT_FOUND">
4733 Virtual machine has no snapshots or snapshot not found.
4734 </result>
4735
4736 </desc>
4737 <param name="id" type="uuid" dir="in">
4738 <desc>UUID of the snapshot to get</desc>
4739 </param>
4740 <param name="snapshot" type="ISnapshot" dir="return">
4741 <desc>Snapshot object with the given UUID.</desc>
4742 </param>
4743 </method>
4744
4745 <method name="findSnapshot">
4746 <desc>
4747 Returns a snapshot of this machine with the given name.
4748
4749 <result name="VBOX_E_OBJECT_NOT_FOUND">
4750 Virtual machine has no snapshots or snapshot not found.
4751 </result>
4752
4753 </desc>
4754 <param name="name" type="wstring" dir="in">
4755 <desc>Name of the snapshot to find</desc>
4756 </param>
4757 <param name="snapshot" type="ISnapshot" dir="return">
4758 <desc>Snapshot object with the given name.</desc>
4759 </param>
4760 </method>
4761
4762 <method name="setCurrentSnapshot">
4763 <desc>
4764 Sets the current snapshot of this machine.
4765 <note>
4766 In the current implementation, this operation is not
4767 implemented.
4768 </note>
4769 </desc>
4770 <param name="id" type="uuid" dir="in">
4771 <desc>UUID of the snapshot to set as the current snapshot.</desc>
4772 </param>
4773 </method>
4774
4775 <method name="createSharedFolder">
4776 <desc>
4777 Creates a new permanent shared folder by associating the given logical
4778 name with the given host path, adds it to the collection of shared
4779 folders and starts sharing it. Refer to the description of
4780 <link to="ISharedFolder"/> to read more about logical names.
4781
4782 <result name="VBOX_E_OBJECT_IN_USE">
4783 Shared folder already exists.
4784 </result>
4785 <result name="VBOX_E_FILE_ERROR">
4786 Shared folder @a hostPath not accessible.
4787 </result>
4788
4789 </desc>
4790 <param name="name" type="wstring" dir="in">
4791 <desc>Unique logical name of the shared folder.</desc>
4792 </param>
4793 <param name="hostPath" type="wstring" dir="in">
4794 <desc>Full path to the shared folder in the host file system.</desc>
4795 </param>
4796 <param name="writable" type="boolean" dir="in">
4797 <desc>Whether the share is writable or readonly</desc>
4798 </param>
4799 </method>
4800
4801 <method name="removeSharedFolder">
4802 <desc>
4803 Removes the permanent shared folder with the given name previously
4804 created by <link to="#createSharedFolder"/> from the collection of
4805 shared folders and stops sharing it.
4806
4807 <result name="VBOX_E_INVALID_VM_STATE">
4808 Virtual machine is not mutable.
4809 </result>
4810 <result name="VBOX_E_OBJECT_NOT_FOUND">
4811 Shared folder @a name does not exist.
4812 </result>
4813
4814 </desc>
4815 <param name="name" type="wstring" dir="in">
4816 <desc>Logical name of the shared folder to remove.</desc>
4817 </param>
4818 </method>
4819
4820 <method name="canShowConsoleWindow">
4821 <desc>
4822 Returns @c true if the VM console process can activate the
4823 console window and bring it to foreground on the desktop of
4824 the host PC.
4825 <note>
4826 This method will fail if a session for this machine is not
4827 currently open.
4828 </note>
4829
4830 <result name="VBOX_E_INVALID_VM_STATE">
4831 Machine session is not open.
4832 </result>
4833
4834 </desc>
4835 <param name="canShow" type="boolean" dir="return">
4836 <desc>
4837 @c true if the console window can be shown and @c
4838 false otherwise.
4839 </desc>
4840 </param>
4841 </method>
4842
4843 <method name="showConsoleWindow">
4844 <desc>
4845 Activates the console window and brings it to foreground on
4846 the desktop of the host PC. Many modern window managers on
4847 many platforms implement some sort of focus stealing
4848 prevention logic, so that it may be impossible to activate
4849 a window without the help of the currently active
4850 application. In this case, this method will return a non-zero
4851 identifier that represents the top-level window of the VM
4852 console process. The caller, if it represents a currently
4853 active process, is responsible to use this identifier (in a
4854 platform-dependent manner) to perform actual window
4855 activation.
4856 <note>
4857 This method will fail if a session for this machine is not
4858 currently open.
4859 </note>
4860
4861 <result name="VBOX_E_INVALID_VM_STATE">
4862 Machine session is not open.
4863 </result>
4864
4865 </desc>
4866 <param name="winId" type="unsigned long long" dir="return">
4867 <desc>
4868 Platform-dependent identifier of the top-level VM console
4869 window, or zero if this method has performed all actions
4870 necessary to implement the <i>show window</i> semantics for
4871 the given platform and/or VirtualBox front-end.
4872 </desc>
4873 </param>
4874 </method>
4875
4876 <method name="getGuestProperty">
4877 <desc>
4878 Reads an entry from the machine's guest property store.
4879
4880 <result name="VBOX_E_INVALID_VM_STATE">
4881 Machine session is not open.
4882 </result>
4883
4884 </desc>
4885 <param name="name" type="wstring" dir="in">
4886 <desc>
4887 The name of the property to read.
4888 </desc>
4889 </param>
4890 <param name="value" type="wstring" dir="out">
4891 <desc>
4892 The value of the property. If the property does not exist then this
4893 will be empty.
4894 </desc>
4895 </param>
4896 <param name="timestamp" type="unsigned long long" dir="out">
4897 <desc>
4898 The time at which the property was last modified, as seen by the
4899 server process.
4900 </desc>
4901 </param>
4902 <param name="flags" type="wstring" dir="out">
4903 <desc>
4904 Additional property parameters, passed as a comma-separated list of
4905 "name=value" type entries.
4906 </desc>
4907 </param>
4908 </method>
4909
4910 <method name="getGuestPropertyValue">
4911 <desc>
4912 Reads a value from the machine's guest property store.
4913
4914 <result name="VBOX_E_INVALID_VM_STATE">
4915 Machine session is not open.
4916 </result>
4917
4918 </desc>
4919 <param name="property" type="wstring" dir="in">
4920 <desc>
4921 The name of the property to read.
4922 </desc>
4923 </param>
4924 <param name="value" type="wstring" dir="return">
4925 <desc>
4926 The value of the property. If the property does not exist then this
4927 will be empty.
4928 </desc>
4929 </param>
4930 </method>
4931
4932 <method name="getGuestPropertyTimestamp">
4933 <desc>
4934 Reads a property timestamp from the machine's guest property store.
4935
4936 <result name="VBOX_E_INVALID_VM_STATE">
4937 Machine session is not open.
4938 </result>
4939
4940 </desc>
4941 <param name="property" type="wstring" dir="in">
4942 <desc>
4943 The name of the property to read.
4944 </desc>
4945 </param>
4946 <param name="value" type="unsigned long long" dir="return">
4947 <desc>
4948 The timestamp. If the property does not exist then this will be
4949 empty.
4950 </desc>
4951 </param>
4952 </method>
4953
4954 <method name="setGuestProperty">
4955 <desc>
4956 Sets, changes or deletes an entry in the machine's guest property
4957 store.
4958
4959 <result name="E_ACCESSDENIED">
4960 Property cannot be changed.
4961 </result>
4962 <result name="E_INVALIDARG">
4963 Invalid @a flags.
4964 </result>
4965 <result name="VBOX_E_INVALID_VM_STATE">
4966 Virtual machine is not mutable or session not open.
4967 </result>
4968 <result name="VBOX_E_INVALID_OBJECT_STATE">
4969 Cannot set transient property when machine not running.
4970 </result>
4971
4972 </desc>
4973 <param name="property" type="wstring" dir="in">
4974 <desc>
4975 The name of the property to set, change or delete.
4976 </desc>
4977 </param>
4978 <param name="value" type="wstring" dir="in">
4979 <desc>
4980 The new value of the property to set, change or delete. If the
4981 property does not yet exist and value is non-empty, it will be
4982 created. If the value is empty, the key will be deleted if it
4983 exists.
4984 </desc>
4985 </param>
4986 <param name="flags" type="wstring" dir="in">
4987 <desc>
4988 Additional property parameters, passed as a comma-separated list of
4989 "name=value" type entries.
4990 </desc>
4991 </param>
4992 </method>
4993
4994 <method name="setGuestPropertyValue">
4995 <desc>
4996 Sets, changes or deletes a value in the machine's guest property
4997 store. The flags field will be left unchanged or created empty for a
4998 new property.
4999
5000 <result name="E_ACCESSDENIED">
5001 Property cannot be changed.
5002 </result>
5003 <result name="VBOX_E_INVALID_VM_STATE">
5004 Virtual machine is not mutable or session not open.
5005 </result>
5006 <result name="VBOX_E_INVALID_OBJECT_STATE">
5007 Cannot set transient property when machine not running.
5008 </result>
5009 </desc>
5010
5011 <param name="property" type="wstring" dir="in">
5012 <desc>
5013 The name of the property to set, change or delete.
5014 </desc>
5015 </param>
5016 <param name="value" type="wstring" dir="in">
5017 <desc>
5018 The new value of the property to set, change or delete. If the
5019 property does not yet exist and value is non-empty, it will be
5020 created. If value is empty, the property will be deleted if it
5021 exists.
5022 </desc>
5023 </param>
5024 </method>
5025
5026 <method name="enumerateGuestProperties">
5027 <desc>
5028 Return a list of the guest properties matching a set of patterns along
5029 with their values, time stamps and flags.
5030 </desc>
5031 <param name="patterns" type="wstring" dir="in">
5032 <desc>
5033 The patterns to match the properties against, separated by '|'
5034 characters. If this is empty or NULL, all properties will match.
5035 </desc>
5036 </param>
5037 <param name="name" type="wstring" dir="out" safearray="yes">
5038 <desc>
5039 The names of the properties returned.
5040 </desc>
5041 </param>
5042 <param name="value" type="wstring" dir="out" safearray="yes">
5043 <desc>
5044 The values of the properties returned. The array entries match the
5045 corresponding entries in the @a name array.
5046 </desc>
5047 </param>
5048 <param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
5049 <desc>
5050 The time stamps of the properties returned. The array entries match
5051 the corresponding entries in the @a name array.
5052 </desc>
5053 </param>
5054 <param name="flags" type="wstring" dir="out" safearray="yes">
5055 <desc>
5056 The flags of the properties returned. The array entries match the
5057 corresponding entries in the @a name array.
5058 </desc>
5059 </param>
5060 </method>
5061</interface>
5062
5063 <!--
5064 // IConsole
5065 /////////////////////////////////////////////////////////////////////////
5066 -->
5067
5068 <interface
5069 name="IConsoleCallback" extends="$unknown"
5070 uuid="13dfbef3-b74d-487d-bada-2304529aefa6"
5071 wsmap="suppress"
5072 >
5073
5074 <method name="onMousePointerShapeChange">
5075 <desc>
5076 Notification when the guest mouse pointer shape has
5077 changed. The new shape data is given.
5078 </desc>
5079 <param name="visible" type="boolean" dir="in">
5080 <desc>
5081 Flag whether the pointer is visible.
5082 </desc>
5083 </param>
5084 <param name="alpha" type="boolean" dir="in">
5085 <desc>
5086 Flag whether the pointer has an alpha channel.
5087 </desc>
5088 </param>
5089 <param name="xHot" type="unsigned long" dir="in">
5090 <desc>
5091 The pointer hot spot x coordinate.
5092 </desc>
5093 </param>
5094 <param name="yHot" type="unsigned long" dir="in">
5095 <desc>
5096 The pointer hot spot y coordinate.
5097 </desc>
5098 </param>
5099 <param name="width" type="unsigned long" dir="in">
5100 <desc>
5101 Width of the pointer shape in pixels.
5102 </desc>
5103 </param>
5104 <param name="height" type="unsigned long" dir="in">
5105 <desc>
5106 Height of the pointer shape in pixels.
5107 </desc>
5108 </param>
5109 <param name="shape" type="octet" mod="ptr" dir="in">
5110 <desc>
5111 Address of the shape buffer.
5112
5113 The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
5114 followed by a 32-bpp XOR (color) mask.
5115
5116 For pointers without alpha channel the XOR mask pixels are 32
5117 bit values: (lsb)BGR0(msb). For pointers with alpha channel
5118 the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
5119
5120 An AND mask is used for pointers with alpha channel, so if the
5121 callback does not support alpha, the pointer could be
5122 displayed as a normal color pointer.
5123
5124 The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
5125 size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
5126 height</tt>. The padding bits at the end of each scanline are
5127 undefined.
5128
5129 The XOR mask follows the AND mask on the next 4-byte aligned
5130 offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) &amp; ~3</tt>.
5131 Bytes in the gap between the AND and the XOR mask are undefined.
5132 The XOR mask scanlines have no gap between them and the size of
5133 the XOR mask is: <tt>cXor = width * 4 * height</tt>.
5134
5135 <note>
5136 If @a shape is 0, only the pointer visibility is changed.
5137 </note>
5138 </desc>
5139 </param>
5140 </method>
5141
5142 <method name="onMouseCapabilityChange">
5143 <desc>
5144 Notification when the mouse capabilities reported by the
5145 guest have changed. The new capabilities are passed.
5146 </desc>
5147 <param name="supportsAbsolute" type="boolean" dir="in"/>
5148 <param name="needsHostCursor" type="boolean" dir="in"/>
5149 </method>
5150
5151 <method name="onKeyboardLedsChange">
5152 <desc>
5153 Notification when the guest OS executes the KBD_CMD_SET_LEDS command
5154 to alter the state of the keyboard LEDs.
5155 </desc>
5156 <param name="numLock" type="boolean" dir="in"/>
5157 <param name="capsLock" type="boolean" dir="in"/>
5158 <param name="scrollLock" type="boolean" dir="in"/>
5159 </method>
5160
5161 <method name="onStateChange">
5162 <desc>
5163 Notification when the execution state of the machine has changed.
5164 The new state will be given.
5165 </desc>
5166 <param name="state" type="MachineState" dir="in"/>
5167 </method>
5168
5169 <method name="onAdditionsStateChange">
5170 <desc>
5171 Notification when a Guest Additions property changes.
5172 Interested callees should query IGuest attributes to
5173 find out what has changed.
5174 </desc>
5175 </method>
5176
5177 <method name="onDVDDriveChange">
5178 <desc>
5179 Notification when a property of the
5180 virtual <link to="IMachine::DVDDrive">DVD drive</link> changes.
5181 Interested callees should use IDVDDrive methods to find out what has
5182 changed.
5183 </desc>
5184 </method>
5185
5186 <method name="onFloppyDriveChange">
5187 <desc>
5188 Notification when a property of the
5189 virtual <link to="IMachine::floppyDrive">floppy drive</link> changes.
5190 Interested callees should use IFloppyDrive methods to find out what
5191 has changed.
5192 </desc>
5193 </method>
5194
5195 <method name="onNetworkAdapterChange">
5196 <desc>
5197 Notification when a property of one of the
5198 virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
5199 changes. Interested callees should use INetworkAdapter methods and
5200 attributes to find out what has changed.
5201 </desc>
5202 <param name="networkAdapter" type="INetworkAdapter" dir="in">
5203 <desc>Network adapter that is subject to change.</desc>
5204 </param>
5205 </method>
5206
5207 <method name="onSerialPortChange">
5208 <desc>
5209 Notification when a property of one of the
5210 virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
5211 Interested callees should use ISerialPort methods and attributes
5212 to find out what has changed.
5213 </desc>
5214 <param name="serialPort" type="ISerialPort" dir="in">
5215 <desc>Serial port that is subject to change.</desc>
5216 </param>
5217 </method>
5218
5219 <method name="onParallelPortChange">
5220 <desc>
5221 Notification when a property of one of the
5222 virtual <link to="IMachine::getParallelPort">parallel ports</link>
5223 changes. Interested callees should use ISerialPort methods and
5224 attributes to find out what has changed.
5225 </desc>
5226 <param name="parallelPort" type="IParallelPort" dir="in">
5227 <desc>Parallel port that is subject to change.</desc>
5228 </param>
5229 </method>
5230
5231 <method name="onVRDPServerChange">
5232 <desc>
5233 Notification when a property of the
5234 <link to="IMachine::VRDPServer">VRDP server</link> changes.
5235 Interested callees should use IVRDPServer methods and attributes to
5236 find out what has changed.
5237 </desc>
5238 </method>
5239
5240 <method name="onUSBControllerChange">
5241 <desc>
5242 Notification when a property of the virtual
5243 <link to="IMachine::USBController">USB controller</link> changes.
5244 Interested callees should use IUSBController methods and attributes to
5245 find out what has changed.
5246 </desc>
5247 </method>
5248
5249 <method name="onUSBDeviceStateChange">
5250 <desc>
5251 Notification when a USB device is attached to or detached from
5252 the virtual USB controller.
5253
5254 This notification is sent as a result of the indirect
5255 request to attach the device because it matches one of the
5256 machine USB filters, or as a result of the direct request
5257 issued by <link to="IConsole::attachUSBDevice"/> or
5258 <link to="IConsole::detachUSBDevice"/>.
5259
5260 This notification is sent in case of both a succeeded and a
5261 failed request completion. When the request succeeds, the
5262 @a error parameter is @c null, and the given device has been
5263 already added to (when @a attached is @c true) or removed from
5264 (when @a attached is @c false) the collection represented by
5265 <link to="IConsole::USBDevices"/>. On failure, the collection
5266 doesn't change and the @a error parameter represents the error
5267 message describing the failure.
5268
5269 </desc>
5270 <param name="device" type="IUSBDevice" dir="in">
5271 <desc>Device that is subject to state change.</desc>
5272 </param>
5273 <param name="attached" type="boolean" dir="in">
5274 <desc>
5275 <tt>true</tt> if the device was attached
5276 and <tt>false</tt> otherwise.
5277 </desc>
5278 </param>
5279 <param name="error" type="IVirtualBoxErrorInfo" dir="in">
5280 <desc>
5281 <tt>null</tt> on success or an error message object on
5282 failure.
5283 </desc>
5284 </param>
5285 </method>
5286
5287 <method name="onSharedFolderChange">
5288 <desc>
5289 Notification when a shared folder is added or removed.
5290 The @a scope argument defines one of three scopes:
5291 <link to="IVirtualBox::sharedFolders">global shared folders</link>
5292 (<link to="Scope_Global">Global</link>),
5293 <link to="IMachine::sharedFolders">permanent shared folders</link> of
5294 the machine (<link to="Scope_Machine">Machine</link>) or <link
5295 to="IConsole::sharedFolders">transient shared folders</link> of the
5296 machine (<link to="Scope_Session">Session</link>). Interested callees
5297 should use query the corresponding collections to find out what has
5298 changed.
5299 </desc>
5300 <param name="scope" type="Scope" dir="in">
5301 <desc>Scope of the notification.</desc>
5302 </param>
5303 </method>
5304
5305 <method name="onRuntimeError">
5306 <desc>
5307 Notification when an error happens during the virtual
5308 machine execution.
5309
5310 There are three kinds of runtime errors:
5311 <ul>
5312 <li><i>fatal</i></li>
5313 <li><i>non-fatal with retry</i></li>
5314 <li><i>non-fatal warnings</i></li>
5315 </ul>
5316
5317 <b>Fatal</b> errors are indicated by the @a fatal parameter set
5318 to <tt>true</tt>. In case of fatal errors, the virtual machine
5319 execution is always paused before calling this notification, and
5320 the notification handler is supposed either to immediately save
5321 the virtual machine state using <link to="IConsole::saveState"/>
5322 or power it off using <link to="IConsole::powerDown"/>.
5323 Resuming the execution can lead to unpredictable results.
5324
5325 <b>Non-fatal</b> errors and warnings are indicated by the
5326 @a fatal parameter set to <tt>false</tt>. If the virtual machine
5327 is in the Paused state by the time the error notification is
5328 received, it means that the user can <i>try to resume</i> the machine
5329 execution after attempting to solve the problem that caused the
5330 error. In this case, the notification handler is supposed
5331 to show an appropriate message to the user (depending on the
5332 value of the @a id parameter) that offers several actions such
5333 as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
5334 wants to retry, the notification handler should continue
5335 the machine execution using the <link to="IConsole::resume"/>
5336 call. If the machine execution is not Paused during this
5337 notification, then it means this notification is a <i>warning</i>
5338 (for example, about a fatal condition that can happen very soon);
5339 no immediate action is required from the user, the machine
5340 continues its normal execution.
5341
5342 Note that in either case the notification handler
5343 <b>must not</b> perform any action directly on a thread
5344 where this notification is called. Everything it is allowed to
5345 do is to post a message to another thread that will then talk
5346 to the user and take the corresponding action.
5347
5348 Currently, the following error identifiers are known:
5349 <ul>
5350 <li><tt>"HostMemoryLow"</tt></li>
5351 <li><tt>"HostAudioNotResponding"</tt></li>
5352 <li><tt>"VDIStorageFull"</tt></li>
5353 </ul>
5354
5355 <note>
5356 This notification is not designed to be implemented by
5357 more than one callback at a time. If you have multiple
5358 IConsoleCallback instances registered on the given
5359 IConsole object, make sure you simply do nothing but
5360 return @c S_OK from all but one of them that does actual
5361 user notification and performs necessary actions.
5362 </note>
5363
5364 </desc>
5365 <param name="fatal" type="boolean" dir="in">
5366 <desc>Whether the error is fatal or not</desc>
5367 </param>
5368 <param name="id" type="wstring" dir="in">
5369 <desc>Error identifier</desc>
5370 </param>
5371 <param name="message" type="wstring" dir="in">
5372 <desc>Optional error message</desc>
5373 </param>
5374 </method>
5375
5376 <method name="onCanShowWindow">
5377 <desc>
5378 Notification when a call to
5379 <link to="IMachine::canShowConsoleWindow"/> is made by a
5380 front-end to check if a subsequent call to
5381 <link to="IMachine::showConsoleWindow"/> can succeed.
5382
5383 The callee should give an answer appropriate to the current
5384 machine state in the @a canShow argument. This answer must
5385 remain valid at least until the next
5386 <link to="IConsole::state">machine state</link> change.
5387
5388 <note>
5389 This notification is not designed to be implemented by
5390 more than one callback at a time. If you have multiple
5391 IConsoleCallback instances registered on the given
5392 IConsole object, make sure you simply do nothing but
5393 return @c true and @c S_OK from all but one of them that
5394 actually manages console window activation.
5395 </note>
5396 </desc>
5397 <param name="canShow" type="boolean" dir="return">
5398 <desc>
5399 @c true if the console window can be shown and @c
5400 false otherwise.
5401 </desc>
5402 </param>
5403 </method>
5404
5405 <method name="onShowWindow">
5406 <desc>
5407 Notification when a call to
5408 <link to="IMachine::showConsoleWindow"/>
5409 requests the console window to be activated and brought to
5410 foreground on the desktop of the host PC.
5411
5412 This notification should cause the VM console process to
5413 perform the requested action as described above. If it is
5414 impossible to do it at a time of this notification, this
5415 method should return a failure.
5416
5417 Note that many modern window managers on many platforms
5418 implement some sort of focus stealing prevention logic, so
5419 that it may be impossible to activate a window without the
5420 help of the currently active application (which is supposedly
5421 an initiator of this notification). In this case, this method
5422 must return a non-zero identifier that represents the
5423 top-level window of the VM console process. The caller, if it
5424 represents a currently active process, is responsible to use
5425 this identifier (in a platform-dependent manner) to perform
5426 actual window activation.
5427
5428 This method must set @a winId to zero if it has performed all
5429 actions necessary to complete the request and the console
5430 window is now active and in foreground, to indicate that no
5431 further action is required on the caller's side.
5432
5433 <note>
5434 This notification is not designed to be implemented by
5435 more than one callback at a time. If you have multiple
5436 IConsoleCallback instances registered on the given
5437 IConsole object, make sure you simply do nothing but
5438 return @c S_OK from all but one of them that actually
5439 manages console window activation.
5440 </note>
5441 </desc>
5442 <param name="winId" type="unsigned long long" dir="return">
5443 <desc>
5444 Platform-dependent identifier of the top-level VM console
5445 window, or zero if this method has performed all actions
5446 necessary to implement the <i>show window</i> semantics for
5447 the given platform and/or this VirtualBox front-end.
5448 </desc>
5449 </param>
5450 </method>
5451
5452 </interface>
5453
5454 <interface
5455 name="IRemoteDisplayInfo" extends="$unknown"
5456 uuid="550104cd-2dfd-4a6c-857d-f6f8e088e62c"
5457 wsmap="struct"
5458 >
5459 <desc>
5460 Contains information about the remote display (VRDP) capabilities and status.
5461 This is used in the <link to="IConsole::remoteDisplayInfo" /> attribute.
5462 </desc>
5463
5464 <attribute name="active" type="boolean" readonly="yes">
5465 <desc>
5466 Whether the remote display connection is active.
5467 </desc>
5468 </attribute>
5469
5470 <attribute name="numberOfClients" type="unsigned long" readonly="yes">
5471 <desc>
5472 How many times a client connected.
5473 </desc>
5474 </attribute>
5475
5476 <attribute name="beginTime" type="long long" readonly="yes">
5477 <desc>
5478 When the last connection was established, in milliseconds since 1970-01-01 UTC.
5479 </desc>
5480 </attribute>
5481
5482 <attribute name="endTime" type="long long" readonly="yes">
5483 <desc>
5484 When the last connection was terminated or the current time, if
5485 connection is still active, in milliseconds since 1970-01-01 UTC.
5486 </desc>
5487 </attribute>
5488
5489 <attribute name="bytesSent" type="unsigned long long" readonly="yes">
5490 <desc>
5491 How many bytes were sent in last or current, if still active, connection.
5492 </desc>
5493 </attribute>
5494
5495 <attribute name="bytesSentTotal" type="unsigned long long" readonly="yes">
5496 <desc>
5497 How many bytes were sent in all connections.
5498 </desc>
5499 </attribute>
5500
5501 <attribute name="bytesReceived" type="unsigned long long" readonly="yes">
5502 <desc>
5503 How many bytes were received in last or current, if still active, connection.
5504 </desc>
5505 </attribute>
5506
5507 <attribute name="bytesReceivedTotal" type="unsigned long long" readonly="yes">
5508 <desc>
5509 How many bytes were received in all connections.
5510 </desc>
5511 </attribute>
5512
5513 <attribute name="user" type="wstring" readonly="yes">
5514 <desc>
5515 Login user name supplied by the client.
5516 </desc>
5517 </attribute>
5518
5519 <attribute name="domain" type="wstring" readonly="yes">
5520 <desc>
5521 Login domain name supplied by the client.
5522 </desc>
5523 </attribute>
5524
5525 <attribute name="clientName" type="wstring" readonly="yes">
5526 <desc>
5527 The client name supplied by the client.
5528 </desc>
5529 </attribute>
5530
5531 <attribute name="clientIP" type="wstring" readonly="yes">
5532 <desc>
5533 The IP address of the client.
5534 </desc>
5535 </attribute>
5536
5537 <attribute name="clientVersion" type="unsigned long" readonly="yes">
5538 <desc>
5539 The client software version number.
5540 </desc>
5541 </attribute>
5542
5543 <attribute name="encryptionStyle" type="unsigned long" readonly="yes">
5544 <desc>
5545 Public key exchange method used when connection was established.
5546 Values: 0 - RDP4 public key exchange scheme.
5547 1 - X509 certificates were sent to client.
5548 </desc>
5549 </attribute>
5550
5551 </interface>
5552
5553 <interface
5554 name="IConsole" extends="$unknown"
5555 uuid="e3c6d4a1-a935-47ca-b16d-f9e9c496e53e"
5556 wsmap="managed"
5557 >
5558 <desc>
5559 The IConsole interface represents an interface to control virtual
5560 machine execution.
5561
5562 The console object that implements the IConsole interface is obtained
5563 from a session object after the session for the given machine has been
5564 opened using one of <link to="IVirtualBox::openSession"/>,
5565 <link to="IVirtualBox::openRemoteSession"/> or
5566 <link to="IVirtualBox::openExistingSession"/> methods.
5567
5568 Methods of the IConsole interface allow the caller to query the current
5569 virtual machine execution state, pause the machine or power it down, save
5570 the machine state or take a snapshot, attach and detach removable media
5571 and so on.
5572
5573 <see>ISession</see>
5574 </desc>
5575
5576 <attribute name="machine" type="IMachine" readonly="yes">
5577 <desc>
5578 Machine object this console is sessioned with.
5579 <note>
5580 This is a convenience property, it has the same value as
5581 <link to="ISession::machine"/> of the corresponding session
5582 object.
5583 </note>
5584 </desc>
5585 </attribute>
5586
5587 <attribute name="state" type="MachineState" readonly="yes">
5588 <desc>
5589 Current execution state of the machine.
5590 <note>
5591 This property always returns the same value as the corresponding
5592 property of the IMachine object this console is sessioned with.
5593 For the process that owns (executes) the VM, this is the
5594 preferable way of querying the VM state, because no IPC
5595 calls are made.
5596 </note>
5597 </desc>
5598 </attribute>
5599
5600 <attribute name="guest" type="IGuest" readonly="yes">
5601 <desc>Guest object.</desc>
5602 </attribute>
5603
5604 <attribute name="keyboard" type="IKeyboard" readonly="yes">
5605 <desc>
5606 Virtual keyboard object.
5607 <note>
5608 If the machine is not running, any attempt to use
5609 the returned object will result in an error.
5610 </note>
5611 </desc>
5612 </attribute>
5613
5614 <attribute name="mouse" type="IMouse" readonly="yes">
5615 <desc>
5616 Virtual mouse object.
5617 <note>
5618 If the machine is not running, any attempt to use
5619 the returned object will result in an error.
5620 </note>
5621 </desc>
5622 </attribute>
5623
5624 <attribute name="display" type="IDisplay" readonly="yes">
5625 <desc>Virtual display object.
5626 <note>
5627 If the machine is not running, any attempt to use
5628 the returned object will result in an error.
5629 </note>
5630 </desc>
5631 </attribute>
5632
5633 <attribute name="debugger" type="IMachineDebugger" readonly="yes">
5634 <desc>Debugging interface.</desc>
5635 </attribute>
5636
5637 <attribute name="USBDevices" type="IUSBDeviceCollection" readonly="yes">
5638 <desc>
5639 Collection of USB devices currently attached to the virtual
5640 USB controller.
5641 <note>
5642 The collection is empty if the machine is not running.
5643 </note>
5644 </desc>
5645 </attribute>
5646
5647 <attribute name="remoteUSBDevices" type="IHostUSBDeviceCollection" readonly="yes">
5648 <desc>
5649 List of USB devices currently attached to the remote VRDP client.
5650 Once a new device is physically attached to the remote host computer,
5651 it appears in this list and remains there until detached.
5652 </desc>
5653 </attribute>
5654
5655 <attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
5656 <desc>
5657 Collection of shared folders for the current session. These folders
5658 are called transient shared folders because they are available to the
5659 guest OS running inside the associated virtual machine only for the
5660 duration of the session (as opposed to
5661 <link to="IMachine::sharedFolders"/> which represent permanent shared
5662 folders). When the session is closed (e.g. the machine is powered down),
5663 these folders are automatically discarded.
5664
5665 New shared folders are added to the collection using
5666 <link to="#createSharedFolder"/>. Existing shared folders can be
5667 removed using <link to="#removeSharedFolder"/>.
5668 </desc>
5669 </attribute>
5670
5671 <attribute name="remoteDisplayInfo" type="IRemoteDisplayInfo" readonly="yes">
5672 <desc>
5673 Interface that provides information on Remote Display (VRDP) connection.
5674 </desc>
5675 </attribute>
5676
5677 <method name="powerUp">
5678 <desc>
5679 Starts the virtual machine execution using the current machine
5680 state (that is, its current execution state, current settings and
5681 current hard disks).
5682
5683 If the machine is powered off or aborted, the execution will
5684 start from the beginning (as if the real hardware were just
5685 powered on).
5686
5687 If the machine is in the <link to="MachineState_Saved"/> state,
5688 it will continue its execution the point where the state has
5689 been saved.
5690
5691 <note>
5692 Unless you are trying to write a new VirtualBox front-end that
5693 performs direct machine execution (like the VirtualBox or VBoxSDL
5694 front-ends), don't call <link to="IConsole::powerUp"/> in a direct
5695 session opened by <link to="IVirtualBox::openSession"/> and use this
5696 session only to change virtual machine settings. If you simply want to
5697 start virtual machine execution using one of the existing front-ends
5698 (for example the VirtualBox GUI or headless server), simply use
5699 <link to="IVirtualBox::openRemoteSession"/>; these front-ends will
5700 power up the machine automatically for you.
5701 </note>
5702
5703 <see>#saveState</see>
5704 <result name="VBOX_E_INVALID_VM_STATE">
5705 Virtual machine already running.
5706 </result>
5707 <result name="VBOX_E_HOST_ERROR">
5708 Host interface does not exist or name not set.
5709 </result>
5710 <result name="VBOX_E_FILE_ERROR">
5711 Invalid saved state file.
5712 </result>
5713 </desc>
5714 <param name="progress" type="IProgress" dir="return">
5715 <desc>Progress object to track the operation completion.</desc>
5716 </param>
5717 </method>
5718
5719 <method name="powerUpPaused">
5720 <desc>
5721 Identical to powerUp except that the VM will enter the
5722 <link to="MachineState_Paused"/> state, instead of
5723 <link to="MachineState_Running"/>.
5724
5725 <see>#powerUp</see>
5726 <result name="VBOX_E_INVALID_VM_STATE">
5727 Virtual machine already running.
5728 </result>
5729 <result name="VBOX_E_HOST_ERROR">
5730 Host interface does not exist or name not set.
5731 </result>
5732 <result name="VBOX_E_FILE_ERROR">
5733 Invalid saved state file.
5734 </result>
5735 </desc>
5736 <param name="progress" type="IProgress" dir="return">
5737 <desc>Progress object to track the operation completion.</desc>
5738 </param>
5739 </method>
5740
5741 <method name="powerDown">
5742 <desc>
5743 Stops the virtual machine execution.
5744 After this operation completes, the machine will go to the
5745 PoweredOff state.
5746
5747 @deprecated This method will be removed in VirtualBox 2.1 where the
5748 powerDownAsync() method will take its name. Do not use this method in
5749 the code.
5750 <result name="VBOX_E_INVALID_VM_STATE">
5751 Virtual machine must be Running, Paused or Stuck to be powered down.
5752 </result>
5753 <result name="VBOX_E_VM_ERROR">
5754 Unable to power off or destroy virtual machine.
5755 </result>
5756 </desc>
5757 </method>
5758
5759 <method name="powerDownAsync">
5760 <desc>
5761 Initiates the power down procedure to stop the virtual machine
5762 execution.
5763
5764 The completion of the power down procedure is tracked using the returned
5765 IProgress object. After the operation is complete, the machine will go
5766 to the PoweredOff state.
5767
5768 @warning This method will be renamed to "powerDown" in VirtualBox 2.1
5769 where the original powerDown() method will be removed. You will need to
5770 rename "powerDownAsync" to "powerDown" in your sources to make them
5771 build with version 2.1.
5772 <result name="VBOX_E_INVALID_VM_STATE">
5773 Virtual machine must be Running, Paused or Stuck to be powered down.
5774 </result>
5775 </desc>
5776 <param name="progress" type="IProgress" dir="return">
5777 <desc>Progress object to track the operation completion.</desc>
5778 </param>
5779 </method>
5780
5781 <method name="reset">
5782 <desc>Resets the virtual machine.
5783 <result name="VBOX_E_INVALID_VM_STATE">
5784 Virtual machine not in Running state.
5785 </result>
5786 <result name="VBOX_E_VM_ERROR">
5787 Virtual machine error in reset operation.
5788 </result>
5789 </desc>
5790 </method>
5791
5792 <method name="pause">
5793 <desc>Pauses the virtual machine execution.
5794 <result name="VBOX_E_INVALID_VM_STATE">
5795 Virtual machine not in Running state.
5796 </result>
5797 <result name="VBOX_E_VM_ERROR">
5798 Virtual machine error in suspend operation.
5799 </result>
5800 </desc>
5801 </method>
5802
5803 <method name="resume">
5804 <desc>Resumes the virtual machine execution.
5805 <result name="VBOX_E_INVALID_VM_STATE">
5806 Virtual machine not in Paused state.
5807 </result>
5808 <result name="VBOX_E_VM_ERROR">
5809 Virtual machine error in resume operation.
5810 </result>
5811 </desc>
5812 </method>
5813
5814 <method name="powerButton">
5815 <desc>Sends the ACPI power button event to the guest.
5816 <result name="VBOX_E_INVALID_VM_STATE">
5817 Virtual machine not in Running state.
5818 </result>
5819 <result name="VBOX_E_PDM_ERROR">
5820 Controlled power off failed.
5821 </result>
5822 </desc>
5823 </method>
5824
5825 <method name="sleepButton">
5826 <desc>Sends the ACPI sleep button event to the guest.
5827 <result name="VBOX_E_INVALID_VM_STATE">
5828 Virtual machine not in Running state.
5829 </result>
5830 <result name="VBOX_E_PDM_ERROR">
5831 Sending sleep button event failed.
5832 </result>
5833 </desc>
5834 </method>
5835
5836 <method name="getPowerButtonHandled">
5837 <desc>Checks if the last power button event was handled by guest.
5838 <result name="VBOX_E_PDM_ERROR">
5839 Checking if the event was handled by the guest OS failed.
5840 </result>
5841 </desc>
5842 <param name="handled" type="boolean" dir="return"/>
5843 </method>
5844
5845 <method name="getGuestEnteredACPIMode">
5846 <desc>Checks if the guest entered the ACPI mode G0 (working) or
5847 G1 (sleeping). If this method returns false, the guest will
5848 most likely not respond to external ACPI events.
5849 <result name="VBOX_E_INVALID_VM_STATE">
5850 Virtual machine not in Running state.
5851 </result>
5852 </desc>
5853 <param name="entered" type="boolean" dir="return"/>
5854 </method>
5855
5856 <method name="saveState">
5857 <desc>
5858 Saves the current execution state of a running virtual machine
5859 and stops its execution.
5860
5861 After this operation completes, the machine will go to the
5862 Saved state. Next time it is powered up, this state will
5863 be restored and the machine will continue its execution from
5864 the place where it was saved.
5865
5866 This operation differs from taking a snapshot to the effect
5867 that it doesn't create new differencing hard disks. Also, once
5868 the machine is powered up from the state saved using this method,
5869 the saved state is deleted, so it will be impossible to return
5870 to this state later.
5871
5872 <note>
5873 On success, this method implicitly calls
5874 <link to="IMachine::saveSettings"/> to save all current machine
5875 settings (including runtime changes to the DVD drive, etc.).
5876 Together with the impossibility to change any VM settings when it is
5877 in the Saved state, this guarantees adequate hardware
5878 configuration of the machine when it is restored from the saved
5879 state file.
5880 </note>
5881
5882 <note>
5883 The machine must be in the Running or Paused state, otherwise
5884 the operation will fail.
5885 </note>
5886 <result name="VBOX_E_INVALID_VM_STATE">
5887 Virtual machine state neither Running nor Paused.
5888 </result>
5889 <result name="VBOX_E_FILE_ERROR">
5890 Failed to create directory for saved state file.
5891 </result>
5892
5893 <see><link to="#takeSnapshot"/></see>
5894 </desc>
5895 <param name="progress" type="IProgress" dir="return">
5896 <desc>Progress object to track the operation completion.</desc>
5897 </param>
5898 </method>
5899
5900 <method name="adoptSavedState">
5901 <desc>
5902 Associates the given saved state file to the virtual machine.
5903
5904 On success, the machine will go to the Saved state. Next time it is
5905 powered up, it will be restored from the adopted saved state and
5906 continue execution from the place where the saved state file was
5907 created.
5908
5909 The specified saved state file path may be absolute or relative to the
5910 folder the VM normally saves the state to (usually,
5911 <link to="IMachine::snapshotFolder"/>).
5912
5913 <note>
5914 It's a caller's responsibility to make sure the given saved state
5915 file is compatible with the settings of this virtual machine that
5916 represent its virtual hardware (memory size, hard disk configuration
5917 etc.). If there is a mismatch, the behavior of the virtual machine
5918 is undefined.
5919 </note>
5920 <result name="VBOX_E_INVALID_VM_STATE">
5921 Virtual machine state neither PoweredOff nor Aborted.
5922 </result>
5923 </desc>
5924 <param name="savedStateFile" type="wstring" dir="in">
5925 <desc>Path to the saved state file to adopt.</desc>
5926 </param>
5927 </method>
5928
5929 <method name="discardSavedState">
5930 <desc>
5931 Discards (deletes) the saved state of the virtual machine
5932 previously created by <link to="#saveState"/>. Next time the
5933 machine is powered up, a clean boot will occur.
5934 <note>
5935 This operation is equivalent to resetting or powering off
5936 the machine without doing a proper shutdown in the guest OS.
5937 </note>
5938 <result name="VBOX_E_INVALID_VM_STATE">
5939 Virtual machine not in state Saved.
5940 </result>
5941 </desc>
5942 </method>
5943
5944 <method name="getDeviceActivity">
5945 <desc>
5946 Gets the current activity type of a given device or device group.
5947 <result name="E_INVALIDARG">
5948 Invalid device type.
5949 </result>
5950 </desc>
5951 <param name="type" type="DeviceType" dir="in"/>
5952 <param name="activity" type="DeviceActivity" dir="return"/>
5953 </method>
5954
5955 <method name="attachUSBDevice">
5956 <desc>
5957 Attaches a host USB device with the given UUID to the
5958 USB controller of the virtual machine.
5959
5960 The device needs to be in one of the following states:
5961 <link to="USBDeviceState_Busy"/>,
5962 <link to="USBDeviceState_Available"/> or
5963 <link to="USBDeviceState_Held"/>,
5964 otherwise an error is immediately returned.
5965
5966 When the device state is
5967 <link to="USBDeviceState_Busy">Busy</link>, an error may also
5968 be returned if the host computer refuses to release it for some reason.
5969
5970 <see>IUSBController::deviceFilters, USBDeviceState</see>
5971 <result name="VBOX_E_INVALID_VM_STATE">
5972 Virtual machine state neither Running nor Paused.
5973 </result>
5974 <result name="VBOX_E_PDM_ERROR">
5975 Virtual machine does not have a USB controller.
5976 </result>
5977 </desc>
5978 <param name="id" type="uuid" dir="in">
5979 <desc>UUID of the host USB device to attach.</desc>
5980 </param>
5981 </method>
5982
5983 <method name="detachUSBDevice">
5984 <desc>
5985 Detaches an USB device with the given UUID from the USB controller
5986 of the virtual machine.
5987
5988 After this method succeeds, the VirtualBox server re-initiates
5989 all USB filters as if the device were just physically attached
5990 to the host, but filters of this machine are ignored to avoid
5991 a possible automatic re-attachment.
5992
5993 <see>IUSBController::deviceFilters, USBDeviceState</see>
5994
5995 <result name="VBOX_E_PDM_ERROR">
5996 Virtual machine does not have a USB controller.
5997 </result>
5998 <result name="E_INVALIDARG">
5999 USB device not attached to this virtual machine.
6000 </result>
6001 </desc>
6002 <param name="id" type="uuid" dir="in">
6003 <desc>UUID of the USB device to detach.</desc>
6004 </param>
6005 <param name="device" type="IUSBDevice" dir="return">
6006 <desc>Detached USB device.</desc>
6007 </param>
6008 </method>
6009
6010 <method name="createSharedFolder">
6011 <desc>
6012 Creates a transient new shared folder by associating the given logical
6013 name with the given host path, adds it to the collection of shared
6014 folders and starts sharing it. Refer to the description of
6015 <link to="ISharedFolder"/> to read more about logical names.
6016
6017 <result name="VBOX_E_INVALID_VM_STATE">
6018 Virtual machine in Saved state or currently changing state.
6019 </result>
6020 <result name="VBOX_E_FILE_ERROR">
6021 Shared folder already exists or not accessible.
6022 </result>
6023 </desc>
6024 <param name="name" type="wstring" dir="in">
6025 <desc>Unique logical name of the shared folder.</desc>
6026 </param>
6027 <param name="hostPath" type="wstring" dir="in">
6028 <desc>Full path to the shared folder in the host file system.</desc>
6029 </param>
6030 <param name="writable" type="boolean" dir="in">
6031 <desc>Whether the share is writable or readonly</desc>
6032 </param>
6033 </method>
6034
6035 <method name="removeSharedFolder">
6036 <desc>
6037 Removes a transient shared folder with the given name previously
6038 created by <link to="#createSharedFolder"/> from the collection of
6039 shared folders and stops sharing it.
6040 <result name="VBOX_E_INVALID_VM_STATE">
6041 Virtual machine in Saved state or currently changing state.
6042 </result>
6043 <result name="VBOX_E_FILE_ERROR">
6044 Shared folder does not exists.
6045 </result>
6046 </desc>
6047 <param name="name" type="wstring" dir="in">
6048 <desc>Logical name of the shared folder to remove.</desc>
6049 </param>
6050 </method>
6051
6052 <method name="takeSnapshot">
6053 <desc>
6054 Saves the current execution state and all settings of the
6055 machine and creates differencing images for all
6056 normal (non-independent) hard disks.
6057
6058 This method can be called for a PoweredOff, Saved, Running or
6059 Paused virtual machine. When the machine is PoweredOff, an
6060 offline <link to="ISnapshot">snapshot</link> is created,
6061 in all other cases -- an online snapshot.
6062
6063 The taken snapshot is always based on the
6064 <link to="IMachine::currentSnapshot">current
6065 snapshot</link> of the associated virtual machine and becomes
6066 a new current snapshot.
6067
6068 <note>
6069 This method implicitly calls <link to="IMachine::saveSettings"/> to
6070 save all current machine settings before taking an offline snapshot.
6071 </note>
6072
6073 <see>ISnapshot, <link to="#saveState"/></see>
6074 <result name="VBOX_E_INVALID_VM_STATE">
6075 Virtual machine currently changing state.
6076 </result>
6077 </desc>
6078 <param name="name" type="wstring" dir="in">
6079 <desc>Short name for the snapshot.</desc>
6080 </param>
6081 <param name="description" type="wstring" dir="in">
6082 <desc>Optional description of the snapshot.</desc>
6083 </param>
6084 <param name="progress" type="IProgress" dir="return">
6085 <desc>Progress object to track the operation completion.</desc>
6086 </param>
6087 </method>
6088
6089 <method name="discardSnapshot">
6090 <desc>
6091
6092 Starts discarding the specified snapshot. The execution state
6093 and settings of the associated machine stored in the snapshot
6094 will be deleted. The contents of all differencing hard disks of
6095 this snapshot will be merged with the contents of their
6096 dependent child hard disks to keep the, disks valid (in other
6097 words, all changes represented by hard disks being discarded
6098 will be propagated to their child hard disks). After that, this
6099 snapshot's differencing hard disks will be deleted. The parent
6100 of this snapshot will become a new parent for all its child
6101 snapshots.
6102
6103 If the discarded snapshot is the current one, its parent
6104 snapshot will become a new current snapshot. The current machine
6105 state is not directly affected in this case, except that
6106 currently attached differencing hard disks based on hard disks
6107 of the discarded snapshot will be also merged as described
6108 above.
6109
6110 If the discarded snapshot is the first one (the root snapshot)
6111 and it has exactly one child snapshot, this child snapshot will
6112 become the first snapshot after discarding. If there are no
6113 children at all (i.e. the first snapshot is the only snapshot of
6114 the machine), both the current and the first snapshot of the
6115 machine will be set to null. In all other cases, the first
6116 snapshot cannot be discarded.
6117
6118 You cannot discard the snapshot if it
6119 stores <link to="HardDiskType_Normal">normal</link> (non-differencing)
6120 hard disks that have differencing hard disks based on them. Snapshots of
6121 such kind can be discarded only when every normal hard disk has either
6122 no children at all or exactly one child. In the former case, the normal
6123 hard disk simply becomes unused (i.e. not attached to any VM). In the
6124 latter case, it receives all the changes stored in the child hard disk,
6125 and then it replaces the child hard disk in the configuration of the
6126 corresponding snapshot or machine.
6127
6128 Also, you cannot discard the snapshot if it stores hard disks
6129 (of any type) having differencing child hard disks that belong
6130 to other machines. Such snapshots can be only discarded after
6131 you discard all snapshots of other machines containing "foreign"
6132 child disks, or detach these "foreign" child disks from machines
6133 they are attached to.
6134
6135 One particular example of the snapshot storing normal hard disks
6136 is the first snapshot of a virtual machine that had normal hard
6137 disks attached when taking the snapshot. Be careful when
6138 discarding such snapshots because this implicitly commits
6139 changes (made since the snapshot being discarded has been taken)
6140 to normal hard disks (as described above), which may be not what
6141 you want.
6142
6143 The virtual machine is put to
6144 the <link to="MachineState_Discarding">Discarding</link> state until
6145 the discard operation is completed.
6146
6147 <note>
6148 The machine must not be running, otherwise the operation
6149 will fail.
6150 </note>
6151
6152 <note>
6153 Child hard disks of all normal hard disks of the discarded snapshot
6154 must be accessible (see <link to="IMedium::state"/>) for this
6155 operation to succeed. In particular, this means that all virtual
6156 machines, whose hard disks are directly or indirectly based on the
6157 hard disks of discarded snapshot, must be powered off.
6158 </note>
6159 <note>
6160 Merging hard disk contents can be very time and disk space
6161 consuming, if these disks are big in size and have many
6162 children. However, if the snapshot being discarded is the last
6163 (head) snapshot on the branch, the operation will be rather
6164 quick.
6165 </note>
6166 <note>
6167 Note that discarding the current snapshot
6168 will implicitly call <link to="IMachine::saveSettings"/> to
6169 make all current machine settings permanent.
6170 </note>
6171 <result name="VBOX_E_INVALID_VM_STATE">
6172 Virtual machine is running.
6173 </result>
6174 </desc>
6175 <param name="id" type="uuid" dir="in">
6176 <desc>UUID of the snapshot to discard.</desc>
6177 </param>
6178 <param name="progress" type="IProgress" dir="return">
6179 <desc>Progress object to track the operation completion.</desc>
6180 </param>
6181 </method>
6182
6183 <method name="discardCurrentState">
6184 <desc>
6185 This operation is similar to <link to="#discardSnapshot"/> but
6186 affects the current machine state. This means that the state stored in
6187 the current snapshot will become a new current state, and all current
6188 settings of the machine and changes stored in differencing hard disks
6189 will be lost.
6190
6191 After this operation is successfully completed, new empty differencing
6192 hard disks are created for all normal hard disks of the machine.
6193
6194 If the current snapshot of the machine is an online snapshot, the
6195 machine will go to the <link to="MachineState_Saved"> saved
6196 state</link>, so that the next time it is powered on, the execution
6197 state will be restored from the current snapshot.
6198
6199 <note>
6200 The machine must not be running, otherwise the operation will fail.
6201 </note>
6202
6203 <note>
6204 If the machine state is <link to="MachineState_Saved">Saved</link>
6205 prior to this operation, the saved state file will be implicitly
6206 discarded (as if <link to="IConsole::discardSavedState"/> were
6207 called).
6208 </note>
6209
6210 <result name="VBOX_E_INVALID_VM_STATE">
6211 Virtual machine is running.
6212 </result>
6213 </desc>
6214 <param name="progress" type="IProgress" dir="return">
6215 <desc>Progress object to track the operation completion.</desc>
6216 </param>
6217 </method>
6218
6219 <method name="discardCurrentSnapshotAndState">
6220 <desc>
6221
6222 This method is equivalent to
6223 doing <link to="IConsole::discardSnapshot">discardSnapshot</link>
6224 (currentSnapshot.id(), progress) followed by
6225 <link to="#discardCurrentState"/>.
6226
6227 As a result, the machine will be fully restored from the
6228 snapshot preceding the current snapshot, while both the current
6229 snapshot and the current machine state will be discarded.
6230
6231 If the current snapshot is the first snapshot of the machine (i.e. it
6232 has the only snapshot), the current machine state will be
6233 discarded <b>before</b> discarding the snapshot. In other words, the
6234 machine will be restored from its last snapshot, before discarding
6235 it. This differs from performing a single
6236 <link to="#discardSnapshot"/> call (note that no
6237 <link to="#discardCurrentState"/> will be possible after it)
6238 to the effect that the latter will preserve the current state instead of
6239 discarding it.
6240
6241 Unless explicitly mentioned otherwise, all remarks and
6242 limitations of the above two methods also apply to this method.
6243
6244 <note>
6245 The machine must not be running, otherwise the operation
6246 will fail.
6247 </note>
6248
6249 <note>
6250 If the machine state is <link to="MachineState_Saved">Saved</link>
6251 prior to this operation, the saved state file will be implicitly
6252 discarded (as if <link to="#discardSavedState"/> were
6253 called).
6254 </note>
6255
6256 <note>
6257 This method is more efficient than calling both of the above
6258 methods separately: it requires less IPC calls and provides
6259 a single progress object.
6260 </note>
6261
6262 <result name="VBOX_E_INVALID_VM_STATE">
6263 Virtual machine is running.
6264 </result>
6265 </desc>
6266 <param name="progress" type="IProgress" dir="return">
6267 <desc>Progress object to track the operation completion.</desc>
6268 </param>
6269 </method>
6270
6271 <method name="registerCallback">
6272 <desc>
6273 Registers a new console callback on this instance. The methods of the
6274 callback interface will be called by this instance when the appropriate
6275 event occurs.
6276 </desc>
6277 <param name="callback" type="IConsoleCallback" dir="in"/>
6278 </method>
6279
6280 <method name="unregisterCallback">
6281 <desc>
6282 Unregisters the console callback previously registered using
6283 <link to="#registerCallback"/>.
6284 <result name="E_INVALIDARG">
6285 Given @a callback handler is not registered.
6286 </result>
6287 </desc>
6288 <param name="callback" type="IConsoleCallback" dir="in"/>
6289 </method>
6290 </interface>
6291
6292 <!--
6293 // IHost
6294 /////////////////////////////////////////////////////////////////////////
6295 -->
6296
6297 <interface
6298 name="IHostDVDDrive" extends="$unknown"
6299 uuid="21f86694-202d-4ce4-8b05-a63ff82dbf4c"
6300 wsmap="managed"
6301 >
6302 <desc>
6303 The IHostDVDDrive interface represents the physical CD/DVD drive
6304 hardware on the host. Used indirectly in <link to="IHost::DVDDrives"/>.
6305 </desc>
6306
6307 <attribute name="name" type="wstring" readonly="yes">
6308 <desc>
6309 Returns the platform-specific device identifier.
6310 On DOS-like platforms, it is a drive name (e.g. R:).
6311 On Unix-like platforms, it is a device name (e.g. /dev/hdc).
6312 </desc>
6313 </attribute>
6314 <attribute name="description" type="wstring" readonly="yes">
6315 <desc>
6316 Returns a human readable description for the drive. This
6317 description usually contains the product and vendor name. A
6318 @c null string is returned if the description is not available.
6319 </desc>
6320 </attribute>
6321 <attribute name="udi" type="wstring" readonly="yes">
6322 <desc>
6323 Returns the unique device identifier for the drive. This
6324 attribute is reserved for future use instead of
6325 <link to="#name"/>. Currently it is not used and may return
6326 @c null on some platforms.
6327 </desc>
6328 </attribute>
6329
6330 </interface>
6331
6332 <interface
6333 name="IHostFloppyDrive" extends="$unknown"
6334 uuid="3f02d604-e908-4919-9fd1-8a4afd68fc63"
6335 wsmap="managed"
6336 >
6337 <desc>
6338 The IHostFloppyDrive interface represents the physical floppy drive
6339 hardware on the host. Used indirectly in <link to="IHost::floppyDrives"/>.
6340 </desc>
6341 <attribute name="name" type="wstring" readonly="yes">
6342 <desc>
6343 Returns the platform-specific device identifier.
6344 On DOS-like platforms, it is a drive name (e.g. A:).
6345 On Unix-like platforms, it is a device name (e.g. /dev/fd0).
6346 </desc>
6347 </attribute>
6348 <attribute name="description" type="wstring" readonly="yes">
6349 <desc>
6350 Returns a human readable description for the drive. This
6351 description usually contains the product and vendor name. A
6352 @c null string is returned if the description is not available.
6353 </desc>
6354 </attribute>
6355 <attribute name="udi" type="wstring" readonly="yes">
6356 <desc>
6357 Returns the unique device identifier for the drive. This
6358 attribute is reserved for future use instead of
6359 <link to="#name"/>. Currently it is not used and may return
6360 @c null on some platforms.
6361 </desc>
6362 </attribute>
6363 </interface>
6364
6365 <enum
6366 name="HostNetworkInterfaceMediumType"
6367 uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6368 >
6369 <desc>
6370 Type of encapsulation. Ethernet encapsulation includes both wired and
6371 wireless Ethernet connections.
6372 <see>IHostNetworkInterface</see>
6373 </desc>
6374
6375 <const name="Unknown" value="0">
6376 <desc>
6377 The type of interface cannot be determined.
6378 </desc>
6379 </const>
6380 <const name="Ethernet" value="1">
6381 <desc>
6382 Ethernet frame encapsulation.
6383 </desc>
6384 </const>
6385 <const name="PPP" value="2">
6386 <desc>
6387 Point-to-point protocol encapsulation.
6388 </desc>
6389 </const>
6390 <const name="SLIP" value="3">
6391 <desc>
6392 Serial line IP encapsulation.
6393 </desc>
6394 </const>
6395 </enum>
6396
6397 <enum
6398 name="HostNetworkInterfaceStatus"
6399 uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6400 >
6401 <desc>
6402 Current status of the interface.
6403 <see>IHostNetworkInterface</see>
6404 </desc>
6405
6406 <const name="Unknown" value="0">
6407 <desc>
6408 The state of interface cannot be determined.
6409 </desc>
6410 </const>
6411 <const name="Up" value="1">
6412 <desc>
6413 The interface is fully operational.
6414 </desc>
6415 </const>
6416 <const name="Down" value="2">
6417 <desc>
6418 The interface is not functioning.
6419 </desc>
6420 </const>
6421 </enum>
6422
6423 <enum
6424 name="HostNetworkInterfaceType"
6425 uuid="4cd97025-b31b-430b-98dd-211e85cf389f"
6426 >
6427 <desc>
6428 Network interface type.
6429 </desc>
6430 <const name="Bridged" value="1"/>
6431 <const name="HostOnly" value="2"/>
6432 </enum>
6433
6434 <interface
6435 name="IHostNetworkInterface" extends="$unknown"
6436 uuid="c312bf73-b353-4add-9db7-481b891ec08c"
6437 wsmap="managed"
6438 >
6439 <desc>
6440 Reprents one of host's network interfaces. IP V6 address and network
6441 mask are strings of 32 hexdecimal digits grouped by four. Groups are
6442 separated by colons.
6443 For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6444 </desc>
6445 <attribute name="name" type="wstring" readonly="yes">
6446 <desc>Returns the host network interface name.</desc>
6447 </attribute>
6448
6449 <attribute name="id" type="uuid" readonly="yes">
6450 <desc>Returns the interface UUID.</desc>
6451 </attribute>
6452
6453 <attribute name="IPAddress" type="unsigned long" readonly="yes">
6454 <desc>Returns the IP V4 address of the interface.</desc>
6455 </attribute>
6456
6457 <attribute name="networkMask" type="unsigned long" readonly="yes">
6458 <desc>Returns the network mask of the interface.</desc>
6459 </attribute>
6460
6461 <attribute name="IPV6Address" type="wstring" readonly="yes">
6462 <desc>Returns the IP V6 address of the interface.</desc>
6463 </attribute>
6464
6465 <attribute name="IPV6NetworkMask" type="wstring" readonly="yes">
6466 <desc>Returns the IP V6 network mask of the interface.</desc>
6467 </attribute>
6468
6469 <attribute name="hardwareAddress" type="wstring" readonly="yes">
6470 <desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6471 </attribute>
6472
6473 <attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6474 <desc>Type of protocol encapsulation used.</desc>
6475 </attribute>
6476
6477 <attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6478 <desc>Status of the interface.</desc>
6479 </attribute>
6480
6481 <attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6482 <desc>specifies the host interface type.</desc>
6483 </attribute>
6484 </interface>
6485
6486 <interface
6487 name="IHost" extends="$unknown"
6488 uuid="96128709-69b5-43cc-9393-b3895f3b866a"
6489 wsmap="managed"
6490 >
6491 <desc>
6492 The IHost interface represents the physical machine that this VirtualBox
6493 installation runs on.
6494
6495 An object implementing this interface is returned by the
6496 <link to="IVirtualBox::host" /> attribute. This interface contains
6497 read-only information about the host's physical hardware (such as what
6498 processors and disks are available, what the host operating system is,
6499 and so on) and also allows for manipulating some of the host's hardware,
6500 such as global USB device filters and host interface networking.
6501
6502 </desc>
6503 <attribute name="DVDDrives" type="IHostDVDDrive" readonly="yes" safearray="yes">
6504 <desc>List of DVD drives available on the host.</desc>
6505 </attribute>
6506
6507 <attribute name="floppyDrives" type="IHostFloppyDrive" readonly="yes" safearray="yes">
6508 <desc>List of floppy drives available on the host.</desc>
6509 </attribute>
6510
6511 <attribute name="USBDevices" type="IHostUSBDeviceCollection" readonly="yes">
6512 <desc>
6513 List of USB devices currently attached to the host.
6514 Once a new device is physically attached to the host computer,
6515 it appears in this list and remains there until detached.
6516
6517 <note>
6518 This method may set a @ref com_warnings "warning result code".
6519 </note>
6520 <note>
6521 If USB functionality is not available in the given edition of
6522 VirtualBox, this method will set the result code to @c E_NOTIMPL.
6523 </note>
6524 </desc>
6525 </attribute>
6526
6527 <attribute name="USBDeviceFilters" type="IHostUSBDeviceFilterCollection" readonly="yes">
6528 <desc>
6529 List of USB device filters in action.
6530 When a new device is physically attached to the host computer,
6531 filters from this list are applied to it (in order they are stored
6532 in the list). The first matched filter will determine the
6533 <link to="IHostUSBDeviceFilter::action">action</link>
6534 performed on the device.
6535
6536 Unless the device is ignored by these filters, filters of all
6537 currently running virtual machines
6538 (<link to="IUSBController::deviceFilters"/>) are applied to it.
6539
6540 <note>
6541 This method may set a @ref com_warnings "warning result code".
6542 </note>
6543 <note>
6544 If USB functionality is not available in the given edition of
6545 VirtualBox, this method will set the result code to @c E_NOTIMPL.
6546 </note>
6547
6548 <see>IHostUSBDeviceFilter, USBDeviceState</see>
6549 </desc>
6550 </attribute>
6551
6552 <attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
6553 <desc>List of host network interfaces currently defined on the host.</desc>
6554 </attribute>
6555
6556 <attribute name="processorCount" type="unsigned long" readonly="yes">
6557 <desc>Number of (logical) CPUs installed in the host system.</desc>
6558 </attribute>
6559
6560 <attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
6561 <desc>Number of (logical) CPUs online in the host system.</desc>
6562 </attribute>
6563
6564 <method name="getProcessorSpeed">
6565 <desc>Query the (approximate) maximum speed of a specified host CPU in
6566 Megahertz.
6567 </desc>
6568 <param name="cpuId" type="unsigned long" dir="in">
6569 <desc>
6570 Identifier of the CPU.
6571 </desc>
6572 </param>
6573 <param name="speed" type="unsigned long" dir="return">
6574 <desc>
6575 Speed value. 0 is returned if value is not known or @a cpuId is
6576 invalid.
6577 </desc>
6578 </param>
6579 </method>
6580
6581 <method name="getProcessorFeature">
6582 <desc>Query whether a CPU feature is supported or not.</desc>
6583 <param name="feature" type="ProcessorFeature" dir="in">
6584 <desc>
6585 CPU Feature identifier.
6586 </desc>
6587 </param>
6588 <param name="supported" type="boolean" dir="return">
6589 <desc>
6590 Feature is supported or not.
6591 </desc>
6592 </param>
6593 </method>
6594
6595 <method name="getProcessorDescription">
6596 <desc>Query the model string of a specified host CPU.
6597 <note>
6598 This function is not implemented in the current version of the
6599 product.
6600 </note>
6601 </desc>
6602 <param name="cpuId" type="unsigned long" dir="in">
6603 <desc>
6604 Identifier of the CPU.
6605 </desc>
6606 </param>
6607 <param name="description" type="wstring" dir="return">
6608 <desc>
6609 Model string. A NULL string is returned if value is not known or
6610 @a cpuId is invalid.
6611 </desc>
6612 </param>
6613 </method>
6614
6615 <attribute name="memorySize" type="unsigned long" readonly="yes">
6616 <desc>Amount of system memory in megabytes installed in the host system.</desc>
6617 </attribute>
6618
6619 <attribute name="memoryAvailable" type="unsigned long" readonly="yes">
6620 <desc>Available system memory in the host system.</desc>
6621 </attribute>
6622
6623 <attribute name="operatingSystem" type="wstring" readonly="yes">
6624 <desc>Name of the host system's operating system.</desc>
6625 </attribute>
6626
6627 <attribute name="OSVersion" type="wstring" readonly="yes">
6628 <desc>Host operating system's version string.</desc>
6629 </attribute>
6630
6631 <attribute name="UTCTime" type="long long" readonly="yes">
6632 <desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
6633 </attribute>
6634
6635<if target="midl">
6636 <method name="createHostOnlyNetworkInterface">
6637 <desc>
6638 Creates a new adapter for Host Only Networking.
6639 <result name="E_INVALIDARG">
6640 Host network interface @a name already exists.
6641 </result>
6642 </desc>
6643 <param name="name" type="wstring" dir="in">
6644 <desc>
6645 Adapter name.
6646 </desc>
6647 </param>
6648 <param name="hostInterface" type="IHostNetworkInterface" dir="out">
6649 <desc>
6650 Created host interface object.
6651 </desc>
6652 </param>
6653 <param name="progress" type="IProgress" dir="return">
6654 <desc>
6655 Progress object to track the operation completion.
6656 </desc>
6657 </param>
6658 </method>
6659 <method name="removeHostOnlyNetworkInterface">
6660 <desc>
6661 Removes the given Host Only Networking interface.
6662 <result name="VBOX_E_OBJECT_NOT_FOUND">
6663 No host network interface matching @a id found.
6664 </result>
6665 </desc>
6666 <param name="id" type="uuid" dir="in">
6667 <desc>
6668 Adapter GUID.
6669 </desc>
6670 </param>
6671 <param name="hostInterface" type="IHostNetworkInterface" dir="out">
6672 <desc>
6673 Removed host interface object.
6674 </desc>
6675 </param>
6676 <param name="progress" type="IProgress" dir="return">
6677 <desc>
6678 Progress object to track the operation completion.
6679 </desc>
6680 </param>
6681 </method>
6682</if>
6683
6684 <method name="createUSBDeviceFilter">
6685 <desc>
6686 Creates a new USB device filter. All attributes except
6687 the filter name are set to <tt>null</tt> (any match),
6688 <i>active</i> is <tt>false</tt> (the filter is not active).
6689
6690 The created filter can be added to the list of filters using
6691 <link to="#insertUSBDeviceFilter"/>.
6692
6693 <see>#USBDeviceFilters</see>
6694 </desc>
6695 <param name="name" type="wstring" dir="in">
6696 <desc>
6697 Filter name. See <link to="IHostUSBDeviceFilter::name"/>
6698 for more info.
6699 </desc>
6700 </param>
6701 <param name="filter" type="IHostUSBDeviceFilter" dir="return">
6702 <desc>Created filter object.</desc>
6703 </param>
6704 </method>
6705
6706 <method name="insertUSBDeviceFilter">
6707 <desc>
6708 Inserts the given USB device to the specified position
6709 in the list of filters.
6710
6711 Positions are numbered starting from <tt>0</tt>. If the specified
6712 position is equal to or greater than the number of elements in
6713 the list, the filter is added at the end of the collection.
6714
6715 <note>
6716 Duplicates are not allowed, so an attempt to insert a
6717 filter that is already in the list, will return an
6718 error.
6719 </note>
6720 <note>
6721 This method may set a @ref com_warnings "warning result code".
6722 </note>
6723 <note>
6724 If USB functionality is not available in the given edition of
6725 VirtualBox, this method will set the result code to @c E_NOTIMPL.
6726 </note>
6727
6728 <see>#USBDeviceFilters</see>
6729
6730 <result name="VBOX_E_INVALID_OBJECT_STATE">
6731 USB device filter is not created within this VirtualBox instance.
6732 </result>
6733 <result name="E_INVALIDARG">
6734 USB device filter already in list.
6735 </result>
6736
6737 </desc>
6738 <param name="position" type="unsigned long" dir="in">
6739 <desc>Position to insert the filter to.</desc>
6740 </param>
6741 <param name="filter" type="IHostUSBDeviceFilter" dir="in">
6742 <desc>USB device filter to insert.</desc>
6743 </param>
6744 </method>
6745
6746 <method name="removeUSBDeviceFilter">
6747 <desc>
6748 Removes a USB device filter from the specified position in the
6749 list of filters.
6750
6751 Positions are numbered starting from <tt>0</tt>. Specifying a
6752 position equal to or greater than the number of elements in
6753 the list will produce an error.
6754
6755 <note>
6756 This method may set a @ref com_warnings "warning result code".
6757 </note>
6758 <note>
6759 If USB functionality is not available in the given edition of
6760 VirtualBox, this method will set the result code to @c E_NOTIMPL.
6761 </note>
6762
6763 <see>#USBDeviceFilters</see>
6764
6765 <result name="E_INVALIDARG">
6766 USB device filter list empty or invalid @a position.
6767 </result>
6768
6769 </desc>
6770 <param name="position" type="unsigned long" dir="in">
6771 <desc>Position to remove the filter from.</desc>
6772 </param>
6773 <param name="filter" type="IHostUSBDeviceFilter" dir="return">
6774 <desc>Removed USB device filter.</desc>
6775 </param>
6776 </method>
6777
6778 <method name="findHostDVDDrive">
6779 <desc>
6780 Searches for a host DVD drive with the given @c name.
6781
6782 <result name="VBOX_E_OBJECT_NOT_FOUND">
6783 Given @c name does not correspond to any host drive.
6784 </result>
6785
6786 </desc>
6787 <param name="name" type="wstring" dir="in">
6788 <desc>Name of the host drive to search for</desc>
6789 </param>
6790 <param name="drive" type="IHostDVDDrive" dir="return">
6791 <desc>Found host drive object</desc>
6792 </param>
6793 </method>
6794
6795 <method name="findHostFloppyDrive">
6796 <desc>
6797 Searches for a host floppy drive with the given @c name.
6798
6799 <result name="VBOX_E_OBJECT_NOT_FOUND">
6800 Given @c name does not correspond to any host floppy drive.
6801 </result>
6802
6803 </desc>
6804 <param name="name" type="wstring" dir="in">
6805 <desc>Name of the host floppy drive to search for</desc>
6806 </param>
6807 <param name="drive" type="IHostFloppyDrive" dir="return">
6808 <desc>Found host floppy drive object</desc>
6809 </param>
6810 </method>
6811
6812 <method name="findHostNetworkInterfaceByName">
6813 <desc>
6814 Searches through all host network interfaces for an interface with
6815 the given @c name.
6816 <note>
6817 The method returns an error if the given @c name does not
6818 correspond to any host network interface.
6819 </note>
6820 </desc>
6821 <param name="name" type="wstring" dir="in">
6822 <desc>Name of the host network interface to search for.</desc>
6823 </param>
6824 <param name="networkInterface" type="IHostNetworkInterface" dir="return">
6825 <desc>Found host network interface object.</desc>
6826 </param>
6827 </method>
6828 <method name="findHostNetworkInterfaceById">
6829 <desc>
6830 Searches through all host network interfaces for an interface with
6831 the given GUID.
6832 <note>
6833 The method returns an error if the given GUID does not
6834 correspond to any host network interface.
6835 </note>
6836 </desc>
6837 <param name="id" type="uuid" dir="in">
6838 <desc>GUID of the host network interface to search for.</desc>
6839 </param>
6840 <param name="networkInterface" type="IHostNetworkInterface" dir="return">
6841 <desc>Found host network interface object.</desc>
6842 </param>
6843 </method>
6844 <method name="findHostNetworkInterfacesOfType">
6845 <desc>
6846 Searches through all host network interfaces and returns a list of interfaces of the specified type
6847 </desc>
6848 <param name="type" type="HostNetworkInterfaceType" dir="in">
6849 <desc>type of the host network interfaces to search for.</desc>
6850 </param>
6851 <param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
6852 <desc>Found host network interface objects.</desc>
6853 </param>
6854 </method>
6855 </interface>
6856
6857 <!--
6858 // ISystemProperties
6859 /////////////////////////////////////////////////////////////////////////
6860 -->
6861
6862 <interface
6863 name="ISystemProperties"
6864 extends="$unknown"
6865 uuid="0760e03f-06d0-481e-9f81-be43fef092ba"
6866 wsmap="managed"
6867 >
6868 <desc>
6869 The ISystemProperties interface represents global properties of the given
6870 VirtualBox installation.
6871
6872 These properties define limits and default values for various attributes
6873 and parameters. Most of the properties are read-only, but some can be
6874 changed by a user.
6875 </desc>
6876
6877 <attribute name="minGuestRAM" type="unsigned long" readonly="yes">
6878 <desc>Minimum guest system memory in Megabytes.</desc>
6879 </attribute>
6880
6881 <attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
6882 <desc>Maximum guest system memory in Megabytes.</desc>
6883 </attribute>
6884
6885 <attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
6886 <desc>Minimum guest video memory in Megabytes.</desc>
6887 </attribute>
6888
6889 <attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
6890 <desc>Maximum guest video memory in Megabytes.</desc>
6891 </attribute>
6892
6893 <attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
6894 <desc>Minimum CPU count.</desc>
6895 </attribute>
6896
6897 <attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
6898 <desc>Maximum CPU count.</desc>
6899 </attribute>
6900
6901 <attribute name="maxVDISize" type="unsigned long long" readonly="yes">
6902 <desc>Maximum size of a virtual disk image in Megabytes.</desc>
6903 </attribute>
6904
6905 <attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
6906 <desc>
6907 Number of network adapters associated with every
6908 <link to="IMachine"/> instance.
6909 </desc>
6910 </attribute>
6911
6912 <attribute name="serialPortCount" type="unsigned long" readonly="yes">
6913 <desc>
6914 Number of serial ports associated with every
6915 <link to="IMachine"/> instance.
6916 </desc>
6917 </attribute>
6918
6919 <attribute name="parallelPortCount" type="unsigned long" readonly="yes">
6920 <desc>
6921 Number of parallel ports associated with every
6922 <link to="IMachine"/> instance.
6923 </desc>
6924 </attribute>
6925
6926 <attribute name="maxBootPosition" type="unsigned long" readonly="yes">
6927 <desc>
6928 Maximum device position in the boot order. This value corresponds
6929 to the total number of devices a machine can boot from, to make it
6930 possible to include all possible devices to the boot list.
6931 <see><link to="IMachine::setBootOrder"/></see>
6932 </desc>
6933 </attribute>
6934
6935 <attribute name="defaultMachineFolder" type="wstring">
6936 <desc>
6937 Full path to the default directory used to create new or open
6938 existing machines when a settings file name contains no
6939 path.
6940
6941 The initial value of this property is
6942 <tt>&lt;</tt><link to="IVirtualBox::homeFolder">
6943 VirtualBox_home</link><tt>&gt;/Machines</tt>.
6944
6945 <note>
6946 Setting this property to <tt>null</tt> will restore the
6947 initial value.
6948 </note>
6949 <note>
6950 When settings this property, the specified path can be
6951 absolute (full path) or relative
6952 to the <link to="IVirtualBox::homeFolder">
6953 VirtualBox home directory</link>.
6954 When reading this property, a full path is
6955 always returned.
6956 </note>
6957 <note>
6958 The specified path may not exist, it will be created
6959 when necessary.
6960 </note>
6961
6962 <see>
6963 <link to="IVirtualBox::createMachine"/>,
6964 <link to="IVirtualBox::openMachine"/>
6965 </see>
6966 </desc>
6967 </attribute>
6968
6969 <attribute name="defaultHardDiskFolder" type="wstring">
6970 <desc>
6971 Full path to the default directory used to create new or open existing
6972 virtual disks.
6973
6974 This path is used when the storage unit of a hard disk is a regular file
6975 in the host's file system and only a file name that contains no path is
6976 given.
6977
6978 The initial value of this property is
6979 <tt>&lt;</tt>
6980 <link to="IVirtualBox::homeFolder">VirtualBox_home</link>
6981 <tt>&gt;/HardDisks</tt>.
6982
6983 <note>
6984 Setting this property to <tt>null</tt> will restore the
6985 initial value.
6986 </note>
6987 <note>
6988 When settings this property, the specified path can be relative
6989 to the
6990 <link to="IVirtualBox::homeFolder">VirtualBox home directory</link> or
6991 absolute. When reading this property, a full path is
6992 always returned.
6993 </note>
6994 <note>
6995 The specified path may not exist, it will be created
6996 when necessary.
6997 </note>
6998
6999 <see>
7000 IHardDisk,
7001 <link to="IVirtualBox::createHardDisk"/>,
7002 <link to="IVirtualBox::openHardDisk"/>,
7003 <link to="IMedium::location"/>
7004 </see>
7005 </desc>
7006 </attribute>
7007
7008 <attribute name="hardDiskFormats" type="IHardDiskFormat" safearray="yes" readonly="yes">
7009 <desc>
7010 List of all hard disk storage formats supported by this VirtualBox
7011 installation.
7012
7013 Keep in mind that the hard disk format identifier
7014 (<link to="IHardDiskFormat::id"/>) used in other API calls like
7015 <link to="IVirtualBox::createHardDisk"/> to refer to a particular
7016 hard disk format is a case-insensitive string. This means that, for
7017 example, all of the following strings:
7018 <pre>
7019 "VDI"
7020 "vdi"
7021 "VdI"</pre>
7022 refer to the same hard disk format.
7023
7024 Note that the virtual hard disk framework is backend-based, therefore
7025 the list of supported formats depends on what backends are currently
7026 installed.
7027
7028 <see>
7029 <link to="IHardDiskFormat"/>,
7030 </see>
7031 </desc>
7032 </attribute>
7033
7034 <attribute name="defaultHardDiskFormat" type="wstring">
7035 <desc>
7036 Identifier of the default hard disk format used by VirtualBox.
7037
7038 The hard disk format set by this attribute is used by VirtualBox
7039 when the hard disk format was not specified explicitly. One example is
7040 <link to="IVirtualBox::createHardDisk"/> with the <tt>null</tt>
7041 format argument. A more complex example is implicit creation of
7042 differencing hard disks when taking a snapshot of a virtual machine:
7043 this operation will try to use a format of the parent hard disk first
7044 and if this format does not support differencing hard disks the default
7045 format specified by this argument will be used.
7046
7047 The list of supported hard disk formats may be obtained by the
7048 <link to="#hardDiskFormats"/> call. Note that the default hard disk
7049 format must have a capability to create differencing hard disks;
7050 otherwise opeartions that create hard disks implicitly may fail
7051 unexpectedly.
7052
7053 The initial value of this property is <tt>VDI</tt> in the current
7054 version of the VirtualBox product, but may change in the future.
7055
7056 <note>
7057 Setting this property to <tt>null</tt> will restore the
7058 initial value.
7059 </note>
7060
7061 <see>
7062 <link to="#hardDiskFormats"/>,
7063 <link to="IHardDiskFormat::id"/>,
7064 <link to="IVirtualBox::createHardDisk"/>
7065 </see>
7066 </desc>
7067 </attribute>
7068
7069 <attribute name="remoteDisplayAuthLibrary" type="wstring">
7070 <desc>
7071 Library that provides authentication for VRDP clients. The library
7072 is used if a virtual machine's authentication type is set to "external"
7073 in the VM RemoteDisplay configuration.
7074
7075 The system library extension (".DLL" or ".so") must be omitted.
7076 A full path can be specified; if not, then the library must reside on the
7077 system's default library path.
7078
7079 The default value of this property is <tt>VRDPAuth</tt>. There is a library
7080 of that name in one of the default VirtualBox library directories.
7081
7082 For details about VirtualBox authentication libraries and how to implement
7083 them, please refer to the VirtualBox manual.
7084
7085 <note>
7086 Setting this property to <tt>null</tt> will restore the
7087 initial value.
7088 </note>
7089 </desc>
7090 </attribute>
7091
7092 <attribute name="webServiceAuthLibrary" type="wstring">
7093 <desc>
7094 Library that provides authentication for webservice clients. The library
7095 is used if a virtual machine's authentication type is set to "external"
7096 in the VM RemoteDisplay configuration and will be called from
7097 within the <link to="IWebsessionManager::logon" /> implementation.
7098
7099 As opposed to <link to="ISystemProperties::remoteDisplayAuthLibrary" />,
7100 there is no per-VM setting for this, as the webservice is a global
7101 resource (if it is running). Only for this setting (for the webservice),
7102 setting this value to a literal "null" string disables authentication,
7103 meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7104 no matter what user name and password are supplied.
7105
7106 The initial value of this property is <tt>VRDPAuth</tt>,
7107 meaning that the webservice will use the same authentication
7108 library that is used by default for VBoxVRDP (again, see
7109 <link to="ISystemProperties::remoteDisplayAuthLibrary" />).
7110 The format and calling convention of authentication libraries
7111 is the same for the webservice as it is for VBoxVRDP.
7112
7113 </desc>
7114 </attribute>
7115
7116 <attribute name="HWVirtExEnabled" type="boolean">
7117 <desc>
7118 This specifies the default value for hardware virtualization
7119 extensions. If enabled, virtual machines will make use of
7120 hardware virtualization extensions such as Intel VT-x and
7121 AMD-V by default. This value can be overridden by each VM
7122 using their <link to="IMachine::HWVirtExEnabled" /> property.
7123 </desc>
7124 </attribute>
7125
7126 <attribute name="LogHistoryCount" type="unsigned long">
7127 <desc>
7128 This value specifies how many old release log files are kept.
7129 </desc>
7130 </attribute>
7131 </interface>
7132
7133 <!--
7134 // IGuest
7135 /////////////////////////////////////////////////////////////////////////
7136 -->
7137
7138 <interface
7139 name="IGuestOSType" extends="$unknown"
7140 uuid="cfe9e64c-4430-435b-9e7c-e3d8e417bd58"
7141 wsmap="struct"
7142 >
7143 <desc>
7144 </desc>
7145
7146 <attribute name="familyId" type="wstring" readonly="yes">
7147 <desc>Guest OS family identifier string.</desc>
7148 </attribute>
7149
7150 <attribute name="familyDescription" type="wstring" readonly="yes">
7151 <desc>Human readable description of the guest OS family.</desc>
7152 </attribute>
7153
7154 <attribute name="id" type="wstring" readonly="yes">
7155 <desc>Guest OS identifier string.</desc>
7156 </attribute>
7157
7158 <attribute name="description" type="wstring" readonly="yes">
7159 <desc>Human readable description of the guest OS.</desc>
7160 </attribute>
7161
7162 <attribute name="is64Bit" type="boolean" readonly="yes">
7163 <desc>Returns @c true if the given OS is 64-bit</desc>
7164 </attribute>
7165
7166 <attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7167 <desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7168 </attribute>
7169
7170 <attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7171 <desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7172 </attribute>
7173
7174 <attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7175 <desc>Recommended RAM size in Megabytes.</desc>
7176 </attribute>
7177
7178 <attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7179 <desc>Recommended video RAM size in Megabytes.</desc>
7180 </attribute>
7181
7182 <attribute name="recommendedHDD" type="unsigned long" readonly="yes">
7183 <desc>Recommended hard disk size in Megabytes.</desc>
7184 </attribute>
7185
7186 <attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7187 <desc>Returns recommended network adapter for this OS type.</desc>
7188 </attribute>
7189 </interface>
7190
7191 <interface
7192 name="IGuest" extends="$unknown"
7193 uuid="d8556fca-81bc-12af-fca3-365528fa38ca"
7194
7195 wsmap="suppress"
7196 >
7197 <desc>
7198 The IGuest interface represents information about the operating system
7199 running inside the virtual machine. Used in
7200 <link to="IConsole::guest"/>.
7201
7202 IGuest provides information about the guest operating system, whether
7203 Guest Additions are installed and other OS-specific virtual machine
7204 properties.
7205 </desc>
7206
7207 <attribute name="OSTypeId" type="wstring" readonly="yes">
7208 <desc>
7209 Identifier of the Guest OS type as reported by the Guest
7210 Additions.
7211 You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
7212 an IGuestOSType object representing details about the given
7213 Guest OS type.
7214 <note>
7215 If Guest Additions are not installed, this value will be
7216 the same as <link to="IMachine::OSTypeId"/>.
7217 </note>
7218 </desc>
7219 </attribute>
7220
7221 <attribute name="additionsActive" type="boolean" readonly="yes">
7222 <desc>
7223 Flag whether the Guest Additions are installed and active
7224 in which case their version will be returned by the
7225 <link to="#additionsVersion"/> property.
7226 </desc>
7227 </attribute>
7228
7229 <attribute name="additionsVersion" type="wstring" readonly="yes">
7230 <desc>
7231 Version of the Guest Additions (3 decimal numbers separated
7232 by dots) or empty when the Additions are not installed. The
7233 Additions may also report a version but yet not be active as
7234 the version might be refused by VirtualBox (incompatible) or
7235 other failures occurred.
7236 </desc>
7237 </attribute>
7238
7239 <attribute name="supportsSeamless" type="boolean" readonly="yes">
7240 <desc>
7241 Flag whether seamless guest display rendering (seamless desktop
7242 integration) is supported.
7243 </desc>
7244 </attribute>
7245
7246 <attribute name="supportsGraphics" type="boolean" readonly="yes">
7247 <desc>
7248 Flag whether the guest is in graphics mode. If it is not, then
7249 seamless rendering will not work, resize hints are not immediately
7250 acted on and guest display resizes are probably not initiated by
7251 the guest additions.
7252 </desc>
7253 </attribute>
7254
7255 <attribute name="memoryBalloonSize" type="unsigned long">
7256 <desc>Guest system memory balloon size in megabytes.</desc>
7257 </attribute>
7258
7259 <attribute name="statisticsUpdateInterval" type="unsigned long">
7260 <desc>Interval to update guest statistics in seconds.</desc>
7261 </attribute>
7262
7263 <method name="setCredentials">
7264 <desc>
7265 Store login credentials that can be queried by guest operating
7266 systems with Additions installed. The credentials are transient
7267 to the session and the guest may also choose to erase them. Note
7268 that the caller cannot determine whether the guest operating system
7269 has queried or made use of the credentials.
7270
7271 <result name="VBOX_E_VM_ERROR">
7272 VMM device is not available.
7273 </result>
7274
7275 </desc>
7276 <param name="userName" type="wstring" dir="in">
7277 <desc>User name string, can be empty</desc>
7278 </param>
7279 <param name="password" type="wstring" dir="in">
7280 <desc>Password string, can be empty</desc>
7281 </param>
7282 <param name="domain" type="wstring" dir="in">
7283 <desc>Domain name (guest logon scheme specific), can be empty</desc>
7284 </param>
7285 <param name="allowInteractiveLogon" type="boolean" dir="in">
7286 <desc>
7287 Flag whether the guest should alternatively allow the user to
7288 interactively specify different credentials. This flag might
7289 not be supported by all versions of the Additions.
7290 </desc>
7291 </param>
7292 </method>
7293
7294 <method name="getStatistic">
7295 <desc>
7296 Query specified guest statistics as reported by the VirtualBox Additions.
7297 </desc>
7298 <param name="cpuId" type="unsigned long" dir="in">
7299 <desc>Virtual CPU id; not relevant for all statistic types</desc>
7300 </param>
7301 <param name="statistic" type="GuestStatisticType" dir="in">
7302 <desc>Statistic type.</desc>
7303 </param>
7304 <param name="statVal" type="unsigned long" dir="out">
7305 <desc>Statistics value</desc>
7306 </param>
7307 </method>
7308
7309 </interface>
7310
7311
7312 <!--
7313 // IProgress
7314 /////////////////////////////////////////////////////////////////////////
7315 -->
7316
7317 <interface
7318 name="IProgress" extends="$unknown"
7319 uuid="d3aa5417-6103-41fc-9e54-01ee1d08f42f"
7320 wsmap="managed"
7321 >
7322 <desc>
7323 The IProgress interface represents a task progress object that allows
7324 to wait for the completion of some asynchronous task.
7325
7326 The task consists of one or more operations that run sequentially,
7327 one by one. There is an individual percentage of completion of the
7328 current operation and the percentage of completion of the task as a
7329 whole. Similarly, you can wait for the completion of a particular
7330 operation or for the completion of the whole task.
7331
7332 Every operation is identified by a number (starting from 0)
7333 and has a separate description.
7334 </desc>
7335
7336 <attribute name="id" type="uuid" readonly="yes">
7337 <desc>ID of the task.</desc>
7338 </attribute>
7339
7340 <attribute name="description" type="wstring" readonly="yes">
7341 <desc>Description of the task.</desc>
7342 </attribute>
7343
7344 <attribute name="initiator" type="$unknown" readonly="yes">
7345 <desc>Initiator of the task.</desc>
7346 </attribute>
7347
7348 <attribute name="cancelable" type="boolean" readonly="yes">
7349 <desc>Whether the task can be interrupted.</desc>
7350 </attribute>
7351
7352 <attribute name="percent" type="long" readonly="yes">
7353 <desc>
7354 Current task progress value in percent.
7355 This value depends on how many operations are already complete.
7356 </desc>
7357 </attribute>
7358
7359 <attribute name="completed" type="boolean" readonly="yes">
7360 <desc>Whether the task has been completed.</desc>
7361 </attribute>
7362
7363 <attribute name="canceled" type="boolean" readonly="yes">
7364 <desc>Whether the task has been canceled.</desc>
7365 </attribute>
7366
7367 <attribute name="resultCode" type="result" readonly="yes">
7368 <desc>
7369 Result code of the progress task.
7370 Valid only if <link to="#completed"/> is true.
7371 </desc>
7372 </attribute>
7373
7374 <attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
7375 <desc>
7376 Extended information about the unsuccessful result of the
7377 progress operation. May be NULL when no extended information
7378 is available.
7379 Valid only if <link to="#completed"/> is true and
7380 <link to="#resultCode"/> indicates a failure.
7381 </desc>
7382 </attribute>
7383
7384 <attribute name="operationCount" type="unsigned long" readonly="yes">
7385 <desc>
7386 Number of operations this task is divided into.
7387 Every task consists of at least one operation.
7388 </desc>
7389 </attribute>
7390
7391 <attribute name="operation" type="unsigned long" readonly="yes">
7392 <desc>Number of the operation being currently executed.</desc>
7393 </attribute>
7394
7395 <attribute name="operationDescription" type="wstring" readonly="yes">
7396 <desc>
7397 Description of the operation being currently executed.
7398 </desc>
7399 </attribute>
7400
7401 <attribute name="operationPercent" type="long" readonly="yes">
7402 <desc>Current operation progress value in percent.</desc>
7403 </attribute>
7404
7405 <method name="waitForCompletion">
7406 <desc>
7407 Waits until the task is done (including all operations) with a
7408 given timeout.
7409
7410 <result name="VBOX_E_IPRT_ERROR">
7411 Failed to wait for task completion.
7412 </result>
7413
7414 </desc>
7415 <param name="timeout" type="long" dir="in">
7416 <desc>
7417 Timeout value in milliseconds.
7418 Specify -1 for an indefinite wait.
7419 </desc>
7420 </param>
7421 </method>
7422
7423 <method name="waitForOperationCompletion">
7424 <desc>
7425 Waits until the given operation is done with a given timeout.
7426
7427 <result name="VBOX_E_IPRT_ERROR">
7428 Failed to wait for operation completion.
7429 </result>
7430
7431 </desc>
7432 <param name="operation" type="unsigned long" dir="in">
7433 <desc>
7434 Number of the operation to wait for.
7435 Must be less than <link to="#operationCount"/>.
7436 </desc>
7437 </param>
7438 <param name="timeout" type="long" dir="in">
7439 <desc>
7440 Timeout value in milliseconds.
7441 Specify -1 for an indefinite wait.
7442 </desc>
7443 </param>
7444 </method>
7445
7446 <method name="cancel">
7447 <desc>
7448 Cancels the task.
7449 <note>
7450 If <link to="#cancelable"/> is <tt>false</tt>, then
7451 this method will fail.
7452 </note>
7453
7454 <result name="VBOX_E_INVALID_OBJECT_STATE">
7455 Operation cannot be canceled.
7456 </result>
7457
7458 </desc>
7459 </method>
7460
7461 </interface>
7462
7463
7464 <!--
7465 // ISnapshot
7466 /////////////////////////////////////////////////////////////////////////
7467 -->
7468
7469 <interface
7470 name="ISnapshot" extends="$unknown"
7471 uuid="5db6b1d9-c76b-4424-a6f4-8257f642d6ea"
7472 wsmap="managed"
7473 >
7474 <desc>
7475 The ISnapshot interface represents a snapshot of the virtual
7476 machine.
7477
7478 The <i>snapshot</i> stores all the information about a virtual
7479 machine necessary to bring it to exactly the same state as it was at
7480 the time of taking the snapshot. The snapshot includes:
7481
7482 <ul>
7483 <li>all settings of the virtual machine (i.e. its hardware
7484 configuration: RAM size, attached hard disks, etc.)
7485 </li>
7486 <li>the execution state of the virtual machine (memory contents,
7487 CPU state, etc.).
7488 </li>
7489 </ul>
7490
7491 Snapshots can be <i>offline</i> (taken when the VM is powered off)
7492 or <i>online</i> (taken when the VM is running). The execution
7493 state of the offline snapshot is called a <i>zero execution state</i>
7494 (it doesn't actually contain any information about memory contents
7495 or the CPU state, assuming that all hardware is just powered off).
7496
7497 <h3>Snapshot branches</h3>
7498
7499 Snapshots can be chained. Chained snapshots form a branch where
7500 every next snapshot is based on the previous one. This chaining is
7501 mostly related to hard disk branching (see <link to="IHardDisk"/>
7502 description). This means that every time a new snapshot is created,
7503 a new differencing hard disk is implicitly created for all normal
7504 hard disks attached to the given virtual machine. This allows to
7505 fully restore hard disk contents when the machine is later reverted
7506 to a particular snapshot.
7507
7508 In the current implementation, multiple snapshot branches within one
7509 virtual machine are not allowed. Every machine has a single branch,
7510 and <link to="IConsole::takeSnapshot"/> operation adds a new
7511 snapshot to the top of that branch.
7512
7513 Existing snapshots can be discarded using
7514 <link to="IConsole::discardSnapshot"/>.
7515
7516 <h3>Current snapshot</h3>
7517
7518 Every virtual machine has a current snapshot, identified by
7519 <link to="IMachine::currentSnapshot"/>. This snapshot is used as
7520 a base for the <i>current machine state</i> (see below), to the effect
7521 that all normal hard disks of the machine and its execution
7522 state are based on this snapshot.
7523
7524 In the current implementation, the current snapshot is always the
7525 last taken snapshot (i.e. the head snapshot on the branch) and it
7526 cannot be changed.
7527
7528 The current snapshot is <tt>null</tt> if the machine doesn't have
7529 snapshots at all; in this case the current machine state is just
7530 current settings of this machine plus its current execution state.
7531
7532 <h3>Current machine state</h3>
7533
7534 The current machine state is what represented by IMachine instances got
7535 directly from IVirtualBox
7536 using <link
7537 to="IVirtualBox::getMachine">getMachine()</link>, <link
7538 to="IVirtualBox::findMachine">findMachine()</link>, etc. (as opposed
7539 to instances returned by <link to="ISnapshot::machine"/>). This state
7540 is always used when the machine is <link to="IConsole::powerUp"> powered
7541 on</link>.
7542
7543 The current machine state also includes the current execution state.
7544 If the machine is being currently executed
7545 (<link to="IMachine::state"/> is <link to="MachineState_Running"/>
7546 and above), its execution state is just what's happening now.
7547 If it is powered off (<link to="MachineState_PoweredOff"/> or
7548 <link to="MachineState_Aborted"/>), it has a zero execution state.
7549 If the machine is saved (<link to="MachineState_Saved"/>), its
7550 execution state is what saved in the execution state file
7551 (<link to="IMachine::stateFilePath"/>).
7552
7553 If the machine is in the saved state, then, next time it is powered
7554 on, its execution state will be fully restored from the saved state
7555 file and the execution will continue from the point where the state
7556 was saved.
7557
7558 Similarly to snapshots, the current machine state can be discarded
7559 using <link to="IConsole::discardCurrentState"/>.
7560
7561 <h3>Taking and discarding snapshots</h3>
7562
7563 The table below briefly explains the meaning of every snapshot
7564 operation:
7565
7566 <table>
7567 <tr><th>Operation</th><th>Meaning</th><th>Remarks</th></tr>
7568
7569 <tr><td><link to="IConsole::takeSnapshot"/></td>
7570
7571 <td>Save the current state of the virtual machine, including all
7572 settings, contents of normal hard disks and the current modifications
7573 to immutable hard disks (for online snapshots)</td>
7574
7575 <td>The current state is not changed (the machine will continue
7576 execution if it is being executed when the snapshot is
7577 taken)</td></tr>
7578
7579 <tr><td><link to="IConsole::discardSnapshot"/></td>
7580
7581 <td>Forget the state of the virtual machine stored in the snapshot:
7582 dismiss all saved settings and delete the saved execution state (for
7583 online snapshots)</td>
7584
7585 <td>Other snapshots (including child snapshots, if any) and the
7586 current state are not directly affected</td></tr>
7587
7588 <tr><td><link to="IConsole::discardCurrentState"/></td>
7589
7590 <td>Restore the current state of the virtual machine from the state
7591 stored in the current snapshot, including all settings and hard disk
7592 contents</td>
7593
7594 <td>The current state of the machine existed prior to this operation
7595 is lost</td></tr>
7596
7597 <tr><td><link to="IConsole::discardCurrentSnapshotAndState"/></td>
7598
7599 <td>Completely revert the virtual machine to the state it was in
7600 before the current snapshot has been taken</td>
7601
7602 <td>The current state, as well as the current snapshot, are
7603 lost</td></tr>
7604
7605 </table>
7606
7607 </desc>
7608
7609 <attribute name="id" type="uuid" readonly="yes">
7610 <desc>UUID of the snapshot.</desc>
7611 </attribute>
7612
7613 <attribute name="name" type="wstring">
7614 <desc>Short name of the snapshot.</desc>
7615 </attribute>
7616
7617 <attribute name="description" type="wstring">
7618 <desc>Optional description of the snapshot.</desc>
7619 </attribute>
7620
7621 <attribute name="timeStamp" type="long long" readonly="yes">
7622 <desc>
7623 Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
7624 </desc>
7625 </attribute>
7626
7627 <attribute name="online" type="boolean" readonly="yes">
7628 <desc>
7629 <tt>true</tt> if this snapshot is an online snapshot and
7630 <tt>false</tt> otherwise.
7631
7632 <note>
7633 When this attribute is <tt>true</tt>, the
7634 <link to="IMachine::stateFilePath"/> attribute of the
7635 <link to="#machine"/> object associated with this snapshot
7636 will point to the saved state file. Otherwise, it will be
7637 <tt>null</tt>.
7638 </note>
7639 </desc>
7640 </attribute>
7641
7642 <attribute name="machine" type="IMachine" readonly="yes">
7643 <desc>
7644 Virtual machine this snapshot is taken on. This object
7645 stores all settings the machine had when taking this snapshot.
7646 <note>
7647 The returned machine object is immutable, i.e. no
7648 any settings can be changed.
7649 </note>
7650 </desc>
7651 </attribute>
7652
7653 <attribute name="parent" type="ISnapshot" readonly="yes">
7654 <desc>
7655 Parent snapshot (a snapshot this one is based on).
7656 <note>
7657 It's not an error to read this attribute on a snapshot
7658 that doesn't have a parent -- a null object will be
7659 returned to indicate this.
7660 </note>
7661 </desc>
7662 </attribute>
7663
7664 <attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
7665 <desc>
7666 Child snapshots (all snapshots having this one as a parent).
7667 <note>
7668 In the current implementation, there can be only one
7669 child snapshot, or no children at all, meaning this is the
7670 last (head) snapshot.
7671 </note>
7672 </desc>
7673 </attribute>
7674
7675 </interface>
7676
7677
7678 <!--
7679 // IMedia
7680 /////////////////////////////////////////////////////////////////////////
7681 -->
7682
7683 <enum
7684 name="MediaState"
7685 uuid="8b86e03c-2f1c-412a-8fbd-326f62701200"
7686 >
7687 <desc>
7688 Virtual media state.
7689 <see>IMedia</see>
7690 </desc>
7691
7692 <const name="NotCreated" value="0">
7693 <desc>
7694 Associated media storage does not exist (either was not created yet or
7695 was deleted).
7696 </desc>
7697 </const>
7698 <const name="Created" value="1">
7699 <desc>
7700 Associated storage exists and accessible.
7701 </desc>
7702 </const>
7703 <const name="LockedRead" value="2">
7704 <desc>
7705 Media is locked for reading, no data modification is possible.
7706 </desc>
7707 </const>
7708 <const name="LockedWrite" value="3">
7709 <desc>
7710 Media is locked for writing, no concurrent data reading or modification
7711 is possible.
7712 </desc>
7713 </const>
7714 <const name="Inaccessible" value="4">
7715 <desc>
7716 Associated media storage is not accessible.
7717 </desc>
7718 </const>
7719 <const name="Creating" value="5">
7720 <desc>
7721 Associated media storage is being created.
7722 </desc>
7723 </const>
7724 <const name="Deleting" value="6">
7725 <desc>
7726 Associated media storage is being deleted.
7727 </desc>
7728 </const>
7729 </enum>
7730
7731 <interface
7732 name="IMedium" extends="$unknown"
7733 uuid="a7fb3bfb-c180-4274-bae4-7fbc89046e13"
7734 wsmap="managed"
7735 >
7736 <desc>
7737 The IMedium interface is a common interface for all objects representing
7738 virtual media such as hard disks, DVD images.
7739
7740 Each medium is associated with a storage unit (such as a file on the host
7741 computer or a network resource) that holds actual data. The location of
7742 the storage unit is represented by the #location attribute. The value of
7743 this attribute is media type dependent.
7744
7745 The exact media type may be determined by querying the appropriate
7746 interface such as:
7747 <ul>
7748 <li>IHardDisk (virtual hard disks)</li>
7749 <li>IDVDImage (standard CD/DVD ISO image files)</li>
7750 <li>IFloppyImage (raw floppy image files)</li>
7751 </ul>
7752
7753 Existing media are opened using the following methods, depending on the
7754 media type:
7755 <ul>
7756 <li><link to="IVirtualBox::openHardDisk"/></li>
7757 <li><link to="IVirtualBox::openDVDImage"/></li>
7758 <li><link to="IVirtualBox::openFloppyImage"/></li>
7759 </ul>
7760
7761 New hard disk media are created using the
7762 <link to="IVirtualBox::createHardDisk"/> method. CD/DVD and floppy
7763 images are created outside VirtualBox, usually by storing a copy
7764 of the real medium of the corresponding type in a regular file.
7765
7766 <h3>Known Media</h3>
7767
7768 When an existing medium gets opened for the first time, it gets
7769 automatically remembered by the given VirtualBox installation or, in other
7770 words, becomes a <i>known medium</i>. Known media are stored in the media
7771 registry transparently maintained by VirtualBox and stored in settings
7772 files so that this registry is preserved when VirtualBox is not running.
7773
7774 Newly created virtual hard disks get remembered only when the associated
7775 storage unit is actually created (see IHardDisk for more details).
7776
7777 All known media can be enumerated using
7778 <link to="IVirtualBox::hardDisks"/>,
7779 <link to="IVirtualBox::DVDImages"/> and
7780 <link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
7781 quickly found by UUID using <link to="IVirtualBox::getHardDisk"/>
7782 and similar methods or by location using
7783 <link to="IVirtualBox::findHardDisk"/> and similar methods.
7784
7785 Only known media can be attached to virtual machines.
7786
7787 Removing known media from the media registry is performed when the given
7788 medium is closed using the <link to="#close"/> method or when its
7789 associated storage unit is deleted (only for hard disks).
7790
7791 <h3>Accessibility Checks</h3>
7792
7793 The given medium (with the created storage unit) is considered to be
7794 <i>accessible</i> when its storage unit can be successfully read from.
7795 Accessible media are indicated by the <link to="MediaState_Created"/>
7796 value of the <link to="#state"/> attribute. When the storage unit cannot
7797 be read (for example, because it is located on a disconnected network
7798 resource, or was accidentally deleted outside VirtualBox), the medium is
7799 considered to be <i>inaccessible</i> which is indicated by the
7800 <link to="MediaState_Inaccessible"/> state. The details about the reason
7801 of being inaccessible can be obtained using the
7802 <link to="#lastAccessError"/> attribute.
7803
7804 A new accessibility check is performed each time the <link to="#state"/>
7805 attribute is read. Please note that this check may take long time (several
7806 seconds or even minutes, depending on the storage unit location and
7807 format), and will block the calling thread until finished. For this
7808 reason, it is recommended to never read this attribute on the main UI
7809 thread to avoid making the UI unresponsive.
7810
7811 Note that when VirtualBox starts up (e.g. the VirtualBox object gets
7812 created for the first time), all known media are in the
7813 <link to="MediaState_Inaccessible"/> state but the value of the <link
7814 to="#lastAccessError"/> attribute is <tt>null</tt> because no actual
7815 accessibility check is made on startup. This is done to make the
7816 VirtualBox object ready for serving requests as
7817 fast as possible and let the end-user application decide if it needs to
7818 check media accessibility right away or not.
7819 </desc>
7820
7821 <attribute name="id" type="uuid" readonly="yes">
7822 <desc>
7823 UUID of the medium. For a newly created medium, this value is a randomly
7824 generated UUID.
7825
7826 <note>
7827 For media in one of MediaState_NotCreated, MediaState_Creating or
7828 MediaState_Deleting states, the value of this property is undefined
7829 and will most likely be an empty UUID.
7830 </note>
7831 </desc>
7832 </attribute>
7833
7834 <attribute name="description" type="wstring">
7835 <desc>
7836 Optional description of the medium. For newly created media, the value
7837 of this attribute value is <tt>null</tt>.
7838
7839 Media types that don't support this attribute will return E_NOTIMPL in
7840 attempt to get or set this attribute's value.
7841
7842 <note>
7843 For some storage types, reading this attribute may return an outdated
7844 (last known) value when <link to="#state"/> is <link
7845 to="MediaState_Inaccessible"/> or <link
7846 to="MediaState_LockedWrite"/> because the value of this attribute is
7847 stored within the storage unit itself. Also note that changing the
7848 attribute value is not possible in such case, as well as when the
7849 medium is the <link to="MediaState_LockedRead"/> state.
7850 </note>
7851 </desc>
7852 </attribute>
7853
7854 <attribute name="state" type="MediaState" readonly="yes">
7855 <desc>
7856 Current media state. Inspect <link to="MediaState"/> values for details.
7857
7858 Reading this attribute may take long time because a new accessibility
7859 check of the storage unit is performed every time the attribute is read.
7860 This check may cause a significant delay if the storage unit of the
7861 given medium is, for example, a file located on a network share which is
7862 not currently accessible due to connectivity problems -- the call will
7863 not return until a timeout interval defined by the host OS for this
7864 operation expires.
7865
7866 If the last known state of the medium is <link to="MediaState_Created"/>
7867 and the accessibility check fails then the state would be set to
7868 <link to="MediaState_Inaccessible"/> and <link to="#lastAccessError"/>
7869 may be used to get more details about the failure. If the state of the
7870 medium is <link to="MediaState_LockedRead"/> or
7871 <link to="MediaState_LockedWrite"/> then it remains the same, and a
7872 non-null value of <link to="#lastAccessError"/> will indicate a failed
7873 accessibility check in this case.
7874
7875 Note that not all media states are applicable to certain media types.
7876 For example, states <link to="MediaState_NotCreated"/>,
7877 <link to="MediaState_LockedWrite"/>, <link to="MediaState_Creating"/>,
7878 <link to="MediaState_Deleting"/> are meaningless for IDVDImage and
7879 IFloppyImage media.
7880 </desc>
7881 </attribute>
7882
7883 <attribute name="location" type="wstring">
7884 <desc>
7885 Location of the storage unit holding media data.
7886
7887 The format of the location string is media type specific. For media
7888 types that use regular files in a host's file system, the location
7889 string is just a full file name.
7890
7891 Some media types may support changing the storage unit location by
7892 simply changing the value of this property. If this operation is not
7893 supported, the implementation will return E_NOTIMPL in attempt to set
7894 this attribute's value.
7895
7896 When setting a value of the location attribute which is a regular file
7897 in the host's file system, the given file name may be either relative to
7898 the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
7899 absolute. Note that if the given location specification does not contain
7900 the file extension part then a proper default extension will be
7901 automatically appended by the implementation depending on the media type.
7902 </desc>
7903 </attribute>
7904
7905 <attribute name="name" type="wstring" readonly="yes">
7906 <desc>
7907 Name of the storage unit holding media data.
7908
7909 The returned string is a short version of the <link to="#location"/>
7910 attribute that is suitable for representing the medium in situations
7911 where the full location specification is too long (such as lists
7912 and comboboxes in GUI frontends). This string is also used by frontends
7913 to sort the media list alphabetically when needed.
7914
7915 For example, for locations that are regular files in the host's file
7916 system, the value of this attribute is just a file name (+ extension),
7917 without the path specification.
7918
7919 Note that as opposed to the <link to="#location"/> attribute, the name
7920 attribute will not necessary be unique for a list of media of the
7921 given type and format.
7922 </desc>
7923 </attribute>
7924
7925 <attribute name="size" type="unsigned long long" readonly="yes">
7926 <desc>
7927 Physical size of the storage unit used to hold media data (in bytes).
7928
7929 <note>
7930 For media whose <link to="#state"/> is <link
7931 to="MediaState_Inaccessible"/>, the value of this property is the
7932 last known size. For <link to="MediaState_NotCreated"/> media,
7933 the returned value is zero.
7934 </note>
7935 </desc>
7936 </attribute>
7937
7938 <attribute name="lastAccessError" type="wstring" readonly="yes">
7939 <desc>
7940 Text message that represents the result of the last accessibility
7941 check.
7942
7943 Accessibility checks are performed each time the <link to="#state"/>
7944 attribute is read. A @c null string is returned if the last
7945 accessibility check was successful. A non-null string indicates a
7946 failure and should normally describe a reason of the failure (for
7947 example, a file read error).
7948 </desc>
7949 </attribute>
7950
7951 <attribute name="machineIds" type="uuid" safearray="yes" readonly="yes">
7952 <desc>
7953 Array of UUIDs of all machines this medium is attached to.
7954
7955 A <tt>null</tt> array is returned if this medium is not attached to any
7956 machine or to any machine's snapshot.
7957
7958 <note>
7959 The returned array will include a machine even if this medium is not
7960 attached to that machine in the current state but attached to it in
7961 one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
7962 details.
7963 </note>
7964 </desc>
7965 </attribute>
7966
7967 <method name="getSnapshotIds">
7968 <desc>
7969 Returns an array of UUIDs of all snapshots of the given machine where
7970 this medium is attached to it.
7971
7972 If the medium is attached to the machine in the current state, then the
7973 first element in the array will always be the ID of the queried machine
7974 (i.e. the value equal to the @c machineId argument), followed by
7975 snapshot IDs (if any).
7976
7977 If the medium is not attached to the machine in the current state, then
7978 the array will contain only snapshot IDs.
7979
7980 The returned array may be <tt>null</tt> if this medium is not attached
7981 to the given machine at all, neither in the current state nor in one of
7982 snapshots.
7983 </desc>
7984 <param name="machineId" type="uuid" dir="in">
7985 <desc>
7986 UUID of the machine to query.
7987 </desc>
7988 </param>
7989 <param name="snapshotIds" type="uuid" safearray="yes" dir="return">
7990 <desc>
7991 Array of snapshot UUIDs of the given machine using this medium.
7992 </desc>
7993 </param>
7994 </method>
7995
7996 <method name="lockRead">
7997 <desc>
7998 Locks this medium for reading.
7999
8000 The read lock is shared: many clients can simultaneously lock the
8001 same media for reading unless it is already locked for writing (see
8002 <link to="#lockWrite"/>) in which case an error is returned.
8003
8004 When the medium is locked for reading, it cannot be modified
8005 from within VirtualBox. This means that any method that changes
8006 the properties of this medium or contents of the storage unit
8007 will return an error (unless explicitly stated otherwise) and
8008 that an attempt to start a virtual machine that wants to modify
8009 the medium will also fail.
8010
8011 When the virtual machine is started up, it locks for reading all
8012 media it uses in read-only mode. If some media cannot be locked
8013 for reading, the startup procedure will fail.
8014
8015 The medium locked for reading must be unlocked using the <link
8016 to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
8017 can be nested and must be followed by the same number of paired
8018 <link to="#unlockRead"/> calls.
8019
8020 This method sets the media state to <link
8021 to="MediaState_LockedRead"/> on success. The state prior to
8022 this call must be <link to="MediaState_Created"/>, <link
8023 to="MediaState_Inaccessible"/> or <link
8024 to="MediaState_LockedRead"/>. As you can see, inaccessible
8025 media can be locked too. This is not an error; this method
8026 performs a logical lock that prevents modifications of this
8027 media through the VirtualBox API, not a physical lock of the
8028 underlying storage unit.
8029
8030 This method returns the current state of the medium
8031 <b>before</b> the operation.
8032
8033 <result name="VBOX_E_INVALID_OBJECT_STATE">
8034 Invalid media state (e.g. not created, locked, inaccessible,
8035 creating, deleting).
8036 </result>
8037
8038 </desc>
8039 <param name="state" type="MediaState" dir="return">
8040 <desc>
8041 State of the medium after the operation.
8042 </desc>
8043 </param>
8044 </method>
8045
8046 <method name="unlockRead">
8047 <desc>
8048 Cancels the read lock previously set by <link to="#lockRead"/>.
8049
8050 Either on success or on failure, this method returns the current state
8051 of the medium <b>after</b> the operation.
8052
8053 See <link to="#lockRead"/> for more details.
8054
8055 <result name="VBOX_E_INVALID_OBJECT_STATE">
8056 Medium not locked for reading.
8057 </result>
8058
8059 </desc>
8060 <param name="state" type="MediaState" dir="return">
8061 <desc>
8062 State of the medium after the operation.
8063 </desc>
8064 </param>
8065 </method>
8066
8067 <method name="lockWrite">
8068 <desc>
8069 Locks this medium for writing.
8070
8071 The write lock, as opposed to <link to="#lockRead"/>, is
8072 exclusive: there may be only one client that holds a write lock
8073 and there may be no read locks while the write lock is held.
8074
8075 When the medium is locked for writing, it cannot be modified
8076 from within VirtualBox and it is not guaranteed that the values
8077 of its properties are up-to-date. Any method that changes the
8078 properties of this medium or contents of the storage unit will
8079 return an error ((unless explicitly stated otherwise) and an
8080 attempt to start a virtual machine that wants to modify or to
8081 read the medium will also fail.
8082
8083 When the virtual machine is started up, it locks for writing all
8084 media it uses to write data to. If some media cannot be locked
8085 for writing, the startup procedure will fail.
8086
8087 The medium locked for writing must be unlocked using the <link
8088 to="#unlockWrite"/> method. Calls to <link to="#lockWrite"/>
8089 can <b>not</b> be nested and must be followed by a paired <link
8090 to="#unlockWrite"/> call.
8091
8092 This method sets the media state to <link
8093 to="MediaState_LockedWrite"/> on success. The state prior to
8094 this call must be <link to="MediaState_Created"/> or <link
8095 to="MediaState_Inaccessible"/>. As you can see, inaccessible
8096 media can be locked too. This is not an error; this method
8097 performs a logical lock that prevents modifications of this
8098 media through the VirtualBox API, not a physical lock of the
8099 underlying storage unit.
8100
8101 Either on success or on failure, this method returns the current
8102 state of the medium <b>before</b> the operation.
8103
8104 <result name="VBOX_E_INVALID_OBJECT_STATE">
8105 Invalid media state (e.g. not created, locked, inaccessible,
8106 creating, deleting).
8107 </result>
8108
8109 </desc>
8110 <param name="state" type="MediaState" dir="return">
8111 <desc>
8112 State of the medium after the operation.
8113 </desc>
8114 </param>
8115 </method>
8116
8117 <method name="unlockWrite">
8118 <desc>
8119 Cancels the write lock previously set by <link to="#lockWrite"/>.
8120
8121 Either on success or on failure, this method returns the current
8122 state of the medium <b>after</b> the operation.
8123
8124 See <link to="#lockWrite"/> for more details.
8125
8126 <result name="VBOX_E_INVALID_OBJECT_STATE">
8127 Medium not locked for writing.
8128 </result>
8129
8130 </desc>
8131 <param name="state" type="MediaState" dir="return">
8132 <desc>
8133 State of the medium after the operation.
8134 </desc>
8135 </param>
8136 </method>
8137
8138 <method name="close">
8139 <desc>
8140 Closes this medium.
8141
8142 The hard disk must not be attached to any known virtual machine
8143 and must not have any known child hard disks, otherwise the
8144 operation will fail.
8145
8146 When the hard disk is successfully closed, it gets removed from
8147 the list of remembered hard disks, but its storage unit is not
8148 deleted. In particular, this means that this hard disk can be
8149 later opened again using the <link
8150 to="IVirtualBox::openHardDisk"/> call.
8151
8152 Note that after this method successfully returns, the given hard
8153 disk object becomes uninitialized. This means that any attempt
8154 to call any of its methods or attributes will fail with the
8155 <tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
8156
8157 <result name="VBOX_E_INVALID_OBJECT_STATE">
8158 Invalid media state (other than not created, created or
8159 inaccessible).
8160 </result>
8161 <result name="VBOX_E_OBJECT_IN_USE">
8162 Medium attached to virtual machine.
8163 </result>
8164 <result name="VBOX_E_FILE_ERROR">
8165 Settings file not accessible.
8166 </result>
8167 <result name="VBOX_E_XML_ERROR">
8168 Could not parse the settings file.
8169 </result>
8170
8171 </desc>
8172 </method>
8173
8174 </interface>
8175
8176
8177 <!--
8178 // IHardDisk
8179 /////////////////////////////////////////////////////////////////////////
8180 -->
8181
8182 <enum
8183 name="HardDiskType"
8184 uuid="a348fafd-a64e-4643-ba65-eb3896bd7e0a"
8185 >
8186 <desc>
8187 Virtual hard disk type.
8188 <see>IHardDisk</see>
8189 </desc>
8190
8191 <const name="Normal" value="0">
8192 <desc>
8193 Normal hard disk (attached directly or indirectly, preserved
8194 when taking snapshots).
8195 </desc>
8196 </const>
8197 <const name="Immutable" value="1">
8198 <desc>
8199 Immutable hard disk (attached indirectly, changes are wiped out
8200 after powering off the virtual machine).
8201 </desc>
8202 </const>
8203 <const name="Writethrough" value="2">
8204 <desc>
8205 Write through hard disk (attached directly, ignored when
8206 taking snapshots).
8207 </desc>
8208 </const>
8209 </enum>
8210
8211 <interface
8212 name="IHardDiskAttachment" extends="$unknown"
8213 uuid="b1dd04bb-93c0-4ad3-a9cf-82316e595836"
8214 wsmap="struct"
8215 >
8216 <desc>
8217 The IHardDiskAttachment interface represents a hard disk attachment of a
8218 virtual machine.
8219
8220 Every hard disk attachment specifies a slot of the virtual hard disk
8221 controller and a virtual hard disk attached to this slot.
8222
8223 The array of hard disk attachments is returned by
8224 <link to="IMachine::hardDiskAttachments"/>.
8225 </desc>
8226 <attribute name="hardDisk" type="IHardDisk" readonly="yes">
8227 <desc>Hard disk object associated with this attachment.</desc>
8228 </attribute>
8229
8230 <attribute name="bus" type="StorageBus" readonly="yes">
8231 <desc>Interface bus of this attachment.</desc>
8232 </attribute>
8233
8234 <attribute name="channel" type="long" readonly="yes">
8235 <desc>Channel number of this attachment.</desc>
8236 </attribute>
8237
8238 <attribute name="device" type="long" readonly="yes">
8239 <desc>Device slot number of this attachment.</desc>
8240 </attribute>
8241
8242 </interface>
8243
8244 <interface
8245 name="IHardDisk" extends="IMedium"
8246 uuid="244f89fe-1943-464d-baad-2efd73e5d532"
8247 wsmap="managed"
8248 >
8249 <desc>
8250 The IHardDisk interface represents a virtual hard disk drive
8251 used by a virtual machine. This is a subclass of <link to="IMedium" />; see remarks there.
8252
8253 Virtual hard disk objects virtualize the hard disk hardware and look like
8254 regular hard disks for the guest OS running inside the virtual machine.
8255
8256 <h3>Hard Disk Types</h3>
8257
8258 There are three types of hard disks:
8259 <link to="HardDiskType_Normal">Normal</link>,
8260 <link to="HardDiskType_Immutable">Immutable</link> and
8261 <link to="HardDiskType_Writethrough">Writethrough</link>. The type of the
8262 hard disk defines how the hard disk is attached to a virtual machine and
8263 what happens when a <link to="ISnapshot">snapshot</link> of the virtual
8264 machine with the attached hard disk is taken. The type of the hard disk is
8265 defined by the <link to="#type"/> attribute.
8266
8267 All hard disks can be also divided in two big groups: <i>base</i> hard
8268 disks and <i>differencing</i> hard disks. A base hard disk contains all
8269 sectors of the hard disk data in its storage unit and therefore can be
8270 used independently. On the contrary, a differencing hard disk contains
8271 only some part of the hard disk data (a subset of sectors) and needs
8272 another hard disk to get access to the missing sectors of data. This
8273 another hard disk is called a <i>parent</i> hard disk and defines a hard
8274 disk to which this differencing hard disk is known to be <i>linked to</i>.
8275 The parent hard disk may be itself a differencing hard disk. This
8276 way, differencing hard disks form a linked hard disk chain. This chain
8277 always ends with the base hard disk which is sometimes referred to as the
8278 root hard disk of this chain. Note that several differencing hard disks
8279 may be linked to the same parent hard disk. This way, all known hard disks
8280 form a hard disk tree which is based on their parent-child relationship.
8281
8282 Differencing hard disks can be distinguished from base hard disks by
8283 querying the <link to="#parent"/> attribute: base hard disks do not have
8284 parents they would depend on, so the value of this attribute is always
8285 <tt>null</tt> for them. Using this attribute, it is possible to walk up
8286 the hard disk tree (from the child hard disk to its parent). It is also
8287 possible to walk down the tree using the <link to="#children"/>
8288 attribute.
8289
8290 Note that the type of all differencing hard disks is
8291 <link to="HardDiskType_Normal">Normal</link>; all other values are
8292 meaningless for them. Base hard disks may be of any type.
8293
8294 <h3>Creating Hard Disks</h3>
8295
8296 New base hard disks are created using
8297 <link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
8298 opened using <link to="IVirtualBox::openHardDisk"/>. Differencing hard
8299 disks are usually implicitly created by VirtualBox when needed but may
8300 also be created explicitly using <link to="#createDiffStorage"/>.
8301
8302 After the hard disk is successfully created (including the storage unit)
8303 or opened, it becomes a known hard disk (remembered in the internal media
8304 registry). Known hard disks can be attached to a virtual machine, accessed
8305 through <link to="IVirtualBox::getHardDisk"/> and
8306 <link to="IVirtualBox::findHardDisk"/> methods or enumerated using the
8307 <link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
8308
8309 The following methods, besides <link to="IMedium::close"/>,
8310 automatically remove the hard disk from the media registry:
8311 <ul>
8312 <li><link to="#deleteStorage"/></li>
8313 <li><link to="#mergeTo"/></li>
8314 </ul>
8315
8316 If the storage unit of the hard disk is a regular file in the host's
8317 file system then the rules stated in the description of the
8318 <link to="IMedium::location"/> attribute apply when setting its value. In
8319 addition, a plain file name without any path may be given, in which case
8320 the <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
8321 folder</link> will be prepended to it.
8322
8323 <h4>Automatic composition of the file name part</h4>
8324
8325 Another extension to the <link to="IMedium::location"/> attribute is that
8326 there is a possibility to cause VirtualBox to compose a unique value for
8327 the file name part of the location using the UUID of the hard disk. This
8328 applies only to hard disks in <link to="MediaState_NotCreated"/> state,
8329 e.g. before the storage unit is created, and works as follows. You set the
8330 value of the <link to="IMedium::location"/> attribute to a location
8331 specification which only contains the path specification but not the file
8332 name part and ends with either a forward slash or a backslash character.
8333 In response, VirtualBox will generate a new UUID for the hard disk and
8334 compose the file name using the following pattern:
8335 <pre>
8336 &lt;path&gt;/{&lt;uuid&gt;}.&lt;ext&gt;
8337 </pre>
8338 where <tt>&lt;path&gt;</tt> is the supplied path specification,
8339 <tt>&lt;uuid&gt;</tt> is the newly generated UUID and <tt>&lt;ext&gt;</tt>
8340 is the default extension for the storage format of this hard disk. After
8341 that, you may call any of the methods that create a new hard disk storage
8342 unit and they will use the generated UUID and file name.
8343
8344 <h3>Attaching Hard Disks</h3>
8345
8346 Hard disks are attached to virtual machines using the
8347 <link to="IMachine::attachHardDisk"/> method and detached using the
8348 <link to="IMachine::detachHardDisk"/> method. Depending on their
8349 <link to="#type"/>, hard disks are attached either
8350 <i>directly</i> or <i>indirectly</i>.
8351
8352 When a hard disk is being attached directly, it is associated with the
8353 virtual machine and used for hard disk operations when the machine is
8354 running. When a hard disk is being attached indirectly, a new differencing
8355 hard disk linked to it is implicitly created and this differencing hard
8356 disk is associated with the machine and used for hard disk operations.
8357 This also means that if <link to="IMachine::attachHardDisk"/> performs
8358 a direct attachment then the same hard disk will be returned in response
8359 to the subsequent <link to="IMachine::getHardDisk"/> call; however if
8360 an indirect attachment is performed then
8361 <link to="IMachine::getHardDisk"/> will return the implicitly created
8362 differencing hard disk, not the original one passed to <link
8363 to="IMachine::attachHardDisk"/>. The following table shows the
8364 dependency of the attachment type on the hard disk type:
8365
8366 <table>
8367 <tr>
8368 <th>Hard Disk Type</th>
8369 <th>Direct or Indirect?</th>
8370 </tr>
8371 <tr>
8372 <td>Normal (Base)</td>
8373 <td>
8374 Normal base hard disks that do not have children (i.e. differencing
8375 hard disks linked to them) and that are not already attached to
8376 virtual machines in snapshots are attached <b>directly</b>.
8377 Otherwise, they are attached <b>indirectly</b> because having
8378 dependent children or being part of the snapshot makes it impossible
8379 to modify hard disk contents without breaking the integrity of the
8380 dependent party. The <link to="#readOnly"/> attribute allows to
8381 quickly determine the kind of the attachment for the given hard
8382 disk. Note that if a normal base hard disk is to be indirectly
8383 attached to a virtual machine with snapshots then a special
8384 procedure called <i>smart attachment</i> is performed (see below).
8385 </td>
8386 </tr>
8387 <tr>
8388 <td>Normal (Differencing)</td>
8389 <td>
8390 Differencing hard disks are like normal base hard disks: attached
8391 <b>directly</b> if they do not have children and are not attached to
8392 virtual machines in snapshots, and <b>indirectly</b> otherwise. Note
8393 that the smart attachment procedure is never performed for
8394 differencing hard disks.
8395 </td>
8396 </tr>
8397 <tr>
8398 <td>Immutable</td>
8399 <td>
8400 Immutable hard disks are always attached <b>indirectly</b> because
8401 they are designed to be non-writable. If an immutable hard disk is
8402 attached to a virtual machine with snapshots then a special
8403 procedure called smart attachment is performed (see below).
8404 </td>
8405 </tr>
8406 <tr>
8407 <td>Writethrough</td>
8408 <td>
8409 Writethrough hard disks are always attached <b>directly</b>, also as
8410 designed. This also means that writethrough hard disks cannot have
8411 other hard disks linked to them at all.
8412 </td>
8413 </tr>
8414 </table>
8415
8416 Note that the same hard disk, regardless of its type, may be attached to
8417 more than one virtual machine at a time. In this case, the machine that is
8418 started first gains exclusive access to the hard disk and attempts to
8419 start other machines having this hard disk attached will fail until the
8420 first machine is powered down.
8421
8422 Detaching hard disks is performed in a <i>deferred</i> fashion. This means
8423 that the given hard disk remains associated with the given machine after a
8424 successful <link to="IMachine::detachHardDisk"/> call until
8425 <link to="IMachine::saveSettings"/> is called to save all changes to
8426 machine settings to disk. This deferring is necessary to guarantee that
8427 the hard disk configuration may be restored at any time by a call to
8428 <link to="IMachine::discardSettings"/> before the settings
8429 are saved (committed).
8430
8431 Note that if <link to="IMachine::discardSettings"/> is called after
8432 indirectly attaching some hard disks to the machine but before a call to
8433 <link to="IMachine::saveSettings"/> is made, it will implicitly delete
8434 all differencing hard disks implicitly created by
8435 <link to="IMachine::attachHardDisk"/> for these indirect attachments.
8436 Such implicitly created hard disks will also be immediately deleted when
8437 detached explicitly using the <link to="IMachine::detachHardDisk"/>
8438 call if it is made before <link to="IMachine::saveSettings"/>. This
8439 implicit deletion is safe because newly created differencing hard
8440 disks do not contain any user data.
8441
8442 However, keep in mind that detaching differencing hard disks that were
8443 implicitly created by <link to="IMachine::attachHardDisk"/>
8444 before the last <link to="IMachine::saveSettings"/> call will
8445 <b>not</b> implicitly delete them as they may already contain some data
8446 (for example, as a result of virtual machine execution). If these hard
8447 disks are no more necessary, the caller can always delete them explicitly
8448 using <link to="#deleteStorage"/> after they are actually de-associated
8449 from this machine by the <link to="IMachine::saveSettings"/> call.
8450
8451 <h3>Smart Attachment</h3>
8452
8453 When normal base or immutable hard disks are indirectly attached to a
8454 virtual machine then some additional steps are performed to make sure the
8455 virtual machine will have the most recent "view" of the hard disk being
8456 attached. These steps include walking through the machine's snapshots
8457 starting from the current one and going through ancestors up to the first
8458 snapshot. Hard disks attached to the virtual machine in all
8459 of the encountered snapshots are checked whether they are descendants of
8460 the given normal base or immutable hard disk. The first found child (which
8461 is the differencing hard disk) will be used instead of the normal base or
8462 immutable hard disk as a parent for creating a new differencing hard disk
8463 that will be actually attached to the machine. And only if no descendants
8464 are found or if the virtual machine does not have any snapshots then the
8465 normal base or immutable hard disk will be used itself as a parent for
8466 this differencing hard disk.
8467
8468 It is easier to explain what smart attachment does using the
8469 following example:
8470 <pre>
8471BEFORE attaching B.vdi: AFTER attaching B.vdi:
8472
8473Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
8474 Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
8475 Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
8476 Snapshot 4 (none) Snapshot 4 (none)
8477 CurState (none) CurState (D3->D2.vdi)
8478
8479 NOT
8480 ...
8481 CurState (D3->B.vdi)
8482 </pre>
8483 The first column is the virtual machine configuration before the base hard
8484 disk <tt>B.vdi</tt> is attached, the second column shows the machine after
8485 this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
8486 mean that the hard disk that is actually attached to the machine is a
8487 differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
8488 another hard disk, <tt>B.vdi</tt>.
8489
8490 As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
8491 from the machine before taking Snapshot 4. Later, after Snapshot 4 was
8492 taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
8493 dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
8494 it cannot be attached directly and needs an indirect attachment (i.e.
8495 implicit creation of a new differencing hard disk). Due to the smart
8496 attachment procedure, the new differencing hard disk
8497 (<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
8498 <tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
8499 <tt>B.vdi</tt> existing for this snapshot branch of the given virtual
8500 machine.
8501
8502 Note that if there is more than one descendant hard disk of the given base
8503 hard disk found in a snapshot, and there is an exact device, channel and
8504 bus match, then this exact match will be used. Otherwise, the youngest
8505 descendant will be picked up.
8506
8507 There is one more important aspect of the smart attachment procedure which
8508 is not related to snapshots at all. Before walking through the snapshots
8509 as described above, the backup copy of the current list of hard disk
8510 attachment is searched for descendants. This backup copy is created when
8511 the hard disk configuration is changed for the first time after the last
8512 <link to="IMachine::saveSettings"/> call and used by
8513 <link to="IMachine::discardSettings"/> to undo the recent hard disk
8514 changes. When such a descendant is found in this backup copy, it will be
8515 simply re-attached back, without creating a new differencing hard disk for
8516 it. This optimization is necessary to make it possible to re-attach the
8517 base or immutable hard disk to a different bus, channel or device slot
8518 without losing the contents of the differencing hard disk actually
8519 attached to the machine in place of it.
8520 </desc>
8521
8522 <attribute name="format" type="wstring" readonly="yes">
8523 <desc>
8524 Storage format of this hard disk.
8525
8526 The value of this attribute is a string that specifies a backend used to
8527 store hard disk data. The storage format is defined when you create a
8528 new hard disk or automatically detected when you open an existing hard
8529 disk medium, and cannot be changed later.
8530
8531 The list of all storage formats supported by this VirtualBox
8532 installation can be obtained using
8533 <link to="ISystemProperties::hardDiskFormats"/>.
8534 </desc>
8535 </attribute>
8536
8537 <attribute name="type" type="HardDiskType">
8538 <desc>
8539 Type (role) of this hard disk.
8540
8541 The following constraints apply when changing the value of this
8542 attribute:
8543 <ul>
8544 <li>If a hard disk is attached to a virtual machine (either in the
8545 current state or in one of the snapshots), its type cannot be
8546 changed.
8547 </li>
8548 <li>As long as the hard disk has children, its type cannot be set
8549 to <link to="HardDiskType_Writethrough"/>.
8550 </li>
8551 <li>The type of all differencing hard disks is
8552 <link to="HardDiskType_Normal"/> and cannot be changed.
8553 </li>
8554 </ul>
8555
8556 The type of a newly created or opened hard disk is set to
8557 <link to="HardDiskType_Normal"/>.
8558 </desc>
8559 </attribute>
8560
8561 <attribute name="parent" type="IHardDisk" readonly="yes">
8562 <desc>
8563 Parent of this hard disk (a hard disk this hard disk is directly based
8564 on).
8565
8566 Only differencing hard disks have parents. For base (non-differencing)
8567 hard disks, <tt>null</tt> is returned.
8568 </desc>
8569 </attribute>
8570
8571 <attribute name="children" type="IHardDisk" safearray="yes" readonly="yes">
8572 <desc>
8573 Children of this hard disk (all differencing hard disks directly based
8574 on this hard disk). A <tt>null</tt> array is returned if this hard disk
8575 does not have any children.
8576 </desc>
8577 </attribute>
8578
8579 <attribute name="root" type="IHardDisk" readonly="yes">
8580 <desc>
8581 Root hard disk of this hard disk.
8582
8583 If this is a differencing hard disk, its root hard disk is the base hard
8584 disk the given hard disk branch starts from. For all other types of hard
8585 disks, this property returns the hard disk object itself (i.e. the same
8586 object this property is read on).
8587 </desc>
8588 </attribute>
8589
8590 <attribute name="readOnly" type="boolean" readonly="yes">
8591 <desc>
8592 Returns <tt>true</tt> if this hard disk is read-only and <tt>false</tt>
8593 otherwise.
8594
8595 A hard disk is considered to be read-only when its contents cannot be
8596 modified without breaking the integrity of other parties that depend on
8597 this hard disk such as its child hard disks or snapshots of virtual
8598 machines where this hard disk is attached to these machines. If there
8599 are no children and no such snapshots then there is no dependency and
8600 the hard disk is not read-only.
8601
8602 The value of this attribute can be used to determine the kind of the
8603 attachment that will take place when attaching this hard disk to a
8604 virtual machine. If the value is <tt>false</tt> then the hard disk will
8605 be attached directly. If the value is <tt>true</tt> then the hard disk
8606 will be attached indirectly by creating a new differencing child hard
8607 disk for that. See the interface description for more information.
8608
8609 Note that all <link to="HardDiskType_Immutable">Immutable</link> hard
8610 disks are always read-only while all
8611 <link to="HardDiskType_Writethrough">Writethrough</link> hard disks are
8612 always not.
8613
8614 <note>
8615 The read-only condition represented by this attribute is related to
8616 the hard disk type and usage, not to the current
8617 <link to="IMedium::state">media state</link> and not to the read-only
8618 state of the storage unit.
8619 </note>
8620 </desc>
8621 </attribute>
8622
8623 <attribute name="logicalSize" type="unsigned long long" readonly="yes">
8624 <desc>
8625 Logical size of this hard disk (in megabytes), as reported to the
8626 guest OS running inside the virtual machine this disk is
8627 attached to. The logical size is defined when the hard disk is created
8628 and cannot be changed later.
8629
8630 <note>
8631 Reading this property on a differencing hard disk will return the size
8632 of its <link to="#root"/> hard disk.
8633 </note>
8634 <note>
8635 For hard disks whose state is <link to="#state"/> is <link
8636 to="MediaState_Inaccessible"/>, the value of this property is the
8637 last known logical size. For <link to="MediaState_NotCreated"/> hard
8638 disks, the returned value is zero.
8639 </note>
8640 </desc>
8641 </attribute>
8642
8643 <!-- storage methods -->
8644
8645 <method name="getProperty">
8646 <desc>
8647 Returns the value of the custom hard disk property with the given name.
8648
8649 The list of all properties supported by the given hard disk format can
8650 be obtained with <link to="IHardDiskFormat::describeProperties"/>.
8651
8652 Note that if this method returns a <tt>null</tt> @a value, the requested
8653 property is supported but currently not assigned any value.
8654
8655 <result name="VBOX_E_OBJECT_NOT_FOUND">
8656 Requested property does not exist (not supported by the format).
8657 </result>
8658 <result name="E_INVALIDARG">@a name is NULL or empty.</result>
8659 </desc>
8660 <param name="name" type="wstring" dir="in">
8661 <desc>Name of the property to get.</desc>
8662 </param>
8663 <param name="value" type="wstring" dir="return">
8664 <desc>Current property value.</desc>
8665 </param>
8666 </method>
8667
8668 <method name="setProperty">
8669 <desc>
8670 Sets the value of the custom hard disk property with the given name.
8671
8672 The list of all properties supported by the given hard disk format can
8673 be obtained with <link to="IHardDiskFormat::describeProperties"/>.
8674
8675 Note that setting the property value to <tt>null</tt> is equivalent to
8676 deleting the existing value. A default value (if it is defined for this
8677 property) will be used by the format backend in this case.
8678
8679 <result name="VBOX_E_OBJECT_NOT_FOUND">
8680 Requested property does not exist (not supported by the format).
8681 </result>
8682 <result name="E_INVALIDARG">@a name is NULL or empty.</result>
8683 </desc>
8684 <param name="name" type="wstring" dir="in">
8685 <desc>Name of the property to set.</desc>
8686 </param>
8687 <param name="value" type="wstring" dir="in">
8688 <desc>Property value to set.</desc>
8689 </param>
8690 </method>
8691
8692 <method name="getProperties">
8693 <desc>
8694 Returns values for a group of properties in one call.
8695
8696 The names of the properties to get are specified using the @a names
8697 argument which is a list of comma-separated property names or
8698 <tt>null</tt> if all properties are to be returned. Note that currently
8699 the value of this argument is ignored and the method always returns all
8700 existing properties.
8701
8702 The list of all properties supported by the given hard disk format can
8703 be obtained with <link to="IHardDiskFormat::describeProperties"/>.
8704
8705 The method returns two arrays, the array of property names corresponding
8706 to the @a names argument and the current values of these properties.
8707 Both arrays have the same number of elements with each elemend at the
8708 given index in the first array corresponds to an element at the same
8709 index in the second array.
8710
8711 Note that for properties that do not have assigned values,
8712 <tt>null</tt> is returned at the appropriate index in the
8713 @a returnValues array.
8714
8715 </desc>
8716 <param name="names" type="wstring" dir="in">
8717 <desc>
8718 Names of properties to get.
8719 </desc>
8720 </param>
8721 <param name="returnNames" type="wstring" safearray="yes" dir="out">
8722 <desc>Names of returned properties.</desc>
8723 </param>
8724 <param name="returnValues" type="wstring" safearray="yes" dir="return">
8725 <desc>Values of returned properties.</desc>
8726 </param>
8727 </method>
8728
8729 <method name="setProperties">
8730 <desc>
8731 Sets values for a group of properties in one call.
8732
8733 The names of the properties to set are passed in the @a names
8734 array along with the new values for them in the @a values array. Both
8735 arrays have the same number of elements with each elemend at the given
8736 index in the first array corresponding to an element at the same index
8737 in the second array.
8738
8739 If there is at least one property name in @a names that is not valid,
8740 the method will fail before changing the values of any other properties
8741 from the @a names array.
8742
8743 Using this method over <link to="#setProperty"/> is preferred if you
8744 need to set several properties at once since it will result into less
8745 IPC calls.
8746
8747 The list of all properties supported by the given hard disk format can
8748 be obtained with <link to="IHardDiskFormat::describeProperties"/>.
8749
8750 Note that setting the property value to <tt>null</tt> is equivalent to
8751 deleting the existing value. A default value (if it is defined for this
8752 property) will be used by the format backend in this case.
8753 </desc>
8754 <param name="names" type="wstring" safearray="yes" dir="in">
8755 <desc>Names of properties to set.</desc>
8756 </param>
8757 <param name="values" type="wstring" safearray="yes" dir="in">
8758 <desc>Values of properties to set.</desc>
8759 </param>
8760 </method>
8761
8762 <!-- storage methods -->
8763
8764 <method name="createDynamicStorage">
8765 <desc>
8766 Starts creating a dynamically expanding hard disk storage unit in the
8767 background. The previous storage unit created for this object, if
8768 any, must first be deleted using <link to="#deleteStorage"/>, otherwise
8769 the operation will fail.
8770
8771 Before the operation starts, the hard disk is placed in
8772 <link to="MediaState_Creating"/> state. If the create operation
8773 fails, the media will be placed back in <link to="MediaState_NotCreated"/>
8774 state.
8775
8776 After the returned progress object reports that the operation has
8777 successfully completed, the media state will be set to <link
8778 to="MediaState_Created"/>, the hard disk will be remembered by this
8779 VirtualBox installation and may be attached to virtual machines.
8780
8781 <result name="VBOX_E_NOT_SUPPORTED">
8782 Dynamic storage creation operation is not supported. See <link
8783 to="IHardDiskFormat::capabilities"/>.
8784 </result>
8785 </desc>
8786 <param name="logicalSize" type="unsigned long long" dir="in">
8787 <desc>Maximum logical size of the hard disk in megabytes.</desc>
8788 </param>
8789 <param name="progress" type="IProgress" dir="return">
8790 <desc>Progress object to track the operation completion.</desc>
8791 </param>
8792 </method>
8793
8794 <method name="createFixedStorage">
8795 <desc>
8796 Starts creating a fixed-size hard disk storage unit in the background.
8797 The previous storage unit created for this object, if
8798 any, must be first deleted using <link to="#deleteStorage"/>, otherwise
8799 the operation will fail.
8800
8801 Before the operation starts, the hard disk is placed to
8802 <link to="MediaState_Creating"/> state. If the create operation
8803 fails, the media will placed back to <link to="MediaState_NotCreated"/>
8804 state.
8805
8806 After the returned progress object reports that the operation is
8807 successfully complete, the media state will be set to <link
8808 to="MediaState_Created"/>, the hard disk will be remembered by this
8809 VirtualBox installation and may be attached to virtual machines.
8810
8811 <result name="VBOX_E_NOT_SUPPORTED">
8812 Fixed storage creation operation is not supported. See
8813 <link to="IHardDiskFormat::capabilities"/>.
8814 </result>
8815 </desc>
8816 <param name="logicalSize" type="unsigned long long" dir="in">
8817 <desc>Logical size of the hard disk in megabytes.</desc>
8818 </param>
8819 <param name="progress" type="IProgress" dir="return">
8820 <desc>Progress object to track the operation completion.</desc>
8821 </param>
8822 </method>
8823
8824 <method name="deleteStorage">
8825 <desc>
8826 Starts deleting the storage unit of this hard disk.
8827
8828 The hard disk must not be attached to any known virtual machine and must
8829 not have any known child hard disks, otherwise the operation will fail.
8830 It will also fail if there is no storage unit to delete or if deletion
8831 is already in progress, or if the hard disk is being in use (locked for
8832 read or for write) or inaccessible. Therefore, the only valid state for
8833 this operation to succeed is <link to="MediaState_Created"/>.
8834
8835 Before the operation starts, the hard disk is placed to
8836 <link to="MediaState_Deleting"/> state and gets removed from the list
8837 of remembered hard disks (media registry). If the delete operation
8838 fails, the media will be remembered again and placed back to
8839 <link to="MediaState_Created"/> state.
8840
8841 After the returned progress object reports that the operation is
8842 complete, the media state will be set to
8843 <link to="MediaState_NotCreated"/> and you will be able to use one of
8844 the storage creation methods to create it again.
8845
8846 <see>#close()</see>
8847
8848 <result name="VBOX_E_OBJECT_IN_USE">
8849 Hard disk is attached to a virtual machine.
8850 </result>
8851 <result name="VBOX_E_NOT_SUPPORTED">
8852 Storage deletion is not allowed because neither of storage creation
8853 operations are supported. See
8854 <link to="IHardDiskFormat::capabilities"/>.
8855 </result>
8856
8857 <note>
8858 If the deletion operation fails, it is not guaranteed that the storage
8859 unit still exists. You may check the <link to="IMedium::state"/> value
8860 to answer this question.
8861 </note>
8862 </desc>
8863 <param name="progress" type="IProgress" dir="return">
8864 <desc>Progress object to track the operation completion.</desc>
8865 </param>
8866 </method>
8867
8868 <!-- diff methods -->
8869
8870 <method name="createDiffStorage">
8871 <desc>
8872 Starts creating an empty differencing storage unit based on this hard
8873 disk in the format and at the location defined by the @a target
8874 argument.
8875
8876 The target hard disk must be in <link to="MediaState_NotCreated"/>
8877 state (i.e. must not have an existing storage unit). Upon successful
8878 completion, this operation will set the type of the target hard disk to
8879 <link to="HardDiskType_Normal"/> and create a storage unit necessary to
8880 represent the differencing hard disk data in the given format (according
8881 to the storage format of the target object).
8882
8883 After the returned progress object reports that the operation is
8884 successfully complete, the target hard disk gets remembered by this
8885 VirtualBox installation and may be attached to virtual machines.
8886
8887 <note>
8888 The hard disk will be set to <link to="MediaState_LockedRead"/>
8889 state for the duration of this operation.
8890 </note>
8891 <result name="VBOX_E_OBJECT_IN_USE">
8892 Hard disk not in NotCreated state.
8893 </result>
8894 </desc>
8895 <param name="target" type="IHardDisk" dir="in">
8896 <desc>Target hard disk.</desc>
8897 </param>
8898 <param name="progress" type="IProgress" dir="return">
8899 <desc>Progress object to track the operation completion.</desc>
8900 </param>
8901 </method>
8902
8903 <method name="mergeTo">
8904 <desc>
8905 Starts merging the contents of this hard disk and all intermediate
8906 differencing hard disks in the chain to the given target hard disk.
8907
8908 The target hard disk must be either a descendant of this hard disk or
8909 its ancestor (otherwise this method will immediately return a failure).
8910 It follows that there are two logical directions of the merge operation:
8911 from ancestor to descendant (<i>forward merge</i>) and from descendant to
8912 ancestor (<i>backward merge</i>). Let us consider the following hard disk
8913 chain:
8914
8915 <pre>Base &lt;- Diff_1 &lt;- Diff_2</pre>
8916
8917 Here, calling this method on the <tt>Base</tt> hard disk object with
8918 <tt>Diff_2</tt> as an argument will be a forward merge; calling it on
8919 <tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
8920 merge. Note that in both cases the contents of the resulting hard disk
8921 will be the same, the only difference is the hard disk object that takes
8922 the result of the merge operation. In case of the forward merge in the
8923 above example, the result will be written to <tt>Diff_2</tt>; in case of
8924 the backward merge, the result will be written to <tt>Base</tt>. In
8925 other words, the result of the operation is always stored in the target
8926 hard disk.
8927
8928 Upon successful operation completion, the storage units of all hard
8929 disks in the chain between this (source) hard disk and the target hard
8930 disk, including the source hard disk itself, will be automatically
8931 deleted and the relevant hard disk objects (including this hard disk)
8932 will become uninitialized. This means that any attempt to call any of
8933 their methods or attributes will fail with the
8934 <tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
8935 example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
8936 delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> hard
8937 disks. Note that <tt>Diff_2</tt> in this case will become a base hard
8938 disk itself since it will no longer be based on any other hard disk.
8939
8940 Considering the above, all of the following conditions must be met in
8941 order for the merge operation to succeed:
8942 <ul>
8943 <li>
8944 Neither this (source) hard disk nor any intermediate
8945 differencing hard disk in the chain between it and the target
8946 hard disk is attached to any virtual machine.
8947 </li>
8948 <li>
8949 Neither the source hard disk nor the target hard disk is an
8950 <link to="HardDiskType_Immutable"/> hard disk.
8951 </li>
8952 <li>
8953 The part of the hard disk tree from the source hard disk to the
8954 target hard disk is a linear chain, i.e. all hard disks in this
8955 chain have exactly one child which is the next hard disk in this
8956 chain. The only exception from this rule is the target hard disk in
8957 the forward merge operation; it is allowed to have any number of
8958 child hard disks because the merge operation will hot change its
8959 logical contents (as it is seen by the guest OS or by children).
8960 </li>
8961 <li>
8962 None of the involved hard disks are in
8963 <link to="MediaState_LockedRead"/> or
8964 <link to="MediaState_LockedWrite"/> state.
8965 </li>
8966 </ul>
8967
8968 <note>
8969 This (source) hard disk and all intermediates will be placed to <link
8970 to="MediaState_Deleting"/> state and the target hard disk will be
8971 placed to <link to="MediaState_LockedWrite"/> state and for the
8972 duration of this operation.
8973 </note>
8974 </desc>
8975 <param name="targetId" type="uuid" dir="in">
8976 <desc>UUID of the target ancestor or descendant hard disk.</desc>
8977 </param>
8978 <param name="progress" type="IProgress" dir="return">
8979 <desc>Progress object to track the operation completion.</desc>
8980 </param>
8981 </method>
8982
8983 <!-- clone methods -->
8984
8985 <method name="cloneTo">
8986 <desc>
8987 Starts creating a clone of this hard disk in the format and at the
8988 location defined by the @a target argument.
8989
8990 The target hard disk must be in <link to="MediaState_NotCreated"/>
8991 state (i.e. must not have an existing storage unit). Upon successful
8992 completion, the cloned hard disk will contain exactly the same sector
8993 data as the hard disk being cloned, except that a new UUID for the clone
8994 will be randomly generated.
8995
8996 After the returned progress object reports that the operation is
8997 successfully complete, the target hard disk gets remembered by this
8998 VirtualBox installation and may be attached to virtual machines.
8999
9000 <note>
9001 If the cloned hard disk is a differencing hard disk, it will inherit
9002 parent dependency of the original hard disk.
9003 </note>
9004 <note>
9005 This hard disk will be placed to <link to="MediaState_LockedRead"/>
9006 state for the duration of this operation.
9007 </note>
9008 </desc>
9009 <param name="target" type="IHardDisk" dir="in">
9010 <desc>Target hard disk.</desc>
9011 </param>
9012 <param name="progress" type="IProgress" dir="return">
9013 <desc>Progress object to track the operation completion.</desc>
9014 </param>
9015 </method>
9016
9017 <method name="flattenTo">
9018 <desc>
9019 Starts creating a deep (independent) clone of this hard disk in the
9020 format and at the location defined by the @a target argument.
9021
9022 This operation is similar to <link to="#cloneTo"/> except that when
9023 applied to a differencing hard disk, it will also copy missing hard disk
9024 data from all parent hard disks it is linked to. This will make the
9025 created clone an independent base hard disk that contains all hard disk
9026 data and does not need any other hard disks to operate.
9027
9028 After the returned progress object reports that the operation is
9029 successfully complete, the target hard disk gets remembered by this
9030 VirtualBox installation and may be attached to virtual machines.
9031
9032 <note>
9033 For base hard disks, this operation is identical to
9034 <link to="#cloneTo"/>.
9035 </note>
9036 <note>
9037 This hard disk and all its parent hard disks will be placed to <link
9038 to="MediaState_LockedRead"/> state for the duration of this
9039 operation.
9040 </note>
9041 </desc>
9042 <param name="target" type="IHardDisk" dir="in">
9043 <desc>Target hard disk.</desc>
9044 </param>
9045 <param name="progress" type="IProgress" dir="return">
9046 <desc>Progress object to track the operation completion.</desc>
9047 </param>
9048 </method>
9049
9050 <method name="compact">
9051 <desc>
9052 Starts compacting of this hard disk. This means that the disk is
9053 transformed into a possibly more compact storage representation.
9054 This potentially creates temporary images, which can require a
9055 substantial amount of additional disk space.
9056
9057 After the returned progress object reports that the operation is
9058 successfully complete, the media state will be set back to the
9059 current state.
9060
9061 <note>
9062 This hard disk and all its parent hard disks will be placed to <link
9063 to="MediaState_LockedRead"/> state for the duration of this
9064 operation.
9065 </note>
9066 </desc>
9067 <param name="progress" type="IProgress" dir="return">
9068 <desc>Progress object to track the operation completion.</desc>
9069 </param>
9070 </method>
9071
9072 </interface>
9073
9074
9075 <!--
9076 // IHardDiskFormat
9077 /////////////////////////////////////////////////////////////////////////
9078 -->
9079
9080 <enum
9081 name="DataType"
9082 uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
9083 >
9084 <const name="Int32" value="0"/>
9085 <const name="Int8" value="1"/>
9086 <const name="String" value="2"/>
9087 </enum>
9088
9089 <enum
9090 name="DataFlags"
9091 uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
9092 >
9093 <const name="None" value="0x00"/>
9094 <const name="Mandatory" value="0x01"/>
9095 <const name="Expert" value="0x02"/>
9096 <const name="Array" value="0x04"/>
9097 <const name="FlagMask" value="0x07"/>
9098 </enum>
9099
9100 <enum
9101 name="HardDiskFormatCapabilities"
9102 uuid="1df1e4aa-d25a-4ba6-b2a2-02f60eb5903b"
9103 >
9104 <desc>
9105 Hard disk format capability flags.
9106 </desc>
9107
9108 <const name="Uuid" value="0x01">
9109 <desc>
9110 Supports UUIDs as expected by VirtualBox code.
9111 </desc>
9112 </const>
9113
9114 <const name="CreateFixed" value="0x02">
9115 <desc>
9116 Supports creating fixed size images, allocating all space instantly.
9117 </desc>
9118 </const>
9119
9120 <const name="CreateDynamic" value="0x04">
9121 <desc>
9122 Supports creating dynamically growing images, allocating space on
9123 demand.
9124 </desc>
9125 </const>
9126
9127 <const name="CreateSplit2G" value="0x08">
9128 <desc>
9129 Supports creating images split in chunks of a bit less than 2 GBytes.
9130 </desc>
9131 </const>
9132
9133 <const name="Differencing" value="0x10">
9134 <desc>
9135 Supports being used as a format for differencing hard disks (see <link
9136 to="IHardDisk::createDiffStorage"/>).
9137 </desc>
9138 </const>
9139
9140 <const name="Asynchronous" value="0x20">
9141 <desc>
9142 Supports asynchronous I/O operations for at least some configurations.
9143 </desc>
9144 </const>
9145
9146 <const name="File" value="0x40">
9147 <desc>
9148 The format backend operates on files (the <link to="IMedium::location"/>
9149 attribute of the hard disk specifies a file used to store hard disk
9150 data; for a list of supported file extensions see
9151 <link to="IHardDiskFormat::fileExtensions"/>).
9152 </desc>
9153 </const>
9154
9155 <const name="Properties" value="0x80">
9156 <desc>
9157 The format backend uses the property interface to configure the storage
9158 location and properties (the <link to="IHardDiskFormat::describeProperties"/>
9159 method is used to get access to properties supported by the given hard
9160 disk format).
9161 </desc>
9162 </const>
9163
9164 <const name="CapabilityMask" value="0xFF"/>
9165 </enum>
9166
9167 <interface
9168 name="IHardDiskFormat" extends="$unknown"
9169 uuid="7f3ba790-3a0b-4a8a-bac2-bb50150123c5"
9170 wsmap="managed"
9171 >
9172 <desc>
9173 The IHardDiskFormat interface represents a virtual hard disk format.
9174
9175 Each hard disk format has an associated backend which is used to handle
9176 hard disks stored in this format. This interface provides information
9177 about the properties of the associated backend.
9178
9179 Each hard disk format is identified by a string represented by the
9180 <link to="#id"/> attribute. This string is used in calls like
9181 <link to="IVirtualBox::createHardDisk"/> to specify the desired
9182 format.
9183
9184 The list of all supported hard disk formats can be obtained using
9185 <link to="ISystemProperties::hardDiskFormats"/>.
9186
9187 <see>IHardDisk</see>
9188 </desc>
9189
9190 <attribute name="id" type="wstring" readonly="yes">
9191 <desc>
9192 Identifier of this format.
9193
9194 The format identifier is a non-null non-empty ASCII string. Note that
9195 this string is case-insensitive. This means that, for example, all of
9196 the following strings:
9197 <pre>
9198 "VDI"
9199 "vdi"
9200 "VdI"</pre>
9201 refer to the same hard disk format.
9202
9203 This string is used in methods of other interfaces where it is necessary
9204 to specify a hard disk format, such as
9205 <link to="IVirtualBox::createHardDisk"/>.
9206 </desc>
9207 </attribute>
9208
9209 <attribute name="name" type="wstring" readonly="yes">
9210 <desc>
9211 Human readable description of this format.
9212
9213 Mainly for use in file open dialogs.
9214 </desc>
9215 </attribute>
9216
9217 <attribute name="fileExtensions" type="wstring" safearray="yes" readonly="yes">
9218 <desc>
9219 Array of strings containing the supported file extensions.
9220
9221 The first extension in the array is the extension preferred by the
9222 backend. It is recommended to use this extension when specifying a
9223 location of the storage unit for a new hard disk.
9224
9225 Note that some backends do not work on files, so this array may be
9226 empty.
9227
9228 <see>IHardDiskFormat::capabilities</see>
9229 </desc>
9230 </attribute>
9231
9232 <attribute name="capabilities" type="unsigned long" readonly="yes">
9233 <desc>
9234 Capabilities of the format as a set of bit flags.
9235
9236 For the meaning of individual capability flags see
9237 <link to="HardDiskFormatCapabilities"/>.
9238 </desc>
9239 </attribute>
9240
9241 <method name="describeProperties">
9242 <desc>
9243 Returns several arrays describing the properties supported by this
9244 format.
9245
9246 An element with the given index in each array describes one
9247 property. Thus, the number of elements in each returned array is the
9248 same and corresponds to the number of supported properties.
9249
9250 The returned arrays are filled in only if the
9251 <link to="HardDiskFormatCapabilities_Properties"/> flag is set.
9252 All arguments must be non-NULL.
9253
9254 <see>DataType</see>
9255 <see>DataFlags</see>
9256 </desc>
9257
9258 <param name="names" type="wstring" safearray="yes" dir="out">
9259 <desc>Array of property names.</desc>
9260 </param>
9261 <param name="description" type="wstring" safearray="yes" dir="out">
9262 <desc>Array of property descriptions.</desc>
9263 </param>
9264 <param name="types" type="DataType" safearray="yes" dir="out">
9265 <desc>Array of property types.</desc>
9266 </param>
9267 <param name="flags" type="unsigned long" safearray="yes" dir="out">
9268 <desc>Array of property flags.</desc>
9269 </param>
9270 <param name="defaults" type="wstring" safearray="yes" dir="out">
9271 <desc>Array of default property values.</desc>
9272 </param>
9273 </method>
9274
9275 </interface>
9276
9277
9278 <!--
9279 // IFloppyImage
9280 /////////////////////////////////////////////////////////////////////////
9281 -->
9282
9283 <interface
9284 name="IFloppyImage" extends="IMedium"
9285 uuid="faa6101f-078c-4b3a-ab75-75670c8170b3"
9286 wsmap="managed"
9287 >
9288 <desc>
9289 The IFloppyImage interface represents a medium containing the image
9290 of a floppy disk. This is a subclass of <link to="IMedium" />; see remarks there.
9291 </desc>
9292
9293 </interface>
9294
9295
9296 <!--
9297 // IDVDImage
9298 /////////////////////////////////////////////////////////////////////////
9299 -->
9300
9301 <interface
9302 name="IDVDImage" extends="IMedium"
9303 uuid="b1f90bbb-e8a9-4484-9af1-3638e943f763"
9304 wsmap="managed"
9305 >
9306 <desc>
9307 The IDVDImage interface represents a medium containing the image
9308 of a CD or DVD disk in the ISO format.
9309
9310 This is a subclass of <link to="IMedium" />; see remarks there.
9311 </desc>
9312
9313 </interface>
9314
9315
9316 <!--
9317 // IDVDDrive
9318 /////////////////////////////////////////////////////////////////////////
9319 -->
9320
9321 <interface
9322 name="IDVDDrive" extends="$unknown"
9323 uuid="d650ef30-be9b-4dae-b463-11d5824681a5"
9324 wsmap="managed"
9325 >
9326 <desc>
9327 The IDVDDrive interface represents the virtual CD/DVD drive of the
9328 virtual machine. An object of this type is returned by
9329 <link to="IMachine::DVDDrive"/>.
9330 </desc>
9331
9332 <attribute name="state" type="DriveState" readonly="yes">
9333 <desc>Current drive state.</desc>
9334 </attribute>
9335
9336 <attribute name="passthrough" type="boolean">
9337 <desc>
9338 When a host drive is mounted and passthrough is enabled
9339 the guest OS will be able to directly send SCSI commands to
9340 the host drive. This enables the guest OS to use CD/DVD writers
9341 but is potentially dangerous.
9342 </desc>
9343 </attribute>
9344
9345 <method name="mountImage">
9346 <desc>Mounts a CD/DVD image with the specified UUID.
9347
9348 <result name="VBOX_E_FILE_ERROR">
9349 Invalid image file location.
9350 </result>
9351 <result name="VBOX_E_OBJECT_NOT_FOUND">
9352 Could not find a CD/DVD image matching @a imageID.
9353 </result>
9354 <result name="VBOX_E_INVALID_OBJECT_STATE">
9355 Invalid media state.
9356 </result>
9357
9358 </desc>
9359 <param name="imageId" type="uuid" dir="in"/>
9360 </method>
9361
9362 <method name="captureHostDrive">
9363 <desc>Captures the specified host CD/DVD drive.</desc>
9364 <param name="drive" type="IHostDVDDrive" dir="in"/>
9365 </method>
9366
9367 <method name="unmount">
9368 <desc>Unmounts the currently mounted image or host drive.</desc>
9369 </method>
9370
9371 <method name="getImage">
9372 <desc>Returns the currently mounted CD/DVD image.</desc>
9373 <param name="image" type="IDVDImage" dir="return"/>
9374 </method>
9375
9376 <method name="getHostDrive">
9377 <desc>Returns the currently mounted host CD/DVD drive.</desc>
9378 <param name="drive" type="IHostDVDDrive" dir="return"/>
9379 </method>
9380
9381 </interface>
9382
9383
9384 <!--
9385 // IFloppyDrive
9386 /////////////////////////////////////////////////////////////////////////
9387 -->
9388
9389 <interface
9390 name="IFloppyDrive" extends="$unknown"
9391 uuid="159412cd-bab8-452e-8097-218a020825a6"
9392 wsmap="managed"
9393 >
9394 <desc>
9395 The IFloppyDrive interface represents the virtual floppy drive of the
9396 virtual machine. An object of this type is returned by
9397 <link to="IMachine::floppyDrive" />.
9398 </desc>
9399
9400 <attribute name="enabled" type="boolean">
9401 <desc>
9402 Flag whether the floppy drive is enabled. If it is disabled,
9403 the floppy drive will not be reported to the guest OS.
9404 </desc>
9405 </attribute>
9406
9407 <attribute name="state" type="DriveState" readonly="yes">
9408 <desc>Current drive state.</desc>
9409 </attribute>
9410
9411 <method name="mountImage">
9412 <desc>Mounts a floppy image with the specified UUID.
9413
9414 <result name="VBOX_E_FILE_ERROR">
9415 Invalid image file location.
9416 </result>
9417 <result name="VBOX_E_OBJECT_NOT_FOUND">
9418 Could not find a floppy image matching @a imageID.
9419 </result>
9420 <result name="VBOX_E_INVALID_OBJECT_STATE">
9421 Invalid media state.
9422 </result>
9423
9424 </desc>
9425 <param name="imageId" type="uuid" dir="in"/>
9426 </method>
9427
9428 <method name="captureHostDrive">
9429 <desc>Captures the specified host floppy drive.</desc>
9430 <param name="drive" type="IHostFloppyDrive" dir="in"/>
9431 </method>
9432
9433 <method name="unmount">
9434 <desc>Unmounts the currently mounted image or host drive.</desc>
9435 </method>
9436
9437 <method name="getImage">
9438 <desc>Returns the currently mounted floppy image.</desc>
9439 <param name="image" type="IFloppyImage" dir="return"/>
9440 </method>
9441
9442 <method name="getHostDrive">
9443 <desc>Returns the currently mounted host floppy drive.</desc>
9444 <param name="drive" type="IHostFloppyDrive" dir="return"/>
9445 </method>
9446
9447 </interface>
9448
9449
9450 <!--
9451 // IKeyboard
9452 /////////////////////////////////////////////////////////////////////////
9453 -->
9454
9455 <interface
9456 name="IKeyboard" extends="$unknown"
9457 uuid="2d1a531b-4c6e-49cc-8af6-5c857b78b5d7"
9458 wsmap="managed"
9459 >
9460 <desc>
9461 The IKeyboard interface represents the virtual machine's keyboard. Used
9462 in <link to="IConsole::keyboard"/>.
9463
9464 Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
9465 to the virtual machine.
9466
9467 </desc>
9468 <method name="putScancode">
9469 <desc>Sends a scancode to the keyboard.
9470
9471 <result name="VBOX_E_IPRT_ERROR">
9472 Could not send scan code to virtual keyboard.
9473 </result>
9474
9475 </desc>
9476 <param name="scancode" type="long" dir="in"/>
9477 </method>
9478
9479 <method name="putScancodes">
9480 <desc>Sends an array of scancodes to the keyboard.
9481
9482 <result name="VBOX_E_IPRT_ERROR">
9483 Could not send all scan codes to virtual keyboard.
9484 </result>
9485
9486 </desc>
9487 <param name="scancodes" type="long" dir="in" safearray="yes"/>
9488 <param name="codesStored" type="unsigned long" dir="return"/>
9489 </method>
9490
9491 <method name="putCAD">
9492 <desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
9493 function is nothing special, it is just a convenience function
9494 calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
9495
9496 <result name="VBOX_E_IPRT_ERROR">
9497 Could not send all scan codes to virtual keyboard.
9498 </result>
9499
9500 </desc>
9501 </method>
9502
9503 </interface>
9504
9505
9506 <!--
9507 // IMouse
9508 /////////////////////////////////////////////////////////////////////////
9509 -->
9510
9511 <enum
9512 name="MouseButtonState"
9513 uuid="03131722-2EC5-4173-9794-0DACA46673EF"
9514 >
9515 <desc>
9516 Mouse button state.
9517 </desc>
9518
9519 <const name="LeftButton" value="0x01"/>
9520 <const name="RightButton" value="0x02"/>
9521 <const name="MiddleButton" value="0x04"/>
9522 <const name="WheelUp" value="0x08"/>
9523 <const name="WheelDown" value="0x10"/>
9524 <const name="MouseStateMask" value="0x1F"/>
9525 </enum>
9526
9527 <interface
9528 name="IMouse" extends="$unknown"
9529 uuid="FD443EC1-0006-4F5B-9282-D72760A66916"
9530 wsmap="managed"
9531 >
9532 <desc>
9533 The IMouse interface represents the virtual machine's mouse. Used in
9534 <link to="IConsole::mouse"/>.
9535
9536 Through this interface, the virtual machine's virtual mouse can be
9537 controlled.
9538 </desc>
9539
9540 <attribute name="absoluteSupported" type="boolean" readonly="yes">
9541 <desc>
9542 Whether the guest OS supports absolute mouse pointer positioning
9543 or not.
9544 <note>
9545 VirtualBox Guest Tools need to be installed to the guest OS
9546 in order to enable absolute mouse positioning support.
9547 You can use the <link to="IConsoleCallback::onMouseCapabilityChange"/>
9548 callback to be instantly informed about changes of this attribute
9549 during virtual machine execution.
9550 </note>
9551 <see><link to="#putMouseEventAbsolute"/></see>
9552 </desc>
9553 </attribute>
9554
9555 <method name="putMouseEvent">
9556 <desc>
9557 Initiates a mouse event using relative pointer movements
9558 along x and y axis.
9559
9560 <result name="E_ACCESSDENIED">
9561 Console not powered up.
9562 </result>
9563 <result name="VBOX_E_IPRT_ERROR">
9564 Could not send mouse event to virtual mouse.
9565 </result>
9566
9567 </desc>
9568
9569 <param name="dx" type="long" dir="in">
9570 <desc>
9571 Amount of pixels the mouse should move to the right.
9572 Negative values move the mouse to the left.
9573 </desc>
9574 </param>
9575 <param name="dy" type="long" dir="in">
9576 <desc>
9577 Amount of pixels the mouse should move downwards.
9578 Negative values move the mouse upwards.
9579 </desc>
9580 </param>
9581 <param name="dz" type="long" dir="in">
9582 <desc>
9583 Amount of mouse wheel moves.
9584 Positive values describe clockwise wheel rotations,
9585 negative values describe counterclockwise rotations.
9586 </desc>
9587 </param>
9588 <param name="buttonState" type="long" dir="in">
9589 <desc>
9590 The current state of mouse buttons. Every bit represents
9591 a mouse button as follows:
9592 <table>
9593 <tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
9594 <tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
9595 <tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
9596 </table>
9597 A value of <tt>1</tt> means the corresponding button is pressed.
9598 otherwise it is released.
9599 </desc>
9600 </param>
9601 </method>
9602
9603 <method name="putMouseEventAbsolute">
9604 <desc>
9605 Positions the mouse pointer using absolute x and y coordinates.
9606 These coordinates are expressed in pixels and
9607 start from <tt>[1,1]</tt> which corresponds to the top left
9608 corner of the virtual display.
9609
9610 <result name="E_ACCESSDENIED">
9611 Console not powered up.
9612 </result>
9613 <result name="VBOX_E_IPRT_ERROR">
9614 Could not send mouse event to virtual mouse.
9615 </result>
9616
9617 <note>
9618 This method will have effect only if absolute mouse
9619 positioning is supported by the guest OS.
9620 </note>
9621
9622 <see><link to="#absoluteSupported"/></see>
9623 </desc>
9624
9625 <param name="x" type="long" dir="in">
9626 <desc>
9627 X coordinate of the pointer in pixels, starting from <tt>1</tt>.
9628 </desc>
9629 </param>
9630 <param name="y" type="long" dir="in">
9631 <desc>
9632 Y coordinate of the pointer in pixels, starting from <tt>1</tt>.
9633 </desc>
9634 </param>
9635 <param name="dz" type="long" dir="in">
9636 <desc>
9637 Amount of mouse wheel moves.
9638 Positive values describe clockwise wheel rotations,
9639 negative values describe counterclockwise rotations.
9640 </desc>
9641 </param>
9642 <param name="buttonState" type="long" dir="in">
9643 <desc>
9644 The current state of mouse buttons. Every bit represents
9645 a mouse button as follows:
9646 <table>
9647 <tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
9648 <tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
9649 <tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
9650 </table>
9651 A value of <tt>1</tt> means the corresponding button is pressed.
9652 otherwise it is released.
9653 </desc>
9654 </param>
9655 </method>
9656
9657 </interface>
9658
9659 <!--
9660 // IDisplay
9661 /////////////////////////////////////////////////////////////////////////
9662 -->
9663
9664 <enum
9665 name="FramebufferAccelerationOperation"
9666 uuid="f0e5ebbe-dc8e-4e2d-916e-53baa3844df8"
9667 >
9668 <desc>
9669 Frame buffer acceleration operation.
9670 </desc>
9671
9672 <const name="SolidFillAcceleration" value="1"/>
9673 <const name="ScreenCopyAcceleration" value="2"/>
9674 </enum>
9675
9676 <enum
9677 name="FramebufferPixelFormat"
9678 uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
9679 >
9680 <desc>
9681 Format of the video memory buffer. Constants represented by this enum can
9682 be used to test for particular values of <link
9683 to="IFramebuffer::pixelFormat"/>. See also <link
9684 to="IFramebuffer::requestResize"/>.
9685
9686 See also www.fourcc.org for more information about FOURCC pixel formats.
9687 </desc>
9688
9689 <const name="Opaque" value="0">
9690 <desc>
9691 Unknown buffer format (the user may not assume any particular format of
9692 the buffer).
9693 </desc>
9694 </const>
9695 <const name="FOURCC_RGB" value="0x32424752">
9696 <desc>
9697 Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
9698 bit layout).
9699 </desc>
9700 </const>
9701 </enum>
9702
9703 <interface
9704 name="IFramebuffer" extends="$unknown"
9705 uuid="af431304-5b09-40e2-94da-3c3cb03822c1"
9706 wsmap="suppress"
9707 >
9708 <attribute name="address" type="octet" mod="ptr" readonly="yes">
9709 <desc>Address of the start byte of the frame buffer.</desc>
9710 </attribute>
9711
9712 <attribute name="width" type="unsigned long" readonly="yes">
9713 <desc>Frame buffer width, in pixels.</desc>
9714 </attribute>
9715
9716 <attribute name="height" type="unsigned long" readonly="yes">
9717 <desc>Frame buffer height, in pixels.</desc>
9718 </attribute>
9719
9720 <attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
9721 <desc>
9722 Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
9723 to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
9724 are: 8, 15, 16, 24 and 32.
9725 </desc>
9726 </attribute>
9727
9728 <attribute name="bytesPerLine" type="unsigned long" readonly="yes">
9729 <desc>
9730 Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
9731 to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
9732 size of the scan line must be aligned to 32 bits.
9733 </desc>
9734 </attribute>
9735
9736 <attribute name="pixelFormat" type="unsigned long" readonly="yes">
9737 <desc>
9738 Frame buffer pixel format. It's either one of the values defined by <link
9739 to="FramebufferPixelFormat"/> or a raw FOURCC code.
9740 <note>
9741 This attribute must never return <link
9742 to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
9743 <link to="#address"/> points to must be always known.
9744 </note>
9745 </desc>
9746 </attribute>
9747
9748 <attribute name="usesGuestVRAM" type="boolean" readonly="yes">
9749 <desc>
9750 Defines whether this frame buffer uses the virtual video card's memory
9751 buffer (guest VRAM) directly or not. See <link
9752 to="IFramebuffer::requestResize"/> for more information.
9753 </desc>
9754 </attribute>
9755
9756 <attribute name="heightReduction" type="unsigned long" readonly="yes">
9757 <desc>
9758 Hint from the frame buffer about how much of the standard
9759 screen height it wants to use for itself. This information is
9760 exposed to the guest through the VESA BIOS and VMMDev interface
9761 so that it can use it for determining its video mode table. It
9762 is not guaranteed that the guest respects the value.
9763 </desc>
9764 </attribute>
9765
9766 <attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
9767 <desc>
9768 An alpha-blended overlay which is superposed over the frame buffer.
9769 The initial purpose is to allow the display of icons providing
9770 information about the VM state, including disk activity, in front
9771 ends which do not have other means of doing that. The overlay is
9772 designed to controlled exclusively by IDisplay. It has no locking
9773 of its own, and any changes made to it are not guaranteed to be
9774 visible until the affected portion of IFramebuffer is updated. The
9775 overlay can be created lazily the first time it is requested. This
9776 attribute can also return NULL to signal that the overlay is not
9777 implemented.
9778 </desc>
9779 </attribute>
9780
9781 <attribute name="winId" type="unsigned long long" readonly="yes">
9782 <desc>
9783 Platform-dependent identifier of the window where context of this
9784 frame buffer is drawn, or zero if there's no such window.
9785 </desc>
9786 </attribute>
9787
9788 <method name="lock">
9789 <desc>
9790 Locks the frame buffer.
9791 Gets called by the IDisplay object where this frame buffer is
9792 bound to.
9793 </desc>
9794 </method>
9795
9796 <method name="unlock">
9797 <desc>
9798 Unlocks the frame buffer.
9799 Gets called by the IDisplay object where this frame buffer is
9800 bound to.
9801 </desc>
9802 </method>
9803
9804 <method name="notifyUpdate">
9805 <desc>
9806 Informs about an update.
9807 Gets called by the display object where this buffer is
9808 registered.
9809 </desc>
9810 <param name="x" type="unsigned long" dir="in"/>
9811 <param name="y" type="unsigned long" dir="in"/>
9812 <param name="width" type="unsigned long" dir="in"/>
9813 <param name="height" type="unsigned long" dir="in"/>
9814 <param name="finished" type="boolean" dir="return"/>
9815 </method>
9816
9817 <method name="requestResize">
9818 <desc>
9819 Requests a size and pixel format change.
9820
9821 There are two modes of working with the video buffer of the virtual
9822 machine. The <i>indirect</i> mode implies that the IFramebuffer
9823 implementation allocates a memory buffer for the requested display mode
9824 and provides it to the virtual machine. In <i>direct</i> mode, the
9825 IFramebuffer implementation uses the memory buffer allocated and owned
9826 by the virtual machine. This buffer represents the video memory of the
9827 emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
9828 usually faster because the implementation gets a raw pointer to the
9829 guest VRAM buffer which it can directly use for visualizing the contents
9830 of the virtual display, as opposed to the indirect mode where the
9831 contents of guest VRAM are copied to the memory buffer provided by
9832 the implementation every time a display update occurs.
9833
9834 It is important to note that the direct mode is really fast only when
9835 the implementation uses the given guest VRAM buffer directly, for
9836 example, by blitting it to the window representing the virtual machine's
9837 display, which saves at least one copy operation comparing to the
9838 indirect mode. However, using the guest VRAM buffer directly is not
9839 always possible: the format and the color depth of this buffer may be
9840 not supported by the target window, or it may be unknown (opaque) as in
9841 case of text or non-linear multi-plane VGA video modes. In this case,
9842 the indirect mode (that is always available) should be used as a
9843 fallback: when the guest VRAM contents are copied to the
9844 implementation-provided memory buffer, color and format conversion is
9845 done automatically by the underlying code.
9846
9847 The @a pixelFormat parameter defines whether the direct mode is
9848 available or not. If @a pixelFormat is <link
9849 to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
9850 VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
9851 @a bytesPerLine parameters must be ignored and the implementation must use
9852 the indirect mode (where it provides its own buffer in one of the
9853 supported formats). In all other cases, @a pixelFormat together with
9854 @a bitsPerPixel and @a bytesPerLine define the format of the video memory
9855 buffer pointed to by the @a VRAM parameter and the implementation is
9856 free to choose which mode to use. To indicate that this frame buffer uses
9857 the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
9858 attribute must return <tt>true</tt> and <link to="#address"/> must
9859 return exactly the same address that is passed in the @a VRAM parameter
9860 of this method; otherwise it is assumed that the indirect strategy is
9861 chosen.
9862
9863 The @a width and @a height parameters represent the size of the
9864 requested display mode in both modes. In case of indirect mode, the
9865 provided memory buffer should be big enough to store data of the given
9866 display mode. In case of direct mode, it is guaranteed that the given
9867 @a VRAM buffer contains enough space to represent the display mode of the
9868 given size. Note that this frame buffer's <link to="#width"/> and <link
9869 to="#height"/> attributes must return exactly the same values as
9870 passed to this method after the resize is completed (see below).
9871
9872 The @a finished output parameter determines if the implementation has
9873 finished resizing the frame buffer or not. If, for some reason, the
9874 resize cannot be finished immediately during this call, @a finished
9875 must be set to @c false, and the implementation must call
9876 <link to="IDisplay::resizeCompleted"/> after it has returned from
9877 this method as soon as possible. If @a finished is @c false, the
9878 machine will not call any frame buffer methods until
9879 <link to="IDisplay::resizeCompleted"/> is called.
9880
9881 Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
9882 <link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
9883 this frame buffer must return exactly the same values as specified in the
9884 parameters of this method, after the resize is completed. If the
9885 indirect mode is chosen, these attributes must return values describing
9886 the format of the implementation's own memory buffer <link
9887 to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
9888 value must always correlate with <link to="#pixelFormat"/>. Note that
9889 the <link to="#pixelFormat"/> attribute must never return <link
9890 to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
9891
9892 <note>
9893 This method is called by the IDisplay object under the
9894 <link to="#lock"/> provided by this IFramebuffer
9895 implementation. If this method returns @c false in @a finished, then
9896 this lock is not released until
9897 <link to="IDisplay::resizeCompleted"/> is called.
9898 </note>
9899 </desc>
9900 <param name="screenId" type="unsigned long" dir="in">
9901 <desc>
9902 Logical screen number. Must be used in the corresponding call to
9903 <link to="IDisplay::resizeCompleted"/> if this call is made.
9904 </desc>
9905 </param>
9906 <param name="pixelFormat" type="unsigned long" dir="in">
9907 <desc>
9908 Pixel format of the memory buffer pointed to by @a VRAM.
9909 See also <link to="FramebufferPixelFormat"/>.
9910 </desc>
9911 </param>
9912 <param name="VRAM" type="octet" mod="ptr" dir="in">
9913 <desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
9914 </param>
9915 <param name="bitsPerPixel" type="unsigned long" dir="in">
9916 <desc>Color depth, bits per pixel.</desc>
9917 </param>
9918 <param name="bytesPerLine" type="unsigned long" dir="in">
9919 <desc>Size of one scan line, in bytes.</desc>
9920 </param>
9921 <param name="width" type="unsigned long" dir="in">
9922 <desc>Width of the guest display, in pixels.</desc>
9923 </param>
9924 <param name="height" type="unsigned long" dir="in">
9925 <desc>Height of the guest display, in pixels.</desc>
9926 </param>
9927 <param name="finished" type="boolean" dir="return">
9928 <desc>
9929 Can the VM start using the new frame buffer immediately
9930 after this method returns or it should wait for
9931 <link to="IDisplay::resizeCompleted"/>.
9932 </desc>
9933 </param>
9934 </method>
9935
9936 <method name="operationSupported">
9937 <desc>
9938 Returns whether the given acceleration operation is supported
9939 by the IFramebuffer implementation. If not, the display object
9940 will not attempt to call the corresponding IFramebuffer entry
9941 point. Even if an operation is indicated as supported, the
9942 IFramebuffer implementation always has the option to return non
9943 supported from the corresponding acceleration method in which
9944 case the operation will be performed by the display engine. This
9945 allows for reduced IFramebuffer implementation complexity where
9946 only common cases are handled.
9947 </desc>
9948 <param name="operation" type="FramebufferAccelerationOperation" dir="in"/>
9949 <param name="supported" type="boolean" dir="return"/>
9950 </method>
9951
9952 <method name="videoModeSupported">
9953 <desc>
9954 Returns whether the frame buffer implementation is willing to
9955 support a given video mode. In case it is not able to render
9956 the video mode (or for some reason not willing), it should
9957 return false. Usually this method is called when the guest
9958 asks the VMM device whether a given video mode is supported
9959 so the information returned is directly exposed to the guest.
9960 It is important that this method returns very quickly.
9961 </desc>
9962 <param name="width" type="unsigned long" dir="in"/>
9963 <param name="height" type="unsigned long" dir="in"/>
9964 <param name="bpp" type="unsigned long" dir="in"/>
9965 <param name="supported" type="boolean" dir="return"/>
9966 </method>
9967
9968 <method name="solidFill">
9969 <desc>
9970 Fills the specified rectangle on screen with a solid color.
9971 </desc>
9972 <param name="x" type="unsigned long" dir="in"/>
9973 <param name="y" type="unsigned long" dir="in"/>
9974 <param name="width" type="unsigned long" dir="in"/>
9975 <param name="height" type="unsigned long" dir="in"/>
9976 <param name="color" type="unsigned long" dir="in"/>
9977 <param name="handled" type="boolean" dir="return"/>
9978 </method>
9979
9980 <method name="copyScreenBits">
9981 <desc>
9982 Copies specified rectangle on the screen.
9983 </desc>
9984 <param name="xDst" type="unsigned long" dir="in"/>
9985 <param name="yDst" type="unsigned long" dir="in"/>
9986 <param name="xSrc" type="unsigned long" dir="in"/>
9987 <param name="ySrc" type="unsigned long" dir="in"/>
9988 <param name="width" type="unsigned long" dir="in"/>
9989 <param name="height" type="unsigned long" dir="in"/>
9990 <param name="handled" type="boolean" dir="return"/>
9991 </method>
9992
9993 <method name="getVisibleRegion">
9994 <desc>
9995 Returns the visible region of this frame buffer.
9996
9997 If the @a rectangles parameter is <tt>NULL</tt> then the value of the
9998 @a count parameter is ignored and the number of elements necessary to
9999 describe the current visible region is returned in @a countCopied.
10000
10001 If @a rectangles is not <tt>NULL</tt> but @a count is less
10002 than the required number of elements to store region data, the method
10003 will report a failure. If @a count is equal or greater than the
10004 required number of elements, then the actual number of elements copied
10005 to the provided array will be returned in @a countCopied.
10006
10007 <note>
10008 The address of the provided array must be in the process space of
10009 this IFramebuffer object.
10010 </note>
10011 <note>
10012 Method not yet implemented.
10013 </note>
10014 </desc>
10015 <param name="rectangles" type="octet" mod="ptr" dir="in">
10016 <desc>Pointer to the <tt>RTRECT</tt> array to receive region data.</desc>
10017 </param>
10018 <param name="count" type="unsigned long" dir="in">
10019 <desc>Number of <tt>RTRECT</tt> elements in the @a rectangles array.</desc>
10020 </param>
10021 <param name="countCopied" type="unsigned long" dir="return">
10022 <desc>Number of elements copied to the @a rectangles array.</desc>
10023 </param>
10024 </method>
10025
10026 <method name="setVisibleRegion">
10027 <desc>
10028 Suggests a new visible region to this frame buffer. This region
10029 represents the area of the VM display which is a union of regions of
10030 all top-level windows of the guest operating system running inside the
10031 VM (if the Guest Additions for this system support this
10032 functionality). This information may be used by the frontends to
10033 implement the seamless desktop integration feature.
10034
10035 <note>
10036 The address of the provided array must be in the process space of
10037 this IFramebuffer object.
10038 </note>
10039 <note>
10040 The IFramebuffer implementation must make a copy of the provided
10041 array of rectangles.
10042 </note>
10043 <note>
10044 Method not yet implemented.
10045 </note>
10046 </desc>
10047 <param name="rectangles" type="octet" mod="ptr" dir="in">
10048 <desc>Pointer to the <tt>RTRECT</tt> array.</desc>
10049 </param>
10050 <param name="count" type="unsigned long" dir="in">
10051 <desc>Number of <tt>RTRECT</tt> elements in the @a rectangles array.</desc>
10052 </param>
10053 </method>
10054
10055 </interface>
10056
10057 <interface
10058 name="IFramebufferOverlay" extends="IFramebuffer"
10059 uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
10060 wsmap="suppress"
10061 >
10062 <desc>
10063 The IFramebufferOverlay interface represents an alpha blended overlay
10064 for displaying status icons above an IFramebuffer. It is always created
10065 not visible, so that it must be explicitly shown. It only covers a
10066 portion of the IFramebuffer, determined by its width, height and
10067 co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
10068 that order) format, and may be written to directly. Do re-read the
10069 width though, after setting it, as it may be adjusted (increased) to
10070 make it more suitable for the front end.
10071 </desc>
10072 <attribute name="x" type="unsigned long" readonly="yes">
10073 <desc>X position of the overlay, relative to the frame buffer.</desc>
10074 </attribute>
10075
10076 <attribute name="y" type="unsigned long" readonly="yes">
10077 <desc>Y position of the overlay, relative to the frame buffer.</desc>
10078 </attribute>
10079
10080 <attribute name="visible" type="boolean" readonly="no">
10081 <desc>
10082 Whether the overlay is currently visible.
10083 </desc>
10084 </attribute>
10085
10086 <attribute name="alpha" type="unsigned long" readonly="no">
10087 <desc>
10088 The global alpha value for the overlay. This may or may not be
10089 supported by a given front end.
10090 </desc>
10091 </attribute>
10092
10093 <method name="move">
10094 <desc>
10095 Changes the overlay's position relative to the IFramebuffer.
10096 </desc>
10097 <param name="x" type="unsigned long" dir="in"/>
10098 <param name="y" type="unsigned long" dir="in"/>
10099 </method>
10100
10101 </interface>
10102
10103 <interface
10104 name="IDisplay" extends="$unknown"
10105 uuid="09789f63-4525-48e5-a5e4-1080453b0eab"
10106 wsmap="suppress"
10107 >
10108 <desc>
10109 The IDisplay interface represents the virtual machine's display.
10110
10111 The object implementing this interface is contained in each
10112 <link to="IConsole::display"/> attribute and represents the visual
10113 output of the virtual machine.
10114
10115 The virtual display supports pluggable output targets represented by the
10116 IFramebuffer interface. Examples of the output target are a window on
10117 the host computer or an RDP session's display on a remote computer.
10118 </desc>
10119 <attribute name="width" type="unsigned long" readonly="yes">
10120 <desc>Current display width.</desc>
10121 </attribute>
10122
10123 <attribute name="height" type="unsigned long" readonly="yes">
10124 <desc>Current display height.</desc>
10125 </attribute>
10126
10127 <attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10128 <desc>
10129 Current guest display color depth. Note that this may differ
10130 from <link to="IFramebuffer::bitsPerPixel"/>.
10131 </desc>
10132 </attribute>
10133
10134 <method name="setupInternalFramebuffer">
10135 <desc>
10136 Prepares an internally managed frame buffer.
10137 </desc>
10138 <param name="depth" type="unsigned long" dir="in"/>
10139 </method>
10140
10141 <method name="lockFramebuffer">
10142 <desc>
10143 Requests access to the internal frame buffer.
10144
10145 <result name="VBOX_E_NOT_SUPPORTED">
10146 Attempt to lock a non-internal frame buffer.
10147 </result>
10148
10149 </desc>
10150 <param name="address" type="octet" mod="ptr" dir="return"/>
10151 </method>
10152
10153 <method name="unlockFramebuffer">
10154 <desc>
10155 Releases access to the internal frame buffer.
10156
10157 <result name="VBOX_E_NOT_SUPPORTED">
10158 Attempt to unlock a non-internal frame buffer.
10159 </result>
10160
10161 </desc>
10162 </method>
10163
10164 <method name="registerExternalFramebuffer">
10165 <desc>
10166 Registers an external frame buffer.
10167 </desc>
10168 <param name="framebuffer" type="IFramebuffer" dir="in"/>
10169 </method>
10170
10171 <method name="setFramebuffer">
10172 <desc>
10173 Sets the framebuffer for given screen.
10174 </desc>
10175 <param name="screenId" type="unsigned long" dir="in"/>
10176 <param name="framebuffer" type="IFramebuffer" dir="in"/>
10177 </method>
10178
10179 <method name="getFramebuffer">
10180 <desc>
10181 Queries the framebuffer for given screen.
10182 </desc>
10183 <param name="screenId" type="unsigned long" dir="in"/>
10184 <param name="framebuffer" type="IFramebuffer" dir="out"/>
10185 <param name="xOrigin" type="long" dir="out"/>
10186 <param name="yOrigin" type="long" dir="out"/>
10187 </method>
10188
10189 <method name="setVideoModeHint">
10190 <desc>
10191 Asks VirtualBox to request the given video mode from
10192 the guest. This is just a hint and it cannot be guaranteed
10193 that the requested resolution will be used. Guest Additions
10194 are required for the request to be seen by guests. The caller
10195 should issue the request and wait for a resolution change and
10196 after a timeout retry.
10197
10198 Specifying <tt>0</tt> for either @a width, @a height or @a bitsPerPixel
10199 parameters means that the corresponding values should be taken from the
10200 current video mode (i.e. left unchanged).
10201
10202 If the guest OS supports multi-monitor configuration then the @a display
10203 parameter specifies the number of the guest display to send the hint to:
10204 <tt>0</tt> is the primary display, <tt>1</tt> is the first secondary and
10205 so on. If the multi-monitor configuration is not supported, @a display
10206 must be <tt>0</tt>.
10207
10208 <result name="E_INVALIDARG">
10209 The @a display is not associated with any monitor.
10210 </result>
10211
10212 </desc>
10213 <param name="width" type="unsigned long" dir="in"/>
10214 <param name="height" type="unsigned long" dir="in"/>
10215 <param name="bitsPerPixel" type="unsigned long" dir="in"/>
10216 <param name="display" type="unsigned long" dir="in"/>
10217 </method>
10218
10219 <method name="setSeamlessMode">
10220 <desc>
10221 Enables or disables seamless guest display rendering (seamless desktop
10222 integration) mode.
10223 <note>
10224 Calling this method has no effect if <link
10225 to="IGuest::supportsSeamless"/> returns <tt>false</tt>.
10226 </note>
10227 </desc>
10228 <param name="enabled" type="boolean" dir="in"/>
10229 </method>
10230
10231 <method name="takeScreenShot">
10232 <desc>
10233 Takes a screen shot of the requested size and copies it to the
10234 32-bpp buffer allocated by the caller.
10235
10236 <result name="E_NOTIMPL">
10237 Feature not implemented.
10238 </result>
10239 <result name="VBOX_E_IPRT_ERROR">
10240 Could not take a screenshot.
10241 </result>
10242
10243 </desc>
10244 <param name="address" type="octet" mod="ptr" dir="in"/>
10245 <param name="width" type="unsigned long" dir="in"/>
10246 <param name="height" type="unsigned long" dir="in"/>
10247 </method>
10248
10249 <method name="drawToScreen">
10250 <desc>
10251 Draws a 32-bpp image of the specified size from the given buffer
10252 to the given point on the VM display.
10253
10254 <result name="E_NOTIMPL">
10255 Feature not implemented.
10256 </result>
10257 <result name="VBOX_E_IPRT_ERROR">
10258 Could not draw to screen.
10259 </result>
10260
10261 </desc>
10262 <param name="address" type="octet" mod="ptr" dir="in"/>
10263 <param name="x" type="unsigned long" dir="in"/>
10264 <param name="y" type="unsigned long" dir="in"/>
10265 <param name="width" type="unsigned long" dir="in"/>
10266 <param name="height" type="unsigned long" dir="in"/>
10267 </method>
10268
10269 <method name="invalidateAndUpdate">
10270 <desc>
10271 Does a full invalidation of the VM display and instructs the VM
10272 to update it.
10273
10274 <result name="VBOX_E_IPRT_ERROR">
10275 Could not invalidate and update screen.
10276 </result>
10277
10278 </desc>
10279 </method>
10280
10281 <method name="resizeCompleted">
10282 <desc>
10283 Signals that a framebuffer has completed the resize operation.
10284
10285 <result name="VBOX_E_NOT_SUPPORTED">
10286 Operation only valid for external frame buffers.
10287 </result>
10288
10289 </desc>
10290 <param name="screenId" type="unsigned long" dir="in"/>
10291 </method>
10292
10293 <method name="updateCompleted">
10294 <desc>
10295 Signals that a framebuffer has completed the update operation.
10296
10297 <result name="VBOX_E_NOT_SUPPORTED">
10298 Operation only valid for external frame buffers.
10299 </result>
10300
10301 </desc>
10302 </method>
10303
10304 </interface>
10305
10306 <!--
10307 // INetworkAdapter
10308 /////////////////////////////////////////////////////////////////////////
10309 -->
10310
10311 <enum
10312 name="NetworkAttachmentType"
10313 uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
10314 >
10315 <desc>
10316 Network attachment type.
10317 </desc>
10318
10319 <const name="Null" value="0">
10320 <desc>Null value, also means "not attached".</desc>
10321 </const>
10322 <const name="NAT" value="1"/>
10323 <const name="Bridged" value="2"/>
10324 <const name="Internal" value="3"/>
10325 <const name="HostOnly" value="4"/>
10326 </enum>
10327
10328 <enum
10329 name="NetworkAdapterType"
10330 uuid="156b17b9-5d61-4d54-be90-62e37dda848d"
10331 >
10332 <desc>
10333 Network adapter type.
10334 </desc>
10335
10336 <const name="Null" value="0">
10337 <desc>Null value (never used by the API).</desc>
10338 </const>
10339 <const name="Am79C970A" value="1"/>
10340 <const name="Am79C973" value="2"/>
10341 <const name="I82540EM" value="3"/>
10342 <const name="I82543GC" value="4"/>
10343 </enum>
10344
10345 <interface
10346 name="INetworkAdapter" extends="$unknown"
10347 uuid="8eca30de-a883-40ee-b856-aac86f1ec383"
10348 wsmap="managed"
10349 >
10350 <attribute name="adapterType" type="NetworkAdapterType">
10351 <desc>
10352 Type of the virtual network adapter. Depending on this value,
10353 VirtualBox will provide a different virtual network hardware
10354 to the guest.
10355 </desc>
10356 </attribute>
10357
10358 <attribute name="slot" type="unsigned long" readonly="yes">
10359 <desc>
10360 Slot number this adapter is plugged into. Corresponds to
10361 the value you pass to <link to="IMachine::getNetworkAdapter"/>
10362 to obtain this instance.
10363 </desc>
10364 </attribute>
10365
10366 <attribute name="enabled" type="boolean">
10367 <desc>
10368 Flag whether the network adapter is present in the
10369 guest system. If disabled, the virtual guest hardware will
10370 not contain this network adapter. Can only be changed when
10371 the VM is not running.
10372 </desc>
10373 </attribute>
10374
10375 <attribute name="MACAddress" type="wstring">
10376 <desc>
10377 Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
10378 it to NULL, VirtualBox will generate a unique MAC address.
10379 </desc>
10380 </attribute>
10381
10382 <attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
10383
10384 <attribute name="hostInterface" type="wstring">
10385 <desc>
10386 Name of the host network interface the VM is attached to.
10387 </desc>
10388 </attribute>
10389
10390 <attribute name="internalNetwork" type="wstring">
10391 <desc>
10392 Name of the internal network the VM is attached to.
10393 </desc>
10394 </attribute>
10395
10396 <attribute name="NATNetwork" type="wstring">
10397 <desc>
10398 Name of the NAT network the VM is attached to.
10399 </desc>
10400 </attribute>
10401
10402 <attribute name="cableConnected" type="boolean">
10403 <desc>
10404 Flag whether the adapter reports the cable as connected or not.
10405 It can be used to report offline situations to a VM.
10406 </desc>
10407 </attribute>
10408
10409 <attribute name="lineSpeed" type="unsigned long">
10410 <desc>
10411 Line speed reported by custom drivers, in units of 1 kbps.
10412 </desc>
10413 </attribute>
10414
10415 <attribute name="traceEnabled" type="boolean">
10416 <desc>
10417 Flag whether network traffic from/to the network card should be traced.
10418 Can only be toggled when the VM is turned off.
10419 </desc>
10420 </attribute>
10421
10422 <attribute name="traceFile" type="wstring">
10423 <desc>
10424 Filename where a network trace will be stored. If not set, VBox-pid.pcap
10425 will be used.
10426 </desc>
10427 </attribute>
10428
10429 <method name="attachToNAT">
10430 <desc>
10431 Attach the network adapter to the Network Address Translation (NAT) interface.
10432 </desc>
10433 </method>
10434
10435 <method name="attachToBridgedNetwork">
10436 <desc>
10437 Attach the network adapter to a bridged host interface.
10438 </desc>
10439 </method>
10440
10441 <method name="attachToInternalNetwork">
10442 <desc>
10443 Attach the network adapter to an internal network.
10444 </desc>
10445 </method>
10446
10447 <method name="attachToHostOnlyNetwork">
10448 <desc>
10449 Attach the network adapter to the host-only network.
10450 </desc>
10451 </method>
10452
10453 <method name="detach">
10454 <desc>
10455 Detach the network adapter
10456 </desc>
10457 </method>
10458 </interface>
10459
10460
10461 <!--
10462 // ISerialPort
10463 /////////////////////////////////////////////////////////////////////////
10464 -->
10465
10466 <enum
10467 name="PortMode"
10468 uuid="b266f43c-2e93-46b3-812b-c20e600e867b"
10469 >
10470 <desc>
10471 The PortMode enumeration represents possible communication modes for
10472 the virtual serial port device.
10473 </desc>
10474
10475 <const name="Disconnected" value="0">
10476 <desc>Virtual device is not attached to any real host device.</desc>
10477 </const>
10478 <const name="HostPipe" value="1">
10479 <desc>Virtual device is attached to a host pipe.</desc>
10480 </const>
10481 <const name="HostDevice" value="2">
10482 <desc>Virtual device is attached to a host device.</desc>
10483 </const>
10484 </enum>
10485
10486 <interface
10487 name="ISerialPort" extends="$unknown"
10488 uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
10489 wsmap="managed"
10490 >
10491
10492 <desc>
10493 The ISerialPort interface represents the virtual serial port device.
10494
10495 The virtual serial port device acts like an ordinary serial port
10496 inside the virtual machine. This device communicates to the real
10497 serial port hardware in one of two modes: host pipe or host device.
10498
10499 In host pipe mode, the #path attribute specifies the path to the pipe on
10500 the host computer that represents a serial port. The #server attribute
10501 determines if this pipe is created by the virtual machine process at
10502 machine startup or it must already exist before starting machine
10503 execution.
10504
10505 In host device mode, the #path attribute specifies the name of the
10506 serial port device on the host computer.
10507
10508 There is also a third communication mode: the disconnected mode. In this
10509 mode, the guest OS running inside the virtual machine will be able to
10510 detect the serial port, but all port write operations will be discarded
10511 and all port read operations will return no data.
10512
10513 <see>IMachine::getSerialPort</see>
10514 </desc>
10515
10516 <attribute name="slot" type="unsigned long" readonly="yes">
10517 <desc>
10518 Slot number this serial port is plugged into. Corresponds to
10519 the value you pass to <link to="IMachine::getSerialPort"/>
10520 to obtain this instance.
10521 </desc>
10522 </attribute>
10523
10524 <attribute name="enabled" type="boolean">
10525 <desc>
10526 Flag whether the serial port is enabled. If disabled,
10527 the serial port will not be reported to the guest OS.
10528 </desc>
10529 </attribute>
10530
10531 <attribute name="IOBase" type="unsigned long">
10532 <desc>Base I/O address of the serial port.</desc>
10533 </attribute>
10534
10535 <attribute name="IRQ" type="unsigned long">
10536 <desc>IRQ number of the serial port.</desc>
10537 </attribute>
10538
10539 <attribute name="hostMode" type="PortMode">
10540 <desc>
10541 How is this port connected to the host.
10542 <note>
10543 Changing this attribute may fail if the conditions for
10544 <link to="#path"/> are not met.
10545 </note>
10546 </desc>
10547 </attribute>
10548
10549 <attribute name="server" type="boolean">
10550 <desc>
10551 Flag whether this serial port acts as a server (creates a new pipe on
10552 the host) or as a client (uses the existing pipe). This attribute is
10553 used only when <link to="#hostMode"/> is PortMode_HostPipe.
10554 </desc>
10555 </attribute>
10556
10557 <attribute name="path" type="wstring">
10558 <desc>
10559 Path to the serial port's pipe on the host when <link to="#hostMode"/> is
10560 PortMode_HostPipe, or the host serial device name when
10561 <link to="#hostMode"/> is PortMode_HostDevice. In either of the above
10562 cases, setting a @c null or an empty string as the attribute's value
10563 will result into an error. Otherwise, the value of this property is
10564 ignored.
10565 </desc>
10566 </attribute>
10567
10568 </interface>
10569
10570 <!--
10571 // IParallelPort
10572 /////////////////////////////////////////////////////////////////////////
10573 -->
10574
10575 <interface
10576 name="IParallelPort" extends="$unknown"
10577 uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
10578 wsmap="managed"
10579 >
10580
10581 <desc>
10582 The IParallelPort interface represents the virtual parallel port device.
10583
10584 The virtual parallel port device acts like an ordinary parallel port
10585 inside the virtual machine. This device communicates to the real
10586 parallel port hardware using the name of the parallel device on the host
10587 computer specified in the #path attribute.
10588
10589 Each virtual parallel port device is assigned a base I/O address and an
10590 IRQ number that will be reported to the guest operating system and used
10591 to operate the given parallel port from within the virtual machine.
10592
10593 <see>IMachine::getParallelPort</see>
10594 </desc>
10595
10596 <attribute name="slot" type="unsigned long" readonly="yes">
10597 <desc>
10598 Slot number this parallel port is plugged into. Corresponds to
10599 the value you pass to <link to="IMachine::getParallelPort"/>
10600 to obtain this instance.
10601 </desc>
10602 </attribute>
10603
10604 <attribute name="enabled" type="boolean">
10605 <desc>
10606 Flag whether the parallel port is enabled. If disabled,
10607 the parallel port will not be reported to the guest OS.
10608 </desc>
10609 </attribute>
10610
10611 <attribute name="IOBase" type="unsigned long">
10612 <desc>Base I/O address of the parallel port.</desc>
10613 </attribute>
10614
10615 <attribute name="IRQ" type="unsigned long">
10616 <desc>IRQ number of the parallel port.</desc>
10617 </attribute>
10618
10619 <attribute name="path" type="wstring">
10620 <desc>
10621 Host parallel device name. If this parallel port is enabled, setting a
10622 @c null or an empty string as this attribute's value will result into
10623 an error.
10624 </desc>
10625 </attribute>
10626
10627 </interface>
10628
10629
10630 <!--
10631 // IMachineDebugger
10632 /////////////////////////////////////////////////////////////////////////
10633 -->
10634
10635 <interface
10636 name="IMachineDebugger" extends="$unknown"
10637 uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
10638 wsmap="suppress"
10639 >
10640 <method name="resetStats">
10641 <desc>
10642 Reset VM statistics.
10643 </desc>
10644 <param name="pattern" type="wstring" dir="in">
10645 <desc>The selection pattern. A bit similar to filename globbing.</desc>
10646 </param>
10647 </method>
10648
10649 <method name="dumpStats">
10650 <desc>
10651 Dumps VM statistics.
10652 </desc>
10653 <param name="pattern" type="wstring" dir="in">
10654 <desc>The selection pattern. A bit similar to filename globbing.</desc>
10655 </param>
10656 </method>
10657
10658 <method name="getStats">
10659 <desc>
10660 Get the VM statistics in a XMLish format.
10661 </desc>
10662 <param name="pattern" type="wstring" dir="in">
10663 <desc>The selection pattern. A bit similar to filename globbing.</desc>
10664 </param>
10665 <param name="withDescriptions" type="boolean" dir="in">
10666 <desc>Whether to include the descriptions.</desc>
10667 </param>
10668 <param name="stats" type="wstring" dir="out">
10669 <desc>The XML document containing the statistics.</desc>
10670 </param>
10671 </method>
10672
10673 <method name="injectNMI">
10674 <desc>
10675 Inject an NMI into a running VT-x/AMD-V VM.
10676 </desc>
10677 </method>
10678
10679 <attribute name="singlestep" type="boolean">
10680 <desc>Switch for enabling singlestepping.</desc>
10681 </attribute>
10682
10683 <attribute name="recompileUser" type="boolean">
10684 <desc>Switch for forcing code recompilation for user mode code.</desc>
10685 </attribute>
10686
10687 <attribute name="recompileSupervisor" type="boolean">
10688 <desc>Switch for forcing code recompilation for supervisor mode code.</desc>
10689 </attribute>
10690
10691 <attribute name="PATMEnabled" type="boolean">
10692 <desc>Switch for enabling and disabling the PATM component.</desc>
10693 </attribute>
10694
10695 <attribute name="CSAMEnabled" type="boolean">
10696 <desc>Switch for enabling and disabling the CSAM component.</desc>
10697 </attribute>
10698
10699 <attribute name="logEnabled" type="boolean">
10700 <desc>Switch for enabling and disabling logging.</desc>
10701 </attribute>
10702
10703 <attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
10704 <desc>
10705 Flag indicating whether the VM is currently making use of CPU hardware
10706 virtualization extensions.
10707 </desc>
10708 </attribute>
10709
10710 <attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
10711 <desc>
10712 Flag indicating whether the VM is currently making use of the nested paging
10713 CPU hardware virtualization extension.
10714 </desc>
10715 </attribute>
10716
10717 <attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
10718 <desc>
10719 Flag indicating whether the VM is currently making use of the VPID
10720 VT-x extension.
10721 </desc>
10722 </attribute>
10723
10724 <attribute name="PAEEnabled" type="boolean" readonly="yes">
10725 <desc>
10726 Flag indicating whether the VM is currently making use of the Physical
10727 Address Extension CPU feature.
10728 </desc>
10729 </attribute>
10730
10731 <attribute name="virtualTimeRate" type="unsigned long">
10732 <desc>
10733 The rate at which the virtual time runs expressed as a percentage.
10734 The accepted range is 2% to 20000%.
10735 </desc>
10736 </attribute>
10737
10738 <!-- @todo method for setting log flags, groups and destination! -->
10739
10740 <attribute name="VM" type="unsigned long long" readonly="yes">
10741 <desc>
10742 Gets the VM handle. This is only for internal use while
10743 we carve the details of this interface.
10744 </desc>
10745 </attribute>
10746
10747 </interface>
10748
10749 <!--
10750 // IUSBController
10751 /////////////////////////////////////////////////////////////////////////
10752 -->
10753
10754 <interface
10755 name="IUSBController" extends="$unknown"
10756 uuid="f4c2d3dc-f109-4da7-93b1-ec28973ac89f"
10757 wsmap="managed"
10758 >
10759 <attribute name="enabled" type="boolean">
10760 <desc>
10761 Flag whether the USB controller is present in the
10762 guest system. If disabled, the virtual guest hardware will
10763 not contain any USB controller. Can only be changed when
10764 the VM is powered off.
10765 </desc>
10766 </attribute>
10767
10768 <attribute name="enabledEhci" type="boolean">
10769 <desc>
10770 Flag whether the USB EHCI controller is present in the
10771 guest system. If disabled, the virtual guest hardware will
10772 not contain a USB EHCI controller. Can only be changed when
10773 the VM is powered off.
10774 </desc>
10775 </attribute>
10776
10777 <attribute name="USBStandard" type="unsigned short" readonly="yes">
10778 <desc>
10779 USB standard version which the controller implements.
10780 This is a BCD which means that the major version is in the
10781 high byte and minor version is in the low byte.
10782 </desc>
10783 </attribute>
10784
10785 <attribute name="deviceFilters" type="IUSBDeviceFilterCollection" readonly="yes">
10786 <desc>
10787 List of USB device filters associated with the machine.
10788
10789 If the machine is currently running, these filters are activated
10790 every time a new (supported) USB device is attached to the host
10791 computer that was not ignored by global filters
10792 (<link to="IHost::USBDeviceFilters"/>).
10793
10794 These filters are also activated when the machine is powered up.
10795 They are run against a list of all currently available USB
10796 devices (in states
10797 <link to="USBDeviceState_Available"/>,
10798 <link to="USBDeviceState_Busy"/>,
10799 <link to="USBDeviceState_Held"/>) that were not previously
10800 ignored by global filters.
10801
10802 If at least one filter matches the USB device in question, this
10803 device is automatically captured (attached to) the virtual USB
10804 controller of this machine.
10805
10806 <see>IUSBDeviceFilter, ::IUSBController</see>
10807 </desc>
10808 </attribute>
10809
10810 <method name="createDeviceFilter">
10811 <desc>
10812 Creates a new USB device filter. All attributes except
10813 the filter name are set to <tt>null</tt> (any match),
10814 <i>active</i> is <tt>false</tt> (the filter is not active).
10815
10816 The created filter can then be added to the list of filters using
10817 <link to="#insertDeviceFilter"/>.
10818
10819 <result name="VBOX_E_INVALID_VM_STATE">
10820 The virtual machine is not mutable.
10821 </result>
10822
10823 <see>#deviceFilters</see>
10824 </desc>
10825 <param name="name" type="wstring" dir="in">
10826 <desc>
10827 Filter name. See <link to="IUSBDeviceFilter::name"/>
10828 for more info.
10829 </desc>
10830 </param>
10831 <param name="filter" type="IUSBDeviceFilter" dir="return">
10832 <desc>Created filter object.</desc>
10833 </param>
10834 </method>
10835
10836 <method name="insertDeviceFilter">
10837 <desc>
10838 Inserts the given USB device to the specified position
10839 in the list of filters.
10840
10841 Positions are numbered starting from <tt>0</tt>. If the specified
10842 position is equal to or greater than the number of elements in
10843 the list, the filter is added to the end of the collection.
10844
10845 <note>
10846 Duplicates are not allowed, so an attempt to insert a
10847 filter that is already in the collection, will return an
10848 error.
10849 </note>
10850
10851 <result name="VBOX_E_INVALID_VM_STATE">
10852 Virtual machine is not mutable.
10853 </result>
10854 <result name="E_INVALIDARG">
10855 USB device filter not created within this VirtualBox instance.
10856 </result>
10857 <result name="VBOX_E_INVALID_OBJECT_STATE">
10858 USB device filter already in list.
10859 </result>
10860
10861 <see>#deviceFilters</see>
10862 </desc>
10863 <param name="position" type="unsigned long" dir="in">
10864 <desc>Position to insert the filter to.</desc>
10865 </param>
10866 <param name="filter" type="IUSBDeviceFilter" dir="in">
10867 <desc>USB device filter to insert.</desc>
10868 </param>
10869 </method>
10870
10871 <method name="removeDeviceFilter">
10872 <desc>
10873 Removes a USB device filter from the specified position in the
10874 list of filters.
10875
10876 Positions are numbered starting from <tt>0</tt>. Specifying a
10877 position equal to or greater than the number of elements in
10878 the list will produce an error.
10879
10880 <see>#deviceFilters</see>
10881
10882 <result name="VBOX_E_INVALID_VM_STATE">
10883 Virtual machine is not mutable.
10884 </result>
10885 <result name="E_INVALIDARG">
10886 USB device filter list empty or invalid @a position.
10887 </result>
10888
10889 </desc>
10890 <param name="position" type="unsigned long" dir="in">
10891 <desc>Position to remove the filter from.</desc>
10892 </param>
10893 <param name="filter" type="IUSBDeviceFilter" dir="return">
10894 <desc>Removed USB device filter.</desc>
10895 </param>
10896 </method>
10897
10898 </interface>
10899
10900
10901 <!--
10902 // IUSBDevice
10903 /////////////////////////////////////////////////////////////////////////
10904 -->
10905
10906 <enumerator
10907 name="IUSBDeviceEnumerator" type="IUSBDevice"
10908 uuid="aefe00f7-eb8a-454b-9ea4-fd5ad93c0e99"
10909 />
10910
10911 <collection
10912 name="IUSBDeviceCollection" type="IUSBDevice"
10913 enumerator="IUSBDeviceEnumerator"
10914 uuid="e31f3248-90dd-4ca2-95f0-6b36042d96a2"
10915 readonly="yes"
10916 >
10917 <method name="findById">
10918 <desc>
10919 Searches this collection for a USB device with the given UUID.
10920 <note>
10921 The method returns an error if the given UUID does not
10922 correspond to any USB device in the collection.
10923 </note>
10924 <see>IUSBDevice::id</see>
10925 </desc>
10926 <param name="id" type="uuid" dir="in">
10927 <desc>UUID of the USB device to search for.</desc>
10928 </param>
10929 <param name="device" type="IUSBDevice" dir="return">
10930 <desc>Found USB device object.</desc>
10931 </param>
10932 </method>
10933
10934 <method name="findByAddress">
10935 <desc>
10936 Searches this collection for a USB device with the given
10937 host address.
10938 <note>
10939 The method returns an error if the given address does not
10940 correspond to any USB device in the collection.
10941 </note>
10942 <see>IUSBDevice::address</see>
10943 </desc>
10944 <param name="name" type="wstring" dir="in">
10945 <desc>
10946 Address of the USB device (as assigned by the host) to
10947 search for.
10948 </desc>
10949 </param>
10950 <param name="device" type="IUSBDevice" dir="return">
10951 <desc>Found USB device object.</desc>
10952 </param>
10953 </method>
10954
10955 </collection>
10956
10957 <interface
10958 name="IUSBDevice" extends="$unknown"
10959 uuid="850af07b-9ee8-48c2-b6b0-f6d0acbf63c3"
10960 wsmap="managed"
10961 >
10962 <desc>
10963 The IUSBDevice interface represents a virtual USB device attached to the
10964 virtual machine.
10965
10966 A collection of objects implementing this interface is stored in the
10967 <link to="IConsole::USBDevices"/> attribute which lists all USB devices
10968 attached to a running virtual machine's USB controller.
10969 </desc>
10970
10971 <attribute name="id" type="uuid" readonly="yes">
10972 <desc>
10973 Unique USB device ID. This ID is built from #vendorId,
10974 #productId, #revision and #serialNumber.
10975 </desc>
10976 </attribute>
10977
10978 <attribute name="vendorId" type="unsigned short" readonly="yes">
10979 <desc>Vendor ID.</desc>
10980 </attribute>
10981
10982 <attribute name="productId" type="unsigned short" readonly="yes">
10983 <desc>Product ID.</desc>
10984 </attribute>
10985
10986 <attribute name="revision" type="unsigned short" readonly="yes">
10987 <desc>
10988 Product revision number. This is a packed BCD represented as
10989 unsigned short. The high byte is the integer part and the low
10990 byte is the decimal.
10991 </desc>
10992 </attribute>
10993
10994 <attribute name="manufacturer" type="wstring" readonly="yes">
10995 <desc>Manufacturer string.</desc>
10996 </attribute>
10997
10998 <attribute name="product" type="wstring" readonly="yes">
10999 <desc>Product string.</desc>
11000 </attribute>
11001
11002 <attribute name="serialNumber" type="wstring" readonly="yes">
11003 <desc>Serial number string.</desc>
11004 </attribute>
11005
11006 <attribute name="address" type="wstring" readonly="yes">
11007 <desc>Host specific address of the device.</desc>
11008 </attribute>
11009
11010 <attribute name="port" type="unsigned short" readonly="yes">
11011 <desc>
11012 Host USB port number the device is physically
11013 connected to.
11014 </desc>
11015 </attribute>
11016
11017 <attribute name="version" type="unsigned short" readonly="yes">
11018 <desc>
11019 The major USB version of the device - 1 or 2.
11020 </desc>
11021 </attribute>
11022
11023 <attribute name="portVersion" type="unsigned short" readonly="yes">
11024 <desc>
11025 The major USB version of the host USB port the device is
11026 physically connected to - 1 or 2. For devices not connected to
11027 anything this will have the same value as the version attribute.
11028 </desc>
11029 </attribute>
11030
11031 <attribute name="remote" type="boolean" readonly="yes">
11032 <desc>
11033 Whether the device is physically connected to a remote VRDP
11034 client or to a local host machine.
11035 </desc>
11036 </attribute>
11037
11038 </interface>
11039
11040
11041 <!--
11042 // IUSBDeviceFilter
11043 /////////////////////////////////////////////////////////////////////////
11044 -->
11045
11046 <enumerator
11047 name="IUSBDeviceFilterEnumerator" type="IUSBDeviceFilter"
11048 uuid="d5109c61-93e7-4726-926b-0dee1020da56"
11049 />
11050
11051 <collection
11052 name="IUSBDeviceFilterCollection" type="IUSBDeviceFilter"
11053 enumerator="IUSBDeviceFilterEnumerator"
11054 uuid="4fa3fc99-ceb1-4bf5-a9cb-e962d825c1ef"
11055 readonly="yes"
11056 />
11057
11058 <interface
11059 name="IUSBDeviceFilter" extends="$unknown"
11060 uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
11061 wsmap="managed"
11062 >
11063 <desc>
11064 The IUSBDeviceFilter interface represents an USB device filter used
11065 to perform actions on a group of USB devices.
11066
11067 This type of filters is used by running virtual machines to
11068 automatically capture selected USB devices once they are physically
11069 attached to the host computer.
11070
11071 A USB device is matched to the given device filter if and only if all
11072 attributes of the device match the corresponding attributes of the
11073 filter (that is, attributes are joined together using the logical AND
11074 operation). On the other hand, all together, filters in the list of
11075 filters carry the semantics of the logical OR operation. So if it is
11076 desirable to create a match like "this vendor id OR this product id",
11077 one needs to create two filters and specify "any match" (see below)
11078 for unused attributes.
11079
11080 All filter attributes used for matching are strings. Each string
11081 is an expression representing a set of values of the corresponding
11082 device attribute, that will match the given filter. Currently, the
11083 following filtering expressions are supported:
11084
11085 <ul>
11086 <li><i>Interval filters</i>. Used to specify valid intervals for
11087 integer device attributes (Vendor ID, Product ID and Revision).
11088 The format of the string is:
11089
11090 <tt>int:((m)|([m]-[n]))(,(m)|([m]-[n]))*</tt>
11091
11092 where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
11093 (starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
11094 or decimal (otherwise) form, so that <tt>m &lt; n</tt>. If <tt>m</tt>
11095 is omitted before a dash (<tt>-</tt>), the minimum possible integer
11096 is assumed; if <tt>n</tt> is omitted after a dash, the maximum
11097 possible integer is assumed.
11098 </li>
11099 <li><i>Boolean filters</i>. Used to specify acceptable values for
11100 boolean device attributes. The format of the string is:
11101
11102 <tt>true|false|yes|no|0|1</tt>
11103
11104 </li>
11105 <li><i>Exact match</i>. Used to specify a single value for the given
11106 device attribute. Any string that doesn't start with <tt>int:</tt>
11107 represents the exact match. String device attributes are compared to
11108 this string including case of symbols. Integer attributes are first
11109 converted to a string (see individual filter attributes) and then
11110 compared ignoring case.
11111
11112 </li>
11113 <li><i>Any match</i>. Any value of the corresponding device attribute
11114 will match the given filter. An empty or <tt>null</tt> string is
11115 used to construct this type of filtering expressions.
11116
11117 </li>
11118 </ul>
11119
11120 <note>
11121 On the Windows host platform, interval filters are not currently
11122 available. Also all string filter attributes
11123 (<link to="#manufacturer"/>, <link to="#product"/>,
11124 <link to="#serialNumber"/>) are ignored, so they behave as
11125 <i>any match</i> no matter what string expression is specified.
11126 </note>
11127
11128 <see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
11129 </desc>
11130
11131 <attribute name="name" type="wstring">
11132 <desc>
11133 Visible name for this filter.
11134 This name is used to visually distinguish one filter from another,
11135 so it can neither be <tt>null</tt> nor an empty string.
11136 </desc>
11137 </attribute>
11138
11139 <attribute name="active" type="boolean">
11140 <desc>Whether this filter active or has been temporarily disabled.</desc>
11141 </attribute>
11142
11143 <attribute name="vendorId" type="wstring">
11144 <desc>
11145 <link to="IUSBDevice::vendorId">Vendor ID</link> filter.
11146 The string representation for the <i>exact matching</i>
11147 has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
11148 (including leading zeroes).
11149 </desc>
11150 </attribute>
11151
11152 <attribute name="productId" type="wstring">
11153 <desc>
11154 <link to="IUSBDevice::productId">Product ID</link> filter.
11155 The string representation for the <i>exact matching</i>
11156 has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
11157 (including leading zeroes).
11158 </desc>
11159 </attribute>
11160
11161 <attribute name="revision" type="wstring">
11162 <desc>
11163 <link to="IUSBDevice::productId">Product revision number</link>
11164 filter. The string representation for the <i>exact matching</i>
11165 has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
11166 of the integer part of the revision, and <tt>F</tt> is the
11167 decimal digit of its fractional part (including leading and
11168 trailing zeros).
11169 Note that for interval filters, it's best to use the hexadecimal
11170 form, because the revision is stored as a 16 bit packed BCD value;
11171 so the expression <tt>int:0x0100-0x0199</tt> will match any
11172 revision from <tt>1.0</tt> to <tt>1.99</tt>.
11173 </desc>
11174 </attribute>
11175
11176 <attribute name="manufacturer" type="wstring">
11177 <desc>
11178 <link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
11179 </desc>
11180 </attribute>
11181
11182 <attribute name="product" type="wstring">
11183 <desc>
11184 <link to="IUSBDevice::product">Product</link> filter.
11185 </desc>
11186 </attribute>
11187
11188 <attribute name="serialNumber" type="wstring">
11189 <desc>
11190 <link to="IUSBDevice::serialNumber">Serial number</link> filter.
11191 </desc>
11192 </attribute>
11193
11194 <attribute name="port" type="wstring">
11195 <desc>
11196 <link to="IUSBDevice::port">Host USB port</link> filter.
11197 </desc>
11198 </attribute>
11199
11200 <attribute name="remote" type="wstring">
11201 <desc>
11202 <link to="IUSBDevice::remote">Remote state</link> filter.
11203 <note>
11204 This filter makes sense only for machine USB filters,
11205 i.e. it is ignored by IHostUSBDeviceFilter objects.
11206 </note>
11207 </desc>
11208 </attribute>
11209
11210 <attribute name="maskedInterfaces" type="unsigned long">
11211 <desc>
11212 This is an advanced option for hiding one or more USB interfaces
11213 from the guest. The value is a bit mask where the bits that are set
11214 means the corresponding USB interface should be hidden, masked off
11215 if you like.
11216 This feature only works on Linux hosts.
11217 </desc>
11218 </attribute>
11219
11220 </interface>
11221
11222
11223 <!--
11224 // IHostUSBDevice
11225 /////////////////////////////////////////////////////////////////////////
11226 -->
11227
11228 <enum
11229 name="USBDeviceState"
11230 uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
11231 >
11232 <desc>
11233 USB device state. This enumeration represents all possible states
11234 of the USB device physically attached to the host computer regarding
11235 its state on the host computer and availability to guest computers
11236 (all currently running virtual machines).
11237
11238 Once a supported USB device is attached to the host, global USB
11239 filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
11240 either ignore the device, or put it to USBDeviceState_Held state, or do
11241 nothing. Unless the device is ignored by global filters, filters of all
11242 currently running guests (<link to="IUSBController::deviceFilters"/>) are
11243 activated that can put it to USBDeviceState_Captured state.
11244
11245 If the device was ignored by global filters, or didn't match
11246 any filters at all (including guest ones), it is handled by the host
11247 in a normal way. In this case, the device state is determined by
11248 the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
11249 or USBDeviceState_Available, depending on the current device usage.
11250
11251 Besides auto-capturing based on filters, the device can be manually
11252 captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
11253 state is USBDeviceState_Busy, USBDeviceState_Available or
11254 USBDeviceState_Held.
11255
11256 <note>
11257 Due to differences in USB stack implementations in Linux and Win32,
11258 states USBDeviceState_Busy and USBDeviceState_vailable are applicable
11259 only to the Linux version of the product. This also means that (<link
11260 to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
11261 device state is USBDeviceState_Held.
11262 </note>
11263
11264 <see>IHostUSBDevice, IHostUSBDeviceFilter</see>
11265 </desc>
11266
11267 <const name="NotSupported" value="0">
11268 <desc>
11269 Not supported by the VirtualBox server, not available to guests.
11270 </desc>
11271 </const>
11272 <const name="Unavailable" value="1">
11273 <desc>
11274 Being used by the host computer exclusively,
11275 not available to guests.
11276 </desc>
11277 </const>
11278 <const name="Busy" value="2">
11279 <desc>
11280 Being used by the host computer, potentially available to guests.
11281 </desc>
11282 </const>
11283 <const name="Available" value="3">
11284 <desc>
11285 Not used by the host computer, available to guests (the host computer
11286 can also start using the device at any time).
11287 </desc>
11288 </const>
11289 <const name="Held" value="4">
11290 <desc>
11291 Held by the VirtualBox server (ignored by the host computer),
11292 available to guests.
11293 </desc>
11294 </const>
11295 <const name="Captured" value="5">
11296 <desc>
11297 Captured by one of the guest computers, not available
11298 to anybody else.
11299 </desc>
11300 </const>
11301 </enum>
11302
11303 <enumerator
11304 name="IHostUSBDeviceEnumerator" type="IHostUSBDevice"
11305 uuid="a0c55136-939f-4d20-b9d3-4d406f08bfa5"
11306 />
11307
11308 <collection
11309 name="IHostUSBDeviceCollection" type="IHostUSBDevice"
11310 enumerator="IHostUSBDeviceEnumerator"
11311 uuid="f9d3f96d-b027-4994-b589-70bb9ee0d364"
11312 readonly="yes"
11313 >
11314 <method name="findById">
11315 <desc>
11316 Searches this collection for a USB device with the given UUID.
11317 <note>
11318 The method returns an error if the given UUID does not
11319 correspond to any USB device in the collection.
11320 </note>
11321 <see>IHostUSBDevice::id</see>
11322 </desc>
11323 <param name="id" type="uuid" dir="in">
11324 <desc>UUID of the USB device to search for.</desc>
11325 </param>
11326 <param name="device" type="IHostUSBDevice" dir="return">
11327 <desc>Found USB device object.</desc>
11328 </param>
11329 </method>
11330
11331 <method name="findByAddress">
11332 <desc>
11333 Searches this collection for a USB device with the given
11334 host address.
11335 <note>
11336 The method returns an error if the given address does not
11337 correspond to any USB device in the collection.
11338 </note>
11339 <see>IHostUSBDevice::address</see>
11340 </desc>
11341 <param name="name" type="wstring" dir="in">
11342 <desc>
11343 Address of the USB device (as assigned by the host) to
11344 search for.
11345 </desc>
11346 </param>
11347 <param name="device" type="IHostUSBDevice" dir="return">
11348 <desc>Found USB device object.</desc>
11349 </param>
11350 </method>
11351
11352 </collection>
11353
11354 <interface
11355 name="IHostUSBDevice" extends="IUSBDevice"
11356 uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
11357 wsmap="managed"
11358 >
11359 <desc>
11360 The IHostUSBDevice interface represents a physical USB device attached
11361 to the host computer.
11362
11363 Besides properties inherited from IUSBDevice, this interface adds the
11364 <link to="#state"/> property that holds the current state of the USB
11365 device.
11366
11367 <see>IHost::USBDevices, IHost::USBDeviceFilters</see>
11368 </desc>
11369
11370 <attribute name="state" type="USBDeviceState" readonly="yes">
11371 <desc>
11372 Current state of the device.
11373 </desc>
11374 </attribute>
11375
11376 <!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
11377
11378 </interface>
11379
11380
11381 <!--
11382 // IHostUSBDeviceFilter
11383 /////////////////////////////////////////////////////////////////////////
11384 -->
11385
11386 <enum
11387 name="USBDeviceFilterAction"
11388 uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
11389 >
11390 <desc>
11391 Actions for host USB device filters.
11392 <see>IHostUSBDeviceFilter, USBDeviceState</see>
11393 </desc>
11394
11395 <const name="Null" value="0">
11396 <desc>Null value (never used by the API).</desc>
11397 </const>
11398 <const name="Ignore" value="1">
11399 <desc>Ignore the matched USB device.</desc>
11400 </const>
11401 <const name="Hold" value="2">
11402 <desc>Hold the matched USB device.</desc>
11403 </const>
11404 </enum>
11405
11406 <enumerator
11407 name="IHostUSBDeviceFilterEnumerator" type="IHostUSBDeviceFilter"
11408 uuid="ff735211-903e-4642-9c37-189eb44579fe"
11409 />
11410
11411 <collection
11412 name="IHostUSBDeviceFilterCollection" type="IHostUSBDeviceFilter"
11413 enumerator="IHostUSBDeviceFilterEnumerator"
11414 uuid="1a80458b-87f1-4a74-995d-04e2330119e0"
11415 readonly="yes"
11416 />
11417
11418 <interface
11419 name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
11420 uuid="4cc70246-d74a-400f-8222-3900489c0374"
11421 wsmap="managed"
11422 >
11423 <desc>
11424 The IHostUSBDeviceFilter interface represents a global filter for a
11425 physical USB device used by the host computer. Used indirectly in
11426 <link to="IHost::USBDeviceFilters"/>.
11427
11428 Using filters of this type, the host computer determines the initial
11429 state of the USB device after it is physically attached to the
11430 host's USB controller.
11431
11432 <note>
11433 The <link to="#remote"/> attribute is ignored by this type of
11434 filters, because it makes sense only for
11435 <link to="IUSBController::deviceFilters">machine USB filters</link>.
11436 </note>
11437
11438 <see>IHost::USBDeviceFilters</see>
11439 </desc>
11440
11441 <attribute name="action" type="USBDeviceFilterAction">
11442 <desc>
11443 Action performed by the host when an attached USB device
11444 matches this filter.
11445 </desc>
11446 </attribute>
11447
11448 </interface>
11449
11450 <!--
11451 // IAudioAdapter
11452 /////////////////////////////////////////////////////////////////////////
11453 -->
11454
11455 <enum
11456 name="AudioDriverType"
11457 uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
11458 >
11459 <desc>
11460 Host audio driver type.
11461 </desc>
11462
11463 <const name="Null" value="0">
11464 <desc>Null value, also means "dummy audio driver".</desc>
11465 </const>
11466 <const name="WinMM" value="1"/>
11467 <const name="OSS" value="2"/>
11468 <const name="ALSA" value="3"/>
11469 <const name="DirectSound" value="4"/>
11470 <const name="CoreAudio" value="5"/>
11471 <const name="MMPM" value="6"/>
11472 <const name="Pulse" value="7"/>
11473 <const name="SolAudio" value="8"/>
11474 </enum>
11475
11476 <enum
11477 name="AudioControllerType"
11478 uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
11479 >
11480 <desc>
11481 Virtual audio controller type.
11482 </desc>
11483
11484 <const name="AC97" value="0"/>
11485 <const name="SB16" value="1"/>
11486 </enum>
11487
11488 <interface
11489 name="IAudioAdapter" extends="$unknown"
11490 uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
11491 wsmap="managed"
11492 >
11493 <desc>
11494 The IAudioAdapter interface represents the virtual audio adapter of
11495 the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
11496 </desc>
11497 <attribute name="enabled" type="boolean">
11498 <desc>
11499 Flag whether the audio adapter is present in the
11500 guest system. If disabled, the virtual guest hardware will
11501 not contain any audio adapter. Can only be changed when
11502 the VM is not running.
11503 </desc>
11504 </attribute>
11505 <attribute name="audioController" type="AudioControllerType">
11506 <desc>
11507 The audio hardware we emulate.
11508 </desc>
11509 </attribute>
11510 <attribute name="audioDriver" type="AudioDriverType">
11511 <desc>
11512 Audio driver the adapter is connected to. This setting
11513 can only be changed when the VM is not running.
11514 </desc>
11515 </attribute>
11516 </interface>
11517
11518 <!--
11519 // IVRDPServer
11520 /////////////////////////////////////////////////////////////////////////
11521 -->
11522
11523 <enum
11524 name="VRDPAuthType"
11525 uuid="3d91887a-b67f-4b33-85bf-2da7ab1ea83a"
11526 >
11527 <desc>
11528 VRDP authentication type.
11529 </desc>
11530
11531 <const name="Null" value="0">
11532 <desc>Null value, also means "no authentication".</desc>
11533 </const>
11534 <const name="External" value="1"/>
11535 <const name="Guest" value="2"/>
11536 </enum>
11537
11538 <interface
11539 name="IVRDPServer" extends="$unknown"
11540 uuid="f4584ae7-6bce-474b-83d6-17d235e6aa89"
11541 wsmap="managed"
11542 >
11543 <attribute name="enabled" type="boolean">
11544 <desc>VRDP server status.</desc>
11545 </attribute>
11546
11547 <attribute name="port" type="unsigned long">
11548 <desc>
11549 VRDP server port number.
11550 <note>
11551 Setting the value of this property to <tt>0</tt> will reset the port
11552 number to the default value which is
11553 currently <tt>3389</tt>. Reading this property will always return a
11554 real port number, even after it has been set to <tt>0</tt> (in which
11555 case the default port is returned).
11556 </note>
11557 </desc>
11558 </attribute>
11559
11560 <attribute name="netAddress" type="wstring">
11561 <desc>VRDP server address.</desc>
11562 </attribute>
11563
11564 <attribute name="authType" type="VRDPAuthType">
11565 <desc>VRDP authentication method.</desc>
11566 </attribute>
11567
11568 <attribute name="authTimeout" type="unsigned long">
11569 <desc>Timeout for guest authentication. Milliseconds.</desc>
11570 </attribute>
11571
11572 <attribute name="allowMultiConnection" type="boolean">
11573 <desc>
11574 Flag whether multiple simultaneous connections to the VM are permitted.
11575 Note that this will be replaced by a more powerful mechanism in the future.
11576 </desc>
11577 </attribute>
11578
11579 <attribute name="reuseSingleConnection" type="boolean">
11580 <desc>
11581 Flag whether the existing connection must be dropped and a new connection
11582 must be established by the VRDP server, when a new client connects in single
11583 connection mode.
11584 </desc>
11585 </attribute>
11586
11587 </interface>
11588
11589
11590 <!--
11591 // ISharedFolder
11592 /////////////////////////////////////////////////////////////////////////
11593 -->
11594
11595 <interface
11596 name="ISharedFolder" extends="$unknown"
11597 uuid="64637bb2-9e17-471c-b8f3-f8968dd9884e"
11598 wsmap="struct"
11599 >
11600 <desc>
11601 The ISharedFolder interface represents a folder in the host computer's
11602 file system accessible from the guest OS running inside a virtual
11603 machine using an associated logical name.
11604
11605 There are three types of shared folders:
11606 <ul>
11607 <li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
11608 folders available to all virtual machines.</li>
11609 <li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
11610 VM-specific shared folders available to the given virtual machine at
11611 startup.</li>
11612 <li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
11613 VM-specific shared folders created in the session context (for
11614 example, when the virtual machine is running) and automatically
11615 discarded when the session is closed (the VM is powered off).</li>
11616 </ul>
11617
11618 Logical names of shared folders must be unique within the given scope
11619 (global, permanent or transient). However, they do not need to be unique
11620 across scopes. In this case, the definition of the shared folder in a
11621 more specific scope takes precedence over definitions in all other
11622 scopes. The order of precedence is (more specific to more general):
11623 <ol>
11624 <li>Transient definitions</li>
11625 <li>Permanent definitions</li>
11626 <li>Global definitions</li>
11627 </ol>
11628
11629 For example, if MyMachine has a shared folder named
11630 <tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
11631 transient shared folder named <tt>C_DRIVE</tt> (that points
11632 to <tt>C:\\\\WINDOWS</tt>) will change the definition
11633 of <tt>C_DRIVE</tt> in the guest OS so
11634 that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
11635 to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
11636 PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
11637 the previous (permanent) definition of <tt>C_DRIVE</tt> that points
11638 to <tt>C:\\</tt> if it still exists.
11639
11640 Note that permanent and transient shared folders of different machines
11641 are in different name spaces, so they don't overlap and don't need to
11642 have unique logical names.
11643
11644 <note>
11645 Global shared folders are not implemented in the current version of the
11646 product.
11647 </note>
11648 </desc>
11649
11650 <attribute name="name" type="wstring" readonly="yes">
11651 <desc>Logical name of the shared folder.</desc>
11652 </attribute>
11653
11654 <attribute name="hostPath" type="wstring" readonly="yes">
11655 <desc>Full path to the shared folder in the host file system.</desc>
11656 </attribute>
11657
11658 <attribute name="accessible" type="boolean" readonly="yes">
11659 <desc>
11660 Whether the folder defined by the host path is currently
11661 accessible or not.
11662 For example, the folder can be unaccessible if it is placed
11663 on the network share that is not available by the time
11664 this property is read.
11665 </desc>
11666 </attribute>
11667
11668 <attribute name="writable" type="boolean" readonly="yes">
11669 <desc>
11670 Whether the folder defined by the host path is writable or
11671 not.
11672 </desc>
11673 </attribute>
11674
11675 <attribute name="lastAccessError" type="wstring" readonly="yes">
11676 <desc>
11677 Text message that represents the result of the last accessibility
11678 check.
11679
11680 Accessibility checks are performed each time the <link to="#accessible"/>
11681 attribute is read. A @c null string is returned if the last
11682 accessibility check was successful. A non-null string indicates a
11683 failure and should normally describe a reason of the failure (for
11684 example, a file read error).
11685 </desc>
11686 </attribute>
11687
11688 </interface>
11689
11690 <!--
11691 // ISession
11692 /////////////////////////////////////////////////////////////////////////
11693 -->
11694
11695 <interface
11696 name="IInternalSessionControl" extends="$unknown"
11697 uuid="2581845a-5a9d-45fb-bc3b-2476552dd970"
11698 internal="yes"
11699 wsmap="suppress"
11700 >
11701 <method name="getPID">
11702 <desc>PID of the process that has created this Session object.
11703 </desc>
11704 <param name="pid" type="unsigned long" dir="return"/>
11705 </method>
11706
11707 <method name="getRemoteConsole">
11708 <desc>
11709 Returns the console object suitable for remote control.
11710
11711 <result name="VBOX_E_INVALID_VM_STATE">
11712 Session state prevents operation.
11713 </result>
11714 <result name="VBOX_E_INVALID_OBJECT_STATE">
11715 Session type prevents operation.
11716 </result>
11717
11718 </desc>
11719 <param name="console" type="IConsole" dir="return"/>
11720 </method>
11721
11722 <method name="assignMachine">
11723 <desc>
11724 Assigns the machine object associated with this direct-type
11725 session or informs the session that it will be a remote one
11726 (if @a machine == NULL).
11727
11728 <result name="VBOX_E_INVALID_VM_STATE">
11729 Session state prevents operation.
11730 </result>
11731 <result name="VBOX_E_INVALID_OBJECT_STATE">
11732 Session type prevents operation.
11733 </result>
11734
11735 </desc>
11736 <param name="machine" type="IMachine" dir="in"/>
11737 </method>
11738
11739 <method name="assignRemoteMachine">
11740 <desc>
11741 Assigns the machine and the (remote) console object associated with
11742 this remote-type session.
11743
11744 <result name="VBOX_E_INVALID_VM_STATE">
11745 Session state prevents operation.
11746 </result>
11747
11748 </desc>
11749 <param name="machine" type="IMachine" dir="in"/>
11750 <param name="console" type="IConsole" dir="in"/>
11751 </method>
11752
11753 <method name="updateMachineState">
11754 <desc>
11755 Updates the machine state in the VM process.
11756 Must be called only in certain cases
11757 (see the method implementation).
11758
11759 <result name="VBOX_E_INVALID_VM_STATE">
11760 Session state prevents operation.
11761 </result>
11762 <result name="VBOX_E_INVALID_OBJECT_STATE">
11763 Session type prevents operation.
11764 </result>
11765
11766 </desc>
11767 <param name="aMachineState" type="MachineState" dir="in"/>
11768 </method>
11769
11770 <method name="uninitialize">
11771 <desc>
11772 Uninitializes (closes) this session. Used by VirtualBox to close
11773 the corresponding remote session when the direct session dies
11774 or gets closed.
11775
11776 <result name="VBOX_E_INVALID_VM_STATE">
11777 Session state prevents operation.
11778 </result>
11779
11780 </desc>
11781 </method>
11782
11783 <method name="onDVDDriveChange">
11784 <desc>
11785 Triggered when settings of the DVD drive object of the
11786 associated virtual machine have changed.
11787
11788 <result name="VBOX_E_INVALID_VM_STATE">
11789 Session state prevents operation.
11790 </result>
11791 <result name="VBOX_E_INVALID_OBJECT_STATE">
11792 Session type prevents operation.
11793 </result>
11794
11795 </desc>
11796 </method>
11797
11798 <method name="onFloppyDriveChange">
11799 <desc>
11800 Triggered when settings of the floppy drive object of the
11801 associated virtual machine have changed.
11802
11803 <result name="VBOX_E_INVALID_VM_STATE">
11804 Session state prevents operation.
11805 </result>
11806 <result name="VBOX_E_INVALID_OBJECT_STATE">
11807 Session type prevents operation.
11808 </result>
11809
11810 </desc>
11811 </method>
11812
11813 <method name="onNetworkAdapterChange">
11814 <desc>
11815 Triggered when settings of a network adapter of the
11816 associated virtual machine have changed.
11817
11818 <result name="VBOX_E_INVALID_VM_STATE">
11819 Session state prevents operation.
11820 </result>
11821 <result name="VBOX_E_INVALID_OBJECT_STATE">
11822 Session type prevents operation.
11823 </result>
11824
11825 </desc>
11826 <param name="networkAdapter" type="INetworkAdapter" dir="in"/>
11827 </method>
11828
11829 <method name="onSerialPortChange">
11830 <desc>
11831 Triggered when settings of a serial port of the
11832 associated virtual machine have changed.
11833
11834 <result name="VBOX_E_INVALID_VM_STATE">
11835 Session state prevents operation.
11836 </result>
11837 <result name="VBOX_E_INVALID_OBJECT_STATE">
11838 Session type prevents operation.
11839 </result>
11840
11841 </desc>
11842 <param name="serialPort" type="ISerialPort" dir="in"/>
11843 </method>
11844
11845 <method name="onParallelPortChange">
11846 <desc>
11847 Triggered when settings of a parallel port of the
11848 associated virtual machine have changed.
11849
11850 <result name="VBOX_E_INVALID_VM_STATE">
11851 Session state prevents operation.
11852 </result>
11853 <result name="VBOX_E_INVALID_OBJECT_STATE">
11854 Session type prevents operation.
11855 </result>
11856
11857 </desc>
11858 <param name="parallelPort" type="IParallelPort" dir="in"/>
11859 </method>
11860
11861 <method name="onVRDPServerChange">
11862 <desc>
11863 Triggered when settings of the VRDP server object of the
11864 associated virtual machine have changed.
11865
11866 <result name="VBOX_E_INVALID_VM_STATE">
11867 Session state prevents operation.
11868 </result>
11869 <result name="VBOX_E_INVALID_OBJECT_STATE">
11870 Session type prevents operation.
11871 </result>
11872
11873 </desc>
11874 </method>
11875
11876 <method name="onUSBControllerChange">
11877 <desc>
11878 Triggered when settings of the USB controller object of the
11879 associated virtual machine have changed.
11880
11881 <result name="VBOX_E_INVALID_VM_STATE">
11882 Session state prevents operation.
11883 </result>
11884 <result name="VBOX_E_INVALID_OBJECT_STATE">
11885 Session type prevents operation.
11886 </result>
11887
11888 </desc>
11889 </method>
11890
11891 <method name="onSharedFolderChange">
11892 <desc>
11893 Triggered when a permanent (global or machine) shared folder has been
11894 created or removed.
11895 <note>
11896 We don't pass shared folder parameters in this notification because
11897 the order in which parallel notifications are delivered is not defined,
11898 therefore it could happen that these parameters were outdated by the
11899 time of processing this notification.
11900 </note>
11901
11902 <result name="VBOX_E_INVALID_VM_STATE">
11903 Session state prevents operation.
11904 </result>
11905 <result name="VBOX_E_INVALID_OBJECT_STATE">
11906 Session type prevents operation.
11907 </result>
11908
11909 </desc>
11910 <param name="global" type="boolean" dir="in"/>
11911 </method>
11912
11913 <method name="onUSBDeviceAttach">
11914 <desc>
11915 Triggered when a request to capture a USB device (as a result
11916 of matched USB filters or direct call to
11917 <link to="IConsole::attachUSBDevice"/>) has completed.
11918 A @c null @a error object means success, otherwise it
11919 describes a failure.
11920
11921 <result name="VBOX_E_INVALID_VM_STATE">
11922 Session state prevents operation.
11923 </result>
11924 <result name="VBOX_E_INVALID_OBJECT_STATE">
11925 Session type prevents operation.
11926 </result>
11927
11928 </desc>
11929 <param name="device" type="IUSBDevice" dir="in"/>
11930 <param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
11931 <param name="maskedInterfaces" type="unsigned long" dir="in"/>
11932 </method>
11933
11934 <method name="onUSBDeviceDetach">
11935 <desc>
11936 Triggered when a request to release the USB device (as a result
11937 of machine termination or direct call to
11938 <link to="IConsole::detachUSBDevice"/>) has completed.
11939 A @c null @a error object means success, otherwise it
11940
11941 <result name="VBOX_E_INVALID_VM_STATE">
11942 Session state prevents operation.
11943 </result>
11944 <result name="VBOX_E_INVALID_OBJECT_STATE">
11945 Session type prevents operation.
11946 </result>
11947
11948 </desc>
11949 <param name="id" type="uuid" dir="in"/>
11950 <param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
11951 </method>
11952
11953 <method name="onShowWindow">
11954 <desc>
11955 Called by <link to="IMachine::canShowConsoleWindow"/> and by
11956 <link to="IMachine::showConsoleWindow"/> in order to notify
11957 console callbacks
11958 <link to="IConsoleCallback::onCanShowWindow"/>
11959 and <link to="IConsoleCallback::onShowWindow"/>.
11960
11961 <result name="VBOX_E_INVALID_OBJECT_STATE">
11962 Session type prevents operation.
11963 </result>
11964
11965 </desc>
11966 <param name="check" type="boolean" dir="in"/>
11967 <param name="canShow" type="boolean" dir="out"/>
11968 <param name="winId" type="unsigned long long" dir="out"/>
11969 </method>
11970
11971 <method name="accessGuestProperty">
11972 <desc>
11973 Called by <link to="IMachine::getGuestProperty"/> and by
11974 <link to="IMachine::setGuestProperty"/> in order to read and
11975 modify guest properties.
11976
11977 <result name="VBOX_E_INVALID_VM_STATE">
11978 Machine session is not open.
11979 </result>
11980 <result name="VBOX_E_INVALID_OBJECT_STATE">
11981 Session type is not direct.
11982 </result>
11983
11984 </desc>
11985 <param name="name" type="wstring" dir="in"/>
11986 <param name="value" type="wstring" dir="in"/>
11987 <param name="flags" type="wstring" dir="in"/>
11988 <param name="isSetter" type="boolean" dir="in"/>
11989 <param name="retValue" type="wstring" dir="out"/>
11990 <param name="retTimestamp" type="unsigned long long" dir="out"/>
11991 <param name="retFlags" type="wstring" dir="out"/>
11992 </method>
11993
11994 <method name="enumerateGuestProperties">
11995 <desc>
11996 Return a list of the guest properties matching a set of patterns along
11997 with their values, time stamps and flags.
11998
11999 <result name="VBOX_E_INVALID_VM_STATE">
12000 Machine session is not open.
12001 </result>
12002 <result name="VBOX_E_INVALID_OBJECT_STATE">
12003 Session type is not direct.
12004 </result>
12005
12006 </desc>
12007 <param name="patterns" type="wstring" dir="in">
12008 <desc>
12009 The patterns to match the properties against as a comma-separated
12010 string. If this is empty, all properties currently set will be
12011 returned.
12012 </desc>
12013 </param>
12014 <param name="key" type="wstring" dir="out" safearray="yes">
12015 <desc>
12016 The key names of the properties returned.
12017 </desc>
12018 </param>
12019 <param name="value" type="wstring" dir="out" safearray="yes">
12020 <desc>
12021 The values of the properties returned. The array entries match the
12022 corresponding entries in the @a key array.
12023 </desc>
12024 </param>
12025 <param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
12026 <desc>
12027 The time stamps of the properties returned. The array entries match
12028 the corresponding entries in the @a key array.
12029 </desc>
12030 </param>
12031 <param name="flags" type="wstring" dir="out" safearray="yes">
12032 <desc>
12033 The flags of the properties returned. The array entries match the
12034 corresponding entries in the @a key array.
12035 </desc>
12036 </param>
12037 </method>
12038
12039 </interface>
12040
12041 <interface
12042 name="ISession" extends="$dispatched"
12043 uuid="12F4DCDB-12B2-4ec1-B7CD-DDD9F6C5BF4D"
12044 wsmap="managed"
12045 >
12046 <desc>
12047 The ISession interface represents a serialization primitive for virtual
12048 machines.
12049
12050 With VirtualBox, every time one wishes to manipulate a virtual machine
12051 (e.g. change its settings or start execution), a session object is
12052 required. Such an object must be passed to one of the session methods
12053 that open the given session, which then initiates the machine manipulation.
12054
12055 A session serves several purposes: it identifies to the inter-process VirtualBox
12056 code which process is currently working with the virtual machine, and it ensures
12057 that there are no incompatible requests from several processes for the
12058 same virtual machine. Session objects can therefore be thought of as mutex
12059 semaphores that lock virtual machines to prevent conflicting accesses from
12060 several processes.
12061
12062 How sessions objects are used depends on whether you use the Main API
12063 via COM or via the webservice:
12064
12065 <ul>
12066 <li>When using the COM API directly, an object of the Session class from the
12067 VirtualBox type library needs to be created. In regular COM C++ client code,
12068 this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
12069 This object will then act as a local session object in further calls to open
12070 a session.
12071 </li>
12072
12073 <li>In the webservice, the session manager (IWebsessionManager) instead creates
12074 one session object automatically when <link to="IWebsessionManager::logon" />
12075 is called. A managed object reference to that session object can be retrieved by
12076 calling <link to="IWebsessionManager::getSessionObject" />. This session object
12077 reference can then be used to open sessions.
12078 </li>
12079 </ul>
12080
12081 Sessions are mainly used in two variations:
12082
12083 <ul>
12084 <li>
12085 To start a virtual machine in a separate process, one would call
12086 <link to="IVirtualBox::openRemoteSession"/>, which requires a session
12087 object as its first parameter. This session then identifies the caller
12088 and lets him control the started machine (for example, pause machine
12089 execution or power it down) as well as be notified about machine
12090 execution state changes.
12091 </li>
12092
12093 <li>To alter machine settings, or to start machine execution within the
12094 current process, one needs to open a direct session for the machine first by
12095 calling <link to="IVirtualBox::openSession"/>. While a direct session
12096 is open within one process, no any other process may open another direct
12097 session for the same machine. This prevents the machine from being changed
12098 by other processes while it is running or while the machine is being configured.
12099 </li>
12100 </ul>
12101
12102 One also can attach to an existing direct session already opened by
12103 another process (for example, in order to send a control request to the
12104 virtual machine such as the pause or the reset request). This is done by
12105 calling <link to="IVirtualBox::openExistingSession"/>.
12106
12107 <note>
12108 Unless you are trying to write a new VirtualBox front-end that
12109 performs direct machine execution (like the VirtualBox or VBoxSDL
12110 front-ends), don't call <link to="IConsole::powerUp"/> in a direct
12111 session opened by <link to="IVirtualBox::openSession"/> and use this
12112 session only to change virtual machine settings. If you simply want to
12113 start virtual machine execution using one of the existing front-ends
12114 (for example the VirtualBox GUI or headless server), simply use
12115 <link to="IVirtualBox::openRemoteSession"/>; these front-ends
12116 will power up the machine automatically for you.
12117 </note>
12118 </desc>
12119
12120 <attribute name="state" type="SessionState" readonly="yes">
12121 <desc>Current state of this session.</desc>
12122 </attribute>
12123
12124 <attribute name="type" type="SessionType" readonly="yes">
12125 <desc>
12126 Type of this session. The value of this attribute is valid only
12127 if the session is currently open (i.e. its #state is
12128 SessionType_SessionOpen), otherwise an error will be returned.
12129 </desc>
12130 </attribute>
12131
12132 <attribute name="machine" type="IMachine" readonly="yes">
12133 <desc>Machine object associated with this session.</desc>
12134 </attribute>
12135
12136 <attribute name="console" type="IConsole" readonly="yes">
12137 <desc>Console object associated with this session.</desc>
12138 </attribute>
12139
12140 <method name="close">
12141 <desc>
12142 Closes a session that was previously opened.
12143
12144 It is recommended that every time an "open session" method (such as
12145 <link to="IVirtualBox::openRemoteSession" /> or
12146 <link to="IVirtualBox::openSession" />) has been called to
12147 manipulate a virtual machine, the caller invoke
12148 ISession::close() when it's done doing so. Since sessions are
12149 serialization primitives much like ordinary mutexes, they are
12150 best used the same way: for each "open" call, there should be
12151 a matching "close" call, even when errors occur.
12152
12153 Otherwise, if a direct session for a machine opened with
12154 <link to="IVirtualBox::openSession"/> is not explicitly closed
12155 when the application terminates, the state of the machine will
12156 be set to <link to="MachineState_Aborted" /> on the server.
12157
12158 Generally, it is recommended to close all open sessions explicitly
12159 before terminating the application (regardless of the reason for
12160 the termination).
12161
12162 <note>
12163 Do not expect the session state (<link to="ISession::state" />
12164 to return to "Closed" immediately after you invoke
12165 ISession::close(), particularly if you have started a remote
12166 session to execute the VM in a new process. The session state will
12167 automatically return to "Closed" once the VM is no longer executing,
12168 which can of course take a very long time.
12169 </note>
12170
12171 <result name="E_UNEXPECTED">
12172 Session is not open.
12173 </result>
12174
12175 </desc>
12176 </method>
12177
12178 </interface>
12179
12180 <!--
12181 // ISATAController
12182 /////////////////////////////////////////////////////////////////////////
12183 -->
12184
12185 <interface
12186 name="ISATAController" extends="$unknown"
12187 uuid="9a4b868b-1376-4533-8ef5-065b8e8cedff"
12188 wsmap="managed"
12189 >
12190 <attribute name="enabled" type="boolean">
12191 <desc>
12192 Flag whether the SATA controller is present in the
12193 guest system. If disabled, the virtual guest hardware will
12194 not contain any SATA controller. Can only be changed when
12195 the VM is powered off.
12196 </desc>
12197 </attribute>
12198
12199 <attribute name="portCount" type="unsigned long">
12200 <desc>
12201 The number of usable ports on the SATA controller.
12202 It ranges from 1 to 30.
12203 </desc>
12204 </attribute>
12205
12206 <method name="GetIDEEmulationPort">
12207 <desc>
12208 Gets the corresponding port number which is emulated as an IDE device.
12209
12210 <result name="E_INVALIDARG">
12211 The @a devicePosition is not in the range 0 to 3.
12212 </result>
12213
12214 </desc>
12215 <param name="devicePosition" type="long" dir="in"/>
12216 <param name="portNumber" type="long" dir="return"/>
12217 </method>
12218
12219 <method name="SetIDEEmulationPort">
12220 <desc>
12221 Sets the port number which is emulated as an IDE device.
12222
12223 <result name="E_INVALIDARG">
12224 The @a devicePosition is not in the range 0 to 3 or the
12225 @a portNumber is not in the range 0 to 29.
12226 </result>
12227
12228 </desc>
12229 <param name="devicePosition" type="long" dir="in"/>
12230 <param name="portNumber" type="long" dir="in"/>
12231 </method>
12232
12233 </interface>
12234
12235<if target="wsdl">
12236
12237 <!--
12238 // IManagedObjectRef
12239 /////////////////////////////////////////////////////////////////////////
12240 -->
12241
12242 <interface
12243 name="IManagedObjectRef" extends="$unknown"
12244 uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
12245 internal="yes"
12246 wsmap="managed"
12247 wscpp="hardcoded"
12248 >
12249 <desc>
12250 Managed object reference.
12251
12252 Only within the webservice, a managed object reference (which is really
12253 an opaque number) allows a webservice client to address an object
12254 that lives in the address space of the webservice server.
12255
12256 Behind each managed object reference, there is a COM object that lives
12257 in the webservice server's address space. The COM object is not freed
12258 until the managed object reference is released, either by an explicit
12259 call to <link to="IManagedObjectRef::release" /> or by logging off from
12260 the webservice (<link to="IWebsessionManager::logoff" />), which releases
12261 all objects created during the webservice session.
12262
12263 Whenever a method call of the VirtualBox API returns a COM object, the
12264 webservice representation of that method will instead return a
12265 managed object reference, which can then be used to invoke methods
12266 on that object.
12267 </desc>
12268
12269 <method name="getInterfaceName">
12270 <desc>
12271 Returns the name of the interface that this managed object represents,
12272 for example, "IMachine", as a string.
12273 </desc>
12274 <param name="return" type="wstring" dir="return"/>
12275 </method>
12276
12277 <method name="release">
12278 <desc>
12279 Releases this managed object reference and frees the resources that
12280 were allocated for it in the webservice server process. After calling
12281 this method, the identifier of the reference can no longer be used.
12282 </desc>
12283 </method>
12284
12285 </interface>
12286
12287 <!--
12288 // IWebsessionManager
12289 /////////////////////////////////////////////////////////////////////////
12290 -->
12291
12292 <interface
12293 name="IWebsessionManager" extends="$unknown"
12294 uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
12295 internal="yes"
12296 wsmap="global"
12297 wscpp="hardcoded"
12298 >
12299 <desc>
12300 Websession manager. This provides essential services
12301 to webservice clients.
12302 </desc>
12303 <method name="logon">
12304 <desc>
12305 Logs a new client onto the webservice and returns a managed object reference to
12306 the IVirtualBox instance, which the client can then use as a basis to further
12307 queries, since all calls to the VirtualBox API are based on the IVirtualBox
12308 interface, in one way or the other.
12309 </desc>
12310 <param name="username" type="wstring" dir="in"/>
12311 <param name="password" type="wstring" dir="in"/>
12312 <param name="return" type="IVirtualBox" dir="return"/>
12313 </method>
12314
12315 <method name="getSessionObject">
12316 <desc>
12317 Returns a managed object reference to the internal ISession object that was created
12318 for this web service session when the client logged on.
12319
12320 <see>ISession</see>
12321 </desc>
12322 <param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
12323 <param name="return" type="ISession" dir="return"/>
12324 </method>
12325
12326 <method name="logoff">
12327 <desc>
12328 Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
12329 and destroys all resources associated with the session (most importantly, all
12330 managed objects created in the server while the session was active).
12331 </desc>
12332 <param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
12333 </method>
12334
12335 </interface>
12336
12337</if>
12338
12339 <!--
12340 // IPerformanceCollector & friends
12341 /////////////////////////////////////////////////////////////////////////
12342 -->
12343
12344 <interface
12345 name="IPerformanceMetric" extends="$unknown"
12346 uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
12347 >
12348 <desc>
12349 The IPerformanceMetric interface represents parameters of the given
12350 performance metric.
12351 </desc>
12352
12353 <attribute name="metricName" type="wstring" readonly="yes">
12354 <desc>
12355 Name of the metric.
12356 </desc>
12357 </attribute>
12358
12359 <attribute name="object" type="$unknown" readonly="yes">
12360 <desc>
12361 Object this metric belongs to.
12362 </desc>
12363 </attribute>
12364
12365 <attribute name="description" type="wstring" readonly="yes">
12366 <desc>
12367 Textual description of the metric.
12368 </desc>
12369 </attribute>
12370
12371 <attribute name="period" type="unsigned long" readonly="yes">
12372 <desc>
12373 Time interval between samples, measured in seconds.
12374 </desc>
12375 </attribute>
12376
12377 <attribute name="count" type="unsigned long" readonly="yes">
12378 <desc>
12379 Number of recent samples retained by the performance collector for this
12380 metric.
12381
12382 When the collected sample count exceeds this number, older samples
12383 are discarded.
12384 </desc>
12385 </attribute>
12386
12387 <attribute name="unit" type="wstring" readonly="yes">
12388 <desc>
12389 Unit of measurement.
12390 </desc>
12391 </attribute>
12392
12393 <attribute name="minimumValue" type="long" readonly="yes">
12394 <desc>
12395 Minimum possible value of this metric.
12396 </desc>
12397 </attribute>
12398
12399 <attribute name="maximumValue" type="long" readonly="yes">
12400 <desc>
12401 Maximum possible value of this metric.
12402 </desc>
12403 </attribute>
12404 </interface>
12405
12406 <interface
12407 name="IPerformanceCollector" extends="$unknown"
12408 uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
12409 wsmap="managed"
12410 >
12411 <desc>
12412 The IPerformanceCollector interface represents a service that collects and
12413 stores performance metrics data.
12414
12415 Performance metrics are associated with objects like IHost and
12416 IMachine. Each object has a distinct set of performance metrics.
12417 The set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
12418
12419 Metric data are collected at the specified intervals and are retained
12420 internally. The interval and the number of samples retained can be set
12421 with <link to="IPerformanceCollector::setupMetrics" />.
12422
12423 Metrics are organized hierarchically, each level separated by slash (/).
12424 General scheme for metric name is
12425 "Category/Metric[/SubMetric][:aggregation]". For example CPU/Load/User:avg
12426 metric name stands for: CPU category, Load metric, User submetric, average
12427 aggregate. An aggregate function is computed over all retained data. Valid
12428 aggregate functions are:
12429
12430 <ul>
12431 <li>avg -- average</li>
12432 <li>min -- minimum</li>
12433 <li>max -- maximum</li>
12434 </ul>
12435
12436 "Category/Metric" together form base metric name. A base metric is the
12437 smallest unit for which a sampling interval and the number of retained
12438 samples can be set. Only base metrics can be enabled and disabled. All
12439 sub-metrics are collected when their base metric is collected.
12440 Collected values for any set of sub-metrics can be queried with
12441 <link to="IPerformanceCollector::queryMetricsData" />. When setting up
12442 metric parameters, querying metric data, enabling or disabling metrics
12443 wildcards can be used in metric names to specify a subset of metrics. For
12444 example, to select all CPU-related metrics use <tt>CPU/*</tt>, all
12445 averages can be queried using <tt>*:avg</tt> and so on. To query metric
12446 values without aggregates <tt>*:</tt> can be used.
12447
12448 The valid names for base metrics are:
12449
12450 <ul>
12451 <li>CPU/Load</li>
12452 <li>CPU/MHz</li>
12453 <li>RAM/Usage</li>
12454 </ul>
12455
12456 The general sequence for collecting and retrieving the metrics is:
12457 <ul>
12458 <li>
12459 Obtain an instance of IPerformanceCollector with
12460 <link to="IVirtualBox::performanceCollector" />
12461 </li>
12462 <li>
12463 Allocate and populate an array with references to objects the metrics
12464 will be collected for. Use references to IHost and IMachine objects.
12465 </li>
12466 <li>
12467 Allocate and populate an array with base metric names the data will be
12468 collected for.
12469 </li>
12470 <li>
12471 Call <link to="IPerformanceCollector::setupMetrics" />. From now on the
12472 metric data will be collected and stored.
12473 </li>
12474 <li>
12475 Wait for the data to get collected.
12476 </li>
12477 <li>
12478 Allocate and populate an array with references to objects the metric
12479 values will be queried for. You can re-use the object array used for
12480 setting base metrics.
12481 </li>
12482 <li>
12483 Allocate and populate an array with metric names the data will be
12484 collected for. Note that metric names differ from base metric names.
12485 </li>
12486 <li>
12487 Call <link to="IPerformanceCollector::queryMetricsData" />. The data that
12488 have been collected so far are returned. Note that the values are still
12489 retained internally and data collection continues.
12490 </li>
12491 </ul>
12492
12493 For an example of usage refer to the following files in VirtualBox SDK:
12494 <ul>
12495 <li>
12496 Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
12497 </li>
12498 <li>
12499 Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
12500 </li>
12501 </ul>
12502 </desc>
12503
12504 <attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
12505 <desc>
12506 Array of unique names of metrics.
12507
12508 This array represents all metrics supported by the performance
12509 collector. Individual objects do not necessarily support all of them.
12510 <link to="IPerformanceCollector::getMetrics"/> can be used to get the
12511 list of supported metrics for a particular object.
12512 </desc>
12513 </attribute>
12514
12515 <method name="getMetrics">
12516 <desc>
12517 Returns parameters of specified metrics for a set of objects.
12518 <note>
12519 @c Null metrics array means all metrics. @c Null object array means
12520 all existing objects.
12521 </note>
12522 </desc>
12523 <param name="metricNames" type="wstring" dir="in" safearray="yes">
12524 <desc>
12525 Metric name filter. Currently, only a comma-separated list of metrics
12526 is supported.
12527 </desc>
12528 </param>
12529 <param name="objects" type="$unknown" dir="in" safearray="yes">
12530 <desc>
12531 Set of objects to return metric parameters for.
12532 </desc>
12533 </param>
12534 <param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
12535 <desc>
12536 Array of returned metric parameters.
12537 </desc>
12538 </param>
12539 </method>
12540
12541 <method name="setupMetrics">
12542 <desc>
12543 Sets parameters of specified base metrics for a set of objects. Returns
12544 an array of <link to="IPerformanceMetric" /> describing the metrics have
12545 been affected.
12546 <note>
12547 @c Null or empty metric name array means all metrics. @c Null or empty
12548 object array means all existing objects. If metric name array contains
12549 a single element and object array contains many, the single metric
12550 name array element is applied to each object array element to form
12551 metric/object pairs.
12552 </note>
12553 </desc>
12554 <param name="metricNames" type="wstring" dir="in" safearray="yes">
12555 <desc>
12556 Metric name filter. Comma-separated list of metrics with wildcard
12557 support.
12558 </desc>
12559 </param>
12560 <param name="objects" type="$unknown" dir="in" safearray="yes">
12561 <desc>
12562 Set of objects to setup metric parameters for.
12563 </desc>
12564 </param>
12565 <param name="period" type="unsigned long" dir="in">
12566 <desc>
12567 Time interval in seconds between two consecutive samples of performance
12568 data.
12569 </desc>
12570 </param>
12571 <param name="count" type="unsigned long" dir="in">
12572 <desc>
12573 Number of samples to retain in performance data history. Older samples
12574 get discarded.
12575 </desc>
12576 </param>
12577 <param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
12578 <desc>
12579 Array of metrics that have been modified by the call to this method.
12580 </desc>
12581 </param>
12582 </method>
12583
12584 <method name="enableMetrics">
12585 <desc>
12586 Turns on collecting specified base metrics. Returns an array of
12587 <link to="IPerformanceMetric" /> describing the metrics have been
12588 affected.
12589 <note>
12590 @c Null or empty metric name array means all metrics. @c Null or empty
12591 object array means all existing objects. If metric name array contains
12592 a single element and object array contains many, the single metric
12593 name array element is applied to each object array element to form
12594 metric/object pairs.
12595 </note>
12596 </desc>
12597 <param name="metricNames" type="wstring" dir="in" safearray="yes">
12598 <desc>
12599 Metric name filter. Comma-separated list of metrics with wildcard
12600 support.
12601 </desc>
12602 </param>
12603 <param name="objects" type="$unknown" dir="in" safearray="yes">
12604 <desc>
12605 Set of objects to enable metrics for.
12606 </desc>
12607 </param>
12608 <param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
12609 <desc>
12610 Array of metrics that have been modified by the call to this method.
12611 </desc>
12612 </param>
12613 </method>
12614
12615 <method name="disableMetrics">
12616 <desc>
12617 Turns off collecting specified base metrics. Returns an array of
12618 <link to="IPerformanceMetric" /> describing the metrics have been
12619 affected.
12620 <note>
12621 @c Null or empty metric name array means all metrics. @c Null or empty
12622 object array means all existing objects. If metric name array contains
12623 a single element and object array contains many, the single metric
12624 name array element is applied to each object array element to form
12625 metric/object pairs.
12626 </note>
12627 </desc>
12628 <param name="metricNames" type="wstring" dir="in" safearray="yes">
12629 <desc>
12630 Metric name filter. Comma-separated list of metrics with wildcard
12631 support.
12632 </desc>
12633 </param>
12634 <param name="objects" type="$unknown" dir="in" safearray="yes">
12635 <desc>
12636 Set of objects to disable metrics for.
12637 </desc>
12638 </param>
12639 <param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
12640 <desc>
12641 Array of metrics that have been modified by the call to this method.
12642 </desc>
12643 </param>
12644 </method>
12645
12646 <method name="queryMetricsData">
12647 <desc>
12648 Queries collected metrics data for a set of objects.
12649
12650 The data itself and related metric information are returned in seven
12651 parallel and one flattened array of arrays. Elements of
12652 <tt>returnMetricNames, returnObjects, returnUnits, returnScales,
12653 returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
12654 the same index describe one set of values corresponding to a single
12655 metric.
12656
12657 The <tt>returnData</tt> parameter is a flattened array of arrays. Each
12658 start and length of a sub-array is indicated by
12659 <tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
12660 value for metric <tt>metricNames[i]</tt> is at
12661 <tt>returnData[returnIndices[i]]</tt>.
12662
12663 <note>
12664 @c Null or empty metric name array means all metrics. @c Null or empty
12665 object array means all existing objects. If metric name array contains
12666 a single element and object array contains many, the single metric
12667 name array element is applied to each object array element to form
12668 metric/object pairs.
12669 </note>
12670 <note>
12671 Data collection continues behind the scenes after call to
12672 @c queryMetricsData. The return data can be seen as the snapshot of
12673 the current state at the time of @c queryMetricsData call. The
12674 internally kept metric values are not cleared by the call. This makes
12675 possible querying different subsets of metrics or aggregates with
12676 subsequent calls. If periodic querying is needed it is highly
12677 suggested to query the values with @c interval*count period to avoid
12678 confusion. This way a completely new set of data values will be
12679 provided by each query.
12680 </note>
12681 </desc>
12682 <param name="metricNames" type="wstring" dir="in" safearray="yes">
12683 <desc>
12684 Metric name filter. Comma-separated list of metrics with wildcard
12685 support.
12686 </desc>
12687 </param>
12688 <param name="objects" type="$unknown" dir="in" safearray="yes">
12689 <desc>
12690 Set of objects to query metrics for.
12691 </desc>
12692 </param>
12693 <param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
12694 <desc>
12695 Names of metrics returned in @c returnData.
12696 </desc>
12697 </param>
12698 <param name="returnObjects" type="$unknown" dir="out" safearray="yes">
12699 <desc>
12700 Objects associated with metrics returned in @c returnData.
12701 </desc>
12702 </param>
12703 <param name="returnUnits" type="wstring" dir="out" safearray="yes">
12704 <desc>
12705 Units of measurement for each returned metric.
12706 </desc>
12707 </param>
12708 <param name="returnScales" type="unsigned long" dir="out" safearray="yes">
12709 <desc>
12710 Divisor that should be applied to return values in order to get
12711 floating point values. For example:
12712 <tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
12713 will retrieve the floating point value of i-th sample of the first
12714 metric.
12715 </desc>
12716 </param>
12717 <param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
12718 <desc>
12719 Sequence numbers of the first elements of value sequences of particular metrics
12720 returned in @c returnData. For aggregate metrics it is the sequence number of
12721 the sample the aggregate started calculation from.
12722 </desc>
12723 </param>
12724 <param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
12725 <desc>
12726 Indices of the first elements of value sequences of particular metrics
12727 returned in @c returnData.
12728 </desc>
12729 </param>
12730 <param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
12731 <desc>
12732 Lengths of value sequences of particular metrics.
12733 </desc>
12734 </param>
12735 <param name="returnData" type="long" dir="return" safearray="yes">
12736 <desc>
12737 Flattened array of all metric data containing sequences of values for
12738 each metric.
12739 </desc>
12740 </param>
12741 </method>
12742
12743 </interface>
12744
12745 <module name="VBoxSVC" context="LocalServer">
12746 <class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
12747 namespace="virtualbox.org">
12748 <interface name="IVirtualBox" default="yes"/>
12749 </class>
12750 </module>
12751
12752 <module name="VBoxC" context="InprocServer" threadingModel="Free">
12753 <class name="Session" uuid="3C02F46D-C9D2-4f11-A384-53F0CF917214"
12754 namespace="virtualbox.org">
12755 <interface name="ISession" default="yes"/>
12756 </class>
12757 </module>
12758
12759</library>
12760
12761</idl>
12762
12763<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->
Note: See TracBrowser for help on using the repository browser.

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