SubstArr

Syntax

SubstArr(tbl_file, str_key, array);

tbl_file	A string specifying the path and filename of the substitution table.
str_key	A string specifying a key in the table.
array	A variable that receives the array of columns from the substitution entry.

Description

Looks up a key in a substitution table, and creates an array containing the entry values. Returns the number of entry values.

Returns

num	If the key was found, returns the number of items returned in array.
-1	The key was not found.

Example

In this example, the following substitution table (author.tbl) is used.

//!CodePage UTF8! //!multicolumn! agatha christie 1890 alfred hitchcock 1899

The following script creates an array for the entry with key agatha:

$nCol = SubstArr("../data/tables/author.tbl", "agatha", $addrArr);

$surName = $addrArr[0];

$birthDay =  $addrArr[1];

Result:

$nCol = 2

$surName = christie

$birthDay = 1890

Notes

•	A substitution table is kept in memory until the script function EraseSubst is called for that table.