aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLINFO_SCHEME.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libcurl/opts/CURLINFO_SCHEME.md')
-rw-r--r--docs/libcurl/opts/CURLINFO_SCHEME.md68
1 files changed, 68 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLINFO_SCHEME.md b/docs/libcurl/opts/CURLINFO_SCHEME.md
new file mode 100644
index 000000000..db567fc98
--- /dev/null
+++ b/docs/libcurl/opts/CURLINFO_SCHEME.md
@@ -0,0 +1,68 @@
+---
+c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
+SPDX-License-Identifier: curl
+Title: CURLINFO_SCHEME
+Section: 3
+Source: libcurl
+See-also:
+ - CURLINFO_EFFECTIVE_URL (3)
+ - CURLINFO_PROTOCOL (3)
+ - CURLINFO_RESPONSE_CODE (3)
+ - curl_easy_getinfo (3)
+ - curl_easy_setopt (3)
+---
+
+# NAME
+
+CURLINFO_SCHEME - get the URL scheme (sometimes called protocol) used in the connection
+
+# SYNOPSIS
+
+~~~c
+#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 connection done with
+this CURL **handle**.
+
+The **scheme** pointer is NULL or points to private memory. You MUST NOT
+free - it gets freed when you call curl_easy_cleanup(3) on the
+corresponding CURL handle.
+
+# PROTOCOLS
+
+All
+
+# EXAMPLE
+
+~~~c
+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 7.52.0
+
+# RETURN VALUE
+
+Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.