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

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>px_retrieve_record</methodname>
   <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam>
   <methodparam><type>int</type><parameter>num</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   This function is very similar to <function>px_get_record</function>
   but uses internally a different approach to retrieve the data. It
   relies on pxlib for reading each single field value, which usually
   results in support for more field types.
  </para>
  <note>
   <para>
    This function is only available if pxlib &gt;= 0.6.0 is used.
   </para>
  </note>
 </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>num</parameter></term>
     <listitem>
      <para>
       The record number is an artificial number counting records in the order
       as they are stored in the database. The first record has number 0.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       The optional <parameter>mode</parameter> can be
       <constant>PX_KEYTOLOWER</constant> or <constant>PX_KEYTOUPPER</constant>
       in order to convert the keys into lower or upper case. If
       <parameter>mode</parameter> is not passed or is 0, then the key will be
       exactly like the field name. The element values will contain the field
       values. NULL values will be retained and are different from 0.0, 0 or
       the empty string. Fields of type <constant>PX_FIELD_TIME</constant>
       will be returned as an integer counting the number of milliseconds
       starting at midnight. A timestamp is a floating point value also
       counting milliseconds starting at the beginning of julian calendar.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the <parameter>num</parameter>&apos;th record from the paradox
   database. The record is returned as an associated array with its keys
   being the field names.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>px_get_record</function></member>
   </simplelist>
  </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
-->