SET_REQUEST_TIMER request

Format


>>-ftpapi--(--stem--,--'set_request_timer'--,--reqtimer--)-----><

Sets the length of time that the FTP client API waits for an INIT, SCMD, or TERM request to complete.

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.
'set_request_timer': Requests that the request timer be set for subsequent INIT, SCMD, or TERM requests. The string literal is not case sensitive.
reqtimer: The number of seconds to wait for the request to complete. Valid values are in the range 0 – 256. The value corresponds to the FCAI_ReqTimer field used by the C and callable FTP client APIs.

Table 1. FTP client SET_REQUEST_TIMER 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.
	-17 (FCAI_RESULT_UNUSABLESTEM)	The stem variable is not usable.
	-19 (FCAI_RESULT_REXXERROR)	An error occurred when storing, fetching, or dropping a REXX variable.
≥0		The call completed successfully.
	0 (FCAI_RESULT_OK)	No additional information is provided.

rc = ftpapi('fcai.', 'set_request_timer', 1)