formZ SDK | 4.0 Call Back Reference | Command | System Command

# fz_cmnd_cbak_syst_help

Description

Command help (Recommended). This function is called by formZ to get the help text of the command. It is recomended 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 dilaogs and the Keyshortcuts manager.

Plugin Prototype

fzrt_error_td fz_cmnd_cbak_syst_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_cmnd_cbak_syst_name,

Function Set

fz_cmnd_fset

Defined in

fz_cmnd_api.h