Public Attributes | |
unsigned int | api |
The API version the Plugin complies to. | |
unsigned long | version |
The Plugin version. | |
unsigned long | type |
The Plugin type. | |
const char * | name |
Plugin's unique name. | |
const char * | synopsis |
Plugin's short help string. | |
const char * | description |
Plugin's detailed description. | |
const char * | author |
Name of the plugin's author. | |
const char * | |
Author's email address. | |
const char * | copyright |
Plugin's copyright. | |
cpl_plugin_func | initialize |
Initalizes a plugin instance. | |
cpl_plugin_func | execute |
Executes a plugin instance. | |
cpl_plugin_func | deinitialize |
Deinitialization a plugin instance. |
|
The API version the Plugin complies to. The API version number identifies the internal layout of the plugin interface structure. It may be used by an application calling a plugin to setup the correct interface to communicate with the plugin or, in the simplest case, to ignore any plugin which does not match the plugin API an application has been buid for. |
|
Name of the plugin's author.
Variable contains the null-terminated identifier string of the plugins author. If the plugin does not specify an author this pointer should be set to a |
|
Plugin's copyright.
Variable contains the copyright and license string applying to the plugin. The returned string must be null-terminated. If no copyright applies this pointer should be set to a |
|
Deinitialization a plugin instance.
NULL no deinitialization of the plugin instance is needed. |
|
Plugin's detailed description.
Variable contains the plugin's null-terminated detailed description string. The description is the detailed help for the plugin. For formatting the output the C special characters |
|
Author's email address.
Variable contains the null-terminated string of the author's email address. If the plugin does not specify an email address this pointer should be set to a |
|
Executes a plugin instance.
|
|
Initalizes a plugin instance.
|
|
Plugin's unique name. Variable contains the unique name of the Plugin. To ensure uniqueness across all possible Plugins one should follow the hierarchical naming convention mentioned in the CPL documentation. |
|
Plugin's short help string.
Variable contains the plugin's null-terminated short help string. The short help string should summarize the plugin's purpose in not more than a few lines. It may contain new line characters. If the plugin does not provide a short help the pointer should be set to a |
|
The Plugin type. The Plugin type identifies the type of plugin. The data type is not a cpl_plugin_type in order to keep this interface as generic as possible. |
|
The Plugin version. The Plugin version number defines the version number for the plugin. The Plugin version number is an encoded version of the usual MAJOR.MINOR.MICRO form for version numbers. |