2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from curl_mime_name.md
|
2024-08-02 19:52:59 -06:00
|
|
|
.TH curl_mime_name 3 "2024-08-02" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
|
|
|
|
curl_mime_name \- set a mime part\(aqs name
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_mime_name(curl_mimepart *part, const char *name);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
\fIcurl_mime_name(3)\fP sets a mime part\(aqs name. This is the way HTTP form
|
|
|
|
|
fields are named.
|
|
|
|
|
|
|
|
|
|
\fIpart\fP is the part\(aqs handle to assign a name to.
|
|
|
|
|
|
|
|
|
|
\fIname\fP points to the null\-terminated name string.
|
|
|
|
|
|
|
|
|
|
The name string is copied into the part, thus the associated storage may
|
|
|
|
|
safely be released or reused after call. Setting a part\(aqs name multiple times
|
|
|
|
|
is valid: only the value set by the last call is retained. It is possible to
|
|
|
|
|
reset the name of a part by setting \fIname\fP to NULL.
|
2024-03-30 12:28:04 -06:00
|
|
|
.SH PROTOCOLS
|
2024-07-29 18:00:04 -06:00
|
|
|
This functionality affects http, imap and smtp
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH EXAMPLE
|
|
|
|
|
.nf
|
|
|
|
|
int main(void)
|
|
|
|
|
{
|
|
|
|
|
curl_mime *mime;
|
|
|
|
|
curl_mimepart *part;
|
|
|
|
|
|
|
|
|
|
CURL *curl = curl_easy_init();
|
|
|
|
|
if(curl) {
|
|
|
|
|
/* create a mime handle */
|
|
|
|
|
mime = curl_mime_init(curl);
|
|
|
|
|
|
|
|
|
|
/* add a part */
|
|
|
|
|
part = curl_mime_addpart(mime);
|
|
|
|
|
|
|
|
|
|
/* give the part a name */
|
|
|
|
|
curl_mime_name(part, "shoe_size");
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.fi
|
|
|
|
|
.SH AVAILABILITY
|
2024-07-29 18:00:04 -06:00
|
|
|
Added in curl 7.56.0
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH RETURN VALUE
|
|
|
|
|
CURLE_OK or a CURL error code upon failure.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR curl_mime_addpart (3),
|
|
|
|
|
.BR curl_mime_data (3),
|
|
|
|
|
.BR curl_mime_type (3)
|
