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.2   6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4   7.5    Statistic  

ImageCapture.GetParameter

Queries a parameter of current functional unit.

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

MBS( "ImageCapture.GetParameter"; Selector )

Parameters

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

Result

Returns OK or error.

Description

Queries a parameter of current functional unit.

SelectorDescriptionExample
acceptsThresholdForBlackAndWhiteScanningIndicates if this functional unit accepts threshold value to be used when performing a scan in black & white.1
availableFunctionalUnitTypesThe available functional unit types. This can include Flatbed, DocumentFeeder, NegativeTransparency or PositiveTransparency."Flatbed¶DocumentFeeder"
bitDepthThe bit depth to use when performing the final scan. This will always be one of the supported bit depths.8
canPerformOverviewScanIndicates 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
defaultThresholdForBlackAndWhiteScanningDefault threshold value used when performing a scan in black & white. This value is from 0 to 255.127
documentHeightThe document height.
documentLoadedIndicates 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
documentNameThe document name."Scan"
documentSizeDocument size of the current document type expressed in current measurement unit.
documentTypeCurrent document type."A4"
documentUTIThe document UTI. Can be JPEG, JPEG2000, TIFF or PNG."JPEG"
documentWidthThe document width.
downloadsDirectoryThe downloads directory."/Users/cs/Desktop"
duplexScanningEnabledIndicates whether duplex scanning is enabled.1
evenPageOrientationDesired orientation of the even pages of the scanned document.
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"
nativeXResolutionOptical resolution along the X axis.
nativeYResolutionOptical resolution along the Y axis.
oddPageOrientationDesired orientation of the odd pages of the scanned document.
overviewImageOverview scan image. This property will be empty for functional units that do not support overview scans.
overviewResolutionOverview image resolution. Value assigned to this will be contrained by resolutions allowed by the device.
overviewScanInProgressIndicates if an overview scan is in progress.1
physicalHeightPhysical height of the scan area in current measurement unit.
physicalSizePhysical size of the scan area in current measurement unit.
physicalWidthPhysical width of the scan area in current measurement unit.
pixelDataTypeThe pixel data type. Can be BW, Gray, RGB, Palette, CMY, CMYK, YUV, YUVK or CIEXYZ."RGB"
preferredResolutionsPreferred scan resolutions in DPI.300
preferredScaleFactorsPreferred scale factors in percentage.100
resolutionCurrent scan resolution. This will always be one of the supported resolution values.300
reverseFeederPageOrderIndicates whether the document feeder reads pages from back to front.
scaleFactorCurrent scale factor. This will always be one of the supported scale factor values.100
scanAreaThe area to scan. This property along with scanAreaOrientation describes the area to be scanned.
scanAreaOrientationDesired 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
scanInProgressIndicates if a scan is in progress.1
scanProgressPercentDoneIndicates percentage of scan completed.0.5
stateIndicates the current state of the functional unit. 1 for Ready. Add 2 for Scan In Progress. Add 4 for Overview Scan in Progress5
supportedBitDepthsSupported bit depths. Can include 1, 8 or 16."1¶8"
supportedDocumentTypesSupported document types.
supportedMeasurementUnitsSupported measurement units. Can be Inches, Centimeters, Picas, Points, Twips or Pixels."Inches"
supportedResolutionsSupported scan resolutions in DPI."100¶200¶300"
supportedScaleFactorsSupported scale factors in percentage."100"
supportsDuplexScanningIndicates whether duplex scanning is supported.1
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

Examples

Query available functional unit types:

MBS("ImageCapture.GetParameter"; "availableFunctionalUnitTypes")

Query supported resolutions:

Set Variable [$supportedResolutions; Value:MBS("ImageCapture.GetParameter"; "supportedResolutions")]

Query supported document types:

MBS("ImageCapture.GetParameter"; "supportedDocumentTypes")

Query supported bit depths:

MBS("ImageCapture.GetParameter"; "supportedBitDepths")

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)]

See also

Example Databases


ImageCapture.GetFeatureValue   -   ImageCapture.ImagePaths

Feedback: Report problem or ask question.




Links
MBS Xojo tutorial videos