curl_mime_filename(3)

curl_mime_filename3

Set a mime part's remote file name

Usage

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

Overview

curl_mime_filename(3) sets a mime part's remote filename. When remote filename is set, content data is processed as a file, whatever is the part's content source. A part's remote filename is transmitted to the server in the associated Content-Disposition generated header.

part is the part's handle to assign the remote filename to.

filename points to the null-terminated filename string; it may be set to NULL to remove a previously attached remote filename.

The remote filename string is copied into the part, thus the associated storage may safely be released or reused after call. Setting a part's file name multiple times is valid: only the value set by the last call is retained.

Examples

static char imagebuf[]="imagedata";
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);
    /* send image data from memory */
    curl_mime_data(part, imagebuf, sizeof(imagebuf));
    /* set a file name to make it look like a file upload */
    curl_mime_filename(part, "image.png");
    /* set name */
    curl_mime_name(part, "data");
  }
}

Return value

CURLE_OK or a CURL error code upon failure.

Releases

32 releases since macOS 12.0.1; the text changed 9 times.

  1. 12.0.1–12.2
  2. 12.3–12.5
  3. 13.0
  4. 13.1
  5. 13.2
  6. 13.3
  7. 13.4
  8. 13.5–14.1
  9. 14.2–14.4
  10. 14.5–26.5

Availability

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

From curl 166.0.0.0.1 in macOS 26.5. Parsed by carta from the page's man source.