FtpGet.html 974 B

12345678910111213141516171819202122232425262728293031323334
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
  2. <html>
  3. <head>
  4. <title>FtpGet</title>
  5. <link rel="stylesheet" type="text/css" href="doc.css">
  6. </head>
  7. <body>
  8. <h1>FtpGet</h1>
  9. <p>Retreive a file from the remote system.</p>
  10. <h2>SYNOPSIS</h2>
  11. <pre>
  12. #include &lt;ftplib.h&gt;
  13. int FtpGet(const char *output, const char *path, char mode, netbuf *nControl);
  14. </pre>
  15. <h2>PARAMETERS</h2>
  16. <dl>
  17. <dt><b>output</b></dt>
  18. <dd>Name of a local file to receive the contents of the remote
  19. file. If specified as NULL file data will be written to stdout.</dd>
  20. <dt><b>path</b></dt>
  21. <dd>Name of remote file to be retrieved.</dd>
  22. <dt><b>mode</b></dt>
  23. <dd>Specifies the transfer mode as FTPLIB_ASCII or
  24. FTPLIB_IMAGE.</dd>
  25. <dt><b>nControl</b></dt>
  26. <dd>A handle returned by <a href="FtpConnect.html">FtpConnect()</a>.</dd>
  27. </dl>
  28. <h2>DESCRIPTION</h2>
  29. <p>FtpGet() copies the contents of a remote file to a local
  30. file.</p>
  31. <h2>RETURN VALUE</h2>
  32. <p>Returns 1 if successful or 0 on error.</p>
  33. </body>
  34. </html>