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