SQL.GetParamAsPDF
-----------------

Returns parameters's value as PDF value.

| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|---|
| [SQL](component_SQL.md) | [4.3](newinversion43.md) | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |

MBS( "SQL.GetParamAsPDF"; Command; Param { ; DontRenderPreview } ) 

**MBS**( **"SQL.GetParamAsPDF";** /\* Returns parameters's value as PDF value. \*/  
**$Command**; /\* The command reference number gained with [SQL.NewCommand](SQLNewCommand.md). \*/   
**$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.e.g. "1" \*/   
**$DontRenderPreview**) /\* Optional; Pass 1 to not create a JPEG with preview of first page as part of the container.e.g. 0 \*/ 

### Parameters

| Parameter | Description | Example | Flags |
|---|---|---|---|
| Command | The command reference number gained with [SQL.NewCommand](SQLNewCommand.md). | $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](SQLGetParamAsJPEG.md) and [SQL.GetParamAsPNG](SQLGetParamAsPNG.md).  
  
For PDF content: If you have a DynaPDF Pro license and [DynaPDF](component_DynaPDF.md) 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](SQLGetParamAsJPEG.md)
- [SQL.GetParamAsPNG](SQLGetParamAsPNG.md)
- [SQL.GetParamAsText](SQLGetParamAsText.md)
- [SQL.GetParamAsTime](SQLGetParamAsTime.md)
- [SQL.GetParamIsNull](SQLGetParamIsNull.md)
- [SQL.GetParamsAsJSON](SQLGetParamsAsJSON.md)
- [SQL.GetParamValue](SQLGetParamValue.md)
- [SQL.NewCommand](SQLNewCommand.md)
- [SQL.SetParamAsDate](SQLSetParamAsDate.md)
- [SQL.SetParamAsText](SQLSetParamAsText.md)

### Blog Entries

- [MBS FileMaker Plugin, version 5.1pr1](https://www.mbsplugins.de/archive/2015-03-16/MBS_FileMaker_Plugin_version_5/monkeybreadsoftware_blog_filemaker)
- [MBS Filemaker Plugin, version 4.3pr1](https://www.mbsplugins.de/archive/2014-07-02/MBS_Filemaker_Plugin_version_4/monkeybreadsoftware_blog_filemaker)

This function is free to use.

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

  
[SQL.GetParamAsNumber](SQLGetParamAsNumber.md) - [SQL.GetParamAsPNG](SQLGetParamAsPNG.md)

[HTML Version](SQLGetParamAsPDF.shtml)