CURLINFO_OS_ERRNO.3 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  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. .\"
  25. .TH CURLINFO_OS_ERRNO 3 "January 02, 2023" "libcurl 7.88.1" "curl_easy_getinfo options"
  26. .SH NAME
  27. CURLINFO_OS_ERRNO \- get errno number from last connect failure
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_OS_ERRNO, long *errnop);
  32. .fi
  33. .SH DESCRIPTION
  34. Pass a pointer to a long to receive the errno variable from a connect failure.
  35. Note that the value is only set on failure, it is not reset upon a successful
  36. operation. The number is OS and system specific.
  37. .SH PROTOCOLS
  38. All
  39. .SH EXAMPLE
  40. .nf
  41. CURL *curl = curl_easy_init();
  42. if(curl) {
  43. CURLcode res;
  44. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  45. res = curl_easy_perform(curl);
  46. if(res != CURLE_OK) {
  47. long error;
  48. res = curl_easy_getinfo(curl, CURLINFO_OS_ERRNO, &error);
  49. if(res && error) {
  50. printf("Errno: %ld\\n", error);
  51. }
  52. }
  53. curl_easy_cleanup(curl);
  54. }
  55. .fi
  56. .SH AVAILABILITY
  57. Added in 7.12.2
  58. .SH RETURN VALUE
  59. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  60. .SH "SEE ALSO"
  61. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "