TuttleOFX  1
Data Fields
OfxHost Struct Reference

Generic host structure passed to OfxPlugin::setHost function. More...

#include <ofxCorePlugin.h>

Data Fields

OfxPropertySetHandle host
 Global handle to the host. Extract relevant host properties from this. This pointer will be valid while the binary containing the plug-in is loaded.
void *(* fetchSuite )(OfxPropertySetHandle host, const char *suiteName, int suiteVersion)
 The function which the plug-in uses to fetch suites from the host.

Detailed Description

Generic host structure passed to OfxPlugin::setHost function.

This structure contains what is needed by a plug-in to bootstrap it's connection to the host.

Definition at line 45 of file ofxCorePlugin.h.

Field Documentation

void*( * OfxHost::fetchSuite)(OfxPropertySetHandle host, const char *suiteName, int suiteVersion)

The function which the plug-in uses to fetch suites from the host.

  • host - the host the suite is being fetched from this must be the host member of the OfxHost struct containing fetchSuite.
  • suiteName - ASCII string labelling the host supplied API
  • suiteVersion - version of that suite to fetch

Any API fetched will be valid while the binary containing the plug-in is loaded.

Repeated calls to fetchSuite with the same parameters will return the same pointer.

returns

  • NULL if the API is unknown (either the api or the version requested),

pointer to the relevant API if it was found

Definition at line 66 of file ofxCorePlugin.h.

Referenced by OFX::fetchSuite(), and tuttle::host::ofx::OfxhHost::OfxhHost().

OfxPropertySetHandle OfxHost::host

Global handle to the host. Extract relevant host properties from this. This pointer will be valid while the binary containing the plug-in is loaded.

Definition at line 50 of file ofxCorePlugin.h.

Referenced by OFX::Private::fetchHostDescription(), tuttle::host::ofx::OfxhHost::OfxhHost(), and OFX::Validation::validateHostProperties().

The documentation for this struct was generated from the following file: