SIGNDOC_FindTextOccurrenceArray Class Reference

Array of SIGNDOC_FindTextOccurrence objects. More...

#include <SignDocSDK-c.h>

Public Member Functions
struct SIGNDOC_FindTextOccurrenceArray *	SIGNDOC_FindTextOccurrenceArray_new (struct SIGNDOC_Exception **aEx)
	Create a new array of SIGNDOC_FindTextOccurrence objects. More...
void	SIGNDOC_FindTextOccurrenceArray_delete (struct SIGNDOC_FindTextOccurrenceArray *aArray)
	Free an array of SIGNDOC_FindTextOccurrence objects and all its elements. More...
unsigned	SIGNDOC_FindTextOccurrenceArray_count (const struct SIGNDOC_FindTextOccurrenceArray *aArray)
	Get the number of elements in an array of SIGNDOC_FindTextOccurrence objects. More...
struct SIGNDOC_FindTextOccurrence *	SIGNDOC_FindTextOccurrenceArray_at (struct SIGNDOC_FindTextOccurrenceArray *aArray, unsigned aIdx)
	Get a particular SIGNDOC_FindTextOccurrence object from an array. More...

Detailed Description

Array of SIGNDOC_FindTextOccurrence objects.

Member Function Documentation

struct SIGNDOC_FindTextOccurrence * SIGNDOC_FindTextOccurrenceArray_at	(	struct SIGNDOC_FindTextOccurrenceArray *	aArray,
		unsigned	aIdx
	)

Get a particular SIGNDOC_FindTextOccurrence object from an array.

Parameters

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

Returns

A pointer to the SIGNDOC_FindTextOccurrence object at position aIdx.

unsigned SIGNDOC_FindTextOccurrenceArray_count

(

const struct SIGNDOC_FindTextOccurrenceArray *

aArray

)

Get the number of elements in an array of SIGNDOC_FindTextOccurrence objects.

Parameters

[in]

aArray

A pointer to an array created by SIGNDOC_FindTextOccurrenceArray_new().

Returns

The number of elements in the array.

void SIGNDOC_FindTextOccurrenceArray_delete

(

struct SIGNDOC_FindTextOccurrenceArray *

aArray

)

Free an array of SIGNDOC_FindTextOccurrence objects and all its elements.

Parameters

[in]

aArray

A pointer to an array created by SIGNDOC_FindTextOccurrenceArray_new().

struct SIGNDOC_FindTextOccurrenceArray * SIGNDOC_FindTextOccurrenceArray_new

(

struct SIGNDOC_Exception **

aEx

)

Create a new array of SIGNDOC_FindTextOccurrence 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 SIGNDOC_FindTextOccurrence objects.

See also

SIGNDOC_FindTextOccurrenceArray_delete()

---

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

• SignDocSDK-c.h