Man page - curl_mime_name(3)

Packages contains this manual

Package: libcurl4-doc
apt-get install libcurl4-doc

Manuals in package:

Documentations in package:

libcurl4-doc

Manual

curl_mime_name

NAME
SYNOPSIS
DESCRIPTION
PROTOCOLS
EXAMPLE
AVAILABILITY
RETURN VALUE
SEE ALSO

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(3) 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

This functionality affects 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

Added in curl 7.56.0

RETURN VALUE

This function returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3) . If CURLOPT_ERRORBUFFER(3) was set with curl_easy_setopt(3) there can be an error message stored in the error buffer when non-zero is returned.