CURLOPT_FTP_ACCOUNT.3 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
  9. .\" *
  10. .\" * This software is licensed as described in the file COPYING, which
  11. .\" * you should have received as part of this distribution. The terms
  12. .\" * are also available at https://curl.se/docs/copyright.html.
  13. .\" *
  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15. .\" * copies of the Software, and permit persons to whom the Software is
  16. .\" * furnished to do so, under the terms of the COPYING file.
  17. .\" *
  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19. .\" * KIND, either express or implied.
  20. .\" *
  21. .\" * SPDX-License-Identifier: curl
  22. .\" *
  23. .\" **************************************************************************
  24. .\"
  25. .TH CURLOPT_FTP_ACCOUNT 3 "January 02, 2023" "libcurl 7.88.1" "curl_easy_setopt options"
  26. .SH NAME
  27. CURLOPT_FTP_ACCOUNT \- account info for FTP
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_ACCOUNT, char *account);
  32. .fi
  33. .SH DESCRIPTION
  34. Pass a pointer to a null-terminated string (or NULL to disable). When an FTP
  35. server asks for "account data" after user name and password has been provided,
  36. this data is sent off using the ACCT command.
  37. The application does not have to keep the string around after setting this
  38. option.
  39. .SH DEFAULT
  40. NULL
  41. .SH PROTOCOLS
  42. FTP
  43. .SH EXAMPLE
  44. .nf
  45. CURL *curl = curl_easy_init();
  46. if(curl) {
  47. curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/foo.bin");
  48. curl_easy_setopt(curl, CURLOPT_FTP_ACCOUNT, "human-resources");
  49. ret = curl_easy_perform(curl);
  50. curl_easy_cleanup(curl);
  51. }
  52. .fi
  53. .SH AVAILABILITY
  54. Added in 7.13.0
  55. .SH RETURN VALUE
  56. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  57. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  58. .SH "SEE ALSO"
  59. .BR CURLOPT_USERNAME "(3), " CURLOPT_PASSWORD "(3), "