Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.2   6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4   7.5    Statistic  

DynaPDF.GetMetadata

Queries metadata from PDF.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
DynaPDF 5.2 Yes Yes Yes Yes Yes

MBS( "DynaPDF.GetMetadata"; PDF; ObjType { ; Handle } )

Parameters

Parameter Description Example value
PDF The PDF reference returned from DynaPDF.New. $pdf
ObjType The object type. Can be Catalog, Font, Image, Page or Template. "Catalog"
Handle Optional
Object handle or -1 for the catalog object.
-1

Result

Returns text or error.

Description

Queries metadata from PDF.
Reads the optional metadata streams of pages, fonts, images, pages, templates, as well as the global metadata stream that is associated with the Catalog object. Metadata streams are in XMP format that is a superset of XML.
The global metadata stream will be created when this function is called. The returned stream is a preview of the XMP stream that will be stored in the file when DynaPDF.CloseFile or DynaPDF.CloseFileEx is called. Note that the creation and modification date will be updated when the file is closed (except if the stream will be modified or replaced with DynaPDF.SetMetadata).
The original global XMP stream of external PDF files can be accessed with DynaPDF.GetInMetadata.
Metadata streams are optional and maybe not present. The function returns true if no error occurs, also if no metadata stream is present. The caller must also check whether the text returned has a length greater than zero to determine whether stream data was returned.

See also GetMetadata function in DynaPDF manual.

See also


DynaPDF.GetMetaConvFlags   -   DynaPDF.GetOpacity

Feedback: Report problem or ask question.




Links
MBS FileMaker tutorial videos