Whole document tree

Whole document tree

Berkeley DB: DB->set_dup_compare



#include <db.h>

int DB->set_dup_compare(DB *db, int (*dup_compare_fcn)(DB *, const DBT *, const DBT *));


Set the duplicate data item comparison function. The comparison function is called when it is necessary to compare a data item specified by the application with a data item currently stored in the tree. The first argument to the comparison function is the DBT representing the application's data item, the second is the current tree's data item.

The comparison function must return an integer value less than, equal to, or greater than zero if the first data item argument is considered to be respectively less than, equal to, or greater than the second data item argument. In addition, the comparison function must cause the data items in the set to be well-ordered. The comparison function must correctly handle any data item values used by the application (possibly including zero-length data items). The data and size fields of the DBT are the only fields that may be used for the purposes of this comparison.

If no comparison function is specified, the data items are compared lexically, with shorter data items collating before longer data items. The same duplicate data item comparison method must be used each time a particular Btree is opened.

The DB->set_dup_compare interface may only be used to configure Berkeley DB before the DB->open interface is called.

The DB->set_dup_compare function returns a non-zero error value on failure and 0 on success.


An invalid flag value or parameter was specified.

See Also

db_create, DB->close, DB->cursor, DB->del, DB->err, DB->fd, DB->get, DB->get_byteswapped, DB->get_type, DB->join, DB->key_range, DB->open, DB->put, DB->remove, DB->set_bt_compare, DB->set_bt_minkey, DB->set_bt_prefix, DB->set_cachesize, DB->set_dup_compare, DB->set_errcall, DB->set_errfile, DB->set_errpfx, DB->set_flags, DB->set_h_ffactor, DB->set_h_hash, DB->set_h_nelem, DB->set_lorder, DB->set_malloc, DB->set_pagesize, DB->set_paniccall, DB->set_q_extentsize, DB->set_realloc, DB->set_re_delim, DB->set_re_len, DB->set_re_pad, DB->set_re_source, DB->stat, DB->sync, DB->upgrade and DB->verify.


Copyright Sleepycat Software