Using the flow Tag

The <flow> tag characterizes the program control flow. The halts attribute of the <flow> tag specifies whether the calling program terminates after the call:

yes

If control is not received back from the API.

no

If the calling program returns normally. This is the default value.

The <param> subtag identifies characteristics of the call parameters. Attributes are:

index

This is the index of the parameter that references the item of interest, beginning with 1. Use an asterisk (*) to specify all parameters not specified directly.

usage

Specifies the direction of the data flow through the parameter:

r

For input.

w

For output.

rw

For input/output.

Unspecified parameters are assumed to be input/output parameters.

<flow halts='no'>
  <param index='1' usage='r'/>
  <param index='2' usage='r'/>
  <param index='3' usage='rw'/>
  <param index='*' usage='rw'/>
</flow>