ImageCapture.GetParameter
-------------------------

Queries a parameter of current scanner functional unit.

| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|---|
| [ImageCapture](component_ImageCapture.md) | [6.4](newinversion64.md) | ✅ Yes | ❌ No | ❌ No | ❌ No | ❌ No |

MBS( "ImageCapture.GetParameter"; Selector ) 

**MBS**( **"ImageCapture.GetParameter";** /\* Queries a parameter of current scanner functional unit. \*/  
**$Selector**) /\* Which value to query.e.g. "name" \*/ 

### Parameters

| Parameter | Description | Example |
|---|---|---|
| Selector | Which value to query. | "name" |

### Result

Returns value or error.

### Description

Queries a parameter of current scanner functional unit.  
  
| Selector | Description | Example |
|---|---|---|
| acceptsThresholdForBlackAndWhiteScanning | Indicates if this functional unit accepts threshold value to be used when performing a scan in black &amp; white. | 1 |
| availableFunctionalUnitTypes | The available functional unit types. This can include Flatbed, DocumentFeeder, NegativeTransparency or PositiveTransparency. | "Flatbed¶DocumentFeeder" |
| bitDepth | The bit depth to use when performing the final scan. This will always be one of the supported bit depths. | 8 |
| canPerformOverviewScan | Indicates if this functional unit can perfrom an overview scan. Not all functional units can perform an overview scan. For example, a document feeder or a sheet feeder unit cannot perform an overview scan. | 1 |
| defaultThresholdForBlackAndWhiteScanning | Default threshold value used when performing a scan in black &amp; white. This value is from 0 to 255. | 127 |
| documentHeight | The document height. |  |
| documentLoaded | Indicates whether the feeder has documents to scan. This value will change when the document is loaded or removed from the feeder, if the scanner module has the capability to detect this state. | 1 |
| documentName | The document name. | "Scan" |
| documentSize | Document size of the current document type expressed in current measurement unit. |  |
| documentType | Current document type. | "A4" |
| documentUTI | The document UTI. Can be JPEG, JPEG2000, TIFF or PNG. | "JPEG" |
| documentWidth | The document width. |  |
| downloadsDirectory | The downloads directory. | "/Users/cs/Desktop" |
| duplexScanningEnabled | Indicates whether duplex scanning is enabled. | 1 |
| evenPageOrientation | Desired orientation of the even pages of the scanned document. |  |
| maxMemoryBandSize | The total maximum band size requested when performing a memory based transfer. |  |
| measurementUnit | Current measurement unit. Can be Inches, Centimeters, Picas, Points, Twips or Pixels. | "Inches" |
| nativeXResolution | Optical resolution along the X axis. |  |
| nativeYResolution | Optical resolution along the Y axis. |  |
| oddPageOrientation | Desired orientation of the odd pages of the scanned document. |  |
| overviewImage | Overview scan image. This property will be empty for functional units that do not support overview scans. |  |
| overviewResolution | Overview image resolution. Value assigned to this will be contrained by resolutions allowed by the device. |  |
| overviewScanInProgress | Indicates if an overview scan is in progress. | 1 |
| physicalHeight | Physical height of the scan area in current measurement unit. |  |
| physicalSize | Physical size of the scan area in current measurement unit. |  |
| physicalWidth | Physical width of the scan area in current measurement unit. |  |
| pixelDataType | The pixel data type. Can be BW, Gray, RGB, Palette, CMY, CMYK, YUV, YUVK or CIEXYZ. | "RGB" |
| preferredResolutions | Preferred scan resolutions in DPI. | 300 |
| preferredScaleFactors | Preferred scale factors in percentage. | 100 |
| resolution | Current scan resolution. This will always be one of the supported resolution values. | 300 |
| reverseFeederPageOrder | Indicates whether the document feeder reads pages from back to front. |  |
| scaleFactor | Current scale factor. This will always be one of the supported scale factor values. | 100 |
| scanArea | The area to scan. This property along with scanAreaOrientation describes the area to be scanned. |  |
| scanAreaOrientation | Desired orientation of the scan area. This property along with scanArea describes the area to be scanned. 1 for Normal, 2 Flipped horizontally, 3 Rotated 180°, 4 Flipped vertically, 5. Rotated 90° CCW and flipped vertically, 6 Rotated 90° CCW, 7 Rotated 90° CW and flipped vertically, 8 Rotated 90° CW. | 1 |
| scanInProgress | Indicates if a scan is in progress. | 1 |
| scanProgressPercentDone | Indicates percentage of scan completed. | 0.5 |
| state | Indicates the current state of the functional unit. 1 for Ready. Add 2 for Scan In Progress. Add 4 for Overview Scan in Progress | 5 |
| supportedBitDepths | Supported bit depths. Can include 1, 8 or 16. | "1¶8" |
| supportedDocumentTypes | Supported document types. |  |
| supportedMeasurementUnits | Supported measurement units. Can be Inches, Centimeters, Picas, Points, Twips or Pixels. | "Inches" |
| supportedResolutions | Supported scan resolutions in DPI. | "100¶200¶300" |
| supportedScaleFactors | Supported scale factors in percentage. | "100" |
| supportsDuplexScanning | Indicates whether duplex scanning is supported. | 1 |
| thresholdForBlackAndWhiteScanning | Threshold value to be used when performing a scan in black &amp; white. This value should be from 0 to 255. | 127 |
| transferMode | The transfer mode for scanned document. Can be File or Memory, but Plugin only supports File. | "File" |
| usesThresholdForBlackAndWhiteScanning | Indicates if this functional unit uses threshold value to be used when performing a scan in black &amp; white. | 1 |

### Examples

Query available functional unit types:

 MBS ("ImageCapture.GetParameter"; "availableFunctionalUnitTypes")  
<small>  
Example result:   
Flatbed  
DocumentFeeder</small>Query supported resolutions:

 Set Variable \[$supportedResolutions ; Value:MBS ("ImageCapture.GetParameter"; "supportedResolutions")\]  
<small>  
Example result:   
100  
150  
200  
300  
400  
600</small>Query supported document types:

 MBS ("ImageCapture.GetParameter"; "supportedDocumentTypes")  
<small>  
Example result:   
A4  
B5  
USLetter  
USLegal  
A5  
USExecutive</small>Query supported bit depths:

 MBS ("ImageCapture.GetParameter"; "supportedBitDepths")  
<small>  
Example result:   
1  
8</small>Set scan area to physical size:

 Set Variable \[$physicalWidth ; Value:MBS ("ImageCapture.GetParameter"; "physicalWidth")\]  
Set Variable \[$physicalHeight ; Value:MBS ("ImageCapture.GetParameter"; "physicalHeight")\]  
Set Variable \[$r ; Value:MBS ("[ImageCapture.SetParameter](ImageCaptureSetParameter.md)"; "scanArea"; 0; 0; $physicalWidth ; $physicalHeight )\]  
Query folder path for image files:

 MBS ( "ImageCapture.GetParameter"; "downloadsDirectory" )  
<small>  
Example result: "/Users/cs/Pictures"</small>### See also

- [ImageCapture.GetFeatures](ImageCaptureGetFeatures.md)
- [ImageCapture.GetParameters](ImageCaptureGetParameters.md)
- [ImageCapture.RequestScan](ImageCaptureRequestScan.md)
- [ImageCapture.RequestSelectFunctionalUnit](ImageCaptureRequestSelectFunctionalUnit.md)
- [ImageCapture.SetParameter](ImageCaptureSetParameter.md)

### Release notes

- **Version 10.0**
    - Changed [ImageCapture.GetParameter](https://www.mbsplugins.eu/ImageCaptureGetParameter.shtml) and [ImageCapture.SetParameter](https://www.mbsplugins.eu/ImageCaptureSetParameter.shtml) to return an error if you try to set parameter of a functional unit, but none is selected.
- **Version 8.3**
    - Added [ImageCapture.GetFeatures](http://www.mbsplugins.eu/ImageCaptureGetFeatures.shtml) and [ImageCapture.GetParameters](http://www.mbsplugins.eu/ImageCaptureGetParameters.shtml) to return all as JSON.

### Example Databases

- [Mac only/ImageCapture/ImageCapture](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Mac%20only/ImageCapture/ImageCapture.shtml#4ScriptAnchor_)

### Blog Entries

- [MBS FileMaker Plugin, version 9.6pr3](https://www.mbsplugins.de/archive/2019-12-17/MBS_FileMaker_Plugin_version_9/monkeybreadsoftware_blog_filemaker)
- [ImageCapture functions for Mac OS X](https://www.mbsplugins.de/archive/2016-09-12/ImageCapture_functions_for_Mac/monkeybreadsoftware_blog_filemaker)

### FileMaker Magazin

- [Ausgabe 6/2022, Seite 13](https://filemaker-magazin.de/neuigkeit/4206-Appetithappen-FMM_202206)

This function checks for a license.

Created 11st September 2016 , last changed 9th November 2021

  
[ImageCapture.GetFeatures](ImageCaptureGetFeatures.md) - [ImageCapture.GetParameters](ImageCaptureGetParameters.md)

[HTML Version](ImageCaptureGetParameter.shtml)