curl / libcurl / API / curl_easy_getinfo / CURLINFO_SCHEME

CURLINFO_SCHEME explained

Name

CURLINFO_SCHEME - URL scheme used in transfer

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-terminated string holding the URL scheme used for the most recent transfer done with this CURL handle. The scheme might also sometimes be referred to as the protocol.

The scheme pointer is NULL or points to private memory. You must not free it. The memory gets freed automatically when you call curl_easy_cleanup on the corresponding curl handle.

The returned scheme might be upper or lowercase. Do comparisons case insensitively.

Protocols

This functionality affects all supported protocols

Example

int main(void)
{
  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 curl 7.52.0

Return value

curl_easy_getinfo returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors.