Define Help File for Verb Group

This Subroutine defines a Help File associated with the currently Setup Verb Group. This File will be scanned in order to respond to requests from the User of an Application Program for Help.

Short Name Calling Sequence

STATUS = UIDFHE(FILNAM)

Long Name Calling Sequence

STATUS = UI_DEFINE_HELP(....)

Input Arguments

FILNAM (Character) Help Filename

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_SYNTAX ) Illegal Filename Syntax UIILSY )

UI__ILLEGAL_GROUP ) Illegal Verb Group UIILGP )

UI__LOCKED_GROUP ) Locked Verb Group UIGLOK )

Note:

1. The FILNAM Argument should correspond to a valid File.
   The UI__ILLEGAL_SYNTAX Function Value will be returned if the Filename syntax is illegal, or if the specified File does not exist.
2. Leading or Trailing spaces are ignored.
3. If a Help File has already been defined for the current Verb Group, this new File specification will supersede the earlier one.
4. Error UI__LOCKED_GROUP will be returned if the currently setup Verb Group has been locked by a prior call to UI_LOCK_GROUP.