diff options
Diffstat (limited to 'docs/libcurl/gnurl_formfree.3')
| -rw-r--r-- | docs/libcurl/gnurl_formfree.3 | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/libcurl/gnurl_formfree.3 b/docs/libcurl/gnurl_formfree.3 new file mode 100644 index 000000000..24764dc59 --- /dev/null +++ b/docs/libcurl/gnurl_formfree.3 @@ -0,0 +1,51 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.TH gnurl_formfree 3 "6 April 2001" "libcurl 7.7.1" "libgnurl Manual" +.SH NAME +curl_formfree - free a previously build multipart/formdata HTTP POST chain +.SH SYNOPSIS +.B #include <gnurl/curl.h> +.sp +.BI "void curl_formfree(struct curl_httppost *" form); +.ad +.SH DESCRIPTION +This function is deprecated. Do not use! See \fIcurl_mime_init(3)\fP instead! + +curl_formfree() is used to clean up data previously built/appended with +\fIcurl_formadd(3)\fP. This must be called when the data has been used, which +typically means after \fIcurl_easy_perform(3)\fP has been called. + +The pointer to free is the same pointer you passed to the +\fICURLOPT_HTTPPOST(3)\fP option, which is the \fIfirstitem\fP pointer from +the \fIcurl_formadd(3)\fP invoke(s). + +\fBform\fP is the pointer as returned from a previous call to +\fIcurl_formadd(3)\fP and may be NULL. + +Passing in a NULL pointer in \fIform\fP will make this function return +immediately with no action. +.SH AVAILABILITY +Deprecated in 7.56.0. +.SH RETURN VALUE +None +.SH "SEE ALSO" +.BR curl_formadd "(3), " curl_mime_init "(3), " curl_mime_free "(3)" |