$ListCnt: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 17: Line 17:
<var class="term">%result</var> is set either to the number of items in the indicated $list, or to a negative number if an error has occurred.</p>
<var class="term">%result</var> is set either to the number of items in the indicated $list, or to a negative number if an error has occurred.</p>


===Error codes===
<p class="code">-5 - Required argument not specified
<p class="code">-5 - Required argument not specified
-6 - $List identifier invalid
-6 - $List identifier invalid
</p>
<p class="caption">$ListCnt Error Codes
</p>
</p>



Revision as of 21:48, 18 July 2013

Number of items in $list

Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListCnt function is Count.

This function returns an integer that, if positive, contains the number of items in the specified $list and if negative indicates an error.

The $ListCnt function accepts one argument and returns a numeric result.

The first argument is a $list identifier. This is a required argument.

Syntax

%result = $ListCnt(list_identifier)

%result is set either to the number of items in the indicated $list, or to a negative number if an error has occurred.

Error codes

-5 - Required argument not specified -6 - $List identifier invalid

Products authorizing $ListCnt