ACTIVESWLib::ISPReference Interface Reference

---

Detailed Description

SignWare Dynamic Development toolkit, ActiveX wrapper for SPReferenceInterface ISPReference.

A reference object is a collection of signature objects. Reference objects can be used to create a flat file to save a signature or reference signature to disk or data base, or to compare a refence signature against a signature, or to create a template object (compressed flat file format optimized for smartcards).

Public Member Functions
HRESULT	AddSignature ([in] ISPSignature *pSignature,[out, retval] long *result)
	Add a signature structure to a reference structure.
HRESULT	Check ([in] ISPPropertyMap *pParams,[out, retval] long *result)
	Check a Reference.
HRESULT	Clone ([out] ISPReference **ppReference,[out, retval] long *result)
	Create a new reference structure as a clone from pReference.
HRESULT	Create ([out, retval] long *result)
	Create a new (emty) reference structure.
HRESULT	CreateFromAcquire ([in] ISPAcquire *pSPAcquire,[out, retval] long *result)
	get the resulting reference data structure after acquiry
HRESULT	CreateFromFlatFile ([in] ISPFlatFile *pbFlatFile,[out, retval] long *result)
	Load a reference from a flat file.
HRESULT	CreateFromFlatFile3 ([in] ISPFlatFile *pbFlatFile,[in] long iFlags,[out, retval] long *result)
	Load a reference from a flat file.
HRESULT	CreateFromGuiAcqu ([in] ISPGuiAcqu *pSPGui,[out, retval] long *result)
	get the resulting reference data structure after acquiry
HRESULT	CreateFromTellerImage ([in] ISPTellerImage *pTellerImage,[out, retval] long *result)
	get the resulting reference data structure fram a TellerImage
HRESULT	GetDynamicQuality ([out] long *piResult,[out, retval] long *result)
	Get the Quality of the dynamic features of a reference.
HRESULT	GetImage ([in] double dZoom,[in] long iImageFormat,[in] long iIndex,[out] ISPFlatFile **ppImage,[out, retval] long *result)
	Convert a reference to a standard image file format.
HRESULT	GetImage2 ([in] double dZoom,[in] long iImageFormat,[in] long iIndex,[in] ISPTicket *pTicket,[out] ISPFlatFile **ppImage,[out, retval] long *result)
	Convert a reference to a standard image file format.
HRESULT	GetImageSize ([in] long iIndex,[out] long *piWidth,[out] long *piHeight,[out, retval] long *result)
	Query the image size of this reference object.
HRESULT	GetSignatureCount ([out] long *piNrSignatures,[out, retval] long *result)
	Get the number of signatures contained in a reference structure.
HRESULT	GetStaticQuality ([in] long iIndex,[out] long *piResult,[out, retval] long *result)
	Get the Quality of the static features of a signature.
HRESULT	GetVariance ([out] long *piVariance,[out, retval] long *result)
	Check the variance of a reference.
HRESULT	GetVarianceEx ([in] long iQuality,[out] long *piVariance,[out, retval] long *result)
	Check the variance of a reference.
HRESULT	MirrorY ([out, retval] long *result)
	Mirror a reference vertically.
Data Fields
const BSTR	SPX_REFERENCE_CHECK_SIGNATURES = L"SPReferenceCheckSignatures"
	Check all signatures included in a reference.
const BSTR	SPX_REFERENCE_MAX_DURATION = L"SPReferenceMaxDuration"
	Maximum duration to enter all signatures within a reference.
const BSTR	SPX_REFERENCE_MIN_DYNAMIC_QUALITY = L"SPReferenceMinDynamicQuality"
	Minimum dynamic quality of a reference.
const BSTR	SPX_REFERENCE_MIN_MATCH = "SPReferenceMinMatch"
	Variance of a reference.
const BSTR	SPX_REFERENCE_MIN_SIGNATURES = L"SPReferenceMinSignatures"
	Minimum number of signatures contained in a reference.

---

Member Function Documentation

HRESULT ACTIVESWLib::ISPReference::AddSignature (  [in] ISPSignature *  pSignature, [out, retval] long *  result )

Add a signature structure to a reference structure. Parameters: pSignature  [i] pointer to a valid pSPSIGNATURE_T structure result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_PARAMERR invalid parameter SPX_MEMERR out of memory Returns: Automation result, S_OK on success, else error code Note: It may become necessary to allocate a new memory block for the reference data. The parameter ppReference will in this case be overwritten and will point to the newly allocated memory block. The previous memory block will be freed. See also: SPReferenceCreate

HRESULT ACTIVESWLib::ISPReference::Check (  [in] ISPPropertyMap *  pParams, [out, retval] long *  result )

Check a Reference. Reference plausability check. A reference should have a min static and dynamic quality and a max variance. Parameters: pParams  [i] Parameters, may be null SP_REFERENCE_MIN_SIGNATURES minimum number of signatures in reference, int, set to 0 to skip the test, default SP_NUMBER_OF_SIGNATURES_FOR_REFERENCE SP_REFERENCE_MIN_DYNAMIC_QUALITY minimum dynamic quality, range 0 ... 100, int, set to 0 to skip the test, default SP_MIN_REF_QUALITY_DYNAMIC SP_REFERENCE_MIN_MATCH minimum signature match, range 0 ... 100, int, set to 0 to skip the test, default SP_VARIANCE_LIMIT SP_REFERENCE_MAX_DURATION maximum reference entry duration [seconds], int, set to 0 to skip the test, default 600 seconds [10 minutes] SP_REFERENCE_CHECK_SIGNATURES check all included signatures, range 0 or 1, int, set to 0 to skip the test, default 0 result  [io] Signware result SPX_NOERR success SPX_INVALIDERR check failed SPX_PARAMERR invalid parameter Returns: Automation result, S_OK on success, else error code See also: SPReferenceCheck

HRESULT ACTIVESWLib::ISPReference::Clone (  [out] ISPReference **  ppReference, [out, retval] long *  result )

Create a new reference structure as a clone from pReference. Parameters: ppReference  [o] pointer to a pSPREFERENCE_T variable, that will be filled with a valid pSPREFERENCE_T data structure result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_PARAMERR invalid parameter SPX_MEMERR no more memory Returns: Automation result, S_OK on success, else error code See also: SPReferenceFree

HRESULT ACTIVESWLib::ISPReference::Create (  [out, retval] long *  result  )

Create a new (emty) reference structure. Parameters: result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_PARAMERR invalid parameter SPX_MEMERR no more memory Returns: Automation result, S_OK on success, else error code See also: SPReferenceFree

HRESULT ACTIVESWLib::ISPReference::CreateFromAcquire (  [in] ISPAcquire *  pSPAcquire, [out, retval] long *  result )

get the resulting reference data structure after acquiry Parameters: pSPAcquire  [i] a pointer to a valid SPACQUIRE_T data structure result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_PARAMERR invalid parameter Returns: Automation result, S_OK on success, else error code Note: It is the applications responsabilty to free the returned reference. See also: SPReferenceFree

HRESULT ACTIVESWLib::ISPReference::CreateFromFlatFile (  [in] ISPFlatFile *  pbFlatFile, [out, retval] long *  result )

Load a reference from a flat file. This function deserializes an SPReference object serialized by ISPFlatFile::CreateFromReference. CreateFromFlatFile() is equivalent to CreateFromFlatFile3() with a value of zero for iFlags unless overridden by environment variable SIGNWARE_ISO_LOAD. The value of that environment variable is either a decimal number or a hexadecimal number (prefixed by "0x"). The number will be shifted left 20 bits, that is, the following values (and combinations thereof) are defined: 0x01 is equivalent to SPDynamicFormat::SPX_FF_ISO_FLAG_METERS 0x02 is equivalent to SPDynamicFormat::SPX_FF_ISO_FLAG_NO_FIX 0x08 is equivalent to SPDynamicFormat::SPX_FF_ISO_FLAG_NO_EXT_DATA Parameters: pbFlatFile  [i] pointer to an unsigned char array representing a signature as flat file result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_PARAMERR invalid parameter SPX_MEMERR no more memory Returns: Automation result, S_OK on success, else error code See also: CreateFromFlatFile3, SPReferenceCreateFromFlatFile

HRESULT ACTIVESWLib::ISPReference::CreateFromFlatFile3 (  [in] ISPFlatFile *  pbFlatFile, [in] long  iFlags, [out, retval] long *  result )

Load a reference from a flat file. This function deserializes an SPReference object serialized by ISPFlatFile::CreateFromReference. This function does not use environment variable SIGNWARE_ISO_LOAD. Parameters: pbFlatFile  [i] pointer to an unsigned char array representing a signature as flat file iFlags  [i] flags modifying the behavior of this function: SPDynamicFormat::SPX_FF_ISO_FLAG_METERS SPDynamicFormat::SPX_FF_ISO_FLAG_NO_FIX SPDynamicFormat::SPX_FF_ISO_FLAG_NO_EXT_DATA result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_PARAMERR invalid parameter SPX_MEMERR no more memory Returns: Automation result, S_OK on success, else error code See also: CreateFromFlatFile3, SPReferenceCreateFromFlatFile3

HRESULT ACTIVESWLib::ISPReference::CreateFromGuiAcqu (  [in] ISPGuiAcqu *  pSPGui, [out, retval] long *  result )

get the resulting reference data structure after acquiry Parameters: pSPGui  [i] a pointer to a valid SPGUIACQU_T data structure result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_PARAMERR invalid parameter Returns: Automation result, S_OK on success, else error code Note: It is the applications responsabilty to free the returned reference. See also: SPReferenceFree

HRESULT ACTIVESWLib::ISPReference::CreateFromTellerImage (  [in] ISPTellerImage *  pTellerImage, [out, retval] long *  result )

get the resulting reference data structure fram a TellerImage Parameters: pTellerImage  [i] a pointer to a valid SPTellerImage object result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK Returns: 0: success, else error code errors: SPX_PARAMERR invalid parameter Note: It is the applications responsabilty to free the returned reference. See also: SPReferenceFree

HRESULT ACTIVESWLib::ISPReference::GetDynamicQuality (  [out] long *  piResult, [out, retval] long *  result )

Get the Quality of the dynamic features of a reference. Parameters: piResult  [o] pointer to an int variable, that will be filled with the quality of the dynamic features (in %) result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_PARAMERR invalid parameter SPX_LINKLIBRARYERR cannot access static engine SPX_MEMERR out of memory SPX_DYNAMICERR error during processing Returns: Automation result, S_OK on success, else error code

HRESULT ACTIVESWLib::ISPReference::GetImage (  [in] double  dZoom, [in] long  iImageFormat, [in] long  iIndex, [out] ISPFlatFile **  ppImage, [out, retval] long *  result )

Convert a reference to a standard image file format. Parameters: dZoom  [i] magnification value of the resulting image iImageFormat  [i] desired format of the resulting image SPX_IMAGE_GIF SPX_IMAGE_CCITT4 SPX_IMAGE_TIFF SPX_IMAGE_BMP_WIN further options include SPX_IMAGE_BLACKWHITE, SPX_IMAGE_BLACKWHITE_1BPP and SPX_IMAGE_CROSSED iIndex  [i] 0-based index to the signature within the reference ppImage  [o] pointer to a variable that will be filled with the address of the data buffer result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_PARAMERR invalid parameter SPX_MEMERR out of memory Returns: Automation result, S_OK on success, else error code See also: SPReferenceGetImage

HRESULT ACTIVESWLib::ISPReference::GetImage2 (  [in] double  dZoom, [in] long  iImageFormat, [in] long  iIndex, [in] ISPTicket *  pTicket, [out] ISPFlatFile **  ppImage, [out, retval] long *  result )

Convert a reference to a standard image file format. Parameters: dZoom  [i] magnification value of the resulting image iImageFormat  [i] desired format of the resulting image SPX_IMAGE_GIF SPX_IMAGE_CCITT4 SPX_IMAGE_TIFF SPX_IMAGE_BMP_WIN further options include SPX_IMAGE_BLACKWHITE and SPX_IMAGE_CROSSED iIndex  [i] 0-based index to the signature within the reference pTicket  [i] pointer to a (SP_TICKET_RENDER) charged ticket object, ppImage  [o] pointer to a variable that will be filled with the address of the data buffer result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_PARAMERR invalid parameter SPX_MEMERR out of memory Returns: Automation result, S_OK on success, else error code See also: SPReferenceGetImage Deprecated: Use ACTIVESWLib::ISPSignware::SetTicket and ACTIVESWLib::ISPReference::GetImage instead

HRESULT ACTIVESWLib::ISPReference::GetImageSize (  [in] long  iIndex, [out] long *  piWidth, [out] long *  piHeight, [out, retval] long *  result )

Query the image size of this reference object. Parameters: iIndex  [i] 0-based index to the signature within the reference piWidth  [o] pointer to an integer that will be filled with the width of the image piHeight  [o] pointer to an integer that will be filled with the height of the image result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_PARAMERR invalid parameter Returns: Automation result, S_OK on success, else error code See also: SPReferenceGetImageSize

HRESULT ACTIVESWLib::ISPReference::GetSignatureCount (  [out] long *  piNrSignatures, [out, retval] long *  result )

Get the number of signatures contained in a reference structure. Parameters: piNrSignatures  [o] pointer to an SPINT32 that will be filled with the number of signatures within the reference structure result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_PARAMERR invalid parameter Returns: Automation result, S_OK on success, else error code See also: SPReferenceCreate, SPReferenceAddSignature

HRESULT ACTIVESWLib::ISPReference::GetStaticQuality (  [in] long  iIndex, [out] long *  piResult, [out, retval] long *  result )

Get the Quality of the static features of a signature. Parameters: iIndex  [i] Index of the signature to test piResult  [o] pointer to an int variable, that will be filled with the quality of the static features (in %) result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_PARAMERR invalid parameter SPX_LINKLIBRARYERR cannot access static engine SPX_MEMERR out of memory SPX_STATICERR error during processing Returns: Automation result, S_OK on success, else error code

HRESULT ACTIVESWLib::ISPReference::GetVariance (  [out] long *  piVariance, [out, retval] long *  result )

Check the variance of a reference. Parameters: piVariance  [o] pointer to an int variable, that will be filled with the variance of the signatures (1: OK (variance acceptable), 0: not OK (Variance too big)) result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_PARAMERR invalid parameter SPX_LINKLIBRARYERR cannot access static engine SPX_MEMERR out of memory SPX_DYNAMICERR error during processing SPX_STATICERR error during processing Returns: Automation result, S_OK on success, else error code See also: SPReferenceGetVarianceEx Note: SPReferenceGetVariance calls SPReferenceGetVarianceEx with iQuality set to 80.

HRESULT ACTIVESWLib::ISPReference::GetVarianceEx (  [in] long  iQuality, [out] long *  piVariance, [out, retval] long *  result )

Check the variance of a reference. Parameters: iQuality  [i] variance quality level, range 0 .. 100, typical 80 piVariance  [o] pointer to an int variable, that will be filled with the variance of the signatures (1: OK (variance acceptable), 0: not OK (Variance too big)) result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_PARAMERR invalid parameter SPX_LINKLIBRARYERR cannot access static engine SPX_MEMERR out of memory SPX_DYNAMICERR error during processing SPX_STATICERR error during processing Returns: Automation result, S_OK on success, else error code

HRESULT ACTIVESWLib::ISPReference::MirrorY (  [out, retval] long *  result  )

Mirror a reference vertically. The reference is mirrored such that for each signature the range of Y coordinates is not changed. Parameters: result  [io] pointer to a long that will be filled with the SDK result if the functions returns S_OK. Returns: 0: success, else error code errors: SPX_PARAMERR invalid parameter Since: Version 3.2.9.1

---

Field Documentation

const BSTR ACTIVESWLib::ISPReference::SPX_REFERENCE_CHECK_SIGNATURES = L"SPReferenceCheckSignatures"

Check all signatures included in a reference. See also: Check

const BSTR ACTIVESWLib::ISPReference::SPX_REFERENCE_MAX_DURATION = L"SPReferenceMaxDuration"

Maximum duration to enter all signatures within a reference. See also: Check

const BSTR ACTIVESWLib::ISPReference::SPX_REFERENCE_MIN_DYNAMIC_QUALITY = L"SPReferenceMinDynamicQuality"

Minimum dynamic quality of a reference. See also: Check

const BSTR ACTIVESWLib::ISPReference::SPX_REFERENCE_MIN_MATCH = "SPReferenceMinMatch"

Variance of a reference. See also: Check

const BSTR ACTIVESWLib::ISPReference::SPX_REFERENCE_MIN_SIGNATURES = L"SPReferenceMinSignatures"

Minimum number of signatures contained in a reference. See also: Check

---

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

• ActiveSW.idl