TERM request

Format


>>-ftpapi--(--stem--,--'term'--)-------------------------------><

The user program issues the TERM request to terminate this instance of interface use. A TERM request is accepted by the interface at any time.

Rule: Each successful invocation of INIT should be terminated with a corresponding invocation of TERM.

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.
'term': Requests the termination of this instance of the FTP interface. The string literal is not case sensitive.

Table 1. FTP client TERM 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 when 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)	No additional information is provided.

rc = ftpapi('fcai.', 'term')