formZ SDK | 5.0 API Reference | System | Plugin Manager (FZPL)

fzpl_plugin_get_desc

Description

Gets the description for plugin.

Plugin Prototype

fzrt_error_td fzpl_plugin_get_desc(

fzrt_unsigned_int

plugin_rt_id,

char *

desc_str,

fzrt_int

max_len )

Parameters

plugin_rt_id [Input]

The plugin's runtime id.

desc_str [Result]

The plugin's description string.

max_len [Input]

The maximum number of characters to copy into desc_str.

Returns

FZRT_NOERR on success.
FZRT_BAD_PARAM_ERROR - desc_str is NULL or plugin_rt_id is invalid.

Availability

5.0.0.0

Function Set

fzpl_plugin_query_fset


Defined in

fzpl_plugin.h