Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_RESUME_FROM (3)

Name

CURLOPT_RESUME_FROM - offset to resume transfer from

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RESUME_FROM, long from);

Description

CURLOPT_RESUME_FROM(3)     curl_easy_setopt options     CURLOPT_RESUME_FROM(3)



NAME
       CURLOPT_RESUME_FROM - offset to resume transfer from

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RESUME_FROM, long from);

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 CUR-
       LOPT_RESUME_FROM_LARGE(3) instead.

DEFAULT
       0, not used

PROTOCOLS
       HTTP, FTP, SFTP, FILE

EXAMPLE
       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);
       }

AVAILABILITY
       Always

RETURN VALUE
       Returns CURLE_OK


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLOPT_RESUME_FROM_LARGE(3), CURLOPT_RANGE(3), CURLOPT_INFILESIZE(3),



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source      was      downloaded       from        https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 November 26, 2021        CURLOPT_RESUME_FROM(3)