FtpAccess.html 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
  2. <html>
  3. <head>
  4. <title>FtpAccess</title>
  5. <link rel="stylesheet" type="text/css" href="doc.css">
  6. </head>
  7. <body>
  8. <h1>FtpAccess</h1>
  9. <p>Open a file or directory on the remote system.</p>
  10. <h2>SYNOPSIS</h2>
  11. <pre>
  12. #include &lt;ftplib.h&gt;
  13. int FtpAccess(const char *path, int typ, int mode, netbuf *nControl,
  14. netbuf **nData);
  15. </pre>
  16. <h2>PARAMETERS</h2>
  17. <dl>
  18. <dt><b>path</b></dt>
  19. <dd>Specifies the name of the remote file or directory to
  20. open.</dd>
  21. <dt><b>typ</b></dt>
  22. <dd>Specifies the type of transfer to be performed. FTPLIB_DIR
  23. performs a terse directory. FTPLIB_DIR_VERBOSE performs a verbose
  24. directory. FTPLIB_FILE_READ opens a remote file for reading.
  25. FTPLIB_FILE_WRITE creates a remote file and readies it for
  26. writing.</dd>
  27. <dt><b>mode</b></dt>
  28. <dd>Specifies the transfer mode as FTPLIB_ASCII or
  29. FTPLIB_IMAGE.</dd>
  30. <dt><b>nControl</b></dt>
  31. <dd>A handle returned by <a href="FtpConnect.html">FtpConnect()</a>.</dd>
  32. <dt><b>nData</b></dt>
  33. <dd>Specifies the address to store a pointer to the created data
  34. handle.</dd>
  35. </dl>
  36. <h2>DESCRIPTION</h2>
  37. <p>FtpAccess() opens a remote file or directory and returns a
  38. handle for the calling program to use to transfer data.</p>
  39. <h2>RETURN VALUE</h2>
  40. <p>Returns 1 if successful or 0 on error.</p>
  41. </body>
  42. </html>