Result of SignDocSignatureData::matchSignature(), SignDocSignatureData::matchReference(), SignDocImage::matchSignature(), and SignDocImage::matchReference().
More...
#include <SignDocSDK-cpp.h>
Constructor.
No results will be set.
Copy constructor.
- Parameters
-
[in] | aSource | The object to be copied. |
ReturnCode getDStatMatchQuality |
( |
int & |
aOutput | ) |
const |
|
inline |
ReturnCode getDynamicMatchQuality |
( |
int & |
aOutput | ) |
const |
|
inline |
ReturnCode getDynamicResult |
( |
bool & |
aOutput | ) |
const |
|
inline |
const char * getErrorMessage |
( |
Encoding |
aEncoding | ) |
const |
|
inline |
Get an error message for the last function call.
- Parameters
-
[in] | aEncoding | The encoding to be used for the error message. |
- 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 this object is destroyed or a member function of this object is called.
- See also
- getErrorMessageW()
const wchar_t * getErrorMessageW |
( |
| ) |
const |
|
inline |
Get an error message for the last function call.
- 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 this object is destroyed or a member function of this object is called.
- See also
- getErrorMessage()
SIGNDOC_MatchResult* getImpl |
( |
| ) |
|
|
inline |
const SIGNDOC_MatchResult* getImpl |
( |
| ) |
const |
|
inline |
ReturnCode getNumberOfStaticResults |
( |
int & |
aOutput | ) |
const |
|
inline |
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] | aOutput | The number of results. |
- Returns
- ReturnCode::rc_ok iff successful.
- See also
- getStaticMatchQuality(), getStaticResult()
ReturnCode getStaticMatchQuality |
( |
int |
aIndex, |
|
|
int & |
aOutput |
|
) |
| const |
|
inline |
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
-
[in] | aIndex | 0-based index of the match result. |
[out] | aOutput | 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. |
- Returns
- ReturnCode::rc_ok iff successful.
- See also
- getDStatMatchQuality(), getDynamicMatchQuality(), getStaticResult(), getNumberOfStaticResults()
ReturnCode getStaticResult |
( |
int |
aIndex, |
|
|
bool & |
aOutput |
|
) |
| const |
|
inline |
Get a static match result.
References contain more than one signature, therefore there are multiple results, one per signature in the reference.
- Parameters
-
[in] | aIndex | 0-based index of the match result. |
[out] | aOutput | true for a match reported by the static matching engine, false otherwise. |
- Returns
- ReturnCode::rc_ok iff successful.
- See also
- getNumberOfStaticResults(), getStaticMatchQuality(), getResult()
Assignment operator.
- Parameters
-
[in] | aSource | The source object. |
- Returns
- This object.
void setImpl |
( |
SIGNDOC_MatchResult * |
aP | ) |
|
|
inline |
Efficiently swap this object with another one.
- Parameters
-
[in] | aOther | The other object. |
The documentation for this class was generated from the following file: