<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: ed1aff13602c94f86344bdd7c4fbc31f5a71bf84 Maintainer: yannick Status: ready -->

<!-- Reviewed: yes -->

<refentry xml:id="function.odbc-specialcolumns" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>odbc_specialcolumns</refname>

<refpurpose>Retourne l'ensemble optimal de colonnes</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>Odbc\Result</type><type>false</type></type><methodname>odbc_specialcolumns</methodname>

<methodparam><type>Odbc\Connection</type><parameter>odbc</parameter></methodparam>

<methodparam><type>int</type><parameter>type</parameter></methodparam>

<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>catalog</parameter></methodparam>

<methodparam><type>string</type><parameter>schema</parameter></methodparam>

<methodparam><type>string</type><parameter>table</parameter></methodparam>

<methodparam><type>int</type><parameter>scope</parameter></methodparam>

<methodparam><type>int</type><parameter>nullable</parameter></methodparam>

</methodsynopsis>

<para>

Retourne soit l'ensemble optimal de colonnes qui identifie de façon unique

une ligne d'une table, ou les colonnes qui sont automatiquement mises à

jour lorsqu'un des valeurs de la ligne est mise à jour par une transaction.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>odbc</parameter></term>

<listitem>

&odbc.connection.id;

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>type</parameter></term>

<listitem>

<simpara>

Lorsque le type est <constant>SQL_BEST_ROWID</constant>,

<function>odbc_specialcolumns</function>

retourne la ou les colonnes qui permettent de repérer uniquement

chaque ligne d'une table.

</simpara>

<simpara>

Lorsque le type est <constant>SQL_ROWVER</constant>,

<function>odbc_specialcolumns</function> retourne la colonne ou les colonnes

de la table spécifiée, s'il y en a, elles sont automatiquement mises à jour

par les données sources lorsque chaque valeur de la ligne est mise à jour

par n'importe quelle transaction.

</simpara>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>catalog</parameter></term>

<listitem>

<para>

&odbc.parameter.catalog;

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>schema</parameter></term>

<listitem>

<para>

&odbc.parameter.schema;

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>table</parameter></term>

<listitem>

<para>

La table.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>scope</parameter></term>

<listitem>

<para>

Le <parameter>scope</parameter>, qui ordonne le jeu de résultats.

Un de <constant>SQL_SCOPE_CURROW</constant>, <constant>SQL_SCOPE_TRANSACTION</constant>

ou <constant>SQL_SCOPE_SESSION</constant>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>nullable</parameter></term>

<listitem>

<para>

Détermine si les colonnes spéciales qui peuvent avoir une valeur NULL

doivent être retourné ou non.

Un de <constant>SQL_NO_NULLS</constant> ou <constant>SQL_NULLABLE</constant>.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

&odbc.result.object-return-falseforfailure;

</para>

<para>

Le jeu de résultat contient les colonnes suivantes :

<itemizedlist>

<listitem><simpara><literal>SCOPE</literal></simpara></listitem>

<listitem><simpara><literal>COLUMN_NAME</literal></simpara></listitem>

<listitem><simpara><literal>DATA_TYPE</literal></simpara></listitem>

<listitem><simpara><literal>TYPE_NAME</literal></simpara></listitem>

<listitem><simpara><literal>COLUMN_SIZE</literal></simpara></listitem>

<listitem><simpara><literal>BUFFER_LENGTH</literal></simpara></listitem>

<listitem><simpara><literal>DECIMAL_DIGITS</literal></simpara></listitem>

<listitem><simpara><literal>PSEUDO_COLUMN</literal></simpara></listitem>

</itemizedlist>

&odbc.result.driver-specific;

</para>

<simpara>

Le jeu de résultat est ordonné par <literal>SCOPE</literal>.

</simpara>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

&odbc.changelog.connection-param;

&odbc.changelog.result-return;

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>odbc_tables</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

-->