CURLOPT_POSTFIELDSIZE_LARGE.3 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  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_POSTFIELDSIZE_LARGE 3 "17 Jun 2014" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_POSTFIELDSIZE_LARGE \- size of POST data pointed to
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_POSTFIELDSIZE_LARGE,
  32. curl_off_t size);
  33. .SH DESCRIPTION
  34. If you want to post static data to the server without having libcurl do a
  35. strlen() to measure the data size, this option must be used. When this option
  36. is used you can post fully binary data, which otherwise is likely to fail. If
  37. this size is set to -1, the library will use strlen() to get the size or rely
  38. on the \fICURLOPT_READFUNCTION\fP (if used) to signal the end of data.
  39. .SH DEFAULT
  40. -1
  41. .SH PROTOCOLS
  42. HTTP(S)
  43. .SH EXAMPLE
  44. .nf
  45. CURL *curl = curl_easy_init();
  46. if(curl) {
  47. const char *data = large_chunk;
  48. curl_off_t length_of_data; /* set somehow */
  49. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  50. /* size of the POST data */
  51. curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE_LARGE, length_of_data);
  52. curl_easy_setopt(curl, CURLOPT_POSTFIELDS, data);
  53. curl_easy_perform(curl);
  54. }
  55. .fi
  56. .SH AVAILABILITY
  57. Along with HTTP
  58. .SH RETURN VALUE
  59. Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
  60. .SH "SEE ALSO"
  61. .BR CURLOPT_POSTFIELDS "(3), " CURLOPT_COPYPOSTFIELDS "(3), "
  62. .BR CURLOPT_POSTFIELDSIZE "(3), "