Return to CURLINFO_SCHEME.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_SCHEME.3, revision 1.1.1.1

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