FTP_SET_OPTION(3) 1 FTP_SET_OPTION(3)
ftp_set_option - Set miscellaneous runtime FTP options
SYNOPSIS
bool ftp_set_option (resource $ftp_stream, int $option, mixed $value)
DESCRIPTION
This function controls various runtime options for the specified FTP stream.
PARAMETERS
o $ftp_stream
- The link identifier of the FTP connection.
o $option
- Currently, the following options are supported:
Supported runtime FTP options
+----------------+---------------------------------------------------+
| | |
|FTP_TIMEOUT_SEC | |
| | |
| | Changes the timeout in seconds used for all net- |
| | work 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. |
| | |
+----------------+---------------------------------------------------+
o $value
- This parameter depends on which $option is chosen to be altered.
RETURN VALUES
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.
EXAMPLES
Example #1
ftp_set_option(3) example
<?php
// Set the network timeout to 10 seconds
ftp_set_option($conn_id, FTP_TIMEOUT_SEC, 10);
?>
SEE ALSO
ftp_get_option(3).
PHP Documentation Group FTP_SET_OPTION(3)