Click above to get retro games delivered to your door ever month!

Syntax

DO HELP  ... or ... EXTERNAL HELP

Purpose

Generalised context-sensitive help facility.

Arguments

Passed automatically if called through SET KEY:

     _proc -- procedure/function name

     _line -- line number if compiled with line numbers, else 0

     _var -- variable being read, if any

Setup

A help table, alias HELP, is required:

     Field  Field Name  Type       Width

         1  HELP_KEY    Character     15
         2  VARIABLE    Character     15
         3  SUBJECT     Character     35
         4  HELP        Memo          10
         5  HTR         Numeric        2
         6  HTC         Numeric        2
         7  HBR         Numeric        2
         8  HBC         Numeric        2

Clipper automatically ties the F1 key to the function HELP. The public
variable help_code is a lookup into HELP->Help_Key. If
help_code is empty or does not exist, _proc is used. THE_USUAL sets
help_code to DICT->Help_code when it loads a table. Help is made
context-sensitive by altering the value of M->help_code at appropriate
places in your code.

Example

     EXTERNAL HELP          && Press F1 anywhere.

Returns

.T.

Side Effects

None.

Artful Calls

GET/SET_KEYS, IS_OPEN, DB_OPEN, POP_MSG, VERIFY, READ_MEMO

Source File

AA_HELP.PRG, AM_HELP.PRG