aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/curl_slist_free_all.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libcurl/curl_slist_free_all.md')
-rw-r--r--docs/libcurl/curl_slist_free_all.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/docs/libcurl/curl_slist_free_all.md b/docs/libcurl/curl_slist_free_all.md
new file mode 100644
index 000000000..928f30601
--- /dev/null
+++ b/docs/libcurl/curl_slist_free_all.md
@@ -0,0 +1,58 @@
+---
+c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
+SPDX-License-Identifier: curl
+Title: curl_slist_free_all
+Section: 3
+Source: libcurl
+See-also:
+ - curl_slist_append (3)
+---
+
+# NAME
+
+curl_slist_free_all - free an entire curl_slist list
+
+# SYNOPSIS
+
+~~~c
+#include <curl/curl.h>
+
+void curl_slist_free_all(struct curl_slist *list);
+~~~
+
+# DESCRIPTION
+
+curl_slist_free_all() removes all traces of a previously built curl_slist
+linked list.
+
+Passing in a NULL pointer in *list* makes this function return immediately
+with no action.
+
+# EXAMPLE
+
+~~~c
+int main(void)
+{
+ CURL *handle;
+ struct curl_slist *slist = NULL;
+
+ slist = curl_slist_append(slist, "X-libcurl: coolness");
+
+ if(!slist)
+ return -1;
+
+ curl_easy_setopt(handle, CURLOPT_HTTPHEADER, slist);
+
+ curl_easy_perform(handle);
+
+ curl_slist_free_all(slist); /* free the list again */
+}
+~~~
+
+# AVAILABILITY
+
+Always
+
+# RETURN VALUE
+
+Nothing.