moparisthebest/curl
1
0
Fork 0
mirror of https://github.com/moparisthebest/curl synced 2024-11-15 22:15:13 -05:00
Code Issues Releases Wiki Activity
3b3459eed8
curl/docs/libcurl/opts/CURLINFO_SCHEME.3

63 lines
2.3 KiB
Groff
Raw Normal View History

add CURLINFO_SCHEME, CURLINFO_PROTOCOL, and %{scheme} Adds access to the effectively used protocol/scheme to both libcurl and curl, both in string and numeric (CURLPROTO_*) form. Note that the string form will be uppercase, as it is just the internal string. As these strings are declared internally as const, and all other strings returned by curl_easy_getinfo() are de-facto const as well, string handling in getinfo.c got const-ified. Closes #1137
2016-11-23 04:44:18 -05:00
.\" **************************************************************************
.\" * _ _ ____ _
.\" * Project ___| | | | _ \| |
.\" * / __| | | | |_) | |
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
copyright: fix out-of-date copyright ranges and missing headers Reported by the new script 'scripts/copyright.pl'. The script has a regex whitelist for the files that don't need copyright headers. Removed three (mostly usesless) README files from docs/ Closes #5141
2020-03-23 09:44:29 -04:00
.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
add CURLINFO_SCHEME, CURLINFO_PROTOCOL, and %{scheme} Adds access to the effectively used protocol/scheme to both libcurl and curl, both in string and numeric (CURLPROTO_*) form. Note that the string form will be uppercase, as it is just the internal string. As these strings are declared internally as const, and all other strings returned by curl_easy_getinfo() are de-facto const as well, string handling in getinfo.c got const-ified. Closes #1137
2016-11-23 04:44:18 -05:00
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
curl.se: new home Closes #6172
2020-11-04 08:02:01 -05:00
.\" * are also available at https://curl.se/docs/copyright.html.
add CURLINFO_SCHEME, CURLINFO_PROTOCOL, and %{scheme} Adds access to the effectively used protocol/scheme to both libcurl and curl, both in string and numeric (CURLPROTO_*) form. Note that the string form will be uppercase, as it is just the internal string. As these strings are declared internally as const, and all other strings returned by curl_easy_getinfo() are de-facto const as well, string handling in getinfo.c got const-ified. Closes #1137
2016-11-23 04:44:18 -05:00
.\" *
.\" * 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.
.\" *
.\" **************************************************************************
.\"
.TH CURLINFO_SCHEME 3 "23 November 2016" "libcurl 7.52.0" "curl_easy_getinfo options"
.SH NAME
CURLINFO_SCHEME \- get the URL scheme (sometimes called protocol) used in the connection
.SH SYNOPSIS
#include <curl/curl.h>
CURLINFO_SCHEME.3: fix variable type - Change documented param type to char ** from incorrect long *.
2017-04-08 15:44:39 -04:00
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SCHEME, char **scheme);
add CURLINFO_SCHEME, CURLINFO_PROTOCOL, and %{scheme} Adds access to the effectively used protocol/scheme to both libcurl and curl, both in string and numeric (CURLPROTO_*) form. Note that the string form will be uppercase, as it is just the internal string. As these strings are declared internally as const, and all other strings returned by curl_easy_getinfo() are de-facto const as well, string handling in getinfo.c got const-ified. Closes #1137
2016-11-23 04:44:18 -05:00
.SH DESCRIPTION
terminology: call them null-terminated strings Updated terminology in docs, comments and phrases to refer to C strings as "null-terminated". Done to unify with how most other C oriented docs refer of them and what users in general seem to prefer (based on a single highly unscientific poll on twitter). Reported-by: coinhubs on github Fixes #5598 Closes #5608
2020-06-25 05:38:25 -04:00
Pass a pointer to a char pointer to receive the pointer to a null-terminated
CURLINFO_SCHEME.3: fix variable type - Change documented param type to char ** from incorrect long *.
2017-04-08 15:44:39 -04:00
string holding the URL scheme used for the most recent connection done with
this CURL \fBhandle\fP.
add CURLINFO_SCHEME, CURLINFO_PROTOCOL, and %{scheme} Adds access to the effectively used protocol/scheme to both libcurl and curl, both in string and numeric (CURLPROTO_*) form. Note that the string form will be uppercase, as it is just the internal string. As these strings are declared internally as const, and all other strings returned by curl_easy_getinfo() are de-facto const as well, string handling in getinfo.c got const-ified. Closes #1137
2016-11-23 04:44:18 -05:00
CURLINFO_SCHEME.3: fix variable type - Change documented param type to char ** from incorrect long *.
2017-04-08 15:44:39 -04: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.
add CURLINFO_SCHEME, CURLINFO_PROTOCOL, and %{scheme} Adds access to the effectively used protocol/scheme to both libcurl and curl, both in string and numeric (CURLPROTO_*) form. Note that the string form will be uppercase, as it is just the internal string. As these strings are declared internally as const, and all other strings returned by curl_easy_getinfo() are de-facto const as well, string handling in getinfo.c got const-ified. Closes #1137
2016-11-23 04:44:18 -05:00
.SH PROTOCOLS
All
.SH EXAMPLE
.nf
CURL *curl = curl_easy_init();
if(curl) {
CURLcode res;
man pages: switch to https://example.com URLs Since HTTPS is "the new normal", this update changes a lot of man page examples to use https://example.com instead of the previous "http://..." Closes #5969
2020-09-16 17:04:07 -04:00
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
add CURLINFO_SCHEME, CURLINFO_PROTOCOL, and %{scheme} Adds access to the effectively used protocol/scheme to both libcurl and curl, both in string and numeric (CURLPROTO_*) form. Note that the string form will be uppercase, as it is just the internal string. As these strings are declared internally as const, and all other strings returned by curl_easy_getinfo() are de-facto const as well, string handling in getinfo.c got const-ified. Closes #1137
2016-11-23 04:44:18 -05:00
res = curl_easy_perform(curl);
if(res == CURLE_OK) {
CURLINFO_SCHEME.3: fix variable type - Change documented param type to char ** from incorrect long *.
2017-04-08 15:44:39 -04:00
char *scheme = NULL;
add CURLINFO_SCHEME, CURLINFO_PROTOCOL, and %{scheme} Adds access to the effectively used protocol/scheme to both libcurl and curl, both in string and numeric (CURLPROTO_*) form. Note that the string form will be uppercase, as it is just the internal string. As these strings are declared internally as const, and all other strings returned by curl_easy_getinfo() are de-facto const as well, string handling in getinfo.c got const-ified. Closes #1137
2016-11-23 04:44:18 -05:00
curl_easy_getinfo(curl, CURLINFO_SCHEME, &scheme);
CURLINFO_SCHEME.3: fix variable type - Change documented param type to char ** from incorrect long *.
2017-04-08 15:44:39 -04:00
if(scheme)
printf("scheme: %s\\n", scheme); /* scheme: HTTP */
add CURLINFO_SCHEME, CURLINFO_PROTOCOL, and %{scheme} Adds access to the effectively used protocol/scheme to both libcurl and curl, both in string and numeric (CURLPROTO_*) form. Note that the string form will be uppercase, as it is just the internal string. As these strings are declared internally as const, and all other strings returned by curl_easy_getinfo() are de-facto const as well, string handling in getinfo.c got const-ified. Closes #1137
2016-11-23 04:44:18 -05: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), "
Reference in New Issue Copy Permalink