finished new doc style, and greatly reduced the refpurpose size

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@260054 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2008-05-20 15:53:37 +00:00
parent b98266d37e
commit b66d828fc1

View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.odbc-foreignkeys" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_foreignkeys</refname>
<refpurpose>Returns a list of foreign keys in the specified table or a list of foreign keys in other tables that refer to the primary key in the specified table</refpurpose>
<refpurpose>Retrieves a list of foreign keys</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -19,9 +19,78 @@
<methodparam><type>string</type><parameter>fk_table</parameter></methodparam>
</methodsynopsis>
<para>
<function>odbc_foreignkeys</function> retrieves information about
foreign keys. Returns an ODBC result identifier or
&false; on failure.
Retrieves a list of foreign keys in the specified table or a list of
foreign keys in other tables that refer to the primary key in the
specified table
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection_id</parameter></term>
<listitem>
&odbc.connection.id;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pk_qualifier</parameter></term>
<listitem>
<para>
The primary key qualifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pk_owner</parameter></term>
<listitem>
<para>
The primary key owner.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pk_table</parameter></term>
<listitem>
<para>
The primary key table.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fk_qualifier</parameter></term>
<listitem>
<para>
The foreign key qualifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fk_owner</parameter></term>
<listitem>
<para>
The foreign key owner.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fk_table</parameter></term>
<listitem>
<para>
The foreign key table.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an ODBC result identifier or &false; on failure.
</para>
<para>
The result set has the following columns:
@ -62,6 +131,7 @@
<parameter>pk_table</parameter>. This should be one key at most.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file