bdfp1m38Programming Concepts and Reference

HELPA-Help Message Text

Use this macro to build the output messages for the ZUDFM OAH (help) command.

Format




label
is a symbolic name assigned to the macro statement.

ENTRY=cmdtext
specifies the command for which you want to build the help message, where cmdtext is a 2- to 10-character string.

HEADER=hdrtext
specifies the header for the help message, where hdrtext is a 1- to 30-character string.

DESCRv=destext
specifies the command description that will be displayed in the help message, where v is a number from 1-7 and destext is a 1- to 45-character string.

RESTRw=restext
specifies any restrictions that will be displayed in the help message, where w is a number from 1-5 and restext is a 1- to 45-character string.

REFERx=reftext
specifies any references that will be displayed in the help message, where x is 1 or 2 and reftext is a 1- to 45-character string.

ENTRy=entrtext
specifies the different parameters that will be displayed in the help message, where y is a number from 1-20 and entrtext is a 1- to 25-character string.

ENTTz=enttext
specifies the description of the parameters specified with the ENTRy parameter, where z is a number from 1-20 and entrtext is a 1- to 45-character string.

Entry Requirements

None.

Normal Return

The help message is displayed.

Error Return

None.

Programming Considerations

Examples

The following example shows how to code a help message for the ZUDFM OAI/FILE command.

HELPA ENTRY=OAI/FILE,                                         -
      HEADER=DSECT_LABEL_DISPLAY,                             -
      DESCR1=THE_DSECT_EQUATES_AND_LABELS_WRITTEN,            -
      DESCR2=ONTO_MLS_BY_OFFLINE_PGMS_CAN_BE_DISPLAYED,       -
      DESCR3=ONLINE_WITH_OAI/FILE_ENTRIES,                    -
      RESTR1=NONE,                                            -
      REFER1=SEE_UFB_DOCUMENTATION,                           -
      ENTR01=OAI/FILE_,                                       -
      ENTT01=INDEX_OF_ALL_DSECTS_WRITTEN_ONTO_MLS,            -
      ENTR02=OAI/FILE/ID,                                     -
      ENTT02=DISPLAY_DETAILED_INFORMATION_OF_SPECIFIED_ID.,   -
      ENTT03=LREC-KEYS_VALIDATION/EQUATES/LABELS_WITH,        -
      ENTT04=DISPLACEMENT_AND_LENGTH

This example produces the following display:

+--------------------------------------------------------------------------------+
|User:   ZUDFM OAHOAI/FILE                                 |
|                                                                                |
|System: UDFM0243I          TPFDF HELP FACILITY                                  |
|        O A - H E L P  -  OAI/FILE    DSECT LABEL DISPLAY                       |
|        ---------------------------------------------------------------         |
|                                                                                |
|        DESCRIPTION:      THE DSECT EQUATES AND LABELS WRITTEN                  |
|                          ONTO MLS BY OFFLINE PGMS CAN BE DISPLAYED             |
|                          ONLINE WITH OAI/FILE ENTRIES                          |
|        RESTRICTION:      NONE                                                  |
|        REFERENCE:        SEE UFB DOCUMENTATION                                 |
|                                                                                |
|        ENTRIES:                                                                |
|        OAI/FILE          INDEX OF ALL DSECTS WRITTEN ONTO MLS                  |
|        OAI/FILE/ID       DISPLAY DETAILED INFORMATION OF SPECIFIED ID.         |
|                          LREC-KEYS VALIDATION/EQUATES/LABELS WITH              |
|                          DISPLACEMENT AND LENGTH                               |
+--------------------------------------------------------------------------------+

Related Macros

None.