SignDoc SDK (C)
5.0.0
|
Actions and parameters for SIGNDOC_SignatureData_clean(). More...
#include <SignDocSDK-c.h>
Public Member Functions | |
struct SIGNDOC_CleanParameters * | SIGNDOC_CleanParameters_new (struct SIGNDOC_Exception **aEx) |
SIGNDOC_CleanParameters constructor. More... | |
void | SIGNDOC_CleanParameters_delete (struct SIGNDOC_CleanParameters *aObj) |
SIGNDOC_CleanParameters destructor. More... | |
struct SIGNDOC_CleanParameters * | SIGNDOC_CleanParameters_clone (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_CleanParameters *aSource) |
Clone a SIGNDOC_CleanParameters object. More... | |
void | SIGNDOC_CleanParameters_assign (struct SIGNDOC_Exception **aEx, struct SIGNDOC_CleanParameters *aObj, const struct SIGNDOC_CleanParameters *aSource) |
SIGNDOC_CleanParameters assignment operator. More... | |
void | SIGNDOC_CleanParameters_clear (struct SIGNDOC_Exception **aEx, struct SIGNDOC_CleanParameters *aObj) |
Remove all actions. More... | |
int | SIGNDOC_CleanParameters_getType (struct SIGNDOC_Exception **aEx, const char *aName) |
Get the type of the parameter of an action. More... | |
int | SIGNDOC_CleanParameters_add (struct SIGNDOC_Exception **aEx, struct SIGNDOC_CleanParameters *aObj, const char *aName) |
Add an action without parameter. More... | |
int | SIGNDOC_CleanParameters_addBoolean (struct SIGNDOC_Exception **aEx, struct SIGNDOC_CleanParameters *aObj, const char *aName, SIGNDOC_Boolean aValue) |
Add an action with a boolean parameter. More... | |
int | SIGNDOC_CleanParameters_addInteger (struct SIGNDOC_Exception **aEx, struct SIGNDOC_CleanParameters *aObj, const char *aName, int aValue) |
Add an action with an integer parameter. More... | |
int | SIGNDOC_CleanParameters_addNumber (struct SIGNDOC_Exception **aEx, struct SIGNDOC_CleanParameters *aObj, const char *aName, double aValue) |
Add an action with a floating-point number parameter. More... | |
int | SIGNDOC_CleanParameters_getNumberOfActions (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_CleanParameters *aObj) |
Get the number of actions. More... | |
int | SIGNDOC_CleanParameters_getTypeAt (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_CleanParameters *aObj, int aIndex) |
Get the type of the parameter of an action. More... | |
const char * | SIGNDOC_CleanParameters_getNameAt (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_CleanParameters *aObj, int aIndex) |
Get the name of an action. More... | |
const SIGNDOC_Boolean * | SIGNDOC_CleanParameters_getBooleanAt (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_CleanParameters *aObj, int aIndex) |
Get the value of a boolean parameter. More... | |
const int * | SIGNDOC_CleanParameters_getIntegerAt (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_CleanParameters *aObj, int aIndex) |
Get the value of an integer parameter. More... | |
const double * | SIGNDOC_CleanParameters_getNumberAt (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_CleanParameters *aObj, int aIndex) |
Get the value of a floating-point number parameter. More... | |
const char * | SIGNDOC_CleanParameters_getErrorMessage (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_CleanParameters *aObj, int aEncoding) |
Get an error message for the last function call. More... | |
const wchar_t * | SIGNDOC_CleanParameters_getErrorMessageW (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_CleanParameters *aObj) |
Get an error message for the last function call. More... | |
Actions and parameters for SIGNDOC_SignatureData_clean().
int SIGNDOC_CleanParameters_add | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_CleanParameters * | aObj, | ||
const char * | aName | ||
) |
Add an action without parameter.
The following actions without parameter are available:
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_CleanParameters object. |
[in] | aName | The name of the action (case-sensitive). |
int SIGNDOC_CleanParameters_addBoolean | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_CleanParameters * | aObj, | ||
const char * | aName, | ||
SIGNDOC_Boolean | aValue | ||
) |
Add an action with a boolean parameter.
The following action with boolean parameter is available:
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_CleanParameters object. |
[in] | aName | The name of the action (case-sensitive). |
[in] | aValue | The value of the parameter. |
int SIGNDOC_CleanParameters_addInteger | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_CleanParameters * | aObj, | ||
const char * | aName, | ||
int | aValue | ||
) |
Add an action with an integer parameter.
The following actions with integer parameter are available:
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_CleanParameters object. |
[in] | aName | The name of the action (case-sensitive). |
[in] | aValue | The value of the parameter. |
int SIGNDOC_CleanParameters_addNumber | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_CleanParameters * | aObj, | ||
const char * | aName, | ||
double | aValue | ||
) |
Add an action with a floating-point number parameter.
The following action with a floating-point number parameter is available:
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_CleanParameters object. |
[in] | aName | The name of the action (case-sensitive). |
[in] | aValue | The value of the parameter. |
void SIGNDOC_CleanParameters_assign | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_CleanParameters * | aObj, | ||
const struct SIGNDOC_CleanParameters * | aSource | ||
) |
SIGNDOC_CleanParameters assignment operator.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_CleanParameters object. |
[in] | aSource | The source object. |
void SIGNDOC_CleanParameters_clear | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_CleanParameters * | aObj | ||
) |
Remove all actions.
struct SIGNDOC_CleanParameters * SIGNDOC_CleanParameters_clone | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_CleanParameters * | aSource | ||
) |
Clone a SIGNDOC_CleanParameters object.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aSource | The object to be copied. |
void SIGNDOC_CleanParameters_delete | ( | struct SIGNDOC_CleanParameters * | aObj | ) |
SIGNDOC_CleanParameters destructor.
[in] | aObj | A pointer to the SIGNDOC_CleanParameters object. |
const SIGNDOC_Boolean * SIGNDOC_CleanParameters_getBooleanAt | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_CleanParameters * | aObj, | ||
int | aIndex | ||
) |
Get the value of a boolean parameter.
This function does not set an error message.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_CleanParameters object. |
[in] | aIndex | The zero-based index of the action. |
const char * SIGNDOC_CleanParameters_getErrorMessage | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_CleanParameters * | aObj, | ||
int | aEncoding | ||
) |
Get an error message for the last function call.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_CleanParameters object. |
[in] | aEncoding | The encoding to be used for the error message (SIGNDOC_ENCODING_NATIVE, SIGNDOC_ENCODING_UTF_8, or SIGNDOC_ENCODING_LATIN_1). |
const wchar_t * SIGNDOC_CleanParameters_getErrorMessageW | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_CleanParameters * | aObj | ||
) |
Get an error message for the last function call.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_CleanParameters object. |
const int * SIGNDOC_CleanParameters_getIntegerAt | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_CleanParameters * | aObj, | ||
int | aIndex | ||
) |
Get the value of an integer parameter.
This function does not set an error message.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_CleanParameters object. |
[in] | aIndex | The zero-based index of the action. |
const char * SIGNDOC_CleanParameters_getNameAt | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_CleanParameters * | aObj, | ||
int | aIndex | ||
) |
Get the name of an action.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_CleanParameters object. |
[in] | aIndex | The zero-based index of the action. |
const double * SIGNDOC_CleanParameters_getNumberAt | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_CleanParameters * | aObj, | ||
int | aIndex | ||
) |
Get the value of a floating-point number parameter.
This function does not set an error message.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_CleanParameters object. |
[in] | aIndex | The zero-based index of the action. |
int SIGNDOC_CleanParameters_getNumberOfActions | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_CleanParameters * | aObj | ||
) |
Get the number of actions.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_CleanParameters object. |
int SIGNDOC_CleanParameters_getType | ( | struct SIGNDOC_Exception ** | aEx, |
const char * | aName | ||
) |
Get the type of the parameter of an action.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aName | The name of the action (case-sensitive). |
int SIGNDOC_CleanParameters_getTypeAt | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_CleanParameters * | aObj, | ||
int | aIndex | ||
) |
Get the type of the parameter of an action.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_CleanParameters object. |
[in] | aIndex | The zero-based index of the action. |
struct SIGNDOC_CleanParameters * SIGNDOC_CleanParameters_new | ( | struct SIGNDOC_Exception ** | aEx | ) |
SIGNDOC_CleanParameters constructor.
No actions will be set.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |