| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
SQL.GetParamAsPDF
Returns parameters's value as PDF value.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| SQL | 4.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "SQL.GetParamAsPDF"; Command; Param { ; DontRenderPreview } ) More
Parameters
| Parameter | Description | Example | Flags |
|---|---|---|---|
| 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 | Pass 1 to not create a JPEG with preview of first page as part of the container. | 0 | Optional |
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
- SQL.GetParamAsJPEG
- SQL.GetParamAsPNG
- SQL.GetParamAsText
- SQL.GetParamAsTime
- SQL.GetParamIsNull
- SQL.GetParamsAsJSON
- SQL.GetParamValue
- SQL.NewCommand
- SQL.SetParamAsDate
- SQL.SetParamAsText
Blog Entries
This function is free to use.
Created 18th August 2014, last changed 17th August 2018
