| .\" ************************************************************************** |
| .\" * _ _ ____ _ |
| .\" * Project ___| | | | _ \| | |
| .\" * / __| | | | |_) | | |
| .\" * | (__| |_| | _ <| |___ |
| .\" * \___|\___/|_| \_\_____| |
| .\" * |
| .\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al. |
| .\" * |
| .\" * This software is licensed as described in the file COPYING, which |
| .\" * you should have received as part of this distribution. The terms |
| .\" * are also available at https://curl.se/docs/copyright.html. |
| .\" * |
| .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| .\" * copies of the Software, and permit persons to whom the Software is |
| .\" * furnished to do so, under the terms of the COPYING file. |
| .\" * |
| .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| .\" * KIND, either express or implied. |
| .\" * |
| .\" ************************************************************************** |
| .\" |
| .TH CURLOPT_RESUME_FROM 3 "November 04, 2020" "libcurl 7.78.0" "curl_easy_setopt options" |
| |
| .SH NAME |
| CURLOPT_RESUME_FROM \- set a point to resume transfer from |
| .SH SYNOPSIS |
| #include <curl/curl.h> |
| |
| CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RESUME_FROM, long from); |
| .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 will then append 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 |
| HTTP, FTP, SFTP, FILE |
| .SH EXAMPLE |
| .nf |
| CURL *curl = curl_easy_init(); |
| if(curl) { |
| 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 |
| Always |
| .SH RETURN VALUE |
| Returns CURLE_OK |
| .SH "SEE ALSO" |
| .BR CURLOPT_RESUME_FROM_LARGE "(3), " CURLOPT_RANGE "(3), " |
| .BR CURLOPT_INFILESIZE "(3), " |