<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>ssl::context::set_password_callback (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../set_password_callback.html" title="ssl::context::set_password_callback">
<link rel="prev" href="overload1.html" title="ssl::context::set_password_callback (1 of 2 overloads)">
<link rel="next" href="../set_verify_callback.html" title="ssl::context::set_verify_callback">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../set_password_callback.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../set_verify_callback.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__context.set_password_callback.overload2"></a><a class="link" href="overload2.html" title="ssl::context::set_password_callback (2 of 2 overloads)">ssl::context::set_password_callback
          (2 of 2 overloads)</a>
</h5></div></div></div>
<p>
            Set the password callback.
          </p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">typename</span> <span class="identifier">PasswordCallback</span><span class="special">&gt;</span>
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span> <span class="identifier">set_password_callback</span><span class="special">(</span>
    <span class="identifier">PasswordCallback</span> <span class="identifier">callback</span><span class="special">,</span>
    <span class="identifier">asio</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>
</pre>
<p>
            This function is used to specify a callback function to obtain password
            information about an encrypted key in PEM format.
          </p>
<h6>
<a name="asio.reference.ssl__context.set_password_callback.overload2.h0"></a>
            <span><a name="asio.reference.ssl__context.set_password_callback.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.ssl__context.set_password_callback.overload2.parameters">Parameters</a>
          </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">callback</span></dt>
<dd>
<p>
                  The function object to be used for obtaining the password. The
                  function signature of the handler must be:
</p>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">password_callback</span><span class="special">(</span>
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">max_length</span><span class="special">,</span>  <span class="comment">// The maximum size for a password.</span>
  <span class="identifier">password_purpose</span> <span class="identifier">purpose</span> <span class="comment">// Whether password is for reading or writing.</span>
<span class="special">);</span>
</pre>
<p>
                  The return value of the callback is a string containing the password.
                </p>
</dd>
<dt><span class="term">ec</span></dt>
<dd><p>
                  Set to indicate what error occurred, if any.
                </p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__context.set_password_callback.overload2.h1"></a>
            <span><a name="asio.reference.ssl__context.set_password_callback.overload2.remarks"></a></span><a class="link" href="overload2.html#asio.reference.ssl__context.set_password_callback.overload2.remarks">Remarks</a>
          </h6>
<p>
            Calls <code class="computeroutput"><span class="identifier">SSL_CTX_set_default_passwd_cb</span></code>.
          </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003-2015 Christopher M.
      Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        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>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../set_password_callback.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../set_verify_callback.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
