72 lines
2.5 KiB
Groff
72 lines
2.5 KiB
Groff
|
.\" **************************************************************************
|
||
|
|
.\" * _ _ ____ _
|
||
|
|
.\" * Project ___| | | | _ \| |
|
||
|
|
.\" * / __| | | | |_) | |
|
||
|
|
.\" * | (__| |_| | _ <| |___
|
||
|
|
.\" * \___|\___/|_| \_\_____|
|
||
|
|
.\" *
|
||
|
|
.\" * Copyright (C) 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.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.
|
||
|
|
.\" *
|
||
|
|
.\" * SPDX-License-Identifier: curl
|
||
|
|
.\" *
|
||
|
|
.\" **************************************************************************
|
||
|
|
.TH curl_formfree 3 "August 22, 2023" "libcurl 8.3.0" "libcurl"
|
||
|
|
|
||
|
|
.SH NAME
|
||
|
|
curl_formfree - free a previously build multipart form post chain
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
#include <curl/curl.h>
|
||
|
|
|
||
|
|
void curl_formfree(struct curl_httppost *form);
|
||
|
|
.fi
|
||
|
|
.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 makes this function return immediately
|
||
|
|
with no action.
|
||
|
|
.SH EXAMPLE
|
||
|
|
.nf
|
||
|
|
/* Fill in a file upload field */
|
||
|
|
curl_formadd(&formpost,
|
||
|
|
&lastptr,
|
||
|
|
CURLFORM_COPYNAME, "file",
|
||
|
|
CURLFORM_FILE, "nice-image.jpg",
|
||
|
|
CURLFORM_END);
|
||
|
|
|
||
|
|
curl_easy_setopt(curl, CURLOPT_HTTPPOST, formpost);
|
||
|
|
|
||
|
|
curl_easy_perform(curl);
|
||
|
|
|
||
|
|
/* then cleanup the formpost chain */
|
||
|
|
curl_formfree(formpost);
|
||
|
|
.fi
|
||
|
|
.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)"
|