CURLINFO_SCHEME.3 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2016, 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.haxx.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. .\"
  23. .TH CURLINFO_SCHEME 3 "April 08, 2017" "libcurl 7.61.1" "curl_easy_getinfo options"
  24. .SH NAME
  25. CURLINFO_SCHEME \- get the URL scheme (sometimes called protocol) used in the connection
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SCHEME, char **scheme);
  29. .SH DESCRIPTION
  30. Pass a pointer to a char pointer to receive the pointer to a zero-terminated
  31. string holding the URL scheme used for the most recent connection done with
  32. this CURL \fBhandle\fP.
  33. The \fBscheme\fP pointer will be NULL or pointing to private memory you MUST
  34. NOT free - it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the
  35. corresponding CURL handle.
  36. .SH PROTOCOLS
  37. All
  38. .SH EXAMPLE
  39. .nf
  40. CURL *curl = curl_easy_init();
  41. if(curl) {
  42. CURLcode res;
  43. curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  44. res = curl_easy_perform(curl);
  45. if(res == CURLE_OK) {
  46. char *scheme = NULL;
  47. curl_easy_getinfo(curl, CURLINFO_SCHEME, &scheme);
  48. if(scheme)
  49. printf("scheme: %s\\n", scheme); /* scheme: HTTP */
  50. }
  51. curl_easy_cleanup(curl);
  52. }
  53. .fi
  54. .SH AVAILABILITY
  55. Added in 7.52.0
  56. .SH RETURN VALUE
  57. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  58. .SH "SEE ALSO"
  59. .BR CURLINFO_RESPONSE_CODE "(3), "
  60. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "