docs/libcurl/curl_easy_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 http://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 .\"
  23 .TH curl_easy_cleanup 3 "22 aug 2007" "libcurl 7.17.0" "libcurl Manual"
  24 .SH NAME
  25 curl_easy_cleanup - End a libcurl easy session
  26 .SH SYNOPSIS
  27 .B #include <curl/curl.h>
  28
  29 .BI "void curl_easy_cleanup(CURL *" handle ");"
  30
  31 .SH DESCRIPTION
  32 This function must be the last function to call for an easy session. It is the
  33 opposite of the \fIcurl_easy_init(3)\fP function and must be called with the
  34 same \fIhandle\fP as input that the curl_easy_init call returned.
  35
  36 This will effectively close all connections this handle has used and possibly
  37 has kept open until now. Don't call this function if you intend to transfer
  38 more files.
  39
  40 Occasionally you may get your progress callback or header callback called from
  41 within \fIcurl_easy_cleanup(3)\fP (if previously set for the handle using
  42 \fIcurl_easy_setopt(3)\fP). Like if libcurl decides to shut down the
  43 connection and the protocol is of a kind that requires a command/response
  44 sequence before disconnect. Examples of such protocols are FTP, POP3 and IMAP.
  45
  46 Any uses of the \fBhandle\fP after this function has been called and have
  47 returned, are illegal. This kills the handle and all memory associated with
  48 it!
  49
  50 With libcurl versions prior to 7.17.: when you've called this, you can safely
  51 remove all the strings you've previously told libcurl to use, as it won't use
  52 them anymore now.
  53 .SH RETURN VALUE
  54 None
  55 .SH "SEE ALSO"
  56 .BR curl_easy_init "(3), "
  57