Use Parameter

This Subprogram specifies the Parameter to which subsequently defined Qualifiers are to be associated. Thus such Qualifiers, although associated with the currently setup Verb, may only form part of a valid response when attached directly to this Parameter. This Subprogram is also used when decoding a response from the User in order to identify the currently valid subset of Qualifiers.

Short Name Calling Sequence

STATUS = UIUSPA(PARAM)

Long Name Calling Sequence

STATUS = UI_USE_PARAMETER(PARAM)

Input Arguments

PARAM (Character) Parameter Name

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_PARAMETER ) Illegal Parameter UIILPA ) Note:

1. The specified Parameter must refer to an already defined Parameter associated with the currently setup Verb within the currently setup Verb Group. The Parameter name may be truncated as long as it remains unambiguous.
2. All subsequently defined Qualifiers will be positional dependent, being associated with this Parameter as well as the currently setup Verb.
3. Following a call to this Subprogram, only Qualifiers associated with this Parameter will be treated as legal when decoding a User response. To return to allowing Qualifiers directly associated with the current Verb to be treated as being valid, call UI_USE_VERB again (this being done implicitly by the Action Menu Subprograms).