MYSARR

Variable that can store and return an array of string values that you specify. You can use multiple MySArr variables in a template by giving them different names.

Syntax

• MYSARR "mysarr_name", index_number = "string"

This sets the value for one index of a MySArr variable and returns the number 0.

The "mysarr_name" is not case sensitive, so MYSARR "Name1" is the same as MYSARR "name1". You can substitute an SVar or a MySVar for "mysarr_name".

Index_number can be any integer from -2,147,483,648 to 2,147,483,647, including the number 0. If you specify a fractional value (such as 0.7 or -13.6) for the index_number, it will be rounded to the nearest whole number (such as 1 or -14). If you specify a MYNVAR for the index_number, that variable must be surrounded by parentheses.

• MYSARR "mysarr_name", index_number

This returns the string value of the specified index of a MySArr variable. If the specified index of this MySArr variable has not been set, this command returns an empty string.

Return value

See above.

Notes

You can set up to 4,294,967,296 indexes for one MySArr. Also, there is no limit to the number of MySArrs that can be used within a template.

To clear a MySArr index, set it to an empty string. To clear all values in a MySArr, use the ARRAY_OPT command. To clear all variables, including MySArrs, use the INITVARS command.

All variables, including MySArrs, keep their assigned value until they are cleared or until you exit the GainSeeker module that was running the template. This allows a variable to be set by one template and then used by a subsequent template.

When you save a stored session, all variables – including MySArrs – are saved with the stored sessions. When you open this stored session, the values of these saved variables are retrieved.

Some MySArr values may be set by template commands. These include:

See also: MYNARR, MYSVAR, MYNVAR, SVAR, NVAR

Examples

FREAD 1 :
MYSARR "Characteristic", 1 = COL_S 4 :
MYSARR "Characteristic", 2 = COL_S 6 :
MYSARR "Characteristic", 3 = COL_S 10

This formula reads a line from a text file and uses three indexes of the "Characteristic" variable to hold characteristic names from separate columns.

MYSARR "Characteristic", 2

This formula returns the value of the index number 2 from the MySArr named "Characteristic".

MYSARR "Characteristic", NVAR 99 = [K1].

This formula uses NV at 99 to determine which index of the "Characteristic" variable will be used to hold the current value of cell [K1].

MYSARR "Characteristic", (MYNVAR "Counter") = [K1]

This formula uses MyNVar "Counter" to determine which index of the "Characteristic" variable will be used to hold the current value of cell [K1].