The <codeclass="methodname">DB_ENV->log_archive()</code> method returns an array of log or database
filenames.
</p>
<p>
By default, <codeclass="methodname">DB_ENV->log_archive()</code> returns the names of all of the
log files that are no longer in use (for example, that are no longer involved in active
transactions), and that may safely be archived for catastrophic recovery and then removed
from the system. If there are no filenames to return, the memory location to which
<spanclass="bold"><strong>listp</strong></span> refers will be set to NULL.
</p>
<p>
When Replication Manager is in use, log archiving is
performed in a replication group-aware manner such that the
log file status of other sites in the group is considered to
determine if a log file is in use.
</p>
<p>
Arrays of log filenames are stored in allocated memory. If application-specific allocation
routines have been declared (see <aclass="xref"href="envset_alloc.html"title="DB_ENV->set_alloc()">DB_ENV->set_alloc()</a>
for more information), they are used to allocate the memory; otherwise, the standard
C library <spanclass="bold"><strong>malloc</strong></span>(3) is used. The caller is responsible
for deallocating the memory. To deallocate the memory, free the memory reference;
references inside the returned memory need not be individually freed.
</p>
<p>
Log cursor handles (returned by the <aclass="xref"href="logcursor.html"title="DB_ENV->log_cursor()">DB_ENV->log_cursor()</a>
method) may have open file descriptors for log files in the database environment. Also,
the Berkeley DB interfaces to the database environment logging subsystem (for example,
<aclass="xref"href="logput.html"title="DB_ENV->log_put()">DB_ENV->log_put()</a> and <aclass="xref"href="txnabort.html"title="DB_TXN->abort()">DB_TXN->abort()</a> ) may allocate log cursors and have open file descriptors
for log files as well. On operating systems where filesystem related system calls (for
example, rename and unlink on Windows/NT) can fail if a process has an open file descriptor
for the affected file, attempting to move or remove the log files listed by
<codeclass="methodname">DB_ENV->log_archive()</code> may fail. All Berkeley DB internal use of log
cursors operates on active log files only and furthermore, is short-lived in nature. So,
an application seeing such a failure should be restructured to close any open log cursors
it may have, and otherwise to retry the operation until it succeeds. (Although the latter
is not likely to be necessary; it is hard to imagine a reason to move or rename a log file
in which transactions are being logged or aborted.)
</p>
<p>
See <aclass="link"href="db_archive.html"title="db_archive">db_archive</a> for more information on
database archival procedures.
</p>
<p>
The <codeclass="methodname">DB_ENV->log_archive()</code> method is the underlying method used by the
