curl_easy_strerror.3 2.1 KB

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