Main Page   File List   File Members  

Envelope.h File Reference

OpenSOAP API Envelope Processing. More...

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

Go to the source code of this file.

Typedefs

typedef tagOpenSOAPEnvelope OpenSOAPEnvelope
 OpenSOAPEnvelope Structure Type Definition.

typedef OpenSOAPEnvelopeOpenSOAPEnvelopePtr
 OpenSOAPEnvelope Pointer Type Definition.


Functions

int OpenSOAPEnvelopeCreate (OpenSOAPEnvelopePtr *soap_env)
 OpenSOAP Envelope Instance Create. More...

int OpenSOAPEnvelopeCreateMB (const char *soapVer, const char *envPrefix, OpenSOAPEnvelopePtr *soapEnv)
 OpenSOAP Envelope Instance Create(MB). More...

int OpenSOAPEnvelopeCreateWC (const wchar_t *soapVer, const wchar_t *envPrefix, OpenSOAPEnvelopePtr *soapEnv)
 OpenSOAP Envelope instance create(WC). More...

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

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

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

int OpenSOAPEnvelopeCreateCharEncoding (const char *chEnc, OpenSOAPByteArrayPtr b_ary, OpenSOAPEnvelopePtr *soap_env)
 Create Char Encoding. More...

int OpenSOAPEnvelopeRetain (OpenSOAPEnvelopePtr soap_env)
 Add Reference To OpenSOAP Envelope. More...

int OpenSOAPEnvelopeRelease (OpenSOAPEnvelopePtr soap_env)
 Release OpenSOAP Envelope Buffer. More...

int OpenSOAPEnvelopeAddHeaderBlockMB (OpenSOAPEnvelopePtr soap_env, const char *block_name, OpenSOAPBlockPtr *h_block)
 Add SOAP Header Block(MB). More...

int OpenSOAPEnvelopeAddHeaderBlockWC (OpenSOAPEnvelopePtr soap_env, const wchar_t *block_name, OpenSOAPBlockPtr *h_block)
 Add SOAP Header Block(WC). More...

int OpenSOAPEnvelopeGetNextHeaderBlock (OpenSOAPEnvelopePtr soap_env, OpenSOAPBlockPtr *h_block)
 Get SOAP Header Block. More...

int OpenSOAPEnvelopeGetHeaderBlockMB (OpenSOAPEnvelopePtr soap_env, const char *block_name, OpenSOAPBlockPtr *h_block)
 Get SOAP Header Block(MB). More...

int OpenSOAPEnvelopeGetHeaderBlockWC (OpenSOAPEnvelopePtr soap_env, const wchar_t *block_name, OpenSOAPBlockPtr *h_block)
 Get SOAP Header Block(WC). More...

int OpenSOAPEnvelopeAddBodyBlockMB (OpenSOAPEnvelopePtr soap_env, const char *block_name, OpenSOAPBlockPtr *b_block)
 Add SOAP Body Block(MB). More...

int OpenSOAPEnvelopeAddBodyBlockWC (OpenSOAPEnvelopePtr soap_env, const wchar_t *block_name, OpenSOAPBlockPtr *b_block)
 Add SOAP Body Block(WC). More...

int OpenSOAPEnvelopeGetNextBodyBlock (OpenSOAPEnvelopePtr soap_env, OpenSOAPBlockPtr *b_block)
 Get SOAP Body Block. More...

int OpenSOAPEnvelopeGetBodyBlockMB (OpenSOAPEnvelopePtr soap_env, const char *block_name, OpenSOAPBlockPtr *b_block)
 Get SOAP Body Block(MB). More...

int OpenSOAPEnvelopeGetBodyBlockWC (OpenSOAPEnvelopePtr soap_env, const wchar_t *block_name, OpenSOAPBlockPtr *b_block)
 Get SOAP Body Block(WC). More...

int OpenSOAPEnvelopeGetCharEncodingString (OpenSOAPEnvelopePtr soap_env, const char *ch_enc, OpenSOAPByteArrayPtr b_ary)
 SOAP Envelope Character Encoding Output. More...

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

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

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

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

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


Detailed Description

OpenSOAP API Envelope Processing.

Author:
OpenSOAP Development Team

Function Documentation

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

Add SOAP Body Block(MB).

Parameters:
soap_env  OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope
block_name  const char * [in] ((|block_name|)) SOAP Block Name. If block_name==NULL, add body element only (no body block).
b_block  OpenSOAPBlockPtr * [out] ((|b_block|)) OpenSOAP Body Block
Returns:
Error Code

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

Add SOAP Body Block(WC).

Parameters:
soap_env  OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope
block_name  const wchar_t * [in] ((|block_name|)) SOAP Block Name
b_block  OpenSOAPBlockPtr * [out] ((|b_block|)) OpenSOAP Body Block
Returns:
Error Code

int OpenSOAPEnvelopeAddFaultString OpenSOAPEnvelopePtr    soapEnv,
OpenSOAPStringPtr    faultCode,
OpenSOAPStringPtr    faultString,
int    isValueDup,
OpenSOAPBlockPtr   faultBlock
 

Add Fault String.

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

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

Add SOAP Header Block(MB).

Parameters:
soapEnv  OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope
block_name  const char * [in] ((|block_name|)) SOAP Block Name
h_block  OpenSOAPBlockPtr * [out] ((|h_block|)) OpenSOAP Header Block
Returns:
Error Code

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

Add SOAP Header Block(WC).

Parameters:
soapEnv  OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope
block_name  const wchar_t * [in] ((|block_name|)) SOAP Block Name
h_block  OpenSOAPBlockPtr * [out] ((|h_block|)) OpenSOAP Header Block
Returns:
Error Code

int OpenSOAPEnvelopeCreate OpenSOAPEnvelopePtr   soap_env
 

OpenSOAP Envelope Instance Create.

Parameters:
soap_env  OpenSOAPEnvelopePtr * [out] ((|soap_env|)) Storage Buffer of OpenSOAP Envelope Pointer
Returns:
Error Code

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

Create Char Encoding.

Parameters:
chEnc  const char * [in] ((|chEnc|)) character encoding
b_ary  OpenSOAPByteArrayPtr [in] ((|b_ary|)) OpenSOAP ByteArray
soapEnv  OpenSOAPEnvelopePtr * [out] ((|soapEnv|)) Storage Buffer of OpenSOAP Envelope Pointer
Returns:
Error Code

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

Create OpenSOAP Fault Block(MB).

Parameters:
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|)) Storage Buffer of OpenSOAP Fault Block Pointer
soapEnv  OpenSOAPEnvelopePtr * [out] ((|soapEnv|)) Storage Buffer of OpenSOAP Envelope Pointer
Returns:
Error Code

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

Parameters:
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|)) Storage Buffer of OpenSOAP Fault Block Pointer
soapEnv  OpenSOAPEnvelopePtr * [out] ((|soapEnv|)) Storage Buffer of OpenSOAP Envelope Pointer
Returns:
Error Code

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

OpenSOAP Envelope Instance Create(MB).

Parameters:
soapVer  const char * [in] ((||soapVer|)) SOAP Version
envPrefix  const char * [in] ((|envPrefix|)) SOAP Envelope namespace prefix
soapEnv  OpenSOAPEnvelopePtr * [out] ((|soapEnv|)) Storage Buffer of OpenSOAP Envelope Pointer
Returns:
Error Code
Note:
soapVer This should be "1.1" or "1.2". If NULL, this defaults to "1.1"
envPrefix If NULL, this defaults as follows according to soapVer; "1.1": SOAP-ENV, "1.2": env

int OpenSOAPEnvelopeCreateString OpenSOAPStringPtr    soapVer,
OpenSOAPStringPtr    envPrefix,
OpenSOAPEnvelopePtr   soapEnv
 

OpenSOAP Envelope instance create(OpenSOAPString).

Parameters:
soapVer  OpenSOAPStringPtr [in] ((||soapVer|)) SOAP Version
envPrefix  OpenSOAPStringPtr [in] ((|envPrefix|)) SOAP Envelope namespace prefix
soapEnv  OpenSOAPEnvelopePtr * [out] ((|soapEnv|)) Storage Buffer of OpenSOAP Envelope Pointer
Returns:
Error Code

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

OpenSOAP Envelope instance create(WC).

Parameters:
soapVer  const char * [in] ((||soapVer|)) SOAP Version
envPrefix  const char * [in] ((|envPrefix|)) SOAP Envelope namespace prefix
soapEnv  OpenSOAPEnvelopePtr * [out] ((|soapEnv|)) Storage Buffer of OpenSOAP Envelope Pointer
Returns:
Error Code
Note:
soapVer This should be "1.1" or "1.2". If NULL, this defaults to "1.1" envPrefix If NULL, this defaults as follows according to soapVer; "1.1": SOAP-ENV, "1.2": env

int OpenSOAPEnvelopeGetActorNameString OpenSOAPEnvelopePtr    soapEnv,
OpenSOAPStringPtr   actorName
 

Get Actor Name String.

Parameters:
soapEnv  OpenSOAPEnvelopePtr [in] ((|soapEnv|)) OpenSOAP Envelope Pointer
actorName  OpenSOAPStringPtr * [out] ((|actorName|)) Actor Name
Returns:
Error Code

int OpenSOAPEnvelopeGetActorNextString OpenSOAPEnvelopePtr    soapEnv,
OpenSOAPStringPtr   actorNext
 

Get Actor Next String.

Parameters:
soapEnv  OpenSOAPEnvelopePtr [in] ((|soapEnv|)) OpenSOAP Envelope Pointer
actorNext  OpenSOAPStringPtr * [out] ((|actorNext|)) Actor Next
Returns:
Error Code

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

Get SOAP Body Block(MB).

Parameters:
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
Returns:
Error Code
Note:
Search for 'block_name' and return the corresponding Body Block in 'b_block'.

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

Get SOAP Body Block(WC).

Parameters:
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
Returns:
Error Code
Note:
Search for 'block_name' and return the corresponding Body Block in 'b_block'.

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

Soap Body Character Encoding Output.

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

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

SOAP Envelope Character Encoding Output.

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

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

Get SOAP Header Block(MB).

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

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

Get SOAP Header Block(WC).

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

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

Soap Header character encoding output.

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

int OpenSOAPEnvelopeGetNextBodyBlock OpenSOAPEnvelopePtr    soap_env,
OpenSOAPBlockPtr   b_block
 

Get SOAP Body Block.

Parameters:
soap_env  OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope
b_block  OpenSOAPBlockPtr * [in, out] ((|b_block|)) OpenSOAP Body Block. If *b_block is NULL, then return first Body Block.
Returns:
Error Code

int OpenSOAPEnvelopeGetNextHeaderBlock OpenSOAPEnvelopePtr    soap_env,
OpenSOAPBlockPtr   h_block
 

Get SOAP Header Block.

Parameters:
soap_env  OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope
h_block  OpenSOAPBlockPtr * [in, out] ((|h_block|)) OpenSOAP Header Block. If NULL, return first header block.
Returns:
Error Code

int OpenSOAPEnvelopeRelease OpenSOAPEnvelopePtr    soapEnv
 

Release OpenSOAP Envelope Buffer.

Parameters:
soapEnv  OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope
Returns:
Error Code
Note:
Release Resources of Created OpenSOAP Resource

int OpenSOAPEnvelopeRetain OpenSOAPEnvelopePtr    soapEnv
 

Add Reference To OpenSOAP Envelope.

Parameters:
soapEnv  OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope
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