Sign in Join
FPDoc Onlineexperiment

TAbstractResourceReader.CheckMagic function

Member of TAbstractResourceReaderprotectedIn unit resource

Checks whether a stream is in a format the reader recognizes

Declaration

pascal
function CheckMagic(aStream: TStream): Boolean; virtual; abstract

Arguments

aStream

The stream to check

Function result

true if the format of the stream is recognized

Description

A TResources object invokes this method when it is searching for a reader able to read a stream, passing that stream as the aStream parameter.

aStream position is already correctly set: the reader must start to read from there.

This method should read the minimum amount of information needed to recognize the contents of a stream as a valid format: it usually means reading a magic number or a file header.

See also

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