db2-client-info.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 871b71764cdca8238069f27436d96011a6a2cb36 Maintainer: jsgoupil Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.db2-client-info" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_client_info</refname>
  <refpurpose>Retourne un objet avec des propriétés qui décrivent le client de base de données DB2</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>stdClass</type><type>false</type></type><methodname>db2_client_info</methodname>
   <methodparam><type>resource</type><parameter>connection</parameter></methodparam>
  </methodsynopsis>
  
  <para>
   Cette fonction retourne un objet avec des propriétés en lecture seule qui
   retournent des informations à propos du client de base de données DB2. La
   table suivante liste les propriétés du client DB2 :
   <table>
    <title>Propriétés du client DB2</title>
    <tgroup cols="3">
     <thead>
      <row>
       <entry>Nom Propriété</entry>
       <entry>Type de retour</entry>
       <entry>Description</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>APPL_CODEPAGE</entry>
       <entry>&integer;</entry>
       <entry>L'application est un code page.</entry>
      </row>
      <row>
       <entry>CONN_CODEPAGE</entry>
       <entry>&integer;</entry>
       <entry>Le code page pour la connexion courante.</entry>
      </row>
      <row>
       <entry>DATA_SOURCE_NAME</entry>
       <entry>&string;</entry>
       <entry>Le nom source de la donnée (DSN) utilisé pour créer la connexion
        courante à la base de données.</entry>
      </row>
      <row>
       <entry>DRIVER_NAME</entry>
       <entry>&string;</entry>
       <entry>Le nom de la bibliothèque qui implémente la spécification 
        <literal>DB2 Call Level Interface</literal> (CLI).</entry>
      </row>
      <row>
       <entry>DRIVER_ODBC_VER</entry>
       <entry>&string;</entry>
       <entry>La version de ODBC que le client DB2 supporte. Ceci retourne une
        &string; <literal>"MM.mm"</literal> où <varname>MM</varname> est la version majeure et
        <varname>mm</varname> est la version mineure. Le client DB2 retourne
        toujours <literal>"03.51"</literal>.
       </entry>
      </row>
      <row>
       <entry>DRIVER_VER</entry>
       <entry>&string;</entry>
       <entry>La version du client, dans la forme d'une &string; <literal>"MM.mm.uuuu"</literal>
        où <varname>MM</varname> est la version majeure, <varname>mm</varname>
        est la version mineure et <varname>uuuu</varname> est la mise à jour.
        Par exemple, <literal>"08.02.0001"</literal> représente la version majeure 8, la version
        mineure 2, et la mise à jour 1.
       </entry>
      </row>
      <row>
       <entry>ODBC_SQL_CONFORMANCE</entry>
       <entry>&string;</entry>
       <entry>
        <para>Le niveau de grammaire supporté par le client :
         <variablelist>
          <varlistentry>
           <term>MINIMUM</term>
           <listitem>
            <para>
             Supporte le minimum de grammaire SQL de ODBC.
            </para>
           </listitem>
          </varlistentry>
          <varlistentry>
           <term>CORE</term>
           <listitem>
            <para>
             Supporte le noyau de grammaire SQL de ODBC.
            </para>
           </listitem>
          </varlistentry>
          <varlistentry>
           <term>EXTENDED</term>
           <listitem>
            <para>
             Supporte la grammaire étendue SQL de ODBC.
            </para>
           </listitem>
          </varlistentry>
         </variablelist>
        </para>
       </entry>
      </row>
      <row>
       <entry>ODBC_VER</entry>
       <entry>&string;</entry>
       <entry>La version de ODBC que le gestionnaire de pilote ODBC supporte.
        Cela retourne une &string; <literal>"MM.mm.rrrr"</literal> où <varname>MM</varname> est la
        version majeure, <varname>mm</varname> est la version mineure et
        <varname>rrrr</varname> est la mise à jour. Le client DB2 retourne
        toujours <literal>"03.01.0000"</literal>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>
  
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      <para>
       Spécifie la connexion cliente DB2 active.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un objet si l'appel est réussi,&return.falseforfailure;
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>db2_client_info</function></title>
    <para>
     Pour récupérer des informations à propos du client, vous devez passer une
     ressource de connexion de base de données valide à la fonction
     <function>db2_client_info</function>.
    </para>
    <programlisting role="php">
<![CDATA[<?php
$conn = db2_connect( 'SAMPLE', 'db2inst1', 'ibmdb2' );
$client = db2_client_info( $conn );

if ($client) {
    echo "DRIVER_NAME: ";   var_dump( $client->DRIVER_NAME );  
    echo "DRIVER_VER: ";   var_dump( $client->DRIVER_VER );  
    echo "DATA_SOURCE_NAME: ";   var_dump( $client->DATA_SOURCE_NAME );  
    echo "DRIVER_ODBC_VER: ";   var_dump( $client->DRIVER_ODBC_VER );  
    echo "ODBC_VER: ";    var_dump( $client->ODBC_VER );  
    echo "ODBC_SQL_CONFORMANCE: ";  var_dump( $client->ODBC_SQL_CONFORMANCE );  
    echo "APPL_CODEPAGE: ";   var_dump( $client->APPL_CODEPAGE );  
    echo "CONN_CODEPAGE: ";   var_dump( $client->CONN_CODEPAGE );  
}
else {
    echo "Erreur de récupération des informations du client.
     Peut-être que votre connexion à la base de données était invalide.";
}
db2_close($conn);

?>]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
DRIVER_NAME: string(8) "libdb2.a"
DRIVER_VER: string(10) "08.02.0001"
DATA_SOURCE_NAME: string(6) "SAMPLE"
DRIVER_ODBC_VER: string(5) "03.51"
ODBC_VER: string(10) "03.01.0000"
ODBC_SQL_CONFORMANCE: string(8) "EXTENDED"
APPL_CODEPAGE: int(819)
CONN_CODEPAGE: int(819)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>db2_server_info</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
-->