aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLOPT_POSTFIELDSIZE_LARGE.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_POSTFIELDSIZE_LARGE.md')
-rw-r--r--docs/libcurl/opts/CURLOPT_POSTFIELDSIZE_LARGE.md72
1 files changed, 72 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLOPT_POSTFIELDSIZE_LARGE.md b/docs/libcurl/opts/CURLOPT_POSTFIELDSIZE_LARGE.md
new file mode 100644
index 000000000..36fc0ff95
--- /dev/null
+++ b/docs/libcurl/opts/CURLOPT_POSTFIELDSIZE_LARGE.md
@@ -0,0 +1,72 @@
+---
+c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
+SPDX-License-Identifier: curl
+Title: CURLOPT_POSTFIELDSIZE_LARGE
+Section: 3
+Source: libcurl
+See-also:
+ - CURLOPT_COPYPOSTFIELDS (3)
+ - CURLOPT_POSTFIELDS (3)
+ - CURLOPT_POSTFIELDSIZE (3)
+---
+
+# NAME
+
+CURLOPT_POSTFIELDSIZE_LARGE - size of POST data pointed to
+
+# SYNOPSIS
+
+~~~c
+#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(3) (if used) to signal the end of data.
+
+# DEFAULT
+
+-1
+
+# PROTOCOLS
+
+HTTP(S)
+
+# EXAMPLE
+
+~~~c
+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.