Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_MAXREDIRS (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

CURLOPT_MAXREDIRS(3)       curl_easy_setopt options       CURLOPT_MAXREDIRS(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 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(3) 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, "http://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.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_FOLLOWLOCATION(3),



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was    downloaded    from    https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    17 Jun 2014             CURLOPT_MAXREDIRS(3)