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

curl_multi_init.3 2.0 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253 
  1. .\" **************************************************************************
    2. 

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

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

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

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

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

  7. .\" *
    8. 

  8. .\" * Copyright (C) 1998 - 2022, 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. .\" * SPDX-License-Identifier: curl
    22. 

  22. .\" *
    23. 

  23. .\" **************************************************************************
    24. 

  24. .TH curl_multi_init 3 "1 March 2002" "libcurl 7.9.5" "libcurl Manual"
    25. 

  25. .SH NAME
    26. 

  26. curl_multi_init - create a multi handle
    27. 

  27. .SH SYNOPSIS
    28. 

  28. .nf
    29. 

  29. #include <curl/curl.h>
    30. 

  30. 

  31. CURLM *curl_multi_init();
    32. 

  32. .fi
    33. 

  33. .SH DESCRIPTION
    34. 

  34. This function returns a pointer to a \fICURLM\fP handle to be used as input to
    35. 

  35. all the other multi-functions, sometimes referred to as a multi handle in some
    36. 

  36. places in the documentation. This init call MUST have a corresponding call to
    37. 

  37. \fIcurl_multi_cleanup(3)\fP when the operation is complete.
    38. 

  38. .SH EXAMPLE
    39. 

  39. .nf
    40. 

  40. /* init a multi stack */
    41. 

  41. multi_handle = curl_multi_init();
    42. 

  42. 

  43. /* add individual transfers */
    44. 

  44. curl_multi_add_handle(multi_handle, http_handle);
    45. 

  45. curl_multi_add_handle(multi_handle, http_handle2);
    46. 

  46. .fi
    47. 

  47. .SH AVAILABILITY
    48. 

  48. Added in 7.9.6
    49. 

  49. .SH RETURN VALUE
    50. 

  50. If this function returns NULL, something went wrong and you cannot use the
    51. 

  51. other curl functions.
    52. 

  52. .SH "SEE ALSO"
    53. 

  53. .BR curl_multi_cleanup "(3)," curl_global_init "(3)," curl_easy_init "(3)"
    54.