Using Help Strings to Specify Help Information

Designer: You can attach help strings to your Designer data form items, data forms, menu fields, and menus using the Designer. You can also attach help strings in your code at any point after you have read the form or menu from the Designer by following the steps outlined below.

Code: If you are using only help strings to specify help information in your application, use the following steps:

Step 1: Include the help header file vv_help.h.

General: To use the help system, you must #include the vv_help.h header file in all modules that reference the help functions and in your main program before vv_main.h.

Step 2: Specify help strings for individual data or menu forms.

Designer: Skip this step if you have already specified help for your forms and menus within the Designer.

Code: Specify help strings for individual data and menu forms by calling the set form help function, sfm_help():

void sfm_help(help_stp_or_kwdp, fmp)

UCHAR *help_stp_or_kwdp;

/* Help string or keyword

*/

FORMPTR fmp;

/* Pointer to menu or data form

*/

Specify the help string message for help_stp_or_kwdp. Specify a pointer to the form for fmp.

Step 3: Specify help strings for individual scrollable regions.

Designer: Skip this step if you have already specified help for each scrollable region within the Designer.

Code: Specify help strings for individual scrollable regions by calling the set scrollable region help function, ssr_help():

void ssr_help(help_stp_or_kwdp, srp)

UCHAR *help_stp_or_kwdp;

/* Help string or keyword

*/

SRPTR srp;

/* Pointer to scrollable region

*/

Specify the help string message for help_stp_or_kwdp. Specify a pointer to the scrollable region for srp.

Step 4: Specify help strings for each field, choice list, or menu item.

Designer: Skip this step if you have already specified help for each field, choice list, or menu item within the Designer.

Code: To specify help for a field on a data form, a field in a scrollable region, or a field in a menu, use the set field help function, sf_help():

void sf_help(help_stp_or_kwdp, fldp)

UCHAR *help_stp_or_kwdp;

/* Help string or keyword

*/

FIELDPTR fldp;

/* Pointer to field

*/

Specify the help string message for help_stp_or_kwdp. Specify a pointer to the field for fldp.

To specify help for a choice list attached to a data field or a stand-alone choice list, use the set choice list help function, scl_help():

void scl_help(help_stp_or_kwdp, clistp)

UCHAR *help_stp_or_kwdp;

/* Help string or keyword

*/

CLISTPTR clistp;

/* Pointer to choice list

*/

Specify the help string message for help_stp_or_kwdp. Specify a pointer to the choice list for clistp.