Define Qualifier on Verb

This Subroutine defines a Qualifier for the currently setup Verb (via UI_DEFINE_VERB or UI_USE_VERB) within the currently setup Verb Group. This Qualifier is positional, being directly associated with the Verb unless it has been preceeded by a call to UI_DEFINE_PARAMETER or UI_USE_PARAMETER in which case it is associated with that Parameter. This Subprogram also specifies whether the Qualifier is negatable, has an associated value, and the type of such a value. This request will be treated as illegal if the currently setup Group is Locked. etc.

Short Name Calling Sequence

STATUS = UIDFQU(QUAL,TYPE)

Long Name Calling Sequence

STATUS = UI_DEFINE_QUALIFIER(...)

Input Arguments

QUAL (Character) Qualifier Name TYPE (Character) Qualifier Type (see notes)

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__DUPLICATE_QUALIFIER ) Duplicate Qualifier UIDUPQ )

UI__ILLEGAL_VERB ) Illegal Verb UIILVB )

UI__ILLEGAL_GROUP ) Illegal Group UIILGP )

UI__LOCKED_GROUP ) Group Locked UIGLOK )

UI_ILLEGAL_TYPE ) Illegal Qualifier Type UIILTP ) Note:

1. The specified Qualifier is associated with only the currently setup Verb within the currently setup Group. If this association is desired for several Verbs and Groups, it must be made explicitly by multiple calls to this routine with UI_DEFINE_VERB (or UI_USE_VERB) and UI_DEFINE_GROUP (or UI_USE_GROUP) called as appropriate.
2. This Qualifier is positional, being directly associated with the currently setup Verb or the currently setup Verb Parameter. If this Qualifier should be position-independent, then either no Parameter Names should be associated with this Verb (this is only the names, not the fact that no parameters exist which is determined by the program code) or the Qualifier should be defined explicitly for each Verb and Parameter.
3. The Qualifier text should be made up of only the alphanumeric characters a-z, A-Z and 0-9 and the underscore ``_" and dollar ``$" characters. Up to 32 characters may be specified, of which 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.
4. Qualifiers may be of several types, some of which may have associated values. The TYPE argument specifies the type, and may take on the following values:-

   ' '             No associated Value
   'Double'        Double Precision Value
   'Filename'      Filename Value
   'Hexadecimal'   Hexadecimal Value
   'HexBounds'     Hexadecimal Bounds Value
   'HexList'       Hexadecimal List Value
   'Integer'       Integer Value
   'IntBounds'     Integer Bounds Value
   'IntList'       Integer List Value
   'Logical'       Logical (True/False) Value
   'Negatable'     Negatable
   'Octal'         Octal Value
   'OctBounds'     Octal Bounds Value
   'OctList'       Octal List Value
   'OnOff'         On/Off Value
   'Real'          Real Value
   'RealBounds'    Real Bounds Value
   'RealList'      Real List Value
   'Text'          Text Value
   'YesNo'         Yes/No Value
   

   where these may be truncated as long as they remain unambiguous (i.e. 'T' is valid) and are case insensitive (i.e. upper or lower case may be used). Specified Types of 'I', 'In' and 'Int' all default to 'Integer', and similar defaults hold for 'Hex', 'Oct' and 'Real'.
5. Error UI__LOCKED_GROUP will be returned if the currently setup Verb Group has been locked by a prior call to UI_LOCK_GROUP.