FileTools[Compressed] - Maple Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : Programming : Input and Output : File Manipulation : FileTools : FileTools/Compressed/WriteFile

FileTools[Compressed]

  

WriteFile

  

write an entire compressed file

 

Calling Sequence

Parameters

Options

Description

Examples

Compatibility

Calling Sequence

WriteFile(gzipfilename, data, opts, gzipopts)

WriteFile(target in zipfilename, data, opts)

Parameters

gzipfilename

-

string

data

-

string or an rtable of hardware datatype numbers

target

-

string

zipfilename

-

string

opts

-

(optional) options as specified below

Options

• 

format : zip or gzip ; specify the output format explicitly

• 

output : bytes ; write bytes of string input directly to file, even when target ends in ".m" or ".mpl". even

• 

gzipopts : additional compression options to pass to zlib see FileTools[Compressed].

Description

• 

WriteFile is an all-in-one command to open a file, write data in a compressed format, and close the file.

• 

For gzip format, the default action is to overwrite the target file.

• 

For zip format, the file zipfilename is a container, so a target filename target within the archive filename must be specified. This is done with the syntax target in filename.  If target exists in zipfilename already, it will be replaced.  Replacing a file in a zip archive will force all other open handles to the same zip file to be closed.  If the target does not exist it will be appended to the zip file alongside any other pre-existing data.

• 

By default, the bytes of a string or hardware rtable are compressed and written to the target file.  Arbitrary Maple objects, such as non-hardware rtables can be written only if the name of the in-zip file target being written ends in ".m" or ".mpl".  In these cases, the Maple data structure is converted to either external save format, or plain text format before writing.  Specifying output=bytes will override the filename matching, and always write the bytes of a string or Array (and fail on other objects).

Examples

Create a temporary file in gzip format, write data, and retrieve it.

fileFileTools[TemporaryFilename]catFileTools[TemporaryDirectory],kerneloptsdirsep,GZtest-

file:=/mnt/tmpfs/mpldoc_slot4/mpldoc2/GZtest-yYoYxV9R

(1)

FileTools[Compressed][WriteFile]file,This is a test

14

(2)

FileTools[Compressed][ReadFile]file,string

This is a test

(3)

FileTools[Compressed][WriteFile]file,Array1..50,0,datatype=integer[1]

50

(4)

FileTools[Compressed][ReadFile]file

1 .. 50 ArrayData Type: integer1Storage: rectangularOrder: Fortran_order

(5)

FileTools[Remove]file

Create a temporary file in gzip format, write data, and retrieve it.

zipfileFileTools[TemporaryFilename]catFileTools[TemporaryDirectory],kerneloptsdirsep,Ziptest-

zipfile:=/mnt/tmpfs/mpldoc_slot4/mpldoc2/Ziptest-bx70dpPu

(6)

FileTools[Compressed][WriteFile]("inZipName" in zipfile, "This is a zip test");

18

(7)

FileTools[Compressed][Contents]zipfile

inZipName

(8)

FileTools[Compressed][WriteFile]("data" in zipfile, "This is a second file");

21

(9)

FileTools[Compressed][Contents]zipfile

inZipName,data

(10)

FileTools[Compressed][ReadFile]("data" in zipfile, string);

This is a second file

(11)

FileTools[Compressed][ReadFile]("inZipName" in zipfile, string);

This is a zip test

(12)

FileTools[Remove]zipfile

Compatibility

• 

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

• 

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

See Also

FileTools[Compressed]

FileTools[Compressed][ReadFile]

FileTools[Remove]

 


Download Help Document

Was this information helpful?



Please add your Comment (Optional)
E-mail Address (Optional)
What is ? This question helps us to combat spam