メインページ | ファイル一覧 | ファイルメンバ

ByteArray.h の解説

OpenSOAP API ByteArray 処理. [詳細]

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

ソースコードを見る。

マクロ定義

#define OpenSOAPByteArrayCreateWithSize(sz, b_ary)   OpenSOAPByteArrayCreateWithData(0, (sz), (b_ary))
 Byte (unsigned char)指定サイズ分0クリアします。.


Typedef

typedef tagOpenSOAPByteArray OpenSOAPByteArray
 OpenSOAPByteArray 構造体型定義.

typedef OpenSOAPByteArray * OpenSOAPByteArrayPtr
 OpenSOAPByteArray ポインタ型定義.


関数

int OpenSOAPByteArrayCreate (OpenSOAPByteArrayPtr *b_ary)
 Byte (unsigned char)可変サイズ配列を作成します。.

int OpenSOAPByteArrayCreateWithData (const unsigned char *data, size_t sz, OpenSOAPByteArrayPtr *b_ary)
 初期化データを指定して、Byte (unsigned char)可変サイズ配列を作成します。

int OpenSOAPByteArrayAppendRef (OpenSOAPByteArrayPtr b_ary)
 Byte (unsigned char)可変サイズ配列の利用を宣言します。.

int OpenSOAPByteArrayRelease (OpenSOAPByteArrayPtr b_ary)
 Byte (unsigned char)可変サイズ配列を開放します。.

int OpenSOAPByteArrayGetSize (OpenSOAPByteArrayPtr b_ary, size_t *sz)
 Byte (unsigned char)可変サイズ配列のサイズを取得します。.

int OpenSOAPByteArrayBeginConst (OpenSOAPByteArrayPtr b_ary, const unsigned char **beg)
 Byte (unsigned char)可変サイズ配列の先頭の const ポインタを取得します。.

int OpenSOAPByteArrayEndConst (OpenSOAPByteArrayPtr b_ary, const unsigned char **ed)
 Byte (unsigned char)可変サイズ配列の終端の const ポインタを取得します。.

int OpenSOAPByteArrayGetBeginSizeConst (OpenSOAPByteArrayPtr b_ary, const unsigned char **beg, size_t *sz)
 Byte (unsigned char)可変サイズ配列の先頭の const ポインタとサイズを取得します。.

int OpenSOAPByteArrayGetBeginEndConst (OpenSOAPByteArrayPtr b_ary, const unsigned char **beg, const unsigned char **ed)
 Byte (unsigned char)可変サイズ配列の先頭と終端の const ポインタを取得します。.

int OpenSOAPByteArrayBegin (OpenSOAPByteArrayPtr b_ary, unsigned char **beg)
 Byte (unsigned char)可変サイズ配列の先頭の 非const ポインタを取得します。.

int OpenSOAPByteArrayEnd (OpenSOAPByteArrayPtr b_ary, unsigned char **ed)
 Byte (unsigned char)可変サイズ配列の終端の 非const ポインタを取得します。.

int OpenSOAPByteArrayGetBeginSize (OpenSOAPByteArrayPtr b_ary, unsigned char **beg, size_t *sz)
 Byte (unsigned char)可変サイズ配列の先頭の const ポインタとサイズを取得します。.

int OpenSOAPByteArrayGetBeginEnd (OpenSOAPByteArrayPtr b_ary, unsigned char **beg, unsigned char **ed)
 Byte (unsigned char)可変サイズ配列の先頭と終端の const ポインタを取得します。.

int OpenSOAPByteArrayClear (OpenSOAPByteArrayPtr b_ary)
 Byte (unsigned char)可変サイズ配列をクリアします。.

int OpenSOAPByteArraySetData (OpenSOAPByteArrayPtr b_ary, const unsigned char *data, size_t sz)
 Byte (unsigned char)可変サイズ配列へデータを設定します。.

int OpenSOAPByteArrayAppend (OpenSOAPByteArrayPtr b_ary, const unsigned char *dat, size_t dat_len)
 Byte (unsigned char)可変サイズ配列へデータを追加します。.

int OpenSOAPByteArrayResize (OpenSOAPByteArrayPtr b_ary, size_t new_size)
 Byte (unsigned char)可変サイズ配列のサイズを変更します。.

int OpenSOAPByteArrayDuplicate (OpenSOAPByteArrayPtr b_ary, OpenSOAPByteArrayPtr *dup_b_ary)
 ByteArray を複製します。.

解説

OpenSOAP API ByteArray 処理.

作者:
OpenSOAP Development Team

マクロ定義の解説

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

Byte (unsigned char)指定サイズ分0クリアします。.

OpenSOAPByteArrayCreateWithData(0, (sz), (b_ary))

引数:
sz size_t [in] ((|sz|)) 初期化データサイズ
b_ary OpenSOAPByteArrayPtr * [out] ((|b_ary|)) ByteArrayポインタ

関数の解説

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

Byte (unsigned char)可変サイズ配列へデータを追加します。.

引数:
b_ary OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray
dat const unsigned char * [in] ((|dat|)) 追加するデータへの先頭ポインタ。NULL の場合は、0 で埋める。
dat_len size_t [in] dat_sz 追加するデータのサイズ
戻り値:
エラーコード

int OpenSOAPByteArrayAppendRef (  OpenSOAPByteArrayPtr  b_ary  ) 
 

Byte (unsigned char)可変サイズ配列の利用を宣言します。.

引数:
b_ary OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArrayポインタ
戻り値:
エラーコード

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

Byte (unsigned char)可変サイズ配列の先頭の 非const ポインタを取得します。.

引数:
b_ary OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray
beg unsigned char ** [out] ((|beg|)) 先頭ポインタ格納変数へのポインタ。
戻り値:
エラーコード

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

Byte (unsigned char)可変サイズ配列の先頭の const ポインタを取得します。.

引数:
b_ary OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray
beg const unsigned char ** [out] ((|beg|)) 先頭ポインタ格納変数へのポインタ。
戻り値:
エラーコード

int OpenSOAPByteArrayClear (  OpenSOAPByteArrayPtr  b_ary  ) 
 

Byte (unsigned char)可変サイズ配列をクリアします。.

引数:
b_ary OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray
戻り値:
エラーコード

int OpenSOAPByteArrayCreate (  OpenSOAPByteArrayPtr *  b_ary  ) 
 

Byte (unsigned char)可変サイズ配列を作成します。.

引数:
b_ary OpenSOAPByteArrayPtr * [out] ((|b_ary|)) ByteArrayポインタ
戻り値:
エラーコード

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

初期化データを指定して、Byte (unsigned char)可変サイズ配列を作成します。

引数:
data const unsigned char * [in] ((|data|)) 初期化データ。この値が NULL の場合、 ((|sz|)) 分データを確保して、0 fill する。
sz size_t [in] ((|sz|)) 初期化データサイズ
b_ary OpenSOAPByteArrayPtr * [out] ((|b_ary|)) ByteArrayポインタ
戻り値:
エラーコード

int OpenSOAPByteArrayDuplicate (  OpenSOAPByteArrayPtr  b_ary,
OpenSOAPByteArrayPtr *  dup_b_ary
) 
 

ByteArray を複製します。.

引数:
b_ary OpenSOAPByteArrayPtr [in] ((|b_ary|)) ByteArray
dup_b_ary OpenSOAPByteArrayPtr * [out] ((|new_size|)) 複製先 ByteArray
戻り値:
エラーコード

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

Byte (unsigned char)可変サイズ配列の終端の 非const ポインタを取得します。.

引数:
b_ary OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray
ed unsigned char ** [out] ((|ed|)) 終端ポインタ格納変数へのポインタ。
戻り値:
エラーコード

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

Byte (unsigned char)可変サイズ配列の終端の const ポインタを取得します。.

引数:
b_ary OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray
ed const unsigned char ** [out] ((|ed|)) 終端ポインタ格納変数へのポインタ。
戻り値:
エラーコード

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

Byte (unsigned char)可変サイズ配列の先頭と終端の const ポインタを取得します。.

引数:
b_ary OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray
beg unsigned char ** [out] ((|beg|)) 先頭ポインタ格納変数へのポインタ。
ed unsigned char ** [out] ((|ed|)) 終端ポインタ格納変数へのポインタ。
戻り値:
エラーコード

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

Byte (unsigned char)可変サイズ配列の先頭と終端の const ポインタを取得します。.

引数:
b_ary OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray
beg const unsigned char ** [out] ((|beg|)) 先頭ポインタ格納変数へのポインタ。
ed const unsigned char ** [out] ((|ed|)) 終端ポインタ格納変数へのポインタ。
戻り値:
エラーコード

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

Byte (unsigned char)可変サイズ配列の先頭の const ポインタとサイズを取得します。.

引数:
b_ary OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray
beg unsigned char ** [out] ((|beg|)) 先頭ポインタ格納変数へのポインタ。
sz size_t * [out] ((|sz|)) サイズ格納変数へのポインタ。
戻り値:
エラーコード

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

Byte (unsigned char)可変サイズ配列の先頭の const ポインタとサイズを取得します。.

引数:
b_ary OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray
beg const unsigned char ** [out] ((|beg|)) 先頭ポインタ格納変数へのポインタ。
sz size_t * [out] ((|sz|)) サイズ格納変数へのポインタ。
戻り値:
エラーコード

int OpenSOAPByteArrayGetSize (  OpenSOAPByteArrayPtr  b_ary,
size_t *  sz
) 
 

Byte (unsigned char)可変サイズ配列のサイズを取得します。.

引数:
b_ary OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArrayポインタ
sz size_t * [out] ((|sz|)) サイズ格納変数へのポインタ。
戻り値:
エラーコード

int OpenSOAPByteArrayRelease (  OpenSOAPByteArrayPtr  b_ary  ) 
 

Byte (unsigned char)可変サイズ配列を開放します。.

引数:
b_ary OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArrayポインタ
戻り値:
エラーコード

int OpenSOAPByteArrayResize (  OpenSOAPByteArrayPtr  b_ary,
size_t  new_size
) 
 

Byte (unsigned char)可変サイズ配列のサイズを変更します。.

引数:
b_ary OpenSOAPByteArrayPtr [in, out] ((|b_ary|)) ByteArray
new_size size_t [in] ((|new_size|)) 新しいサイズ。現在のサイズより大きな値を指定した場合、大きくなった部分は 0 fill される。
戻り値:
エラーコード

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

Byte (unsigned char)可変サイズ配列へデータを設定します。.

引数:
b_ary OpenSOAPByteArrayPtr * [in] ((|b_ary|)) ByteArray
data unsigned char * [in] ((|data|)) 格納するデータ
sz size_t [in] ((|sz|)) データサイズ
戻り値:
エラーコード

OpenSOAPに対してMon Dec 1 19:55:01 2003に生成されました。 doxygen 1.3.3