SignDocMatchParameters Class Reference

Parameters for SignDocSignatureData.matchSignature(), SignDocSignatureData.matchReference(), SignDocImage.matchSignature(), and SignDocImage.matchReference(). More...

Public Member Functions
	~SignDocMatchParameters ()
	Destructor. More...
	!SignDocMatchParameters ()
	Finalizer. More...
	SignDocMatchParameters ()
	Constructor. More...
	SignDocMatchParameters (SignDocMatchParameters aSource)
	Copy constructor. More...
void	clear ()
	Unset all parameters. More...
void	setBoolean (out ReturnCode aReturnCode, string aName, bool aValue)
	Set a boolean parameter. More...
void	setInteger (out ReturnCode aReturnCode, string aName, int aValue)
	Set an integer parameter. More...
bool?	getBoolean (string aName)
	Get the value of a boolean parameter. More...
int?	getInteger (string aName)
	Get the value of an integer parameter. More...
string	getErrorMessage ()
	Get an error message for the last function call. More...

Static Public Member Functions
static MatchParameterType	getType (string aName)
	Get the type of a parameter. More...

Detailed Description

Parameters for SignDocSignatureData.matchSignature(), SignDocSignatureData.matchReference(), SignDocImage.matchSignature(), and SignDocImage.matchReference().

Constructor & Destructor Documentation

~SignDocMatchParameters

(

)

Destructor.

!SignDocMatchParameters

(

)

Finalizer.

SignDocMatchParameters

(

)

Constructor.

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

SignDocMatchParameters

(

SignDocMatchParameters

aSource

)

Copy constructor.

Parameters

[in]

aSource

The object to be copied.

Member Function Documentation

void clear

(

)

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.

bool? getBoolean

(

string

aName

)

Get the value of a boolean parameter.

This function does not set an error message.

Parameters

[in]

aName

The name of the parameter (case-sensitive).

Returns

The value of the specified parameter or null if the parameter is not set or is not a boolean parameter.

See also

setBoolean()

string getErrorMessage

(

)

Get an error message for the last function call.

Returns

A string describing the reason for the failure of the last function call. The string is empty if the last call succeeded.

int? getInteger

(

string

aName

)

Get the value of an integer parameter.

This function does not set an error message.

Parameters

[in]

aName

The name of the parameter (case-sensitive).

Returns

The value of the specified parameter or null if the parameter is not set or is not an integer parameter.

See also

setInteger()

static MatchParameterType getType ( string  aName )

static

Get the type of a parameter.

Parameters

[in]

aName

The name of the parameter (case-sensitive).

Returns

The type of the parameter, see enum MatchParameterType.

void setBoolean	(	out ReturnCode	aReturnCode,
		string	aName,
		bool	aValue
	)

Set a boolean parameter.

The following boolean parameters are available:

• EngineAuto: see MatchParametersFlags.EngineAuto
• EngineDStat: see MatchParametersFlags.EngineDStat
• EngineDynamic: see MatchParametersFlags.EngineDynamic
• EngineStatic: see MatchParametersFlags.EngineStatic
• KeepResolution: see MatchParametersFlags.KeepResolution
• Mirror: see MatchParametersFlags.Mirror
• NormalizeSampleRates: see MatchParametersFlags.NormalizeSampleRates

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

Parameters

[out]	aReturnCode	The return code, ReturnCode.OK if successful, ReturnCode.UnknownParameter if aName is not the name of a boolean parameter.
[in]	aName	The name of the parameter (case-sensitive).
[in]	aValue	The value of the parameter.

See also

getBoolean(), setInteger()

void setInteger	(	out ReturnCode	aReturnCode,
		string	aName,
		int	aValue
	)

Set an integer parameter.

The following integer parameters are available:

• Flags: set of flags controlling matching behavior:
  • MatchParametersFlags.EngineAuto
  • MatchParametersFlags.EngineDStat
  • MatchParametersFlags.EngineDynamic
  • MatchParametersFlags.EngineStatic
  • MatchParametersFlags.KeepResolution
  • MatchParametersFlags.Mirror
  • MatchParametersFlags.NormalizeSampleRates
• MaxResolution: maximum resolution for MatchParametersFlags.KeepResolution, 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]	aReturnCode	The return code, ReturnCode.OK if successful, ReturnCode.UnknownParameter if aName is not the name of an integer parameter, ReturnCode.InvalidValue if aValue is invalid.
[in]	aName	The name of the parameter (case-sensitive).
[in]	aValue	The value of the parameter.

See also

getInteger(), setBoolean()

---

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

• SignDocDotNet.cs