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

curl_multi_cleanup.3 2.1 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950 
  1. .\" **************************************************************************
    2. 

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

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

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

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

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

  7. .\" *
    8. 

  8. .\" * Copyright (C) 1998 - 2018, 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.haxx.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_multi_cleanup 3 "1 March 2002" "libcurl 7.9.5" "libcurl Manual"
    23. 

  23. .SH NAME
    24. 

  24. curl_multi_cleanup - close down a multi session
    25. 

  25. .SH SYNOPSIS
    26. 

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

  27. .sp
    28. 

  28. .BI "CURLMcode curl_multi_cleanup( CURLM *multi_handle );"
    29. 

  29. .ad
    30. 

  30. .SH DESCRIPTION
    31. 

  31. Cleans up and removes a whole multi stack. It does not free or touch any
    32. 

  32. individual easy handles in any way - they still need to be closed
    33. 

  33. individually, using the usual \fIcurl_easy_cleanup(3)\fP way. The order of
    34. 

  34. cleaning up should be:
    35. 

  35. 

  36. 1 - \fIcurl_multi_remove_handle(3)\fP before any easy handles are cleaned up
    37. 

  37. 

  38. 2 - \fIcurl_easy_cleanup(3)\fP can now be called independently since the easy
    39. 

  39. handle is no longer connected to the multi handle
    40. 

  40. 

  41. 3 - \fIcurl_multi_cleanup(3)\fP should be called when all easy handles are
    42. 

  42. removed
    43. 

  43. 

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

  45. CURLM_BAD_HANDLE immediately with no other action.
    46. 

  46. .SH RETURN VALUE
    47. 

  47. CURLMcode type, general libcurl multi interface error code. On success,
    48. 

  48. CURLM_OK is returned.
    49. 

  49. .SH "SEE ALSO"
    50. 

  50. .BR curl_multi_init "(3)," curl_easy_cleanup "(3)," curl_easy_init "(3)"
    51.