FileTools - Maple Programming Help

Online Help

All Products    Maple    MapleSim


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

FileTools

  

Position

  

set or return the current position within a file

 

Calling Sequence

Parameters

Description

Examples

Calling Sequence

Position(file, pos)

Parameters

file

-

filename or file descriptor

pos

-

(optional) integer offset into the file or infinity

Description

• 

The Position(file) command returns the current position within the specified file. This is the position to which the next write takes place, or from which the next read takes place.

• 

The Position(file, pos) command sets the current position within the specified file and returns that new position.

• 

A specified position of infinity sets the current position to the end of the file.

• 

If file does not refer to an open file, an error is raised.

• 

To determine a position suitable for passing to Position in a text file, call Position. Only values returned by Position(file) are guaranteed to be meaningful when used in Position(file, pos). Counting characters while reading and/or writing is not reliable, because newline characters are translated from/to local conventions, which may use more than a single character. However, Position(file, infinity) is always valid.

Examples

testfileFileToolsTemporaryFiletest

testfile/tmp/test

(1)

FileToolsTextWriteFiletestfile,This is a test.

15

(2)

FileToolsTextOpentestfile

FileToolsPositiontestfile,∞

15

(3)

See Also

FileTools

FileTools[AtEndOfFile]

FileTools[Text]

IO_errors

iostatus