$ListDel: Difference between revisions
m (1 revision) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Release CCATEMP storage used for $list<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Release CCATEMP storage used for $list<section end="desc" /></span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. | <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> | ||
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. | 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. | ||
| Line 8: | Line 8: | ||
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. | 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 $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. | The only argument is the identifier of the $list that is to be deleted. | ||
| Line 17: | Line 17: | ||
</p> | </p> | ||
<p class="caption">%RESULT is zero, or it is a negative error code if an error has occurred.</p> | <p class="caption">%RESULT is zero, or it is a negative error code if an error has occurred.</p> | ||
<p class="code"> | <p class="code"> | ||
-5 - Required argument not specified | -5 - Required argument not specified | ||
| Line 34: | Line 35: | ||
<li>[[Japanese functions]]</li> | <li>[[Japanese functions]]</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
| Line 40: | Line 40: | ||
<p class="caption">Products authorizing $ListDel | <p class="caption">Products authorizing $ListDel | ||
</p> | </p> | ||
[[Category:$Functions|$ListDel]] | [[Category:$Functions|$ListDel]] | ||
Revision as of 13:57, 9 February 2011
<section begin="desc" />Release CCATEMP storage used for $list<section end="desc" />
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
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility
Products authorizing $ListDel