<!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>Retrieves various runtime behaviours of the current FTP stream</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ftp-fput.html">ftp_fput</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-get.html">ftp_get</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-get-option" class="refentry">
<div class="refnamediv">
<h1 class="refname">ftp_get_option</h1>
<p class="verinfo">(PHP 4 >= 4.2.0, PHP 5)</p><p class="refpurpose"><span class="refname">ftp_get_option</span> — <span class="dc-title">Retrieves various runtime behaviours of the current FTP stream</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ftp-get-option-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>ftp_get_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>
)</div>
<p class="para rdfs-comment">
This function returns the value for the requested
<em><code class="parameter">option</code></em> from the specified FTP connection.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ftp-get-option-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">ftp_stream</code></em></span>
<dd>
<p class="para">
The link identifier of the FTP connection.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">option</code></em></span>
<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>
Returns the current timeout used for network related operations.
</td>
</tr>
<tr>
<td><strong><code>FTP_AUTOSEEK</code></strong></td>
<td>
Returns <strong><code>TRUE</code></strong> if this option is on, <strong><code>FALSE</code></strong> otherwise.
</td>
</tr>
</tbody>
</table>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ftp-get-option-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the value on success or <strong><code>FALSE</code></strong> if the given
<em><code class="parameter">option</code></em> is not supported. In the latter case, a
warning message is also thrown.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ftp-get-option-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4284">
<p><strong>Example #1 <span class="function"><strong>ftp_get_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">// Get the timeout of the given FTP stream<br /></span><span style="color: #0000BB">$timeout </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_get_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">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ftp-get-option-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ftp-set-option.html" class="function" rel="rdfs-seeAlso">ftp_set_option()</a> - Set miscellaneous runtime FTP options</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-fput.html">ftp_fput</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-get.html">ftp_get</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>
