GETL_COPY request

Format


                                              .-,--'A'--.      
>>-ftpapi--(--stem--,--'getl_copy'--,--lines--+---------+--)---><
                                              '-,--type-'

Purpose

Finds and returns all lines of the output that was returned from the FTP client by an INIT, SCMD, or POLL request.

Parameters

stem

The name of a stem that represents the FTP client environment. The stem must have been passed on a prior successful INIT function call.

'getl_copy'

Requests the return of all remaining lines of output of type type that were returned from the FTP client by an INIT, SCMD, or POLL request. The string literal is not case sensitive.

lines

The stem where the output lines are to be copied. The results are:

lines.0: The number of output lines returned. This is ≥ 1 if the function result is 0, and 0 if the function result is 4.
lines.id.i: The 1-character identifier for line i of output. Possible values are M, R, T, and L. These are described under the type parameter.
lines.i: The contents of line i of output.

type

A 1-character parameter that indicates what type of output is requested. The string literal is not case sensitive. Possible values are:

M: Message from the client
R: Reply from the server
L: List data from a DIR or LS subcommand
T: Trace output from debug or dump routine
A: Any type of output

The default value is A.

Results

Table 1. FTP client GETL_COPY request return codes
Value	Return codes	Explanation
<0		The call did not complete successfully. The possible failure return codes are listed in the Return codes column.
	-2 (FCAI_RESULT_IE)	An interface error occurred. The interface error code is stored in the stem.FCAI_IE stem variable.
	-3 (FCAI_RESULT_CEC)	A client error occurred. The client error code is stored in the stem.FCAI_CEC field stem variable.
	-17 (FCAI_RESULT_UNUSABLESTEM)	The stem variable is not usable.
	-18 (FCAI_TASK_TASKMISMATCH)	The task is not the same as the INIT task.
	-19 (FCAI_RESULT_REXXERROR)	An error occurred in storing, fetching, or dropping a REXX variable.
	-32 (FCAI_TASK_CLIPROCESSKILL)	A TERM request issued BPX1KIL to end the client process.
≥0		The call completed successfully.
	0 (FCAI_RESULT_OK)	The matching output lines were found and returned in the lines stem variable.
	4 (FCAI_RESULT_NOMATCH)	The prior request has completed successfully but no matching output lines were found.

Examples

rc = ftpapi('fcai.', 'getl_copy', 'lines.', 'A')