VirtualBox Main API
Public Member Functions | Public Attributes | List of all members
IVirtualBoxClient Interface Reference

Convenience interface for client applications. More...

Inheritance diagram for IVirtualBoxClient:

Public Member Functions

void checkMachineError (in IMachine machine)
 Perform error checking before using an IMachine object. More...
 

Public Attributes

readonly attribute IVirtualBox virtualBox
 Reference to the server-side API root object. More...
 
readonly attribute ISession session
 Create a new session object and return the reference to it. More...
 
readonly attribute IEventSource eventSource
 Event source for VirtualBoxClient events. More...
 

Detailed Description

Convenience interface for client applications.

Treat this as a singleton, i.e. never create more than one instance of this interface.

At the moment only available for clients of the local API (not usable via the webservice). Once the session logic is redesigned this might change.

Interface ID:
{D2937A8E-CB8D-4382-90BA-B7DA78A74573}

Member Function Documentation

void IVirtualBoxClient::checkMachineError ( in IMachine  machine)

Perform error checking before using an IMachine object.

Generally useful before starting a VM and all other uses. If anything is not as it should be then this method will return an appropriate error.

Parameters
machineThe machine object to check.

Member Data Documentation

readonly attribute IVirtualBox IVirtualBoxClient::virtualBox

Reference to the server-side API root object.

readonly attribute ISession IVirtualBoxClient::session

Create a new session object and return the reference to it.

readonly attribute IEventSource IVirtualBoxClient::eventSource

Event source for VirtualBoxClient events.