Return to CURLINFO_SSL_ENGINES.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_SSL_ENGINES.3, revision 1.1

1.1     ! misho       1: .\" **************************************************************************
        !             2: .\" *                                  _   _ ____  _
        !             3: .\" *  Project                     ___| | | |  _ \| |
        !             4: .\" *                             / __| | | | |_) | |
        !             5: .\" *                            | (__| |_| |  _ <| |___
        !             6: .\" *                             \___|\___/|_| \_\_____|
        !             7: .\" *
        !             8: .\" * Copyright (C) 1998 - 2017, 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 "May 31, 2017" "libcurl 7.70.0" "curl_easy_getinfo options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLINFO_SSL_ENGINES \- get an slist of OpenSSL crypto-engines
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SSL_ENGINES,
        !            31:                            struct curl_slist **engine_list);
        !            32: .SH DESCRIPTION
        !            33: Pass the address of a 'struct curl_slist *' to receive a linked-list of
        !            34: OpenSSL crypto-engines supported. Note that engines are normally implemented
        !            35: in separate dynamic libraries. Hence not all the returned engines may be
        !            36: available at run-time. \fBNOTE:\fP you must call \fIcurl_slist_free_all(3)\fP
        !            37: on the list pointer once you're done with it, as libcurl will not free the
        !            38: data for you.
        !            39: .SH PROTOCOLS
        !            40: All TLS based ones.
        !            41: .SH EXAMPLE
        !            42: .nf
        !            43: CURL *curl = curl_easy_init();
        !            44: if(curl) {
        !            45:   CURLcode res;
        !            46:   struct curl_slist *engines;
        !            47:   res = curl_easy_getinfo(curl, CURLINFO_SSL_ENGINES, &engines);
        !            48:   if((res == CURLE_OK) && engines) {
        !            49:     /* we have a list, free it when done using it */
        !            50:     curl_slist_free_all(engines);
        !            51:   }
        !            52: 
        !            53:   curl_easy_cleanup(curl);
        !            54: }
        !            55: .fi
        !            56: .SH AVAILABILITY
        !            57: Added in 7.12.3. Available in OpenSSL builds with "engine" support.
        !            58: .SH RETURN VALUE
        !            59: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
        !            60: .SH "SEE ALSO"
        !            61: .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "