include/ldb_errors.h(3)

💖 NAME 💖

include/ldb_errors.h — bestie, this header is literally the vibe-checker for LDB function calls: it hands you a whole set of result codes so you know what went down. ✨

---

🦋 SYNOPSIS 🦋

✨ Macros ✨

• #define LDB_SUCCESS 0 — the function call ate and left no crumbs. It worked. 💅
• #define LDB_ERR_OPERATIONS_ERROR 1 — the call flopped for some non-specific reason. No details, just vibes. 😭
• #define LDB_ERR_PROTOCOL_ERROR 2 — the call failed because of a protocol violation. Rude behaviour, honestly.
• #define LDB_ERR_TIME_LIMIT_EXCEEDED 3 — the call failed because a time limit was exceeded. Clocked out, bestie. ⏰
• #define LDB_ERR_SIZE_LIMIT_EXCEEDED 4 — the call failed because a size limit was exceeded. Too much, too big. 🫶
• #define LDB_ERR_COMPARE_FALSE 5 — the function was for value comparison, and the comparison operation returned false.
• #define LDB_ERR_COMPARE_TRUE 6 — the function was for value comparison, and the comparison operation returned true.
• #define LDB_ERR_AUTH_METHOD_NOT_SUPPORTED 7 — the function used an authentication method that is not supported by the database. The database said "not my type". 💀
• #define LDB_ERR_STRONG_AUTH_REQUIRED 8 — the call required an underlying operation that required strong authentication. Bring your strongest self. 💪
• #define LDB_ERR_REFERRAL 10 — the function resulted in a referral to another server. It's giving "ask my friend instead". ➡️
• #define LDB_ERR_ADMIN_LIMIT_EXCEEDED 11 — the function failed because an administrative / policy limit was exceeded. The admin said no. 🚫
• #define LDB_ERR_UNSUPPORTED_CRITICAL_EXTENSION 12 — the function required an extension or capability that the database cannot provide. Not in her skill set, sorry. 🙈
• #define LDB_ERR_CONFIDENTIALITY_REQUIRED 13 — the function involved a transaction or database operation that could not be performed without a secure link. No secure link, no business. 🔒
• #define LDB_ERR_SASL_BIND_IN_PROGRESS 14 — this is an intermediate result code for SASL bind operations that have more than one step. Mid-transformation, hold on. ✨
• #define LDB_ERR_NO_SUCH_ATTRIBUTE 16 — the function referred to an attribute type that is not present in the entry. She's not here. 💀
• #define LDB_ERR_UNDEFINED_ATTRIBUTE_TYPE 17 — the function referred to an attribute type that is invalid.
• #define LDB_ERR_INAPPROPRIATE_MATCHING 18 — the function required a filter type that is not available for the specified attribute. Wrong filter for this attribute, incompatible fr fr. 💔
• #define LDB_ERR_CONSTRAINT_VIOLATION 19 — the function would have violated an attribute constraint. Rules are rules, bestie. 🎀
• #define LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS 20 — the function involved an attribute type or attribute value that already exists in the entry. Already on the guest list. 👑
• #define LDB_ERR_INVALID_ATTRIBUTE_SYNTAX 21 — the function used an invalid (incorrect syntax) attribute value. Typo era. 😭
• #define LDB_ERR_NO_SUCH_OBJECT 32 — the function referred to an object that does not exist in the database. Ghosted by the object. 👻
• #define LDB_ERR_ALIAS_PROBLEM 33 — the function referred to an alias which points to a non-existent object in the database. The alias is pointing at absolutely nothing.
• #define LDB_ERR_INVALID_DN_SYNTAX 34 — the function used a DN which was invalid (incorrect syntax). That DN is not DN-ing. 🚩
• #define LDB_ERR_ALIAS_DEREFERENCING_PROBLEM 36 — the function required dereferencing of an alias, and something went wrong during the dereferencing process. The dereference arc had a plot twist. 😵
• #define LDB_ERR_INAPPROPRIATE_AUTHENTICATION 48 — the function passed in the wrong authentication method.
• #define LDB_ERR_INVALID_CREDENTIALS 49 — the function passed in or referenced incorrect credentials during authentication. Wrong password bestie, we've all been there. 🙈
• #define LDB_ERR_INSUFFICIENT_ACCESS_RIGHTS 50 — the function required access permissions that the user does not possess. This user does not have the range. 💅
• #define LDB_ERR_BUSY 51 — the function required a transaction or call that the database could not perform because it is busy. She's booked and busy, main character energy. 🔥
• #define LDB_ERR_UNAVAILABLE 52 — the function required a transaction or call to a database that is not available. Out of office. 🌴
• #define LDB_ERR_UNWILLING_TO_PERFORM 53 — the function required a transaction or call to a database that the database declined to perform. She simply said no. 💅
• #define LDB_ERR_LOOP_DETECT 54 — the function failed because it resulted in a loop being detected. Going in circles is not the vibe. 🌀
• #define LDB_ERR_NAMING_VIOLATION 64 — the function failed because it would have violated a naming rule.
• #define LDB_ERR_OBJECT_CLASS_VIOLATION 65 — the function failed because it would have violated the schema.
• #define LDB_ERR_NOT_ALLOWED_ON_NON_LEAF 66 — the function required an operation that is only allowed on leaf objects, but the object is not a leaf. Only leaves get this treatment. 🍃
• #define LDB_ERR_NOT_ALLOWED_ON_RDN 67 — the function required an operation that cannot be performed on a Relative DN, but the object is a Relative DN. Not allowed on a Relative DN, periodt.
• #define LDB_ERR_ENTRY_ALREADY_EXISTS 68 — the function failed because the entry already exists. She's already here, babe. ✨
• #define LDB_ERR_OBJECT_CLASS_MODS_PROHIBITED 69 — the function failed because modifications to an object class are not allowable. No edits, no notes. 🚫
• #define LDB_ERR_AFFECTS_MULTIPLE_DSAS 71 — the function failed because it needed to be applied to multiple databases. It's giving "this affects everyone", messy. 😭
• #define LDB_ERR_OTHER 80 — the function failed for unknown reasons. Mystery era. 🔮

---

🎀 Detailed Description 🎀

This header provides a set of result codes for LDB function calls.

Many LDB function calls return an integer value (int). As shown in the function documentation, those return values may indicate whether the function call worked correctly (in which case it returns LDB_SUCCESS) or some problem occurred (in which case some other value will be returned). As a special case, LDB_ERR_COMPARE_FALSE or LDB_ERR_COMPARE_TRUE may be returned, which does not indicate an error. So don't panic, those two are just reporting the comparison result. 🫶

💜 Note 💜

Not all error codes make sense for LDB, however they are based on the LDAP error codes, and are kept for reference and to avoid overlap. iykyk.

Some of this documentation is based on information in the OpenLDAP documentation, as developed and maintained by the The OpenLDAP Project. Credit where credit is due, we love a documented source. 💖

---

✨ Macro Definition Documentation ✨

okay so these are all the #define result codes LDB can throw at you, bestie — every single one is here, no skipping, fr fr. if a function returns one of these, this is the tea ☕💅

• #define LDB_ERR_ADMIN_LIMIT_EXCEEDED 11 — the function failed because an administrative or policy limit was exceeded. 💀
• #define LDB_ERR_AFFECTS_MULTIPLE_DSAS 71 — the function failed because it needed to be applied to multiple databases. 🗂️
• #define LDB_ERR_ALIAS_DEREFERENCING_PROBLEM 36 — the function needed to dereference an alias, and something went wrong during the dereferencing process. 😭
• #define LDB_ERR_ALIAS_PROBLEM 33 — the function referred to an alias that points to a non-existent object in the database. 👻
• #define LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS 20 — the function involved an attribute type or attribute value that already exists in the entry. ✨
• #define LDB_ERR_AUTH_METHOD_NOT_SUPPORTED 7 — the function used an authentication method that is not supported by the database. 🚫
• #define LDB_ERR_BUSY 51 — the function required a transaction or call that the database could not perform because it is busy. 🐝
• #define LDB_ERR_COMPARE_FALSE 5 — the function was for value comparison, and the comparison operation returned false. ❌

Note: this is a status value, and it doesn't normally indicate an error. 🫶

• #define LDB_ERR_COMPARE_TRUE 6 — the function was for value comparison, and the comparison operation returned true. ✅

Note: this is a status value, and it doesn't normally indicate an error. 🫶

• #define LDB_ERR_CONFIDENTIALITY_REQUIRED 13 — the function involved a transaction or database operation that could not be performed without a secure link. 🔐
• #define LDB_ERR_CONSTRAINT_VIOLATION 19 — the function would have violated an attribute constraint. 🚧
• #define LDB_ERR_ENTRY_ALREADY_EXISTS 68 — the function failed because the entry already exists. 📦
• #define LDB_ERR_INAPPROPRIATE_AUTHENTICATION 48 — the function passed in the wrong authentication method. 🙈
• #define LDB_ERR_INAPPROPRIATE_MATCHING 18 — the function required a filter type that is not available for the specified attribute. 🔍
• #define LDB_ERR_INSUFFICIENT_ACCESS_RIGHTS 50 — the function required access permissions that the user does not possess. 🚪
• #define LDB_ERR_INVALID_ATTRIBUTE_SYNTAX 21 — the function used an invalid attribute value — incorrect syntax, bestie. 🤨
• #define LDB_ERR_INVALID_CREDENTIALS 49 — the function passed in or referenced incorrect credentials during authentication. 🔑
• #define LDB_ERR_INVALID_DN_SYNTAX 34 — the function used a DN which was invalid — incorrect syntax. 📛
• #define LDB_ERR_LOOP_DETECT 54 — the function failed because it resulted in a loop being detected. 🔁
• #define LDB_ERR_NAMING_VIOLATION 64 — the function failed because it would have violated a naming rule. 🏷️
• #define LDB_ERR_NO_SUCH_ATTRIBUTE 16 — the function referred to an attribute type that is not present in the entry. 🫥
• #define LDB_ERR_NO_SUCH_OBJECT 32 — the function referred to an object that does not exist in the database. 🕳️
• #define LDB_ERR_NOT_ALLOWED_ON_NON_LEAF 66 — the function required an operation that is only allowed on leaf objects, but the object is not a leaf. 🍃
• #define LDB_ERR_NOT_ALLOWED_ON_RDN 67 — the function required an operation that cannot be performed on a Relative DN, but the object is a Relative DN. 🌿
• #define LDB_ERR_OBJECT_CLASS_MODS_PROHIBITED 69 — the function failed because modifications to an object class are not allowable. 🚫
• #define LDB_ERR_OBJECT_CLASS_VIOLATION 65 — the function failed because it would have violated the schema. 📜
• #define LDB_ERR_OPERATIONS_ERROR 1 — the function call failed for some non-specific reason. ❓
• #define LDB_ERR_OTHER 80 — the function failed for unknown reasons. 🤷
• #define LDB_ERR_PROTOCOL_ERROR 2 — the function call failed because of a protocol violation. 📡
• #define LDB_ERR_REFERRAL 10 — the function resulted in a referral to another server. 📬
• #define LDB_ERR_SASL_BIND_IN_PROGRESS 14 — this is an intermediate result code for SASL bind operations that have more than one step. ⏳

Note: this is a result code that does not normally indicate an error has occurred. 💖

• #define LDB_ERR_SIZE_LIMIT_EXCEEDED 4 — the function call failed because a size limit was exceeded. 📏
• #define LDB_ERR_STRONG_AUTH_REQUIRED 8 — the function call required an underlying operation that required strong authentication. This will normally only occur if you are using LDB with a LDAP backend. 🛡️
• #define LDB_ERR_TIME_LIMIT_EXCEEDED 3 — the function call failed because a time limit was exceeded. ⏰
• #define LDB_ERR_UNAVAILABLE 52 — the function required a transaction or call to a database that is not available. 📴
• #define LDB_ERR_UNDEFINED_ATTRIBUTE_TYPE 17 — the function referred to an attribute type that is invalid. 🧐
• #define LDB_ERR_UNSUPPORTED_CRITICAL_EXTENSION 12 — the function required an extension or capability that the database cannot provide. 🧩
• #define LDB_ERR_UNWILLING_TO_PERFORM 53 — the function required a transaction or call to a database that the database declined to perform. 🙅
• #define LDB_SUCCESS 0 — the function call succeeded. If a function returns LDB_SUCCESS, then that function, and the underlying transactions that may have been required, completed successfully. 🎉
  • Examples: ldbreader.c. 📖

🌟 Author 🌟

Generated automatically by Doxygen for LDB from the source code. 🤖

---

okay bestie, that's the whole list 💖 source/version: LDB — page: include/ldb_errors.h(3) — the footer didn't show a date, so no date to spill, but the vibes are immaculate. 🫶