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

192 lines
9.3 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: wxCryptoSession 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_session-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">wxCryptoSession 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 Session Base Class.
<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>
<div class="dynheader">
Inheritance diagram for wxCryptoSession:</div>
<div class="dyncontent">
<div class="center">
<img src="classwx_crypto_session.png" usemap="#wxCryptoSession_map" alt=""/>
<map id="wxCryptoSession_map" name="wxCryptoSession_map">
<area href="classwx_crypto_session_r_s_a_a_e_s.html" title="RSA AES Cryptographics Session." alt="wxCryptoSessionRSAAES" shape="rect" coords="0,56,159,80"/>
</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:ab745053893934e49fa3304e70e16bff6" id="r_ab745053893934e49fa3304e70e16bff6"><td class="memItemLeft" align="right" valign="top"><a id="ab745053893934e49fa3304e70e16bff6" name="ab745053893934e49fa3304e70e16bff6"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>wxCryptoSession</b> ()</td></tr>
<tr class="memdesc:ab745053893934e49fa3304e70e16bff6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new cryptographics session. <br /></td></tr>
<tr class="separator:ab745053893934e49fa3304e70e16bff6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a492e3909129930480b8b95773cc57af2" id="r_a492e3909129930480b8b95773cc57af2"><td class="memItemLeft" align="right" valign="top"><a id="a492e3909129930480b8b95773cc57af2" name="a492e3909129930480b8b95773cc57af2"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><b>~wxCryptoSession</b> ()</td></tr>
<tr class="memdesc:a492e3909129930480b8b95773cc57af2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a492e3909129930480b8b95773cc57af2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8ed4efdc2c9fbec56129ee096354744" id="r_ae8ed4efdc2c9fbec56129ee096354744"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae8ed4efdc2c9fbec56129ee096354744">IsOk</a> () const noexcept</td></tr>
<tr class="memdesc:ae8ed4efdc2c9fbec56129ee096354744"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has the session creation been successful? <br /></td></tr>
<tr class="separator:ae8ed4efdc2c9fbec56129ee096354744"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07af35e7873944f3405203ba1bb11796" id="r_a07af35e7873944f3405203ba1bb11796"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a07af35e7873944f3405203ba1bb11796">operator HCRYPTPROV</a> () const noexcept</td></tr>
<tr class="separator:a07af35e7873944f3405203ba1bb11796"><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:afc12a4c11aa0319694da98a469156f51" id="r_afc12a4c11aa0319694da98a469156f51"><td class="memItemLeft" align="right" valign="top"><a id="afc12a4c11aa0319694da98a469156f51" name="afc12a4c11aa0319694da98a469156f51"></a>
HCRYPTPROV&#160;</td><td class="memItemRight" valign="bottom"><b>m_h</b></td></tr>
<tr class="memdesc:afc12a4c11aa0319694da98a469156f51"><td class="mdescLeft">&#160;</td><td class="mdescRight">Session Handle. <br /></td></tr>
<tr class="separator:afc12a4c11aa0319694da98a469156f51"><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 Session Base Class. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae8ed4efdc2c9fbec56129ee096354744" name="ae8ed4efdc2c9fbec56129ee096354744"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8ed4efdc2c9fbec56129ee096354744">&#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 wxCryptoSession::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 session 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="a07af35e7873944f3405203ba1bb11796" name="a07af35e7873944f3405203ba1bb11796"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07af35e7873944f3405203ba1bb11796">&#9670;&#160;</a></span>operator HCRYPTPROV()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">wxCryptoSession::operator HCRYPTPROV </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>Session 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