CURLOPT_DEBUGDATA.3 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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_DEBUGDATA 3 "17 Jun 2014" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_DEBUGDATA \- pointer passed to the debug callback
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DEBUGDATA, void *pointer);
  32. .fi
  33. .SH DESCRIPTION
  34. Pass a \fIpointer\fP to whatever you want passed in to your
  35. \fICURLOPT_DEBUGFUNCTION(3)\fP in the last void * argument. This pointer is
  36. not used by libcurl, it is only passed to the callback.
  37. .SH DEFAULT
  38. NULL
  39. .SH PROTOCOLS
  40. All
  41. .SH EXAMPLE
  42. .nf
  43. int main(void)
  44. {
  45. CURL *curl;
  46. CURLcode res;
  47. struct data my_tracedata;
  48. curl = curl_easy_init();
  49. if(curl) {
  50. curl_easy_setopt(curl, CURLOPT_DEBUGFUNCTION, my_trace);
  51. curl_easy_setopt(curl, CURLOPT_DEBUGDATA, &my_tracedata);
  52. /* the DEBUGFUNCTION has no effect until we enable VERBOSE */
  53. curl_easy_setopt(curl, CURLOPT_VERBOSE, 1L);
  54. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  55. res = curl_easy_perform(curl);
  56. /* always cleanup */
  57. curl_easy_cleanup(curl);
  58. }
  59. return 0;
  60. }
  61. .fi
  62. .SH AVAILABILITY
  63. Always
  64. .SH RETURN VALUE
  65. Returns CURLE_OK
  66. .SH "SEE ALSO"
  67. .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "