Monkeybread Software - MBS FileMaker Plugin: DynaPDF.GetEmbeddedFile

Topics All Mac OS X (Only) Windows (Only) Linux (Only, Not) iOS (Only, Not)
Components Crossplatform Mac & Win Server Client Old Guides Examples
New in version: 7.1 7.2 7.3 7.4 7.5 8.0 8.1 8.2 8.3 8.4 Statistic

DynaPDF.GetEmbeddedFile

Retrieves the details of an embedded file.

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

MBS( "DynaPDF.GetEmbeddedFile"; PDF; Index; Selector { ; Encoding } )

Parameters

Parameter Description Example value

PDF The PDF reference returned from DynaPDF.New. $pdf

Index The index of the embedded file. From 0 to DynaPDF.GetEmbeddedFileCount-1. 0

Selector Which value to query.
Can be DataSize, FileSize, Compressed, Name, FileName, isURL, UnicodeName, Description, MimeType, CreationDate, ModificationDate or CheckSum.
With value "Content" you can query the content of the embedded file as text. Optional Text encoding parameter is used in this case. "Name"

Encoding Optional
The text encoding for the content.
Possible encoding names: ANSI, Arabic-Mac, Arabic-Win, Baltic-Win, CentralEurope-Mac, ChineseSimp-Mac, ChineseSimp-Win, ChineseTrad-Mac, ChineseTrad-Win, Cyrillic-Mac, Cyrillic-Win, EasternEurope-Win, Greek-Mac, Greek-Win, Hebrew-Mac, Hebrew-Win, ISO-8859-1, ISO-8859-2, ISO-8859-3, ISO-8859-4, ISO-8859-5, ISO-8859-6, ISO-8859-7, ISO-8859-8, ISO-8859-9, ISO-8859-15, Korean-Johab, Korean-Mac, Korean-Win, Latin1, Mac, Native, ShiftJIS-Mac, ShiftJIS-Win, Turkish-Mac, Turkish-Win, UTF-8, DOS or Windows. Pass native to use the native encoding of the current platform.

Parameter	Description	Example value
PDF	The PDF reference returned from DynaPDF.New.	$pdf
Index	The index of the embedded file. From 0 to DynaPDF.GetEmbeddedFileCount-1.	0
Selector	Which value to query. Can be DataSize, FileSize, Compressed, Name, FileName, isURL, UnicodeName, Description, MimeType, CreationDate, ModificationDate or CheckSum. With value "Content" you can query the content of the embedded file as text. Optional Text encoding parameter is used in this case.	"Name"
Encoding	Optional The text encoding for the content. Possible encoding names: ANSI, Arabic-Mac, Arabic-Win, Baltic-Win, CentralEurope-Mac, ChineseSimp-Mac, ChineseSimp-Win, ChineseTrad-Mac, ChineseTrad-Win, Cyrillic-Mac, Cyrillic-Win, EasternEurope-Win, Greek-Mac, Greek-Win, Hebrew-Mac, Hebrew-Win, ISO-8859-1, ISO-8859-2, ISO-8859-3, ISO-8859-4, ISO-8859-5, ISO-8859-6, ISO-8859-7, ISO-8859-8, ISO-8859-9, ISO-8859-15, Korean-Johab, Korean-Mac, Korean-Win, Latin1, Mac, Native, ShiftJIS-Mac, ShiftJIS-Win, Turkish-Mac, Turkish-Win, UTF-8, DOS or Windows. Pass native to use the native encoding of the current platform.

Result

Returns value or error.

Description

Retrieves the details of an embedded file.

See also GetEmbeddedFile function in DynaPDF manual.

Examples

Query name of first file:

MBS( "DynaPDF.GetEmbeddedFile"; $pdf; 0; "name")

Query content as text in UTF-8:

MBS( "DynaPDF.GetEmbeddedFile"; $pdf; 0; "Content"; "UTF-8" )

Example Databases

Created 11st September 2014, last changed 15th December 2015

DynaPDF.GetDynaPDFVersion - DynaPDF.GetEmbeddedFileAsContainer

Feedback: Report problem or ask question.