getarg

From Eternity Wiki
Revision as of 09:14, 8 July 2009 by Printz (talk | contribs)
Jump to navigationJump to search

native getarg(arg, index = 0);

Found in: core.inc

Description

This function allows a script that takes a variable number of arguments to access the values which were passed to the script. As with all other indexing in Small, the first argument is considered to be #0, not #1. The second argument, which is optional, is used as an array index when the function takes arrays as parameters.

Parameters
  • arg: Argument sequence number. The first argument to the function is argument zero.
  • index: When the argument specified by 'arg' is an array, this parameter specifies an index into that array.
Return value

Value of the specified argument (and for arrays, at the given index).

See also

Small Functions