standard.net.soap.SOAPEnvNewWithFault

Concept Framework 2.2 documentation

standard.net.soap.SOAPEnvNewWithFault

Name	Version	Deprecated
SOAPEnvNewWithFault	version 1.0	no

Prototype:

number SOAPEnvNewWithFault(number faultCode, string faultString, string faultActor, string detail, var number out_env)

Parameters:

faultCode	[in] the fault code
faultString	[in] a fault message
detail	[in] the detail on the error
out_env	[out] the resulting envelope with parameters like in the example section

Description:

Create an envelope with a fault object.

Example:

  <SOAP-ENV:Envelope xmlns:SOAP-ENV="..." SOAP-ENV:encoding="..."
       xmlns:xsi="..."
     xmlns:xsd="...">
   <SOAP-ENV:Body>
	 <Fault>
	  <faultcode>...</faultcode>
	  <faultstring>...</faultstring>
	  <faultactor>...</faultactor>
	  <faultdetail>..</faultdetail>
	 </Fault>
   </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>

Returns:
Returns null if succeeded, or an error handle (to get the error text, you should call SOAPError)

Documented by Eduard Suica, generation time: Sun Jan 27 18:15:19 2013 GMT