CURLINFO_PROTOCOL.3 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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_PROTOCOL 3 "January 02, 2023" "libcurl 7.88.1" "curl_easy_getinfo options"
  26. .SH NAME
  27. CURLINFO_PROTOCOL \- get the protocol used in the connection
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PROTOCOL, long *p);
  32. .fi
  33. .SH DESCRIPTION
  34. This option is deprecated. We strongly recommend using
  35. \fICURLINFO_SCHEME(3)\fP instead, because this option cannot return all
  36. possible protocols!
  37. Pass a pointer to a long to receive the version used in the last http
  38. connection. The returned value will be exactly one of the CURLPROTO_* values:
  39. .nf
  40. CURLPROTO_DICT, CURLPROTO_FILE, CURLPROTO_FTP, CURLPROTO_FTPS,
  41. CURLPROTO_GOPHER, CURLPROTO_HTTP, CURLPROTO_HTTPS, CURLPROTO_IMAP,
  42. CURLPROTO_IMAPS, CURLPROTO_LDAP, CURLPROTO_LDAPS, CURLPROTO_POP3,
  43. CURLPROTO_POP3S, CURLPROTO_RTMP, CURLPROTO_RTMPE, CURLPROTO_RTMPS,
  44. CURLPROTO_RTMPT, CURLPROTO_RTMPTE, CURLPROTO_RTMPTS, CURLPROTO_RTSP,
  45. CURLPROTO_SCP, CURLPROTO_SFTP, CURLPROTO_SMB, CURLPROTO_SMBS, CURLPROTO_SMTP,
  46. CURLPROTO_SMTPS, CURLPROTO_TELNET, CURLPROTO_TFTP, CURLPROTO_MQTT
  47. .SH PROTOCOLS
  48. All
  49. .SH EXAMPLE
  50. .nf
  51. CURL *curl = curl_easy_init();
  52. if(curl) {
  53. CURLcode res;
  54. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  55. res = curl_easy_perform(curl);
  56. if(res == CURLE_OK) {
  57. long protocol;
  58. curl_easy_getinfo(curl, CURLINFO_PROTOCOL, &protocol);
  59. }
  60. curl_easy_cleanup(curl);
  61. }
  62. .fi
  63. .SH AVAILABILITY
  64. Added in 7.52.0. Deprecated since 7.85.0.
  65. .SH RETURN VALUE
  66. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  67. .SH "SEE ALSO"
  68. .BR CURLINFO_RESPONSE_CODE "(3), "
  69. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "