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