Db::set_heap_regionsize()

#include <db_cxx.h>
 
int
Db::set_heap_regionsize(u_int32_t npages); 

Sets the number of pages in a region of a database configured to use the Heap access method. If this method is never called, the default region size for the database's page size will be used. You can set the database page size using the Db::set_pagesize() method.

The Db::set_heap_regionsize() 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_heap_regionsize() will be ignored. If the specified region size is larger than the maximum region size for the database's page size, an error will be returned when Db::open() is called. The maximum allowable region size will be included in the error message.

The Db::set_heap_regionsize() method either returns a non-zero error value or throws an exception that encapsulates a non-zero error value on failure, and returns 0 on success.

Parameters

npages

The npages parameter is the number of pages in a Heap database region.

Errors

The Db::set_heap_regionsize() method may fail and throw a DbException exception, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:

EINVAL

If the specified region size was too small; 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, Db::get_heap_regionsize()