mirror/curl
2
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2024-12-15 06:40:09 +08:00
Code Issues Packages Projects Releases Wiki Activity
a94d6fe706
curl/docs/libcurl/curl_mime_name.3

67 lines
2.3 KiB
Groff
Raw Normal View History

mime: new MIME API. Available in HTTP, SMTP and IMAP. Deprecates the FORM API. See CURLOPT_MIMEPOST. Lib code and associated documentation.
2017-09-03 00:47:10 +08:00
.\" **************************************************************************
.\" * _ _ ____ _
.\" * Project ___| | | | _ \| |
.\" * / __| | | | |_) | |
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
copyright: make repository REUSE compliant Add licensing and copyright information for all files in this repository. This either happens in the file itself as a comment header or in the file `.reuse/dep5`. This commit also adds a Github workflow to check pull requests and adapts copyright.pl to the changes. Closes #8869
2022-05-17 17:16:50 +08:00
.\" * Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.
mime: new MIME API. Available in HTTP, SMTP and IMAP. Deprecates the FORM API. See CURLOPT_MIMEPOST. Lib code and associated documentation.
2017-09-03 00:47:10 +08:00
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
curl.se: new home Closes #6172
2020-11-04 21:02:01 +08:00
.\" * are also available at https://curl.se/docs/copyright.html.
mime: new MIME API. Available in HTTP, SMTP and IMAP. Deprecates the FORM API. See CURLOPT_MIMEPOST. Lib code and associated documentation.
2017-09-03 00:47:10 +08:00
.\" *
.\" * 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.
.\" *
copyright: make repository REUSE compliant Add licensing and copyright information for all files in this repository. This either happens in the file itself as a comment header or in the file `.reuse/dep5`. This commit also adds a Github workflow to check pull requests and adapts copyright.pl to the changes. Closes #8869
2022-05-17 17:16:50 +08:00
.\" * SPDX-License-Identifier: curl
.\" *
mime: new MIME API. Available in HTTP, SMTP and IMAP. Deprecates the FORM API. See CURLOPT_MIMEPOST. Lib code and associated documentation.
2017-09-03 00:47:10 +08:00
.\" **************************************************************************
.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
docs: consistent manpage SYNOPSIS Make all libcurl related options use .nf (no fill) for the SYNOPSIS section - for consistent look. roffit then renders that section using <pre> (monospace font) in html for the website. Extended manpage-syntax (test 1173) with a basic check for it. Closes #8062
2021-11-26 21:20:18 +08:00
.nf
#include <curl/curl.h>
CURLcode curl_mime_name(curl_mimepart *part, const char *name);
.fi
mime: new MIME API. Available in HTTP, SMTP and IMAP. Deprecates the FORM API. See CURLOPT_MIMEPOST. Lib code and associated documentation.
2017-09-03 00:47:10 +08:00
.SH DESCRIPTION
docs: curl_mime_*.3 man page formatting edits
2017-09-04 15:20:24 +08:00
\fIcurl_mime_name(3)\fP sets a mime part's name. This is the way HTTP form
fields are named.
mime: new MIME API. Available in HTTP, SMTP and IMAP. Deprecates the FORM API. See CURLOPT_MIMEPOST. Lib code and associated documentation.
2017-09-03 00:47:10 +08:00
docs: curl_mime_*.3 man page formatting edits
2017-09-04 15:20:24 +08:00
\fIpart\fP is the part's handle to assign a name to.
mime: new MIME API. Available in HTTP, SMTP and IMAP. Deprecates the FORM API. See CURLOPT_MIMEPOST. Lib code and associated documentation.
2017-09-03 00:47:10 +08:00
terminology: call them null-terminated strings Updated terminology in docs, comments and phrases to refer to C strings as "null-terminated". Done to unify with how most other C oriented docs refer of them and what users in general seem to prefer (based on a single highly unscientific poll on twitter). Reported-by: coinhubs on github Fixes #5598 Closes #5608
2020-06-25 17:38:25 +08:00
\fIname\fP points to the null-terminated name string.
form/mime: field names are not allowed to contain zero-valued bytes. Also suppress length argument of curl_mime_name() (names are always zero-terminated).
2017-09-22 08:08:29 +08:00
docs: curl_mime_*.3 man page formatting edits
2017-09-04 15:20:24 +08:00
The name string is copied into the part, thus the associated storage may
docs: clarify data replacement policy for MIME API The API documentation for the MIME functions specify that the parts can be set twice, with the last call winning. While true, the user can set the parts n times for n > 2, reword to specify multiple API calls instead. Closes: #8860 Reviewed-by: Daniel Stenberg <daniel@haxx.se>
2022-05-17 02:32:38 +08:00
safely be released or reused after call. Setting a part's name multiple times
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.
docs/curl_mime_*.3: added examples
2017-09-05 17:14:42 +08:00
.SH EXAMPLE
.nf
docs/curl_mime_*.3: use correct variable types in examples
2017-09-05 17:41:03 +08:00
curl_mime *mime;
curl_mimepart *part;
docs/curl_mime_*.3: added examples
2017-09-05 17:14:42 +08:00
/* create a mime handle */
mime = curl_mime_init(easy);
/* add a part */
part = curl_mime_addpart(mime);
/* give the part a name */
form/mime: field names are not allowed to contain zero-valued bytes. Also suppress length argument of curl_mime_name() (names are always zero-terminated).
2017-09-22 08:08:29 +08:00
curl_mime_name(part, "shoe_size");
docs/curl_mime_*.3: added examples
2017-09-05 17:14:42 +08:00
.fi
man pages: require all to use the same section header order This is the same order we already enforce among the options' man pages: consistency is good. Add lots of previously missing examples. Adjust the manpage-syntax script for this purpose, used in test 1173. Closes #7904
2021-10-25 14:54:08 +08:00
.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.
mime: new MIME API. Available in HTTP, SMTP and IMAP. Deprecates the FORM API. See CURLOPT_MIMEPOST. Lib code and associated documentation.
2017-09-03 00:47:10 +08:00
.SH "SEE ALSO"
form/mime: field names are not allowed to contain zero-valued bytes. Also suppress length argument of curl_mime_name() (names are always zero-terminated).
2017-09-22 08:08:29 +08:00
.BR curl_mime_addpart "(3),"
.BR curl_mime_data "(3),"
docs: curl_mime_*.3 man page formatting edits
2017-09-04 15:20:24 +08:00
.BR curl_mime_type "(3)"
Reference in New Issue Copy Permalink