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

Managed object reference. More...

Public Member Functions

void getInterfaceName ([retval] out wstring return)
 Returns the name of the interface that this managed object represents, for example, "IMachine", as a string.
void release ()
 Releases this managed object reference and frees the resources that were allocated for it in the webservice server process.

Detailed Description

Managed object reference.

  Only within the webservice, a managed object reference (which is really
  an opaque number) allows a webservice client to address an object
  that lives in the address space of the webservice server.

  Behind each managed object reference, there is a COM object that lives
  in the webservice server's address space. The COM object is not freed
  until the managed object reference is released, either by an explicit
  call to  @link IManagedObjectRef::release IManagedObjectRef::release@endlink<b></b> or by logging off from
  the webservice (@link IWebsessionManager::logoff IWebsessionManager::logoff@endlink<b></b>), which releases
  all objects created during the webservice session.

  Whenever a method call of the VirtualBox API returns a COM object, the
  webservice representation of that method will instead return a
  managed object reference, which can then be used to invoke methods
  on that object.
Interface ID:
{9474D09D-2313-46DE-B568-A42B8718E8ED}

Member Function Documentation

void IManagedObjectRef::getInterfaceName ( [retval] out wstring  return)

Returns the name of the interface that this managed object represents, for example, "IMachine", as a string.

void IManagedObjectRef::release ( )

Releases this managed object reference and frees the resources that were allocated for it in the webservice server process.

After calling this method, the identifier of the reference can no longer be used.