curl_share_setopt.3 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2022, 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. .TH curl_share_setopt 3 "8 Aug 2003" "libcurl 7.10.7" "libcurl Manual"
  25. .SH NAME
  26. curl_share_setopt - Set options for a shared object
  27. .SH SYNOPSIS
  28. .nf
  29. #include <curl/curl.h>
  30. CURLSHcode curl_share_setopt(CURLSH *share, CURLSHoption option, parameter);
  31. .fi
  32. .SH DESCRIPTION
  33. Set the \fIoption\fP to \fIparameter\fP for the given \fIshare\fP.
  34. .SH OPTIONS
  35. .IP CURLSHOPT_LOCKFUNC
  36. See \fICURLSHOPT_LOCKFUNC(3)\fP.
  37. .IP CURLSHOPT_UNLOCKFUNC
  38. See \fICURLSHOPT_UNLOCKFUNC(3)\fP.
  39. .IP CURLSHOPT_SHARE
  40. See \fICURLSHOPT_SHARE(3)\fP.
  41. .IP CURLSHOPT_UNSHARE
  42. See \fICURLSHOPT_UNSHARE(3)\fP.
  43. .IP CURLSHOPT_USERDATA
  44. See \fICURLSHOPT_USERDATA(3)\fP.
  45. .SH EXAMPLE
  46. .nf
  47. CURLSHcode sh;
  48. share = curl_share_init();
  49. sh = curl_share_setopt(share, CURLSHOPT_SHARE, CURL_LOCK_DATA_CONNECT);
  50. if(sh)
  51. printf("Error: %s\\n", curl_share_strerror(sh));
  52. .fi
  53. .SH AVAILABILITY
  54. Added in 7.10
  55. .SH RETURN VALUE
  56. CURLSHE_OK (zero) means that the option was set properly, non-zero means an
  57. error occurred as \fI<curl/curl.h>\fP defines. See the \fIlibcurl-errors.3\fP
  58. man page for the full list with descriptions.
  59. .SH "SEE ALSO"
  60. .BR curl_share_cleanup "(3), " curl_share_init "(3)"