$ListDel

From m204wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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