[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
Function            HELP()
Action              Provides context sensitive popup help
Returns
Category            Help
Syntax              SET KEY xxx TO HELP
Description         By setting a key xxx to this function, the
                    current PROC and VARIABLE are passed to it
                    when the key is pressed during the program.
                    By comparing the PROC and VARIABLE parameters
                    against entries in the HELP.DBF, HELP() can
                    then provide the appropriate help screen for
                    the user. If no matching record is found, HELP()
                    displays a 'No Help Found' message to the user.

                    HELP() works in conjunction with HELPMOD() which
                    is used to create help screen records for the
                    HELP.DBF. HELPMOD() allows online creation and
                    modification of the size, location and contents
                    of the help screen for the current PROC,VARIABLE
                    combination.

                    It is important to issue the following statement
                    in your code: EXTERNAL HELP
                    This is due to Clipper not recognizing and linking
                    in procs that are only referenced as SET KEY's.
Examples            EXTERNAL HELP
                    SET KEY 28 to HELP
Notes               This approach has two major limitations. When a SET
                    KEY function is called while the program is in
                    ACHOICE(), only the ACHOICE is passed as a PROC, and
                    no variable is passed. Thus, only one help screen
                    for the proc ACHOICE is definable for an entire
                    system.

                    The 2nd is a difficulty with MENU TO. The PROC and
                    VARIABLE allow 1 help screen per MENU TO, as the
                    PROC,VARIABLE stays the same no matter which option
                    is hilited.

                    Both FUNCKY and GET-IT (libraries) have functions
                    which would help get around these limitations.

                    For READS, however, this HELP works pretty well.

Warnings            The 'HELP' key is still active while in this
                    proc. If you have a means of turning the
                    help key off and on, do so here.

Found in (prg)......S_HELP.PRG

This page created by ng2html v1.05, the Norton guide to HTML conversion utility. Written by Dave Pearson