FileTools[Text] - Maple Programming Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : Programming : Input and Output : File Manipulation : FileTools : Text Subpackage : 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

Parameters

Description

Examples

Compatibility

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.

• 

WriteString does not close the file after writing the specified string. To ensure all data is appended to file it is necessary to explicitly close the file after WriteString or other FileTools[Text] commands are performed.

• 

WriteFile behaves identically to WriteString, except that if the specified file was not already open prior to WriteFile being called, then WriteFile will close it before it returns. WriteFile therefore offers a convenient syntax to write a string to disk with a single command, without the need to open or close the file explicitly.

Examples

FileToolsTextWriteStringtestfile,This is a test

14

(1)

FileToolsTextClosetestfile

FileToolsTextReadLinetestfile

This

(2)

FileToolsTextReadLinetestfile

is

(3)

FileToolsTextReadLinetestfile

a

(4)

FileToolsTextReadLinetestfile

test

(5)

FileToolsRemovetestfile

FileToolsTextWriteFiletestfile,This is another test.

21

(6)

FileToolsRemovetestfile

Compatibility

• 

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

• 

For more information on Maple 18 changes, see Updates in Maple 18.

See Also

file

FileTools[Remove]

FileTools[Text]

FileTools[Text][Close]

FileTools[Text][Open]

FileTools[Text][ReadLine]

FileTools[Text][ReadString]

IO_errors