FtpRename.html 807 B

123456789101112131415161718192021222324252627282930
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
  2. <html>
  3. <head>
  4. <title>FtpRename</title>
  5. <link rel="stylesheet" type="text/css" href="doc.css">
  6. </head>
  7. <body>
  8. <h1>FtpRename</h1>
  9. <p>Rename a remote file.</p>
  10. <h2>SYNOPSIS</h2>
  11. <pre>
  12. #include &lt;ftplib.h&gt;
  13. int FtpRename(const char *src, const char *dst, netbuf *nControl);
  14. </pre>
  15. <h2>PARAMETERS</h2>
  16. <dl>
  17. <dt><b>src</b></dt>
  18. <dd>A string containing the current name of the remote file.</dd>
  19. <dt><b>dst</b></dt>
  20. <dd>A string containing the desired new name for the remote
  21. file.</dd>
  22. <dt><b>nControl</b></dt>
  23. <dd>A handle returned by <a href="FtpConnect.html">FtpConnect()</a>.</dd>
  24. </dl>
  25. <h2>DESCRIPTION</h2>
  26. <p>FtpRename() sends a rename request to the remote server.</p>
  27. <h2>RETURN VALUE</h2>
  28. <p>Returns 1 if successful or 0 on error.</p>
  29. </body>
  30. </html>