$ListDel: Difference between revisions
m (1 revision) |
m (1 revision) |
||
Line 12: | Line 12: | ||
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"><section begin="syntax" />[%RESULT =] $ListDel(list_identifier) | ||
<section end="syntax" /></p> | <section end="syntax" /></p> | ||
<p class="caption">$ListDel Function | <p class="caption">$ListDel Function |
Revision as of 20:32, 24 October 2012
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" />
-5 - Required argument not specified -6 - $List identifier invalid