ImageGear Professional DLL v18.1 for Windows
IG_TWAIN_cap_container_type_get
Send Feedback
ImageGear Professional v18.1 > API Reference Guide > TWAIN Component API Reference > TWAIN Component Functions Reference > Capability Functions > IG_TWAIN_cap_container_type_get

Glossary Item Box

This function gets the type of a capability container.

Declaration:

  Copy Code 
AT_ERRCOUNT ACCUAPI IG_TWAIN_cap_container_type_get(
        HTWAINCAP hTWAINCap,
        LPAT_MODE lpContainerType
);

Arguments:

Name Type Description
hTWAINCap HTWAINCAP Handle to the capability container. References the container structure where detailed information about the capability is stored.
lpContainerType LPAT_MODE

Capability container type. Can be one of the following values:

  • IG_TW_ON_ONEVALUE - A single value whose current and default values are coincident. The range of available values for this type of capability is simply this single value. For example, a capability that indicates the presence of a document feeder could be of this type.
  • IG_TW_ON_ARRAY - A rectangular array of values that describe a logical item. It is similar to the IG_TW_ON_ONEVALUE because the current and default values are the same and there are no other values from which to select. For example, a list of the names, such as the supported capabilities list returned by the IG_TW_CAP_SUPPORTEDCAPS capability, would use this type of container.
  • IG_TW_ON_ENUMERATION - This is the most general type because it defines a list of values from which the Current Value can be chosen. The values do not progress uniformly through a range and there is not a consistent step size between the values. For example, if a Source's resolution options did not occur in even step sizes, then an enumeration would be used (for example, 150, 400, and 600).
  • IG_TW_ON_RANGE - Many capabilities allow users to select their current value from a range of regularly spaced values. The capability can specify the minimum and maximum acceptable values and the incremental step size between values. For example, resolution might be supported from 100 to 600 in steps of 50 (100, 150, 200, ..., 550, 600).

Return Value:

Returns the number of ImageGear errors that occurred during this function call. If there are no errors, the return value is IGE_SUCCESS.

Supported Raster Image Formats:

This function does not process image pixels.

©2014. Accusoft Corporation. All Rights Reserved.