$ListChk: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
Line 14: | Line 14: | ||
<p class="caption">$ListChk Function | <p class="caption">$ListChk Function | ||
</p> | </p> | ||
<p class="caption">% | <p class="caption">%result is set either to 1, if the passed value is indeed a valid $list identifier, or to 0 otherwise.</p> | ||
<p class="code"> | <p class="code"> |
Revision as of 20:44, 24 October 2012
Validate a $list identifier
Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $ListChk function.
This function returns either a 0 if a value is not a valid $list identifier and a 1 otherwise.
The $ListChk function accepts one argument and returns a numeric result.
The first argument is a potential $list identifier. This is a required argument.
Syntax
<section begin="syntax" />%result = $ListChk(list_identifier) <section end="syntax" />
All errors cause request cancellation
The only possible error in a $ListChk call is not specifying a value for the candidate $list identifier. This error will cause request cancellation.