<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.dbase.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'function.dbase-get-header-info.php',
    1 => 'dbase_get_header_info',
    2 => 'Gets the header info of a database',
  ),
  'up' => 
  array (
    0 => 'ref.dbase.php',
    1 => 'dBase 函数',
  ),
  'prev' => 
  array (
    0 => 'function.dbase-delete-record.php',
    1 => 'dbase_delete_record',
  ),
  'next' => 
  array (
    0 => 'function.dbase-get-record.php',
    1 => 'dbase_get_record',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/dbase/functions/dbase-get-header-info.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<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"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$database</code></span>): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>

  <p class="para rdfs-comment">
   Returns information on the column structure of the given database resource.
  </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">database</code></dt>
     <dd>
      <p class="para">
       The database resource, returned by <span class="function"><a href="function.dbase-open.php" class="function">dbase_open()</a></span>
       or <span class="function"><a href="function.dbase-create.php" 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="book.dbase.php#intro.dbase" 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="function.printf.php" 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><a href="reserved.constants.php#constant.false">false</a></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>PECL dbase 7.0.0</td>
      <td>
       <code class="parameter">database</code> is now a <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>
       instead of an <span class="type"><a href="language.types.integer.php" 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-1">
    <p><strong>示例 #1 Showing header information for a dBase database file</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">// Path to dbase file<br /></span><span style="color: #0000BB">$db_path </span><span style="color: #007700">= </span><span style="color: #DD0000">"/tmp/test.dbf"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// Open dbase file<br /></span><span style="color: #0000BB">$dbh </span><span style="color: #007700">= </span><span style="color: #0000BB">dbase_open</span><span style="color: #007700">(</span><span style="color: #0000BB">$db_path</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">)<br />  or die(</span><span style="color: #DD0000">"Error! Could not open dbase database file '</span><span style="color: #0000BB">$db_path</span><span style="color: #DD0000">'."</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Get column information<br /></span><span style="color: #0000BB">$column_info </span><span style="color: #007700">= </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">// Display 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></code></div>
    </div>

   </div>
  </p>
 </div>

</div><?php manual_footer($setup); ?>