Home Explore Help
Sign In
OWEALs
/
curl
mirror of https://github.com/curl/curl.git
2
0
Fork 0
Files Issues 8 Wiki
Tree: 58c4b8d636
Branches Tags
curl
/
docs
/
libcurl
/
curl_formfree.3

curl_formfree.3 2.1 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051 
  1. .\" **************************************************************************
    2. 

  2. .\" *                                  _   _ ____  _
    3. 

  3. .\" *  Project                     ___| | | |  _ \| |
    4. 

  4. .\" *                             / __| | | | |_) | |
    5. 

  5. .\" *                            | (__| |_| |  _ <| |___
    6. 

  6. .\" *                             \___|\___/|_| \_\_____|
    7. 

  7. .\" *
    8. 

  8. .\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
    9. 

  9. .\" *
    10. 

  10. .\" * This software is licensed as described in the file COPYING, which
    11. 

  11. .\" * you should have received as part of this distribution. The terms
    12. 

  12. .\" * are also available at https://curl.se/docs/copyright.html.
    13. 

  13. .\" *
    14. 

  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
    15. 

  15. .\" * copies of the Software, and permit persons to whom the Software is
    16. 

  16. .\" * furnished to do so, under the terms of the COPYING file.
    17. 

  17. .\" *
    18. 

  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
    19. 

  19. .\" * KIND, either express or implied.
    20. 

  20. .\" *
    21. 

  21. .\" **************************************************************************
    22. 

  22. .TH curl_formfree 3 "6 April 2001" "libcurl 7.7.1" "libcurl Manual"
    23. 

  23. .SH NAME
    24. 

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

  25. .SH SYNOPSIS
    26. 

  26. .B #include <curl/curl.h>
    27. 

  27. .sp
    28. 

  28. .BI "void curl_formfree(struct curl_httppost *" form);
    29. 

  29. .ad
    30. 

  30. .SH DESCRIPTION
    31. 

  31. This function is deprecated. Do not use! See \fIcurl_mime_init(3)\fP instead!
    32. 

  32. 

  33. curl_formfree() is used to clean up data previously built/appended with
    34. 

  34. \fIcurl_formadd(3)\fP. This must be called when the data has been used, which
    35. 

  35. typically means after \fIcurl_easy_perform(3)\fP has been called.
    36. 

  36. 

  37. The pointer to free is the same pointer you passed to the
    38. 

  38. \fICURLOPT_HTTPPOST(3)\fP option, which is the \fIfirstitem\fP pointer from
    39. 

  39. the \fIcurl_formadd(3)\fP invoke(s).
    40. 

  40. 

  41. \fBform\fP is the pointer as returned from a previous call to
    42. 

  42. \fIcurl_formadd(3)\fP and may be NULL.
    43. 

  43. 

  44. Passing in a NULL pointer in \fIform\fP will make this function return
    45. 

  45. immediately with no action.
    46. 

  46. .SH AVAILABILITY
    47. 

  47. Deprecated in 7.56.0.
    48. 

  48. .SH RETURN VALUE
    49. 

  49. None
    50. 

  50. .SH "SEE ALSO"
    51. 

  51. .BR curl_formadd "(3), " curl_mime_init "(3), " curl_mime_free "(3)"
    52.