SignDoc SDK (C)
5.0.0
|
One property, without value. More...
#include <SignDocSDK-c.h>
Public Member Functions | |
struct SIGNDOC_Property * | SIGNDOC_Property_new (struct SIGNDOC_Exception **aEx) |
SIGNDOC_Property constructor. More... | |
struct SIGNDOC_Property * | SIGNDOC_Property_clone (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_Property *aSource) |
Clone a SIGNDOC_Property object. More... | |
void | SIGNDOC_Property_delete (struct SIGNDOC_Property *aObj) |
SIGNDOC_Property destructor. More... | |
char * | SIGNDOC_Property_getName (struct SIGNDOC_Exception **aEx, struct SIGNDOC_Property *aObj, int aEncoding) |
Get the name of the property. More... | |
const char * | SIGNDOC_Property_getNameUTF8 (struct SIGNDOC_Exception **aEx, struct SIGNDOC_Property *aObj) |
Get the name of the property as UTF-8-encoded C string. More... | |
int | SIGNDOC_Property_getType (struct SIGNDOC_Exception **aEx, struct SIGNDOC_Property *aObj) |
Get the type of the property. More... | |
One property, without value.
Use SIGNDOC_Document_getBooleanProperty(), SIGNDOC_Document_getIntegerProperty(), or SIGNDOC_Document_getStringProperty() to get the value of a property.
struct SIGNDOC_Property * SIGNDOC_Property_clone | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_Property * | aSource | ||
) |
Clone a SIGNDOC_Property 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_Property_delete | ( | struct SIGNDOC_Property * | aObj | ) |
SIGNDOC_Property destructor.
[in] | aObj | A pointer to the SIGNDOC_Property object, must not be a pointer returned by SIGNDOC_PropertyArray_at(). |
char * SIGNDOC_Property_getName | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_Property * | aObj, | ||
int | aEncoding | ||
) |
Get the name of the property.
Property names are compared under Unicode simple case folding, that is, lower case and upper case is not distinguished.
This function throws an exception of type SIGNDOC_EXCEPTION_TYPE_SPOOC_ENCODING_ERROR if the name cannot be represented using the specified encoding.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_Property object. |
[in] | aEncoding | The encoding to be used for the return value (SIGNDOC_ENCODING_NATIVE, SIGNDOC_ENCODING_UTF_8, or SIGNDOC_ENCODING_LATIN_1). |
const char * SIGNDOC_Property_getNameUTF8 | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_Property * | aObj | ||
) |
Get the name of the property as UTF-8-encoded C string.
Property names are compared under Unicode simple case folding, that is, lower case and upper case is not distinguished.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_Property object. |
int SIGNDOC_Property_getType | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_Property * | aObj | ||
) |
Get the type of the property.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_Property object. |
struct SIGNDOC_Property * SIGNDOC_Property_new | ( | struct SIGNDOC_Exception ** | aEx | ) |
SIGNDOC_Property constructor.
The new SIGNDOC_Property object will have one widget.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |