Crestron SIMPL+ - ReadInteger Function

Crestron SIMPL+
®
Software
Language Reference Guide - DOC. 5797G SIMPL+
®
z 159
ReadInteger
Name:
ReadInteger
Syntax:
SIGNED_INTEGER ReadInteger ( INTEGER file_handle,
INTEGER i )
Description:
Reads an integer from a file starting at the current file position. Two bytes are read,
most significant byte first. Refer to the section entitled “Reading and Writing Data to
a File” on page 118 for a discussion of when to use this function and when to use the
related functions: FileRead, ReadInteger, ReadString, ReadStructure,
ReadSignedInteger, ReadLongInteger, ReadLongSignedInteger, ReadIntegerArray,
ReadSignedIntegerArray, ReadLongIntegerArray, ReadLongSignedIntegerArray,
ReadStringArray.
Parameters:
FILE_HANDLE specifies the file handle of the previously opened file (from
FileOpen).
I is the integer whose value is read.
Return Value:
Number of bytes read from file. If the return value is negative, it is an error code.
NOTE: Input and Output variables of any kind are not allowed in the file read
functions.