Twain.Acquire

MBS( "Twain.Acquire"; /* Acquires a picture. */$Modal; /* Optional; Whether to run the process modal. Default is 0 for running non modal.
Ignored in most cases.e.g. 0 */
$ShowUI; /* Optional; Whether to show the dialog. Pass 1 to show dialog or 0 to not show it. Default is 1.e.g. 1 */
$BringWindowToFront) /* Optional; For Windows only a flag.
Pass 1 to have the plugin watch for new windows and bring them to front and avoid them showing behind FileMaker’s windows.
Default 0.e.g. 1 */
Less

Parameters

Parameter

Description

Example value

Modal

OptionalWhether to run the process modal. Default is 0 for running non modal.
Ignored in most cases.

0

ShowUI

OptionalWhether to show the dialog. Pass 1 to show dialog or 0 to not show it. Default is 1.

1

BringWindowToFront

OptionalFor Windows only a flag.
Pass 1 to have the plugin watch for new windows and bring them to front and avoid them showing behind FileMaker’s windows.
Default 0.

1

Result

Returns OK or the Twain error code.

Description

Acquires a picture.
The acquire process will go asynchronously. You can define a script with Twain.SetNotificationScript to be called when transfers are done. If you acquire without UI, you can make script pause to let the acquire work and check with Twain.GetImageCount function whether images have been received.
Even when using no UI, you can pass Modal = 1 to have the plugin transfer the image right after acquire without waiting for an event from twain driver.