From ce0881edee3c78609eae49665fb70264d8786d29 Mon Sep 17 00:00:00 2001 From: Patrick Monnerat Date: Sat, 2 Sep 2017 17:47:10 +0100 Subject: mime: new MIME API. Available in HTTP, SMTP and IMAP. Deprecates the FORM API. See CURLOPT_MIMEPOST. Lib code and associated documentation. --- docs/libcurl/curl_mime_name.3 | 52 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 docs/libcurl/curl_mime_name.3 (limited to 'docs/libcurl/curl_mime_name.3') diff --git a/docs/libcurl/curl_mime_name.3 b/docs/libcurl/curl_mime_name.3 new file mode 100644 index 000000000..5ef7c887f --- /dev/null +++ b/docs/libcurl/curl_mime_name.3 @@ -0,0 +1,52 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, , et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.TH curl_mime_name 3 "22 August 2017" "libcurl 7.56.0" "libcurl Manual" +.SH NAME +curl_mime_name - set a mime part's name +.SH SYNOPSIS +.B #include +.sp +.BI "CURLcode curl_mime_name(curl_mimepart * " part ", const char * " name +.BI ", ssize_t " namesize ");" +.ad +.SH DESCRIPTION +curl_mime_name() sets a mime part's name. This is the way HTTP form fields are +named. + +\fIname\fP points to the name byte string; the string may contain nul bytes +unless \fInamesize\fP is -1. +\fInamesize\fP is the name length: it can be set to -1 to indicate +\fIname\fP is a nul-terminated string. +\fIpart\fP is the part's handle to assign a name to. + +The name string is copied into the part, thus the associated storage may safely +be released or reused after call. Setting a part's name twice is valid: +only the value set by the last call is retained. It is possible to "unname" +a part by setting \fIname\fP to NULL. + +.SH AVAILABILITY +As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0. +.SH RETURN VALUE +CURLE_OK or a CURL error code upon failure. + +.SH "SEE ALSO" +.BR curl_mime_addpart "(3)" -- cgit v1.2.3