$ListInf Lstr: Difference between revisions
m (1 revision) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Retrieve $list item into longstring<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Retrieve $list item into longstring<section end="desc" /></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 [[ | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListInf_Lstr function is the [[Item (Stringlist function]].</p> | ||
This function returns the current contents of a specified $list item as a | 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 $ListInf_Lstr function accepts two arguments and returns a longstring result. | ||
| Line 11: | Line 11: | ||
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"><section begin="syntax" /> %RESULT = $ListInf_Lstr(list_identifier, item_num) | ||
| Line 17: | Line 18: | ||
</p> | </p> | ||
<p class="caption">%RESULT is a string that contains the contents of the indicated $list item.</p> | <p class="caption">%RESULT is a string that contains the contents of the indicated $list item.</p> | ||
$ListInf_Lstr works almost exactly like $ListInf except: | $ListInf_Lstr works almost exactly like $ListInf except: | ||
<li>It returns a | <ul> | ||
<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). | ||
</ | </ul> | ||
$ListInf_Lstr is available in ''[[Sirius Mods]]'' Version 6.2 and later.<p> | $ListInf_Lstr is available in ''[[Sirius Mods]]'' Version 6.2 and later.<p> | ||
| Line 39: | Line 38: | ||
<li>[[Japanese functions]]</li> | <li>[[Japanese functions]]</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
</p> | </p> | ||
<p class="caption">Products authorizing $ListInf_Lstr | <p class="caption">Products authorizing $ListInf_Lstr | ||
</p> | </p> | ||
[[Category:$Functions|$ListInf_Lstr]] | [[Category:$Functions|$ListInf_Lstr]] | ||
Revision as of 15:02, 10 February 2011
<section begin="desc" />Retrieve $list item into longstring<section end="desc" />
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListInf_Lstr function is the Item (Stringlist 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
<section begin="syntax" /> %RESULT = $ListInf_Lstr(list_identifier, item_num) <section end="syntax" />
$ListInf_Lstr Function
%RESULT is a string that contains the contents of the indicated $list item.
$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).
$ListInf_Lstr is available in Sirius Mods Version 6.2 and later.
- 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 $ListInf_Lstr