A single change made to a PDF document after a signature. SIGNDOC_Document_getSignature().
More...
#include <SignDocSDK-c.h>
|
void | SIGNDOC_Change_delete (struct SIGNDOC_Change *aObj) |
| SIGNDOC_Change destructor. More...
|
|
int | SIGNDOC_Change_getType (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_Change *aObj) |
| Get the type of the change. More...
|
|
char * | SIGNDOC_Change_getName (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_Change *aObj, int aEncoding) |
| Get the name of the changed field, annotation, or attachment. More...
|
|
const char * | SIGNDOC_Change_getNameUTF8 (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_Change *aObj) |
| Get the name of the changed field, annotation, or attachment as UTF-8-encoded C string. More...
|
|
int | SIGNDOC_Change_getPage (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_Change *aObj) |
| Get the page number of the change. More...
|
|
int | SIGNDOC_Change_getFieldType (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_Change *aObj) |
| Get the type of the changed field. More...
|
|
const char * | SIGNDOC_Change_getAnnotationType (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_Change *aObj) |
| Get the type of the changed annotation. More...
|
|
A single change made to a PDF document after a signature. SIGNDOC_Document_getSignature().
- See also
- SIGNDOC_Signature_getChange()
Get the type of the changed annotation.
- 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_Change object. |
- Returns
- The annotation type as string, empty if not known (for instance, if the change does not involve an annotation). This pointer will become invalid when aObj is destroyed.
Get the name of the changed field, annotation, or attachment.
For change types SIGNDOC_CHANGE_TYPE_FIELD_ADDED, SIGNDOC_CHANGE_TYPE_FIELD_REMOVED, SIGNDOC_CHANGE_TYPE_FIELD_MODIFIED, SIGNDOC_CHANGE_TYPE_ANNOTATION_ADDED, SIGNDOC_CHANGE_TYPE_ANNOTATION_REMOVED, SIGNDOC_CHANGE_TYPE_ANNOTATION_MODIFIED, SIGNDOC_CHANGE_TYPE_ATTACHMENT_ADDED, SIGNDOC_CHANGE_TYPE_ATTACHMENT_REMOVED, and SIGNDOC_CHANGE_TYPE_ATTACHMENT_MODIFIED, the name of the changed field, annotation, or attachment can be retrieved by calling this function.
- Parameters
-
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_Change object. |
[in] | aEncoding | The encoding to be used for the return value. |
- Returns
- The name of the field, annotation, or attachment; empty if not available. If flag SIGNDOC_DOCUMENT_FLAGS_KEEP_ESCAPE_SEQUENCES is set, the string may contain escape sequences for selecting natural languages.
- See also
- SIGNDOC_Change_getNameUTF8(), SIGNDOC_Change_getType()
Get the name of the changed field, annotation, or attachment as UTF-8-encoded C string.
For change types SIGNDOC_CHANGE_TYPE_FIELD_ADDED, SIGNDOC_CHANGE_TYPE_FIELD_REMOVED, SIGNDOC_CHANGE_TYPE_FIELD_MODIFIED, SIGNDOC_CHANGE_TYPE_ANNOTATION_ADDED, SIGNDOC_CHANGE_TYPE_ANNOTATION_REMOVED, SIGNDOC_CHANGE_TYPE_ANNOTATION_MODIFIED, SIGNDOC_CHANGE_TYPE_ATTACHMENT_ADDED, SIGNDOC_CHANGE_TYPE_ATTACHMENT_REMOVED, and SIGNDOC_CHANGE_TYPE_ATTACHMENT_MODIFIED, the name of the changed field, annotation, or attachment can be retrieved by calling this function.
- 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_Change object. |
- Returns
- The name of the field, annotation, or attachment; empty if not available. This pointer will become invalid when aObj is destroyed.
- See also
- SIGNDOC_Change_getName(), SIGNDOC_Change_getType()
Get the page number of the change.
- Parameters
-
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_Change object. |
- Returns
- The one-based page number or 0 if not available. For removed items, the page number is in the document "as
signed" by the signature described by the SIGNDOC_Signature object, for modified and added items, the page number is in the document "as signed" by the next signature (or the current version of the document if the SIGNDOC_Signature object describes the last signature).
Get the type of the change.
- Parameters
-
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_Signature object. |
- Returns
- The type of the change: SIGNDOC_CHANGE_TYPE_OTHER, SIGNDOC_CHANGE_TYPE_FIELD_ADDED, SIGNDOC_CHANGE_TYPE_FIELD_REMOVED, SIGNDOC_CHANGE_TYPE_FIELD_MODIFIED, SIGNDOC_CHANGE_TYPE_FIELD_FILLED_IN, SIGNDOC_CHANGE_TYPE_ANNOTATION_ADDED, SIGNDOC_CHANGE_TYPE_ANNOTATION_REMOVED, SIGNDOC_CHANGE_TYPE_ANNOTATION_MODIFIED, SIGNDOC_CHANGE_TYPE_ATTACHMENT_ADDED, SIGNDOC_CHANGE_TYPE_ATTACHMENT_REMOVED, SIGNDOC_CHANGE_TYPE_ATTACHMENT_MODIFIED, SIGNDOC_CHANGE_TYPE_PAGE_ADDED, SIGNDOC_CHANGE_TYPE_PAGE_REMOVED, SIGNDOC_CHANGE_TYPE_PAGE_MODIFIED.
The documentation for this class was generated from the following file: