archived-doc-es/reference/dbase/functions/dbase-get-header-info.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: seros Status: ready -->
<refentry xml:id="function.dbase-get-header-info" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>dbase_get_header_info</refname>
  <refpurpose>Obtiene la información de cabecera de una base de datos</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>dbase_get_header_info</methodname>
   <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam>
  </methodsynopsis>
  <para>
   Devuelve la informaicón de la estructura de columna del identificador de enlace de la
   base de datos dada.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>dbase_identifier</parameter></term>
     <listitem>
      <para>
       El identificador de enlace de la base de datos, devuelto por <function>dbase_open</function>
       o <function>dbase_create</function>..
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Una matriz indexada con una entrada para cada columna de la base de datos. El índice de la matriz
   comienza en 0.
  </para>
  <para>
   Cada elemento de la matriz contiene una matriz asociativa de información de columna, como
   se describe a continuación:
   <variablelist>
    <varlistentry>
     <term>name</term>
     <listitem>
      <simpara>
       El nombre de la columna
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>type</term>
     <listitem>
      <simpara>
       El nombre legible por humanos del tipo de dbase de la columna (p.ej. date,
       boolean, etc.)
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>length</term>
     <listitem>
      <simpara>
       El número de bytes que puede soportar esta columna
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>precision</term>
     <listitem>
      <simpara>
       El número de dígitos de precisión decimal de la columna
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>format</term>
     <listitem>
      <simpara>
       Un especificador de formato de <function>printf</function> sugerido para la columna
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>offset</term>
     <listitem>
      <simpara>
       El índice de byte de la columna desde el inicio de la fila
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
  <para>
   Si no se puede leer la información de la cabecera de la base de datos, se devuleve &false;.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Mostrar la información de cabecera de un archivo de base de datos dBase</title>
    <programlisting role="php">
<![CDATA[
<?php
// Ruta al archivo dbase
$ruta_db = "/tmp/test.dbf";

// Abrir un el archivo dbase
$dbh = dbase_open($ruta_db, 0)
  or die("¡Error! No se pudo abrir el archivo de base de datos dbase '$ruta_db'.");

// Obtener la información de columna
$info_columna = dbase_get_header_info($dbh);

// Mostrar la información
print_r($info_columna);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->