CAP_ALARMS

Featured Clients

Sectors: FinanceInformation TechnoloyGovernmentHealthcareIndustriesEducation(show all)

TWAIN Capability: CAP_ALARMS

CAP_ALARMS

Description

Turns specific audible alarms on and off.

Application

Note that an application may opt to turn off all alarms by issuing a MSG_SET with no data. Therefore, an application should also be prepared to receive an empty array from a Source with an MSG_GET. (i.e., pTW_ARRAY->NumItems == 0)

The easiest way to test for allowed values is to try to set them all with MSG_SET. If not all are allowed, the Source will return TWRC_CHECKSTATUS with those values that it supports.

Source

Values

It is worth noting that the alarms do not have to be present in the device for a Source to make use of this capability. If the device is capable of alerting the Source to these various kinds of conditions, but is unable to generate the alarms, itself; then the Source may opt to generate them on its behalf.

TWAL_ALARM is a catchall for alarms not explicitly listed. It is also used where a device only provides control over a single, multi-use alarm. For instance, if a device beeps for both jams and bar-codes, but doesn’t allow independent control of the alarms, then it should report TWAL_ALARM to cover them, and not TWAL_BARCODE, TWAL_JAM.

TWAL_FEEDERERROR covers paper handling errors such as jams, double-feeds, skewing and the like; conditions that most likely stop scanning.

TWAL_FEEDERWARNING covers non-fatal events, such as feeder empty.

TWAL_DOUBLEFEED, TWAL_JAM and TWALSKEW cover paper handling errors.

TWAL_BARCODE and TWAL_PATCHCODE generate alarms when an image with this kind of data is recognized.

TWAL_POWER generates alarms for any changes in power to the device.

Type: TW_UINT

Value after MSG_OPENDS: (may be remembered from a pervious session)

After MSG_RESET/MSG_RESETALL: (selected by the data source writer)

Allowed Values: TWAL_ALARM TWAL_FEEDERERROR TWAL_FEEDERWARNING TWAL_BARCODE TWAL_DOUBLEFEED TWAL_JAM TWAL_PATCHCODE TWAL_POWER TWAL_SKEW

Containers

MSG_GET TW_ARRAY

MSG_GETCURRENT TW_ARRAY

MSG_GETDEFAULT TW_ARRAY

MSG_SET TW_ONEVALUE TW_ARRAY

MSG_RESET TW_ARRAY

MSG_SETCONSTRAINT TW_ONEVALUE

TW_ARRAY

MSG_QUERYSUPPORT TW_ONEVALUE

Required By

None

TWAIN Version Introduced

Version 1.8

Related

CAP_ALARMVOLUME

TWAIN Notice

Where would you like to scan from? Scan in Web Apps Scan in Java Scan in .NET