Define Verb

This Subprogram defines a new Verb within the currently setup Verb Group. This request will be treated as illegal if the currently setup Group is Locked.

Short Name Calling Sequence

STATUS = UIDFVB(VERB)

Long Name Calling Sequence

STATUS = UI_DEFINE_VERB(VERB)

Input Arguments

VERB (Character) Verb Text

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_GROUP ) Illegal Group UIILGP )

UI__LOCKED_GROUP ) Group Locked UIGLOK )

UI__ILLEGAL_SYNTAX ) Illegal Verb Syntax UIILSY )

UI__DUPLICATE_VERB ) Duplicate Verb UIDUVB )

UI__OVERFLOW ) Work Space Overflow UIOVRF ) Note:

1. The Verb Text should be made up from only the alpha-numeric characters a-z, A-Z and 0-9 together with the underscore ``_" and dollar ``$" characters. A maximum of 32 characters may be specified, of which only 8 are 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.
2. All subsequent calls to define Parameters, Qualifiers and Action Routines etc. will refer to this verb, unless prefixed by another call to UI_DEFINE_VERB or UI_USE_VERB to refer to another valid verb.
3. Error UI__LOCKED_GROUP will be returned if the currently setup Verb Group has been locked by a prior call to UI_LOCK_GROUP.