Sign in Join
FPDoc Onlineexperiment

TMemoryStream.LoadFromStream procedure

Member of TMemoryStreampublicIn unit Classes

Loads the contents of a stream into memory.

Declaration

pascal
procedure LoadFromStream(Stream: TStream)

Description

LoadFromStream loads the contents of Stream into the memorybuffer of the stream. Any previous contents of the memory stream are overwritten. Memory is allocated as needed.

The LoadFromStream uses the Size property of Stream to determine how much memory must be allocated. Some streams do not allow the stream size to be determined, so care must be taken when using this method.

This method will work much faster than the use of the CopyFrom method:

Seek(0,soFromBeginning);
  CopyFrom(Stream,Stream.Size);

because the CopyFrom method copies the contents in blocks, while LoadFromStream reads the contents of the stream as one big block.

Errors

If an error occurs when reading from the stream, an EStreamError may occur.

See also

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