curl/docs/libcurl/curl_global_init.3

.\" You can view this file with:
.\" nroff -man [file]
.\" $Id$
.\"
.TH curl_global_init 3 "11 May 2004" "libcurl 7.12" "libcurl Manual"
.SH NAME
curl_global_init - Global libcurl initialisation
.SH SYNOPSIS
.B #include <curl/curl.h>
.sp
.BI "CURLcode curl_global_init(long " flags ");"
.ad
.SH DESCRIPTION
This function sets up the program environment that libcurl needs.  Think of it
as an extension of the library loader.

This function must be called at least once within a program (a program is all
the code that shares a memory space) before the program calls any other
function in libcurl.  The environment it sets up is constant for the life of
the program and is the same for every program, so multiple calls have the same
effect as one call.

The flags option is a bit pattern that tells libcurl exactly what features to
init, as described below. Set the desired bits by ORing the values together.
In normal operation, you must specify CURL_GLOBAL_ALL.  Don't use any other
value unless you are familiar with and mean to control internal operations of
libcurl.

\fBThis function is not thread safe.\fP You must not call it when any other
thread in the program (i.e. a thread sharing the same memory) is running.
This doesn't just mean no other thread that is using libcurl.  Because
\fIcurl_global_init()\fP calls functions of other libraries that are similarly
thread unsafe, it could conflict with any other thread that uses these other
libraries.

See the description in \fBlibcurl\fP(3) of global environment requirements for
details of how to use this function.

.SH FLAGS
.TP 5
.B CURL_GLOBAL_ALL
Initialize everything possible. This sets all known bits.
.TP
.B CURL_GLOBAL_SSL
Initialize SSL
.TP
.B CURL_GLOBAL_WIN32
Initialize the Win32 socket libraries.
.TP
.B CURL_GLOBAL_NOTHING
Initialise nothing extra. This sets no bit.
.SH RETURN VALUE
If this function returns non-zero, something went wrong and you cannot use the
other curl functions.
.SH "SEE ALSO"
.BR curl_global_init_mem "(3), "
.BR curl_global_cleanup "(3), "
.BR curl_easy_init "(3) "
.BR libcurl "(3) "
ripped out from ../ and put in its own directory now 2002-03-04 11:09:48 +01:00			`.\" You can view this file with:`
			`.\" nroff -man [file]`
			`.\" $Id$`
			`.\"`
curl_global_init_mem() allows the memory functions to be replaced. memory.h is included everywhere for this. 2004-05-11 13:30:23 +02:00			`.TH curl_global_init 3 "11 May 2004" "libcurl 7.12" "libcurl Manual"`
ripped out from ../ and put in its own directory now 2002-03-04 11:09:48 +01:00			`.SH NAME`
			`curl_global_init - Global libcurl initialisation`
			`.SH SYNOPSIS`
			`.B #include <curl/curl.h>`
			`.sp`
			`.BI "CURLcode curl_global_init(long " flags ");"`
			`.ad`
			`.SH DESCRIPTION`
[Hiper-related work] Added a function called curl_multi_assign() that will set a private pointer added to the internal libcurl hash table for the particular socket passed in to this function. 2006-07-27 00:19:42 +02:00			`This function sets up the program environment that libcurl needs. Think of it`
			`as an extension of the library loader.`
ripped out from ../ and put in its own directory now 2002-03-04 11:09:48 +01:00
[Hiper-related work] Added a function called curl_multi_assign() that will set a private pointer added to the internal libcurl hash table for the particular socket passed in to this function. 2006-07-27 00:19:42 +02:00			`This function must be called at least once within a program (a program is all`
			`the code that shares a memory space) before the program calls any other`
			`function in libcurl. The environment it sets up is constant for the life of`
			`the program and is the same for every program, so multiple calls have the same`
			`effect as one call.`
ripped out from ../ and put in its own directory now 2002-03-04 11:09:48 +01: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-16 00:55:53 +01:00			`The flags option is a bit pattern that tells libcurl exactly what features to`
ripped out from ../ and put in its own directory now 2002-03-04 11:09:48 +01:00			`init, as described below. Set the desired bits by ORing the values together.`
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-16 00:55:53 +01:00			`In normal operation, you must specify CURL_GLOBAL_ALL. Don't use any other`
[Hiper-related work] Added a function called curl_multi_assign() that will set a private pointer added to the internal libcurl hash table for the particular socket passed in to this function. 2006-07-27 00:19:42 +02:00			`value unless you are familiar with and mean to control internal operations of`
			`libcurl.`
ripped out from ../ and put in its own directory now 2002-03-04 11:09:48 +01:00
[Hiper-related work] Added a function called curl_multi_assign() that will set a private pointer added to the internal libcurl hash table for the particular socket passed in to this function. 2006-07-27 00:19:42 +02:00			`\fBThis function is not thread safe.\fP You must not call it when any other`
			`thread in the program (i.e. a thread sharing the same memory) is running.`
			`This doesn't just mean no other thread that is using libcurl. Because`
			`\fIcurl_global_init()\fP calls functions of other libraries that are similarly`
			`thread unsafe, it could conflict with any other thread that uses these other`
			`libraries.`
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-16 00:55:53 +01:00
[Hiper-related work] Added a function called curl_multi_assign() that will set a private pointer added to the internal libcurl hash table for the particular socket passed in to this function. 2006-07-27 00:19:42 +02:00			`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 11:09:48 +01:00
			`.SH FLAGS`
			`.TP 5`
			`.B CURL_GLOBAL_ALL`
			`Initialize everything possible. This sets all known bits.`
			`.TP`
			`.B CURL_GLOBAL_SSL`
			`Initialize SSL`
			`.TP`
			`.B CURL_GLOBAL_WIN32`
formatting update to produce better links with the new roffit version 2004-02-27 16:34:06 +01:00			`Initialize the Win32 socket libraries.`
ripped out from ../ and put in its own directory now 2002-03-04 11:09:48 +01:00			`.TP`
			`.B CURL_GLOBAL_NOTHING`
			`Initialise nothing extra. This sets no bit.`
			`.SH RETURN VALUE`
			`If this function returns non-zero, something went wrong and you cannot use the`
			`other curl functions.`
			`.SH "SEE ALSO"`
curl_global_init_mem() allows the memory functions to be replaced. memory.h is included everywhere for this. 2004-05-11 13:30:23 +02:00			`.BR curl_global_init_mem "(3), "`
ripped out from ../ and put in its own directory now 2002-03-04 11:09:48 +01:00			`.BR curl_global_cleanup "(3), "`
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-16 00:55:53 +01:00			`.BR curl_easy_init "(3) "`
			`.BR libcurl "(3) "`