curl / libcurl / API / curl_easy_setopt / CURLOPT_MAXREDIRS

CURLOPT_MAXREDIRS explained

Name

CURLOPT_MAXREDIRS - maximum number of redirects allowed

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXREDIRS, long amount);

Description

Pass a long. The set number will be the redirection limit amount. If that many redirections have been followed, the next redirect will cause an error (CURLE_TOO_MANY_REDIRECTS). This option only makes sense if the CURLOPT_FOLLOWLOCATION is used at the same time.

Setting the limit to 0 will make libcurl refuse any redirect.

Set it to -1 for an infinite number of redirects.

Default

-1, unlimited

Protocols

HTTP(S)

Example

curl = curl_easy_init();
if(curl) {
  curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
 
  /* enable redirect following */
  curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
 
  /* allow three redirects */
  curl_easy_setopt(curl, CURLOPT_MAXREDIRS, 3L);
 
  /* Perform the request */
  curl_easy_perform(curl);
}

Availability

Along with HTTP

Return value

Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.