curl / libcurl / API / curl_easy_getinfo / CURLINFO_CONTENT_LENGTH_UPLOAD_T

CURLINFO_CONTENT_LENGTH_UPLOAD_T explained

Name

CURLINFO_CONTENT_LENGTH_UPLOAD_T - specified size of the upload

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONTENT_LENGTH_UPLOAD_T,
                           curl_off_t *content_length);

Description

Pass a pointer to a curl_off_t to receive the specified size of the upload. Stores -1 if the size is not known.

This is the size set by the client prior to the transfer start. The expected upload amount. Compare this with CURLINFO_SIZE_UPLOAD_T, which is the amount of data that was actually uploaded in the end. In many cases those two numbers are identical.

Protocols

This functionality affects all supported protocols

Example

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
 
    /* Perform the upload */
    result = curl_easy_perform(curl);
 
    if(result == CURLE_OK) {
      /* check the size */
      curl_off_t cl;
      result = curl_easy_getinfo(curl, CURLINFO_CONTENT_LENGTH_UPLOAD_T, &cl);
      if(result == CURLE_OK) {
        printf("Upload size: %" CURL_FORMAT_CURL_OFF_T "\n", cl);
      }
    }
  }
}

Availability

Added in curl 7.55.0

Return value

curl_easy_getinfo returns a CURLcode indicating success or error.

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