$ListAdd Lstr: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 2: Line 2:
<span class="pageSubtitle">Add longstring as new $list item</span>
<span class="pageSubtitle">Add longstring as new $list item</span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListAdd_Lstr function is the [[Add (Stringlist function)]].  Note that because Stringlists are longstring capabable, no special longstring methods are required.</p>
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var>$ListAdd_Lstr</var> function is the [[Add (Stringlist 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 (see [[Calling Sirius Mods $functions]]).  
The <var>$ListAdd_Lstr</var> function accepts two arguments and returns a numeric result. It is a callable $function (see [[Calling Sirius Mods $functions]]).  


The first argument is a $list identifier. This is a required argument.  
The first argument is a $list identifier. This is a required argument.  
Line 29: Line 29:
Before <var class="product">[[Sirius Mods]]</var> Version 6.6, it was a request cancelling error to try to add a longstring longer than the size limit of a $list item: 6124 bytes. This limitation was eliminated in <var class="product">[[Sirius Mods]]</var> Version 6.6.  
Before <var class="product">[[Sirius Mods]]</var> Version 6.6, it was a request cancelling error to try to add a longstring longer than the size limit of a $list item: 6124 bytes. This limitation was eliminated in <var class="product">[[Sirius Mods]]</var> Version 6.6.  


<var>$ListAdd_Lstr</var> works almost exactly like $ListAdd except:
<var>$ListAdd_Lstr</var> works almost exactly like <var>$ListAdd</var> except:


<ol>
<ol>
<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.  
<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).

Revision as of 19:25, 19 October 2012

Add longstring as new $list item

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListAdd_Lstr function is the Add (Stringlist 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 (see Calling Sirius Mods $functions).

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

<section begin="syntax" /> [%RESULT =] $ListAdd_Lstr(list_identifier, string) <section end="syntax" />

$ListAdd_Lstr Function

%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.

-3 - No room to add item (if LISTFC $SirParm parameter not set) All other errors cause request cancellation

$ListAdd_Lstr Error Codes

Before Sirius Mods Version 6.6, it was a request cancelling error to try to add a longstring longer than the size limit of a $list item: 6124 bytes. This limitation was eliminated in Sirius Mods Version 6.6.

$ListAdd_Lstr works almost exactly like $ListAdd except:

  1. It accepts a LONGSTRING input. $ListAdd_Lstr can be used with regular strings as well to pick up automatic request cancellation on programming errors.
  2. It cancels the request on any errors such as invalid $list identifier or invalid $list item number.
  3. It does not have an item length argument (argument 3 in $ListAdd).

$ListAdd_Lstr is available in Sirius Mods Version 6.2 and later.

Products authorizing $ListAdd

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$ListAdd_Lstr&oldid=33583"