diff options
| author | Lorry <lorry@roadtrain.codethink.co.uk> | 2012-07-20 20:00:05 +0100 |
|---|---|---|
| committer | Lorry <lorry@roadtrain.codethink.co.uk> | 2012-07-20 20:00:05 +0100 |
| commit | 3ef782d3745ea8f25a3151561a3cfb882190210e (patch) | |
| tree | 86b9c2f5fde051dd0bced99b3fc9f5a3ba08db69 /docs/api_reference/C/logfile.html | |
| download | berkeleydb-3ef782d3745ea8f25a3151561a3cfb882190210e.tar.gz | |
Tarball conversion
Diffstat (limited to 'docs/api_reference/C/logfile.html')
| -rw-r--r-- | docs/api_reference/C/logfile.html | 199 |
1 files changed, 199 insertions, 0 deletions
diff --git a/docs/api_reference/C/logfile.html b/docs/api_reference/C/logfile.html new file mode 100644 index 00000000..7fbf6cc9 --- /dev/null +++ b/docs/api_reference/C/logfile.html @@ -0,0 +1,199 @@ +<?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_ENV->log_file()</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="lsn.html" title="Chapter 7. The DB_LSN Handle" /> + <link rel="prev" href="logcursor.html" title="DB_ENV->log_cursor()" /> + <link rel="next" href="logflush.html" title="DB_ENV->log_flush()" /> + </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_ENV->log_file()</th> + </tr> + <tr> + <td width="20%" align="left"><a accesskey="p" href="logcursor.html">Prev</a> </td> + <th width="60%" align="center">Chapter 7. + The DB_LSN Handle + </th> + <td width="20%" align="right"> <a accesskey="n" href="logflush.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="logfile"></a>DB_ENV->log_file()</h2> + </div> + </div> + </div> + <pre class="programlisting">#include <db.h> + +int +DB_ENV->log_file(DB_ENV *env, + const DB_LSN *lsn, char *namep, size_t len); </pre> + <p> + The <code class="methodname">DB_ENV->log_file()</code> method maps + <code class="classname">DB_LSN</code> structures to filenames, + returning the name of the file containing the record named by + <span class="bold"><strong>lsn</strong></span>. + </p> + <p> + This mapping of <code class="classname">DB_LSN</code> structures to files is needed for database + administration. For example, a transaction manager typically records + the earliest <a class="link" href="lsn.html" title="Chapter 7. The DB_LSN Handle">DB_LSN</a> + needed for restart, and the database administrator may want to archive + log files to tape when they contain only + <a class="link" href="lsn.html" title="Chapter 7. The DB_LSN Handle">DB_LSN</a> entries before the + earliest one needed for restart. + </p> + <p> + The <code class="methodname">DB_ENV->log_file()</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="idp60797128"></a>Parameters</h3> + </div> + </div> + </div> + <div class="sect3" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h4 class="title"><a id="idp60832328"></a>lsn</h4> + </div> + </div> + </div> + <p> + The <span class="bold"><strong>lsn</strong></span> parameter is the + <code class="classname">DB_LSN</code> structure for which a + filename is wanted. + </p> + </div> + <div class="sect3" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h4 class="title"><a id="idp60837232"></a>namep</h4> + </div> + </div> + </div> + <p> + The <span class="bold"><strong>namep</strong></span> parameter references memory + into which the name of the file containing the record named by + <span class="bold"><strong>lsn</strong></span> is copied. + </p> + </div> + <div class="sect3" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h4 class="title"><a id="idp60792088"></a>len</h4> + </div> + </div> + </div> + <p> + The <span class="bold"><strong>len</strong></span> parameter is the length of + the <span class="bold"><strong>namep</strong></span> buffer in bytes. If + <span class="bold"><strong>namep</strong></span> is too short to hold the + filename, <code class="methodname">DB_ENV->log_file()</code> will fail. (Log filenames + are always 14 characters long.) + </p> + </div> + </div> + <div class="sect2" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h3 class="title"><a id="idp60795280"></a>Errors</h3> + </div> + </div> + </div> + <p> + The <code class="methodname">DB_ENV->log_file()</code> <span> + <span> + method may fail and return one of the following non-zero errors: + </span> + + </span> + </p> + <div class="sect3" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h4 class="title"><a id="idp60843288"></a>EINVAL</h4> + </div> + </div> + </div> + <p> + If supplied buffer was too small to hold the log filename; + or if an invalid flag value or parameter was specified. + </p> + </div> + </div> + <div class="sect2" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h3 class="title"><a id="idp60801192"></a>Class</h3> + </div> + </div> + </div> + <p> + <a class="link" href="env.html" title="Chapter 5. The DB_ENV Handle">DB_ENV</a>, + <a class="link" href="logc.html" title="The DB_LOGC Handle">DB_LOGC</a>, + <a class="link" href="lsn.html" title="Chapter 7. The DB_LSN Handle">DB_LSN</a> + </p> + </div> + <div class="sect2" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h3 class="title"><a id="idp60844624"></a>See Also</h3> + </div> + </div> + </div> + <p> + <a class="xref" href="lsn.html#loglist" title="Logging Subsystem and Related Methods">Logging Subsystem 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="logcursor.html">Prev</a> </td> + <td width="20%" align="center"> + <a accesskey="u" href="lsn.html">Up</a> + </td> + <td width="40%" align="right"> <a accesskey="n" href="logflush.html">Next</a></td> + </tr> + <tr> + <td width="40%" align="left" valign="top">DB_ENV->log_cursor() </td> + <td width="20%" align="center"> + <a accesskey="h" href="index.html">Home</a> + </td> + <td width="40%" align="right" valign="top"> DB_ENV->log_flush()</td> + </tr> + </table> + </div> + </body> +</html> |