CREATE request

Format


                                 .-,--'   '----.  .-,--'A'---------.  .-,--1000000--.      
>>-ftpapi--(--stem--,--'create'--+-------------+--+----------------+--+-------------+--)-><
                                 '-,--trace_id-'  '-,--traceSClass-'  '-,--traceNum-'

Purpose

Creates a new instance of the FTP client API.

Parameters

stem: The name of a stem used to return the FTP client environment. This stem is included as the first parameter on all subsequent FTP client API for REXX calls.
'create': Requests the creation of a new FTP client API stem. The string literal is not case sensitive.
trace_id: The identifier to be used in trace records. The ID is a 3-character ID string that is written as the first three characters of each trace record. If not specified, then three blank characters (' ') are used. The string literal is case sensitive.
traceSClass: The SYSOUT class for the trace. Valid values are in the range A – Z and 0 – 9. The default value is A. The string literal is case sensitive.
traceNum: The number of trace records written to the REXX trace file before the file is closed and then reopened. This value can be any decimal value in the range 1 – 1 000 000. The default is 1 000 000 records.

Results

Table 1. FTP client CREATE request return codes
Value	Return codes	Explanation
<0		The call did not complete successfully. The FTP client API stem variable was not created. 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)	An error occurred in creating the stem variable.
	-19 (FCAI_RESULT_REXXERROR)	An error occurred when storing, fetching, or dropping a REXX variable.
≥0		The call completed successfully. The FTP client API stem variable was successfully created.
	0 (FCAI_RESULT_OK)	No additional information is available.

Examples

rc = ftpapi('fcai.', 'create', 'PAZ')