GetPagePieceInfo

Page properties

Description

Reads one private-data value from a page PieceInfo application dictionary

Syntax

Delphi

Function GetPagePieceInfo(PageNumber: Integer; Const AppName, Key: WideString): WideString;

Parameters

PageNumberOne-based page number
AppNameApplication name under the page /PieceInfo dictionary
KeyEntry name inside the application dictionary

Return values

TextDecoded PDF string value or the text of a PDF name value
Empty stringNo selected document, invalid page, empty AppName or Key, missing entry, unsupported value type or a stored empty string

Remarks

The lookup does not create dictionaries and only returns values stored as PDF strings or PDF names

An empty result is therefore not sufficient to distinguish a missing entry from a stored empty string

Example

Revision:= PDF.GetPagePieceInfo(1, "Editor", "Rev");

See also

SetPagePieceInfo, ClearPagePieceInfo, GetNamedPage