<!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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crypto++: algparam.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Crypto++
 <span id="projectnumber">7.0</span>
</div>
<div id="projectbrief">Free C++ class library of cryptographic schemes</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">algparam.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Classes for working with <a class="el" href="class_name_value_pairs.html" title="Interface for retrieving values given their names. ">NameValuePairs</a>.
<a href="#details">More...</a></p>
<p><a href="algparam_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_const_byte_array_parameter.html">ConstByteArrayParameter</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Used to pass byte array input as part of a <a class="el" href="class_name_value_pairs.html" title="Interface for retrieving values given their names. ">NameValuePairs</a> object. <a href="class_const_byte_array_parameter.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_byte_array_parameter.html">ByteArrayParameter</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Used to pass byte array input as part of a <a class="el" href="class_name_value_pairs.html" title="Interface for retrieving values given their names. ">NameValuePairs</a> object. <a href="class_byte_array_parameter.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_combined_name_value_pairs.html">CombinedNameValuePairs</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Combines two sets of <a class="el" href="class_name_value_pairs.html" title="Interface for retrieving values given their names. ">NameValuePairs</a>. <a href="class_combined_name_value_pairs.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm_parameters_base.html">AlgorithmParametersBase</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base class for <a class="el" href="class_algorithm_parameters.html" title="An object that implements NameValuePairs. ">AlgorithmParameters</a>. <a href="class_algorithm_parameters_base.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm_parameters_base_1_1_parameter_not_used.html">AlgorithmParametersBase::ParameterNotUsed</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_exception.html" title="Base class for all exceptions thrown by the library. ">Exception</a> thrown when an AlgorithmParameter is unused. <a href="class_algorithm_parameters_base_1_1_parameter_not_used.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm_parameters_template.html">AlgorithmParametersTemplate< T ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Template base class for <a class="el" href="class_algorithm_parameters.html" title="An object that implements NameValuePairs. ">AlgorithmParameters</a>. <a href="class_algorithm_parameters_template.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm_parameters.html">AlgorithmParameters</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An object that implements <a class="el" href="class_name_value_pairs.html" title="Interface for retrieving values given their names. ">NameValuePairs</a>. <a href="class_algorithm_parameters.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a4ad41719cb8807adc9a2a4adc1bfec4a"><td class="memItemLeft" align="right" valign="top"><a id="a4ad41719cb8807adc9a2a4adc1bfec4a"></a>
#define </td><td class="memItemRight" valign="bottom"><b>CRYPTOPP_GET_FUNCTION_ENTRY</b>(name)   (Name::name(), &ThisClass::Get##name)</td></tr>
<tr class="separator:a4ad41719cb8807adc9a2a4adc1bfec4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4fce3e3f75bedc0ae26daa67027eb04"><td class="memItemLeft" align="right" valign="top"><a id="af4fce3e3f75bedc0ae26daa67027eb04"></a>
#define </td><td class="memItemRight" valign="bottom"><b>CRYPTOPP_SET_FUNCTION_ENTRY</b>(name)   (Name::name(), &ThisClass::Set##name)</td></tr>
<tr class="separator:af4fce3e3f75bedc0ae26daa67027eb04"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a37f7cb24c4d045059385b0cfa4bd1901"><td class="memItemLeft" align="right" valign="top"><a id="a37f7cb24c4d045059385b0cfa4bd1901"></a>
#define </td><td class="memItemRight" valign="bottom"><b>CRYPTOPP_SET_FUNCTION_ENTRY2</b>(name1, name2)   (Name::name1(), Name::name2(), &ThisClass::Set##name1##And##name2)</td></tr>
<tr class="separator:a37f7cb24c4d045059385b0cfa4bd1901"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aaad53aeb97a54b5ae5d8aa986e96b781"><td class="memItemLeft" align="right" valign="top"><a id="aaad53aeb97a54b5ae5d8aa986e96b781"></a>
bool </td><td class="memItemRight" valign="bottom"><b>AssignIntToInteger</b> (const std::type_info &valueType, void *pInteger, const void *pInt)</td></tr>
<tr class="separator:aaad53aeb97a54b5ae5d8aa986e96b781"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8451253e847bf47bb3cede499f98182"><td class="memItemLeft" align="right" valign="top"><a id="ae8451253e847bf47bb3cede499f98182"></a>
const std::type_info & </td><td class="memItemRight" valign="bottom"><b>IntegerTypeId</b> ()</td></tr>
<tr class="separator:ae8451253e847bf47bb3cede499f98182"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa13eee74de98cf8aaa7e83f4fae7f28b"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:aa13eee74de98cf8aaa7e83f4fae7f28b"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="class_algorithm_parameters.html">AlgorithmParameters</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="algparam_8h.html#aa13eee74de98cf8aaa7e83f4fae7f28b">MakeParameters</a> (const char *name, const T &value, bool throwIfNotUsed=true)</td></tr>
<tr class="memdesc:aa13eee74de98cf8aaa7e83f4fae7f28b"><td class="mdescLeft"> </td><td class="mdescRight">Create an object that implements <a class="el" href="class_name_value_pairs.html" title="Interface for retrieving values given their names. ">NameValuePairs</a>. <a href="#aa13eee74de98cf8aaa7e83f4fae7f28b">More...</a><br /></td></tr>
<tr class="separator:aa13eee74de98cf8aaa7e83f4fae7f28b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Classes for working with <a class="el" href="class_name_value_pairs.html" title="Interface for retrieving values given their names. ">NameValuePairs</a>. </p>
<p class="definition">Definition in file <a class="el" href="algparam_8h_source.html">algparam.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="aa13eee74de98cf8aaa7e83f4fae7f28b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa13eee74de98cf8aaa7e83f4fae7f28b">◆ </a></span>MakeParameters()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_algorithm_parameters.html">AlgorithmParameters</a> MakeParameters </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>throwIfNotUsed</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an object that implements <a class="el" href="class_name_value_pairs.html" title="Interface for retrieving values given their names. ">NameValuePairs</a>. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>the class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>the name of the object or value to retrieve </td></tr>
<tr><td class="paramname">value</td><td>reference to a variable that receives the value </td></tr>
<tr><td class="paramname">throwIfNotUsed</td><td>if true, the object will throw an exception if the value is not accessed </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>throwIfNotUsed is ignored if using a compiler that does not support std::uncaught_exception(), such as MSVC 7.0 and earlier. </dd>
<dd>
A <a class="el" href="class_name_value_pairs.html" title="Interface for retrieving values given their names. ">NameValuePairs</a> object containing an arbitrary number of name value pairs may be constructed by repeatedly using <code>operator()</code> on the object returned by <code>MakeParameters</code>, for example: <pre>
<a class="el" href="class_algorithm_parameters.html" title="An object that implements NameValuePairs. ">AlgorithmParameters</a> parameters = MakeParameters(name1, value1)(name2, value2)(name3, value3);
</pre> </dd></dl>
<p class="definition">Definition at line <a class="el" href="algparam_8h_source.html#l00502">502</a> of file <a class="el" href="algparam_8h_source.html">algparam.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 16 2018 07:58:09 for Crypto++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
0a67b807a02637f2cae68649d519a89d
>
files
>
183
