Getnumarrayrows - Crestron SIMPL+ Reference Manual

Crestron SIMPL+
Language Reference Guide - DOC. 5797G
®

GetNumArrayRows

Name:
GetNumArrayRows
Syntax:
INTEGER GetNumArrayRows(STRING | INTEGER ARRAY_NAME);
Description:
Returns the number of rows for two-dimensional arrays.
One-dimensional arrays return 0.
Parameters:
ARRAY_NAME is the array name as determined by the size.
Return Value:
For the data types in the table after this paragraph, the return value of
GetNumArrayRows is shown.
DATA TYPE
INTEGER X[size1][size2]
SIGNED_INTEGER X[size1][size2]
SIGNED_LONG_INTEGER X[size1][size2]
STRING X[chars]
STRING_INPUT X[size][chars]
BUFFER_INPUT X[size][chars]
Example:
DIGITAL_INPUT TEST;
INTEGER My_Array[10][20];
PUSH TEST
{
PRINT("Rows = %d\n", GetNumArrayRows(My_Array));
}
In this example, Rows = 10 will be printed.
Version:
SIMPL+ Version 2.00
Software
RETURN VALUE
Size 1
Size 1
Size 1
Size
Size
Size
®
SIMPL+ 97