ISIS Tags

0x0000 (0)

—

Integer

A list of all the tags that the driver supports, as numeric values.

0x06A5 (1701)

TAG_ADFTIMEOUT

Integer

The time (in seconds) that the scanner spends attempting to read the next page before reporting that no page was found.

0x1318 (4888)

TAG_ALLFILESFLAG

Integer

Enables or disables the filter that shows all files (*.*) in a common file open selection list. Set this tag as desired before getting the value of TAG_AVAILFMTS to control whether the available formats include the filter.

Possible Values for: TAG_ALLFILESFLAG

0x1322 (4892)

TAG_ALLOWEDFORMATS

Integer

Limits the available formats reported by TAG_AVAILFMTS, enabling your application to list only a subset of the formats supported by the installed group of file filters in a file open or file save selection list.

The number of times this tag can be set depends on the value of TAG_NUMALLOWEDFORMATS.

For the list of possible tag values, refer to ImGearIsisFileType.

0x1330 (4900)

TAG_AVAILBITSPERSAMPLE

Integer

Enables you to retrieve the valid choices for the number of bits per sample.

The value of this tag has no specific meaning. You simply get the value in order to retrieve the list of available choices.

0x1324 (4894)

TAG_AVAILCOLORFMTS

Integer

Enables you to retrieve the valid color format choices for the file types in TAG_AVAILFORMAT_FILETYPES.

The value of this tag has no specific meaning. You simply get the value in order to retrieve the list of available choices.

0x1325 (4895)

TAG_AVAILCOLORFMTSNAME

String

Enables you to retrieve the valid color format name choices for the color format choices in TAG_AVAILCOLORFMTS.

The value of this tag has no specific meaning. You simply get the value in order to retrieve the list of available choices.

0x1326 (4896)

TAG_AVAILCOMPRESSION

Integer

Enables you to retrieve the valid compression choices for the color format choices in TAG_AVAILCOLORFMTS.

The value of this tag has no specific meaning. You simply get the value in order to retrieve the list of available choices.

0x1327 (4897)

TAG_AVAILCOMPRESSIONNAME

String

Enables you to retrieve the valid compression name choices for the color format choices in TAG_AVAILCOLORFMTS.

The value of this tag has no specific meaning. You simply get the value in order to retrieve the list of available choices.

0x1316 (4886)

TAG_AVAILFMTS

String

A string in the format required by a file type list in a Windows common file open window.

The list depends on the values of TAG_NUMALLOWEDFORMATS and TAG_ALLOWEDFORMATS.

0x1321 (4891)

TAG_AVAILFORMAT_EXTS

String

Enables you to retrieve the filename extensions for the valid file types.

The value of this tag has no specific meaning. You simply get the value in order to retrieve the list of available choices.

0x1319 (4889)

TAG_AVAILFORMAT_FILETYPES

Integer

Enables you to retrieve the file types. For the list of possible values that might be available as choices, refer to ImGearIsisFileType.

The value of this tag has no specific meaning. You simply get the value in order to retrieve the list of available choices.

0x1320 (4890)

TAG_AVAILFORMAT_NAMES

String

Enables you to retrieve the file type names.

The value of this tag has no specific meaning. You simply get the value in order to retrieve the list of available choices.

0x1329 (4899)

TAG_AVAILPHOTOMETRIC

Integer

Enables you to retrieve the valid photometric interpretation choices for the current bits per sample choices.

The value of this tag has no specific meaning. You simply get the value in order to retrieve the list of available choices.

0x1328 (4898)

TAG_AVAILSAMPLESPERPIXEL

Integer

Enables you to retrieve the valid samples per pixel choices for the current file type choices.

The value of this tag has no specific meaning. You simply get the value in order to retrieve the list of available choices.

0x06C1 (1729)

TAG_BAR_AUTOREADBACK

Integer

Enables or disables automatic barcode detection on the back side of a duplex scan, using the current barcode search parameters.

0x06C0 (1728)

TAG_BAR_AUTOREADFRONT

Integer

Enables or disables automatic barcode detection on the front side of a duplex scan, using the current barcode search parameters.

0x069C (1692)

TAG_BAR_TYPE

Integer

The type or types of barcodes to search for.

This tag contains a list of one or more values, accessible through an index. Set the number of barcode types with TAG_BAR_TYPECOUNT.

For the list of possible barcode type values, refer to ImGearIsisBarcodeType.

0x069D (1693)

TAG_BAR_TYPECOUNT

Integer

The number of barcode types to search for.

0x069B (1691)

TAG_BARCODE

Integer

Enables or disables barcode detection.

Possible values for: TAG_BARCODE

0x06C7 (1735)

TAG_BARDATA_TEXT

String

The text of the barcode from the most recent barcode detection.

If no barcode was found, then this value has no meaning and should be ignored. Check the value TAG_BARDATA_TYPE to determine if a barcode was found.

0x06C2 (1730)

TAG_BARDATA_TYPE

Integer

The type of the barcode from the most recent barcode detection.

For the list of possible values, refer to ImGearIsisBarcodeType.

0x06C3 (1731)

TAG_BARDATA_XPOSITION

Integer

The horizontal position of the barcode from the most recent barcode detection, measured in units of the current resolution. This is the horizontal distance from the left edge of the page to the left edge of the barcode.

0x06C4 (1732)

TAG_BARDATA_YPOSITION

Integer

The vertical position of the barcode from the most recent barcode detection, measured in units of the current resolution. This is the vertical distance from the top edge of the page to the top edge of the barcode.

0x0508 (1288)

TAG_BELL

Integer

Indicates if the scanner has an audible alert device.

Possible values for: TAG_BELL

0x0102 (258)

TAG_BITSPERSAMPLE

Integer

The number of bits per sample to use in stored images.

0x1726 (5926)

TAG_BLANKPAGE_IMPRINTER_BEHAVIOR

Integer

Detects whether the scanner’s imprinter prints on deleted blank pages. You can use this value to keep track of the imprinter counter when a blank page is deleted.

Possible values for: TAG_BLANKPAGE_IMPRINTER_BEHAVIOR

0x1334 (4904)

TAG_BPS_LBS

String

Enables you to retrieve the valid choices for the number of bits per sample for a list box control. It should be used in conjunction with TAG_SPP_LBS and TAG_PHOTO_LBS to give the user total control over color format. If separate control is not desired, you should use TAG_COLORFMTS_LBS instead.

The value of this tag has no specific meaning. You simply get the value in order to retrieve the list of available choices.

0x0502 (1282)

TAG_BRIGHTNESS

Integer

The brightness applied to an image.

The table that follows lists the possible nonpositive special values. You must get the list of valid choices to be aware of the number of possible positive values.

Possible values for: TAG_BRIGHTNESS

0x0507 (1287)

TAG_BUFSIZE

Integer

The size of the driver’s preferred image buffer, in bytes.

0x1332 (4902)

TAG_COLORFMTS_LBS

String

Enables you to retrieve the valid color format choices for a list box control.

The value of this tag has no specific meaning. You simply get the value in order to retrieve the list of available choices.

TAG_COLORFORMAT

The color format to use in stored images.

Possible values for: TAG_COLORFORMAT

0x0140 (320)

TAG_COLORMAP

Integer

The palette values for a palette image.

This tag is set automatically by file drivers when they are handling a palette image, so in most cases you do not need to be concerned with this tag.

0x0103 (259)

TAG_COMPRESSION

Integer

The compression type to use in stored images. For the list of possible values, refer to ImGearIsisImageCompression.

The valid compression types depend on the color format, so you should set this tag only after setting the desired color format. For information about the supported formats, refer to ImGearIsisFileType.

0x1333 (4903)

TAG_COMPRESSION_LBS

String

Enables you to retrieve the valid compression type choices for a list box control.

The value of this tag has no specific meaning. You simply get the value in order to retrieve the list of available choices.

0x0600 (1536)

TAG_CONFIGURATIONS

String

Enables you to retrieve the names of the custom default scanner configurations that are defined in the driver. The configurations themselves are stored in the TAG_CONFIG_n tags.

The value of this tag has no specific meaning. You simply get the value in order to retrieve the list of available choices.

0x0601 (1537)

TAG_CONFIG_1

String

A custom default scanner configuration that is defined in the driver.

0x0602 (1538)

TAG_CONFIG_2

String

A custom default scanner configuration that is defined in the driver.

0x0603 (1539)

TAG_CONFIG_3

String

A custom default scanner configuration that is defined in the driver.

0x0604 (1540)

TAG_CONFIG_4

String

A custom default scanner configuration that is defined in the driver.

0x0501 (1281)

TAG_CONTRAST

Integer

The contrast applied to an image.

Possible values for: TAG_CONTRAST

0x0114 (276)

TAG_DATAORIENTATION

Integer

The orientation to which the scanner has rotated the image.

For the list of possible values, refer to ImGearIsisOrientation.

0x1341 (4929)

TAG_DETECTBLANKIMAGE

Integer

Enables or disables blank page detection and deletion during scanning.

This is useful if you are keeping track of page sides in a duplex scan. Unless you can detect deleted pages, you will be unable to determine whether an image is from the front side or the back side of a sheet of paper.

You can also use this, along with TAG_BLANKPAGE_IMPRINTER_BEHAVIOR, to keep track of imprinter counts.

Possible values for: TAG_DETECTBLANKIMAGE

0x133B (4923)

TAG_DETECTBLANKIMAGE_BINARY

Integer

Enables or disables blank page detection and deletion for the binary stream during multistream scanning.

Possible values for: TAG_DETECTBLANKIMAGE_BINARY

0x133D (4925)

TAG_DETECTBLANKIMAGE_COLOR

Integer

Enables or disables blank page detection and deletion for the color stream during multistream scanning.

Possible values for: TAG_DETECTBLANKIMAGE_COLOR

0x133C (4924)

TAG_DETECTBLANKIMAGE_GRAY

Integer

Enables or disables blank page detection and deletion for the grayscale stream during multistream scanning.

Possible values for: TAG_DETECTBLANKIMAGE_GRAY

0x05A7 (1447)

TAG_DETECTJOBSEP

Integer

The mode for detecting job separator sheets.

Possible values for: TAG_DETECTJOBSEP

0x0500 (1280)

TAG_DITHER

String

The dithering mode.

Dither patterns are unique to each scanner, so there is no predefined set of tag choices. You should get the valid choices before attempting to set this tag. The first choice represents no dithering and is usually called None.

0x0518 (1304)

TAG_DITHER_LENGTH1

Integer

The length of TAG_DITHER_PATTERN1.

0x0519 (1305)

TAG_DITHER_LENGTH2

Integer

The length of TAG_DITHER_PATTERN2.

0x0548 (1352)

TAG_DITHER_PATTERN1

Integer

A downloadable dither pattern defined on the scanner.

A dither pattern is a 2-dimensional array of values. To create one, establish the pattern width and length, then fill in the values for each element. For more information, consult the documentation supplied with scanners that support downloadable dither patterns.

0x0549 (1353)

TAG_DITHER_PATTERN2

Integer

A downloadable dither pattern defined on the scanner.

A dither pattern is a 2-dimensional array of values. To create one, establish the pattern width and length, then fill in the values for each element. For more information, consult the documentation supplied with scanners that support downloadable dither patterns.

0x0538 (1336)

TAG_DITHER_WIDTH1

Integer

The width of TAG_DITHER_PATTERN1.

0x0539 (1337)

TAG_DITHER_WIDTH2

Integer

The width of TAG_DITHER_PATTERN2.

0x0510 (1296)

TAG_EMPHASIS

Integer

The scanner’s emphasis setting. Consult the scanner documentation for information on how to use emphasis.

Possible values for: TAG_EMPHASIS

0x16F2 (5874)

TAG_ENDORSER_COUNTER_INDEX

Integer

Specifies which endorser or imprinter counter to increment. For imprinters that support multiple counters, this tag is the 0-based index for accessing the counter tags for each counter. This tag only controls multiple counters within the same imprinter. Counters on different imprinters are indexed by TAG_ENDORSER_INDEX.

The currently-selected imprinter should be enabled before setting this tag. The imprinter should be configured to print the incrementing counter by using the proper token in TAG_ENDORSER_STRING.

As an index tag, this tag can change the current value for any other counter-specific tag, including TAG_ENDORSER_COUNTERDIGITS, TAG_ENDORSER_INCSTART, and TAG_ENDORSER_INCSTEP.

0x152C (5420)

TAG_ENDORSER_COUNTERDIGITS

Integer

The number of digits of the incrementing counter to print. The high-order digits are truncated if necessary.

If the counter has fewer digits than specified, then the behavior depends on the selected counter format. For example, some formats will pad with 0’s or spaces.

The currently-selected imprinter should be enabled before setting this tag. The imprinter should be configured to print the incrementing counter by using the proper token in TAG_ENDORSER_STRING.

This tag is indexed from TAG_ENDORSER_COUNTER_INDEX.

0x16FB (5883)

TAG_ENDORSER_DATE_SEPARATOR

String

The separator to be used when printing the special date codes. Some scanners support changing the separator value, while others do not.

The currently-selected imprinter should be enabled before setting this tag. Enable one of the special date codes in TAG_ENDORSER_STRING.

0x1068 (4200)

TAG_ENDORSER_FONT

String

The text font used by the imprinter.

The possible values of this tag vary based on the scanner. It might use formal font names or user-friendly names.

The currently-selected imprinter should be enabled before setting this tag.

0x0584 (1412)

TAG_ENDORSER_INCSTART

Integer

The starting value for the imprinter incrementing counter.

This tag is automatically updated at the end of the batch with the next number to be printed.

The currently-selected imprinter should be enabled before setting this tag. The imprinter should be configured to print the incrementing counter by using the proper token in TAG_ENDORSER_STRING.

This tag is indexed from TAG_ENDORSER_COUNTER_INDEX.

0x1066 (4198)

TAG_ENDORSER_INCSTEP

Integer

The increment value for the imprinter incrementing counter. For each page the counter will be increased by this value.

The currently-selected imprinter should be enabled before setting this tag. The imprinter should be configured to print the incrementing counter by using the proper token in TAG_ENDORSER_STRING.

This tag is indexed from TAG_ENDORSER_COUNTER_INDEX.

0x16F1 (5873)

TAG_ENDORSER_INDEX

Integer

The 0-based index value of the imprinter to configure. The values of the other imprinter tags depend on which imprinter is selected.

Imprinters are not indexed in any particular order, so your application should look at the values of other tags to determine which imprinter is selected.

0x1067 (4199)

TAG_ENDORSER_ORIENTATION

Integer

The orientation of the printed text relative to the leading edge of the page.

For the list of possible values, refer to ImGearIsisOrientation.

The currently-selected imprinter should be enabled before setting this tag.

0x106C (4204)

TAG_ENDORSER_PRINTTYPE

Integer

Enables or disables the currently selected imprinter.

Possible values for: TAG_EMPHASIS

0x0477 (1143)

TAG_ENDORSER_SIDE

Integer

Specifies which side of a duplex page on which to print the endorser string.

For the list of possible values, refer to ImGearIsisPageSide.

0x0583 (1411)

TAG_ENDORSER_STRING

String

The imprinter string.

Special token codes can be used to describe dynamic data such as the date, the time, or an incrementing counter.

The values acceptable to an endorser are specific to the scanner. Various scanners support different characters and string lengths, and might support other tags that control endorsement position, orientation, size, and so forth.

For legacy support, setting this tag to an empty string turns off the imprinter, and setting this tag to a non-empty string turns on the imprinter. However, you should not rely on this behavior. Always enable or disable the imprinter with TAG_ENDORSER_PRINTTYPE.

0x16F3 (5875)

TAG_ENDORSER_STRING_EXAMPLE

String

The actual imprinter string that would be printed on the page using the current date, time, and counter value.

0x16FA (5882)

TAG_ENDORSER_TIME_SEPARATOR

String

The separator to be used when printing the special time codes. Some scanners support changing the separator value, while others do not.

0x16F4 (5876)

TAG_ENDORSER_TOKEN_FULL

String

The list of all available imprinter string characters and token codes as a single string. This tag requires some minor parsing, so you might want to use TAG_ENDORSER_TOKEN_NEXT_CODE instead.

The format of a token is the token code, followed by the symbol |, followed by a description. An example is:

The currently-selected imprinter should be enabled before setting this tag.

0x16F9 (5881)

TAG_ENDORSER_TOKEN_MASK

Integer

Applies a mask to the imprinter string.

The value is a bitmask, with each bit specifying a different component to mask. The default value is 0x00000001.

Bit values for: TAG_ENDORSER_TOKEN_MASK

The currently-selected imprinter should be enabled before setting this tag.

0x16F6 (5878)

TAG_ENDORSER_TOKEN_NEXT_CODE

String

The next available token code in the scanner’s list.

Setting this tag modifies the other next token tags to match the selected token.

The currently-selected imprinter should be enabled before setting this tag.

0x16F5 (5877)

TAG_ENDORSER_TOKEN_NEXT_DESC

String

The next available token code description in the scanner’s list.

Setting this tag modifies the other next token tags to match the selected token.

The currently-selected imprinter should be enabled before setting this tag.

0x16F7 (5879)

TAG_ENDORSER_TOKEN_NEXT_EXAMPLE

String

The example string for the next available token code.

Setting this tag modifies the other next token tags to match the selected token.

The currently-selected imprinter should be enabled before setting this tag.

0x16F8 (5880)

TAG_ENDORSER_TOKEN_NEXT_FULL

String

The next full token in the scanner’s list, including the token code and the description.

Setting this tag modifies the other next token tags to match the selected token.

The currently-selected imprinter should be enabled before setting this tag.

0x0476 (1142)

TAG_ENDORSER_TYPE

Integer

Specifies if the imprinter string is printed before or after an image is scanned.

Bit values for: TAG_ENDORSER_TOKEN_MASK

0x16F0 (5872)

TAG_ENDORSER_VERSION

Integer

The version number of the imprinter.

0x0585 (1413)

TAG_ENDORSER_YOFFSET

Integer

The distance (in mm) to the printed imprinter string from a scanner-defined location (often the edge of the page).

The choices for this tag are limited by where the scanner allows the imprinter string to be placed.

0x0503 (1283)

TAG_FEEDER

Integer

The feeder capabilities of the scanner.

The value is a bitmask, with each bit specifying a different component to mask.

Bit values for:  TAG_FEEDER

0x0907 (2311)

TAG_FILETYPE

Integer

The file type to store.

For the list of possible values, refer to ImGearIsisFileType.

0x1331 (4901)

TAG_FILETYPE_LBS

String

Enables you to retrieve the valid file type choices for a list box control.

The value of this tag has no specific meaning. You simply get the value in order to retrieve the list of available choices.

0x010A (266)

TAG_FILLORDER

Integer

The order in which bits are stored in a byte.

This tag applies only to binary images. The default value is 1.

The value is a bitmask, with each bit specifying a different component to mask.

Possible values for: TAG_FILLORDER

0x050F (1295)

TAG_GAMMA

Integer

The scanner’s gamma correction setting.

Possible values for: TAG_GAMMA

0x0558 (1368)

TAG_GAMMA_LENGTH1

Integer

The length of TAG_GAMMA_TABLE1.

0x0559 (1369)

TAG_GAMMA_LENGTH2

Integer

The length of TAG_GAMMA_TABLE2.

0x055A (1370)

TAG_GAMMA_LENGTH3

Integer

The length of TAG_GAMMA_TABLE3.

0x055B (1371)

TAG_GAMMA_LENGTH4

Integer

The length of TAG_GAMMA_TABLE4.

0x055C (1372)

TAG_GAMMA_LENGTH5

Integer

The length of TAG_GAMMA_TABLE5.

0x055D (1373)

TAG_GAMMA_LENGTH6

Integer

The length of TAG_GAMMA_TABLE6.

0x0568 (1384)

TAG_GAMMA_TABLE1

Integer

A downloadable gamma table defined on the scanner.

To create a gamma table, establish the table length, then fill in the values for each element. For more information, consult the documentation supplied with scanners that support downloadable gamma tables.

0x0569 (1385)

TAG_GAMMA_TABLE2

Integer

A downloadable gamma table defined on the scanner.

To create a gamma table, establish the table length, then fill in the values for each element. For more information, consult the documentation supplied with scanners that support downloadable gamma tables.

0x056A (1386)

TAG_GAMMA_TABLE3

Integer

A downloadable gamma table defined on the scanner.

To create a gamma table, establish the table length, then fill in the values for each element. For more information, consult the documentation supplied with scanners that support downloadable gamma tables.

0x056B (1387)

TAG_GAMMA_TABLE4

Integer

A downloadable gamma table defined on the scanner.

To create a gamma table, establish the table length, then fill in the values for each element. For more information, consult the documentation supplied with scanners that support downloadable gamma tables.

0x056C (1388)

TAG_GAMMA_TABLE5

Integer

A downloadable gamma table defined on the scanner.

To create a gamma table, establish the table length, then fill in the values for each element. For more information, consult the documentation supplied with scanners that support downloadable gamma tables.

0x056D (1389)

TAG_GAMMA_TABLE6

Integer

A downloadable gamma table defined on the scanner.

To create a gamma table, establish the table length, then fill in the values for each element. For more information, consult the documentation supplied with scanners that support downloadable gamma tables.

0x090B (2315)

TAG_GIFVERSION

Integer

The version number of the GIF file format being used.

Possible values for: TAG_GIFVERSION

0x0124 (292)

TAG_GROUP3OPTIONS

Integer

Options for ITU Group 3 compression.

The value is a bitmask, so multiple values can be specified with the different bits. All unused bits must be set to 0. The default value is 0x0.

Bit values for: TAG_GROUP3OPTIONS

0x0698 (1688)

TAG_HAVELENGTH

Integer

Specifies whether the end of an autopipe delivers the length of the image, required by file writing drivers.

Possible values for: TAG_HAVELENGTH

0x1725 (5925)

TAG_IMAGEDELETED

Integer

Indicates that a blank page was deleted.

The image was deleted if the tag is defined. The only possible value for the tag is 1.

0x0101 (257)

TAG_IMAGELENGTH

Integer

The height of an image, in pixels.

In some applications, you can set this tag to crop or overscan the image.

0x0100 (256)

TAG_IMAGEWIDTH

Integer

The width of an image, in pixels.

In some applications, you can set this tag to crop or overscan the image.

0x16E1 (5857)

TAG_INPUTAUTHOR

String

The author of a document.

0x16E3 (5859)

TAG_INPUTCREATOR

String

The creator of a document.

0x16E4 (5860)

TAG_INPUTKEYWORDS

String

The keywords defined in a document.

0x1008 (4104)

TAG_INPUTNAME

String

The name of the file from which an image is read.

0x16E5 (5861)

TAG_INPUTPRODUCER

String

The producer of a document.

0x16E2 (5858)

TAG_INPUTSUBJECT

String

The subject of a document.

0x16E0 (5856)

TAG_INPUTTITLE

String

The title of a document.

0x1311 (4881)

TAG_INSERTMODE

Integer

Specifies how data is inserted into a file.

Possible values for: TAG_INSERTMODE

0x05E3 (1507)

TAG_INVERT

Integer

Specifies whether an image is color inverted.

Possible values for: TAG_INVERT

0x87BE (34750)

TAG_JBIGOPTIONS

Integer

Options for JBIG image data.

This valule consists of 20 bytes that comprise the JBIG header, and have the following values:

Byte values for: TAG_JBIGOPTIONS

0x05A8 (1448)

TAG_JOBSEPDETECTED

Integer

Indicates that a job separator page was detected.

Values for: TAG_JOBSEPDETECTED

0x138F (5007)

TAG_JP2_LOSSLESS

Integer

Specifies whether the compression is lossless.

Values for: TAG_JP2_LOSSLESS

0x138D (5005)

TAG_JP2_MAXRATE

Rational

The maximum number of quality layers in a JPEG 2000 compressed image.

0x138C (5004)

TAG_JP2_MINRATE

Rational

The minimum number of quality layers in a JPEG 2000 compressed image.

0x138E (5006)

TAG_JP2_NUMRATES

Integer

The number of quality layers to spread between TAG_JP2_MINRATE and TAG_JP2_MAXRATE.

Values for: TAG_JP2_NUMRATES

0x137F (4991)

TAG_JP2_PROGRESSION_ORDER

Integer

The progression order to use when saving JPEG 2000 compressed files.

The default value is 0.

Values for: TAG_JP2_PROGRESSION_ORDER

0x138B (5003)

TAG_JP2_RATE

Rational

The compression ratio to use when saving JPEG 2000 compressed files, expressed as a ratio between the total number of compressed bits (including headers) and the product of the longest horizontal and vertical image component dimensions. The compression factor affects the degree of compression and the image quality of the saved file.

The default value is 1/1.

For lossless compression, the final quality layer includes all pixels in the original image (compressed).

This value is ignored if TAG_JP2_USEDEFAULTRATE is set to 1.

0x1289 (5001)

TAG_JP2_USEDEFAULTRATE

Integer

Specifies whether a default compression ratio is used.

The default value is 1.

Values for: TAG_JP2_USEDEFAULTRATE

0x1380 (4992)

TAG_JPEGCOMPRESSIONFACTOR

Integer

The compression factor to use when saving JPEG compressed files. The compression factor affects the degree of compression and the image quality of the saved file.

The possible values are integers from -10 to 10, inclusive. Lower numbers provide less compression with better image quality, while higher numbers provide greater compression at the expense of image quality.

0x050C (1292)

TAG_KFACTOR

Integer

The “Parameter K” value as defined in the ITU Specification for Group 3 two-dimensional compression. It is generated in compressed images from ISIS drivers that support Group 3 2D compression.

0x1317 (4887)

TAG_KNOWNFMTSFLAG

Integer

Specifies whether the “Known Formats” entry in a common file open window is enabled.

Values for: TAG_KNOWNFMTSFLAG

0x13DE (5086)

TAG_LASTPAGE_ENDORSER

String

The actual imprinter text that was printed on the page.

0x06FF (1791)

TAG_LASTPAGE_SIDE

Integer

The side of a sheet of paper that was scanned.

For the list of possible values, refer to ImGearIsisPageSide.

0x0912 (2322)

TAG_MAXDCXIFDSIZE

Integer

The maximum number of bytes allocated to the DCX offsets list.

0x0504 (1284)

TAG_MAXPAGES

Integer

The maximum number of pages that can be loaded at one time in the scanner’s automatic document feeder.

0x0505 (1285)

TAG_MAXTIME

Integer

The maximum amount of time required for scanner to scan a page, expressed in tenths of a second.

0x0511 (1297)

TAG_MIXEDSCAN

Integer

Specifies if mixed text and image scanning is enabled.

Values for: TAG_MIXEDSCAN

0x0512 (1298)

TAG_MORE_SETTINGS

Integer

Indicates if the scanner driver has extended settings available in a secondary configuration window.

Values for: TAG_MORE_SETTINGS

0x1323 (4893)

TAG_NUMALLOWEDFORMATS

Integer

The number of allowed file formats.

Use this tag with TAG_ALLOWEDFORMATS to design an application that handles a particular subset of the available file formats.

0x090A (2314)

TAG_OPENATTRIBUTE

Integer

File open modes.

The value is a bitmask, so multiple values can be specified with the different bits.

Bit Values for: TAG_OPENATTRIBUTE

0x0112 (274)

TAG_ORIENTATION

Integer

The orientation of the image.

For the list of possible values, refer to ImGearIsisOrientation.

0x05A6 (1446)

TAG_OUTLINE

Integer

Specifies if outline scanning is enabled.

Values for: TAG_OUTLINE

0x1337 (4907)

TAG_OUTPUT_TAGS

Integer

A pointer to a structure that contains all of the settings specified by the user.

0x16E7 (5863)

TAG_OUTPUTAUTHOR

String

The author of the output document.

0X16E9 (5865)

TAG_OUTPUTCREATOR

String

The creator of the output document.

0x16EA (5866)

TAG_OUTPUTKEYWORDS

String

The keywords for the output document.

0x0680 (1664)

TAG_OUTPUTNAME

String

The name of the file to write.

0x16E8 (5864)

TAG_OUTPUTSUBJECT

String

The subject of the output document.

0x16E6 (5862)

TAG_OUTPUTTITLE

String

The title of the output document.

0x0696 (1686)

TAG_PAD16

Integer

Specifies whether an image is padded to a 16-bit word boundary when required for the file type.

Values for: TAG_PAD16

0x1007 (4103)

TAG_PAGENUMBER

Integer

The page number in the file at which to insert or overwrite pages when writing to the file.

0x050E (1294)

TAG_PAGESIZE

String

The page size, as a descriptive string. The available choices depend on the scanner.

This tag affects the values of several other tags and so should be set before all of these other tags:

• TAG_IMAGELENGTH

• TAG_IMAGEWIDTH

• TAG_XPOSITION

• TAG_XRESOLUTION

• TAG_YPOSITION

• TAG_YRESOLUTION

0x1336 (4906)

TAG_PHOTO_LBS

String

Enables you to retrieve the valid choices for the photometric interpretation for a list box control. It should be used in conjunction with TAG_BPS_LBS and TAG_SPP_LBS to give the user total control over color format. If separate control is not desired, you should use TAG_COLORFMTS_LBS instead.

The value of this tag has no specific meaning. You simply get the value in order to retrieve the list of available choices.

0x0106 (262)

TAG_PHOTOMETRICINTERPRETATION

Integer

The photometric interpretation to use in the image.

For the list of possible values, refer to ImGearIsisPhotometric.

0x1300 (4864)

TAG_PIXFPACK_CALLBACK

Integer

Used to create custom tags to be written into the image file.

0x1301 (4865)

TAG_PIXFPACK_CALLBACK_DATA

Integer

Contains the value to which to set the custom tag created by using TAG_PIXFPACK_CALLBACK.

0x1302 (4866)

TAG_PIXFPACK_IOFNS

Integer

A pointer to a structure containing replacement I/O functions for writing data.

0x1303 (4867)

TAG_PIXIF_IOFNS

Integer

A pointer to a structure containing replacement I/O functions for reading data.

0x057E (1406)

TAG_PIXMPAGE

Integer

A pointer to the next page to use.

0x011C (284)

TAG_PLANARCONFIGURATION

Integer

Describes how data in a color RGB image is arranged.

Values for: TAG_PLANARCONFIGURATION

0x050B (1291)

TAG_PLATENLENGTH

Integer

The maximum number of pixels that can be scanned from the scanner’s platen (flatbed) at the current resolution.

0x0516 (1302)

TAG_RESPONSECURVE

Integer

A mapping of image values.

Values for: TAG_RESPONSECURVE

0x0128 (296)

TAG_RESUNIT

Integer

The unit of measurement for image resolution.

The default value is 2.

Values for: TAG_RESUNIT

0x0116 (278)

TAG_ROWSPERSTRIP

Integer

The number of rows per strip in an image.

The default value is the maximum of 2^(32-1). That is, the entire image is one strip.

0x0695 (1685)

TAG_RUNSAFE

Integer

Specifies if ITU Group 4 compressed images are converted to raster images before converting them back into Group 3 compressed images. This is necessary because the intermediate run list used by Group 4 is not compatible with the run list required by Group 3.

Values for: TAG_RUNSAFE

0x0115 (277)

TAG_SAMPLESPERPIXEL

Integer

The number of samples per pixel to use in stored images.

The default value is 1.

0x050D (1293)

TAG_SCANAHEAD

Integer

Specifies if the ScanAhead feature of the scanner is enabled.

Values for: TAG_SCANAHEAD

0x057C (1404)

TAG_SCANAHEAD_MAXPAGES

Integer

The maximum number of pages to scan ahead.

A value of 0 means to scan until the feeder is empty. Some scanners only support a value of 0 because there is no way to tell the scanner how many pages to scan.

0x0515 (1301)

TAG_SCANAHEAD_PAGES

Integer

The number of pages that have been scanned ahead.

You can use this information to determine if all of the scanned pages have been successfully read (to be sure, for example, that no misfeed or paper jam occurred).

0x050A (1290)

TAG_SCANNERID

String

The unique scanner ID.

0x0113 (275)

TAG_SCANORIENTATION

Integer

The orientation of a page in the scanner’s feeder.

For the list of possible values, refer to ImGearIsisOrientation.

0x0514 (1300)

TAG_SCANTYPE

Integer

The scanning source.

Values for: TAG_SCANAHEAD

0x1335 (4905)

TAG_SPP_LBS

String

Enables you to retrieve the valid choices for the number of samples per pixel for a list box control. It should be used in conjunction with TAG_BPS_LBS and TAG_PHOTO_LBS to give the user total control over color format. If separate control is not desired, you should use TAG_COLORFMTS_LBS instead.

The value of this tag has no specific meaning. You simply get the value in order to retrieve the list of available choices.

0x0117 (279)

TAG_STRIPBYTECOUNTS

Integer

The number of bytes in a particular strip of a stripped image after compression (if any). This is a read-only tag.

The value is an array of integers, each representing the number of bytes in a particular strip. An image with PlanarConfiguration = 1 has one value for each strip. An image with PlanarConfiguration <> 1 has (SamplesPerPixel * StripsPerImage) values.

0x0111 (273)

TAG_STRIPOFFSETS

Integer

The byte offset of each strip of a stripped image.

The value is array of integers, each representing the byte offset from the beginning of the file. Note that this implies that each strip has a location independent of the location of other strips. An image with PlanarConfiguration = 1 has one value for each strip. An image with PlanarConfiguration <> 1 has (SamplesPerPixel * StripsPerImage) values.

This TIFF-required field is the only way for a reader to find the image data (unless the TIFF-specific tag TAG_TILEOFFSETS is used).

0x0517 (1303)

TAG_TRCMAP8

Integer

A mapping of 8-bit input levels to 8-bit output levels.

0x0700 (1792)

TAG_USERn

(where n is a number between 0 and 99, inclusive)

Driver-Defined

Custom tags specific to the driver.

0x011E (286)

TAG_XPOSITION

Rational

The distance in pixels from the left edge of the page to the start of the image.

0x011A (282)

TAG_XRESOLUTION

Rational

The number of pixels in each unit specified by TAG_RESUNIT when measured horizontally.

0x0513 (1299)

TAG_YIELDPROC

Integer

A pointer to a procedure to be called during printing.

0x011F (287)

TAG_YPOSITION

Rational

The distance in pixels from the top edge of the page to the start of the image.

0x011B (283)

TAG_YRESOLUTION

Rational

The number of pixels in each unit specified by TAG_RESUNIT when measured vertically.