Return to curl_mime_headers.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl

Annotation of embedaddon/curl/docs/libcurl/curl_mime_headers.3, revision 1.1.1.1

1.1       misho       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_mime_headers 3 "September 22, 2017" "libcurl 7.70.0" "libcurl Manual"
                     23: 
                     24: .SH NAME
                     25: curl_mime_headers - set a mime part's custom headers
                     26: .SH SYNOPSIS
                     27: .B #include <curl/curl.h>
                     28: .sp
                     29: .BI "CURLcode curl_mime_headers(curl_mimepart * " part ,
                     30: .BI "struct curl_slist * " headers ", int " take_ownership ");"
                     31: .ad
                     32: .SH DESCRIPTION
                     33: \fIcurl_mime_headers(3)\fP sets a mime part's custom headers.
                     34: 
                     35: \fIpart\fP is the part's handle to assign the custom headers list to.
                     36: 
                     37: \fIheaders\fP is the head of a list of custom headers; it may be set to NULL
                     38: to remove a previously attached custom header list.
                     39: 
                     40: \fItake_ownership\fP: when non-zero, causes the list to be freed upon
                     41: replacement or mime structure deletion; in this case the list must not be
                     42: freed explicitly.
                     43: 
                     44: Setting a part's custom headers list twice is valid: only the value set by
                     45: the last call is retained.
                     46: .SH AVAILABILITY
                     47: As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
                     48: .SH RETURN VALUE
                     49: CURLE_OK or a CURL error code upon failure.
                     50: .SH EXAMPLE
                     51: .nf
                     52:  struct curl_slist *headers = NULL;
                     53: 
                     54:  headers = curl_slist_append("Custom-Header: mooo", headers);
                     55: 
                     56:  /* use these headers, please take ownership */
                     57:  curl_mime_headers(part, headers, TRUE);
                     58: 
                     59:  /* pass on this data */
                     60:  curl_mime_data(part, "12345679", CURL_ZERO_TERMINATED);
                     61: 
                     62:  /* set name */
                     63:  curl_mime_name(part, "numbers");
                     64: .fi
                     65: .SH "SEE ALSO"
                     66: .BR curl_mime_addpart "(3)"