| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758 |
- .\" generated by cd2nroff 0.1 from CURLOPT_RESUME_FROM_LARGE.md
- .TH CURLOPT_RESUME_FROM_LARGE 3 "2025-01-17" libcurl
- .SH NAME
- CURLOPT_RESUME_FROM_LARGE \- offset to resume transfer from
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RESUME_FROM_LARGE,
- curl_off_t from);
- .fi
- .SH DESCRIPTION
- Pass a curl_off_t as parameter. It contains the offset in number of bytes that
- you want the transfer to start from. Set this option to 0 to make the transfer
- start from the beginning (effectively disabling resume). For FTP, set this
- option to \-1 to make the transfer start from the end of the target file
- (useful to continue an interrupted upload).
- When doing uploads with FTP, the resume position is where in the local/source
- file libcurl should try to resume the upload from and it appends the source
- file to the remote target file.
- .SH DEFAULT
- 0, not used
- .SH PROTOCOLS
- This functionality affects all supported protocols
- .SH EXAMPLE
- .nf
- int main(void)
- {
- CURL *curl = curl_easy_init();
- if(curl) {
- curl_off_t resume_position; /* get it somehow */
- curl_off_t file_size; /* get it somehow as well */
- curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com");
- /* resuming upload at this position, possibly beyond 2GB */
- curl_easy_setopt(curl, CURLOPT_RESUME_FROM_LARGE, resume_position);
- /* ask for upload */
- curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);
- /* set total data amount to expect */
- curl_easy_setopt(curl, CURLOPT_INFILESIZE_LARGE, file_size);
- /* Perform the request */
- curl_easy_perform(curl);
- }
- }
- .fi
- .SH AVAILABILITY
- Added in curl 7.11.0
- .SH RETURN VALUE
- Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- .SH SEE ALSO
- .BR CURLOPT_INFILESIZE_LARGE (3),
- .BR CURLOPT_RANGE (3),
- .BR CURLOPT_RESUME_FROM (3)
|