SIGNDOC_FieldArray Class Reference

Array of fields. More...

#include <SignDocSDK-c.h>

Public Member Functions
struct SIGNDOC_FieldArray *	SIGNDOC_FieldArray_new (struct SIGNDOC_Exception **aEx)
	Create a new array of fields (SIGNDOC_Field objects). More...
void	SIGNDOC_FieldArray_delete (struct SIGNDOC_FieldArray *aArray)
	Free an array of fields and all its elements. More...
unsigned	SIGNDOC_FieldArray_count (const struct SIGNDOC_FieldArray *aArray)
	Get the number of elements in an array of fields. More...
struct SIGNDOC_Field *	SIGNDOC_FieldArray_at (struct SIGNDOC_FieldArray *aArray, unsigned aIdx)
	Get a particular field from an array of fields. More...

Detailed Description

Array of fields.

Member Function Documentation

struct SIGNDOC_Field * SIGNDOC_FieldArray_at	(	struct SIGNDOC_FieldArray *	aArray,
		unsigned	aIdx
	)

Get a particular field from an array of fields.

Parameters

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

Returns

A pointer to the field at position aIdx.

unsigned SIGNDOC_FieldArray_count

(

const struct SIGNDOC_FieldArray *

aArray

)

Get the number of elements in an array of fields.

Parameters

[in]

aArray

A pointer to an array of fields created by SIGNDOC_FieldArray_new().

Returns

The number of elements in the array.

void SIGNDOC_FieldArray_delete

(

struct SIGNDOC_FieldArray *

aArray

)

Free an array of fields and all its elements.

Parameters

[in]

aArray

A pointer to an array of fields created by SIGNDOC_FieldArray_new().

struct SIGNDOC_FieldArray * SIGNDOC_FieldArray_new

(

struct SIGNDOC_Exception **

aEx

)

Create a new array of fields (SIGNDOC_Field 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 fields.

See also

SIGNDOC_FieldArray_delete()

---

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

• SignDocSDK-c.h