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

296 lines
18 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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WinStd: General</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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.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">WinStd
</div>
<div id="projectbrief">Windows Win32 API using Standard C++</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="doc-content">
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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 class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle"><div class="title">General</div></div>
</div><!--header-->
<div class="contents">
<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_1_local_free__delete.html">winstd::LocalFree_delete&lt; _Ty &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deleter for unique_ptr using LocalFree. <a href="structwinstd_1_1_local_free__delete.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1_local_free__delete_3_01___ty_0f_0e_4.html">winstd::LocalFree_delete&lt; _Ty[]&gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deleter for unique_ptr to array of unknown size using LocalFree. <a href="structwinstd_1_1_local_free__delete_3_01___ty_0f_0e_4.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1_global_free__delete.html">winstd::GlobalFree_delete</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deleter for unique_ptr using GlobalFree. <a href="structwinstd_1_1_global_free__delete.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1globalmem__accessor.html">winstd::globalmem_accessor&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Context scope automatic GlobalAlloc (un)access. <a href="classwinstd_1_1globalmem__accessor.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="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga2cbff438813b72648c18c8af875f47c9" id="r_ga2cbff438813b72648c18c8af875f47c9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2cbff438813b72648c18c8af875f47c9">__L</a>(x)</td></tr>
<tr class="memdesc:ga2cbff438813b72648c18c8af875f47c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">"L" stringizing macro <br /></td></tr>
<tr class="separator:ga2cbff438813b72648c18c8af875f47c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8b08a24569840250e78cb8d510f1324a" id="r_ga8b08a24569840250e78cb8d510f1324a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8b08a24569840250e78cb8d510f1324a">_L</a>(x)</td></tr>
<tr class="memdesc:ga8b08a24569840250e78cb8d510f1324a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Makes string Unicode. <br /></td></tr>
<tr class="separator:ga8b08a24569840250e78cb8d510f1324a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4a46b36a9276ea0451d0790e51c7621f" id="r_ga4a46b36a9276ea0451d0790e51c7621f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4a46b36a9276ea0451d0790e51c7621f">WINSTD_STRING_IMPL</a>(x)</td></tr>
<tr class="memdesc:ga4a46b36a9276ea0451d0790e51c7621f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stringizing macro helper. <br /></td></tr>
<tr class="separator:ga4a46b36a9276ea0451d0790e51c7621f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac2a4fa0600886ba34fd4f7d2116d35da" id="r_gac2a4fa0600886ba34fd4f7d2116d35da"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gac2a4fa0600886ba34fd4f7d2116d35da">WINSTD_STRING</a>(x)</td></tr>
<tr class="memdesc:gac2a4fa0600886ba34fd4f7d2116d35da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stringizing macro. <br /></td></tr>
<tr class="separator:gac2a4fa0600886ba34fd4f7d2116d35da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga11254c72ad33a6e0f5de31db708f784c" id="r_ga11254c72ad33a6e0f5de31db708f784c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga11254c72ad33a6e0f5de31db708f784c">WINSTD_NONCOPYABLE</a>(C)</td></tr>
<tr class="memdesc:ga11254c72ad33a6e0f5de31db708f784c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Declares a class as non-copyable. <br /></td></tr>
<tr class="separator:ga11254c72ad33a6e0f5de31db708f784c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac91fa8d79c860b1fdbba65b6a322f760" id="r_gac91fa8d79c860b1fdbba65b6a322f760"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gac91fa8d79c860b1fdbba65b6a322f760">WINSTD_NONMOVABLE</a>(C)</td></tr>
<tr class="memdesc:gac91fa8d79c860b1fdbba65b6a322f760"><td class="mdescLeft">&#160;</td><td class="mdescRight">Declares a class as non-movable. <br /></td></tr>
<tr class="separator:gac91fa8d79c860b1fdbba65b6a322f760"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3ca39107a61bbcd05f901898ec584986" id="r_ga3ca39107a61bbcd05f901898ec584986"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3ca39107a61bbcd05f901898ec584986">WINSTD_STACK_BUFFER_BYTES</a>&#160;&#160;&#160;1024</td></tr>
<tr class="memdesc:ga3ca39107a61bbcd05f901898ec584986"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of the stack buffer in bytes used for initial system function call. <br /></td></tr>
<tr class="separator:ga3ca39107a61bbcd05f901898ec584986"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga8081292a94f5d070e644bdc90662d1fc" id="r_ga8081292a94f5d070e644bdc90662d1fc"><td class="memItemLeft" align="right" valign="top"><a id="ga8081292a94f5d070e644bdc90662d1fc" name="ga8081292a94f5d070e644bdc90662d1fc"></a>
typedef std::string&#160;</td><td class="memItemRight" valign="bottom"><b>winstd::tstring</b></td></tr>
<tr class="memdesc:ga8081292a94f5d070e644bdc90662d1fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multi-byte / Wide-character string (according to _UNICODE) <br /></td></tr>
<tr class="separator:ga8081292a94f5d070e644bdc90662d1fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga2cbff438813b72648c18c8af875f47c9" name="ga2cbff438813b72648c18c8af875f47c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2cbff438813b72648c18c8af875f47c9">&#9670;&#160;</a></span>__L</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define __L</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>x</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">L ## x</div>
</div><!-- fragment -->
<p>"L" stringizing macro </p>
</div>
</div>
<a id="ga8b08a24569840250e78cb8d510f1324a" name="ga8b08a24569840250e78cb8d510f1324a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8b08a24569840250e78cb8d510f1324a">&#9670;&#160;</a></span>_L</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define _L</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>x</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_define" href="#ga2cbff438813b72648c18c8af875f47c9">__L</a>(x)</div>
<div class="ttc" id="agroup___win_std_general_html_ga2cbff438813b72648c18c8af875f47c9"><div class="ttname"><a href="#ga2cbff438813b72648c18c8af875f47c9">__L</a></div><div class="ttdeci">#define __L(x)</div><div class="ttdoc">&quot;L&quot; stringizing macro</div><div class="ttdef"><b>Definition</b> Common.h:44</div></div>
</div><!-- fragment -->
<p>Makes string Unicode. </p>
</div>
</div>
<a id="ga11254c72ad33a6e0f5de31db708f784c" name="ga11254c72ad33a6e0f5de31db708f784c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga11254c72ad33a6e0f5de31db708f784c">&#9670;&#160;</a></span>WINSTD_NONCOPYABLE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WINSTD_NONCOPYABLE</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>C</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">private</span>: \</div>
<div class="line"> C (_In_ <span class="keyword">const</span> C &amp;h) <span class="keyword">noexcept</span>; \</div>
<div class="line"> C&amp; operator=(_In_ <span class="keyword">const</span> C &amp;h) <span class="keyword">noexcept</span>;</div>
</div><!-- fragment -->
<p>Declares a class as non-copyable. </p>
</div>
</div>
<a id="gac91fa8d79c860b1fdbba65b6a322f760" name="gac91fa8d79c860b1fdbba65b6a322f760"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac91fa8d79c860b1fdbba65b6a322f760">&#9670;&#160;</a></span>WINSTD_NONMOVABLE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WINSTD_NONMOVABLE</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>C</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">private</span>: \</div>
<div class="line"> C (_Inout_ C &amp;&amp;h) <span class="keyword">noexcept</span>; \</div>
<div class="line"> C&amp; operator=(_Inout_ C &amp;&amp;h) <span class="keyword">noexcept</span>;</div>
</div><!-- fragment -->
<p>Declares a class as non-movable. </p>
</div>
</div>
<a id="ga3ca39107a61bbcd05f901898ec584986" name="ga3ca39107a61bbcd05f901898ec584986"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3ca39107a61bbcd05f901898ec584986">&#9670;&#160;</a></span>WINSTD_STACK_BUFFER_BYTES</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WINSTD_STACK_BUFFER_BYTES&#160;&#160;&#160;1024</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of the stack buffer in bytes used for initial system function call. </p>
<p>Some system functions with variable length output data fail for insufficient buffer sizes, and return an exact buffer length required. The function helpers use a fixed size stack buffer first. If the stack buffer really prooved sufficient, the helper allocates the exact length output on heap and copies the data without calling the system function again. Otherwise it allocates the exact length output on heap and retries.</p>
<dl class="section note"><dt>Note</dt><dd>Decrease this value in case of stack overflow. </dd></dl>
</div>
</div>
<a id="gac2a4fa0600886ba34fd4f7d2116d35da" name="gac2a4fa0600886ba34fd4f7d2116d35da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac2a4fa0600886ba34fd4f7d2116d35da">&#9670;&#160;</a></span>WINSTD_STRING</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WINSTD_STRING</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>x</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_define" href="#ga4a46b36a9276ea0451d0790e51c7621f">WINSTD_STRING_IMPL</a>(x)</div>
<div class="ttc" id="agroup___win_std_general_html_ga4a46b36a9276ea0451d0790e51c7621f"><div class="ttname"><a href="#ga4a46b36a9276ea0451d0790e51c7621f">WINSTD_STRING_IMPL</a></div><div class="ttdeci">#define WINSTD_STRING_IMPL(x)</div><div class="ttdoc">Stringizing macro helper.</div><div class="ttdef"><b>Definition</b> Common.h:57</div></div>
</div><!-- fragment -->
<p>Stringizing macro. </p>
</div>
</div>
<a id="ga4a46b36a9276ea0451d0790e51c7621f" name="ga4a46b36a9276ea0451d0790e51c7621f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4a46b36a9276ea0451d0790e51c7621f">&#9670;&#160;</a></span>WINSTD_STRING_IMPL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WINSTD_STRING_IMPL</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>x</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="preprocessor">#x</span></div>
</div><!-- fragment -->
<p>Stringizing macro helper. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Nov 11 2024 12:59:48 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.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink