curl_multi_init.3 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.
  9. .\" *
  10. .\" * This software is licensed as described in the file COPYING, which
  11. .\" * you should have received as part of this distribution. The terms
  12. .\" * are also available at https://curl.se/docs/copyright.html.
  13. .\" *
  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15. .\" * copies of the Software, and permit persons to whom the Software is
  16. .\" * furnished to do so, under the terms of the COPYING file.
  17. .\" *
  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19. .\" * KIND, either express or implied.
  20. .\" *
  21. .\" **************************************************************************
  22. .TH curl_multi_init 3 "1 March 2002" "libcurl 7.9.5" "libcurl Manual"
  23. .SH NAME
  24. curl_multi_init - create a multi handle
  25. .SH SYNOPSIS
  26. .nf
  27. #include <curl/curl.h>
  28. CURLM *curl_multi_init();
  29. .fi
  30. .SH DESCRIPTION
  31. This function returns a CURLM handle to be used as input to all the other
  32. multi-functions, sometimes referred to as a multi handle in some places in the
  33. documentation. This init call MUST have a corresponding call to
  34. \fIcurl_multi_cleanup(3)\fP when the operation is complete.
  35. .SH EXAMPLE
  36. .nf
  37. /* init a multi stack */
  38. multi_handle = curl_multi_init();
  39. /* add individual transfers */
  40. curl_multi_add_handle(multi_handle, http_handle);
  41. curl_multi_add_handle(multi_handle, http_handle2);
  42. .fi
  43. .SH AVAILABILITY
  44. Added in 7.9.6
  45. .SH RETURN VALUE
  46. If this function returns NULL, something went wrong and you cannot use the
  47. other curl functions.
  48. .SH "SEE ALSO"
  49. .BR curl_multi_cleanup "(3)," curl_global_init "(3)," curl_easy_init "(3)"