libdb/docs/api_reference/C/dbget_re_pad.html
2012-11-14 16:35:20 -05:00

135 lines
5.2 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>DB-&gt;get_re_pad()</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C API Reference" />
<link rel="up" href="db.html" title="Chapter 2.  The DB Handle" />
<link rel="prev" href="dbget_re_len.html" title="DB-&gt;get_re_len()" />
<link rel="next" href="dbget_re_source.html" title="DB-&gt;get_re_source()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.3</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DB-&gt;get_re_pad()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbget_re_len.html">Prev</a> </td>
<th width="60%" align="center">Chapter 2. 
The DB Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="dbget_re_source.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="dbget_re_pad"></a>DB-&gt;get_re_pad()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db.h&gt;
int
DB-&gt;get_re_pad(DB *db, int *re_padp); </pre>
<p>
The <code class="methodname">DB-&gt;get_re_pad()</code> method returns the pad character used for
short, fixed-length records used by the Queue and Recno access methods.
This character is set using the
<a class="xref" href="dbset_re_pad.html" title="DB-&gt;set_re_pad()">DB-&gt;set_re_pad()</a>
method.
</p>
<p>
The <code class="methodname">DB-&gt;get_re_pad()</code> method may be
called only after the database has been opened.
</p>
<p>
The <code class="methodname">DB-&gt;get_re_pad()</code> <span>
<span>
method returns a non-zero error value on failure and 0 on success.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp57786424"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp57785776"></a>re_padp</h4>
</div>
</div>
</div>
<p>
The <code class="methodname">DB-&gt;get_re_pad()</code> method returns the pad
character in <span class="bold"><strong>re_padp</strong></span>. If used on a handle
that has not yet been opened, the default pad character is returned.
See the <a class="xref" href="dbset_re_pad.html" title="DB-&gt;set_re_pad()">DB-&gt;set_re_pad()</a>
method description for what that default value is.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp57779456"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="db.html" title="Chapter 2.  The DB Handle">DB</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp57768872"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a>,
<a class="xref" href="dbset_re_pad.html" title="DB-&gt;set_re_pad()">DB-&gt;set_re_pad()</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="dbget_re_len.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="db.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="dbget_re_source.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB-&gt;get_re_len() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DB-&gt;get_re_source()</td>
</tr>
</table>
</div>
</body>
</html>