<!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>Returns the size of the given file</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ftp-site.html">ftp_site</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-ssl-connect.html">ftp_ssl_connect</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-size" class="refentry">
<div class="refnamediv">
<h1 class="refname">ftp_size</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">ftp_size</span> — <span class="dc-title">Returns the size of the given file</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ftp-size-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>ftp_size</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$ftp_stream</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$remote_file</code></span>
)</div>
<p class="para rdfs-comment">
<span class="function"><strong>ftp_size()</strong></span> returns the size of the given file in
bytes.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
Not all servers support this feature.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-function.ftp-size-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">remote_file</code></em></span>
<dd>
<p class="para">
The remote file.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ftp-size-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the file size on success, or -1 on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ftp-size-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4307">
<p><strong>Example #1 <span class="function"><strong>ftp_size()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$file </span><span style="color: #007700">= </span><span style="color: #DD0000">'somefile.txt'</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// set up basic connection<br /></span><span style="color: #0000BB">$conn_id </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$ftp_server</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// login with username and password<br /></span><span style="color: #0000BB">$login_result </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_login</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">, </span><span style="color: #0000BB">$ftp_user_name</span><span style="color: #007700">, </span><span style="color: #0000BB">$ftp_user_pass</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// get the size of $file<br /></span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_size</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">, </span><span style="color: #0000BB">$file</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$res </span><span style="color: #007700">!= -</span><span style="color: #0000BB">1</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"size of </span><span style="color: #0000BB">$file</span><span style="color: #DD0000"> is </span><span style="color: #0000BB">$res</span><span style="color: #DD0000"> bytes"</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">"couldn't get the size"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">// close the connection<br /></span><span style="color: #0000BB">ftp_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ftp-size-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ftp-rawlist.html" class="function" rel="rdfs-seeAlso">ftp_rawlist()</a> - Returns a detailed list of files in the given directory</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-site.html">ftp_site</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-ssl-connect.html">ftp_ssl_connect</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>
