Crestron SIMPL+ - ReadLongInteger Function

Crestron SIMPL+
®
Software
Language Reference Guide - DOC. 5797G SIMPL+
®
z 163
ReadLongInteger
Name:
ReadLongInteger
Syntax:
SIGNED_INTEGER ReadLongInteger ( INTEGER file_handle,
LONG_INTEGER li )
Description:
Reads a long integer from a file starting at the current file position. Four bytes are
read, most significant byte first and least significant byte last. 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).
LI is the long 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.