Home Explore Help
Sign In
OWEALs
/
curl
mirror of https://github.com/curl/curl.git
2
0
Fork 0
Files Issues 8 Wiki
Tree: a86bf2e02a
Branches Tags
curl
/
docs
/
libcurl
/
curl_share_setopt.3

curl_share_setopt.3 2.2 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061 
  1. .\" **************************************************************************
    2. 

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

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

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

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

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

  7. .\" *
    8. 

  8. .\" * Copyright (C) 1998 - 2022, 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 curl_share_setopt 3 "8 Aug 2003" "libcurl 7.10.7" "libcurl Manual"
    25. 

  25. .SH NAME
    26. 

  26. curl_share_setopt - Set options for a shared object
    27. 

  27. .SH SYNOPSIS
    28. 

  28. .nf
    29. 

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

  30. 

  31. CURLSHcode curl_share_setopt(CURLSH *share, CURLSHoption option, parameter);
    32. 

  32. .fi
    33. 

  33. .SH DESCRIPTION
    34. 

  34. Set the \fIoption\fP to \fIparameter\fP for the given \fIshare\fP.
    35. 

  35. .SH OPTIONS
    36. 

  36. .IP CURLSHOPT_LOCKFUNC
    37. 

  37. See \fICURLSHOPT_LOCKFUNC(3)\fP.
    38. 

  38. .IP CURLSHOPT_UNLOCKFUNC
    39. 

  39. See \fICURLSHOPT_UNLOCKFUNC(3)\fP.
    40. 

  40. .IP CURLSHOPT_SHARE
    41. 

  41. See \fICURLSHOPT_SHARE(3)\fP.
    42. 

  42. .IP CURLSHOPT_UNSHARE
    43. 

  43. See \fICURLSHOPT_UNSHARE(3)\fP.
    44. 

  44. .IP CURLSHOPT_USERDATA
    45. 

  45. See \fICURLSHOPT_USERDATA(3)\fP.
    46. 

  46. .SH EXAMPLE
    47. 

  47. .nf
    48. 

  48.   CURLSHcode sh;
    49. 

  49.   share = curl_share_init();
    50. 

  50.   sh = curl_share_setopt(share, CURLSHOPT_SHARE, CURL_LOCK_DATA_CONNECT);
    51. 

  51.   if(sh)
    52. 

  52.     printf("Error: %s\\n", curl_share_strerror(sh));
    53. 

  53. .fi
    54. 

  54. .SH AVAILABILITY
    55. 

  55. Added in 7.10
    56. 

  56. .SH RETURN VALUE
    57. 

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

  58. error occurred as \fI<curl/curl.h>\fP defines. See the \fIlibcurl-errors.3\fP
    59. 

  59. man page for the full list with descriptions.
    60. 

  60. .SH "SEE ALSO"
    61. 

  61. .BR curl_share_cleanup "(3), " curl_share_init "(3)"
    62.