_getArrayLength()

This function returns the element count for a specified dimension of an array variable.

UJML Script Syntax

int _getArrayLength(arrayref arrayVariable, int dimension);

Parameters

Parameters	Description
arrayVariable	The name of an array variable. See Arrays.
dimension	The dimension of the array variable for which you want to get the size.

Returns

The _getArrayLength() function returns an int value representing the count of elements in a single dimension of an array variable.

Description

This function returns the count of elements for a specified dimension of an array variable. See Arrays. You must pass an integer value indicating which dimension of the array for which you want the size.

Note: The _getArrayLength() function works for all array variables, including array state variables.

Example

The following example gets the size of a one-dimensioned variable. It is part of the timer.ujml sample.

Copy Code

cnt = _getArrayLength(mListeners, 0);