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

# fzpl_fset_def_check

Description

This provides a runtime type, size and version check of a function set. This function is usually calls from a function set's fill function ( fzpl_fset_def_get_fset_func) with version_op set to FZPL_VERSION_OP_NEWER prior to setting the function set's function pointers. This allows the plugin to make sure the function set is the right size, version, and type before filling it.

Plugin Prototype

fzrt_error_td fzpl_fset_def_check(

const fzpl_fset_def_ptr | fset_def,
fzpl_vers_td | version,
const char * | fset_typestr,
fzrt_unsigned_int | fset_size,
fzpl_vers_op_td | version_op )

Parameters

fset_def [Input]

The function set definition to check.

version [Input]

The version to compare. Use FZPL_VERS_ANY to disable version checking.

fset_typestr [Input]

The type string to compare. Use FZPL_TYPE_STRING().

fset_size [Input]

The size to compare. Use sizeof().

version_op [Input]

The version operation to use in the comparison.

Returns

FZRT_NOERR if everything matches.
FZRT_BAD_PARAM_ERROR - A parameter is NULL or out of range.
FZPL_BAD_SIZE_ERROR - fset_size does not match the size of the fset registered with the plugin manager.
FZPL_BAD_VERSION_ERROR - The requested version of the function set is not available.
FZPL_BAD_TYPE_ERROR - fset_typestr does not match the type string of the fset registered with the plugin manager.

Availability

5.0.0.0

See Also

fzpl_fset_td

Function Set

fzpl_fset_glue_fset

Defined in

fzpl_plugin.h