docs/libcurl/opts/CURLOPT_MAXREDIRS.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 http://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 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_MAXREDIRS \- maximum number of redirects allowed
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXREDIRS, long amount);
  30 .SH DESCRIPTION
  31 Pass a long. The set number will be the redirection limit \fIamount\fP. If
  32 that many redirections have been followed, the next redirect will cause an
  33 error (\fICURLE_TOO_MANY_REDIRECTS\fP). This option only makes sense if the
  34 \fICURLOPT_FOLLOWLOCATION(3)\fP is used at the same time.
  35
  36 Setting the limit to 0 will make libcurl refuse any redirect.
  37
  38 Set it to -1 for an infinite number of redirects.
  39 .SH DEFAULT
  40 -1, unlimited
  41 .SH PROTOCOLS
  42 HTTP(S)
  43 .SH EXAMPLE
  44 .nf
  45 curl = curl_easy_init();
  46 if(curl) {
  47   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/");
  48
  49   /* enable redirect following */
  50   curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
  51
  52   /* allow three redirects */
  53   curl_easy_setopt(curl, CURLOPT_MAXREDIRS, 3L);
  54
  55   /* Perform the request */
  56   curl_easy_perform(curl);
  57 }
  58 .fi
  59 .SH AVAILABILITY
  60 Along with HTTP
  61 .SH RETURN VALUE
  62 Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
  63 .SH "SEE ALSO"
  64 .BR CURLOPT_FOLLOWLOCATION "(3), "