SignDoc SDK (C)  5.0.0
SIGNDOC_WeightedFrameArray Class Reference

Array of frames. More...

#include <SignDocSDK-c.h>

Public Member Functions

struct SIGNDOC_WeightedFrameArraySIGNDOC_WeightedFrameArray_new (struct SIGNDOC_Exception **aEx)
 Create a new array of SIGNDOC_WeightedFrame objects. More...
 
void SIGNDOC_WeightedFrameArray_delete (struct SIGNDOC_WeightedFrameArray *aArray)
 Free an array of SIGNDOC_WeightedFrame objects and all its elements. More...
 
unsigned SIGNDOC_WeightedFrameArray_count (const struct SIGNDOC_WeightedFrameArray *aArray)
 Get the number of elements in an array of SIGNDOC_WeightedFrame objects. More...
 
struct SIGNDOC_WeightedFrameSIGNDOC_WeightedFrameArray_at (struct SIGNDOC_WeightedFrameArray *aArray, unsigned aIdx)
 Get a particular SIGNDOC_WeightedFrame object from an array. More...
 

Detailed Description

Array of frames.

Member Function Documentation

struct SIGNDOC_WeightedFrame * SIGNDOC_WeightedFrameArray_at ( struct SIGNDOC_WeightedFrameArray aArray,
unsigned  aIdx 
)

Get a particular SIGNDOC_WeightedFrame object from an array.

Parameters
[in]aArrayA pointer to an array created by SIGNDOC_WeightedFrameArray_new().
[in]aIdxThe 0-based array index.
Returns
A pointer to the SIGNDOC_WeightedFrame object at position aIdx.
unsigned SIGNDOC_WeightedFrameArray_count ( const struct SIGNDOC_WeightedFrameArray aArray)

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

Parameters
[in]aArrayA pointer to an array created by SIGNDOC_WeightedFrameArray_new().
Returns
The number of elements in the array.
void SIGNDOC_WeightedFrameArray_delete ( struct SIGNDOC_WeightedFrameArray aArray)

Free an array of SIGNDOC_WeightedFrame objects and all its elements.

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

Create a new array of SIGNDOC_WeightedFrame 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_WeightedFrame objects.
See also
SIGNDOC_WeightedFrameArray_delete()

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