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_pad()</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_re_len.html" title="Db::set_re_len()" /> 12 <link rel="next" href="dbset_re_source.html" title="Db::set_re_source()" /> 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_pad()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="dbset_re_len.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_source.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_pad"></a>Db::set_re_pad()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40int 41Db::set_re_pad(int re_pad); </pre> 42 <p> 43 Set the padding character for short, fixed-length records for the 44 Queue and Recno access methods. 45 </p> 46 <p> 47 If no pad character is specified, <space> characters (that is, 48 ASCII 0x20) are used for padding. 49 </p> 50 <p> 51 The <code class="methodname">Db::set_re_pad()</code> method configures a database, not only 52 operations performed using the specified <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> handle. 53 </p> 54 <p> 55 The <code class="methodname">Db::set_re_pad()</code> method may not be called after the 56 <a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a> method is called. If 57 the database already exists when 58 <a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a> is called, the 59 information specified to <code class="methodname">Db::set_re_pad()</code> will be ignored. 60 </p> 61 <p> 62 The <code class="methodname">Db::set_re_pad()</code> <span> 63 64 <span> 65 method either returns a non-zero error value or throws an 66 exception that encapsulates a non-zero error value on 67 failure, and returns 0 on success. 68 </span> 69 </span> 70 </p> 71 <div class="sect2" lang="en" xml:lang="en"> 72 <div class="titlepage"> 73 <div> 74 <div> 75 <h3 class="title"><a id="id1651075"></a>Parameters</h3> 76 </div> 77 </div> 78 </div> 79 <div class="sect3" lang="en" xml:lang="en"> 80 <div class="titlepage"> 81 <div> 82 <div> 83 <h4 class="title"><a id="id1651071"></a>re_pad</h4> 84 </div> 85 </div> 86 </div> 87 <p> 88 The <span class="bold"><strong>re_pad</strong></span> parameter is the pad 89 character for fixed-length records for the Queue and Recno access 90 methods. 91 </p> 92 </div> 93 </div> 94 <div class="sect2" lang="en" xml:lang="en"> 95 <div class="titlepage"> 96 <div> 97 <div> 98 <h3 class="title"><a id="id1651413"></a>Errors</h3> 99 </div> 100 </div> 101 </div> 102 <p> 103 The <code class="methodname">Db::set_re_pad()</code> <span> 104 105 <span> 106 method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a> 107 exception, encapsulating one of the following non-zero errors, or return one 108 of the following non-zero errors: 109 </span> 110 </span> 111 </p> 112 <div class="sect3" lang="en" xml:lang="en"> 113 <div class="titlepage"> 114 <div> 115 <div> 116 <h4 class="title"><a id="id1651090"></a>EINVAL</h4> 117 </div> 118 </div> 119 </div> 120 <p> 121 If the method was called after <a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a> 122 was called; or if an invalid flag value or parameter was specified. 123 </p> 124 </div> 125 </div> 126 <div class="sect2" lang="en" xml:lang="en"> 127 <div class="titlepage"> 128 <div> 129 <div> 130 <h3 class="title"><a id="id1651092"></a>Class</h3> 131 </div> 132 </div> 133 </div> 134 <p> 135 <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> 136 </p> 137 </div> 138 <div class="sect2" lang="en" xml:lang="en"> 139 <div class="titlepage"> 140 <div> 141 <div> 142 <h3 class="title"><a id="id1651119"></a>See Also</h3> 143 </div> 144 </div> 145 </div> 146 <p> 147 <a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a> 148 </p> 149 </div> 150 </div> 151 <div class="navfooter"> 152 <hr /> 153 <table width="100%" summary="Navigation footer"> 154 <tr> 155 <td width="40%" align="left"><a accesskey="p" href="dbset_re_len.html">Prev</a> </td> 156 <td width="20%" align="center"> 157 <a accesskey="u" href="db.html">Up</a> 158 </td> 159 <td width="40%" align="right"> <a accesskey="n" href="dbset_re_source.html">Next</a></td> 160 </tr> 161 <tr> 162 <td width="40%" align="left" valign="top">Db::set_re_len() </td> 163 <td width="20%" align="center"> 164 <a accesskey="h" href="index.html">Home</a> 165 </td> 166 <td width="40%" align="right" valign="top"> Db::set_re_source()</td> 167 </tr> 168 </table> 169 </div> 170 </body> 171</html> 172