SignDoc SDK (.NET with exceptions)  5.0.0
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 (string aName, bool aValue)
 Set a boolean parameter. More...
 
void setInteger (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

Constructor & Destructor Documentation

Destructor.

Finalizer.

Constructor.

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

Copy constructor.

Parameters
[in]aSourceThe 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]aNameThe 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]aNameThe 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]aNameThe name of the parameter (case-sensitive).
Returns
The type of the parameter, see enum MatchParameterType.
void setBoolean ( string  aName,
bool  aValue 
)

Set a boolean parameter.

The following boolean parameters are available:

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

Parameters
[in]aNameThe name of the parameter (case-sensitive).
[in]aValueThe value of the parameter.
See also
getBoolean(), setInteger()
void setInteger ( string  aName,
int  aValue 
)

Set an integer parameter.

The following integer parameters are available:

Parameters
[in]aNameThe name of the parameter (case-sensitive).
[in]aValueThe value of the parameter.
See also
getInteger(), setBoolean()

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