curl / libcurl / API / curl_mime_name

curl_mime_name - set a mime part name

Name

curl_mime_name - set a mime part's name

Synopsis

#include <curl/curl.h>
 
CURLcode curl_mime_name(curl_mimepart *part, const char *name);

Description

curl_mime_name sets a mime part's name. This is the way HTTP form fields are named.

part is the part's handle to assign a name to.

name 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's 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 name to NULL.

Protocols

HTTP, IMAP and SMTP

Example

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");
  }
}

Availability

As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.

Return value

CURLE_OK or a CURL error code upon failure.