docs/libcurl/opts/CURLOPT_RANGE.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2016, 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_RANGE 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_RANGE \- set byte range to request
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RANGE, char *range);
  30 .SH DESCRIPTION
  31 Pass a char * as parameter, which should contain the specified range you want
  32 to retrieve. It should be in the format "X-Y", where either X or Y may be left
  33 out and X and Y are byte indexes.
  34
  35 HTTP transfers also support several intervals, separated with commas as in
  36 \fI"X-Y,N-M"\fP. Using this kind of multiple intervals will cause the HTTP
  37 server to send the response document in pieces (using standard MIME separation
  38 techniques). Unfortunately, the HTTP standard (RFC 7233 section 3.1) allows
  39 servers to ignore range requests so even when you set \fICURLOPT_RANGE(3)\fP
  40 for a request, you may end up getting the full response sent back.
  41
  42 For RTSP, the formatting of a range should follow RFC2326 Section 12.29. For
  43 RTSP, byte ranges are \fBnot\fP permitted. Instead, ranges should be given in
  44 npt, utc, or smpte formats.
  45
  46 Pass a NULL to this option to disable the use of ranges.
  47 .SH DEFAULT
  48 NULL
  49 .SH PROTOCOLS
  50 HTTP, FTP, FILE, RTSP and SFTP.
  51 .SH EXAMPLE
  52 .nf
  53 CURL *curl = curl_easy_init();
  54 if(curl) {
  55   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  56
  57   /* get the first 200 bytes */
  58   curl_easy_setopt(curl, CURLOPT_RANGE, "0-199");
  59
  60   /* Perform the request */
  61   curl_easy_perform(curl);
  62 }
  63 .fi
  64 .SH AVAILABILITY
  65 FILE since 7.18.0, RTSP since 7.20.0
  66 .SH RETURN VALUE
  67 Returns CURLE_OK on success or
  68 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  69 .SH "SEE ALSO"
  70 .BR CURLOPT_RESUME_FROM "(3), "