1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.odbc-gettypeinfo" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_gettypeinfo</refname>
<refpurpose>Retrieves information about data types supported by the data source</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>odbc_gettypeinfo</methodname>
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>data_type</parameter></methodparam>
</methodsynopsis>
<para>
Retrieves information about data types supported by the data source.
</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>data_type</parameter></term>
<listitem>
<para>
The data type, which can be used to restrict the information to a
single data type.
</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:
<itemizedlist>
<listitem><simpara>TYPE_NAME</simpara></listitem>
<listitem><simpara>DATA_TYPE</simpara></listitem>
<listitem><simpara>PRECISION</simpara></listitem>
<listitem><simpara>LITERAL_PREFIX</simpara></listitem>
<listitem><simpara>LITERAL_SUFFIX</simpara></listitem>
<listitem><simpara>CREATE_PARAMS</simpara></listitem>
<listitem><simpara>NULLABLE</simpara></listitem>
<listitem><simpara>CASE_SENSITIVE</simpara></listitem>
<listitem><simpara>SEARCHABLE</simpara></listitem>
<listitem><simpara>UNSIGNED_ATTRIBUTE</simpara></listitem>
<listitem><simpara>MONEY</simpara></listitem>
<listitem><simpara>AUTO_INCREMENT</simpara></listitem>
<listitem><simpara>LOCAL_TYPE_NAME</simpara></listitem>
<listitem><simpara>MINIMUM_SCALE</simpara></listitem>
<listitem><simpara>MAXIMUM_SCALE</simpara></listitem>
</itemizedlist>
</para>
<para>
The result set is ordered by DATA_TYPE and TYPE_NAME.
</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
-->
|