Script Function Reference

Function Reference >Script Function Reference >Varaible Manipulation>getMatrix

getMatrix

getMatrix will retrieve a matrix variable.

getMatrix(varName, ...)

Parameters

getMatrix will accept any number of string values. Each string needs to be the name of a varaible defined in the calculator.

Return Value

For each parameter passed getMatrix will return a matrix in the matrix table format. If the variable is not defined in the calculator or is a number or list a nil is returned.

Example

function example()
	matrix = getMatrix("list")
	outputString("dim(matrix)=("..matrix.row..", "..matrix.col..")\n")
end