Crestron SIMPL+ - ReadSignedInteger Function

Crestron SIMPL+
®
Software
Language Reference Guide - DOC. 5797G SIMPL+
®
z 167
ReadSignedInteger
Name:
ReadSignedInteger
Syntax:
SIGNED_INTEGER ReadSignedInteger ( INTEGER file_handle,
SIGNED_INTEGER si )
Description:
Reads a signed integer from a file starting at the current file position. Two bytes are
read, most significant 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).
SI is the signed 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.