errortypes_8h.tex

xapian 是一个“Xapian 是一个开源概率论信息检索库

\hypertarget{errortypes_8h}{
\section{include/xapian/errortypes.h File Reference}
\label{errortypes_8h}\index{include/xapian/errortypes.h@{include/xapian/errortypes.h}}
}
Exception subclasses. 



This graph shows which files directly or indirectly include this file:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=334pt]{errortypes_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Functions}
\begin{CompactItemize}
\item 
\hyperlink{errortypes_8h_66660aed072cba69800b7756dede4d30}{XAPIAN\_\-DEFINE\_\-ERROR\_\-BASECLASS} (Logic\-Error, Error)
\begin{CompactList}\small\item\em Base class for errors due to programming errors. \item\end{CompactList}\item 
\hyperlink{errortypes_8h_88279c78cff6d74aba561f496fb64e49}{XAPIAN\_\-DEFINE\_\-ERROR\_\-BASECLASS} (Runtime\-Error, Error)
\begin{CompactList}\small\item\em Base class for errors due to run time problems. \item\end{CompactList}\item 
\hyperlink{errortypes_8h_a291117c6b9b67d4eff698dcf710af8b}{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS} (Assertion\-Error, Logic\-Error)
\begin{CompactList}\small\item\em Thrown if an internal consistency check fails. \item\end{CompactList}\item 
\hyperlink{errortypes_8h_5ca81084dd887e75076529b7e90f6657}{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS} (Unimplemented\-Error, Logic\-Error)
\begin{CompactList}\small\item\em Thrown when an attempt to use an unimplemented feature is made. \item\end{CompactList}\item 
\hyperlink{errortypes_8h_e6709a02d9d3704eb14d128b42d8585d}{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS} (Invalid\-Argument\-Error, Logic\-Error)
\begin{CompactList}\small\item\em Thrown when an invalid argument is supplied to the API. \item\end{CompactList}\item 
\hyperlink{errortypes_8h_7d77600f4ba01a42e97e9d970bd2bde5}{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS} (Invalid\-Operation\-Error, Logic\-Error)
\begin{CompactList}\small\item\em Thrown when API calls are made in an invalid way. \item\end{CompactList}\item 
\hyperlink{errortypes_8h_6638fc076574a537379d62a284c718b7}{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS} (Doc\-Not\-Found\-Error, Runtime\-Error)
\begin{CompactList}\small\item\em Thrown when an attempt is made to access a document which is not in the database. \item\end{CompactList}\item 
\hyperlink{errortypes_8h_6c70e2b68b3cf954504568a868150824}{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS} (Range\-Error, Runtime\-Error)
\begin{CompactList}\small\item\em thrown when an element is out of range. \item\end{CompactList}\item 
\hyperlink{errortypes_8h_299f315b3d3a9d801ae84fae0ad50563}{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS} (Internal\-Error, Runtime\-Error)
\begin{CompactList}\small\item\em thrown when really weird stuff happens. \item\end{CompactList}\item 
\hyperlink{errortypes_8h_9b330d7d9f0e5460bb9a4c1d08532f7c}{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS} (Database\-Error, Runtime\-Error)
\begin{CompactList}\small\item\em thrown for miscellaneous database errors. \item\end{CompactList}\item 
\hyperlink{errortypes_8h_c703d279f25f24c9bb80c3b9d19ac3a4}{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS} (Feature\-Unavailable\-Error, Runtime\-Error)
\begin{CompactList}\small\item\em Thrown if a feature is unavailable - usually due to not being compiled in. \item\end{CompactList}\item 
\hyperlink{errortypes_8h_4500d86d43a6b3171e869984084f20f9}{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS} (Network\-Error, Runtime\-Error)
\begin{CompactList}\small\item\em thrown when there is a communications problem with a remote database. \item\end{CompactList}\item 
\hyperlink{errortypes_8h_4522d97b28da9267989212e9e48a6f25}{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS} (Network\-Timeout\-Error, Network\-Error)
\begin{CompactList}\small\item\em Thrown when a network timeout is exceeded. \item\end{CompactList}\item 
\hyperlink{errortypes_8h_be4e9214da215c8d3e34dabd791f9e62}{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS} (Database\-Corrupt\-Error, Database\-Error)
\begin{CompactList}\small\item\em thrown if the database is corrupt. \item\end{CompactList}\item 
\hyperlink{errortypes_8h_9dd96390054e03aa6eaa6006f3af9a8d}{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS} (Database\-Create\-Error, Database\-Error)
\begin{CompactList}\small\item\em Thrown when creating a database fails. \item\end{CompactList}\item 
\hyperlink{errortypes_8h_aded8b238c355ab603833a32a6c7a0ca}{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS} (Database\-Opening\-Error, Database\-Error)
\begin{CompactList}\small\item\em Thrown when opening a database fails. \item\end{CompactList}\item 
\hyperlink{errortypes_8h_2159e15107832825b0d55c8d798ef8e4}{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS} (Database\-Lock\-Error, Database\-Error)
\begin{CompactList}\small\item\em Thrown when gaining a lock on a database fails. \item\end{CompactList}\item 
\hyperlink{errortypes_8h_ceaf87389cc9576ab93f3f01679541c2}{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS} (Database\-Modified\-Error, Database\-Error)
\begin{CompactList}\small\item\em Thrown when a database has been modified whilst being read. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Exception subclasses. 



\subsection{Function Documentation}
\hypertarget{errortypes_8h_88279c78cff6d74aba561f496fb64e49}{
\index{errortypes.h@{errortypes.h}!XAPIAN_DEFINE_ERROR_BASECLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-BASECLASS}}
\index{XAPIAN_DEFINE_ERROR_BASECLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-BASECLASS}!errortypes.h@{errortypes.h}}
\subsubsection[XAPIAN\_\-DEFINE\_\-ERROR\_\-BASECLASS]{\setlength{\rightskip}{0pt plus 5cm}XAPIAN\_\-DEFINE\_\-ERROR\_\-BASECLASS (Runtime\-Error, Error)}}
\label{errortypes_8h_88279c78cff6d74aba561f496fb64e49}


Base class for errors due to run time problems. 

An exception derived from Runtime\-Error is thrown when an error is caused by problems with the data or environment rather than a programming mistake. \hypertarget{errortypes_8h_66660aed072cba69800b7756dede4d30}{
\index{errortypes.h@{errortypes.h}!XAPIAN_DEFINE_ERROR_BASECLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-BASECLASS}}
\index{XAPIAN_DEFINE_ERROR_BASECLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-BASECLASS}!errortypes.h@{errortypes.h}}
\subsubsection[XAPIAN\_\-DEFINE\_\-ERROR\_\-BASECLASS]{\setlength{\rightskip}{0pt plus 5cm}XAPIAN\_\-DEFINE\_\-ERROR\_\-BASECLASS (Logic\-Error, Error)}}
\label{errortypes_8h_66660aed072cba69800b7756dede4d30}


Base class for errors due to programming errors. 

An exception derived from Logic\-Error is thrown when a misuse of the API is detected. \hypertarget{errortypes_8h_ceaf87389cc9576ab93f3f01679541c2}{
\index{errortypes.h@{errortypes.h}!XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}}
\index{XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}!errortypes.h@{errortypes.h}}
\subsubsection[XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS]{\setlength{\rightskip}{0pt plus 5cm}XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS (Database\-Modified\-Error, Database\-Error)}}
\label{errortypes_8h_ceaf87389cc9576ab93f3f01679541c2}


Thrown when a database has been modified whilst being read. 

\hypertarget{errortypes_8h_2159e15107832825b0d55c8d798ef8e4}{
\index{errortypes.h@{errortypes.h}!XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}}
\index{XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}!errortypes.h@{errortypes.h}}
\subsubsection[XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS]{\setlength{\rightskip}{0pt plus 5cm}XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS (Database\-Lock\-Error, Database\-Error)}}
\label{errortypes_8h_2159e15107832825b0d55c8d798ef8e4}


Thrown when gaining a lock on a database fails. 

\hypertarget{errortypes_8h_aded8b238c355ab603833a32a6c7a0ca}{
\index{errortypes.h@{errortypes.h}!XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}}
\index{XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}!errortypes.h@{errortypes.h}}
\subsubsection[XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS]{\setlength{\rightskip}{0pt plus 5cm}XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS (Database\-Opening\-Error, Database\-Error)}}
\label{errortypes_8h_aded8b238c355ab603833a32a6c7a0ca}


Thrown when opening a database fails. 

\hypertarget{errortypes_8h_9dd96390054e03aa6eaa6006f3af9a8d}{
\index{errortypes.h@{errortypes.h}!XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}}
\index{XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}!errortypes.h@{errortypes.h}}
\subsubsection[XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS]{\setlength{\rightskip}{0pt plus 5cm}XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS (Database\-Create\-Error, Database\-Error)}}
\label{errortypes_8h_9dd96390054e03aa6eaa6006f3af9a8d}


Thrown when creating a database fails. 

\hypertarget{errortypes_8h_be4e9214da215c8d3e34dabd791f9e62}{
\index{errortypes.h@{errortypes.h}!XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}}
\index{XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}!errortypes.h@{errortypes.h}}
\subsubsection[XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS]{\setlength{\rightskip}{0pt plus 5cm}XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS (Database\-Corrupt\-Error, Database\-Error)}}
\label{errortypes_8h_be4e9214da215c8d3e34dabd791f9e62}


thrown if the database is corrupt. 

\hypertarget{errortypes_8h_4522d97b28da9267989212e9e48a6f25}{
\index{errortypes.h@{errortypes.h}!XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}}
\index{XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}!errortypes.h@{errortypes.h}}
\subsubsection[XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS]{\setlength{\rightskip}{0pt plus 5cm}XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS (Network\-Timeout\-Error, Network\-Error)}}
\label{errortypes_8h_4522d97b28da9267989212e9e48a6f25}


Thrown when a network timeout is exceeded. 

\hypertarget{errortypes_8h_4500d86d43a6b3171e869984084f20f9}{
\index{errortypes.h@{errortypes.h}!XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}}
\index{XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}!errortypes.h@{errortypes.h}}
\subsubsection[XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS]{\setlength{\rightskip}{0pt plus 5cm}XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS (Network\-Error, Runtime\-Error)}}
\label{errortypes_8h_4500d86d43a6b3171e869984084f20f9}


thrown when there is a communications problem with a remote database. 

\hypertarget{errortypes_8h_c703d279f25f24c9bb80c3b9d19ac3a4}{
\index{errortypes.h@{errortypes.h}!XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}}
\index{XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}!errortypes.h@{errortypes.h}}
\subsubsection[XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS]{\setlength{\rightskip}{0pt plus 5cm}XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS (Feature\-Unavailable\-Error, Runtime\-Error)}}
\label{errortypes_8h_c703d279f25f24c9bb80c3b9d19ac3a4}


Thrown if a feature is unavailable - usually due to not being compiled in. 

\hypertarget{errortypes_8h_9b330d7d9f0e5460bb9a4c1d08532f7c}{
\index{errortypes.h@{errortypes.h}!XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}}
\index{XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}!errortypes.h@{errortypes.h}}
\subsubsection[XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS]{\setlength{\rightskip}{0pt plus 5cm}XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS (Database\-Error, Runtime\-Error)}}
\label{errortypes_8h_9b330d7d9f0e5460bb9a4c1d08532f7c}


thrown for miscellaneous database errors. 

\hypertarget{errortypes_8h_299f315b3d3a9d801ae84fae0ad50563}{
\index{errortypes.h@{errortypes.h}!XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}}
\index{XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}!errortypes.h@{errortypes.h}}
\subsubsection[XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS]{\setlength{\rightskip}{0pt plus 5cm}XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS (Internal\-Error, Runtime\-Error)}}
\label{errortypes_8h_299f315b3d3a9d801ae84fae0ad50563}


thrown when really weird stuff happens. 

If this is thrown something has gone badly wrong. \hypertarget{errortypes_8h_6c70e2b68b3cf954504568a868150824}{
\index{errortypes.h@{errortypes.h}!XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}}
\index{XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}!errortypes.h@{errortypes.h}}
\subsubsection[XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS]{\setlength{\rightskip}{0pt plus 5cm}XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS (Range\-Error, Runtime\-Error)}}
\label{errortypes_8h_6c70e2b68b3cf954504568a868150824}


thrown when an element is out of range. 

\hypertarget{errortypes_8h_6638fc076574a537379d62a284c718b7}{
\index{errortypes.h@{errortypes.h}!XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}}
\index{XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}!errortypes.h@{errortypes.h}}
\subsubsection[XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS]{\setlength{\rightskip}{0pt plus 5cm}XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS (Doc\-Not\-Found\-Error, Runtime\-Error)}}
\label{errortypes_8h_6638fc076574a537379d62a284c718b7}


Thrown when an attempt is made to access a document which is not in the database. 

This could occur either due to a programming error, or because the database has changed since running the query. \hypertarget{errortypes_8h_7d77600f4ba01a42e97e9d970bd2bde5}{
\index{errortypes.h@{errortypes.h}!XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}}
\index{XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}!errortypes.h@{errortypes.h}}
\subsubsection[XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS]{\setlength{\rightskip}{0pt plus 5cm}XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS (Invalid\-Operation\-Error, Logic\-Error)}}
\label{errortypes_8h_7d77600f4ba01a42e97e9d970bd2bde5}


Thrown when API calls are made in an invalid way. 

\hypertarget{errortypes_8h_e6709a02d9d3704eb14d128b42d8585d}{
\index{errortypes.h@{errortypes.h}!XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}}
\index{XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}!errortypes.h@{errortypes.h}}
\subsubsection[XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS]{\setlength{\rightskip}{0pt plus 5cm}XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS (Invalid\-Argument\-Error, Logic\-Error)}}
\label{errortypes_8h_e6709a02d9d3704eb14d128b42d8585d}


Thrown when an invalid argument is supplied to the API. 

\hypertarget{errortypes_8h_5ca81084dd887e75076529b7e90f6657}{
\index{errortypes.h@{errortypes.h}!XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}}
\index{XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}!errortypes.h@{errortypes.h}}
\subsubsection[XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS]{\setlength{\rightskip}{0pt plus 5cm}XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS (Unimplemented\-Error, Logic\-Error)}}
\label{errortypes_8h_5ca81084dd887e75076529b7e90f6657}


Thrown when an attempt to use an unimplemented feature is made. 

\hypertarget{errortypes_8h_a291117c6b9b67d4eff698dcf710af8b}{
\index{errortypes.h@{errortypes.h}!XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}}
\index{XAPIAN_DEFINE_ERROR_CLASS@{XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS}!errortypes.h@{errortypes.h}}
\subsubsection[XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS]{\setlength{\rightskip}{0pt plus 5cm}XAPIAN\_\-DEFINE\_\-ERROR\_\-CLASS (Assertion\-Error, Logic\-Error)}}
\label{errortypes_8h_a291117c6b9b67d4eff698dcf710af8b}


Thrown if an internal consistency check fails. 

This represents a bug in \hyperlink{namespaceXapian}{Xapian}.