| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <[email protected]>, 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 |
For HTTP PUT uploads this option should not be used, since it may conflict with |
| 47 |
other options. If you need to upload arbitrary parts of a file (like for |
| 48 |
Amazon's web services) support is limited. We suggest set resume position using |
| 49 |
\fICURLOPT_RESUME_FROM(3)\fP, set end (resume+size) position using |
| 50 |
\fICURLOPT_INFILESIZE(3)\fP and seek to the resume position before initiating |
| 51 |
the transfer for each part. For more information refer to |
| 52 |
https://curl.haxx.se/mail/lib-2019-05/0012.html |
| 53 |
|
| 54 |
Pass a NULL to this option to disable the use of ranges. |
| 55 |
|
| 56 |
The application does not have to keep the string around after setting this |
| 57 |
option. |
| 58 |
.SH DEFAULT |
| 59 |
NULL |
| 60 |
.SH PROTOCOLS |
| 61 |
HTTP, FTP, FILE, RTSP and SFTP. |
| 62 |
.SH EXAMPLE |
| 63 |
.nf |
| 64 |
CURL *curl = curl_easy_init(); |
| 65 |
if(curl) { |
| 66 |
curl_easy_setopt(curl, CURLOPT_URL, "http://example.com"); |
| 67 |
|
| 68 |
/* get the first 200 bytes */ |
| 69 |
curl_easy_setopt(curl, CURLOPT_RANGE, "0-199"); |
| 70 |
|
| 71 |
/* Perform the request */ |
| 72 |
curl_easy_perform(curl); |
| 73 |
} |
| 74 |
.fi |
| 75 |
.SH AVAILABILITY |
| 76 |
FILE since 7.18.0, RTSP since 7.20.0 |
| 77 |
.SH RETURN VALUE |
| 78 |
Returns CURLE_OK on success or |
| 79 |
CURLE_OUT_OF_MEMORY if there was insufficient heap space. |
| 80 |
.SH "SEE ALSO" |
| 81 |
.BR CURLOPT_RESUME_FROM "(3), " |