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

# fz_palt_cbak_syst_help

Description

Palette help (Recommended). This function is called by formZ to get the help text of the palette. 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_palt_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_palt_cbak_syst_uuid

Function Set

fz_palt_cbak_syst_fset

Defined in

fz_palt_api.h