diff options
author | Andrew Bartlett <abartlet@samba.org> | 2019-07-04 13:50:22 +1200 |
---|---|---|
committer | Andrew Bartlett <abartlet@samba.org> | 2019-07-04 03:51:58 +0000 |
commit | e513bab96173fa9273d3349afa72c947e186f52a (patch) | |
tree | 20eb74a318e6b7b3b4004df9362d1c63c1766f90 /lib | |
parent | bc48b4b158b9bb76ba82cf30bfc83d707e2dbaf3 (diff) | |
download | samba-e513bab96173fa9273d3349afa72c947e186f52a.tar.gz |
ldb: Try to explain the confusing overload of the LDB_FLG_MOD_* enumeration and other flags
Signed-off-by: Andrew Bartlett <abartlet@samba.org>
Reviewed-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Autobuild-User(master): Andrew Bartlett <abartlet@samba.org>
Autobuild-Date(master): Thu Jul 4 03:51:58 UTC 2019 on sn-devel-184
Diffstat (limited to 'lib')
-rw-r--r-- | lib/ldb/include/ldb.h | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/lib/ldb/include/ldb.h b/lib/ldb/include/ldb.h index 38e76c31605..f06d5e95528 100644 --- a/lib/ldb/include/ldb.h +++ b/lib/ldb/include/ldb.h @@ -104,19 +104,20 @@ struct ldb_dn; /** There are a number of flags that are used with ldap_modify() in ldb_message_element.flags fields. The LDB_FLAG_MOD_ADD, - LDB_FLAG_MOD_DELETE and LDB_FLAG_MOD_REPLACE flags are used in - ldap_modify() calls to specify whether attributes are being added, - deleted or modified respectively. + LDB_FLAG_MOD_DELETE and LDB_FLAG_MOD_REPLACE are better thought of as + an enumeration, not flags, and are used in ldap_modify() calls to + specify whether attributes are being added, deleted or modified + respectively. */ #define LDB_FLAG_MOD_MASK 0x3 /** - use this to extract the mod type from the operation + use this to extract the mod type (enum) from the operation */ #define LDB_FLAG_MOD_TYPE(flags) ((flags) & LDB_FLAG_MOD_MASK) /** - Flag value used in ldap_modify() to indicate that attributes are + Value used in ldap_modify() to indicate that attributes are being added. \sa LDB_FLAG_MOD_MASK @@ -124,7 +125,7 @@ struct ldb_dn; #define LDB_FLAG_MOD_ADD 1 /** - Flag value used in ldap_modify() to indicate that attributes are + Value used in ldap_modify() to indicate that attributes are being replaced. \sa LDB_FLAG_MOD_MASK @@ -132,7 +133,7 @@ struct ldb_dn; #define LDB_FLAG_MOD_REPLACE 2 /** - Flag value used in ldap_modify() to indicate that attributes are + Value used in ldap_modify() to indicate that attributes are being deleted. \sa LDB_FLAG_MOD_MASK @@ -142,6 +143,9 @@ struct ldb_dn; /** Flag value used in ldb_ldif_write_trace() to enforce binary encoded attribute values per attribute. + + This is a genuine flag, being outside LDB_FLAG_MOD_MASK and also + outside LDB_FLAG_INTERNAL_MASK */ #define LDB_FLAG_FORCE_NO_BASE64_LDIF 4 |