tpf_soapEnd: End a SOAP consumer Web service session

This function ends a SOAP consumer Web service session that was previously established by using the tpf_soapInitHandle function to initialize the SOAP consumer API handle.

Last updated

Added for PUT06.

Format

LIBS := CWSA
#include  <tpf/c_soapc.h>
int tpf_soapEnd (t_soapHandle soapHandle);
soapHandle
A t_soapHandle type that represents the SOAP consumer API handle to end.

Normal return

TPF_SOAP_SUCCESS indicates that the specified SOAP consumer API handle ended.

Error return

The tpf_soapEnd function returns TPF_SOAP_ERROR and errno is set to one of the following:
ETPFSOAP_HANDLEERR
The specified SOAP consumer API handle is not valid.
ETPFSOAP_UWSE
This is returned from the UWSE user exit. The request was not performed.

Programming considerations

  • SOAP consumer API handles cannot be shared across processes in the z/TPF system.
  • This must be the last function call for a SOAP consumer Web service session. Do not call this function if you intend to make more SOAP consumer requests using this SOAP consumer API handle.
  • This function releases all storage that is associated with the SOAP consumer API handle. This includes the following:
    • The SOAP request message
    • The SOAP response message
    • The XMLHandle structures that are associated with the request and reply when SOAP_PARMS is specified for the dataFormat field and used for the tpf_soapInvokeService function call.

Examples

See the example in tpf_soapInitHandle: Initialize a SOAP consumer API handle.

Related information

See z/TPF Web Services Support for more information about SOAP support.

See z/TPF C functions overview for more information about z/TPF C/C++ language support.