mingw/share/man/man3/curl_share_init.3

   1 .\" $Id: curl_share_init.3,v 1.4 2004/03/24 21:40:45 bagder Exp $
   2 .\"
   3 .TH curl_share_init 3 "8 Aug 2003" "libcurl 7.10.7" "libcurl Manual"
   4 .SH NAME
   5 curl_share_init - Create a shared object
   6 .SH SYNOPSIS
   7 .B #include <curl/curl.h>
   8 .sp
   9 .BI "CURLSH *curl_share_init( );"
  10 .ad
  11 .SH DESCRIPTION
  12 This function returns a CURLSH handle to be used as input to all the other
  13 share-functions, sometimes referred to as a share handle on some places in the
  14 documentation. This init call MUST have a corresponding call to
  15 \fIcurl_share_cleanup\fP when all operations using the share are complete.
  16
  17 This \fIshare handle\fP is what you pass to curl using the \fICURLOPT_SHARE\fP
  18 option with \fIcurl_easy_setopt(3)\fP, to make that specific curl handle use
  19 the data in this share.
  20 .SH RETURN VALUE
  21 If this function returns NULL, something went wrong (out of memory, etc.)
  22 and therefore the share object was not created.
  23 .SH "SEE ALSO"
  24 .BR curl_share_cleanup "(3), " curl_share_setopt "(3)"
  25