Home Explore Help
Sign In
OWEALs
/
curl
mirror of https://github.com/curl/curl.git
2
0
Fork 0
Files Issues 8 Wiki
Tree: 0c9211798f
Branches Tags
curl
/
docs
/
libcurl
/
curl_mime_subparts.3

curl_mime_subparts.3 2.2 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253 
  1. .\" **************************************************************************
    2. 

  2. .\" *                                  _   _ ____  _
    3. 

  3. .\" *  Project                     ___| | | |  _ \| |
    4. 

  4. .\" *                             / __| | | | |_) | |
    5. 

  5. .\" *                            | (__| |_| |  _ <| |___
    6. 

  6. .\" *                             \___|\___/|_| \_\_____|
    7. 

  7. .\" *
    8. 

  8. .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
    9. 

  9. .\" *
    10. 

  10. .\" * This software is licensed as described in the file COPYING, which
    11. 

  11. .\" * you should have received as part of this distribution. The terms
    12. 

  12. .\" * are also available at https://curl.haxx.se/docs/copyright.html.
    13. 

  13. .\" *
    14. 

  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
    15. 

  15. .\" * copies of the Software, and permit persons to whom the Software is
    16. 

  16. .\" * furnished to do so, under the terms of the COPYING file.
    17. 

  17. .\" *
    18. 

  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
    19. 

  19. .\" * KIND, either express or implied.
    20. 

  20. .\" *
    21. 

  21. .\" **************************************************************************
    22. 

  22. .TH curl_mime_subparts 3 "22 August 2017" "libcurl 7.56.0" "libcurl Manual"
    23. 

  23. .SH NAME
    24. 

  24. curl_mime_subparts - set subparts of a multipart mime part
    25. 

  25. .SH SYNOPSIS
    26. 

  26. .B #include <curl/curl.h>
    27. 

  27. .sp
    28. 

  28. .BI "CURLcode curl_mime_subparts(curl_mimepart * " part ,
    29. 

  29. .BI "curl_mime * " subparts ");"
    30. 

  30. .ad
    31. 

  31. .SH DESCRIPTION
    32. 

  32. \fIcurl_mime_subparts(3)\fP sets a multipart mime part's content from a mime
    33. 

  33. structure.
    34. 

  34. 

  35. \fIpart\fP is a handle to the multipart part.
    36. 

  36. 

  37. \fIsubparts\fP is a mime structure handle holding the subparts. After
    38. 

  38. \fIcurl_mime_subparts\fP succeeds, the mime structure handle belongs to the
    39. 

  39. multipart part and must not be freed explicitly. It may however be updated by
    40. 

  40. subsequent calls to mime API functions.
    41. 

  41. 

  42. Setting a part's contents twice is valid: only the value set by the last call
    43. 

  43. is retained. It is possible to unassign previous part's contents by setting
    44. 

  44. \fIsubparts\fP to NULL.
    45. 

  45. .SH AVAILABILITY
    46. 

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

  47. .SH RETURN VALUE
    48. 

  48. CURLE_OK or a CURL error code upon failure.
    49. 

  49. .SH EXAMPLE
    50. 

  50. TODO
    51. 

  51. .SH "SEE ALSO"
    52. 

  52. .BR curl_mime_addpart "(3),"
    53. 

  53. .BR curl_mime_init "(3)"
    54.