| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <[email protected]>, 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_formfree 3 "6 April 2001" "libcurl 7.7.1" "libcurl Manual" |
| 23 |
.SH NAME |
| 24 |
curl_formfree - free a previously build multipart/formdata HTTP POST chain |
| 25 |
.SH SYNOPSIS |
| 26 |
.B #include <curl/curl.h> |
| 27 |
.sp |
| 28 |
.BI "void curl_formfree(struct curl_httppost *" form); |
| 29 |
.ad |
| 30 |
.SH DESCRIPTION |
| 31 |
This function is deprecated. Do not use! See \fIcurl_mime_init(3)\fP instead! |
| 32 |
|
| 33 |
curl_formfree() is used to clean up data previously built/appended with |
| 34 |
\fIcurl_formadd(3)\fP. This must be called when the data has been used, which |
| 35 |
typically means after \fIcurl_easy_perform(3)\fP has been called. |
| 36 |
|
| 37 |
The pointer to free is the same pointer you passed to the |
| 38 |
\fICURLOPT_HTTPPOST(3)\fP option, which is the \fIfirstitem\fP pointer from |
| 39 |
the \fIcurl_formadd(3)\fP invoke(s). |
| 40 |
|
| 41 |
\fBform\fP is the pointer as returned from a previous call to |
| 42 |
\fIcurl_formadd(3)\fP and may be NULL. |
| 43 |
|
| 44 |
Passing in a NULL pointer in \fIform\fP will make this function return |
| 45 |
immediately with no action. |
| 46 |
.SH AVAILABILITY |
| 47 |
Deprecated in 7.56.0. |
| 48 |
.SH RETURN VALUE |
| 49 |
None |
| 50 |
.SH "SEE ALSO" |
| 51 |
.BR curl_formadd "(3), " curl_mime_init "(3), " curl_mime_free "(3)" |