curl_share_cleanup.3 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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. .TH curl_share_cleanup 3 "8 Aug 2003" "libcurl" "libcurl"
  25. .SH NAME
  26. curl_share_cleanup - Clean up a shared object
  27. .SH SYNOPSIS
  28. .nf
  29. #include <curl/curl.h>
  30. CURLSHcode curl_share_cleanup(CURLSH *share_handle);
  31. .fi
  32. .SH DESCRIPTION
  33. This function deletes a shared object. The share handle cannot be used anymore
  34. when this function has been called.
  35. Passing in a NULL pointer in \fIshare_handle\fP makes this function return
  36. immediately with no action.
  37. .SH EXAMPLE
  38. .nf
  39. int main(void)
  40. {
  41. CURLSHcode sh;
  42. CURLSH *share = curl_share_init();
  43. sh = curl_share_setopt(share, CURLSHOPT_SHARE, CURL_LOCK_DATA_CONNECT);
  44. /* use the share, then ... */
  45. curl_share_cleanup(share);
  46. }
  47. .fi
  48. .SH AVAILABILITY
  49. Added in 7.10
  50. .SH RETURN VALUE
  51. CURLSHE_OK (zero) means that the option was set properly, non-zero means an
  52. error occurred as \fI<curl/curl.h>\fP defines. See the \fIlibcurl-errors(3)\fP
  53. man page for the full list with descriptions. If an error occurs, then the
  54. share object is not deleted.
  55. .SH "SEE ALSO"
  56. .BR curl_share_init (3),
  57. .BR curl_share_setopt (3)