Returns the result of the last SOAP procedure that was successfully run.
// Returns the result of the last SOAP procedure run
ResProcedure = SOAPGetResult(SOAPResult)
Syntax
<Result> = SOAPGetResult(<Type of result> [, <Result Number>])
<Result>: Character string
- Result of the last SOAP procedure that was successfully run.
- If several results are returned by the SOAP server and if the SOAPResult constant is used:
- result <Result Number>,
- first result returned if <Result Number> is not specified.
- An empty string ("") if:
- no result was returned by the SOAP server,
- no connection was established with the SOAP server.
<Type of result>: Constant
Type of result to return: | |
| SOAPHTTPResult | Result (in HTTP format) of the last SOAP procedure run. |
| SOAPResult | Result of last SOAP procedure run.
This result can be used only if the return type is a simple type (integer, string, ...) |
| SOAPXMLResult | Result (in XML format) of the last SOAP procedure run .
This constant is recommended. The return type is a composite type. The values can be checked out by the XML functions. |
<Result Number>: Optional integer
Number of the result to return. This parameter is used only if several results are returned by the SOAP server and if the SOAPResult constant is specified. Otherwise, this parameter is ignored.
Remarks
Example: The different types of results
The same procedure run on a SOAP server may return three types of results.
Let's study the following example:
The "getTemp" procedure (used to find out the temperature of a city) has been run. The types of results returned by SOAPGetResult are as follows:
- With the SOAPResult constant: 37
- With the SOAPHTTPResult constant:
HTTP/1.1 200 OK
Date: Mon, 09 Jul 2001 09:34:49 GMT
Status: 200
Set-Cookie2: JSESSIONID=To16135mC022383577812008837At;Version=1;Discard;Path="/soap"
Servlet-Engine: Tomcat Web Server/3.1 (JSP 1.1; Servlet 2.2; Java 1.3.0;
Linux 2.2.19-6.2.1.2RS x86; java.vendor=IBM Corporation)
Set-Cookie: JSESSIONID=To16135mC022383577812008837At;Path=/soap
Content-Type: text/xml; charset=utf-8
Content-Length: 467
Content-Language: en
<?xml version='1.0' encoding='UTF-8'?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/1999/XMLSchema">
<SOAP-ENV:Body>
<ns1:getTempResponse xmlns:ns1="urn:xmethods-Temperature"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<return xsi:type="xsd:float">37.0</return>
</ns1:getTempResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
- With the SOAPXMLResult constant:
<?xml version='1.0' encoding='UTF-8'?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/1999/XMLSchema">
<SOAP-ENV:Body>
<ns1:getTempResponse xmlns:ns1="urn:xmethods-Temperature"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<return xsi:type="xsd:float">37.0</return>
</ns1:getTempResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>