xref: /curl/docs/libcurl/opts/CURLINFO_SCHEME.md (revision e3fe0200)
1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLINFO_SCHEME
5Section: 3
6Source: libcurl
7See-also:
8  - CURLINFO_EFFECTIVE_URL (3)
9  - CURLINFO_PROTOCOL (3)
10  - CURLINFO_RESPONSE_CODE (3)
11  - curl_easy_getinfo (3)
12  - curl_easy_setopt (3)
13Protocol:
14  - All
15---
16
17# NAME
18
19CURLINFO_SCHEME - get the URL scheme (sometimes called protocol) used in the connection
20
21# SYNOPSIS
22
23~~~c
24#include <curl/curl.h>
25
26CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SCHEME, char **scheme);
27~~~
28
29# DESCRIPTION
30
31Pass a pointer to a char pointer to receive the pointer to a null-terminated
32string holding the URL scheme used for the most recent connection done with
33this CURL **handle**.
34
35The **scheme** pointer is NULL or points to private memory. You MUST NOT
36free - it gets freed when you call curl_easy_cleanup(3) on the
37corresponding CURL handle.
38
39# EXAMPLE
40
41~~~c
42int main(void)
43{
44  CURL *curl = curl_easy_init();
45  if(curl) {
46    CURLcode res;
47    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
48    res = curl_easy_perform(curl);
49    if(res == CURLE_OK) {
50      char *scheme = NULL;
51      curl_easy_getinfo(curl, CURLINFO_SCHEME, &scheme);
52      if(scheme)
53        printf("scheme: %s\n", scheme); /* scheme: HTTP */
54    }
55    curl_easy_cleanup(curl);
56  }
57}
58~~~
59
60# AVAILABILITY
61
62Added in 7.52.0
63
64# RETURN VALUE
65
66Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
67