2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from curl_mime_free.md
|
2024-07-29 18:00:04 -06:00
|
|
|
.TH curl_mime_free 3 "2024-07-29" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
|
|
|
|
curl_mime_free \- free a previously built mime structure
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
void curl_mime_free(curl_mime *mime);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
\fIcurl_mime_free(3)\fP is used to clean up data previously built/appended
|
|
|
|
|
with \fIcurl_mime_addpart(3)\fP and other mime\-handling functions. This must
|
|
|
|
|
be called when the data has been used, which typically means after
|
|
|
|
|
\fIcurl_easy_perform(3)\fP has been called.
|
|
|
|
|
|
|
|
|
|
The handle to free is the one you passed to the \fICURLOPT_MIMEPOST(3)\fP
|
|
|
|
|
option: attached sub part mime structures must not be explicitly freed as they
|
|
|
|
|
are by the top structure freeing.
|
|
|
|
|
|
|
|
|
|
\fBmime\fP is the handle as returned from a previous call to
|
|
|
|
|
\fIcurl_mime_init(3)\fP and may be NULL.
|
|
|
|
|
|
|
|
|
|
Passing in a NULL pointer in \fImime\fP makes this function return immediately
|
|
|
|
|
with no action.
|
2024-03-30 12:28:04 -06:00
|
|
|
.SH PROTOCOLS
|
2024-07-29 18:00:04 -06:00
|
|
|
This functionality affects http, imap and smtp
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH EXAMPLE
|
|
|
|
|
.nf
|
|
|
|
|
int main(void)
|
|
|
|
|
{
|
|
|
|
|
CURL *curl = curl_easy_init();
|
|
|
|
|
if(curl) {
|
|
|
|
|
/* Build the mime message. */
|
|
|
|
|
curl_mime *mime = curl_mime_init(curl);
|
|
|
|
|
|
|
|
|
|
/* send off the transfer */
|
|
|
|
|
|
|
|
|
|
/* Free multipart message. */
|
|
|
|
|
curl_mime_free(mime);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.fi
|
|
|
|
|
.SH AVAILABILITY
|
2024-07-29 18:00:04 -06:00
|
|
|
Added in curl 7.56.0
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH RETURN VALUE
|
|
|
|
|
None
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR curl_free (3),
|
|
|
|
|
.BR curl_mime_init (3)
|
