Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_RESUME_FROM_LARGE.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, 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_RESUME_FROM_LARGE 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_RESUME_FROM_LARGE \- set a point to resume transfer from
27: .SH SYNOPSIS
28: .nf
29: #include <curl/curl.h>
30:
31: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RESUME_FROM_LARGE,
32: curl_off_t from);
33: .SH DESCRIPTION
34: Pass a curl_off_t as parameter. It contains the offset in number of bytes that
35: you want the transfer to start from. Set this option to 0 to make the transfer
36: start from the beginning (effectively disabling resume). For FTP, set this
37: option to -1 to make the transfer start from the end of the target file
38: (useful to continue an interrupted upload).
39:
40: When doing uploads with FTP, the resume position is where in the local/source
41: file libcurl should try to resume the upload from and it will then append the
42: source file to the remote target file.
43: .SH DEFAULT
44: 0, not used
45: .SH PROTOCOLS
46: HTTP, FTP, SFTP, FILE
47: .SH EXAMPLE
48: .nf
49: CURL *curl = curl_easy_init();
50: if(curl) {
51: curl_off_t resume_position = GET_IT_SOMEHOW;
52: curl_off_t file_size = GET_IT_SOMEHOW_AS_WELL;
53:
54: curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com");
55:
56: /* resuming upload at this position, possibly beyond 2GB */
57: curl_easy_setopt(curl, CURLOPT_RESUME_FROM_LARGE, resume_position);
58:
59: /* ask for upload */
60: curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);
61:
62: /* set total data amount to expect */
63: curl_easy_setopt(curl, CURLOPT_INFILESIZE_LARGE, file_size);
64:
65: /* Perform the request */
66: curl_easy_perform(curl);
67: }
68: .fi
69: .SH AVAILABILITY
70: Added in 7.11.0
71: .SH RETURN VALUE
72: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
73: .SH "SEE ALSO"
74: .BR CURLOPT_RESUME_FROM "(3), " CURLOPT_RANGE "(3), "
75: .BR CURLOPT_INFILESIZE_LARGE "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>