manpagez: man pages & more
man curl_formfree(3)
Home | html | info | man
curl_formfree(3)           Library Functions Manual           curl_formfree(3)


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(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_HTTPPOST(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 makes this function return
       immediately with no action.


PROTOCOLS

       This functionality affects http only


EXAMPLE

       int main(void)
       {
         CURL *curl = curl_easy_init();
         if(curl) {
           struct curl_httppost *formpost;
           struct curl_httppost *lastptr;

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


DEPRECATED

       Deprecated in 7.56.0.


AVAILABILITY

       Added in curl 7.1


RETURN VALUE

       None


SEE ALSO

       curl_formadd(3), curl_mime_free(3), curl_mime_init(3)

libcurl                           2024-08-05                  curl_formfree(3)

curl 8.9.1 - Generated Wed Aug 7 13:22:15 CDT 2024
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.