docs/libcurl/opts/CURLOPT_RESUME_FROM.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 http://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 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_RESUME_FROM \- set a point to resume transfer from
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RESUME_FROM, long from);
  30 .SH DESCRIPTION
  31 Pass a long as parameter. It contains the offset in number of bytes that you
  32 want the transfer to start from. Set this option to 0 to make the transfer
  33 start from the beginning (effectively disabling resume). For FTP, set this
  34 option to -1 to make the transfer start from the end of the target file
  35 (useful to continue an interrupted upload).
  36
  37 When doing uploads with FTP, the resume position is where in the local/source
  38 file libcurl should try to resume the upload from and it will then append the
  39 source file to the remote target file.
  40
  41 If you need to resume a transfer beyond the 2GB limit, use
  42 \fICURLOPT_RESUME_FROM_LARGE(3)\fP instead.
  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_easy_setopt(curl, CURLOPT_URL, "ftp://example.com");
  52
  53   /* resume upload at byte index 200 */
  54   curl_easy_setopt(curl, CURLOPT_RESUME_FROM, 200L);
  55
  56   /* ask for upload */
  57   curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);
  58
  59   /* set total data amount to expect */
  60   curl_easy_setopt(curl, CURLOPT_INFILESIZE, size_of_file);
  61
  62   /* Perform the request */
  63   curl_easy_perform(curl);
  64 }
  65 .fi
  66 .SH AVAILABILITY
  67 Always
  68 .SH RETURN VALUE
  69 Returns CURLE_OK
  70 .SH "SEE ALSO"
  71 .BR CURLOPT_RESUME_FROM_LARGE "(3), " CURLOPT_RANGE "(3), "
  72 .BR CURLOPT_INFILESIZE "(3), "