docs/libcurl/curl_global_init.3

   1 .\" You can view this file with:
   2 .\" nroff -man [file]
   3 .\" $Id$
   4 .\"
   5 .TH curl_global_init 3 "11 May 2004" "libcurl 7.12" "libcurl Manual"
   6 .SH NAME
   7 curl_global_init - Global libcurl initialisation
   8 .SH SYNOPSIS
   9 .B #include <curl/curl.h>
  10 .sp
  11 .BI "CURLcode curl_global_init(long " flags ");"
  12 .ad
  13 .SH DESCRIPTION
  14 This function sets up the program environment that libcurl needs.  Think
  15 of it as an extension of the library loader.
  16
  17 This function must be called at least once within a program (a program is
  18 all the code that shares a memory space) before the program calls any other
  19 function in libcurl.  The environment it sets up is constant for the life
  20 of the program and is the same for every program, so multiple calls have
  21 the same effect as one call.
  22
  23 The flags option is a bit pattern that tells libcurl exactly what features to
  24 init, as described below. Set the desired bits by ORing the values together.
  25 In normal operation, you must specify CURL_GLOBAL_ALL.  Don't use any other
  26 value unless you are familiar with and mean to control internal operations
  27 of libcurl.
  28
  29 \fBThis function is not thread safe.\fP  You must not call it when any
  30 other thread in the program (i.e. a thread sharing the same memory) is
  31 running.  This doesn't just mean no other thread that is using
  32 libcurl.  Because \fIcurl_global_init()\fP calls functions of other
  33 libraries that are similarly thread unsafe, it could conflict with any
  34 other thread that uses these other libraries.
  35
  36 See the description in \fBlibcurl\fP(3) of global environment
  37 requirements for details of how to use this function.
  38
  39 .SH FLAGS
  40 .TP 5
  41 .B CURL_GLOBAL_ALL
  42 Initialize everything possible. This sets all known bits.
  43 .TP
  44 .B CURL_GLOBAL_SSL
  45 Initialize SSL
  46 .TP
  47 .B CURL_GLOBAL_WIN32
  48 Initialize the Win32 socket libraries.
  49 .TP
  50 .B CURL_GLOBAL_NOTHING
  51 Initialise nothing extra. This sets no bit.
  52 .SH RETURN VALUE
  53 If this function returns non-zero, something went wrong and you cannot use the
  54 other curl functions.
  55 .SH "SEE ALSO"
  56 .BR curl_global_init_mem "(3), "
  57 .BR curl_global_cleanup "(3), "
  58 .BR curl_easy_init "(3) "
  59 .BR libcurl "(3) "