1 .\" **************************************************************************
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
8 .\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al.
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.
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.
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
21 .\" **************************************************************************
23 .TH CURLOPT_RANGE 3 "December 21, 2016" "libcurl 7.56.1" "curl_easy_setopt options"
26 CURLOPT_RANGE \- set byte range to request
28 #include <curl/curl.h>
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RANGE, char *range);
32 Pass a char * as parameter, which should contain the specified range you want
33 to retrieve. It should be in the format "X-Y", where either X or Y may be left
34 out and X and Y are byte indexes.
36 HTTP transfers also support several intervals, separated with commas as in
37 \fI"X-Y,N-M"\fP. Using this kind of multiple intervals will cause the HTTP
38 server to send the response document in pieces (using standard MIME separation
39 techniques). Unfortunately, the HTTP standard (RFC 7233 section 3.1) allows
40 servers to ignore range requests so even when you set \fICURLOPT_RANGE(3)\fP
41 for a request, you may end up getting the full response sent back.
43 For RTSP, the formatting of a range should follow RFC2326 Section 12.29. For
44 RTSP, byte ranges are \fBnot\fP permitted. Instead, ranges should be given in
45 npt, utc, or smpte formats.
47 Pass a NULL to this option to disable the use of ranges.
49 The application does not have to keep the string around after setting this
54 HTTP, FTP, FILE, RTSP and SFTP.
57 CURL *curl = curl_easy_init();
59 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
61 /* get the first 200 bytes */
62 curl_easy_setopt(curl, CURLOPT_RANGE, "0-199");
64 /* Perform the request */
65 curl_easy_perform(curl);
69 FILE since 7.18.0, RTSP since 7.20.0
71 Returns CURLE_OK on success or
72 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
74 .BR CURLOPT_RESUME_FROM "(3), "