API referenceCore SDK

pdfGetInDocInfoEx

Enumerate the import source's document-info entries by index,

CategoryDocument metadata (import)

Purpose — Enumerate the import source's document-info entries by index, mapped back to TDocumentInfo where recognized.

Description — Walks the same fixed 12-slot key table as pdfGetInDocInfo (Author, Creator, Keywords, Producer, Subject, Title, *(no diCompany key)*, GTS_PDFXVersion, *(no diCustom key)*, GTS_PDFXConformance, CreationDate, ModDate) — Index here indexes into this fixed table by position, not into the raw /Info dictionary's actual key set (contrast with pdfGetInDocInfoCount, which counts the raw dictionary). On failure, Ord_ defaults to 8 (diCustom) as a sentinel.

Declarations

C
BOOL32 __stdcall pdfGetInDocInfoEx(PPDF IPDF, uint32_t Index, TDocumentInfo* DInfo, const char* Key, const char* Value, BOOL32* Unicode);
Delphi
function pdfGetInDocInfoEx(const IPDF: PPDF; Index: Cardinal; var DInfo: TDocumentInfo; var Key, Value: PAnsiChar; var Unicode: LongBool): LongBool; stdcall; external 'LumasPdf.dll';

Parameters

ParameterTypeDescription
IPDFPPDFInstance handle with an open import source.
IndexCardinalPosition in the fixed 12-entry key table (not the raw dictionary's key order).
DInfoTDocumentInfo*Receives the ordinal; 8 (diCustom) on failure.
KeyPAnsiChar*Always NULL in this build.
ValuePAnsiChar*Receives the value (empty if this slot has no data in the source file).
UnicodeBOOL32*Always FALSE.

Return valueTRUE if Index is 0..11 and the import source is open; FALSE otherwise (this call does not fail just because a given slot's value is empty — check Value for that).

See alsopdfGetInDocInfo

Structure tree

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
[return: MarshalAs(UnmanagedType.Bool)]
Area
Core SDK
Category

Getters

Exported names

pdfGetInDocInfoEx

String variants

The …A form takes UTF-8, …W takes UTF-16; a bare name aliases the ANSI form.

See working code

Worked examples — complete programs in ten languages.