docs/libcurl/curl_mime_free.3

   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_free 3 "September 04, 2017" "libcurl 7.59.0" "libcurl Manual"
  23
  24 .SH NAME
  25 curl_mime_free - free a previously built mime structure
  26 .SH SYNOPSIS
  27 .B #include <curl/curl.h>
  28 .sp
  29 .BI "void curl_mime_free(curl_mime *" mime);
  30 .ad
  31 .SH DESCRIPTION
  32 \fIcurl_mime_free(3)\fP is used to clean up data previously built/appended
  33 with \fIcurl_mime_addpart(3)\fP and other mime-handling functions.  This must
  34 be called when the data has been used, which typically means after
  35 \fIcurl_easy_perform(3)\fP has been called.
  36
  37 The handle to free is the one you passed to
  38 the \fICURLOPT_MIMEPOST(3)\fP option: attached subparts mime structures must
  39 not be explicitly freed as they are by the top structure freeing.
  40
  41 \fBmime\fP is the handle as returned from a previous call to
  42 \fIcurl_mime_init(3)\fP and may be NULL.
  43
  44 .SH AVAILABILITY
  45 As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
  46 .SH RETURN VALUE
  47 None
  48 .SH "SEE ALSO"
  49 .BR curl_mime_init "(3)"