SignDoc SDK (C)  5.0.0
SIGNDOC_RectArray Class Reference

Array of rectangles. More...

#include <SignDocSDK-c.h>

Public Member Functions

struct SIGNDOC_RectArraySIGNDOC_RectArray_new (struct SIGNDOC_Exception **aEx)
 Create a new array of SIGNDOC_Rect objects. More...
 
void SIGNDOC_RectArray_delete (struct SIGNDOC_RectArray *aArray)
 Free an array of SIGNDOC_Rect objects and all its elements. More...
 
unsigned SIGNDOC_RectArray_count (const struct SIGNDOC_RectArray *aArray)
 Get the number of elements in an array of SIGNDOC_Rect objects. More...
 
struct SIGNDOC_RectSIGNDOC_RectArray_at (struct SIGNDOC_RectArray *aArray, unsigned aIdx)
 Get a particular SIGNDOC_Rect object from an array. More...
 

Detailed Description

Array of rectangles.

Member Function Documentation

struct SIGNDOC_Rect * SIGNDOC_RectArray_at ( struct SIGNDOC_RectArray aArray,
unsigned  aIdx 
)

Get a particular SIGNDOC_Rect object from an array.

Parameters
[in]aArrayA pointer to an array created by SIGNDOC_RectArray_new().
[in]aIdxThe 0-based array index.
Returns
A pointer to the SIGNDOC_Rect object at position aIdx.
unsigned SIGNDOC_RectArray_count ( const struct SIGNDOC_RectArray aArray)

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

Parameters
[in]aArrayA pointer to an array created by SIGNDOC_RectArray_new().
Returns
The number of elements in the array.
void SIGNDOC_RectArray_delete ( struct SIGNDOC_RectArray aArray)

Free an array of SIGNDOC_Rect objects and all its elements.

Parameters
[in]aArrayA pointer to an array created by SIGNDOC_RectArray_new().
struct SIGNDOC_RectArray * SIGNDOC_RectArray_new ( struct SIGNDOC_Exception **  aEx)

Create a new array of SIGNDOC_Rect objects.

Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
Returns
A pointer to a new array of SIGNDOC_Rect objects.
See also
SIGNDOC_RectArray_delete()

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