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

fzpl_fset_get_typestr

Description

Queries a function set for its human readable type string. The function set must have been acquired by fzpl_fset_acquire. The type string must be pre-allocated by the caller.

Plugin Prototype

fzrt_error_td fzpl_fset_get_typestr(

const fzpl_fset_td * const

fset,

char *

typestr,

fzrt_unsigned_int

max_len )

Parameters

fset [Input]

The function set to query.

typestr [Result]

The type name string.

max_len [Input]

The maximum number of bytes to copy into typestr.

Returns

FZRT_NOERR on success.
FZRT_BAD_PARAM_ERROR - fset or typestr is NULL.
FZPL_BAD_FUNCTION_SET_ERROR - the function set is uninitialized or corrupt. Most likely caused by passing in a function set which was not acquired by fzpl_fset_acquire.

Availability

5.0.0.0

See Also

fzpl_fset_td

Function Set

fzpl_fset_glue_fset


Defined in

fzpl_plugin.h