$ListAdd Lstr: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
(Automatically generated page update) |
||
| (46 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$ListAdd_Lstr}} | {{DISPLAYTITLE:$ListAdd_Lstr}} | ||
<span class="pageSubtitle" | <span class="pageSubtitle">Add longstring as new $list item</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListAdd_Lstr function is the <var>[[Add (Stringlist function)|Add]]</var> function. Note that because Stringlists are longstring capabable, no special longstring methods are required.</p> | ||
This function adds longstring data to a $list. Generally, this $list would have been created with the $ListNew function. | This function adds longstring data to a $list. Generally, this $list would have been created with the [[$ListNew]] function. | ||
The $ListAdd_Lstr function accepts two arguments and returns a numeric result. It is a callable $function | The <var>$ListAdd_Lstr</var> function accepts two arguments and returns a numeric result. It is a [[Calling Sirius Mods $functions|callable]] $function. | ||
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 longstring that is to be added to the $list. This is a required argument. | The second argument is a longstring that is to be added to the $list. This is a required argument. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax" | <p class="syntax">[%RESULT =] $ListAdd_Lstr(list_identifier, string) | ||
</p> | </p> | ||
<p><var class="term">%result</var> is set either to the number of items in the indicated $list after the string has been added to the $list, or to a negative number if an error has occurred. Note that in the former case, %result is also the item number associated with the added string in the $list.</p> | |||
===Error Codes=== | |||
<p class="code">-3 - No room to add item | |||
(if LISTFC <var>$SirParm</var> parameter not set) | |||
All other errors cause request cancellation | |||
</p> | |||
$ListAdd_Lstr works almost exactly like $ListAdd except: | ==Usage notes== | ||
<ul> | |||
<li><var>$ListAdd_Lstr</var> works almost exactly like <var>$ListAdd</var> except: | |||
<li>It accepts a LONGSTRING input. $ListAdd_Lstr can be used with regular strings as well to pick up automatic request cancellation on programming errors. | <ul> | ||
<li>It accepts a LONGSTRING input. <var>$ListAdd_Lstr</var> can be used with regular strings as well to pick up automatic request cancellation on programming errors. | |||
<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 an item length argument (argument 3 in $ListAdd). | <li>It does not have an item length argument (argument 3 in $ListAdd). | ||
</ | </ul> | ||
</ul> | |||
==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> | <li>Japanese functions</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$ListAdd_Lstr]] | [[Category:$Functions|$ListAdd_Lstr]] | ||
Latest revision as of 22:51, 20 September 2018
Add longstring as new $list item
Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListAdd_Lstr function is the Add function. Note that because Stringlists are longstring capabable, no special longstring methods are required.
This function adds longstring data to a $list. Generally, this $list would have been created with the $ListNew function.
The $ListAdd_Lstr function accepts two arguments and returns a numeric result. It is a callable $function.
The first argument is a $list identifier. This is a required argument.
The second argument is a longstring that is to be added to the $list. This is a required argument.
Syntax
[%RESULT =] $ListAdd_Lstr(list_identifier, string)
%result is set either to the number of items in the indicated $list after the string has been added to the $list, or to a negative number if an error has occurred. Note that in the former case, %result is also the item number associated with the added string in the $list.
Error Codes
-3 - No room to add item (if LISTFC $SirParm parameter not set) All other errors cause request cancellation
Usage notes
- $ListAdd_Lstr works almost exactly like $ListAdd except:
- It accepts a LONGSTRING input. $ListAdd_Lstr can be used with regular strings as well to pick up automatic request cancellation on programming errors.
- It cancels the request on any errors such as invalid $list identifier or invalid $list item number.
- It does not have an item length argument (argument 3 in $ListAdd).