docs/libcurl/curl_slist_append.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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.haxx.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 .\" **************************************************************************
  22 .TH curl_slist_append 3 "May 05, 2017" "libcurl 7.59.0" "libcurl Manual"
  23
  24 .SH NAME
  25 curl_slist_append - add a string to an slist
  26 .SH SYNOPSIS
  27 .B #include <curl/curl.h>
  28 .sp
  29 .BI "struct curl_slist *curl_slist_append(struct curl_slist *" list,
  30 .BI "const char * "string ");"
  31 .ad
  32 .SH DESCRIPTION
  33 \fIcurl_slist_append(3)\fP appends a string to a linked list of strings. The
  34 existing \fBlist\fP should be passed as the first argument and the new list is
  35 returned from this function. Pass in NULL in the \fBlist\fP argument to create
  36 a new list. The specified \fBstring\fP has been appended when this function
  37 returns. \fIcurl_slist_append(3)\fP copies the string.
  38
  39 The list should be freed again (after usage) with
  40 \fIcurl_slist_free_all(3)\fP.
  41 .SH RETURN VALUE
  42 A null pointer is returned if anything went wrong, otherwise the new list
  43 pointer is returned.
  44 .SH EXAMPLE
  45 .nf
  46 CURL *handle;
  47 struct curl_slist *slist=NULL;
  48
  49 slist = curl_slist_append(slist, "pragma:");
  50
  51 if (slist == NULL)
  52   return -1;
  53
  54 curl_easy_setopt(handle, CURLOPT_HTTPHEADER, slist);
  55
  56 curl_easy_perform(handle);
  57
  58 curl_slist_free_all(slist); /* free the list again */
  59 .fi
  60 .SH "SEE ALSO"
  61 .BR curl_slist_free_all "(3), "