visit Kofax web site
de.softpro.signware.SPScannerEnum

de.softpro.signware.SPScannerEnum Class Reference

Inheritance diagram for de.softpro.signware.SPScannerEnum:

de.softpro.signware.SPSignwareObject List of all members.

Detailed Description

Representation of a Signware scanner enumeration object.

The scanner enumeration contains a list of installed scanners

Note:
the SPScannerEnum is not serializable
Operating Systems:
Windows (Win32)


Public Member Functions

SPPropertyMap getDescriptor (int iIndex) throws SPSignwareException
 Query the descriptor of a scanner.
int getNumberScanners () throws SPSignwareException
 Query the number of scanner devices enumerated in this object.
 SPScannerEnum (java.lang.String strClassName) throws SPSignwareException
 Create a new scanner enum object.

Package Functions

final native int jniFree ()

Constructor & Destructor Documentation

de.softpro.signware.SPScannerEnum.SPScannerEnum (  java.lang.String  strClassName  )  throws SPSignwareException
 

Create a new scanner enum object.

Parameters:
strClassName [i] the class name for the enumeration. These classes are supported:
  • ScannerTwain enumerate twain scanners, only Windows
  • ScannerWIA enumerate WIA scannrs, only Windows
  • ScannerWIA2 enumerate WIA2 scannrs, only Windows, not yet implemented
  • ScannerSane enumerate Sane scannrs, only Linux, not yet implemented
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64)
See also:
SPScannerEnumCreate

Member Function Documentation

SPPropertyMap de.softpro.signware.SPScannerEnum.getDescriptor (  int  iIndex  )  throws SPSignwareException
 

Query the descriptor of a scanner.

The returned SPPropertyMap object contains these properties:

  • "DriverClassName" the driver class name ("ScannerTwain", "ScannerWIA", "ScannerWIA2" or "ScannerSane")
  • "DeviceDescription" the scanner description
  • "DeviceName" the scanner device name
  • "DeviceId" the scanner identifyer
  • "DriverName" the name of the driver ("Twain", "WIA", "WIA2" or "Sane")
  • "VendorName" the scanner vendor
Returns:
SPPropertyMap: the scanner descriptor
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64)

int de.softpro.signware.SPScannerEnum.getNumberScanners (   )  throws SPSignwareException
 

Query the number of scanner devices enumerated in this object.

Returns:
int: the number of scanners enumerated in this pSPSCANNERENUM_T object
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64)

final native int de.softpro.signware.SPScannerEnum.jniFree (   )  [package, virtual]
 

Implements de.softpro.signware.SPSignwareObject.

The documentation for this class was generated from the following file: