curl_mime_free.3 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2018, 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_free 3 "22 August 2017" "libcurl 7.56.0" "libcurl Manual"
  23. .SH NAME
  24. curl_mime_free - free a previously built mime structure
  25. .SH SYNOPSIS
  26. .B #include <curl/curl.h>
  27. .sp
  28. .BI "void curl_mime_free(curl_mime *" mime);
  29. .ad
  30. .SH DESCRIPTION
  31. \fIcurl_mime_free(3)\fP is used to clean up data previously built/appended
  32. with \fIcurl_mime_addpart(3)\fP and other mime-handling functions. This must
  33. be called when the data has been used, which typically means after
  34. \fIcurl_easy_perform(3)\fP has been called.
  35. The handle to free is the one you passed to
  36. the \fICURLOPT_MIMEPOST(3)\fP option: attached subparts mime structures must
  37. not be explicitly freed as they are by the top structure freeing.
  38. \fBmime\fP is the handle as returned from a previous call to
  39. \fIcurl_mime_init(3)\fP and may be NULL.
  40. Passing in a NULL pointer in \fImime\fP will make this function return
  41. immediately with no action.
  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. None
  46. .SH "SEE ALSO"
  47. .BR curl_mime_init "(3)"