aboutsummaryrefslogtreecommitdiffstats
path: root/docs/libcurl/curl_easy_perform.3
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libcurl/curl_easy_perform.3')
-rw-r--r--docs/libcurl/curl_easy_perform.339
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/libcurl/curl_easy_perform.3 b/docs/libcurl/curl_easy_perform.3
new file mode 100644
index 00000000..1ed006b0
--- /dev/null
+++ b/docs/libcurl/curl_easy_perform.3
@@ -0,0 +1,39 @@
+.\" You can view this file with:
+.\" nroff -man [file]
+.\"
+.TH curl_easy_perform 3 "5 Mar 2001" "libcurl 7.7" "libcurl Manual"
+.SH NAME
+curl_easy_perform - Perform a file transfer
+.SH SYNOPSIS
+.B #include <curl/curl.h>
+.sp
+.BI "CURLcode curl_easy_perform(CURL *" handle ");"
+.ad
+.SH DESCRIPTION
+This function is called after the init and all the \fIcurl_easy_setopt(3)\fP
+calls are made, and will perform the transfer as described in the options. It
+must be called with the same
+.I handle
+as input as the curl_easy_init call returned.
+
+You can do any amount of calls to \fIcurl_easy_perform(3)\fP while using the
+same handle. If you intend to transfer more than one file, you are even
+encouraged to do so. libcurl will then attempt to re-use the same connection
+for the following transfers, thus making the operations faster, less CPU
+intense and using less network resources. Just note that you will have to use
+\fIcurl_easy_setopt(3)\fP between the invokes to set options for the following
+curl_easy_perform.
+
+You must never call this function simultaneously from two places using the
+same handle. Let the function return first before invoking it another time. If
+you want parallel transfers, you must use several curl handles.
+.SH RETURN VALUE
+0 means everything was ok, non-zero means an error occurred as
+.I <curl/curl.h>
+defines. If the CURLOPT_ERRORBUFFER was set with
+.I curl_easy_setopt
+there will be a readable error message in the error buffer when non-zero is
+returned.
+.SH "SEE ALSO"
+.BR curl_easy_init "(3), " curl_easy_setopt "(3), "
+