next up previous contents
Up: Help Subprograms Previous: Drop Help File

Prompt for Verb and Display Help Information

This Subprogram will prompt for the Operator to supply a Verb Name and will then Display the Help Information associated with that Verb. It acts as an alternative to the normal ``?" Help.

Short Name Calling Sequence

STATUS = UIGTHE(PROMPT)

Long Name Calling Sequence

STATUS = UI_GET_HELP(...)

Input Arguments

PROMPT (Character) Prompt Text String

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI ) Note:

  1. Only Verbs within the currently setup Verb Group are valid.
  2. A null response will cause a brief summary of all the Verbs within the currently setup Verb Group to be displayed.
  3. The Prompt string will only be issued if a response is not already present in the input line.
  4. Only a brief Help description will be shown if no Help File has been defined for the current Verb Group (see UI_DEFINE_HELP).



Liz Buckle
Fri Jan 13 17:37:44 CST 1995