visit Kofax web site

SPBitmap.h File Reference


Detailed Description

SignWare Dynamic Development toolkit, create a bitmap from a dynamic object.

Author:
uko
SPBitmap objects are serialized SPImage objects. SPBitmap objects include static image features, but no dynamic signature features.

In contrast, SPFlatFile objects (see SPFlatFile.h) are serialized SPReference, SPTemplate or SPSignature objects. SPFlatFile objects include both static and dynamic features.


Functions

SPINT32 __cdecl SPBitmapCreateFromFlatFile (SPUCHAR **ppbBitmap, SPINT32 *piBitmapLength, const SPUCHAR *pbFlatfile, SPINT32 iFlatfileLength, SPINT32 iResolution, SPINT32 iFormat)
 Create a bitmap from a flat file object containing a signature, a reference, or a template.
SPINT32 __cdecl SPBitmapCreateFromImage (SPUCHAR **ppbBitmap, SPINT32 *piBitmapLength, pSPIMAGE_T pImage, SPINT32 iFormat)
 Create a bitmap from an image object.
SPINT32 __cdecl SPBitmapCreateFromReference (SPUCHAR **ppbBitmap, SPINT32 *piBitmapLength, pSPREFERENCE_T pReference, SPINT32 iResolution, SPINT32 iFormat)
 Create a bitmap from an SPReference object.
SPINT32 __cdecl SPBitmapCreateFromSignature (SPUCHAR **ppbBitmap, SPINT32 *piBitmapLength, pSPSIGNATURE_T pSignature, SPINT32 iResolution, SPINT32 iFormat)
 Create a bitmap from an SPSignature object.
SPINT32 __cdecl SPBitmapCreateFromTemplate (SPUCHAR **ppbBitmap, SPINT32 *piBitmapLength, pSPTEMPLATE_T pTemplate, SPINT32 iResolution, SPINT32 iFormat)
 Create a bitmap from a template object.
SPINT32 __cdecl SPBitmapFree (SPUCHAR **ppbBitmap)
 Deallocate a bitmap.


Function Documentation

SPINT32 __cdecl SPBitmapCreateFromFlatFile SPUCHAR **  ppbBitmap,
SPINT32 piBitmapLength,
const SPUCHAR pbFlatfile,
SPINT32  iFlatfileLength,
SPINT32  iResolution,
SPINT32  iFormat
 

Create a bitmap from a flat file object containing a signature, a reference, or a template.

If the flat file object contains a reference, the second signature of the reference will be used (unless the reference contains only a single signature).

Parameters:
ppbBitmap [o] pointer to a variable that will be filled with a pointer to an array of bytes containing the bitmap. The caller is responsible for deallocating that array of bytes by calling SPBitmapFree.
piBitmapLength [o] pointer to a variable that will be filled with the length (in bytes) of the bitmap returned via ppbBitmap.
pbFlatfile [i] pointer to the flat file object from which the bitmap is to be created.
iFlatfileLength [i] length (in bytes) of the flat file object pointed to by pbFlatfile.
iResolution [i] desired resolution of the bitmap (in DPI). This resolution must not exceed the resolution of the signature, reference, or template.
iFormat [i] desired format of the bitmap: Flags that can be added with the `|' operator:
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPBitmapFree, SPFlatFileCreateFromReference, SPFlatFileCreateFromSignature, SPFlatFileCreateFromTemplate

SPINT32 __cdecl SPBitmapCreateFromImage SPUCHAR **  ppbBitmap,
SPINT32 piBitmapLength,
pSPIMAGE_T  pImage,
SPINT32  iFormat
 

Create a bitmap from an image object.

Parameters:
ppbBitmap [o] pointer to a variable that will be filled with a pointer to an array of bytes containing the bitmap. The caller is responsible for deallocating that array of bytes by calling SPBitmapFree.
piBitmapLength [o] pointer to a variable that will be filled with the length (in bytes) of the bitmap returned via ppbBitmap.
pImage [i] pointer to an image object.
iFormat [i] desired format of the bitmap: Flags that can be added with the `|' operator:
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPImageFree, SPImageSaveInBitmap

SPINT32 __cdecl SPBitmapCreateFromReference SPUCHAR **  ppbBitmap,
SPINT32 piBitmapLength,
pSPREFERENCE_T  pReference,
SPINT32  iResolution,
SPINT32  iFormat
 

Create a bitmap from an SPReference object.

The second signature of the reference will be used (unless the reference contains only a single signature).

Parameters:
ppbBitmap [o] pointer to a variable that will be filled with a pointer to an array of bytes containing the bitmap. The caller is responsible for deallocating that array of bytes by calling SPBitmapFree.
piBitmapLength [o] pointer to a variable that will be filled with the length (in bytes) of the bitmap returned via ppbBitmap.
pReference [i] pointer to a a reference object.
iResolution [i] desired resolution of the bitmap (in DPI). This resolution must not exceed the resolution of the reference pointed to by pReference.
iFormat [i] desired format of the bitmap: Flags that can be added with the `|' operator:
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPBitmapFree, SPReferenceGetImage

SPINT32 __cdecl SPBitmapCreateFromSignature SPUCHAR **  ppbBitmap,
SPINT32 piBitmapLength,
pSPSIGNATURE_T  pSignature,
SPINT32  iResolution,
SPINT32  iFormat
 

Create a bitmap from an SPSignature object.

Parameters:
ppbBitmap [o] pointer to a variable that will be filled with a pointer to an array of bytes containing the bitmap. The caller is responsible for deallocating that array of bytes by calling SPBitmapFree.
piBitmapLength [o] pointer to a variable that will be filled with the length (in bytes) of the bitmap returned via ppbBitmap.
pSignature [i] pointer to a signature object.
iResolution [i] desired resolution of the bitmap (in DPI). This resolution must not exceed the resolution of the signature pointed to by pSignature.
iFormat [i] desired format of the bitmap: Flags that can be added with the `|' operator:
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPBitmapFree, SPSignatureGetImage

SPINT32 __cdecl SPBitmapCreateFromTemplate SPUCHAR **  ppbBitmap,
SPINT32 piBitmapLength,
pSPTEMPLATE_T  pTemplate,
SPINT32  iResolution,
SPINT32  iFormat
 

Create a bitmap from a template object.

Parameters:
ppbBitmap [o] pointer to a variable that will be filled with a pointer to an array of bytes containing the bitmap. The caller is responsible for deallocating that array of bytes by calling SPBitmapFree.
piBitmapLength [o] pointer to a variable that will be filled with the length (in bytes) of the bitmap returned via ppbBitmap.
pTemplate [i] pointer to a template object.
iResolution [i] desired resolution of the bitmap (in DPI). This resolution must not exceed the resolution of the template pointed to by pTemplate.
iFormat [i] desired format of the bitmap: Flags that can be added with the `|' operator:
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPBitmapFree, SPTemplateGetImage

SPINT32 __cdecl SPBitmapFree SPUCHAR **  ppbBitmap  ) 
 

Deallocate a bitmap.

The bitmap must have been created by SPBitmapCreateFromReference, SPBitmapCreateFromSignature, SPBitmapCreateFromFlatFile, SPBitmapCreateFromTemplate, or SPImageSaveInBitmap.

Parameters:
ppbBitmap [io] pointer to a variable containing a pointer to an array of bytes containing a bitmap. The variable will be set to NULL if this function succeeds.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPBitmapCreateFromReference, SPBitmapCreateFromSignature, SPBitmapCreateFromFlatFile, SPBitmapCreateFromTemplate, SPImageSaveInBitmap