View source for $List Global Del and $List Session Del

{{DISPLAYTITLE:$List_Global_Del and $List_Session_Del}}
<span class="pageSubtitle">$List_Global_Del and $List_Session_Del: Delete global/session $lists</span>

<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the <var>$List_Global_Del</var> and <var>$List_Session_Del</var> functions.</p>

These functions delete one or more global or session $lists that were created with either <var>$ListSav</var> (or <var>$ListSave</var>), <var>$List_Global</var>, or <var>$List_Session</var> in the current or any previous <var class="product">SOUL</var> program. It always returns a result of 1. 

<var>$List_Global_Del</var> and <var>$List_Session_Del</var> accept one argument and return a numeric result. Both are [[Calling Sirius Mods $functions|callable]] $functions. 

==Syntax==
<p class="syntax">[%RESULT =] $List_Global_Del(name)
</p>
<p class="syntax">[%RESULT =] $List_Session_Del(name)
</p>

===Syntax terms===
<table class="syntaxTable">
<tr><th>%result</th>
<td>Always set to 1.</td></tr>
<tr><th>%result</th>
<td>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.</td></tr>
</table>

==Usage notes==
<ul>
<li>The name specified for <var>$List_Global_Del</var> or <var>$List_Session_Del</var> can be an explicit name or it can contain the following wildcard characters:

<table class="syntaxTable">
<tr><th>*</th>
<td>Matches any number of characters including none</td></tr>
<tr><th>?</th>
<td>Matches any single character</td></tr>
<tr><th>"</th>
<td>Indicates that the next character must be treated literally even if it is a wildcard character.
</td></tr></table>

For example, the following statement would delete only a global $list named <code>TYRANNOSAURUS</code>:
<p class="code">%rc = $List_Global_Del('TYRANNOSAURUS')</p>

The following would delete globals $lists named <code>STEG</code>, <code>STEGOSAURUS</code>, and <code>STEG.DATA</code>, if they existed:
<p class="code">%rc = $List_Global_Del('STEG*')</p>

The following would delete session $lists named <code>STAN</code>, <code>STEP</code>, and <code>STUN.DATA</code>, if they existed:
<p class="code">%rc = $List_Session_Del('ST??')</p>

The following would delete globals $lists named <code>*</code>, <code>*LOOK</code>, and <code>*ZAP.DATA</code>, if they existed:
<p class="code">%rc = $List_Global_Del('"**')</p>

The following would delete all session $lists: 
<p class="code">%rc = $List_Session_Del('*')</p>

<li>When a <var>$List_Global_Del</var> or <var>$List_Session_Del</var> 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 <code>%listc</code> is no longer valid: 
<p class="code">%listc = $List_Global('VELOCIRAPTOR')
%rc = $List_Global_Del('VEL*')</p>

<var>$List_Global_Del</var> does not distinguish among the manner in which a global $list was created; it will delete any $list created with <var>$List_Global</var>, <var>$Listsave</var>, or <var>$Listsav</var>, 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 <var>$List_Session</var>, <var>$List_Session_Del</var> will delete only $lists created by <var>$List_Session</var>. 

<li>A <var>$List_Session_Del</var> call when there is no session open causes a request cancellation. 
</ul>

==Products authorizing $List_Global_Del and $List_Session_Del==
<ul class="smallAndTightList">
<li>[[List of $functions|Sirius functions]]</li>
<li>[[Fast/Unload User Language Interface]]</li>
<li>[[Media:JoclrNew.pdf|Janus Open Client]]</li>
<li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li>
<li>[[Janus Sockets]]</li>
<li>[[Janus Web Server]]</li>
<li>Japanese functions</li>
<li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li>
</ul>
 
[[Category:$Functions|$List_Global_Del and $List_Session_Del]]