1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
<!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=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tclap: TCLAP::ExitException 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="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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">tclap
 <span id="projectnumber">1.2.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceTCLAP.html">TCLAP</a></li><li class="navelem"><a class="el" href="classTCLAP_1_1ExitException.html">ExitException</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classTCLAP_1_1ExitException-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">TCLAP::ExitException Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Thrown when <a class="el" href="namespaceTCLAP.html">TCLAP</a> thinks the program should exit.
<a href="classTCLAP_1_1ExitException.html#details">More...</a></p>
<p><code>#include <<a class="el" href="ArgException_8h_source.html">ArgException.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a03a48ed9da416c8261edbd9cbbf85b27"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ExitException.html#a03a48ed9da416c8261edbd9cbbf85b27">ExitException</a> (int estat)</td></tr>
<tr class="separator:a03a48ed9da416c8261edbd9cbbf85b27"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a976a098bb1cfa75bde36a4195ce1f59c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ExitException.html#a976a098bb1cfa75bde36a4195ce1f59c">getExitStatus</a> () const</td></tr>
<tr class="separator:a976a098bb1cfa75bde36a4195ce1f59c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Thrown when <a class="el" href="namespaceTCLAP.html">TCLAP</a> thinks the program should exit. </p>
<p>For example after parse error this exception will be thrown (and normally caught). This allows any resource to be clened properly before exit.</p>
<p>If exception handling is disabled (<a class="el" href="classTCLAP_1_1CmdLine.html#aa02055d8f4864bfa9b505e2d26bbbd87" title="Disables or enables CmdLine's internal parsing exception handling.">CmdLine::setExceptionHandling</a>), this exception will propagate to the call site, allowing the program to catch it and avoid program termination, or do it's own cleanup. See for example, <a href="https://sourceforge.net/p/tclap/bugs/29">https://sourceforge.net/p/tclap/bugs/29</a>. </p>
<p class="definition">Definition at line <a class="el" href="ArgException_8h_source.html#l00200">200</a> of file <a class="el" href="ArgException_8h_source.html">ArgException.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a03a48ed9da416c8261edbd9cbbf85b27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03a48ed9da416c8261edbd9cbbf85b27">◆ </a></span>ExitException()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">TCLAP::ExitException::ExitException </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>estat</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 class="definition">Definition at line <a class="el" href="ArgException_8h_source.html#l00202">202</a> of file <a class="el" href="ArgException_8h_source.html">ArgException.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a976a098bb1cfa75bde36a4195ce1f59c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a976a098bb1cfa75bde36a4195ce1f59c">◆ </a></span>getExitStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int TCLAP::ExitException::getExitStatus </td>
<td>(</td>
<td class="paramname"></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 class="definition">Definition at line <a class="el" href="ArgException_8h_source.html#l00204">204</a> of file <a class="el" href="ArgException_8h_source.html">ArgException.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="CmdLine_8h_source.html#l00457">TCLAP::CmdLine::parse()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ArgException_8h_source.html">ArgException.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
|
