Sign in Join
FPDoc Onlineexperiment

TBufStream.Read procedure

Member of TBufStreamIn unit Objects

Read data from the file to a buffer in memory.

Declaration

pascal
procedure Read(var Buf; Count: LongInt); virtual

Description

If the Stream is open and the stream status is stOK then Read will read Count bytes from the stream and place them in Buf.

Read will first try to read the data from the stream's internal buffer. If insufficient data is available, the buffer will be filled before continuing to read. This process is repeated until all needed data has been read.

For an example, see Read.

Errors

In case of an error, Status is set to StReadError, and ErrorInfo gets the OS specific error, or 0 when an attempt was made to read beyond the end of the stream.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.