Crestron SIMPL+ - ReadStructure Function

Crestron SIMPL+
®
Software
Language Reference Guide - DOC. 5797G SIMPL+
®
z 179
ReadStructure
Name:
ReadStructure
Syntax:
ReadStructure ( INTEGER nFileHandle, STRUCTURE struct [,
INTEGER nTotalBytesRead] )
Description:
Reads data from a file starting at the current file position. Each element of the
structure is read, without any padding bytes, that might actually be there in memory.
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.
There is no error if the structure does not match the data.
Parameters:
nFileHandle - File handle of the previously opened file (from FileOpen).
struct - Structure variable that will receive data read from file
nTotalBytesRead - optional argument. INTEGER variable that will contain the total
number of bytes read from the file into the structure.
Return Value:
None.
NOTE: Input and Output variables of any kind are not allowed in the file reading and
writing functions, just internal variables.