curl/docs/libcurl/curl_easy_init.3

.\" $Id$
.\"
.TH curl_easy_init 3 "4 March 2002" "libcurl 7.8.1" "libcurl Manual"
.SH NAME
curl_easy_init - Start a libcurl easy session
.SH SYNOPSIS
.B #include <curl/curl.h>

.BI "CURL *curl_easy_init( );"

.SH DESCRIPTION
This function must be the first function to call, and it returns a CURL easy
handle that you must use as input to other easy-functions. curl_easy_init
initializes curl and this call \fBMUST\fP have a corresponding call to
\fIcurl_easy_cleanup(3)\fP when the operation is complete.

If you did not already call \fIcurl_global_init(3)\fP, 
\fIcurl_easy_init(3)\fP does it automatically.
This may be lethal in multi-threaded cases, since \fIcurl_global_init(3)\fP is
not thread-safe, and it may result in resource problems because there is
no corresponding cleanup.

You are strongly advised to not allow this automatic behaviour, by
calling \fIcurl_global_init(3)\fP yourself properly.
See the description in \fBlibcurl\fP(3) of global environment
requirements for details of how to use this function.

.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), " curl_global_init "(3), " curl_easy_reset "(3)"
ripped out from ../ and put in its own directory now 2002-03-04 05:09:48 -05:00			`.\" $Id$`
			`.\"`
mention 'easy handle' and not just handle, there will soon be other handles to keep track of too 2002-03-04 08:06:46 -05:00			`.TH curl_easy_init 3 "4 March 2002" "libcurl 7.8.1" "libcurl Manual"`
ripped out from ../ and put in its own directory now 2002-03-04 05:09:48 -05:00			`.SH NAME`
mention 'easy handle' and not just handle, there will soon be other handles to keep track of too 2002-03-04 08:06:46 -05:00			`curl_easy_init - Start a libcurl easy session`
ripped out from ../ and put in its own directory now 2002-03-04 05:09:48 -05:00			`.SH SYNOPSIS`
			`.B #include <curl/curl.h>`
minor format edits 2003-11-05 10:52:00 -05:00
ripped out from ../ and put in its own directory now 2002-03-04 05:09:48 -05:00			`.BI "CURL *curl_easy_init( );"`
minor format edits 2003-11-05 10:52:00 -05:00
ripped out from ../ and put in its own directory now 2002-03-04 05:09:48 -05:00			`.SH DESCRIPTION`
mention 'easy handle' and not just handle, there will soon be other handles to keep track of too 2002-03-04 08:06:46 -05:00			`This function must be the first function to call, and it returns a CURL easy`
			`handle that you must use as input to other easy-functions. curl_easy_init`
Tor Arntsen's major ispell patch 2004-03-24 16:40:45 -05:00			`initializes curl and this call \fBMUST\fP have a corresponding call to`
formatting update to produce better links with the new roffit version 2004-02-27 10:34:06 -05:00			`\fIcurl_easy_cleanup(3)\fP when the operation is complete.`
ripped out from ../ and put in its own directory now 2002-03-04 05:09:48 -05:00
Bryan Henderson turned the 'initialized' variable for curl_global_init() into a counter, and thus you can now do multiple curl_global_init() and you are then supposed to do the same amount of calls to curl_global_cleanup(). Bryan also updated the docs accordingly. 2006-01-15 18:55:53 -05:00			`If you did not already call \fIcurl_global_init(3)\fP,`
			`\fIcurl_easy_init(3)\fP does it automatically.`
clarified that curl_global_init() isn't thread-safe and that it might affect curl_easy_init() if you don't call curl_global_init() explicitly in your app 2005-12-23 18:22:23 -05:00			`This may be lethal in multi-threaded cases, since \fIcurl_global_init(3)\fP is`
Bryan Henderson turned the 'initialized' variable for curl_global_init() into a counter, and thus you can now do multiple curl_global_init() and you are then supposed to do the same amount of calls to curl_global_cleanup(). Bryan also updated the docs accordingly. 2006-01-15 18:55:53 -05:00			`not thread-safe, and it may result in resource problems because there is`
			`no corresponding cleanup.`

			`You are strongly advised to not allow this automatic behaviour, by`
			`calling \fIcurl_global_init(3)\fP yourself properly.`
			`See the description in \fBlibcurl\fP(3) of global environment`
			`requirements for details of how to use this function.`

ripped out from ../ and put in its own directory now 2002-03-04 05:09:48 -05:00			`.SH RETURN VALUE`
			`If this function returns NULL, something went wrong and you cannot use the`
			`other curl functions.`
			`.SH "SEE ALSO"`
see also the reset function 2004-08-17 08:39:10 -04:00			`.BR curl_easy_cleanup "(3), " curl_global_init "(3), " curl_easy_reset "(3)"`