<!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 a list of files in the given directory</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ftp-nb-put.html">ftp_nb_put</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-pasv.html">ftp_pasv</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-nlist" class="refentry">
<div class="refnamediv">
<h1 class="refname">ftp_nlist</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">ftp_nlist</span> — <span class="dc-title">Returns a list of files in the given directory</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ftp-nlist-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>ftp_nlist</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">$directory</code></span>
)</div>
</div>
<div class="refsect1 parameters" id="refsect1-function.ftp-nlist-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">directory</code></em></span>
<dd>
<p class="para">
The directory to be listed. This parameter can also include arguments, eg.
ftp_nlist($conn_id, "-la /your/dir");
Note that this parameter isn't escaped so there may be some issues with
filenames containing spaces and other characters.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ftp-nlist-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array of filenames from the specified directory on success or
<strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ftp-nlist-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4297">
<p><strong>Example #1 <span class="function"><strong>ftp_nlist()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<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 contents of the current directory<br /></span><span style="color: #0000BB">$contents </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_nlist</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn_id</span><span style="color: #007700">, </span><span style="color: #DD0000">"."</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// output $contents<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$contents</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(3) {
[0]=>
string(11) "public_html"
[1]=>
string(10) "public_ftp"
[2]=>
string(3) "www"
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ftp-nlist-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-nb-put.html">ftp_nb_put</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-pasv.html">ftp_pasv</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>
