SIGNDOC_StringArray Class Reference

Array of strings. More...

#include <SignDocSDK-c.h>

Public Member Functions
struct SIGNDOC_StringArray *	SIGNDOC_StringArray_new (struct SIGNDOC_Exception **aEx)
	Create a new array of strings. More...
void	SIGNDOC_StringArray_delete (struct SIGNDOC_StringArray *aArray)
	Free an array of strings and all its elements. More...
unsigned	SIGNDOC_StringArray_count (const struct SIGNDOC_StringArray *aArray)
	Get the number of elements in an array of strings. More...
const char *	SIGNDOC_StringArray_at (struct SIGNDOC_StringArray *aArray, unsigned aIdx)
	Get a particular string of an array of strings. More...

Detailed Description

Array of strings.

Member Function Documentation

const char * SIGNDOC_StringArray_at	(	struct SIGNDOC_StringArray *	aArray,
		unsigned	aIdx
	)

Get a particular string of an array of strings.

Note

Do not call SIGNDOC_free() on the return value.

Parameters

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

Returns

A pointer to the string at index aIdx.

unsigned SIGNDOC_StringArray_count

(

const struct SIGNDOC_StringArray *

aArray

)

Get the number of elements in an array of strings.

Parameters

[in]

aArray

A pointer to an array of strings created by SIGNDOC_StringArray_new().

Returns

The number of elements in the array.

void SIGNDOC_StringArray_delete

(

struct SIGNDOC_StringArray *

aArray

)

Free an array of strings and all its elements.

Parameters

[in]

aArray

A pointer to an array of strings created by SIGNDOC_StringArray_new().

struct SIGNDOC_StringArray * SIGNDOC_StringArray_new

(

struct SIGNDOC_Exception **

aEx

)

Create a new array of strings.

Parameters

[out]

aEx

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

Returns

A pointer to a new array of strings.

See also

SIGNDOC_StringArray_delete()

---

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

• SignDocSDK-c.h