sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Switch to new doc style

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@226704 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-01-08 00:47:18 +00:00
parent efa54d504a
commit eb1adb553b
7 changed files with 165 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
reference/filepro/functions/filepro-fieldcount.xml
View file

@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>filepro_fieldcount</methodname>
<void/>
@ -15,8 +15,20 @@
Returns the number of fields (columns) in the opened filePro
database.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
See also <function>filepro</function>.
Returns the number of fields in the opened filePro database, or &false; on
errors.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>filepro</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

31
reference/filepro/functions/filepro-fieldname.xml
View file

@ -1,19 +1,40 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.filepro-fieldname">
<refnamediv>
<refname>filepro_fieldname</refname>
<refpurpose>Gets the name of a field</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<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>.
Returns the name of the field corresponding to
<parameter>field_number</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>field_number</parameter></term>
<listitem>
<para>
The field number.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the name of the field as a string, or &false; on errors.
</para>
</refsect1>
</refentry>

27
reference/filepro/functions/filepro-fieldtype.xml
View file

@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.filepro-fieldtype">
<refnamediv>
<refname>filepro_fieldtype</refname>
<refpurpose>Gets the type of a field</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>filepro_fieldtype</methodname>
<methodparam><type>int</type><parameter>field_number</parameter></methodparam>
@ -15,6 +15,27 @@
Returns the edit type of the field corresponding to <parameter>field_number</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>field_number</parameter></term>
<listitem>
<para>
The field number.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the edit type of the field as a string, or &false; on errors.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

27
reference/filepro/functions/filepro-fieldwidth.xml
View file

@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.filepro-fieldwidth">
<refnamediv>
<refname>filepro_fieldwidth</refname>
<refpurpose>Gets the width of a field</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>filepro_fieldwidth</methodname>
<methodparam><type>int</type><parameter>field_number</parameter></methodparam>
@ -15,6 +15,27 @@
Returns the width of the field corresponding to <parameter>field_number</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>field_number</parameter></term>
<listitem>
<para>
The field number.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the width of the field as a integer, or &false; on errors.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

45
reference/filepro/functions/filepro-retrieve.xml
View file

@ -1,28 +1,53 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.filepro-retrieve">
<refnamediv>
<refname>filepro_retrieve</refname>
<refpurpose>Retrieves data from a filePro database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<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. The
<parameter>row_number</parameter> parameter must be between zero
and the total number of rows minus one
(0..<function>filepro_rowcount</function> - 1). Likewise,
<parameter>field_number</parameter> accepts values between zero and
the total number of fields minus one
(0..<function>filepro_fieldcount</function> - 1)
Returns the data from the specified location in the database.
</para>
&note.sm.uidcheck;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>row_number</parameter></term>
<listitem>
<para>
The row number. Must be between zero and the total number of rows
minus one (0..<function>filepro_rowcount</function> - 1)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field_number</parameter></term>
<listitem>
<para>
The field number. Accepts values between zero and the total number of
fields minus one (0..<function>filepro_fieldcount</function> - 1)
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the specified data, or &false; on errors.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

20
reference/filepro/functions/filepro-rowcount.xml
View file

@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<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>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>filepro_rowcount</methodname>
<void/>
@ -15,8 +15,20 @@
Returns the number of rows in the opened filePro database.
</para>
&note.sm.uidcheck;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
See also <function>filepro</function>.
Returns the number of rows in the opened filePro database, or &false; on
errors.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>filepro</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

27
reference/filepro/functions/filepro.xml
View file

@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.filepro">
<refnamediv>
<refname>filepro</refname>
<refpurpose>Read and verify the map file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>filepro</methodname>
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
@ -21,6 +21,27 @@
</para>
&note.sm.uidcheck;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>directory</parameter></term>
<listitem>
<para>
The map directory.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file