cls.ftp_service.readftpfile.htm

FTP Services for Visual Foxpro

    <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">

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_Resume</span></span>
</td><td>Resume mode</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="#_26715XXQJ">lcData</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="#_26715XXQJ">lcData</a> is string.</td></tr>
 <tr><td><span class="PDMEXPR PDMNor" ><span class='PDMVar'>_FTPS_RWF_Rewrite</span></span>
</td><td>Rewrite mode</td></tr>
</table>

    </span>
   </dd>
   <dt class="dt_">
    <a class="DIAMP_PDM_AB_Params_ParaName" id="_26715XXQO" name="_26715XXQO">
     <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/Array</td>
      </tr>
      <tr>
       <td class="CellValue">Direction</td>
       <td class="CellData">Input</td>
      </tr>
     </tbody>
    </table>
    <span class="Params_Detail">

The value can be single number value of array number values.

If You use single value, then passed value is equal to <span class="PDMEXPR PDMNor" ><span class='PDMVar'>dwFlags</span></span>
 parameter of API function.
Value is combined with <a class="PDM_AB_See" href="../../code/ftp.prg/cls.ftp_service.ncachingtype.htm" title="Skip to property FTP_SERVICE::nCachingType">FTP_SERVICE::nCachingType</a>'s value.
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>.
<p />
If you use array of numbers, then first value (<span class="PDMEXPR PDMNor" ><span class='PDMVar'>_FTPS_FA_Default</span></span>
) is equal to <span class="PDMEXPR PDMNor" ><span class='PDMVar'>dwFlags</span></span>
 parameter of API function.
 Second value (<span class="PDMEXPR PDMNor" ><span class='PDMVar'>_FTPS_FA_ModeFile</span></span>
) is controling flag . 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'>_FTPS_FA_MF_Error</span></span>
</td><td>Cause error if local file doesn't exist.</td></tr>
 <tr><td><span class="PDMEXPR PDMNor" ><span class='PDMVar'>_FTPS_FA_MF_Append</span></span>
</td><td>Create new local file and add empty place.</td></tr>
 <tr><td><span class="PDMEXPR PDMNor" ><span class='PDMVar'>_FTPS_FA_MF_New</span></span>
</td><td>Create new file.</td></tr>
</table>
The value is ignore then you don't use <span class="PDMEXPR PDMNor" ><span class='PDMVar'>_FTPS_RWF_Resume</span></span>
.

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

 <div class="DIAMP_PDM_AB_RetVal"><!-- Returns Begin -->
  <div>
   <span class="PDM_AB_Head">
    <a id="_26715XXQH" name="_26715XXQH">
     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 file is downloaded or <span class="PDMEXPR PDMNor" ><span class='PDMLit'>.F.</span></span>
 is not.
  </div>
 </div><!-- Returns 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='PDMOper'>,</span><span class='PDMVar'>lcPom</span>
<span class='PDMResK'>LOCAL</span> <span class='PDMResK'>ARRAY</span> <span class='PDMVar'>laFlags</span><span class='PDMOper'>(</span><span class='PDMVar'>_FTPS_FA_MaxSize</span><span class='PDMOper'>)</span>
<span class='PDMOper'>#</span><span class='PDMResK'>INCLUDE</span> <span class='PDMStr'>"ftp.h"</span>
<span class='PDMVar'>laFlags</span><span class='PDMOper'>(</span><span class='PDMVar'>_FTPS_FA_Default</span><span class='PDMOper'>)</span><span class='PDMOper'>=</span><span class='PDMVar'>FTP_TRANSFER_TYPE_BINARY</span>