Edit File - File Manager

Edit File: db_set_re_delim.html

<html>
<head>
<title>Berkeley DB: Db::set_re_delim</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>
Db::set_re_delim
</td>
<td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a>
<a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<pre>
#include &lt;db_cxx.h&gt;

int
Db::set_re_delim(int re_delim);

int
Db::get_re_delim(int *delimp);
</pre>
<hr size=1 noshade>
Description: Db::set_re_delim
Set the delimiting byte used to mark the end of a record in the backing
source file for the Recno access method.
This byte is used for variable length records if the re_source
file is specified. If the re_source file is specified and no
delimiting byte was specified, &lt;newline&gt; characters (that
is, ASCII 0x0a) are interpreted as end-of-record markers.
The Db::set_re_delim method configures a database, not only operations performed
using the specified <a href="../../db4-devel-4.7.25/api_cxx/db_class.html">Db</a> handle.
The Db::set_re_delim method may not be called after the <a href="../../db4-devel-4.7.25/api_cxx/db_open.html">Db::open</a> method is called.
If the database already exists when
<a href="../../db4-devel-4.7.25/api_cxx/db_open.html">Db::open</a> is called, the information specified to Db::set_re_delim will
be ignored.

The Db::set_re_delim 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 
 re_delim<ul compact><li>The re_delim parameter is the delimiting byte used to mark the
end of a record.</ul>
 
 Errors
The Db::set_re_delim method
may fail and throw
<a href="../../db4-devel-4.7.25/api_cxx/except_class.html">DbException</a>,
encapsulating one of the following non-zero errors, or return one of
the following non-zero errors:
 
EINVAL<ul compact><li>If the method was called after <a href="../../db4-devel-4.7.25/api_cxx/db_open.html">Db::open</a> was called; or if an
invalid flag value or parameter was specified.</ul>
 
<hr size=1 noshade>
Description: Db::get_re_delim
The Db::get_re_delim method returns the delimiting byte.
The Db::get_re_delim method may be called at any time during the life of the
application.
The Db::get_re_delim 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 
 delimp<ul compact><li>The Db::get_re_delim method returns the
delimiting byte in delimp.</ul>
 
<hr size=1 noshade>
 Class
<a href="../../db4-devel-4.7.25/api_cxx/db_class.html">Db</a>
 See Also
<a href="../../db4-devel-4.7.25/api_cxx/db_list.html">Databases and Related Methods</a>
</tt>
<table width="100%"><tr><td> </td><td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a><a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
Copyright (c) 1996,2008 Oracle. All rights reserved.
</body>
</html>

Back to File Manager