SIGNDOC_RenderParameters Class Reference

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...

Detailed Description

Parameters for SIGNDOC_Document_renderPageAsImage() and SIGNDOC_Document_renderPageAsSignDocImage().

Member Function Documentation

void SIGNDOC_RenderParameters_assign	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_RenderParameters *	aObj,
		const struct SIGNDOC_RenderParameters *	aSource
	)

SIGNDOC_RenderParameters 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_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.

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.

struct SIGNDOC_RenderParameters * SIGNDOC_RenderParameters_clone	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_RenderParameters *	aSource
	)

Clone a SIGNDOC_RenderParameters object.

Parameters

[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.

Parameters

[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.

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]	aOther	The object to compare against.

Returns

SIGNDOC_TRUE iff aObj compares equal to aOther.

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.

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).

Returns

A pointer to the value of the specified parameter or NULL if the parameter is not set or is not a boolean parameter.

See also

SIGNDOC_RenderParameters_setBoolean()

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.

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_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).

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_RenderParameters_getErrorMessageW()

const wchar_t * SIGNDOC_RenderParameters_getErrorMessageW	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_RenderParameters *	aObj
	)

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_RenderParameters 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_RenderParameters_getErrorMessage()

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.

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).

Returns

A pointer to the value of the specified parameter or NULL if the parameter is not set or is not an integer parameter.

See also

SIGNDOC_RenderParameters_setInteger()

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.

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).

Returns

A pointer to the value of the specified parameter or NULL if the parameter is not set or is not a floating-point number parameter.

See also

SIGNDOC_RenderParameters_setNumber()

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.

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, UTF-8).

Returns

A pointer to the value of the specified parameter or NULL if the parameter is not set.

See also

SIGNDOC_RenderParameters_getString2(), SIGNDOC_RenderParameters_setString()

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.

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, UTF-8).

Returns

A pointer to the value of the specified parameter or NULL if the parameter is not set.

See also

SIGNDOC_RenderParameters_getString(), SIGNDOC_RenderParameters_setString2()

int SIGNDOC_RenderParameters_getType	(	struct SIGNDOC_Exception **	aEx,
		const char *	aName
	)

Get the type of a parameter.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aName	The name of the parameter (case-sensitive).

Returns

The type of the parameter: SIGNDOC_RENDERPARAMETERS_TYPE_UNDEFINED, SIGNDOC_RENDERPARAMETERS_TYPE_BOOLEAN, SIGNDOC_RENDERPARAMETERS_TYPE_INTEGER, SIGNDOC_RENDERPARAMETERS_TYPE_NUMBER, SIGNDOC_RENDERPARAMETERS_TYPE_STRING, or SIGNDOC_RENDERPARAMETERS_TYPE_STRING2.

SIGNDOC_Boolean SIGNDOC_RenderParameters_isLessThan	(	const struct SIGNDOC_RenderParameters *	aObj,
		const struct SIGNDOC_RenderParameters *	aOther
	)

"Less than" operator for SIGNDOC_RenderParameters.

Parameters

[in]	aObj	A pointer to the SIGNDOC_RenderParameters object.
[in]	aOther	The object to compare against.

Returns

SIGNDOC_TRUE if aObj compares less than aOther, SIGNDOC_FALSE otherwise.

struct SIGNDOC_RenderParameters * SIGNDOC_RenderParameters_new

(

struct SIGNDOC_Exception **

aEx

)

SIGNDOC_RenderParameters constructor.

Parameters

[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:

  • no icon (signature field not signed)
  • green check mark (signature is OK)
  • green check mark with yellow triangle (signature is OK but the certificate is not trusted or the document has been extended, ie, modified and saved incrementally after signing)
  • red cross (signature broken)

  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.

• BlackAndWhite: SIGNDOC_TRUE to force black and white output (1 bit per pixel), SIGNDOC_FALSE to use RGB for PDF documents or to keep the pixel format of TIFF documents. The default value is SIGNDOC_FALSE.
• ForPrinting: SIGNDOC_TRUE to enable rendering for printing, SIGNDOC_FALSE to enable rendering for displaying. This may affect rendering of annotations in PDF documents.
• Interlaced: SIGNDOC_TRUE to create an interlaced image (progressive encoding). The default value is SIGNDOC_FALSE.
• UseModificationState: SIGNDOC_TRUE to check the modification state for signature fields of PDF documents (expensive), SIGNDOC_FALSE to ignore the modification state. The default value is SIGNDOC_FALSE. This parameter has an effect only if boolean parameter "Decorations" is SIGNDOC_TRUE.

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]	aValue	The value of the parameter.

Returns

SIGNDOC_RETURNCODE_OK iff successful.

See also

SIGNDOC_RenderParameters_getBoolean(), SIGNDOC_RenderParameters_setInteger(), SIGNDOC_RenderParameters_setNumber(), SIGNDOC_RenderParameters_setString()

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:

• FirstPage: Render a range of pages. The value is the 1-based page number of the first page. "LastPage" must also be set. If both parameter are set to the same value, SIGNDOC_RenderParameters_getInteger() will return that value for parameter "Page". If multiple pages are selected, the image format must be "tiff" for SIGNDOC_Document_renderPageAsImage(). Rendering ranges of pages is not yet implemented for TIFF documents.
• Height: The height for automatic computation of the scaling factor to make the rendered image fit the specified height in pixels. If this parameter is set, floating-point number parameter "Scale" will be ignored.
• LastPage: Render a range of pages. The value is the 1-based page number of the last page. "FirstPage" must also be set. If both parameter are set to the same value, SIGNDOC_RenderParameters_getInteger() will return that value for parameter "Page". If multiple pages are selected, the image format must be "tiff" for SIGNDOC_Document_renderPageAsImage(). Rendering ranges of pages is not yet implemented for TIFF documents.
• Page: Render a single page. The value is the 1-based page number of that page. Setting this parameter will set both "FirstPage" and "LastPage".
• Quality: Quality for scaling pages of TIFF documents. The value must be in the range 0 (low quality, fast) through 100 (high quality, slow). The default value is 25. Currently, all values below 50 will be treated as low quality, all values above 49 will be treated as high quality.
• Width: The width for automatic computation of the scaling factor to make the rendered image fit the specified width in pixels. If this parameter is set, floating-point number parameter "Scale" will be ignored.

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]	aValue	The value of the parameter.

Returns

SIGNDOC_RETURNCODE_OK iff successful.

See also

SIGNDOC_RenderParameters_getInteger(), SIGNDOC_RenderParameters_setBoolean(), SIGNDOC_RenderParameters_setNumber(), SIGNDOC_RenderParameters_setString()

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:

• Resolution: The resolution for rendering PDF documents. Setting this parameter is equivalent to setting both "ResolutionX" and "ResolutionY". See also floating-point number parameter "Scale".
• ResolutionX: The horizontal resolution for rendering PDF documents. The value of this parameter will be ignored for TIFF documents as the resolution is computed automatically from the scaling factor and the document's resolution. If this parameter is not set, but "ResolutionY" is set, the value of parameter "ResolutionY" will be used for both the horizontal and the vertical resolution. If neither parameter is set, 96 DPI (subject to change) will be used for rendering PDF documents. See also floating-point number parameter "Scale".
• ResolutionY: The vertical resolution for rendering PDF documents. The value of this parameter will be ignored for TIFF documents as the resolution is computed automatically from the scaling factor and the document's resolution. If this parameter is not set, but "ResolutionX" is set, the value of parameter "ResolutionX" will be used for both the horizontal and the vertical resolution. If neither parameter is set, 96 DPI (subject to change) will be used for rendering PDF documents. See also floating-point number parameter "Scale".
• Scale: Scaling factor. There is no default value, ie, either this parameter or at least one of integer parameters "Height" and "Width" must be set. This parameter will be ignored if integer parameter "Height" or "Width" is set. See also floating-point number parameters "ResolutionX" and "ResolutionY".

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]	aValue	The value of the parameter.

Returns

SIGNDOC_RETURNCODE_OK iff successful.

See also

SIGNDOC_RenderParameters_getNumber(), SIGNDOC_RenderParameters_setBoolean(), SIGNDOC_RenderParameters_setInteger(), SIGNDOC_RenderParameters_setString()

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:

• Compression: Compression method. The following values are available:
  • "default": no compression for PDF documents, same compression as the source document for TIFF documents.
  • "none": no compression
  • "ccitt4": CCITT Group 4
  • "lzw": LZW
  • "rle": RLE
  • "zip": ZIP
  The default value is "default".
• Format: The image format, "jpg", "png", "tiff", "gif", or "bmp". For SIGNDOC_Document_renderPageAsImage(), this parameter must be set, there is no default value. For SIGNDOC_Document_renderPageAsSignDocImage(), this parameter is ignored.

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]	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.

Returns

SIGNDOC_RETURNCODE_OK iff successful.

See also

SIGNDOC_RenderParameters_getString(), SIGNDOC_RenderParameters_setBoolean(), SIGNDOC_RenderParameters_setInteger(), SIGNDOC_RenderParameters_setNumber(), SIGNDOC_RenderParameters_setString2()

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:

• DecorationState: Set the decoration state for a single signature in a PDF document. aName2 is the name of the field (not checked by this function). The decorations set by this parameter are ignored unless boolean parameter "AddDecorations" is set to true. This parameter is ignored for rendering TIFF documents. The following values are available:
  • "auto": validate signature and choose appropriate decoration.
  • "empty": the signature field is not signed.
  • "ok": signature validated successfully.
  • "problem": signature validated mostly successfully, there is at least one problem.
  • "broken": signature is broken.
  Value "auto" will be assumed for all fields for which this parameter is set.

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]	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.

Returns

SIGNDOC_RETURNCODE_OK iff successful.

See also

SIGNDOC_RenderParameters_getString(), SIGNDOC_RenderParameters_setBoolean(), SIGNDOC_RenderParameters_setInteger(), SIGNDOC_RenderParameters_setNumber(), SIGNDOC_RenderParameters_setString(), SIGNDOC_RenderParameters_setString2Wide()

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.

Note

Unlike SIGNDOC_*Parameters_setStringW() functions, this one has a narrow value.

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).

Returns

SIGNDOC_RETURNCODE_OK iff successful.

See also

SIGNDOC_RenderParameters_getString(), SIGNDOC_RenderParameters_setBoolean(), SIGNDOC_RenderParameters_setInteger(), SIGNDOC_RenderParameters_setNumber(), SIGNDOC_RenderParameters_setString2()

---

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

• SignDocSDK-c.h