SignDoc SDK (C)  5.0.0
SIGNDOC_CheckSignatureParameters Class Reference

Parameters for SIGNDOC_SignatureData_checkReference() and SIGNDOC_SignatureData_checkSignature(). More...

#include <SignDocSDK-c.h>

Public Member Functions

struct SIGNDOC_CheckSignatureParametersSIGNDOC_CheckSignatureParameters_new (struct SIGNDOC_Exception **aEx)
 SIGNDOC_CheckSignatureParameters constructor. More...
 
void SIGNDOC_CheckSignatureParameters_delete (struct SIGNDOC_CheckSignatureParameters *aObj)
 SIGNDOC_CheckSignatureParameters destructor. More...
 
struct SIGNDOC_CheckSignatureParametersSIGNDOC_CheckSignatureParameters_clone (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_CheckSignatureParameters *aSource)
 Clone a SIGNDOC_CheckSignatureParameters object. More...
 
void SIGNDOC_CheckSignatureParameters_assign (struct SIGNDOC_Exception **aEx, struct SIGNDOC_CheckSignatureParameters *aObj, const struct SIGNDOC_CheckSignatureParameters *aSource)
 SIGNDOC_CheckSignatureParameters assignment operator. More...
 
void SIGNDOC_CheckSignatureParameters_clear (struct SIGNDOC_Exception **aEx, struct SIGNDOC_CheckSignatureParameters *aObj)
 Unset all parameters. More...
 
int SIGNDOC_CheckSignatureParameters_getType (struct SIGNDOC_Exception **aEx, const char *aName)
 Get the type of a parameter. More...
 
int SIGNDOC_CheckSignatureParameters_setBoolean (struct SIGNDOC_Exception **aEx, struct SIGNDOC_CheckSignatureParameters *aObj, const char *aName, SIGNDOC_Boolean aValue)
 Set a boolean parameter. More...
 
int SIGNDOC_CheckSignatureParameters_setInteger (struct SIGNDOC_Exception **aEx, struct SIGNDOC_CheckSignatureParameters *aObj, const char *aName, int aValue)
 Set an integer parameter. More...
 
const SIGNDOC_BooleanSIGNDOC_CheckSignatureParameters_getBoolean (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_CheckSignatureParameters *aObj, const char *aName)
 Get the value of a boolean parameter. More...
 
const int * SIGNDOC_CheckSignatureParameters_getInteger (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_CheckSignatureParameters *aObj, const char *aName)
 Get the value of an integer parameter. More...
 
const char * SIGNDOC_CheckSignatureParameters_getErrorMessage (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_CheckSignatureParameters *aObj, int aEncoding)
 Get an error message for the last function call. More...
 
const wchar_t * SIGNDOC_CheckSignatureParameters_getErrorMessageW (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_CheckSignatureParameters *aObj)
 Get an error message for the last function call. More...
 

Detailed Description

Member Function Documentation

void SIGNDOC_CheckSignatureParameters_assign ( struct SIGNDOC_Exception **  aEx,
struct SIGNDOC_CheckSignatureParameters aObj,
const struct SIGNDOC_CheckSignatureParameters aSource 
)

SIGNDOC_CheckSignatureParameters assignment operator.

Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
[in]aObjA pointer to the SIGNDOC_CheckSignatureParameters object.
[in]aSourceThe source object.
void SIGNDOC_CheckSignatureParameters_clear ( struct SIGNDOC_Exception **  aEx,
struct SIGNDOC_CheckSignatureParameters aObj 
)

Unset all parameters.

After calling this function no parameters will be set.

struct SIGNDOC_CheckSignatureParameters * SIGNDOC_CheckSignatureParameters_clone ( struct SIGNDOC_Exception **  aEx,
const struct SIGNDOC_CheckSignatureParameters aSource 
)

Clone a SIGNDOC_CheckSignatureParameters object.

Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
[in]aSourceThe object to be copied.
Returns
A pointer to the new SIGNDOC_CheckSignatureParameters object.
See also
SIGNDOC_CheckSignatureParameters_delete()
void SIGNDOC_CheckSignatureParameters_delete ( struct SIGNDOC_CheckSignatureParameters aObj)

SIGNDOC_CheckSignatureParameters destructor.

Parameters
[in]aObjA pointer to the SIGNDOC_CheckSignatureParameters object.
See also
SIGNDOC_CheckSignatureParameters_new()
const SIGNDOC_Boolean * SIGNDOC_CheckSignatureParameters_getBoolean ( struct SIGNDOC_Exception **  aEx,
const struct SIGNDOC_CheckSignatureParameters aObj,
const char *  aName 
)

Get the value of a boolean parameter.

This function does not set an error message.

Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
[in]aObjA pointer to the SIGNDOC_CheckSignatureParameters object.
[in]aNameThe name of the parameter (case-sensitive).
Returns
A pointer to the value of the specified parameter or NULL if the parameter is not set or is not a boolean parameter.
See also
SIGNDOC_CheckSignatureParameters_setBoolean()
const char * SIGNDOC_CheckSignatureParameters_getErrorMessage ( struct SIGNDOC_Exception **  aEx,
const struct SIGNDOC_CheckSignatureParameters aObj,
int  aEncoding 
)

Get an error message for the last function call.

Note
Do not call SIGNDOC_free() on the return value.
Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
[in]aObjA pointer to the SIGNDOC_CheckSignatureParameters object.
[in]aEncodingThe encoding to be used for the error message (SIGNDOC_ENCODING_NATIVE, SIGNDOC_ENCODING_UTF_8, or SIGNDOC_ENCODING_LATIN_1).
Returns
A pointer to a string describing the reason for the failure of the last function call. The string is empty if the last call succeeded. The pointer is valid until aObj is destroyed or a member function of aObj is called.
See also
SIGNDOC_CheckSignatureParameters_getErrorMessageW()
const wchar_t * SIGNDOC_CheckSignatureParameters_getErrorMessageW ( struct SIGNDOC_Exception **  aEx,
const struct SIGNDOC_CheckSignatureParameters aObj 
)

Get an error message for the last function call.

Note
Do not call SIGNDOC_free() on the return value.
Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
[in]aObjA pointer to the SIGNDOC_CheckSignatureParameters object.
Returns
A pointer to a string describing the reason for the failure of the last function call. The string is empty if the last call succeeded. The pointer is valid until aObj is destroyed or a member function of aObj is called.
See also
SIGNDOC_CheckSignatureParameters_getErrorMessage()
const int * SIGNDOC_CheckSignatureParameters_getInteger ( struct SIGNDOC_Exception **  aEx,
const struct SIGNDOC_CheckSignatureParameters aObj,
const char *  aName 
)

Get the value of an integer parameter.

This function does not set an error message.

Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
[in]aObjA pointer to the SIGNDOC_CheckSignatureParameters object.
[in]aNameThe name of the parameter (case-sensitive).
Returns
A pointer to the value of the specified parameter or NULL if the parameter is not set or is not an integer parameter.
See also
SIGNDOC_CheckSignatureParameters_setInteger()
int SIGNDOC_CheckSignatureParameters_getType ( struct SIGNDOC_Exception **  aEx,
const char *  aName 
)

Get the type of a parameter.

Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
[in]aNameThe name of the parameter (case-sensitive).
Returns
The type of the parameter: SIGNDOC_CHECKSIGNATUREPARAMETERS_TYPE_UNDEFINED, SIGNDOC_CHECKSIGNATUREPARAMETERS_TYPE_BOOLEAN, or SIGNDOC_CHECKSIGNATUREPARAMETERS_TYPE_INTEGER.
struct SIGNDOC_CheckSignatureParameters * SIGNDOC_CheckSignatureParameters_new ( struct SIGNDOC_Exception **  aEx)

SIGNDOC_CheckSignatureParameters constructor.

No parameters will be set.

Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
Returns
A pointer to the new SIGNDOC_CheckSignatureParameters object.
See also
SIGNDOC_CheckSignatureParameters_clone(), SIGNDOC_CheckSignatureParameters_delete()
int SIGNDOC_CheckSignatureParameters_setBoolean ( struct SIGNDOC_Exception **  aEx,
struct SIGNDOC_CheckSignatureParameters aObj,
const char *  aName,
SIGNDOC_Boolean  aValue 
)

Set a boolean parameter.

The following boolean parameter is available for use with SIGNDOC_SignatureData_checkReference():

Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
[in]aObjA pointer to the SIGNDOC_CheckSignatureParameters object.
[in]aNameThe name of the parameter (case-sensitive).
[in]aValueThe value of the parameter.
Returns
SIGNDOC_RETURNCODE_OK iff successful.
See also
SIGNDOC_CheckSignatureParameters_getBoolean(), SIGNDOC_CheckSignatureParameters_setInteger()
int SIGNDOC_CheckSignatureParameters_setInteger ( struct SIGNDOC_Exception **  aEx,
struct SIGNDOC_CheckSignatureParameters aObj,
const char *  aName,
int  aValue 
)

Set an integer parameter.

The following integer parameters are available for use with SIGNDOC_SignatureData_checkReference():

  • ReferenceMinSignatures: minimum number of signatures in a reference. Set to 0 to skip the test. The default value is 3.
  • ReferenceMinDynamicQuality (0 through 100): minimum dynamic quality of a reference (see SIGNDOC_SignatureData_getDynamicQuality()). Set to 0 to skip the test. The default value is 60.
  • ReferenceMinStaticQuality (0 through 100): minimum static quality of a reference (see SIGNDOC_SignatureData_getStaticQuality()). Set to 0 to skip the test. The default value is 80.
  • ReferenceMaxDuration: maximum reference capture duration in seconds. Set to 0 to skip the test. The default value is 600. The reference capture duration is computed by subtracting the smallest signature timestamp of the reference from the greatest signature timestamp of the reference.

The following integer parameters will be used by SIGNDOC_SignatureData_checkReference() if the value of boolean parameter "ReferenceCheckSignatures" is SIGNDOC_TRUE and (unconditionally) by SIGNDOC_SignatureData_checkSignature():

  • SignatureMinWidth: minimum width of a signature in mm. Set to 0 to skip the test. The default value is 10.
  • SignatureMinHeight: minimum height of a signature in mm. Set to 0 to skip the test. The default value is 5.
  • SignatureMinPressureLevels (0 through 100): minimum number of different pressure levels in a signature in percent of the pressure levels provided by the capture device or 1024 (whichever is lower). Set to 0 to skip the test. The default value is 5.
  • SignatureMinComplexity (0 through 100): minimum static quality (see SIGNDOC_SignatureData_getComplexity()). Set to 0 to skip the test. The default value is 35.
  • SignatureMinSamples: minimum number of samples with positive pressure in a signature. Set to 0 to skip the test. The default value is 10.
Note
In SignWare, ReferenceMinStaticQuality is named SPReferenceMinMatch, SignatureMinSamples is named SPSignatureMinVectors, and SignatureMinComplexity is named SPSignatureMinStaticQuality.
Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
[in]aObjA pointer to the SIGNDOC_CheckSignatureParameters object.
[in]aNameThe name of the parameter (case-sensitive).
[in]aValueThe value of the parameter.
Returns
SIGNDOC_RETURNCODE_OK iff successful.
See also
SIGNDOC_CheckSignatureParameters_getInteger(), SIGNDOC_CheckSignatureParameters_setBoolean()

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