ReadFile - Maple Help
For the best experience, we recommend viewing online help using Google Chrome or Microsoft Edge.
Our website is currently undergoing maintenance, which may result in occasional errors while browsing. We apologize for any inconvenience this may cause and are working swiftly to restore full functionality. Thank you for your patience.

Online Help

All Products    Maple    MapleSim


FileTools[Compressed]

  

ReadFile

  

read an entire compressed file

 

Calling Sequence

Parameters

Options

Description

Examples

Compatibility

Calling Sequence

ReadFile(filename, outputtype, opts)

Parameters

filename

-

string, or string in string

outputtype

-

(optional) either string, ByteArray, or 'Array'(m,n,hwdatatype)

opts

-

(optional) options as specified below

Options

• 

format : bzip2, zip, or gzip ; specify the input format explicitly

Description

• 

ReadFile is an all-in-one command to open a file, read and decompress its data, and close the file.

• 

If the given file is in zip format, and an in-zip name is not specified (using "subfile" in "zipfile"), then the first member of the zip archive is read.

• 

If the second parameter, outputtype, is string then the contents of the file are returned as a string.

• 

If the outputtype is not specified and the in-zip file name ends in ".m", then the contents of the zip file will be parsed as if they were in Maple's internal object format.

• 

If the outputtype is not specified and the in-zip file name ends in ".mpl", then the contents of the zip file will be parsed as if they were a single Maple-syntax text command.

• 

If outputtype is Array, then m and n are integers specifying the dimensions of the Array. The dimensions are optional, and one or more can be set. The hwdatatype indicates one of the integer[], float[], or complex[] datatype variations accepted by the 'datatype' option of the Array command.

• 

If outputtype is set to bytes or does not match any of the above criteria then an Array of datatype integer[1] is returned.

Examples

Read from a file in gzip format.

(1)

(2)

(3)

(4)

(5)

Read from a file in zip format.

(6)

FileTools[Compressed][WriteFile]("first" in zipfile, "one");

(7)

FileTools[Compressed][WriteFile]("second" in zipfile, Array(1..50, 0, datatype=integer[1]));

(8)

(9)

(10)

FileTools[Compressed][ReadFile]("second" in zipfile);

(11)

Compatibility

• 

The FileTools[Compressed][ReadFile] command was introduced in Maple 16.

• 

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

See Also

FileTools[Compressed]

FileTools[Compressed][WriteFile]

FileTools[Remove]

StringTools[FromByteArray]

 


Download Help Document