visit Kofax web site

de.softpro.signware.SPSignwareException Class Reference

List of all members.

Detailed Description

This class includes Signware errors with an error description.

Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)


Public Member Functions

int getErrCode ()
 Query the error code.
String getMessage ()
 Query a String representation of the error code.
 SPSignwareException (int iErrCode)
 Instantiate a SPSignwareException.

Static Public Attributes

static final int SP_APPLERR = -24
 Application error.
static final int SP_BUSYERR = -25
 Busy error.
static final int SP_CANCELERR = -23
 Aborted / cancelled by user.
static final int SP_CHECKSUMERR = -33
 Smartcard checksum error.
static final int SP_CLASSERR = -2
 Class error.
static final int SP_COMMERR = -21
 Communication error.
static final int SP_CORRUPTEDDATAERR = -15
 Corrupted / broken data.
static final int SP_CREATEERR = -18
 File creation error.
static final int SP_CRYPTERR = -11
 En / Decryption error.
static final int SP_DIBERR = -20
 Bitmap creation error.
static final int SP_DYNAMICERR = -27
 Error in Dynamic engine.
static final int SP_FIELDERR = -4
 Field error.
static final int SP_FILEERR = -26
 File / data IO error.
static final int SP_IDENTICERR = -38
 Compare error, signature and reference are identical.
static final int SP_INTERR = -8
 Internal error.
static final int SP_INVALIDERR = -35
 invalid value
static final int SP_LICENSEERR = -34
 License error.
static final int SP_LINKLIBRARYERR = -29
 Library error.
static final int SP_MEMERR = -6
 Out of memory error.
static final int SP_METHODERR = -3
 Method error.
static final int SP_NOERR = 0
 No error.
static final int SP_NOPADERR = -28
 Tablet not accessible.
static final int SP_OFFLINEERR = -31
 A device is offline.
static final int SP_OPENERR = -17
 File open error.
static final int SP_PARAMERR = -1
 Parameter error.
static final int SP_SMARTCARDERR = -32
 Smartcard driver error.
static final int SP_STATICERR = -7
 error in static engine
static final int SP_TIMEOUTERR = -40
 Timeout error.
static final int SP_UNSUPPORTEDERR = -5
 Unsupported device error.
static final int SP_VERSIONERR = -16
 Wrong Version.


Constructor & Destructor Documentation

de.softpro.signware.SPSignwareException.SPSignwareException int  iErrCode  ) 
 

Instantiate a SPSignwareException.

Parameters:
iErrCode Error code for this exception


Member Function Documentation

int de.softpro.signware.SPSignwareException.getErrCode  ) 
 

Query the error code.

Returns:
int Error code

String de.softpro.signware.SPSignwareException.getMessage  ) 
 

Query a String representation of the error code.

Returns:
String Error code as String
Note:
the returned string is only available in english language. The method is intended to provide for a readable conversion of the error code during developement, please provide your own translation if required.


Member Data Documentation

final int de.softpro.signware.SPSignwareException.SP_APPLERR = -24 [static]
 

Application error.

Application may not call the function at this time

final int de.softpro.signware.SPSignwareException.SP_BUSYERR = -25 [static]
 

Busy error.

The requested resource / device is busy

final int de.softpro.signware.SPSignwareException.SP_CANCELERR = -23 [static]
 

Aborted / cancelled by user.

The requested action was aborted or cancelled by user

final int de.softpro.signware.SPSignwareException.SP_CHECKSUMERR = -33 [static]
 

Smartcard checksum error.

Error during smartcard verify pin commands

final int de.softpro.signware.SPSignwareException.SP_CLASSERR = -2 [static]
 

Class error.

A class is not accessible

final int de.softpro.signware.SPSignwareException.SP_COMMERR = -21 [static]
 

Communication error.

A communication link could not be created

final int de.softpro.signware.SPSignwareException.SP_CORRUPTEDDATAERR = -15 [static]
 

Corrupted / broken data.

Data is corrupted, does bot comply with the expected format

final int de.softpro.signware.SPSignwareException.SP_CREATEERR = -18 [static]
 

File creation error.

A file or data item could not be created

final int de.softpro.signware.SPSignwareException.SP_CRYPTERR = -11 [static]
 

En / Decryption error.

Cannot encrypt / decrypt

final int de.softpro.signware.SPSignwareException.SP_DIBERR = -20 [static]
 

Bitmap creation error.

A bitmap / image could not be created

final int de.softpro.signware.SPSignwareException.SP_DYNAMICERR = -27 [static]
 

Error in Dynamic engine.

Dynamic engine returned an error

final int de.softpro.signware.SPSignwareException.SP_FIELDERR = -4 [static]
 

Field error.

A field in a class is not accessible

final int de.softpro.signware.SPSignwareException.SP_FILEERR = -26 [static]
 

File / data IO error.

File or data IO error

final int de.softpro.signware.SPSignwareException.SP_IDENTICERR = -38 [static]
 

Compare error, signature and reference are identical.

final int de.softpro.signware.SPSignwareException.SP_INTERR = -8 [static]
 

Internal error.

An unspecified internal (e. g. exception) error has occurred

final int de.softpro.signware.SPSignwareException.SP_INVALIDERR = -35 [static]
 

invalid value

final int de.softpro.signware.SPSignwareException.SP_LICENSEERR = -34 [static]
 

License error.

final int de.softpro.signware.SPSignwareException.SP_LINKLIBRARYERR = -29 [static]
 

Library error.

Cannot load a library

final int de.softpro.signware.SPSignwareException.SP_MEMERR = -6 [static]
 

Out of memory error.

The operation could not access the required amount of memory

final int de.softpro.signware.SPSignwareException.SP_METHODERR = -3 [static]
 

Method error.

A method in a class is not accessible

final int de.softpro.signware.SPSignwareException.SP_NOERR = 0 [static]
 

No error.

The function returned successfully

final int de.softpro.signware.SPSignwareException.SP_NOPADERR = -28 [static]
 

Tablet not accessible.

Tablet not connected, or not installed, or not accessible

final int de.softpro.signware.SPSignwareException.SP_OFFLINEERR = -31 [static]
 

A device is offline.

final int de.softpro.signware.SPSignwareException.SP_OPENERR = -17 [static]
 

File open error.

A file or data item could not be opened

final int de.softpro.signware.SPSignwareException.SP_PARAMERR = -1 [static]
 

Parameter error.

An illegal parameter was passed

final int de.softpro.signware.SPSignwareException.SP_SMARTCARDERR = -32 [static]
 

Smartcard driver error.

Error when calling the smartcard driver

final int de.softpro.signware.SPSignwareException.SP_STATICERR = -7 [static]
 

error in static engine

The static engine returned an error

final int de.softpro.signware.SPSignwareException.SP_TIMEOUTERR = -40 [static]
 

Timeout error.

final int de.softpro.signware.SPSignwareException.SP_UNSUPPORTEDERR = -5 [static]
 

Unsupported device error.

The operation could not access the requested device

final int de.softpro.signware.SPSignwareException.SP_VERSIONERR = -16 [static]
 

Wrong Version.

A library was found with wrong version


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