wxExtend/classwx_crypto_hash_s_h_a1.html

195 lines
16 KiB
HTML

<!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=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wxExtend: wxCryptoHashSHA1 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectrow">
<td id="projectalign">
<div id="projectname">wxExtend
</div>
<div id="projectbrief">Additional templates and function helpers for wxWidgets</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classwx_crypto_hash_s_h_a1-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">wxCryptoHashSHA1 Class Reference<div class="ingroups"><a class="el" href="group__wx_extend.html">WxExtend</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>SHA-1 Cryptographics Hash.
<a href="classwx_crypto_hash_s_h_a1.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="crypto_8h_source.html">wxex/crypto.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for wxCryptoHashSHA1:</div>
<div class="dyncontent">
<div class="center">
<img src="classwx_crypto_hash_s_h_a1.png" usemap="#wxCryptoHashSHA1_map" alt=""/>
<map id="wxCryptoHashSHA1_map" name="wxCryptoHashSHA1_map">
<area href="classwx_crypto_hash.html" title="Cryptographics Hash Base." alt="wxCryptoHash" shape="rect" coords="0,0,127,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a39beceb5a2186bc1cc9f09428c35eeda"><td class="memItemLeft" align="right" valign="top"><a id="a39beceb5a2186bc1cc9f09428c35eeda" name="a39beceb5a2186bc1cc9f09428c35eeda"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>wxCryptoHashSHA1</b> (<a class="el" href="classwx_crypto_session.html">wxCryptoSession</a> &amp;session)</td></tr>
<tr class="memdesc:a39beceb5a2186bc1cc9f09428c35eeda"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new cryptographics SHA-1 hash. <br /></td></tr>
<tr class="separator:a39beceb5a2186bc1cc9f09428c35eeda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac684c67a791c1daa76060cfb8be6c115"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_crypto_hash_s_h_a1.html#ac684c67a791c1daa76060cfb8be6c115">GetValue</a> (wxMemoryBuffer &amp;hash)</td></tr>
<tr class="memdesc:ac684c67a791c1daa76060cfb8be6c115"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finish hashing and return hash data. <a href="classwx_crypto_hash_s_h_a1.html#ac684c67a791c1daa76060cfb8be6c115">More...</a><br /></td></tr>
<tr class="separator:ac684c67a791c1daa76060cfb8be6c115"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classwx_crypto_hash"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classwx_crypto_hash')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classwx_crypto_hash.html">wxCryptoHash</a></td></tr>
<tr class="memitem:a294ffd571dfb94b7641db96bce483fae inherit pub_methods_classwx_crypto_hash"><td class="memItemLeft" align="right" valign="top"><a id="a294ffd571dfb94b7641db96bce483fae" name="a294ffd571dfb94b7641db96bce483fae"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>wxCryptoHash</b> ()</td></tr>
<tr class="memdesc:a294ffd571dfb94b7641db96bce483fae inherit pub_methods_classwx_crypto_hash"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new cryptographics hash. <br /></td></tr>
<tr class="separator:a294ffd571dfb94b7641db96bce483fae inherit pub_methods_classwx_crypto_hash"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53ec9d8cc3275837284899c5b21ac6fb inherit pub_methods_classwx_crypto_hash"><td class="memItemLeft" align="right" valign="top"><a id="a53ec9d8cc3275837284899c5b21ac6fb" name="a53ec9d8cc3275837284899c5b21ac6fb"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><b>~wxCryptoHash</b> ()</td></tr>
<tr class="memdesc:a53ec9d8cc3275837284899c5b21ac6fb inherit pub_methods_classwx_crypto_hash"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a53ec9d8cc3275837284899c5b21ac6fb inherit pub_methods_classwx_crypto_hash"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5d521f9db3f6ac272e938fa74afb207 inherit pub_methods_classwx_crypto_hash"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_crypto_hash.html#ac5d521f9db3f6ac272e938fa74afb207">IsOk</a> () const noexcept</td></tr>
<tr class="memdesc:ac5d521f9db3f6ac272e938fa74afb207 inherit pub_methods_classwx_crypto_hash"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has the hash creation been successful? <a href="classwx_crypto_hash.html#ac5d521f9db3f6ac272e938fa74afb207">More...</a><br /></td></tr>
<tr class="separator:ac5d521f9db3f6ac272e938fa74afb207 inherit pub_methods_classwx_crypto_hash"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af48cdd5c908fcb13a6aec3383c95e344 inherit pub_methods_classwx_crypto_hash"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_crypto_hash.html#af48cdd5c908fcb13a6aec3383c95e344">operator HCRYPTHASH</a> () const noexcept</td></tr>
<tr class="separator:af48cdd5c908fcb13a6aec3383c95e344 inherit pub_methods_classwx_crypto_hash"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae26c3fa63ede941c3ae6e3758ea2c966 inherit pub_methods_classwx_crypto_hash"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_crypto_hash.html#ae26c3fa63ede941c3ae6e3758ea2c966">Hash</a> (_In_reads_bytes_(size) const void *data, size_t size)</td></tr>
<tr class="memdesc:ae26c3fa63ede941c3ae6e3758ea2c966 inherit pub_methods_classwx_crypto_hash"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hashes given block of data. <a href="classwx_crypto_hash.html#ae26c3fa63ede941c3ae6e3758ea2c966">More...</a><br /></td></tr>
<tr class="separator:ae26c3fa63ede941c3ae6e3758ea2c966 inherit pub_methods_classwx_crypto_hash"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36f7967c2f2affb36c9c7a9924d94c39 inherit pub_methods_classwx_crypto_hash"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_crypto_hash.html#a36f7967c2f2affb36c9c7a9924d94c39">Hash</a> (const wxMemoryBuffer &amp;data)</td></tr>
<tr class="memdesc:a36f7967c2f2affb36c9c7a9924d94c39 inherit pub_methods_classwx_crypto_hash"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hashes given block of data. <a href="classwx_crypto_hash.html#a36f7967c2f2affb36c9c7a9924d94c39">More...</a><br /></td></tr>
<tr class="separator:a36f7967c2f2affb36c9c7a9924d94c39 inherit pub_methods_classwx_crypto_hash"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65d60a6937ee200baac1fe01eb8255f6 inherit pub_methods_classwx_crypto_hash"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_crypto_hash.html#a65d60a6937ee200baac1fe01eb8255f6">HashAsUTF8</a> (const wxString &amp;str)</td></tr>
<tr class="memdesc:a65d60a6937ee200baac1fe01eb8255f6 inherit pub_methods_classwx_crypto_hash"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts string to UTF-8 and hashes it. <a href="classwx_crypto_hash.html#a65d60a6937ee200baac1fe01eb8255f6">More...</a><br /></td></tr>
<tr class="separator:a65d60a6937ee200baac1fe01eb8255f6 inherit pub_methods_classwx_crypto_hash"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a322f6ead6d2bc7e23a54ca6104e71cf8 inherit pub_methods_classwx_crypto_hash"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_crypto_hash.html#a322f6ead6d2bc7e23a54ca6104e71cf8">HashFile</a> (const wxString &amp;fileName)</td></tr>
<tr class="memdesc:a322f6ead6d2bc7e23a54ca6104e71cf8 inherit pub_methods_classwx_crypto_hash"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hashes a file. <a href="classwx_crypto_hash.html#a322f6ead6d2bc7e23a54ca6104e71cf8">More...</a><br /></td></tr>
<tr class="separator:a322f6ead6d2bc7e23a54ca6104e71cf8 inherit pub_methods_classwx_crypto_hash"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d1bee413e0c04bf56edc82a5da78559 inherit pub_methods_classwx_crypto_hash"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_crypto_hash.html#a9d1bee413e0c04bf56edc82a5da78559">GetValue</a> (wxMemoryBuffer &amp;hash)</td></tr>
<tr class="memdesc:a9d1bee413e0c04bf56edc82a5da78559 inherit pub_methods_classwx_crypto_hash"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finish hashing and return hash data. <a href="classwx_crypto_hash.html#a9d1bee413e0c04bf56edc82a5da78559">More...</a><br /></td></tr>
<tr class="separator:a9d1bee413e0c04bf56edc82a5da78559 inherit pub_methods_classwx_crypto_hash"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30e3060aea3e1f7233d4c547a4913629 inherit pub_methods_classwx_crypto_hash"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_crypto_hash.html#a30e3060aea3e1f7233d4c547a4913629">Sign</a> (wxMemoryBuffer &amp;signature)</td></tr>
<tr class="memdesc:a30e3060aea3e1f7233d4c547a4913629 inherit pub_methods_classwx_crypto_hash"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signs the hash using session key. <a href="classwx_crypto_hash.html#a30e3060aea3e1f7233d4c547a4913629">More...</a><br /></td></tr>
<tr class="separator:a30e3060aea3e1f7233d4c547a4913629 inherit pub_methods_classwx_crypto_hash"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa50c43132cffb5b0050073a6ff8066bc inherit pub_methods_classwx_crypto_hash"><td class="memItemLeft" align="right" valign="top">wxMemoryBuffer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_crypto_hash.html#aa50c43132cffb5b0050073a6ff8066bc">Sign</a> ()</td></tr>
<tr class="memdesc:aa50c43132cffb5b0050073a6ff8066bc inherit pub_methods_classwx_crypto_hash"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signs the hash using session key. <a href="classwx_crypto_hash.html#aa50c43132cffb5b0050073a6ff8066bc">More...</a><br /></td></tr>
<tr class="separator:aa50c43132cffb5b0050073a6ff8066bc inherit pub_methods_classwx_crypto_hash"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_classwx_crypto_hash"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classwx_crypto_hash')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classwx_crypto_hash.html">wxCryptoHash</a></td></tr>
<tr class="memitem:a5424e152aba41c70b3bdb821ef21851c inherit pro_attribs_classwx_crypto_hash"><td class="memItemLeft" align="right" valign="top"><a id="a5424e152aba41c70b3bdb821ef21851c" name="a5424e152aba41c70b3bdb821ef21851c"></a>
HCRYPTHASH&#160;</td><td class="memItemRight" valign="bottom"><b>m_h</b></td></tr>
<tr class="memdesc:a5424e152aba41c70b3bdb821ef21851c inherit pro_attribs_classwx_crypto_hash"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hash Handle. <br /></td></tr>
<tr class="separator:a5424e152aba41c70b3bdb821ef21851c inherit pro_attribs_classwx_crypto_hash"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >SHA-1 Cryptographics Hash. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ac684c67a791c1daa76060cfb8be6c115" name="ac684c67a791c1daa76060cfb8be6c115"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac684c67a791c1daa76060cfb8be6c115">&#9670;&nbsp;</a></span>GetValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool wxCryptoHashSHA1::GetValue </td>
<td>(</td>
<td class="paramtype">wxMemoryBuffer &amp;&#160;</td>
<td class="paramname"><em>hash</em></td><td>)</td>
<td></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>Finish hashing and return hash data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">hash</td><td>Hash data</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>true</code> if succeeded</li>
<li><code>false</code> otherwise </li>
</ul>
</dd></dl>
<p>Reimplemented from <a class="el" href="classwx_crypto_hash.html#a9d1bee413e0c04bf56edc82a5da78559">wxCryptoHash</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/wxex/<a class="el" href="crypto_8h_source.html">crypto.h</a></li>
<li>src/crypto.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Feb 17 2022 12:50:26 for wxExtend by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
</small></address>
</body>
</html>