iw7-mod/deps/curl/docs/libcurl/opts/CURLOPT_MAXREDIRS.md
2024-08-13 05:15:34 -04:00

1.5 KiB

c SPDX-License-Identifier Title Section Source See-also
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. curl CURLOPT_MAXREDIRS 3 libcurl
CURLINFO_REDIRECT_COUNT (3)
CURLINFO_REDIRECT_URL (3)
CURLOPT_FOLLOWLOCATION (3)

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 is the redirection limit amount. If that many redirections have been followed, the next redirect triggers the error (CURLE_TOO_MANY_REDIRECTS). This option only makes sense if the CURLOPT_FOLLOWLOCATION(3) 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.

DEFAULT

30 (since 8.3.0), it was previously unlimited.

PROTOCOLS

HTTP(S)

EXAMPLE

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);
  }
}

AVAILABILITY

Along with HTTP

RETURN VALUE

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