76 lines
2.7 KiB
Groff
76 lines
2.7 KiB
Groff
|
.\" **************************************************************************
|
||
|
|
.\" * _ _ ____ _
|
||
|
|
.\" * Project ___| | | | _ \| |
|
||
|
|
.\" * / __| | | | |_) | |
|
||
|
|
.\" * | (__| |_| | _ <| |___
|
||
|
|
.\" * \___|\___/|_| \_\_____|
|
||
|
|
.\" *
|
||
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
||
|
|
.\" *
|
||
|
|
.\" * This software is licensed as described in the file COPYING, which
|
||
|
|
.\" * you should have received as part of this distribution. The terms
|
||
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
||
|
|
.\" *
|
||
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
||
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
||
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
||
|
|
.\" *
|
||
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
||
|
|
.\" * KIND, either express or implied.
|
||
|
|
.\" *
|
||
|
|
.\" * SPDX-License-Identifier: curl
|
||
|
|
.\" *
|
||
|
|
.\" **************************************************************************
|
||
|
|
.TH curl_mime_filename 3 "22 August 2017" "libcurl" "libcurl"
|
||
|
|
.SH NAME
|
||
|
|
curl_mime_filename - set a mime part's remote file name
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
#include <curl/curl.h>
|
||
|
|
|
||
|
|
CURLcode curl_mime_filename(curl_mimepart *part,
|
||
|
|
const char *filename);
|
||
|
|
.fi
|
||
|
|
.SH DESCRIPTION
|
||
|
|
\fIcurl_mime_filename(3)\fP 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.
|
||
|
|
|
||
|
|
\fIpart\fP is the part's handle to assign the remote file name to.
|
||
|
|
|
||
|
|
\fIfilename\fP 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 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.
|
||
|
|
.SH EXAMPLE
|
||
|
|
.nf
|
||
|
|
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");
|
||
|
|
.fi
|
||
|
|
.SH AVAILABILITY
|
||
|
|
As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
|
||
|
|
.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_filedata (3)
|