php-doc-en/functions/filepro.xml

166 lines
4.9 KiB
XML

<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 Fiserv, 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>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>filepro</function></funcdef>
<paramdef>string <parameter>directory</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<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>
</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>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>filepro_fieldname</function></funcdef>
<paramdef>int <parameter>field_number</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<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>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>filepro_fieldtype</function></funcdef>
<paramdef>int <parameter>field_number</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<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>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>filepro_fieldwidth</function></funcdef>
<paramdef>int <parameter>field_number</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<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>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>filepro_retrieve</function></funcdef>
<paramdef>int <parameter>row_number</parameter></paramdef>
<paramdef>int <parameter>field_number</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns the data from the specified location in the database.</para>
</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>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>filepro_fieldcount</function></funcdef>
<void/>
</funcprototype>
</funcsynopsis>
<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>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>filepro_rowcount</function></funcdef>
<void/>
</funcprototype>
</funcsynopsis>
<para>
Returns the number of rows in the opened filePro database.</para>
<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
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->