<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = 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 => 'zh',
  ),
  'this' => 
  array (
    0 => 'function.ftp-nlist.php',
    1 => 'ftp_nlist',
    2 => '返回给定目录的文件列表',
  ),
  'up' => 
  array (
    0 => 'ref.ftp.php',
    1 => 'FTP 函数',
  ),
  'prev' => 
  array (
    0 => 'function.ftp-nb-put.php',
    1 => 'ftp_nb_put',
  ),
  'next' => 
  array (
    0 => 'function.ftp-pasv.php',
    1 => 'ftp_pasv',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/ftp/functions/ftp-nlist.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.ftp-nlist" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ftp_nlist</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">ftp_nlist</span> &mdash; <span class="dc-title">返回给定目录的文件列表</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.ftp-nlist-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>ftp_nlist</strong></span>(<span class="methodparam"><span class="type"><a href="class.ftp-connection.php" class="type FTP\Connection">FTP\Connection</a></span> <code class="parameter">$ftp</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$directory</code></span>): <span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

 </div>

 <div class="refsect1 parameters" id="refsect1-function.ftp-nlist-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">ftp</code></dt>
     <dd>
       <p class="para"><span class="classname"><a href="class.ftp-connection.php" class="classname">FTP\Connection</a></span> 实例。</p>
     </dd>
    
    
     <dt><code class="parameter">directory</code></dt>
     <dd>
      <p class="para">
       指定要列表的目录。本参数接受带参数的形式，例如：<code class="literal">ftp_nlist($ftp,
       &quot;-la /your/dir&quot;);</code>；注意此参数不对传入值做处理，在目录或者文件名包括空格或特殊的情况下，可能会存在问题。
       </p>
      </dd>
     
    </dl>
   </p>
  </div>

  <div class="refsect1 returnvalues" id="refsect1-function.ftp-nlist-returnvalues">
  <h3 class="title">返回值</h3>
    <p class="para">
     如果成功则返回给定目录下的文件名组成的数组，否则返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>。
    </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.ftp-nlist-changelog">
  <h3 class="title">更新日志</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>版本</th>
      <th>说明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.1.0</td>
 <td>
  现在 <code class="parameter">ftp</code> 参数接受 <span class="classname"><a href="class.ftp-connection.php" class="classname">FTP\Connection</a></span>
  实例，之前接受 <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>。
 </td>
</tr>

    </tbody>
   
  </table>

 </div>

 
 <div class="refsect1 examples" id="refsect1-function.ftp-nlist-examples">
   <h3 class="title">示例</h3>
   <p class="para">
    <div class="example" id="example-1">
     <p><strong>示例 #1 <span class="function"><strong>ftp_nlist()</strong></span> 示例</strong></p>
     <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">// set up basic connection<br /></span><span style="color: #0000BB">$ftp </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 /></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">$ftp</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">// check connection<br /></span><span style="color: #007700">if ((!</span><span style="color: #0000BB">$ftp</span><span style="color: #007700">) || (!</span><span style="color: #0000BB">$login_result</span><span style="color: #007700">)) {<br />    die(</span><span style="color: #DD0000">"FTP connection has failed !"</span><span style="color: #007700">);<br />}<br /> <br /></span><span style="color: #FF8000">// get contents of the root 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">$ftp</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">?&gt;</span></span></code></div>
     </div>

     <div class="example-contents"><p>以上示例的输出类似于：</p></div>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">array(3) {
  [0]=&gt;
  string(11) &quot;public_html&quot;
  [1]=&gt;
  string(10) &quot;public_ftp&quot;
  [2]=&gt;
  string(3) &quot;www&quot;</pre>
</div>
    </div>
   </div>
  </p>
 </div>

 <div class="refsect1 seealso" id="refsect1-function.ftp-nlist-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.ftp-rawlist.php" class="function" rel="rdfs-seeAlso">ftp_rawlist()</a> - 返回指定目录下文件的详细列表</span></li>
    <li><span class="function"><a href="function.ftp-mlsd.php" class="function" rel="rdfs-seeAlso">ftp_mlsd()</a> - 返回指定目录中的文件列表</span></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>