aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/curl_easy_option_by_name.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libcurl/curl_easy_option_by_name.md')
-rw-r--r--docs/libcurl/curl_easy_option_by_name.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/libcurl/curl_easy_option_by_name.md b/docs/libcurl/curl_easy_option_by_name.md
new file mode 100644
index 000000000..86ccbd4da
--- /dev/null
+++ b/docs/libcurl/curl_easy_option_by_name.md
@@ -0,0 +1,53 @@
+---
+c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
+SPDX-License-Identifier: curl
+Title: curl_easy_option_by_name
+Section: 3
+Source: libcurl
+See-also:
+ - curl_easy_option_by_id (3)
+ - curl_easy_option_next (3)
+ - curl_easy_setopt (3)
+---
+
+# NAME
+
+curl_easy_option_by_name - find an easy setopt option by name
+
+# SYNOPSIS
+
+~~~c
+#include <curl/curl.h>
+
+const struct curl_easyoption *curl_easy_option_by_name(const char *name);
+~~~
+
+# DESCRIPTION
+
+Given a **name**, this function returns a pointer to the
+*curl_easyoption* struct, holding information about the
+curl_easy_setopt(3) option using that name. The name should be specified
+without the "CURLOPT_" prefix and the name comparison is made case
+insensitive.
+
+If libcurl has no option with the given name, this function returns NULL.
+
+# EXAMPLE
+
+~~~c
+int main(void)
+{
+ const struct curl_easyoption *opt = curl_easy_option_by_name("URL");
+ if(opt) {
+ printf("This option wants CURLoption %x\n", (int)opt->id);
+ }
+}
+~~~
+
+# AVAILABILITY
+
+This function was added in libcurl 7.73.0
+
+# RETURN VALUE
+
+A pointer to the *curl_easyoption* struct for the option or NULL.