eefcc1bda4
curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
78 lines
1.7 KiB
Markdown
78 lines
1.7 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: curl_multi_get_handles
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- curl_multi_add_handle (3)
|
|
- curl_multi_cleanup (3)
|
|
- curl_multi_init (3)
|
|
- curl_multi_remove_handle (3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
curl_multi_get_handles - returns all added easy handles
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURL **curl_multi_get_handles(CURLM *multi_handle);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Returns an array with pointers to all added easy handles. The end of the list
|
|
is marked with a NULL pointer.
|
|
|
|
Even if there is not a single easy handle added, this still returns an array
|
|
but with only a single NULL pointer entry.
|
|
|
|
The returned array contains all the handles that are present at the time of
|
|
the call. As soon as a handle has been removed from or a handle has been added
|
|
to the multi handle after the handle array was returned, the two data points
|
|
are out of sync.
|
|
|
|
The order of the easy handles within the array is not guaranteed.
|
|
|
|
The returned array must be freed with a call to curl_free(3) after use.
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
/* init a multi stack */
|
|
CURLM *multi = curl_multi_init();
|
|
CURL *curl = curl_easy_init();
|
|
|
|
if(curl) {
|
|
/* add the transfer */
|
|
curl_multi_add_handle(multi, curl);
|
|
|
|
/* extract all added handles */
|
|
CURL **list = curl_multi_get_handles(multi);
|
|
|
|
if(list) {
|
|
int i;
|
|
/* remove all added handles */
|
|
for(i = 0; list[i]; i++) {
|
|
curl_multi_remove_handle(multi, list[i]);
|
|
}
|
|
curl_free(list);
|
|
}
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Added in 8.4.0
|
|
|
|
# RETURN VALUE
|
|
|
|
Returns NULL on failure. Otherwise it returns a pointer to an allocated array.
|