SignDoc SDK (C)  5.0.0
SIGNDOC_ByteArray Class Reference

Array of bytes. More...

#include <SignDocSDK-c.h>

Public Member Functions

const int * SIGNDOC_IntArray_data (const struct SIGNDOC_IntArray *aArray)
 Get a pointer to the data in an array of int values. More...
 
struct SIGNDOC_ByteArraySIGNDOC_ByteArray_new (struct SIGNDOC_Exception **aEx)
 Create a new array of bytes (blob). More...
 
void SIGNDOC_ByteArray_delete (struct SIGNDOC_ByteArray *aArray)
 Free an array of bytes. More...
 
unsigned SIGNDOC_ByteArray_count (const struct SIGNDOC_ByteArray *aArray)
 Get the number of elements in an array of bytes. More...
 
unsigned char SIGNDOC_ByteArray_at (struct SIGNDOC_ByteArray *aArray, unsigned aIdx)
 Get a particular byte of an array of bytes. More...
 
unsigned char * SIGNDOC_ByteArray_data (struct SIGNDOC_ByteArray *aArray)
 Get a pointer to the data in an array of bytes. More...
 
void SIGNDOC_ByteArray_clear (struct SIGNDOC_ByteArray *aObj)
 Clear a SIGNDOC_ByteArray object. More...
 
void SIGNDOC_ByteArray_set (struct SIGNDOC_Exception **aEx, struct SIGNDOC_ByteArray *aObj, const unsigned char *aPtr, size_t aSize)
 Replace all the data in a SIGNDOC_ByteArray object. More...
 

Detailed Description

Array of bytes.

Member Function Documentation

unsigned char SIGNDOC_ByteArray_at ( struct SIGNDOC_ByteArray aArray,
unsigned  aIdx 
)

Get a particular byte of an array of bytes.

Parameters
[in]aArrayA pointer to an array of bytes created by SIGNDOC_ByteArray_new().
[in]aIdxThe 0-based array index.
Returns
The byte at index aIdx.
void SIGNDOC_ByteArray_clear ( struct SIGNDOC_ByteArray aObj)

Clear a SIGNDOC_ByteArray object.

SIGNDOC_ByteArray_count() will return 0.

Parameters
[in]aObjA pointer to the SIGNDOC_UserOutputStream object.
unsigned SIGNDOC_ByteArray_count ( const struct SIGNDOC_ByteArray aArray)

Get the number of elements in an array of bytes.

Parameters
[in]aArrayA pointer to an array of bytes created by SIGNDOC_ByteArray_new().
Returns
The number of elements (bytes).
unsigned char * SIGNDOC_ByteArray_data ( struct SIGNDOC_ByteArray aArray)

Get a pointer to the data in an array of bytes.

Parameters
[in]aArrayA pointer to an array of bytes created by SIGNDOC_ByteArray_new().
Returns
A pointer to the first byte or NULL if the array is empty.
See also
SIGNDOC_ByteArray_at(), SIGNDOC_ByteArray_count()
void SIGNDOC_ByteArray_delete ( struct SIGNDOC_ByteArray aArray)

Free an array of bytes.

Parameters
[in]aArrayA pointer to an array of bytes created by SIGNDOC_ByteArray_new(), must not be a pointer returned by SIGNDOC_ByteArrayArray_at().
struct SIGNDOC_ByteArray * SIGNDOC_ByteArray_new ( struct SIGNDOC_Exception **  aEx)

Create a new array of bytes (blob).

Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
Returns
A pointer to a new array of bytes.
See also
SIGNDOC_ByteArray_delete()
void SIGNDOC_ByteArray_set ( struct SIGNDOC_Exception **  aEx,
struct SIGNDOC_ByteArray aObj,
const unsigned char *  aPtr,
size_t  aSize 
)

Replace all the data in a SIGNDOC_ByteArray object.

Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
[in]aObjA pointer to the SIGNDOC_UserOutputStream object.
[in]aPtrA pointer to the first octet.
[in]aSizeNumber of octets pointed to by aPtr.
const int * SIGNDOC_IntArray_data ( const struct SIGNDOC_IntArray aArray)

Get a pointer to the data in an array of int values.

Parameters
[in]aArrayA pointer to an array of bytes created by SIGNDOC_IntArray_new().
Returns
A pointer to the first value or NULL if the array is empty.
See also
SIGNDOC_IntArray_at(), SIGNDOC_IntArray_count()

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