Table of Contents
Advertisement
Crestron SIMPL+
Language Reference Guide - DOC. 5797G
®
ReadStringArray
Name:
ReadStringArray
Syntax:
SIGNED_INTEGER ReadStringArray ( INTEGER file_handle,
STRING s[] )
Description:
Reads a string from a file starting at the current file position. Internally, the string is
stored with the first 2 bytes indicating the total number of string written, then each
string follows as a 2-byte length, most significant byte first, then the actual string
bytes. In the case of a string variable, the total number of bytes is the calculated from
the size of the string, not the string allocation size. Refer to the section entitled
"Reading and Writing Data to a File" on page
function and 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 reading and
writing functions, just internal variables.
Parameters:
FILE_HANDLE specifies the file handle of the previously opened file (from
FileOpen).
S is the string whose value is read.
Return Value:
Number of bytes read from file into the string. 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.
Software
118
for a discussion of when to use this
SIMPL+
®
177
Advertisement
Table of Contents
