aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLOPT_COPYPOSTFIELDS.3
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2014-06-19 17:59:00 +0200
committerDaniel Stenberg <daniel@haxx.se>2014-06-19 17:59:13 +0200
commita6cd174b2efed8f094e72b54fd0ccbfb65226afb (patch)
treefb563cfba9d64b4e5a11a508465235b9aaf0c1ba /docs/libcurl/opts/CURLOPT_COPYPOSTFIELDS.3
parentfede49532d11fc44a7c8cee77f2986629c81c3bb (diff)
opts: 37 additional man pages
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_COPYPOSTFIELDS.3')
-rw-r--r--docs/libcurl/opts/CURLOPT_COPYPOSTFIELDS.356
1 files changed, 56 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLOPT_COPYPOSTFIELDS.3 b/docs/libcurl/opts/CURLOPT_COPYPOSTFIELDS.3
new file mode 100644
index 000000000..7f4b7f40e
--- /dev/null
+++ b/docs/libcurl/opts/CURLOPT_COPYPOSTFIELDS.3
@@ -0,0 +1,56 @@
+.\" **************************************************************************
+.\" * _ _ ____ _
+.\" * Project ___| | | | _ \| |
+.\" * / __| | | | |_) | |
+.\" * | (__| |_| | _ <| |___
+.\" * \___|\___/|_| \_\_____|
+.\" *
+.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" *
+.\" * This software is licensed as described in the file COPYING, which
+.\" * you should have received as part of this distribution. The terms
+.\" * are also available at http://curl.haxx.se/docs/copyright.html.
+.\" *
+.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
+.\" * copies of the Software, and permit persons to whom the Software is
+.\" * furnished to do so, under the terms of the COPYING file.
+.\" *
+.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
+.\" * KIND, either express or implied.
+.\" *
+.\" **************************************************************************
+.\"
+.TH CURLOPT_COPYPOSTFIELDS 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
+.SH NAME
+CURLOPT_COPYPOSTFIELDS \- have libcurl copy data to POST
+.SH SYNOPSIS
+#include <curl/curl.h>
+
+CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COPYPOSTFIELDS, [argument]);
+.SH DESCRIPTION
+Pass a char * as parameter, which should be the full data to post in a HTTP
+POST operation. It behaves as the \fICURLOPT_POSTFIELDS(3)\fP option, but the
+original data is instead copied by the library, allowing the application to
+overwrite the original data after setting this option.
+
+Because data are copied, care must be taken when using this option in
+conjunction with \fICURLOPT_POSTFIELDSIZE(3)\fP or
+\fICURLOPT_POSTFIELDSIZE_LARGE(3)\fP: If the size has not been set prior to
+\fICURLOPT_COPYPOSTFIELDS(3)\fP, the data is assumed to be a zero terminated
+string; else the stored size informs the library about the byte count to
+copy. In any case, the size must not be changed after
+\fICURLOPT_COPYPOSTFIELDS(3)\fP, unless another \fICURLOPT_POSTFIELDS(3)\fP or
+\fICURLOPT_COPYPOSTFIELDS(3)\fP option is issued.
+.SH DEFAULT
+NULL
+.SH PROTOCOLS
+HTTP
+.SH EXAMPLE
+TODO
+.SH AVAILABILITY
+Added in 7.17.1
+.SH RETURN VALUE
+Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
+.SH "SEE ALSO"
+.BR CURLOPT_POSTFIELDS "(3), " CURLOPT_POSTFIELDSIZE "(3), "