DAGetPageImageList

Image handling, Direct access functionality, Page properties

Description

This function finds all the images on the selected page and returns an ImageListID that can be used with the DAGetImageListCount, DAGetImageListItemIntProperty, DAGetImageListItemDblProperty, DAGetImageListItemDataToString, DAGetImageListItemDataToVariant and DASaveImageListItemDataToFile 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.DAGetPageImageList(FileHandle, PageRef: Integer): Integer;

ActiveX

Function PDFlib::DAGetPageImageList(FileHandle As Long, PageRef As Long) As Long

DLL

int DLDAGetPageImageList(int InstanceID, int FileHandle, int PageRef);

Parameters

FileHandleA handle returned by the DAOpenFile, DAOpenFileReadOnly or DAOpenFromStream functions
PageRefA page reference returned by the DAFindPage function

Return values

0The FileHandle or PageRef parameters were invalid An ImageListID value that can be used with the other direct access image list functions
Non-zero