Initial bulk commit for "Git on MSys"
[msysgit/historical-msysgit.git] / mingw / include / curl / easy.h
blobb5867200242745c64924c7ac128bd24e50395b45
1 #ifndef __CURL_EASY_H
2 #define __CURL_EASY_H
3 /***************************************************************************
4 * _ _ ____ _
5 * Project ___| | | | _ \| |
6 * / __| | | | |_) | |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
10 * Copyright (C) 1998 - 2004, Daniel Stenberg, <daniel@haxx.se>, et al.
12 * This software is licensed as described in the file COPYING, which
13 * you should have received as part of this distribution. The terms
14 * are also available at http://curl.haxx.se/docs/copyright.html.
16 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17 * copies of the Software, and permit persons to whom the Software is
18 * furnished to do so, under the terms of the COPYING file.
20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21 * KIND, either express or implied.
23 * $Id: easy.h,v 1.13 2004/11/09 14:02:58 giva Exp $
24 ***************************************************************************/
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
29 CURL_EXTERN CURL *curl_easy_init(void);
30 CURL_EXTERN CURLcode curl_easy_setopt(CURL *curl, CURLoption option, ...);
31 CURL_EXTERN CURLcode curl_easy_perform(CURL *curl);
32 CURL_EXTERN void curl_easy_cleanup(CURL *curl);
35 * NAME curl_easy_getinfo()
37 * DESCRIPTION
39 * Request internal information from the curl session with this function. The
40 * third argument MUST be a pointer to a long, a pointer to a char * or a
41 * pointer to a double (as the documentation describes elsewhere). The data
42 * pointed to will be filled in accordingly and can be relied upon only if the
43 * function returns CURLE_OK. This function is intended to get used *AFTER* a
44 * performed transfer, all results from this function are undefined until the
45 * transfer is completed.
47 CURL_EXTERN CURLcode curl_easy_getinfo(CURL *curl, CURLINFO info, ...);
51 * NAME curl_easy_duphandle()
53 * DESCRIPTION
55 * Creates a new curl session handle with the same options set for the handle
56 * passed in. Duplicating a handle could only be a matter of cloning data and
57 * options, internal state info and things like persistant connections cannot
58 * be transfered. It is useful in multithreaded applications when you can run
59 * curl_easy_duphandle() for each new thread to avoid a series of identical
60 * curl_easy_setopt() invokes in every thread.
62 CURL_EXTERN CURL* curl_easy_duphandle(CURL *curl);
65 * NAME curl_easy_reset()
67 * DESCRIPTION
69 * Re-initializes a CURL handle to the default values. This puts back the
70 * handle to the same state as it was in when it was just created.
72 * It does keep: live connections, the Session ID cache, the DNS cache and the
73 * cookies.
75 CURL_EXTERN void curl_easy_reset(CURL *curl);
77 #ifdef __cplusplus
79 #endif
81 #endif