Return to curl_share_init.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl

Annotation of embedaddon/curl/docs/libcurl/curl_share_init.3, revision 1.1

1.1     ! misho       1: .\" **************************************************************************
        !             2: .\" *                                  _   _ ____  _
        !             3: .\" *  Project                     ___| | | |  _ \| |
        !             4: .\" *                             / __| | | | |_) | |
        !             5: .\" *                            | (__| |_| |  _ <| |___
        !             6: .\" *                             \___|\___/|_| \_\_____|
        !             7: .\" *
        !             8: .\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
        !             9: .\" *
        !            10: .\" * This software is licensed as described in the file COPYING, which
        !            11: .\" * you should have received as part of this distribution. The terms
        !            12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
        !            13: .\" *
        !            14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
        !            15: .\" * copies of the Software, and permit persons to whom the Software is
        !            16: .\" * furnished to do so, under the terms of the COPYING file.
        !            17: .\" *
        !            18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
        !            19: .\" * KIND, either express or implied.
        !            20: .\" *
        !            21: .\" **************************************************************************
        !            22: .TH curl_share_init 3 "March 23, 2020" "libcurl 7.70.0" "libcurl Manual"
        !            23: 
        !            24: .SH NAME
        !            25: curl_share_init - Create a shared object
        !            26: .SH SYNOPSIS
        !            27: .B #include <curl/curl.h>
        !            28: .sp
        !            29: .BI "CURLSH *curl_share_init( );"
        !            30: .ad
        !            31: .SH DESCRIPTION
        !            32: This function returns a CURLSH handle to be used as input to all the other
        !            33: share-functions, sometimes referred to as a share handle in some places in the
        !            34: documentation. This init call MUST have a corresponding call to
        !            35: \fIcurl_share_cleanup\fP when all operations using the share are complete.
        !            36: 
        !            37: This \fIshare handle\fP is what you pass to curl using the
        !            38: \fICURLOPT_SHARE(3)\fP option with \fIcurl_easy_setopt(3)\fP, to make that
        !            39: specific curl handle use the data in this share.
        !            40: .SH RETURN VALUE
        !            41: If this function returns NULL, something went wrong (out of memory, etc.)
        !            42: and therefore the share object was not created.
        !            43: .SH "SEE ALSO"
        !            44: .BR curl_share_cleanup "(3), " curl_share_setopt "(3)"