FnPlugin Struct Reference

The basic plug-in information that must be returned from a call to getPlugins(). More...

#include <FnPluginSystem.h>

List of all members.

Public Attributes
const char *	name
	A descriptive name for the plug-in.
const char *	apiName
	The string name of the API supported by this plug-in.
unsigned int	apiVersion
	The integer version of the API supported by this plug-in.
unsigned int	pluginVersionMajor
	The major version of a plug-in changes when a new incompatible version is released.
unsigned int	pluginVersionMinor
	The minor version of a plug-in changes on small, but compatible, updates.
FnPluginStatus(*	setHost )(FnPluginHost *host)
	The host will call this on the plug-in to provide its details and check for acceptance.
const void *(*	getSuite )()
	The plug-in must implement this to return its suite of functions that implements the API it supports.
void(*	flush )()
	The host will call this to clean up any plug-in information before unloading the library.

---

Detailed Description

The basic plug-in information that must be returned from a call to getPlugins().

---

Member Data Documentation

const void*(* FnPlugin::getSuite)()

The plug-in must implement this to return its suite of functions that implements the API it supports.

Returns:

A pointer to a suite of functions in a structure, according to the API

FnPluginStatus FnPlugin::setHost

The host will call this on the plug-in to provide its details and check for acceptance.

Parameters:

host	Basic information about the host, for identification and access to the host function suite

Returns:

FnPluginStatusOK if the plug-in accepts the host, or FnPluginStatusError if not

---

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

• FnPluginSystem.h