next up previous contents
Next: Test whether Parameters Up: Command Line Decoding Previous: Get Type of

Get Type of specified Qualifier

This Subprogram will return the Qualifier Type of the specified Qualifier as a text string. It is intended for use in the situation where a Qualifier has been detected by UI_GET_QUALIFIER and the Application Programmer wishes to verify that the returned Function Value detailing whether the Qualifier is negated etc. is consistent with the definition of the Qualifier.

Short Name Calling Sequence

STATUS = UIGTQT(QUAL,TYPE)

Long Name Calling Sequence

STATUS = UI_GET_QUALIFIER_TYPE(...)

Input Arguments

QUAL (Character) Text of Qualifier

Output Arguments

TYPE (Character) Qualifier Type

Function Value

UI__SUCCESS ) Success UISUCC )

UI__ILLEGAL_QUALIFIER ) Illegal Qualifier UIILQU )

UI__NOT_INITIALIZED ) Package not Initialized UININI ) Note:

  1. While this Subprogram is primarily intended for use during the decoding of a Command Line, it also may be used elsewhere, in which case it operates on the currently setup Verb (via UI_USE_VERB) and Verb Parameter (via UI_USE_PARAMETER).
  2. QUAL should refer to a valid Qualifier, or an unambiguous truncation thereof, for the currently setup Verb. Only Qualifiers associated directly with the currently setup Verb are valid, unless UI_USE_PARAMETER has been called prior to this call, in which case only Qualifiers associated with that Verb Parameter are legal.
  3. If the specified Qualifier exists for the currently setup Verb, TYPE will be returned as one of the following Text Strings, with the indicated meaning:-

    ' '             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 will be truncated or padded out with trailing spaces as appropriate.
  4. If the specified Qualifier is not valid (either because it is not associated with the currently setup Verb, or is ambiguous), TYPE will be set to all spaces.


Liz Buckle
Fri Jan 13 17:24:10 CST 1995