| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061 |
- .\" generated by cd2nroff 0.1 from curl_easy_cleanup.md
- .TH curl_easy_cleanup 3 "2025-01-17" libcurl
- .SH NAME
- curl_easy_cleanup \- free an easy handle
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- void curl_easy_cleanup(CURL *handle);
- .fi
- .SH DESCRIPTION
- This function is the opposite of \fIcurl_easy_init(3)\fP. It closes down and frees
- all resources previously associated with this easy handle.
- This call closes all connections this handle has used and possibly has kept
- open until now unless the easy handle was attached to a multi handle while
- doing the transfers. Do not call this function if you intend to transfer more
- files, reusing handles is a key to good performance with libcurl.
- 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 use of the easy \fBhandle\fP after this function has been called and have
- returned, is illegal.
- To close an easy handle that has been used with the multi interface, make sure
- to first call \fIcurl_multi_remove_handle(3)\fP to remove it from the multi handle
- before it is closed.
- Passing in a NULL pointer in \fIhandle\fP makes this function return immediately
- with no action.
- .SH PROTOCOLS
- This functionality affects all supported protocols
- .SH EXAMPLE
- .nf
- int main(void)
- {
- CURL *curl = curl_easy_init();
- if(curl) {
- CURLcode res;
- curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
- res = curl_easy_perform(curl);
- if(res)
- printf("error: %s\\n", curl_easy_strerror(res));
- curl_easy_cleanup(curl);
- }
- }
- .fi
- .SH AVAILABILITY
- Added in curl 7.1
- .SH RETURN VALUE
- None
- .SH SEE ALSO
- .BR curl_easy_duphandle (3),
- .BR curl_easy_init (3),
- .BR curl_easy_reset (3),
- .BR curl_multi_cleanup (3),
- .BR curl_multi_remove_handle (3)
|