Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

ImageCapture.RequestOverviewScan

Starts an overview scan on selectedFunctionalUnit.

Component Version macOS Windows Linux Server iOS SDK
ImageCapture 6.4 ✅ Yes ❌ No ❌ No ❌ No ❌ No
MBS( "ImageCapture.RequestOverviewScan" { ; Wait } )   More

Parameters

Parameter Description Example Flags
Wait Pass 1 to wait till complete.
Or pass 0 to return immediately.
Default is 1 to wait.
0 Optional

Result

Returns OK or error.

Description

Starts an overview scan on selectedFunctionalUnit.
If a progress dialog from our plugin is visible, the plugin will keep it updated with progress.

MBS Plugin 8.5 and newer observes progress and returns timeout error if scanner didn't do anything for 60 seconds.

Release notes

Blog Entries

Created 11st September 2016, last changed 19th November 2018


ImageCapture.RequestEnableTethering - ImageCapture.RequestScan