.\" generated by cd2nroff 0.1 from CURLOPT_TIMEOUT_MS.md
.TH CURLOPT_TIMEOUT_MS 3 "2024-09-18" libcurl
.SH NAME
CURLOPT_TIMEOUT_MS \- maximum time the transfer is allowed to complete
.SH SYNOPSIS
.nf
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMEOUT_MS, long timeout);
.fi
.SH DESCRIPTION
Pass a long as parameter containing \fItimeout\fP \- the maximum time in
milliseconds that you allow the libcurl transfer operation to take.

See \fICURLOPT_TIMEOUT(3)\fP for details.
.SH DEFAULT
0 (zero) which means it never times out during transfer.
.SH PROTOCOLS
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");

    /* complete within 20000 milliseconds */
    curl_easy_setopt(curl, CURLOPT_TIMEOUT_MS, 20000L);

    curl_easy_perform(curl);
  }
}
.fi
.SH AVAILABILITY
Added in curl 7.16.2
.SH RETURN VALUE
Returns CURLE_OK
.SH SEE ALSO
.BR CURLOPT_CONNECTTIMEOUT (3),
.BR CURLOPT_LOW_SPEED_LIMIT (3),
.BR CURLOPT_TCP_KEEPALIVE (3),
.BR CURLOPT_TIMEOUT (3)