| 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"> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 5 |
<meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| 6 |
<meta name="generator" content="Doxygen 1.15.0"/> |
| 7 |
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 8 |
<title>Xapian: API Documentation: Xapian::UnimplementedError 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="doxygen.css" rel="stylesheet" type="text/css" /> |
| 13 |
</head> |
| 14 |
<body> |
| 15 |
<div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 16 |
<div id="titlearea"> |
| 17 |
<table cellspacing="0" cellpadding="0"> |
| 18 |
<tbody> |
| 19 |
<tr style="height: 56px;"> |
| 20 |
<td id="projectalign" style="padding-left: 0.5em;"> |
| 21 |
<div id="projectname">xapian-core |
| 22 |
 <span id="projectnumber">1.4.31</span> |
| 23 |
</div> |
| 24 |
</td> |
| 25 |
</tr> |
| 26 |
</tbody> |
| 27 |
</table> |
| 28 |
</div> |
| 29 |
<!-- end header part --> |
| 30 |
<!-- Generated by Doxygen 1.15.0 --> |
| 31 |
<script type="text/javascript"> |
| 32 |
$(function() { codefold.init(); }); |
| 33 |
</script> |
| 34 |
<script type="text/javascript" src="menudata.js"></script> |
| 35 |
<script type="text/javascript" src="menu.js"></script> |
| 36 |
<script type="text/javascript"> |
| 37 |
$(function() { |
| 38 |
initMenu('',false,false,'search.php','Search',false); |
| 39 |
}); |
| 40 |
</script> |
| 41 |
<div id="main-nav"></div> |
| 42 |
<div id="nav-path" class="navpath"> |
| 43 |
<ul> |
| 44 |
<li class="navelem"><a href="namespaceXapian.html">Xapian</a></li><li class="navelem"><a href="classXapian_1_1UnimplementedError.html">UnimplementedError</a></li> </ul> |
| 45 |
</div> |
| 46 |
</div><!-- top --> |
| 47 |
<div id="doc-content"> |
| 48 |
<div class="header"> |
| 49 |
<div class="summary"> |
| 50 |
<a href="#pub-methods">Public Member Functions</a> | |
| 51 |
<a href="classXapian_1_1UnimplementedError-members.html">List of all members</a> </div> |
| 52 |
<div class="headertitle"><div class="title">Xapian::UnimplementedError Class Reference</div></div> |
| 53 |
</div><!--header--> |
| 54 |
<div class="contents"> |
| 55 |
|
| 56 |
<p><a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">UnimplementedError</a> indicates an attempt to use an unimplemented feature. |
| 57 |
<a href="#details">More...</a></p> |
| 58 |
|
| 59 |
<p><code>#include <error.h></code></p> |
| 60 |
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Inheritance diagram for Xapian::UnimplementedError:</div> |
| 61 |
<div id="dynsection-0-summary" class="dynsummary" style="display:block;"> |
| 62 |
</div> |
| 63 |
<div id="dynsection-0-content" class="dyncontent" style="display:none;"> |
| 64 |
<div class="center"><img src="classXapian_1_1UnimplementedError__inherit__graph.png" border="0" usemap="#aXapian_1_1UnimplementedError_inherit__map" loading="lazy" alt="Inheritance graph"/></div> |
| 65 |
<map name="aXapian_1_1UnimplementedError_inherit__map" id="aXapian_1_1UnimplementedError_inherit__map"> |
| 66 |
<area shape="rect" title="UnimplementedError indicates an attempt to use an unimplemented feature." alt="" coords="5,157,216,184"/> |
| 67 |
<area shape="rect" href="classXapian_1_1LogicError.html" title="The base class for exceptions indicating errors in the program logic." alt="" coords="41,81,180,109"/> |
| 68 |
<area shape="poly" title=" " alt="" coords="112,123,113,157,108,155,109,126"/> |
| 69 |
<area shape="rect" href="classXapian_1_1Error.html" title="All exceptions thrown by Xapian are subclasses of Xapian::Error." alt="" coords="58,5,163,33"/> |
| 70 |
<area shape="poly" title=" " alt="" coords="112,46,113,81,108,80,109,51"/> |
| 71 |
</map> |
| 72 |
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> |
| 73 |
<table class="memberdecls"> |
| 74 |
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a> |
| 75 |
Public Member Functions</h2></td></tr> |
| 76 |
<tr class="memitem:a07264ff5488cca70fbf073cfc340190b" id="r_a07264ff5488cca70fbf073cfc340190b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a07264ff5488cca70fbf073cfc340190b">UnimplementedError</a> (const std::string &msg_, const std::string &context_=std::string(), int errno_=0)</td></tr> |
| 77 |
<tr class="memdesc:a07264ff5488cca70fbf073cfc340190b"><td class="mdescLeft"> </td><td class="mdescRight">General purpose constructor. <br /></td></tr> |
| 78 |
<tr class="memitem:a025c7f29d76bd5b9c0fc875d82f4554d" id="r_a025c7f29d76bd5b9c0fc875d82f4554d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a025c7f29d76bd5b9c0fc875d82f4554d">UnimplementedError</a> (const std::string &msg_, int errno_)</td></tr> |
| 79 |
<tr class="memdesc:a025c7f29d76bd5b9c0fc875d82f4554d"><td class="mdescLeft"> </td><td class="mdescRight">Construct from message and errno value. <br /></td></tr> |
| 80 |
<tr class="inherit_header pub_methods_classXapian_1_1Error"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classXapian_1_1Error')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Member Functions inherited from <a class="el" href="classXapian_1_1Error.html">Xapian::Error</a></td></tr> |
| 81 |
<tr class="memitem:ae2663feca0ff541dcef3a79396dd05ab inherit pub_methods_classXapian_1_1Error" id="r_ae2663feca0ff541dcef3a79396dd05ab"><td class="memItemLeft" align="right" valign="top"> |
| 82 |
const char * </td><td class="memItemRight" valign="bottom"><b>get_type</b> () const</td></tr> |
| 83 |
<tr class="memdesc:ae2663feca0ff541dcef3a79396dd05ab inherit pub_methods_classXapian_1_1Error"><td class="mdescLeft"> </td><td class="mdescRight">The type of this error (e.g. "DocNotFoundError".). <br /></td></tr> |
| 84 |
<tr class="memitem:a840d36cfe92531bcbb7ad8baa445858a inherit pub_methods_classXapian_1_1Error" id="r_a840d36cfe92531bcbb7ad8baa445858a"><td class="memItemLeft" align="right" valign="top"> |
| 85 |
const std::string & </td><td class="memItemRight" valign="bottom"><b>get_msg</b> () const</td></tr> |
| 86 |
<tr class="memdesc:a840d36cfe92531bcbb7ad8baa445858a inherit pub_methods_classXapian_1_1Error"><td class="mdescLeft"> </td><td class="mdescRight">Message giving details of the error, intended for human consumption. <br /></td></tr> |
| 87 |
<tr class="memitem:a3e1cf96dd8dcff7008a4245a607122b7 inherit pub_methods_classXapian_1_1Error" id="r_a3e1cf96dd8dcff7008a4245a607122b7"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Error.html#a3e1cf96dd8dcff7008a4245a607122b7">get_context</a> () const</td></tr> |
| 88 |
<tr class="memdesc:a3e1cf96dd8dcff7008a4245a607122b7 inherit pub_methods_classXapian_1_1Error"><td class="mdescLeft"> </td><td class="mdescRight">Optional context information. <br /></td></tr> |
| 89 |
<tr class="memitem:ab0d5a2f12c551f5220716282b501a7a1 inherit pub_methods_classXapian_1_1Error" id="r_ab0d5a2f12c551f5220716282b501a7a1"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Error.html#ab0d5a2f12c551f5220716282b501a7a1">get_error_string</a> () const</td></tr> |
| 90 |
<tr class="memdesc:ab0d5a2f12c551f5220716282b501a7a1 inherit pub_methods_classXapian_1_1Error"><td class="mdescLeft"> </td><td class="mdescRight">Returns any system error string associated with this exception. <br /></td></tr> |
| 91 |
<tr class="memitem:a1fabaae0c1c2e5aa0164a5151c0b8c7f inherit pub_methods_classXapian_1_1Error" id="r_a1fabaae0c1c2e5aa0164a5151c0b8c7f"><td class="memItemLeft" align="right" valign="top"> |
| 92 |
std::string </td><td class="memItemRight" valign="bottom"><b>get_description</b> () const</td></tr> |
| 93 |
<tr class="memdesc:a1fabaae0c1c2e5aa0164a5151c0b8c7f inherit pub_methods_classXapian_1_1Error"><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <br /></td></tr> |
| 94 |
</table> |
| 95 |
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2> |
| 96 |
<div class="textblock"><p><a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">UnimplementedError</a> indicates an attempt to use an unimplemented feature. </p> |
| 97 |
</div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor & Destructor Documentation</h2> |
| 98 |
<a id="a07264ff5488cca70fbf073cfc340190b" name="a07264ff5488cca70fbf073cfc340190b"></a> |
| 99 |
<h2 class="memtitle"><span class="permalink"><a href="#a07264ff5488cca70fbf073cfc340190b">◆ </a></span>UnimplementedError() <span class="overload">[1/2]</span></h2> |
| 100 |
|
| 101 |
<div class="memitem"> |
| 102 |
<div class="memproto"> |
| 103 |
<table class="mlabels"> |
| 104 |
<tr> |
| 105 |
<td class="mlabels-left"> |
| 106 |
<table class="memname"> |
| 107 |
<tr> |
| 108 |
<td class="memname">Xapian::UnimplementedError::UnimplementedError </td> |
| 109 |
<td>(</td> |
| 110 |
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>msg_</em></span>, </td> |
| 111 |
</tr> |
| 112 |
<tr> |
| 113 |
<td class="paramkey"></td> |
| 114 |
<td></td> |
| 115 |
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>context_</em></span><span class="paramdefsep"> = </span><span class="paramdefval">std::string()</span>, </td> |
| 116 |
</tr> |
| 117 |
<tr> |
| 118 |
<td class="paramkey"></td> |
| 119 |
<td></td> |
| 120 |
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>errno_</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span> )</td> |
| 121 |
</tr> |
| 122 |
</table> |
| 123 |
</td> |
| 124 |
<td class="mlabels-right"> |
| 125 |
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel explicit">explicit</span></span> </td> |
| 126 |
</tr> |
| 127 |
</table> |
| 128 |
</div><div class="memdoc"> |
| 129 |
|
| 130 |
<p>General purpose constructor. </p> |
| 131 |
<dl class="params"><dt>Parameters</dt><dd> |
| 132 |
<table class="params"> |
| 133 |
<tr><td class="paramname">msg_</td><td>Message giving details of the error, intended for human consumption. </td></tr> |
| 134 |
<tr><td class="paramname">context_</td><td>Optional context information for this error. </td></tr> |
| 135 |
<tr><td class="paramname">errno_</td><td>Optional errno value associated with this error. </td></tr> |
| 136 |
</table> |
| 137 |
</dd> |
| 138 |
</dl> |
| 139 |
|
| 140 |
</div> |
| 141 |
</div> |
| 142 |
<a id="a025c7f29d76bd5b9c0fc875d82f4554d" name="a025c7f29d76bd5b9c0fc875d82f4554d"></a> |
| 143 |
<h2 class="memtitle"><span class="permalink"><a href="#a025c7f29d76bd5b9c0fc875d82f4554d">◆ </a></span>UnimplementedError() <span class="overload">[2/2]</span></h2> |
| 144 |
|
| 145 |
<div class="memitem"> |
| 146 |
<div class="memproto"> |
| 147 |
<table class="mlabels"> |
| 148 |
<tr> |
| 149 |
<td class="mlabels-left"> |
| 150 |
<table class="memname"> |
| 151 |
<tr> |
| 152 |
<td class="memname">Xapian::UnimplementedError::UnimplementedError </td> |
| 153 |
<td>(</td> |
| 154 |
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>msg_</em></span>, </td> |
| 155 |
</tr> |
| 156 |
<tr> |
| 157 |
<td class="paramkey"></td> |
| 158 |
<td></td> |
| 159 |
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>errno_</em></span> )</td> |
| 160 |
</tr> |
| 161 |
</table> |
| 162 |
</td> |
| 163 |
<td class="mlabels-right"> |
| 164 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 165 |
</tr> |
| 166 |
</table> |
| 167 |
</div><div class="memdoc"> |
| 168 |
|
| 169 |
<p>Construct from message and errno value. </p> |
| 170 |
<dl class="params"><dt>Parameters</dt><dd> |
| 171 |
<table class="params"> |
| 172 |
<tr><td class="paramname">msg_</td><td>Message giving details of the error, intended for human consumption. </td></tr> |
| 173 |
<tr><td class="paramname">errno_</td><td>Optional errno value associated with this error. </td></tr> |
| 174 |
</table> |
| 175 |
</dd> |
| 176 |
</dl> |
| 177 |
|
| 178 |
</div> |
| 179 |
</div> |
| 180 |
<hr/>The documentation for this class was generated from the following file:<ul> |
| 181 |
<li>xapian/<a class="el" href="error_8h.html">error.h</a></li> |
| 182 |
</ul> |
| 183 |
</div><!-- contents --> |
| 184 |
<!-- start footer part --> |
| 185 |
<hr class="footer"/><address class="footer"><small> |
| 186 |
Generated by <a href="https://www.doxygen.org/">Doxygen 1.15.0</a> |
| 187 |
</small></address> |
| 188 |
</body> |
| 189 |
</html> |