SPFlatFile.h File Reference

---

Detailed Description

SignWare Dynamic Development toolkit, SPFlatFile object.

Author:

uko

This header defines the SPFlatFile object.

SPFlatFile objects are serialized SPReference, SPTemplate or SPSignature objects. SPFlatFile objects include both static and dynamic signature features.

In contrast, SPBitmap objects (see SPBitmap.h) are serialized SPImage objects. SPBitmap objects include static image features, but no dynamic signature features.

Defines
#define	SP_FF_ISO_19794_COMPLEX   3
	Flat file format: ISO/IEC 19794-7 biometric signature / reference data embedded in a CBEFF structure according to clause 12 of ISO 19785-3 ("complex patron format").
#define	SP_FF_ISO_19794_MINIMUM   1
	Flat file format: ISO/IEC 19794-7 biometric signature data embedded in a CBEFF structure according to clause 8 of ISO 19785-3 ("minimum simple byte-oriented patron format").
#define	SP_FF_ISO_19794_SIMPLE   2
	Flat file format: ISO/IEC 19794-7 biometric signature data embedded in a CBEFF structure according to clause 9 of ISO 19785-3 ("fixed-length-fields, byte-oriented patron format using presence bitmap").
#define	SP_FF_SOFTPRO   0
	Flat file format: SOFTPRO secure (encrypted) biometric signature / reference data.
Functions
SPINT32 __cdecl	SPFlatFileCreateFromCleanParameter (SPUCHAR **ppbFlatFile, SPINT32 *piFlatFileLength, pSPCLEANPARAMETER_T pCleanParameter)
	Create a flat file object from an SPCleanParameter object.
SPINT32 __cdecl	SPFlatFileCreateFromPropertyMap (SPUCHAR **ppbFlatFile, SPINT32 *piFlatFileLength, pSPPROPERTYMAP_T pPropertyMap)
	Create a flat file object from an SPPropertyMap object.
SPINT32 __cdecl	SPFlatFileCreateFromReference (SPUCHAR **ppbFlatFile, SPINT32 *piFlatFileLength, pSPREFERENCE_T pReference)
	Create a flat file object in SP_FF_SOFTPRO format from a reference object.
SPINT32 __cdecl	SPFlatFileCreateFromReference2 (SPUCHAR **ppbFlatFile, SPINT32 *piFlatFileLength, pSPREFERENCE_T pReference, SPINT32 iFormat)
	Create a flat file object from a reference object.
SPINT32 __cdecl	SPFlatFileCreateFromSignature (SPUCHAR **ppbFlatFile, SPINT32 *piFlatFileLength, pSPSIGNATURE_T pSignature)
	Create a flat file object in SP_FF_SOFTPRO format from a signature object.
SPINT32 __cdecl	SPFlatFileCreateFromSignature2 (SPUCHAR **ppbFlatFile, SPINT32 *piFlatFileLength, pSPSIGNATURE_T pSignature, SPINT32 iFormat)
	Create a flat file object from a signature object.
SPINT32 __cdecl	SPFlatFileCreateFromTemplate (SPUCHAR **ppbFlatFile, SPINT32 *piFlatFileLength, pSPTEMPLATE_T pTemplate)
	Create a flat file object from a template object.
SPINT32 __cdecl	SPFlatFileCreateFromTicket (SPUCHAR **ppbFlatFile, SPINT32 *piFlatFileLength, pSPTICKET_T pTicket)
	Create a flat file object from an SPTicket object.
SPINT32 __cdecl	SPFlatFileFree (SPUCHAR **ppbFlatFile)
	Deallocate a flat file object.
SPINT32 __cdecl	SPFlatFileIsCleanParameterL (const SPUCHAR *pbFlatFile, SPINT32 iFlatFileLength)
	Check if a flat file object contains an SPCleanParameter object.
SPINT32 __cdecl	SPFlatFileIsPropertyMapL (const SPUCHAR *pbFlatFile, SPINT32 iFlatFileLength)
	Check if a flat file object contains an SPPropertyMap object.
SPINT32 __cdecl	SPFlatFileIsReference (const SPUCHAR *pbFlatFile)
	Check if a flat file object contains a reference.
SPINT32 __cdecl	SPFlatFileIsReferenceL (const SPUCHAR *pbFlatFile, SPINT32 iFlatFileLength)
	Check if a flat file object contains a reference.
SPINT32 __cdecl	SPFlatFileIsSignatureL (const SPUCHAR *pbFlatFile, SPINT32 iFlatFileLength)
	Check if a flat file object contains a signature.
SPINT32 __cdecl	SPFlatFileIsTemplate (const SPUCHAR *pbFlatFile)
	Check if a flat file object contains a template.
SPINT32 __cdecl	SPFlatFileIsTemplateL (const SPUCHAR *pbFlatFile, SPINT32 iFlatFileLength)
	Check if a flat file object contains a template.
SPINT32 __cdecl	SPFlatFileIsTicketL (const SPUCHAR *pbFlatFile, SPINT32 iFlatFileLength)
	Check if a flat file object contains a ticket.

---

Define Documentation

#define SP_FF_ISO_19794_COMPLEX   3

Flat file format: ISO/IEC 19794-7 biometric signature / reference data embedded in a CBEFF structure according to clause 12 of ISO 19785-3 ("complex patron format"). This format can be used for signatures and references, but not for templates. Note: It is recommended to use the SOFTPRO flat file format to save signatures and references and to convert to ISO/IEC 19794 format only when required as this format does not store the tablet ID and the tablet serial ID. See also: SPFlatFileCreateFromSignature2, SPFlatFileCreateFromReference2 SP_FF_SOFTPRO, SP_FF_ISO_19794_MINIMUM, SP_FF_ISO_19794_SIMPLE

#define SP_FF_ISO_19794_MINIMUM   1

Flat file format: ISO/IEC 19794-7 biometric signature data embedded in a CBEFF structure according to clause 8 of ISO 19785-3 ("minimum simple byte-oriented patron format"). This format can be used for signatures only, but not for references and templates. Note: It is recommended to use the SOFTPRO flat file format to save signatures and references and to convert to ISO/IEC 19794 format only when required as this format does not store the tablet ID, the tablet serial ID, and the timestamp. See also: SPFlatFileCreateFromSignature2 SP_FF_SOFTPRO, SP_FF_ISO_19794_SIMPLE, SP_FF_ISO_19794_COMPLEX

#define SP_FF_ISO_19794_SIMPLE   2

Flat file format: ISO/IEC 19794-7 biometric signature data embedded in a CBEFF structure according to clause 9 of ISO 19785-3 ("fixed-length-fields, byte-oriented patron format using presence bitmap"). This format can be used for signatures only, but not for references and templates. Note: It is recommended to use the SOFTPRO flat file format to save signatures and references and to convert to ISO/IEC 19794 format only when required as this format does not store the tablet ID and the tablet serial ID. See also: SPFlatFileCreateFromSignature2 SP_FF_SOFTPRO, SP_FF_ISO_19794_MINIMUM, SP_FF_ISO_19794_COMPLEX

#define SP_FF_SOFTPRO   0

Flat file format: SOFTPRO secure (encrypted) biometric signature / reference data. It is recommended to use the SOFTPRO flat file format to save signatures and references and to convert to ISO/IEC 19794 format only when required as the ISO formats don't store the tablet ID and the tablet serial ID. See also: SPFlatFileCreateFromSignature, SPFlatFileCreateFromSignature2, SPFlatFileCreateFromReference, SPFlatFileCreateFromReference2 SP_FF_ISO_19794_MINIMUM, SP_FF_ISO_19794_SIMPLE, SP_FF_ISO_19794_COMPLEX

---

Function Documentation

SPINT32 __cdecl SPFlatFileCreateFromCleanParameter (  SPUCHAR **  ppbFlatFile, SPINT32 *  piFlatFileLength, pSPCLEANPARAMETER_T  pCleanParameter )

Create a flat file object from an SPCleanParameter object. Parameters: ppbFlatFile  [o] pointer to a variable that will be filled with a pointer to an array of bytes containing the flat file object. The caller is responsible for deallocating that array of bytes by calling SPFlatFileFree. piFlatFileLength  [o] pointer to a variable that will be filled with the length (in bytes) of the flat file object returned via ppbFlatFile. pCleanParameter  [i] pointer to an SPCleanCarameter object. Returns: SP_NOERR on success, else error code: SP_MEMERR out of memory Operating Systems: Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a) See also: SPFlatFileFree, SPFlatFileIsCleanParameterL, SPCleanParameterCreateFromFlatFile, SPCleanParameterWrite

SPINT32 __cdecl SPFlatFileCreateFromPropertyMap (  SPUCHAR **  ppbFlatFile, SPINT32 *  piFlatFileLength, pSPPROPERTYMAP_T  pPropertyMap )

Create a flat file object from an SPPropertyMap object. Parameters: ppbFlatFile  [o] pointer to a variable that will be filled with a pointer to an array of bytes containing the flat file object. The caller is responsible for deallocating that array of bytes by calling SPFlatFileFree. piFlatFileLength  [o] pointer to a variable that will be filled with the length (in bytes) of the flat file object returned via ppbFlatFile. pPropertyMap  [i] pointer to an SPPropertyMap object. Returns: SP_NOERR on success, else error code: SP_MEMERR out of memory Operating Systems: Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64) See also: SPFlatFileFree, SPFlatFileIsPropertyMapL, SPPropertyMapCreateFromFlatFile, SPPropertyMapWrite

SPINT32 __cdecl SPFlatFileCreateFromReference (  SPUCHAR **  ppbFlatFile, SPINT32 *  piFlatFileLength, pSPREFERENCE_T  pReference )

Create a flat file object in SP_FF_SOFTPRO format from a reference object. This function uses flat file format SP_FF_SOFTPRO. Parameters: ppbFlatFile  [o] pointer to a variable that will be filled with a pointer to an array of bytes containing the flat file object. The caller is responsible for deallocating that array of bytes by calling SPFlatFileFree. piFlatFileLength  [o] pointer to a variable that will be filled with the length (in bytes) of the flat file object returned via ppbFlatFile. pReference  [i] pointer to an SPReference object. Returns: SP_NOERR on success, else error code: SP_PARAMERR invalid parameter SP_MEMERR out of memory Operating Systems: Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64) See also: SPFlatFileFree, SPFlatFileCreateFromReference2, SPFlatFileCreateFromSignature, SPFlatFileIsReferenceL, SPReferenceCreateFromFlatFile SP_FF_SOFTPRO

SPINT32 __cdecl SPFlatFileCreateFromReference2 (  SPUCHAR **  ppbFlatFile, SPINT32 *  piFlatFileLength, pSPREFERENCE_T  pReference, SPINT32  iFormat )

Create a flat file object from a reference object. Parameters: ppbFlatFile  [o] pointer to a variable that will be filled with a pointer to an array of bytes containing the flat file object. The caller is responsible for deallocating that array of bytes by calling SPFlatFileFree. piFlatFileLength  [o] pointer to a variable that will be filled with the length (in bytes) of the flat file object returned via ppbFlatFile. pReference  [i] pointer to an SPReference object. iFormat  [i] desired format of the flat file object to be created: SP_FF_ISO_19794_COMPLEX ISO/IEC 19794-7 biometric interchange data format SP_FF_SOFTPRO secure (encrypted) biometric reference data format Returns: SP_NOERR on success, else error code: SP_PARAMERR invalid parameter SP_MEMERR out of memory Operating Systems: Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64) See also: SPFlatFileFree, SPFlatFileCreateFromReference, SPFlatFileCreateFromSignature2, SPFlatFileIsReferenceL, SPReferenceCreateFromFlatFile SP_FF_SOFTPRO, SP_FF_ISO_19794_COMPLEX

SPINT32 __cdecl SPFlatFileCreateFromSignature (  SPUCHAR **  ppbFlatFile, SPINT32 *  piFlatFileLength, pSPSIGNATURE_T  pSignature )

Create a flat file object in SP_FF_SOFTPRO format from a signature object. This function uses flat file format SP_FF_SOFTPRO. Parameters: ppbFlatFile  [o] pointer to a variable that will be filled with a pointer to an array of bytes containing the flat file object. The caller is responsible for deallocating that array of bytes by calling SPFlatFileFree. piFlatFileLength  [o] pointer to a variable that will be filled with the length (in bytes) of the flat file object returned via ppbFlatFile. pSignature  [i] pointer to an SPSignature object. Returns: SP_NOERR on success, else error code: SP_PARAMERR invalid parameter SP_MEMERR out of memory Operating Systems: Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64) See also: SPFlatFileFree, SPFlatFileCreateFromSignature2, SPFlatFileCreateFromReference, SPFlatFileIsSignatureL, SPSignatureCreateFromFlatFile SP_FF_SOFTPRO

SPINT32 __cdecl SPFlatFileCreateFromSignature2 (  SPUCHAR **  ppbFlatFile, SPINT32 *  piFlatFileLength, pSPSIGNATURE_T  pSignature, SPINT32  iFormat )

Create a flat file object from a signature object. Parameters: ppbFlatFile  [o] pointer to a variable that will be filled with a pointer to an array of bytes containing the flat file object. The caller is responsible for deallocating that array of bytes by calling SPFlatFileFree. piFlatFileLength  [o] pointer to a variable that will be filled with the length (in bytes) of the flat file object returned via ppbFlatFile. pSignature  [i] pointer to an SPSignature object. iFormat  [i] desired format of the flat file object to be created: SP_FF_ISO_19794_MINIMUM ISO/IEC 19794-7 biometric interchange data format SP_FF_ISO_19794_SIMPLE ISO/IEC 19794-7 biometric interchange data format SP_FF_ISO_19794_COMPLEX ISO/IEC 19794-7 biometric interchange data format SP_FF_SOFTPRO secure (encrypted) biometric reference data format Returns: SP_NOERR on success, else error code: SP_PARAMERR invalid parameter SP_MEMERR out of memory Operating Systems: Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64) See also: SPFlatFileFree, SPFlatFileCreateFromSignature, SPFlatFileCreateFromReference2, SPFlatFileIsSignatureL, SPSignatureCreateFromFlatFile SP_FF_SOFTPRO, SP_FF_ISO_19794_MINIMUM, SP_FF_ISO_19794_SIMPLE, SP_FF_ISO_19794_COMPLEX

SPINT32 __cdecl SPFlatFileCreateFromTemplate (  SPUCHAR **  ppbFlatFile, SPINT32 *  piFlatFileLength, pSPTEMPLATE_T  pTemplate )

Create a flat file object from a template object. Parameters: ppbFlatFile  [o] pointer to a variable that will be filled with a pointer to an array of bytes containing the flat file object. The caller is responsible for deallocating that array of bytes by calling SPFlatFileFree. piFlatFileLength  [o] pointer to a variable that will be filled with the length (in bytes) of the flat file object returned via ppbFlatFile. pTemplate  [i] pointer to an SPTemplate object. Returns: SP_NOERR on success, else error code: SP_PARAMERR invalid parameter SP_MEMERR out of memory Operating Systems: Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64) See also: SPFlatFileFree, SPFlatFileCreateFromReference, SPFlatFileCreateFromSignature, SPFlatFileIsTemplateL, SPTemplateCreateFromFlatFile

SPINT32 __cdecl SPFlatFileCreateFromTicket (  SPUCHAR **  ppbFlatFile, SPINT32 *  piFlatFileLength, pSPTICKET_T  pTicket )

Create a flat file object from an SPTicket object. Deprecated: Please use a license key. Parameters: ppbFlatFile  [o] pointer to a variable that will be filled with a pointer to an array of bytes containing the flat file object. The caller is responsible for deallocating that array of bytes by calling SPFlatFileFree. piFlatFileLength  [o] pointer to a variable that will be filled with the length (in bytes) of the flat file object returned via ppbFlatFile. pTicket  [i] pointer to an SPTicket object. Returns: SP_NOERR on sucess, else error code: SP_LICENSEERR no license available SP_MEMERR out of memory SP_INTERR an internal error occured SP_PARAMERR invalid parameter Operating Systems: Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a) See also: SPFlatFileFree, SPFlatFileIsTicketL, SPTicketCreateFromFlatFile

SPINT32 __cdecl SPFlatFileFree (  SPUCHAR **  ppbFlatFile  )

Deallocate a flat file object. The flat file object must have been created by SPFlatFileCreateFromReference, SPFlatFileCreateFromReference2, SPFlatFileCreateFromSignature, SPFlatFileCreateFromSignature2, SPFlatFileCreateFromTemplate, SPFlatFileCreateFromTicket, or SPFlatFileCreateFromCleanParameter. Parameters: ppbFlatFile  [io] pointer to a variable containing a pointer to an array of bytes containing a flat file. The variable will be set to NULL if this function succeeds. Returns: SP_NOERR on success, else error code: SP_PARAMERR invalid parameter Operating Systems: Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPFlatFileIsCleanParameterL (  const SPUCHAR *  pbFlatFile, SPINT32  iFlatFileLength )

Check if a flat file object contains an SPCleanParameter object. Parameters: pbFlatFile  [i] pointer to a flat file object. iFlatFileLength  [i] length (in bytes) of the flat file object pointed to by pbFlatFile. Returns: 0: the flat file object data does not contain an SPCleanParameter object 1: the flat file object contains an SPCleanParameter object Operating Systems: Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a) See also: SPFlatFileCreateFromCleanParameter, SPFlatFileIsReferenceL, SPFlatFileIsSignatureL, SPFlatFileIsTemplateL, SPFlatFileIsTicketL

SPINT32 __cdecl SPFlatFileIsPropertyMapL (  const SPUCHAR *  pbFlatFile, SPINT32  iFlatFileLength )

Check if a flat file object contains an SPPropertyMap object. Parameters: pbFlatFile  [i] pointer to a flat file object. iFlatFileLength  [i] length (in bytes) of the flat file object pointed to by pbFlatFile. Returns: 0: the flat file object data does not contain an SPPropertyMap object 1: the flat file object contains an SPPropertyMap object Operating Systems: Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64) See also: SPFlatFileCreateFromPropertyMap, SPFlatFileIsReferenceL, SPFlatFileIsSignatureL, SPFlatFileIsTemplateL, SPFlatFileIsTicketL

SPINT32 __cdecl SPFlatFileIsReference (  const SPUCHAR *  pbFlatFile  )

Check if a flat file object contains a reference. Parameters: pbFlatFile  [i] pointer to a flat file object. Returns: 0: the flat file object does not contain a reference 1: the flat file object contains a reference Deprecated: Replaced by SPFlatFileIsReferenceL. Operating Systems: Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPFlatFileIsReferenceL (  const SPUCHAR *  pbFlatFile, SPINT32  iFlatFileLength )

Check if a flat file object contains a reference. Note: Prior versions did not differentiate between references and signatures. The value 1 may therefore be returned even if the flat file object contains a signature. Parameters: pbFlatFile  [i] pointer to a flat file object. iFlatFileLength  [i] length (in bytes) of the flat file object pointed to by pbFlatFile. Returns: 0: the flat file object does not contain a reference 1: the flat file object contains a reference Operating Systems: Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64) See also: SPFlatFileCreateFromReference, SPFlatFileIsCleanParameterL, SPFlatFileIsSignatureL, SPFlatFileIsTemplateL, SPFlatFileIsTicketL

SPINT32 __cdecl SPFlatFileIsSignatureL (  const SPUCHAR *  pbFlatFile, SPINT32  iFlatFileLength )

Check if a flat file object contains a signature. This function is quite expensive as the flat file object must be unpacked to check the signature object integrity. Parameters: pbFlatFile  [i] pointer to a flat file object. iFlatFileLength  [i] length (in bytes) of the flat file object pointed to by pbFlatFile. Returns: 0: the flat file object does not contain a signature 1: the flat file object contains a signature Operating Systems: Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64) See also: SPFlatFileCreateFromSignature, SPFlatFileIsCleanParameterL, SPFlatFileIsReferenceL, SPFlatFileIsTemplateL, SPFlatFileIsTicketL

SPINT32 __cdecl SPFlatFileIsTemplate (  const SPUCHAR *  pbFlatFile  )

Check if a flat file object contains a template. Parameters: pbFlatFile  [i] pointer to a flat file object. Returns: 0: the flat file object does not contain a template 1: the flat file object contains a template Deprecated: Replaced by SPFlatFileIsTemplateL. Operating Systems: Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPFlatFileIsTemplateL (  const SPUCHAR *  pbFlatFile, SPINT32  iFlatFileLength )

Check if a flat file object contains a template. Parameters: pbFlatFile  [i] pointer to a flat file object. iFlatFileLength  [i] length (in bytes) of the flat file object pointed to by pbFlatFile. Returns: 0: the flat file object does not contain a template 1: the flat file object contains a template Operating Systems: Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64) See also: SPFlatFileCreateFromTemplate, SPFlatFileIsCleanParameterL, SPFlatFileIsReferenceL, SPFlatFileIsSignatureL, SPFlatFileIsTicketL

SPINT32 __cdecl SPFlatFileIsTicketL (  const SPUCHAR *  pbFlatFile, SPINT32  iFlatFileLength )

Check if a flat file object contains a ticket. Deprecated: Please use a license key. Parameters: pbFlatFile  [i] pointer to a flat file object. iFlatFileLength  [i] length (in bytes) of the flat file object pointed to by pbFlatFile. Returns: 0: the flat file object does not contain a ticket 1: the flat file object contains a ticket Operating Systems: Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a) See also: SPFlatFileCreateFromTicket, SPFlatFileIsCleanParameterL, SPFlatFileIsReferenceL, SPFlatFileIsSignatureL, SPFlatFileIsTemplateL