docs/libcurl/opts/CURLOPT_SSLENGINE_DEFAULT.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 http://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 CURLOPT_SSLENGINE_DEFAULT 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_SSLENGINE_DEFAULT \- make SSL engine default
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLENGINE_DEFAULT, long val);
  30 .SH DESCRIPTION
  31 Pass a long set to 1 as parameter. Sets the actual crypto engine as the
  32 default for (asymmetric) crypto operations.
  33
  34 If the crypto device cannot be set, \fICURLE_SSL_ENGINE_SETFAILED\fP is
  35 returned.
  36 .SH DEFAULT
  37 None
  38 .SH PROTOCOLS
  39 All TLS based protocols: HTTPS, FTPS, IMAPS, POP3, SMTPS etc.
  40 .SH EXAMPLE
  41 TODO
  42 .SH AVAILABILITY
  43 If built TLS enabled.
  44 .SH RETURN VALUE
  45 Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
  46 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  47 .SH "SEE ALSO"
  48 .BR CURLOPT_SSLENGINE "(3), " CURLOPT_SSLCERT "(3), "