$ListDel

From m204wiki
Revision as of 22:18, 8 February 2011 by 198.242.244.47 (talk) (Created page with "{{DISPLAYTITLE:$ListDel}} <span class="pageSubtitle"><section begin="desc" />Release CCATEMP storage used for $list<section end="desc" /></span> <p class="warning">Most Sirius $...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

<section begin="desc" />Release CCATEMP storage used for $list<section end="desc" />

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListDel function is to be entered.

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 (:hdref refid=callfun.).

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