Result of SIGNDOC_SignatureData_matchSignature(), SIGNDOC_SignatureData_matchReference(), SIGNDOC_Image_matchSignature(), and SIGNDOC_Image_matchReference().
More...
#include <SignDocSDK-c.h>
|
struct SIGNDOC_MatchResult * | SIGNDOC_MatchResult_new (struct SIGNDOC_Exception **aEx) |
| SIGNDOC_MatchResult constructor. More...
|
|
void | SIGNDOC_MatchResult_delete (struct SIGNDOC_MatchResult *aObj) |
| SIGNDOC_MatchResult destructor. More...
|
|
struct SIGNDOC_MatchResult * | SIGNDOC_MatchResult_clone (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_MatchResult *aSource) |
| Clone a SIGNDOC_MatchResult object. More...
|
|
void | SIGNDOC_MatchResult_assign (struct SIGNDOC_Exception **aEx, struct SIGNDOC_MatchResult *aObj, const struct SIGNDOC_MatchResult *aSource) |
| SIGNDOC_MatchResult assignment operator. More...
|
|
int | SIGNDOC_MatchResult_getNumberOfStaticResults (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_MatchResult *aObj, int *aOutput) |
| Get the number of results for the static matching engine. More...
|
|
int | SIGNDOC_MatchResult_getDynamicMatchQuality (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_MatchResult *aObj, int *aOutput) |
| Get the dynamic match quality. More...
|
|
int | SIGNDOC_MatchResult_getDStatMatchQuality (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_MatchResult *aObj, int *aOutput) |
| Get the DStat match quality. More...
|
|
int | SIGNDOC_MatchResult_getStaticMatchQuality (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_MatchResult *aObj, int aIndex, int *aOutput) |
| Get the static match quality. More...
|
|
int | SIGNDOC_MatchResult_getResult (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_MatchResult *aObj, SIGNDOC_Boolean *aOutput) |
| Get the overall match result. More...
|
|
int | SIGNDOC_MatchResult_getDynamicResult (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_MatchResult *aObj, SIGNDOC_Boolean *aOutput) |
| Get the dynamic match result. More...
|
|
int | SIGNDOC_MatchResult_getDStatResult (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_MatchResult *aObj, SIGNDOC_Boolean *aOutput) |
| Get the DStat match result. More...
|
|
int | SIGNDOC_MatchResult_getStaticResult (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_MatchResult *aObj, int aIndex, SIGNDOC_Boolean *aOutput) |
| Get a static match result. More...
|
|
const char * | SIGNDOC_MatchResult_getErrorMessage (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_MatchResult *aObj, int aEncoding) |
| Get an error message for the last function call. More...
|
|
const wchar_t * | SIGNDOC_MatchResult_getErrorMessageW (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_MatchResult *aObj) |
| Get an error message for the last function call. More...
|
|
SIGNDOC_MatchResult 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_MatchResult object. |
[in] | aSource | The source object. |
Get the DStat match quality.
- 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 match quality (0 through 100) computed by the DStat engine or a negative value if the DStat match quality has not been computed will be stored into the object pointed to by this argument. |
- Returns
- SIGNDOC_RETURNCODE_OK iff successful.
- See also
- SIGNDOC_Matchresult_getDStatResult(), SIGNDOC_Matchresult_getDynamicMatchQuality(), SIGNDOC_Matchresult_getStaticMatchQuality()
Get the DStat match result.
- 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 match result for the DStat engine will be stored in the object pointed to this argument: SIGNDOC_TRUE for a match reported by the dynamic matching engine, SIGNDOC_FALSE otherwise. |
- Returns
- SIGNDOC_RETURNCODE_OK iff successful.
- See also
- SIGNDOC_Matchresult_getDStatMatchQuality(), SIGNDOC_Matchresult_getResult()
Get the dynamic match quality.
- 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 match quality (0 through 100) computed by the dynamic matching engine or a negative value if the dynamic match quality has not been computed will be stored into the object pointed to by this argument. |
- Returns
- SIGNDOC_RETURNCODE_OK iff successful.
- See also
- SIGNDOC_Matchresult_getDStatMatchQuality(), SIGNDOC_Matchresult_getDynamicResult(), SIGNDOC_Matchresult_getStaticMatchQuality()
Get the dynamic match result.
- 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 match result for the dynamic engine will be stored in the object pointed to this argument: SIGNDOC_TRUE for a match reported by the dynamic matching engine, SIGNDOC_FALSE otherwise. |
- Returns
- SIGNDOC_RETURNCODE_OK iff successful.
- See also
- SIGNDOC_Matchresult_getDynamicMatchQuality(), SIGNDOC_Matchresult_getResult()
Get an error message for the last function call.
- Note
- Do not call SIGNDOC_free() on the return value.
- Parameters
-
- 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_MatchResult_getErrorMessageW()
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_MatchResult 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_MatchResult_getErrorMessage()
Get the number of results for the static matching engine.
- 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 results will be stored into the object pointed to by this argument. |
- Returns
- SIGNDOC_RETURNCODE_OK iff successful.
- See also
- SIGNDOC_Matchresult_getStaticMatchQuality(), SIGNDOC_Matchresult_getStaticResult()
Get the overall match result.
- 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 overall result will be stored in the object pointed to this argument: SIGNDOC_TRUE if all signatures match for all enabled matching engines, SIGNDOC_FALSE otherwise. |
- Returns
- SIGNDOC_RETURNCODE_OK iff successful.
- See also
- SIGNDOC_Matchresult_getDStatResult(), SIGNDOC_Matchresult_getDynamicResult(), SIGNDOC_Matchresult_getStaticResult()
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] | 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 match result. |
[out] | aOutput | The match quality (0 through 100) computed by the static engine or a negative value if the static match quality has not been computed will be stored into the object pointed to by this argument. |
- Returns
- SIGNDOC_RETURNCODE_OK iff successful.
- See also
- SIGNDOC_Matchresult_getDStatMatchQuality(), SIGNDOC_Matchresult_getDynamicMatchQuality(), SIGNDOC_Matchresult_getStaticResult(), SIGNDOC_Matchresult_getNumberOfStaticResults()
Get a static match result.
- 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 match result. |
[out] | aOutput | The match result for the static engine will be stored in the object pointed to this argument: SIGNDOC_TRUE for a match reported by the dynamic matching engine, SIGNDOC_FALSE otherwise. |
- Returns
- SIGNDOC_RETURNCODE_OK iff successful.
- See also
- SIGNDOC_MatchResult_getNumberOfStaticResults(), SIGNDOC_Matchresult_getResult(), SIGNDOC_Matchresult_getStaticMatchQuality()
The documentation for this class was generated from the following file: