TBufferedFile 0.20 Documentation

****************
***Properties***
****************

TBufferedFile.Size --> not implemented yet
------------------
Specifies the length, in bytes, of the file.

property Size: Longint;

Description:

Read Size to determine the number of bytes in the file. 

TBufferedFile.Position
----------------------
Indicates the current offset into the stream for reading and writing.

property Position: Longint;

Description:

Use Position to obtain the current position of the file. This is the number of bytes 
from the beginning of the streamed data.

TBufferedFile.Filename
----------------------
Indicates the current opened file.

property Filename: String;

Description:

Use Filename the get the current opened file. This property is readonly.


****************
****Methods*****
****************

TBufferedFile.Read
------------------
Reads up to Count bytes of data from the file into Buffer.

function Read(var Buffer; Count: Longint): Longint; override;

Description:

Read transfers up to Count bytes from the file, starting at the current position, 
and then advances the current position in the file by the number of bytes actually transferred. Read returns the number of bytes actually transferred, which may be 
less than Count if the end of file marker is encountered.

TBufferedFile.Write
-------------------
Writes Count bytes from the Buffer to the current position in the resource.

function Write(const Buffer; Count: Longint): Longint; override;

Description:

Use Write to write Count bytes to the file, starting at the current position. 
After writing to the file, Write advances the current position by the number bytes 
written, and returns the number of bytes written.

TBufferedFile.Seek 
------------------
Resets the current position of the handle stream.

function Seek(Offset: Longint; Origin: Word): Longint; override;

Description:

Use Seek to move the current position within the file by the indicated offset. 
Seek allows an application to read from or write to a particular location within 
the file.

The Origin parameter indicates how to interpret the Offset parameter. Origin should 
be one of the following values: --> not implemented yet

Value	          Meaning

soFromBeginning	  Offset is from the beginning of the resource. Seek moves to the 
                   position Offset. Offset must be >= 0.
soFromCurrent	  Offset is from the current position in the resource. Seek moves 
                   to Position + Offset.
soFromEnd	  Offset is from the end of the resource. Offset must be <= 0 to 
                   indicate a number of bytes before the end of the file.

Seek returns the new value of the Position property, the new current position in the resource.

