Sign in Join
FPDoc Onlineexperiment

TGraphic.IsStreamFormatSupported function

Member of TGraphicpublicIn unit Graphics

Indicates whether the specified stream type is supported in the class.

Declaration

pascal
class function IsStreamFormatSupported(Stream: TStream): Boolean
 ; virtual

Arguments

Stream

Stream with content examined in the method.

Function result

True when the stream contains supported graphic data; otherwise, False.

Description

IsStreamFormatSupported is a Boolean class function used to determine if the specified stream contains graphic data in a format supported in the class.

IsStreamFormatSupported is declared as a virtual method, and is overridden in descendants to check whether the values stored in the stream instance can be used in the reader and/or writer classes for the graphic format.

In general, IsStreamFormatSupported indicates whether the LoadFromStream method can be successfully used to load graphic data into the class instance using the specified stream.

See also

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