mirror of
https://codeberg.org/kiss-community/repo
synced 2024-08-19 20:56:58 +00:00
52 lines
1.4 KiB
Groff
52 lines
1.4 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_MAXREDIRS.md
|
|
.TH CURLOPT_MAXREDIRS 3 "March 15 2024" libcurl
|
|
.SH NAME
|
|
CURLOPT_MAXREDIRS \- maximum number of redirects allowed
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXREDIRS, long amount);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a long. The set number is the redirection limit \fIamount\fP. If that
|
|
many redirections have been followed, the next redirect triggers the 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 makes libcurl refuse any redirect.
|
|
|
|
Set it to \-1 for an infinite number of redirects. This allows your application
|
|
to get stuck in never\-ending redirect loops.
|
|
.SH DEFAULT
|
|
30 (since 8.3.0), it was previously unlimited.
|
|
.SH PROTOCOLS
|
|
HTTP(S)
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
CURL *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 CURLINFO_REDIRECT_COUNT (3),
|
|
.BR CURLINFO_REDIRECT_URL (3),
|
|
.BR CURLOPT_FOLLOWLOCATION (3)
|