FileInterface.Write(String, Variable) Method

Top

Description

Writes the first numberOfCharacters (or bytes if the FileInterface is in binary mode) from stringToWrite to the file stream, and returns the number of characters (or bytes) written to the stream.

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

Method Signature

FileInterface.Write(	String stringToWrite,
	Variable numberOfCharacters)

Arguments

stringToWrite
Description:	String to output to the FileInterface object.

numberOfCharacters
Description:	Number of characters from the string to output to the FileInterface object.
Valid Range:	numberOfCharacters ≥ 1

Return Value

Type:

number

If a variable argument is written, this method returns a 1 if the write was successful or a 0 if unsuccessful. If a string argument is written, this method returns the number of characters written to the file.

Syntax

myVariable1 = myFileInterface1.Write(myString1, myVariable2);