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 OpenSOAPBlock * OpenSOAPBlockPtr
 OpenSOAPBlock Pointer Type Definition.


Functions

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

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

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

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

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

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

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

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

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

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

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).

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

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

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

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

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

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

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

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

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

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.

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.

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

int OpenSOAPBlockSetMustunderstandAttr (OpenSOAPBlockPtr soap_block)
 Set mustunderstand attribute.

int OpenSOAPBlockClearMustunderstandAttr (OpenSOAPBlockPtr soap_block)
 Clear mustunderstand attribute.

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

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

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

int OpenSOAPBlockClearActorAttr (OpenSOAPBlockPtr soap_block)
 Clear actor attribute.

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

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

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

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

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 Mon Oct 18 18:29:44 2004 for OpenSOAP by doxygen 1.3.6