Flash CS3 Documentation

ActionScript 2.0 Components Language Reference > Web service classes > PendingCall.getOutputParameter()

PendingCall.getOutputParameter()

Availability

Flash Player 6 (6.0.79.0).

Edition

Flash MX Professional 2004.

Usage

myPendingCall.getOutputParameter(index)

Parameters

index The zero-based index of the parameter.

Returns

A SOAPParameter object with two properties: value (the output parameter's ActionScript value) and element (the output parameter's XML value).

Description

Function; gets an additional output parameter of the SOAPParameter object, which contains the value and the XML element. SOAP RPC calls may return multiple output parameters. The first (or only) return value is always delivered in the result parameter of the onResult callback function, but to get access to the other return values, you must use functions such as getOutputParameter() and getOutputValue(). The getOutputParameter() function returns the nth output parameter as a SOAPParameter object.

Example

Given the SOAP descriptor file below, getOutputParameter(1) would return a SOAPParameter object with value="Hi there!" and element=the <outParam2> XMLNode.

...
<SOAP:Body>
  <rpcResponse>
    <outParam1 xsi:type="xsd:int">54</outParam1>
    <outParam2 xsi:type="xsd:string">Hi there!</outParam2>
    <outParam3 xsi:type="xsd:boolean">true</outParam3>
  </rpcResponse>
</SOAP:Body>
...