doc/html/boost_asio/reference/ssl__context/use_rsa_private_key_file/overload2.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>ssl::context::use_rsa_private_key_file (2 of 2 overloads)</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
   8 <link rel="up" href="../use_rsa_private_key_file.html" title="ssl::context::use_rsa_private_key_file">
   9 <link rel="prev" href="overload1.html" title="ssl::context::use_rsa_private_key_file (1 of 2 overloads)">
  10 <link rel="next" href="../use_tmp_dh_file.html" title="ssl::context::use_tmp_dh_file">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../use_rsa_private_key_file.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../use_tmp_dh_file.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="boost_asio.reference.ssl__context.use_rsa_private_key_file.overload2"></a><a class="link" href="overload2.html" title="ssl::context::use_rsa_private_key_file (2 of 2 overloads)">ssl::context::use_rsa_private_key_file
  28           (2 of 2 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             Use an RSA private key from a file.
  32           </p>
  33 <pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="identifier">use_rsa_private_key_file</span><span class="special">(</span>
  34     <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span> <span class="identifier">filename</span><span class="special">,</span>
  35     <span class="identifier">file_format</span> <span class="identifier">format</span><span class="special">,</span>
  36     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  37 </pre>
  38 <p>
  39             This function is used to load an RSA private key into the context from
  40             a file.
  41           </p>
  42 <h6>
  43 <a name="boost_asio.reference.ssl__context.use_rsa_private_key_file.overload2.h0"></a>
  44             <span><a name="boost_asio.reference.ssl__context.use_rsa_private_key_file.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.ssl__context.use_rsa_private_key_file.overload2.parameters">Parameters</a>
  45           </h6>
  46 <div class="variablelist">
  47 <p class="title"><b></b></p>
  48 <dl>
  49 <dt><span class="term">filename</span></dt>
  50 <dd><p>
  51                   The name of the file containing the RSA private key.
  52                 </p></dd>
  53 <dt><span class="term">format</span></dt>
  54 <dd><p>
  55                   The file format (ASN.1 or PEM).
  56                 </p></dd>
  57 <dt><span class="term">ec</span></dt>
  58 <dd><p>
  59                   Set to indicate what error occurred, if any.
  60                 </p></dd>
  61 </dl>
  62 </div>
  63 <h6>
  64 <a name="boost_asio.reference.ssl__context.use_rsa_private_key_file.overload2.h1"></a>
  65             <span><a name="boost_asio.reference.ssl__context.use_rsa_private_key_file.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.ssl__context.use_rsa_private_key_file.overload2.remarks">Remarks</a>
  66           </h6>
  67 <p>
  68             Calls <code class="computeroutput"><span class="identifier">SSL_CTX_use_RSAPrivateKey_file</span></code>.
  69           </p>
  70 </div>
  71 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  72 <td align="left"></td>
  73 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2012 Christopher M. Kohlhoff<p>
  74         Distributed under the Boost Software License, Version 1.0. (See accompanying
  75         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  76       </p>
  77 </div></td>
  78 </tr></table>
  79 <hr>
  80 <div class="spirit-nav">
  81 <a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../use_rsa_private_key_file.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../use_tmp_dh_file.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  82 </div>
  83 </body>
  84 </html>