xref: /freebsd/contrib/lutok/api-docs/html/a00895.html (revision 132f818ddbf457ee67d502cd89b5a18e0a34713d)
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6<meta name="generator" content="Doxygen 1.9.6"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>Lutok: lutok::error Class Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="search/search.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="search/searchdata.js"></script>
14<script type="text/javascript" src="search/search.js"></script>
15<link href="doxygen.css" rel="stylesheet" type="text/css" />
16</head>
17<body>
18<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19<div id="titlearea">
20<table cellspacing="0" cellpadding="0">
21 <tbody>
22 <tr id="projectrow">
23  <td id="projectalign">
24   <div id="projectname">Lutok<span id="projectnumber">&#160;0.6.2</span>
25   </div>
26  </td>
27 </tr>
28 </tbody>
29</table>
30</div>
31<!-- end header part -->
32<!-- Generated by Doxygen 1.9.6 -->
33<script type="text/javascript">
34/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
35var searchBox = new SearchBox("searchBox", "search/",'.html');
36/* @license-end */
37</script>
38<script type="text/javascript" src="menudata.js"></script>
39<script type="text/javascript" src="menu.js"></script>
40<script type="text/javascript">
41/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
42$(function() {
43  initMenu('',true,false,'search.php','Search');
44  $(document).ready(function() { init_search(); });
45});
46/* @license-end */
47</script>
48<div id="main-nav"></div>
49<!-- window showing the filter options -->
50<div id="MSearchSelectWindow"
51     onmouseover="return searchBox.OnSearchSelectShow()"
52     onmouseout="return searchBox.OnSearchSelectHide()"
53     onkeydown="return searchBox.OnSearchSelectKey(event)">
54</div>
55
56<!-- iframe showing the search results (closed by default) -->
57<div id="MSearchResultsWindow">
58<div id="MSearchResults">
59<div class="SRPage">
60<div id="SRIndex">
61<div id="SRResults"></div>
62<div class="SRStatus" id="Loading">Loading...</div>
63<div class="SRStatus" id="Searching">Searching...</div>
64<div class="SRStatus" id="NoMatches">No Matches</div>
65</div>
66</div>
67</div>
68</div>
69
70<div id="nav-path" class="navpath">
71  <ul>
72<li class="navelem"><b>lutok</b></li><li class="navelem"><a class="el" href="a00895.html">error</a></li>  </ul>
73</div>
74</div><!-- top -->
75<div class="header">
76  <div class="summary">
77<a href="#pub-methods">Public Member Functions</a> &#124;
78<a href="a00892.html">List of all members</a>  </div>
79  <div class="headertitle"><div class="title">lutok::error Class Reference</div></div>
80</div><!--header-->
81<div class="contents">
82
83<p>Base exception for lua errors.
84 <a href="a00895.html#details">More...</a></p>
85
86<p><code>#include &lt;<a class="el" href="a00053_source.html">exceptions.hpp</a>&gt;</code></p>
87<div class="dynheader">
88Inheritance diagram for lutok::error:</div>
89<div class="dyncontent">
90 <div class="center">
91  <img src="a00895.png" usemap="#lutok::error_map" alt=""/>
92  <map id="lutok::error_map" name="lutok::error_map">
93<area href="a00899.html" title="Exception for errors raised by the Lua API library." alt="lutok::api_error" shape="rect" coords="0,168,160,192"/>
94<area href="a00903.html" title="File not found error." alt="lutok::file_not_found_error" shape="rect" coords="170,168,330,192"/>
95  </map>
96</div></div>
97<table class="memberdecls">
98<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
99Public Member Functions</h2></td></tr>
100<tr class="memitem:a0c0a2ad18088fcafc0ca2a3b61ac5e00"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00895.html#a0c0a2ad18088fcafc0ca2a3b61ac5e00">error</a> (const std::string &amp;)</td></tr>
101<tr class="memdesc:a0c0a2ad18088fcafc0ca2a3b61ac5e00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new error with a plain-text message.  <br /></td></tr>
102<tr class="separator:a0c0a2ad18088fcafc0ca2a3b61ac5e00"><td class="memSeparator" colspan="2">&#160;</td></tr>
103<tr class="memitem:a0e8084a7eaeb9c462e9ebfe26c3c86e8"><td class="memItemLeft" align="right" valign="top"><a id="a0e8084a7eaeb9c462e9ebfe26c3c86e8" name="a0e8084a7eaeb9c462e9ebfe26c3c86e8"></a>
104virtual&#160;</td><td class="memItemRight" valign="bottom"><b>~error</b> (void)  throw ()</td></tr>
105<tr class="memdesc:a0e8084a7eaeb9c462e9ebfe26c3c86e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor for the error. <br /></td></tr>
106<tr class="separator:a0e8084a7eaeb9c462e9ebfe26c3c86e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
107</table>
108<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
109<div class="textblock"><p>Base exception for lua errors. </p>
110</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
111<a id="a0c0a2ad18088fcafc0ca2a3b61ac5e00" name="a0c0a2ad18088fcafc0ca2a3b61ac5e00"></a>
112<h2 class="memtitle"><span class="permalink"><a href="#a0c0a2ad18088fcafc0ca2a3b61ac5e00">&#9670;&#160;</a></span>error()</h2>
113
114<div class="memitem">
115<div class="memproto">
116<table class="mlabels">
117  <tr>
118  <td class="mlabels-left">
119      <table class="memname">
120        <tr>
121          <td class="memname">lutok::error::error </td>
122          <td>(</td>
123          <td class="paramtype">const std::string &amp;&#160;</td>
124          <td class="paramname"><em>message</em></td><td>)</td>
125          <td></td>
126        </tr>
127      </table>
128  </td>
129  <td class="mlabels-right">
130<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
131  </tr>
132</table>
133</div><div class="memdoc">
134
135<p>Constructs a new error with a plain-text message. </p>
136<dl class="params"><dt>Parameters</dt><dd>
137  <table class="params">
138    <tr><td class="paramname">message</td><td>The plain-text error message. </td></tr>
139  </table>
140  </dd>
141</dl>
142
143</div>
144</div>
145<hr/>The documentation for this class was generated from the following files:<ul>
146<li><a class="el" href="a00053_source.html">exceptions.hpp</a></li>
147<li>exceptions.cpp</li>
148</ul>
149</div><!-- contents -->
150<!-- start footer part -->
151<hr class="footer"/><address class="footer"><small>
152Generated 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.6
153</small></address>
154</body>
155</html>
156