The buffers may be shared between processes.
.PP
The function
-.IR mpool_open ()
+.BR mpool_open ()
initializes a memory pool.
The
.I key
sharing the file.
.PP
The
-.IR mpool_filter ()
+.BR mpool_filter ()
function is intended to make transparent input and output processing of the
pages possible.
If the
pointer, the page number and a pointer to the page to being read or written.
.PP
The function
-.IR mpool_new ()
+.BR mpool_new ()
takes an MPOOL pointer and an address as arguments.
If a new page can be allocated, a pointer to the page is returned and
the page number is stored into the
Otherwise, NULL is returned and errno is set.
.PP
The function
-.IR mpool_get ()
+.BR mpool_get ()
takes a MPOOL pointer and a page number as arguments.
If the page exists, a pointer to the page is returned.
Otherwise, NULL is returned and errno is set.
The flags parameter is not currently used.
.PP
The function
-.IR mpool_put ()
+.BR mpool_put ()
unpins the page referenced by
.IR pgaddr .
.I pgaddr
must be an address previously returned by
-.IR mpool_get ()
+.BR mpool_get ()
or
-.IR mpool_new ().
+.BR mpool_new ().
The flag value is specified by
.IR or 'ing
any of the following values:
MPOOL_DIRTY
The page has been modified and needs to be written to the backing file.
.PP
-.IR mpool_put ()
+.BR mpool_put ()
returns 0 on success and \-1 if an error occurs.
.PP
The function
-.IR mpool_sync ()
+.BR mpool_sync ()
writes all modified pages associated with the MPOOL pointer to the
backing file.
-.IR mpool_sync ()
+.BR mpool_sync ()
returns 0 on success and \-1 if an error occurs.
.PP
The
-.IR mpool_close ()
+.BR mpool_close ()
function free's up any allocated memory associated with the memory pool
cookie.
Modified pages are
.B not
written to the backing file.
-.IR mpool_close ()
+.BR mpool_close ()
returns 0 on success and \-1 if an error occurs.
.SH ERRORS
The
-.IR mpool_open ()
+.BR mpool_open ()
function may fail and set
.I errno
for any of the errors specified for the library routine
-.IR malloc (3).
+.BR malloc (3).
.PP
The
-.IR mpool_get ()
+.BR mpool_get ()
function may fail and set
.I errno
for the following:
The requested record doesn't exist.
.PP
The
-.IR mpool_new ()
+.BR mpool_new ()
and
-.IR mpool_get ()
+.BR mpool_get ()
functions may fail and set
.I errno
for any of the errors specified for the library routines
-.IR read (2) ,
-.IR write (2) ,
+.BR read (2) ,
+.BR write (2) ,
and
-.IR malloc (3).
+.BR malloc (3).
.PP
The
-.IR mpool_sync ()
+.BR mpool_sync ()
function may fail and set
.I errno
for any of the errors specified for the library routine
-.IR write (2).
+.BR write (2).
.PP
The
-.IR mpool_close ()
+.BR mpool_close ()
function may fail and set
.I errno
for any of the errors specified for the library routine
-.IR free (3).
+.BR free (3).
.SH "SEE ALSO"
-.IR dbopen (3),
-.IR btree (3),
-.IR hash (3),
-.IR recno (3)
+.BR dbopen (3),
+.BR btree (3),
+.BR hash (3),
+.BR recno (3)