curl_slist_free_all.3 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
  9. .\" *
  10. .\" * This software is licensed as described in the file COPYING, which
  11. .\" * you should have received as part of this distribution. The terms
  12. .\" * are also available at https://curl.se/docs/copyright.html.
  13. .\" *
  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15. .\" * copies of the Software, and permit persons to whom the Software is
  16. .\" * furnished to do so, under the terms of the COPYING file.
  17. .\" *
  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19. .\" * KIND, either express or implied.
  20. .\" *
  21. .\" * SPDX-License-Identifier: curl
  22. .\" *
  23. .\" **************************************************************************
  24. .TH curl_slist_free_all 3 "5 March 2001" "libcurl" "libcurl"
  25. .SH NAME
  26. curl_slist_free_all - free an entire curl_slist list
  27. .SH SYNOPSIS
  28. .nf
  29. #include <curl/curl.h>
  30. void curl_slist_free_all(struct curl_slist *list);
  31. .fi
  32. .SH DESCRIPTION
  33. curl_slist_free_all() removes all traces of a previously built curl_slist
  34. linked list.
  35. Passing in a NULL pointer in \fIlist\fP will make this function return
  36. immediately with no action.
  37. .SH EXAMPLE
  38. .nf
  39. CURL *handle;
  40. struct curl_slist *slist=NULL;
  41. slist = curl_slist_append(slist, "X-libcurl: coolness");
  42. if (slist == NULL)
  43. return -1;
  44. curl_easy_setopt(handle, CURLOPT_HTTPHEADER, slist);
  45. curl_easy_perform(handle);
  46. curl_slist_free_all(slist); /* free the list again */
  47. .fi
  48. .SH AVAILABILITY
  49. Always
  50. .SH RETURN VALUE
  51. Nothing.
  52. .SH "SEE ALSO"
  53. .BR curl_slist_append "(3), "