DB->set_re_len()

#include <db.h>

int
DB->set_re_len(DB *db, u_int32_t re_len);  

For the Queue access method, specify that the records are of length re_len. For the Queue access method, the record length must be enough smaller than the database's page size that at least one record plus the database page's metadata information can fit on each database page.

For the Recno access method, specify that the records are fixed-length, not byte-delimited, and are of length re_len.

Any records added to the database that are less than re_len bytes long are automatically padded (see DB->set_re_pad() for more information).

Any attempt to insert records into the database that are greater than re_len bytes long will cause the call to fail immediately and return an error.

The DB->set_re_len() method configures a database, not only operations performed using the specified DB handle.

The DB->set_re_len() method may not be called after the DB->open() method is called. If the database already exists when DB->open() is called, the information specified to DB->set_re_len() will be ignored.

The DB->set_re_len() method returns a non-zero error value on failure and 0 on success.

Parameters

re_len

The re_len parameter is the length of a Queue or Recno database record, in bytes.

Errors

The DB->set_re_len() method may fail and return one of the following non-zero errors:

EINVAL

If the method was called after DB->open() was called; or if an invalid flag value or parameter was specified.

Class

DB

See Also

Database and Related Methods