Return to curl_formfree.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl

Annotation of embedaddon/curl/docs/libcurl/curl_formfree.3, revision 1.1.1.1

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