FtpRead.html 993 B

12345678910111213141516171819202122232425262728293031323334
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
  2. <html>
  3. <head>
  4. <title>FtpRead</title>
  5. <link rel="stylesheet" type="text/css" href="doc.css">
  6. </head>
  7. <body>
  8. <h1>FtpRead</h1>
  9. <p>Read data from a remote file or directory.</p>
  10. <h2>SYNOPSIS</h2>
  11. <pre>
  12. #include &lt;ftplib.h&gt;
  13. int FtpRead(void *buf, int max, netbuf *nData);
  14. </pre>
  15. <h2>PARAMETERS</h2>
  16. <dl>
  17. <dt><b>buf</b></dt>
  18. <dd>Specifies the address of a buffer where received data will be
  19. written.</dd>
  20. <dt><b>max</b></dt>
  21. <dd>Specifies the size of the user's buffer.</dd>
  22. <dt><b>nData</b></dt>
  23. <dd>A handle returned by <a href="FtpAccess.html">FtpAccess()</a>.</dd>
  24. </dl>
  25. <h2>DESCRIPTION</h2>
  26. <p>FtpRead copies up to max bytes of data from the specified data
  27. connection and returns it to the user's buffer. If the data
  28. connection was opened in ascii mode, no more than one line of data
  29. will be returned.</p>
  30. <h2>RETURN VALUE</h2>
  31. <p>Returns the number of bytes written to the user's buffer or -1
  32. on error or end of file.</p>
  33. </body>
  34. </html>