Platforms to show: All Mac Windows Linux Cross-Platform

Back to TwainMBS class.

TwainMBS.AutoFeed as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 13.0 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
Whether plugin should auto feed (if feeder is enabled).

Value is -1 if you didn't set it before.
This value is stored and next time you call Acquire the plugin will ask the scanner to enable/disable auto feed. If the scanner does not support auto feeding, the scanner will ignore this setting.
(Read and Write property)

TwainMBS.AutomaticBorderDetection as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 13.5 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
Whether plugin should enable automatic border detection.

Value is -1 if you didn't set it before.
This value is stored and next time you call Acquire the plugin will ask the scanner to enable/disable auto border detection. If the scanner does not support this feature, the scanner will ignore this setting.
0 = off, 1 = on, -1 = default/undefined.
(Read and Write property)

TwainMBS.AutomaticBrightness as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 13.5 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
Enables or disables the Source's Auto-brightness function (if any).

The plugin will apply this setting on the next scan.
Value is 0 to disable, 1 to enable or -1 if undefined/default.
(Read and Write property)

TwainMBS.AutomaticRotate as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 13.5 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
Whether to enable automatic rotation when next scan starts.

Value is -1 if you didn't set it before.
This value is stored and next time you call Acquire the plugin will ask the scanner to enable/disable automatic rotation. If the scanner does not support this feature, the scanner will ignore this setting.
(Read and Write property)

TwainMBS.Brightness as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 13.5 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
The brightness setting to use.

The plugin will apply this setting on the next scan.
Source should normalize the values into the range. Make sure that a '0' value is available as the Current Value when the Source starts up. If the Source's ± range is asymmetric about the '0' value, set range maxima to ±1000 and scale homogeneously from the '0' value in each direction. This will yield a positive range whose step size differs from the negative range's step size.
Plugin uses value -10000 for undefined/default.
(Read and Write property)

TwainMBS.ConditionCode as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 14.2 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
The condition code.

If error code in Lasterror is 1, this Condition value is set.
(-1 if unknown)

Possible codes:
TWCC_SUCCESS0Success
TWCC_BUMMER1Failure due to unknown causes
TWCC_LOWMEMORY2Not enough memory to perform operation
TWCC_NODS3No Data Source
TWCC_MAXCONNECTIONS4DS is connected to max possible applications
TWCC_OPERATIONERROR5DS or DSM reported error, application shouldn't
TWCC_BADCAP6Unknown capability
TWCC_BADPROTOCOL9Unrecognized MSG DG DAT combination
TWCC_BADVALUE10Data parameter out of range
TWCC_SEQERROR11DG DAT MSG out of expected sequence
TWCC_BADDEST12Unknown destination Application/Source in DSM_Entry
TWCC_CAPUNSUPPORTED13Capability not supported by source
TWCC_CAPBADOPERATION14Operation not supported by capability
TWCC_CAPSEQERROR15Capability has dependancy on other capability
TWCC_DENIED16File System operation is denied (file is protected)
TWCC_FILEEXISTS17Operation failed because file already exists.
TWCC_FILENOTFOUND18File not found
TWCC_NOTEMPTY19Operation failed because directory is not empty
TWCC_PAPERJAM20The feeder is jammed
TWCC_PAPERDOUBLEFEED21The feeder detected multiple pages
TWCC_FILEWRITEERROR22Error writing the file (meant for things like disk full conditions)
TWCC_CHECKDEVICEONLINE23The device went offline prior to or during this operation
(Read and Write property)

TwainMBS.Contrast as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 13.5 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
The contrast setting to use.

The plugin will apply this setting on the next scan.
Scale the values available internally into a homogeneous range between -1000 and 1000. Make sure that a '0' value is available as the Current value when the Source starts up. If the Source's ± range is asymmetric about the '0' value, set range maxima to ±1000 and scale homogeneously from the '0' value in each direction. This will yield a positive range whose step size differs from the negative range's step size.
(Read and Write property)

TwainMBS.DiscardBlankPages as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 13.5 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
Whether to have the scanner ask to discard blank pages.

Value is -1 if you didn't set it before.
This value is stored and next time you call Acquire the plugin will ask the scanner to enable/disable blank pages discarding. If the scanner does not support this feature, the scanner will ignore this setting.
(Read and Write property)

TwainMBS.Duplex as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 13.3 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
Whether to enable duplex when next scan starts.

This value is stored and next time you call Acquire the plugin will ask the scanner to enable/disable duplex. If the scanner does not support duplex, the scanner will ignore this setting.
Value is -1 if not set, 0 to disable and 1 to enable.
(Read and Write property)

TwainMBS.FeederEnabled as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 13.0 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
Whether to enable feeder when next scan starts.

This value is stored and next time you call Acquire the plugin will ask the scanner to enable/disable feeder. If the scanner does not support the feeder, the scanner will ignore this setting.
Value is -1 if not set, 0 to disable and 1 to enable.
(Read and Write property)

TwainMBS.Gamma as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 13.5 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
Gamma correction value for the image data.

The plugin will apply this setting on the next scan.
Default value 2.2. The setting is -10000 if not set.
(Read and Write property)

TwainMBS.Highlight as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 13.5 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
Specifies which value in an image should be interpreted as the lightest highlight.

The plugin will apply this setting on the next scan.
All values lighter than this value will be clipped to this value. Whether lighter values are smaller or larger can be determined by examining the Current value of PixelFlavor.
If more or less than 8 bits are used to describe the image, the actual data values should be normalized to fit within the 0-255 range. The normalization need not result in a homogeneous distribution if the original distribution was not homogeneous.
Value can be between 0 and 255.

Value can be between 0 and 255.
Plugin uses value -10000 for undefined/default.
(Read and Write property)

TwainMBS.Lasterror as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 12.3 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
The last error code.

(Read and Write property)

TwainMBS.Orientation as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 13.0 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
The orientation for the scanner.

This value is stored and next time you call Acquire the plugin will ask the scanner to enable/disable feeder. If the scanner does not support the feeder, the scanner will ignore this setting.

Value can be:
00 degree
190 degree
2180 degree
3270 degree
0Portrait
3Landscape
(Read and Write property)

TwainMBS.Parent as Variant

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 12.3 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
The parent window.

Can reference a Window or DesktopWindow object.
(Read and Write property)

TwainMBS.PendingTransferCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 13.3 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
How many pages are pending.

So when you transfer you can make a loop and run until PendingTransferCount is zero.
PendingTransferCount may be -1 or 65535 for unknown number of pages.
(Read and Write property)

Some examples using this property:

TwainMBS.PixelType as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 13.5 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
The pixel type requested.

Value can be 0 for BW, 1 for Gray, 2 for RGB, 3 for Palette.
The plugin can request als CMY (4), CMYK (5), YUV (6), YUVK (7) and CIEXYZ (8), but can't currently decode those.

Value is -1 if you didn't set it before.
This value is stored and next time you call Acquire the plugin will ask the scanner to use the given pixel type. If the scanner does not support this feature, the scanner will ignore this setting.
(Read and Write property)

TwainMBS.ProvideSliceData as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 12.5 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
Whether to pass Memoryblock with data with Progress event for new rows arrived.

(Read and Write property)

Some examples using this property:

TwainMBS.ProvideSlicePicture as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 12.5 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
Whether to pass picture with Progress event for new rows arrived.

(Read and Write property)

Some examples using this property:

TwainMBS.ResX as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 13.0 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
The horizontal resolution for scanning.

This value is stored and next time you call Acquire the plugin will ask the scanner to use this resolution. If the scanner does not support the resolution, the scanner will use the last valid setting.
Use -1 to use the default setting.
(Read and Write property)

TwainMBS.ResY as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 13.0 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
The vertical resolution for scanning.

This value is stored and next time you call Acquire the plugin will ask the scanner to use this resolution. If the scanner does not support the resolution, the scanner will use the last valid setting.
Use -1 to use the default setting.
(Read and Write property)

TwainMBS.Shadow as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Twain MBS Picture Plugin 13.5 ✅ Yes ✅ Yes ❌ No ❌ No Desktop only
Specifies which value in an image should be interpreted as the darkest shadow.

The plugin will apply this setting on the next scan.
All values darker than this value will be clipped to this value.

Whether darker values are smaller or larger can be determined by examining the Current value of PixelFlavor.
Source

If more or less than 8 bits are used to describe the image, the actual data values should be normalized to fit within the 0-255 range. The normalization need not result in a homogeneous distribution if the original distribution was not homogeneous.
(Read and Write property)

The items on this page are in the following plugins: MBS Picture Plugin.


The biggest plugin in space...