moparisthebest/curl
1
0
Fork 0
mirror of https://github.com/moparisthebest/curl synced 2024-12-25 01:28:51 -05:00
Code Issues Releases Wiki Activity
124198631b
curl/docs/libcurl/curl_mime_name.3

64 lines
2.2 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-02 12:47:10 -04:00
.\" **************************************************************************
.\" * _ _ ____ _
.\" * Project ___| | | | _ \| |
.\" * / __| | | | |_) | |
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
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 05:38:25 -04:00
.\" * Copyright (C) 1998 - 2020, 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-02 12:47:10 -04: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 08:02:01 -05: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-02 12:47:10 -04: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.
.\" *
.\" **************************************************************************
.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 <curl/curl.h>
.sp
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-21 20:08:29 -04:00
.BI "CURLcode curl_mime_name(curl_mimepart * " part ", const char * " name ");"
mime: new MIME API. Available in HTTP, SMTP and IMAP. Deprecates the FORM API. See CURLOPT_MIMEPOST. Lib code and associated documentation.
2017-09-02 12:47:10 -04:00
.ad
.SH DESCRIPTION
docs: curl_mime_*.3 man page formatting edits
2017-09-04 03:20:24 -04: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-02 12:47:10 -04:00
docs: curl_mime_*.3 man page formatting edits
2017-09-04 03:20:24 -04: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-02 12:47:10 -04: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 05:38:25 -04: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-21 20:08:29 -04:00
docs: curl_mime_*.3 man page formatting edits
2017-09-04 03:20:24 -04:00
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.
mime: new MIME API. Available in HTTP, SMTP and IMAP. Deprecates the FORM API. See CURLOPT_MIMEPOST. Lib code and associated documentation.
2017-09-02 12:47:10 -04: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.
docs/curl_mime_*.3: added examples
2017-09-05 05:14:42 -04:00
.SH EXAMPLE
.nf
docs/curl_mime_*.3: use correct variable types in examples
2017-09-05 05:41:03 -04:00
curl_mime *mime;
curl_mimepart *part;
docs/curl_mime_*.3: added examples
2017-09-05 05:14:42 -04: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-21 20:08:29 -04:00
curl_mime_name(part, "shoe_size");
docs/curl_mime_*.3: added examples
2017-09-05 05:14:42 -04:00
.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-02 12:47:10 -04: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-21 20:08:29 -04:00
.BR curl_mime_addpart "(3),"
.BR curl_mime_data "(3),"
docs: curl_mime_*.3 man page formatting edits
2017-09-04 03:20:24 -04:00
.BR curl_mime_type "(3)"
Reference in New Issue Copy Permalink