SIGNDOC_ByteArrayArray Class Reference

Array of arrays of bytes. More...

#include <SignDocSDK-c.h>

Public Member Functions
struct SIGNDOC_ByteArrayArray *	SIGNDOC_ByteArrayArray_new (struct SIGNDOC_Exception **aEx)
	Creates a new array of SIGNDOC_ByteArray objects. More...
void	SIGNDOC_ByteArrayArray_delete (struct SIGNDOC_ByteArrayArray *aArray)
	Free an array of SIGNDOC_ByteArray objects and all its elements. More...
unsigned	SIGNDOC_ByteArrayArray_count (const struct SIGNDOC_ByteArrayArray *aArray)
	Get the number of elements in an array of SIGNDOC_ByteArray objects. More...
struct SIGNDOC_ByteArray *	SIGNDOC_ByteArrayArray_at (struct SIGNDOC_ByteArrayArray *aArray, unsigned aIdx)
	Get a particular element of an array of SIGNDOC_ByteArray objects. More...

Detailed Description

Array of arrays of bytes.

Member Function Documentation

struct SIGNDOC_ByteArray * SIGNDOC_ByteArrayArray_at	(	struct SIGNDOC_ByteArrayArray *	aArray,
		unsigned	aIdx
	)

Get a particular element of an array of SIGNDOC_ByteArray objects.

Parameters

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

Returns

A pointer to SIGNDOC_ByteArray object at position aIdx.

unsigned SIGNDOC_ByteArrayArray_count

(

const struct SIGNDOC_ByteArrayArray *

aArray

)

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

Parameters

[in]

aArray

A pointer to an array created by SIGNDOC_ByteArrayArray_new().

Returns

The number of elements (blobs).

void SIGNDOC_ByteArrayArray_delete

(

struct SIGNDOC_ByteArrayArray *

aArray

)

Free an array of SIGNDOC_ByteArray objects and all its elements.

Parameters

[in]

aArray

A pointer to an array created by SIGNDOC_ByteArrayArray_new().

struct SIGNDOC_ByteArrayArray * SIGNDOC_ByteArrayArray_new

(

struct SIGNDOC_Exception **

aEx

)

Creates a new array of SIGNDOC_ByteArray 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_ByteArray objects.

See also

SIGNDOC_ByteArrayArray_delete()

---

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

• SignDocSDK-c.h