$ListChk: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{DISPLAYTITLE:$ListChk}} <span class="pageSubtitle"><section begin="desc" />Validate a $list identifier<section end="desc" /></span> <p class="warning">Most Sirius $functions h...") |
(Automatically generated page update) |
||
| (41 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$ListChk}} | {{DISPLAYTITLE:$ListChk}} | ||
<span class="pageSubtitle" | <span class="pageSubtitle">Validate a $list identifier</span> | ||
<p class="warn"><b>Note: </b>Many $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. | ||
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. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax">< | <p class="syntax"><span class="term">%result</span> = <span class="literal">$ListChk</span>(<span class="term">list_identifier</span>) | ||
< | </p> | ||
<p | <p> | ||
</p> | </p> | ||
<p class=" | <p> | ||
<p class="code"> | <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">All errors cause request cancellation | |||
</p> | </p> | ||
<p class="caption">$ListChk Error Codes | <p class="caption">$ListChk Error Codes | ||
</p> | </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> | |||
==Products authorizing {{PAGENAMEE}}== | |||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius functions]]</li> | <li>[[List of $functions|Sirius functions]]</li> | ||
<li>[[Fast/Unload User Language Interface]]</li> | <li>[[Fast/Unload User Language Interface]]</li> | ||
<li>[[Janus Open Client]]</li> | <li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | ||
<li>[[Janus Open Server]]</li> | <li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li> | ||
<li>[[Janus Sockets]]</li> | <li>[[Janus Sockets]]</li> | ||
<li>[[Janus Web Server]]</li> | <li>[[Janus Web Server]]</li> | ||
<li> | <li>Japanese functions</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
</p> | </p> | ||
<p | <p> | ||
</p> | </p> | ||
[[Category:$Functions|$ListChk]] | [[Category:$Functions|$ListChk]] | ||
Latest revision as of 22:51, 20 September 2018
Validate a $list identifier
Note: Many $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
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility