Define Alias Name for Verb

This Subroutine defines an alternative Alias Name for the currently setup Verb within the currently setup Verb Group. Whenever this Alias Name is entered by the Operator as a response, the primary Verb Name will be returned to the Application Program.

Short Name Calling Sequence

STATUS = UIDFAL(ALIAS)

Long Name Calling Sequence

STATUS = UI_DEFINE_ALIAS(....)

Input Arguments

ALIAS (Character) Verb Alias Name

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_GROUP ) Illegal Verb Group UIILGP )

UI__LOCKED_GROUP ) Group Locked UIGLOK )

UI__ILLEGAL_VERB ) Illegal Verb UIILVB ) Note:

1. The specified Alias is only associated with the currently setup Verb in the currently setup Verb Group (via prior calls to UI_DEFINE_VERB or UI_USE_VERB and UI_DEFINE_GROUP or UI_USE_GROUP).
2. An Alias Name must conform to the same naming conventions as for normal Verbs. Thus up to 32 characters may be specified, but only 8 are treated as significant by default. This default may be modified by a call to UI_DEFINE_VERB_LENGTH which allows the significant length to be adjusted up the maximum of 32 characters.
3. There is no limit to the number of Alias Names that may be associated with a Verb, but the Alias Names within each Verb Group must be unique.
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.