$ListILn: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:$ListILn}} <span class="pageSubtitle"><section begin="desc" />Length of $list item<section end="desc" /></span> <p class="warning">Most Sirius $functions have bee...")
 
(Automatically generated page update)
 
(44 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:$ListILn}}
{{DISPLAYTITLE:$ListILn}}
<span class="pageSubtitle"><section begin="desc" />Length of $list item<section end="desc" /></span>
<span class="pageSubtitle">Length of $list item</span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListILn function is [[to be entered]].</p>
<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListILn function is <var>[[ItemLength (Stringlist function)|ItemLength]]</var>.</p>


This function returns a number containing the length of a specified $list item, or it returns a negative number indicating that an error has occurred.  
This function returns a number containing the length of a specified $list item, or it returns a negative number indicating that an error has occurred.  


The $ListILn function accepts two arguments and returns a numeric result.  
The <var>$ListILn</var> function accepts two arguments and returns a numeric result.  


The first argument is a $list identifier. This is a required argument.  
The first argument is a $list identifier. This is a required argument.  


The second argument is a string that specifies the item number in the $list. This is a required argument.
The second argument is a string that specifies the item number in the $list. This is a required argument.
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %RESULT = $ListILn(list_identifier, item_num)
<p class="syntax"><span class="term">%result</span> = <span class="literal">$ListILn</span>(<span class="term">list_identifier</span>, <span class="term">item_num</span>)
<section end="syntax" /></p>
<p class="caption">$ListILn Function
</p>
</p>
<p class="caption">%RESULT is a string that contains the length of the indicated $list item, or it is a negative number if an error has occurred.</p>
 
<p class="code">  
<p>
-5 - Required argument not specified
<var class="term">%result</var> is a string that contains the length of the indicated $list item, or it is a negative number if an error has occurred.</p>
-6 - $List identifier invalid
 
-7 - Item number not found in $list
===Error codes===
</p>
<p class="code">-5 - Required argument not specified
<p class="caption">$ListILn Error Codes
-6 - $List identifier invalid
-7 - Item number not found in $list
</p>
</p>
<p class="code">


==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>[[Japanese functions]]</li>
<li>Japanese functions</li>
<li>[[Sir2000 Field Migration Facility]]</li>
<li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li>
 
</ul>
</ul>
</p>
<p class="caption">Products authorizing $ListILn
</p>


[[Category:$Functions|$ListILn]]
[[Category:$Functions|$ListILn]]

Latest revision as of 22:51, 20 September 2018

Length of $list item

Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListILn function is ItemLength.

This function returns a number containing the length of a specified $list item, or it returns a negative number indicating that an error has occurred.

The $ListILn function accepts two arguments and returns a numeric result.

The first argument is a $list identifier. This is a required argument.

The second argument is a string that specifies the item number in the $list. This is a required argument.

Syntax

%result = $ListILn(list_identifier, item_num)

%result is a string that contains the length of the indicated $list item, or it is a negative number if an error has occurred.

Error codes

-5 - Required argument not specified -6 - $List identifier invalid -7 - Item number not found in $list

Products authorizing $ListILn