Kodak Alaris Inc.

WIA Custom Properties

11-November-2013

 

 

Contents

  1. Overview
  2. Setting Shortcuts (KDS_IPS_PROFILES)

 

1. Overview

 

WIA allows for the driver to expose custom properties to enable advanced functionality. While there is no UI for Kodak Alaris Inc.’s WIA driver custom properties, they can be accessed programmatically.

 

 

2. Setting Shortcuts (KDS_IPS_PROFILES)

 

This property is available for all wia.dll version and starting with version 2.1 of the wiamini.dll. (see WIA Versions in the readme for more information on determining the WIA version)

 

This custom property allows WIA to use Setting Shortcuts (a collection of settings that allow the user to set/enable features of the scanner, similar to TWAIN’s Setting Shortcuts). This property contains a list of the shortcuts that were present when the WIA driver was started. If no shortcuts were present, then this property is not available.

 

The shortcuts are the same format as TWAIN’s (see Creating Setting Shortcuts below).

 

 

The property is defined as follows:

 

#define KDS_IPS_PROFILE             WIA_PRIVATE_ITEMPROP

#define KDS_IPS_PROFILE_STR         L"Profile"

 

            Kind:                            PRSPEC_PROPID

Property Type:              VT_BSTR
Valid Values:                 WIA_PROP_LIST
Access Rights:              READ/WRITE


This is an item property.

 

To use this property the application should read the valid values from it and user those values to set the property. We suggest displaying the list to the user and allow them to select the shortcut. Once a new shortcut is selected you must validate this property so the shortcut settings will be loaded into all the other WIA properties.

 

NOTE: The shortcuts may contain settings that are invalid in WIA. In this case, the WIA driver will override the shortcut setting with the last valid value it had for a property (e.g. front set to Color and rear set to Grayscale). Since this can cause unexpected behavior, it is recommended that shortcuts get created with one image per side and have the same settings for the front and rear.

 

2.1 Creating Setting Shortcuts

 

In order to add shortcut to the WIA driver they must first be created with that scanner’s Kodak Alaris Inc. TWAIN driver. You must use the TWAIN driver for the same model scanner that you want to use the WIA with. To do this, follow these steps:

 

For all wia.dll drivers and for 4.x wiamini.dll drivers:

1.     Open the TWAIN driver’s UI (e.g. use SVT)

2.     Create as many custom Setting Shortcuts as you like and then close the TWAIN application

3.     Power cycle the scanner so WIA will load the new shortcuts

 

For 2.1 and 3.x wiamini.dll WIA drivers:

4.     Open the TWAIN driver’s UI (e.g. use SVT)

5.     Create as many custom Setting Shortcuts as you like and then close the TWAIN application

6.     3The shortcuts will be contained with the twain directory of the scanner’s model directory (see Finding the scanner’s model directory in the readme)

7.     4Copy the entire profiles directory from the twain directory (e.g. C:\Document and Settings\All Users\Application Data\kds_kodak\kds_i1200\twain) to the scanner model’s wia directory (e.g. C:\Document and Settings\All Users\Application Data\kds_kodak\kds_i1200\wia); which will give you a profiles directory within the wia directory (e.g. C:\Document and Settings\All Users\Application Data\kds_kodak\kds_i1200\wia\profiles)
NOTE: create the wia folder it it does not exist

8.     Power cycle the scanner so WIA will load the new shortcuts