<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Packs a database</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.dbase-open.html">dbase_open</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.dbase-replace-record.html">dbase_replace_record</a></div>
<div class="up"><a href="ref.dbase.html">dBase Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.dbase-pack" class="refentry">
<div class="refnamediv">
<h1 class="refname">dbase_pack</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">dbase_pack</span> — <span class="dc-title">Packs a database</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.dbase-pack-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>dbase_pack</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$dbase_identifier</code></span>
)</div>
<p class="para rdfs-comment">
Packs the specified database by permanently deleting all records marked
for deletion using <span class="function"><a href="function.dbase-delete-record.html" class="function">dbase_delete_record()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.dbase-pack-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">dbase_identifier</code></em></span>
<dd>
<p class="para">
The database link identifier, returned by <span class="function"><a href="function.dbase-open.html" class="function">dbase_open()</a></span>
or <span class="function"><a href="function.dbase-create.html" class="function">dbase_create()</a></span>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.dbase-pack-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.dbase-pack-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-1102">
<p><strong>Example #1 Emptying a dBase database</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">// open in read-write mode<br /></span><span style="color: #0000BB">$db </span><span style="color: #007700">= </span><span style="color: #0000BB">dbase_open</span><span style="color: #007700">(</span><span style="color: #DD0000">'/tmp/test.dbf'</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$db</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$record_numbers </span><span style="color: #007700">= </span><span style="color: #0000BB">dbase_numrecords</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">);<br /> for (</span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">1</span><span style="color: #007700">; </span><span style="color: #0000BB">$i </span><span style="color: #007700"><= </span><span style="color: #0000BB">$record_numbers</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700">++) {<br /> </span><span style="color: #0000BB">dbase_delete_record</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">, </span><span style="color: #0000BB">$i</span><span style="color: #007700">);<br /> }<br /> </span><span style="color: #FF8000">// expunge the database<br /> </span><span style="color: #0000BB">dbase_pack</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.dbase-pack-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.dbase-delete-record.html" class="function" rel="rdfs-seeAlso">dbase_delete_record()</a> - Deletes a record from a database</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.dbase-open.html">dbase_open</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.dbase-replace-record.html">dbase_replace_record</a></div>
<div class="up"><a href="ref.dbase.html">dBase Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
