CURLOPT_UPLOAD.3 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2014, 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.haxx.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. .\" **************************************************************************
  22. .\"
  23. .TH CURLOPT_UPLOAD 3 "April 17, 2018" "libcurl 7.61.1" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_UPLOAD \- enable data upload
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_UPLOAD, long upload);
  29. .SH DESCRIPTION
  30. The long parameter \fIupload\fP set to 1 tells the library to prepare for and
  31. perform an upload. The \fICURLOPT_READDATA(3)\fP and
  32. \fICURLOPT_INFILESIZE(3)\fP or \fICURLOPT_INFILESIZE_LARGE(3)\fP options are
  33. also interesting for uploads. If the protocol is HTTP, uploading means using
  34. the PUT request unless you tell libcurl otherwise.
  35. Using PUT with HTTP 1.1 implies the use of a "Expect: 100-continue" header.
  36. You can disable this header with \fICURLOPT_HTTPHEADER(3)\fP as usual.
  37. If you use PUT to an HTTP 1.1 server, you can upload data without knowing the
  38. size before starting the transfer if you use chunked encoding. You enable this
  39. by adding a header like "Transfer-Encoding: chunked" with
  40. \fICURLOPT_HTTPHEADER(3)\fP. With HTTP 1.0 or without chunked transfer, you
  41. must specify the size.
  42. .SH DEFAULT
  43. 0, default is download
  44. .SH PROTOCOLS
  45. Most
  46. .SH EXAMPLE
  47. .nf
  48. CURL *curl = curl_easy_init();
  49. if(curl) {
  50. /* we want to use our own read function */
  51. curl_easy_setopt(curl, CURLOPT_READFUNCTION, read_callback);
  52. /* enable uploading */
  53. curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);
  54. /* specify target */
  55. curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/dir/to/newfile");
  56. /* now specify which pointer to pass to our callback */
  57. curl_easy_setopt(curl, CURLOPT_READDATA, hd_src);
  58. /* Set the size of the file to upload */
  59. curl_easy_setopt(curl, CURLOPT_INFILESIZE_LARGE, (curl_off_t)fsize);
  60. /* Now run off and do what you've been told! */
  61. curl_easy_perform(curl);
  62. }
  63. .fi
  64. .SH AVAILABILITY
  65. Always
  66. .SH RETURN VALUE
  67. Returns CURLE_OK
  68. .SH "SEE ALSO"
  69. .BR CURLOPT_PUT "(3), " CURLOPT_READFUNCTION "(3), "
  70. .BR CURLOPT_INFILESIZE_LARGE "(3), "