SignDoc SDK (C)
5.0.0
|
Parameters for SIGNDOC_Document_renderPageAsImage() and SIGNDOC_Document_renderPageAsSignDocImage(). More...
#include <SignDocSDK-c.h>
Public Member Functions | |
struct SIGNDOC_RenderParameters * | SIGNDOC_RenderParameters_new (struct SIGNDOC_Exception **aEx) |
SIGNDOC_RenderParameters constructor. More... | |
struct SIGNDOC_RenderParameters * | SIGNDOC_RenderParameters_clone (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_RenderParameters *aSource) |
Clone a SIGNDOC_RenderParameters object. More... | |
void | SIGNDOC_RenderParameters_delete (struct SIGNDOC_RenderParameters *aObj) |
SIGNDOC_RenderParameters destructor. More... | |
void | SIGNDOC_RenderParameters_assign (struct SIGNDOC_Exception **aEx, struct SIGNDOC_RenderParameters *aObj, const struct SIGNDOC_RenderParameters *aSource) |
SIGNDOC_RenderParameters assignment operator. More... | |
SIGNDOC_Boolean | SIGNDOC_RenderParameters_isLessThan (const struct SIGNDOC_RenderParameters *aObj, const struct SIGNDOC_RenderParameters *aOther) |
"Less than" operator for SIGNDOC_RenderParameters. More... | |
int | SIGNDOC_RenderParameters_getType (struct SIGNDOC_Exception **aEx, const char *aName) |
Get the type of a parameter. More... | |
void | SIGNDOC_RenderParameters_clear (struct SIGNDOC_Exception **aEx, struct SIGNDOC_RenderParameters *aObj) |
Reset all parameters to their initial values. More... | |
int | SIGNDOC_RenderParameters_setBoolean (struct SIGNDOC_Exception **aEx, struct SIGNDOC_RenderParameters *aObj, const char *aName, SIGNDOC_Boolean aValue) |
Set a boolean parameter. More... | |
int | SIGNDOC_RenderParameters_setInteger (struct SIGNDOC_Exception **aEx, struct SIGNDOC_RenderParameters *aObj, const char *aName, int aValue) |
Set an integer parameter. More... | |
int | SIGNDOC_RenderParameters_setNumber (struct SIGNDOC_Exception **aEx, struct SIGNDOC_RenderParameters *aObj, const char *aName, double aValue) |
Set a floating-point number parameter. More... | |
int | SIGNDOC_RenderParameters_setString (struct SIGNDOC_Exception **aEx, struct SIGNDOC_RenderParameters *aObj, int aEncoding, const char *aName, const char *aValue) |
Set a string parameter. More... | |
int | SIGNDOC_RenderParameters_setString2 (struct SIGNDOC_Exception **aEx, struct SIGNDOC_RenderParameters *aObj, int aEncoding, const char *aName, const char *aName2, const char *aValue) |
Set a string parameter with two parameter names. More... | |
int | SIGNDOC_RenderParameters_setString2Wide (struct SIGNDOC_Exception **aEx, struct SIGNDOC_RenderParameters *aObj, const char *aName, const wchar_t *aName2, const char *aValue) |
Set a string parameter (with two parameter names, the second one being specified as a wide string). More... | |
const SIGNDOC_Boolean * | SIGNDOC_RenderParameters_getBoolean (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_RenderParameters *aObj, const char *aName) |
Get the value of a boolean parameter. More... | |
const int * | SIGNDOC_RenderParameters_getInteger (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_RenderParameters *aObj, const char *aName) |
Get the value of an integer parameter. More... | |
const double * | SIGNDOC_RenderParameters_getNumber (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_RenderParameters *aObj, const char *aName) |
Get the value of a floating-point number parameter. More... | |
const char * | SIGNDOC_RenderParameters_getString (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_RenderParameters *aObj, const char *aName) |
Get the value of a string parameter. More... | |
const char * | SIGNDOC_RenderParameters_getString2 (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_RenderParameters *aObj, const char *aName, const char *aName2) |
Get the value of a string parameter with two parameter names. More... | |
SIGNDOC_Boolean | SIGNDOC_RenderParameters_equals (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_RenderParameters *aObj, const struct SIGNDOC_RenderParameters *aOther) |
Compare against another SIGNDOC_RenderParameters object. More... | |
const char * | SIGNDOC_RenderParameters_getErrorMessage (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_RenderParameters *aObj, int aEncoding) |
Get an error message for the last function call. More... | |
const wchar_t * | SIGNDOC_RenderParameters_getErrorMessageW (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_RenderParameters *aObj) |
Get an error message for the last function call. More... | |
Parameters for SIGNDOC_Document_renderPageAsImage() and SIGNDOC_Document_renderPageAsSignDocImage().
void SIGNDOC_RenderParameters_assign | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_RenderParameters * | aObj, | ||
const struct SIGNDOC_RenderParameters * | aSource | ||
) |
SIGNDOC_RenderParameters assignment operator.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_RenderParameters object. |
[in] | aSource | The source object. |
void SIGNDOC_RenderParameters_clear | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_RenderParameters * | aObj | ||
) |
Reset all parameters to their initial values.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_RenderParameters object. |
struct SIGNDOC_RenderParameters * SIGNDOC_RenderParameters_clone | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_RenderParameters * | aSource | ||
) |
Clone a SIGNDOC_RenderParameters 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_RenderParameters_delete | ( | struct SIGNDOC_RenderParameters * | aObj | ) |
SIGNDOC_RenderParameters destructor.
[in] | aObj | A pointer to the SIGNDOC_RenderParameters object. |
SIGNDOC_Boolean SIGNDOC_RenderParameters_equals | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_RenderParameters * | aObj, | ||
const struct SIGNDOC_RenderParameters * | aOther | ||
) |
Compare against another SIGNDOC_RenderParameters object.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_RenderParameters object. |
[in] | aOther | The object to compare against. |
const SIGNDOC_Boolean * SIGNDOC_RenderParameters_getBoolean | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_RenderParameters * | aObj, | ||
const char * | aName | ||
) |
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_RenderParameters object. |
[in] | aName | The name of the parameter (case-sensitive). |
const char * SIGNDOC_RenderParameters_getErrorMessage | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_RenderParameters * | 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_RenderParameters 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_RenderParameters_getErrorMessageW | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_RenderParameters * | 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_RenderParameters object. |
const int * SIGNDOC_RenderParameters_getInteger | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_RenderParameters * | aObj, | ||
const char * | aName | ||
) |
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_RenderParameters object. |
[in] | aName | The name of the parameter (case-sensitive). |
const double * SIGNDOC_RenderParameters_getNumber | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_RenderParameters * | aObj, | ||
const char * | aName | ||
) |
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_RenderParameters object. |
[in] | aName | The name of the parameter (case-sensitive). |
const char * SIGNDOC_RenderParameters_getString | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_RenderParameters * | aObj, | ||
const char * | aName | ||
) |
Get the value of a string 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_RenderParameters object. |
[in] | aName | The name of the parameter (case-sensitive, UTF-8). |
const char * SIGNDOC_RenderParameters_getString2 | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_RenderParameters * | aObj, | ||
const char * | aName, | ||
const char * | aName2 | ||
) |
Get the value of a string parameter with two parameter names.
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_RenderParameters object. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aName2 | The second name of the parameter (case-sensitive, UTF-8). |
int SIGNDOC_RenderParameters_getType | ( | struct SIGNDOC_Exception ** | aEx, |
const char * | aName | ||
) |
Get the type of a parameter.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aName | The name of the parameter (case-sensitive). |
SIGNDOC_Boolean SIGNDOC_RenderParameters_isLessThan | ( | const struct SIGNDOC_RenderParameters * | aObj, |
const struct SIGNDOC_RenderParameters * | aOther | ||
) |
"Less than" operator for SIGNDOC_RenderParameters.
[in] | aObj | A pointer to the SIGNDOC_RenderParameters object. |
[in] | aOther | The object to compare against. |
struct SIGNDOC_RenderParameters * SIGNDOC_RenderParameters_new | ( | struct SIGNDOC_Exception ** | aEx | ) |
SIGNDOC_RenderParameters constructor.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
int SIGNDOC_RenderParameters_setBoolean | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_RenderParameters * | aObj, | ||
const char * | aName, | ||
SIGNDOC_Boolean | aValue | ||
) |
Set a boolean parameter.
Available boolean parameters are:
AddDecorations: Enable rendering of decorations of signature fields of PDF documents. If SIGNDOC_TRUE, an icon visualizing the signature status will be added to each signature field:
You might want to set boolean parameter "UseModificationState" to SIGNDOC_TRUE to compute the signature state more thoroughly.
Enabling rendering of decorations can slow down SIGNDOC_Document_renderPageAsImage() and SIGNDOC_Document_renderPageAsSignDocImage() substantially for PDF documents as each call will validate all the signatures of the page. Moreover, long term validation (LTV) is currently not supported by SIGNDOC_Document_renderPageAsImage() and SIGNDOC_Document_renderPageAsSignDocImage(). Setting string parameter (with two parameter names) "DecorationState" might solve these problems.
It is recommended to display the status of signatures off-page rather than using this parameter, see SIGNDOC_Document_getSignature().
For TIFF documents, this parameter is ignored; a red cross will be displayed in signature fields if the signature is broken.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_RenderParameters object. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
int SIGNDOC_RenderParameters_setInteger | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_RenderParameters * | aObj, | ||
const char * | aName, | ||
int | aValue | ||
) |
Set an integer parameter.
Available integer parameters are:
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_RenderParameters object. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
int SIGNDOC_RenderParameters_setNumber | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_RenderParameters * | aObj, | ||
const char * | aName, | ||
double | aValue | ||
) |
Set a floating-point number parameter.
Available floating-point number parameters are:
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_RenderParameters object. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
int SIGNDOC_RenderParameters_setString | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_RenderParameters * | aObj, | ||
int | aEncoding, | ||
const char * | aName, | ||
const char * | aValue | ||
) |
Set a string parameter.
Available string parameters are:
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_RenderParameters object. |
[in] | aEncoding | The encoding used for aName and aValue (SIGNDOC_ENCODING_NATIVE, SIGNDOC_ENCODING_UTF_8, or SIGNDOC_ENCODING_LATIN_1). |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. The encoding is specified by aEncoding. |
int SIGNDOC_RenderParameters_setString2 | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_RenderParameters * | aObj, | ||
int | aEncoding, | ||
const char * | aName, | ||
const char * | aName2, | ||
const char * | aValue | ||
) |
Set a string parameter with two parameter names.
String parameters with two parameter names are referenced in the documentation of other functions as "NAME:NAME2" where NAME is passed to aName of this function and NAME2 is passed as aName2. The documentation of this function lists NAME only.
Available string parameters with two parameter names are:
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_RenderParameters object. |
[in] | aEncoding | The encoding used for aName2 and aValue (SIGNDOC_ENCODING_NATIVE, SIGNDOC_ENCODING_UTF_8, or SIGNDOC_ENCODING_LATIN_1). |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aName2 | The second name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. The encoding is specified by aEncoding. |
int SIGNDOC_RenderParameters_setString2Wide | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_RenderParameters * | aObj, | ||
const char * | aName, | ||
const wchar_t * | aName2, | ||
const char * | aValue | ||
) |
Set a string parameter (with two parameter names, the second one being specified as a wide string).
See SIGNDOC_RenderParameters_setString2() for the available parameters.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_RenderParameters object. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aName2 | The second name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter (UTF-8). |