SignDoc SDK (C)  5.0.0
SIGNDOC_Property Class Reference

One property, without value. More...

#include <SignDocSDK-c.h>

Public Member Functions

struct SIGNDOC_PropertySIGNDOC_Property_new (struct SIGNDOC_Exception **aEx)
 SIGNDOC_Property constructor. More...
 
struct SIGNDOC_PropertySIGNDOC_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...
 

Detailed Description

Member Function Documentation

struct SIGNDOC_Property * SIGNDOC_Property_clone ( struct SIGNDOC_Exception **  aEx,
const struct SIGNDOC_Property aSource 
)

Clone a SIGNDOC_Property object.

Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
[in]aSourceThe object to be copied.
void SIGNDOC_Property_delete ( struct SIGNDOC_Property aObj)

SIGNDOC_Property destructor.

Parameters
[in]aObjA 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.

Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
[in]aObjA pointer to the SIGNDOC_Property object.
[in]aEncodingThe encoding to be used for the return value (SIGNDOC_ENCODING_NATIVE, SIGNDOC_ENCODING_UTF_8, or SIGNDOC_ENCODING_LATIN_1).
Returns
The name of the property. The string must be freed with SIGNDOC_free().
See also
SIGNDOC_Property_getNameUTF8()
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.

Note
Do not call SIGNDOC_free() on the return value.
Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
[in]aObjA pointer to the SIGNDOC_Property object.
Returns
The name of the property. This pointer will become invalid when aObj is destroyed.
See also
SIGNDOC_Property_getName()
int SIGNDOC_Property_getType ( struct SIGNDOC_Exception **  aEx,
struct SIGNDOC_Property aObj 
)

Get the type of the property.

Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
[in]aObjA pointer to the SIGNDOC_Property object.
Returns
The type of the property: SIGNDOC_PROPERTY_TYPE_STRING, SIGNDOC_PROPERTY_TYPE_INTEGER, or SIGNDOC_PROPERTY_TYPE_BOOLEAN.
struct SIGNDOC_Property * SIGNDOC_Property_new ( struct SIGNDOC_Exception **  aEx)

SIGNDOC_Property constructor.

The new SIGNDOC_Property object will have one widget.

Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.

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