<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Set miscellaneous runtime FTP options</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ftp-rmdir.html">ftp_rmdir</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-site.html">ftp_site</a></div>
<div class="up"><a href="ref.ftp.html">FTP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ftp-set-option" class="refentry">
<div class="refnamediv">
<h1 class="refname">ftp_set_option</h1>
<p class="verinfo">(PHP 4 >= 4.2.0, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">ftp_set_option</span> — <span class="dc-title">Set miscellaneous runtime FTP options</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ftp-set-option-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ftp_set_option</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$ftp_stream</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$option</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>
)</div>
<p class="para rdfs-comment">
This function controls various runtime options for the specified FTP
stream.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ftp-set-option-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">ftp_stream</code></dt>
<dd>
<p class="para">
The link identifier of the FTP connection.
</p>
</dd>
<dt>
<code class="parameter">option</code></dt>
<dd>
<p class="para">
Currently, the following options are supported:
<table class="doctable table">
<caption><strong>Supported runtime FTP options</strong></caption>
<tbody class="tbody">
<tr>
<td><strong><code>FTP_TIMEOUT_SEC</code></strong></td>
<td>
Changes the timeout in seconds used for all network related
functions. <code class="parameter">value</code> must be an integer that
is greater than 0. The default timeout is 90 seconds.
</td>
</tr>
<tr>
<td><strong><code>FTP_AUTOSEEK</code></strong></td>
<td>
When enabled, GET or PUT requests with a
<code class="parameter">resumepos</code> or <code class="parameter">startpos</code>
parameter will first seek to the requested position within the file.
This is enabled by default.
</td>
</tr>
<tr>
<td><strong><code>FTP_USEPASVADDRESS</code></strong></td>
<td>
When disabled, PHP will ignore the IP address returned by the FTP server in response to the PASV command and instead use the IP address that was supplied in the ftp_connect().
<code class="parameter">value</code> must be a boolean.
</td>
</tr>
</tbody>
</table>
</p>
</dd>
<dt>
<code class="parameter">value</code></dt>
<dd>
<p class="para">
This parameter depends on which <code class="parameter">option</code> is chosen
to be altered.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ftp-set-option-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> if the option could be set; <strong><code>FALSE</code></strong> if not. A warning
message will be thrown if the <code class="parameter">option</code> is not
supported or the passed <code class="parameter">value</code> doesn't match the
expected value for the given <code class="parameter">option</code>.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ftp-set-option-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5467">
<p><strong>Example #1 <span class="function"><strong>ftp_set_option()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Set the network timeout to 10 seconds<br /></span><span style="color: #0000BB">ftp_set_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">, </span><span style="color: #0000BB">FTP_TIMEOUT_SEC</span><span style="color: #007700">, </span><span style="color: #0000BB">10</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ftp-set-option-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.ftp-get-option.html" class="function" rel="rdfs-seeAlso">ftp_get_option()</a> - Retrieves various runtime behaviours of the current FTP stream</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ftp-rmdir.html">ftp_rmdir</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-site.html">ftp_site</a></div>
<div class="up"><a href="ref.ftp.html">FTP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
