Parameters for SIGNDOC_SignatureData_matchReference(), SIGNDOC_SignatureData_matchSignature(), SIGNDOC_Image_matchReference(), and SIGNDOC_Image_matchSignature(). More...

#include <SignDocSDK-c.h>

Public Member Functions
struct SIGNDOC_MatchParameters *	SIGNDOC_MatchParameters_new (struct SIGNDOC_Exception **aEx)
	SIGNDOC_MatchParameters constructor. More...

void	SIGNDOC_MatchParameters_delete (struct SIGNDOC_MatchParameters *aObj)
	SIGNDOC_MatchParameters destructor. More...

struct SIGNDOC_MatchParameters *	SIGNDOC_MatchParameters_clone (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_MatchParameters aSource)
	Clone a SIGNDOC_MatchParameters object. More...

void	SIGNDOC_MatchParameters_assign (struct SIGNDOC_Exception *aEx, struct SIGNDOC_MatchParameters aObj, const struct SIGNDOC_MatchParameters *aSource)
	SIGNDOC_MatchParameters assignment operator. More...

void	SIGNDOC_MatchParameters_clear (struct SIGNDOC_Exception *aEx, struct SIGNDOC_MatchParameters aObj)
	Unset all parameters. More...

int	SIGNDOC_MatchParameters_getType (struct SIGNDOC_Exception *aEx, const char aName)
	Get the type of a parameter. More...

int	SIGNDOC_MatchParameters_setBoolean (struct SIGNDOC_Exception *aEx, struct SIGNDOC_MatchParameters aObj, const char *aName, SIGNDOC_Boolean aValue)
	Set a boolean parameter. More...

int	SIGNDOC_MatchParameters_setInteger (struct SIGNDOC_Exception *aEx, struct SIGNDOC_MatchParameters aObj, const char *aName, int aValue)
	Set an integer parameter. More...

const SIGNDOC_Boolean *	SIGNDOC_MatchParameters_getBoolean (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_MatchParameters aObj, const char *aName)
	Get the value of a boolean parameter. More...

const int *	SIGNDOC_MatchParameters_getInteger (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_MatchParameters aObj, const char *aName)
	Get the value of an integer parameter. More...

const char *	SIGNDOC_MatchParameters_getErrorMessage (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_MatchParameters aObj, int aEncoding)
	Get an error message for the last function call. More...

const wchar_t *	SIGNDOC_MatchParameters_getErrorMessageW (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_MatchParameters aObj)
	Get an error message for the last function call. More...

Detailed Description

Parameters for SIGNDOC_SignatureData_matchReference(), SIGNDOC_SignatureData_matchSignature(), SIGNDOC_Image_matchReference(), and SIGNDOC_Image_matchSignature().

Member Function Documentation

void SIGNDOC_MatchParameters_assign	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_MatchParameters *	aObj,
		const struct SIGNDOC_MatchParameters *	aSource
	)

SIGNDOC_MatchParameters assignment operator.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_MatchParameters object.
[in]	aSource	The source object.

void SIGNDOC_MatchParameters_clear	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_MatchParameters *	aObj
	)

Unset all parameters.

After calling this function no parameters will be set except for integer parameter "%Flags" (which will be zero) and the boolean parameters derived from that parameter.

struct SIGNDOC_MatchParameters * SIGNDOC_MatchParameters_clone	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_MatchParameters *	aSource
	)

Clone a SIGNDOC_MatchParameters object.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aSource	The object to be copied.

Returns: A pointer to the new SIGNDOC_MatchParameters object.

See also: SIGNDOC_MatchParameters_delete()

void SIGNDOC_MatchParameters_delete ( struct SIGNDOC_MatchParameters * aObj )

SIGNDOC_MatchParameters destructor.

Parameters

[in] aObj A pointer to the SIGNDOC_MatchParameters object.

See also: SIGNDOC_MatchParameters_new()

const SIGNDOC_Boolean * SIGNDOC_MatchParameters_getBoolean	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_MatchParameters *	aObj,
		const char *	aName
	)

Get the value of a boolean parameter.

This function does not set an error message.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_MatchParameters object.
[in]	aName	The 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_MatchParameters_setBoolean()

const char * SIGNDOC_MatchParameters_getErrorMessage	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_MatchParameters *	aObj,
		int	aEncoding
	)

Get an error message for the last function call.

Note: Do not call SIGNDOC_free() on the return value.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_MatchParameters object.
[in]	aEncoding	The 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_MatchParameters_getErrorMessageW()

const wchar_t * SIGNDOC_MatchParameters_getErrorMessageW	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_MatchParameters *	aObj
	)

Get an error message for the last function call.

Note: Do not call SIGNDOC_free() on the return value.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_MatchParameters 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_MatchParameters_getErrorMessage()

const int * SIGNDOC_MatchParameters_getInteger	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_MatchParameters *	aObj,
		const char *	aName
	)

Get the value of an integer parameter.

This function does not set an error message.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_MatchParameters object.
[in]	aName	The 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_MatchParameters_setInteger()

int SIGNDOC_MatchParameters_getType	(	struct SIGNDOC_Exception **	aEx,
		const char *	aName
	)

Get the type of a parameter.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aName	The name of the parameter (case-sensitive).

Returns: The type of the parameter: SIGNDOC_MATCHPARAMETERS_TYPE_UNDEFINED, SIGNDOC_MATCHPARAMETERS_TYPE_BOOLEAN, or SIGNDOC_MATCHPARAMETERS_TYPE_INTEGER.

struct SIGNDOC_MatchParameters * SIGNDOC_MatchParameters_new ( struct SIGNDOC_Exception ** aEx )

SIGNDOC_MatchParameters constructor.

No parameters will be set except for integer parameter "%Flags" (which will be zero) and the boolean parameters derived from that parameter.

Parameters

[out] aEx Any exception will be returned in the object pointed to by this parameter.

Returns: A pointer to the new SIGNDOC_MatchParameters object.

See also: SIGNDOC_MatchParameters_clone(), SIGNDOC_MatchParameters_delete()

int SIGNDOC_MatchParameters_setBoolean	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_MatchParameters *	aObj,
		const char *	aName,
		SIGNDOC_Boolean	aValue
	)

Set a boolean parameter.

Available boolean parameters are:

EngineAuto: see SIGNDOC_MATCHPARAMETERS_FLAGS_ENGINE_AUTO
EngineDStat: see SIGNDOC_MATCHPARAMETERS_FLAGS_ENGINE_DSTAT
EngineDynamic: see SIGNDOC_MATCHPARAMETERS_FLAGS_ENGINE_DYNAMIC
EngineStatic: see SIGNDOC_MATCHPARAMETERS_FLAGS_ENGINE_STATIC
KeepResolution: see SIGNDOC_MATCHPARAMETERS_FLAGS_KEEP_RESOLUTION
Mirror: see SIGNDOC_MATCHPARAMETERS_FLAGS_MIRROR
NormalizeSampleRates: see SIGNDOC_MATCHPARAMETERS_FLAGS_NORMALIZE_SAMPLE_RATES

These boolean parameters allow controlling individual bits in integer parameter "%Flags". Initially, all boolean parameters have value SIGNDOC_FALSE.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_MatchParameters object.
[in]	aName	The name of the parameter (case-sensitive).
[in]	aValue	The value of the parameter.

Returns: SIGNDOC_RETURNCODE_OK iff successful.

See also: SIGNDOC_MatchParameters_getBoolean(), SIGNDOC_MatchParameters_setInteger()

int SIGNDOC_MatchParameters_setInteger	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_MatchParameters *	aObj,
		const char *	aName,
		int	aValue
	)

Set an integer parameter.

Available integer parameters are:

Flags: set of flags controlling matching behavior:
MaxResolution: maximum resolution for SIGNDOC_MATCHPARAMETERS_FLAGS_KEEP_RESOLUTION, set to 0 for no maximum resolution. The default value is 300.
MinDStatQuality (0 through 100): minimum acceptable match value from the DStat matching engine. The default value is 80.
MinDynamicQuality (0 through 100): minimum acceptable match value from the dynamic matching engine. The default value is 80.
MinStaticQuality (0 through 100): minimum acceptable match value from the static matching engine. The default value is 80.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_MatchParameters object.
[in]	aName	The name of the parameter (case-sensitive).
[in]	aValue	The value of the parameter.

Returns: SIGNDOC_RETURNCODE_OK iff successful.

See also: SIGNDOC_MatchParameters_getInteger(), SIGNDOC_MatchParameters_setBoolean()

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

SignDocSDK-c.h

Public Member Functions

Detailed Description

Member Function Documentation