etlegacy-libs/curl/docs/libcurl/opts/CURLINFO_SCHEME.3

64 lines
2.3 KiB
Groff
Raw Normal View History

2017-03-02 22:46:25 +00:00
.\" **************************************************************************
.\" * _ _ ____ _
.\" * Project ___| | | | _ \| |
.\" * / __| | | | |_) | |
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
.\" * are also available at https://curl.haxx.se/docs/copyright.html.
.\" *
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
.\" * copies of the Software, and permit persons to whom the Software is
.\" * furnished to do so, under the terms of the COPYING file.
.\" *
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
.\" * KIND, either express or implied.
.\" *
.\" **************************************************************************
.\"
2020-03-26 12:29:51 +00:00
.TH CURLINFO_SCHEME 3 "April 08, 2017" "libcurl 7.69.1" "curl_easy_getinfo options"
2017-07-01 14:06:24 +00:00
2017-03-02 22:46:25 +00:00
.SH NAME
CURLINFO_SCHEME \- get the URL scheme (sometimes called protocol) used in the connection
.SH SYNOPSIS
#include <curl/curl.h>
2017-07-01 14:06:24 +00:00
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SCHEME, char **scheme);
2017-03-02 22:46:25 +00:00
.SH DESCRIPTION
Pass a pointer to a char pointer to receive the pointer to a zero-terminated
2017-07-01 14:06:24 +00:00
string holding the URL scheme used for the most recent connection done with
this CURL \fBhandle\fP.
2017-03-02 22:46:25 +00:00
2017-07-01 14:06:24 +00:00
The \fBscheme\fP pointer will be NULL or pointing to private memory you MUST
NOT free - it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the
corresponding CURL handle.
2017-03-02 22:46:25 +00:00
.SH PROTOCOLS
All
.SH EXAMPLE
.nf
CURL *curl = curl_easy_init();
if(curl) {
CURLcode res;
curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
res = curl_easy_perform(curl);
if(res == CURLE_OK) {
2017-07-01 14:06:24 +00:00
char *scheme = NULL;
2017-03-02 22:46:25 +00:00
curl_easy_getinfo(curl, CURLINFO_SCHEME, &scheme);
2017-07-01 14:06:24 +00:00
if(scheme)
printf("scheme: %s\\n", scheme); /* scheme: HTTP */
2017-03-02 22:46:25 +00:00
}
curl_easy_cleanup(curl);
}
.fi
.SH AVAILABILITY
Added in 7.52.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH "SEE ALSO"
.BR CURLINFO_RESPONSE_CODE "(3), "
.BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "