Define Parameter for Verb

This Subroutine defines a Parameter for the currently setup Verb (via UI_DEFINE_VERB or UI_USE_VERB) within the currently setup Verb Group. It also specifies whether the Parameter is numeric, text etc. UIPACK does not use this type information other than to make it available to the Application Programmer via UI_GET_PARAMETER_TYPE. Parameters may be used to identifier whether a Qualifier is positional or may be freely associated with the Verb or Parameters. This request will be treated as illegal if the currently setup Group is Locked.

Short Name Calling Sequence

STATUS = UIDFPA(PARAM,TYPE)

Long Name Calling Sequence

STATUS = UI_DEFINE_PARAMETER(...)

Input Arguments

PARAM (Character) Parameter Name TYPE (Character) Parameter Type (see notes)

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__DUPLICATE_PARAMETER ) Duplicate Parameter UIDUPP )

UI__ILLEGAL_SYNTAX ) Illegal Parameter Syntax UIILSY )

UI__ILLEGAL_VERB ) Illegal Verb UIILVB )

UI__ILLEGAL_GROUP ) Illegal Group UIILGP )

UI__LOCKED_GROUP ) Group Locked UIGLOK )

UI_ILLEGAL_TYPE ) Illegal Parameter Type UIILTP ) Note:

1. The specified Parameter 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. The Parameter Name 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.
3. Following a call to this subprogram any subsequently defined Qualifiers (via UI_DEFINE_QUALIFIER) will be associated with this Verb Parameter rather than directly with the currently setup Verb.
4. Parameters may be of several types such as unspecified, integer, text etc. The TYPE argument specifies the type, and may take on the following values:-

   ' '             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 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.