1<!--$Id: db_set_re_delim.so,v 10.39 2004/09/28 15:04:19 bostic Exp $--> 2<!--Copyright (c) 1997,2008 Oracle. All rights reserved.--> 3<!--See the file LICENSE for redistribution information.--> 4<html> 5<head> 6<title>Berkeley DB: Db::set_re_delim</title> 7<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> 8<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> 9</head> 10<body bgcolor=white> 11<table width="100%"><tr valign=top> 12<td> 13<b>Db::set_re_delim</b> 14</td> 15<td align=right> 16<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a> 17<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> 18</tr></table> 19<hr size=1 noshade> 20<tt> 21<b><pre> 22#include <db_cxx.h> 23<p> 24int 25Db::set_re_delim(int re_delim); 26<p> 27int 28Db::get_re_delim(int *delimp); 29</pre></b> 30<hr size=1 noshade> 31<b>Description: Db::set_re_delim</b> 32<p>Set the delimiting byte used to mark the end of a record in the backing 33source file for the Recno access method.</p> 34<p>This byte is used for variable length records if the <b>re_source</b> 35file is specified. If the <b>re_source</b> file is specified and no 36delimiting byte was specified, <newline> characters (that 37is, ASCII 0x0a) are interpreted as end-of-record markers.</p> 38<p>The Db::set_re_delim method configures a database, not only operations performed 39using the specified <a href="../api_cxx/db_class.html">Db</a> handle.</p> 40<p>The Db::set_re_delim method may not be called after the <a href="../api_cxx/db_open.html">Db::open</a> method is called. 41If the database already exists when 42<a href="../api_cxx/db_open.html">Db::open</a> is called, the information specified to Db::set_re_delim will 43be ignored. 44</p> 45<p>The Db::set_re_delim method 46either returns a non-zero error value 47or throws an exception that encapsulates a non-zero error value on 48failure, and returns 0 on success. 49</p> 50<b>Parameters</b> <br> 51 <b>re_delim</b><ul compact><li>The <b>re_delim</b> parameter is the delimiting byte used to mark the 52end of a record.</ul> 53<br> 54<br><b>Errors</b> 55<p>The Db::set_re_delim method 56may fail and throw 57<a href="../api_cxx/except_class.html">DbException</a>, 58encapsulating one of the following non-zero errors, or return one of 59the following non-zero errors:</p> 60<br> 61<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 62invalid flag value or parameter was specified.</ul> 63<br> 64<hr size=1 noshade> 65<b>Description: Db::get_re_delim</b> 66<p>The Db::get_re_delim method returns the delimiting byte.</p> 67<p>The Db::get_re_delim method may be called at any time during the life of the 68application.</p> 69<p>The Db::get_re_delim method 70either returns a non-zero error value 71or throws an exception that encapsulates a non-zero error value on 72failure, and returns 0 on success. 73</p> 74<b>Parameters</b> <br> 75 <b>delimp</b><ul compact><li>The Db::get_re_delim method returns the 76delimiting byte in <b>delimp</b>.</ul> 77<br> 78<hr size=1 noshade> 79<br><b>Class</b> 80<a href="../api_cxx/db_class.html">Db</a> 81<br><b>See Also</b> 82<a href="../api_cxx/db_list.html">Databases and Related Methods</a> 83</tt> 84<table width="100%"><tr><td><br></td><td align=right> 85<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> 86</td></tr></table> 87<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 88</body> 89</html> 90