$ListDel: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
(Automatically generated page update)
 
(26 intermediate revisions by 3 users not shown)
Line 2: Line 2:
<span class="pageSubtitle">Release CCATEMP storage used for $list</span>
<span class="pageSubtitle">Release CCATEMP storage used for $list</span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $ListDel function, but stringlists can be emptied of content with the [[Empty (Stringlist subroutine)]].</p>
<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $ListDel function, but stringlists can be emptied of content with the <var>[[Empty (Stringlist subroutine)|Empty]]</var> subroutine.</p>


This function releases CCATEMP storage containing $list items, which helps reduce CCATEMP usage and possibly reduce disk I/O. The information contained in the $list is lost after a <var>$ListDel</var>.  
This function releases CCATEMP storage containing $list items, which helps reduce CCATEMP usage and possibly reduce disk I/O. The information contained in the $list is lost after a <var>$ListDel</var>.  
Line 8: Line 8:
Note that while it is not strictly necessary to <var>$ListDel</var> any $list since they are cleaned up at the termination of the current procedure, the processing for <var>$ListDel</var> is considerably more efficient than end of evaluation cleanup and can actually reduce CCATEMP I/O.  
Note that while it is not strictly necessary to <var>$ListDel</var> any $list since they are cleaned up at the termination of the current procedure, the processing for <var>$ListDel</var> is considerably more efficient than end of evaluation cleanup and can actually reduce CCATEMP I/O.  


The <var>$ListDel</var> function accepts one argument and returns a numeric result. It is a callable $function (see [[Calling Sirius Mods $functions]]).  
The <var>$ListDel</var> function accepts one argument and returns a numeric result. It is a [[Calling Sirius Mods $functions|callable]] $function.  


The only argument is the identifier of the $list that is to be deleted.
The only argument is the identifier of the $list that is to be deleted.
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" />[%RESULT =] $ListDel(list_identifier)
<p class="syntax">[%RESULT =] $ListDel(list_identifier)
<section end="syntax" /></p>
<p class="caption">$ListDel Function
</p>
</p>
<p class="caption">%result is zero, or it is a negative error code if an error has occurred.</p>


<p class="code">  
<p><var class="term">%result</var> is zero, or it is a negative error code if an error has occurred.</p>
-5 - Required argument not specified
 
-6 - $List identifier invalid
===Error codes===
<p class="code">-5 - Required argument not specified
-6 - $List identifier invalid
</p>
</p>
<p class="caption">$ListDel Error Codes
</p>
<p class="code">


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

Latest revision as of 22:51, 20 September 2018

Release CCATEMP storage used for $list

Note: Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $ListDel function, but stringlists can be emptied of content with the Empty subroutine.

This function releases CCATEMP storage containing $list items, which helps reduce CCATEMP usage and possibly reduce disk I/O. The information contained in the $list is lost after a $ListDel.

Note that while it is not strictly necessary to $ListDel any $list since they are cleaned up at the termination of the current procedure, the processing for $ListDel is considerably more efficient than end of evaluation cleanup and can actually reduce CCATEMP I/O.

The $ListDel function accepts one argument and returns a numeric result. It is a callable $function.

The only argument is the identifier of the $list that is to be deleted.

Syntax

[%RESULT =] $ListDel(list_identifier)

%result is zero, or it is a negative error code if an error has occurred.

Error codes

-5 - Required argument not specified -6 - $List identifier invalid


Products authorizing $ListDel