odbc-data-source.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.odbc-data-source" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>odbc_data_source</refname>
  <refpurpose>Returns information about a current connection</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>odbc_data_source</methodname>
   <methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
   <methodparam><type>int</type><parameter>fetch_type</parameter></methodparam>
  </methodsynopsis>
  <para>
   This function will return the list of available DSN (after calling it
   several times).
  </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>fetch_type</parameter></term>
     <listitem>
      <para>
       The <parameter>fetch_type</parameter> can be one of two constant types:
       <constant>SQL_FETCH_FIRST</constant>, <constant>SQL_FETCH_NEXT</constant>.
       Use <constant>SQL_FETCH_FIRST</constant> the first time this function is
       called, thereafter use the <constant>SQL_FETCH_NEXT</constant>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns &false; on error, and an array upon success.
  </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
-->