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.3   7.4   7.5   8.0   8.1   8.2   8.3   8.4   8.5   8.6    Statistic  

SQL.GetParamAsPDF

Returns parameters's value as PDF value.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
SQL 4.3 Yes Yes Yes Yes Yes
MBS( "SQL.GetParamAsPDF"; Command; Param { ; DontRenderPreview } )   More

Parameters

Parameter Description Example value
Command The command reference number gained with SQL.NewCommand. $Command
Param The parameter name or ID. Pass number for ID, a text with parameter name or the index with # prefix. e.g. "#0" for first parameter. "1"
DontRenderPreview Optional
Pass 1 to not create a JPEG with preview of first page as part of the container.
0

Result

Returns container value or error message.

Description

Returns parameters's value as PDF value.
Field must be a BLOB parameter. The plugin does not verify if the BLOB contains a valid PDF document.
See also SQL.GetParamAsJPEG and SQL.GetParamAsPNG.

For PDF content: If you have a DynaPDF Pro license and DynaPDF functions initialized, this function can add previews for the PDF file on Windows and Linux. For MacOS, we make them with PDFKit.

Examples

Read field value of field "PDFData" into variable:

$firstname = MBS("SQL.GetParamAsPDF"; $command; "PDFData")

Query value of first parameter:

MBS( "SQL.GetParamAsPDF"; $Command; "#0" )

See also

Blog Entries

Created 18th August 2014, last changed 17th August 2018


SQL.GetParamAsNumber   -   SQL.GetParamAsPNG

Feedback: Report problem or ask question.




Links
MBS FileMaker blog