curl / libcurl / API / curl_easy_getinfo / CURLINFO_XFER_ID

CURLINFO_XFER_ID explained

Name

CURLINFO_XFER_ID - get the ID of a transfer

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_XFER_ID,
                           curl_off_t *xfer_id);

Description

Pass a pointer to a curl_off_t to receive the identifier of the current/last transfer done with the handle. Stores -1 if no transfer has been started yet for the handle.

The transfer id is unique among all transfers performed using the same connection cache. This is implicitly the case for all transfers in the same multi handle.

Protocols

This functionality affects all supported protocols

Example

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
 
    /* Perform the request */
    res = curl_easy_perform(curl);
 
    if(!res) {
      curl_off_t xfer_id;
      res = curl_easy_getinfo(curl, CURLINFO_XFER_ID, &xfer_id);
      if(!res) {
        printf("Transfer ID: %" CURL_FORMAT_CURL_OFF_T "\n", xfer_id);
      }
    }
  }
}

Availability

Added in curl 8.2.0

Return value

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.