Amebis/wxExtend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
wxExtend/classwx_crypto_key.html

191 lines
10 KiB
HTML
Raw Blame History

<!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" lang="en-US">
<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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wxExtend: wxCryptoKey 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>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.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.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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');
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classwx_crypto_key-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">wxCryptoKey Class Reference<div class="ingroups"><a class="el" href="group__wx_extend.html">WxExtend</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Cryptographics Key Base.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="crypto_8h_source.html">wxex/crypto.h</a>&gt;</code></p>
<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:a77b57e4487dc3287aff103c6300348c0" id="r_a77b57e4487dc3287aff103c6300348c0"><td class="memItemLeft" align="right" valign="top"><a id="a77b57e4487dc3287aff103c6300348c0" name="a77b57e4487dc3287aff103c6300348c0"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>wxCryptoKey</b> ()</td></tr>
<tr class="memdesc:a77b57e4487dc3287aff103c6300348c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new cryptographics key. <br /></td></tr>
<tr class="separator:a77b57e4487dc3287aff103c6300348c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0aa0c802206417dd65b7efe8847a6505" id="r_a0aa0c802206417dd65b7efe8847a6505"><td class="memItemLeft" align="right" valign="top"><a id="a0aa0c802206417dd65b7efe8847a6505" name="a0aa0c802206417dd65b7efe8847a6505"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><b>~wxCryptoKey</b> ()</td></tr>
<tr class="memdesc:a0aa0c802206417dd65b7efe8847a6505"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a0aa0c802206417dd65b7efe8847a6505"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc8cb58b4d6d362d1dd1f2b68b93b38d" id="r_afc8cb58b4d6d362d1dd1f2b68b93b38d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afc8cb58b4d6d362d1dd1f2b68b93b38d">IsOk</a> () const noexcept</td></tr>
<tr class="memdesc:afc8cb58b4d6d362d1dd1f2b68b93b38d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has the key creation been successful? <br /></td></tr>
<tr class="separator:afc8cb58b4d6d362d1dd1f2b68b93b38d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac33af073e59164397426adaed6dc6ad0" id="r_ac33af073e59164397426adaed6dc6ad0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac33af073e59164397426adaed6dc6ad0">operator HCRYPTKEY</a> () const noexcept</td></tr>
<tr class="separator:ac33af073e59164397426adaed6dc6ad0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab038e20153c1e5881ccf29ea2a49e884" id="r_ab038e20153c1e5881ccf29ea2a49e884"><td class="memItemLeft" align="right" valign="top"><a id="ab038e20153c1e5881ccf29ea2a49e884" name="ab038e20153c1e5881ccf29ea2a49e884"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>ImportPrivate</b> (<a class="el" href="classwx_crypto_session.html">wxCryptoSession</a> &amp;session, _In_reads_bytes_(size) const void *data, size_t size)</td></tr>
<tr class="memdesc:ab038e20153c1e5881ccf29ea2a49e884"><td class="mdescLeft">&#160;</td><td class="mdescRight">Imports private key. <br /></td></tr>
<tr class="separator:ab038e20153c1e5881ccf29ea2a49e884"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a125633f1ec6153228d5bb8001c342f8a" id="r_a125633f1ec6153228d5bb8001c342f8a"><td class="memItemLeft" align="right" valign="top"><a id="a125633f1ec6153228d5bb8001c342f8a" name="a125633f1ec6153228d5bb8001c342f8a"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>ImportPublic</b> (<a class="el" href="classwx_crypto_session.html">wxCryptoSession</a> &amp;session, _In_reads_bytes_(size) const void *data, size_t size)</td></tr>
<tr class="memdesc:a125633f1ec6153228d5bb8001c342f8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Imports public key. <br /></td></tr>
<tr class="separator:a125633f1ec6153228d5bb8001c342f8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a80ff174fdca2897a83addf87b5f7afb9" id="r_a80ff174fdca2897a83addf87b5f7afb9"><td class="memItemLeft" align="right" valign="top"><a id="a80ff174fdca2897a83addf87b5f7afb9" name="a80ff174fdca2897a83addf87b5f7afb9"></a>
HCRYPTKEY&#160;</td><td class="memItemRight" valign="bottom"><b>m_h</b></td></tr>
<tr class="memdesc:a80ff174fdca2897a83addf87b5f7afb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key Handle. <br /></td></tr>
<tr class="separator:a80ff174fdca2897a83addf87b5f7afb9"><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>Cryptographics Key Base. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="afc8cb58b4d6d362d1dd1f2b68b93b38d" name="afc8cb58b4d6d362d1dd1f2b68b93b38d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc8cb58b4d6d362d1dd1f2b68b93b38d">&#9670;&#160;</a></span>IsOk()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool wxCryptoKey::IsOk </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Has the key creation been successful? </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>true</code> if creation succeeded</li>
<li><code>false</code> otherwise </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ac33af073e59164397426adaed6dc6ad0" name="ac33af073e59164397426adaed6dc6ad0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac33af073e59164397426adaed6dc6ad0">&#9670;&#160;</a></span>operator HCRYPTKEY()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">wxCryptoKey::operator HCRYPTKEY </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>Key handle to be used in native API calls. </dd></dl>
</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/<b>crypto.cpp</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Mar 11 2024 14:56:54 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.10.0
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink