FTP Client Application Interface (FCAI) stem variables

The user-written REXX program uses an FCAI stem to represent an instance of use of the interface.

Guideline: When passing the REXX stem to the FTP client API for REXX, include the terminating period (.).

Table 1 describes the stem variables that are created from the REXX stem. The Type column indicates the type of value that the field contains, which can be decimal or binary.

All stem variables, with the exception of stem.FCAI_Map, are output fields. The stem.FCAI_Map variable is used internally by the FTP client API for REXX function package.

Table 1. FCAI stem variables
Name	Type	Description	Additional Information
stem.FCAI_Result	Decimal	This stem variable corresponds to the FCAI_Result field in the FCAI_Map control block.	See Table 7.
stem.FCAI_IE	Decimal	This stem variable corresponds to the FCAI_IE field in the FCAI_Map control block.	See Table 8.
stem.FCAI_CEC	Decimal	This stem variable corresponds to the FCAI_CEC field in the FCAI_Map control block.	See FTP return codes in the z/OS Communications Server: IP User's Guide and Commands.
stem.FCAI_ReplyCode	Decimal	This stem variable corresponds to the FCAI_ReplyCode in the FCAI_Map control block.	See FTPD reply codes in z/OS Communications Server: IP and SNA Codes.
stem.FCAI_TraceStatus	Decimal	This stem variable corresponds to the FCAI_TraceStatus field in the FCAI_Map control block. It can be used to determine whether the last FTP client API trace succeeded or failed.	See Table 5.
stem.FCAI_ReturnCode	Decimal	This stem variable corresponds to the FCAI_ReturnCode field in the FCAI_Map control block.	See Table 5 and Table 8.
stem.FCAI_ReasonCode	Decimal	This stem variable corresponds to the FCAI_ReasonCode field in the FCAI_Map control block.	See Table 5 and Table 8.
stem.FCAI_SCMD	Decimal	This stem variable corresponds to the FCAI_SCMD field in the FCAI_Map control block.	See FTP subcommand codes in the z/OS Communications Server: IP User's Guide and Commands.
stem.FCAI_Map	Binary	This stem variable contains a binary representation of the FCAI_Map control block, plus additional fields used by the FTP client API for REXX.	This stem variable must not be modified by the REXX program.