curl / libcurl / API / curl_formfree

curl_formfree - free a multipart/formdata HTTP POST chain

Name

curl_formfree - free a previously build multipart form post chain

Synopsis

#include <curl/curl.h>
 
void curl_formfree(struct curl_httppost *form);

Description

This function is deprecated. Do not use. See curl_mime_init instead!

curl_formfree() is used to clean up data previously built/appended with curl_formadd. This must be called when the data has been used, which typically means after curl_easy_perform has been called.

The pointer to free is the same pointer you passed to the CURLOPT_HTTPPOST option, which is the firstitem pointer from the curl_formadd invoke(s).

form is the pointer as returned from a previous call to curl_formadd and may be NULL.

Passing in a NULL pointer in form will make this function return immediately with no action.

Example

  /* 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);

Availability

Deprecated in 7.56.0.

Return value

None