Library Version 18.1.40

DbMpoolFile::set_pgcookie()
Prev | Chapter 9. The DbMpoolFile Handle | Next

## DbMpoolFile::set_pgcookie()

    #include <db_cxx.h>

    int
    DbMpoolFile::set_pgcookie(DBT *pgcookie);

The `DbMpoolFile::set_pgcookie()` method specifies a byte string that is provided to the functions registered to do input or output processing of the file's pages as they are read from or written to, the backing filesystem store. (See the DbEnv::memp_register() documentation for more information.)

The `DbMpoolFile::set_pgcookie()` method configures a file in the cache, not only operations performed using the specified DbMpoolFile handle.

The `DbMpoolFile::set_pgcookie()` method may not be called after the DbMpoolFile::open() method is called. If the file is already open in the cache when DbMpoolFile::open() is called, the information specified to `DbMpoolFile::set_pgcookie()` will replace the existing information.

The `DbMpoolFile::set_pgcookie()` 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

#### pgcookie

The pgcookie parameter is a byte string provided to the functions registered to do input or output processing of the file's pages.

### Class

DbEnv, DbMpoolFile

### See Also

Memory Pools and Related Methods

Prev | Up | Next
DbMpoolFile::set_maxsize() | Home | DbMpoolFile::set_priority()