visit Kofax web site

de.softpro.signware.SPSmartcardDriver Class Reference

Inheritance diagram for de.softpro.signware.SPSmartcardDriver:

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

Detailed Description

Smartcard driver object.

Connect and access a smartcard reader.

Operating Systems:
Windows (Win32)


Public Member Functions

String getCompanyName () throws SPSignwareException
 Query the Company name of the driver.
String getDeviceName () throws SPSignwareException
 Query the Device name of the driver.
int getTerminal () throws SPSignwareException
 Query the terminal number of the reader.
 SPSmartcardDriver (Window compOwner) throws SPSignwareException
 Create an instance of a Smartcard reader.
 SPSmartcardDriver (int iIndex) throws SPSignwareException
 Create an instance of a Smartcard reader.
String toString ()
 Return the SmartcardDriver in String representation.

Static Public Member Functions

static int getNumberDrivers () throws SPSignwareException
 Query the total number of readers connected.
static void reset () throws SPSignwareException
 Reset all ctapi driver initialisation.

Package Functions

native int jniFree ()


Constructor & Destructor Documentation

de.softpro.signware.SPSmartcardDriver.SPSmartcardDriver int  iIndex  )  throws SPSignwareException
 

Create an instance of a Smartcard reader.

Call the dispose() method if the instance is no longer needed.

Parameters:
iIndex an Index to the enumerated list of the readers connected.
Exceptions:
SPSignwareException on error.
Operating Systems:
Windows (Win32)

de.softpro.signware.SPSmartcardDriver.SPSmartcardDriver Window  compOwner  )  throws SPSignwareException
 

Create an instance of a Smartcard reader.

The instanted object represents the reader at index 0, if one reader is connected. A popup dialog will be opened, if nore than one reader is connected.

Call the dispose() method if the instance is no longer needed.

Exceptions:
SPSignwareException on error.
Parameters:
compOwner the owner window of the created dialog.
Operating Systems:
Windows (Win32)


Member Function Documentation

String de.softpro.signware.SPSmartcardDriver.getCompanyName  )  throws SPSignwareException
 

Query the Company name of the driver.

Returns:
String name of the company as returned by the driver, or null for error
Exceptions:
SPSignwareException on error.
Operating Systems:
Windows (Win32)

String de.softpro.signware.SPSmartcardDriver.getDeviceName  )  throws SPSignwareException
 

Query the Device name of the driver.

Returns:
String name of the device as returned by the driver, or null for error
Exceptions:
SPSignwareException on error.
Operating Systems:
Windows (Win32)

static int de.softpro.signware.SPSmartcardDriver.getNumberDrivers  )  throws SPSignwareException [static]
 

Query the total number of readers connected.

Call the dispose() method if the instance is no longer needed.

Returns:
int Number of readers.
Exceptions:
SPSignwareException on error.
Operating Systems:
Windows (Win32)

int de.softpro.signware.SPSmartcardDriver.getTerminal  )  throws SPSignwareException
 

Query the terminal number of the reader.

Returns:
int terminal number, or -1 for error
Exceptions:
SPSignwareException on error.
Operating Systems:
Windows (Win32)

native int de.softpro.signware.SPSmartcardDriver.jniFree  )  [package, virtual]
 

Implements de.softpro.signware.SPSignwareObject.

static void de.softpro.signware.SPSmartcardDriver.reset  )  throws SPSignwareException [static]
 

Reset all ctapi driver initialisation.

You may not call this function if you have any SmartcardDriver or Smartcard objects instantiated, else calls to these objects will fail.

Note:
There should not be any reason why you should have to call this function unless you program a service that is started very early during windows boot time and you might have to try a few times until smartcard drivers are available.
Operating Systems:
Windows (Win32)
Exceptions:
SPSignwareException on error.

String de.softpro.signware.SPSmartcardDriver.toString  ) 
 

Return the SmartcardDriver in String representation.

The String is composed of Company name, device name and Terminal number as returned by the reders driver.

Exceptions:
SPSignwareException on error.
Operating Systems:
Windows (Win32)


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