Home Explore Help
Register Sign In
apple
/
External
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 9488874a0f
Branches Tags
External
/
Libraries
/
CURL
/
share
/
man
/
man3
/
CURLSHOPT_USERDATA.3

CURLSHOPT_USERDATA.3 2.1 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657 
  1. .\" **************************************************************************
    2. 

  2. .\" *                                  _   _ ____  _
    3. 

  3. .\" *  Project                     ___| | | |  _ \| |
    4. 

  4. .\" *                             / __| | | | |_) | |
    5. 

  5. .\" *                            | (__| |_| |  _ <| |___
    6. 

  6. .\" *                             \___|\___/|_| \_\_____|
    7. 

  7. .\" *
    8. 

  8. .\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
    9. 

  9. .\" *
    10. 

  10. .\" * This software is licensed as described in the file COPYING, which
    11. 

  11. .\" * you should have received as part of this distribution. The terms
    12. 

  12. .\" * are also available at https://curl.se/docs/copyright.html.
    13. 

  13. .\" *
    14. 

  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
    15. 

  15. .\" * copies of the Software, and permit persons to whom the Software is
    16. 

  16. .\" * furnished to do so, under the terms of the COPYING file.
    17. 

  17. .\" *
    18. 

  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
    19. 

  19. .\" * KIND, either express or implied.
    20. 

  20. .\" *
    21. 

  21. .\" * SPDX-License-Identifier: curl
    22. 

  22. .\" *
    23. 

  23. .\" **************************************************************************
    24. 

  24. .TH CURLSHOPT_USERDATA 3 "February 07, 2023" "libcurl 7.88.1" "libcurl Manual"
    25. 

  25. 

  26. .SH NAME
    27. 

  27. CURLSHOPT_USERDATA - pointer passed to the lock and unlock mutex callbacks
    28. 

  28. .SH SYNOPSIS
    29. 

  29. .nf
    30. 

  30. #include <curl/curl.h>
    31. 

  31. 

  32. CURLSHcode curl_share_setopt(CURLSH *share, CURLSHOPT_USERDATA, void *clientp);
    33. 

  33. .fi
    34. 

  34. .SH DESCRIPTION
    35. 

  35. The \fIclientp\fP parameter is held verbatim by libcurl and is passed on as
    36. 

  36. the \fIclientp\fP argument to the callbacks set with
    37. 

  37. \fICURLSHOPT_LOCKFUNC(3)\fP and \fICURLSHOPT_UNLOCKFUNC(3)\fP.
    38. 

  38. .SH PROTOCOLS
    39. 

  39. All
    40. 

  40. .SH EXAMPLE
    41. 

  41. .nf
    42. 

  42.   CURLSHcode sh;
    43. 

  43.   struct secrets private_stuff;
    44. 

  44.   share = curl_share_init();
    45. 

  45.   sh = curl_share_setopt(share, CURLSHOPT_USERDATA, &private_stuff);
    46. 

  46.   if(sh)
    47. 

  47.     printf("Error: %s\\n", curl_share_strerror(sh));
    48. 

  48. .fi
    49. 

  49. .SH AVAILABILITY
    50. 

  50. Added in 7.10
    51. 

  51. .SH RETURN VALUE
    52. 

  52. CURLSHE_OK (zero) means that the option was set properly, non-zero means an
    53. 

  53. error occurred. See \fIlibcurl-errors(3)\fP for the full list with
    54. 

  54. descriptions.
    55. 

  55. .SH "SEE ALSO"
    56. 

  56. .BR CURLSHOPT_LOCKFUNC "(3), "
    57. 

  57. .BR curl_share_setopt "(3), " curl_share_cleanup "(3), " curl_share_init "(3)"
    58.