WinStd/classwinstd_1_1com__runtime__error.html

235 lines
14 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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WinStd: winstd::com_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.8 -->
<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_1com__runtime__error.html">com_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_1com__runtime__error-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">winstd::com_runtime_error Class Reference<div class="ingroups"><a class="el" href="group___win_std_exceptions.html">Exceptions</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>COM runtime error.
<a href="classwinstd_1_1com__runtime__error.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_c_o_m_8h_source.html">WinStd/COM.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for winstd::com_runtime_error:</div>
<div class="dyncontent">
<div class="center">
<img src="classwinstd_1_1com__runtime__error.png" usemap="#winstd::com_5Fruntime_5Ferror_map" alt=""/>
<map id="winstd::com_5Fruntime_5Ferror_map" name="winstd::com_5Fruntime_5Ferror_map">
<area href="classwinstd_1_1num__runtime__error.html" alt="winstd::num_runtime_error&lt; HRESULT &gt;" shape="rect" coords="0,56,239,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:a75030cbe7acc6532140c73caf4b15ed8" id="r_a75030cbe7acc6532140c73caf4b15ed8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1com__runtime__error.html#a75030cbe7acc6532140c73caf4b15ed8">com_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:a75030cbe7acc6532140c73caf4b15ed8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an exception. <br /></td></tr>
<tr class="separator:a75030cbe7acc6532140c73caf4b15ed8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1b65214e16b18bf8b9b191abff254b7" id="r_aa1b65214e16b18bf8b9b191abff254b7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1com__runtime__error.html#aa1b65214e16b18bf8b9b191abff254b7">com_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:aa1b65214e16b18bf8b9b191abff254b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an exception. <br /></td></tr>
<tr class="separator:aa1b65214e16b18bf8b9b191abff254b7"><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; HRESULT &gt;</a></td></tr>
<tr class="memitem:a4cfc6c7f3b1d5fed5a3d9e0c5aac3d19 inherit pub_methods_classwinstd_1_1num__runtime__error" id="r_a4cfc6c7f3b1d5fed5a3d9e0c5aac3d19"><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. <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" id="r_a4c0d5efd086891093156fede0dd43cd0"><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. <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" id="r_a6388a483c00628c1a94a5ce45ca63e70"><td class="memItemLeft" align="right" valign="top">
<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 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; HRESULT &gt;</a></td></tr>
<tr class="memitem:a6fa2de87d0151b3ad9cac58f838852e0 inherit pub_types_classwinstd_1_1num__runtime__error" id="r_a6fa2de87d0151b3ad9cac58f838852e0"><td class="memItemLeft" align="right" valign="top">
typedef HRESULT&#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; HRESULT &gt;</a></td></tr>
<tr class="memitem:a865b8400a5a5a962c3068bf55f022d1f inherit pro_attribs_classwinstd_1_1num__runtime__error" id="r_a865b8400a5a5a962c3068bf55f022d1f"><td class="memItemLeft" align="right" valign="top">
<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>COM runtime error. </p>
<dl class="section note"><dt>Note</dt><dd>Must be defined as derived class from num_runtime_error&lt;&gt; to allow correct type info for dynamic typecasting and prevent folding with other derivates of num_runtime_error&lt;&gt;. </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a75030cbe7acc6532140c73caf4b15ed8" name="a75030cbe7acc6532140c73caf4b15ed8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75030cbe7acc6532140c73caf4b15ed8">&#9670;&#160;</a></span>com_runtime_error() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">winstd::com_runtime_error::com_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>COM 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="aa1b65214e16b18bf8b9b191abff254b7" name="aa1b65214e16b18bf8b9b191abff254b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1b65214e16b18bf8b9b191abff254b7">&#9670;&#160;</a></span>com_runtime_error() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">winstd::com_runtime_error::com_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>COM 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>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/WinStd/<a class="el" href="_c_o_m_8h_source.html">COM.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 18 2023 11:44:07 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.8
</small></address>
</body>
</html>