| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051 |
- .\" generated by cd2nroff 0.1 from CURLINFO_XFER_ID.md
- .TH CURLINFO_XFER_ID 3 "2025-01-17" libcurl
- .SH NAME
- CURLINFO_XFER_ID \- get the ID of a transfer
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_XFER_ID,
- curl_off_t *xfer_id);
- .fi
- .SH DESCRIPTION
- Pass a pointer to a \fIcurl_off_t\fP 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.
- .SH PROTOCOLS
- This functionality affects all supported protocols
- .SH EXAMPLE
- .nf
- 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);
- }
- }
- }
- }
- .fi
- .SH AVAILABILITY
- Added in curl 8.2.0
- .SH RETURN VALUE
- Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- .SH SEE ALSO
- .BR CURLINFO_CONN_ID (3),
- .BR curl_easy_getinfo (3),
- .BR curl_easy_setopt (3)
|
