TSharedRasterImage.ReleaseHandle function

Declaration

function ReleaseHandle: TLCLHandle; virtual

Function result

Value for the internal handle on entry to the method.

Description

ReleaseHandle is a TLCLHandle function used to release a reference for the handle in the class instance. The return value contains the value for the handle on entry.

ReleaseHandle sets the handle value to 0 to indicate that it is no longer used or invalid. It does not call DeleteObject to remove the handle in widgetset classes.

ReleaseHandle is called from classes which support a specific image format, like TCustomBitmap and TIcon, when their ReleaseHandle method is called to free the handle for its shared image.

Modified in LCL version 4.0 to use the TLCLHandle type instead of the deprecated THandle type in the return value.

See also

• LCLType.TLCLHandle
• WSReferences.TLCLHandle