- Contents
SOAP API Developer's Guide
SOAP Get Next RPC Parameter
This tool returns the element node at the current iterator position and returns an iterator to the next position. As the iterator is just a variable, you can make copies at any time to remember a certain position, for example the start position. By using the same variable as input and output iterator, you can easily iterate over the list by connecting the Success path back to this tool (after processing the node, of course). The tool takes the ‘End' exit when the iterator points to an empty list or the iteration is complete (list traversed to end).
The tool will fail (take the Failure exit) if the node to which ‘Parameter Iterator' points is not an element! This cannot happen if the iterator was obtained through ‘SOAP Get RPC Method Info'.
Exit Paths: Success, End, Failure
Parameter |
Dir |
Type |
Remarks |
Parameter Iterator |
IN |
NodeIter |
Iterator to collection of parameter of a method. |
Retrieve Value |
IN |
Boolean |
Checkbox: False Do not retrieve value True Default. Return node value Disable retrieval of value if value is not used and parameter may contain a large XML document. |
Next Parameter |
OUT |
NodeIter |
Iterator pointing to next parameter in the list |
Parameter Element |
OUT |
Node |
Node of the parameter element |
Parameter Base Name |
OUT |
String |
Base name of the parameter element |
Parameter Namespace |
OUT |
String |
Namespace URI of the parameter element |
Value |
OUT |
String |
Value of the parameter |