Sign in Join
FPDoc Onlineexperiment

TCustomIcon.GetDescription procedure

Member of TCustomIconpublicIn unit Graphics

Gets metadata which describes the icon image at the specified position in the image list.

Declaration

pascal
procedure GetDescription(Aindex: Integer; out AFormat: TPixelFormat; 
 out AHeight: Word; out AWidth: Word)

Description

GetDescription is used to get image metadata which describes the icon image at the position specified in AIndex. AFormat, AHeight, and AWidth are output parameters where the corresponding values from the TIconImage instance are stored.

GetDescription accesses the image list in the internal TSharedIcon instance used in the class.

See also

An experiment, built from Lazarus main 2dfa93c66e of 10-22-2026. Not the official Lazarus documentation.