SignDoc SDK (.NET without exceptions)  5.0.0
SignDocMatchResult Class Reference

Result of SignDocSignatureData.matchSignature(), SignDocSignatureData.matchReference(), SignDocImage.matchSignature(), and SignDocImage.matchReference(). More...

Public Member Functions

 ~SignDocMatchResult ()
 Destructor. More...
 
 !SignDocMatchResult ()
 Finalizer. More...
 
 SignDocMatchResult ()
 Constructor. More...
 
int getNumberOfStaticResults (out ReturnCode aReturnCode)
 Get the number of results for the static matching engine. More...
 
int getDynamicMatchQuality (out ReturnCode aReturnCode)
 Get the dynamic match quality. More...
 
int getDStatMatchQuality (out ReturnCode aReturnCode)
 Get the DStat match quality. More...
 
int getStaticMatchQuality (out ReturnCode aReturnCode, int aIndex)
 Get the static match quality. More...
 
bool getResult (out ReturnCode aReturnCode)
 Get the overall match result. More...
 
bool getDynamicResult (out ReturnCode aReturnCode)
 Get the dynamic match result. More...
 
bool getDStatResult (out ReturnCode aReturnCode)
 Get the DStat match result. More...
 
bool getStaticResult (out ReturnCode aReturnCode, int aIndex)
 Get a static match result. More...
 
string getErrorMessage ()
 Get an error message for the last function call. More...
 

Detailed Description

Constructor & Destructor Documentation

Destructor.

Finalizer.

Constructor.

No results will be set.

Member Function Documentation

int getDStatMatchQuality ( out ReturnCode  aReturnCode)

Get the DStat match quality.

Parameters
[out]aReturnCodeThe return code, ReturnCode.OK iff successful.
Returns
The match quality (0 through 100) computed by the DStat engine or a negative value if the DStat match quality has not been computed.
See also
getDStatResult(), getDynamicMatchQuality(), getStaticMatchQuality()
bool getDStatResult ( out ReturnCode  aReturnCode)

Get the DStat match result.

Parameters
[out]aReturnCodeThe return code, ReturnCode.OK iff successful.
Returns
true for a match reported by the DStat matching engine, false otherwise.
See also
getDStatMatchQuality(), getResult()
int getDynamicMatchQuality ( out ReturnCode  aReturnCode)

Get the dynamic match quality.

Parameters
[out]aReturnCodeThe return code, ReturnCode.OK iff successful.
Returns
The match quality (0 through 100) computed by the dynamic matching engine or a negative value if the dynamic match quality has not been computed.
See also
getDStatMatchQuality(), getDynamicResult(), getStaticMatchQuality()
bool getDynamicResult ( out ReturnCode  aReturnCode)

Get the dynamic match result.

Parameters
[out]aReturnCodeThe return code, ReturnCode.OK iff successful.
Returns
true for a match reported by the dynamic matching engine, false otherwise.
See also
getDynamicMatchQuality(), getResult()
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 getNumberOfStaticResults ( out ReturnCode  aReturnCode)

Get the number of results for the static matching engine.

References contain more than one signature, therefore there are multiple results for the static matching engine, one per signature in the reference.

Parameters
[out]aReturnCodeThe return code, ReturnCode.OK iff successful.
Returns
The number of results.
See also
getStaticMatchQuality(), getStaticResult()
bool getResult ( out ReturnCode  aReturnCode)

Get the overall match result.

Parameters
[out]aReturnCodeThe return code, ReturnCode.OK iff successful.
Returns
true if all signatures match for all enabled matching engines, false otherwise.
See also
getDStatResult(), getDynamicResult(), getStaticResult()
int getStaticMatchQuality ( out ReturnCode  aReturnCode,
int  aIndex 
)

Get the static match quality.

References contain more than one signature, therefore there are multiple results for the static matching engine, one per signature in the reference.

Parameters
[out]aReturnCodeThe return code, ReturnCode.OK iff successful.
[in]aIndex0-based index of the match result.
Returns
The match quality (0 through 100) computed by the static matching engine or a negative value if the static match quality has not been computed.
See also
getDStatMatchQuality(), getDynamicMatchQuality(), getStaticResult(), getNumberOfStaticResults()
bool getStaticResult ( out ReturnCode  aReturnCode,
int  aIndex 
)

Get a static match result.

References contain more than one signature, therefore there are multiple results, one per signature in the reference.

Parameters
[out]aReturnCodeThe return code, ReturnCode.OK iff successful.
[in]aIndex0-based index of the match result.
Returns
true for a match reported by the static matching engine, false otherwise.
See also
getNumberOfStaticResults(), getStaticMatchQuality(), getResult()

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