File: classXapian_1_1FeatureUnavailableError.html

package info (click to toggle)
xapian-core 1.4.22-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 22,816 kB
  • sloc: cpp: 92,138; ansic: 9,983; sh: 4,929; perl: 850; makefile: 503; javascript: 331; tcl: 319; python: 40
file content (209 lines) | stat: -rw-r--r-- 13,382 bytes parent folder | download 
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
<!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.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Xapian: API Documentation: Xapian::FeatureUnavailableError 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">xapian-core
   &#160;<span id="projectnumber">1.4.22</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<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('',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="namespaceXapian.html">Xapian</a></li><li class="navelem"><a class="el" href="classXapian_1_1FeatureUnavailableError.html">FeatureUnavailableError</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classXapian_1_1FeatureUnavailableError-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">Xapian::FeatureUnavailableError Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Indicates an attempt to use a feature which is unavailable.  
 <a href="classXapian_1_1FeatureUnavailableError.html#details">More...</a></p>

<p><code>#include &lt;error.h&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Xapian::FeatureUnavailableError:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classXapian_1_1FeatureUnavailableError__inherit__graph.png" border="0" usemap="#aXapian_1_1FeatureUnavailableError_inherit__map" alt="Inheritance graph"/></div>
<map name="aXapian_1_1FeatureUnavailableError_inherit__map" id="aXapian_1_1FeatureUnavailableError_inherit__map">
<area shape="rect" title="Indicates an attempt to use a feature which is unavailable." alt="" coords="5,155,208,196"/>
<area shape="rect" href="classXapian_1_1RuntimeError.html" title="The base class for exceptions indicating errors only detectable at runtime." alt="" coords="26,80,187,107"/>
<area shape="rect" href="classXapian_1_1Error.html" title="All exceptions thrown by Xapian are subclasses of Xapian::Error." alt="" coords="53,5,160,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></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:aa0c0377fd357fc7aa026aa3637e3714a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1FeatureUnavailableError.html#aa0c0377fd357fc7aa026aa3637e3714a">FeatureUnavailableError</a> (const std::string &amp;msg_, const std::string &amp;context_=std::string(), int errno_=0)</td></tr>
<tr class="memdesc:aa0c0377fd357fc7aa026aa3637e3714a"><td class="mdescLeft">&#160;</td><td class="mdescRight">General purpose constructor.  <a href="classXapian_1_1FeatureUnavailableError.html#aa0c0377fd357fc7aa026aa3637e3714a">More...</a><br /></td></tr>
<tr class="separator:aa0c0377fd357fc7aa026aa3637e3714a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c8440e4252839a4b24a8fb4ded15cd3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1FeatureUnavailableError.html#a7c8440e4252839a4b24a8fb4ded15cd3">FeatureUnavailableError</a> (const std::string &amp;msg_, int errno_)</td></tr>
<tr class="memdesc:a7c8440e4252839a4b24a8fb4ded15cd3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct from message and errno value.  <a href="classXapian_1_1FeatureUnavailableError.html#a7c8440e4252839a4b24a8fb4ded15cd3">More...</a><br /></td></tr>
<tr class="separator:a7c8440e4252839a4b24a8fb4ded15cd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classXapian_1_1Error"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classXapian_1_1Error')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classXapian_1_1Error.html">Xapian::Error</a></td></tr>
<tr class="memitem:ae2663feca0ff541dcef3a79396dd05ab inherit pub_methods_classXapian_1_1Error"><td class="memItemLeft" align="right" valign="top"><a id="ae2663feca0ff541dcef3a79396dd05ab" name="ae2663feca0ff541dcef3a79396dd05ab"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><b>get_type</b> () const</td></tr>
<tr class="memdesc:ae2663feca0ff541dcef3a79396dd05ab inherit pub_methods_classXapian_1_1Error"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type of this error (e.g. "DocNotFoundError".) <br /></td></tr>
<tr class="separator:ae2663feca0ff541dcef3a79396dd05ab inherit pub_methods_classXapian_1_1Error"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840d36cfe92531bcbb7ad8baa445858a inherit pub_methods_classXapian_1_1Error"><td class="memItemLeft" align="right" valign="top"><a id="a840d36cfe92531bcbb7ad8baa445858a" name="a840d36cfe92531bcbb7ad8baa445858a"></a>
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>get_msg</b> () const</td></tr>
<tr class="memdesc:a840d36cfe92531bcbb7ad8baa445858a inherit pub_methods_classXapian_1_1Error"><td class="mdescLeft">&#160;</td><td class="mdescRight">Message giving details of the error, intended for human consumption. <br /></td></tr>
<tr class="separator:a840d36cfe92531bcbb7ad8baa445858a inherit pub_methods_classXapian_1_1Error"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e1cf96dd8dcff7008a4245a607122b7 inherit pub_methods_classXapian_1_1Error"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Error.html#a3e1cf96dd8dcff7008a4245a607122b7">get_context</a> () const</td></tr>
<tr class="memdesc:a3e1cf96dd8dcff7008a4245a607122b7 inherit pub_methods_classXapian_1_1Error"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional context information.  <a href="classXapian_1_1Error.html#a3e1cf96dd8dcff7008a4245a607122b7">More...</a><br /></td></tr>
<tr class="separator:a3e1cf96dd8dcff7008a4245a607122b7 inherit pub_methods_classXapian_1_1Error"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0d5a2f12c551f5220716282b501a7a1 inherit pub_methods_classXapian_1_1Error"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Error.html#ab0d5a2f12c551f5220716282b501a7a1">get_error_string</a> () const</td></tr>
<tr class="memdesc:ab0d5a2f12c551f5220716282b501a7a1 inherit pub_methods_classXapian_1_1Error"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns any system error string associated with this exception.  <a href="classXapian_1_1Error.html#ab0d5a2f12c551f5220716282b501a7a1">More...</a><br /></td></tr>
<tr class="separator:ab0d5a2f12c551f5220716282b501a7a1 inherit pub_methods_classXapian_1_1Error"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fabaae0c1c2e5aa0164a5151c0b8c7f inherit pub_methods_classXapian_1_1Error"><td class="memItemLeft" align="right" valign="top"><a id="a1fabaae0c1c2e5aa0164a5151c0b8c7f" name="a1fabaae0c1c2e5aa0164a5151c0b8c7f"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>get_description</b> () const</td></tr>
<tr class="memdesc:a1fabaae0c1c2e5aa0164a5151c0b8c7f inherit pub_methods_classXapian_1_1Error"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
<tr class="separator:a1fabaae0c1c2e5aa0164a5151c0b8c7f inherit pub_methods_classXapian_1_1Error"><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 >Indicates an attempt to use a feature which is unavailable. </p>
<p >Typically a feature is unavailable because it wasn't compiled in, or because it requires other software or facilities which aren't available. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa0c0377fd357fc7aa026aa3637e3714a" name="aa0c0377fd357fc7aa026aa3637e3714a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0c0377fd357fc7aa026aa3637e3714a">&#9670;&nbsp;</a></span>FeatureUnavailableError() <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">Xapian::FeatureUnavailableError::FeatureUnavailableError </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>msg_</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>context_</em> = <code>std::string()</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>errno_</em> = <code>0</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 class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>General purpose constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">msg_</td><td>Message giving details of the error, intended for human consumption. </td></tr>
    <tr><td class="paramname">context_</td><td>Optional context information for this error. </td></tr>
    <tr><td class="paramname">errno_</td><td>Optional errno value associated with this error. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a7c8440e4252839a4b24a8fb4ded15cd3" name="a7c8440e4252839a4b24a8fb4ded15cd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c8440e4252839a4b24a8fb4ded15cd3">&#9670;&nbsp;</a></span>FeatureUnavailableError() <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">Xapian::FeatureUnavailableError::FeatureUnavailableError </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>msg_</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>errno_</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>Construct from message and errno value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">msg_</td><td>Message giving details of the error, intended for human consumption. </td></tr>
    <tr><td class="paramname">errno_</td><td>Optional errno value associated with this error. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="error_8h.html">error.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/">Doxygen 1.9.4</a>
</small></address>
</body>
</html>