Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.0   6.1   6.2   6.3   6.4   6.5   7.0   7.1   7.2   7.3    Statistic  


Sets a parameter for current functional device.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
ImageCapture 6.4 Yes No No No No

MBS( "ImageCapture.SetParameter"; Selector; Value )


Parameter Description Example value
Selector The value to set. "documentName"
Value The value to set.


Returns OK or error.


Sets a parameter for current functional device.

bitDepthThe bit depth to use when performing the final scan. This will always be one of the supported bit depths.8
documentNameThe document name.„Scan"
documentTypeCurrent document type.„A4"
documentUTIThe document UTI. Can be set using JPEG, JPEG2000, PDF, TIFF or PNG.„JPEG“
downloadsDirectoryThe downloads directory. If you pass „temp“, we use the user’s temp folder.„/Users/cs/Desktop“
maxMemoryBandSizeThe total maximum band size requested when performing a memory based transfer.
measurementUnitCurrent measurement unit. Can be Inches, Centimeters, Picas, Points, Twips or Pixels.„Inches"
overviewResolutionOverview image resolution. Value assigned to this will be contrained by resolutions allowed by the device.
resolutionCurrent scan resolution. This will always be one of the supported resolution values.300
thresholdForBlackAndWhiteScanningThreshold value to be used when performing a scan in black & white. This value should be from 0 to 255.127
transferModeThe transfer mode for scanned document. Can be File or Memory, but Plugin only supports File.„File"
usesThresholdForBlackAndWhiteScanningIndicates if this functional unit uses threshold value to be used when performing a scan in black & white.1

For scan area, please pass x, y, width and height as separate parameters.


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"; "scanArea"; 0; 0; $physicalWidth; $physicalHeight)]

Set to US Letter format:

MBS("ImageCapture.SetParameter"; "documentType"; "USLetter")

Set document name:

MBS("ImageCapture.SetParameter"; "documentName"; "Scan")

Set resolution to 300 dpi:

MBS("ImageCapture.SetParameter"; "resolution"; 300)

Set to scan 8 bit RGB picture:

Set Variable [$r; Value:MBS("ImageCapture.SetParameter"; "bitDepth"; 8)]
Set Variable [$r; Value:MBS("ImageCapture.SetParameter"; "pixelDataType"; "RGB")]

Set JPEG image type:

Set Variable [$r; Value:MBS("ImageCapture.SetParameter"; "documentUTI"; "jpeg")]

Use temporary folder for temp files:

Set Variable [$r; Value:MBS("ImageCapture.SetParameter"; "downloadsDirectory"; "temp")]

Set scan area:

MBS( "ImageCapture.SetParameter"; "scanArea"; $x; $y; $w; $h )

See also

Example Databases

ImageCapture.SetFeatureValue   -   ImageCapture.cancelScan

Feedback: Report problem or ask question.

MBS FileMaker blog