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


Acquires a picture.

Component Version macOS Windows Linux Server iOS SDK
Twain 3.1 ✅ Yes ✅ Yes ❌ No ❌ No ❌ No
MBS( "Twain.Acquire" { ; Modal; ShowUI; BringWindowToFront } )   More


Parameter Description Example Flags
Modal Whether to run the process modal. Default is 0 for running non modal.
Ignored in most cases.
0 Optional
ShowUI Whether to show the dialog. Pass 1 to show dialog or 0 to not show it. Default is 1. 1 Optional
BringWindowToFront 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.
1 Optional


Returns OK or the Twain error code.


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.


Acquire with UI, window to front and modal:

MBS( "Twain.Acquire"; 1; 1; 1)

See also

Release notes

  • Version 11.4
    • Fixed problem in Twain.Acquire to fail better if we can't open the data source.
  • Version 7.2

Example Databases

Blog Entries

This function checks for a license.

Created 18th August 2014, last changed 9th May 2017

Trace.WriteLine - Twain.ClearCancelScript