CURLOPT_HEADERDATA.3 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  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 http://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_HEADERDATA 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_HEADERDATA \- pointer to pass to header callback
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HEADERDATA, void *pointer);
  29. .SH DESCRIPTION
  30. Pass a \fIpointer\fP to be used to write the header part of the received data
  31. to.
  32. If \fICURLOPT_WRITEFUNCTION(3)\fP or \fICURLOPT_HEADERFUNCTION(3)\fP is used,
  33. \fIpointer\fP will be passed in to the respective callback.
  34. If neither of those options are set, \fIpointer\fP must be a valid FILE * and
  35. it will be used by a plain fwrite() to write headers to.
  36. .SH DEFAULT
  37. NULL
  38. .SH PROTOCOLS
  39. All
  40. .SH EXAMPLE
  41. TODO
  42. .SH AVAILABILITY
  43. Always
  44. .SH RETURN VALUE
  45. Returns CURLE_OK
  46. .SH "SEE ALSO"
  47. .BR CURLOPT_HEADERFUNCTION "(3), " CURLOPT_WRITEFUNCTION "(3), "