WinStd/classwinstd_1_1sanitizing__allocator.html

137 lines
9.1 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>WinStd: winstd::sanitizing_allocator&lt; _Ty &gt; Class Template 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">WinStd
</div>
<div id="projectbrief">Additional templates and function helpers for Microsoft Windows using Standard C++ classes</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>winstd</b></li><li class="navelem"><a class="el" href="classwinstd_1_1sanitizing__allocator.html">sanitizing_allocator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classwinstd_1_1sanitizing__allocator-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">winstd::sanitizing_allocator&lt; _Ty &gt; Class Template Reference<div class="ingroups"><a class="el" href="group___win_std_mem_sanitize.html">Auto-sanitize Memory Management</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>An allocator template that sanitizes each memory block before it is destroyed or reallocated.
<a href="classwinstd_1_1sanitizing__allocator.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_common_8h_source.html">WinStd/Common.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for winstd::sanitizing_allocator&lt; _Ty &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classwinstd_1_1sanitizing__allocator.png" alt=""/>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwinstd_1_1sanitizing__allocator_1_1rebind.html">rebind</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert this type to sanitizing_allocator&lt;_Other&gt; <a href="structwinstd_1_1sanitizing__allocator_1_1rebind.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:af60051d2fb18f2c2353ffe9bb6a06087"><td class="memItemLeft" align="right" valign="top"><a id="af60051d2fb18f2c2353ffe9bb6a06087" name="af60051d2fb18f2c2353ffe9bb6a06087"></a>
typedef std::allocator&lt; _Ty &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>_Mybase</b></td></tr>
<tr class="memdesc:af60051d2fb18f2c2353ffe9bb6a06087"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base type. <br /></td></tr>
<tr class="separator:af60051d2fb18f2c2353ffe9bb6a06087"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:af89279ba111029e2880c2a43189b4d4c"><td class="memItemLeft" align="right" valign="top"><a id="af89279ba111029e2880c2a43189b4d4c" name="af89279ba111029e2880c2a43189b4d4c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>sanitizing_allocator</b> () noexcept</td></tr>
<tr class="memdesc:af89279ba111029e2880c2a43189b4d4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct default allocator. <br /></td></tr>
<tr class="separator:af89279ba111029e2880c2a43189b4d4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1559d5205a26a17bec111649840f5825"><td class="memItemLeft" align="right" valign="top"><a id="a1559d5205a26a17bec111649840f5825" name="a1559d5205a26a17bec111649840f5825"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>sanitizing_allocator</b> (const <a class="el" href="classwinstd_1_1sanitizing__allocator.html">sanitizing_allocator</a>&lt; _Ty &gt; &amp;_Othr)</td></tr>
<tr class="memdesc:a1559d5205a26a17bec111649840f5825"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct by copying. <br /></td></tr>
<tr class="separator:a1559d5205a26a17bec111649840f5825"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63e7945c2c3e16de6676dea04d08ed16"><td class="memTemplParams" colspan="2"><a id="a63e7945c2c3e16de6676dea04d08ed16" name="a63e7945c2c3e16de6676dea04d08ed16"></a>
template&lt;class _Other &gt; </td></tr>
<tr class="memitem:a63e7945c2c3e16de6676dea04d08ed16"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>sanitizing_allocator</b> (const <a class="el" href="classwinstd_1_1sanitizing__allocator.html">sanitizing_allocator</a>&lt; _Other &gt; &amp;_Othr) noexcept</td></tr>
<tr class="memdesc:a63e7945c2c3e16de6676dea04d08ed16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct from a related allocator. <br /></td></tr>
<tr class="separator:a63e7945c2c3e16de6676dea04d08ed16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c208920fad2171f4448ec6e7817522a"><td class="memItemLeft" align="right" valign="top"><a id="a2c208920fad2171f4448ec6e7817522a" name="a2c208920fad2171f4448ec6e7817522a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>deallocate</b> (pointer _Ptr, size_type _Size)</td></tr>
<tr class="memdesc:a2c208920fad2171f4448ec6e7817522a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deallocate object at _Ptr sanitizing its content first. <br /></td></tr>
<tr class="separator:a2c208920fad2171f4448ec6e7817522a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class _Ty&gt;<br />
class winstd::sanitizing_allocator&lt; _Ty &gt;</div><p >An allocator template that sanitizes each memory block before it is destroyed or reallocated. </p>
<dl class="section note"><dt>Note</dt><dd><code><a class="el" href="classwinstd_1_1sanitizing__allocator.html" title="An allocator template that sanitizes each memory block before it is destroyed or reallocated.">sanitizing_allocator</a></code> introduces a performance penalty. However, it provides an additional level of security. Use for security sensitive data memory storage only. </dd></dl>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>include/WinStd/<a class="el" href="_common_8h_source.html">Common.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 3 2022 08:18:01 for WinStd 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>