summaryrefslogtreecommitdiff
path: root/lib/ldb
diff options
context:
space:
mode:
authorMatthieu Patou <mat@matws.net>2012-12-17 01:45:30 -0800
committerAndrew Bartlett <abartlet@samba.org>2013-02-08 15:06:34 +1100
commit75f422fe1df7dd04aa46d5c77cbeb43d101c3ad6 (patch)
treead5229cf8f02befcc0d56097ce777e79468abc75 /lib/ldb
parent1e4e51f4c913a3821d7ecbd0842280240917ae38 (diff)
downloadsamba-75f422fe1df7dd04aa46d5c77cbeb43d101c3ad6.tar.gz
samba-75f422fe1df7dd04aa46d5c77cbeb43d101c3ad6.tar.bz2
samba-75f422fe1df7dd04aa46d5c77cbeb43d101c3ad6.zip
ldb-tdb: Document ltdb_index_add1 for more clarity
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
Diffstat (limited to 'lib/ldb')
-rw-r--r--lib/ldb/ldb_tdb/ldb_index.c23
1 files changed, 20 insertions, 3 deletions
diff --git a/lib/ldb/ldb_tdb/ldb_index.c b/lib/ldb/ldb_tdb/ldb_index.c
index d79417f442..cf21092426 100644
--- a/lib/ldb/ldb_tdb/ldb_index.c
+++ b/lib/ldb/ldb_tdb/ldb_index.c
@@ -1087,9 +1087,26 @@ int ltdb_search_indexed(struct ltdb_context *ac, uint32_t *match_count)
return ret;
}
-/*
- add an index entry for one message element
-*/
+/**
+ * @brief Add a DN in the index list of a given attribute name/value pair
+ *
+ * This function will add the DN in the index list for the index for
+ * the given attribute name and value.
+ *
+ * @param[in] module A ldb_module structure
+ *
+ * @param[in] dn The string representation of the DN as it
+ * will be stored in the index entry
+ *
+ * @param[in] el A ldb_message_element array, one of the entry
+ * referred by the v_idx is the attribute name and
+ * value pair which will be used to construct the
+ * index name
+ *
+ * @param[in] v_idx The index of element in the el array to use
+ *
+ * @return An ldb error code
+ */
static int ltdb_index_add1(struct ldb_module *module, const char *dn,
struct ldb_message_element *el, int v_idx)
{