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_19785_3_FORMAT2   0x00000200
	Flat file format: Use ISO/IEC 19785-3:2015 patron format type 2 ("minimum simple byte-oriented patron format") CBEFF wrapper.
#define	SP_FF_ISO_19785_3_FORMAT3   0x00000300
	Flat file format: Use ISO/IEC 19785-3:2015 patron format type 3 ("maximum simple patron format (byte oriented) using presence bitmap") CBEFF wrapper.
#define	SP_FF_ISO_19785_3_FORMAT6   0x00000600
	Flat file format: Use ISO/IEC 19785-3:2015 patron format type 6 ("complex patron format") CBEFF wrapper.
#define	SP_FF_ISO_19785_3_NONE   0x00000000
	Flat file format: No ISO/IEC 19785-3:2015 (CBEFF) wrapper.
#define	SP_FF_ISO_19794_7_2007TC1   0x00001000
	Flat file format: ISO/IEC 19794-7:2007 (with Technical Corrigendum 1) Biometric Data Block (version 1).
#define	SP_FF_ISO_19794_7_2014   0x00002000
	Flat file format: ISO/IEC 19794-7:2014 Biometric Data Block (version 2).
#define	SP_FF_ISO_19794_7_FULL   0x00000000
	Flat file format: ISO/IEC 19794-7 full format.
#define	SP_FF_ISO_19794_COMPLEX   3
	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").
#define	SP_FF_ISO_19794_MINIMUM   1
	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").
#define	SP_FF_ISO_19794_SIMPLE   2
	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").
#define	SP_FF_ISO_FLAG_COMPAT1   0x00400000
	Flat file format flag: write with bug compatibility with SignWare before version 3.2.9.0.
#define	SP_FF_ISO_FLAG_METERS   0x00100000
	Flat file format flag: Use meters rather than millimeters for X and Y coordinates.
#define	SP_FF_ISO_FLAG_NO_EXT_DATA   0x00800000
	Flat file format flag: Omit or ignore extended data.
#define	SP_FF_ISO_FLAG_NO_FIX   0x00200000
	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.
#define	SP_FF_ISO_MASK_BDB   0x0000f000
	Mask for flat file format: BDB format.
#define	SP_FF_ISO_MASK_DATA   0x000f0000
	Mask for flat file format: data format.
#define	SP_FF_ISO_MASK_FLAGS   0xfff00000
	Mask for flat file format: flags.
#define	SP_FF_ISO_MASK_SINGLE   0x000000ff
	Mask for flat file format: formats specified by a single value.
#define	SP_FF_ISO_MASK_WRAPPER   0x00000f00
	Mask for flat file format: CBEFF wrapper.
#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	SPFlatFileCreateFromReference3 (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	SPFlatFileCreateFromSignature3 (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_19785_3_FORMAT2   0x00000200

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 SP_FF_ISO_19794_7_2007TC1 or SP_FF_ISO_19794_7_2014. With SP_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 SP_FF_ISO_19794_7_2014 with SP_FF_ISO_19785_3_NONE.

#define SP_FF_ISO_19785_3_FORMAT3   0x00000300

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 SP_FF_ISO_19794_7_2007TC1 or SP_FF_ISO_19794_7_2014. With SP_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 SP_FF_ISO_19794_7_2014 with SP_FF_ISO_19785_3_NONE.

#define SP_FF_ISO_19785_3_FORMAT6   0x00000600

Flat file format: Use ISO/IEC 19785-3:2015 patron format type 6 ("complex patron format") CBEFF wrapper. This can be used with SP_FF_ISO_19794_7_2007TC1 or SP_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 SP_FF_ISO_19794_7_2014 with SP_FF_ISO_19785_3_NONE.

#define SP_FF_ISO_19785_3_NONE   0x00000000

Flat file format: No ISO/IEC 19785-3:2015 (CBEFF) wrapper. This should be used with SP_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.

#define SP_FF_ISO_19794_7_2007TC1   0x00001000

Flat file format: ISO/IEC 19794-7:2007 (with Technical Corrigendum 1) Biometric Data Block (version 1). Please also use SP_FF_ISO_19785_3_FORMAT2, SP_FF_ISO_19785_3_FORMAT3, or SP_FF_ISO_19785_3_FORMAT6 to specify the ISO/IEC 19785-3 wrapper. Alternateively, use SP_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. SP_FF_ISO_19785_3_FORMAT6 is required for saving references, signatures can be saved with any of these constants. Please also use SP_FF_ISO_19794_7_FULL (default) to select the data format. You can include flag SP_FF_ISO_FLAG_METERS for using ISO/IEC 19794-7:2007 without Technical Corrigendum 1. You can include flag SP_FF_ISO_FLAG_COMPAT1 for bug compatibility with SignWare before version 3.2.9.0. You can include flag SP_FF_ISO_FLAG_NO_EXT_DATA to omit extended data.

#define SP_FF_ISO_19794_7_2014   0x00002000

Flat file format: ISO/IEC 19794-7:2014 Biometric Data Block (version 2). Please also use SP_FF_ISO_19785_3_NONE, SP_FF_ISO_19785_3_FORMAT2, SP_FF_ISO_19785_3_FORMAT3, or SP_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 SP_FF_ISO_19794_7_FULL (default) to select the data format.

#define SP_FF_ISO_19794_7_FULL   0x00000000

Flat file format: ISO/IEC 19794-7 full format. To be used with either SP_FF_ISO_19794_7_2007TC1 or SP_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.

#define SP_FF_ISO_19794_COMPLEX   3

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 SP_FF_ISO_FLAG_METERS for using ISO/IEC 19794-7:2007 without Technical Corrigendum 1. You can include flag SP_FF_ISO_FLAG_COMPAT1 for bug compatibility with SignWare before version 3.2.9.0. You can include flag SP_FF_ISO_FLAG_NO_EXT_DATA to omit extended data. This value is equivalent to (but does not have the same value as) SP_FF_ISO_19794_7_2007TC1 | SP_FF_ISO_19794_7_FULL | SP_FF_ISO_19785_3_FORMAT6 Deprecated: Patron format type 6 has been deprecated in ISO/IEC 19785-3:2015, please use SP_FF_ISO_19794_7_2014 with SP_FF_ISO_19785_3_NONE. See also: SPFlatFileCreateFromSignature2, SPFlatFileCreateFromSignature3, SPFlatFileCreateFromReference2, SPFlatFileCreateFromReference3 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: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 SP_FF_ISO_FLAG_METERS for using ISO/IEC 19794-7:2007 without Technical Corrigendum 1. You can include flag SP_FF_ISO_FLAG_COMPAT1 for bug compatibility with SignWare before version 3.2.9.0. You can include flag SP_FF_ISO_FLAG_NO_EXT_DATA to omit extended data. This value is equivalent to (but does not have the same value as) SP_FF_ISO_19794_7_2007TC1 | SP_FF_ISO_19794_7_FULL | SP_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 SP_FF_ISO_19794_7_2014 with SP_FF_ISO_19785_3_NONE. See also: SPFlatFileCreateFromSignature2, SPFlatFileCreateFromSignature3 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: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 SP_FF_ISO_FLAG_METERS for using ISO/IEC 19794-7:2007 without Technical Corrigendum 1. You can include flag SP_FF_ISO_FLAG_COMPAT1 for bug compatibility with SignWare before version 3.2.9.0. You can include flag SP_FF_ISO_FLAG_NO_EXT_DATA to omit extended data. This value is equivalent to (but does not have the same value as) SP_FF_ISO_19794_7_2007TC1 | SP_FF_ISO_19794_7_FULL | SP_FF_ISO_19785_3_FORMAT3 Deprecated: Patron format type 3 has been deprecated in ISO/IEC 19785-3:2015, please use SP_FF_ISO_19794_7_2014 with SP_FF_ISO_19785_3_NONE. See also: SPFlatFileCreateFromSignature2, SPFlatFileCreateFromSignature3 SP_FF_SOFTPRO, SP_FF_ISO_19794_MINIMUM, SP_FF_ISO_19794_COMPLEX

#define SP_FF_ISO_FLAG_COMPAT1   0x00400000

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 SP_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 SP_FF_ISO_19794_MINIMUM, SP_FF_ISO_19794_SIMPLE, SP_FF_ISO_19794_COMPLEX, and SP_FF_ISO_19794_7_2007TC1 (with SP_FF_ISO_19785_3_FORMAT2, SP_FF_ISO_19785_3_FORMAT3, or SP_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: SP_FF_ISO_FLAG_METERS, SP_FF_ISO_FLAG_NO_FIX

#define SP_FF_ISO_FLAG_METERS   0x00100000

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 SP_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 SP_FF_ISO_FLAG_COMPAT1 rather than this flag. This flag is ignored for non-ISO formats. See also: SP_FF_ISO_FLAG_COMPAT1, SP_FF_ISO_FLAG_NO_FIX

#define SP_FF_ISO_FLAG_NO_EXT_DATA   0x00800000

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: SP_FF_ISO_FLAG_COMPAT1

#define SP_FF_ISO_FLAG_NO_FIX   0x00200000

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 (SP_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: SP_FF_ISO_FLAG_COMPAT1, SP_FF_ISO_FLAG_METERS

#define SP_FF_ISO_MASK_BDB   0x0000f000

Mask for flat file format: BDB format.

#define SP_FF_ISO_MASK_DATA   0x000f0000

Mask for flat file format: data format.

#define SP_FF_ISO_MASK_FLAGS   0xfff00000

Mask for flat file format: flags.

#define SP_FF_ISO_MASK_SINGLE   0x000000ff

Mask for flat file format: formats specified by a single value.

#define SP_FF_ISO_MASK_WRAPPER   0x00000f00

Mask for flat file format: CBEFF wrapper.

#define SP_FF_SOFTPRO   0

Flat file format: SOFTPRO secure (encrypted) biometric signature / reference data. This format can be used for signatures and references, not for templates. See also: SPFlatFileCreateFromSignature, SPFlatFileCreateFromSignature2, SPFlatFileCreateFromSignature3, SPFlatFileCreateFromReference, SPFlatFileCreateFromReference2, SPFlatFileCreateFromReference3 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, SPFlatFileCreateFromReference3, SPFlatFileCreateFromReference3, 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. Flags can be specified by environment variable SIGNWARE_ISO_SAVE. Its value is either a decimal number or a hexadecimal number (prefixed by "0x"). The number will be shifted left 20 bits and bitwise or-ed into iFormat, that is, the following values (and combinations thereof) are defined: 0x01 is equivalent to SP_FF_ISO_FLAG_METERS 0x04 is equivalent to SP_FF_ISO_FLAG_COMPAT1 0x08 is equivalent to SP_FF_ISO_FLAG_NO_EXT_DATA 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] Format to be used: either one of the following constants: SP_FF_SOFTPRO SP_FF_ISO_19794_MINIMUM (deprecated) SP_FF_ISO_19794_SIMPLE (deprecated) SP_FF_ISO_19794_COMPLEX (deprecated) or a combination (bitwise or) of up to one constant from each of the following three groups: version of ISO/IEC 19794-7: SP_FF_ISO_19794_7_2007TC1 (superseded) or SP_FF_ISO_19794_7_2014 (recommended) data format: SP_FF_ISO_19794_7_FULL (default); compact format, compression format, and XML are currently not supported CBEFF wrapper: SP_FF_ISO_19785_3_NONE (default), SP_FF_ISO_19785_3_FORMAT2, SP_FF_ISO_19785_3_FORMAT3, or SP_FF_ISO_19785_3_FORMAT6 No flags can be specified in iFormat, but see SPFlatFileCreateFromReference3(). SP_FF_ISO_19794_7_2007TC1 without SP_FF_ISO_19785_3_FORMAT6, as well as SP_FF_ISO_19794_MINIMUM and SP_FF_ISO_19794_SIMPLE can be used only if the number of signatures is one. 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, SPFlatFileCreateFromReference3, SPFlatFileCreateFromSignature2, SPFlatFileCreateFromSignature3, SPFlatFileIsReferenceL, SPReferenceCreateFromFlatFile SP_FF_SOFTPRO, SP_FF_ISO_19794_COMPLEX

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

Create a flat file object from a reference object. This function does not use environment variable SIGNWARE_ISO_SAVE. 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] Format to be used: either one of the following constants: SP_FF_SOFTPRO SP_FF_ISO_19794_MINIMUM (deprecated) SP_FF_ISO_19794_SIMPLE (deprecated) SP_FF_ISO_19794_COMPLEX (deprecated) or a combination (bitwise or) of up to one constant from each of the following three groups: version of ISO/IEC 19794-7: SP_FF_ISO_19794_7_2007TC1 (superseded) or SP_FF_ISO_19794_7_2014 (recommended) data format: SP_FF_ISO_19794_7_FULL (default); compact format, compression format, and XML are currently not supported CBEFF wrapper: SP_FF_ISO_19785_3_NONE (default), SP_FF_ISO_19785_3_FORMAT2, SP_FF_ISO_19785_3_FORMAT3 or SP_FF_ISO_19785_3_FORMAT6 For some formats, you can additionally include (bitwise or) these flags: SP_FF_ISO_FLAG_METERS SP_FF_ISO_FLAG_COMPAT1 SP_FF_ISO_FLAG_NO_EXT_DATA SP_FF_ISO_19794_7_2007TC1 without SP_FF_ISO_19785_3_FORMAT6, as well as SP_FF_ISO_19794_MINIMUM and SP_FF_ISO_19794_SIMPLE can be used only if the number of signatures is one. 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, SPFlatFileCreateFromReference2, SPFlatFileCreateFromSignature3, 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, SPFlatFileCreateFromSignature3, 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. Flags can be specified by environment variable SIGNWARE_ISO_SAVE. Its value is either a decimal number or a hexadecimal number (prefixed by "0x"). The number will be shifted left 20 bits and bitwise or-ed into iFormat, that is, the following values (and combinations thereof) are defined: 0x01 is equivalent to SP_FF_ISO_FLAG_METERS 0x04 is equivalent to SP_FF_ISO_FLAG_COMPAT1 0x08 is equivalent to SP_FF_ISO_FLAG_NO_EXT_DATA 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] Format to be used: either one of the following constants: SP_FF_SOFTPRO SP_FF_ISO_19794_MINIMUM (deprecated) SP_FF_ISO_19794_SIMPLE (deprecated) SP_FF_ISO_19794_COMPLEX (deprecated) or a combination (bitwise or) of up to one constant from each of the following three groups: version of ISO/IEC 19794-7: SP_FF_ISO_19794_7_2007TC1 (superseded) or SP_FF_ISO_19794_7_2014 (recommended) data format: SP_FF_ISO_19794_7_FULL (default); compact format, compression format, and XML are currently not supported CBEFF wrapper: SP_FF_ISO_19785_3_NONE (default), SP_FF_ISO_19785_3_FORMAT2, SP_FF_ISO_19785_3_FORMAT3, or SP_FF_ISO_19785_3_FORMAT6 No flags can be specified in iFormat, but see SPFlatFileCreateFromSignature3(). 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, SPFlatFileCreateFromSignature3, SPFlatFileCreateFromReference2, SPFlatFileIsSignatureL, SPSignatureCreateFromFlatFile SP_FF_SOFTPRO, SP_FF_ISO_19794_MINIMUM, SP_FF_ISO_19794_SIMPLE, SP_FF_ISO_19794_COMPLEX

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

Create a flat file object from a signature object. This function does not use environment variable SIGNWARE_ISO_SAVE. 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] Format to be used: either one of the following constants: SP_FF_SOFTPRO SP_FF_ISO_19794_MINIMUM (deprecated) SP_FF_ISO_19794_SIMPLE (deprecated) SP_FF_ISO_19794_COMPLEX (deprecated) or a combination (bitwise or) of up to one constant from each of the following three groups: version of ISO/IEC 19794-7: SP_FF_ISO_19794_7_2007TC1 (superseded) or SP_FF_ISO_19794_7_2014 (recommended) data format: SP_FF_ISO_19794_7_FULL (default); compact format, compression format, and XML are currently not supported CBEFF wrapper: SP_FF_ISO_19785_3_NONE (default), SP_FF_ISO_19785_3_FORMAT2, SP_FF_ISO_19785_3_FORMAT3, or SP_FF_ISO_19785_3_FORMAT6 For some formats, you can additionally include (bitwise or) these flags: SP_FF_ISO_FLAG_METERS SP_FF_ISO_FLAG_COMPAT1 SP_FF_ISO_FLAG_NO_EXT_DATA 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, SPFlatFileCreateFromSignature2, SPFlatFileCreateFromReference3, 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, SPFlatFileCreateFromReference3, SPFlatFileCreateFromSignature, SPFlatFileCreateFromSignature2, SPFlatFileCreateFromSignature3, 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