| .\" ************************************************************************** |
| .\" * _ _ ____ _ |
| .\" * Project ___| | | | _ \| | |
| .\" * / __| | | | |_) | | |
| .\" * | (__| |_| | _ <| |___ |
| .\" * \___|\___/|_| \_\_____| |
| .\" * |
| .\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al. |
| .\" * |
| .\" * This software is licensed as described in the file COPYING, which |
| .\" * you should have received as part of this distribution. The terms |
| .\" * are also available at https://curl.se/docs/copyright.html. |
| .\" * |
| .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| .\" * copies of the Software, and permit persons to whom the Software is |
| .\" * furnished to do so, under the terms of the COPYING file. |
| .\" * |
| .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| .\" * KIND, either express or implied. |
| .\" * |
| .\" ************************************************************************** |
| .\" |
| .TH CURLOPT_MAXREDIRS 3 "November 04, 2020" "libcurl 7.78.0" "curl_easy_setopt options" |
| |
| .SH NAME |
| CURLOPT_MAXREDIRS \- maximum number of redirects allowed |
| .SH SYNOPSIS |
| #include <curl/curl.h> |
| |
| CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXREDIRS, long amount); |
| .SH DESCRIPTION |
| Pass a long. The set number will be the redirection limit \fIamount\fP. If |
| that many redirections have been followed, the next redirect will cause an |
| error (\fICURLE_TOO_MANY_REDIRECTS\fP). This option only makes sense if the |
| \fICURLOPT_FOLLOWLOCATION(3)\fP 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. |
| .SH DEFAULT |
| -1, unlimited |
| .SH PROTOCOLS |
| HTTP(S) |
| .SH EXAMPLE |
| .nf |
| 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); |
| } |
| .fi |
| .SH AVAILABILITY |
| Along with HTTP |
| .SH RETURN VALUE |
| Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. |
| .SH "SEE ALSO" |
| .BR CURLOPT_FOLLOWLOCATION "(3), " |
