Biometric data of handwritten signatures. More...

#include <SignDocSDK-c.h>

Public Member Functions
struct SIGNDOC_SignatureData *	SIGNDOC_SignatureData_new (struct SIGNDOC_Exception **aEx)
	SIGNDOC_SignatureData constructor. More...

void	SIGNDOC_SignatureData_delete (struct SIGNDOC_SignatureData *aObj)
	SIGNDOC_SignatureData destructor. More...

struct SIGNDOC_SignatureData *	SIGNDOC_SignatureData_clone (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aSource)
	Clone a SIGNDOC_SignatureData object. More...

void	SIGNDOC_SignatureData_assign (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj, const struct SIGNDOC_SignatureData *aSource)
	SIGNDOC_SignatureData assignment operator. More...

int	SIGNDOC_SignatureData_getType (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj)
	Get the type of handwritten signatures stored in a SIGNDOC_SignatureData object. More...

SIGNDOC_Boolean	SIGNDOC_SignatureData_isEmpty (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj)
	Check if a SIGNDOC_SignatureData object is empty. More...

SIGNDOC_Boolean	SIGNDOC_SignatureData_isReference (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj)
	Check if a SIGNDOC_SignatureData object contains a reference. More...

SIGNDOC_Boolean	SIGNDOC_SignatureData_isSignature (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj)
	Check if a SIGNDOC_SignatureData object contains a signature. More...

int	SIGNDOC_SignatureData_getNumberOfSignatures (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj)
	Get the number of signatures in a SIGNDOC_SignatutreData object. More...

int	SIGNDOC_SignatureData_getStaticQuality (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, const struct SIGNDOC_ImageParameters aImageParameters, int aOutput)
	Compute the static quality of a reference. More...

int	SIGNDOC_SignatureData_getDynamicQuality (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, int *aOutput)
	Compute the dynamic quality of a reference. More...

void	SIGNDOC_SignatureData_clear (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj)
	Remove all signatures. More...

int	SIGNDOC_SignatureData_addEmptySignature (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj)
	Add an empty signature. More...

int	SIGNDOC_SignatureData_add (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj, const struct SIGNDOC_SignatureData *aSource)
	Add signatures from another SIGNDOC_SignatureData object. More...

int	SIGNDOC_SignatureData_addFromMemory (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj, const unsigned char *aPtr, size_t aSize, unsigned aFlags)
	Add signatures from a blob. More...

int	SIGNDOC_SignatureData_addFromFile (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj, int aEncoding, const char *aPath, unsigned aFlags)
	Add signatures from a file. More...

int	SIGNDOC_SignatureData_addFromFileW (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj, const wchar_t *aPath, unsigned aFlags)
	Add signatures from a file. More...

int	SIGNDOC_SignatureData_loadFromFile (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj, int aEncoding, const char *aPath, unsigned aFlags)
	Load (deserialize) signatures from a file. More...

int	SIGNDOC_SignatureData_loadFromFileW (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj, const wchar_t *aPath, unsigned aFlags)
	Load (deserialize) signatures from a file. More...

int	SIGNDOC_SignatureData_loadFromMemory (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj, const unsigned char *aPtr, size_t aSize, unsigned aFlags)
	Load (deserialize) signatures from a blob. More...

int	SIGNDOC_SignatureData_saveToMemory (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, struct SIGNDOC_ByteArray *aOutput, int aFormat)
	Serialize a SIGNDOC_SignatureData object to a blob. More...

int	SIGNDOC_SignatureData_saveToFile (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, int aEncoding, const char *aPath, int aFormat)
	Serialize a SIGNDOC_SignatureData object to a file. More...

int	SIGNDOC_SignatureData_saveToFileW (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, const wchar_t *aPath, int aFormat)
	Serialize a SIGNDOC_SignatureData object to a file. More...

int	SIGNDOC_SignatureData_selectSignature (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj, int aIndex)
	Select a signature for most functions operating on a single signature. More...

int	SIGNDOC_SignatureData_getSelectedSignature (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj)
	Get the index of the currently selected signature. More...

int	SIGNDOC_SignatureData_getDeviceId (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, int *aOutput)
	Get the capture device identifier. More...

int	SIGNDOC_SignatureData_setDeviceId (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj, int aDeviceId)
	Set the capture device identifier. More...

int	SIGNDOC_SignatureData_getDeviceMaxPressure (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, int *aOutput)
	Get the maximum pressure (force) value of the capture device. More...

int	SIGNDOC_SignatureData_getDevicePressureLevels (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, int *aOutput)
	Get the number of pressure (force) levels supported by the capture device. More...

int	SIGNDOC_SignatureData_setDeviceMaxPressure (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj, int aDeviceMaxPressure)
	Set the maximum pressure (force) value of the capture device. More...

int	SIGNDOC_SignatureData_getDeviceResolution (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, int *aOutput)
	Get the spatial resolution of the capture device. More...

int	SIGNDOC_SignatureData_setDeviceResolution (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj, int aDeviceResolution)
	Set the spatial resolution of the capture device. More...

int	SIGNDOC_SignatureData_getDeviceSampleRate (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, int *aOutput)
	Get the sample rate (temporal resolution) of the capture device. More...

int	SIGNDOC_SignatureData_setDeviceSampleRate (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj, int aDeviceSampleRate)
	Set the sample rate (temporal resolution) of the capture device. More...

int	SIGNDOC_SignatureData_getDeviceSerialNumber (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, struct SIGNDOC_ByteArray *aOutput)
	Get the serial number of the capture device. More...

int	SIGNDOC_SignatureData_setDeviceSerialNumber (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj, const unsigned char *aPtr, size_t aSize)
	Set the serial number of the capture device. More...

int	SIGNDOC_SignatureData_getTimeStamp (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, unsigned *aOutput)
	Get the capture time stamp. More...

int	SIGNDOC_SignatureData_setTimeStamp (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj, unsigned aTimeStamp)
	Set the capture time stamp. More...

int	SIGNDOC_SignatureData_getNumberOfSamples (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, int *aOutput)
	Get the number of samples. More...

SIGNDOC_Boolean	SIGNDOC_SignatureData_hasTimeChannel (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj)
	Check if the biometric data has a time channel. More...

int	SIGNDOC_SignatureData_getSample (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, int aIndex, int aX, int aY, int aP, int aT)
	Get a sample. More...

int	SIGNDOC_SignatureData_getMaxP (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, int *aOutput)
	Compute the maximum pressure (force) value recorded in the biometric data. More...

int	SIGNDOC_SignatureData_getMaxX (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, int *aOutput)
	Compute the maximum X coordinate recorded in the biometric data. More...

int	SIGNDOC_SignatureData_getMaxY (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, int *aOutput)
	Compute the maximum Y coordinate recorded in the biometric data. More...

int	SIGNDOC_SignatureData_getMinX (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, int *aOutput)
	Compute the minimum X coordinate recorded in the biometric data. More...

int	SIGNDOC_SignatureData_getMinY (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, int *aOutput)
	Compute the minimum Y coordinate recorded in the biometric data. More...

int	SIGNDOC_SignatureData_getHeight (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, int *aOutput)
	Compute the height of the signature. More...

int	SIGNDOC_SignatureData_getWidth (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, int *aOutput)
	Compute the width of the signature. More...

int	SIGNDOC_SignatureData_clearSamples (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj)
	Remove all samples from a signature. More...

int	SIGNDOC_SignatureData_addSample (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj, int aX, int aY, int aP, int aT)
	Add a sample. More...

int	SIGNDOC_SignatureData_mirrorY (struct SIGNDOC_Exception *aEx, struct SIGNDOC_SignatureData aObj)
	Mirror signatures vertically. More...

int	SIGNDOC_SignatureData_checkReference (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, const struct SIGNDOC_CheckSignatureParameters aCheckSignatureParameters, const struct SIGNDOC_ImageParameters aImageParameters, SIGNDOC_Boolean *aOutput)
	Check biometric data of a reference for plausibility. More...

int	SIGNDOC_SignatureData_getComplexity (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, const struct SIGNDOC_ImageParameters aImageParameters, int aOutput)
	Compute the complexity of a signature. More...

int	SIGNDOC_SignatureData_checkSignature (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, const struct SIGNDOC_CheckSignatureParameters aCheckSignatureParameters, const struct SIGNDOC_ImageParameters aImageParameters, SIGNDOC_Boolean *aOutput)
	Check biometric data of a signature for plausibility. More...

int	SIGNDOC_SignatureData_renderAsImage (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, struct SIGNDOC_ByteArray aImage, const struct SIGNDOC_ImageParameters aImageParameters, struct SIGNDOC_RenderOutput *aOutput)
	Render a signature as image (returned as a blob). More...

int	SIGNDOC_SignatureData_renderAsSignDocImage (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, const struct SIGNDOC_ImageParameters aImageParameters, struct SIGNDOC_Image *aImage)
	Render a signature as image (returned as a SIGNDOC_Image object). More...

int	SIGNDOC_SignatureData_matchSignature (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, const struct SIGNDOC_SignatureData aOther, const struct SIGNDOC_MatchParameters aMatchParameters, const struct SIGNDOC_ImageParameters aImageParameters, struct SIGNDOC_MatchResult *aOutput)
	Match a single signature against another signature or a reference. More...

int	SIGNDOC_SignatureData_matchReference (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_SignatureData aObj, const struct SIGNDOC_SignatureData aOther, const struct SIGNDOC_MatchParameters aMatchParameters, const struct SIGNDOC_ImageParameters aImageParameters, struct SIGNDOC_MatchResult *aOutput)
	Match a reference against a single signature. More...

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

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

Detailed Description

Biometric data of handwritten signatures.

A SIGNDOC_SignatureData object holds any number of handwritten signatures:

If a SIGNDOC_SignatureData object contains no signatures, SIGNDOC_SignatureData_getType() returns SIGNDOC_SIGNATUREDATA_TYPE_EMPTY. This is the initial state.
If a SIGNDOC_SignatureData object contains exactly one signature, SIGNDOC_SignatureData_getType() returns SIGNDOC_SIGNATUREDATA_TYPE_SIGNATURE. SIGNDOC_SignatureData objects of this type are used for signing.
If a SIGNDOC_SignatureData object contains exactly two or more signatures, SIGNDOC_SignatureData_getType() returns SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE. SIGNDOC_SignatureData objects of these types are used for enrolling persons and for later matching of a signature against a reference. A valid reference contains at least 3 and at most 10 signatures.

The origin of the coordinate system is in the upper left corner of the capture device; X coordinates increase to the right, Y coordinates increase downwards. Note that this coordinate system differs from the coordinate system used by ISO 19794-7. Unless flag SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_COMPAT1 is set, the coordinate system will be transformed appropriately when reading or writing ISO 19794-7 data.

Functions for creating SIGNDOC_SignatureData objects:

SIGNDOC_SignatureData_new()
SIGNDOC_SignatureData_clone()
SIGNDOC_SignatureData_cloneSignature()

Functions for getting information about a SIGNDOC_SignatureData object:

Functions for modifying a SIGNDOC_SignatureData object:

Functions for serializing and deserializing a SIGNDOC_SignatureData object:

Functions for getting information about the currently selected signature:

Functions for modifying the currently selected signature:

Other functions:

Member Function Documentation

int SIGNDOC_SignatureData_add	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj,
		const struct SIGNDOC_SignatureData *	aSource
	)

Add signatures from another SIGNDOC_SignatureData object.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_SIGNATURE and aSource has type SIGNDOC_SIGNATUREDATA_TYPE_SIGNATURE or SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, aObj will become a reference.

All involved signatures must have the same sample rate.

Parameters

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

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if the sample rates do not match.

See also: SIGNDOC_SignatureData_addEmptySignature(), SIGNDOC_SignatureData_addFromFile(), SIGNDOC_SignatureData_addFromFileW(), SIGNDOC_SignatureData_addFromMemory(), SIGNDOC_SignatureData_clear(), SIGNDOC_SignatureData_getType()

int SIGNDOC_SignatureData_addEmptySignature	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj
	)

Add an empty signature.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_SIGNATURE, it will become a reference. If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_SIGNATURE or SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, the new empty signature will inherit the sample rate and capture device ID of the existing signature.

The new signature will be the selected signature.

Parameters

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

Returns: SIGNDOC_RETURNCODE_OK if successful.

See also: SIGNDOC_SignatureData_add(), SIGNDOC_SignatureData_selectSignature()

int SIGNDOC_SignatureData_addFromFile	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj,
		int	aEncoding,
		const char *	aPath,
		unsigned	aFlags
	)

Add signatures from a file.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_SIGNATURE and the blob pointed to by aPtr contains a signature or a reference, aObj will become a reference.

This function opens the file, loads signatures from the file, and closes the file.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aEncoding	The encoding of the strings pointed to by aPath (SIGNDOC_ENCODING_NATIVE, SIGNDOC_ENCODING_UTF_8, or SIGNDOC_ENCODING_LATIN_1).
[in]	aPath	The pathname of the file to be read.
[in]	aFlags	Flags modifying the behavior of this function: SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_METERS SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_NO_FIX SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_NO_EXT_DATA

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if an argument is invalid or if the sample rates do not match or if the blob is invalid.

See also: SIGNDOC_SignatureData_add(), SIGNDOC_SignatureData_addFromFileW(), SIGNDOC_SignatureData_addFromMemory(), SIGNDOC_SignatureData_getType(), SIGNDOC_SignatureData_loadFromFile(), SIGNDOC_SignatureData_loadFromFileW()

int SIGNDOC_SignatureData_addFromFileW	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj,
		const wchar_t *	aPath,
		unsigned	aFlags
	)

Add signatures from a file.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_SIGNATURE and the blob pointed to by aPtr contains a signature or a reference, aObj will become a reference.

This function opens the file, loads signatures from the file, and closes the file.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aPath	The pathname of the file to be read.
[in]	aFlags	Flags modifying the behavior of this function: SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_METERS SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_NO_FIX SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_NO_EXT_DATA

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if an argument is invalid or if the sample rates do not match or if the blob is invalid.

See also: SIGNDOC_SignatureData_add(), SIGNDOC_SignatureData_addFromFile(), SIGNDOC_SignatureData_addFromMemory(), SIGNDOC_SignatureData_getType(), SIGNDOC_SignatureData_loadFromFile(), SIGNDOC_SignatureData_loadFromFileW()

int SIGNDOC_SignatureData_addFromMemory	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj,
		const unsigned char *	aPtr,
		size_t	aSize,
		unsigned	aFlags
	)

Add signatures from a blob.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_SIGNATURE and the blob pointed to by aPtr contains a signature or a reference, aObj will become a reference.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aPtr	A pointer to the first octet of a serialized SIGNDOC_SignatureData object, see SIGNDOC_SignatureData_saveToMemory().
[in]	aSize	Size in octets of the blob pointed to by aPtr.
[in]	aFlags	Flags modifying the behavior of this function: SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_METERS SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_NO_FIX SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_NO_EXT_DATA

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if an argument is invalid or if the sample rates do not match or if the blob is invalid.

See also: SIGNDOC_SignatureData_add(), SIGNDOC_SignatureData_addFromFile(), SIGNDOC_SignatureData_addFromFileW(), SIGNDOC_SignatureData_getType(), SIGNDOC_SignatureData_loadFromMemory()

int SIGNDOC_SignatureData_addSample	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj,
		int	aX,
		int	aY,
		int	aP,
		int	aT
	)

Add a sample.

This function fails if aT is -1 and aObj already contains a sample with time channel.

This function fails if aT is not -1 and aObj already contains a sample without time channel.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aX	X coordinate.
[in]	aY	Y coordinate.
[in]	aP	Pressure (or force), normalized to 0 through 1023. A sample with zero pressure is used for separating strokes.
[in]	aT	Relative time in milliseconds. Must be -1 if the biometric data does not have a time channel.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected or if if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY or if aP or aT is invalid.

See also: SIGNDOC_SignatureData_addEmptySignature(), SIGNDOC_SignatureData_clearSamples(), SIGNDOC_SignatureData_getDeviceSampleRate(), SIGNDOC_SignatureData_getTimeStamp(), SIGNDOC_SignatureData_selectSignature(), SIGNDOC_SignatureData_setTimeStamp()

void SIGNDOC_SignatureData_assign	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj,
		const struct SIGNDOC_SignatureData *	aSource
	)

SIGNDOC_SignatureData 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_SignatureData object.
[in]	aSource	The source object.

int SIGNDOC_SignatureData_checkReference	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		const struct SIGNDOC_CheckSignatureParameters *	aCheckSignatureParameters,
		const struct SIGNDOC_ImageParameters *	aImageParameters,
		SIGNDOC_Boolean *	aOutput
	)

Check biometric data of a reference for plausibility.

The static and dynamic qualities of a reference should be equal to or greater than a certain value and the variance should be below a certain value. The individual signatures should meet or exceed a certain size and contain a certain number of different pressure levels. The complexity of the individual signatures should be equal to or greater than a certain value.

This function throws an exception if aObj does not have type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE.

The following parameters are defined for aCheckSignatureParameters (see SIGNDOC_CheckSignatureParameters):

ReferenceMinSignatures (integer)
ReferenceMinDynamicQuality (integer)
ReferenceMinStaticQuality (integer)
ReferenceMaxDuration (integer)
ReferenceCheckSignatures (boolean)

Additionally, the following parameters will be used if the value of boolean parameter "ReferenceCheckSignatures" is SIGNDOC_TRUE:

SignatureMinWidth (integer)
SignatureMinHeight (integer)
SignatureMinPressureLevels (integer)
SignatureMinComplexity (integer)
SignatureMinSamples (integer)

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aCheckSignatureParameters	Parameters for checking a signature. Default parameters will be used if this argument is NULL.
[in]	aImageParameters	A pointer to parameters for rendering the signature as image, should be NULL for using default parameters.
[out]	aOutput	The result will be stored into the object pointed to by this argument: SIGNDOC_TRUE if the biometric data passes all checks, SIGNDOC_FALSE if the biometric data fails any check.

Returns: SIGNDOC_RETURNCODE_OK iff successful.

See also: SIGNDOC_SignatureData_checkSignature(), SIGNDOC_SignatureData_getDynamicQuality(), SIGNDOC_SignatureData_getStaticQuality(), SIGNDOC_SignatureData_selectSignature()

int SIGNDOC_SignatureData_checkSignature	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		const struct SIGNDOC_CheckSignatureParameters *	aCheckSignatureParameters,
		const struct SIGNDOC_ImageParameters *	aImageParameters,
		SIGNDOC_Boolean *	aOutput
	)

Check biometric data of a signature for plausibility.

A handwritten signature should meet or exceed a certain size and contain a certain number of different pressure levels. The static qualitiy of a signature should be equal to or greater than a certain value.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

The following parameters are defined for aParameters (see SIGNDOC_CheckSignatureParameters):

SignatureMinWidth (integer)
SignatureMinHeight (integer)
SignatureMinPressureLevels (integer)
SignatureMinComplexity (integer)
SignatureMinSamples (integer)

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aCheckSignatureParameters	Parameters for checking a signature. Default parameters will be used if this argument is NULL.
[in]	aImageParameters	A pointer to parameters for rendering the signature as image, should be NULL for using default parameters.
[out]	aOutput	The result will be stored into the object pointed to by this argument: SIGNDOC_TRUE if the biometric data passes all checks, SIGNDOC_FALSE if the biometric data fails any check.

Returns: SIGNDOC_RETURNCODE_OK iff successful.

See also: SIGNDOC_SignatureData_checkReference(), SIGNDOC_SignatureData_getComplexity(), SIGNDOC_SignatureData_selectSignature()

void SIGNDOC_SignatureData_clear	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj
	)

Remove all signatures.

SIGNDOC_SignatureData_getType() will return SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

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

See also: SIGNDOC_SignatureData_add(), SIGNDOC_SignatureData_addFromFile(), SIGNDOC_SignatureData_addFromFileW(), SIGNDOC_SignatureData_addFromMemory(), SIGNDOC_SignatureData_getType()

int SIGNDOC_SignatureData_clearSamples	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj
	)

Remove all samples from a signature.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

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

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected or if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

See also: SIGNDOC_SignatureData_addEmptySignature(), SIGNDOC_SignatureData_addSample(), SIGNDOC_SignatureData_selectSignature()

struct SIGNDOC_SignatureData * SIGNDOC_SignatureData_clone	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aSource
	)

Clone a SIGNDOC_SignatureData 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_SignatureData object.

See also: SIGNDOC_SignatureData_cloneSignature(), SIGNDOC_SignatureData_delete()

void SIGNDOC_SignatureData_delete ( struct SIGNDOC_SignatureData * aObj )

SIGNDOC_SignatureData destructor.

Parameters

[in] aObj A pointer to the SIGNDOC_SignatureData object.

See also: SIGNDOC_SignatureData_new()

int SIGNDOC_SignatureData_getComplexity	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		const struct SIGNDOC_ImageParameters *	aImageParameters,
		int *	aOutput
	)

Compute the complexity of a signature.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aImageParameters	A pointer to parameters for rendering the signature as image, should be NULL for using default parameters.
[out]	aOutput	The complexity of the signature in the range 0 (most simple) through 100 (most complex) will be stored into the object pointed to by this argument.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_checkSignature(), SIGNDOC_SignatureData_selectSignature()

int SIGNDOC_SignatureData_getDeviceId	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		int *	aOutput
	)

Get the capture device identifier.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[out]	aOutput	The capzure device identifier (see SIGNDOC_SIGNATUREDATA_CAPTUREDEVICE_UNKNOWN etc.) will be stored into the object pointed to by this argument.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_selectSignature(), SIGNDOC_SignatureData_setDeviceId

int SIGNDOC_SignatureData_getDeviceMaxPressure	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		int *	aOutput
	)

Get the maximum pressure (force) value of the capture device.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Note: The range of pressure (force) values recorded in the samples is always 0 through 1023.; Some capture device drivers record the number of pressure (force) values rather than the maxium pressure (force) value, that is, they make this function report a value that is off by one. See SIGNDOC_SignatureData_getDevicePressureLevels() which tries to work around that problem.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[out]	aOutput	The maximum pressure (force) value of the capture device will be stored into the object pointed to by this argument.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_selectSignature(), SIGNDOC_SignatureData_setDeviceMaxPressure

int SIGNDOC_SignatureData_getDevicePressureLevels	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		int *	aOutput
	)

Get the number of pressure (force) levels supported by the capture device.

Some capture device drivers record the number of pressure (force) values rather than the maxium pressure (force) value, that is, they SIGNDOC_SignatureData_getDeviceMaxPressure() report a value that is off by one. This function (SIGNDOC_SignatureData_getDevicePressureLevels()) tries to work around that problem. It either returns the same value as SIGNDOC_SignatureData_getDeviceMaxPressure() (if that value looks wrong) or that value plus one (if that value looks good).

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Note: The range of pressure (force) values recorded in the samples is always 0 through 1023.; Some capture device drivers record the number of pressure (force) values rather than the maxium pressure (force) value, that is, they make this function report a value that is off by one. See SIGNDOC_SignatureData_getDevicePressureLevels() which tries to work around that problem.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[out]	aOutput	The number of pressure (force) levels supported by the capture device will be stored into the object pointed to by this argument.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_getDeviceMaxPressure(), SIGNDOC_SignatureData_selectSignature(), SIGNDOC_SignatureData_setDeviceMaxPressure

int SIGNDOC_SignatureData_getDeviceResolution	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		int *	aOutput
	)

Get the spatial resolution of the capture device.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[out]	aOutput	The spatial resolution of the device in 1/inch will be stored into the object pointed to by this argument. This value is used for the X and Y coordinates.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_selectSignature(), SIGNDOC_SignatureData_setDeviceResolution

int SIGNDOC_SignatureData_getDeviceSampleRate	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		int *	aOutput
	)

Get the sample rate (temporal resolution) of the capture device.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[out]	aOutput	The number of samples per second (or 0 if the biometric data has a time channel) will be stored into the object pointed to by this argument.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_selectSignature(), SIGNDOC_SignatureData_setDeviceSampleRate

int SIGNDOC_SignatureData_getDeviceSerialNumber	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		struct SIGNDOC_ByteArray *	aOutput
	)

Get the serial number of the capture device.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Note: Most capture devices do not have a serial number.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in,out]	aOutput	The serial number as an array of bytes, empty if the capture device does not have a serial number.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_selectSignature(), SIGNDOC_SignatureData_setDeviceSerialNumber

int SIGNDOC_SignatureData_getDynamicQuality	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		int *	aOutput
	)

Compute the dynamic quality of a reference.

This function fails if aObj does not have type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[out]	aOutput	The dynamic quality in the range 0 (bad) through 100 (very good) will be stored into the object pointed to by this argument.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj is not a reference.

See also: SIGNDOC_SignatureData_checkReference(), SIGNDOC_SignatureData_getStaticQuality()

const char * SIGNDOC_SignatureData_getErrorMessage	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	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_SignatureData 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_SignatureData_getErrorMessageW()

const wchar_t * SIGNDOC_SignatureData_getErrorMessageW	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	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_SignatureData 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_SignatureData_getErrorMessage()

int SIGNDOC_SignatureData_getHeight	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		int *	aOutput
	)

Compute the height of the signature.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[out]	aOutput	The maximum Y coordinate minus the minimum Y coordinate will be stored into the object pointed to by this argument. Samples with non-positive pressure (force) value will be ignored, zero if there are no samples with positive pressure (force) value.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_getMaxY(), SIGNDOC_SignatureData_getMinY(), SIGNDOC_SignatureData_getSample(), SIGNDOC_SignatureData_getWidth(), SIGNDOC_SignatureData_selectSignature()

int SIGNDOC_SignatureData_getMaxP	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		int *	aOutput
	)

Compute the maximum pressure (force) value recorded in the biometric data.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[out]	aOutput	The maximum pressure (force) value (0 through 1023) will be stored into the object pointed to by this argument. Zero if there are no samples.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_getDeviceMaxPressure(), SIGNDOC_SignatureData_getDevicePressureLevels(), SIGNDOC_SignatureData_getSample(), SIGNDOC_SignatureData_selectSignature()

int SIGNDOC_SignatureData_getMaxX	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		int *	aOutput
	)

Compute the maximum X coordinate recorded in the biometric data.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[out]	aOutput	The maximum X coordinate will be stored into the object pointed to by this argument. Samples with non-positive pressure (force) value will be ignored, zero if there are no samples with positive pressure (force) value.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_getHeight(), SIGNDOC_SignatureData_getMaxY(), SIGNDOC_SignatureData_getMinX(), SIGNDOC_SignatureData_getMinY(), SIGNDOC_SignatureData_getSample(), SIGNDOC_SignatureData_getWidth(), SIGNDOC_SignatureData_selectSignature()

int SIGNDOC_SignatureData_getMaxY	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		int *	aOutput
	)

Compute the maximum Y coordinate recorded in the biometric data.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[out]	aOutput	The maximum Y coordinate will be stored into the object pointed to by this argument. Samples with non-positive pressure (force) value will be ignored, zero if there are no samples with positive pressure (force) value.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_getHeight(), SIGNDOC_SignatureData_getMaxX(), SIGNDOC_SignatureData_getMinX(), SIGNDOC_SignatureData_getMinY(), SIGNDOC_SignatureData_getSample(), SIGNDOC_SignatureData_getWidth(), SIGNDOC_SignatureData_selectSignature()

int SIGNDOC_SignatureData_getMinX	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		int *	aOutput
	)

Compute the minimum X coordinate recorded in the biometric data.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[out]	aOutput	The minimum X coordinate will be stored into the object pointed to by this argument. Samples with non-positive pressure (force) value will be ignored, zero if there are no samples with positive pressure (force) value.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_getHeight(), SIGNDOC_SignatureData_getMaxX(), SIGNDOC_SignatureData_getMaxY(), SIGNDOC_SignatureData_getMinY(), SIGNDOC_SignatureData_getSample(), SIGNDOC_SignatureData_getWidth(), SIGNDOC_SignatureData_selectSignature()

int SIGNDOC_SignatureData_getMinY	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		int *	aOutput
	)

Compute the minimum Y coordinate recorded in the biometric data.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[out]	aOutput	The minimum Y coordinate will be stored into the object pointed to by this argument. Samples with non-positive pressure (force) value will be ignored, zero if there are no samples with positive pressure (force) value.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_getHeight(), SIGNDOC_SignatureData_getMaxX(), SIGNDOC_SignatureData_getMaxY(), SIGNDOC_SignatureData_getMinX(), SIGNDOC_SignatureData_getSample(), SIGNDOC_SignatureData_getWidth(), SIGNDOC_SignatureData_selectSignature()

int SIGNDOC_SignatureData_getNumberOfSamples	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		int *	aOutput
	)

Get the number of samples.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[out]	aOutput	The number of samples will be stored into the object pointed to by this argument.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_getSample(), SIGNDOC_SignatureData_selectSignature()

int SIGNDOC_SignatureData_getNumberOfSignatures	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj
	)

Get the number of signatures in a SIGNDOC_SignatutreData object.

References contain two or more signatures, objects of type SIGNDOC_SIGNATUREDATA_TYPE_SIGNATURE contain one signature, objects of type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY contain zero signatures.

Parameters

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

Returns: The number of signatures.

See also: SIGNDOC_SignatureData_getType(), SIGNDOC_SignatureData_isEmpty(), SIGNDOC_SignatureData_isReference(), SIGNDOC_SignatureData_isSignature()

int SIGNDOC_SignatureData_getSample	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		int	aIndex,
		int *	aX,
		int *	aY,
		int *	aP,
		int *	aT
	)

Get a sample.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aIndex	The 0-based index of the sample.
[out]	aX	The X coordinate will be stored into the object pointed by this argument (the value will not be stored if this argument is NULL).
[out]	aY	The Y coordinate will be stored into the object pointed by this argument (the value will not be stored if this argument is NULL).
[out]	aP	The pressure (force) will be stored into the object pointed by this argument (the value will not be stored if this argument is NULL). The value is normalized to 0 through 1023. A sample with zero pressure is used for separating strokes.
[out]	aT	The Relative time in milliseconds will be stored into the object pointed by this argument (the value will not be stored if this argument is NULL).

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected or if aIndex is out of range.

See also: SIGNDOC_SignatureData_getNumberOfSamples(), SIGNDOC_SignatureData_selectSignature()

int SIGNDOC_SignatureData_getSelectedSignature	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj
	)

Get the index of the currently selected signature.

Parameters

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

Returns: The index of the currently selected signature or -1 if no signature is selected.

See also: SIGNDOC_SignatureData_selectSignature()

int SIGNDOC_SignatureData_getStaticQuality	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		const struct SIGNDOC_ImageParameters *	aImageParameters,
		int *	aOutput
	)

Compute the static quality of a reference.

This function fails if aObj does not have type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aImageParameters	Parameters for rendering the signature as image, should be NULL for using default parameters.
[out]	aOutput	The smallest static match quality encountered (0 through 100) will be stored into the object pointed to by this argument.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj is not a reference.

See also: SIGNDOC_SignatureData_checkReference(), SIGNDOC_SignatureData_getDynamicQuality()

int SIGNDOC_SignatureData_getTimeStamp	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		unsigned *	aOutput
	)

Get the capture time stamp.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[out]	aOutput	The capture time in seconds since 1970-01-01T00:00Z will be stored into the object pointed to by this argument. Zero if the time stamp is not available.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_selectSignature(), SIGNDOC_SignatureData_setTimeStamp

int SIGNDOC_SignatureData_getType	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj
	)

Get the type of handwritten signatures stored in a SIGNDOC_SignatureData object.

Parameters

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

Returns: The type of aObj: SIGNDOC_SIGNATUREDATA_TYPE_EMPTY, SIGNDOC_SIGNATUREDATA_TYPE_SIGNATURE, or SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE.

See also: SIGNDOC_SignatureData_getNumberOfSignatures(), SIGNDOC_SignatureData_isEmpty(), SIGNDOC_SignatureData_isReference(), SIGNDOC_SignatureData_isSignature(), SIGNDOC_SIGNATUREDATA_TYPE_EMPTY, SIGNDOC_SIGNATUREDATA_TYPE_SIGNATURE, SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE

int SIGNDOC_SignatureData_getWidth	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		int *	aOutput
	)

Compute the width of the signature.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[out]	aOutput	The maximum X coordinate minus the minimum X coordinate will be stored into the object pointed to by this argument. Samples with non-positive pressure (force) value will be ignored, zero if there are no samples with positive pressure (force) value.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_getHeight(), SIGNDOC_SignatureData_getMaxX(), SIGNDOC_SignatureData_getMinX(), SIGNDOC_SignatureData_getSample(), SIGNDOC_SignatureData_selectSignature()

SIGNDOC_Boolean SIGNDOC_SignatureData_hasTimeChannel	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj
	)

Check if the biometric data has a time channel.

This function returns SIGNDOC_FALSE if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY or if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected with SIGNDOC_SignatureData_selectSignature().

Parameters

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

Returns: SIGNDOC_TRUE iff the biometric data has a time channel.

See also: SIGNDOC_SignatureData_getSample(), SIGNDOC_SignatureData_getNumberOfSamples(), SIGNDOC_SignatureData_selectSignature()

SIGNDOC_Boolean SIGNDOC_SignatureData_isEmpty	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj
	)

Check if a SIGNDOC_SignatureData object is empty.

Parameters

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

Returns: SIGNDOC_TRUE iff SIGNDOC_SignatureData_getType() returns SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

See also: SIGNDOC_SignatureData_getType(), SIGNDOC_SignatureData_isReference(), SIGNDOC_SignatureData_isSignature()

SIGNDOC_Boolean SIGNDOC_SignatureData_isReference	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj
	)

Check if a SIGNDOC_SignatureData object contains a reference.

Parameters

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

Returns: SIGNDOC_TRUE iff SIGNDOC_SignatureData_getType() returns SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE.

See also: SIGNDOC_SignatureData_getType(), SIGNDOC_SignatureData_isEmpty(), SIGNDOC_SignatureData_isSignature()

SIGNDOC_Boolean SIGNDOC_SignatureData_isSignature	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj
	)

Check if a SIGNDOC_SignatureData object contains a signature.

Parameters

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

Returns: SIGNDOC_TRUE iff SIGNDOC_SignatureData_getType() returns SIGNDOC_SIGNATUREDATA_TYPE_SIGNATURE.

See also: SIGNDOC_SignatureData_getType(), SIGNDOC_SignatureData_isEmpty(), SIGNDOC_SignatureData_isReference()

int SIGNDOC_SignatureData_loadFromFile	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj,
		int	aEncoding,
		const char *	aPath,
		unsigned	aFlags
	)

Load (deserialize) signatures from a file.

This function is equivalent to SIGNDOC_SignatureData_clear() followed by SIGNDOC_SignatureData_addFromFile().

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aEncoding	The encoding of the strings pointed to by aPath (SIGNDOC_ENCODING_NATIVE, SIGNDOC_ENCODING_UTF_8, or SIGNDOC_ENCODING_LATIN_1).
[in]	aPath	The pathname of the file to be read.
[in]	aFlags	Flags modifying the behavior of this function: SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_METERS SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_NO_FIX SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_NO_EXT_DATA

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if an argument is invalid or if the blob is invalid.

See also: SIGNDOC_SignatureData_add(), SIGNDOC_SignatureData_addFromFile(), SIGNDOC_SignatureData_getType(), SIGNDOC_SignatureData_loadFromFileW(), SIGNDOC_SignatureData_loadFromMemory()

int SIGNDOC_SignatureData_loadFromFileW	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj,
		const wchar_t *	aPath,
		unsigned	aFlags
	)

Load (deserialize) signatures from a file.

This function is equivalent to SIGNDOC_SignatureData_clear() followed by SIGNDOC_SignatureData_addFromFile().

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aPath	The pathname of the file to be read.
[in]	aFlags	Flags modifying the behavior of this function: SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_METERS SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_NO_FIX SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_NO_EXT_DATA

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if an argument is invalid or if the blob is invalid.

See also: SIGNDOC_SignatureData_add(), SIGNDOC_SignatureData_addFromFile(), SIGNDOC_SignatureData_getType(), SIGNDOC_SignatureData_loadFromFile(), SIGNDOC_SignatureData_loadFromMemory()

int SIGNDOC_SignatureData_loadFromMemory	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj,
		const unsigned char *	aPtr,
		size_t	aSize,
		unsigned	aFlags
	)

Load (deserialize) signatures from a blob.

This function is equivalent to SIGNDOC_SignatureData_clear() followed by SIGNDOC_SignatureData_addFromMemory().

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aPtr	A pointer to the first octet of a serialized SIGNDOC_SignatureData object, see SIGNDOC_SignatureData_saveToMemory().
[in]	aSize	Size in octets of the blob pointed to by aPtr.
[in]	aFlags	Flags modifying the behavior of this function: SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_METERS SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_NO_FIX SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_NO_EXT_DATA

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if an argument is invalid or if the blob is invalid.

See also: SIGNDOC_SignatureData_add(), SIGNDOC_SignatureData_addFromMemory(), SIGNDOC_SignatureData_getType(), SIGNDOC_SignatureData_loadFromFile(), SIGNDOC_SignatureData_loadFromFileW()

int SIGNDOC_SignatureData_matchReference	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		const struct SIGNDOC_SignatureData *	aOther,
		const struct SIGNDOC_MatchParameters *	aMatchParameters,
		const struct SIGNDOC_ImageParameters *	aImageParameters,
		struct SIGNDOC_MatchResult **	aOutput
	)

Match a reference against a single signature.

This function fails if aObj does not have type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE.

If aOther has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must have been called at least once for aOther to select the signature to match against.

SIGNDOC_SignatureData_matchSignature() matches a single signature against a single signature or a reference, SIGNDOC_SignatureData_matchReference() matches a reference against a single signature.

The license must allow comparing signatures.

Note: This function is not symmetric: if aOther has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, only one signature in that reference will be matched against the reference in aObj.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aOther	The signature to match against.
[in]	aMatchParameters	Parameters controlling how signature are matched. If this argument is NULL, all parameters will be set to their respective default value.
[in]	aImageParameters	Parameters controlling how signature are rendered as images for static matching. If this argument is NULL, all parameters will be set to their respective default value. String parameter "Format" will be ignored.
[out]	aOutput	A pointer to a new SIGNDOC_MatchResult object or NULL will be stored here. The caller is responsible for destroying that object.

Returns: SIGNDOC_RETURNCODE_OK iff successful.

See also: SIGNDOC_SignatureData_matchSignature(), SIGNDOC_SignatureData_selectSignature(), SIGNDOC_Image_matchReference()

int SIGNDOC_SignatureData_matchSignature	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		const struct SIGNDOC_SignatureData *	aOther,
		const struct SIGNDOC_MatchParameters *	aMatchParameters,
		const struct SIGNDOC_ImageParameters *	aImageParameters,
		struct SIGNDOC_MatchResult **	aOutput
	)

Match a single signature against another signature or a reference.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj does not have type SIGNDOC_SIGNATUREDATA_TYPE_SIGNATURE or SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE.

SIGNDOC_SignatureData_matchSignature() matches a single signature against a single signature or a reference, SIGNDOC_SignatureData_matchReference() matches a reference against a single signature.

The license must allow comparing signatures.

Note: This function is not symmetric: if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, only one signature in that reference will be matched against aOther. On the other hand, if aOther has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, all signatures in that reference will be matched against.; Only the static matching engine can match a single signature against a single signature.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aOther	The signature or reference to match against.
[in]	aMatchParameters	Parameters controlling how signature are matched. If this argument is NULL, all parameters will be set to their respective default value.
[in]	aImageParameters	Parameters controlling how signature are rendered as images for static matching. If this argument is NULL, all parameters will be set to their respective default value. String parameter "Format" will be ignored.
[out]	aOutput	A pointer to a new SIGNDOC_MatchResult object or NULL will be stored here. The caller is responsible for destroying that object.

Returns: SIGNDOC_RETURNCODE_OK iff successful.

See also: SIGNDOC_SignatureData_matchReference(), SIGNDOC_SignatureData_selectSignature(), SIGNDOC_Image_matchSignature()

int SIGNDOC_SignatureData_mirrorY	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj
	)

Mirror signatures vertically.

The signatures are mirrored such that for each signature the range of Y coordinates is not changed.

There is no function for mirroring a single signature of a reference.

Parameters

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

Returns: SIGNDOC_RETURNCODE_OK if successful.

struct SIGNDOC_SignatureData * SIGNDOC_SignatureData_new ( struct SIGNDOC_Exception ** aEx )

SIGNDOC_SignatureData constructor.

The new SIGNDOC_SignatureData object won't contain any signature. SIGNDOC_SignatureData_getType() will return SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Use SIGNDOC_SignatureData_loadFromFile(), SIGNDOC_SignatureData_saveToFileW(), or SIGNDOC_SignatureData_loadFromMemory() to load signatures. Use SIGNDOC_SignatureData_add(), SIGNDOC_SignatureData_addEmptySignature(), SIGNDOC_SignatureData_addFromFile(), SIGNDOC_SignatureData_addFromFileW(), and SIGNDOC_SignatureData_addFromMemory() to add signatures.

Parameters

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

Returns: A pointer to the new SIGNDOC_SignatureData object.

See also: SIGNDOC_SignatureData_add(), SIGNDOC_SignatureData_addFromFile(), SIGNDOC_SignatureData_addFromFileW(), SIGNDOC_SignatureData_addFromMemory(), SIGNDOC_SignatureData_delete(), SIGNDOC_SignatureData_getType()

int SIGNDOC_SignatureData_renderAsImage	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		struct SIGNDOC_ByteArray *	aImage,
		const struct SIGNDOC_ImageParameters *	aImageParameters,
		struct SIGNDOC_RenderOutput *	aOutput
	)

Render a signature as image (returned as a blob).

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

The following parameter in aImageParameters is mandatory:

Format (string)

There are three ways to specify the size of the image:

Set integer parameter "Resolution". This requires the spatial resolution of the capture device to be correctly recorded (see SIGNDOC_SignatureData_getDeviceResolution()). Coordinates will be scaled such that the resulting image will have the specified resolution. Floating-point parmateter "Zoom" must not be set. If integer parameter "Width" or "Height" (or both) are set, the resolution will be reduced (if needed) such that the image width or height (or both) won't exceed the specified values.
Set integer parameters "Width" or "Height" parameter (or both). Integer parameter "Resolution" and floating-point parameter "Zoom" must not be set. Coordinates will be scaled such that the with or height (or both) of the image won't exceed the specified sizes.
Set floating-point parameter "Zoom". Convert sample coordinates to image coordinates by multiplying them with the specified number. If integer parameter "Resolution" is set, the image resolution will be set to the specified value (but that value won't affect scaling). Integer parameters "Width" and "Height" must not be set.

The license must allow rendering signatures.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[out]	aImage	The rendered image will be stored here.
[in]	aImageParameters	Parameters controlling how the signature is rendered.
[out]	aOutput	The image size will be stored here. You can pass NULL if you don't need the image size. This argument must not be NULL for raw format.

Returns: SIGNDOC_RETURNCODE_OK if successful.

See also: SIGNDOC_SignatureData_renderAsSignDocImage()

int SIGNDOC_SignatureData_renderAsSignDocImage	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		const struct SIGNDOC_ImageParameters *	aImageParameters,
		struct SIGNDOC_Image **	aImage
	)

Render a signature as image (returned as a SIGNDOC_Image object).

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

See SIGNDOC_SignatureData_renderAsImage() for details. String parameter "Format" is ignored by this function.

The license must allow rendering signatures.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aImageParameters	Parameters controlling how the signature is rendered.
[out]	aImage	A pointer to the new SIGNDOC_Image object will be stored here. The caller is responsible for destroying the object.

Returns: SIGNDOC_RETURNCODE_OK iff successful.

See also: SIGNDOC_SignatureData_renderAsImage(), SIGNDOC_Image_delete()

int SIGNDOC_SignatureData_saveToFile	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		int	aEncoding,
		const char *	aPath,
		int	aFormat
	)

Serialize a SIGNDOC_SignatureData object to a file.

Empty objects can be serialized only if aFormat is SIGNDOC_SIGNATUREDATA_FORMAT_SOFTPRO.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aEncoding	The encoding of the strings pointed to by aPath (SIGNDOC_ENCODING_NATIVE, SIGNDOC_ENCODING_UTF_8, or SIGNDOC_ENCODING_LATIN_1).
[in]	aPath	The pathname of the file to be created or overwritten.
[in]	aFormat	Format to be used: either SIGNDOC_SIGNATUREDATA_FORMAT_SOFTPRO or a combination (bitwise or) of up to one constant from each of the following three groups: version of ISO/IEC 19794-7: SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19794_7_2007TC1 (superseded) or SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19794_7_2014 (recommended) data format: SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19794_7_FULL (default); compact format, compression format, and XML are currently not supported CBEFF wrapper: SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19785_3_NONE (default), SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19785_3_FORMAT2, SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19785_3_FORMAT3, or SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19785_3_FORMAT6 For some formats, you can additionally include (bitwise or) these flags: SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_METERS SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_COMPAT1 SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_NO_EXT_DATA

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aFormat is invalid.

See also: SIGNDOC_SignatureData_addFromFile(), SIGNDOC_SignatureData_getErrorMessage(), SIGNDOC_SignatureData_loadFromFile(), SIGNDOC_SignatureData_saveToFileW(), SIGNDOC_SignatureData_saveToMemory()

int SIGNDOC_SignatureData_saveToFileW	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		const wchar_t *	aPath,
		int	aFormat
	)

Serialize a SIGNDOC_SignatureData object to a file.

Empty objects can be serialized only if aFormat is SIGNDOC_SIGNATUREDATA_FORMAT_SOFTPRO.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aPath	The pathname of the file to be created or overwritten.
[in]	aFormat	Format to be used: either SIGNDOC_SIGNATUREDATA_FORMAT_SOFTPRO or a combination (bitwise or) of up to one constant from each of the following three groups: version of ISO/IEC 19794-7: SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19794_7_2007TC1 (superseded) or SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19794_7_2014 (recommended) data format: SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19794_7_FULL (default); compact format, compression format, and XML are currently not supported CBEFF wrapper: SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19785_3_NONE (default), SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19785_3_FORMAT2, SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19785_3_FORMAT3, or SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19785_3_FORMAT6 For some formats, you can additionally include (bitwise or) these flags: SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_METERS SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_COMPAT1 SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_NO_EXT_DATA

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aFormat is invalid.

See also: SIGNDOC_SignatureData_addFromFile(), SIGNDOC_SignatureData_getErrorMessage(), SIGNDOC_SignatureData_loadFromFile(), SIGNDOC_SignatureData_saveToFile(), SIGNDOC_SignatureData_saveToMemory()

int SIGNDOC_SignatureData_saveToMemory	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_SignatureData *	aObj,
		struct SIGNDOC_ByteArray *	aOutput,
		int	aFormat
	)

Serialize a SIGNDOC_SignatureData object to a blob.

Empty objects can be serialized only if aFormat is SIGNDOC_SIGNATUREDATA_FORMAT_SOFTPRO.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in,out]	aOutput	The serialized data will be stored here.
[in]	aFormat	Format to be used: either SIGNDOC_SIGNATUREDATA_FORMAT_SOFTPRO or a combination (bitwise or) of up to one constant from each of the following three groups: version of ISO/IEC 19794-7: SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19794_7_2007TC1 (superseded) or SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19794_7_2014 (recommended) data format: SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19794_7_FULL (default); compact format, compression format, and XML are currently not supported CBEFF wrapper: SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19785_3_NONE (default), SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19785_3_FORMAT2, SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19785_3_FORMAT3, or SIGNDOC_SIGNATUREDATA_FORMAT_ISO_19785_3_FORMAT6 For some formats, you can additionally include (bitwise or) these flags: SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_METERS SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_COMPAT1 SIGNDOC_SIGNATUREDATA_FORMAT_ISO_FLAG_NO_EXT_DATA

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aFormat is invalid.

See also: SIGNDOC_SignatureData_addFromMemory(), SIGNDOC_SignatureData_getErrorMessage(), SIGNDOC_SignatureData_loadFromMemory(), SIGNDOC_SignatureData_saveToFile(), SIGNDOC_SignatureData_saveToFileW()

int SIGNDOC_SignatureData_selectSignature	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj,
		int	aIndex
	)

Select a signature for most functions operating on a single signature.

If aObj contains a single signature (SIGNDOC_SignatureData_getType() returns SIGNDOC_SIGNATUREDATA_TYPE_SIGNATURE), SIGNDOC_SignatureData_selectSignature() need not be called. If aObj contains a multiple signatures (SIGNDOC_SignatureData_getType() returns SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE), SIGNDOC_SignatureData_selectSignature() must be called before any of these functions can be used:

The following functions also have an effect on what signature is selected:

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aIndex	0-based index of the signature to be selected.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aIndex is out of range.

See also: SIGNDOC_SignatureData_addEmptySignature(), SIGNDOC_SignatureData_addSample(), SIGNDOC_SignatureData_clear(), SIGNDOC_SignatureData_clearSamples(), SIGNDOC_SignatureData_cloneSignature(), SIGNDOC_SignatureData_getComplexity(), SIGNDOC_SignatureData_getDeviceId(), SIGNDOC_SignatureData_getDeviceMaxPressure(), SIGNDOC_SignatureData_getDevicePressureLevels(), SIGNDOC_SignatureData_getDeviceResolution(), SIGNDOC_SignatureData_getDeviceSampleRate(), SIGNDOC_SignatureData_getDeviceSerialNumber(), SIGNDOC_SignatureData_getHeight(), SIGNDOC_SignatureData_getMaxP(), SIGNDOC_SignatureData_getMaxX(), SIGNDOC_SignatureData_getMaxY(), SIGNDOC_SignatureData_getMinX(), SIGNDOC_SignatureData_getMinY(), SIGNDOC_SignatureData_getNumberOfSamples(), SIGNDOC_SignatureData_getNumberOfSignatures(), SIGNDOC_SignatureData_getSample(), SIGNDOC_SignatureData_getSelectedSignature(), SIGNDOC_SignatureData_getTimeStamp(), SIGNDOC_SignatureData_getWidth(), SIGNDOC_SignatureData_loadFromFile(), SIGNDOC_SignatureData_loadFromFileW(), SIGNDOC_SignatureData_loadFromMemory(), SIGNDOC_SignatureData_matchReference(), SIGNDOC_SignatureData_matchSignature(), SIGNDOC_SignatureData_renderAsImage(), SIGNDOC_SignatureData_renderAsSignDocImage(), SIGNDOC_SignatureData_setDeviceId(), SIGNDOC_SignatureData_setDeviceMaxPressure(), SIGNDOC_SignatureData_setDeviceResolution(), SIGNDOC_SignatureData_setDeviceSampleRate(), SIGNDOC_SignatureData_setDeviceSerialNumber(), SIGNDOC_SignatureData_setTimeStamp()

int SIGNDOC_SignatureData_setDeviceId	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj,
		int	aDeviceId
	)

Set the capture device identifier.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aDeviceId	The new capture device identifier, see SIGNDOC_SIGNATUREDATA_CAPTUREDEVICE_UNKNOWN etc.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_getDeviceId, SIGNDOC_SignatureData_selectSignature()

int SIGNDOC_SignatureData_setDeviceMaxPressure	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj,
		int	aDeviceMaxPressure
	)

Set the maximum pressure (force) value of the capture device.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Note: The range of pressure (force) values recorded in the samples is always 0 through 1023.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aDeviceMaxPressure	The new maximum pressure (force) value of the capture device.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_getDeviceMaxPressure(), SIGNDOC_SignatureData_getDevicePressureLevels(), SIGNDOC_SignatureData_selectSignature()

int SIGNDOC_SignatureData_setDeviceResolution	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj,
		int	aDeviceResolution
	)

Set the spatial resolution of the capture device.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aDeviceResolution	The new device resolution in 1/inch. This value is used for the X and Y coordinates.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_getDeviceResolution, SIGNDOC_SignatureData_selectSignature()

int SIGNDOC_SignatureData_setDeviceSampleRate	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj,
		int	aDeviceSampleRate
	)

Set the sample rate (temporal resolution) of the capture device.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aDeviceSampleRate	The new number of samples per second or 0 if the biometric data has a time channel.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_getDeviceSampleRate, SIGNDOC_SignatureData_selectSignature()

int SIGNDOC_SignatureData_setDeviceSerialNumber	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj,
		const unsigned char *	aPtr,
		size_t	aSize
	)

Set the serial number of the capture device.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aPtr	A pointer to the first octet of the new serial number of the capture device.
[in]	aSize	The number of octets in the new serial number (0 through 20).

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_getDeviceSerialNumber, SIGNDOC_SignatureData_selectSignature()

int SIGNDOC_SignatureData_setTimeStamp	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_SignatureData *	aObj,
		unsigned	aTimeStamp
	)

Set the capture time stamp.

If aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE, SIGNDOC_SignatureData_selectSignature() must be called once before this function.

This function fails if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_EMPTY.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_SignatureData object.
[in]	aTimeStamp	The capture time in seconds since 1970-01-01T00:00Z or zero if the time stamp is not available.

Returns: SIGNDOC_RETURNCODE_OK if successful, SIGNDOC_RETURNCODE_INVALID_ARGUMENT if aObj has type SIGNDOC_SIGNATUREDATA_TYPE_REFERENCE and no signature has been selected.

See also: SIGNDOC_SignatureData_getTimeStamp, SIGNDOC_SignatureData_selectSignature()

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

SignDocSDK-c.h

Public Member Functions

Detailed Description

Member Function Documentation