$ListDel: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
(Automatically generated page update)
 
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="warn"><b>Note: </b>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 <var>[[Empty (Stringlist subroutine)|Empty]]</var> 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>.  

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