<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/>
<title>pkcs11-helper: Engines interface</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.0 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Engines interface</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structpkcs11h__sys__engine__s.html">pkcs11h_sys_engine_s</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">System engine. <a href="structpkcs11h__sys__engine__s.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structpkcs11h__crypto__engine__s.html">pkcs11h_crypto_engine_s</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Crypto engine. <a href="structpkcs11h__crypto__engine__s.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Modules</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PKCS11H__ENGINE__CRYPTO.html">PKCS11H_ENGINE_CRYPTO</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>pkcs11-helper built-in engines. </p>
<br/></td></tr>
</p>
<tr><td colspan="2"><h2>Files</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">file </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs11h-engines_8h.html">pkcs11h-engines.h</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>pkcs11-helper engines definitions. </p>
<br/></td></tr>
</p>
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6910440acfcf4051ee61312067db9bfb"></a><!-- doxytag: member="pkcs11h_engines::pkcs11h_engine_system_t" ref="ga6910440acfcf4051ee61312067db9bfb" args="" -->
typedef struct <a class="el" href="structpkcs11h__sys__engine__s.html">pkcs11h_sys_engine_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pkcs11h__engines.html#ga6910440acfcf4051ee61312067db9bfb">pkcs11h_engine_system_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">System engine. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga583dcfe41e186a962a2cd9ea19cb9b3e"></a><!-- doxytag: member="pkcs11h_engines::pkcs11h_engine_crypto_t" ref="ga583dcfe41e186a962a2cd9ea19cb9b3e" args="" -->
typedef struct <br class="typebreak"/>
<a class="el" href="structpkcs11h__crypto__engine__s.html">pkcs11h_crypto_engine_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pkcs11h__engines.html#ga583dcfe41e186a962a2cd9ea19cb9b3e">pkcs11h_engine_crypto_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Crypto engine. <br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">CK_RV </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pkcs11h__engines.html#gaca5be294bedd184eb8f6b22682c485ed">pkcs11h_engine_setSystem</a> (IN const <a class="el" href="structpkcs11h__sys__engine__s.html">pkcs11h_engine_system_t</a> *const engine)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set system engine to be used. <a href="#gaca5be294bedd184eb8f6b22682c485ed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">CK_RV </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pkcs11h__engines.html#ga0d1ca236165a37d4d25a1671ea7e6506">pkcs11h_engine_setCrypto</a> (IN const <a class="el" href="structpkcs11h__crypto__engine__s.html">pkcs11h_engine_crypto_t</a> *const engine)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set crypto engine to be used. <a href="#ga0d1ca236165a37d4d25a1671ea7e6506"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>External dependencies. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga0d1ca236165a37d4d25a1671ea7e6506"></a><!-- doxytag: member="pkcs11h-engines.h::pkcs11h_engine_setCrypto" ref="ga0d1ca236165a37d4d25a1671ea7e6506" args="(IN const pkcs11h_engine_crypto_t *const engine)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CK_RV pkcs11h_engine_setCrypto </td>
<td>(</td>
<td class="paramtype">IN const <a class="el" href="structpkcs11h__crypto__engine__s.html">pkcs11h_engine_crypto_t</a> *const </td>
<td class="paramname"> <em>engine</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set crypto engine to be used. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>engine</em> </td><td>Engine to use. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>CK_RV. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Must be called before pkcs11h_initialize. </dd>
<dd>
Default is provided at configuration time. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__PKCS11H__ENGINE__CRYPTO.html" title="pkcs11-helper built-in engines.">PKCS11H_ENGINE_CRYPTO</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaca5be294bedd184eb8f6b22682c485ed"></a><!-- doxytag: member="pkcs11h-engines.h::pkcs11h_engine_setSystem" ref="gaca5be294bedd184eb8f6b22682c485ed" args="(IN const pkcs11h_engine_system_t *const engine)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CK_RV pkcs11h_engine_setSystem </td>
<td>(</td>
<td class="paramtype">IN const <a class="el" href="structpkcs11h__sys__engine__s.html">pkcs11h_engine_system_t</a> *const </td>
<td class="paramname"> <em>engine</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set system engine to be used. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>engine</em> </td><td>Engine to use. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>CK_RV. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Must be called before pkcs11h_initialize. </dd>
<dd>
Default engine is libc functions. </dd></dl>
</div>
</div>
</div>
<hr>
<table width="100%"><tr><td>pkcs11-helper, Copyright (C) Alon Bar-Lev <alon.barlev@gmail.com></td><td align="right"><a href="http://www.opensc-project.org"><img src="opensc-logo.gif" alt="OpenSC-Project.org Logo" border="0"/></a></td></tr></table>
