php-doc-en/functions/filepro.xml

<!-- D O   N O T   E D I T   T H I S   F I L E   ! ! !  

     it is still here for historical reasons only 
     (as translators may need to check old revision diffs)

     if you want to change things documented in this file
     you should now edit the files found under en/reference
     instead -->
     
     <?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.16 $ -->
 <reference id="ref.filepro">
  <title>filePro functions</title>
  <titleabbrev>filePro</titleabbrev>

  <partintro>
   <simpara>
    These functions allow read-only access to data stored in filePro databases.
   </simpara>
   <simpara>
    filePro is a registered trademark of fP Technologies, Inc. You can find more
    information about filePro at <ulink url="&url.filepro;">&url.filepro;</ulink>.
   </simpara>
  </partintro>

  <refentry id="function.filepro">
   <refnamediv>
    <refname>filepro</refname>
    <refpurpose>Read and verify the map file</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>filepro</methodname>
      <methodparam><type>string</type><parameter>directory</parameter></methodparam>
     </methodsynopsis>
    <para>
     This reads and verifies the map file, storing the field count
     and info.
    </para>
    <para>
     No locking is done, so you should avoid modifying your filePro
     database while it may be opened in PHP.
    </para>
    &note.sm.uidcheck;
   </refsect1>
  </refentry>

  <refentry id="function.filepro-fieldname">
   <refnamediv>
    <refname>filepro_fieldname</refname>
    <refpurpose>Gets the name of a field</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>filepro_fieldname</methodname>
      <methodparam><type>int</type><parameter>field_number</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns the name of the field corresponding 
     to <parameter>field_number</parameter>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.filepro-fieldtype">
   <refnamediv>
    <refname>filepro_fieldtype</refname>
    <refpurpose>Gets the type of a field</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>filepro_fieldtype</methodname>
      <methodparam><type>int</type><parameter>field_number</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns the edit type of the field corresponding to <parameter>field_number</parameter>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.filepro-fieldwidth">
   <refnamediv>
    <refname>filepro_fieldwidth</refname>
    <refpurpose>Gets the width of a field</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>filepro_fieldwidth</methodname>
      <methodparam><type>int</type><parameter>field_number</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns the width of the field corresponding to <parameter>field_number</parameter>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.filepro-retrieve">
   <refnamediv>
    <refname>filepro_retrieve</refname>
    <refpurpose>Retrieves data from a filePro database</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>filepro_retrieve</methodname>
      <methodparam><type>int</type><parameter>row_number</parameter></methodparam>
      <methodparam><type>int</type><parameter>field_number</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns the data from the specified location in the database.
    </para>
    &note.sm.uidcheck;
   </refsect1>
  </refentry>

  <refentry id="function.filepro-fieldcount">
   <refnamediv>
    <refname>filepro_fieldcount</refname>
    <refpurpose>Find out how many fields are in a filePro database</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>filepro_fieldcount</methodname>
      <void/>
     </methodsynopsis>
    <para>
     Returns the number of fields (columns) in the opened filePro
     database.
    </para>
    <para>
     See also <function>filepro</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.filepro-rowcount">
   <refnamediv>
    <refname>filepro_rowcount</refname>
    <refpurpose>Find out how many rows are in a filePro database</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>filepro_rowcount</methodname>
      <void/>
     </methodsynopsis>
    <para>
     Returns the number of rows in the opened filePro database.
    </para>
    &note.sm.uidcheck;
    <para>
     See also <function>filepro</function>.
    </para>
   </refsect1>
  </refentry>

 </reference>

<!-- 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:"../../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
-->