visit Kofax web site

SPCleanParameter.h File Reference

Detailed Description

SignWare Dynamic Development toolkit, parameters for static image cleaning.

Author:
uko
An SPCleanParameter object contains enable flags (set with SPCleanParameterAddEnableFlag) and properties (set with SPCleanParameterSetInt, SPCleanParameterSetDouble, and SPCleanParameterSetString.

Names of enable flags and properties are defined in SPImage.h.


Functions

SPINT32 __cdecl SPCleanParameterAddEnableFlag (pSPCLEANPARAMETER_T pCleanParameter, const SPCHAR *pszName)
 Add an enable flag to the end of the list.
SPINT32 __cdecl SPCleanParameterAppendEnableFlag (pSPCLEANPARAMETER_T pCleanParameter, const SPCHAR *pszName)
 Add an enable flag to the end of the list.
SPINT32 __cdecl SPCleanParameterClearEnableFlags (pSPCLEANPARAMETER_T pCleanParameter)
 Clear all enable flags in the list.
SPINT32 __cdecl SPCleanParameterClone (pSPCLEANPARAMETER_T pCleanParameter, pSPCLEANPARAMETER_T *ppClone)
 Create a copy of an SPCleanParameter object.
SPINT32 __cdecl SPCleanParameterCreate (pSPCLEANPARAMETER_T *ppCleanParameter)
 Create an SPCleanParameter object.
SPINT32 __cdecl SPCleanParameterCreateFromFlatFile (pSPCLEANPARAMETER_T *ppCleanParameter, const SPUCHAR *pbFlatFile, SPINT32 iFlatFileLen)
 Create an SPCleanParameter object from serialized data.
SPINT32 __cdecl SPCleanParameterFree (pSPCLEANPARAMETER_T *ppCleanParameter)
 Free an SPCleanParameter object.
SPINT32 __cdecl SPCleanParameterGetDouble (pSPCLEANPARAMETER_T pCleanParameter, const SPCHAR *pszName, SPDOUBLE *pdValue)
 Get the value of a floating-point or integer property.
SPINT32 __cdecl SPCleanParameterGetEnableFlag (pSPCLEANPARAMETER_T pCleanParameter, int iIndex, SPCHAR **ppszValue)
 Get the enable flag at an index.
SPINT32 __cdecl SPCleanParameterGetEnableFlagCount (pSPCLEANPARAMETER_T pCleanParameter, int *piCount)
 Query the number of enable flags.
SPINT32 __cdecl SPCleanParameterGetInt (pSPCLEANPARAMETER_T pCleanParameter, const SPCHAR *pszName, SPINT32 *piValue)
 Get the value of an integer property.
SPINT32 __cdecl SPCleanParameterGetString (pSPCLEANPARAMETER_T pCleanParameter, const SPCHAR *pszName, SPCHAR **ppszValue)
 Get the value of a property as a string.
SPINT32 __cdecl SPCleanParameterRead (pSPCLEANPARAMETER_T pCleanParameter, const SPUCHAR *pData, SPINT32 *piDataLen)
 Deserialize an SPCleanParameter object from an array of bytes.
SPINT32 __cdecl SPCleanParameterSetDouble (pSPCLEANPARAMETER_T pCleanParameter, const SPCHAR *pszName, SPDOUBLE dValue)
 Set the value of a property to a floating-point number.
SPINT32 __cdecl SPCleanParameterSetInt (pSPCLEANPARAMETER_T pCleanParameter, const SPCHAR *pszName, SPINT32 iValue)
 Set the value of a property to an integer.
SPINT32 __cdecl SPCleanParameterSetString (pSPCLEANPARAMETER_T pCleanParameter, const SPCHAR *pszName, const SPCHAR *pszValue)
 Set the value of a property to a string.
SPINT32 __cdecl SPCleanParameterWrite (pSPCLEANPARAMETER_T pCleanParameter, SPUCHAR **ppData, SPINT32 *piDataLen)
 Serialize an SPCleanParameter object.

Function Documentation

SPINT32 __cdecl SPCleanParameterAddEnableFlag (  pSPCLEANPARAMETER_T  pCleanParameter,
const SPCHAR *  pszName
) 
 

Add an enable flag to the end of the list.

Parameters:
pCleanParameter [i] pointer to an SPCleanParameter object.
pszName [i] name of the enable flag to be added to the list. See SPImage.h for enable flags.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPCleanParameterClearEnableFlags, SPCleanParameterGetEnableFlag, SPImageCleanBatch

SPINT32 __cdecl SPCleanParameterAppendEnableFlag (  pSPCLEANPARAMETER_T  pCleanParameter,
const SPCHAR *  pszName
) 
 

Add an enable flag to the end of the list.

Parameters:
pCleanParameter [i] pointer to an SPCleanParameter object.
pszName [i] name of the enable flag to be added to the list. See SPImage.h for enable flags.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPCleanParameterClearEnableFlags, SPCleanParameterGetEnableFlag, SPImageCleanBatch
Note:
Kept for backward compatibility

SPINT32 __cdecl SPCleanParameterClearEnableFlags (  pSPCLEANPARAMETER_T  pCleanParameter  ) 
 

Clear all enable flags in the list.

Parameters:
pCleanParameter [i] pointer to an SPCleanParameter object.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPImageCleanBatch, SPCleanParameterAddEnableFlag

SPINT32 __cdecl SPCleanParameterClone (  pSPCLEANPARAMETER_T  pCleanParameter,
pSPCLEANPARAMETER_T *  ppClone
) 
 

Create a copy of an SPCleanParameter object.

Parameters:
pCleanParameter [i] pointer to the SPCleanParameter object to be copied.
ppClone [o] pointer to a variable that will be filled with a pointer to a new SPCleanParameter object. The new object will have the same values as the object pointed to by pCleanParameter. The caller is responsible for deallocating the new object by calling SPCleanParameterFree.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)

SPINT32 __cdecl SPCleanParameterCreate (  pSPCLEANPARAMETER_T *  ppCleanParameter  ) 
 

Create an SPCleanParameter object.

Parameters:
ppCleanParameter [o] pointer to a variable that will be filled with a pointer to a new SPCleanParameter object. The caller is responsible for deallocating the new object by calling SPCleanParameterFree.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)

SPINT32 __cdecl SPCleanParameterCreateFromFlatFile (  pSPCLEANPARAMETER_T *  ppCleanParameter,
const SPUCHAR *  pbFlatFile,
SPINT32  iFlatFileLen
) 
 

Create an SPCleanParameter object from serialized data.

This function deserializes an SPCleanParameter object serialized by SPFlatFileCreateFromCleanParameter.

In contrast to SPCleanParameterRead, this function creates a new SPCleanParameter object.

Parameters:
ppCleanParameter [o] pointer to a variable that will be filled with a pointer to a new SPCleanParameter object. The caller is responsible for deallocating the new object by calling SPCleanParameterFree.
pbFlatFile [i] pointer to an array of bytes containing a serialized SPCleanParameter object.
iFlatFileLen [i] length (in bytes) of the serialized data pointed to by pbFlatFile.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPCleanParameterRead, SPFlatFileCreateFromCleanParameter

SPINT32 __cdecl SPCleanParameterFree (  pSPCLEANPARAMETER_T *  ppCleanParameter  ) 
 

Free an SPCleanParameter object.

The SPCleanParameter object must have been created by SPCleanParameterCreate, SPCleanParameterCreateFromFlatFile, or SPCleanParameterClone.

Parameters:
ppCleanParameter [io] pointer to a variable containing a pointer to an SPCleanParameter object. 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)

SPINT32 __cdecl SPCleanParameterGetDouble (  pSPCLEANPARAMETER_T  pCleanParameter,
const SPCHAR *  pszName,
SPDOUBLE *  pdValue
) 
 

Get the value of a floating-point or integer property.

Parameters:
pCleanParameter [i] pointer to an SPCleanParameter object.
pszName [i] the name of the property. See SPImage.h for property names.
pdValue [o] pointer to a variable that will be filled with the value of the property.
Returns:
SP_NOERR on success, else error code:
  • SP_PARAMERR undefined property or the named property is neither a floating-point property nor an integer property
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPCleanParameterSetDouble

SPINT32 __cdecl SPCleanParameterGetEnableFlag (  pSPCLEANPARAMETER_T  pCleanParameter,
int  iIndex,
SPCHAR **  ppszValue
) 
 

Get the enable flag at an index.

Parameters:
pCleanParameter [i] pointer to an SPCleanParameter object.
iIndex [i] zero-based index of the enable flag.
ppszValue [o] pointer to a variable that will be filled with a pointer to a string containing the name of the enable flag at index iIndex. The caller is responsible for deallocating the string by calling SPFreeString. See SPImage.h for enable flags.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPCleanParameterAddEnableFlag, SPCleanParameterClearEnableFlags, SPImageCleanBatch

SPINT32 __cdecl SPCleanParameterGetEnableFlagCount (  pSPCLEANPARAMETER_T  pCleanParameter,
int *  piCount
) 
 

Query the number of enable flags.

Author:
Uko (11.05.2012)
Parameters:
pCleanParameter [i] pointer to an SPCleanParameter object.
piCount [o] pointer to a variable that will be filled with the count of enable flags
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPCleanParameterAddEnableFlag, SPCleanParameterClearEnableFlags, SPImageCleanBatch

SPINT32 __cdecl SPCleanParameterGetInt (  pSPCLEANPARAMETER_T  pCleanParameter,
const SPCHAR *  pszName,
SPINT32 *  piValue
) 
 

Get the value of an integer property.

Parameters:
pCleanParameter [i] pointer to an SPCleanParameter object.
pszName [i] the name of the property. See SPImage.h for property names.
piValue [o] pointer to a variable that will be filled with the value of the property.
Returns:
SP_NOERR on success, else error code:
  • SP_PARAMERR undefined property or the named property is not an integer property
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPCleanParameterSetInt

SPINT32 __cdecl SPCleanParameterGetString (  pSPCLEANPARAMETER_T  pCleanParameter,
const SPCHAR *  pszName,
SPCHAR **  ppszValue
) 
 

Get the value of a property as a string.

Parameters:
pCleanParameter [i] pointer to an SPCleanParameter object.
pszName [i] the name of the property. See SPImage.h for property names.
ppszValue [o] pointer to a variable that will be filled with a pointer to a string containing the value of the property. The caller is responsible for deallocating the string by calling SPFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPCleanParameterSetString

SPINT32 __cdecl SPCleanParameterRead (  pSPCLEANPARAMETER_T  pCleanParameter,
const SPUCHAR *  pData,
SPINT32 *  piDataLen
) 
 

Deserialize an SPCleanParameter object from an array of bytes.

In contrast to SPCleanParameterCreateFromFlatFile, this function does not create a new SPCleanParameter object.

Parameters:
pCleanParameter [i] pointer to an SPCleanParameter object.
pData [i] pointer to an array of bytes containing a serialized SPCleanParameter object.
piDataLen [io] pointer to a variable containing the length (in bytes) of the array pointed to by pData; the variable will be set to the number of bytes actually read from the array.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPCleanParameterCreateFromFlatFile, SPFlatFileCreateFromCleanParameter

SPINT32 __cdecl SPCleanParameterSetDouble (  pSPCLEANPARAMETER_T  pCleanParameter,
const SPCHAR *  pszName,
SPDOUBLE  dValue
) 
 

Set the value of a property to a floating-point number.

Parameters:
pCleanParameter [i] pointer to an SPCleanParameter object.
pszName [i] the name of the property. See SPImage.h for property names.
dValue [i] the value of the property.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPCleanParameterGetDouble

SPINT32 __cdecl SPCleanParameterSetInt (  pSPCLEANPARAMETER_T  pCleanParameter,
const SPCHAR *  pszName,
SPINT32  iValue
) 
 

Set the value of a property to an integer.

Parameters:
pCleanParameter [i] pointer to an SPCleanParameter object.
pszName [i] the name of the property. See SPImage.h for property names.
iValue [i] the value of the property.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPCleanParameterGetInt

SPINT32 __cdecl SPCleanParameterSetString (  pSPCLEANPARAMETER_T  pCleanParameter,
const SPCHAR *  pszName,
const SPCHAR *  pszValue
) 
 

Set the value of a property to a string.

Parameters:
pCleanParameter [i] pointer to an SPCleanParameter object.
pszName [i] the name of the property. See SPImage.h for property names.
pszValue [i] the value of the property.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPCleanParameterGetString

SPINT32 __cdecl SPCleanParameterWrite (  pSPCLEANPARAMETER_T  pCleanParameter,
SPUCHAR **  ppData,
SPINT32 *  piDataLen
) 
 

Serialize an SPCleanParameter object.

Parameters:
pCleanParameter [i] pointer to an SPCleanParameter object.
ppData [o] pointer to a variable that will be filled with a pointer to an array of bytes containing serialized data representing the object pointed to by pCleanParameter. The caller is responsible for deallocating the array by calling SPFreeMemory.
piDataLen [o] pointer to a variable that will be be filled with the length (in bytes) of the array returned via ppData.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPFlatFileCreateFromCleanParameter