Main Page | Modules | Class List | File List | Class Members | File Members

OfxHost Struct Reference

#include <ofxCore.h>

List of all members.

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.


Public Attributes

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.

Member Data 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

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.

The documentation for this struct was generated from the following file:
Copyright 2003-2004 The Foundry Visonmongers Ltd. All rights reserved.
Copying and redistribution with or without modification, is permitted provided that the following conditions are met:
  1. Redistributions of the document must retain the above copyright notice and this list of conditions.
  2. Neither the name of The Foundry Visonmongers Ltd nor names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
Automatic documentation generated by DOxygen.