1<?xml version="1.0" encoding="UTF-8" standalone="no"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml"> 4 <head> 5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 6 <title>Db::set_re_delim()</title> 7 <link rel="stylesheet" href="apiReference.css" type="text/css" /> 8 <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /> 9 <link rel="start" href="index.html" title="Berkeley DB C++ API Reference" /> 10 <link rel="up" href="db.html" title="Chapter 2. The Db Handle" /> 11 <link rel="prev" href="dbset_q_extentsize.html" title="Db::set_q_extentsize()" /> 12 <link rel="next" href="dbset_re_len.html" title="Db::set_re_len()" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">Db::set_re_delim()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="dbset_q_extentsize.html">Prev</a> </td> 22 <th width="60%" align="center">Chapter 2. 23 The Db Handle 24 </th> 25 <td width="20%" align="right"> <a accesskey="n" href="dbset_re_len.html">Next</a></td> 26 </tr> 27 </table> 28 <hr /> 29 </div> 30 <div class="sect1" lang="en" xml:lang="en"> 31 <div class="titlepage"> 32 <div> 33 <div> 34 <h2 class="title" style="clear: both"><a id="dbset_re_delim"></a>Db::set_re_delim()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40int 41Db::set_re_delim(int re_delim); </pre> 42 <p> 43 Set the delimiting byte used to mark the end of a record in the 44 backing source file for the Recno access method. 45 </p> 46 <p> 47 This byte is used for variable length records if the 48 <span class="bold"><strong>re_source</strong></span> file is specified using the 49 <a class="xref" href="dbset_re_source.html" title="Db::set_re_source()">Db::set_re_source()</a> 50 method. If the <span class="bold"><strong>re_source</strong></span> file is 51 specified and no delimiting byte was specified, <newline> 52 characters (that is, ASCII 0x0a) are interpreted as end-of-record markers. 53 </p> 54 <p> 55 The <code class="methodname">Db::set_re_delim()</code> method configures a database, not only 56 operations performed using the specified 57 <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> handle. 58 </p> 59 <p> 60 The <code class="methodname">Db::set_re_delim()</code> method may not be called after the 61 <a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a> method is called. If 62 the database already exists when 63 <a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a> is called, the 64 information specified to <code class="methodname">Db::set_re_delim()</code> will be ignored. 65 </p> 66 <p> 67 The <code class="methodname">Db::set_re_delim()</code> <span> 68 69 <span> 70 method either returns a non-zero error value or throws an 71 exception that encapsulates a non-zero error value on 72 failure, and returns 0 on success. 73 </span> 74 </span> 75 </p> 76 <div class="sect2" lang="en" xml:lang="en"> 77 <div class="titlepage"> 78 <div> 79 <div> 80 <h3 class="title"><a id="id1650500"></a>Parameters</h3> 81 </div> 82 </div> 83 </div> 84 <div class="sect3" lang="en" xml:lang="en"> 85 <div class="titlepage"> 86 <div> 87 <div> 88 <h4 class="title"><a id="id1650445"></a>re_delim</h4> 89 </div> 90 </div> 91 </div> 92 <p> 93 The <span class="bold"><strong>re_delim</strong></span> parameter is the 94 delimiting byte used to mark the end of a record. 95 </p> 96 </div> 97 </div> 98 <div class="sect2" lang="en" xml:lang="en"> 99 <div class="titlepage"> 100 <div> 101 <div> 102 <h3 class="title"><a id="id1650997"></a>Errors</h3> 103 </div> 104 </div> 105 </div> 106 <p> 107 The <code class="methodname">Db::set_re_delim()</code> <span> 108 109 <span> 110 method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a> 111 exception, encapsulating one of the following non-zero errors, or return one 112 of the following non-zero errors: 113 </span> 114 </span> 115 </p> 116 <div class="sect3" lang="en" xml:lang="en"> 117 <div class="titlepage"> 118 <div> 119 <div> 120 <h4 class="title"><a id="id1651081"></a>EINVAL</h4> 121 </div> 122 </div> 123 </div> 124 <p> 125 If the method was called after <a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a> 126 was called; or if an invalid flag value or parameter was specified. 127 </p> 128 </div> 129 </div> 130 <div class="sect2" lang="en" xml:lang="en"> 131 <div class="titlepage"> 132 <div> 133 <div> 134 <h3 class="title"><a id="id1651082"></a>Class</h3> 135 </div> 136 </div> 137 </div> 138 <p> 139 <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> 140 </p> 141 </div> 142 <div class="sect2" lang="en" xml:lang="en"> 143 <div class="titlepage"> 144 <div> 145 <div> 146 <h3 class="title"><a id="id1650697"></a>See Also</h3> 147 </div> 148 </div> 149 </div> 150 <p> 151 <a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a> 152 </p> 153 </div> 154 </div> 155 <div class="navfooter"> 156 <hr /> 157 <table width="100%" summary="Navigation footer"> 158 <tr> 159 <td width="40%" align="left"><a accesskey="p" href="dbset_q_extentsize.html">Prev</a> </td> 160 <td width="20%" align="center"> 161 <a accesskey="u" href="db.html">Up</a> 162 </td> 163 <td width="40%" align="right"> <a accesskey="n" href="dbset_re_len.html">Next</a></td> 164 </tr> 165 <tr> 166 <td width="40%" align="left" valign="top">Db::set_q_extentsize() </td> 167 <td width="20%" align="center"> 168 <a accesskey="h" href="index.html">Home</a> 169 </td> 170 <td width="40%" align="right" valign="top"> Db::set_re_len()</td> 171 </tr> 172 </table> 173 </div> 174 </body> 175</html> 176