WinStd/classwinstd_1_1ws2__runtime__error.html

341 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" 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.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WinStd: winstd::ws2_runtime_error Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<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.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(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">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>winstd</b></li><li class="navelem"><a class="el" href="classwinstd_1_1ws2__runtime__error.html">ws2_runtime_error</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classwinstd_1_1ws2__runtime__error-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">winstd::ws2_runtime_error Class Reference<div class="ingroups"><a class="el" href="group___win_sock2_a_p_i.html">WinSock2 API</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>WinSock2 runtime error.
<a href="classwinstd_1_1ws2__runtime__error.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_win_sock2_8h_source.html">WinStd/WinSock2.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for winstd::ws2_runtime_error:</div>
<div class="dyncontent">
<div class="center">
<img src="classwinstd_1_1ws2__runtime__error.png" usemap="#winstd::ws2_5Fruntime_5Ferror_map" alt=""/>
<map id="winstd::ws2_5Fruntime_5Ferror_map" name="winstd::ws2_5Fruntime_5Ferror_map">
<area href="classwinstd_1_1num__runtime__error.html" alt="winstd::num_runtime_error&lt; int &gt;" shape="rect" coords="0,56,197,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa6ed38106310751800eca077c2fcb71a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1ws2__runtime__error.html#aa6ed38106310751800eca077c2fcb71a">ws2_runtime_error</a> (<a class="el" href="classwinstd_1_1num__runtime__error.html#a6fa2de87d0151b3ad9cac58f838852e0">error_type</a> num, const std::string &amp;<a class="el" href="classwinstd_1_1ws2__runtime__error.html#af6984de4ac18e732a6844f379d67c52f">msg</a>)</td></tr>
<tr class="memdesc:aa6ed38106310751800eca077c2fcb71a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an exception. <a href="classwinstd_1_1ws2__runtime__error.html#aa6ed38106310751800eca077c2fcb71a">More...</a><br /></td></tr>
<tr class="separator:aa6ed38106310751800eca077c2fcb71a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f57437dbc7c87ac05230a5a5458846b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1ws2__runtime__error.html#a0f57437dbc7c87ac05230a5a5458846b">ws2_runtime_error</a> (<a class="el" href="classwinstd_1_1num__runtime__error.html#a6fa2de87d0151b3ad9cac58f838852e0">error_type</a> num, const char *<a class="el" href="classwinstd_1_1ws2__runtime__error.html#af6984de4ac18e732a6844f379d67c52f">msg</a>=nullptr)</td></tr>
<tr class="memdesc:a0f57437dbc7c87ac05230a5a5458846b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an exception. <a href="classwinstd_1_1ws2__runtime__error.html#a0f57437dbc7c87ac05230a5a5458846b">More...</a><br /></td></tr>
<tr class="separator:a0f57437dbc7c87ac05230a5a5458846b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7914ed1c76d543399992573bc580b4e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1ws2__runtime__error.html#ae7914ed1c76d543399992573bc580b4e">ws2_runtime_error</a> (const std::string &amp;<a class="el" href="classwinstd_1_1ws2__runtime__error.html#af6984de4ac18e732a6844f379d67c52f">msg</a>)</td></tr>
<tr class="memdesc:ae7914ed1c76d543399992573bc580b4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an exception using <code>WSAGetLastError()</code> <a href="classwinstd_1_1ws2__runtime__error.html#ae7914ed1c76d543399992573bc580b4e">More...</a><br /></td></tr>
<tr class="separator:ae7914ed1c76d543399992573bc580b4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e54221cc0f78724af416f9af1415267"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1ws2__runtime__error.html#a2e54221cc0f78724af416f9af1415267">ws2_runtime_error</a> (const char *<a class="el" href="classwinstd_1_1ws2__runtime__error.html#af6984de4ac18e732a6844f379d67c52f">msg</a>=nullptr)</td></tr>
<tr class="memdesc:a2e54221cc0f78724af416f9af1415267"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an exception using <code>WSAGetLastError()</code> <a href="classwinstd_1_1ws2__runtime__error.html#a2e54221cc0f78724af416f9af1415267">More...</a><br /></td></tr>
<tr class="separator:a2e54221cc0f78724af416f9af1415267"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6984de4ac18e732a6844f379d67c52f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___win_std_general.html#ga8081292a94f5d070e644bdc90662d1fc">tstring</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1ws2__runtime__error.html#af6984de4ac18e732a6844f379d67c52f">msg</a> (DWORD dwLanguageId=0) const</td></tr>
<tr class="memdesc:af6984de4ac18e732a6844f379d67c52f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a user-readable Windows error message. <a href="classwinstd_1_1ws2__runtime__error.html#af6984de4ac18e732a6844f379d67c52f">More...</a><br /></td></tr>
<tr class="separator:af6984de4ac18e732a6844f379d67c52f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classwinstd_1_1num__runtime__error"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classwinstd_1_1num__runtime__error')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classwinstd_1_1num__runtime__error.html">winstd::num_runtime_error&lt; int &gt;</a></td></tr>
<tr class="memitem:a4cfc6c7f3b1d5fed5a3d9e0c5aac3d19 inherit pub_methods_classwinstd_1_1num__runtime__error"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1num__runtime__error.html#a4cfc6c7f3b1d5fed5a3d9e0c5aac3d19">num_runtime_error</a> (<a class="el" href="classwinstd_1_1num__runtime__error.html#a6fa2de87d0151b3ad9cac58f838852e0">error_type</a> num, const std::string &amp;msg)</td></tr>
<tr class="memdesc:a4cfc6c7f3b1d5fed5a3d9e0c5aac3d19 inherit pub_methods_classwinstd_1_1num__runtime__error"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an exception. <a href="classwinstd_1_1num__runtime__error.html#a4cfc6c7f3b1d5fed5a3d9e0c5aac3d19">More...</a><br /></td></tr>
<tr class="separator:a4cfc6c7f3b1d5fed5a3d9e0c5aac3d19 inherit pub_methods_classwinstd_1_1num__runtime__error"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c0d5efd086891093156fede0dd43cd0 inherit pub_methods_classwinstd_1_1num__runtime__error"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1num__runtime__error.html#a4c0d5efd086891093156fede0dd43cd0">num_runtime_error</a> (<a class="el" href="classwinstd_1_1num__runtime__error.html#a6fa2de87d0151b3ad9cac58f838852e0">error_type</a> num, const char *msg=nullptr)</td></tr>
<tr class="memdesc:a4c0d5efd086891093156fede0dd43cd0 inherit pub_methods_classwinstd_1_1num__runtime__error"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an exception. <a href="classwinstd_1_1num__runtime__error.html#a4c0d5efd086891093156fede0dd43cd0">More...</a><br /></td></tr>
<tr class="separator:a4c0d5efd086891093156fede0dd43cd0 inherit pub_methods_classwinstd_1_1num__runtime__error"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6388a483c00628c1a94a5ce45ca63e70 inherit pub_methods_classwinstd_1_1num__runtime__error"><td class="memItemLeft" align="right" valign="top"><a id="a6388a483c00628c1a94a5ce45ca63e70" name="a6388a483c00628c1a94a5ce45ca63e70"></a>
<a class="el" href="classwinstd_1_1num__runtime__error.html#a6fa2de87d0151b3ad9cac58f838852e0">error_type</a>&#160;</td><td class="memItemRight" valign="bottom"><b>number</b> () const</td></tr>
<tr class="memdesc:a6388a483c00628c1a94a5ce45ca63e70 inherit pub_methods_classwinstd_1_1num__runtime__error"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the Windows error number. <br /></td></tr>
<tr class="separator:a6388a483c00628c1a94a5ce45ca63e70 inherit pub_methods_classwinstd_1_1num__runtime__error"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classwinstd_1_1num__runtime__error"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classwinstd_1_1num__runtime__error')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classwinstd_1_1num__runtime__error.html">winstd::num_runtime_error&lt; int &gt;</a></td></tr>
<tr class="memitem:a6fa2de87d0151b3ad9cac58f838852e0 inherit pub_types_classwinstd_1_1num__runtime__error"><td class="memItemLeft" align="right" valign="top"><a id="a6fa2de87d0151b3ad9cac58f838852e0" name="a6fa2de87d0151b3ad9cac58f838852e0"></a>
typedef int&#160;</td><td class="memItemRight" valign="bottom"><b>error_type</b></td></tr>
<tr class="memdesc:a6fa2de87d0151b3ad9cac58f838852e0 inherit pub_types_classwinstd_1_1num__runtime__error"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error number type. <br /></td></tr>
<tr class="separator:a6fa2de87d0151b3ad9cac58f838852e0 inherit pub_types_classwinstd_1_1num__runtime__error"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classwinstd_1_1num__runtime__error"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classwinstd_1_1num__runtime__error')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classwinstd_1_1num__runtime__error.html">winstd::num_runtime_error&lt; int &gt;</a></td></tr>
<tr class="memitem:a865b8400a5a5a962c3068bf55f022d1f inherit pro_attribs_classwinstd_1_1num__runtime__error"><td class="memItemLeft" align="right" valign="top"><a id="a865b8400a5a5a962c3068bf55f022d1f" name="a865b8400a5a5a962c3068bf55f022d1f"></a>
<a class="el" href="classwinstd_1_1num__runtime__error.html#a6fa2de87d0151b3ad9cac58f838852e0">error_type</a>&#160;</td><td class="memItemRight" valign="bottom"><b>m_num</b></td></tr>
<tr class="memdesc:a865b8400a5a5a962c3068bf55f022d1f inherit pro_attribs_classwinstd_1_1num__runtime__error"><td class="mdescLeft">&#160;</td><td class="mdescRight">Numeric error code. <br /></td></tr>
<tr class="separator:a865b8400a5a5a962c3068bf55f022d1f inherit pro_attribs_classwinstd_1_1num__runtime__error"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >WinSock2 runtime error. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa6ed38106310751800eca077c2fcb71a" name="aa6ed38106310751800eca077c2fcb71a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6ed38106310751800eca077c2fcb71a">&#9670;&#160;</a></span>ws2_runtime_error() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">winstd::ws2_runtime_error::ws2_runtime_error </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwinstd_1_1num__runtime__error.html#a6fa2de87d0151b3ad9cac58f838852e0">error_type</a>&#160;</td>
<td class="paramname"><em>num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>msg</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an exception. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>WinSock2 error code </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Error message </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0f57437dbc7c87ac05230a5a5458846b" name="a0f57437dbc7c87ac05230a5a5458846b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f57437dbc7c87ac05230a5a5458846b">&#9670;&#160;</a></span>ws2_runtime_error() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">winstd::ws2_runtime_error::ws2_runtime_error </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwinstd_1_1num__runtime__error.html#a6fa2de87d0151b3ad9cac58f838852e0">error_type</a>&#160;</td>
<td class="paramname"><em>num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>msg</em> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an exception. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>WinSock2 error code </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Error message </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae7914ed1c76d543399992573bc580b4e" name="ae7914ed1c76d543399992573bc580b4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7914ed1c76d543399992573bc580b4e">&#9670;&#160;</a></span>ws2_runtime_error() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">winstd::ws2_runtime_error::ws2_runtime_error </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an exception using <code>WSAGetLastError()</code> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Error message </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2e54221cc0f78724af416f9af1415267" name="a2e54221cc0f78724af416f9af1415267"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e54221cc0f78724af416f9af1415267">&#9670;&#160;</a></span>ws2_runtime_error() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">winstd::ws2_runtime_error::ws2_runtime_error </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>msg</em> = <code>nullptr</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an exception using <code>WSAGetLastError()</code> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Error message </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af6984de4ac18e732a6844f379d67c52f" name="af6984de4ac18e732a6844f379d67c52f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6984de4ac18e732a6844f379d67c52f">&#9670;&#160;</a></span>msg()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___win_std_general.html#ga8081292a94f5d070e644bdc90662d1fc">tstring</a> winstd::ws2_runtime_error::msg </td>
<td>(</td>
<td class="paramtype">DWORD&#160;</td>
<td class="paramname"><em>dwLanguageId</em> = <code>0</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a user-readable Windows error message. </p>
<dl class="section see"><dt>See also</dt><dd><a href="https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-formatmessage">FormatMessage function</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/WinStd/<a class="el" href="_win_sock2_8h_source.html">WinSock2.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Oct 28 2022 12:27: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.5
</small></address>
</body>
</html>