~ubuntu-branches/ubuntu/precise/curl/precise-proposed

.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  Project                     ___| | | |  _ \| |

.\" *                             / __| | | | |_) | |

.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * This software is licensed as described in the file COPYING, which

.\" * you should have received as part of this distribution. The terms

.\" * are also available at http://curl.haxx.se/docs/copyright.html.

.\" *

.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell

.\" * copies of the Software, and permit persons to whom the Software is

.\" * furnished to do so, under the terms of the COPYING file.

.\" *

.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY

.\" * KIND, either express or implied.

.\" *

.\" **************************************************************************

.\"

.TH curl_easy_cleanup 3 "22 aug 2007" "libcurl 7.17.0" "libcurl Manual"

.SH NAME

curl_easy_cleanup - End a libcurl easy session

.SH SYNOPSIS

.B #include <curl/curl.h>

.BI "void curl_easy_cleanup(CURL *" handle ");"

.SH DESCRIPTION

This function must be the last function to call for an easy session. It is the

opposite of the \fIcurl_easy_init(3)\fP function and must be called with the

same \fIhandle\fP as input that the curl_easy_init call returned.

This will effectively close all connections this handle has used and possibly

has kept open until now. Don't call this function if you intend to transfer

more files.

Occasionally you may get your progress callback or header callback called from

within \fIcurl_easy_cleanup(3)\fP (if previously set for the handle using

\fIcurl_easy_setopt(3)\fP). Like if libcurl decides to shut down the

connection and the protocol is of a kind that requires a command/response

sequence before disconnect. Examples of such protocols are FTP, POP3 and IMAP.

Any uses of the \fBhandle\fP after this function has been called and have

returned, are illegal. This kills the handle and all memory associated with

it!

With libcurl versions prior to 7.17.: when you've called this, you can safely

remove all the strings you've previously told libcurl to use, as it won't use

them anymore now.

.SH RETURN VALUE

None

.SH "SEE ALSO"

.BR curl_easy_init "(3), "