Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_PROTOCOL.3, revision 1.1
1.1 ! misho 1: .\" **************************************************************************
! 2: .\" * _ _ ____ _
! 3: .\" * Project ___| | | | _ \| |
! 4: .\" * / __| | | | |_) | |
! 5: .\" * | (__| |_| | _ <| |___
! 6: .\" * \___|\___/|_| \_\_____|
! 7: .\" *
! 8: .\" * Copyright (C) 1998 - 2018, 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_PROTOCOL 3 "April 14, 2020" "libcurl 7.70.0" "curl_easy_getinfo options"
! 24:
! 25: .SH NAME
! 26: CURLINFO_PROTOCOL \- get the protocol used in the connection
! 27: .SH SYNOPSIS
! 28: #include <curl/curl.h>
! 29:
! 30: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PROTOCOL, long *p);
! 31: .SH DESCRIPTION
! 32: Pass a pointer to a long to receive the version used in the last http
! 33: connection. The returned value will be exactly one of the CURLPROTO_* values:
! 34:
! 35: .nf
! 36: CURLPROTO_DICT, CURLPROTO_FILE, CURLPROTO_FTP, CURLPROTO_FTPS,
! 37: CURLPROTO_GOPHER, CURLPROTO_HTTP, CURLPROTO_HTTPS, CURLPROTO_IMAP,
! 38: CURLPROTO_IMAPS, CURLPROTO_LDAP, CURLPROTO_LDAPS, CURLPROTO_POP3,
! 39: CURLPROTO_POP3S, CURLPROTO_RTMP, CURLPROTO_RTMPE, CURLPROTO_RTMPS,
! 40: CURLPROTO_RTMPT, CURLPROTO_RTMPTE, CURLPROTO_RTMPTS, CURLPROTO_RTSP,
! 41: CURLPROTO_SCP, CURLPROTO_SFTP, CURLPROTO_SMB, CURLPROTO_SMBS, CURLPROTO_SMTP,
! 42: CURLPROTO_SMTPS, CURLPROTO_TELNET, CURLPROTO_TFTP, CURLPROTO_MQTT
! 43: .SH PROTOCOLS
! 44: All
! 45: .SH EXAMPLE
! 46: .nf
! 47: CURL *curl = curl_easy_init();
! 48: if(curl) {
! 49: CURLcode res;
! 50: curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
! 51: res = curl_easy_perform(curl);
! 52: if(res == CURLE_OK) {
! 53: long protocol;
! 54: curl_easy_getinfo(curl, CURLINFO_PROTOCOL, &protocol);
! 55: }
! 56: curl_easy_cleanup(curl);
! 57: }
! 58: .fi
! 59: .SH AVAILABILITY
! 60: Added in 7.52.0
! 61: .SH RETURN VALUE
! 62: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
! 63: .SH "SEE ALSO"
! 64: .BR CURLINFO_RESPONSE_CODE "(3), "
! 65: .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>