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

136 lines
5 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;fd()</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="dbexists.html" title="DB-&gt;exists()" />
<link rel="next" href="dbget.html" title="DB-&gt;get()" />
</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;fd()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbexists.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.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="dbfd"></a>DB-&gt;fd()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db.h&gt;
int
DB-&gt;fd(DB *db, int *fdp); </pre>
<p>
The <code class="methodname">DB-&gt;fd()</code> method provides access to a file descriptor
representative of the underlying database. A file descriptor
referring to the same file will be returned to all processes that call
<a class="xref" href="dbopen.html" title="DB-&gt;open()">DB-&gt;open()</a> with the same
<span class="bold"><strong>file</strong></span> parameter.
</p>
<p>
This file descriptor may be safely used as a parameter to the
<span class="bold"><strong>fcntl</strong></span>(2) and <span class="bold"><strong>flock</strong></span>(2) locking functions.
</p>
<p>
The <code class="methodname">DB-&gt;fd()</code> method only supports a coarse-grained form of locking.
Applications should instead use the Berkeley DB lock manager where
possible.
</p>
<p>
The <code class="methodname">DB-&gt;fd()</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="idp57516584"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp57518416"></a>fdp</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>fdp</strong></span> parameter references memory
into which the current file descriptor is copied.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp57487616"></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="idp57520120"></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>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="dbexists.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.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB-&gt;exists() </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()</td>
</tr>
</table>
</div>
</body>
</html>