uTools-Manuals/docs/php/dbase_get_header_info.html
2019-04-08 23:22:26 +08:00

188 lines
6.1 KiB
HTML

<!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>Gets the header info of a database</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><div id="function.dbase-get-header-info" class="refentry">
<div class="refnamediv">
<h1 class="refname">dbase_get_header_info</h1>
<p class="verinfo">(PHP 5 &lt; 5.3.0, dbase 5, dbase 7)</p><p class="refpurpose"><span class="refname">dbase_get_header_info</span> &mdash; <span class="dc-title">Gets the header info of a database</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.dbase-get-header-info-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>dbase_get_header_info</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$dbase_identifier</code></span>
) : <span class="type">array</span></div>
<p class="para rdfs-comment">
Returns information on the column structure of the given database link
identifier.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.dbase-get-header-info-parameters">
<h3 class="title">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">dbase_identifier</code></dt>
<dd>
<p class="para">
The database link identifier, returned by <span class="function"><a href="dbase_open.html" class="function">dbase_open()</a></span>
or <span class="function"><a href="dbase_create.html" class="function">dbase_create()</a></span>.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.dbase-get-header-info-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
An indexed array with an entry for each column in the database. The array index
starts at 0.
</p>
<p class="para">
Each array element contains an associative array of column information, as
described here:
<dl>
<dt>
name</dt>
<dd>
<span class="simpara">
The name of the column
</span>
</dd>
<dt>
type</dt>
<dd>
<span class="simpara">
The human-readable name for the dbase type of the column (i.e. date,
boolean, etc.)
The supported field types are listed in the <a href="intro.dbase.html" class="link">introduction section</a>.
</span>
</dd>
<dt>
length</dt>
<dd>
<span class="simpara">
The number of bytes this column can hold
</span>
</dd>
<dt>
precision</dt>
<dd>
<span class="simpara">
The number of digits of decimal precision for the column
</span>
</dd>
<dt>
format</dt>
<dd>
<span class="simpara">
A suggested <span class="function"><a href="printf.html" class="function">printf()</a></span> format specifier for the column
</span>
</dd>
<dt>
offset</dt>
<dd>
<span class="simpara">
The byte offset of the column from the start of the row
</span>
</dd>
</dl>
</p>
<p class="para">
If the database header information cannot be read, <strong><code>FALSE</code></strong> is returned.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.dbase-get-header-info-changelog">
<h3 class="title">更新日志</h3>
<table class="doctable informaltable">
<thead>
<tr>
<th>版本</th>
<th>说明</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>dbase 7.0.0</td>
<td>
<code class="parameter">dbase_identifier</code> is now a <span class="type"><a href="language.types.resource.html" class="type resource">resource</a></span>
instead of an <span class="type"><a href="language.types.integer.html" class="type int">int</a></span>.
</td>
</tr>
</tbody>
</table>
</div>
<div class="refsect1 examples" id="refsect1-function.dbase-get-header-info-examples">
<h3 class="title">范例</h3>
<p class="para">
<div class="example" id="example-1187">
<p><strong>Example #1 Showing header information for a dBase database file</strong></p>
<div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">//&nbsp;Path&nbsp;to&nbsp;dbase&nbsp;file<br /></span><span style="color: #0000BB">$db_path&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">"/tmp/test.dbf"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">//&nbsp;Open&nbsp;dbase&nbsp;file<br /></span><span style="color: #0000BB">$dbh&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">dbase_open</span><span style="color: #007700">(</span><span style="color: #0000BB">$db_path</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">0</span><span style="color: #007700">)<br />&nbsp;&nbsp;or&nbsp;die(</span><span style="color: #DD0000">"Error!&nbsp;Could&nbsp;not&nbsp;open&nbsp;dbase&nbsp;database&nbsp;file&nbsp;'</span><span style="color: #0000BB">$db_path</span><span style="color: #DD0000">'."</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">//&nbsp;Get&nbsp;column&nbsp;information<br /></span><span style="color: #0000BB">$column_info&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">dbase_get_header_info</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbh</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">//&nbsp;Display&nbsp;information<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$column_info</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</pre></div>
</div>
</div>
</p>
</div>
</div></div></div></body></html>