Readintegerarray - Crestron SIMPL+ Reference Manual

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

ReadIntegerArray

Name:
ReadIntegerArray
Syntax:
SIGNED_INTEGER ReadIntegerArray( INTEGER file_handle,
INTEGER iArray[m][n] )
Description:
Reads the array from a file starting at the current file position. Two bytes are read,
most significant first containing the row dimension of the array, then two more bytes
are read, containing the column dimension of the array. Then each integer is read as
a two byte quantity, most significant byte first. The integers are stored in row-major
order, e.g. all the elements of row 0 first, then the elements of row 1, etc. Note that
there is one more row and one more column than the dimensions that are read,
because there is a row 0 and a column 0. Refer to the section entitled "Reading and
Writing Data to a File" on page
when to use the related functions: FileRead, ReadInteger, ReadString, ReadStructure,
ReadSignedInteger, ReadLongInteger, ReadLongSignedInteger, ReadIntegerArray,
ReadSignedIntegerArray, ReadLongIntegerArray, ReadLongSignedIntegerArray,
ReadStringArray.
NOTE: Input and Output variables of any kind are not allowed in the file read
functions.
Parameters:
FILE_HANDLE specifies the file handle of the previously opened file (from
FileOpen).
IARRAY is the array whose values are read.
Return Value:
Number of bytes read from file. If the return value is negative, it is an error code. An
error occurs if the array is not large enough to hold the data.
118 for a discussion of when to use this function and
Software
®
SIMPL+ 161