$ListDel: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
{{DISPLAYTITLE:$ListDel}}
{{DISPLAYTITLE:$ListDel}}
<span class="pageSubtitle"><section begin="desc" />Release CCATEMP storage used for $list<section end="desc" /></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="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>

Revision as of 21:21, 22 November 2011

Release CCATEMP storage used for $list

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).

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 (see Calling Sirius Mods $functions).

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

Syntax

<section begin="syntax" /> [%RESULT =] $ListDel(list_identifier) <section end="syntax" />

$ListDel Function

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

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

$ListDel Error Codes

Products authorizing $ListDel