Get Type of specified Parameter

This Subprogram will return the Parameter Type of the specified Parameter as a text string. This attribute is not used internally by UIPACK, but could be used by the Application Programmer to determine the UI_GET_xxx Subprogram to be used to prompt for the Parameter.

Short Name Calling Sequence

STATUS = UIGTPT(PARAM,TYPE)

Long Name Calling Sequence

STATUS = UI_GET_PARAMETER_TYPE(...)

Input Arguments

PARAM (Character) Parameter Name

Output Arguments

TYPE (Character) Parameter Type

Function Value

UI__SUCCESS ) Success UISUCC )

UI__ILLEGAL_PARAMETER ) Illegal Parameter UIILPA )

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).
2. PARAM should refer to a valid Parameter, or an unambiguous truncation thereof, for the currently setup Verb.
3. This Subprogram does not modify the definition of the currently setup Parameter. UI_USE_PARAMETER should be used if this is desired.
4. If the specified Parameter exists for the currently setup Verb, TYPE will be returned as one of the following Text Strings, with the indicated meaning:-

   ' '             Unspecified
   'DOUBLE'        Double Precision 
   'FILENAME'      Filename 
   'HEXADECIMAL'   Hexadecimal 
   'HEXBOUNDS'    Hexadecimal Bounds 
   'HEXLIST'      Hexadecimal List 
   'INTEGER'       Integer 
   'INTBOUNDS'    Integer Bounds 
   'INTLIST'      Integer List 
   'LOGICAL'       Logical (True/False) 
   'OCTAL' Octal 
   'OCTBOUNDS'    Octal Bounds 
   'OCTLIST'      Octal List 
   'ONOFF'         On/Off 
   'REAL'          Real 
   'REALBOUNDS'   Real Bounds 
   'REALLIST'     Real List 
   'TEXT'          Text 
   'YESNO'         Yes/No
   

   where these will be truncated or padded out with trailing spaces as appropriate.
5. If the specified Parameter is not valid (either because it is not associated with the currently setup Verb, or is ambiguous), TYPE will be set to all spaces.