FileTools[Text] - Maple Help

Home : Support : Online Help : Programming : Input and Output : File Manipulation : FileTools : FileTools/Text/WriteString

FileTools[Text]

 WriteString
 write a string to a file
 WriteFile
 write a string to a file and close the file

 Calling Sequence WriteString(file, str) WriteFile(file, str)

Parameters

 file - file descriptor or filename str - Maple string to be printed

Description

 • The WriteString(file, str) and WriteFile(file, str) commands write the specified Maple string to the specified file.
 • Both commands return a count of the number of characters written.  Due to different character encodings, this number may differ from the number of bytes written to disk.
 • If file is default, the output is written to the current output stream.
 • If file is terminal, the line is written to the top level output stream. The top level output stream is the current output stream that was in effect when Maple was started.
 • WriteFile behaves identically to WriteString, except that if the file is not open prior to calling WriteFile, it will be closed before returning.  Therefore,  WriteFile offers a convenient syntax to write a string to disk with a single command, without the need to open or close the file explicitly.
 • If no strings are specified, only a newline is printed.

Examples

 > $\mathrm{FileTools}[\mathrm{Text}][\mathrm{WriteString}]\left("testfile","This is a test"\right)$
 ${14}$ (1)
 > $\mathrm{FileTools}[\mathrm{Text}][\mathrm{Close}]\left("testfile"\right)$
 > $\mathrm{FileTools}[\mathrm{Text}][\mathrm{ReadLine}]\left("testfile"\right)$
 ${"This"}$ (2)
 > $\mathrm{FileTools}[\mathrm{Text}][\mathrm{ReadLine}]\left("testfile"\right)$
 ${"is"}$ (3)
 > $\mathrm{FileTools}[\mathrm{Text}][\mathrm{ReadLine}]\left("testfile"\right)$
 ${"a"}$ (4)
 > $\mathrm{FileTools}[\mathrm{Text}][\mathrm{ReadLine}]\left("testfile"\right)$
 ${"test"}$ (5)
 > $\mathrm{FileTools}[\mathrm{Remove}]\left("testfile"\right)$
 > $\mathrm{FileTools}[\mathrm{Text}][\mathrm{WriteFile}]\left("testfile","This is another test."\right)$
 > $\mathrm{FileTools}[\mathrm{Remove}]\left("testfile"\right)$

Compatibility

 • The FileTools[Text][WriteFile] command was introduced in Maple 18.