SIGNDOC_PropertyArray Class Reference

Array of properties. More...

#include <SignDocSDK-c.h>

Public Member Functions
struct SIGNDOC_PropertyArray *	SIGNDOC_PropertyArray_new (struct SIGNDOC_Exception **aEx)
	Create a new array of properties (SIGNDOC_Property objects). More...
void	SIGNDOC_PropertyArray_delete (struct SIGNDOC_PropertyArray *aArray)
	Free an array of properties and all its elements. More...
unsigned	SIGNDOC_PropertyArray_count (const struct SIGNDOC_PropertyArray *aArray)
	Get the number of elements in an array of properties. More...
struct SIGNDOC_Property *	SIGNDOC_PropertyArray_at (struct SIGNDOC_PropertyArray *aArray, unsigned aIdx)
	Get a particular property from an array of properties. More...

Detailed Description

Array of properties.

Member Function Documentation

struct SIGNDOC_Property * SIGNDOC_PropertyArray_at	(	struct SIGNDOC_PropertyArray *	aArray,
		unsigned	aIdx
	)

Get a particular property from an array of properties.

Parameters

[in]	aArray	A pointer to an array of properties created by SIGNDOC_PropertyArray_new().
[in]	aIdx	The 0-based array index.

Returns

A pointer to the property at position aIdx.

unsigned SIGNDOC_PropertyArray_count

(

const struct SIGNDOC_PropertyArray *

aArray

)

Get the number of elements in an array of properties.

Parameters

[in]

aArray

A pointer to an array of properties created by SIGNDOC_PropertyArray_new().

Returns

The number of elements in the array.

void SIGNDOC_PropertyArray_delete

(

struct SIGNDOC_PropertyArray *

aArray

)

Free an array of properties and all its elements.

Parameters

[in]

aArray

A pointer to an array of properties created by SIGNDOC_PropertyArray_new().

struct SIGNDOC_PropertyArray * SIGNDOC_PropertyArray_new

(

struct SIGNDOC_Exception **

aEx

)

Create a new array of properties (SIGNDOC_Property objects).

Parameters

[out]

aEx

Any exception will be returned in the object pointed to by this parameter.

Returns

A pointer to a new array of properties.

See also

SIGNDOC_PropertyArray_delete()

---

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

• SignDocSDK-c.h