Return to CURLOPT_MAXREDIRS.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_MAXREDIRS.3, revision 1.1

1.1     ! misho       1: .\" **************************************************************************
        !             2: .\" *                                  _   _ ____  _
        !             3: .\" *  Project                     ___| | | |  _ \| |
        !             4: .\" *                             / __| | | | |_) | |
        !             5: .\" *                            | (__| |_| |  _ <| |___
        !             6: .\" *                             \___|\___/|_| \_\_____|
        !             7: .\" *
        !             8: .\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
        !             9: .\" *
        !            10: .\" * This software is licensed as described in the file COPYING, which
        !            11: .\" * you should have received as part of this distribution. The terms
        !            12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
        !            13: .\" *
        !            14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
        !            15: .\" * copies of the Software, and permit persons to whom the Software is
        !            16: .\" * furnished to do so, under the terms of the COPYING file.
        !            17: .\" *
        !            18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
        !            19: .\" * KIND, either express or implied.
        !            20: .\" *
        !            21: .\" **************************************************************************
        !            22: .\"
        !            23: .TH CURLOPT_MAXREDIRS 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLOPT_MAXREDIRS \- maximum number of redirects allowed
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXREDIRS, long amount);
        !            31: .SH DESCRIPTION
        !            32: Pass a long. The set number will be the redirection limit \fIamount\fP. If
        !            33: that many redirections have been followed, the next redirect will cause an
        !            34: error (\fICURLE_TOO_MANY_REDIRECTS\fP). This option only makes sense if the
        !            35: \fICURLOPT_FOLLOWLOCATION(3)\fP is used at the same time.
        !            36: 
        !            37: Setting the limit to 0 will make libcurl refuse any redirect.
        !            38: 
        !            39: Set it to -1 for an infinite number of redirects.
        !            40: .SH DEFAULT
        !            41: -1, unlimited
        !            42: .SH PROTOCOLS
        !            43: HTTP(S)
        !            44: .SH EXAMPLE
        !            45: .nf
        !            46: curl = curl_easy_init();
        !            47: if(curl) {
        !            48:   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/");
        !            49: 
        !            50:   /* enable redirect following */
        !            51:   curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
        !            52: 
        !            53:   /* allow three redirects */
        !            54:   curl_easy_setopt(curl, CURLOPT_MAXREDIRS, 3L);
        !            55: 
        !            56:   /* Perform the request */
        !            57:   curl_easy_perform(curl);
        !            58: }
        !            59: .fi
        !            60: .SH AVAILABILITY
        !            61: Along with HTTP
        !            62: .SH RETURN VALUE
        !            63: Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
        !            64: .SH "SEE ALSO"
        !            65: .BR CURLOPT_FOLLOWLOCATION "(3), "