php-doc-en/reference/paradox/functions/px-get-schema.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/paradox.xml, last change in rev  -->
<refentry xml:id="function.px-get-schema" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>px_get_schema</refname>
  <refpurpose>Returns the database schema</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>px_get_schema</methodname>
   <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>px_get_schema</function> returns the database schema.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>pxdoc</parameter></term>
     <listitem>
      <para>
       Resource identifier of the paradox database
       as returned by <function>px_new</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       If the optional <parameter>mode</parameter> is
       <constant>PX_KEYTOLOWER</constant> or
       <constant>PX_KEYTOUPPER</constant> the keys of the returned array
       will be converted to lower
       or upper case. If <parameter>mode</parameter> is 0 or not passed at all,
       then the key name will be identical to the field name.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the schema of a database file as an associated array. The key name
   is equal to the field name. Each array element is itself an associated
   array containing the two fields <literal>type</literal> and
   <literal>size</literal>. <literal>type</literal> is one of the constants in
   table <link linkend="paradox.table-fieldtypes">Constants for field
   types</link>. <literal>size</literal> is the number of bytes this field
   consumes in the record. The total of all field sizes is equal to the
   record size as it can be retrieved with <function>px-get-info</function>.
  </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
-->