formZ SDK | 5.0 API Reference | System | Runtime Library (FZRT) | Basic

# fzrt_context_str_func

Description

Gets a string for an error code. This is a callback function that returns the string associated with the error code in the associated context. Each plugin is considered a unique context Any error set with the associated plugin context id, should return the appropriate string.

Plugin Prototype

fzrt_boolean fzrt_context_str_func(

fzrt_int | err,
char * | str,
short | str_len )

Parameters

err [Input]

str [Input]

str_len [Input]

Returns

TRUE on success.
FALSE - otherwise.

Availability

5.0.0.0

See Also

fzpl_plugin_register, fzrt_error_set, , fzrt_error_get_string

Defined in

fzrt_api_type.h