Return to curl_mime_subparts.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl

Annotation of embedaddon/curl/docs/libcurl/curl_mime_subparts.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
                      9: .\" *
                     10: .\" * This software is licensed as described in the file COPYING, which
                     11: .\" * you should have received as part of this distribution. The terms
                     12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
                     13: .\" *
                     14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
                     15: .\" * copies of the Software, and permit persons to whom the Software is
                     16: .\" * furnished to do so, under the terms of the COPYING file.
                     17: .\" *
                     18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
                     19: .\" * KIND, either express or implied.
                     20: .\" *
                     21: .\" **************************************************************************
                     22: .TH curl_mime_subparts 3 "September 05, 2017" "libcurl 7.70.0" "libcurl Manual"
                     23: 
                     24: .SH NAME
                     25: curl_mime_subparts - set subparts of a multipart mime part
                     26: .SH SYNOPSIS
                     27: .B #include <curl/curl.h>
                     28: .sp
                     29: .BI "CURLcode curl_mime_subparts(curl_mimepart * " part ,
                     30: .BI "curl_mime * " subparts ");"
                     31: .ad
                     32: .SH DESCRIPTION
                     33: \fIcurl_mime_subparts(3)\fP sets a multipart mime part's content from a mime
                     34: structure.
                     35: 
                     36: \fIpart\fP is a handle to the multipart part.
                     37: 
                     38: \fIsubparts\fP is a mime structure handle holding the subparts. After
                     39: \fIcurl_mime_subparts\fP succeeds, the mime structure handle belongs to the
                     40: multipart part and must not be freed explicitly. It may however be updated by
                     41: subsequent calls to mime API functions.
                     42: 
                     43: Setting a part's contents twice is valid: only the value set by the last call
                     44: is retained. It is possible to unassign previous part's contents by setting
                     45: \fIsubparts\fP to NULL.
                     46: .SH AVAILABILITY
                     47: As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
                     48: .SH RETURN VALUE
                     49: CURLE_OK or a CURL error code upon failure.
                     50: .SH EXAMPLE
                     51: TODO
                     52: .SH "SEE ALSO"
                     53: .BR curl_mime_addpart "(3),"
                     54: .BR curl_mime_init "(3)"