diff options
Diffstat (limited to 'docs/libcurl/curl_mime_type.3')
-rw-r--r-- | docs/libcurl/curl_mime_type.3 | 85 |
1 files changed, 0 insertions, 85 deletions
diff --git a/docs/libcurl/curl_mime_type.3 b/docs/libcurl/curl_mime_type.3 deleted file mode 100644 index 74d7d9416..000000000 --- a/docs/libcurl/curl_mime_type.3 +++ /dev/null @@ -1,85 +0,0 @@ -.\" ************************************************************************** -.\" * _ _ ____ _ -.\" * 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_type 3 "22 August 2017" "libcurl" "libcurl" -.SH NAME -curl_mime_type - set a mime part's content type -.SH SYNOPSIS -.nf -#include <curl/curl.h> - -CURLcode curl_mime_type(curl_mimepart *part, const char *mimetype); -.fi -.SH DESCRIPTION -\fIcurl_mime_type(3)\fP sets a mime part's content type. - -\fIpart\fP is the part's handle to assign the content type to. - -\fImimetype\fP points to the null-terminated file mime type string; it may be -set to NULL to remove a previously attached mime type. - -The mime type string is copied into the part, thus the associated storage may -safely be released or reused after call. Setting a part's type multiple times -is valid: only the value set by the last call is retained. - -In the absence of a mime type and if needed by the protocol specifications, -a default mime type is determined by the context: -.br -- If set as a custom header, use this value. -.br -- application/form-data for an HTTP form post. -.br -- If a remote file name is set, the mime type is taken from the file name -extension, or application/octet-stream by default. -.br -- For a multipart part, multipart/mixed. -.br -- text/plain in other cases. -.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); - - /* get data from this file */ - curl_mime_filedata(part, "image.png"); - - /* content-type for this part */ - curl_mime_type(part, "image/png"); - - /* set name */ - curl_mime_name(part, "image"); -.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_name (3) |