curl_share_strerror.3 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  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. .\" **************************************************************************
  22. .TH curl_share_strerror 3 "Apr 26, 2004" "libcurl 7.12" "libcurl Manual"
  23. .SH NAME
  24. curl_share_strerror - return string describing error code
  25. .SH SYNOPSIS
  26. .nf
  27. .B #include <curl/curl.h>
  28. .BI "const char *curl_share_strerror(CURLSHcode " errornum ");"
  29. .SH DESCRIPTION
  30. The curl_share_strerror() function returns a string describing the CURLSHcode
  31. error code passed in the argument \fIerrornum\fP.
  32. .SH EXAMPLE
  33. .nf
  34. CURLSHcode sh;
  35. share = curl_share_init();
  36. sh = curl_share_setopt(share, CURLSHOPT_SHARE, CURL_LOCK_DATA_CONNECT);
  37. if(sh)
  38. printf("Error: %s\\n", curl_share_strerror(sh));
  39. .fi
  40. .SH AVAILABILITY
  41. This function was added in libcurl 7.12.0
  42. .SH RETURN VALUE
  43. A pointer to a null-terminated string.
  44. .SH "SEE ALSO"
  45. .BR libcurl-errors "(3), " curl_multi_strerror "(3), "
  46. .BR curl_easy_strerror "(3), " curl_url_strerror "(3)"