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

237 lines
37 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">
<a href="_win_sock2_8h.html">Go to the documentation of this file.</a><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="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include &quot;<a class="code" href="_common_8h.html">Common.h</a>&quot;</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include &lt;<a class="code" href="_win_sock2_8h.html">WinSock2.h</a>&gt;</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include &lt;ws2def.h&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include &lt;WS2tcpip.h&gt;</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="keyword">namespace </span>winstd</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>{</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="classwinstd_1_1ws2__runtime__error.html"> 28</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="l00029" name="l00029"></a><span class="lineno"> 29</span> {</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="classwinstd_1_1ws2__runtime__error.html#aa6ed38106310751800eca077c2fcb71a"> 37</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="l00038" name="l00038"></a><span class="lineno"> 38</span> {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> }</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="classwinstd_1_1ws2__runtime__error.html#a0f57437dbc7c87ac05230a5a5458846b"> 47</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="l00048" name="l00048"></a><span class="lineno"> 48</span> {</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> }</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="classwinstd_1_1ws2__runtime__error.html#ae7914ed1c76d543399992573bc580b4e"> 56</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="l00057" name="l00057"></a><span class="lineno"> 57</span> {</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> }</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="classwinstd_1_1ws2__runtime__error.html#a2e54221cc0f78724af416f9af1415267"> 65</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="l00066" name="l00066"></a><span class="lineno"> 66</span> {</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> }</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="classwinstd_1_1ws2__runtime__error.html#af6984de4ac18e732a6844f379d67c52f"> 74</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="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <a class="code hl_typedef" href="group___win_std_general.html#ga8081292a94f5d070e644bdc90662d1fc">tstring</a> str;</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="group___win_std_str_format.html#ga78bf19793ce080f2826f56f228d64623">FormatMessage</a>(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="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="comment">// Stock Windows error messages contain CRLF. Well... Trim all the trailing white space.</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</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="l00080" name="l00080"></a><span class="lineno"> 80</span> } <span class="keywordflow">else</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <a class="code hl_function" href="group___win_std_str_format.html#gac397f655a858a069b3e521940af64331">sprintf</a>(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="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keywordflow">return</span> str;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> }</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> };</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="preprocessor">#if (NTDDI_VERSION &gt;= NTDDI_WINXPSP2) || (_WIN32_WINNT &gt;= 0x0502)</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="classwinstd_1_1addrinfo.html"> 98</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="l00099" name="l00099"></a><span class="lineno"> 99</span> {</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</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="l00101" name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="classwinstd_1_1addrinfo.html#aaa7a9365cde194bb9f54a96ea04f9883"> 108</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="l00109" name="l00109"></a><span class="lineno"> 109</span> {</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</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="l00111" name="l00111"></a><span class="lineno"> 111</span> <a class="code hl_function" href="classwinstd_1_1addrinfo.html#a279ad84ce2877b22797eedbec80cd55f">free_internal</a>();</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> }</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"><a class="line" href="classwinstd_1_1addrinfo.html#a279ad84ce2877b22797eedbec80cd55f"> 120</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="l00121" name="l00121"></a><span class="lineno"> 121</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> FreeAddrInfoA(<a class="code hl_variable" href="classwinstd_1_1handle.html#aabde3f16fd98b06b3b0282ef7806eb59">m_h</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> };</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"><a class="line" href="classwinstd_1_1waddrinfo.html"> 131</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="l00132" name="l00132"></a><span class="lineno"> 132</span> {</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</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="l00134" name="l00134"></a><span class="lineno"> 134</span> </div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"><a class="line" href="classwinstd_1_1waddrinfo.html#a2b1209904bd7486acefd833ff5c4bcca"> 141</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="l00142" name="l00142"></a><span class="lineno"> 142</span> {</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</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="l00144" name="l00144"></a><span class="lineno"> 144</span> <a class="code hl_function" href="classwinstd_1_1waddrinfo.html#a479f7602b60a4c4205a9327f91e25f66">free_internal</a>();</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> }</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">protected</span>:</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"><a class="line" href="classwinstd_1_1waddrinfo.html#a479f7602b60a4c4205a9327f91e25f66"> 153</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="l00154" name="l00154"></a><span class="lineno"> 154</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> FreeAddrInfoW(<a class="code hl_variable" href="classwinstd_1_1handle.html#aabde3f16fd98b06b3b0282ef7806eb59">m_h</a>);</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> }</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> };</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> </div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span><span class="preprocessor">#ifdef _UNICODE</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</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="l00164" name="l00164"></a><span class="lineno"> 164</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"><a class="line" href="group___win_sock2_a_p_i.html#ga73a783d5ebf3d1af2a565cb78062b5b6"> 165</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="l00166" name="l00166"></a><span class="lineno"> 166</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> </div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> </div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span>}</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span> </div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> </div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span><span class="preprocessor">#pragma warning(push)</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</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="l00178" name="l00178"></a><span class="lineno"> 178</span> </div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"><a class="line" href="group___win_sock2_a_p_i.html#gae9f6e09e2e81a57135dc30bc999d27af"> 180</a></span><span class="keyword">static</span> INT <a class="code hl_function" href="group___win_sock2_a_p_i.html#gae9f6e09e2e81a57135dc30bc999d27af">GetAddrInfoA</a>(</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> _In_opt_ PCSTR pNodeName,</div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span> _In_opt_ PCSTR pServiceName,</div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> _In_opt_ <span class="keyword">const</span> ADDRINFOA *pHints,</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> _Inout_ <a class="code hl_class" href="classwinstd_1_1addrinfo.html">winstd::addrinfo</a> &amp;result)</div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span>{</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span> PADDRINFOA h;</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> INT iResult = <a class="code hl_function" href="group___win_sock2_a_p_i.html#gae9f6e09e2e81a57135dc30bc999d27af">GetAddrInfoA</a>(pNodeName, pServiceName, pHints, &amp;h);</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> <span class="keywordflow">if</span> (iResult == 0)</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> result.attach(h);</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span> <span class="keywordflow">return</span> iResult;</div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span>}</div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> </div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"><a class="line" href="group___win_sock2_a_p_i.html#gad222deae09d76241e018a2e350aa1ec9"> 198</a></span><span class="keyword">static</span> INT <a class="code hl_function" href="group___win_sock2_a_p_i.html#gad222deae09d76241e018a2e350aa1ec9">GetAddrInfoW</a>(</div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> _In_opt_ PCWSTR pNodeName,</div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span> _In_opt_ PCWSTR pServiceName,</div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno"> 201</span> _In_opt_ <span class="keyword">const</span> ADDRINFOW *pHints,</div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span> _Inout_ <a class="code hl_class" href="classwinstd_1_1waddrinfo.html">winstd::waddrinfo</a> &amp;result)</div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span>{</div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span> PADDRINFOW h;</div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span> INT iResult = <a class="code hl_function" href="group___win_sock2_a_p_i.html#gad222deae09d76241e018a2e350aa1ec9">GetAddrInfoW</a>(pNodeName, pServiceName, pHints, &amp;h);</div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span> <span class="keywordflow">if</span> (iResult == 0)</div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span> result.attach(h);</div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span> <span class="keywordflow">return</span> iResult;</div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span>}</div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span> </div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span><span class="preprocessor">#pragma warning(pop)</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> </div>
<div class="ttc" id="a_common_8h_html"><div class="ttname"><a href="_common_8h.html">Common.h</a></div><div class="ttdoc">General API.</div></div>
<div class="ttc" id="a_win_sock2_8h_html"><div class="ttname"><a href="_win_sock2_8h.html">WinSock2.h</a></div><div class="ttdoc">Integrates WinStd classes with Microsoft WinSock2 API.</div></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:99</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:120</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:108</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:615</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:866</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:1011</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:1013</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:1049</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:132</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:141</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:153</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:29</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:47</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:65</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:37</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:56</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:74</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:165</div></div>
<div class="ttc" id="agroup___win_sock2_a_p_i_html_gad222deae09d76241e018a2e350aa1ec9"><div class="ttname"><a href="group___win_sock2_a_p_i.html#gad222deae09d76241e018a2e350aa1ec9">GetAddrInfoW</a></div><div class="ttdeci">static INT GetAddrInfoW(PCWSTR pNodeName, PCWSTR pServiceName, const ADDRINFOW *pHints, winstd::waddrinfo &amp;result)</div><div class="ttdoc">Provides protocol-independent translation from a host name to an address.</div><div class="ttdef"><b>Definition:</b> WinSock2.h:198</div></div>
<div class="ttc" id="agroup___win_sock2_a_p_i_html_gae9f6e09e2e81a57135dc30bc999d27af"><div class="ttname"><a href="group___win_sock2_a_p_i.html#gae9f6e09e2e81a57135dc30bc999d27af">GetAddrInfoA</a></div><div class="ttdeci">static INT GetAddrInfoA(PCSTR pNodeName, PCSTR pServiceName, const ADDRINFOA *pHints, winstd::addrinfo &amp;result)</div><div class="ttdoc">Provides protocol-independent translation from a host name to an address.</div><div class="ttdef"><b>Definition:</b> WinSock2.h:180</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:346</div></div>
<div class="ttc" id="agroup___win_std_str_format_html_ga78bf19793ce080f2826f56f228d64623"><div class="ttname"><a href="group___win_std_str_format.html#ga78bf19793ce080f2826f56f228d64623">FormatMessage</a></div><div class="ttdeci">static DWORD FormatMessage(DWORD dwFlags, LPCVOID lpSource, DWORD dwMessageId, DWORD dwLanguageId, std::basic_string&lt; char, _Traits, _Ax &gt; &amp;str, va_list *Arguments)</div><div class="ttdoc">Formats a message string.</div><div class="ttdef"><b>Definition:</b> Common.h:307</div></div>
<div class="ttc" id="agroup___win_std_str_format_html_gac397f655a858a069b3e521940af64331"><div class="ttname"><a href="group___win_std_str_format.html#gac397f655a858a069b3e521940af64331">sprintf</a></div><div class="ttdeci">static int sprintf(std::basic_string&lt; _Elem, _Traits, _Ax &gt; &amp;str, const _Elem *format,...)</div><div class="ttdoc">Formats string using printf().</div><div class="ttdef"><b>Definition:</b> Common.h:292</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:171</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:625</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Mar 7 2022 11:58:55 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