Table of Contents
Advertisement
Crestron SIMPL+
Language Reference Guide - DOC. 5797G
®
WriteStringArray
Name:
WriteStringArray
Syntax:
SIGNED_INTEGER WriteStringArray ( INTEGER file_handle,
STRING s[] )
Description:
Writes a string array to a file starting at the current file position. Internally, the string
is stored with the first 2 bytes indicating the total number of strings 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 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
and when to use the related functions: FileWrite, WriteInteger, WriteString,
WriteStructure, WriteSignedInteger, WriteLongInteger, WriteLongSignedInteger,
WriteIntegerArray, WriteSignedIntegerArray, WriteLongIntegerArray,
WriteLongSignedIntegerArray, WriteStringArray.
NOTE: Input and Output variables of any kind are not allowed in the file reading and
writing functions, just internal variables.
Use ReadStringArray to read this.
Parameters:
FILE_HANDLE specifies the file handle of the previously opened file (from
FileOpen).
S is the string whose value is written.
Return Value:
Number of bytes written to the file. If the return value is negative, it is an error code.
118
for a discussion of when to use this function
Software
®
SIMPL+
201
Advertisement
Table of Contents
