2011-03-12 07:14:32 +08:00
|
|
|
.\" **************************************************************************
|
|
|
|
|
.\" * _ _ ____ _
|
|
|
|
|
.\" * Project ___| | | | _ \| |
|
|
|
|
|
.\" * / __| | | | |_) | |
|
|
|
|
|
.\" * | (__| |_| | _ <| |___
|
|
|
|
|
.\" * \___|\___/|_| \_\_____|
|
|
|
|
|
.\" *
|
2022-05-17 17:16:50 +08:00
|
|
|
.\" * Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.
|
2011-03-12 07:14:32 +08:00
|
|
|
.\" *
|
|
|
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
|
|
|
.\" * you should have received as part of this distribution. The terms
|
2020-11-04 21:02:01 +08:00
|
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
2011-03-12 07:14:32 +08:00
|
|
|
.\" *
|
|
|
|
|
.\" * 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.
|
|
|
|
|
.\" *
|
2022-05-17 17:16:50 +08:00
|
|
|
.\" * SPDX-License-Identifier: curl
|
|
|
|
|
.\" *
|
2011-03-12 07:14:32 +08:00
|
|
|
.\" **************************************************************************
|
2002-03-04 21:06:46 +08:00
|
|
|
.TH curl_easy_init 3 "4 March 2002" "libcurl 7.8.1" "libcurl Manual"
|
2002-03-04 18:09:48 +08:00
|
|
|
.SH NAME
|
2002-03-04 21:06:46 +08:00
|
|
|
curl_easy_init - Start a libcurl easy session
|
2002-03-04 18:09:48 +08:00
|
|
|
.SH SYNOPSIS
|
2021-11-26 21:20:18 +08:00
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
2003-11-05 23:52:00 +08:00
|
|
|
|
2021-11-26 21:20:18 +08:00
|
|
|
CURL *curl_easy_init();
|
|
|
|
|
.fi
|
2002-03-04 18:09:48 +08:00
|
|
|
.SH DESCRIPTION
|
2002-03-04 21:06:46 +08:00
|
|
|
This function must be the first function to call, and it returns a CURL easy
|
2014-10-21 16:26:40 +08:00
|
|
|
handle that you must use as input to other functions in the easy
|
|
|
|
|
interface. This call \fBMUST\fP have a corresponding call to
|
2004-02-27 23:34:06 +08:00
|
|
|
\fIcurl_easy_cleanup(3)\fP when the operation is complete.
|
2002-03-04 18:09:48 +08:00
|
|
|
|
2014-10-21 16:26:40 +08:00
|
|
|
If you did not already call \fIcurl_global_init(3)\fP, \fIcurl_easy_init(3)\fP
|
2021-11-26 15:46:59 +08:00
|
|
|
does it automatically. This may be lethal in multi-threaded cases, since
|
2014-10-21 16:26:40 +08:00
|
|
|
\fIcurl_global_init(3)\fP is not thread-safe, and it may result in resource
|
|
|
|
|
problems because there is no corresponding cleanup.
|
2006-01-16 07:55:53 +08:00
|
|
|
|
2020-12-31 17:11:49 +08:00
|
|
|
You are strongly advised to not allow this automatic behavior, by calling
|
2021-11-26 15:46:59 +08:00
|
|
|
\fIcurl_global_init(3)\fP yourself properly. See the description in
|
2014-10-21 16:26:40 +08:00
|
|
|
\fBlibcurl\fP(3) of global environment requirements for details of how to use
|
|
|
|
|
this function.
|
2014-11-25 21:25:02 +08:00
|
|
|
.SH EXAMPLE
|
|
|
|
|
.nf
|
|
|
|
|
CURL *curl = curl_easy_init();
|
|
|
|
|
if(curl) {
|
|
|
|
|
CURLcode res;
|
2020-09-17 05:04:07 +08:00
|
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
2014-11-25 21:25:02 +08:00
|
|
|
res = curl_easy_perform(curl);
|
|
|
|
|
curl_easy_cleanup(curl);
|
|
|
|
|
}
|
|
|
|
|
.fi
|
2021-10-25 14:54:08 +08:00
|
|
|
.SH AVAILABILITY
|
|
|
|
|
Always
|
|
|
|
|
.SH RETURN VALUE
|
|
|
|
|
If this function returns NULL, something went wrong and you cannot use the
|
|
|
|
|
other curl functions.
|
2002-03-04 18:09:48 +08:00
|
|
|
.SH "SEE ALSO"
|
2014-11-25 21:25:02 +08:00
|
|
|
.BR curl_easy_cleanup "(3), " curl_global_init "(3), " curl_easy_reset "(3), "
|
|
|
|
|
.BR curl_easy_perform "(3) "
|
