Common WIA Item Property Constants
The following device property constants must be supported by all IWiaItem, IWiaItem2 and IWiaDrvItem Interface interfaces unless otherwise noted in their descriptions.
The prefix "WIA_IPA_" indicates an item property for all devices and is the naming convention used in C/C++. For scripting purposes these constants use the prefix "Picture" and are part of the WiaItemPropertyId enumerated type. The corresponding member name from that script enumeration appears in parentheses next to the C/C++ constant name in the following list.
| Constant/value | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
This flag controls access to the item as well as whether the item is deleted. Required for all WIA 2.0 items. Type: VT_I4; Read/Write or Read Only, depending on the item's ability to have its access rights changed; Valid values: WIA_PROP_FLAG The following table has the five flags that are valid with this property.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
This property is reserved by for future use and is not implemented at this time. Type: VT_I4, Access: Read Only, Valid Values: WIA_PROP_NONE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contains the number of bits per channel for the image. The minidriver creates and maintains this property. Required for all WIA 2.0 acquisition-enabled or stored image items. Type: VT_I4, Access: Read Only, Valid Values: WIA_PROP_NONE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contains the size of the buffer, in bytes, used during a data transfer. The minidriver creates and maintains this property. An application can read this property to determine the driver-specified buffer size for data transfers. The WIA service also reads this property to allocate memory for the minidriver during the data transfer Optional for all transfer-enabled WIA 2.0 items. Type: VT_I4, Access: Read Only, Valid Values: WIA_PROP_NONE Note: |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contains the number of bytes in one scan line of the image. The minidriver creates and maintains this property. Optional for all WIA 2.0 items. Type: VT_I4, Access: Read Only, Valid Values: WIA_PROP_NONE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contains the number of channels per pixel for the image. The minidriver creates and maintains this property. Required for all WIA 2.0 acquisition-enabled or stored image items. Type: VT_I4, Access: Read Only, Valid Values: WIA_PROP_NONE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
This property is reserved by for future use and is not implemented at this time. Type: VT_I4, Access: Read Only, Valid Values: WIA_PROP_NONE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contains the current compression type used. The minidriver creates and maintains this property. An application reads this property to determine the image compression type or sets this property to configure the compression setting. Type: VT_I4, Access: Read/Write, Valid Values: WIA_PROP_LIST The following table has the constants that are valid with this property. The V symbol indicates that the constant is supported only in Windows Vista and later. (It is only available through the IWiaItem2 interface.)
[!Note] When this property is WIA_COMPRESSION_NONE, and WIA_IPA_FORMAT is either WiaImgFmt_PDFA or WiaImgFmt_XPS; then WIA_COMPRESSION_NONE means that the compression mode is undefined and the scanner must decide on a mode. WIA_COMPRESSION_AUTO is a new property value defined for the WIA_IPA_COMPRESSION property. This value is valid for all programmable image data source items, including the Flatbed and Feeder. When this value is supported by the WIA mini-driver, the WIA application client can set WIA_IPA_COMPRESSION in order to enable automatic compression mode detection at the device. WIA_COMPRESSION_AUTO can work with and without full auto-color being supported or enabled (WIA_DATA_AUTO and WIA_DEPTH_AUTO). WIA_COMPRESSION_AUTO is most useful with transfer file formats that support multiple data types and bit depths, such as WiaImgFmt_RAW. For more information about transfer file formats, see WIA_IPA_FORMAT in this table. It is opitonal for the WIA mini-driver to suport WIA_COMPRESSION_AUTO. When it is supported, the WIA mini-driver must never set it as the default value for WIA_IPA_COMPRESSION; only the WIA application can set this value. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contains the current data type setting for the device. The minidriver creates and maintains this property. An application reads this property to determine the data type of the image. An application writes this property to set the current data type of the image about to be transferred. This property is required for all WIA 2.0 items. It must be Read/Write for all WIA 2.0 acquisition enabled items and Read Only for WIA 2.0 storage items. Type: VT_I4; Access for pre-Windows Vista operating systems: This property is Read Only for cameras and Read/Write for scanners; Access for Windows Vista and later: This property is Read Only for WIA_CATEGORY_FOLDER and WIA_CATEGORY_FINISHED_FILE items, and Read/Write for all other WIA 2.0 item categories; Valid Values: WIA_PROP_LIST The following table has the six constants that are valid with when WIA_IPA_FORMAT is not set to WiaImgFmt_RAW.
The WIA_IPA_DATATYPE property is also used to describe the type of RAW data transfer to be used when the application sets WiaImgFmt_RAW. The driver should set the WIA_IPA_DATATYPE property to a list of allowed values from which the application can pick one. If the device can be set to only a single value, create a WIA_PROP_LIST type, and place the valid value in it. Check the WIA_IPA_DEPTH property to determine the bit depth. This property usually contains a single value for cameras. The following table lists the constants that are valid with WIA_IPA_DATATYPE when WIA_IPA_FORMAT is set to WiaImgFmt_RAW.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
WIA_IPA_DEPTH Contains the bit depth setting of an image. The minidriver creates and maintains this property.An application reads this property to determine the bit depth setting of the image. The application might also be able to set this value to the desired bit depth. If the device can be set to only a single value, create a WIA_PROP_LIST type and place the valid value in it. This property is required for all WIA 2.0 items. It must be Read/Write for all WIA 2.0 acquisition enabled items and Read Only for WIA 2.0 storage items. Type: VT_I4; Access for pre-Windows Vista operating systems: Read/Write; Access for Windows Vista and later: This property is Read Only for WIA_CATEGORY_FOLDER and WIA_CATEGORY_FINISHED_FILE items, and Read/Write for all other WIA 2.0 item categories; Valid Values: WIA_PROP_LIST WIA_DEPTH_AUTO is defined as 0 bits per pixel, and it is a new property value defined for the WIA_IPA_DEPTH. This value is valid for all programmable image data source items, including the Flatbed and Feeder. When WIA_DEPTH_AUTO is supported by the WIA mini-driver, the WIA application client can set WIA_IPA_DEPTH to this value, to enable automatic color detection at the device. When WIA_DEPTH_AUTO is set, the WIA mini-driver must update WIA_IPA_DATATYPE on the same item to WIA_DATA_AUTO (which must be a supported value, if the device supports automatic color). WIA_DEPTH_AUTO is an optional value, but it becomes required when WIA_DATA_AUTO is supported for WIA_IPA_DATATYPE. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contains the file name extension for a particular file format. The minidriver creates and maintains this property. Optional for all transfer-enabled WIA 2.0 items. Type: VT_BSTR, Access: Read Only, Valid Values: WIA_PROP_NONE The driver updates this property to reflect the current value of the WIA_IPA_FORMAT property. For example, if WIA_IPA_FORMAT is WiaImgFmt_JPEG, then WIA_IPA_FILENAME_EXTENSION should be jpg. If WIA_IPA_FORMAT is WiaImgFmt_BMP, then WIA_IPA_FILENAME_EXTENSION should be BMP. Note: This property is recommended for drivers that support standard formats and is required for drivers that implement custom-defined formats. It informs the application of the correct file name extension to use during the transfer of privately formatted files. For example, if the A. Datum Corporation created a WIA driver that transferred a file in a new format, the company could specify an extension of "adc". This allows applications to transfer data in that format to a file and to create a file name such as myfile.adc,which is useful to others who understand the new extension. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contains the current format of the image about to be transferred. An application reads this property to determine the format of the image that it is about to receive. An application writes this property to set the format. This property depends on the WIA_IPA_TYMED property. The minidriver creates and maintains this property. If the device can be set to only a single value, create a WIA_PROP_LIST type, and place the valid value in it. Type: CLSID, Access: Read/Write, Valid Values: WIA_PROP_LIST The following table lists the constants that are valid with this property. The asterisk * indicates that the constant is not supported in Windows Vista. (It is only available through the IWiaItem interface.) The double asterisk ** indicates that the constant is not supported in either Windows Server 2003 or Windows Vista. The V symbol indicates that the constant is supported only in Windows Vista and later. (It is only available through the IWiaItem2 interface.)
Note: |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contains the full item name (the item name together with path information). The full item name is the same as the bstrFullItemName parameter of the wiasCreateDrvItem service utility function. An application reads this property to determine which item it is currently using and where that item is located in the item tree. Each item should have a unique name. Applications commonly use the full item name to search for items in the item tree. The WIA service creates and maintains this property. Required for all WIA 2.0 items. Type: VT_BSTR, Access: Read Only, Valid values: WIA_PROP_NONE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
This property is reserved for future use and is not implemented at this time. Type: VT_I4, Access: Read Only, Valid Values: WIA_PROP_NONE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contains the ICM profile name that is needed to properly decode the image. An application reads this property to determine the ICM profile to use when processing the image. The WIA service creates and maintains this property based on the ICMProfiles entry in the driver installation file. Type: VT_BSTR, Access: Read Only, Valid Values: WIA_PROP_NONE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Supported only in Windows Vista and later. WIA 2.0 items are grouped into categories that define how a IWiaItem2 is to be treated or used. For example, If the item represents a feeder, then the application should expect it to contain the required document feeder properties and operate like a document feeder. If the item represents a finished file, then a WIA 2.0 application should treat it that way, assuming that the data is static and located on the device. (The rules for each item will be defined in their individual specification documents.) Required for all WIA 2.0 items. Type: VT_CLSID, Access: Read Only, Valid values: Item Category GUIDs |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contains the descriptive flags for a WIA item. The item flags are the same as those in the lObjectFlags parameter of the wiasCreateDrvItem service utility function. The WIA service creates and maintains this property. An application reads this property to determine the item's descriptive flag values. Type: VT_I4 Access: Read Only, Valid values: WIA_PROP_NONE The following table has the flags that are valid with this property. An asterisk * indicates that the flag is not supported in Windows Vista or later. (It is only available through the IWiaItem interface.) An double asterisk ** indicates that the flag is not supported in either Windows Server 2003 or Windows Vista or later. The V symbol indicates that the flag is supported only in Windows Vista and later. (It is only available through the IWiaItem2 interface.)
Some of these flags are required or optional for WIA 2.0 items, according to the category of the item, as shown in this table.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contains the item name. An application reads this property to determine which item it is currently using. Each item has a unique name. The WIA service creates and maintains this property. Required for all WIA 2.0 items. Type: VT_BSTR, Access: Read Only, Valid values: WIA_PROP_NONE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contains the current size, in bytes, of the data that is associated with the item. The minidriver creates and maintains this property. Contains is the total size of the data being transferred. If this value is zero, it means that the minidriver has no information about the exact size of the data. (This is common for compressed data.) An application reads this value to determine the size of the acquisition before it takes place. The WIA service reads this property to assist in allocating memory for data transfers. For further information, see Transferring Data to a WIA Application if the property is set to zero and TYMED is configured for a file transfer, the WIA service does not allocate any memory for the WIA minidriver. Required for all transfer-enabled WIA 2.0 items. Type: VT_I4, Access: Read Only, Valid Values: WIA_PROP_NONE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contains the time that the image was originally captured. The minidriver creates and maintains this property. This property should be reported as a vector of eight WORD values in the form of a SYSTEMTIME structure (described in the Platform SDK documentation). Optional for all WIA 2.0 items. Type: VT_UI2 | VT_VECTOR Access: Read/Write or Read Only, Valid values: WIA_PROP_NONE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Supported only in Windows Vista and later. Specifies how many items are stored in the WIA_CATEGORY_FOLDER item. Type: VT_I4, Access: Read/Write, Valid values: WIA_PROP_NONE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Specifies the minimum buffer size that is used in data transfers. If the data transfer is performed through a callback mechanism, the property value can be as small as 64KB. However, if the transfer is to file, the property value is the number of bytes that are needed to transfer one page of data at a time. The minidriver creates and maintains this WIA property. Optional for all transfer-enabled WIA 2.0 items. Type: VT_I4, Access: Read Only, Valid Values: WIA_PROP_NONE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contains the number of lines contained in the image (the vertical height of the image in pixels). The minidriver creates and maintains this property. Optional for all WIA 2.0 items. Type: VT_I4, Access: Read Only, Valid Values: WIA_PROP_NONE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contains the number of pixels in each line of the image (the width of the image in pixels). The minidriver creates and maintains this property. Optional for all WIA 2.0 items. Type: VT_I4, Access: Read Only, Valid Values: WIA_PROP_NONE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
This property is not supported in Windows Vista and later. Contains image data packing options. The minidriver creates and maintains this property. An application reads this property to determine the image packing options or sets the current image packing options. Type: VT_I4; Access: Read/Write; Valid Values: WIA_PROP_LIST. If the device can be set to only a single value, create a WIA_PROP_LIST type and place the valid value in it. The following table has the two constants that are valid with this property.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contains the preferred format for images that this minidriver transfers. The minidriver creates and maintains this property. Required for all transfer-enabled WIA 2.0 items. Type: CLSID, Access: Read Only, Valid Values: WIA_PROP_NONE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Specifies a CLSID that represents a set of device property values. If a device driver implements this feature, applications use this property to determine if the device supports a set of values. Type: CLSID, Access: Read Only, Valid Values: WIA_PROP_LIST The following table has the 12 constants that are valid with this property.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Supported only in Windows Vista and later. Contains the number of bits in each channel. This property should be reported as a vector of as many BYTE values as there are channels, where the first BYTE corresponds to the number of bits in the first channel, the second byte to the number of bits in the second channel and so on. There need to be as many entries as there are channels according to WIA_IPA_CHANNELS_PER_PIXEL. The driver sets that property when the application switches to WiaImgFmt_RAW. For the well-known subtypes, there are as many entries as listed in the table under WIA_IPA_RAW_SUBTYPE. Type: VT_UI1|VT_VECTOR, Access: Read Only, Valid values: WIA_PROP_NONE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
This property is reserved by for future use and is not implemented at this time. Type: VT_I4, Access: Read Only, Valid Values: WIA_PROP_NONE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Specifies whether to suppress the general property pages for items on the device. This property is available on Windows XP and later. Type: VT_I4, Access: Read Only, Valid Values: WIA_PROP_NONE The following table has the constants that are valid with this property. The asterisk * indicates that the constant is not valid with Windows Vista and later. (It is only available through the IWiaItem interface.)
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
This property contains the transfer method setting. The minidriver creates and maintains this property. An application reads this property to determine the minidriver's method of data transfer. Required for all transfer-enabled WIA 2.0 items. Type: VT_I4, Access: Read/Write, Valid Values: WIA_PROP_LIST The following table has the constants that are valid with this property. The asterisk * indicates constants that are not valid with Windows Vista and later. (They are only available through the IWiaItem interface.)
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Supported only in Windows Vista and later. Specifies the number of bytes to upload for an item. Type: VT_I4, Access: Read/Write, Valid values: WIA_PROP_NONE |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows Vista [desktop apps only] |
| Minimum supported server |
Windows Server 2008 [desktop apps only] |
| Header |
|