$ListInf Lstr: Difference between revisions

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


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListInf_Lstr 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 $ListInf_Lstr function is the <var>[[Item (Stringlist function)|Item]]</var> function.</p>


This function returns the current contents of a specified $list item as a LONGSTRING.  
This function returns the current contents of a specified $list item as a longstring.  


The $ListInf_Lstr function accepts two arguments and returns a longstring result.  
The <var>$ListInf_Lstr</var> function accepts two arguments and returns a longstring 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 the number of the item in the $list. This is a required argument.
The second argument is the number of the item in the $list. This is a required argument.
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %RESULT = $ListInf_Lstr(list_identifier, item_num)
<p class="syntax"><span class="term">%result</span> = $ListInf_Lstr(list_identifier, item_num)
<section end="syntax" /></p>
<p class="caption">$ListInf_Lstr Function
</p>
</p>
<p class="caption">%RESULT is a string that contains the contents of the indicated $list item.</p>
<p>
%result is a string that contains the contents of the indicated $list item.</p>


==usage notes==
<ul>
<li><var>$ListInf_Lstr</var> works almost exactly like <var>$ListInf</var> except:


$ListInf_Lstr works almost exactly like $ListInf except:
<ul>
<ol>
<li>It returns a longstring result so will cause request cancellation if the target %variable is not big enough to hold the result.  
 
<li>It returns a LONGSTRING result so will cause request cancellation if the target %variable is not big enough to hold the result.  
<li>It cancels the request on any errors such as invalid $list identifier or invalid $list item number.  
<li>It cancels the request on any errors such as invalid $list identifier or invalid $list item number.  
<li>It does not have item position and length arguments (arguments 3 and 4 in $ListInf).
<li>It does not have item position and length arguments (arguments 3 and 4 in $ListInf).
</ol>
</ul>
 
</ul>
 
$ListInf_Lstr is available in ''[[Sirius Mods]]'' Version 6.2 and later.<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>[[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 $ListInf_Lstr
</p>


[[Category:$Functions|$ListInf_Lstr]]
[[Category:$Functions|$ListInf_Lstr]]

Latest revision as of 22:51, 20 September 2018

Retrieve $list item into longstring

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

This function returns the current contents of a specified $list item as a longstring.

The $ListInf_Lstr function accepts two arguments and returns a longstring result.

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

The second argument is the number of the item in the $list. This is a required argument.

Syntax

%result = $ListInf_Lstr(list_identifier, item_num)

%result is a string that contains the contents of the indicated $list item.

usage notes

  • $ListInf_Lstr works almost exactly like $ListInf except:
    • It returns a longstring result so will cause request cancellation if the target %variable is not big enough to hold the result.
    • It cancels the request on any errors such as invalid $list identifier or invalid $list item number.
    • It does not have item position and length arguments (arguments 3 and 4 in $ListInf).

Products authorizing $ListInf_Lstr