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

262 lines
40 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">
<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: include/WinStd/WinSock2.h Source File</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"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_6f50bb204833d887b928571856c82fbe.html">WinStd</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">WinSock2.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> SPDX-License-Identifier: MIT</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> Copyright © 1991-2022 Amebis</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright © 2016 GÉANT</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">*/</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;Common.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;WinSock2.h&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &lt;ws2def.h&gt;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include &lt;WS2tcpip.h&gt;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">namespace </span>winstd</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>{</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="classwinstd_1_1ws2__runtime__error.html"> 25</a></span> <span class="keyword">class </span><a class="code hl_class" href="classwinstd_1_1ws2__runtime__error.html">ws2_runtime_error</a> : <span class="keyword">public</span> <a class="code hl_class" href="classwinstd_1_1num__runtime__error.html">num_runtime_error</a>&lt;int&gt;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> {</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="classwinstd_1_1ws2__runtime__error.html#aa6ed38106310751800eca077c2fcb71a"> 34</a></span> <a class="code hl_function" href="classwinstd_1_1ws2__runtime__error.html#aa6ed38106310751800eca077c2fcb71a">ws2_runtime_error</a>(_In_ <a class="code hl_typedef" href="classwinstd_1_1num__runtime__error.html#a6fa2de87d0151b3ad9cac58f838852e0">error_type</a> num, _In_ <span class="keyword">const</span> std::string&amp; <a class="code hl_function" href="classwinstd_1_1ws2__runtime__error.html#af6984de4ac18e732a6844f379d67c52f">msg</a>) : <a class="code hl_class" href="classwinstd_1_1num__runtime__error.html">num_runtime_error</a>&lt;int&gt;(num, <a class="code hl_function" href="classwinstd_1_1ws2__runtime__error.html#af6984de4ac18e732a6844f379d67c52f">msg</a>)</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> }</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classwinstd_1_1ws2__runtime__error.html#a0f57437dbc7c87ac05230a5a5458846b"> 44</a></span> <a class="code hl_function" href="classwinstd_1_1ws2__runtime__error.html#a0f57437dbc7c87ac05230a5a5458846b">ws2_runtime_error</a>(_In_ <a class="code hl_typedef" href="classwinstd_1_1num__runtime__error.html#a6fa2de87d0151b3ad9cac58f838852e0">error_type</a> num, _In_opt_z_ <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_function" href="classwinstd_1_1ws2__runtime__error.html#af6984de4ac18e732a6844f379d67c52f">msg</a> = <span class="keyword">nullptr</span>) : <a class="code hl_class" href="classwinstd_1_1num__runtime__error.html">num_runtime_error</a>&lt;int&gt;(num, <a class="code hl_function" href="classwinstd_1_1ws2__runtime__error.html#af6984de4ac18e732a6844f379d67c52f">msg</a>)</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> {</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> }</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="classwinstd_1_1ws2__runtime__error.html#ae7914ed1c76d543399992573bc580b4e"> 53</a></span> <a class="code hl_function" href="classwinstd_1_1ws2__runtime__error.html#ae7914ed1c76d543399992573bc580b4e">ws2_runtime_error</a>(_In_ <span class="keyword">const</span> std::string&amp; <a class="code hl_function" href="classwinstd_1_1ws2__runtime__error.html#af6984de4ac18e732a6844f379d67c52f">msg</a>) : <a class="code hl_class" href="classwinstd_1_1num__runtime__error.html">num_runtime_error</a>&lt;int&gt;(WSAGetLastError(), <a class="code hl_function" href="classwinstd_1_1ws2__runtime__error.html#af6984de4ac18e732a6844f379d67c52f">msg</a>)</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> {</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> }</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="classwinstd_1_1ws2__runtime__error.html#a2e54221cc0f78724af416f9af1415267"> 62</a></span> <a class="code hl_function" href="classwinstd_1_1ws2__runtime__error.html#a2e54221cc0f78724af416f9af1415267">ws2_runtime_error</a>(_In_opt_z_ <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_function" href="classwinstd_1_1ws2__runtime__error.html#af6984de4ac18e732a6844f379d67c52f">msg</a> = <span class="keyword">nullptr</span>) : <a class="code hl_class" href="classwinstd_1_1num__runtime__error.html">num_runtime_error</a>&lt;int&gt;(WSAGetLastError(), <a class="code hl_function" href="classwinstd_1_1ws2__runtime__error.html#af6984de4ac18e732a6844f379d67c52f">msg</a>)</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> {</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> }</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="classwinstd_1_1ws2__runtime__error.html#af6984de4ac18e732a6844f379d67c52f"> 71</a></span> <a class="code hl_typedef" href="group___win_std_general.html#ga8081292a94f5d070e644bdc90662d1fc">tstring</a> <a class="code hl_function" href="classwinstd_1_1ws2__runtime__error.html#af6984de4ac18e732a6844f379d67c52f">msg</a>(_In_opt_ DWORD dwLanguageId = 0)<span class="keyword"> const</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <a class="code hl_typedef" href="group___win_std_general.html#ga8081292a94f5d070e644bdc90662d1fc">tstring</a> str;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keywordflow">if</span> (FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, 0, <a class="code hl_variable" href="classwinstd_1_1num__runtime__error.html#a865b8400a5a5a962c3068bf55f022d1f">m_num</a>, dwLanguageId, str, NULL)) {</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// Stock Windows error messages contain CRLF. Well... Trim all the trailing white space.</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> str.erase(str.find_last_not_of(_T(<span class="stringliteral">&quot; \t\n\r\f\v&quot;</span>)) + 1);</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> } <span class="keywordflow">else</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> sprintf(str, <a class="code hl_variable" href="classwinstd_1_1num__runtime__error.html#a865b8400a5a5a962c3068bf55f022d1f">m_num</a> &gt;= 0x10000 ? _T(<span class="stringliteral">&quot;Error 0x%X&quot;</span>) : _T(<span class="stringliteral">&quot;Error %u&quot;</span>), <a class="code hl_variable" href="classwinstd_1_1num__runtime__error.html#a865b8400a5a5a962c3068bf55f022d1f">m_num</a>);</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keywordflow">return</span> str;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> }</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> };</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="preprocessor">#if (NTDDI_VERSION &gt;= NTDDI_WINXPSP2) || (_WIN32_WINNT &gt;= 0x0502)</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="classwinstd_1_1addrinfo.html"> 93</a></span> <span class="keyword">class </span><a class="code hl_class" href="classwinstd_1_1addrinfo.html">addrinfo</a> : <span class="keyword">public</span> <a class="code hl_class" href="classwinstd_1_1handle.html">handle</a>&lt;PADDRINFOA, NULL&gt;</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> {</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <a class="code hl_define" href="group___win_std_sys_handles.html#ga419efffd12b5c96abc8a275ba375ca60">WINSTD_HANDLE_IMPL</a>(<a class="code hl_class" href="classwinstd_1_1addrinfo.html">addrinfo</a>, NULL)</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="classwinstd_1_1addrinfo.html#ad506b71b76ee837dc727883acfe08ea0"> 103</a></span> <a class="code hl_function" href="classwinstd_1_1addrinfo.html#ad506b71b76ee837dc727883acfe08ea0">__declspec</a>(deprecated(<span class="stringliteral">&quot;Use GetAddrInfoA&quot;</span>))</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> bool get(</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> _In_opt_ PCSTR pNodeName,</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> _In_opt_ PCSTR pServiceName,</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> _In_opt_ const ADDRINFOA *pHints)</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> {</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <a class="code hl_typedef" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h;</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> <span class="keywordflow">if</span> (GetAddrInfoA(pNodeName, pServiceName, pHints, &amp;h) == 0) {</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> <a class="code hl_function" href="classwinstd_1_1handle.html#ab2a98042c3b88fda687e34d370756f11">attach</a>(h);</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> } <span class="keywordflow">else</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> }</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"><a class="line" href="classwinstd_1_1addrinfo.html#aaa7a9365cde194bb9f54a96ea04f9883"> 122</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classwinstd_1_1addrinfo.html#aaa7a9365cde194bb9f54a96ea04f9883">~addrinfo</a>()</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> {</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="classwinstd_1_1handle.html#aabde3f16fd98b06b3b0282ef7806eb59">m_h</a> != <a class="code hl_variable" href="group___win_std_sys_handles.html#gacf43e306968474166474090690857e1c">invalid</a>)</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> <a class="code hl_function" href="classwinstd_1_1addrinfo.html#a279ad84ce2877b22797eedbec80cd55f">free_internal</a>();</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> }</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"><a class="line" href="classwinstd_1_1addrinfo.html#a279ad84ce2877b22797eedbec80cd55f"> 134</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classwinstd_1_1addrinfo.html#a279ad84ce2877b22797eedbec80cd55f">free_internal</a>() noexcept<span class="keyword"> override</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> FreeAddrInfoA(<a class="code hl_variable" href="classwinstd_1_1handle.html#aabde3f16fd98b06b3b0282ef7806eb59">m_h</a>);</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> }</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> };</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"><a class="line" href="classwinstd_1_1waddrinfo.html"> 143</a></span> <span class="keyword">class </span><a class="code hl_class" href="classwinstd_1_1waddrinfo.html">waddrinfo</a> : <span class="keyword">public</span> <a class="code hl_class" href="classwinstd_1_1handle.html">handle</a>&lt;PADDRINFOW, NULL&gt;</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> {</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> <a class="code hl_define" href="group___win_std_sys_handles.html#ga419efffd12b5c96abc8a275ba375ca60">WINSTD_HANDLE_IMPL</a>(<a class="code hl_class" href="classwinstd_1_1waddrinfo.html">waddrinfo</a>, NULL)</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"><a class="line" href="classwinstd_1_1waddrinfo.html#a76c68fdab030ad17fa59b8879657a12e"> 153</a></span> <a class="code hl_function" href="classwinstd_1_1waddrinfo.html#a76c68fdab030ad17fa59b8879657a12e">__declspec</a>(deprecated(<span class="stringliteral">&quot;Use GetAddrInfoW&quot;</span>))</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> bool get(</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> _In_opt_ PCWSTR pNodeName,</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> _In_opt_ PCWSTR pServiceName,</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> _In_opt_ const ADDRINFOW *pHints)</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> {</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> <a class="code hl_typedef" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h;</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> <span class="keywordflow">if</span> (GetAddrInfoW(pNodeName, pServiceName, pHints, &amp;h) == 0) {</div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> <a class="code hl_function" href="classwinstd_1_1handle.html#ab2a98042c3b88fda687e34d370756f11">attach</a>(h);</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> } <span class="keywordflow">else</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> }</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> </div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"><a class="line" href="classwinstd_1_1waddrinfo.html#a2b1209904bd7486acefd833ff5c4bcca"> 172</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classwinstd_1_1waddrinfo.html#a2b1209904bd7486acefd833ff5c4bcca">~waddrinfo</a>()</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span> {</div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="classwinstd_1_1handle.html#aabde3f16fd98b06b3b0282ef7806eb59">m_h</a> != <a class="code hl_variable" href="group___win_std_sys_handles.html#gacf43e306968474166474090690857e1c">invalid</a>)</div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> <a class="code hl_function" href="classwinstd_1_1waddrinfo.html#a479f7602b60a4c4205a9327f91e25f66">free_internal</a>();</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> }</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> </div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"><a class="line" href="classwinstd_1_1waddrinfo.html#a479f7602b60a4c4205a9327f91e25f66"> 184</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classwinstd_1_1waddrinfo.html#a479f7602b60a4c4205a9327f91e25f66">free_internal</a>() noexcept<span class="keyword"> override</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span> FreeAddrInfoW(<a class="code hl_variable" href="classwinstd_1_1handle.html#aabde3f16fd98b06b3b0282ef7806eb59">m_h</a>);</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> }</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> };</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> </div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span><span class="preprocessor">#ifdef _UNICODE</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> <span class="keyword">typedef</span> waddrinfo <a class="code hl_typedef" href="group___win_sock2_a_p_i.html#ga73a783d5ebf3d1af2a565cb78062b5b6">taddrinfo</a>;</div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"><a class="line" href="group___win_sock2_a_p_i.html#ga73a783d5ebf3d1af2a565cb78062b5b6"> 196</a></span> <span class="keyword">typedef</span> <a class="code hl_class" href="classwinstd_1_1addrinfo.html">addrinfo</a> <a class="code hl_typedef" href="group___win_sock2_a_p_i.html#ga73a783d5ebf3d1af2a565cb78062b5b6">taddrinfo</a>;</div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</span> </div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span> </div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span>}</div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span> </div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span> </div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span><span class="preprocessor">#pragma warning(push)</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span><span class="preprocessor">#pragma warning(disable: 4505) </span><span class="comment">// Don&#39;t warn on unused code</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span> </div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span><span class="keyword">static</span> INT GetAddrInfoA(</div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> _In_opt_ PCSTR pNodeName,</div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span> _In_opt_ PCSTR pServiceName,</div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> _In_opt_ <span class="keyword">const</span> ADDRINFOA *pHints,</div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> _Inout_ <a class="code hl_class" href="classwinstd_1_1addrinfo.html">winstd::addrinfo</a> &amp;result)</div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span>{</div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</span> PADDRINFOA h;</div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span> INT iResult = GetAddrInfoA(pNodeName, pServiceName, pHints, &amp;h);</div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span> <span class="keywordflow">if</span> (iResult == 0)</div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> result.attach(h);</div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> <span class="keywordflow">return</span> iResult;</div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span>}</div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> </div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span><span class="keyword">static</span> INT GetAddrInfoW(</div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> _In_opt_ PCWSTR pNodeName,</div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> _In_opt_ PCWSTR pServiceName,</div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span> _In_opt_ <span class="keyword">const</span> ADDRINFOW *pHints,</div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> _Inout_ <a class="code hl_class" href="classwinstd_1_1waddrinfo.html">winstd::waddrinfo</a> &amp;result)</div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"> 234</span>{</div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno"> 235</span> PADDRINFOW h;</div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno"> 236</span> INT iResult = GetAddrInfoW(pNodeName, pServiceName, pHints, &amp;h);</div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span> <span class="keywordflow">if</span> (iResult == 0)</div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span> result.attach(h);</div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno"> 239</span> <span class="keywordflow">return</span> iResult;</div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno"> 240</span>}</div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno"> 241</span> </div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno"> 242</span><span class="preprocessor">#pragma warning(pop)</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno"> 243</span> </div>
<div class="ttc" id="aclasswinstd_1_1addrinfo_html"><div class="ttname"><a href="classwinstd_1_1addrinfo.html">winstd::addrinfo</a></div><div class="ttdoc">SID wrapper class.</div><div class="ttdef"><b>Definition:</b> WinSock2.h:94</div></div>
<div class="ttc" id="aclasswinstd_1_1addrinfo_html_a279ad84ce2877b22797eedbec80cd55f"><div class="ttname"><a href="classwinstd_1_1addrinfo.html#a279ad84ce2877b22797eedbec80cd55f">winstd::addrinfo::free_internal</a></div><div class="ttdeci">void free_internal() noexcept override</div><div class="ttdoc">Frees address information.</div><div class="ttdef"><b>Definition:</b> WinSock2.h:134</div></div>
<div class="ttc" id="aclasswinstd_1_1addrinfo_html_aaa7a9365cde194bb9f54a96ea04f9883"><div class="ttname"><a href="classwinstd_1_1addrinfo.html#aaa7a9365cde194bb9f54a96ea04f9883">winstd::addrinfo::~addrinfo</a></div><div class="ttdeci">virtual ~addrinfo()</div><div class="ttdoc">Frees address information.</div><div class="ttdef"><b>Definition:</b> WinSock2.h:122</div></div>
<div class="ttc" id="aclasswinstd_1_1addrinfo_html_ad506b71b76ee837dc727883acfe08ea0"><div class="ttname"><a href="classwinstd_1_1addrinfo.html#ad506b71b76ee837dc727883acfe08ea0">winstd::addrinfo::__declspec</a></div><div class="ttdeci">__declspec(deprecated(&quot;Use GetAddrInfoA&quot;)) bool get(PCSTR pNodeName</div><div class="ttdoc">Provides protocol-independent translation from a host name to an address.</div></div>
<div class="ttc" id="aclasswinstd_1_1handle_html"><div class="ttname"><a href="classwinstd_1_1handle.html">winstd::handle</a></div><div class="ttdoc">Base abstract template class to support generic object handle keeping.</div><div class="ttdef"><b>Definition:</b> Common.h:603</div></div>
<div class="ttc" id="aclasswinstd_1_1handle_html_a3dda19199ecfbc378c932e7d84d0ea81"><div class="ttname"><a href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">winstd::handle&lt; PADDRINFOA, NULL &gt;::handle_type</a></div><div class="ttdeci">PADDRINFOA handle_type</div><div class="ttdoc">Datatype of the object handle this template class handles.</div><div class="ttdef"><b>Definition:</b> Common.h:608</div></div>
<div class="ttc" id="aclasswinstd_1_1handle_html_aabde3f16fd98b06b3b0282ef7806eb59"><div class="ttname"><a href="classwinstd_1_1handle.html#aabde3f16fd98b06b3b0282ef7806eb59">winstd::handle&lt; PADDRINFOA, NULL &gt;::m_h</a></div><div class="ttdeci">handle_type m_h</div><div class="ttdoc">Object handle.</div><div class="ttdef"><b>Definition:</b> Common.h:854</div></div>
<div class="ttc" id="aclasswinstd_1_1handle_html_ab2a98042c3b88fda687e34d370756f11"><div class="ttname"><a href="classwinstd_1_1handle.html#ab2a98042c3b88fda687e34d370756f11">winstd::handle&lt; PADDRINFOA, NULL &gt;::attach</a></div><div class="ttdeci">void attach(handle_type h) noexcept</div><div class="ttdoc">Sets a new object handle for the class.</div><div class="ttdef"><b>Definition:</b> Common.h:817</div></div>
<div class="ttc" id="aclasswinstd_1_1num__runtime__error_html"><div class="ttname"><a href="classwinstd_1_1num__runtime__error.html">winstd::num_runtime_error</a></div><div class="ttdoc">Numerical runtime error.</div><div class="ttdef"><b>Definition:</b> Common.h:1002</div></div>
<div class="ttc" id="aclasswinstd_1_1num__runtime__error_html_a6fa2de87d0151b3ad9cac58f838852e0"><div class="ttname"><a href="classwinstd_1_1num__runtime__error.html#a6fa2de87d0151b3ad9cac58f838852e0">winstd::num_runtime_error&lt; int &gt;::error_type</a></div><div class="ttdeci">int error_type</div><div class="ttdoc">Error number type.</div><div class="ttdef"><b>Definition:</b> Common.h:1004</div></div>
<div class="ttc" id="aclasswinstd_1_1num__runtime__error_html_a865b8400a5a5a962c3068bf55f022d1f"><div class="ttname"><a href="classwinstd_1_1num__runtime__error.html#a865b8400a5a5a962c3068bf55f022d1f">winstd::num_runtime_error&lt; int &gt;::m_num</a></div><div class="ttdeci">error_type m_num</div><div class="ttdoc">Numeric error code.</div><div class="ttdef"><b>Definition:</b> Common.h:1040</div></div>
<div class="ttc" id="aclasswinstd_1_1waddrinfo_html"><div class="ttname"><a href="classwinstd_1_1waddrinfo.html">winstd::waddrinfo</a></div><div class="ttdoc">SID wrapper class.</div><div class="ttdef"><b>Definition:</b> WinSock2.h:144</div></div>
<div class="ttc" id="aclasswinstd_1_1waddrinfo_html_a2b1209904bd7486acefd833ff5c4bcca"><div class="ttname"><a href="classwinstd_1_1waddrinfo.html#a2b1209904bd7486acefd833ff5c4bcca">winstd::waddrinfo::~waddrinfo</a></div><div class="ttdeci">virtual ~waddrinfo()</div><div class="ttdoc">Frees address information.</div><div class="ttdef"><b>Definition:</b> WinSock2.h:172</div></div>
<div class="ttc" id="aclasswinstd_1_1waddrinfo_html_a479f7602b60a4c4205a9327f91e25f66"><div class="ttname"><a href="classwinstd_1_1waddrinfo.html#a479f7602b60a4c4205a9327f91e25f66">winstd::waddrinfo::free_internal</a></div><div class="ttdeci">void free_internal() noexcept override</div><div class="ttdoc">Frees address information.</div><div class="ttdef"><b>Definition:</b> WinSock2.h:184</div></div>
<div class="ttc" id="aclasswinstd_1_1waddrinfo_html_a76c68fdab030ad17fa59b8879657a12e"><div class="ttname"><a href="classwinstd_1_1waddrinfo.html#a76c68fdab030ad17fa59b8879657a12e">winstd::waddrinfo::__declspec</a></div><div class="ttdeci">__declspec(deprecated(&quot;Use GetAddrInfoW&quot;)) bool get(PCWSTR pNodeName</div><div class="ttdoc">Provides protocol-independent translation from a host name to an address.</div></div>
<div class="ttc" id="aclasswinstd_1_1ws2__runtime__error_html"><div class="ttname"><a href="classwinstd_1_1ws2__runtime__error.html">winstd::ws2_runtime_error</a></div><div class="ttdoc">WinSock2 runtime error.</div><div class="ttdef"><b>Definition:</b> WinSock2.h:26</div></div>
<div class="ttc" id="aclasswinstd_1_1ws2__runtime__error_html_a0f57437dbc7c87ac05230a5a5458846b"><div class="ttname"><a href="classwinstd_1_1ws2__runtime__error.html#a0f57437dbc7c87ac05230a5a5458846b">winstd::ws2_runtime_error::ws2_runtime_error</a></div><div class="ttdeci">ws2_runtime_error(error_type num, const char *msg=nullptr)</div><div class="ttdoc">Constructs an exception.</div><div class="ttdef"><b>Definition:</b> WinSock2.h:44</div></div>
<div class="ttc" id="aclasswinstd_1_1ws2__runtime__error_html_a2e54221cc0f78724af416f9af1415267"><div class="ttname"><a href="classwinstd_1_1ws2__runtime__error.html#a2e54221cc0f78724af416f9af1415267">winstd::ws2_runtime_error::ws2_runtime_error</a></div><div class="ttdeci">ws2_runtime_error(const char *msg=nullptr)</div><div class="ttdoc">Constructs an exception using WSAGetLastError()</div><div class="ttdef"><b>Definition:</b> WinSock2.h:62</div></div>
<div class="ttc" id="aclasswinstd_1_1ws2__runtime__error_html_aa6ed38106310751800eca077c2fcb71a"><div class="ttname"><a href="classwinstd_1_1ws2__runtime__error.html#aa6ed38106310751800eca077c2fcb71a">winstd::ws2_runtime_error::ws2_runtime_error</a></div><div class="ttdeci">ws2_runtime_error(error_type num, const std::string &amp;msg)</div><div class="ttdoc">Constructs an exception.</div><div class="ttdef"><b>Definition:</b> WinSock2.h:34</div></div>
<div class="ttc" id="aclasswinstd_1_1ws2__runtime__error_html_ae7914ed1c76d543399992573bc580b4e"><div class="ttname"><a href="classwinstd_1_1ws2__runtime__error.html#ae7914ed1c76d543399992573bc580b4e">winstd::ws2_runtime_error::ws2_runtime_error</a></div><div class="ttdeci">ws2_runtime_error(const std::string &amp;msg)</div><div class="ttdoc">Constructs an exception using WSAGetLastError()</div><div class="ttdef"><b>Definition:</b> WinSock2.h:53</div></div>
<div class="ttc" id="aclasswinstd_1_1ws2__runtime__error_html_af6984de4ac18e732a6844f379d67c52f"><div class="ttname"><a href="classwinstd_1_1ws2__runtime__error.html#af6984de4ac18e732a6844f379d67c52f">winstd::ws2_runtime_error::msg</a></div><div class="ttdeci">tstring msg(DWORD dwLanguageId=0) const</div><div class="ttdoc">Returns a user-readable Windows error message.</div><div class="ttdef"><b>Definition:</b> WinSock2.h:71</div></div>
<div class="ttc" id="agroup___win_sock2_a_p_i_html_ga73a783d5ebf3d1af2a565cb78062b5b6"><div class="ttname"><a href="group___win_sock2_a_p_i.html#ga73a783d5ebf3d1af2a565cb78062b5b6">winstd::taddrinfo</a></div><div class="ttdeci">addrinfo taddrinfo</div><div class="ttdoc">Multi-byte / Wide-character SID wrapper class (according to _UNICODE)</div><div class="ttdef"><b>Definition:</b> WinSock2.h:196</div></div>
<div class="ttc" id="agroup___win_std_general_html_ga8081292a94f5d070e644bdc90662d1fc"><div class="ttname"><a href="group___win_std_general.html#ga8081292a94f5d070e644bdc90662d1fc">winstd::tstring</a></div><div class="ttdeci">std::string tstring</div><div class="ttdoc">Multi-byte / Wide-character string (according to _UNICODE)</div><div class="ttdef"><b>Definition:</b> Common.h:334</div></div>
<div class="ttc" id="agroup___win_std_sys_handles_html_ga419efffd12b5c96abc8a275ba375ca60"><div class="ttname"><a href="group___win_std_sys_handles.html#ga419efffd12b5c96abc8a275ba375ca60">WINSTD_HANDLE_IMPL</a></div><div class="ttdeci">#define WINSTD_HANDLE_IMPL(C, INVAL)</div><div class="ttdoc">Implements default constructors and operators to prevent their auto-generation by compiler.</div><div class="ttdef"><b>Definition:</b> Common.h:161</div></div>
<div class="ttc" id="agroup___win_std_sys_handles_html_gacf43e306968474166474090690857e1c"><div class="ttname"><a href="group___win_std_sys_handles.html#gacf43e306968474166474090690857e1c">winstd::handle&lt; PADDRINFOA, NULL &gt;::invalid</a></div><div class="ttdeci">static const PADDRINFOA invalid</div><div class="ttdoc">Invalid handle value.</div><div class="ttdef"><b>Definition:</b> Common.h:613</div></div>
</div><!-- fragment --></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>
Reference in New Issue View Git Blame Copy Permalink