formZ SDK | 5.0 API Reference | System | Plugin Manager (FZPL)
Description
Used in the FZPL_PLUGIN_INITIALIZE phase of fzpl_plugin_entry_func, after a plugin is successfully registered, to provide descriptive text about the plugin. the maximum size if the text is FZPL_MAX_DESCRIPTOR_LEN.
Plugin Prototype
fzrt_error_td fzpl_plugin_set_desc(
fzrt_unsigned_int | plugin_rt_id, |
char * | desc_str ) |
Parameters
plugin_rt_id [Input]
A runtime id used to identify this plugin. This was set by fzpl_plugin_register.
desc_str [Input]
The plugin's description string.
Returns
FZRT_NOERR on success.
FZRT_BAD_PARAM_ERROR - plugin_id is invalid.
Availability
5.0.0.0
Function Set
Defined in