Imported Upstream version 7.48.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLINFO_SSL_ENGINES.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2015, 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 https://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 CURLINFO_SSL_ENGINES 3 "1 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
24 .SH NAME
25 CURLINFO_SSL_ENGINES \- get an slist of OpenSSL crypto-engines
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SSL_ENGINES,
30                            struct curl_slist **engine_list);
31 .SH DESCRIPTION
32 Pass the address of a 'struct curl_slist *' to receive a linked-list of
33 OpenSSL crypto-engines supported. Note that engines are normally implemented
34 in separate dynamic libraries. Hence not all the returned engines may be
35 available at run-time. \fBNOTE:\fP you must call \fIcurl_slist_free_all(3)\fP
36 on the list pointer once you're done with it, as libcurl will not free the
37 data for you.
38 .SH PROTOCOLS
39 All TLS based ones.
40 .SH EXAMPLE
41 TODO
42 .SH AVAILABILITY
43 Added in 7.12.3. Available in OpenSSL builds with "engine" support.
44 .SH RETURN VALUE
45 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
46 .SH "SEE ALSO"
47 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "