# include/xapian/errortypes.h File Reference

Exception subclasses. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Functions

| XAPIAN_DEFINE_ERROR_BASECLASS (LogicError, Error)
| Base class for errors due to programming errors.
| XAPIAN_DEFINE_ERROR_BASECLASS (RuntimeError, Error)
| Base class for errors due to run time problems.
| XAPIAN_DEFINE_ERROR_CLASS (AssertionError, LogicError)
| Thrown if an internal consistency check fails.
| XAPIAN_DEFINE_ERROR_CLASS (UnimplementedError, LogicError)
| Thrown when an attempt to use an unimplemented feature is made.
| XAPIAN_DEFINE_ERROR_CLASS (InvalidArgumentError, LogicError)
| Thrown when an invalid argument is supplied to the API.
| XAPIAN_DEFINE_ERROR_CLASS (InvalidOperationError, LogicError)
| Thrown when API calls are made in an invalid way.
| XAPIAN_DEFINE_ERROR_CLASS (DocNotFoundError, RuntimeError)
| Thrown when an attempt is made to access a document which is not in the database.
| XAPIAN_DEFINE_ERROR_CLASS (RangeError, RuntimeError)
| thrown when an element is out of range.
| XAPIAN_DEFINE_ERROR_CLASS (InternalError, RuntimeError)
| thrown when really weird stuff happens.
| XAPIAN_DEFINE_ERROR_CLASS (DatabaseError, RuntimeError)
| thrown for miscellaneous database errors.
| XAPIAN_DEFINE_ERROR_CLASS (FeatureUnavailableError, RuntimeError)
| Thrown if a feature is unavailable - usually due to not being compiled in.
| XAPIAN_DEFINE_ERROR_CLASS (NetworkError, RuntimeError)
| thrown when there is a communications problem with a remote database.
| XAPIAN_DEFINE_ERROR_CLASS (NetworkTimeoutError, NetworkError)
| Thrown when a network timeout is exceeded.
| XAPIAN_DEFINE_ERROR_CLASS (DatabaseCorruptError, DatabaseError)
| thrown if the database is corrupt.
| XAPIAN_DEFINE_ERROR_CLASS (DatabaseCreateError, DatabaseError)
| Thrown when creating a database fails.
| XAPIAN_DEFINE_ERROR_CLASS (DatabaseOpeningError, DatabaseError)
| Thrown when opening a database fails.
| XAPIAN_DEFINE_ERROR_CLASS (DatabaseLockError, DatabaseError)
| Thrown when gaining a lock on a database fails.
| XAPIAN_DEFINE_ERROR_CLASS (DatabaseModifiedError, DatabaseError)
| Thrown when a database has been modified whilst being read.

## Detailed Description

Exception subclasses.

## Function Documentation

XAPIAN_DEFINE_ERROR_BASECLASS | ( | RuntimeError | ,
|  | Error |
| ) |

| Base class for errors due to run time problems. An exception derived from RuntimeError is thrown when an error is caused by problems with the data or environment rather than a programming mistake.

XAPIAN_DEFINE_ERROR_BASECLASS | ( | LogicError | ,
|  | Error |
| ) |

| Base class for errors due to programming errors. An exception derived from LogicError is thrown when a misuse of the API is detected.

XAPIAN_DEFINE_ERROR_CLASS | ( | DatabaseModifiedError | ,
|  | DatabaseError |
| ) |

| Thrown when a database has been modified whilst being read.

XAPIAN_DEFINE_ERROR_CLASS | ( | DatabaseLockError | ,
|  | DatabaseError |
| ) |

| Thrown when gaining a lock on a database fails.

XAPIAN_DEFINE_ERROR_CLASS | ( | DatabaseOpeningError | ,
|  | DatabaseError |
| ) |

| Thrown when opening a database fails.

XAPIAN_DEFINE_ERROR_CLASS | ( | DatabaseCreateError | ,
|  | DatabaseError |
| ) |

| Thrown when creating a database fails.

XAPIAN_DEFINE_ERROR_CLASS | ( | DatabaseCorruptError | ,
|  | DatabaseError |
| ) |

| thrown if the database is corrupt.

XAPIAN_DEFINE_ERROR_CLASS | ( | NetworkTimeoutError | ,
|  | NetworkError |
| ) |

| Thrown when a network timeout is exceeded.

XAPIAN_DEFINE_ERROR_CLASS | ( | NetworkError | ,
|  | RuntimeError |
| ) |

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

XAPIAN_DEFINE_ERROR_CLASS | ( | FeatureUnavailableError | ,
|  | RuntimeError |
| ) |

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

XAPIAN_DEFINE_ERROR_CLASS | ( | DatabaseError | ,
|  | RuntimeError |
| ) |

| thrown for miscellaneous database errors.

XAPIAN_DEFINE_ERROR_CLASS | ( | InternalError | ,
|  | RuntimeError |
| ) |

| thrown when really weird stuff happens. If this is thrown something has gone badly wrong.

XAPIAN_DEFINE_ERROR_CLASS | ( | RangeError | ,
|  | RuntimeError |
| ) |

| thrown when an element is out of range.

XAPIAN_DEFINE_ERROR_CLASS | ( | DocNotFoundError | ,
|  | RuntimeError |
| ) |

| 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.

XAPIAN_DEFINE_ERROR_CLASS | ( | InvalidOperationError | ,
|  | LogicError |
| ) |

| Thrown when API calls are made in an invalid way.

XAPIAN_DEFINE_ERROR_CLASS | ( | InvalidArgumentError | ,
|  | LogicError |
| ) |

| Thrown when an invalid argument is supplied to the API.

XAPIAN_DEFINE_ERROR_CLASS | ( | UnimplementedError | ,
|  | LogicError |
| ) |

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

XAPIAN_DEFINE_ERROR_CLASS | ( | AssertionError | ,
|  | LogicError |
| ) |

| Thrown if an internal consistency check fails. This represents a bug in Xapian.