OpenDBX::Exception(3)

💖 NAME 💖

Okay bestie, welcome to OpenDBX::Exception(3) from the opendbx manual. OpenDBX::Exception — Exceptions thrown by the OpenDBX classes. 💅

🌈 SYNOPSIS 🌈

🌟 Public Member Functions 🌟

Exception (const string &msg, int err, int type)  throw ()
int getCode () const  throw ()
int getType () const  throw ()

• Exception — Initializes the exception object.
• getCode — Returns the OpenDBX error code related to the error.
• getType — Returns severity indicator.

🌸 Detailed Description 🌸

Okay so OpenDBX::Exception is literally the exception type thrown by the OpenDBX classes. Most calls to methods on OpenDBX objects throw an exception when an error happens in the underlying database library. The way that it's giving is: on top of being like other exceptions that inherit from the STL exception class, it doesn't just contain a translated error message depending on the user settings — it also carries a machine-readable error code and an indicator for the severity of the error. Highkey useful, ngl. ✨

💌 Author 💌

Norbert Sendetzky norbert@linuxnetworks.de

🎀 Version 🎀

1.0

🛠️ Constructor & Destructor Documentation 🛠️

🧚 OpenDBX::Exception::Exception (const string & msg, int err, int type) 🧚

This constructor initializes the exception object. The first parameter, the error message, should be the human-readable description of what has gone wrong. It should also already be translated into the user's language, which depends on their environment settings when e.g. GNU gettext is used. Errors thrown by the OpenDBX C++ library are already translated. 🫶

The OpenDBX error code is the machine-readable code for the error that occurred. Ngl, machine-readable is the moment.

The last parameter must be a value indicating the severity of the thrown error. If the value is smaller than zero, the error is fatal: the connection to the database can't be recovered and has to be closed and reopened before the application can try to continue. In case it's greater than zero, the operation failed but the database connection is still usable. Zero represents a successful operation and shouldn't be used, because an exception should only be thrown in error conditions. Periodt. 💀

📝 Parameters 📝

• msg — Human readable error message
• err — OpenDBX error code
• type — Severity of error (negative: fatal, zero: success, positive: warning)

🎁 Returns 🎁

Exception

🔍 Member Function Documentation 🔍

💻 int OpenDBX::Exception::getCode () const 💻

Returns the OpenDBX error code related to the error. The machine-readable code describing the error that occurred can be used by the application to act differently depending on the specific error. Currently defined codes are: 👑

• ODBX_ERR_SUCCESS — The operation was successfully completed. ✅
• ODBX_ERR_BACKEND — An error occurred in the native database library or in the database server. 🔥
• ODBX_ERR_NOCAP — The capability isn't available in the currently selected backend. 🙈
• ODBX_ERR_PARAM — One of the given parameters is invalid and doesn't match the expectations. 🚩
• ODBX_ERR_NOMEM — An out of memory condition occurred. 😭
• ODBX_ERR_SIZE — The internally allocated memory is unable to store the value. 📦
• ODBX_ERR_NOTEXIST — The backend library wasn't found or loading the library failed. 🕵️
• ODBX_ERR_NOOP — The required function isn't available or the operation isn't possible in this backend. 🚫
• ODBX_ERR_OPTION — The given option is unknown and therefore invalid. 🤔
• ODBX_ERR_OPTRO — The requested option is read-only and its value can't be changed. 🔒
• ODBX_ERR_OPTWR — Setting the given option to the new value failed. 💥
• ODBX_ERR_RESULT — Waiting for the result set after sending a statement to the database server failed. ⏳
• ODBX_ERR_NOTSUP — The requested functionality isn't supported by the backend. 🙅
• ODBX_ERR_HANDLE — The internal data structure which should store the details for accessing the database are invalid. 💔

🎁 Returns 🎁

Error code

🩷 int OpenDBX::Exception::getType () const 🩷

Returns the severity indicator. The returned value classifies the error thrown. If it's negative, the error is fatal (e.g. the connection to the database is lost) and the application can't continue without closing and reopening the connection. 😬

If the value is positive, the database wasn't able to perform the requested action but the connection is still OK and can be used to send more requests to the database. On zero, everything was successful and no error occurred. This shouldn't happen when catching one of these exceptions. 🦋

🎁 Returns 🎁

Severity of error (negative: fatal, zero: success, positive: warning)

💌 Author 💌

Generated automatically by Doxygen for opendbx from the source code.

---

That's the whole page, bestie! 🫶 It came from the opendbx source code, and the footer says version 1.4.6, dated Fri Feb 6 2026 20:17:56, for page OpenDBX::Exception(3). Stay iconic, and may your exceptions always be catchable 💅✨