forked from CLIUtils/CLI11
-
Notifications
You must be signed in to change notification settings - Fork 0
/
class_c_l_i_1_1_success.html
123 lines (119 loc) · 7.07 KB
/
class_c_l_i_1_1_success.html
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
<!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.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CLI11: CLI::Success 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">CLI11
</div>
<div id="projectbrief">C++11 Command Line Interface Parser</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(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"><b>CLI</b></li><li class="navelem"><a class="el" href="class_c_l_i_1_1_success.html">Success</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="class_c_l_i_1_1_success-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CLI::Success Class Reference<div class="ingroups"><a class="el" href="group__error__group.html">Errors</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>This is a successful completion on parsing, supposed to exit.
<a href="class_c_l_i_1_1_success.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_error_8hpp_source.html">Error.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for CLI::Success:</div>
<div class="dyncontent">
<div class="center">
<img src="class_c_l_i_1_1_success.png" usemap="#CLI::Success_map" alt=""/>
<map id="CLI::Success_map" name="CLI::Success_map">
<area href="class_c_l_i_1_1_parse_error.html" title="Anything that can error in Parse." alt="CLI::ParseError" shape="rect" coords="133,112,256,136"/>
<area href="class_c_l_i_1_1_error.html" title="All errors derive from this one." alt="CLI::Error" shape="rect" coords="133,56,256,80"/>
<area href="class_c_l_i_1_1_call_for_all_help.html" title="Usually something like –help-all on command line." alt="CLI::CallForAllHelp" shape="rect" coords="0,224,123,248"/>
<area href="class_c_l_i_1_1_call_for_help.html" title="-h or –help on command line" alt="CLI::CallForHelp" shape="rect" coords="133,224,256,248"/>
<area href="class_c_l_i_1_1_call_for_version.html" title="-v or –version on command line" alt="CLI::CallForVersion" shape="rect" coords="266,224,389,248"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_methods_class_c_l_i_1_1_error"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_c_l_i_1_1_error')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_c_l_i_1_1_error.html">CLI::Error</a></td></tr>
<tr class="memitem:a24faca884e953e6366bdb8d84d631588 inherit pub_methods_class_c_l_i_1_1_error"><td class="memItemLeft" align="right" valign="top"><a id="a24faca884e953e6366bdb8d84d631588"></a>
int </td><td class="memItemRight" valign="bottom"><b>get_exit_code</b> () const</td></tr>
<tr class="separator:a24faca884e953e6366bdb8d84d631588 inherit pub_methods_class_c_l_i_1_1_error"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a725f16d721c2320ba75b4d6c99d2056a inherit pub_methods_class_c_l_i_1_1_error"><td class="memItemLeft" align="right" valign="top"><a id="a725f16d721c2320ba75b4d6c99d2056a"></a>
std::string </td><td class="memItemRight" valign="bottom"><b>get_name</b> () const</td></tr>
<tr class="separator:a725f16d721c2320ba75b4d6c99d2056a inherit pub_methods_class_c_l_i_1_1_error"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b30cbdb0c6f3ef3d5550df7d8e18904 inherit pub_methods_class_c_l_i_1_1_error"><td class="memItemLeft" align="right" valign="top"><a id="a7b30cbdb0c6f3ef3d5550df7d8e18904"></a>
 </td><td class="memItemRight" valign="bottom"><b>Error</b> (std::string name, std::string msg, int exit_code=static_cast< int >(ExitCodes::BaseClass))</td></tr>
<tr class="separator:a7b30cbdb0c6f3ef3d5550df7d8e18904 inherit pub_methods_class_c_l_i_1_1_error"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a52187308eced1fc96f270ef384dbd7a2 inherit pub_methods_class_c_l_i_1_1_error"><td class="memItemLeft" align="right" valign="top"><a id="a52187308eced1fc96f270ef384dbd7a2"></a>
 </td><td class="memItemRight" valign="bottom"><b>Error</b> (std::string name, std::string msg, ExitCodes exit_code)</td></tr>
<tr class="separator:a52187308eced1fc96f270ef384dbd7a2 inherit pub_methods_class_c_l_i_1_1_error"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This is a successful completion on parsing, supposed to exit. </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>include/CLI/<a class="el" href="_error_8hpp_source.html">Error.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>