ByteArray.h File Reference

OpenSOAP API ByteArray Processing. More...

#include <stdlib.h>
#include <sys/types.h>
#include <OpenSOAP/Defines.h>
#include <OpenSOAP/ErrorCode.h>

Go to the source code of this file.

Defines
#define	OpenSOAPByteArrayCreateWithSize(sz, b_ary)   OpenSOAPByteArrayCreateWithData(0, (sz), (b_ary))
	OpenSOAPByteArrayCreateWithSize() Function Definition.
Typedefs
typedef tagOpenSOAPByteArray	OpenSOAPByteArray
	OpenSOAPByteArray Structure Type Definition.
typedef OpenSOAPByteArray *	OpenSOAPByteArrayPtr
	OpenSOAPByteArray Pointer Type Definition.
Functions
int	OpenSOAPByteArrayCreate (OpenSOAPByteArrayPtr *b_ary)
	Create a variable size Byte(unsigned char) Array.
int	OpenSOAPByteArrayCreateWithData (const unsigned char *data, size_t sz, OpenSOAPByteArrayPtr *b_ary)
	Create OpenSOAPByteArray with initial data.
int	OpenSOAPByteArrayAppendRef (OpenSOAPByteArrayPtr b_ary)
	Use OpenSOAPByteArray Resource declare.
int	OpenSOAPByteArrayRelease (OpenSOAPByteArrayPtr b_ary)
	Release OpenSOAPByteArray Resource.
int	OpenSOAPByteArrayGetSize (OpenSOAPByteArrayPtr b_ary, size_t *sz)
	Get size of variable size Byte (unsigned char) Array.
int	OpenSOAPByteArrayBeginConst (OpenSOAPByteArrayPtr b_ary, const unsigned char **beg)
	Get const pointer to head of variable Byte (unsigned char) Array.
int	OpenSOAPByteArrayEndConst (OpenSOAPByteArrayPtr b_ary, const unsigned char **ed)
	Get const pointer to tail of variable Byte (unsigned char) Array.
int	OpenSOAPByteArrayGetBeginSizeConst (OpenSOAPByteArrayPtr b_ary, const unsigned char **beg, size_t *sz)
	Get const pointer to head of variable Byte (unsigned char) Array and size.
int	OpenSOAPByteArrayGetBeginEndConst (OpenSOAPByteArrayPtr b_ary, const unsigned char **beg, const unsigned char **ed)
	Get const pointer to head and tail of variable Byte (unsigned char) Array.
int	OpenSOAPByteArrayBegin (OpenSOAPByteArrayPtr b_ary, unsigned char **beg)
	Get pointer to head of variable Byte (unsigned char) Array.
int	OpenSOAPByteArrayEnd (OpenSOAPByteArrayPtr b_ary, unsigned char **ed)
	Get pointer to tail of variable Byte (unsigned char) Array.
int	OpenSOAPByteArrayGetBeginSize (OpenSOAPByteArrayPtr b_ary, unsigned char **beg, size_t *sz)
	Get pointer to head of variable Byte (unsigned char) Array and size.
int	OpenSOAPByteArrayGetBeginEnd (OpenSOAPByteArrayPtr b_ary, unsigned char **beg, unsigned char **ed)
	Get pointer to head and tail of variable Byte (unsigned char) Array.
int	OpenSOAPByteArrayClear (OpenSOAPByteArrayPtr b_ary)
	Clear OpenSOAPByteArray.
int	OpenSOAPByteArraySetData (OpenSOAPByteArrayPtr b_ary, const unsigned char *data, size_t sz)
	Set data of OpenSOAPByteArray.
int	OpenSOAPByteArrayAppend (OpenSOAPByteArrayPtr b_ary, const unsigned char *dat, size_t dat_len)
	Append Byte data to OpenSOAPByteArray.
int	OpenSOAPByteArrayResize (OpenSOAPByteArrayPtr b_ary, size_t new_size)
	Resize OpenSOAPByteArray.
int	OpenSOAPByteArrayDuplicate (OpenSOAPByteArrayPtr b_ary, OpenSOAPByteArrayPtr *dup_b_ary)
	Duplicate OpenSOAPByteArray.

---

Detailed Description

OpenSOAP API ByteArray Processing.

Author:

OpenSOAP Development Team

---

Define Documentation

#define OpenSOAPByteArrayCreateWithSize (  sz, b_ary   )     OpenSOAPByteArrayCreateWithData(0, (sz), (b_ary))

OpenSOAPByteArrayCreateWithSize() Function Definition. OpenSOAPByteArrayCreateWithData(0, (sz), (b_ary))

---

Function Documentation

int OpenSOAPByteArrayAppend (  OpenSOAPByteArrayPtr  b_ary, const unsigned char *  dat, size_t  dat_len )

Append Byte data to OpenSOAPByteArray. Parameters: b_ary  OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray dat  const unsigned char * [in] ((|dat|)) Pointer to head of Append data. If NULL, 0 fill. dat_len  size_t [in] dat_sz Append data size Returns: Error Code

int OpenSOAPByteArrayAppendRef (  OpenSOAPByteArrayPtr  b_ary  )

Use OpenSOAPByteArray Resource declare. Parameters: b_ary  OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray Returns: Error Code

int OpenSOAPByteArrayBegin (  OpenSOAPByteArrayPtr  b_ary, unsigned char **  beg )

Get pointer to head of variable Byte (unsigned char) Array. Parameters: b_ary  OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray beg  unsigned char ** [out] ((|beg|)) Pointer to head of ByteArray Returns: Error Code

int OpenSOAPByteArrayBeginConst (  OpenSOAPByteArrayPtr  b_ary, const unsigned char **  beg )

Get const pointer to head of variable Byte (unsigned char) Array. Parameters: b_ary  OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray beg  const unsigned char ** [out] ((|beg|)) Pointer to head of ByteArray Returns: Error Code

int OpenSOAPByteArrayClear (  OpenSOAPByteArrayPtr  b_ary  )

Clear OpenSOAPByteArray. Parameters: b_ary  OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray Returns: Error Code

int OpenSOAPByteArrayCreate (  OpenSOAPByteArrayPtr *  b_ary  )

Create a variable size Byte(unsigned char) Array. Parameters: b_ary  OpenSOAPByteArrayPtr * [out] ((|b_ary|)) ByteArray Returns: Error Code

int OpenSOAPByteArrayCreateWithData (  const unsigned char *  data, size_t  sz, OpenSOAPByteArrayPtr *  b_ary )

Create OpenSOAPByteArray with initial data. Parameters: data  const unsigned char * [in] ((|data|)) Initial data. If NULL, allocate ((|sz|)) space, and 0 fill. sz  size_t [in] ((|sz|)) Initial data size. b_ary  OpenSOAPByteArrayPtr * [out] ((|b_ary|)) ByteArray Returns: Error Code

int OpenSOAPByteArrayDuplicate (  OpenSOAPByteArrayPtr  b_ary, OpenSOAPByteArrayPtr *  dup_b_ary )

Duplicate OpenSOAPByteArray. Parameters: b_ary  OpenSOAPByteArrayPtr [in] ((|b_ary|)) ByteArray dup_b_ary  OpenSOAPByteArrayPtr * [out] ((|new_size|)) Duplicate ByteArray Returns: Error Code

int OpenSOAPByteArrayEnd (  OpenSOAPByteArrayPtr  b_ary, unsigned char **  ed )

Get pointer to tail of variable Byte (unsigned char) Array. Parameters: b_ary  OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray ed  unsigned char ** [out] ((|ed|)) Pointer to tail of ByteArray Returns: Error Code

int OpenSOAPByteArrayEndConst (  OpenSOAPByteArrayPtr  b_ary, const unsigned char **  ed )

Get const pointer to tail of variable Byte (unsigned char) Array. Parameters: b_ary  OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray ed  const unsigned char ** [out] ((|ed|)) Pointer to tail of ByteArray Returns: Error Code

int OpenSOAPByteArrayGetBeginEnd (  OpenSOAPByteArrayPtr  b_ary, unsigned char **  beg, unsigned char **  ed )

Get pointer to head and tail of variable Byte (unsigned char) Array. Parameters: b_ary  OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray beg  unsigned char ** [out] ((|beg|)) Pointer to head of ByteArray ed  unsigned char ** [out] ((|ed|)) Pointer to tail of ByteArray Returns: Error Code

int OpenSOAPByteArrayGetBeginEndConst (  OpenSOAPByteArrayPtr  b_ary, const unsigned char **  beg, const unsigned char **  ed )

Get const pointer to head and tail of variable Byte (unsigned char) Array. Parameters: b_ary  OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray beg  const unsigned char ** [out] ((|beg|)) Pointer to head of ByteArray ed  const unsigned char ** [out] ((|ed|)) Pointer to tail of ByteArray Returns: Error Code

int OpenSOAPByteArrayGetBeginSize (  OpenSOAPByteArrayPtr  b_ary, unsigned char **  beg, size_t *  sz )

Get pointer to head of variable Byte (unsigned char) Array and size. Parameters: b_ary  OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray beg  unsigned char ** [out] ((|beg|)) Pointer to head of ByteArray sz  size_t * [out] ((|sz|)) size Returns: Error Code

int OpenSOAPByteArrayGetBeginSizeConst (  OpenSOAPByteArrayPtr  b_ary, const unsigned char **  beg, size_t *  sz )

Get const pointer to head of variable Byte (unsigned char) Array and size. Parameters: b_ary  OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray beg  const unsigned char ** [out] ((|beg|)) Pointer to head of ByteArray sz  size_t * [out] ((|sz|)) size Returns: Error Code

int OpenSOAPByteArrayGetSize (  OpenSOAPByteArrayPtr  b_ary, size_t *  sz )

Get size of variable size Byte (unsigned char) Array. Parameters: b_ary  OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray sz  size_t * [out] ((|sz|)) size Returns: Error Code

int OpenSOAPByteArrayRelease (  OpenSOAPByteArrayPtr  b_ary  )

Release OpenSOAPByteArray Resource. Parameters: b_ary  OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray Returns: Error Code

int OpenSOAPByteArrayResize (  OpenSOAPByteArrayPtr  b_ary, size_t  new_size )

Resize OpenSOAPByteArray. Parameters: b_ary  OpenSOAPByteArrayPtr [in, out] ((|b_ary|)) ByteArray new_size  size_t [in] ((|new_size|)) New size. If the new size is greater than the current size, 0 fill the extra area. Returns: Error Code

int OpenSOAPByteArraySetData (  OpenSOAPByteArrayPtr  b_ary, const unsigned char *  data, size_t  sz )

Set data of OpenSOAPByteArray. Parameters: b_ary  OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray data  unsigned char * [in] ((|data|)) data sz  size_t [in] ((|sz|)) data size Returns: Error Code

---