curl / libcurl / API / curl_easy_setopt / CURLOPT_POSTFIELDSIZE_LARGE

CURLOPT_POSTFIELDSIZE_LARGE explained

Name

CURLOPT_POSTFIELDSIZE_LARGE - size of POST data pointed to

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_POSTFIELDSIZE_LARGE,
                          curl_off_t size);

Description

If you want to post static data to the server without having libcurl do a strlen() to measure the data size, this option must be used. When this option is used you can post fully binary data, which otherwise is likely to fail. If this size is set to -1, libcurl uses strlen() to get the size or relies on the CURLOPT_READFUNCTION (if used) to signal the end of data.

Default

-1

Protocols

HTTP(S)

Example

extern char *large_chunk; /* pointer to somewhere */
 
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    const char *data = large_chunk;
    curl_off_t length_of_data; /* set somehow */
 
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
 
    /* size of the POST data */
    curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE_LARGE, length_of_data);
 
    curl_easy_setopt(curl, CURLOPT_POSTFIELDS, data);
 
    curl_easy_perform(curl);
  }
}

Availability

Along with HTTP

Return value

Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.

See also

CURLOPT_COPYPOSTFIELDS(3), CURLOPT_POSTFIELDS(3), CURLOPT_POSTFIELDSIZE(3)

This HTML page was made with roffit.