FtpDir.html 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
  2. <html>
  3. <head>
  4. <title>FtpDir</title>
  5. <link rel="stylesheet" type="text/css" href="doc.css">
  6. </head>
  7. <body>
  8. <h1>FtpDir</h1>
  9. <p>Retrieves a verbose directory listing.</p>
  10. <h2>SYNOPSIS</h2>
  11. <pre>
  12. #include &lt;ftplib.h&gt;
  13. int FtpDir(const char *outputfile, const char *path, netbuf *nControl);
  14. </pre>
  15. <h2>PARAMETERS</h2>
  16. <dl>
  17. <dt><b>outputfile</b></dt>
  18. <dd>Name of a local file to receive the directory listing. If
  19. specified as NULL, the directory listing is written to stdout.</dd>
  20. <dt><b>path</b></dt>
  21. <dd>File specification to pass to remote 'ls'.</dd>
  22. <dt><b>nControl</b></dt>
  23. <dd>A handle returned by <a href=
  24. "FtpConnect.html">FtpConnect()</a>.</dd>
  25. </dl>
  26. <h2>DESCRIPTION</h2>
  27. <p>Sends a LIST command to the server with the specified path. The
  28. response to this is usually a long format directory listing which
  29. will be written to the file named in outputfile. If outputfile is
  30. specified as NULL, the list will be written to stdout.</p>
  31. <p>The format of the listing is dependent on the type of the remote
  32. system. The system type can be determined from
  33. <a href="FtpSysType.html">FtpSysType()</a>.</p>
  34. <h2>RETURN VALUE</h2>
  35. <p>Returns 1 if successful or 0 on error.</p>
  36. </body>
  37. </html>