docs/libcurl/curl_share_cleanup.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2011, 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_cleanup 3 "February 03, 2016" "libcurl 7.59.0" "libcurl Manual"
  23
  24 .SH NAME
  25 curl_share_cleanup - Clean up a shared object
  26 .SH SYNOPSIS
  27 .B #include <curl/curl.h>
  28 .sp
  29 .BI "CURLSHcode curl_share_cleanup(CURLSH *" share_handle ");"
  30 .ad
  31 .SH DESCRIPTION
  32 This function deletes a shared object. The share handle cannot be used anymore
  33 when this function has been called.
  34
  35 .SH RETURN VALUE
  36 CURLSHE_OK (zero) means that the option was set properly, non-zero means an
  37 error occurred as \fI<curl/curl.h>\fP defines. See the \fIlibcurl-errors.3\fP
  38 man page for the full list with descriptions. If an error occurs, then the
  39 share object will not be deleted.
  40 .SH "SEE ALSO"
  41 .BR curl_share_init "(3), " curl_share_setopt "(3)"