db_set_re_pad.html [plain text]
<!--$Id: db_set_re_pad.so,v 10.37 2004/09/28 15:04:19 bostic Exp $-->
<!--Copyright (c) 1997,2008 Oracle. All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: Db::set_re_pad</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
<b>Db::set_re_pad</b>
</td>
<td align=right>
<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a>
<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<b><pre>
#include <db_cxx.h>
<p>
int
Db::set_re_pad(int re_pad);
<p>
int
Db::get_re_pad(int *re_padp);
</pre></b>
<hr size=1 noshade>
<b>Description: Db::set_re_pad</b>
<p>Set the padding character for short, fixed-length records for the Queue
and Recno access methods.</p>
<p>If no pad character is specified, <space> characters (that
is, ASCII 0x20) are used for padding.</p>
<p>The Db::set_re_pad method configures a database, not only operations performed
using the specified <a href="../api_cxx/db_class.html">Db</a> handle.</p>
<p>The Db::set_re_pad method may not be called after the <a href="../api_cxx/db_open.html">Db::open</a> method is called.
If the database already exists when
<a href="../api_cxx/db_open.html">Db::open</a> is called, the information specified to Db::set_re_pad will
be ignored.
</p>
<p>The Db::set_re_pad 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.
</p>
<b>Parameters</b> <br>
<b>re_pad</b><ul compact><li>The <b>re_pad</b> parameter is the pad character for fixed-length
records for the Queue and Recno access methods.</ul>
<br>
<br><b>Errors</b>
<p>The Db::set_re_pad method
may fail and throw
<a href="../api_cxx/except_class.html">DbException</a>,
encapsulating one of the following non-zero errors, or return one of
the following non-zero errors:</p>
<br>
<b>EINVAL</b><ul compact><li>If the method was called after <a href="../api_cxx/db_open.html">Db::open</a> was called; or if an
invalid flag value or parameter was specified.</ul>
<br>
<hr size=1 noshade>
<b>Description: Db::get_re_pad</b>
<p>The Db::get_re_pad method returns the pad character.</p>
<p>The Db::get_re_pad method may be called at any time during the life of the
application.</p>
<p>The Db::get_re_pad 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.
</p>
<b>Parameters</b> <br>
<b>re_padp</b><ul compact><li>The Db::get_re_pad method returns the
pad character in <b>re_padp</b>.</ul>
<br>
<hr size=1 noshade>
<br><b>Class</b>
<a href="../api_cxx/db_class.html">Db</a>
<br><b>See Also</b>
<a href="../api_cxx/db_list.html">Databases and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font>
</body>
</html>