curl_multi_get_offt - returns all easy offt in a multi

Name

curl_multi_get_offt - extract information from a multi handle

Synopsis

#include <curl/curl.h>
 
CURLMcode curl_multi_get_offt(CURLM *multi_handle,
                              CURLMinfo_offt info,
                              curl_off_t *pvalue);

Description

Get the info kept in the multi handle. If the info is not applicable, this function returns CURLM_UNKNOWN_OPTION.

Options

The following information can be extracted:

CURLMINFO_XFERS_CURRENT

See CURLMINFO_XFERS_CURRENT.

CURLMINFO_XFERS_RUNNING

See CURLMINFO_XFERS_RUNNING.

CURLMINFO_XFERS_PENDING

See CURLMINFO_XFERS_PENDING.

CURLMINFO_XFERS_DONE

See CURLMINFO_XFERS_DONE.

CURLMINFO_XFERS_ADDED

See CURLMINFO_XFERS_ADDED.

Protocols

This functionality affects all supported protocols

Example

int main(void)
{
  /* init a multi stack */
  CURLM *multi = curl_multi_init();
  CURL *curl = curl_easy_init();
  curl_off_t n;
 
  if(curl) {
    /* add the transfer */
    curl_multi_add_handle(multi, curl);
 
    curl_multi_get_offt(multi, CURLMINFO_XFERS_ADDED, &n);
    /* on successful add, n is 1 */
  }
}

Availability

Added in curl 8.16.0

Return value

This function returns a CURLMcode indicating success or error.

CURLM_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors.