dwww Home | Manual pages | Find package

curl_mime_filename(3)           libcurl Manual           curl_mime_filename(3)

NAME
       curl_mime_filename - set a mime part's remote file name

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_mime_filename(curl_mimepart *part,
                                   const char *filename);

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

       part is the part's handle to assign the remote file name to.

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

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

EXAMPLE
        curl_mime *mime;
        curl_mimepart *part;

        /* create a mime handle */
        mime = curl_mime_init(easy);

        /* add a part */
        part = curl_mime_addpart(mime);

        /* send image data from memory */
        curl_mime_data(part, imagebuf, imagebuf_len);

        /* 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");

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.

SEE ALSO
       curl_mime_addpart(3), curl_mime_filedata(3), curl_mime_data(3)

libcurl 7.81.0                 November 26, 2021         curl_mime_filename(3)

Generated by dwww version 1.14 on Thu Jan 23 06:09:56 CET 2025.