$ListDel: Difference between revisions
m (1 revision) |
m (1 revision) |
||
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 (see [[Calling Sirius Mods $functions]]). | ||
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. |
Revision as of 01:20, 26 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" />
%result is zero, or it is a negative error code if an error has occurred.
-5 - Required argument not specified -6 - $List identifier invalid
Products authorizing $ListDel
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility