xref: /curl/docs/libcurl/opts/CURLINFO_SCHEME.md (revision 5a488251)
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
15Added-in: 7.52.0
16---
17
18# NAME
19
20CURLINFO_SCHEME - get the URL scheme (sometimes called protocol) used in the connection
21
22# SYNOPSIS
23
24~~~c
25#include <curl/curl.h>
26
27CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SCHEME, char **scheme);
28~~~
29
30# DESCRIPTION
31
32Pass a pointer to a char pointer to receive the pointer to a null-terminated
33string holding the URL scheme used for the most recent connection done with
34this CURL **handle**.
35
36The **scheme** pointer is NULL or points to private memory. You MUST NOT
37free - it gets freed when you call curl_easy_cleanup(3) on the corresponding
38CURL handle.
39
40The returned scheme might be upper or lowercase. Do comparisons case
41insensitively.
42
43# %PROTOCOLS%
44
45# EXAMPLE
46
47~~~c
48int main(void)
49{
50  CURL *curl = curl_easy_init();
51  if(curl) {
52    CURLcode res;
53    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
54    res = curl_easy_perform(curl);
55    if(res == CURLE_OK) {
56      char *scheme = NULL;
57      curl_easy_getinfo(curl, CURLINFO_SCHEME, &scheme);
58      if(scheme)
59        printf("scheme: %s\n", scheme); /* scheme: HTTP */
60    }
61    curl_easy_cleanup(curl);
62  }
63}
64~~~
65
66# %AVAILABILITY%
67
68# RETURN VALUE
69
70Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
71