Flash CS3 Documentation

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

PendingCall.getOutputParameterByName()

Availability

Flash Player 6 (6.0.79.0).

Edition

Flash MX Professional 2004.

Usage

myPendingCall.getOutputParameterByName(var localName)

Parameters

localName The local name of the parameter. In other words, the name of an XML element, stripped of any namespace information. For example, the local name of both of the following elements is bob:

<bob abc="123">
<xsd:bob def="ghi">

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 any output parameter as a 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 getOutputParameterByName(). This function returns the output parameter with the name localName.

Example

Given the SOAP descriptor file below, getOutputParameterByName("outParam2") 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>
...