![]() |
SignDoc SDK (C)
5.0.0
|
Parameters for signing a document. More...
#include <SignDocSDK-c.h>
Public Member Functions | |
void | SIGNDOC_SignatureParameters_delete (struct SIGNDOC_SignatureParameters *aObj) |
SIGNDOC_SignatureParameters destructor. More... | |
int | SIGNDOC_SignatureParameters_setString (struct SIGNDOC_Exception **aEx, struct SIGNDOC_SignatureParameters *aObj, int aEncoding, const char *aName, const char *aValue) |
Set a string parameter. More... | |
int | SIGNDOC_SignatureParameters_setStringW (struct SIGNDOC_Exception **aEx, struct SIGNDOC_SignatureParameters *aObj, const char *aName, const wchar_t *aValue) |
Set a string parameter. More... | |
int | SIGNDOC_SignatureParameters_setInteger (struct SIGNDOC_Exception **aEx, struct SIGNDOC_SignatureParameters *aObj, const char *aName, int aValue) |
Set an integer parameter. More... | |
int | SIGNDOC_SignatureParameters_setBlob (struct SIGNDOC_Exception **aEx, struct SIGNDOC_SignatureParameters *aObj, const char *aName, const unsigned char *aData, size_t aSize) |
Set a blob parameter. More... | |
int | SIGNDOC_SignatureParameters_setLength (struct SIGNDOC_Exception **aEx, struct SIGNDOC_SignatureParameters *aObj, const char *aName, int aType, double aValue) |
Set a length parameter. More... | |
int | SIGNDOC_SignatureParameters_setColor (struct SIGNDOC_Exception **aEx, struct SIGNDOC_SignatureParameters *aObj, const char *aName, const struct SIGNDOC_Color *aValue) |
Set a color parameter. More... | |
int | SIGNDOC_SignatureParameters_addTextItem (struct SIGNDOC_Exception **aEx, struct SIGNDOC_SignatureParameters *aObj, const char *aItem, int aGroup) |
Add another string to be displayed, top down. More... | |
int | SIGNDOC_SignatureParameters_addTextItem2 (struct SIGNDOC_Exception **aEx, struct SIGNDOC_SignatureParameters *aObj, const char *aItem, int aGroup, int aHAlignment, int aDirection) |
Add another string to be displayed, top down, with paragraph direction. More... | |
int | SIGNDOC_SignatureParameters_clearTextItems (struct SIGNDOC_Exception **aEx, struct SIGNDOC_SignatureParameters *aObj) |
Remove all strings that were to be displayed. More... | |
int | SIGNDOC_SignatureParameters_setTextItemDirection (struct SIGNDOC_Exception **aEx, struct SIGNDOC_SignatureParameters *aObj, const char *aItem, int aHAlignment, int aDirection) |
Set the paragraph direction of text items. More... | |
int | SIGNDOC_SignatureParameters_setPKCS7 (struct SIGNDOC_Exception **aEx, struct SIGNDOC_SignatureParameters *aObj, struct SIGNDOC_SignPKCS7 *aPKCS7) |
Set an object which will create a PKCS #7 or CAdES signature. More... | |
int | SIGNDOC_SignatureParameters_setRSA (struct SIGNDOC_Exception **aEx, struct SIGNDOC_SignatureParameters *aObj, struct SIGNDOC_SignRSA *aRSA) |
Set an object which will create an RSA signature. More... | |
int | SIGNDOC_SignatureParameters_setECDSA (struct SIGNDOC_Exception **aEx, struct SIGNDOC_SignatureParameters *aObj, struct SIGNDOC_SignECDSA *aECDSA) |
Set an object which will create an ECDSA signature. More... | |
int | SIGNDOC_SignatureParameters_getAvailableMethods (struct SIGNDOC_Exception **aEx, struct SIGNDOC_SignatureParameters *aObj) |
Get a bitset indicating which signing methods are available for this signature field. More... | |
int | SIGNDOC_SignatureParameters_getTemplate (struct SIGNDOC_Exception **aEx, struct SIGNDOC_SignatureParameters *aObj, struct SIGNDOC_ByteArray *aOutput) |
Get an XML document specifying the current layout. More... | |
const char * | SIGNDOC_SignatureParameters_getErrorMessage (struct SIGNDOC_Exception **aEx, struct SIGNDOC_SignatureParameters *aObj, int aEncoding) |
Get an error message for the last function call. More... | |
const wchar_t * | SIGNDOC_SignatureParameters_getErrorMessageW (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_SignatureParameters *aObj) |
Get an error message for the last function call. More... | |
int | SIGNDOC_SignatureParameters_getType (struct SIGNDOC_Exception **aEx, const char *aName) |
Get the type of a parameter. More... | |
Parameters for signing a document.
Use SIGNDOC_Document_createSignatureParameters(), SIGNDOC_Document_createSignatureParametersForTimeStamp(), or SIGNDOC_Document_createSignatureParametersW() to create objects of this type.
Use SIGNDOC_SignatureParameters_getErrorMessage() or SIGNDOC_SignatureParameters_getErrorMessageW() to get more information after a function call failed.
The available parameters depend both on the document type and on the signature field for which the SIGNDOC_SignatureParameters object has been created.
SIGNDOC_Document_addSignature() may fail due to invalid parameters even if all setters reported success as the setters do not check if there are conflicts between parameters.
Which certificates are acceptable may be restricted by the application (by using SIGNDOC_SIGNATUREPARAMETERS_CERTIFICATESELECTIONFLAGS_SOFTWARE and SIGNDOC_SIGNATUREPARAMETERS_CERTIFICATESELECTIONFLAGS_HARDWARE of integer parameter "SelectCertificate", blob parameters "FilterCertificatesByIssuerCertificate" and "FilterCertificatesBySubjectCertificate", and string parameters "FilterCertificatesByPolicy" and "FilterCertificatesBySubjectDN") and by the PDF document (certificate seed value dictionary). If no matching certificate is available (for instance, because integer parameter "SelectCertificate" is zero), SIGNDOC_Document_addSignature() will fail with SIGNDOC_RETURNCODE_NO_CERTIFICATE. If more than one matching certificate is available but SIGNDOC_SIGNATUREPARAMETERS_CERTIFICATESELECTIONFLAGS_NEVER_ASK is specified in integer parameter "SelectCertificate"), SIGNDOC_Document_addSignature() will fail with SIGNDOC_RETURNCODE_AMBIGUOUS_CERTIFICATE.
To make the signature maximally meaningful, integer parameter "AddCertificates" should be SIGNDOC_SIGNATUREPARAMETERS_ADDCERTIFICATES_ALL (which is the default value) and integer parameter "AddRevocationInfo" should include SIGNDOC_SIGNATUREPARAMETERS_ADDREVOCATIONINFO_ADD.
Unless you need a specific signing method, you should leave integer parameter "Method" at its default value SIGNDOC_SIGNATUREPARAMETERS_METHOD_DEFAULT. If you select a specific signing method and that method is not allowed by the signature field's seed values, signing will fail.
Unless you need a specific digest algorithm, you should leave string parameter "DetachedHashAlgorithm" at its default value. If you select a specific digest algorithm and that algorithm is not allowed by the signature field's seed values, signing will fail.
The interaction between some parameters is quite complex; the following section tries to summarize the signing methods for PDF documents.
Additionally:
For TIFF documents, an additional, simplified signing method is available:
The following parameters control the signing method and related aspects of the signature:
The following parameters control the private key used for signing:
The following parameters control rendering of the signature image from biometric data:
The following parameters put additional data into the signature:
The following parameters provide texts for the appearance of a signature in PDF documents:
The following parameters control how a signed signature field in a PDF document will look like (parameters marked with * can be overridden with blob parameter "Template"):
The following parameters control the signing certificate:
The following parameters are used for generating a self-signed certificate on the fly (you also need to set at least one parameter for the private key):
The following parameters are used for putting biometric data (handwritten signature) into the signature:
The following parameters control the certificate selection dialog:
The following parameters control RFC 3161 timestamps:
The following parameters put additional certificates and revocation information into the signature:
The following parameters do not fall into the above categories:
int SIGNDOC_SignatureParameters_addTextItem | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_SignatureParameters * | aObj, | ||
const char * | aItem, | ||
int | aGroup | ||
) |
Add another string to be displayed, top down.
For DigSig signature fields, this function adds another string to the appearance stream of PDF documents. The first call clears any default strings. The default values depend on the profile passed to SIGNDOC_Document_createSignatureParameters() or SIGNDOC_Document_createSignatureParametersW():
Profile | Value |
---|---|
"" | "Signer"/SIGNDOC_SIGNATUREPARAMETERS_TEXTGROUP_MASTER, "SignTime"/SIGNDOC_SIGNATUREPARAMETERS_TEXTGROUP_MASTER |
"image" | (empty) |
The paragraph direction is 0 which is treated like SIGNDOC_SIGNATUREPARAMETERS_TEXTITEMDIRECTION_LTR.
See also blob parameter "Template".
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_SignatureParameters object. |
[in] | aItem | Select the string to be added:
|
[in] | aGroup | The string's group for font size computation: SIGNDOC_SIGNATUREPARAMETERS_TEXTGROUP_MASTER or SIGNDOC_SIGNATUREPARAMETERS_TEXTGROUP_SLAVE. |
int SIGNDOC_SignatureParameters_addTextItem2 | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_SignatureParameters * | aObj, | ||
const char * | aItem, | ||
int | aGroup, | ||
int | aHAlignment, | ||
int | aDirection | ||
) |
Add another string to be displayed, top down, with paragraph direction.
For DigSig signature fields, this function adds another string to the appearance stream of PDF documents. The first call clears any default strings. The default values depend on the profile passed to SIGNDOC_Document_createSignatureParameters() or SIGNDOC_Document_createSignatureParametersW():
Profile | Value |
---|---|
"" | "Signer"/SIGNDOC_SIGNATUREPARAMETERS_TEXTGROUP_MASTER, "SignTime"/SIGNDOC_SIGNATUREPARAMETERS_TEXTGROUP_MASTER |
"image" | (empty) |
See also blob parameter "Template".
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_SignatureParameters object. |
[in] | aItem | Select the string to be added:
|
[in] | aGroup | The string's group for font size computation: SIGNDOC_SIGNATUREPARAMETERS_TEXTGROUP_MASTER or SIGNDOC_SIGNATUREPARAMETERS_TEXTGROUP_SLAVE. |
[in] | aHAlignment | Horizontal alignment. This value overrides integer parameter "TextHAlignment" unless it is SIGNDOC_SIGNATUREPARAMETERS_HALIGNMENT_DEFAULT. Other possible values are SIGNDOC_SIGNATUREPARAMETERS_HALIGNMENT_LEFT, SIGNDOC_SIGNATUREPARAMETERS_HALIGNMENT_CENTER, SIGNDOC_SIGNATUREPARAMETERS_HALIGNMENT_RIGHT, SIGNDOC_SIGNATUREPARAMETERS_HALIGNMENT_JUSTIFY, and SIGNDOC_SIGNATUREPARAMETERS_HALIGNMENT_AUTO. |
[in] | aDirection | The paragraph direction: 0, SIGNDOC_SIGNATUREPARAMETERS_TEXTITEMDIRECTION_LTR, SIGNDOC_SIGNATUREPARAMETERS_TEXTITEMDIRECTION_RTL, SIGNDOC_SIGNATUREPARAMETERS_TEXTITEMDIRECTION_DEFAULT_LTR, or SIGNDOC_SIGNATUREPARAMETERS_TEXTITEMDIRECTION_DEFAULT_RTL. 0 is treated like SIGNDOC_SIGNATUREPARAMETERS_TEXTITEMDIRECTION_LTR. |
int SIGNDOC_SignatureParameters_clearTextItems | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_SignatureParameters * | aObj | ||
) |
Remove all strings that were to be displayed.
SIGNDOC_SignatureParameters_addTextItem() cannot remove the default strings without adding a new string. This function does.
See also blob parameter "Template".
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_SignatureParameters object. |
void SIGNDOC_SignatureParameters_delete | ( | struct SIGNDOC_SignatureParameters * | aObj | ) |
SIGNDOC_SignatureParameters destructor.
[in] | aObj | A pointer to the SIGNDOC_SignatureParameters object. |
int SIGNDOC_SignatureParameters_getAvailableMethods | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_SignatureParameters * | aObj | ||
) |
Get a bitset indicating which signing methods are available for this signature field.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_SignatureParameters object. |
const char * SIGNDOC_SignatureParameters_getErrorMessage | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_SignatureParameters * | 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_SignatureParameters 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_SignatureParameters_getErrorMessageW | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_SignatureParameters * | 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_SignatureParameters object. |
int SIGNDOC_SignatureParameters_getTemplate | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_SignatureParameters * | aObj, | ||
struct SIGNDOC_ByteArray * | aOutput | ||
) |
Get an XML document specifying the current layout.
This function can be used for debugging and for reporting bugs. This function will fail if the "Template" blob parameter is invalid.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_SignatureParameters object. |
[in,out] | aOutput | The XML document will be stored here. |
int SIGNDOC_SignatureParameters_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). |
int SIGNDOC_SignatureParameters_setBlob | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_SignatureParameters * | aObj, | ||
const char * | aName, | ||
const unsigned char * | aData, | ||
size_t | aSize | ||
) |
Set a blob parameter.
Available blob parameters are:
Additionally, you can store your own blobs in the signature by using a name starting with "Prop_", except for "Prop_AuthTime", "Prop_AuthType", "Prop_Build", and any name starting with "Prop_BiometricData", see SIGNDOC_VerificationResult_getSignatureBlob(). The name shall contain the following characters only: 0-9, a-z, A-Z, '-', and '_'.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_SignatureParameters object. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aData | A pointer to the first octet of the value. |
[in] | aSize | Size of the blob (number of octets). |
int SIGNDOC_SignatureParameters_setColor | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_SignatureParameters * | aObj, | ||
const char * | aName, | ||
const struct SIGNDOC_Color * | aValue | ||
) |
Set a color parameter.
Available color parameters are:
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_SignatureParameters object. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter (will be copied). |
int SIGNDOC_SignatureParameters_setECDSA | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_SignatureParameters * | aObj, | ||
struct SIGNDOC_SignECDSA * | aECDSA | ||
) |
Set an object which will create an ECDSA signature.
By default, ECDSA signatures are computed internally which means that the private key must be available on this machine.
Requirements for string parameters:
Requirements for integer parameters:
Requirements for blob parameters:
SIGNDOC_SignatureParameters_setRSA() and SIGNDOC_SignatureParameters_setPKCS7() must not have been called.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_SignatureParameters object. |
[in] | aECDSA | The object that will compute the ECDSA signature. This function does not take ownership of that object. It must still be alive when SIGNDOC_Document_addSignature() is called. |
int SIGNDOC_SignatureParameters_setInteger | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_SignatureParameters * | aObj, | ||
const char * | aName, | ||
int | aValue | ||
) |
Set an integer parameter.
Available integer parameters are:
BiometricEncryption Specifies how biometric data is to be encrypted: SIGNDOC_SIGNATUREPARAMETERS_BIOMETRICENCRYPTION_RSA, SIGNDOC_SIGNATUREPARAMETERS_BIOMETRICENCRYPTION_FIXED, SIGNDOC_SIGNATUREPARAMETERS_BIOMETRICENCRYPTION_BINARY, SIGNDOC_SIGNATUREPARAMETERS_BIOMETRICENCRYPTION_PASSPHRASE, or SIGNDOC_SIGNATUREPARAMETERS_BIOMETRICENCRYPTION_DONT_STORE.
If not set, biometric data will not be embedded in the signature.
Profile | Value |
---|---|
"" | SIGNDOC_SIGNATUREPARAMETERS_HALIGNMENT_CENTER |
"image" | SIGNDOC_SIGNATUREPARAMETERS_HALIGNMENT_CENTER |
Profile | Value |
---|---|
"" | SIGNDOC_SIGNATUREPARAMETERS_VALIGNMENT_TOP |
"image" | SIGNDOC_SIGNATUREPARAMETERS_VALIGNMENT_CENTER |
Profile | Value |
---|---|
"" | SIGNDOC_SIGNATUREPARAMETERS_HALIGNMENT_CENTER |
"image" | SIGNDOC_SIGNATUREPARAMETERS_HALIGNMENT_CENTER |
Profile | Value |
---|---|
"" | SIGNDOC_SIGNATUREPARAMETERS_TEXTPOSITION_BELOW |
"image" | SIGNDOC_SIGNATUREPARAMETERS_TEXTPOSITION_OVERLAY |
Profile | Value |
---|---|
"" | SIGNDOC_SIGNATUREPARAMETERS_VALIGNMENT_BOTTOM |
"image" | SIGNDOC_SIGNATUREPARAMETERS_VALIGNMENT_CENTER |
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_SignatureParameters object. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
int SIGNDOC_SignatureParameters_setLength | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_SignatureParameters * | aObj, | ||
const char * | aName, | ||
int | aType, | ||
double | aValue | ||
) |
Set a length parameter.
Available length parameters are:
Profile | Value |
---|---|
"" | SIGNDOC_SIGNATUREPARAMETERS_VALUETYPE_FIELD_HEIGHT and 0.1 |
"image" | SIGNDOC_SIGNATUREPARAMETERS_VALUETYPE_FIELD_HEIGHT and 0.1 |
Profile | Value |
---|---|
"" | SIGNDOC_SIGNATUREPARAMETERS_VALUETYPE_ABS and 1.0 |
"image" | SIGNDOC_SIGNATUREPARAMETERS_VALUETYPE_ABS and 1.0 |
Profile | Value |
---|---|
"" | SIGNDOC_SIGNATUREPARAMETERS_VALUETYPE_FIELD_HEIGHT and 0.1 |
"image" | SIGNDOC_SIGNATUREPARAMETERS_VALUETYPE_FIELD_HEIGHT and 0.1 |
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_SignatureParameters object. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aType | Define how the length is specified: SIGNDOC_SIGNATUREPARAMETERS_VALUETYPE_ABS, SIGNDOC_SIGNATUREPARAMETERS_VALUETYPE_FIELD_HEIGHT, or SIGNDOC_SIGNATUREPARAMETERS_VALUETYPE_FIELD_WIDTH. |
[in] | aValue | The value of the parameter. |
int SIGNDOC_SignatureParameters_setPKCS7 | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_SignatureParameters * | aObj, | ||
struct SIGNDOC_SignPKCS7 * | aPKCS7 | ||
) |
Set an object which will create a PKCS #7 or CAdES signature.
By default, PKCS #7 and CAdES signatures are handled internally which means that the private key must be available on this machine.
Requirements for string parameters:
Requirements for integer parameters:
Requirements for blob parameters:
SIGNDOC_SignatureParameters_setRSA() and SIGNDOC_SignatureParameters_setECDSA() must not have been called.
The SIGNDOC_SignPKCS7 interface is quite hard to use, please use SIGNDOC_SignatureParameters_setRSA() and the SIGNDOC_SignRSA interface or SIGNDOC_SignatureParameters_setECDSA() and the SIGNDOC_SignECDSA interface instead.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_SignatureParameters object. |
[in] | aPKCS7 | The object that will create the PKCS #7 or CAdES signature. This function does not take ownership of that object. It must still be alive when SIGNDOC_Document_addSignature() is called. |
int SIGNDOC_SignatureParameters_setRSA | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_SignatureParameters * | aObj, | ||
struct SIGNDOC_SignRSA * | aRSA | ||
) |
Set an object which will create an RSA signature.
By default, RSA signatures are computed internally which means that the private key must be available on this machine.
Requirements for string parameters:
Requirements for integer parameters:
Requirements for blob parameters:
SIGNDOC_SignatureParameters_setECDSA() and SIGNDOC_SignatureParameters_setPKCS7() must not have been called.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_SignatureParameters object. |
[in] | aRSA | The object that will compute the RSA signature. This function does not take ownership of that object. It must still be alive when SIGNDOC_Document_addSignature() is called. |
int SIGNDOC_SignatureParameters_setString | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_SignatureParameters * | aObj, | ||
int | aEncoding, | ||
const char * | aName, | ||
const char * | aValue | ||
) |
Set a string parameter.
Available string parameters are:
Additionally, you can store your own strings in the signature by using a name starting with "Prop_", except for "Prop_AuthTime", "Prop_AuthType", "Prop_Build", and any name starting with "Prop_BiometricData", see SIGNDOC_VerificationResult_getSignatureString(). The name shall contain the following characters only: 0-9, a-z, A-Z, '-', and '_'. The length of the value is restricted for PDF documents and depends on the characters being used; the value encoded as PDF text string shall not exceed 32767 octets.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_SignatureParameters object. |
[in] | aEncoding | The encoding used for 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_SignatureParameters_setStringW | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_SignatureParameters * | aObj, | ||
const char * | aName, | ||
const wchar_t * | aValue | ||
) |
Set a string parameter.
See SIGNDOC_SignatureParameters_setString() for a list of available string parameters.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_SignatureParameters object. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
int SIGNDOC_SignatureParameters_setTextItemDirection | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_SignatureParameters * | aObj, | ||
const char * | aItem, | ||
int | aHAlignment, | ||
int | aDirection | ||
) |
Set the paragraph direction of text items.
This function sets the paragraph direction of all existing text items matching aItem.
See also blob parameter "Template".
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_SignatureParameters object. |
[in] | aItem | Select the text items:
|
[in] | aHAlignment | Horizontal alignment. This value overrides integer parameter "TextHAlignment" unless it is SIGNDOC_SIGNATUREPARAMETERS_HALIGNMENT_DEFAULT. Other possible values are SIGNDOC_SIGNATUREPARAMETERS_HALIGNMENT_LEFT, SIGNDOC_SIGNATUREPARAMETERS_HALIGNMENT_CENTER, SIGNDOC_SIGNATUREPARAMETERS_HALIGNMENT_RIGHT, SIGNDOC_SIGNATUREPARAMETERS_HALIGNMENT_JUSTIFY, and SIGNDOC_SIGNATUREPARAMETERS_HALIGNMENT_AUTO. |
[in] | aDirection | The paragraph direction: 0, SIGNDOC_SIGNATUREPARAMETERS_TEXTITEMDIRECTION_LTR, SIGNDOC_SIGNATUREPARAMETERS_TEXTITEMDIRECTION_RTL, SIGNDOC_SIGNATUREPARAMETERS_TEXTITEMDIRECTION_DEFAULT_LTR, or SIGNDOC_SIGNATUREPARAMETERS_TEXTITEMDIRECTION_DEFAULT_RTL. 0 is treated like SIGNDOC_SIGNATUREPARAMETERS_TEXTITEMDIRECTION_LTR. |