formZ SDK | 5.0 API Reference | System | Plugin Manager (FZPL)
Description
Used in the FZPL_PLUGIN_INITIALIZE phase of fzpl_plugin_entry_func() to register the plugins with the formZ plugin manager. This function also associates function sets with plugins which implement them.
Plugin Prototype
fzrt_error_td fzpl_plugin_register(
const fzrt_UUID_td | id, |
const char * | plugin_name, |
plugin_version, | |
const char * | plugin_vendor_name, |
const char * | plugin_URL, |
const fzrt_UUID_td | plugin_type, |
plugin_type_version, | |
err_str_fcn, | |
fzrt_int | num_depends, |
const fzpl_plugin_dependency_td * | depends, |
fzrt_unsigned_int * const | plugin_id ) |
Parameters
id [Input]
The Unique UUID which identifies this plugin.
plugin_name [Input]
The human readable name for the plugin.
plugin_version [Input]
The version of the plugin.
plugin_vendor_name [Input]
The name of the company which develops or markets the plugin.
plugin_URL [Input]
The URL of the company which develops or markets the plugin.
plugin_type [Input]
The plugin type UUID.
plugin_type_version [Input]
The version of the plugin type.
err_str_fcn [Input]
A function which is called to get an error string when the plugin returns a plugin defined error.
num_depends [Input]
The number of other plugins this plugin depends on (for function set implementations).
depends [Input]
an array of plugin dependencies. This array must contain num_depends elements.
plugin_id [Result]
An application generated runtime id used to identify this plugin.
Returns
FZRT_NOERR on success.
FZPL_PLUGIN_ALREADY_LOADED - A plugin matching this plugins description is already loaded.
FZPL_DISABLED_ERROR - The user has disabled this plugin, thus preventing it from
being registered.
FZRT_NO_MATCH_ERROR - formZ does not recognize this plugin type or it's version is
not acceptable.
Availability
5.0.0.0
Function Set
Defined in