| Example-VB | Example-VC++ |
Returns scanner capability information or current option settings.
| Ö | Imaging for Windows Professional Edition V1.0, V1.1, and V2.0 |
| Imaging for Windows 95 and 98 | |
| Imaging for Windows NT 4.0 |
Image Scan control
object.GetScanCapability(Capability_ID)
| Parameter | Data Type | Description |
| Capability_ID | Integer | Capability information, current values of options, or Variant for an error or unknown capability |
A variant containing capability values supported by the scanner.
| Capability_ID / Name |
Description | Return Value | Data Type |
| 1 Image Types Available |
Colors supported | A bit-wise combination of the following values: 1 - black and white 2 - grayscale 16 4 - grayscale 256 8 - color 256 palletized 16 - true color 24-bit RGB 32 - color 16-bit palettized |
Integer |
| 2 Maximum Height |
Maximum physical page height available on the flatbed. | Inches | Single |
| 3 Maximum Height (with ADF) |
Maximum physical page height supported with an Automatic Document Feeder (ADF). | Inches | Single |
| 4 Maximum Width |
Maximum physical page width | Inches | Single |
| 5 Minimum Resolution |
Minimum resolution available | Dots-per-inch | Long |
| 6 Maximum Resolution |
Maximum resolution available | Dots-per-inch | Long |
| 7 Resolution Step |
The steps between maximum and minimum resolutions | Resolution increments, or an array of values | Long, if step is available. Otherwise, an array of Long or Integer values. |
| 8 Minimum Brightness |
Minimum brightness available | Brightness value | Long |
| 9 Maximum Brightness |
Maximum brightness available | Brightness value | Long |
| 10 Brightness step |
The steps between maximum and minimum brightness values | Brightness increments, or an array of values | Long, if increments are available. Otherwise, an array of Long or Integers values. |
| 11 Auto Brightness |
Determines if an auto brightness feature is available. | True - Auto brightness supported False - Auto brightness not supported |
Boolean |
| 12 Minimum Contrast |
Minimum contrast available | Minimum contrast value | Long |
| 13 Maximum Contrast |
Maximum contrast available | Maximum contrast value | Long |
| 14 Contrast Step |
The steps between maximum and minimum contrast values | Contrast increments, or an array of values | Long, if increments are available. Otherwise, an array of Long or Integer values. |
| 15 Auto Contrast |
Determines if an auto contrast feature is available. | True - Auto contrast supported False - Auto contrast not supported |
Boolean |
| 16 ADF available |
Determines if an automatic document feeder (ADF) is available | True - ADF is available False - ADF is not available |
Boolean |
The following option information shows what values are currently set on the scanner.
| Capability_ID / Name |
Description | Return Value | Data Type |
| 100 Image Type |
Image Type in use | One of the following values: 1 - black and white 2 - grayscale 16 4 - grayscale 256 8 - color 256 palletized 16 - true color 24-bit RGB 32 - color 16-bit palettized |
Integer |
| 101 X Resolution |
X Resolution in use | A value between maximum and minimum resolution | Long |
| 102 Brightness Mode |
Reports if the Brightness Mode is set to Normal or Automatic | One of the following values: 1 - Normal 2 - Automatic |
Integer |
| 103 Brightness |
If the Brightness Mode is Normal, the brightness level is returned | A brightness value (unit of measure varies with scanner type) |
Long |
| 104 Contrast Mode |
Reports if the Contrast Mode is set to Normal or Automatic. | One of the following values: 1 - Normal 2 - Automatic |
Integer |
| 105 Contrast |
If the Contrast Mode is Normal, the contrast level is returned | Contrast value (unit of measure varies with scanner type) |
Long |
| 106 Image Layout |
Reports four values (in inches) that define the image layout - Left, Top, Height, and Width. | An array of 4 values, listed in the following order:
Left start of scan offset |
An array of Single values |
| 107 Scan Mode |
Reports if the Scan Mode is set to Flatbed or ADF (Automatic Document Feeder). | One of the following values: 1 - Flatbed 2 - ADF |
Short |
| 108 Paper in Feeder |
Reports if there is paper in the ADF. The Scanner Mode must be set to 2 (ADF present) for this capability to be valid. | True - Paper is present False - Paper is not present |
Boolean |
| 109 Y Resolution |
Y Resolution in use | A value between maximum and minimum resolution | Long |
The scanner must be open when this call is made, or an error is returned.
If a capability is not supported, a VT_Error is returned.