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
|
<!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>Xapian: API Documentation: Xapian::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="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
 <span id="projectnumber">1.4.18</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="namespaceXapian.html">Xapian</a></li><li class="navelem"><a class="el" href="classXapian_1_1Error.html">Error</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1Error-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Xapian::Error Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>All exceptions thrown by <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> are subclasses of <a class="el" href="classXapian_1_1Error.html" title="All exceptions thrown by Xapian are subclasses of Xapian::Error.">Xapian::Error</a>.
<a href="classXapian_1_1Error.html#details">More...</a></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::Error:</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_1Error__inherit__graph.png" border="0" usemap="#aXapian_1_1Error_inherit__map" alt="Inheritance graph"/></div>
<map name="aXapian_1_1Error_inherit__map" id="aXapian_1_1Error_inherit__map">
<area shape="rect" title="All exceptions thrown by Xapian are subclasses of Xapian::Error." alt="" coords="5,279,112,305"/>
<area shape="rect" href="classXapian_1_1LogicError.html" title="The base class for exceptions indicating errors in the program logic." alt="" coords="171,115,311,141"/>
<area shape="rect" href="classXapian_1_1RuntimeError.html" title="The base class for exceptions indicating errors only detectable at runtime." alt="" coords="160,417,321,444"/>
<area shape="rect" href="classXapian_1_1AssertionError.html" title="AssertionError is thrown if a logical assertion inside Xapian fails." alt="" coords="393,5,560,32"/>
<area shape="rect" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API." alt="" coords="369,56,584,83"/>
<area shape="rect" href="classXapian_1_1InvalidOperationError.html" title="InvalidOperationError indicates the API was used in an invalid way." alt="" coords="385,107,568,149"/>
<area shape="rect" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature." alt="" coords="371,173,582,200"/>
<area shape="rect" href="classXapian_1_1DatabaseError.html" title="DatabaseError indicates some sort of database related error." alt="" coords="393,224,561,251"/>
<area shape="rect" href="classXapian_1_1DocNotFoundError.html" title="Indicates an attempt to access a document not present in the database." alt="" coords="380,275,573,301"/>
<area shape="rect" href="classXapian_1_1FeatureUnavailableError.html" title="Indicates an attempt to use a feature which is unavailable." alt="" coords="375,326,578,367"/>
<area shape="rect" href="classXapian_1_1InternalError.html" title="InternalError indicates a runtime problem of some sort." alt="" coords="399,392,555,419"/>
<area shape="rect" href="classXapian_1_1NetworkError.html" title="Indicates a problem communicating with a remote database." alt="" coords="396,443,557,469"/>
<area shape="rect" href="classXapian_1_1QueryParserError.html" title="Indicates a query string can't be parsed." alt="" coords="383,493,570,520"/>
<area shape="rect" href="classXapian_1_1RangeError.html" title="RangeError indicates an attempt to access outside the bounds of a container." alt="" coords="403,544,550,571"/>
<area shape="rect" href="classXapian_1_1SerialisationError.html" title="Indicates an error in the std::string serialisation of an object." alt="" coords="383,595,570,621"/>
<area shape="rect" href="classXapian_1_1WildcardError.html" title="WildcardError indicates an error expanding a wildcarded query." alt="" coords="395,645,558,672"/>
<area shape="rect" href="classXapian_1_1DatabaseClosedError.html" title="Indicates an attempt to access a closed database." alt="" coords="637,97,849,124"/>
<area shape="rect" href="classXapian_1_1DatabaseCorruptError.html" title="DatabaseCorruptError indicates database corruption was detected." alt="" coords="635,148,851,175"/>
<area shape="rect" href="classXapian_1_1DatabaseCreateError.html" title="DatabaseCreateError indicates a failure to create a database." alt="" coords="638,199,849,225"/>
<area shape="rect" href="classXapian_1_1DatabaseLockError.html" title="DatabaseLockError indicates failure to lock a database." alt="" coords="644,249,843,276"/>
<area shape="rect" href="classXapian_1_1DatabaseModifiedError.html" title="DatabaseModifiedError indicates a database was modified." alt="" coords="646,301,841,342"/>
<area shape="rect" href="classXapian_1_1DatabaseOpeningError.html" title="DatabaseOpeningError indicates failure to open a database." alt="" coords="632,367,855,393"/>
<area shape="rect" href="classXapian_1_1DatabaseNotFoundError.html" title="Indicates an attempt to access a database not present." alt="" coords="912,330,1111,371"/>
<area shape="rect" href="classXapian_1_1DatabaseVersionError.html" title="DatabaseVersionError indicates that a database is in an unsupported format." alt="" coords="903,396,1120,423"/>
<area shape="rect" href="classXapian_1_1NetworkTimeoutError.html" title="Indicates a timeout expired while communicating with a remote database." alt="" coords="636,443,851,469"/>
</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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aafe12261f4457a6f584bf66bcd5062a9"><td class="memItemLeft" align="right" valign="top"><a id="aafe12261f4457a6f584bf66bcd5062a9"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Error.html#aafe12261f4457a6f584bf66bcd5062a9">get_type</a> () const</td></tr>
<tr class="memdesc:aafe12261f4457a6f584bf66bcd5062a9"><td class="mdescLeft"> </td><td class="mdescRight">The type of this error (e.g. "DocNotFoundError".) <br /></td></tr>
<tr class="separator:aafe12261f4457a6f584bf66bcd5062a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16824f7bfcc25c7a68f2dbf9d02f1bb5"><td class="memItemLeft" align="right" valign="top"><a id="a16824f7bfcc25c7a68f2dbf9d02f1bb5"></a>
const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Error.html#a16824f7bfcc25c7a68f2dbf9d02f1bb5">get_msg</a> () const</td></tr>
<tr class="memdesc:a16824f7bfcc25c7a68f2dbf9d02f1bb5"><td class="mdescLeft"> </td><td class="mdescRight">Message giving details of the error, intended for human consumption. <br /></td></tr>
<tr class="separator:a16824f7bfcc25c7a68f2dbf9d02f1bb5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add645c8059652c634fa970a01b45fca2"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Error.html#add645c8059652c634fa970a01b45fca2">get_context</a> () const</td></tr>
<tr class="memdesc:add645c8059652c634fa970a01b45fca2"><td class="mdescLeft"> </td><td class="mdescRight">Optional context information. <a href="classXapian_1_1Error.html#add645c8059652c634fa970a01b45fca2">More...</a><br /></td></tr>
<tr class="separator:add645c8059652c634fa970a01b45fca2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a1e58b8ff941a6cf6cb7c853882b343"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Error.html#a2a1e58b8ff941a6cf6cb7c853882b343">get_error_string</a> () const</td></tr>
<tr class="memdesc:a2a1e58b8ff941a6cf6cb7c853882b343"><td class="mdescLeft"> </td><td class="mdescRight">Returns any system error string associated with this exception. <a href="classXapian_1_1Error.html#a2a1e58b8ff941a6cf6cb7c853882b343">More...</a><br /></td></tr>
<tr class="separator:a2a1e58b8ff941a6cf6cb7c853882b343"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1fabaae0c1c2e5aa0164a5151c0b8c7f"><td class="memItemLeft" align="right" valign="top"><a id="a1fabaae0c1c2e5aa0164a5151c0b8c7f"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Error.html#a1fabaae0c1c2e5aa0164a5151c0b8c7f">get_description</a> () const</td></tr>
<tr class="memdesc:a1fabaae0c1c2e5aa0164a5151c0b8c7f"><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
<tr class="separator:a1fabaae0c1c2e5aa0164a5151c0b8c7f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>All exceptions thrown by <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> are subclasses of <a class="el" href="classXapian_1_1Error.html" title="All exceptions thrown by Xapian are subclasses of Xapian::Error.">Xapian::Error</a>. </p>
<p>This class can not be instantiated directly - instead a subclass should be used. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="add645c8059652c634fa970a01b45fca2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add645c8059652c634fa970a01b45fca2">◆ </a></span>get_context()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string& Xapian::Error::get_context </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>Optional context information. </p>
<p>This context is intended for use by <a class="el" href="classXapian_1_1ErrorHandler.html" title="Decide if a Xapian::Error exception should be ignored.">Xapian::ErrorHandler</a> (for example so it can know which remote server is unreliable and report the problem and remove that server from those being searched). But it's typically a plain-text string, and so also fit for human consumption. </p>
</div>
</div>
<a id="a2a1e58b8ff941a6cf6cb7c853882b343"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a1e58b8ff941a6cf6cb7c853882b343">◆ </a></span>get_error_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* Xapian::Error::get_error_string </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns any system error string associated with this exception. </p>
<p>The system error string may come from errno, h_errno (on UNIX), or GetLastError() (on MS Windows). If there is no associated system error string, NULL is returned. </p>
</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.1</a>
</small></address>
</body>
</html>
|
