CURLINFO_PRIVATE.3 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, 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. .\" **************************************************************************
  22. .\"
  23. .TH CURLINFO_PRIVATE 3 "1 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
  24. .SH NAME
  25. CURLINFO_PRIVATE \- get the private pointer
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRIVATE, char **private);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass a pointer to a char pointer to receive the pointer to the private data
  33. associated with the curl handle (set with the \fICURLOPT_PRIVATE(3)\fP).
  34. Please note that for internal reasons, the value is returned as a char
  35. pointer, although effectively being a 'void *'.
  36. .SH PROTOCOLS
  37. All
  38. .SH EXAMPLE
  39. .nf
  40. CURL *curl = curl_easy_init();
  41. if(curl) {
  42. void *pointer = 0x2345454;
  43. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
  44. /* set the private pointer */
  45. curl_easy_setopt(curl, CURLOPT_PRIVATE, pointer);
  46. ret = curl_easy_perform(curl);
  47. /* extract the private pointer again */
  48. ret = curl_easy_getinfo(curl, CURLINFO_PRIVATE, &pointer);
  49. curl_easy_cleanup(curl);
  50. }
  51. .fi
  52. .SH AVAILABILITY
  53. Added in 7.10.3
  54. .SH RETURN VALUE
  55. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  56. .SH "SEE ALSO"
  57. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
  58. .BR CURLOPT_PRIVATE "(3), "