$ListChk: Difference between revisions
m (1 revision) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Validate a $list identifier<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Validate a $list identifier<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 $ListChk 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. | ||
| Line 17: | Line 15: | ||
</p> | </p> | ||
<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="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"> | ||
All errors cause request cancellation | All errors cause request cancellation | ||
| Line 22: | Line 21: | ||
<p class="caption">$ListChk Error Codes | <p class="caption">$ListChk Error Codes | ||
</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 $ListChk call is not specifying a value for the candidate $list identifier. This error will cause request cancellation.<p> | ||
| Line 35: | Line 33: | ||
<li>[[Japanese functions]]</li> | <li>[[Japanese functions]]</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
| Line 41: | Line 38: | ||
<p class="caption">Products authorizing $ListChk | <p class="caption">Products authorizing $ListChk | ||
</p> | </p> | ||
[[Category:$Functions|$ListChk]] | [[Category:$Functions|$ListChk]] | ||
Revision as of 13:35, 9 February 2011
<section begin="desc" />Validate a $list identifier<section end="desc" />
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