2
0
mirror of https://codeberg.org/kiss-community/repo synced 2024-09-11 23:30:13 +00:00
repo/core/curl/files/CURLOPT_RESUME_FROM_LARGE.3

59 lines
1.8 KiB
Groff
Raw Normal View History

.\" generated by cd2nroff 0.1 from CURLOPT_RESUME_FROM_LARGE.md
2024-06-01 20:49:19 +00:00
.TH CURLOPT_RESUME_FROM_LARGE 3 "2024-06-01" 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
2024-03-30 18:28:04 +00:00
All
.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 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)