$ListChk: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
(Automatically generated page update)
 
(24 intermediate revisions by 3 users not shown)
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="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.  
Line 10: Line 10:
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"><section begin="syntax" />%result = $ListChk(list_identifier)
<p class="syntax"><span class="term">%result</span> = <span class="literal">$ListChk</span>(<span class="term">list_identifier</span>)
<section end="syntax" /></p>
<p class="caption">$ListChk Function
</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>
</p>
<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
Line 24: Line 24:
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>
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>


<h2>Products authorizing {{PAGENAMEE}}</h2><ul class="smallAndTightList">
==Products authorizing {{PAGENAMEE}}==
<li>[[Sirius functions]]</li>
<ul class="smallAndTightList">
<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>[[Japanese functions]]</li>
<li>Japanese functions</li>
<li>[[Sir2000 Field Migration Facility]]</li>
<li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li>
</ul>
</ul>
   
   

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

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$ListChk&oldid=116859"