Host Interface


IHostApplication

Inheritance: FUnknown <- IHostApplication
Include File:  ihostapplication.h

IHostApplication is the minimum interface, implemented by ALL host applications. You can query the context variable passed on in IPluginBase::initialize for a reference to this interface.

Methods:


IHostApplication::getName

const char* PLUGIN_API getName ()

Returns a pointer to the host application name string (e.g. "Cubase SX"). The pointer is valid as long as the interface reference is valid.


IHostApplication::getVersion

const char* PLUGIN_API getVersion ()

Returns a pointer to the host application version string (e.g. "2.0"). The pointer is valid as long as the interface reference is valid.


IHostApplication::getBuild

const char* PLUGIN_API getBuild ()

Returns a pointer to the host application build string (e.g. "100"). The pointer is valid as long as the interface reference is valid.


IHostApplication::getApplicationPath

tresult PLUGIN_API getApplicationPath (void** path)

Copies the host application path to the path parameter. The datatype is platform-dependent:
In Windows and Mac OS X you have to provide a character buffer of at least MAX_PATH size.


IHostApplication::getMainWindow

tresult PLUGIN_API getMainWindow (void** window)

Sets the window parameter to the host application's main window handle. The datatype is platform-dependent: in Windows it is an HWND, on the MAC platform it is a WindowRef. The Plug-In can use this handle e.g. as parent for modal dialogs.



Last Modified: