GetPageImageList

Image handling, Page properties

Description

This function finds all the images on the selected page and returns an ImageListID that can be used with the GetImageListCount, GetImageListItemIntProperty, GetImageListItemDblProperty, GetImageListItemDataToString, GetImageListItemDataToVariant and SaveImageListItemDataToFile functions.

It will include Inline images but the ImageID will be 0 for any inline image which means that any inline images cannot used with ReplaceImage or ClearImage functions.

Syntax

Delphi

function TPDFlib.GetPageImageList(Options: Integer): Integer;

ActiveX

Function PDFlib::GetPageImageList(Options As Long) As Long

DLL

int DLGetPageImageList(int InstanceID, int Options);

Parameters

OptionsReserved for future use, should be set to 0.

Return values

0The images on the page could not be enumerated.
Non-zeroAn ImageListID value