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

Block.h の解説

OpenSOAP API SOAPブロック処理. [詳細]

#include <OpenSOAP/XMLElm.h>
#include <OpenSOAP/XMLNamespace.h>

ソースコードを見る。

Typedef

typedef tagOpenSOAPBlock OpenSOAPBlock
 OpenSOAPBlock 構造体型定義.

typedef OpenSOAPBlock * OpenSOAPBlockPtr
 OpenSOAPBlock ポインタ型定義.


関数

int OpenSOAPBlockGetValueMB (OpenSOAPBlockPtr soap_block, const char *type_name, void *value)
 Body/Header Block直下の値を取得します。(MB).

int OpenSOAPBlockGetValueWC (OpenSOAPBlockPtr soap_block, const wchar_t *type_name, void *value)
 Body/Header Block直下の値を取得します。(WC).

int OpenSOAPBlockSetValueMB (OpenSOAPBlockPtr soap_block, const char *type_name, void *value)
 SOAP Blockへの値の設定を行います。(MB).

int OpenSOAPBlockSetValueWC (OpenSOAPBlockPtr soap_block, const wchar_t *type_name, void *value)
 SOAP Blockへの値の設定を行います。(WC).

int OpenSOAPBlockSetNamespaceMB (OpenSOAPBlockPtr soap_block, const char *ns_uri, const char *ns_prefix)
 マルチバイト文字列でSOAP Block に Namespaceを設定します。

int OpenSOAPBlockSetNamespaceWC (OpenSOAPBlockPtr soap_block, const wchar_t *ns_uri, const wchar_t *ns_prefix)
 ワイドキャラクタ文字列でSOAP Block に Namespaceを設定します。

int OpenSOAPBlockGetNamespace (OpenSOAPBlockPtr soap_block, OpenSOAPXMLNamespacePtr *ns)
 NamespaceポインタにSOAP BlockのNamespaceを格納します。.

int OpenSOAPBlockIsSameNamespaceMB (OpenSOAPBlockPtr soap_block, const char *ns_uri, int *is_same_uri)
 マルチバイト文字列でNamespaceのURIを比較判定します。

int OpenSOAPBlockIsSameNamespaceWC (OpenSOAPBlockPtr soap_block, const wchar_t *ns_uri, int *is_same_uri)
 ワイドキャラクタ文字列でNamespaceのURIを比較判定します。

int OpenSOAPBlockAddAttributeMB (OpenSOAPBlockPtr soap_block, const char *attr_name, const char *attr_type, void *attr_value, OpenSOAPXMLAttrPtr *attr)
 属性名と値を指定してSOAP Blockに追加します。(MB)

int OpenSOAPBlockAddAttributeWC (OpenSOAPBlockPtr soap_block, const wchar_t *attr_name, const wchar_t *attr_type, void *attr_value, OpenSOAPXMLAttrPtr *attr)
 属性名と値を指定してSOAP Blockに追加します。(WC)

int OpenSOAPBlockGetAttributeMB (OpenSOAPBlockPtr soap_block, const char *attr_name, OpenSOAPXMLAttrPtr *attr)
 指定した属性名(MB)の属性ポインタを返します。ない場合はNULLが格納されます。

int OpenSOAPBlockGetAttributeWC (OpenSOAPBlockPtr soap_block, const wchar_t *attr_name, OpenSOAPXMLAttrPtr *attr)
 指定した属性名(WC)の属性ポインタを返します。ない場合はNULLが格納されます。

int OpenSOAPBlockGetChildValueMB (OpenSOAPBlockPtr soap_block, const char *p_name, const char *type_name, void *value)
 指定した要素名(MB)のXML要素の値を取得します。

int OpenSOAPBlockGetChildValueWC (OpenSOAPBlockPtr soap_block, const wchar_t *p_name, const wchar_t *type_name, void *value)
 指定した要素名(WCのXML要素の値を取得します。

int OpenSOAPBlockSetChildValueMB (OpenSOAPBlockPtr soap_block, const char *p_name, const char *type_name, void *value)
 子要素と子要素の値を設定します。(MB)

int OpenSOAPBlockSetChildValueWC (OpenSOAPBlockPtr soap_block, const wchar_t *p_name, const wchar_t *type_name, void *value)
 子要素と子要素の値を設定します。(WC)

int OpenSOAPBlockGetNextChild (OpenSOAPBlockPtr soap_block, OpenSOAPXMLElmPtr *xml_elm)
 Block直下の次の子要素を格納します。.

int OpenSOAPBlockAddChildMB (OpenSOAPBlockPtr soap_block, const char *elm_name, OpenSOAPXMLElmPtr *xml_elm)
 XML Elementポインタで指される子要素を追加します。(MB).

int OpenSOAPBlockAddChildWC (OpenSOAPBlockPtr soap_block, const wchar_t *elm_name, OpenSOAPXMLElmPtr *xml_elm)
 XML Elementポインタで指される子要素を追加します。(WC).

int OpenSOAPBlockGetChildMB (OpenSOAPBlockPtr soap_block, const char *elm_name, OpenSOAPXMLElmPtr *xml_elm)
 名前(MB)に合致した子 XML Element を取得します。合致するものが複数ある場合は、最初の要素を取り出します。

int OpenSOAPBlockGetChildWC (OpenSOAPBlockPtr soap_block, const wchar_t *elm_name, OpenSOAPXMLElmPtr *xml_elm)
 名前(WC)に合致した子 XML Element を取得します。合致するものが複数ある場合は、最初の要素を取り出します。

int OpenSOAPBlockGetMustunderstandAttr (OpenSOAPBlockPtr soap_block, int *must_std)
 Mustunderstand属性を取得します。.

int OpenSOAPBlockSetMustunderstandAttr (OpenSOAPBlockPtr soap_block)
 Mustunderstand属性を設定します。.

int OpenSOAPBlockClearMustunderstandAttr (OpenSOAPBlockPtr soap_block)
 Mustunderstand属性を消去します。.

int OpenSOAPBlockGetActorAttr (OpenSOAPBlockPtr soap_block, OpenSOAPStringPtr *actor_url)
 Actor属性を取得します。.

int OpenSOAPBlockSetActorAttrMB (OpenSOAPBlockPtr soap_block, const char *actor_url)
 Actor属性を設定します。(MB).

int OpenSOAPBlockSetActorAttrWC (OpenSOAPBlockPtr soap_block, const wchar_t *actor_url)
 Actor属性を設定します。(WC).

int OpenSOAPBlockClearActorAttr (OpenSOAPBlockPtr soap_block)
 Actor属性を消去します。.

int OpenSOAPBlockSetActorAttrNext (OpenSOAPBlockPtr soap_block)
 Actor属性に，URI "http://schemas.xmlsoap.org/soap/actor/next"をセットします。.

int OpenSOAPBlockIsActorAttrNext (OpenSOAPBlockPtr soap_block, int *is_actor_next)
 Actor属性が，URI "http://schemas.xmlsoap.org/soap/actor/next"であるかを判定します。.

int OpenSOAPBlockGetName (OpenSOAPBlockPtr block, OpenSOAPStringPtr *name)
 SOAP Blockの名前を取得します。.

int OpenSOAPBlockGetCharEncodingString (OpenSOAPBlockPtr soap_block, const char *ch_enc, OpenSOAPByteArrayPtr b_ary)
 指定したエンコーディングでSOAPBlockをByteArrayに書き出す

解説

OpenSOAP API SOAPブロック処理.

作者:
OpenSOAP Development Team

関数の解説

int OpenSOAPBlockAddAttributeMB (  OpenSOAPBlockPtr  soap_block,
const char *  attr_name,
const char *  attr_type,
void *  attr_value,
OpenSOAPXMLAttrPtr *  attr
) 
 

属性名と値を指定してSOAP Blockに追加します。(MB)

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|))
attr_name const char * [in] ((|attr_name|)) Attribute Name
attr_type const char * [in] ((|attr_type|)) Attribute Type
attr_value void * [in] ((|attr_value|)) Attribute Value
attr OpenSOAPXMLAttrPtr * [out] ((|attr|)) OpenSOAP XML Attribute
戻り値:
エラーコード

int OpenSOAPBlockAddAttributeWC (  OpenSOAPBlockPtr  soap_block,
const wchar_t *  attr_name,
const wchar_t *  attr_type,
void *  attr_value,
OpenSOAPXMLAttrPtr *  attr
) 
 

属性名と値を指定してSOAP Blockに追加します。(WC)

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
attr_name const wchar_t * [in] ((|attr_name|)) Attribute Name
attr_type const wchar_t * [in] ((|attr_type|)) Attribute Type
attr_value void * [in] ((|attr_value|)) Attribute Value
attr OpenSOAPXMLAttrPtr * [out] ((|attr|)) OpenSOAP XML Attribute
戻り値:
エラーコード

int OpenSOAPBlockAddChildMB (  OpenSOAPBlockPtr  soap_block,
const char *  elm_name,
OpenSOAPXMLElmPtr *  xml_elm
) 
 

XML Elementポインタで指される子要素を追加します。(MB).

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
elm_name const char * [in] ((|elm_name|)) Child XML Element Name
xml_elm OpenSOAPXMLElmPtr * [out] ((|xml_elm|)) OpenSOAP XML Element
戻り値:
エラーコード

int OpenSOAPBlockAddChildWC (  OpenSOAPBlockPtr  soap_block,
const wchar_t *  elm_name,
OpenSOAPXMLElmPtr *  xml_elm
) 
 

XML Elementポインタで指される子要素を追加します。(WC).

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
elm_name const wchar_t * [in] ((|elm_name|)) Child XML Element Name
xml_elm OpenSOAPXMLElmPtr * [out] ((|xml_elm|)) OpenSOAP XML Element
戻り値:
エラーコード

int OpenSOAPBlockClearActorAttr (  OpenSOAPBlockPtr  soap_block  ) 
 

Actor属性を消去します。.

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
戻り値:
エラーコード

int OpenSOAPBlockClearMustunderstandAttr (  OpenSOAPBlockPtr  soap_block  ) 
 

Mustunderstand属性を消去します。.

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
戻り値:
エラーコード

int OpenSOAPBlockGetActorAttr (  OpenSOAPBlockPtr  soap_block,
OpenSOAPStringPtr *  actor_url
) 
 

Actor属性を取得します。.

引数:
soap_block OpenSOAPBlockPtr [in] ((|soapBlock|)) SOAP Block
actor_url OpenSOAPStringPtr * [out] ((|actorUri|)) actor attribute value
戻り値:
エラーコード

int OpenSOAPBlockGetAttributeMB (  OpenSOAPBlockPtr  soap_block,
const char *  attr_name,
OpenSOAPXMLAttrPtr *  attr
) 
 

指定した属性名(MB)の属性ポインタを返します。ない場合はNULLが格納されます。

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
attr_name const char * [in] ((|attr_name|)) Attribute Name
attr OpenSOAPXMLAttrPtr * [out] ((|attr|)) OpenSOAP XML Attribute
戻り値:
エラーコード

int OpenSOAPBlockGetAttributeWC (  OpenSOAPBlockPtr  soap_block,
const wchar_t *  attr_name,
OpenSOAPXMLAttrPtr *  attr
) 
 

指定した属性名(WC)の属性ポインタを返します。ない場合はNULLが格納されます。

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
attr_name const wchar_t * [in] ((|attr_name|)) Attribute Name
attr OpenSOAPXMLAttrPtr * [out] ((|attr|)) OpenSOAP XML Attribute
戻り値:
エラーコード

int OpenSOAPBlockGetCharEncodingString (  OpenSOAPBlockPtr  soap_block,
const char *  ch_enc,
OpenSOAPByteArrayPtr  b_ary
) 
 

指定したエンコーディングでSOAPBlockをByteArrayに書き出す

引数:
soap_block OpenSOAPBlockPtr [in] ((|soap_block|)) OpenSOAP Block
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 OpenSOAPBlockGetChildMB (  OpenSOAPBlockPtr  soap_block,
const char *  elm_name,
OpenSOAPXMLElmPtr *  xml_elm
) 
 

名前(MB)に合致した子 XML Element を取得します。合致するものが複数ある場合は、最初の要素を取り出します。

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
elm_name const char * [in] ((|elm_name|)) Name of XML Element
xml_elm OpenSOAPXMLElmPtr * [out] ((|xml_elm|)) OpenSOAP XML Element
戻り値:
エラーコード

int OpenSOAPBlockGetChildValueMB (  OpenSOAPBlockPtr  soap_block,
const char *  p_name,
const char *  type_name,
void *  value
) 
 

指定した要素名(MB)のXML要素の値を取得します。

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
p_name const char * [in] ((|p_name|)) Parameter Name
type_name const char * [in] ((|type_name|)) Parameter Type
value void * [out] ((|value|)) Parameter Value
戻り値:
エラーコード

int OpenSOAPBlockGetChildValueWC (  OpenSOAPBlockPtr  soap_block,
const wchar_t *  p_name,
const wchar_t *  type_name,
void *  value
) 
 

指定した要素名(WCのXML要素の値を取得します。

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
p_name const wchar_t * [in] ((|p_name|)) Parameter Name
type_name const wchar_t * [in] ((|type_name|)) Parameter Type
value void * [out] ((|value|)) Parameter Value
戻り値:
エラーコード

int OpenSOAPBlockGetChildWC (  OpenSOAPBlockPtr  soap_block,
const wchar_t *  elm_name,
OpenSOAPXMLElmPtr *  xml_elm
) 
 

名前(WC)に合致した子 XML Element を取得します。合致するものが複数ある場合は、最初の要素を取り出します。

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
elm_name const wchar_t * [in] ((|elm_name|)) Name of Child XML Element
xml_elm OpenSOAPXMLElmPtr * [out] ((|xml_elm|)) OpenSOAP XML Element
戻り値:
エラーコード

int OpenSOAPBlockGetMustunderstandAttr (  OpenSOAPBlockPtr  soap_block,
int *  must_std
) 
 

Mustunderstand属性を取得します。.

引数:
soap_block OpenSOAPBlockPtr [in] ((|soap_block|)) SOAP Block
must_std int * [out] ((|must_std|)) mustunderstand return buffer pointer
戻り値:
エラーコード

int OpenSOAPBlockGetName (  OpenSOAPBlockPtr  block,
OpenSOAPStringPtr *  name
) 
 

SOAP Blockの名前を取得します。.

引数:
block OpenSOAPBlockPtr [in] ((|block|)) SOAP Block Pointer
name OpenSOAPStringPtr * [out] ((|name|)) Result Name of SOAP Block
戻り値:
エラーコード

int OpenSOAPBlockGetNamespace (  OpenSOAPBlockPtr  soap_block,
OpenSOAPXMLNamespacePtr *  ns
) 
 

NamespaceポインタにSOAP BlockのNamespaceを格納します。.

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
ns OpenSOAPXMLNamespacePtr * [out] ((|ns|)) Namespace
戻り値:
エラーコード

int OpenSOAPBlockGetNextChild (  OpenSOAPBlockPtr  soap_block,
OpenSOAPXMLElmPtr *  xml_elm
) 
 

Block直下の次の子要素を格納します。.

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
xml_elm OpenSOAPXMLElmPtr * [in, out] ((|xml_elm|)) OpenSOAP XML Element. If *xml_elm is NULL, the first child is returned
戻り値:
エラーコード

int OpenSOAPBlockGetValueMB (  OpenSOAPBlockPtr  soap_block,
const char *  type_name,
void *  value
) 
 

Body/Header Block直下の値を取得します。(MB).

引数:
soap_block OpenSOAPBlockPtr [in] ((|soap_block|)) OpenSOAP SOAP Block
type_name const char * [in] ((|type_name|)) Type Name
value void * [out] ((|value|)) Storage Buffer Pointer
戻り値:
エラーコード

int OpenSOAPBlockGetValueWC (  OpenSOAPBlockPtr  soap_block,
const wchar_t *  type_name,
void *  value
) 
 

Body/Header Block直下の値を取得します。(WC).

引数:
soap_block OpenSOAPBlockPtr [in] ((|soap_block|)) OpenSOAP SOAP Block
type_name const wchar_t * [in] ((|type_name|)) Type Name
value void * [out] ((|value|)) Storage Buffer Pointer
戻り値:
エラーコード

int OpenSOAPBlockIsActorAttrNext (  OpenSOAPBlockPtr  soap_block,
int *  is_actor_next
) 
 

Actor属性が，URI "http://schemas.xmlsoap.org/soap/actor/next"であるかを判定します。.

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
is_actor_next int * [out] ((|is_actor_next|)) judge result
戻り値:
エラーコード

int OpenSOAPBlockIsSameNamespaceMB (  OpenSOAPBlockPtr  soap_block,
const char *  ns_uri,
int *  is_same_uri
) 
 

マルチバイト文字列でNamespaceのURIを比較判定します。

引数:
soap_block OpenSOAPBlockPtr [in] ((|soap_block|)) SOAP Block
ns_uri OpenSOAPStringPtr [in] ((|ns_uri|)) Namespace URI
is_same_uri int * [out] ((|is_same_uri|)) judge result buffer
戻り値:
エラーコード

int OpenSOAPBlockIsSameNamespaceWC (  OpenSOAPBlockPtr  soap_block,
const wchar_t *  ns_uri,
int *  is_same_uri
) 
 

ワイドキャラクタ文字列でNamespaceのURIを比較判定します。

引数:
soap_block OpenSOAPBlockPtr [in] ((|soap_block|)) SOAP Block
ns_uri const wchar_t * [in] ((|ns_uri|)) Namespace URI
is_same_uri int * [out] ((|is_same_uri|)) judge result buffer
戻り値:
エラーコード

int OpenSOAPBlockSetActorAttrMB (  OpenSOAPBlockPtr  soap_block,
const char *  actor_url
) 
 

Actor属性を設定します。(MB).

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
actor_url const char * [in] ((|actor_url|)) actor attribute value
戻り値:
エラーコード

int OpenSOAPBlockSetActorAttrNext (  OpenSOAPBlockPtr  soap_block  ) 
 

Actor属性に，URI "http://schemas.xmlsoap.org/soap/actor/next"をセットします。.

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soapBlock|)) SOAP Block
戻り値:
エラーコード

int OpenSOAPBlockSetActorAttrWC (  OpenSOAPBlockPtr  soap_block,
const wchar_t *  actor_url
) 
 

Actor属性を設定します。(WC).

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
actor_url const wchar_t * [in] ((|actor_url|)) actor attribute value
戻り値:
エラーコード

int OpenSOAPBlockSetChildValueMB (  OpenSOAPBlockPtr  soap_block,
const char *  p_name,
const char *  type_name,
void *  value
) 
 

子要素と子要素の値を設定します。(MB)

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
p_name const char * [in] ((|p_name|)) Parameter Name
type_name const char * [in] ((|type_name|)) Parameter Type
value void * [in] ((|value|)) Parameter Value
戻り値:
エラーコード

int OpenSOAPBlockSetChildValueWC (  OpenSOAPBlockPtr  soap_block,
const wchar_t *  p_name,
const wchar_t *  type_name,
void *  value
) 
 

子要素と子要素の値を設定します。(WC)

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
p_name const wchar_t * [in] ((|p_name|)) Parameter Name
type_name const wchar_t * [in] ((|type_name|)) Parameter Type
value void * [in] ((|value|)) Parameter Value
戻り値:
エラーコード

int OpenSOAPBlockSetMustunderstandAttr (  OpenSOAPBlockPtr  soap_block  ) 
 

Mustunderstand属性を設定します。.

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
戻り値:
エラーコード

int OpenSOAPBlockSetNamespaceMB (  OpenSOAPBlockPtr  soap_block,
const char *  ns_uri,
const char *  ns_prefix
) 
 

マルチバイト文字列でSOAP Block に Namespaceを設定します。

（ns_prifix/ns_uriをsoap_blockへ格納します。）

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
ns_uri const char * [in] ((|ns_uri|)) Namespace URI
ns_prefix const char * [in] ((|ns_prefix|)) Namespace Prefix
戻り値:
エラーコード

int OpenSOAPBlockSetNamespaceWC (  OpenSOAPBlockPtr  soap_block,
const wchar_t *  ns_uri,
const wchar_t *  ns_prefix
) 
 

ワイドキャラクタ文字列でSOAP Block に Namespaceを設定します。

（ns_prifix/ns_uriをsoap_blockへ格納します。）

引数:
soap_block OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
ns_uri const wchar_t * [in] ((|ns_uri|)) Namespace URI
ns_prefix const wchar_t * [in] ((|ns_prefix|)) Namespace Prefix
戻り値:
エラーコード

int OpenSOAPBlockSetValueMB (  OpenSOAPBlockPtr  soap_block,
const char *  type_name,
void *  value
) 
 

SOAP Blockへの値の設定を行います。(MB).

Valueをtype_nameでSerializeした結果をsoap_blockへ格納します。

引数:
soap_block OpenSOAPBlockPtr [in] ((|soap_block|)) OpenSOAP SOAP Block
type_name const char * [in] ((|type_name|)) Type Name
value void * [in] ((|value|)) Storage Buffer Pointer
戻り値:
エラーコード

int OpenSOAPBlockSetValueWC (  OpenSOAPBlockPtr  soap_block,
const wchar_t *  type_name,
void *  value
) 
 

SOAP Blockへの値の設定を行います。(WC).

Valueをtype_nameでSerializeした結果をsoap_blockへ格納します。

引数:
soap_block OpenSOAPBlockPtr [in] ((|soap_block|)) OpenSOAP SOAP Block
type_name const wchar_t * [in] ((|type_name|)) Type Name
value void * [in] ((|value|)) Storage Buffer Pointer
戻り値:
エラーコード

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