Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLINFO_SCHEME (3)

Name

CURLINFO_SCHEME - get the URL scheme (sometimes called protocol) used in the connection

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SCHEME, char **scheme);

Description

CURLINFO_SCHEME(3)         curl_easy_getinfo options        CURLINFO_SCHEME(3)



NAME
       CURLINFO_SCHEME  -  get the URL scheme (sometimes called protocol) used
       in the connection

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SCHEME, char **scheme);

DESCRIPTION
       Pass a pointer to a char pointer to receive the pointer to a  null-ter-
       minated  string holding the URL scheme used for the most recent connec-
       tion done with this CURL handle.

       The scheme pointer will be NULL or pointing to private memory you  MUST
       NOT free - it gets freed when you call curl_easy_cleanup(3) on the cor-
       responding CURL handle.

PROTOCOLS
       All

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         CURLcode res;
         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
         res = curl_easy_perform(curl);
         if(res == CURLE_OK) {
           char *scheme = NULL;
           curl_easy_getinfo(curl, CURLINFO_SCHEME, &scheme);
           if(scheme)
             printf("scheme: %s\n", scheme); /* scheme: HTTP */
         }
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.52.0

RETURN VALUE
       Returns CURLE_OK if the option is supported,  and  CURLE_UNKNOWN_OPTION
       if not.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLINFO_RESPONSE_CODE(3), curl_easy_getinfo(3), curl_easy_setopt(3),



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source       was       downloaded      from       https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 November 26, 2021            CURLINFO_SCHEME(3)