curl_easy_strerror.3 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  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_easy_strerror 3 "26 Apr 2004" "libcurl 7.12" "libcurl Manual"
  23. .SH NAME
  24. curl_easy_strerror - return string describing error code
  25. .SH SYNOPSIS
  26. .nf
  27. #include <curl/curl.h>
  28. const char *curl_easy_strerror(CURLcode errornum);
  29. .fi
  30. .SH DESCRIPTION
  31. The \fIcurl_easy_strerror(3)\fP function returns a string describing the
  32. CURLcode error code passed in the argument \fIerrornum\fP.
  33. Typically applications also appreciate \fICURLOPT_ERRORBUFFER(3)\fP for more
  34. specific error descriptions generated at runtime.
  35. .SH EXAMPLE
  36. .nf
  37. /* Perform the request, res will get the return code */
  38. res = curl_easy_perform(curl);
  39. /* Check for errors */
  40. if(res != CURLE_OK)
  41. fprintf(stderr, "curl_easy_perform() failed: %s\\n",
  42. curl_easy_strerror(res));
  43. .fi
  44. .SH AVAILABILITY
  45. This function was added in libcurl 7.12.0
  46. .SH RETURN VALUE
  47. A pointer to a null-terminated string.
  48. .SH "SEE ALSO"
  49. .BR libcurl-errors "(3), " curl_multi_strerror "(3), "
  50. .BR curl_share_strerror "(3), " curl_url_strerror "(3)"