Main Page   File List   File Members  

Block.h File Reference

OpenSOAP API Block Processing. More...

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

Go to the source code of this file.

Typedefs

typedef tagOpenSOAPBlock OpenSOAPBlock
 OpenSOAPBlock Structure Type Definition.

typedef OpenSOAPBlockOpenSOAPBlockPtr
 OpenSOAPBlock Pointer Type Definition.


Functions

int OpenSOAPBlockGetValueMB (OpenSOAPBlockPtr soap_block, const char *type_name, void *value)
 Get Value of SOAP Block(MB). More...

int OpenSOAPBlockGetValueWC (OpenSOAPBlockPtr soap_block, const wchar_t *type_name, void *value)
 Get Value of SOAP Block(WC). More...

int OpenSOAPBlockSetValueMB (OpenSOAPBlockPtr soap_block, const char *type_name, void *value)
 Set Value of SOAP Block(MB). More...

int OpenSOAPBlockSetValueWC (OpenSOAPBlockPtr soap_block, const wchar_t *type_name, void *value)
 Set Value of SOAP Block(WC). More...

int OpenSOAPBlockSetNamespaceMB (OpenSOAPBlockPtr soap_block, const char *ns_uri, const char *ns_prefix)
 Set Namespace(MB). More...

int OpenSOAPBlockSetNamespaceWC (OpenSOAPBlockPtr soap_block, const wchar_t *ns_uri, const wchar_t *ns_prefix)
 Set Namespace(WC). More...

int OpenSOAPBlockGetNamespace (OpenSOAPBlockPtr soap_block, OpenSOAPXMLNamespacePtr *ns)
 Get Namespace. More...

int OpenSOAPBlockIsSameNamespaceMB (OpenSOAPBlockPtr soap_block, const char *ns_uri, int *is_same_uri)
 Judge Namespace(MB). More...

int OpenSOAPBlockIsSameNamespaceWC (OpenSOAPBlockPtr soap_block, const wchar_t *ns_uri, int *is_same_uri)
 Judge Namespace(WC). More...

int OpenSOAPBlockAddAttributeMB (OpenSOAPBlockPtr soap_block, const char *attr_name, const char *attr_type, void *attr_value, OpenSOAPXMLAttrPtr *attr)
 Add and Set Attribute(MB). More...

int OpenSOAPBlockAddAttributeWC (OpenSOAPBlockPtr soap_block, const wchar_t *attr_name, const wchar_t *attr_type, void *attr_value, OpenSOAPXMLAttrPtr *attr)
 Add and Set Attribute(WC). More...

int OpenSOAPBlockGetAttributeMB (OpenSOAPBlockPtr soap_block, const char *attr_name, OpenSOAPXMLAttrPtr *attr)
 Get Value of Attribute(MB). More...

int OpenSOAPBlockGetAttributeWC (OpenSOAPBlockPtr soap_block, const wchar_t *attr_name, OpenSOAPXMLAttrPtr *attr)
 Get Value of Attribute. More...

int OpenSOAPBlockGetChildValueMB (OpenSOAPBlockPtr soap_block, const char *p_name, const char *type_name, void *value)
 Get Parameter Value(MB). More...

int OpenSOAPBlockGetChildValueWC (OpenSOAPBlockPtr soap_block, const wchar_t *p_name, const wchar_t *type_name, void *value)
 Get Child Value(WC). More...

int OpenSOAPBlockSetChildValueMB (OpenSOAPBlockPtr soap_block, const char *p_name, const char *type_name, void *value)
 Set Parameter Value(MB). More...

int OpenSOAPBlockSetChildValueWC (OpenSOAPBlockPtr soap_block, const wchar_t *p_name, const wchar_t *type_name, void *value)
 Set Parameter Value(WC). More...

int OpenSOAPBlockGetNextChild (OpenSOAPBlockPtr soap_block, OpenSOAPXMLElmPtr *xml_elm)
 Get next child Block. More...

int OpenSOAPBlockAddChildMB (OpenSOAPBlockPtr soap_block, const char *elm_name, OpenSOAPXMLElmPtr *xml_elm)
 Add Child XML Element(MB). More...

int OpenSOAPBlockAddChildWC (OpenSOAPBlockPtr soap_block, const wchar_t *elm_name, OpenSOAPXMLElmPtr *xml_elm)
 Add Child XML Element(WC). More...

int OpenSOAPBlockGetChildMB (OpenSOAPBlockPtr soap_block, const char *elm_name, OpenSOAPXMLElmPtr *xml_elm)
 Get The Child with Matching Name(MB). Get first if more than one. More...

int OpenSOAPBlockGetChildWC (OpenSOAPBlockPtr soap_block, const wchar_t *elm_name, OpenSOAPXMLElmPtr *xml_elm)
 Get The Child with Matching Name(WC). Get first if more than one. More...

int OpenSOAPBlockGetMustunderstandAttr (OpenSOAPBlockPtr soap_block, int *must_std)
 Get mustunderstand attribute. More...

int OpenSOAPBlockSetMustunderstandAttr (OpenSOAPBlockPtr soap_block)
 Set mustunderstand attribute. More...

int OpenSOAPBlockClearMustunderstandAttr (OpenSOAPBlockPtr soap_block)
 Clear mustunderstand attribute. More...

int OpenSOAPBlockGetActorAttr (OpenSOAPBlockPtr soap_block, OpenSOAPStringPtr *actor_url)
 Get actor attribute. More...

int OpenSOAPBlockSetActorAttrMB (OpenSOAPBlockPtr soap_block, const char *actor_url)
 Set actor attribute.(MB). More...

int OpenSOAPBlockSetActorAttrWC (OpenSOAPBlockPtr soap_block, const wchar_t *actor_url)
 Set actor attribute.(WC). More...

int OpenSOAPBlockClearActorAttr (OpenSOAPBlockPtr soap_block)
 Clear actor attribute. More...

int OpenSOAPBlockSetActorAttrNext (OpenSOAPBlockPtr soap_block)
 Set actor attribute to next. More...

int OpenSOAPBlockIsActorAttrNext (OpenSOAPBlockPtr soap_block, int *is_actor_next)
 Is actor attribute to next. More...

int OpenSOAPBlockGetName (OpenSOAPBlockPtr block, OpenSOAPStringPtr *name)
 Get SOAP Block Name. More...

int OpenSOAPBlockGetCharEncodingString (OpenSOAPBlockPtr soap_block, const char *ch_enc, OpenSOAPByteArrayPtr b_ary)
 Soap block character encoding output. More...


Detailed Description

OpenSOAP API Block Processing.

Author:
OpenSOAP Development Team

Function Documentation

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

Add and Set Attribute(MB).

Parameters:
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
Returns:
Error Code

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

Add and Set Attribute(WC).

Parameters:
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
Returns:
Error Code

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

Add Child XML Element(MB).

Parameters:
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
Returns:
Error Code

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

Add Child XML Element(WC).

Parameters:
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
Returns:
Error Code

int OpenSOAPBlockClearActorAttr OpenSOAPBlockPtr    soap_block
 

Clear actor attribute.

Parameters:
soap_block  OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
Returns:
Error Code

int OpenSOAPBlockClearMustunderstandAttr OpenSOAPBlockPtr    soap_block
 

Clear mustunderstand attribute.

Parameters:
soap_block  OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
Returns:
Error Code

int OpenSOAPBlockGetActorAttr OpenSOAPBlockPtr    soap_block,
OpenSOAPStringPtr   actor_url
 

Get actor attribute.

Parameters:
soap_block  OpenSOAPBlockPtr [in] ((|soapBlock|)) SOAP Block
actor_url  OpenSOAPStringPtr * [out] ((|actorUri|)) actor attribute value
Returns:
Error Code

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

Get Value of Attribute(MB).

Parameters:
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
Returns:
Error Code

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

Get Value of Attribute.

Parameters:
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
Returns:
Error Code

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

Soap block character encoding output.

Parameters:
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
Returns:
Error Code

int OpenSOAPBlockGetChildMB OpenSOAPBlockPtr    soap_block,
const char *    elm_name,
OpenSOAPXMLElmPtr   xml_elm
 

Get The Child with Matching Name(MB). Get first if more than one.

Parameters:
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
Returns:
Error Code

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

Get Parameter Value(MB).

Parameters:
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
Returns:
Error Code

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

Get Child Value(WC).

Parameters:
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
Returns:
Error Code

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

Get The Child with Matching Name(WC). Get first if more than one.

Parameters:
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
Returns:
Error Code

int OpenSOAPBlockGetMustunderstandAttr OpenSOAPBlockPtr    soap_block,
int *    must_std
 

Get mustunderstand attribute.

Parameters:
soap_block  OpenSOAPBlockPtr [in] ((|soap_block|)) SOAP Block
must_std  int * [out] ((|must_std|)) mustunderstand return buffer pointer
Returns:
Error Code

int OpenSOAPBlockGetName OpenSOAPBlockPtr    block,
OpenSOAPStringPtr   name
 

Get SOAP Block Name.

Parameters:
block  OpenSOAPBlockPtr [in] ((|block|)) SOAP Block Pointer
name  OpenSOAPStringPtr * [out] ((|name|)) Result Name of SOAP Block
Returns:
Error Code

int OpenSOAPBlockGetNamespace OpenSOAPBlockPtr    soap_block,
OpenSOAPXMLNamespacePtr   ns
 

Get Namespace.

Parameters:
soap_block  OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
ns  OpenSOAPXMLNamespacePtr * [out] ((|ns|)) Namespace
Returns:
Error Code

int OpenSOAPBlockGetNextChild OpenSOAPBlockPtr    soap_block,
OpenSOAPXMLElmPtr   xml_elm
 

Get next child Block.

Parameters:
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
Returns:
Error Code

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

Get Value of SOAP Block(MB).

Parameters:
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
Returns:
Error Code

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

Get Value of SOAP Block(WC).

Parameters:
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
Returns:
Error Code

int OpenSOAPBlockIsActorAttrNext OpenSOAPBlockPtr    soap_block,
int *    is_actor_next
 

Is actor attribute to next.

Parameters:
soap_block  OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
is_actor_next  int * [out] ((|is_actor_next|)) judge result
Returns:
Error Code

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

Judge Namespace(MB).

Parameters:
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
Returns:
Error Code

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

Judge Namespace(WC).

Parameters:
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
Returns:
Error Code

int OpenSOAPBlockSetActorAttrMB OpenSOAPBlockPtr    soap_block,
const char *    actor_url
 

Set actor attribute.(MB).

Parameters:
soap_block  OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
actor_url  const char * [in] ((|actor_url|)) actor attribute value
Returns:
Error Code

int OpenSOAPBlockSetActorAttrNext OpenSOAPBlockPtr    soap_block
 

Set actor attribute to next.

Parameters:
soap_block  OpenSOAPBlockPtr [in, out] ((|soapBlock|)) SOAP Block
Returns:
Error Code

int OpenSOAPBlockSetActorAttrWC OpenSOAPBlockPtr    soap_block,
const wchar_t *    actor_url
 

Set actor attribute.(WC).

Parameters:
soap_block  OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
actor_url  const wchar_t * [in] ((|actor_url|)) actor attribute value
Returns:
Error Code

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

Set Parameter Value(MB).

Parameters:
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
Returns:
Error Code

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

Set Parameter Value(WC).

Parameters:
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
Returns:
Error Code

int OpenSOAPBlockSetMustunderstandAttr OpenSOAPBlockPtr    soap_block
 

Set mustunderstand attribute.

Parameters:
soap_block  OpenSOAPBlockPtr [in, out] ((|soap_block|)) SOAP Block
Returns:
Error Code

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

Set Namespace(MB).

Parameters:
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
Returns:
Error Code

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

Set Namespace(WC).

Parameters:
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
Returns:
Error Code

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

Set Value of SOAP Block(MB).

Parameters:
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
Returns:
Error Code

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

Set Value of SOAP Block(WC).

Parameters:
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
Returns:
Error Code


Generated on Fri Jan 10 21:23:44 2003 for OpenSOAP by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002