ICAP_IMAGEDATASET

Featured Clients

Sectors: FinanceInformation TechnoloyGovernmentHealthcareIndustriesEducation(show all)

TWAIN Capability: ICAP_IMAGEDATASET

ICAP_IMAGEDATASET

Description

Gets or sets the image indices that will be delivered during the standard image transfer done in States 6 and 7. Indices are assumed to start at 1, so a TW_ONEVALUE container sets an implied range from 1 to the number specified. TW_RANGE returns are useful for those cases where the images are contiguous (5 .. 36). TW_ARRAY returns should be used were index values are discontinuous (as could be the case where the user previously set such a data set). See the note in the Values section below.

Application

A MSG_RESET operation should always be done before a MSG_GET if the application wishes to get the complete list of available images. A MSG_SET operation will define the number and order of images delivered during States 6 and 7.

Source

Values

For MSG_GET, if a contiguous range of images are available starting from the first index (e.g., 1 .. it is recommended that the TW_ONEVALUE container is used specifying just the total number of available images (e.g., 36).

If not supported, return TWRC_FAILURE/ TWCC_CAPUNSUPPORTED.

Type: TW_UINT

Value after MSG_OPENDS: (entire range or set of available images)

After MSG_RESET/MSG_RESETALL: (entire range or set of available images)

Allowed Values: 0 to 232 -1 (for MSG_GET) 1 to 232 -1 (for MSG_SET)

Containers

MSG_GET TW_ARRAY (see note below) TW_RANGE (see note below) TW_ONEVALUE (see note below)

MSG_GETCURRENT TW_ARRAY

MSG_GETDEFAULT TW_ARRAY

MSG_SET TW_ONEVALUE (see note below) TW_ARRAY (see note below) TW_RANGE (see note below)

MSG_SETCONSTRAINT TW_ONEVALUE (see note below) TW_ARRAY (see note below) TW_RANGE (see note below)

MSG_RESET TW_ARRAY

MSG_QUERYSUPPORT TW_ONEVALUE Note: Source must use the container type used during the last successful SET/RESET operation. These container types are supported for the returning discontinuous indices that have been previously set by the application. It is highly recommended that for an initialized or reset Image Store device, the TW_ONEVALUE container be the only one returned by the MSG_GET operation. In other words, the data source should not expose the details of the internal memory management of the Image Store device by claiming that it has a hole in its storage locations due to user deletions. For example, a camera that currently has data for pictures 1 to 10 should report that it has 10 images available. If the user later deletes pictures 5, 7, and 9, it should now report that it has 7 images available (i.e., 1 to 7), and not claim that it has pictures 1, 2, 3, 4, 6, 8, and 10 available. To do so would expose the internal memory management constraints of the device and serves little use but to confuse the user.

Required By

All Image Store Data Sources.

TWAIN Version Introduced

Version 1.7

Related

TWAIN Notice

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