cls.ftp_service.nlst.htm

FTP Services for Visual Foxpro

    </span>
    <table class="Params_Info">
     <colgroup>
      <col class="ColumnValue" />
      <col class="ColumnData" />
     </colgroup>
     <tbody>
      <tr>
       <td class="CellValue">Type</td>
       <td class="CellData">Boolean</td>
      </tr>
      <tr>
       <td class="CellValue">Direction</td>
       <td class="CellData">Input</td>
      </tr>
      <tr>
       <td class="CellValue">Optional</td>
      <td class="CellData">&nbsp;</td>
      </tr>
     </tbody>
    </table>
    <span class="Params_Detail">

This parameter define type of first parameter <a class="DIAMP_PDM_AB_Para_Link" href="#_26715Y6QJ">luData</a>.
List of <a class="PDM_AB_See" href="../../others/ftp.h/main.htm" title="Skip to file types">types</a>
<table class="listvalues">
 <tr class="Head"><td>Value</td><td>Description</td></tr>
 <tr><td><span class="PDMEXPR PDMNor" ><span class='PDMVar'>_FTPS_RWF_File</span></span>
</td><td><a class="DIAMP_PDM_AB_Para_Link" href="#_26715Y6QJ">luData</a> is file name.</td></tr>
 <tr><td><span class="PDMEXPR PDMNor" ><span class='PDMVar'>_FTPS_RWF_String</span></span>
</td><td><a class="DIAMP_PDM_AB_Para_Link" href="#_26715Y6QJ">luData</a> is string.</td></tr>
 <tr><td><span class="PDMEXPR PDMNor" ><span class='PDMVar'>_FTPS_RWF_Array</span></span>
</td><td><a class="DIAMP_PDM_AB_Para_Link" href="#_26715Y6QJ">luData</a> is array.</td></tr>
</table>

    </span>
   </dd>
   <dt class="dt_">
    <a class="DIAMP_PDM_AB_Params_ParaName" id="_26715Y6QM" name="_26715Y6QM">
     <span class="PDMEXPR PDMNor" ><span class='PDMVar'>lnFlag</span></span>

    </a>
   </dt>
   <dd class="dd_">
    <span class="Params_Short">
     The flags that indicate various options.
    </span>
    <table class="Params_Info">
     <colgroup>
      <col class="ColumnValue" />
      <col class="ColumnData" />
     </colgroup>
     <tbody>
      <tr>
       <td class="CellValue">Type</td>
       <td class="CellData">Numeric</td>
      </tr>
      <tr>
       <td class="CellValue">Direction</td>
       <td class="CellData">Input</td>
      </tr>
      <tr>
       <td class="CellValue">Optional</td>
      <td class="CellData">&nbsp;</td>
      </tr>
     </tbody>
    </table>
    <span class="Params_Detail">

A passed value is equal to <span class="PDMEXPR PDMNor" ><span class='PDMVar'>dwFlags</span></span>
 parameter of API function.
If this parameter ommited, then default value is <span class="PDMEXPR PDMNor" ><span class='PDMVar'>FTP_TRANSFER_TYPE_UNKNOWN</span></span>
.
Can be one of the following:
<table class="listvalues">
 <tr class="Head"><td>Value</td><td>Description</td></tr>
 <tr><td><span class="PDMEXPR PDMNor" ><span class='PDMVar'>FTP_TRANSFER_TYPE_ASCII</span></span>
</td><td>Transfers the file as ASCII.</td></tr>
 <tr><td><span class="PDMEXPR PDMNor" ><span class='PDMVar'>FTP_TRANSFER_TYPE_BINARY</span></span>
</td><td>Transfers the file as binary.</td></tr>
</table>
Assumed from <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/wininet/wininet/ftpopenfile.asp">MSDN</a>.

    </span>
   </dd>
  </dl>
 </div><!-- Parameters End -->

 <div class="DIAMP_PDM_AB_RetVal"><!-- Returns Begin -->
  <div>
   <span class="PDM_AB_Head">
    <a id="_26715Y6QI" name="_26715Y6QI">
     Return value
    </a>
   </span> <span class="RetVal_Ttype">Boolean</span>
  </div>
  <div class="PDM_AB_Body">
The return value is <span class="PDMEXPR PDMNor" ><span class='PDMLit'>.T.</span></span>
 if list is downloaded or <span class="PDMEXPR PDMNor" ><span class='PDMLit'>.F.</span></span>
 is not.
  </div>
 </div><!-- Returns End -->

 <div class="PDM_AB_Remarks"><!-- Remarks Begin -->
  <span class="PDM_AB_Head">
   Remarks
  </span>
  <div class="PDM_AB_Body">


    <!-- Note -->

   <div class="PDM_AB_Note">
    <div class="Block_Picture" title="">
     Note
    </div>
    <div class="Block_Text">
 This method doesn't support  multioperations - <a class="PDM_AB_See" href="../../code/ftp.prg/cls.ftp_service.lmultioperations.htm" title="Skip to property FTP_SERVICE::lMultiOperations">FTP_SERVICE::lMultiOperations</a>.
    </div><!-- end of note text -->
    <div style="clear: both"></div>
   </div><!-- end of note -->


  </div>
 </div><!-- Remarks End -->

 <div class="PDM_AB_Example"><!-- Example Begin -->
  <span class="PDM_AB_Head">
   Example
  </span>
  <div class="PDM_AB_Body">

<!-- Code Begin -->
<pre class="PDMCODE PDMNor" >
<span class='PDMResK'>LOCAL</span> <span class='PDMVar'>loFTP</span>
<span class='PDMResK'>LOCAL</span> <span class='PDMResK'>ARRAY</span> <span class='PDMVar'>laFiles</span><span class='PDMOper'>(</span><span class='PDMLit'>1</span><span class='PDMOper'>)</span><span class='PDMOper'>,</span><span class='PDMVar'>laFile</span><span class='PDMOper'>(</span><span class='PDMLit'>1</span><span class='PDMOper'>)</span>

<span class='PDMOper'>#</span><span class='PDMResK'>INCLUDE</span> <span class='PDMStr'>"ftp.h"</span>
<span class='PDMResK'>SET</span> <span class='PDMResK'>PROCEDURE</span> <span class='PDMResK'>TO</span> <span class='PDMVar'>ftp</span><span class='PDMOper'>.</span><span class='PDMVar'>prg</span> <span class='PDMResK'>ADDITIVE</span> 
<span class='PDMVar'>loFTP</span><span class='PDMOper'>=</span><span class='PDMResF'>CREATEOBJECT</span><span class='PDMOper'>(</span><span class='PDMStr'>'_myftp'</span><span class='PDMOper'>)</span> 

<span class='PDMResK'>IF</span> <span class='PDMVar'>loFTP</span><span class='PDMOper'>.</span><span class='PDMVar'>OpenInternet</span><span class='PDMOper'>(</span><span class='PDMStr'>"anonymous"</span><span class='PDMOper'>,</span> <span class='PDMStr'>"[e-mail]"</span><span class='PDMOper'>,</span><span class='PDMStr'>"192.168.2.21"</span><span class='PDMOper'>,</span> <span class='PDMStr'>"21"</span><span class='PDMOper'>)</span>

<span class='PDMCom'>    * Get "Name list" and save it as file</span>
    <span class='PDMOper'>=</span><span class='PDMVar'>loFTP</span><span class='PDMOper'>.</span><span class='PDMVar'>NLST</span><span class='PDMOper'>(</span><span class='PDMStr'>"c:\nlstx.txt"</span><span class='PDMOper'>,</span><span class='PDMStr'>""</span><span class='PDMOper'>,</span><span class='PDMVar'>_FTPS_RWF_File</span><span class='PDMOper'>,</span><span class='PDMLit'>0</span><span class='PDMOper'>)</span>
    <span class='PDMResK'>MODI</span> <span class='PDMResK'>FILE</span> <span class='PDMStr'>"c:\nlst.txt"</span> <span class='PDMResK'>NOWAIT</span>


<span class='PDMCom'>    * Get "Name list" and return it as string</span>
    <span class='PDMOper'>=</span><span class='PDMVar'>loFTP</span><span class='PDMOper'>.</span><span class='PDMVar'>NLST</span><span class='PDMOper'>(</span><span class='PDMOper'>@</span><span class='PDMVar'>lcPom</span><span class='PDMOper'>,</span><span class='PDMStr'>""</span><span class='PDMOper'>,</span><span class='PDMVar'>_FTPS_RWF_String</span><span class='PDMOper'>,</span><span class='PDMLit'>0</span><span class='PDMOper'>)</span>
    <span class='PDMOper'>?</span><span class='PDMVar'>lcPom</span>


<span class='PDMCom'>    * Get "Name list" and save it to array</span>
    <span class='PDMOper'>?</span><span class='PDMVar'>loFTP</span><span class='PDMOper'>.</span><span class='PDMVar'>NLST</span><span class='PDMOper'>(</span><span class='PDMOper'>@</span><span class='PDMVar'>laFiles</span><span class='PDMOper'>,</span><span class='PDMStr'>"download"</span><span class='PDMOper'>,</span><span class='PDMVar'>_FTPS_RWF_Array</span><span class='PDMOper'>,</span><span class='PDMLit'>0</span><span class='PDMOper'>)</span>

<span class='PDMCom'>    * For each file get other informations</span>
    <span class='PDMResK'>FOR</span> <span class='PDMVar'>lii</span><span class='PDMOper'>=</span><span class='PDMLit'>1</span> <span class='PDMResK'>to</span> <span class='PDMResF'>ALEN</span><span class='PDMOper'>(</span><span class='PDMVar'>lafiles</span><span class='PDMOper'>)</span>
        <span class='PDMVar'>loFTP</span><span class='PDMOper'>.</span><span class='PDMVar'>GetFTPDirectoryArray</span><span class='PDMOper'>(</span><span class='PDMOper'>@</span><span class='PDMVar'>laFile</span><span class='PDMOper'>,</span> <span class='PDMVar'>laFiles</span><span class='PDMOper'>(</span><span class='PDMVar'>lii</span><span class='PDMOper'>)</span><span class='PDMOper'>,</span><span class='PDMLit'>0</span><span class='PDMOper'>)</span>
        <span class='PDMOper'>?</span>