Seed7 - The extensible programming language
Seed7 FAQ Manual Screenshots Examples Libraries Algorithms Download Links
Libraries AES ARC4 Array ASN.1 Bigfile Bigint Bigrat Bin32 Bin64 Bitdata Bitmapfont Bitset Bitsetof Boolean Browser Bstring Bytedata Cards Category CC config Cgi Cgi dialog Char Charsets Cipher Clib_file Color CLI Commands Complex Console Crc32 Deflate DES Dialog Dir Draw Duration Echo Editline Enable_input Enable_io Enable_output Encoding Environment External_file File File system Float Font Forloop Ftp Getf Gethttp Gethttps Graph Graph_file Gzip Hash Hashsetof Hmac Html_ent Httpserv Idxarray Image Inflate Inflate file Inifile Integer Keybd Line Listener LZW Make Math Msgdigest Null_file Osfiles Picture utility Pixmap_file Pixmapfont PKCS #1 Poll Process Progs Propertyfile Rational Reference Ref_list Scanfile Scanstri Set Shell Smtp Sockbase Socket SQL base Stdio Strifile String Stritext Subrange Tar Text Time TLS/SSL Triple DES Unicode Utf16 Utf8 Vectorfont 3D Vector Wildcard Window Wrinum X.509 Xmldom Xml_ent Zip
Libraries
Bigfile Source Code
 previous   up   next 

Function Summary
bigInteger
bigLength (ref null_file: aFile)
Obtain the length of a file.
void
seek (ref null_file: aFile, ref bigInteger: position)
Set the current file position.
bigInteger
bigTell (ref null_file: aFile)
Obtain the current file position.
bigInteger
bigLength (ref external_file: aFile)
Determine the size of a file and return it as bigInteger.
void
seek (ref external_file: aFile, in bigInteger: position)
Set the current file position.
bigInteger
bigTell (ref external_file: aFile)
Obtain the current file position.

Function Detail

bigLength

const func bigInteger: bigLength (ref null_file: aFile)

Obtain the length of a file. A null_file is not seekable, therefore FILE_ERROR is raised. Derived types of null_file need to override this function.

Returns:
nothing, because FILE_ERROR is always raised.
Raises:
FILE_ERROR - Is always raised, because a null_file is not seekable.

seek

const proc: seek (ref null_file: aFile, ref bigInteger: position)

Set the current file position. A null_file is not seekable, therefore FILE_ERROR is raised. When a derived type is seekable it needs to override this function.

Raises:
FILE_ERROR - Is always raised, because a null_file is not seekable.

bigTell

const func bigInteger: bigTell (ref null_file: aFile)

Obtain the current file position. A null_file is not seekable, therefore FILE_ERROR is raised. When a derived type is seekable it needs to override this function.

Returns:
nothing, because FILE_ERROR is always raised.
Raises:
FILE_ERROR - Is always raised, because a null_file is not seekable.

bigLength

const func bigInteger: bigLength (ref external_file: aFile)

Determine the size of a file and return it as bigInteger. The file length is measured in bytes.

Returns:
the size of the given file.
Raises:
FILE_ERROR - A system function returns an error or the file length reported by the system is negative.
MEMORY_ERROR - Not enough memory to represent the result.

seek

const proc: seek (ref external_file: aFile, in bigInteger: position)

Set the current file position. The file position is measured in bytes from the start of the file. The first byte in the file has the position 1.

Raises:
RANGE_ERROR - The file position is negative or zero or the file position is not representable in the system file position type.
FILE_ERROR - A system function returns an error.

bigTell

const func bigInteger: bigTell (ref external_file: aFile)

Obtain the current file position. The file position is measured in bytes from the start of the file. The first byte in the file has the position 1.

Returns:
the current file position.
Raises:
FILE_ERROR - A system function returns an error or the file position reported by the system is negative.
MEMORY_ERROR - Not enough memory to represent the result.


 previous   up   next