VirtualBox.xidl revision 50453af238fcec34bf98f91cc4c32bf57f738bd3
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * :tabSize=2:indentSize=2:noTabs=true:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * :folding=explicit:collapseFolds=1:
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync * Master declaration for VirtualBox's Main API, represented
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * by COM/XPCOM and web service interfaces.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * From this document, the build system generates several files
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * via XSLT that are then used during the build process.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * Below is the list of XSL templates that operate on this file and
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * output files they generate. These XSL templates must be updated
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * whenever the schema of this file changes:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * out/<platform>/bin/sdk/idl/VirtualBox.idl
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * (MS COM interface definition file for Main API)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * (XPCOM interface definition file for Main API)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * out/<platform>/obj/src/VBox/Main/VirtualBox.idl
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * (pseudo-IDL for Doxygen to generate the official Main API
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * documentation)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * 4. src/VBox/Main/webservice/*.xsl =>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * a bunch of WSDL and C++ files
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * (VirtualBox web service sources and SOAP mappers;
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * see src/VBox/Main/webservice/Makefile.kmk for details)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * 5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * (smart Qt-based C++ wrapper classes for COM interfaces
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * of the Main API)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * 6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * (Main API TypeLib block for the WiX installer)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * 7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * out/<platform>/obj/Runtime/errmsgvboxcomdata.h
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * (<result> extraction for the %Rhrc format specifier)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Copyright (C) 2006-2009 Sun Microsystems, Inc.
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync This file is part of VirtualBox Open Source Edition (OSE), as
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync available from http://www.virtualbox.org. This file is free software;
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync you can redistribute it and/or modify it under the terms of the GNU
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync General Public License (GPL) as published by the Free Software
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync Foundation, in version 2 as it comes in the "COPYING" file of the
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync VirtualBox OSE distribution. VirtualBox OSE is distributed in the
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync Clara, CA 95054 USA or visit http://www.sun.com if you need
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync additional information or have any questions.
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync describes the so-called <i>VirtualBox Main API</i> which comprises all public
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync COM interfaces and components provided by the VirtualBox server and by the
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync VirtualBox client library.
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync VirtualBox employs a client-server design, meaning that whenever any part of
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync interface or any virtual machine --, a dedicated server process named
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync VBoxSVC runs in the background. This allows multiple processes working with
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync VirtualBox to cooperate without conflicts. These processes communicate to each
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync other using inter-process communication facilities provided by the COM
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync implementation of the host computer.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync implementation. On all other platforms, Mozilla XPCOM, an open-source COM
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync implementation, is used.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync All the parts that a typical VirtualBox user interacts with (the Qt GUI,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the VBoxManage command-line interface and the VBoxVRDP server) are technically
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync front-ends to the Main API and only use the interfaces that are documented
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync in this Main API documentation. This ensures that, with any given release
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync version of VirtualBox, all capabilities of the product that could be useful
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to an external client program are always exposed by way of this API.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
e94ff1af89bf631c68367d4e291ddbb491b5e5c0vboxsync contains two public component classes:
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync <tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
e94ff1af89bf631c68367d4e291ddbb491b5e5c0vboxsync implement IVirtualBox and ISession interfaces respectively. These two classes
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync are of supreme importance and will be needed in order for any front-end
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync program to do anything useful. It is recommended to read the documentation of
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync the mentioned interfaces first.
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync there can be only one object of this class on the local machine at any given
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync time. This object is a parent of many other objects in the VirtualBox COM
e94ff1af89bf631c68367d4e291ddbb491b5e5c0vboxsync library and lives in the VBoxSVC process. In fact, when you create an instance
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
e94ff1af89bf631c68367d4e291ddbb491b5e5c0vboxsync process is already running, starts it if not, and returns you a reference to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the <tt>VirtualBox</tt> object created in this process. When the last reference
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to this object is released, the VBoxSVC process ends (with a 5 second delay to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync protect from too frequent restarts).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync as many <tt>Session</tt> objects as you need but all of them will live in a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync process which issues the object instantiation call. <tt>Session</tt> objects
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync represent virtual machine sessions which are used to configure virtual
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machines and control their execution.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync/* currently, nsISupportsImpl.h lacks the below-like macros */
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync NS_IMPL_THREADSAFE_ADDREF(_class) \
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync NS_IMPL_THREADSAFE_RELEASE(_class) \
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync NS_IMPL_THREADSAFE_ADDREF(_class) \
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync NS_IMPL_THREADSAFE_RELEASE(_class) \
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync NS_INTERFACE_MAP_BEGIN(_class) \
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync NS_IMPL_QUERY_CLASSINFO(_class) \
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync NS_INTERFACE_MAP_END
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync _i2, _ic2) \
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync NS_INTERFACE_MAP_BEGIN(_class) \
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync NS_IMPL_QUERY_CLASSINFO(_class) \
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync NS_INTERFACE_MAP_END
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync NS_IMPL_THREADSAFE_ADDREF(_class) \
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync NS_IMPL_THREADSAFE_RELEASE(_class) \
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync _i2, _ic2) \
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync NS_IMPL_THREADSAFE_ADDREF(_class) \
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync NS_IMPL_THREADSAFE_RELEASE(_class) \
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync _i2, _ic2) \
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name="VirtualBox"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync version="1.3"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync desc="VirtualBox Type Library"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync supportsErrorInfo="yes"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync // COM result codes for VirtualBox
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync /////////////////////////////////////////////////////////////////////////
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This section describes all VirtualBox-specific COM result codes that may
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync be returned by methods of VirtualBox COM interfaces in addition to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync standard COM result codes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that along with the result code, every VirtualBox method returns
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync extended error information through the IVirtualBoxErrorInfo interface on
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync failure. This interface is a preferred way to present the error to the end
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync user because it contains a human readable description of the error. Raw
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync result codes, both standard and described in this section, are intended to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync be used by programs to analyze the reason of a failure and select an
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync appropriate course of action without involving the end user (for example,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync retry the operation later or make a different call).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The standard COM result codes that may originate from our methods include:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returned when the value of the method's argument is not within the range
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync of valid values. This should not be confused with situations when the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync value is within the range but simply doesn't suit the current object
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync state and there is a possibility that it will be accepted later (in such
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync cases VirtualBox-specific codes are returned, for example,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returned if a memory pointer for the output argument is invalid (for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync example, <tt>NULL</tt>). Note that when pointers representing input
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync arguments (such as strings) are invalid, E_INVALIDARG is returned.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returned when the called object is not ready. Since the lifetime of a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync public COM object cannot be fully controlled by the implementation,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync VirtualBox maintains the readiness state for all objects it creates and
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync returns this code in response to any method call on the object that was
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync deactivated by VirtualBox and is not functioning any more.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returned when a memory allocation operation fails.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </descGroup>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync everything in <result>/<desc> after (and including) the first dot, so express
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the matter of the error code in the first sentence and keep it short.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Object corresponding to the supplied arguments does not exist.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Current virtual machine state prevents the operation.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine error occurred attempting the operation.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync File not accessible or erroneous file contents.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Runtime subsystem error.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Pluggable Device Manager error.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Current object state prohibits operation.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Host operating system related error.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Requested operation is not supported.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <result name="VBOX_E_XML_ERROR" value="0x80BB000A">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Invalid XML found.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Current session state prohibits operation.
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync <result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Object being in use prohibits operation.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync everything in <result>/<desc> after (and including) the first dot, so express
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the matter of the error code in the first sentence and keep it short.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <descGroup/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync // all common enums
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync /////////////////////////////////////////////////////////////////////////
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name="TSBool"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="523ff64d-842a-4b1a-80e7-c311b028cb3a"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Boolean variable having a third state, default.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name="AccessMode"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Access mode for opening files.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name="MachineState"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="73bf04d0-7c4f-4684-9abf-d65a9ad74343"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine execution state.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This enumeration represents possible values of the <link
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to="IMachine::state"/> attribute.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Below is the basic virtual machine state diagram. It shows how the state
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync changes during virtual machine execution. The text in square braces shows
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync a method of the IConsole interface that performs the given state
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync transition.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync +---------[powerDown()] <- Stuck <--[failure]-+
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync +-> PoweredOff --+-->[powerUp()]--> Starting --+ | +-----[resume()]-----+
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync | | | | V |
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync | Aborted -----+ +--> Running --[pause()]--> Paused
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync | | ^ | ^ |
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync | Saved -----------[powerUp()]--> Restoring -+ | | | |
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync | ^ | | | |
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync | | +-----------------------------------------+-|-------------------+ +
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync | | +-- Saving <--------[takeSnapshot()]<-------+---------------------+
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync | +-------- Saving <--------[saveState()]<----------+---------------------+
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync +-------------- Stopping -------[powerDown()]<----------+---------------------+
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that states to the right from PoweredOff, Aborted and Saved in the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync above diagram are called <i>online VM states</i>. These states
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync represent the virtual machine which is being executed in a dedicated
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync process (usually with a GUI window attached to it where you can see the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync activity of the virtual machine and interact with it). There are two
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync special pseudo-states, FirstOnline and LastOnline, that can be used in
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync relational expressions to detect if the given machine state is online or
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync if (machine.GetState() >= MachineState_FirstOnline &&
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync ...the machine is being executed...
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync When the virtual machine is in one of the online VM states (that is, being
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync executed), only a few machine settings can be modified. Methods working
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync with such settings contain an explicit note about that. An attempt to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync change any oter setting or perform a modifying operation during this time
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync All online states except Running, Paused and Stuck are transitional: they
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync represent temporary conditions of the virtual machine that will last as
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync long as the operation that initiated such a condition.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The Stuck state is a special case. It means that execution of the machine
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync has reached the "Guru Meditation" condition. This condition indicates an
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync internal VMM (virtual machine manager) failure which may happen as a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync result of either an unhandled low-level virtual hardware exception or one
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync of the recompiler exceptions (such as the <i>too-many-traps</i>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync condition).
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync Note also that any online VM state may transit to the Aborted state. This
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync happens if the process that is executing the virtual machine terminates
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync unexpectedly (for example, crashes). Other than that, the Aborted state is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync equivalent to PoweredOff.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync There are also a few additional state diagrams that do not deal with
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync virtual machine execution and therefore are shown separately. The states
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync shown on these diagrams are called <i>offline VM states</i> (this includes
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync PoweredOff, Aborted and Saved too).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The first diagram shows what happens when a lengthy setup operation is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync being executed (such as <link to="IMachine::attachHardDisk"/>).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync +-----------------------------------(same sate as before the call)------+
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync +-> PoweredOff --+ |
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync |-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync +-> Saved -------+
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The next two diagrams demonstrate the process of taking a snapshot of a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync powered off virtual machine and performing one of the "discard..."
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync operations, respectively.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync +-----------------------------------(same sate as before the call)------+
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync +-> PoweredOff --+ |
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync | +-->[takeSnapshot()] -------------------> Saving ------+
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync +-> Aborted -----+
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync +-> PoweredOff --+
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync | Aborted -----+-->[discardSnapshot() ]-------------> Discarding --+
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync | | [discardCurrentState()] |
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync +-> Saved -------+ [discardCurrentSnapshotAndState()] |
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync +---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that the Saving state is present in both the offline state group and
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync online state group. Currently, the only way to determine what group is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync assumed in a particular case is to remember the previous machine state: if
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync it was Running or Paused, then Saving is an online state, otherwise it is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync an offline state. This inconsistency may be removed in one of the future
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync versions of VirtualBox by adding a new state.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync For whoever decides to touch this enum: In order to keep the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync comparisons involving FirstOnline and LastOnline pseudo-states valid,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the numeric values of these states must be correspondingly updated if
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync needed: for any online VM state, the condition
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <tt>FirstOnline <= state <= LastOnline</tt> must be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <tt>true</tt>. The same relates to transient states for which
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The machine is not running.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The machine is not currently running, but the execution state of the machine
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync has been saved to an external file when it was running.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The process running the machine has terminated abnormally.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The machine is currently being executed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync For whoever decides to touch this enum: In order to keep the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync comparisons in the old source code valid, this state must immediately
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync precede the Paused state.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Execution of the machine has been paused.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync For whoever decides to touch this enum: In order to keep the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync comparisons in the old source code valid, this state must immediately
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync follow the Running state.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Execution of the machine has reached the "Guru Meditation"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Machine is being started after powering it on from a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync zero execution state.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Machine is being normally stopped powering it off, or after the guest OS
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync has initiated a shutdown sequence.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Machine is saving its execution state to a file or an online
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync snapshot of the machine is being taken.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Execution state of the machine is being restored from a file
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync after powering it on from the saved execution state.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Snapshot of the machine is being discarded.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Lengthy setup operation is in progress.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="FirstOnline" value="4" wsmap="suppress"> <!-- Running -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Pseudo-state: first online state (for use in relational expressions).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="LastOnline" value="10" wsmap="suppress"> <!-- Restoring -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Pseudo-state: last online state (for use in relational expressions).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="FirstTransient" value="7" wsmap="suppress"> <!-- Starting -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Pseudo-state: first transient state (for use in relational expressions).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="LastTransient" value="12" wsmap="suppress"> <!-- SettingUp -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Pseudo-state: last transient state (for use in relational expressions).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name="SessionState"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="CF2700C0-EA4B-47ae-9725-7810114B94D8"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Session state. This enumeration represents possible values of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IMachine::sessionState"/> and <link to="ISession::state"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync attributes. See individual enumerator descriptions for the meaning for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync every value.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The machine has no open sessions (<link to="IMachine::sessionState"/>);
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the session is closed (<link to="ISession::state"/>)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The machine has an open direct session (<link to="IMachine::sessionState"/>);
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync A new (direct) session is being opened for the machine
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync as a result of <link to="IVirtualBox::openRemoteSession"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the session is currently being opened
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync as a result of <link to="IVirtualBox::openRemoteSession"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The direct session is being closed (<link to="IMachine::sessionState"/>);
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the session is being closed (<link to="ISession::state"/>)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name="SessionType"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Session type. This enumeration represents possible values of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Direct session
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Remote session
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (opened by <link to="IVirtualBox::openRemoteSession"/>)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Existing session
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (opened by <link to="IVirtualBox::openExistingSession"/>)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name="DeviceType"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Device type.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Null value, may also mean "no device" (not allowed for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name="DeviceActivity"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Device activity for <link to="IConsole::getDeviceActivity"/>.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name="ClipboardMode"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="33364716-4008-4701-8f14-be0fa3d62950"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Host-Guest clipboard interchange mode.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name="Scope"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Scope of the operation.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync A generic enumeration used in various methods to define the action or
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync argument scope.
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync name="GuestStatisticType"
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync uuid="aa7c1d71-aafe-47a8-9608-27d2d337cf55"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Statistics type for <link to="IGuest::getStatistic"/>.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Idle CPU load (0-100%) for last interval.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Kernel CPU load (0-100%) for last interval.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync User CPU load (0-100%) for last interval.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Total number of threads in the system.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Total number of processes in the system.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Total number of handles in the system.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Memory load (0-100%).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Total physical memory in megabytes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Free physical memory in megabytes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Ballooned physical memory in megabytes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Total amount of memory in the committed state in megabytes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Total amount of memory used by the guest OS's kernel in megabytes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Total amount of paged memory used by the guest OS's kernel in megabytes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Total amount of non-paged memory used by the guest OS's kernel in megabytes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Total amount of memory used by the guest OS's system cache in megabytes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Pagefile size in megabytes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Statistics sample number
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name="BIOSBootMenuMode"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync BIOS boot menu mode.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name="DriveState"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="cb7233b7-c519-42a5-8310-1830953cacbc"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name="ProcessorFeature"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="b8353b35-705d-4796-9967-ebfb7ba54af4"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync CPU features.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync // IVirtualBoxErrorInfo
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync /////////////////////////////////////////////////////////////////////////
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="e98b5376-8eb4-4eea-812a-3964bf3bb26f"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync supportsErrorInfo="no"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync wsmap="suppress"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The IVirtualBoxErrorInfo interface represents extended error information.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Extended error information can be set by VirtualBox components after
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync unsuccessful or partially successful method invocation. This information
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync can be retrieved by the calling party as an IVirtualBoxErrorInfo object
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync and then shown to the client in addition to the plain 32-bit result code.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In MS COM, this interface extends the IErrorInfo interface,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync in XPCOM, it extends the nsIException interface. In both cases,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync it provides a set of common attributes to retrieve error
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync information.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Sometimes invocation of some component's method may involve methods of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync other components that may also fail (independently of this method's
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync failure), or a series of non-fatal errors may precede a fatal error that
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync causes method failure. In cases like that, it may be desirable to preserve
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync information about all errors happened during method invocation and deliver
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync it to the caller. The <link to="#next"/> attribute is intended
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync specifically for this purpose and allows to represent a chain of errors
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync through a single IVirtualBoxErrorInfo object set after method invocation.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that errors are stored to a chain in the reverse order, i.e. the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync initial error object you query right after method invocation is the last
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync error set by the callee, the object it points to in the @a next attribute
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync is the previous error and so on, up to the first error (which is the last
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync in the chain).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="resultCode" type="result" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Result code of the error.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Usually, it will be the same as the result code returned
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync by the method that provided this error information, but not
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync always. For example, on Win32, CoCreateInstance() will most
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync likely return E_NOINTERFACE upon unsuccessful component
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync instantiation attempt, but not the value the component factory
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In MS COM, there is no equivalent.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In XPCOM, it is the same as nsIException::result.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="interfaceID" type="uuid" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync UUID of the interface that defined the error.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In MS COM, it is the same as IErrorInfo::GetGUID.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In XPCOM, there is no equivalent.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="component" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Name of the component that generated the error.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In MS COM, it is the same as IErrorInfo::GetSource.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In XPCOM, there is no equivalent.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="text" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Text description of the error.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In MS COM, it is the same as IErrorInfo::GetDescription.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In XPCOM, it is the same as nsIException::message.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync Next error object if there is any, or @c null otherwise.
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync In MS COM, there is no equivalent.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In XPCOM, it is the same as nsIException::inner.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </interface>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync // IVirtualBox
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync /////////////////////////////////////////////////////////////////////////
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="5516cc08-fb81-47a6-b184-031e7bbd2997"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync wsmap="suppress"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The execution state of the given machine has changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>ID of the machine this event relates to.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Any of the settings of the given machine has changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>ID of the machine this event relates to.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when someone tries to change extra data for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync either the given machine or (if null) global extra data.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This gives the chance to veto against changes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync ID of the machine this event relates to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (null ID for global extra data change requests).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Extra data key for the attempted write.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Extra data value for the given key.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Optional error message describing the reason of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync veto (ignored if this notification returns @c true).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="allowChange" type="boolean" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Flag to indicate whether the callee agrees (@c true)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync or vetoes against the change (@c false).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when machine specific or global extra data
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync has changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync ID of the machine this event relates to.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Null for global extra data changes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Extra data key that has changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Extra data value for the given key.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The given media was registered or unregistered
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync within this VirtualBox installation.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The @a mediaType parameter describes what type of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync media the specified @a mediaId refers to. Possible
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync values are:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li><link to="DeviceType_HardDisk"/>: the media is a hard disk
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync that, if registered, can be obtained using the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li><link to="DeviceType_DVD"/>: the media is a CD/DVD image
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync that, if registered, can be obtained using the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li><link to="DeviceType_Floppy"/>: the media is a Floppy image
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync that, if registered, can be obtained using the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBox::getFloppyImage"/> call.</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that if this is a deregistration notification,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync there is no way to access the object representing the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync unregistered media. It is supposed that the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync application will do required cleanup based on the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @a mediaId value.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>ID of the media this event relates to.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="mediaType" type="DeviceType" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Type of the media this event relates to.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If true, the media was registered, otherwise it was
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync unregistered.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The given machine was registered or unregistered
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync within this VirtualBox installation.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>ID of the machine this event relates to.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If true, the machine was registered, otherwise it was
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync unregistered.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The state of the session for the given machine was changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>ID of the machine this event relates to.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync A new snapshot of the machine has been taken.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>ID of the machine this event relates to.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Snapshot of the given machine has been discarded.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This notification is delivered <b>after</b> the snapshot
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync object has been uninitialized on the server (so that any
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync attempt to call its methods will return an error).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>ID of the machine this event relates to.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync ID of the discarded snapshot. <tt>null</tt> means the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync current machine state has been discarded (restored from
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the current snapshot).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Snapshot properties (name and/or description) have been changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>ID of the machine this event relates to.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when a guest property has changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync ID of the machine this event relates to.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The name of the property that has changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The new property value.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The new property flags.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </interface>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync wsmap="managed"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The IDHCPServer interface represents the vbox dhcp server configuration.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync To enumerate all the dhcp servers on the host, use the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync specifies if the dhcp server is enabled
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="IPAddress" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync specifies server IP
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="networkMask" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync specifies server network mask
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="networkName" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync specifies internal network name the server is used for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="lowerIP" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync specifies from IP adrres in server address range
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="upperIP" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync specifies to IP adrres in server address range
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync configures the server
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync invalid configuration supplied
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync server IP address
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync server network mask
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="FromIPAddress" type="wstring" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync server From IP address for address range
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync server To IP address for address range
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Starts DHCP server process.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Failed to start the process.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Name of internal network DHCP server should attach to.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Name of internal network trunk.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Type of internal network trunk.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Stops DHCP server process.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Failed to stop the process.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </interface>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="779264f4-65ed-48ed-be39-518ca549e296"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync wsmap="managed"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The IVirtualBox interface represents the main interface exposed by the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync product that provides virtual machine management.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync An instance of IVirtualBox is required for the product to do anything
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync useful. Even though the interface does not expose this, internally,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync IVirtualBox is implemented as a singleton and actually lives in the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync process of the VirtualBox server (VBoxSVC.exe). This makes sure that
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync IVirtualBox can track the state of all virtual machines on a particular
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync host, regardless of which frontend started them.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync To enumerate all the virtual machines on the host, use the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="version" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync A string representing the version number of the product. The
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync format is 3 integer numbers divided by dots (e.g. 1.0.1). The
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync last number represents the build number and will frequently change.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="revision" type="unsigned long" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The internal build revision number of the product.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="packageType" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync A string representing the package type of this product. The
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="homeFolder" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Full path to the directory where the global settings file,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In this version of VirtualBox, the value of this property is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync always <tt><user_dir>/.VirtualBox</tt> (where
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <tt><user_dir></tt> is the path to the user directory,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync as determined by the host OS), and cannot be changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This path is also used as the base to resolve relative paths in
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync places where relative paths are allowed (unless otherwise
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync expressly indicated).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="settingsFilePath" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Full name of the global settings file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The value of this property corresponds to the value of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="settingsFileVersion" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Current version of the format of the global VirtualBox settings file
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The version string has the following format:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync where <tt>x</tt> and <tt>y</tt> are the major and the minor format
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync versions, and <tt>platform</tt> is the platform identifier.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The current version usually matches the value of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#settingsFormatVersion"/> attribute unless the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync settings file was created by an older version of VirtualBox and there
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync was a change of the settings file format since then.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that VirtualBox automatically converts settings files from older
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync versions to the most recent version when reading them (usually at
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync VirtualBox startup) but it doesn't save the changes back until
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync you call a method that implicitly saves settings (such as
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#setExtraData"/>) or call <link to="#saveSettings"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync explicitly. Therefore, if the value of this attribute differs from the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync value of <link to="#settingsFormatVersion"/>, then it
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync means that the settings file was converted but the result of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync conversion is not yet saved to disk.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The above feature may be used by interactive front-ends to inform users
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync about the settings file format change and offer them to explicitly save
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync all converted settings files (the global and VM-specific ones),
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync optionally create backup copies of the old settings files before saving,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <see>settingsFormatVersion, saveSettingsWithBackup()</see>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="settingsFormatVersion" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Most recent version of the settings file format.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The version string has the following format:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync where <tt>x</tt> and <tt>y</tt> are the major and the minor format
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync versions, and <tt>platform</tt> is the platform identifier.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync VirtualBox uses this version of the format when saving settings files
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (either as a result of method calls that require to save settings or as
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync a result of an explicit call to <link to="#saveSettings"/>).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="host" type="IHost" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="systemProperties" type="ISystemProperties" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Array of machine objects registered within this VirtualBox instance.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="hardDisks" type="IHardDisk" readonly="yes" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Array of hard disk objects known to this VirtualBox installation.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This array contains only base (root) hard disks. All differencing
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync hard disks of the given base hard disk can be enumerated using
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="DVDImages" type="IDVDImage" readonly="yes" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Array of CD/DVD image objects registered with this VirtualBox instance.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="floppyImages" type="IFloppyImage" readonly="yes" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Array of floppy image objects registered with this VirtualBox instance.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Collection of global shared folders. Global shared folders are
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync available to all virtual machines.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync New shared folders are added to the collection using
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#createSharedFolder"/>. Existing shared folders can be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In the current version of the product, global shared folders are not
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync implemented and therefore this collection is always empty.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Associated performance collector object.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync dhcp server settings.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Creates a new virtual machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The new machine is created unregistered, with the initial configuration
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync set according to the specified guest OS type. A typical sequence of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync actions to create a new virtual machine is as follows:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Call this method to have a new machine created. The returned machine
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync object will be "mutable" allowing to change any machine property.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Configure the machine using the appropriate attributes and methods.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Call <link to="IMachine::saveSettings" /> to write the settings
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to the machine's XML settings file. The configuration of the newly
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync created machine will not be saved to disk until this method is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Call <link to="#registerMachine" /> to add the machine to the list
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync of machines known to VirtualBox.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync You should specify valid name for the newly created machine when calling
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync this method. See the <link to="IMachine::name"/> attribute description
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync for more details about the machine name.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The specified guest OS type identifier must match an ID of one of known
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Every machine has a <i>settings file</i> that is used to store
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the machine configuration. This file is stored in a directory called the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <i>machine settings subfolder</i>. Both the settings subfolder and file
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync will have a name that corresponds to the name of the virtual machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync You can specify where to create the machine setting subfolder using the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @a baseFolder argument. The base folder can be absolute (full path) or
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync relative to the <link to="IVirtualBox::homeFolder">VirtualBox home
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync directory</link>.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If @a baseFolder is a null or empty string (which is recommended), the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="ISystemProperties::defaultMachineFolder">default machine
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync settings folder</link> will be used as a base folder for the created
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine. Otherwise the given base folder will be used. In either case,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the full path to the resulting settings file has the following
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <base_folder>/<machine_name>/<machine_name>.xml
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that if the resulting settings file already exists, this method
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Optionally, you may specify an UUID of to assign to the created machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync However, this is not recommended and you should normally pass an empty
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (null) UUID to this method so that a new UUID will be automatically
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync generated for every created machine. You can use UUID
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync 00000000-0000-0000-0000-000000000000 as null value.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync There is no way to change the name of the settings file or
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync subfolder of the created machine directly.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @a osTypeId is invalid.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Resulting settings file name is invalid or the settings file already
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync exists or could not be created due to an I/O error.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @a name is empty or null.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="machine" type="IMachine" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Creates a new virtual machine in "legacy" mode, using the specified
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync settings file to store machine settings.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync As opposed to machines created by <link to="#createMachine"/>,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the settings file of the machine created in "legacy" mode is not
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync automatically renamed when the machine name is changed -- it will always
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync remain the same as specified in this method call.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The specified settings file name can be absolute (full path) or relative
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to the <link to="IVirtualBox::homeFolder">VirtualBox home
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync directory</link>. If the file name doesn't contain an extension, the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync default extension (.xml) will be appended.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that the configuration of the newly created machine is not
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync saved to disk (and therefore no settings file is created)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync until <link to="IMachine::saveSettings"/> is called. If the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync specified settings file already exists, this method
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync See <link to="#createMachine"/> for more information.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @deprecated This method may be removed later. Use <link
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to="IVirtualBox::createMachine"/> instead.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync There is no way to change the name of the settings file
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync of the machine created in "legacy" mode.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @a osTypeId is invalid.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @a settingsFile is invalid or the settings file already exists or
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync could not be created due to an I/O error.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @a name or @a settingsFile is empty or null.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="settingsFile" type="wstring" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="machine" type="IMachine" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Opens a virtual machine from the existing settings file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The opened machine remains unregistered until you call
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The specified settings file name can be absolute
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (full path) or relative to the <link to="IVirtualBox::homeFolder">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync VirtualBox home directory</link>. This file must exist
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync and must be a valid machine settings file whose contents
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync will be used to construct the machine object.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @deprecated Will be removed soon.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Settings file name invalid, not found or sharing violation.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="settingsFile" type="wstring" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Name of the machine settings file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="machine" type="IMachine" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IMachine::settingsModified"/> will return
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync false for the created machine, until any of machine settings
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync are changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Registers the machine previously created using
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#openMachine"/> within this VirtualBox installation. After
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync successful method invocation, the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to all registered callbacks.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This method implicitly calls <link to="IMachine::saveSettings"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to save all current machine settings before registering it.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync No matching virtual machine found.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine was not created within this VirtualBox instance.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Attempts to find a virtual machine given its UUID.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync To look up a machine by name, use <link to="IVirtualBox::findMachine" />
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Could not find registered machine matching @a id.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="machine" type="IMachine" dir="return"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Attempts to find a virtual machine given its name.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync To look up a machine by UUID, use <link to="IVirtualBox::getMachine" />
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Could not find registered machine matching @a name.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="machine" type="IMachine" dir="return"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Unregisters the machine previously registered using
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#registerMachine"/>. After successful method invocation, the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to all registered callbacks.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The specified machine must not be in the Saved state, have an open
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (or a spawning) direct session associated with it, have snapshots or
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync have hard disks attached.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This method implicitly calls <link to="IMachine::saveSettings"/> to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync save all current machine settings before unregistering it.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If the given machine is inaccessible (see
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IMachine::accessible"/>), it will be unregistered and
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync fully uninitialized right afterwards. As a result, the returned
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine object will be unusable and an attempt to call
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <b>any</b> method will return the "Object not ready" error.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Could not find registered machine matching @a id.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Machine is in Saved state.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Machine has snapshot or open session or hard disk attached.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="machine" type="IMachine" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Creates a new appliance object, which represents an appliance in the Open Virtual Machine
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="appliance" type="IAppliance" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Creates a new base hard disk object that will use the given storage
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync format and location for hard disk data.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that the actual storage unit is not created by this method. In
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync order to do it, and before you are able to attach the created hard disk
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to virtual machines, you must call one of the following methods to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync allocate a format-specific storage unit at the specified location:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Some hard disk attributes, such as <link to="IHardDisk::id"/>, may
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync remain uninitialized until the hard disk storage unit is successfully
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync created by one of the above methods.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync After the storage unit is successfully created, the hard disk gets
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync remembered by this VirtualBox installation and will be accessible
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync through <link to="#getHardDisk"/> and <link to="#findHardDisk"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync methods. Remembered root (base) hard disks are also returned as part of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the <link to="#hardDisks"/> array. See IHardDisk for more details.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The list of all storage formats supported by this VirtualBox
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync installation can be obtained using
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="ISystemProperties::hardDiskFormats"/>. If the @a format
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync attribute is empty or <tt>null</tt> then the default storage format
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync be used for creating a storage unit of the hard disk.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that the format of the location string is storage format specific.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @a format identifier is invalid. See
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @a location is a not valid file name (for file-based formats only).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @a format is a null or empty string.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Identifier of the storage format to use for the new hard disk.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Location of the storage unit for the new hard disk.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="hardDisk" type="IHardDisk" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Opens a hard disk from an existing location.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync After the hard disk is successfully opened by this method, it gets
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync remembered by (known to) this VirtualBox installation and will be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#findHardDisk"/> methods. Remembered root (base) hard disks
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync are also returned as part of the <link to="#hardDisks"/> array and can
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync be attached to virtual machines. See IHardDisk for more details.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If a differencing hard disk is to be opened by this method, the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync operation will succeed only if its parent hard disk and all ancestors,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync if any, are already known to this VirtualBox installation (for example,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync were opened by this method before).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This method tries to guess the storage format of the specified hard disk
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync by reading hard disk data at the specified location.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If @a write is ReadWrite (which it should be), the image is opened for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync read/write access and must have according permissions, as VirtualBox
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync may actually write status information into the disk's metadata sections.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that write access is required for all typical image usage in VirtualBox,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync since VirtualBox may need to write metadata such as a UUID into the image.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The only exception is opening a source image temporarily for copying and
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync cloning when the image will quickly be closed again.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that the format of the location string is storage format specific.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Invalid hard disk storage file location.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Could not get hard disk storage format.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Invalid hard disk storage format.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Location of the storage unit that contains hard disk data in one of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the supported storage formats.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="accessMode" type="AccessMode" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Determines whether to open the image in read/write or read-only mode.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="hardDisk" type="IHardDisk" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns a hard disk with the given UUID.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The hard disk with the given UUID must be known to this VirtualBox
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync installation, i.e. it must be previously created by
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to="#openHardDisk"/>, or attached to some known virtual machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync No hard disk object matching @a id found.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="hardDisk" type="IHardDisk" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns a hard disk that uses the given location to store hard
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The given hard disk must be known to this VirtualBox installation, i.e.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync it must be previously created by
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to="#openHardDisk"/>, or attached to some known virtual machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The search is done by comparing the value of the @a location argument to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the <link to="IHardDisk::location"/> attribute of each known hard
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync For locations represented by file names in the host's file system, the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync requested location can be a path relative to the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync only a file name without any path is given, the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync folder</link> will be prepended to the file name before searching. Note
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync that on case sensitive file systems, a case sensitive comparison is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync performed, otherwise the case of symbols in the file path is ignored.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync No hard disk object matching @a location found.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="hardDisk" type="IHardDisk" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Opens a CD/DVD image contained in the specified file of the supported
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync format and assigns it the given UUID.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync After the image is successfully opened by this method, it gets
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync remembered by (known to) this VirtualBox installation and will be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#findDVDImage"/> methods. Remembered images are also
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync returned as part of the <link to="#DVDImages"/> array and can be mounted
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to virtual machines. See IMedium for more details.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync See <link to="IMedium::location"/> to get more details about the format
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync of the location string.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Currently only ISO 9960 CD/DVD images are supported by VirtualBox.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Full path to the file that contains a valid CD/DVD image.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync UUID to assign to the given image within this VirtualBox installation.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If an empty (null) UUID is specified, the system will randomly
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync generate a new UUID.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The image with the given UUID must be known to this VirtualBox
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync installation, i.e. it must be previously opened by <link
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to="#openDVDImage"/>, or mounted to some known virtual machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync No matching DVD image found in the media registry.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns a CD/DVD image with the given image location.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The image with the given UUID must be known to this VirtualBox
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync installation, i.e. it must be previously opened by <link
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to="#openDVDImage"/>, or mounted to some known virtual machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The search is done by comparing the value of the @a location argument to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the <link to="IMedium::location"/> attribute of each known CD/DVD image.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The requested location can be a path relative to the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync only a file name without any path is given, the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync folder</link> will be prepended to the file name before searching. Note
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync that on case sensitive file systems, a case sensitive comparison is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync performed, otherwise the case in the file path is ignored.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Invalid image file location.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync No matching DVD image found in the media registry.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Opens a floppy image contained in the specified file of the supported
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync format and assigns it the given UUID.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync After the image is successfully opened by this method, it gets
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync remembered by (known to) this VirtualBox installation and will be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync accessible through <link to="#getFloppyImage"/> and
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#findFloppyImage"/> methods. Remembered images are also
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync returned as part of the <link to="#floppyImages"/> array and can be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync mounted to virtual machines. See IMedium for more details.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync See <link to="IMedium::location"/> to get more details about the format
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync of the location string.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Floppy image specified by @a location not accessible.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Floppy image already exists in the media registry.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Currently, only raw floppy images are supported by VirtualBox.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Full path to the file that contains a valid floppy image.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync UUID to assign to the given image file within this VirtualBox
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync installation. If an empty (null) UUID is specified, the system will
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync randomly generate a new UUID.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="image" type="IFloppyImage" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns a floppy image with the given UUID.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The image with the given UUID must be known to this VirtualBox
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync installation, i.e. it must be previously opened by <link
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to="#openFloppyImage"/>, or mounted to some known virtual machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync No matching floppy image found in the media registry.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="image" type="IFloppyImage" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns a floppy image with the given image location.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The image with the given UUID must be known to this VirtualBox
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync installation, i.e. it must be previously opened by <link
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to="#openFloppyImage"/>, or mounted to some known virtual machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The search is done by comparing the value of the @a location argument to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the <link to="IMedium::location"/> attribute of each known floppy image.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The requested location can be a path relative to the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync only a file name without any path is given, the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync folder</link> will be prepended to the file name before searching. Note
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync that on case sensitive file systems, a case sensitive comparison is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync performed, otherwise the case of symbols in the file path is ignored.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Invalid image file location.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync No matching floppy image found in the media registry.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="image" type="IFloppyImage" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns an object describing the specified guest OS type.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The requested guest OS type is specified using a string which is a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync mnemonic identifier of the guest operating system, such as
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync particular virtual machine can be read or set using the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The <link to="IVirtualBox::guestOSTypes"/> collection contains all
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync available guest OS type objects. Each object has an
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IGuestOSType::id"/> attribute which contains an identifier of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the guest OS this object describes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @a id is not a valid Guest OS type.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="type" type="IGuestOSType" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Creates a new global shared folder by associating the given logical
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name with the given host path, adds it to the collection of shared
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync folders and starts sharing it. Refer to the description of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="ISharedFolder"/> to read more about logical names.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In the current implementation, this operation is not
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync implemented.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Unique logical name of the shared folder.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Full path to the shared folder in the host file system.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Whether the share is writable or readonly</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Removes the global shared folder with the given name previously
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync created by <link to="#createSharedFolder"/> from the collection of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync shared folders and stops sharing it.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In the current implementation, this operation is not
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync implemented.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Logical name of the shared folder to remove.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns the global extra data key name following the supplied key.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync An error is returned if the supplied @a key does not exist. @c NULL is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync returned in @a nextKey if the supplied key is the last key. When
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync supplying @c NULL or an empty string for the @a key, the first key item
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync is returned in @a nextKey (if there is any). @a nextValue is an optional
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync parameter and if supplied, the next key's value is returned in it.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Extra data @a key not found.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns associated global extra data.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If the requested data @a key does not exist, this function will
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync succeed and return @c NULL in the @a value argument.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Settings file not accessible.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Could not parse the settings file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Sets associated global extra data.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If you pass @c NULL as a key @a value, the given @a key will be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Before performing the actual data change, this method will ask all
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync registered callbacks using the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBoxCallback::onExtraDataCanChange"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync notification for a permission. If one of the callbacks refuses the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync new value, the change will not be performed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync On success, the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBoxCallback::onExtraDataChange"/> notification
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync is called to inform all registered callbacks about a successful data
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Settings file not accessible.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Could not parse the settings file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Modification request refused.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Opens a new direct session with the given virtual machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync A direct session acts as a local lock on the given VM.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync There can be only one direct session open at a time for every
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync virtual machine, protecting the VM from being manipulated by
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync conflicting actions from different processes. Only after a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync direct session has been opened, one can change all VM settings
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync and execute the VM in the process space of the session object.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Sessions therefore can be compared to mutex semaphores that
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync lock a given VM for modification and execution.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync See <link to="ISession">ISession</link> for details.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <note>Unless you are writing a new VM frontend, you will not
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync want to execute a VM in the current process. To spawn a new
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync process that executes a VM, use
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync instead.</note>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Upon successful return, the session object can be used to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync get access to the machine and to the VM console.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In VirtualBox terminology, the machine becomes "mutable" after
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync a session has been opened. Note that the "mutable" machine
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync object, on which you may invoke IMachine methods to change its
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync settings, will be a different object from the immutable IMachine
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync objects returned by various IVirtualBox methods. To obtain a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync mutable IMachine object (upon which you can invoke settings methods),
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync One must always call <link to="ISession::close" /> to release the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync lock on the machine, or the machine's state will eventually be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync set to "Aborted".
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In other words, to change settings on a machine, the following
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync sequence is typically performed:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>Call this method (openSession) to have a machine locked for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the current session.</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>Call <link to="IMachine::saveSettings" />.</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>Close the session by calling <link to="ISession::close"/>.</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine not registered.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Process not started by OpenRemoteSession.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync No matching virtual machine found.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Session already open or being opened.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Failed to assign machine to session.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Session object that will represent the opened session after
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync successful method invocation. This object must not represent
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the already open session.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This session will be automatically closed if the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync VirtualBox server is terminated for some reason.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>ID of the virtual machine to open a session with.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Spawns a new process that executes a virtual machine (called a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync "remote session").
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Opening a remote session causes the VirtualBox server to start a new
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync process that opens a direct session with the given VM. As a result, the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync VM is locked by that direct session in the new process, preventing
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync conflicting changes from other processes. Since sessions act as locks
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync that prevent conflicting changes, one cannot open a remote session
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync for a VM that already has another open session (direct or remote), or
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync is currently in the process of opening one (see <link
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to="IMachine::sessionState"/>).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync While the remote session still provides some level of control over the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync VM execution to the caller (using the <link to="IConsole" /> interface),
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync not all VM settings are available for modification within the remote
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync session context.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This operation can take some time (a new VM is started in a new process,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync for which memory and other resources need to be set up). Because of this,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync an <link to="IProgress" /> is returned to allow the caller to wait for this
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync asynchronous operation to be completed. Until then, the remote session
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync object remains in the closed state, and accessing the machine or its
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync console through it is invalid. It is recommended to use
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IProgress::waitForCompletion" /> or similar calls to wait for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync completion.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync As with all <link to="ISession" /> objects, it is recommended to call
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="ISession::close" /> on the local session object once openRemoteSession()
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync has been called. However, the session's state (see <link to="ISession::state" />)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync will not return to "Closed" until the remote session has also closed (i.e.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync until the VM is no longer running). In that case, however, the state of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the session will automatically change back to "Closed".
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Currently supported session types (values of the @a type
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync argument) are:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li><tt>vrdp</tt>: VirtualBox VRDP Server session</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The @a environment argument is a string containing definitions of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync environment variables in the following format:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync NAME[=VALUE]\n
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync NAME[=VALUE]\n
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync where <tt>\\n</tt> is the new line character. These environment
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync variables will be appended to the environment of the VirtualBox server
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync process. If an environment variable exists both in the server process
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync and in this list, the value from this list takes precedence over the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync server's variable. If the value of the environment variable is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync omitted, this variable will be removed from the resulting environment.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If the environment string is @c null, the server environment is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync inherited by the started process as is.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine not registered.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Invalid session type @a type.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync No machine matching @a machineId found.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Session already open or being opened.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Launching process for machine failed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Failed to assign machine to session.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Session object that will represent the opened remote session
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync after successful method invocation (this object must not
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync represent an already open session).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>ID of the virtual machine to open a session with.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Type of the remote session (case sensitive).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Environment to pass to the opened session (may be @c null).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="progress" type="IProgress" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Progress object to track the operation completion.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Opens a new remote session with the virtual machine for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync which a direct session is already open.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The remote session provides some level of control over the VM
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync execution (using the IConsole interface) to the caller; however,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync within the remote session context, not all VM settings are available
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync for modification.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync As opposed to <link to="#openRemoteSession"/>, the number of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync remote sessions opened this way is not limited by the API
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync It is an error to open a remote session with the machine that
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync doesn't have an open direct session.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine not registered.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync No machine matching @a machineId found.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Session already open or being opened.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Direct session state not Open.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Failed to get console object from direct session or assign
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine to session.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Session object that will represent the open remote session
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync after successful method invocation. This object must not
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync represent an already open session.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This session will be automatically closed when the peer
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (direct) session dies or gets closed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>ID of the virtual machine to open a session with.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Registers a new global VirtualBox callback. The methods of the given
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync callback object will be called by VirtualBox when an appropriate
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync event occurs.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync A @c NULL callback cannot be registered.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="callback" type="IVirtualBoxCallback" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Unregisters the previously registered global VirtualBox callback.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Specified @a callback not registered.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="callback" type="IVirtualBoxCallback" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Blocks the caller until any of the properties represented by the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @a what argument changes the value or until the given timeout interval
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The @a what argument is a comma separated list of property masks that
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync describe properties the caller is interested in. The property mask is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync a string in the following format:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync [[group.]subgroup.]name
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync where @c name is the property name and @c group, @c subgroup are zero
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync or more property group specifiers. Each element (group or name) in
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the property mask may be either a Latin string or an asterisk symbol
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (@c "*") which is used to match any string for the given element. A
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync property mask that doesn't contain asterisk symbols represents a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync single fully qualified property name.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Groups in the fully qualified property name go from more generic (the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync left-most part) to more specific (the right-most part). The first
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync element is usually a name of the object the property belongs to. The
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync second element may be either a property name, or a child object name,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync or an index if the preceding element names an object which is one of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync many objects of the same type. This way, property names form a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync hierarchy of properties. Here are some examples of property names:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <td><link to="IVirtualBox::version"/> property</td>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <td><link to="IMachine::name"/> property of the machine with the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync given UUID</td>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Most property names directly correspond to the properties of objects
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (components) provided by the VirtualBox library and may be used to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync track changes to these properties. However, there may be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync pseudo-property names that don't correspond to any existing object's
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync property directly, as well as there may be object properties that
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync don't have a corresponding property name that is understood by this
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync method, and therefore changes to such properties cannot be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync tracked. See individual object's property descriptions to get a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync fully qualified property name that can be used with this method (if
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync There is a special property mask @c "*" (i.e. a string consisting of a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync single asterisk symbol) that can be used to match all properties.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Below are more examples of property masks:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <td>Track all properties of the VirtualBox object</td>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <td>Track changes to the <link to="IMachine::name"/> property of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync all registered virtual machines</td>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This function is not implemented in the current version of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Comma separated list of property masks.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="timeout" type="unsigned long" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Wait timeout in milliseconds.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Specify -1 for an indefinite wait.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Comma separated list of properties that have been changed and caused
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync this method to return to the caller.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Saves the global settings to the global settings file
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This method is only useful for explicitly saving the global settings
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync file after it has been auto-converted from the old format to the most
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync recent format (see <link to="#settingsFileVersion"/> for details).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Normally, the global settings file is implicitly saved when a global
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync setting is changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Settings file not accessible.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Could not parse the settings file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Creates a backup copy of the global settings file
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (<link to="#settingsFilePath"/>) in case of auto-conversion, and then
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that the backup copy is created <b>only</b> if the settings file
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync auto-conversion took place (see <link to="#settingsFileVersion"/> for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync details). Otherwise, this call is fully equivalent to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#saveSettings"/> and no backup copying is done.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The backup copy is created in the same directory where the original
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync settings file is located. It is given the following file name:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync where <tt>original.xml</tt> is the original settings file name
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (excluding path), and <tt>x.y-platform</tt> is the version of the old
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync format of the settings file (before auto-conversion).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If the given backup file already exists, this method will try to add the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <tt>.N</tt> suffix to the backup file name (where <tt>N</tt> counts from
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync 0 to 9) and copy it again until it succeeds. If all suffixes are
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync occupied, or if any other copy error occurs, this method will return a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If the copy operation succeeds, the @a bakFileName return argument will
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync receive a full path to the created backup file (for informational
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync purposes). Note that this will happen even if the subsequent
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#saveSettings"/> call performed by this method after the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync copy operation, fails.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The VirtualBox API never calls this method. It is intended purely for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the purposes of creating backup copies of the settings files by
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync front-ends before saving the results of the automatically performed
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync settings conversion to disk.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Settings file not accessible.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Could not parse the settings file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Could not copy the settings file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="bakFileName" type="wstring" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <!--method name="createDHCPServerForInterface">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Creates a dhcp server settings to be used for the given interface
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync <result name="E_INVALIDARG">
e94ff1af89bf631c68367d4e291ddbb491b5e5c0vboxsync Host network interface @a name already exists.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="interface" type="IHostNetworkInterface" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Network Interface</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="server" type="IDHCPServer" dir="out">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Dhcp server settings</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </method-->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Creates a dhcp server settings to be used for the given internal network name
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Host network interface @a name already exists.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="server" type="IDHCPServer" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Searches a dhcp server settings to be used for the given internal network name
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Host network interface @a name already exists.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="server" type="IDHCPServer" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <!--method name="findDHCPServerForInterface">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Searches a dhcp server settings to be used for the given interface
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <result name="E_INVALIDARG">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Host network interface @a name already exists.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="interface" type="IHostNetworkInterface" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Network Interface</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="server" type="IDHCPServer" dir="out">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Dhcp server settings</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </method-->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Removes the dhcp server settings
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Host network interface @a name already exists.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </interface>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync // IAppliance
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync /////////////////////////////////////////////////////////////////////////
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name="CIMOSType"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="86ef5f8c-18b2-4db8-a314-33721b59f89b"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync OVF operating system values according to CIM V2.20 (as of Nov 2008); http://www.dmtf.org/standards/cim/cim_schema_v220
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Unknown" value="0" /> <!-- "Unknown" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Other" value="1" /> <!-- "Other" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_MACOS" value="2" /> <!-- "MACOS" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_ATTUNIX" value="3" /> <!-- "ATTUNIX" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_DGUX" value="4" /> <!-- "DGUX" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_DECNT" value="5" /> <!-- "DECNT" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Tru64UNIX" value="6" /> <!-- "Tru64 UNIX" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_OpenVMS" value="7" /> <!-- "OpenVMS" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_HPUX" value="8" /> <!-- "HPUX" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_AIX" value="9" /> <!-- "AIX" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_MVS" value="10" /> <!-- "MVS" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_OS400" value="11" /> <!-- "OS400" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_OS2" value="12" /> <!-- "OS/2" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_JavaVM" value="13" /> <!-- "JavaVM" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_MSDOS" value="14" /> <!-- "MSDOS" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_WIN3x" value="15" /> <!-- "WIN3x" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_WIN95" value="16" /> <!-- "WIN95" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_WIN98" value="17" /> <!-- "WIN98" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_WINNT" value="18" /> <!-- "WINNT" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_WINCE" value="19" /> <!-- "WINCE" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_NCR3000" value="20" /> <!-- "NCR3000" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_NetWare" value="21" /> <!-- "NetWare" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_OSF" value="22" /> <!-- "OSF" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_DCOS" value="23" /> <!-- "DC/OS" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_ReliantUNIX" value="24" /> <!-- "Reliant UNIX" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_SCOUnixWare" value="25" /> <!-- "SCO UnixWare" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_SCOOpenServer" value="26" /> <!-- "SCO OpenServer" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Sequent" value="27" /> <!-- "Sequent" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_IRIX" value="28" /> <!-- "IRIX" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Solaris" value="29" /> <!-- "Solaris" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_SunOS" value="30" /> <!-- "SunOS" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_U6000" value="31" /> <!-- "U6000" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_ASERIES" value="32" /> <!-- "ASERIES" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_HPNonStopOS" value="33" /> <!-- "HP NonStop OS" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_HPNonStopOSS" value="34" /> <!-- "HP NonStop OSS" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_BS2000" value="35" /> <!-- "BS2000" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_LINUX" value="36" /> <!-- "LINUX" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Lynx" value="37" /> <!-- "Lynx" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_XENIX" value="38" /> <!-- "XENIX" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_InteractiveUNIX" value="40" /> <!-- "Interactive UNIX" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_BSDUNIX" value="41" /> <!-- "BSDUNIX" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_FreeBSD" value="42" /> <!-- "FreeBSD" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_NetBSD" value="43" /> <!-- "NetBSD" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_GNUHurd" value="44" /> <!-- "GNU Hurd" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_OS9" value="45" /> <!-- "OS9" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_MACHKernel" value="46" /> <!-- "MACH Kernel" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Inferno" value="47" /> <!-- "Inferno" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_QNX" value="48" /> <!-- "QNX" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_EPOC" value="49" /> <!-- "EPOC" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_IxWorks" value="50" /> <!-- "IxWorks" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_VxWorks" value="51" /> <!-- "VxWorks" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_MiNT" value="52" /> <!-- "MiNT" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_BeOS" value="53" /> <!-- "BeOS" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_HPMPE" value="54" /> <!-- "HP MPE" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_NextStep" value="55" /> <!-- "NextStep" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_PalmPilot" value="56" /> <!-- "PalmPilot" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Rhapsody" value="57" /> <!-- "Rhapsody" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Windows2000" value="58" /> <!-- "Windows 2000" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Dedicated" value="59" /> <!-- "Dedicated" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_OS390" value="60" /> <!-- "OS/390" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_VSE" value="61" /> <!-- "VSE" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_TPF" value="62" /> <!-- "TPF" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_WindowsMe" value="63" /> <!-- "Windows (R) Me" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_CalderaOpenUNIX" value="64" /> <!-- "Caldera Open UNIX" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_OpenBSD" value="65" /> <!-- "OpenBSD" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_NotApplicable" value="66" /> <!-- "Not Applicable" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_WindowsXP" value="67" /> <!-- "Windows XP" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_zOS" value="68" /> <!-- "z/OS" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_MicrosoftWindowsServer2003" value="69" /> <!-- "Microsoft Windows Server 2003" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_MicrosoftWindowsServer2003_64" value="70" /> <!-- "Microsoft Windows Server 2003 64-Bit" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_WindowsXP_64" value="71" /> <!-- "Windows XP 64-Bit" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_WindowsXPEmbedded" value="72" /> <!-- "Windows XP Embedded" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_WindowsVista" value="73" /> <!-- "Windows Vista" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_WindowsVista_64" value="74" /> <!-- "Windows Vista 64-Bit" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_WindowsEmbeddedforPointofService" value="75" /> <!-- "Windows Embedded for Point of Service" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_MicrosoftWindowsServer2008" value="76" /> <!-- "Microsoft Windows Server 2008" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_MicrosoftWindowsServer2008_64" value="77" /> <!-- "Microsoft Windows Server 2008 64-Bit" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_FreeBSD_64" value="78" /> <!-- "FreeBSD 64-Bit" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_RedHatEnterpriseLinux" value="79" /> <!-- "RedHat Enterprise Linux" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_RedHatEnterpriseLinux_64" value="80" /> <!-- "RedHat Enterprise Linux 64-Bit" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Solaris_64" value="81" /> <!-- "Solaris 64-Bit" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_SUSE" value="82" /> <!-- "SUSE" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_SUSE_64" value="83" /> <!-- "SUSE 64-Bit" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_SLES" value="84" /> <!-- "SLES" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_SLES_64" value="85" /> <!-- "SLES 64-Bit" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_NovellOES" value="86" /> <!-- "Novell OES" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_NovellLinuxDesktop" value="87" /> <!-- "Novell Linux Desktop" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_SunJavaDesktopSystem" value="88" /> <!-- "Sun Java Desktop System" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Mandriva" value="89" /> <!-- "Mandriva" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Mandriva_64" value="90" /> <!-- "Mandriva 64-Bit" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_TurboLinux" value="91" /> <!-- "TurboLinux" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_TurboLinux_64" value="92" /> <!-- "TurboLinux 64-Bit" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Ubuntu" value="93" /> <!-- "Ubuntu" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Ubuntu_64" value="94" /> <!-- "Ubuntu 64-Bit" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Debian" value="95" /> <!-- "Debian" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Debian_64" value="96" /> <!-- "Debian 64-Bit" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Linux_2_4_x" value="97" /> <!-- "Linux 2.4.x" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Linux_2_4_x_64" value="98" /> <!-- "Linux 2.4.x 64-Bit" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Linux_2_6_x" value="99" /> <!-- "Linux 2.6.x" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Linux_2_6_x_64" value="100" /> <!-- "Linux 2.6.x 64-Bit" -->
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync <const name="CIMOS_Linux_64" value="101" /> <!-- "Linux 64-Bit" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <const name="CIMOS_Other_64" value="102" /> <!-- "Other 64-Bit" -->
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name="OVFResourceType"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="646a78d7-6f04-49f4-82c4-75c28a75a4cd"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync OVF resource type (as listed with CIM_ResourceAllocationSettingData; see for example
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync http://msdn.microsoft.com/en-us/library/cc136877(VS.85).aspx).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="a7a71c1f-20d3-4483-95c0-7357dda77f50"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync wsmap="managed"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Represents a platform-independent appliance in OVF format. An instance of this is returned
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync appliances with VirtualBox.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The OVF standard suggests two different physical file formats:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>If the OVF is distributed as a set of files, then @a file must be a fully qualified
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync path name to an existing OVF descriptor file with an <tt>.ovf</tt> file extension. If
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync this descriptor file references other files, as OVF appliances distributed as a set of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync files most likely do, those files must be in the same directory as the descriptor file.</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>If the OVF is distributed as a single file, it must be in TAR format and have the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync files and optionally other files.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync be added with a later version.</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <b>Importing</b> an OVF appliance into VirtualBox as instances of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IMachine" /> involves the following sequence of API calls:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>On the new object, call <link to="#read" /> with the full path of the OVF file you
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync would like to import. So long as this file is syntactically valid, this will succeed
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync and return an instance of IAppliance that contains the parsed data from the OVF file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync contents of the IAppliance attributes accordingly. These can be inspected by a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync instances of <link to="IVirtualSystemDescription" /> which represent the virtual
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync systems in the OVF, which in turn describe the virtual hardware prescribed by the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync OVF (network and hardware adapters, virtual disk images, memory size and so on).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The GUI can then give the user the option to confirm and/or change these suggestions.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync virtual system to override the suggestions made by the interpret() routine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>Finally, call <link to="#importMachines" /> to create virtual machines in
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync VirtualBox as instances of <link to="IMachine" /> that match the information in the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync virtual system descriptions.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync an empty IAppliance object.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>For each machine you would like to export, call <link to="IMachine::export" />
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync with the IAppliance object you just created. This creates an instance of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualSystemDescription" /> inside the appliance.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync virtual system to override the suggestions made by the export() routine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>Finally, call <link to="#write" /> with a path specification to have the OVF
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync file written.</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="path" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This attribute is empty until one of these methods has been called.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="disks" type="wstring" readonly="yes" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Array of virtual disk definitions. One such description exists for each
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync disk definition in the OVF; each string array item represents one such piece of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync disk information, with the information fields separated by tab (\t) characters.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The caller should be prepared for additional fields being appended to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync this string in future versions of VirtualBox and therefore check for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the number of tabs in the strings returned.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In the current version, the following eight fields are returned per string
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync in the array:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>Disk ID (unique string identifier given to disk)</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>Populated size (optional unsigned integer indicating the current size of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync disk; can be approximate; -1 if unspecified)</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>Format (string identifying the disk format, typically
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync "http://www.vmware.com/specifications/vmdk.html#sparse")</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>Reference (where to find the disk image, typically a file name; if empty,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync then the disk should be created on import)</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>Image size (optional unsigned integer indicating the size of the image,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync which need not necessarily be the same as the values specified above, since
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the image may be compressed or sparse; -1 if not specified)</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>Chunk size (optional unsigned integer if the image is split into chunks;
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync presently unsupported and always -1)</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc> Array of virtual system descriptions. One such description is created
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync for each virtual system found in the OVF.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (for export) has been called.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Reads an OVF file into the appliance object.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync mere fact that this method returns successfully does not mean that VirtualBox supports all
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync on whether the appliance is distributed as a set of files or as a single file, respectively).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Interprets the OVF data that was read when the appliance was constructed. After
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync calling this method, one can inspect the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#virtualSystemDescriptions" /> array attribute, which will then contain
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync one <link to="IVirtualSystemDescription" /> for each virtual machine found in
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the appliance.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Calling this method is the second step of importing an appliance into VirtualBox;
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync After calling this method, one should call <link to="#getWarnings" /> to find out
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync if problems were encountered during the processing which might later lead to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync and other interfaces that match the information contained in the appliance as
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync closely as possible, as represented by the import instructions in the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Calling this method is the final step of importing an appliance into VirtualBox;
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Since importing the appliance will most probably involve copying and converting
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync disk images, which can take a long time, this method operates asynchronously and
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync returns an IProgress object to allow the caller to monitor the progress.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aProgress" type="IProgress" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Writes the contents of the appliance exports into a new OVF file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Calling this method is the final step of exporting an appliance from VirtualBox;
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Since exporting the appliance will most probably involve copying and converting
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync disk images, which can take a long time, this method operates asynchronously and
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync returns an IProgress object to allow the caller to monitor the progress.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync on whether the appliance is distributed as a set of files or as a single file, respectively).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aProgress" type="IProgress" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Returns textual warnings which occured during execution of <link to="#interpret" />.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aWarnings" type="wstring" dir="return" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </interface>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name="VirtualSystemDescriptionType"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="325e7fec-ce06-4174-9654-98f99478d03f"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync a configuration value.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name="VirtualSystemDescriptionValueType"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Used with <link to="GetValuesByType" /> to describe the value
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync type to fetch.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name="IVirtualSystemDescription" extends="$unknown"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync wsmap="managed"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>This interface is used in the <link to="IAppliance::virtualSystemDescriptions" /> array.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync After <link to="IAppliance::interpret" /> has been called, that array contains
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync information about how the virtual systems described in the OVF should best be imported into VirtualBox
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync virtual machines. See <link to="IAppliance" /> for the steps required to import an OVF
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync into VirtualBox.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="count" type="unsigned long" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Return the number of virtual system description entries.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Returns information about the virtual system as arrays of instruction items. In each array, the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync items with the same indices correspond and jointly represent an import instruction for VirtualBox.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The list below identifies the value sets that are possible depending on the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="VirtualSystemDescriptionType" /> enum value in the array item in aTypes[]. In each case,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the array item with the same index in aOvfValues[] will contain the original value as contained
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync in the OVF file (just for informational purposes), and the corresponding item in aVboxValues[]
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync will contain a suggested value to be used for VirtualBox. Depending on the description type,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the aExtraConfigValues[] array item may also be used.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync "OS": the guest operating system type. There must be exactly one such array item on import. The
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync corresponding item in aVboxValues[] contains the suggested guest operating system for VirtualBox.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync item in aOvfValues[] will contain a numerical value that described the operating system in the OVF
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync "Name": the name to give to the new virtual machine. There can be at most one such array item;
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync if none is present on import, then an automatic name will be created from the operating system
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync type. The correponding item im aOvfValues[] will contain the suggested virtual machine name
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync from the OVF file, and aVboxValues[] will contain a suggestion for a unique VirtualBox
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IMachine" /> name that does not exist yet.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync "Description": an arbitrary description.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync "License": the EULA section from the OVF, if present. It is the responsibility of the calling
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync code to display such a license for agreement; the Main API does not enforce any such policy.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync "CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync "Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync is present on import, then VirtualBox will set a meaningful default based on the operating system
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync "HarddiskControllerIDE": an IDE hard disk controller. There can be at most one such item. This
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync has no value in aOvfValues[] or aVboxValues[].
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The matching item in the aRefs[] array will contain an integer that items of the "Harddisk"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync type can use to specify which hard disk controller a virtual disk should be connected to.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync "HarddiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync has no value in aOvfValues[] or aVboxValues[].
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The matching item in the aRefs[] array will be used as with IDE controllers (see above).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync "HarddiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The items in aOvfValues[] and aVboxValues[] will either be "LsiLogic" or "BusLogic".
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The matching item in the aRefs[] array will be used as with IDE controllers (see above).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync "HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The array item in aOvfValues[] will contain the file specification from the OVF file (without
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync a path since the image file should be in the same location as the OVF file itself), whereas the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync item in aVboxValues[] will contain a qualified path specification to where VirtualBox uses the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync hard disk image. This means that on import the image will be copied and converted from the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync "ovf" location to the "vbox" location; on export, this will be handled the other way round.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync On import, the target image will also be registered with VirtualBox.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The matching item in the aExtraConfigValues[] array must contain a string of the following
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync format: "controller=<index>;channel=<c>"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In this string, <index> must be an integer specifying the hard disk controller to connect
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the image to. That number must be the index of an array item with one of the hard disk controller
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync types (HarddiskControllerSCSI, HarddiskControllerSATA, HarddiskControllerIDE).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In addition, <c> must specify the channel to use on that controller. For IDE controllers,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync this can range from 0-2 (which VirtualBox will interpret as primary master, primary slave,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync secondary slave; VirtualBox reserves the secondary master for the CD-ROM drive). For SATA and
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync SCSI conrollers, the channel can range from 0-29.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync "NetworkAdapter": a network adapter. The array item in aVboxValues[] will specify the hardware
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync for the network adapter, whereas the array item in aExtraConfigValues[] will have a string
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync "USBController": a USB controller. There can be at most one such item. If and only if such an
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync item ispresent, USB support will be enabled for the new virtual machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync "SoundCard": a sound card. There can be at most one such item. If and only if such an item is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync present, sound support will be enabled for the new virtual machine. Note that the virtual
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync may be different from the virtual soundcard expected by the appliance.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aRefs" type="wstring" dir="out" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aOvfValues" type="wstring" dir="out" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aVboxValues" type="wstring" dir="out" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>This is the same as <link to="getDescription" /> except that you can specify which types
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync should be returned.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aType" type="VirtualSystemDescriptionType" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aRefs" type="wstring" dir="out" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aOvfValues" type="wstring" dir="out" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aVboxValues" type="wstring" dir="out" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>This is the same as <link to="getDescriptionByType" /> except that you can specify which
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync values.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aType" type="VirtualSystemDescriptionType" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aValues" type="wstring" dir="return" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This method allows the appliance's user to change the configuration for the virtual
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync system descriptions. For each array item returned from <link to="getDescription" />,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync you must pass in one boolean value and one configuration value.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Each item in the boolean array determines whether the particular configuration item
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync should be enabled.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync and SoundCard.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync For the "vbox" and "extra configuration" values, if you pass in the same arrays
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync as returned in the aVboxValues and aExtraConfigValues arrays from getDescription(),
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the configuration remains unchanged. Please see the documentation for getDescription()
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync for valid configuration values for the individual array item types. If the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync corresponding item in the aEnabled array is false, the configuration value is ignored.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aEnabled" type="boolean" dir="in" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aVboxValues" type="wstring" dir="in" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This method adds an additional description entry to the stack of already
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync available descriptions for this virtual system. This is handy for writing
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync values which aren't directly supported by VirtualBox. One example would
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync be the License type of <link to="VirtualSystemDescriptionType" />.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aType" type="VirtualSystemDescriptionType" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aExtraConfigValue" type="wstring" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </interface>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync // IMachine
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync /////////////////////////////////////////////////////////////////////////
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="2c88b969-7a74-4ef3-b95f-8a209a1535f3"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync internal="yes"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync wsmap="suppress"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Updates the VM state.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This operation will also update the settings file with
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the correct information about the saved state file
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync and delete this file from disk when appropriate.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Asks the server to run USB devices filters of the associated
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine against the given USB device and tell if there is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Intended to be used only for remote USB devices. Local
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync ones don't require to call this method (this is done
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync implicitly by the Host and USBProxyService).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="maskedInterfaces" type="unsigned long" dir="out"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Requests a capture of the given host USB device.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync When the request is completed, the VM process will
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync notification.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification that a VM is going to detach (done = false) or has
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync already detached (done = true) the given USB device.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync When the done = true request is completed, the VM process will
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync notification.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In the done = true case, the server must run its own filters
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync and filters of all VMs but this one on the detached device
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync as if it were just attached to the host computer.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Requests a capture all matching USB devices attached to the host.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync When the request is completed, the VM process will
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync notification per every captured device.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification that a VM that is being powered down. The done
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync parameter indicates whether which stage of the power down
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync we're at. When done = false the VM is announcing its
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync intentions, while when done = true the VM is reporting
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync what it has done.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In the done = true case, the server must run its own filters
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync and filters of all VMs but this one on all detach devices as
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync if they were just attached to the host computer.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Triggered by the given session object when the session is about
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to close normally.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="progress" type="IProgress" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Used to wait until the corresponding machine is actually
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync dissociated from the given session on the server.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returned only when this session is a direct one.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Called by the VM process to inform the server it wants to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync save the current state and stop the VM execution.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Progress object created by the VM process to wait until
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the state is saved.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="stateFilePath" type="wstring" dir="out">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync File path the VM process must save the execution state to.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Called by the VM process to inform the server that saving
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the state previously requested by #beginSavingState is either
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync successfully finished or there was a failure.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Settings file not accessible.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Could not parse the settings file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc><tt>true</tt> to indicate success and <tt>false</tt>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Gets called by IConsole::adoptSavedState.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Invalid saved state file path.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="savedStateFile" type="wstring" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Path to the saved state file to adopt.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Called by the VM process to inform the server it wants to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync take a snapshot.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Settings file not accessible.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Could not parse the settings file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>The console object that initiated this call.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Progress object created by the VM process to wait until
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the state is saved (only for online snapshots).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="stateFilePath" type="wstring" dir="out">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync File path the VM process must save the execution state to.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="serverProgress" type="IProgress" dir="out">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Progress object created by the server process to wait until
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the snapshot is taken (VDI diff creation, etc.).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Called by the VM process to inform the server that the snapshot
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync previously requested by #beginTakingSnapshot is either
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync successfully taken or there was a failure.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc><tt>true</tt> to indicate success and <tt>false</tt> otherwise</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Gets called by IConsole::discardSnapshot.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Snapshot has more than one child snapshot.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>The console object that initiated this call.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="machineState" type="MachineState" dir="out">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>New machine state after this operation is started.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="progress" type="IProgress" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Progress object to track the operation completion.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Gets called by IConsole::discardCurrentState.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine does not have any snapshot.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>The console object that initiated this call.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="machineState" type="MachineState" dir="out">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>New machine state after this operation is started.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="progress" type="IProgress" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Progress object to track the operation completion.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Gets called by IConsole::discardCurrentSnapshotAndState.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine does not have any snapshot.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>The console object that initiated this call.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="machineState" type="MachineState" dir="out">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>New machine state after this operation is started.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="progress" type="IProgress" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Progress object to track the operation completion.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Get the list of the guest properties matching a set of patterns along
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync with their values, time stamps and flags and give responsibility for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync managing properties to the console.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="name" type="wstring" dir="out" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The names of the properties returned.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="value" type="wstring" dir="out" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The values of the properties returned. The array entries match the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync corresponding entries in the @a name array.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The time stamps of the properties returned. The array entries match
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the corresponding entries in the @a name array.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="flags" type="wstring" dir="out" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The flags of the properties returned. The array entries match the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync corresponding entries in the @a name array.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Set the list of the guest properties matching a set of patterns along
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync with their values, time stamps and flags and return responsibility for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync managing properties to IMachine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="name" type="wstring" dir="in" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The names of the properties.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="value" type="wstring" dir="in" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The values of the properties. The array entries match the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync corresponding entries in the @a name array.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="timestamp" type="unsigned long long" dir="in" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The time stamps of the properties. The array entries match
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the corresponding entries in the @a name array.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="flags" type="wstring" dir="in" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The flags of the properties. The array entries match the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync corresponding entries in the @a name array.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Update a single guest property in IMachine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The name of the property to be updated.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The value of the property.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="timestamp" type="unsigned long long" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The timestamp of the property.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The flags of the property.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Locks all media attached to the machine for writing and parents of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync attahced different hard disks (if any) for reading. This operation is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync atomic so that if it fails no media is actually locked.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This method is intended to be called when the machine is in Starting or
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Restoring state. The locked media will be automatically unlocked when
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the machine is powered off or crashed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </interface>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync wsmap="managed"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The IBIOSSettings interface represents BIOS settings of the virtual
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Fade out flag for BIOS logo animation.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="logoDisplayTime" type="unsigned long">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>BIOS logo display time in milliseconds (0 = default).</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Local file system path for external BIOS image.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="bootMenuMode" type="BIOSBootMenuMode">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync IO APIC support flag. If set, VirtualBox will provide an IO APIC
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync and support IRQs above 15.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Offset in milliseconds from the host system time. This allows for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync guests running with a different system date/time than the host.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync It is equivalent to setting the system date/time in the BIOS except
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync it is not an absolute value but a relative one. Guest Additions
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync time synchronization honors this offset.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync PXE debug logging flag. If set, VirtualBox will write extensive
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync PXE trace information to the release log.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </interface>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="13420cbb-175a-4456-85d0-301126dfdec7"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync wsmap="managed"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The IMachine interface represents a virtual machine, or guest, created
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync in VirtualBox.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This interface is used in two contexts. First of all, a collection of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync objects implementing this interface is stored in the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBox::machines"/> attribute which lists all the virtual
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machines that are currently registered with this VirtualBox
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync installation. Also, once a session has been opened for the given virtual
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine (e.g. the virtual machine is running), the machine object
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync associated with the open session can be queried from the session object;
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The main role of this interface is to expose the settings of the virtual
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine and provide methods to change various aspects of the virtual
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine's configuration. For machine objects stored in the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBox::machines"/> collection, all attributes are
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync read-only unless explicitly stated otherwise in individual attribute
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync and method descriptions. In order to change a machine setting, a session
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync for this machine must be opened using one of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBox::openExistingSession"/> methods. After the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync session has been successfully opened, a mutable machine object needs to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync be queried from the session object and then the desired settings changes
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync can be applied to the returned object using IMachine attributes and
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync methods. See the ISession interface description for more information
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync about sessions.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that the IMachine interface does not provide methods to control
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync virtual machine execution (such as start the machine, or power it
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync down) -- these methods are grouped in a separate IConsole
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync interface. Refer to the IConsole interface description to get more
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync information about this topic.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="parent" type="IVirtualBox" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="accessible" type="boolean" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Whether this virtual machine is currently accessible or not.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The machine is considered to be inaccessible when:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>It is a registered virtual machine, and
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>Its settings file is inaccessible (for example, it is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync located on a network share that is not accessible during
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync VirtualBox startup, or becomes inaccessible later, or if
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the settings file can be read but is invalid).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Otherwise, the value of this property is always <tt>true</tt>.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Every time this property is read, the accessibility state of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync this machine is re-evaluated. If the returned value is |false|,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the <link to="#accessError"/> property may be used to get the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync detailed error information describing the reason of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync inaccessibility.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync When the machine is inaccessible, only the following properties
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync can be used on it:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync An attempt to access any other property or method will return
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The only possible action you can perform on an inaccessible
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine is to unregister it using the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBox::unregisterMachine"/> call (or, to check
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync for the accessibility state once more by querying this
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In the current implementation, once this property returns
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <tt>true</tt>, the machine will never become inaccessible
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync later, even if its settings file cannot be successfully
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync read/written any more (at least, until the VirtualBox
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync server is restarted). This limitation may be removed in
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync future releases.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Error information describing the reason of machine
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync inaccessibility.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Reading this property is only valid after the last call to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#accessible"/> returned <tt>false</tt> (i.e. the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine is currently unaccessible). Otherwise, a null
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync IVirtualBoxErrorInfo object will be returned.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Name of the virtual machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Besides being used for human-readable identification purposes
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync everywhere in VirtualBox, the virtual machine name is also used
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync as a name of the machine's settings file and as a name of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync subdirectory this settings file resides in. Thus, every time you
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync change the value of this property, the settings file will be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync renamed once you call <link to="#saveSettings"/> to confirm the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync change. The containing subdirectory will be also renamed, but
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync only if it has exactly the same name as the settings file
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync itself prior to changing this property (for backward compatibility
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync with previous API releases). The above implies the following
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync limitations:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>The machine name can contain only characters that are valid
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync file name characters according to the rules of the file
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync system used to store VirtualBox configuration.</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>You cannot have two or more machines with the same name
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync if they use the same subdirectory for storing the machine
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync settings files.</li>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li>You cannot change the name of the machine if it is running,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync or if any file in the directory containing the settings file
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync is being used by another running machine or by any other
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync process in the host operating system at a time when
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If any of the above limitations are hit, <link to="#saveSettings"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync will return an appropriate error message explaining the exact
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync reason and the changes you made to this machine will not be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync For "legacy" machines created using the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBox::createLegacyMachine"/> call,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the above naming limitations do not apply because the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine name does not affect the settings file name.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The settings file name remains the same as it was specified
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync during machine creation and never changes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Description of the virtual machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The description attribute can contain any text and is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync typically used to describe the hardware and software
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync configuration of the virtual machine in detail (i.e. network
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync settings, versions of the installed software and so on).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync User-defined identifier of the Guest OS type.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync an IGuestOSType object representing details about the given
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Guest OS type.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This value may differ from the value returned by
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IGuest::OSTypeId"/> if Guest Additions are
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync installed to the guest OS.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Hardware version identifier. Internal use only for now.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Number of virtual CPUs in the VM. In the current version of the product, this is always 1.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="memoryBalloonSize" type="unsigned long">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Initial memory balloon size in megabytes.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="statisticsUpdateInterval" type="unsigned long">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Initial interval to update guest statistics in seconds.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="accelerate3DEnabled" type="boolean" default="false">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This setting determines whether VirtualBox allows guests to make use
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync of the 3D graphics support available on the host. Currently limited
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to OpenGL only. </desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="monitorCount" type="unsigned long">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Number of virtual monitors.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Only effective on Windows XP and later guests with
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Guest Additions installed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This setting determines whether VirtualBox will try to make use of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the host CPU's hardware virtualization extensions such as Intel VT-x
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync and AMD-V. Note that in case such extensions are not available,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync they will not be used.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="HWVirtExNestedPagingEnabled" type="boolean" default="false">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This setting determines whether VirtualBox will try to make use of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the nested paging extension of Intel VT-x and AMD-V. Note that in case
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync such extensions are not available, they will not be used.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="HWVirtExVPIDEnabled" type="boolean" default="false">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This setting determines whether VirtualBox will try to make use of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the VPID extension of Intel VT-x. Note that in case such extensions are
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync not available, they will not be used.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="PAEEnabled" type="boolean" default="false">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This setting determines whether VirtualBox will expose the Physical Address
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync is not available, it will not be reported.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Full path to the directory used to store snapshot data
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (differencing hard disks and saved state files) of this machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The initial value of this property is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Currently, it is an error to try to change this property on
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync a machine that has snapshots (because this would require to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync move possibly large files to a different location).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync A separate method will be available for this purpose later.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Setting this property to <tt>null</tt> will restore the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync initial value.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync When setting this property, the specified path can be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync absolute (full path) or relative to the directory where the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#settingsFilePath">machine settings file</link>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync is located. When reading this property, a full path is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync always returned.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The specified path may not exist, it will be created
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync when necessary.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="VRDPServer" type="IVRDPServer" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="hardDiskAttachments" type="IHardDiskAttachment" readonly="yes" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Array of hard disks attached to this machine.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="DVDDrive" type="IDVDDrive" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="floppyDrive" type="IFloppyDrive" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="USBController" type="IUSBController" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Associated USB controller object.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This method may set a @ref com_warnings "warning result code".
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If USB functionality is not available in the given edition of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync VirtualBox, this method will set the result code to @c E_NOTIMPL.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Associated audio adapter, always present.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Array of storage controllers attached to this machine.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="settingsFilePath" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Full name of the file containing machine settings data.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="settingsFileVersion" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Current version of the format of the settings file of this machine
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The version string has the following format:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync where <tt>x</tt> and <tt>y</tt> are the major and the minor format
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync versions, and <tt>platform</tt> is the platform identifier.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The current version usually matches the value of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBox::settingsFormatVersion"/> attribute unless the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync settings file was created by an older version of VirtualBox and there
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync was a change of the settings file format since then.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that VirtualBox automatically converts settings files from older
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync versions to the most recent version when reading them (usually at
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync VirtualBox startup) but it doesn't save the changes back until
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync you call a method that implicitly saves settings (such as
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#setExtraData"/>) or call <link to="#saveSettings"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync explicitly. Therefore, if the value of this attribute differs from the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync value of <link to="IVirtualBox::settingsFormatVersion"/>, then it
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync means that the settings file was converted but the result of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync conversion is not yet saved to disk.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The above feature may be used by interactive front-ends to inform users
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync about the settings file format change and offer them to explicitly save
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync all converted settings files (the global and VM-specific ones),
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync optionally create backup copies of the old settings files before saving,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <see>IVirtualBox::settingsFormatVersion, saveSettingsWithBackup()</see>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="settingsModified" type="boolean" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Whether the settings of this machine have been modified
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (but neither yet saved nor discarded).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Reading this property is only valid on instances returned
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync by <link to="ISession::machine"/> and on new machines
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync created by <link to="IVirtualBox::createMachine"/> or opened
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync yet registered, or on unregistered machines after calling
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBox::unregisterMachine"/>. For all other
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync cases, the settings can never be modified.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync For newly created unregistered machines, the value of this
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync property is always TRUE until <link to="#saveSettings"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync is called (no matter if any machine settings have been
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync changed after the creation or not). For opened machines
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the value is set to FALSE (and then follows to normal rules).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="sessionState" type="SessionState" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Current session state for this machine.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="sessionType" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Type of the session. If <link to="#sessionState"/> is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync SessionSpawning or SessionOpen, this attribute contains the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync same value as passed to the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBox::openRemoteSession"/> method in the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @a type parameter. If the session was opened directly using
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#sessionState"/> is SessionClosed, the value of this
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync attribute is @c null.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="sessionPid" type="unsigned long" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Identifier of the session process. This attribute contains the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync platform-dependent identifier of the process that has opened a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync direct session for this machine using the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBox::openSession"/> call. The returned value
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync is only valid if <link to="#sessionState"/> is SessionOpen or
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync SessionClosing (i.e. a session is currently open or being
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync closed) by the time this property is read.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="state" type="MachineState" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Current execution state of this machine.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="lastStateChange" type="long long" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Time stamp of the last execution state change,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync in milliseconds since 1970-01-01 UTC.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="stateFilePath" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Full path to the file that stores the execution state of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the machine when it is in the <link to="MachineState_Saved"/> state.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync When the machine is not in the Saved state, this attribute
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="logFolder" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Full path to the folder that stores a set of rotated log files
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync recorded during machine execution. The most recent log file is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync in the current version).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Current snapshot of this machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync A <tt>null</tt> object is returned if the machine doesn't
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync have snapshots.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="snapshotCount" type="unsigned long" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Number of snapshots taken on this machine. Zero means the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine doesn't have any snapshots.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="currentStateModified" type="boolean" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns <tt>true</tt> if the current state of the machine is not
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync identical to the state stored in the current snapshot.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The current state is identical to the current snapshot right
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync after one of the following calls are made:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IConsole::discardCurrentSnapshotAndState"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <li><link to="IConsole::takeSnapshot"/> (issued on a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync powered off or saved machine, for which
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#settingsModified"/> returns <tt>false</tt>)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The current state remains identical until one of the following
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync For machines that don't have snapshots, this property is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Collection of shared folders for this machine (permanent shared
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync folders). These folders are shared automatically at machine startup
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync and available only to the guest OS installed within this machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync New shared folders are added to the collection using
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#createSharedFolder"/>. Existing shared folders can be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="clipboardMode" type="ClipboardMode">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Synchronization mode between the host OS clipboard
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync and the guest OS clipboard.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="guestPropertyNotificationPatterns" type="wstring">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync A comma-separated list of simple glob patterns. Changes to guest
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync properties whose name matches one of the patterns will generate an
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBoxCallback::onGuestPropertyChange"/> signal.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Puts the given device to the specified position in
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the boot order.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync To indicate that no device is associated with the given position,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @todo setHardDiskBootOrder(), setNetworkBootOrder()
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Boot @a position out of range.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Booting from USB @a device currently not supported.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="position" type="unsigned long" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Position in the boot order (<tt>1</tt> to the total number of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync devices the machine can boot from, as returned by
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The type of the device used to boot at the given position.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns the device type that occupies the specified
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync position in the boot order.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @todo [remove?]
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If the machine can have more than one device of the returned type
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (such as hard disks), then a separate method should be used to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync retrieve the individual device that occupies the given position.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If here are no devices at the given position, then
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @todo getHardDiskBootOrder(), getNetworkBootOrder()
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Boot @a position out of range.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="position" type="unsigned long" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Position in the boot order (<tt>1</tt> to the total number of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync devices the machine can boot from, as returned by
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="device" type="DeviceType" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Device at the given position.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Attaches a virtual hard disk (<link to="IHardDisk" />, identified
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync by the given UUID @a id) to the given hard disk controller
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (<link to="IStorageController" />, identified by @a name),
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync at the indicated port and device.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync For the IDE bus, the @a controllerPort parameter can be either
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @c 0 or @c 1, to specify the primary or secondary IDE controller,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync respectively. For the primary controller of the IDE bus,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @a device can be either @c 0 or @c 1, to specify the master or the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync slave device, respectively. For the secondary IDE controller, the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync device number must be @c 1 because VirtualBox reserves the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync secondary master for the CD-ROM drive.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync For an SATA controller, @a controllerPort must be a number ranging
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync from @c 0 to @c 29. For a SCSI controller, @a controllerPort must
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync be a number ranging from @c 0 to @c 15.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync For both SCSI and SATA, the @a device parameter is unused and must
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The specified device slot must not have another disk attached to it, or
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync this method will fail.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync See <link to="IHardDisk"/> for more detailed information about
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync attaching hard disks.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync You cannot attach a hard disk to a running machine. Also, you cannot
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync attach a hard disk to a newly created machine until this machine's
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync settings are saved to disk using <link to="#saveSettings"/>.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If the hard disk is being attached indirectly, a new differencing hard
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync disk will implicitly be created for it and attached instead. If the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync changes made to the machine settings (including this indirect
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync attachment) are later cancelled using <link to="#discardSettings"/>,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync this implicitly created differencing hard disk will implicitly
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync be deleted.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync SATA device, SATA port, IDE port or IDE slot out of range.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Attempt to attach hard disk to an unregistered virtual machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Invalid machine state.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Hard disk already attached to this or another virtual machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Name of the storage controller to attach the hard disk to.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Device slot in the given port to attach the hard disk to.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns the virtual hard disk attached to a device slot of the specified
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that if the hard disk was indirectly attached by
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#attachHardDisk"/> to the given device slot then this
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync method will return not the same object as passed to the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#attachHardDisk"/> call. See <link to="IHardDisk"/> for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync more detailed information about attaching hard disks.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Name of the storage controller the hard disk is attached to.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Device slot in the given port to query.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="hardDisk" type="IHardDisk" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Detaches the virtual hard disk attached to a device slot of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync specified bus.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Detaching the hard disk from the virtual machine is deferred. This means
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync that the hard disk remains associated with the machine when this method
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync returns and gets actually de-associated only after a successful
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#saveSettings"/> call. See <link to="IHardDisk"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync for more detailed information about attaching hard disks.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync You cannot detach the hard disk from a running machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Detaching differencing hard disks implicitly created by <link
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to="#attachHardDisk"/> for the indirect attachment using this
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IHardDisk::deleteStorage"/> operation should be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync explicitly performed by the caller after the hard disk is successfully
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync detached and the settings are saved with
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#saveSettings"/>, if it is the desired action.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Attempt to detach hard disk from a running virtual machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Hard disk format does not support storage deletion.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>name of the storage controller to detach the hard disk from.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Port number to detach the hard disk from.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Device slot number to detach the hard disk from.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <method name="getHardDiskAttachmentsOfController" const="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns an array of hard disk attachments which are attached to the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the controller with the given name.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync A storage controller with given name doesn't exist.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="hardDiskAttachments" type="IHardDiskAttachment" safearray="yes" dir="return"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns the network adapter associated with the given slot.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Slots are numbered sequentially, starting with zero. The total
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync number of adapters per machine is defined by the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="ISystemProperties::networkAdapterCount"/> property,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync so the maximum slot number is one less than that property's value.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Invalid @a slot number.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="adapter" type="INetworkAdapter" dir="return"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Adds a new storage controller (SCSI or SATA controller) to the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine and returns it as an instance of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @a name identifies the controller with subsequent calls such as
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync After the controller has been added, you can set its exact
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync type by setting the <link to="IStorageController::controllerType" />.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync A storage controller with given name exists already.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Invalid @a controllerType.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="connectionType" type="StorageBus" dir="in"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="controller" type="IStorageController" dir="return"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <method name="getStorageControllerByName" const="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns a storage controller with the given name.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync A storage controller with given name doesn't exist.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="storageController" type="IStorageController" dir="return"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Removes a storage controller from the machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync A storage controller with given name doesn't exist.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns the serial port associated with the given slot.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Slots are numbered sequentially, starting with zero. The total
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync number of serial ports per machine is defined by the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="ISystemProperties::serialPortCount"/> property,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync so the maximum slot number is one less than that property's value.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Invalid @a slot number.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="port" type="ISerialPort" dir="return"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns the parallel port associated with the given slot.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Slots are numbered sequentially, starting with zero. The total
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync number of parallel ports per machine is defined by the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="ISystemProperties::parallelPortCount"/> property,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync so the maximum slot number is one less than that property's value.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Invalid @a slot number.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="port" type="IParallelPort" dir="return"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns the machine-specific extra data key name following the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync supplied key.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync An error is returned if the supplied @a key does not exist. @c NULL is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync returned in @a nextKey if the supplied key is the last key. When
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync supplying @c NULL for the @a key, the first key item is returned in
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @a nextKey (if there is any). @a nextValue is an optional parameter and
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync if supplied, the next key's value is returned in it.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Extra data @a key not found.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns associated machine-specific extra data.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If the requested data @a key does not exist, this function will
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync succeed and return @c NULL in the @a value argument.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Settings file not accessible.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Could not parse the settings file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Sets associated machine-specific extra data.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If you pass @c NULL as a key @a value, the given @a key will be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Before performing the actual data change, this method will ask all
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync registered callbacks using the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBoxCallback::onExtraDataCanChange"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync notification for a permission. If one of the callbacks refuses the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync new value, the change will not be performed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync On success, the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBoxCallback::onExtraDataChange"/> notification
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync is called to inform all registered callbacks about a successful data
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This method can be called outside the machine session and therefore
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync it's a caller's responsibility to handle possible race conditions
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync when several clients change the same key at the same time.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Settings file not accessible.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Could not parse the settings file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Saves any changes to machine settings made since the session
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync has been opened or a new machine has been created, or since the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync For registered machines, new settings become visible to all
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync other VirtualBox clients after successful invocation of this
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The method sends <link to="IVirtualBoxCallback::onMachineDataChange"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync notification event after the configuration has been successfully
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync saved (only for registered machines).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Calling this method is only valid on instances returned
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync by <link to="ISession::machine"/> and on new machines
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync created by <link to="IVirtualBox::createMachine"/> but not
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync yet registered, or on unregistered machines after calling
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Settings file not accessible.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Could not parse the settings file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Modification request refused.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Creates a backup copy of the machine settings file (<link
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to="#settingsFilePath"/>) in case of auto-conversion, and then calls
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that the backup copy is created <b>only</b> if the settings file
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync auto-conversion took place (see <link to="#settingsFileVersion"/> for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync details). Otherwise, this call is fully equivalent to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#saveSettings"/> and no backup copying is done.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The backup copy is created in the same directory where the original
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync settings file is located. It is given the following file name:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync where <tt>original.xml</tt> is the original settings file name
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (excluding path), and <tt>x.y-platform</tt> is the version of the old
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync format of the settings file (before auto-conversion).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If the given backup file already exists, this method will try to add the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <tt>.N</tt> suffix to the backup file name (where <tt>N</tt> counts from
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync 0 to 9) and copy it again until it succeeds. If all suffixes are
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync occupied, or if any other copy error occurs, this method will return a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If the copy operation succeeds, the @a bakFileName return argument will
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync receive a full path to the created backup file (for informational
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync purposes). Note that this will happen even if the subsequent
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#saveSettings"/> call performed by this method after the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync copy operation, fails.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The VirtualBox API never calls this method. It is intended purely for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the purposes of creating backup copies of the settings files by
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync front-ends before saving the results of the automatically performed
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync settings conversion to disk.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Settings file not accessible.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Could not parse the settings file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine is not mutable.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Modification request refused.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="bakFileName" type="wstring" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Discards any changes to the machine settings made since the session
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync has been opened or since the last call to <link to="#saveSettings"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Calling this method is only valid on instances returned
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync by <link to="ISession::machine"/> and on new machines
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync created by <link to="IVirtualBox::createMachine"/> or
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync opened by <link to="IVirtualBox::openMachine"/> but not
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync yet registered, or on unregistered machines after calling
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine is not mutable.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Deletes the settings file of this machine from disk.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The machine must not be registered in order for this operation
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to succeed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#settingsModified"/> will return TRUE after this
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync method successfully returns.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Calling this method is only valid on instances returned
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync by <link to="ISession::machine"/> and on new machines
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync created by <link to="IVirtualBox::createMachine"/> or
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync opened by <link to="IVirtualBox::openMachine"/> but not
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync yet registered, or on unregistered machines after calling
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The deleted machine settings file can be restored (saved again)
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Cannot delete settings of a registered machine or
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine not mutable.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Could not delete the settings file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync steps required to export VirtualBox machines to OVF.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aAppliance" type="IAppliance" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="aDescription" type="IVirtualSystemDescription" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>VirtualSystemDescription object which is created for this machine.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns a snapshot of this machine with the given UUID.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync A <tt>null</tt> UUID can be used to obtain the first snapshot
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync taken on this machine. This is useful if you want to traverse
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the whole tree of snapshots starting from the root.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine has no snapshots or snapshot not found.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="snapshot" type="ISnapshot" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns a snapshot of this machine with the given name.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine has no snapshots or snapshot not found.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="snapshot" type="ISnapshot" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Sets the current snapshot of this machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync In the current implementation, this operation is not
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync implemented.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>UUID of the snapshot to set as the current snapshot.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Creates a new permanent shared folder by associating the given logical
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync name with the given host path, adds it to the collection of shared
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync folders and starts sharing it. Refer to the description of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="ISharedFolder"/> to read more about logical names.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Shared folder already exists.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Shared folder @a hostPath not accessible.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Unique logical name of the shared folder.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Full path to the shared folder in the host file system.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Whether the share is writable or readonly</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Removes the permanent shared folder with the given name previously
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync created by <link to="#createSharedFolder"/> from the collection of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync shared folders and stops sharing it.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine is not mutable.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Shared folder @a name does not exist.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Logical name of the shared folder to remove.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Returns @c true if the VM console process can activate the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync console window and bring it to foreground on the desktop of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the host PC.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This method will fail if a session for this machine is not
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync currently open.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Machine session is not open.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @c true if the console window can be shown and @c
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync false otherwise.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Activates the console window and brings it to foreground on
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the desktop of the host PC. Many modern window managers on
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync many platforms implement some sort of focus stealing
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync prevention logic, so that it may be impossible to activate
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync a window without the help of the currently active
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync application. In this case, this method will return a non-zero
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync identifier that represents the top-level window of the VM
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync console process. The caller, if it represents a currently
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync active process, is responsible to use this identifier (in a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync platform-dependent manner) to perform actual window
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync activation.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This method will fail if a session for this machine is not
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync currently open.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Machine session is not open.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="winId" type="unsigned long long" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Platform-dependent identifier of the top-level VM console
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync window, or zero if this method has performed all actions
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync necessary to implement the <i>show window</i> semantics for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Reads an entry from the machine's guest property store.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Machine session is not open.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The name of the property to read.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The value of the property. If the property does not exist then this
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync will be empty.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="timestamp" type="unsigned long long" dir="out">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The time at which the property was last modified, as seen by the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync server process.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Additional property parameters, passed as a comma-separated list of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync "name=value" type entries.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Reads a value from the machine's guest property store.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Machine session is not open.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The name of the property to read.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The value of the property. If the property does not exist then this
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync will be empty.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Reads a property timestamp from the machine's guest property store.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Machine session is not open.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The name of the property to read.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="value" type="unsigned long long" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The timestamp. If the property does not exist then this will be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Sets, changes or deletes an entry in the machine's guest property
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Property cannot be changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Invalid @a flags.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine is not mutable or session not open.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Cannot set transient property when machine not running.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The name of the property to set, change or delete.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The new value of the property to set, change or delete. If the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync property does not yet exist and value is non-empty, it will be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync created. If the value is empty, the key will be deleted if it
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Additional property parameters, passed as a comma-separated list of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync "name=value" type entries.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Sets, changes or deletes a value in the machine's guest property
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync store. The flags field will be left unchanged or created empty for a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync new property.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Property cannot be changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine is not mutable or session not open.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Cannot set transient property when machine not running.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The name of the property to set, change or delete.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The new value of the property to set, change or delete. If the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync property does not yet exist and value is non-empty, it will be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync created. If value is empty, the property will be deleted if it
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Return a list of the guest properties matching a set of patterns along
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync with their values, time stamps and flags.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The patterns to match the properties against, separated by '|'
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync characters. If this is empty or NULL, all properties will match.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="name" type="wstring" dir="out" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The names of the properties returned.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="value" type="wstring" dir="out" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The values of the properties returned. The array entries match the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync corresponding entries in the @a name array.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The time stamps of the properties returned. The array entries match
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the corresponding entries in the @a name array.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="flags" type="wstring" dir="out" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The flags of the properties returned. The array entries match the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync corresponding entries in the @a name array.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync</interface>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync // IConsole
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync /////////////////////////////////////////////////////////////////////////
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="13dfbef3-b74d-487d-bada-2304529aefa6"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync wsmap="suppress"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when the guest mouse pointer shape has
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync changed. The new shape data is given.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Flag whether the pointer is visible.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Flag whether the pointer has an alpha channel.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The pointer hot spot x coordinate.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The pointer hot spot y coordinate.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Width of the pointer shape in pixels.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="height" type="unsigned long" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Height of the pointer shape in pixels.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="shape" type="octet" mod="ptr" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Address of the shape buffer.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync followed by a 32-bpp XOR (color) mask.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync For pointers without alpha channel the XOR mask pixels are 32
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync bit values: (lsb)BGR0(msb). For pointers with alpha channel
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync An AND mask is used for pointers with alpha channel, so if the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync callback does not support alpha, the pointer could be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync displayed as a normal color pointer.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync height</tt>. The padding bits at the end of each scanline are
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The XOR mask follows the AND mask on the next 4-byte aligned
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Bytes in the gap between the AND and the XOR mask are undefined.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The XOR mask scanlines have no gap between them and the size of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the XOR mask is: <tt>cXor = width * 4 * height</tt>.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If @a shape is 0, only the pointer visibility is changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when the mouse capabilities reported by the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync guest have changed. The new capabilities are passed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="supportsAbsolute" type="boolean" dir="in"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="needsHostCursor" type="boolean" dir="in"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when the guest OS executes the KBD_CMD_SET_LEDS command
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to alter the state of the keyboard LEDs.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when the execution state of the machine has changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The new state will be given.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when a Guest Additions property changes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Interested callees should query IGuest attributes to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync find out what has changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when a property of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync virtual <link to="IMachine::DVDDrive">DVD drive</link> changes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Interested callees should use IDVDDrive methods to find out what has
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when a property of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync virtual <link to="IMachine::floppyDrive">floppy drive</link> changes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Interested callees should use IFloppyDrive methods to find out what
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync has changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when a property of one of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync changes. Interested callees should use INetworkAdapter methods and
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync attributes to find out what has changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="networkAdapter" type="INetworkAdapter" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Network adapter that is subject to change.</desc>
1f1f533d5b88c35cf740dca55c6f1937d1035a36vboxsync Notification when a property of one of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Interested callees should use ISerialPort methods and attributes
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to find out what has changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="serialPort" type="ISerialPort" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Serial port that is subject to change.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when a property of one of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync virtual <link to="IMachine::getParallelPort">parallel ports</link>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync changes. Interested callees should use ISerialPort methods and
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync attributes to find out what has changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="parallelPort" type="IParallelPort" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Parallel port that is subject to change.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when a property of one of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync virtual <link to="IMachine::getStorageControllers">storage controllers</link>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync changes. Interested callees should use query the corresponding collections
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to find out what has changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when a property of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IMachine::VRDPServer">VRDP server</link> changes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Interested callees should use IVRDPServer methods and attributes to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync find out what has changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when a property of the virtual
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IMachine::USBController">USB controller</link> changes.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Interested callees should use IUSBController methods and attributes to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync find out what has changed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when a USB device is attached to or detached from
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the virtual USB controller.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This notification is sent as a result of the indirect
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync request to attach the device because it matches one of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine USB filters, or as a result of the direct request
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync issued by <link to="IConsole::attachUSBDevice"/> or
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This notification is sent in case of both a succeeded and a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync failed request completion. When the request succeeds, the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @a error parameter is @c null, and the given device has been
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync already added to (when @a attached is @c true) or removed from
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (when @a attached is @c false) the collection represented by
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IConsole::USBDevices"/>. On failure, the collection
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync doesn't change and the @a error parameter represents the error
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync message describing the failure.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Device that is subject to state change.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="error" type="IVirtualBoxErrorInfo" dir="in">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <tt>null</tt> on success or an error message object on
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when a shared folder is added or removed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The @a scope argument defines one of three scopes:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBox::sharedFolders">global shared folders</link>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IMachine::sharedFolders">permanent shared folders</link> of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the machine (<link to="Scope_Machine">Machine</link>) or <link
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to="IConsole::sharedFolders">transient shared folders</link> of the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine (<link to="Scope_Session">Session</link>). Interested callees
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync should use query the corresponding collections to find out what has
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when an error happens during the virtual
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine execution.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync There are three kinds of runtime errors:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <b>Fatal</b> errors are indicated by the @a fatal parameter set
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to <tt>true</tt>. In case of fatal errors, the virtual machine
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync execution is always paused before calling this notification, and
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the notification handler is supposed either to immediately save
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the virtual machine state using <link to="IConsole::saveState"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync or power it off using <link to="IConsole::powerDown"/>.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Resuming the execution can lead to unpredictable results.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <b>Non-fatal</b> errors and warnings are indicated by the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @a fatal parameter set to <tt>false</tt>. If the virtual machine
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync is in the Paused state by the time the error notification is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync received, it means that the user can <i>try to resume</i> the machine
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync execution after attempting to solve the problem that caused the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync error. In this case, the notification handler is supposed
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to show an appropriate message to the user (depending on the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync value of the @a id parameter) that offers several actions such
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync wants to retry, the notification handler should continue
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the machine execution using the <link to="IConsole::resume"/>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync call. If the machine execution is not Paused during this
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync notification, then it means this notification is a <i>warning</i>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (for example, about a fatal condition that can happen very soon);
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync no immediate action is required from the user, the machine
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync continues its normal execution.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that in either case the notification handler
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <b>must not</b> perform any action directly on a thread
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync where this notification is called. Everything it is allowed to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync do is to post a message to another thread that will then talk
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to the user and take the corresponding action.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Currently, the following error identifiers are known:
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This notification is not designed to be implemented by
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync more than one callback at a time. If you have multiple
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync IConsoleCallback instances registered on the given
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync IConsole object, make sure you simply do nothing but
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync return @c S_OK from all but one of them that does actual
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync user notification and performs necessary actions.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when a call to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IMachine::canShowConsoleWindow"/> is made by a
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync front-end to check if a subsequent call to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IMachine::showConsoleWindow"/> can succeed.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The callee should give an answer appropriate to the current
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine state in the @a canShow argument. This answer must
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync remain valid at least until the next
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IConsole::state">machine state</link> change.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This notification is not designed to be implemented by
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync more than one callback at a time. If you have multiple
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync IConsoleCallback instances registered on the given
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync IConsole object, make sure you simply do nothing but
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync return @c true and @c S_OK from all but one of them that
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync actually manages console window activation.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @c true if the console window can be shown and @c
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync false otherwise.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Notification when a call to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync requests the console window to be activated and brought to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync foreground on the desktop of the host PC.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This notification should cause the VM console process to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync perform the requested action as described above. If it is
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync impossible to do it at a time of this notification, this
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync method should return a failure.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Note that many modern window managers on many platforms
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync implement some sort of focus stealing prevention logic, so
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync that it may be impossible to activate a window without the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync help of the currently active application (which is supposedly
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync an initiator of this notification). In this case, this method
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync must return a non-zero identifier that represents the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync top-level window of the VM console process. The caller, if it
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync represents a currently active process, is responsible to use
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync this identifier (in a platform-dependent manner) to perform
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync actual window activation.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This method must set @a winId to zero if it has performed all
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync actions necessary to complete the request and the console
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync window is now active and in foreground, to indicate that no
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync further action is required on the caller's side.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This notification is not designed to be implemented by
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync more than one callback at a time. If you have multiple
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync IConsoleCallback instances registered on the given
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync IConsole object, make sure you simply do nothing but
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync return @c S_OK from all but one of them that actually
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync manages console window activation.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="winId" type="unsigned long long" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Platform-dependent identifier of the top-level VM console
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync window, or zero if this method has performed all actions
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync necessary to implement the <i>show window</i> semantics for
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the given platform and/or this VirtualBox front-end.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </interface>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="550104cd-2dfd-4a6c-857d-f6f8e088e62c"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync wsmap="struct"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Contains information about the remote display (VRDP) capabilities and status.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This is used in the <link to="IConsole::remoteDisplayInfo" /> attribute.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="active" type="boolean" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Whether the remote display connection is active.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="numberOfClients" type="unsigned long" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync How many times a client connected.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="beginTime" type="long long" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync When the last connection was established, in milliseconds since 1970-01-01 UTC.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="endTime" type="long long" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync When the last connection was terminated or the current time, if
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync connection is still active, in milliseconds since 1970-01-01 UTC.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="bytesSent" type="unsigned long long" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync How many bytes were sent in last or current, if still active, connection.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="bytesSentTotal" type="unsigned long long" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync How many bytes were sent in all connections.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="bytesReceived" type="unsigned long long" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync How many bytes were received in last or current, if still active, connection.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="bytesReceivedTotal" type="unsigned long long" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync How many bytes were received in all connections.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="user" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Login user name supplied by the client.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="domain" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Login domain name supplied by the client.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="clientName" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The client name supplied by the client.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="clientIP" type="wstring" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The IP address of the client.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="clientVersion" type="unsigned long" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The client software version number.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="encryptionStyle" type="unsigned long" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Public key exchange method used when connection was established.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Values: 0 - RDP4 public key exchange scheme.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync 1 - X509 certificates were sent to client.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </interface>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync uuid="9511bc54-15ee-4ddf-808e-472aba03809c"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync wsmap="managed"
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The IConsole interface represents an interface to control virtual
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync machine execution.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The console object that implements the IConsole interface is obtained
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync from a session object after the session for the given machine has been
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync opened using one of <link to="IVirtualBox::openSession"/>,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBox::openExistingSession"/> methods.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Methods of the IConsole interface allow the caller to query the current
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync virtual machine execution state, pause the machine or power it down, save
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the machine state or take a snapshot, attach and detach removable media
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="machine" type="IMachine" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Machine object this console is sessioned with.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This is a convenience property, it has the same value as
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="ISession::machine"/> of the corresponding session
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="state" type="MachineState" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Current execution state of the machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync This property always returns the same value as the corresponding
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync property of the IMachine object this console is sessioned with.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync For the process that owns (executes) the VM, this is the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync preferable way of querying the VM state, because no IPC
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync calls are made.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="guest" type="IGuest" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="keyboard" type="IKeyboard" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual keyboard object.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If the machine is not running, any attempt to use
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the returned object will result in an error.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="mouse" type="IMouse" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual mouse object.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If the machine is not running, any attempt to use
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the returned object will result in an error.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="display" type="IDisplay" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Virtual display object.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If the machine is not running, any attempt to use
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync the returned object will result in an error.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="debugger" type="IMachineDebugger" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Collection of USB devices currently attached to the virtual
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync USB controller.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The collection is empty if the machine is not running.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync List of USB devices currently attached to the remote VRDP client.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Once a new device is physically attached to the remote host computer,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync it appears in this list and remains there until detached.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Collection of shared folders for the current session. These folders
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync are called transient shared folders because they are available to the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync guest OS running inside the associated virtual machine only for the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync duration of the session (as opposed to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IMachine::sharedFolders"/> which represent permanent shared
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync folders). When the session is closed (e.g. the machine is powered down),
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync these folders are automatically discarded.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync New shared folders are added to the collection using
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="#createSharedFolder"/>. Existing shared folders can be
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <attribute name="remoteDisplayInfo" type="IRemoteDisplayInfo" readonly="yes">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Interface that provides information on Remote Display (VRDP) connection.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync </attribute>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Starts the virtual machine execution using the current machine
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync state (that is, its current execution state, current settings and
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync current hard disks).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If the machine is powered off or aborted, the execution will
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync start from the beginning (as if the real hardware were just
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync powered on).
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync If the machine is in the <link to="MachineState_Saved"/> state,
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync it will continue its execution the point where the state has
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync been saved.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Unless you are trying to write a new VirtualBox front-end that
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync performs direct machine execution (like the VirtualBox or VBoxSDL
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync front-ends), don't call <link to="IConsole::powerUp"/> in a direct
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync session opened by <link to="IVirtualBox::openSession"/> and use this
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync session only to change virtual machine settings. If you simply want to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync start virtual machine execution using one of the existing front-ends
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync (for example the VirtualBox GUI or headless server), simply use
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <link to="IVirtualBox::openRemoteSession"/>; these front-ends will
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync power up the machine automatically for you.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine already running.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Host interface does not exist or name not set.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Invalid saved state file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="progress" type="IProgress" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Progress object to track the operation completion.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Identical to powerUp except that the VM will enter the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine already running.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Host interface does not exist or name not set.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Invalid saved state file.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="progress" type="IProgress" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Progress object to track the operation completion.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Stops the virtual machine execution.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync After this operation completes, the machine will go to the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync PoweredOff state.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @deprecated This method will be removed in VirtualBox 2.1 where the
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync powerDownAsync() method will take its name. Do not use this method in
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine must be Running, Paused or Stuck to be powered down.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Unable to power off or destroy virtual machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Initiates the power down procedure to stop the virtual machine
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync The completion of the power down procedure is tracked using the returned
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync IProgress object. After the operation is complete, the machine will go
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync to the PoweredOff state.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync @warning This method will be renamed to "powerDown" in VirtualBox 2.1
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync where the original powerDown() method will be removed. You will need to
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync rename "powerDownAsync" to "powerDown" in your sources to make them
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync build with version 2.1.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine must be Running, Paused or Stuck to be powered down.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <param name="progress" type="IProgress" dir="return">
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Progress object to track the operation completion.</desc>
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Resets the virtual machine.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine not in Running state.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine error in reset operation.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Pauses the virtual machine execution.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine not in Running state.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine error in suspend operation.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Resumes the virtual machine execution.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine not in Paused state.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine error in resume operation.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync <desc>Sends the ACPI power button event to the guest.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Virtual machine not in Running state.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync Controlled power off failed.
children at all (i.e. the first snapshot is the only snapshot of
hard disk simply becomes unused (i.e. not attached to any VM). In the
(currentSnapshot.id(), progress) followed by
If the current snapshot is the first snapshot of the machine (i.e. it
On DOS-like platforms, it is a drive name (e.g. R:).
On DOS-like platforms, it is a drive name (e.g. A:).
last taken snapshot (i.e. the head snapshot on the branch) and it
The returned machine object is immutable, i.e. no
Note that when VirtualBox starts up (e.g. the VirtualBox object gets
(i.e. the value equal to the @c machineId argument), followed by
Invalid media state (e.g. not created, locked, inaccessible,
Invalid media state (e.g. not created, locked, inaccessible,
e.g. before the storage unit is created, and works as follows. You set the
Normal base hard disks that do not have children (i.e. differencing
CurState (none) CurState (D3->D2.vdi)
CurState (D3->B.vdi)
it cannot be attached directly and needs an indirect attachment (i.e.
disks, this property returns the hard disk object itself (i.e. the same
state (i.e. must not have an existing storage unit). Upon successful
target hard disk is a linear chain, i.e. all hard disks in this
state (i.e. must not have an existing storage unit). Upon successful
See also www.fourcc.org for more information about FOURCC pixel formats.
current video mode (i.e. left unchanged).
Filename where a network trace will be stored. If not set, VBox-pid.pcap
i.e. it is ignored by IHostUSBDeviceFilter objects.
(e.g. change its settings or start execution), a session object is
if the session is currently open (i.e. its #state is
namespace="virtualbox.org">
namespace="virtualbox.org">