formZ SDK | 4.0 Call Back Reference | Command | Tool

fz_tool_cbak_opts_help

Description

Tool Help (Recommended) This function is called by formZ to get the help text of the options for a tool. It is recommended that the help text is stored in .fzr file so that it is localizable. If this function is not provided, no help string is shown. Help text is used in the Help dialogs and the Key shortcuts manager.

Plugin Prototype

fzrt_error_td fz_tool_cbak_opts_help(

char *

help,

fzrt_int

max_len )

Parameters

help [Result]

string to be filled with the help text

max_len [Input]

length of help text parameter

Returns

Error codes

Availability

5.0.0.0

See Also

fz_tool_cbak_opts_name, fz_tool_cbak_opts_uuid

Function Set

fz_tool_cbak_fset


Defined in

fz_tool_api.h