<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crypto++: AlgorithmParameters Class 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.15 -->
<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="#pub-methods">Public Member Functions</a> |
<a href="class_algorithm_parameters-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">AlgorithmParameters Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>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></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for AlgorithmParameters:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="class_algorithm_parameters.png" usemap="#AlgorithmParameters_map" alt=""/>
<map id="AlgorithmParameters_map" name="AlgorithmParameters_map">
<area href="class_name_value_pairs.html" title="Interface for retrieving values given their names." alt="NameValuePairs" shape="rect" coords="0,0,129,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a98a1cc98735ec318436c3f270f507003"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm_parameters.html#a98a1cc98735ec318436c3f270f507003">AlgorithmParameters</a> ()</td></tr>
<tr class="memdesc:a98a1cc98735ec318436c3f270f507003"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="class_algorithm_parameters.html" title="An object that implements NameValuePairs.">AlgorithmParameters</a>. <a href="#a98a1cc98735ec318436c3f270f507003">More...</a><br /></td></tr>
<tr class="separator:a98a1cc98735ec318436c3f270f507003"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f1fbf31702f1eafe9736905da393aa0"><td class="memItemLeft" align="right" valign="top"><a id="a4f1fbf31702f1eafe9736905da393aa0"></a>
 </td><td class="memItemRight" valign="bottom"><b>AlgorithmParameters</b> (const <a class="el" href="class_algorithm_parameters.html">AlgorithmParameters</a> &x)</td></tr>
<tr class="separator:a4f1fbf31702f1eafe9736905da393aa0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f1598d92946549b06ecf2ba96df10c9"><td class="memItemLeft" align="right" valign="top"><a id="a1f1598d92946549b06ecf2ba96df10c9"></a>
<a class="el" href="class_algorithm_parameters.html">AlgorithmParameters</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="class_algorithm_parameters.html">AlgorithmParameters</a> &x)</td></tr>
<tr class="separator:a1f1598d92946549b06ecf2ba96df10c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7ad9db0a46852ec1e686c520f41dfb3"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:ad7ad9db0a46852ec1e686c520f41dfb3"><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="class_algorithm_parameters.html#ad7ad9db0a46852ec1e686c520f41dfb3">operator()</a> (const char *name, const T &value, bool throwIfNotUsed)</td></tr>
<tr class="separator:ad7ad9db0a46852ec1e686c520f41dfb3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad470db151f1e3174befdc010cc9eb8a4"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:ad470db151f1e3174befdc010cc9eb8a4"><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="class_algorithm_parameters.html#ad470db151f1e3174befdc010cc9eb8a4">operator()</a> (const char *name, const T &value)</td></tr>
<tr class="memdesc:ad470db151f1e3174befdc010cc9eb8a4"><td class="mdescLeft"> </td><td class="mdescRight">Appends a NameValuePair to a collection of <a class="el" href="class_name_value_pairs.html" title="Interface for retrieving values given their names.">NameValuePairs</a>. <a href="#ad470db151f1e3174befdc010cc9eb8a4">More...</a><br /></td></tr>
<tr class="separator:ad470db151f1e3174befdc010cc9eb8a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43a5349c7db7bc18385fba581b46a6ea"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm_parameters.html#a43a5349c7db7bc18385fba581b46a6ea">GetVoidValue</a> (const char *name, const std::type_info &valueType, void *pValue) const</td></tr>
<tr class="memdesc:a43a5349c7db7bc18385fba581b46a6ea"><td class="mdescLeft"> </td><td class="mdescRight">Get a named value. <a href="#a43a5349c7db7bc18385fba581b46a6ea">More...</a><br /></td></tr>
<tr class="separator:a43a5349c7db7bc18385fba581b46a6ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_name_value_pairs"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_name_value_pairs')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_name_value_pairs.html">NameValuePairs</a></td></tr>
<tr class="memitem:a3401528f3d69d70f200086501b8af282 inherit pub_methods_class_name_value_pairs"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a3401528f3d69d70f200086501b8af282 inherit pub_methods_class_name_value_pairs"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_name_value_pairs.html#a3401528f3d69d70f200086501b8af282">GetThisObject</a> (T &object) const</td></tr>
<tr class="memdesc:a3401528f3d69d70f200086501b8af282 inherit pub_methods_class_name_value_pairs"><td class="mdescLeft"> </td><td class="mdescRight">Get a copy of this object or subobject. <a href="class_name_value_pairs.html#a3401528f3d69d70f200086501b8af282">More...</a><br /></td></tr>
<tr class="separator:a3401528f3d69d70f200086501b8af282 inherit pub_methods_class_name_value_pairs"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abce7b413ce1345ab7b7d05fa3d1834f5 inherit pub_methods_class_name_value_pairs"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:abce7b413ce1345ab7b7d05fa3d1834f5 inherit pub_methods_class_name_value_pairs"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_name_value_pairs.html#abce7b413ce1345ab7b7d05fa3d1834f5">GetThisPointer</a> (T *&ptr) const</td></tr>
<tr class="memdesc:abce7b413ce1345ab7b7d05fa3d1834f5 inherit pub_methods_class_name_value_pairs"><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to this object. <a href="class_name_value_pairs.html#abce7b413ce1345ab7b7d05fa3d1834f5">More...</a><br /></td></tr>
<tr class="separator:abce7b413ce1345ab7b7d05fa3d1834f5 inherit pub_methods_class_name_value_pairs"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5357c3a09602e44671d1e42cb9a9408d inherit pub_methods_class_name_value_pairs"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a5357c3a09602e44671d1e42cb9a9408d inherit pub_methods_class_name_value_pairs"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_name_value_pairs.html#a5357c3a09602e44671d1e42cb9a9408d">GetValue</a> (const char *name, T &value) const</td></tr>
<tr class="memdesc:a5357c3a09602e44671d1e42cb9a9408d inherit pub_methods_class_name_value_pairs"><td class="mdescLeft"> </td><td class="mdescRight">Get a named value. <a href="class_name_value_pairs.html#a5357c3a09602e44671d1e42cb9a9408d">More...</a><br /></td></tr>
<tr class="separator:a5357c3a09602e44671d1e42cb9a9408d inherit pub_methods_class_name_value_pairs"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4daf1ef67b547c6be96188a43e5ec05e inherit pub_methods_class_name_value_pairs"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a4daf1ef67b547c6be96188a43e5ec05e inherit pub_methods_class_name_value_pairs"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_name_value_pairs.html#a4daf1ef67b547c6be96188a43e5ec05e">GetValueWithDefault</a> (const char *name, T defaultValue) const</td></tr>
<tr class="memdesc:a4daf1ef67b547c6be96188a43e5ec05e inherit pub_methods_class_name_value_pairs"><td class="mdescLeft"> </td><td class="mdescRight">Get a named value. <a href="class_name_value_pairs.html#a4daf1ef67b547c6be96188a43e5ec05e">More...</a><br /></td></tr>
<tr class="separator:a4daf1ef67b547c6be96188a43e5ec05e inherit pub_methods_class_name_value_pairs"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a13faea827ee047cd58557282806ed2e1 inherit pub_methods_class_name_value_pairs"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_name_value_pairs.html#a13faea827ee047cd58557282806ed2e1">GetValueNames</a> () const</td></tr>
<tr class="memdesc:a13faea827ee047cd58557282806ed2e1 inherit pub_methods_class_name_value_pairs"><td class="mdescLeft"> </td><td class="mdescRight">Get a list of value names that can be retrieved. <a href="class_name_value_pairs.html#a13faea827ee047cd58557282806ed2e1">More...</a><br /></td></tr>
<tr class="separator:a13faea827ee047cd58557282806ed2e1 inherit pub_methods_class_name_value_pairs"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a94e5b19dc54625799797668ff8627c57 inherit pub_methods_class_name_value_pairs"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_name_value_pairs.html#a94e5b19dc54625799797668ff8627c57">GetIntValue</a> (const char *name, int &value) const</td></tr>
<tr class="memdesc:a94e5b19dc54625799797668ff8627c57 inherit pub_methods_class_name_value_pairs"><td class="mdescLeft"> </td><td class="mdescRight">Get a named value with type int. <a href="class_name_value_pairs.html#a94e5b19dc54625799797668ff8627c57">More...</a><br /></td></tr>
<tr class="separator:a94e5b19dc54625799797668ff8627c57 inherit pub_methods_class_name_value_pairs"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ddb654b7afcd1a04422a7b4b01366d9 inherit pub_methods_class_name_value_pairs"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_name_value_pairs.html#a7ddb654b7afcd1a04422a7b4b01366d9">GetIntValueWithDefault</a> (const char *name, int defaultValue) const</td></tr>
<tr class="memdesc:a7ddb654b7afcd1a04422a7b4b01366d9 inherit pub_methods_class_name_value_pairs"><td class="mdescLeft"> </td><td class="mdescRight">Get a named value with type int, with default. <a href="class_name_value_pairs.html#a7ddb654b7afcd1a04422a7b4b01366d9">More...</a><br /></td></tr>
<tr class="separator:a7ddb654b7afcd1a04422a7b4b01366d9 inherit pub_methods_class_name_value_pairs"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af28f6e7abf98606d8146bfda271e99db inherit pub_methods_class_name_value_pairs"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:af28f6e7abf98606d8146bfda271e99db inherit pub_methods_class_name_value_pairs"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_name_value_pairs.html#af28f6e7abf98606d8146bfda271e99db">GetRequiredParameter</a> (const char *className, const char *name, T &value) const</td></tr>
<tr class="memdesc:af28f6e7abf98606d8146bfda271e99db inherit pub_methods_class_name_value_pairs"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a required name/value pair. <a href="class_name_value_pairs.html#af28f6e7abf98606d8146bfda271e99db">More...</a><br /></td></tr>
<tr class="separator:af28f6e7abf98606d8146bfda271e99db inherit pub_methods_class_name_value_pairs"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acfb673d912e1bc19386bebba9d58c23f inherit pub_methods_class_name_value_pairs"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_name_value_pairs.html#acfb673d912e1bc19386bebba9d58c23f">GetRequiredIntParameter</a> (const char *className, const char *name, int &value) const</td></tr>
<tr class="memdesc:acfb673d912e1bc19386bebba9d58c23f inherit pub_methods_class_name_value_pairs"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a required name/value pair. <a href="class_name_value_pairs.html#acfb673d912e1bc19386bebba9d58c23f">More...</a><br /></td></tr>
<tr class="separator:acfb673d912e1bc19386bebba9d58c23f inherit pub_methods_class_name_value_pairs"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_class_name_value_pairs"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_class_name_value_pairs')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="class_name_value_pairs.html">NameValuePairs</a></td></tr>
<tr class="memitem:ad4b80eeeb5f1f58e3cedb12f02a6b870 inherit pub_static_methods_class_name_value_pairs"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_name_value_pairs.html#ad4b80eeeb5f1f58e3cedb12f02a6b870">ThrowIfTypeMismatch</a> (const char *name, const std::type_info &stored, const std::type_info &retrieving)</td></tr>
<tr class="memdesc:ad4b80eeeb5f1f58e3cedb12f02a6b870 inherit pub_static_methods_class_name_value_pairs"><td class="mdescLeft"> </td><td class="mdescRight">Ensures an expected name and type is present. <a href="class_name_value_pairs.html#ad4b80eeeb5f1f58e3cedb12f02a6b870">More...</a><br /></td></tr>
<tr class="separator:ad4b80eeeb5f1f58e3cedb12f02a6b870 inherit pub_static_methods_class_name_value_pairs"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>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="section note"><dt>Note</dt><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 operator() on the object returned by MakeParameters, 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#l00419">419</a> of file <a class="el" href="algparam_8h_source.html">algparam.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a98a1cc98735ec318436c3f270f507003"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98a1cc98735ec318436c3f270f507003">◆ </a></span>AlgorithmParameters()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AlgorithmParameters::AlgorithmParameters </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="class_algorithm_parameters.html" title="An object that implements NameValuePairs.">AlgorithmParameters</a>. </p>
<dl class="section note"><dt>Note</dt><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 operator() on the object returned by MakeParameters, 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_8cpp_source.html#l00048">48</a> of file <a class="el" href="algparam_8cpp_source.html">algparam.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad7ad9db0a46852ec1e686c520f41dfb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7ad9db0a46852ec1e686c520f41dfb3">◆ </a></span>operator()() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_algorithm_parameters.html">AlgorithmParameters</a>& AlgorithmParameters::operator() </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> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<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>
<p class="definition">Definition at line <a class="el" href="algparam_8h_source.html#l00460">460</a> of file <a class="el" href="algparam_8h_source.html">algparam.h</a>.</p>
</div>
</div>
<a id="ad470db151f1e3174befdc010cc9eb8a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad470db151f1e3174befdc010cc9eb8a4">◆ </a></span>operator()() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_algorithm_parameters.html">AlgorithmParameters</a>& AlgorithmParameters::operator() </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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Appends a NameValuePair to a collection of <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>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="algparam_8h_source.html#l00474">474</a> of file <a class="el" href="algparam_8h_source.html">algparam.h</a>.</p>
</div>
</div>
<a id="a43a5349c7db7bc18385fba581b46a6ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43a5349c7db7bc18385fba581b46a6ea">◆ </a></span>GetVoidValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool AlgorithmParameters::GetVoidValue </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 std::type_info & </td>
<td class="paramname"><em>valueType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>pValue</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a named value. </p>
<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">valueType</td><td>reference to a variable that receives the value </td></tr>
<tr><td class="paramname">pValue</td><td>void pointer to a variable that receives the value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the value was retrieved, false otherwise</dd></dl>
<p><a class="el" href="class_algorithm_parameters.html#a43a5349c7db7bc18385fba581b46a6ea" title="Get a named value.">GetVoidValue()</a> retrieves the value of name if it exists. </p><dl class="section note"><dt>Note</dt><dd><a class="el" href="class_algorithm_parameters.html#a43a5349c7db7bc18385fba581b46a6ea" title="Get a named value.">GetVoidValue()</a> is an internal function and should be implemented by derived classes. Users should use one of the other functions instead. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_name_value_pairs.html#a5357c3a09602e44671d1e42cb9a9408d" title="Get a named value.">GetValue()</a>, <a class="el" href="class_name_value_pairs.html#a4daf1ef67b547c6be96188a43e5ec05e" title="Get a named value.">GetValueWithDefault()</a>, <a class="el" href="class_name_value_pairs.html#a94e5b19dc54625799797668ff8627c57" title="Get a named value with type int.">GetIntValue()</a>, <a class="el" href="class_name_value_pairs.html#a7ddb654b7afcd1a04422a7b4b01366d9" title="Get a named value with type int, with default.">GetIntValueWithDefault()</a>, <a class="el" href="class_name_value_pairs.html#af28f6e7abf98606d8146bfda271e99db" title="Retrieves a required name/value pair.">GetRequiredParameter()</a> and <a class="el" href="class_name_value_pairs.html#acfb673d912e1bc19386bebba9d58c23f" title="Retrieves a required name/value pair.">GetRequiredIntParameter()</a> </dd></dl>
<p>Implements <a class="el" href="class_name_value_pairs.html#a9fc3f5c4480d53b8104c67ca7958e332">NameValuePairs</a>.</p>
<p class="definition">Definition at line <a class="el" href="algparam_8cpp_source.html#l00065">65</a> of file <a class="el" href="algparam_8cpp_source.html">algparam.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="algparam_8h_source.html">algparam.h</a></li>
<li><a class="el" href="algparam_8cpp_source.html">algparam.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 27 2019 15:03:53 for Crypto++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
17f48c047155a7d4c992d6a672acd57f
>
files
>
289
