$ListChk: Difference between revisions
m (1 revision) |
m (1 revision) |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Validate a $list identifier</span> | <span class="pageSubtitle">Validate a $list identifier</span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $ListChk function.</p> | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the <var>$ListChk</var> function.</p> | ||
This function returns either a 0 if a value is not a valid $list identifier and a 1 otherwise. | 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 <var>$ListChk</var> function accepts one argument and returns a numeric result. | ||
The first argument is a potential $list identifier. This is a required argument. | The first argument is a potential $list identifier. This is a required argument. | ||
| Line 22: | Line 22: | ||
</p> | </p> | ||
The only possible error in a $ListChk call is not specifying a value for the candidate $list identifier. This error will cause request cancellation.<p> | The only possible error in a <var>$ListChk</var> call is not specifying a value for the candidate $list identifier. This error will cause request cancellation.<p> | ||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
Revision as of 19:25, 19 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" />
$ListChk Function
%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.
- 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 $ListChk