CURLOPT_TRAILERDATA.3 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  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_TRAILERDATA 3 "14 Aug 2018" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_TRAILERDATA \- pointer passed to trailing headers callback
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TRAILERDATA, void *userdata);
  32. .fi
  33. .SH DESCRIPTION
  34. Data pointer to be passed to the HTTP trailer callback function.
  35. .SH DEFAULT
  36. NULL
  37. .SH PROTOCOLS
  38. HTTP
  39. .SH EXAMPLE
  40. .nf
  41. /* Assuming we have a CURL handle in the hndl variable. */
  42. struct MyData data;
  43. curl_easy_setopt(hndl, CURLOPT_TRAILERDATA, &data);
  44. .fi
  45. A more complete example can be found in examples/http_trailers.html
  46. .SH AVAILABILITY
  47. This option was added in curl 7.64.0 and is present if HTTP support is enabled
  48. .SH RETURN VALUE
  49. Returns CURLE_OK.
  50. .SH "SEE ALSO"
  51. .BR CURLOPT_TRAILERFUNCTION "(3), "