curl/docs/libcurl/curl_multi_init.md
Daniel Stenberg 8c1d9378ac
curldown: make 'added-in:' a mandatory header field
- generate AVAILABILITY manpage sections automatically - for consistent
  wording

- allows us to double-check against other documumentation (symbols-in-versions
  etc)

- enables proper automation/scripting based on this data

- lots of them were wrong or missing in the manpages

- several of them repeated (sometimes mismatching) backend support info

Add test 1488 to verify "added-in" version numbers against
symbols-in-versions.

Closes #14217
2024-07-18 18:04:09 +02:00

1.1 KiB

c SPDX-License-Identifier Title Section Source See-also Protocol Added-in
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. curl curl_multi_init 3 libcurl
curl_easy_init (3)
curl_global_init (3)
curl_multi_add_handle (3)
curl_multi_cleanup (3)
curl_multi_get_handles (3)
All
7.9.6

NAME

curl_multi_init - create a multi handle

SYNOPSIS

#include <curl/curl.h>

CURLM *curl_multi_init();

DESCRIPTION

This function returns a pointer to a CURLM handle to be used as input to all the other multi-functions, sometimes referred to as a multi handle in some places in the documentation. This init call MUST have a corresponding call to curl_multi_cleanup(3) when the operation is complete.

EXAMPLE

int main(void)
{
  /* init a multi stack */
  CURLM *multi = curl_multi_init();
  CURL *curl = curl_easy_init();
  CURL *curl2 = curl_easy_init();

  /* add individual transfers */
  curl_multi_add_handle(multi, curl);
  curl_multi_add_handle(multi, curl2);
}

RETURN VALUE

If this function returns NULL, something went wrong and you cannot use the other curl functions.