<!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++: DecodingResult Struct 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-methods">Public Member Functions</a> | <a href="#pub-attribs">Public Attributes</a> | <a href="struct_decoding_result-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">DecodingResult Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p>Returns a decoding results. <a href="struct_decoding_result.html#details">More...</a></p> <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:a9e13518e1116d3a22a349c0ba9152bf3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_decoding_result.html#a9e13518e1116d3a22a349c0ba9152bf3">DecodingResult</a> ()</td></tr> <tr class="memdesc:a9e13518e1116d3a22a349c0ba9152bf3"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="struct_decoding_result.html" title="Returns a decoding results. ">DecodingResult</a>. <a href="#a9e13518e1116d3a22a349c0ba9152bf3">More...</a><br /></td></tr> <tr class="separator:a9e13518e1116d3a22a349c0ba9152bf3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a04f03ea66845fe03fc464de05a816bbb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_decoding_result.html#a04f03ea66845fe03fc464de05a816bbb">DecodingResult</a> (size_t len)</td></tr> <tr class="memdesc:a04f03ea66845fe03fc464de05a816bbb"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="struct_decoding_result.html" title="Returns a decoding results. ">DecodingResult</a>. <a href="#a04f03ea66845fe03fc464de05a816bbb">More...</a><br /></td></tr> <tr class="separator:a04f03ea66845fe03fc464de05a816bbb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6a071204f34f658ab76647b23d718d0b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_decoding_result.html#a6a071204f34f658ab76647b23d718d0b">operator==</a> (const <a class="el" href="struct_decoding_result.html">DecodingResult</a> &rhs) const</td></tr> <tr class="memdesc:a6a071204f34f658ab76647b23d718d0b"><td class="mdescLeft"> </td><td class="mdescRight">Compare two <a class="el" href="struct_decoding_result.html" title="Returns a decoding results. ">DecodingResult</a>. <a href="#a6a071204f34f658ab76647b23d718d0b">More...</a><br /></td></tr> <tr class="separator:a6a071204f34f658ab76647b23d718d0b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a31c685c8ea6367fde79b289c2f1129e5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_decoding_result.html#a31c685c8ea6367fde79b289c2f1129e5">operator!=</a> (const <a class="el" href="struct_decoding_result.html">DecodingResult</a> &rhs) const</td></tr> <tr class="memdesc:a31c685c8ea6367fde79b289c2f1129e5"><td class="mdescLeft"> </td><td class="mdescRight">Compare two <a class="el" href="struct_decoding_result.html" title="Returns a decoding results. ">DecodingResult</a>. <a href="#a31c685c8ea6367fde79b289c2f1129e5">More...</a><br /></td></tr> <tr class="separator:a31c685c8ea6367fde79b289c2f1129e5"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> Public Attributes</h2></td></tr> <tr class="memitem:ab88062318cd0e68b3061db351d3ba34d"><td class="memItemLeft" align="right" valign="top"><a id="ab88062318cd0e68b3061db351d3ba34d"></a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_decoding_result.html#ab88062318cd0e68b3061db351d3ba34d">isValidCoding</a></td></tr> <tr class="memdesc:ab88062318cd0e68b3061db351d3ba34d"><td class="mdescLeft"> </td><td class="mdescRight">Flag to indicate the decoding is valid. <br /></td></tr> <tr class="separator:ab88062318cd0e68b3061db351d3ba34d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af4496c82e5764175a27e36629e1cded7"><td class="memItemLeft" align="right" valign="top"><a id="af4496c82e5764175a27e36629e1cded7"></a> size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_decoding_result.html#af4496c82e5764175a27e36629e1cded7">messageLength</a></td></tr> <tr class="memdesc:af4496c82e5764175a27e36629e1cded7"><td class="mdescLeft"> </td><td class="mdescRight">Recovered message length if isValidCoding is true, undefined otherwise. <br /></td></tr> <tr class="separator:af4496c82e5764175a27e36629e1cded7"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Returns a decoding results. </p> <p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l00252">252</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a9e13518e1116d3a22a349c0ba9152bf3"></a> <h2 class="memtitle"><span class="permalink"><a href="#a9e13518e1116d3a22a349c0ba9152bf3">◆ </a></span>DecodingResult() <span class="overload">[1/2]</span></h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">DecodingResult::DecodingResult </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Constructs a <a class="el" href="struct_decoding_result.html" title="Returns a decoding results. ">DecodingResult</a>. </p> <p>isValidCoding is initialized to false and messageLength is initialized to 0. </p> <p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l00256">256</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p> </div> </div> <a id="a04f03ea66845fe03fc464de05a816bbb"></a> <h2 class="memtitle"><span class="permalink"><a href="#a04f03ea66845fe03fc464de05a816bbb">◆ </a></span>DecodingResult() <span class="overload">[2/2]</span></h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">DecodingResult::DecodingResult </td> <td>(</td> <td class="paramtype">size_t </td> <td class="paramname"><em>len</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Constructs a <a class="el" href="struct_decoding_result.html" title="Returns a decoding results. ">DecodingResult</a>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">len</td><td>the message length</td></tr> </table> </dd> </dl> <p>isValidCoding is initialized to true. </p> <p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l00260">260</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a id="a6a071204f34f658ab76647b23d718d0b"></a> <h2 class="memtitle"><span class="permalink"><a href="#a6a071204f34f658ab76647b23d718d0b">◆ </a></span>operator==()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool DecodingResult::operator== </td> <td>(</td> <td class="paramtype">const <a class="el" href="struct_decoding_result.html">DecodingResult</a> & </td> <td class="paramname"><em>rhs</em></td><td>)</td> <td> const</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>Compare two <a class="el" href="struct_decoding_result.html" title="Returns a decoding results. ">DecodingResult</a>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">rhs</td><td>the other <a class="el" href="struct_decoding_result.html" title="Returns a decoding results. ">DecodingResult</a> </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true if both isValidCoding and messageLength are equal, false otherwise </dd></dl> <p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l00265">265</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p> </div> </div> <a id="a31c685c8ea6367fde79b289c2f1129e5"></a> <h2 class="memtitle"><span class="permalink"><a href="#a31c685c8ea6367fde79b289c2f1129e5">◆ </a></span>operator!=()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool DecodingResult::operator!= </td> <td>(</td> <td class="paramtype">const <a class="el" href="struct_decoding_result.html">DecodingResult</a> & </td> <td class="paramname"><em>rhs</em></td><td>)</td> <td> const</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>Compare two <a class="el" href="struct_decoding_result.html" title="Returns a decoding results. ">DecodingResult</a>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">rhs</td><td>the other <a class="el" href="struct_decoding_result.html" title="Returns a decoding results. ">DecodingResult</a> </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true if either isValidCoding or messageLength is <em>not</em> equal, false otherwise</dd></dl> <p>Returns <code>!operator==(rhs)</code>. </p> <p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l00270">270</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p> </div> </div> <hr/>The documentation for this struct 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:23 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>