<!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++: Exception 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.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="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_exception-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Exception Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Base class for all exceptions thrown by the library.
<a href="class_exception.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 Exception:</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_exception.png" usemap="#Exception_map" alt=""/>
<map id="Exception_map" name="Exception_map">
<area href="class_algorithm_parameters_base_1_1_parameter_not_used.html" title="Exception thrown when an AlgorithmParameter is unused. " alt="AlgorithmParametersBase::ParameterNotUsed" shape="rect" coords="412,112,814,136"/>
<area href="class_authenticated_symmetric_cipher_1_1_bad_state.html" title="Exception thrown when the object is in the wrong state for the operation. " alt="AuthenticatedSymmetricCipher::BadState" shape="rect" coords="412,168,814,192"/>
<area href="class_cannot_flush.html" title="Flush(true) was called but it can't completely flush its buffers. " alt="CannotFlush" shape="rect" coords="412,224,814,248"/>
<area href="class_data_decryptor_err.html" title="Exception thrown when LegacyDecryptorWithMAC or DefaultDecryptorWithMAC decryption error is encounter..." alt="DataDecryptorErr" shape="rect" coords="412,280,814,304"/>
<area href="struct_equality_comparison_filter_1_1_mismatch_detected.html" alt="EqualityComparisonFilter::MismatchDetected" shape="rect" coords="412,336,814,360"/>
<area href="class_file_sink_1_1_err.html" title="Exception thrown when file-based error is encountered. " alt="FileSink::Err" shape="rect" coords="412,392,814,416"/>
<area href="class_file_store_1_1_err.html" title="Exception thrown when file-based error is encountered. " alt="FileStore::Err" shape="rect" coords="412,448,814,472"/>
<area href="class_hash_verification_filter_1_1_hash_verification_failed.html" title="Exception thrown when a data integrity check failure is encountered. " alt="HashVerificationFilter::HashVerificationFailed" shape="rect" coords="412,504,814,528"/>
<area href="class_huffman_decoder_1_1_err.html" alt="HuffmanDecoder::Err" shape="rect" coords="412,560,814,584"/>
<area href="class_inflator_1_1_err.html" alt="Inflator::Err" shape="rect" coords="412,616,814,640"/>
<area href="class_integer_1_1_divide_by_zero.html" title="Exception thrown when division by 0 is encountered. " alt="Integer::DivideByZero" shape="rect" coords="412,672,814,696"/>
<area href="class_integer_1_1_open_p_g_p_decode_err.html" title="Exception thrown when an error is encountered decoding an OpenPGP integer. " alt="Integer::OpenPGPDecodeErr" shape="rect" coords="412,728,814,752"/>
<area href="class_integer_1_1_random_number_not_found.html" title="Exception thrown when a random number cannot be found that satisfies the condition. " alt="Integer::RandomNumberNotFound" shape="rect" coords="412,784,814,808"/>
<area href="class_invalid_argument.html" title="An invalid argument was detected. " alt="InvalidArgument" shape="rect" coords="412,840,814,864"/>
<area href="class_invalid_data_format.html" title="Input data was received that did not conform to expected format. " alt="InvalidDataFormat" shape="rect" coords="412,896,814,920"/>
<area href="class_n_i_s_t___d_r_b_g_1_1_err.html" title="Exception thrown when a NIST DRBG encounters an error. " alt="NIST_DRBG::Err" shape="rect" coords="412,952,814,976"/>
<area href="class_not_implemented.html" title="A method was called which was not implemented. " alt="NotImplemented" shape="rect" coords="412,1008,814,1032"/>
<area href="class_object_factory_registry_1_1_factory_not_found.html" alt="ObjectFactoryRegistry< AbstractClass, instance >::FactoryNotFound" shape="rect" coords="412,1064,814,1088"/>
<area href="class_o_s___error.html" title="The operating system reported an error. " alt="OS_Error" shape="rect" coords="412,1120,814,1144"/>
<area href="class_o_s___r_n_g___err.html" title="Exception thrown when an operating system error is encountered. " alt="OS_RNG_Err" shape="rect" coords="412,1176,814,1200"/>
<area href="class_padlock_r_n_g___err.html" title="Exception thrown when a PadlockRNG generator encounters a generator related error. " alt="PadlockRNG_Err" shape="rect" coords="412,1232,814,1256"/>
<area href="class_p_k___encryptor_1_1_invalid_plaintext_length.html" title="Exception thrown when trying to encrypt plaintext of invalid length. " alt="PK_Encryptor::InvalidPlaintextLength" shape="rect" coords="412,1288,814,1312"/>
<area href="class_p_k___signature_scheme_1_1_invalid_key_length.html" title="Exception throw when the private or public key has a length that can't be used. " alt="PK_SignatureScheme::InvalidKeyLength" shape="rect" coords="412,1344,814,1368"/>
<area href="class_polynomial_mod2_1_1_divide_by_zero.html" title="Excpetion thrown when divide by zero is encountered. " alt="PolynomialMod2::DivideByZero" shape="rect" coords="412,1400,814,1424"/>
<area href="class_polynomial_over_1_1_divide_by_zero.html" title="division by zero exception " alt="PolynomialOver< T >::DivideByZero" shape="rect" coords="412,1456,814,1480"/>
<area href="class_r_d_r_a_n_d___err.html" title="Exception thrown when a RDRAND generator encounters a generator related error. " alt="RDRAND_Err" shape="rect" coords="412,1512,814,1536"/>
<area href="class_r_d_s_e_e_d___err.html" title="Exception thrown when a RDSEED generator encounters a generator related error. " alt="RDSEED_Err" shape="rect" coords="412,1568,814,1592"/>
<area href="class_ring_of_polynomials_over_1_1_interpolation_failed.html" alt="RingOfPolynomialsOver< T >::InterpolationFailed" shape="rect" coords="412,1624,814,1648"/>
<area href="class_self_test_failure.html" title="Exception thrown when a crypto algorithm is used after a self test fails. " alt="SelfTestFailure" shape="rect" coords="412,1680,814,1704"/>
<area href="class_signature_verification_filter_1_1_signature_verification_failed.html" title="Exception thrown when an invalid signature is encountered. " alt="SignatureVerificationFilter::SignatureVerificationFailed" shape="rect" coords="412,1736,814,1760"/>
<area href="class_wait_object_container_1_1_err.html" title="exception thrown by WaitObjectContainer " alt="WaitObjectContainer::Err" shape="rect" coords="412,1792,814,1816"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a8e53909d979479380e0274807c074c0a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_exception.html#a8e53909d979479380e0274807c074c0a">ErrorType</a> { <br />
  <a class="el" href="class_exception.html#a8e53909d979479380e0274807c074c0aa1323c0f32eac2f9502b99c5c899ce629">NOT_IMPLEMENTED</a>,
<a class="el" href="class_exception.html#a8e53909d979479380e0274807c074c0aab018a535e00d226178a71d2c5fa800d1">INVALID_ARGUMENT</a>,
<a class="el" href="class_exception.html#a8e53909d979479380e0274807c074c0aa11a8912fe9ae87f7469705b6d5130a06">CANNOT_FLUSH</a>,
<a class="el" href="class_exception.html#a8e53909d979479380e0274807c074c0aa77a639a803cf53052f9c76a0354247e6">DATA_INTEGRITY_CHECK_FAILED</a>,
<br />
  <a class="el" href="class_exception.html#a8e53909d979479380e0274807c074c0aa3a0352964781e7712b21dbb70ffbe646">INVALID_DATA_FORMAT</a>,
<a class="el" href="class_exception.html#a8e53909d979479380e0274807c074c0aad51c7d0e0156bc1794b3b7f99599aba8">IO_ERROR</a>,
<a class="el" href="class_exception.html#a8e53909d979479380e0274807c074c0aa27d9ee7704100a88e4ae4adcc4072015">OTHER_ERROR</a>
<br />
}</td></tr>
<tr class="memdesc:a8e53909d979479380e0274807c074c0a"><td class="mdescLeft"> </td><td class="mdescRight">Error types or categories. <a href="class_exception.html#a8e53909d979479380e0274807c074c0a">More...</a><br /></td></tr>
<tr class="separator:a8e53909d979479380e0274807c074c0a"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a30847048a4b7c9a7aae5e6178964dcfb"><td class="memItemLeft" align="right" valign="top"><a id="a30847048a4b7c9a7aae5e6178964dcfb"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_exception.html#a30847048a4b7c9a7aae5e6178964dcfb">Exception</a> (<a class="el" href="class_exception.html#a8e53909d979479380e0274807c074c0a">ErrorType</a> errorType, const std::string &s)</td></tr>
<tr class="memdesc:a30847048a4b7c9a7aae5e6178964dcfb"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new <a class="el" href="class_exception.html" title="Base class for all exceptions thrown by the library. ">Exception</a>. <br /></td></tr>
<tr class="separator:a30847048a4b7c9a7aae5e6178964dcfb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add710fe2bae3ac497ed60393eea35c91"><td class="memItemLeft" align="right" valign="top"><a id="add710fe2bae3ac497ed60393eea35c91"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_exception.html#add710fe2bae3ac497ed60393eea35c91">what</a> () const throw ()</td></tr>
<tr class="memdesc:add710fe2bae3ac497ed60393eea35c91"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a C-string describing the exception. <br /></td></tr>
<tr class="separator:add710fe2bae3ac497ed60393eea35c91"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae2d81c6f4f89015b9dcaa5ebfa47f3c4"><td class="memItemLeft" align="right" valign="top"><a id="ae2d81c6f4f89015b9dcaa5ebfa47f3c4"></a>
const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_exception.html#ae2d81c6f4f89015b9dcaa5ebfa47f3c4">GetWhat</a> () const</td></tr>
<tr class="memdesc:ae2d81c6f4f89015b9dcaa5ebfa47f3c4"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a string describing the exception. <br /></td></tr>
<tr class="separator:ae2d81c6f4f89015b9dcaa5ebfa47f3c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15f2ad1081dbac6d3cd676a4baa9515d"><td class="memItemLeft" align="right" valign="top"><a id="a15f2ad1081dbac6d3cd676a4baa9515d"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_exception.html#a15f2ad1081dbac6d3cd676a4baa9515d">SetWhat</a> (const std::string &s)</td></tr>
<tr class="memdesc:a15f2ad1081dbac6d3cd676a4baa9515d"><td class="mdescLeft"> </td><td class="mdescRight">Sets the error string for the exception. <br /></td></tr>
<tr class="separator:a15f2ad1081dbac6d3cd676a4baa9515d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2c2e8a3c1871c532660252cd1894b90"><td class="memItemLeft" align="right" valign="top"><a id="ac2c2e8a3c1871c532660252cd1894b90"></a>
<a class="el" href="class_exception.html#a8e53909d979479380e0274807c074c0a">ErrorType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_exception.html#ac2c2e8a3c1871c532660252cd1894b90">GetErrorType</a> () const</td></tr>
<tr class="memdesc:ac2c2e8a3c1871c532660252cd1894b90"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the error type for the exception. <br /></td></tr>
<tr class="separator:ac2c2e8a3c1871c532660252cd1894b90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e1d8806d64e54e9584e9918462894bc"><td class="memItemLeft" align="right" valign="top"><a id="a0e1d8806d64e54e9584e9918462894bc"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_exception.html#a0e1d8806d64e54e9584e9918462894bc">SetErrorType</a> (<a class="el" href="class_exception.html#a8e53909d979479380e0274807c074c0a">ErrorType</a> errorType)</td></tr>
<tr class="memdesc:a0e1d8806d64e54e9584e9918462894bc"><td class="mdescLeft"> </td><td class="mdescRight">Sets the error type for the exceptions. <br /></td></tr>
<tr class="separator:a0e1d8806d64e54e9584e9918462894bc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for all exceptions thrown by the library. </p>
<p>All library exceptions directly or indirectly inherit from the <a class="el" href="class_exception.html" title="Base class for all exceptions thrown by the library. ">Exception</a> class. The <a class="el" href="class_exception.html" title="Base class for all exceptions thrown by the library. ">Exception</a> class itself inherits from std::exception. The library does not use std::runtime_error derived classes. </p>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l00155">155</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a8e53909d979479380e0274807c074c0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e53909d979479380e0274807c074c0a">◆ </a></span>ErrorType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_exception.html#a8e53909d979479380e0274807c074c0a">Exception::ErrorType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Error types or categories. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a8e53909d979479380e0274807c074c0aa1323c0f32eac2f9502b99c5c899ce629"></a>NOT_IMPLEMENTED </td><td class="fielddoc"><p>A method was called which was not implemented. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8e53909d979479380e0274807c074c0aab018a535e00d226178a71d2c5fa800d1"></a>INVALID_ARGUMENT </td><td class="fielddoc"><p>An invalid argument was detected. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8e53909d979479380e0274807c074c0aa11a8912fe9ae87f7469705b6d5130a06"></a>CANNOT_FLUSH </td><td class="fielddoc"><p><a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations. ">BufferedTransformation</a> received a Flush(true) signal but can't flush buffers. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8e53909d979479380e0274807c074c0aa77a639a803cf53052f9c76a0354247e6"></a>DATA_INTEGRITY_CHECK_FAILED </td><td class="fielddoc"><p>Data integerity check, such as CRC or MAC, failed. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8e53909d979479380e0274807c074c0aa3a0352964781e7712b21dbb70ffbe646"></a>INVALID_DATA_FORMAT </td><td class="fielddoc"><p>Input data was received that did not conform to expected format. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8e53909d979479380e0274807c074c0aad51c7d0e0156bc1794b3b7f99599aba8"></a>IO_ERROR </td><td class="fielddoc"><p>Error reading from input device or writing to output device. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8e53909d979479380e0274807c074c0aa27d9ee7704100a88e4ae4adcc4072015"></a>OTHER_ERROR </td><td class="fielddoc"><p>Some other error occurred not belonging to other categories. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l00160">160</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="cryptlib_8h_source.html">cryptlib.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 16 2018 07:58:33 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
>
889
