Drop a Parameter from Verb

This Subprogram may be used to drop a previously defined Parameter from the currently setup Verb in the currently setup Verb Group. This will cause any positional Qualifiers associated with the Parameter to also be dropped. This request will be treated as illegal if the currently setup Group is Locked.

Short Name Calling Sequence

STATUS = UIDRPA(PARAM)

Long Name Calling Sequence

STATUS = UI_DROP_PARAMETER(...)

Input Arguments

PARAM (Character) Parameter Name

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_GROUP ) Illegal Group ID UIILGP )

UI__LOCKED_GROUP ) Group Locked UIGLOK )

UI__ILLEGAL_VERB ) Illegal Verb UIILVB )

UI__ILLEGAL_PARAMETER ) Illegal Parameter UIILPA ) Note:

1. The specified Parameter must refer to an already defined Parameter (or truncation thereof) for the currently setup Verb.
2. All Parameters satisfying the specified name will be dropped. Thus a call to UI_DROP_PARAMETER with argument 'a' will cause all Parameters beginning with the letter A to be dropped.
3. If the PARAM Argument is '*' it is treated as a wildcard and all Parameters associated with the currently setup Verb will be dropped.
4. All Qualifiers associated with this Parameter will be dropped.
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.