visit Kofax web site

ACTIVESWLib Namespace Reference

Detailed Description

Library ACTIVESWLIB includes the ActiveX methods and properties.


Data Structures

interface  _ISPAcquireEvents
 Interface _ISPAcquireEvents. More...
interface  _ISPGuiAcquEvents
 Interface _ISPGuiAcquEvents. More...
interface  _ISPGuiContainerEvents
 Interface _ISPGuiContainerEvents. More...
interface  _ISPScannerEvents
 Interface _ISPScannerEvents. More...
interface  _ISPTabletEvents
 Interface _ISPTabletEvents. More...
interface  ISPAcquire
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPAcquireInterface ISPAcquire. More...
interface  ISPBackgroundObjects
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPBackgroundObjects. More...
interface  ISPCleanParameter
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPCleanParameterInterface ISPCleanParameter. More...
interface  ISPCompare
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPCompareInterface ISPCompare. More...
interface  ISPFlatFile
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPFlatFileInterface ISPFlatFile. More...
interface  ISPGuiAcqu
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPGuiAcquInterface ISPGuiAcqu. More...
interface  ISPGuiContainer
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPGuiContainerInterface ISPGuiContainer. More...
interface  ISPGuiDisp
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPGuiDispInterface ISPGuiDisp. More...
interface  ISPGuiDyn
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPGuiDynInterface ISPGuiDyn. More...
interface  ISPImage
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPImageInterface ISPImage. More...
interface  ISPPropertyMap
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPPropertyMapInterface ISPPropertyMap. More...
interface  ISPReference
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPReferenceInterface ISPReference. More...
interface  ISPScanner
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPScannerInterface ISPScanner. More...
interface  ISPScannerEnum
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPScannerEnumInterface ISPScannerEnum. More...
interface  ISPSignature
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPSignatureInterface ISPSignature. More...
interface  ISPSignware
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPSignwareInterface ISPSignware. More...
interface  ISPSmartCard
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPSmartcardInterface ISPSmartCard. More...
interface  ISPSmartCardDriver
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPSmartcardDriverInterface ISPSmartCardDriver. More...
interface  ISPTablet
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPTabletInterface ISPTablet. More...
interface  ISPTabletEnum
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPTabletEnumInterface ISPTabletEnum. More...
interface  ISPTeller
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPTellerInterface ISPTeller. More...
interface  ISPTellerImage
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPTellerImageInterface ISPTellerImage. More...
interface  ISPTemplate
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPTemplateInterface ISPTemplate. More...
interface  ISPTicket
 SignWare Dynamic Development toolkit, ActiveX wrapper for SPTicketInterface ISPTicket. More...
interface  ISPWeightedFrames
 SignWare Dynamic Development toolkit, container of weighted frames.Interface ISPWeightedFrames. More...
class  SPAcquire
 implements ISPAcquire More...
class  SPBackgroundObjects
 implements ISPBackgroundObjects More...
class  SPCleanParameter
 implements ISPCleanParameter More...
class  SPCompare
 implements ISPCompare More...
class  SPFlatFile
 implements ISPFlatFile More...
class  SPGuiAcqu
 implements ISPGuiAcqu More...
class  SPGuiContainer
 implements ISPGuiContainer More...
class  SPGuiDisp
 implements ISPGuiDisp More...
class  SPGuiDyn
 implements ISPGuiDyn More...
class  SPImage
 implements ISPImage More...
class  SPPropertyMap
 implements ISPPropertyMap More...
class  SPReference
 implements ISPReference More...
class  SPScanner
 implements ISPScanner More...
class  SPScannerEnum
 implements ISPScannerEnum More...
class  SPSignature
 implements ISPSignature More...
class  SPSignware
 implements ISPSignware More...
class  SPSmartCard
 implements ISPSmartCard More...
class  SPSmartCardDriver
 implements ISPSmartCardDriver More...
class  SPTablet
 implements ISPTablet More...
class  SPTabletEnum
 implements ISPTabletEnum More...
class  SPTeller
 implements ISPTeller More...
class  SPTellerImage
 implements ISPTellerImage More...
class  SPTemplate
 implements ISPTemplate More...
class  SPTicket
 implements ISPTicket More...
class  SPWeightedFrames
 implements ISPWeightedFrames More...

Enumerations

enum  SPAcquireDone { SPX_IDOK = 1, SPX_IDCANCEL = 2 }
 Constants in SPAcquire::AcquireDone, SPGuiAcqu::AcquireDone. More...
enum  SPCompareEngine { SPX_COMPARE_DSTAT_ENGINE = 1, SPX_COMPARE_DYNAMIC_ENGINE = 2, SPX_COMPARE_STATIC_ENGINE = 3 }
 Signware compare engines. More...
enum  SPCompareMode {
  SPX_COMPARE_STATIC = 1, SPX_COMPARE_DYNAMIC = 2, SPX_COMPARE_DESKEW = 4, SPX_COMPARE_NORMALIZE_SAMPLERATE = 8,
  SPX_COMPARE_MIRROR = 0x10, SPX_COMPARE_AUTOZOOM = 0x20, SPX_COMPARE_DSTAT = 0x40, SPX_COMPARE_AUTO_ENGINE = 0x80
}
 Compare modes. More...
enum  SPContainerLayout { SPX_GUICONTAINER_TILED_HORZ = 1, SPX_GUICONTAINER_TILED_VERT = 2, SPX_GUICONTAINER_STACKED = 3 }
enum  SPContainerObject { SPX_GUICONTAINER_GUIACQU = 1, SPX_GUICONTAINER_GUIDISP = 2, SPX_GUICONTAINER_GUIDYN = 3 }
enum  SPDynamicFormat {
  SPX_FF_ISO_MASK_SINGLE = 0x000000ff, SPX_FF_ISO_MASK_WRAPPER = 0x00000f00, SPX_FF_ISO_MASK_BDB = 0x0000f000, SPX_FF_ISO_MASK_DATA = 0x000f0000,
  SPX_FF_ISO_MASK_FLAGS = 0xfff00000, SPX_FF_SOFTPRO = 0, SPX_FF_ISO_19794_MINIMUM = 1, SPX_FF_ISO_19794_SIMPLE = 2,
  SPX_FF_ISO_19794_COMPLEX = 3, SPX_FF_ISO_19785_3_NONE = 0x00000000, SPX_FF_ISO_19785_3_FORMAT2 = 0x00000200, SPX_FF_ISO_19785_3_FORMAT3 = 0x00000300,
  SPX_FF_ISO_19785_3_FORMAT6 = 0x00000600, SPX_FF_ISO_19794_7_2007TC1 = 0x00001000, SPX_FF_ISO_19794_7_2014 = 0x00002000, SPX_FF_ISO_19794_7_FULL = 0x00000000,
  SPX_FF_ISO_FLAG_METERS = 0x00100000, SPX_FF_ISO_FLAG_NO_FIX = 0x00200000, SPX_FF_ISO_FLAG_COMPAT1 = 0x00400000, SPX_FF_ISO_FLAG_NO_EXT_DATA = 0x00800000
}
 Dynamic signature or reference formats. More...
enum  SPError {
  SPX_NOERR = 0, SPX_PARAMERR = -1, SPX_CLASSERR = -2, SPX_METHODERR = -3,
  SPX_FIELDERR = -4, SPX_UNSUPPORTEDERR = -5, SPX_MEMERR = -6, SPX_STATICERR = -7,
  SPX_INTERR = -8, SPX_CRYPTERR = -11, SPX_BUFFERERR = -14, SPX_CORRUPTEDDATAERR = -15,
  SPX_VERSIONERR = -16, SPX_OPENERR = -17, SPX_CREATEERR = -18, SPX_DIBERR = -20,
  SPX_COMMERR = -21, SPX_TWAINERR = -22, SPX_CANCELERR = -23, SPX_APPLERR = -24,
  SPX_BUSYERR = -25, SPX_FILEERR = -26, SPX_DYNAMICERR = -27, SPX_NOPADERR = -28,
  SPX_LINKLIBRARYERR = -29, SPX_OFFLINEERR = -31, SPX_SMARTCARDERR = -32, SPX_CHECKSUMERR = -33,
  SPX_LICENSEERR = -34, SPX_INVALIDERR = -35, SPX_IDENTICERR = -38, SPX_GRAPHICERR = -39,
  SPX_TIMEOUTERR = -40
}
 Error codes. More...
enum  SPImageType {
  SPX_IMAGE_BMP_WIN = 1, SPX_IMAGE_JPEG = 3, SPX_IMAGE_GIF = 4, SPX_IMAGE_CCITT4 = 5,
  SPX_IMAGE_TIFF = 6, SPX_IMAGE_PNG = 8, SPX_IMAGE_BLACKWHITE = 0x010000, SPX_IMAGE_CROSSED = 0x020000,
  SPX_IMAGE_ANTIALIAS = 0x040000, SPX_DONT_RENDER_METAFONT = 0x080000, SPX_DONT_RENDER_DIRECT = 0x100000, SPX_IMAGE_BLACKWHITE_1BPP = 0x200000,
  SPX_IMAGE_COLOR = 0x400000
}
enum  SPSignwareDefaults {
  SPX_MIN_STATIC_MATCH = 80, SPX_MIN_DYNAMIC_MATCH = 80, SPX_MIN_DSTAT_MATCH = 80, SPX_MIN_REF_QUALITY_STATIC = 35,
  SPX_MIN_REF_QUALITY_DYNAMIC = 60, SPX_VARIANCE_LIMIT = 80, SPX_NUMBER_OF_SIGNATURES_FOR_REFERENCE = 3
}
 Predefined Signware Constants. More...
enum  SPSignwareStatus { SPX_SDK_LOADED = 1, SPX_GRAPHICLIB_LOADED = 0x10, SPX_AWT_LOADED = 0x40 }
 Signware Status: loaded modules. More...
enum  SPTabletBackgroundImage { SPX_ACTIVE_IMAGE = 0, SPX_IDLE_IMAGE = 1, SPX_IMMEDIATE_IMAGE = 2 }
enum  SPTabletDevice { SPX_UNKNOWN_DEV = 0 }
enum  SPTabletDisplay { SPX_TABLET_NO_DISPLAY = 0, SPX_TABLET_LCD_DISPLAY = 1, SPX_TABLET_PC_DISPLAY = 2 }
enum  SPTabletDriver { SPX_UNKNOWN_DRV = 0, SPX_WINTAB_DRV = 1, SPX_TABLETSERVER_DRV = 5, SPX_REMOTETABLET_DRV = 6 }
enum  SPTabletPropertyDetail { SPX_TABLET_PHYSICAL = 1, SPX_TABLET_LOGICAL = 2 }
enum  SPTabletState { SPX_TABLET_STATE_IDLE = 0, SPX_TABLET_STATE_CONNECT = 1, SPX_TABLET_STATE_ACQUIRE = 2 }
enum  SPTabletType { SPX_TABLET_NO_REALTIME_VECTORS = 1, SPX_TABLET_HARDWARE_AS_VIRTUAL_BUTTONS = 2 }
enum  SPTicketAction {
  SPX_TICKET_LOAD_SIGNWARE = 1, SPX_TICKET_LOAD_STATIC = 2, SPX_TICKET_LOAD_DYNAMIC = 3, SPX_TICKET_COMPARE_STATIC = 5,
  SPX_TICKET_COMPARE_DYNAMIC = 6, SPX_TICKET_CLEAN = 7, SPX_TICKET_CAPTURE = 9, SPX_TICKET_RENDER = 10
}

Functions

 importlib ("stdole2.tlb")
 importlib ("stdole32.tlb")

Enumeration Type Documentation

enum ACTIVESWLib::SPAcquireDone
 

Constants in SPAcquire::AcquireDone, SPGuiAcqu::AcquireDone.

Since:
Version 3.1.1
See also:
ISPGuiAcqu::AcquireDone, ISPAcquire::AcquireDone
Enumerator:
SPX_IDOK  Constant for acquireDone Result OK.
SPX_IDCANCEL  Constant for acquireDone Result Cancel.

enum ACTIVESWLib::SPCompareEngine
 

Signware compare engines.

Since:
Version 3.2.1
See also:
ACTIVESWLib::ISPCompare::GetDetailResult, ACTIVESWLib::ISPCompare::GetNumResults, ACTIVESWLib::ISPCompare::SetMatchQualityEx, ACTIVESWLib::ISPCompare::GetMatchQualityEx
Enumerator:
SPX_COMPARE_DSTAT_ENGINE  Engine specifyer: use dstat (statistic) engine.
SPX_COMPARE_DYNAMIC_ENGINE  Engine specifyer: use dynamic (adsv) engine.
SPX_COMPARE_STATIC_ENGINE  Engine specifyer: use static (sival) engine.

enum ACTIVESWLib::SPCompareMode
 

Compare modes.

See also:
ISPCompare::SetMode, ISPCompare::GetMode
Since:
Version 3.1.1
Enumerator:
SPX_COMPARE_STATIC  Flag to include a static comparison.

The SPCompare-function will do a static comparison of the signature with all reference signatures, or the template.

SPX_COMPARE_DYNAMIC  Flag to include a dynamic comparison.

The SPCompare-function will do a dynamic comparison with the reference or the template.

SPX_COMPARE_DESKEW  Flag to deskew signature and reference / template.

The SPCompare-functions deskew signature and reference / template before calling a static comparison.
The flag is ignored, if SPX_COMPARESTATIC is not set.

SPX_COMPARE_NORMALIZE_SAMPLERATE  Flag to normalize the sample rate of signature and reference or template.

The SPCompare-functions normalize the tablet sample rate of signature and reference or template before calling a static comparison.
The flag is ignored, if SPX_COMPAREDYNAMIC is not set.

SPX_COMPARE_MIRROR  Flag to compare signatures and references / templates that are written from right to left.

Some nations write from right to left. This flag will optimize the static signature compare engine for signatures that were entered writing from left to right. The SPCompare-functions will mirror signature and reference / template before calling a static comparison.
The flag is ignored, if SPX_COMPARESTATIC is not set.

SPX_COMPARE_AUTOZOOM  Flag to size signature / reference images before calling the compare engines.
SPX_COMPARE_DSTAT  Flag to include a dstat (statistic) compare.

The SPCompare-function will do a dstat comparison with the reference.

SPX_COMPARE_AUTO_ENGINE  Flag to use all engines available for the according compare objects.

The compare functions will do a at least static comparison with the reference.
If signature and reference include dynamic data, and all signatures were captured on a device with equidistant sample rate and all signatures were captured on a device with more than 2 pressure levels then the compare functions will do a dynamic comparison.
If signature and reference include dynamic data, and one or more signatures were captured on a device with non equidistant sample rate or one or more signatures were captured on a device with 2 pressure levels then the compare functions will do a statistic comparison.

enum ACTIVESWLib::SPContainerLayout
 

SPGuiContainer layout identifyer

See also:
ISPGuiContainer::SetIntProperty, ISPGuiContainer::GetIntProperty, ISPGuiContainer::SetActive
Since:
Version 3.2
Enumerator:
SPX_GUICONTAINER_TILED_HORZ  Layout horizontally tiled
SPX_GUICONTAINER_TILED_VERT  Layout vertically tiled
SPX_GUICONTAINER_STACKED  Layout stacked

enum ACTIVESWLib::SPContainerObject
 

SPGuiContainer object identifyer

See also:
ISPGuiContainer::GetObject, ISPGuiContainer::AddObject, ISPGuiContainer::CreateObject
Since:
Version 3.2
Enumerator:
SPX_GUICONTAINER_GUIACQU  The Object is a ISPGuiAcqu instance
SPX_GUICONTAINER_GUIDISP  The Object is a ISPGuiDisp instance
SPX_GUICONTAINER_GUIDYN  The Object is a ISPGuiDyn instance

enum ACTIVESWLib::SPDynamicFormat
 

Dynamic signature or reference formats.

See also:
ISPFlateFile::CreateFromReference2, ISPFlateFile::CreateFromReference3, ISPFlateFile::CreateFromSignature2, ISPFlateFile::CreateFromSignature3
Since:
Version 3.1.1
Enumerator:
SPX_FF_ISO_MASK_SINGLE  Mask for flat file format: formats specified by a single value.
SPX_FF_ISO_MASK_WRAPPER  Mask for flat file format: CBEFF wrapper.
SPX_FF_ISO_MASK_BDB  Mask for flat file format: BDB format.
SPX_FF_ISO_MASK_DATA  Mask for flat file format: data format.
SPX_FF_ISO_MASK_FLAGS  Mask for flat file format: flags.
SPX_FF_SOFTPRO  Flat file format: SOFTPRO secure (encrypted) biometric signature / reference data.

This format can be used for signatures and references, not for templates.

See also:
SPX_FF_ISO_1794_MINIMUM, SPX_FF_ISO_19794_SIMPLE, SPX_FF_ISO_19794_COMPLEX
SPX_FF_ISO_19794_MINIMUM  Flat file format: ISO/IEC 19794-7:2007 (with Technical Corrigendum 1) full format biometric signature data (version 1) embedded in a CBEFF (ISO/IEC 19785-3:2015) structure having patron format type 2 ("minimum simple byte-oriented patron format").

This format can be used for signatures only, not for references and templates.

You can include flag SPX_FF_ISO_FLAG_METERS for using ISO/IEC 19794-7:2007 without Technical Corrigendum 1.

You can include flag SPX_FF_ISO_FLAG_COMPAT1 for bug compatibility with SignWare before version 3.2.9.0.

You can include flag SPX_FF_ISO_FLAG_NO_EXT_DATA to omit extended data.

This value is equivalent to (but does not have the same value as) 

 SPX_FF_ISO_19794_7_2007TC1 | SPX_FF_ISO_19794_7_FULL | SPX_FF_ISO_19785_3_FORMAT2

Note:
This format does not store the timestamp.
Deprecated:
Patron format type 2 has been deprecated in ISO/IEC 19785-3:2015, please use SPX_FF_ISO_19794_7_2014 with SPX_FF_ISO_19785_3_NONE.
See also:
SPX_FF_SOFTPRO, SPX_FF_ISO_19794_SIMPLE, SPX_FF_ISO_19794_COMPLEX
SPX_FF_ISO_19794_SIMPLE  Flat file format: ISO/IEC 19794-7:2007 (with Technical Corrigendum 1) full format biometric signature data (version 1) embedded in a CBEFF (ISO/IEC 19785-3:2015) structure having patron format type 3 ("maximum simple patron format (byte oriented) using presence bitmap").

This format can be used for signatures only, not for references and templates.

You can include flag SPX_FF_ISO_FLAG_METERS for using ISO/IEC 19794-7:2007 without Technical Corrigendum 1.

You can include flag SPX_FF_ISO_FLAG_COMPAT1 for bug compatibility with SignWare before version 3.2.9.0.

You can include flag SPX_FF_ISO_FLAG_NO_EXT_DATA to omit extended data.

This value is equivalent to (but does not have the same value as) 

 SPX_FF_ISO_19794_7_2007TC1 | SPX_FF_ISO_19794_7_FULL | SPX_FF_ISO_19785_3_FORMAT3

Deprecated:
Patron format type 3 has been deprecated in ISO/IEC 19785-3:2015, please use SPX_FF_ISO_19794_7_2014 with SPX_FF_ISO_19785_3_NONE.
See also:
SPX_FF_SOFTPRO, SPX_FF_ISO_19794_MINIMUM, SPX_FF_ISO_19794_COMPLEX
SPX_FF_ISO_19794_COMPLEX  Flat file format: ISO/IEC 19794-7:2007 (with Technical Corrigendum 1) full format biometric signature / reference data (version 1) embedded in a CBEFF (ISO/IEC 19785-3:2015) structure having patron format type 6 ("complex patron format").

This format can be used for signatures and references, not for templates.

You can include flag SPX_FF_ISO_FLAG_METERS for using ISO/IEC 19794-7:2007 without Technical Corrigendum 1.

You can include flag SPX_FF_ISO_FLAG_COMPAT1 for bug compatibility with SignWare before version 3.2.9.0.

You can include flag SPX_FF_ISO_FLAG_NO_EXT_DATA to omit extended data.

This value is equivalent to (but does not have the same value as) 

 SPX_FF_ISO_19794_7_2007TC1 | SPX_FF_ISO_19794_7_FULL | SPX_FF_ISO_19785_3_FORMAT6

Deprecated:
Patron format type 6 has been deprecated in ISO/IEC 19785-3:2015, please use SPX_FF_ISO_19794_7_2014 with SPX_FF_ISO_19785_3_NONE.
See also:
SPX_FF_SOFTPRO, SPX_FF_ISO_19794_MINIMUM, SPX_FF_ISO_19794_SIMPLE
SPX_FF_ISO_19785_3_NONE  Flat file format: No ISO/IEC 19785-3:2015 (CBEFF) wrapper.

This should be used with SPX_FF_ISO_19794_7_2014 (version 2) only as ISO/IEC 19794-7:2007 (version 1) requires a CBEFF wrapper. However, some products accept only unwrapped version 1 BDBs.

Note:
This is the default value for the CBEFF wrapper as the value of this constant is zero.

Compact format (not yet implemented) requires a CBEFF wrapper.

SPX_FF_ISO_19785_3_FORMAT2  Flat file format: Use ISO/IEC 19785-3:2015 patron format type 2 ("minimum simple byte-oriented patron format") CBEFF wrapper.

This can be used with SPX_FF_ISO_19794_7_2007TC1 or SPX_FF_ISO_19794_7_2014. With SPX_FF_ISO_19794_7_2007TC1, this patron format cannot be used for saving references.

Deprecated:
Patron format type 2 has been deprecated in ISO/IEC 19785-3:2015, please use SPX_FF_ISO_19794_7_2014 with SPX_FF_ISO_19785_3_NONE.
SPX_FF_ISO_19785_3_FORMAT3  Flat file format: Use ISO/IEC 19785-3:2015 patron format type 3 ("maximum simple patron format (byte oriented) using presence bitmap") CBEFF wrapper.

This can be used with SPX_FF_ISO_19794_7_2007TC1 or SPX_FF_ISO_19794_7_2014. With SPX_FF_ISO_19794_7_2007TC1, this patron format cannot be used for saving references.

Deprecated:
Patron format type 3 has been deprecated in ISO/IEC 19785-3:2015, please use SPX_FF_ISO_19794_7_2014 with SPX_FF_ISO_19785_3_NONE.
SPX_FF_ISO_19785_3_FORMAT6  Flat file format: Use ISO/IEC 19785-3:2015 patron format type 6 ("complex patron format") CBEFF wrapper.

This can be used with SPX_FF_ISO_19794_7_2007TC1 or SPX_FF_ISO_19794_7_2014. Both signatures and references can be saved with this patron format.

Deprecated:
Patron format type 6 has been deprecated in ISO/IEC 19785-3:2015, please use SPX_FF_ISO_19794_7_2014 with SPX_FF_ISO_19785_3_NONE.
SPX_FF_ISO_19794_7_2007TC1  Flat file format: ISO/IEC 19794-7:2007 (with Technical Corrigendum 1) Biometric Data Block (version 1).

Please also use SPX_FF_ISO_19785_3_FORMAT2, SPX_FF_ISO_19785_3_FORMAT3, or SPX_FF_ISO_19785_3_FORMAT6 to specify the ISO/IEC 19785-3 wrapper. Alternateively, use SPX_FF_ISO_19785_3_NONE (signature) to omit the CBEFF wrapper; the CBEFF wrapper is mandatory in ISO/IEC 19794-7:2007, but some products accept only unwrapped BDBs. SPX_FF_ISO_19785_3_FORMAT6 is required for saving references, signatures can be saved with any of these constants.

Please also use SPX_FF_ISO_19794_7_FULL (default) to select the data format.

You can include flag SPX_FF_ISO_FLAG_METERS for using ISO/IEC 19794-7:2007 without Technical Corrigendum 1.

You can include flag SPX_FF_ISO_FLAG_COMPAT1 for bug compatibility with SignWare before version 3.2.9.0.

You can include flag SPX_FF_ISO_FLAG_NO_EXT_DATA to omit extended data.

SPX_FF_ISO_19794_7_2014  Flat file format: ISO/IEC 19794-7:2014 Biometric Data Block (version 2).

Please also use SPX_FF_ISO_19785_3_NONE, SPX_FF_ISO_19785_3_FORMAT2, SPX_FF_ISO_19785_3_FORMAT3, or SPX_FF_ISO_19785_3_FORMAT6 to specify the ISO/IEC 19785-3 wrapper. Unlike ISO/IEC 19794-7:2007, ISO/IEC 19794-7:2014 allows BDBs without CBEFF wrapper. Both signatures and references can be saved with any of these constants.

Please also use SPX_FF_ISO_19794_7_FULL (default) to select the data format.

SPX_FF_ISO_19794_7_FULL  Flat file format: ISO/IEC 19794-7 full format.

To be used with either SPX_FF_ISO_19794_7_2007TC1 or SPX_FF_ISO_19794_7_2014.

Contrast with compact format, compression format, and XML, all of which are not yet supported.

Note:
This is the default value for the data format as the value of this constant is zero.
SPX_FF_ISO_FLAG_METERS  Flat file format flag: Use meters rather than millimeters for X and Y coordinates.

ISO-format signatures written by SignWare before version 3.2.9.0 use meters as units for the X and Y coordinates as specified by the original version of ISO/IEC 19794-7:2007. Technical Corrigendum for ISO/IEC 19794-7:2007 changed the units to millimeters.

Set this flag for compatibility with software that implements ISO/IEC 19794-7:2007 without Technical Corrigendum 1.

This flag takes effect only if the Biometric Data Block is in ISO/IEC 19794-7:2007 format (version 1).

For loading signatures or references written by SignWare before version 3.2.9.0, just leave SPX_FF_ISO_FLAG_NO_FIX unset rather than setting this flag.

For saving signatures or references to be read by SignWare before version 3.2.9.0, set SPX_FF_ISO_FLAG_COMPAT1 rather than this flag.

This flag is ignored for non-ISO formats.

See also:
SPX_FF_ISO_FLAG_COMPAT1, SPX_FF_ISO_FLAG_NO_FIX
SPX_FF_ISO_FLAG_NO_FIX  Flat file format flag: do not attempt to automatically fix ISO-format signatures that have been written by SignWare before version 3.2.9.0.

ISO-format signatures written by SignWare before version 3.2.9.0 have multiple issues:

  • the origin is in the upper left corner rather than in the lower left corner.
  • Technical Corrigendum 1 for ISO/IEC 19794-7:2007 is not implemented. In consequence, the X and Y scaling factors are based on meters rather than millimeters.
  • for CBEFF patron format type 6, garbage is written for bdbCreationDate if the signature does not have a timestamp.
  • the CBEFF wrapper does not use the correct BDB format type.
These bugs have been fixed in SignWare 3.2.9.0.

When loading a signature or reference, all of these issues will be fixed automatically if data written by SignWare before version 3.2.9.0 is detected, unless this flag (SPX_FF_ISO_FLAG_NO_FIX) is set.

If this flag is set, no attempt is made to fix the data. If the signature or reference was indeed written by SignWare before version 3.2.9.0, loading will fail or the data read will be incorrect.

When saving a signature or reference, this flag must not be set.

This flag is ignored for non-ISO formats.

See also:
SPX_FF_ISO_FLAG_COMPAT1, SPX_FF_ISO_FLAG_METERS
SPX_FF_ISO_FLAG_COMPAT1  Flat file format flag: write with bug compatibility with SignWare before version 3.2.9.0.

ISO-format signatures written by SignWare before version 3.2.9.0 have multiple issues:

  • the origin is in the upper left corner rather than in the lower left corner.
  • Technical Corrigendum 1 for ISO/IEC 19794-7:2007 is not implemented. In consequence, the X and Y scaling factors are based on meters rather than millimeters.
  • for CBEFF patron format type 6, garbage is written for bdbCreationDate if the signature does not have a timestamp.
  • the CBEFF wrapper does not use the correct BDB format type.
These bugs have been fixed in SignWare 3.2.9.0.

Use this flag for saving signatures in a format that is bug-compatible with old versions of SignWare (except for the bdbCreationDate bug). Extended data will be omitted (see SPX_FF_ISO_FLAG_NO_EXT_DATA).

When saving a signature or reference, this flag takes effect only if the Biometric Data Block is in ISO/IEC 19794-7:2007 format (version 1) with a patron format type 2, 3, or 6 CBEFF wrapper, that is, for formats SPX_FF_ISO_19794_MINIMUM, SPX_FF_ISO_19794_SIMPLE, SPX_FF_ISO_19794_COMPLEX, and SPX_FF_ISO_19794_7_2007TC1 (with SPX_FF_ISO_19785_3_FORMAT2, SPX_FF_ISO_19785_3_FORMAT3, or SPX_FF_ISO_19785_3_FORMAT6).

When loading a signature or reference, this flag must not be set.

This flag is ignored for non-ISO formats.

See also:
SPX_FF_ISO_FLAG_METERS, SPX_FF_ISO_FLAG_NO_FIX
SPX_FF_ISO_FLAG_NO_EXT_DATA  Flat file format flag: Omit or ignore extended data.

By default, extended data will be written that includes the following information:

  • a version number
  • the SPTablet device ID
  • the tablet serial ID
If this flag is set, extended data won't be added when saving a signature or reference and extended data will be ignored when loading a signature or reference.

This flag is ignored for non-ISO formats.

See also:
SPX_FF_ISO_FLAG_COMPAT1

enum ACTIVESWLib::SPError
 

Error codes.

Since:
Version 3.1.1
Enumerator:
SPX_NOERR  Error code: No error.

The function returned successfully.

SPX_PARAMERR  Error code: Parameter error.

An invalid parameter was passed, for instance:

  • a NULL pointer was passed where a NULL pointer is not allowed
  • a numeric argument is out of range
  • a pointer does not point to an objects of the correct type
  • an object is in a state not supporting the requested operation
  • a buffer length is too small
  • a specified file cannot be opened
SPX_CLASSERR  Error code: Java class error.

A java class is not accessible.

SPX_METHODERR  Error code: Java method error.

A java method is not accessible.

SPX_FIELDERR  Error code: Java field error.

A java field is not accessible.

SPX_UNSUPPORTEDERR  Error code: Unsupported device or state.

The operation could not access the requested device or an object is in a state not supporting the requested operation.

SPX_MEMERR  Error code: Out of memory.

The operation could not obtain the required amount of memory.

SPX_STATICERR  Error code: error in static engine.

The static engine returned an error. See the log file for details.

SPX_INTERR  Error code: Internal error.

An unspecified internal error (such as an unexpected exception) has occurred.

SPX_CRYPTERR  Error code: Encryption or decryption failed.

A flat file could not be encrypted or decrypted.

SPX_BUFFERERR  Error code: provided buffer is too small.

The buffer is too small to pass the data.

SPX_CORRUPTEDDATAERR  Error code: Provided data is corrupted.

The data is corrupted, e.g. header and body do not match.

SPX_VERSIONERR  Error code: Wrong Version.

A library was found, but it does not have the correct version.

SPX_OPENERR  Error code: Cannot open a file.

A file does not exist or is not accessible.

SPX_CREATEERR  Error code: Cannot create a file.

A file could not be created. Usually due to lack of disk space or missing access rights.

SPX_DIBERR  Error code: cannot process a bitmap file.

A DIB (device independant bitmap) operation failed

SPX_COMMERR  Error code: Cannot setup communication.

Cannot setup a communication to a server.

SPX_TWAINERR  Error code: An error occured while processing a scanner request.

Cannot process a scanner capture request.

SPX_CANCELERR  Error code: Aborted / cancelled by user.

The requested action was aborted or cancelled by user.

SPX_APPLERR  Error code: Application error.

The application may not call the function at this time.

SPX_BUSYERR  Error code: Busy error.

The requested resource or device is currently busy.

SPX_FILEERR  Error code: Unspecified file I/O error.

A file I/O operation failed. See the log file for details.

SPX_DYNAMICERR  Error code: Error in dynamic engine.

The dynamic engine returned an error. See the log file for details.

SPX_NOPADERR  Error code: Tablet not accessible.

The tablet not connected, not installed, or not accessible.

SPX_LINKLIBRARYERR  Error code: Library error.

Cannot load a library.

SPX_OFFLINEERR  A device is offline.
SPX_SMARTCARDERR  Error code: Smart card driver error.

Error when calling the smart card driver.

SPX_CHECKSUMERR  Error code: Smart card checksum error.

Error during smart card verify pin commands.

SPX_LICENSEERR  Error code: License error.

Missing license for a license-restricted operation. The license is missing, the allowed quota has been exceeded, a ticket has not been set (for the ticket license model), the license has expired, the license cannot be used on this machine, or there is a problem with license setup.

SPX_INVALIDERR  Error code: Invalid value or operation.
SPX_IDENTICERR  Error code: Attempt to compare identical signatures.
SPX_GRAPHICERR  Error code: Error in graphics engine.

An error occured in the graphics subsystem. See the log file for details.

SPX_TIMEOUTERR  Error code: a timeout occured.

enum ACTIVESWLib::SPImageType
 

Image formats and extensions

Since:
Version 3.1.1
Enumerator:
SPX_IMAGE_BMP_WIN  Image format windows bitmap.

See also:
ISPSignature::GetImage, ISPReference::GetImage, ISPFlatFile::CreateFromImage
SPX_IMAGE_JPEG  Image format jpeg.

Note:
JPEG might add artifacts in the image, it is not recommended for signature images
See also:
ISPSignature::GetImage, ISPReference::GetImage, ISPFlatFile::CreateFromImage
SPX_IMAGE_GIF  Image format gif.

See also:
ISPSignature::GetImage, ISPReference::GetImage, ISPFlatFile::CreateFromImage
SPX_IMAGE_CCITT4  Image format CCITT4.

Note:
CCITT4 is optimized for black white images
See also:
ISPSignature::GetImage, ISPReference::GetImage, ISPFlatFile::CreateFromImage
SPX_IMAGE_TIFF  Image format tiff.

See also:
ISPSignature::GetImage, ISPReference::GetImage, ISPFlatFile::CreateFromImage
SPX_IMAGE_PNG  Image format windows png.

See also:
ISPSignature::GetImage, ISPReference::GetImage, ISPFlatFile::CreateFromImage
SPX_IMAGE_BLACKWHITE  Image flag: create a black white image.

See also:
ISPSignature::GetImage, ISPReference::GetImage, ISPFlatFile::CreateFromImage
SPX_IMAGE_CROSSED  Image flag: draw a cross in the resulting image.

See also:
ISPSignature::GetImage, ISPReference::GetImage
SPX_IMAGE_ANTIALIAS 
SPX_DONT_RENDER_METAFONT  Image flag: don't use the metafont renderer, force using the simple renderer.

See also:
ISPSignature::GetImage, ISPReference::GetImage
SPX_DONT_RENDER_DIRECT  Image flag: don't use the simple renderer, force using the metafont renderer.

See also:
ISPSignature::GetImage, ISPReference::GetImage
SPX_IMAGE_BLACKWHITE_1BPP  Image flag: create a compressed image with 1 bit per pixel, implies SPX_IMAGE_BLACKWHITE.

See also:
ISPSignature::GetImage, ISPReference::GetImage, ISPFlatFile::CreateFromImage
SPX_IMAGE_COLOR  Image flag: create a color image.

See also:
ISPSignature::GetImage, ISPReference::GetImage, ISPFlatFile::CreateFromImage

enum ACTIVESWLib::SPSignwareDefaults
 

Predefined Signware Constants.

Since:
Version 3.1.1
Enumerator:
SPX_MIN_STATIC_MATCH  Defines the default minimum static match level for comparing signatures. valid values 0 - 100 A value of 0 means the signatures may be completly different. A value of 100 means that signatures have to be very similar.

See also:
ISPCompare::GetResult
SPX_MIN_DYNAMIC_MATCH  Defines the default minimum dynamic match level for comparing signatures. valid values 0 - 100 A value of 0 means the signatures may be completly different. A value of 100 means that signatures have to be very similar.

See also:
ISPCompare::GetResult
SPX_MIN_DSTAT_MATCH  Defines the default minimum dstat match level for comparing signatures. valid values 0 - 100 A value of 0 means the signatures may be completly different. A value of 100 means that signatures have to be very similar.

See also:
ISPCompare::GetResult
SPX_MIN_REF_QUALITY_STATIC  Defines the default minimum static quality required for reference signatures. valid values 0 - 100 A higher value means that the static quality/complexity of the reference must be better.

See also:
ISPSignature::Check
SPX_MIN_REF_QUALITY_DYNAMIC  Defines the default minimum dynamic quality required for reference signatures. valid values 0 - 100 A higher value means that the dynamic quality/complexity of the reference must be better.

See also:
ISPReference::Check
SPX_VARIANCE_LIMIT  Defines how the single signatures of a reference may differ to create a reference signature. valid values 0 - 100 A value of 0 means the single signatures may be completly different. A value of 100 means that all single signatures have to be very similar.

See also:
ISPReference::Check
SPX_NUMBER_OF_SIGNATURES_FOR_REFERENCE  Number of signatures used to create a reference.

A reference must contain at least this many signatures.

enum ACTIVESWLib::SPSignwareStatus
 

Signware Status: loaded modules.

See also:
ISPSignware::Status
Since:
Version 3.1.1
Enumerator:
SPX_SDK_LOADED  Loaded (myself) Library SDK.
SPX_GRAPHICLIB_LOADED  Loaded external image processing library.
SPX_AWT_LOADED  Loaded external library jawt (java awt access).

enum ACTIVESWLib::SPTabletBackgroundImage
 

SPTablet background image activation

Since:
Version 3.1.1
Enumerator:
SPX_ACTIVE_IMAGE  Image destination on the tablet: active image.

Note:
The active image is displayed while capturing a signature
See also:
ISPTablet::SetBackgroundImage2
SPX_IDLE_IMAGE  Image destination on the tablet: idle image.

Note:
The idle image is displayed after disconnecting a device.
Not all devices support idle images (currently only Wacom SIGNPAD)
See also:
ISPTablet::SetBackgroundImage2
SPX_IMMEDIATE_IMAGE  Image destination on the tablet: immediate image.

Note:
The immediate image is displayed immediately.
Not all devices support immediate images (currently only Wacom SIGNPAD)
See also:
ISPTablet::SetBackgroundImage2

enum ACTIVESWLib::SPTabletDevice
 

SPTablet devices

Since:
Version 3.1.1
Enumerator:
SPX_UNKNOWN_DEV  Unknown tablet device.

Identifier for an unknown tablet device

See also:
ISPTablet::GetDevice

enum ACTIVESWLib::SPTabletDisplay
 

SPTablet display types

Since:
Version 3.1.1
Enumerator:
SPX_TABLET_NO_DISPLAY  SPTablet display type of the connected tablet, the tablet has no display, e.g. Wacom Intuos.

See also:
ISPTablet::GetDisplayType
SPX_TABLET_LCD_DISPLAY  SPTablet display type of the connected tablet, the tablet has an integrated LCD display, e.g. Wacom Signpad (STU-500).

See also:
ISPTablet::GetDisplayType
SPX_TABLET_PC_DISPLAY  SPTablet display type of the connected tablet, the tablet is integrated into the PC's display, e.g. TabletPC.

See also:
ISPTablet::GetDisplayType

enum ACTIVESWLib::SPTabletDriver
 

SPTablet drivers

Since:
Version 3.1.1
Enumerator:
SPX_UNKNOWN_DRV  Unknown driver.

Identifier for an unknown tablet driver

See also:
ISPTablet::GetDriver
SPX_WINTAB_DRV  Wintab driver.

Identifier for a Wintab driver

See also:
ISPTablet::GetDriver
SPX_TABLETSERVER_DRV  Kofax TabletServer driver.

Identifier for a Kofax TabletServer driver

See also:
ISPTablet::GetDriver
SPX_REMOTETABLET_DRV  Kofax remote driver.

Identifier for a Kofax RemoteTablet driver

See also:
ISPTablet::GetDriver

enum ACTIVESWLib::SPTabletPropertyDetail
 

SPTablet tablet property detail

Since:
Version 3.2.2
Enumerator:
SPX_TABLET_PHYSICAL  Request a physical tablet property.

See also:
ISPTablet::GetResolution2, ISPTablet::GetSampleRate2
SPX_TABLET_LOGICAL  Request a logical tablet property.

See also:
ISPTablet::GetResolution2, ISPTablet::GetSampleRate2

enum ACTIVESWLib::SPTabletState
 

SPTablet states

Since:
Version 3.1.1
Enumerator:
SPX_TABLET_STATE_IDLE  Tablet state idle.

See also:
ISPTablet::GetState
SPX_TABLET_STATE_CONNECT  Tablet state connected.

See also:
ISPTablet::GetState, ISPTablet::Connect
SPX_TABLET_STATE_ACQUIRE  Tablet state acquiring.

See also:
ISPTablet::GetState, ISPTablet::Acquire

enum ACTIVESWLib::SPTabletType
 

SPTablet tablet types

Since:
Version 3.1.1
Enumerator:
SPX_TABLET_NO_REALTIME_VECTORS  The connected tablet cannot send signature strokes (vectors) in real time but rather sends all vectors in a block at the end of the capture process.

See also:
ISPTablet::GetTabletType
SPX_TABLET_HARDWARE_AS_VIRTUAL_BUTTONS  The connected tablet has builtin virtual buttons. A click on a virtual button is passed as a hardware button notification.

See also:
ISPTablet::GetTabletType

enum ACTIVESWLib::SPTicketAction
 

License manager ticket usage

Since:
Version 3.1.1
Enumerator:
SPX_TICKET_LOAD_SIGNWARE  License operation: load signware core modules.
SPX_TICKET_LOAD_STATIC  License operation: load static signature verification engine.
SPX_TICKET_LOAD_DYNAMIC  License operation: load dynamic signature verification engine.
SPX_TICKET_COMPARE_STATIC  License operation: static signature verification.
SPX_TICKET_COMPARE_DYNAMIC  License operation: dynamic signature verification.
SPX_TICKET_CLEAN  License operation: clean static images.
SPX_TICKET_CAPTURE  License operation: signature capture.
SPX_TICKET_RENDER  License operation: render a dynamic signature.

Function Documentation

ACTIVESWLib::importlib (  "stdole2.tlb"   ) 
 

ACTIVESWLib::importlib (  "stdole32.tlb"   )