Home > PHP > Function > FTP > ftp_set_option()

ftp_set_option()

ftp_set_option - Set miscellaneous runtime FTP options

Syntax

bool ftp_set_option (resource $ftp_stream, int $option, mixed $value)

Arguments

  • ftp_stream - The link identifier of the FTP connection.
  • option - Currently, the following options are supported: Supported runtime FTP options FTP_TIMEOUT_SEC Changes the timeout in seconds used for all network related functions. value must be an integer that is greater than 0. The default timeout is 90 seconds. FTP_AUTOSEEK When enabled, GET or PUT requests with a resumepos or startpos parameter will first seek to the requested position within the file. This is enabled by default.
  • value - This parameter depends on which option is chosen to be altered.

Description

This function controls various runtime options for the specified FTP stream.

Version

PHP 4.2.0, 5

Return value

Returns TRUE if the option could be set; FALSE if not. A warning message will be thrown if the option is not supported or the passed value doesn't match the expected value for the given option.