$ListInf Lstr: Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Retrieve $list item into longstring</span> | <span class="pageSubtitle">Retrieve $list item into longstring</span> | ||
<p class="warn"><b>Note: </b>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> | <p class="warn"><b>Note: </b>Most Sirius $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. | ||
| Line 16: | Line 16: | ||
</p> | </p> | ||
<p> | <p> | ||
%result is a string that contains the contents of the indicated $list item.</p> | |||
<var>$ListInf_Lstr</var> works almost exactly like <var>$ListInf</var> except: | ==usage notes== | ||
<ul> | |||
<li><var>$ListInf_Lstr</var> works almost exactly like <var>$ListInf</var> except: | |||
<ul> | <ul> | ||
| Line 26: | Line 27: | ||
<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> | </ul> | ||
</ul> | |||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
| Line 40: | Line 40: | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$ListInf_Lstr]] | [[Category:$Functions|$ListInf_Lstr]] | ||
Revision as of 22:10, 18 July 2013
Retrieve $list item into longstring
Note: Most Sirius $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).