Writestructure - Crestron SIMPL+ Reference Manual

Crestron SIMPL+
Language Reference Guide - DOC. 5797G
®

WriteStructure

Name:
WriteStructure
Syntax:
WriteStructure ( INTEGER nFileHandle, STRUCTURE struct
[, INTEGER nTotalBytesWritten] )
Description:
Writes data to a file starting at the current file position. Each element of the structure
is written, 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
discussion of when to use this function 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 ReadStructure to read this.
Parameters:
nFileHandle - File handle of the previously opened file (from FileOpen).
struct - Structure variable whose data will be written to the file.
nTotalBytesWritten - optional argument. INTEGER variable that will contain the
total number of bytes written to the file from the structure.
Return Value:
None.
Software
118 for a
®
SIMPL+ 203