<!--$Id: db_set_append_recno.so,v 1.22 2003/11/19 04:10:38 bostic Exp $--> <!--Copyright 1997-2003 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB->set_append_recno</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> <meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> </head> <body bgcolor=white> <a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3>DB->set_append_recno</h3> </td> <td align=right> <a href="../../db42-devel-4.2.52/api_c/api_index.html"><img src="../../db42-4.2.52/images/api.gif" alt="API"></a> <a href="../../db42-devel-4.2.52/ref/toc.html"><img src="../../db42-4.2.52/images/ref.gif" alt="Ref"></a> </td></tr></table> <hr size=1 noshade> <tt> <h3><pre> #include <db.h> <p> int DB->set_append_recno(DB *, int (*db_append_recno_fcn)(DB *dbp, DBT *data, db_recno_t recno)); </pre></h3> <hr size=1 noshade> <h3>Description: DB->set_append_recno</h3> <p>When using the <a href="../../db42-devel-4.2.52/api_c/db_put.html#DB_APPEND">DB_APPEND</a> option of the <a href="../../db42-devel-4.2.52/api_c/db_put.html">DB->put</a> method, it may be useful to modify the stored data based on the generated key. If a callback function is specified using the DB->set_append_recno method, it will be called after the record number has been selected, but before the data has been stored.</p> <p>The DB->set_append_recno method configures operations performed using the specified <a href="../../db42-devel-4.2.52/api_c/db_class.html">DB</a> handle, not all operations performed on the underlying database.</p> <p>The DB->set_append_recno method may not be called after the <a href="../../db42-devel-4.2.52/api_c/db_open.html">DB->open</a> method is called. </p> <p>The DB->set_append_recno method returns a non-zero error value on failure and 0 on success. </p> <h3>Parameters</h3> <p><dl compact> <p><dt><b>db_append_recno_fcn</b><dd> The <b>db_append_recno_fcn</b> parameter is a function to call after the record number has been selected but before the data has been stored into the database. The function takes three parameters: <p><dl compact> <p><dt><b>db</b><dd>The <b>db</b> parameter is the enclosing database handle. <p><dt><b>dbt</b><dd>The <b>dbt</b> parameter is the data <a href="../../db42-devel-4.2.52/api_c/dbt_class.html">DBT</a> to be stored. <p><dt><b>recno</b><dd>The <b>recno</b> parameter is the generated record number. </dl> <p>The called function may modify the data <a href="../../db42-devel-4.2.52/api_c/dbt_class.html">DBT</a>. If the function needs to allocate memory for the <b>data</b> field, the <b>flags</b> field of the returned <a href="../../db42-devel-4.2.52/api_c/dbt_class.html">DBT</a> should be set to DB_DBT_APPMALLOC, which indicates that Berkeley DB should free the memory when it is done with it.</p> <p>The callback function must return 0 on success and <b>errno</b> or a value outside of the Berkeley DB error name space on failure.</p> </dl> <h3>Errors</h3> <p>The DB->set_append_recno method may fail and return one of the following non-zero errors:</p> <p><dl compact> <p><dt>EINVAL<dd>If the method was called after <a href="../../db42-devel-4.2.52/api_c/db_open.html">DB->open</a> was called; or if an invalid flag value or parameter was specified. </dl> <hr size=1 noshade> <h3>Class</h3> <a href="../../db42-devel-4.2.52/api_c/db_class.html">DB</a> <h3>See Also</h3> <a href="../../db42-devel-4.2.52/api_c/db_list.html">Databases and Related Methods</a> </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../../db42-devel-4.2.52/api_c/api_index.html"><img src="../../db42-4.2.52/images/api.gif" alt="API"></a><a href="../../db42-devel-4.2.52/ref/toc.html"><img src="../../db42-4.2.52/images/ref.gif" alt="Ref"></a> </td></tr></table> <p><font size=1><a href="../../db42-devel-4.2.52/sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html>