Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

DynaPDF.GetInMetadata

Queries input PDF metadata.

Component Version macOS Windows Linux Server iOS SDK
DynaPDF 5.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "DynaPDF.GetInMetadata"; PDF; ObjType { ; PageNum } )   More

Parameters

Parameter Description Example Flags
PDF The PDF reference returned from DynaPDF.New. $pdf
ObjType The object type. Can be Catalog, Font, Image, Page or Template. "Catalog"
PageNum Page number or -1 to access the global XMP stream. -1 Optional

Result

Returns text or error.

Description

Queries input PDF metadata.
The function can be used to access the optional metadata streams of pages or the global metadata stream of the current open import file. Metadata streams are in XMP format that is a superset of XML. The PDF file must be opened with DynaPDF.OpenPDFFromFile or DynaPDF.OpenPDFFromContainer beforehand.
Although the global XMP stream does usually exist in todays PDF files, metadata streams are optional and maybe not present. The function empty text, if no metadata stream is present.

See also GetInMetadata function in DynaPDF manual.

Examples

Open PDF and get XMP metadata:

Set Variable [$pdf; Value:MBS("DynaPDF.New")]
Set Variable [$r; Value:MBS("DynaPDF.OpenPDFFromContainer"; $pdf; DynaPDF XMP::InputPDF)]
Set Field [DynaPDF XMP::XMP; MBS( "DynaPDF.GetInMetadata"; $pdf; "Catalog"; -1 )]
Set Variable [$r; Value:MBS("DynaPDF.Release"; $pdf)]

See also

Blog Entries

This function checks for a license.

Created 29th July 2015, last changed 31st July 2015


DynaPDF.GetInIsXFAForm - DynaPDF.GetInPDFVersionEx