FTP_GET_OPTION(3) 1 FTP_GET_OPTION(3)
ftp_get_option - Retrieves various runtime behaviours of the current FTP stream
SYNOPSIS
mixed ftp_get_option (resource $ftp_stream, int $option)
DESCRIPTION
This function returns the value for the requested $option from the specified FTP connection.
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 | |
| | |
| | Returns the current timeout used for network |
| | related operations. |
| | |
| | |
| FTP_AUTOSEEK | |
| | |
| | Returns TRUE if this option is on, FALSE other- |
| | wise. |
| | |
+----------------+---------------------------------------------------+
RETURN VALUES
Returns the value on success or FALSE if the given $option is not supported. In the latter case, a warning message is also thrown.
EXAMPLES
Example #1
ftp_get_option(3) example
<?php
// Get the timeout of the given FTP stream
$timeout = ftp_get_option($conn_id, FTP_TIMEOUT_SEC);
?>
SEE ALSO
ftp_set_option(3).
PHP Documentation Group FTP_GET_OPTION(3)