@link
::
@endlink
@note
@see
/**
@par Interface ID:
{
}
*/
/**
@warning This attribute is non-scriptable. In particular, this also means that an
attempt to get or set it from a process other than the process that has created and
owns the object will most likely fail or crash your application.
*/
/**
@warning This method is non-scriptable. In particluar, this also means that an
attempt to call it from a process other than the process that has created and
owns the object will most likely fail or crash your application.
*/
@param
/**
@par Interface ID:
{
}
*/
/** @brief
*/
/*
* DO NOT EDIT! This is a generated file.
*
* Doxygen IDL definition for VirualBox Main API (COM interfaces)
* generated from XIDL (XML interface definition).
*
* Source : src/VBox/Main/idl/VirtualBox.xidl
* Generator : src/VBox/Main/idl/doxygen.xsl
*
* This IDL is generated using some generic OMG IDL-like syntax SOLELY
* for the purpose of generating the documentation using Doxygen and
* is not syntactically valid.
*
* DO NOT USE THIS HEADER IN ANY OTHER WAY!
*/
/** @mainpage
*
* Welcome to the VirtualBox Main documentation. This describes the
* so-called VirtualBox "Main API", which comprises all public COM interfaces
* and components provided by the VirtualBox server and by the VirtualBox client
* library.
*
* VirtualBox employs a client-server design, meaning that whenever any part of
* VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
* interface or any virtual machine --, a background server process named
* VBoxSVC runs in the background. This allows multiple processes to cooperate
* without conflicts. Some of the COM objects described by this Main documentation
* "live" in that server process, others "live" in the local client process. In
* any case, processes that use the Main API are using inter-process communication
* to communicate with these objects, but the details of this are hidden by the COM API.
*
* On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
* implementation. On all other platforms, Mozilla XPCOM, an open-source COM
* implementation, is used.
*
* All the parts that a typical VirtualBox user interacts with (the Qt GUI,
* the VBoxManage command-line interface and the VBoxVRDP server) are technically
* front-ends to the Main API and only use the interfaces that are documented
* in this Main API documentation. This ensures that, with any given release
* version of VirtualBox, all capabilities of the product that could be useful
* to an external client program are always exposed by way of this API.
*
* The complete API is described in a source IDL file, called VirtualBox.idl.
* This contains all public interfaces exposed by the Main API. Two interfaces
* are of supreme importance and will be needed in order for any front-end program
* to do anything useful: these are IVirtualBox and ISession. It is recommended
* to read the documentation of these interfaces first.
*
* @note VirtualBox.idl is automatically generated from a generic internal file
* to define all interfaces in a platform-independent way for documentation
* purposes. This generated file is not a syntactically valid IDL file and
* must not be used for programming.
*/
#if
#endif
interface
:
{
}; /* interface
*/
'array' attributes are not supported, use 'safearray="yes"' instead.
readonly
attribute
;
void
(
,
);
();
interface
: $unknown
{
void hasMore ([retval] out boolean more);
void getNext ([retval] out
next);
}; /* interface
*/
non-readonly collections are not currently supported
interface
: $unknown
{
readonly attribute unsigned long count;
void getItemAt (in unsigned long index, [retval] out
item);
void enumerate ([retval] out
enumerator);
}; /* interface
*/
enum
{
=
,
};
return 'array' parameters are not supported, use 'safearray="yes"' instead.
[array,
must have the same direction
size_is(
,
*
)
array attribute refers to non-existent param:
]
in
out
[retval] out
in
either 'array' or 'safearray="yes"' attribute is allowed, but not both!
booeanPtr
octetPtr
shortPtr
ushortPtr
longPtr
llongPtr
ulongPtr
ullongPtr
charPtr
wcharPtr
attribute 'mod=
' cannot be used with type
of attibute 'mod' is invalid!
result
boolean
octet
short
unsigned short
long
long long
unsigned long
unsigned long long
char
wchar
string
wstring
uuid
$unknown
Unknown parameter type:
[]