mirror of
https://codeberg.org/kiss-community/repo
synced 2025-01-05 01:10:07 -07:00
60 lines
1.7 KiB
Groff
60 lines
1.7 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_RESUME_FROM.md
|
|
.TH CURLOPT_RESUME_FROM 3 "2024-11-09" libcurl
|
|
.SH NAME
|
|
CURLOPT_RESUME_FROM \- offset to resume transfer from
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RESUME_FROM, long from);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a long 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 then appends the
|
|
source file to the remote target file.
|
|
|
|
If you need to resume a transfer beyond the 2GB limit, use
|
|
\fICURLOPT_RESUME_FROM_LARGE(3)\fP instead.
|
|
.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) {
|
|
long size_of_file;
|
|
|
|
curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com");
|
|
|
|
/* resume upload at byte index 200 */
|
|
curl_easy_setopt(curl, CURLOPT_RESUME_FROM, 200L);
|
|
|
|
/* ask for upload */
|
|
curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);
|
|
|
|
/* set total data amount to expect */
|
|
curl_easy_setopt(curl, CURLOPT_INFILESIZE, size_of_file);
|
|
|
|
/* Perform the request */
|
|
curl_easy_perform(curl);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in curl 7.1
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK
|
|
.SH SEE ALSO
|
|
.BR CURLOPT_INFILESIZE (3),
|
|
.BR CURLOPT_RANGE (3),
|
|
.BR CURLOPT_RESUME_FROM_LARGE (3)
|