Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

curl_formfree (3)

Name

curl_formfree - free a previously build multipart/formdata HTTP POST chain

Synopsis

#include <curl/curl.h>

void curl_formfree(struct curl_httppost *form);

Description

curl_formfree(3)                libcurl Manual                curl_formfree(3)



NAME
       curl_formfree  -  free  a previously build multipart/formdata HTTP 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(3) instead!

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

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

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

       Passing  in a NULL pointer in form will make this function return imme-
       diately 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


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       curl_formadd(3), curl_mime_init(3), curl_mime_free(3)



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source      was      downloaded       from        https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 November 26, 2021              curl_formfree(3)