ClearImage

Image handling

Description

Clears the specified image.

To prevent the corruption of existing links to the image it will not be deleted from the document. The image will be converted into a 24-bit RGB format consisting of a single transparent pixel.

Syntax

Delphi

function TPDFlib.ClearImage(ImageID: Integer): Integer;

ActiveX

Function PDFlib::ClearImage(ImageID As Long) As Long

DLL

int DLClearImage(int InstanceID, int ImageID);

Parameters

ImageIDThe ImageID of the image to be cleared

Return values

0The specified ImageID was not valid
1The image was cleared