curl_mime_subparts.3 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2020, 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.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 "22 August 2017" "libcurl 7.56.0" "libcurl Manual"
  23. .SH NAME
  24. curl_mime_subparts - set subparts of a multipart mime part
  25. .SH SYNOPSIS
  26. .B #include <curl/curl.h>
  27. .sp
  28. .BI "CURLcode curl_mime_subparts(curl_mimepart * " part ,
  29. .BI "curl_mime * " subparts ");"
  30. .ad
  31. .SH DESCRIPTION
  32. \fIcurl_mime_subparts(3)\fP sets a multipart mime part's content from a mime
  33. structure.
  34. \fIpart\fP is a handle to the multipart part.
  35. \fIsubparts\fP is a mime structure handle holding the subparts. After
  36. \fIcurl_mime_subparts\fP succeeds, the mime structure handle belongs to the
  37. multipart part and must not be freed explicitly. It may however be updated by
  38. subsequent calls to mime API functions.
  39. Setting a part's contents twice is valid: only the value set by the last call
  40. is retained. It is possible to unassign previous part's contents by setting
  41. \fIsubparts\fP to NULL.
  42. .SH AVAILABILITY
  43. As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
  44. .SH RETURN VALUE
  45. CURLE_OK or a CURL error code upon failure.
  46. .SH EXAMPLE
  47. TODO
  48. .SH "SEE ALSO"
  49. .BR curl_mime_addpart "(3),"
  50. .BR curl_mime_init "(3)"