curl / libcurl / API / curl_easy_setopt / CURLOPT_PUT

CURLOPT_PUT explained

Name

CURLOPT_PUT - make an HTTP PUT request

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PUT, long put);

Description

A parameter set to 1 tells the library to use HTTP PUT to transfer data. The data should be set with CURLOPT_READDATA and CURLOPT_INFILESIZE.

This option is deprecated since version 7.12.1. Use CURLOPT_UPLOAD.

Default

0, disabled

Protocols

This functionality affects http only

Example

static size_t read_cb(char *ptr, size_t size, size_t nmemb, void *userdata)
{
  FILE *src = userdata;
  /* copy as much data as possible into the 'ptr' buffer, but no more than
     'size' * 'nmemb' bytes */
  size_t retcode = fread(ptr, size, nmemb, src);
 
  return retcode;
}
 
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    FILE *src = fopen("local-file", "r");
    curl_off_t fsize = 123456; /* set this to the size of the input file */
 
    /* we want to use our own read function */
    curl_easy_setopt(curl, CURLOPT_READFUNCTION, read_cb);
 
    /* enable PUT */
    curl_easy_setopt(curl, CURLOPT_PUT, 1L);
 
    /* specify target */
    curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/dir/to/newfile");
 
    /* now specify which pointer to pass to our callback */
    curl_easy_setopt(curl, CURLOPT_READDATA, src);
 
    /* Set the size of the file to upload */
    curl_easy_setopt(curl, CURLOPT_INFILESIZE_LARGE, (curl_off_t)fsize);
 
    /* Now run off and do what you have been told */
    curl_easy_perform(curl);
  }
}

Deprecated

Deprecated since 7.12.1.

Availability

Added in curl 7.1

Return value

curl_easy_setopt returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors.