docs/libcurl/opts/CURLOPT_POSTFIELDSIZE_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 https://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_POSTFIELDSIZE_LARGE 3 "February 03, 2016" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_POSTFIELDSIZE_LARGE \- size of POST data pointed to
  27 .SH SYNOPSIS
  28 .nf
  29 #include <curl/curl.h>
  30
  31 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_POSTFIELDSIZE_LARGE,
  32                           curl_off_t size);
  33 .SH DESCRIPTION
  34 If you want to post data to the server without having libcurl do a strlen() to
  35 measure the data size, this option must be used. When this option is used you
  36 can post fully binary data, which otherwise is likely to fail. If this size is
  37 set to -1, the library will use strlen() to get the size.
  38 .SH DEFAULT
  39 -1
  40 .SH PROTOCOLS
  41 HTTP(S)
  42 .SH EXAMPLE
  43 .nf
  44 CURL *curl = curl_easy_init();
  45 if(curl) {
  46   const char *data = large_chunk;
  47   curl_off_t length_of_data; /* set somehow */
  48
  49   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  50
  51   /* size of the POST data */
  52   curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE_LARGE, length_of_data);
  53
  54   curl_easy_setopt(curl, CURLOPT_POSTFIELDS, data);
  55
  56   curl_easy_perform(curl);
  57 }
  58 .fi
  59 .SH AVAILABILITY
  60 Along with HTTP
  61 .SH RETURN VALUE
  62 Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
  63 .SH "SEE ALSO"
  64 .BR CURLOPT_POSTFIELDS "(3), " CURLOPT_COPYPOSTFIELDS "(3), "
  65 .BR CURLOPT_POSTFIELDSIZE "(3), "