Push (Stringlist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (syntax diagram, tags and links)
m (1 revision)
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Template:Stringlist:Push subtitle}}
{{Template:Stringlist:Push subtitle}}


This callable method adds arbitrary string data to the end of a <var>Stringlist</var>. <var>Push</var> method accepts one argument and returns a numeric result.
This [[Notation conventions for methods#Callable functions|callable]] method adds arbitrary string data to the end of a <var>Stringlist</var>. <var>Push</var> method accepts one argument and returns a numeric result.


==Syntax==
==Syntax==

Latest revision as of 19:40, 14 July 2011

Add string as new Stringlist item (Stringlist class)


This callable method adds arbitrary string data to the end of a Stringlist. Push method accepts one argument and returns a numeric result.

Syntax

[%count =] sl:Push( string)

Syntax terms

%count A numeric variable to contain the number of items in the indicated Stringlist after the string has been added. %count is also the item number associated with the added string in the Stringlist.
sl A Stringlist object.
string A string that is to be added to the Stringlist.

Usage notes

  • All errors result in request cancellation.
  • Available in Sirius Mods version 7.0 and later,

See also

  • The Add is the same as the Push method; Push was designed as a convenience for use with Pop.