Source of: /manual/en/function.ftp-get-option.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ftp.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.ftp-get-option.php',
1 => 'ftp_get_option',
),
'up' =>
array (
0 => 'ref.ftp.php',
1 => 'FTP Functions',
),
'prev' =>
array (
0 => 'function.ftp-fput.php',
1 => 'ftp_fput',
),
'next' =>
array (
0 => 'function.ftp-get.php',
1 => 'ftp_get',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<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>
<a name="function.ftp-get-option.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><b>ftp_get_option</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$ftp_stream</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$option</tt></span>
)</div>
<p class="para rdfs-comment">
This function returns the value for the requested
<i><tt class="parameter">option</tt></i>
from the specified FTP connection.
</p>
</div>
<a name="function.ftp-get-option.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">ftp_stream</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The link identifier of the FTP connection.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">option</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Currently, the following options are supported:
</p><table class="doctable table">
<caption><b>Supported runtime FTP options</b></caption>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left"><b><tt class="constant">FTP_TIMEOUT_SEC</tt></b></td>
<td align="left">
Returns the current timeout used for network related operations.
</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">FTP_AUTOSEEK</tt></b></td>
<td align="left">
Returns <b><tt class="constant">TRUE</tt></b> if this option is on, <b><tt class="constant">FALSE</tt></b> otherwise.
</td>
</tr>
</tbody>
</table>
<p>
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.ftp-get-option.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the value on success or <b><tt class="constant">FALSE</tt></b> if the given
<i><tt class="parameter">option</tt></i>
is not supported. In the latter case, a
warning message is also thrown.
</p>
</div>
<a name="function.ftp-get-option.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>ftp_get_option()</b> example</b></p>
<div class="example-contents programlisting">
<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>
</p>
</div>
<a name="function.ftp-get-option.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.ftp-set-option.php" class="function" rel="rdfs-seeAlso">ftp_set_option()</a> - Set miscellaneous runtime FTP options</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
