FCAI request completion values

The following list describes how to interpret the contents of FCAI_Result and how to use the secondary results fields.

If FCAI_Result contains . . .	Then . . .	Explanation
FCAI_Result_OK	no further action is required.	The request is complete with no additional status or errors to report.
FCAI_Result_Status	check the FCAI_Status field for additional status information.	The interface uses the status field to report prompts from the client, to report an indication that the last request is still in-progress, and to report an error in the interface trace function.
FCAI_Result_IE	check the FCAI_IE field for error information.	The request returned an interface error, which indicates that the interface was unable to process the request for some reason. That reason might be a parameter on the call that was not valid, a failure in a service routine (such as GETMAIN), or termination of the client process.
FCAI_Result_CEC	check the FCAI_CEC field for the error code that was returned by the client. You can optionally issue GETL to retrieve diagnostic information (see GETL).	The request completed with an FTP Client Error Code. For information about Client Error Codes and diagnosing errors in the client and server, see FTP return codes in the z/OS Communications Server: IP User's Guide and Commands and Diagnosing FTP problems in the z/OS Communications Server: IP Diagnosis Guide.
Other values returned in FCAI_Result are listed along with their descriptions in FTP Client Application Interface (FCAI) control block.

Tips:

The value in FCAI_Result is returned to the caller in the return code register. Additionally, callers in COBOL, C, and PL/I can access the return code value in the FCAI_ReturnCode field and the reason code value in the FCAI_ReasonCode field.
The result code FCAI_Result_UnusableFCAI is returned only in the return code register.
Always verify that the return code register is set to 0 before inspecting the FCAI.

For all requests that communicate with the FTP server, the field FCAI_ReplyCode reports the last reply that was received from the final server command sent to the FTP server by the client for the request. The FCAI_ReplyCode field is a binary field with a length of 2. For example, a 250 reply from the server is recorded in the field as X'00FA'. A value of all zeros indicates that the client did not communicate with the FTP server. The following conditions apply to the FCAI_ReplyCode field.

GETL and TERM requests do not populate the FCAI_ReplyCode field.
An INIT request populates this field only if an implicit OPEN was performed.
SCMD requests for locally processed subcommands such as LOCSITE and LPWD do not communicate with the FTP server. Those subcommands, and subcommands that fail before sending a command to the server, do not populate this field.
A POLL request might or might not populate this field, depending on the prior subcommand that was in-progress.

Requests that initiate a subcommand in the z/OS® FTP client return a value in the FCAI_SCMD field. This field is set by all SCMD requests and by the INIT request when start parameters that were passed on the request generate an implicit OPEN subcommand.

FCAI_ReturnCode and FCAI_ReasonCode values are set when certain services fail. See FTP Client Application Interface (FCAI) control block and Programming notes for the FTP client API for more information.