$ListChk: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
Line 17: Line 17:
<var class="term">%result</var> is set either to 1, if the passed value is indeed a valid $list identifier, or to 0 otherwise.</p>
<var class="term">%result</var> 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">All errors cause request cancellation
All errors cause request cancellation
</p>
</p>
<p class="caption">$ListChk Error Codes
<p class="caption">$ListChk Error Codes

Revision as of 21:40, 18 July 2013

Validate a $list identifier

Note: 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

%result = $ListChk(list_identifier)

%result is set either to 1, if the passed value is indeed a valid $list identifier, or to 0 otherwise.

All errors cause request cancellation

$ListChk Error Codes

The only possible error in a $ListChk call is not specifying a value for the candidate $list identifier. This error will cause request cancellation.

Products authorizing $ListChk