curl/docs/curl_easy_init.3

33 lines
1.1 KiB
Groff
Raw Normal View History

2000-05-22 15:02:54 -04:00
.\" You can view this file with:
.\" nroff -man [file]
2000-06-20 11:31:26 -04:00
.\" Written by daniel@haxx.se
2000-05-22 15:02:54 -04:00
.\"
2001-03-05 10:51:34 -05:00
.TH curl_easy_init 3 "5 March 2001" "libcurl 7.7" "libcurl Manual"
2000-05-22 15:02:54 -04:00
.SH NAME
2001-03-05 10:51:34 -05:00
curl_easy_init - Start a libcurl session
2000-05-22 15:02:54 -04:00
.SH SYNOPSIS
2001-03-05 10:51:34 -05:00
.B #include <curl/curl.h>
2000-05-22 15:02:54 -04:00
.sp
.BI "CURL *curl_easy_init( );"
.ad
.SH DESCRIPTION
This function must be the first function to call, and it returns a CURL handle
that you shall use as input to the other easy-functions. The init calls
intializes curl and this call MUST have a corresponding call to
.I curl_easy_cleanup
when the operation is complete.
2000-09-28 06:26:44 -04:00
On win32 systems, you need to init the winsock stuff manually, libcurl will
not do that for you. WSAStartup() and WSACleanup() should be used accordingly.
2001-03-05 10:51:34 -05:00
Using libcurl 7.7 and later, you should perform all your sequential file
transfers using the same curl handle. This enables libcurl to use persistant
connections where possible.
2000-05-22 15:02:54 -04:00
.SH RETURN VALUE
If this function returns NULL, something went wrong and you cannot use the
other curl functions.
.SH "SEE ALSO"
.BR curl_easy_cleanup "(3), "
.SH BUGS
Surely there are some, you tell me!