$List_Global_Del and $List_Session_Del
$List_Global_Del and $List_Session_Del: Delete global/session $lists
Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $List_Global_Del and $List_Session_Del functions.
These functions delete one or more global or session $lists that were created with either $LISTSAV, $LISTSAVE, $List_Global or $List_Session in the current or any previous User Language program. It always returns a result of 1.
$List_Global_Del and $List_Session_Del accept one argument and return a numeric result. Both are callable $functions.
Syntax
<section begin="syntax" />[%RESULT =] $List_Global_Del(name) <section end="syntax" />
[%RESULT =] $List_Session_Del(name)
Syntax terms
| %result | Always set to 1. |
|---|---|
| %result | The name of the global or session $list or $lists to be deleted. If not specified, only a $list with a null name is deleted. This argument can contain wildcard characters, as described below. |
Usage notes
- The name specified for $List_Global_Del or $List_Session_Del can be an explicit name or it can contain the following wildcard characters:
* Matches any number of characters including none ? Matches any single character " Indicates that the next character must be treated literally even if it is a wildcard character. For example, the following statement would delete only a global $list named
TYRANNOSAURUS:%rc = $List_Global_Del('TYRANNOSAURUS')
The following would delete globals $lists named
STEG,STEGOSAURUS, andSTEG.DATA, if they existed:%rc = $List_Global_Del('STEG*')
The following would delete session $lists named
STAN,STEP, andSTUN.DATA, if they existed:%rc = $List_Session_Del('ST??')
The following would delete globals $lists named
*,*LOOK, and*ZAP.DATA, if they existed:%rc = $List_Global_Del('"**')
The following would delete all session $lists:
%rc = $List_Session_Del('*')
- When a $List_Global_Del or $List_Session_Del is issued against a global or session $list that has a $list identifier associated with it, that $list identifier becomes invalid. For example, after issuing the following sequence, the $list identifier in
%listcis no longer valid:%listc = $List_Global('VELOCIRAPTOR') %rc = $List_Global_Del('VEL*')
$List_Global_Del does not distinguish among the manner in which a global $list was created; it will delete any $list created with $List_Global, $Listsave, or $Listsav, whether or not it has been referred to with any of these $functions in the current request. Since session $lists can only be created with $List_Session, $List_Session_Del will delete only $lists created by $List_Session.
- A $List_Session_Del call when there is no session open causes a request cancellation.