curl/docs/libcurl/curl_slist_free_all.md
Daniel Stenberg 1e769526b4
docs/libcurl: add to cleanup docs that their inputs go invalid
Reported-by: icy17 on github
Fixes #14248
Closes #14258
2024-07-23 11:18:46 +02:00

1.0 KiB

c SPDX-License-Identifier Title Section Source See-also Protocol Added-in
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. curl curl_slist_free_all 3 libcurl
curl_slist_append (3)
All
7.1

NAME

curl_slist_free_all - free an entire curl_slist list

SYNOPSIS

#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.

Any use of the list after this function has been called and have returned, is illegal.

%PROTOCOLS%

EXAMPLE

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%

RETURN VALUE

Nothing.