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

Envelope.h の解説

OpenSOAP API Envelope 処理. [詳細]

#include <OpenSOAP/Block.h>
#include <OpenSOAP/ByteArray.h>
#include <OpenSOAP/String.h>
#include <stdlib.h>

ソースコードを見る。

Typedef

typedef tagOpenSOAPEnvelope OpenSOAPEnvelope
 OpenSOAPEnvelope 構造体型定義.

typedef OpenSOAPEnvelope * OpenSOAPEnvelopePtr
 OpenSOAPEnvelope ポインタ定義.


関数

int OpenSOAPEnvelopeCreate (OpenSOAPEnvelopePtr *soap_env)
 OpenSOAP Envelope 作成と初期化.

int OpenSOAPEnvelopeCreateMB (const char *soapVer, const char *envPrefix, OpenSOAPEnvelopePtr *soapEnv)
 OpenSOAP Envelope 作成と初期化(MB).

int OpenSOAPEnvelopeCreateWC (const wchar_t *soapVer, const wchar_t *envPrefix, OpenSOAPEnvelopePtr *soapEnv)
 OpenSOAP Envelope 作成と初期化(WC).

int OpenSOAPEnvelopeCreateString (OpenSOAPStringPtr soapVer, OpenSOAPStringPtr envPrefix, OpenSOAPEnvelopePtr *soapEnv)
 OpenSOAP Envelope instance create(OpenSOAPString).

int OpenSOAPEnvelopeCreateFaultMB (const char *soapVer, const char *envPrefix, const char *faultCode, const char *faultString, OpenSOAPBlockPtr *faultBlock, OpenSOAPEnvelopePtr *soapEnv)
 Create OpenSOAP Fault Block(MB).

int OpenSOAPEnvelopeCreateFaultWC (const wchar_t *soapVer, const wchar_t *envPrefix, const wchar_t *faultCode, const wchar_t *faultString, OpenSOAPBlockPtr *faultBlock, OpenSOAPEnvelopePtr *soapEnv)
 Create OpenSOAP Fault Block(WC).

int OpenSOAPEnvelopeCreateCharEncoding (const char *chEnc, OpenSOAPByteArrayPtr b_ary, OpenSOAPEnvelopePtr *soapEnv)
 Character encoding指定による ByteArrayからの SOAP Envelope 作成.

int OpenSOAPEnvelopeRetain (OpenSOAPEnvelopePtr soapEnv)
 ※未実装※ OpenSOAP Envelope リファレンス追加

int OpenSOAPEnvelopeRelease (OpenSOAPEnvelopePtr soapEnv)
 OpenSOAP Envelope の開放.

int OpenSOAPEnvelopeAddHeaderBlockMB (OpenSOAPEnvelopePtr soapEnv, const char *block_name, OpenSOAPBlockPtr *h_block)
 ヘッダブロックの追加(MB)

int OpenSOAPEnvelopeAddHeaderBlockWC (OpenSOAPEnvelopePtr soapEnv, const wchar_t *block_name, OpenSOAPBlockPtr *h_block)
 ヘッダブロックの追加(WC)

int OpenSOAPEnvelopeGetNextHeaderBlock (OpenSOAPEnvelopePtr soap_env, OpenSOAPBlockPtr *h_block)
 ヘッダブロックの取得

int OpenSOAPEnvelopeGetHeaderBlockMB (OpenSOAPEnvelopePtr soap_env, const char *block_name, OpenSOAPBlockPtr *h_block)
 ヘッダブロックの取得(MB)

int OpenSOAPEnvelopeGetHeaderBlockWC (OpenSOAPEnvelopePtr soap_env, const wchar_t *block_name, OpenSOAPBlockPtr *h_block)
 ヘッダブロックの取得(WC)

int OpenSOAPEnvelopeAddBodyBlockMB (OpenSOAPEnvelopePtr soap_env, const char *block_name, OpenSOAPBlockPtr *b_block)
 ボディブロックの追加(MB)

int OpenSOAPEnvelopeAddBodyBlockWC (OpenSOAPEnvelopePtr soap_env, const wchar_t *block_name, OpenSOAPBlockPtr *b_block)
 ボディブロックの追加(WC)

int OpenSOAPEnvelopeGetNextBodyBlock (OpenSOAPEnvelopePtr soap_env, OpenSOAPBlockPtr *b_block)
 ボディブロックの取得

int OpenSOAPEnvelopeGetBodyBlockMB (OpenSOAPEnvelopePtr soap_env, const char *block_name, OpenSOAPBlockPtr *b_block)
 ボディブロックの取得(MB)

int OpenSOAPEnvelopeGetBodyBlockWC (OpenSOAPEnvelopePtr soap_env, const wchar_t *block_name, OpenSOAPBlockPtr *b_block)
 ボディブロックの取得(WC)

int OpenSOAPEnvelopeGetCharEncodingString (OpenSOAPEnvelopePtr soapEnv, const char *chEnc, OpenSOAPByteArrayPtr b_ary)
 SOAP Envelope Character Encoding Output.

int OpenSOAPEnvelopeGetHeaderCharEncodingString (OpenSOAPEnvelopePtr soap_env, const char *ch_enc, OpenSOAPByteArrayPtr b_ary)
 Soap Header character encoding output.

int OpenSOAPEnvelopeGetBodyCharEncodingString (OpenSOAPEnvelopePtr soap_env, const char *ch_enc, OpenSOAPByteArrayPtr b_ary)
 Soap Body Character Encoding Output.

int OpenSOAPEnvelopeAddFaultString (OpenSOAPEnvelopePtr soapEnv, OpenSOAPStringPtr faultCode, OpenSOAPStringPtr faultString, int isValueDup, OpenSOAPBlockPtr *faultBlock)
 Add Fault String.

int OpenSOAPEnvelopeGetActorNameString (OpenSOAPEnvelopePtr soapEnv, OpenSOAPStringPtr *actorName)
 Get Actor Name String.

int OpenSOAPEnvelopeGetActorNextString (OpenSOAPEnvelopePtr soapEnv, OpenSOAPStringPtr *actorNext)
 Get Actor Next String.

解説

OpenSOAP API Envelope 処理.

作者:
OpenSOAP Development Team

関数の解説

int OpenSOAPEnvelopeAddBodyBlockMB (  OpenSOAPEnvelopePtr  soap_env,
const char *  block_name,
OpenSOAPBlockPtr *  b_block
) 
 

ボディブロックの追加(MB)

OpenSOAP Envelope 領域にマルチバイト文字列で名前を指定した Body Block を追加します。

引数:
soap_env OpenSOAPEnvelopePtr [out] ((|soap_env|)) OpenSOAP Envelope
block_name const char * [in] ((|block_name|)) SOAP Block Name. NULLの場合、Body Elementだけ追加。
b_block OpenSOAPBlockPtr * [out] ((|b_block|)) OpenSOAP Body Block
戻り値:
エラーコード

int OpenSOAPEnvelopeAddBodyBlockWC (  OpenSOAPEnvelopePtr  soap_env,
const wchar_t *  block_name,
OpenSOAPBlockPtr *  b_block
) 
 

ボディブロックの追加(WC)

SOAP Envelope 領域にワイドキャラクタ文字列で名前を指定した Body Block を追加します。

引数:
soap_env OpenSOAPEnvelopePtr [out] ((|soap_env|)) OpenSOAP Envelope
block_name const wchar_t * [in] ((|block_name|)) SOAP Block Name
b_block OpenSOAPBlockPtr * [out] ((|b_block|)) OpenSOAP Body Block
戻り値:
エラーコード

int OpenSOAPEnvelopeAddFaultString (  OpenSOAPEnvelopePtr  soapEnv,
OpenSOAPStringPtr  faultCode,
OpenSOAPStringPtr  faultString,
int  isValueDup,
OpenSOAPBlockPtr *  faultBlock
) 
 

Add Fault String.

引数:
soapEnv OpenSOAPEnvelopePtr [out] ((|soapEnv|)) OpenSOAP Envelope Pointer
faultCode OpenSOAPStringPtr [in] ((|faultCode|)) SOAP Fault's faultcode
faultString OpenSOAPStringPtr [in] ((|faultString|)) SOAP Fault's faultstring
isValueDup int [in] ((|isValueDup|)) faultCode and faultString duplicate flag
faultBlock OpenSOAPBlockPtr * [out] ((|faultBlock|)) Storage Buffer of OpenSOAP Fault Block
戻り値:
エラーコード

int OpenSOAPEnvelopeAddHeaderBlockMB (  OpenSOAPEnvelopePtr  soapEnv,
const char *  block_name,
OpenSOAPBlockPtr *  h_block
) 
 

ヘッダブロックの追加(MB)

OpenSOAP Envelope 領域にマルチバイト文字列で名前を指定した

引数:
soapEnv OpenSOAPEnvelopePtr [out] ((|soap_env|)) OpenSOAP Envelope
block_name const char * [in] ((|block_name|)) SOAP Block Name
h_block OpenSOAPBlockPtr * [out] ((|h_block|)) OpenSOAP Header Block
戻り値:
エラーコード

int OpenSOAPEnvelopeAddHeaderBlockWC (  OpenSOAPEnvelopePtr  soapEnv,
const wchar_t *  block_name,
OpenSOAPBlockPtr *  h_block
) 
 

ヘッダブロックの追加(WC)

OpenSOAP Envelope領域にワイドキャラクタ文字列で名前を指定した

引数:
soapEnv OpenSOAPEnvelopePtr [out] ((|soap_env|)) OpenSOAP Envelope
block_name const wchar_t * [in] ((|block_name|)) SOAP Block Name
h_block OpenSOAPBlockPtr * [out] ((|h_block|)) OpenSOAP Header Block
戻り値:
エラーコード

int OpenSOAPEnvelopeCreate (  OpenSOAPEnvelopePtr *  soap_env  ) 
 

OpenSOAP Envelope 作成と初期化.

OpenSOAP Envelope 領域の確保と構造体の初期化を行います。

引数:
soap_env OpenSOAPEnvelopePtr * [out] ((|soap_env|)) OpenSOAP Envelope バッファポインタ
戻り値:
エラーコード

int OpenSOAPEnvelopeCreateCharEncoding (  const char *  chEnc,
OpenSOAPByteArrayPtr  b_ary,
OpenSOAPEnvelopePtr *  soapEnv
) 
 

Character encoding指定による ByteArrayからの SOAP Envelope 作成.

b_aryの内容をch_enc(EUC-JP/Shift_JIS/UTF-8...)にエンコーディングする。soap_env内に各々パラメータをb_aryより設定します。

引数:
chEnc const char * [in] ((|chEnc|)) character encoding
b_ary OpenSOAPByteArrayPtr [in] ((|b_ary|)) OpenSOAP ByteArray
soapEnv OpenSOAPEnvelopePtr * [out] ((|soapEnv|)) OpenSOAP Envelope バッファポインタ
戻り値:
エラーコード
覚え書き:
b_aryの内容をchEnc(EUC-JP/Shift_JIS/UTF-8...)にエンコーディングする。soapEnv内に各々パラメータをb_aryより設定する。

int OpenSOAPEnvelopeCreateFaultMB (  const char *  soapVer,
const char *  envPrefix,
const char *  faultCode,
const char *  faultString,
OpenSOAPBlockPtr *  faultBlock,
OpenSOAPEnvelopePtr *  soapEnv
) 
 

Create OpenSOAP Fault Block(MB).

引数:
soapVer const char * [in] ((||soapVer|)) SOAP Version
envPrefix const char * [in] ((|envPrefix|)) SOAP Envelope namespace prefix
faultCode const char * [in] ((|faultCode|)) SOAP Fault's faultcode
faultString const char * [in] ((|faultString|)) SOAP Fault's faultstring
faultBlock OpenSOAPBlockPtr * [out] ((|faultBlock|)) OpenSOAP Fault Block バッファポインタ
soapEnv OpenSOAPEnvelopePtr * [out] ((|soapEnv|)) OpenSOAP Envelope バッファポインタ
戻り値:
エラーコード

int OpenSOAPEnvelopeCreateFaultWC (  const wchar_t *  soapVer,
const wchar_t *  envPrefix,
const wchar_t *  faultCode,
const wchar_t *  faultString,
OpenSOAPBlockPtr *  faultBlock,
OpenSOAPEnvelopePtr *  soapEnv
) 
 

Create OpenSOAP Fault Block(WC).

引数:
soapVer const wchar_t * [in] ((||soapVer|)) SOAP Version
envPrefix const wchar_t * [in] ((|envPrefix|)) SOAP Envelope namespace prefix
faultCode const wchar_t * [in] ((|faultCode|)) SOAP Fault's faultcode
faultString const wchar_t * [in] ((|faultString|)) SOAP Fault's faultstring
faultBlock OpenSOAPBlockPtr * [out] ((|faultBlock|)) OpenSOAP Fault Block バッファポインタ
soapEnv OpenSOAPEnvelopePtr * [out] ((|soapEnv|)) OpenSOAP Envelope バッファポインタ
戻り値:
エラーコード

int OpenSOAPEnvelopeCreateMB (  const char *  soapVer,
const char *  envPrefix,
OpenSOAPEnvelopePtr *  soapEnv
) 
 

OpenSOAP Envelope 作成と初期化(MB).

OpenSOAP Envelope 作成領域の確保を行い、SOAP Versionによって各々定数の代入を行います。

引数:
soapVer const char * [in] ((||soapVer|)) SOAP Version
envPrefix const char * [in] ((|envPrefix|)) SOAP Envelope namespace prefix
soapEnv OpenSOAPEnvelopePtr * [out] ((|soapEnv|)) OpenSOAP Envelope バッファポインタ
戻り値:
エラーコード
覚え書き:
soapVer "1.1" or "1.2"。NULL の場合は "1.1" と同等。

envPrefix NULL 以外の場合は内容に従う。NULL の場合はsoapVerにより以下に従う。
"1.1" SOAP-ENV
"1.2" env

int OpenSOAPEnvelopeCreateString (  OpenSOAPStringPtr  soapVer,
OpenSOAPStringPtr  envPrefix,
OpenSOAPEnvelopePtr *  soapEnv
) 
 

OpenSOAP Envelope instance create(OpenSOAPString).

引数:
soapVer OpenSOAPStringPtr [in] ((||soapVer|)) SOAP Version
envPrefix OpenSOAPStringPtr [in] ((|envPrefix|)) SOAP Envelope namespace prefix
soapEnv OpenSOAPEnvelopePtr * [out] ((|soapEnv|)) OpenSOAP Envelope バッファポインタ
戻り値:
エラーコード

int OpenSOAPEnvelopeCreateWC (  const wchar_t *  soapVer,
const wchar_t *  envPrefix,
OpenSOAPEnvelopePtr *  soapEnv
) 
 

OpenSOAP Envelope 作成と初期化(WC).

OpenSOAP Envelope 作成領域の確保を行い、SOAP Versionによって各々定数の代入を行います。

引数:
soapVer const char * [in] ((||soapVer|)) SOAP Version
envPrefix const char * [in] ((|envPrefix|)) SOAP Envelope namespace prefix
soapEnv OpenSOAPEnvelopePtr * [out] ((|soapEnv|)) OpenSOAP Envelope バッファポインタ
戻り値:
エラーコード
覚え書き:
soapVer "1.1" or "1.2"。NULL の場合は "1.1" と同等。

envPrefix NULL 以外の場合は内容に従う。NULL の場合はsoapVerにより以下に従う。
"1.1" SOAP-ENV
"1.2" env

int OpenSOAPEnvelopeGetActorNameString (  OpenSOAPEnvelopePtr  soapEnv,
OpenSOAPStringPtr *  actorName
) 
 

Get Actor Name String.

引数:
soapEnv OpenSOAPEnvelopePtr [in] ((|soapEnv|)) OpenSOAP Envelope Pointer
actorName OpenSOAPStringPtr * [out] ((|actorName|)) Actor Name
戻り値:
エラーコード

int OpenSOAPEnvelopeGetActorNextString (  OpenSOAPEnvelopePtr  soapEnv,
OpenSOAPStringPtr *  actorNext
) 
 

Get Actor Next String.

引数:
soapEnv OpenSOAPEnvelopePtr [in] ((|soapEnv|)) OpenSOAP Envelope Pointer
actorNext OpenSOAPStringPtr * [out] ((|actorNext|)) Actor Next
戻り値:
エラーコード

int OpenSOAPEnvelopeGetBodyBlockMB (  OpenSOAPEnvelopePtr  soap_env,
const char *  block_name,
OpenSOAPBlockPtr *  b_block
) 
 

ボディブロックの取得(MB)

名前をマルチバイト文字列で指定して、ボディブロックを取得します。block_nameを検索b_blockを戻す。

引数:
soap_env OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope
block_name const char * [in] ((|block_name|)) SOAP Body Block name
b_block OpenSOAPBlockPtr * [out] ((|b_block|)) Body Block return buffer
戻り値:
エラーコード

int OpenSOAPEnvelopeGetBodyBlockWC (  OpenSOAPEnvelopePtr  soap_env,
const wchar_t *  block_name,
OpenSOAPBlockPtr *  b_block
) 
 

ボディブロックの取得(WC)

名前をワイドキャラクタ文字列で指定して、ボディブロックを取得します。block_nameを検索b_blockを戻す。

引数:
soap_env OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope
block_name const wchar_t * [in] ((|block_name|)) SOAP Body Block name
b_block OpenSOAPBlockPtr * [out] ((|b_block|)) Body Block return buffer
戻り値:
エラーコード

int OpenSOAPEnvelopeGetBodyCharEncodingString (  OpenSOAPEnvelopePtr  soap_env,
const char *  ch_enc,
OpenSOAPByteArrayPtr  b_ary
) 
 

Soap Body Character Encoding Output.

引数:
soap_env OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope
ch_enc const char * [in] ((|ch_enc|)) character encoding. (i.e. "EUC-JP", "Shift_JIS", "UTF-8")
b_ary OpenSOAPByteArrayPtr [out] ((|b_ary|)) Result Buffer
戻り値:
エラーコード

int OpenSOAPEnvelopeGetCharEncodingString (  OpenSOAPEnvelopePtr  soapEnv,
const char *  chEnc,
OpenSOAPByteArrayPtr  b_ary
) 
 

SOAP Envelope Character Encoding Output.

soap_envよりSOAP Messageを組み立てます。

引数:
soapEnv OpenSOAPEnvelopePtr [in] ((|soapEnv|)) OpenSOAP Envelope
chEnc const char * [in] ((|chEnc|)) character encoding. (i.e. "EUC-JP", "Shift_JIS", "UTF-8")
b_ary OpenSOAPByteArrayPtr [out] ((|bAry|)) Storage Buffer
戻り値:
エラーコード

int OpenSOAPEnvelopeGetHeaderBlockMB (  OpenSOAPEnvelopePtr  soap_env,
const char *  block_name,
OpenSOAPBlockPtr *  h_block
) 
 

ヘッダブロックの取得(MB)

名前をマルチバイト文字列で指定して、ヘッダブロックを取得します。

引数:
soap_env OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope
block_name const char * [in] ((|block_name|)) SOAP Header Block name
h_block OpenSOAPBlockPtr * [out] ((|h_block|)) Header Block return buffer
戻り値:
エラーコード

int OpenSOAPEnvelopeGetHeaderBlockWC (  OpenSOAPEnvelopePtr  soap_env,
const wchar_t *  block_name,
OpenSOAPBlockPtr *  h_block
) 
 

ヘッダブロックの取得(WC)

名前をワイドキャラクタ文字列で指定して、ヘッダブロックを取得します。

引数:
soap_env OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope
block_name const wchar_t * [in] ((|block_name|)) SOAP Header Block name
h_block OpenSOAPBlockPtr * [out] ((|h_block|)) Header Block return buffer
戻り値:
エラーコード

int OpenSOAPEnvelopeGetHeaderCharEncodingString (  OpenSOAPEnvelopePtr  soap_env,
const char *  ch_enc,
OpenSOAPByteArrayPtr  b_ary
) 
 

Soap Header character encoding output.

引数:
soap_env OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope
ch_enc const char * [in] ((|ch_enc|)) character encoding. (i.e. "EUC-JP", "Shift_JIS", "UTF-8")
b_ary OpenSOAPByteArrayPtr [out] ((|b_ary|)) Result Buffer
戻り値:
エラーコード

int OpenSOAPEnvelopeGetNextBodyBlock (  OpenSOAPEnvelopePtr  soap_env,
OpenSOAPBlockPtr *  b_block
) 
 

ボディブロックの取得

最後のボディブロックポインタを入力した場合は、最初のボディブロックが取得されます。

引数:
soap_env OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope
b_block OpenSOAPBlockPtr * [in, out] ((|b_block|)) OpenSOAP Body Block. NULLの場合、最初のボディブロックが取得されます。
戻り値:
エラーコード

int OpenSOAPEnvelopeGetNextHeaderBlock (  OpenSOAPEnvelopePtr  soap_env,
OpenSOAPBlockPtr *  h_block
) 
 

ヘッダブロックの取得

次のヘッダブロックへのポインタを取得します。最後のヘッダブロックポインタを入力した場合は、最初のヘッダブロックが取得されます。

引数:
soap_env OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope
h_block OpenSOAPBlockPtr * [in, out] ((|h_block|)) OpenSOAP Header Block.
戻り値:
エラーコード

int OpenSOAPEnvelopeRelease (  OpenSOAPEnvelopePtr  soapEnv  ) 
 

OpenSOAP Envelope の開放.

OpenSOAP Envelope作成領域の開放を行います。

引数:
soapEnv OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope
戻り値:
エラーコード

int OpenSOAPEnvelopeRetain (  OpenSOAPEnvelopePtr  soapEnv  ) 
 

※未実装※ OpenSOAP Envelope リファレンス追加

OpenSOAP Envelope への参照を保持します。

引数:
soapEnv OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope
戻り値:
エラーコード (未実装エラーOPENSOAP_YET_IMPLEMENTATION)

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