php-doc-en/reference/maxdb/functions/maxdb-fetch-fields.xml
Thomas Simenec c5ff12273c MaxDB PHP documentation
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@177090 c90b9560-bf6c-de11-be94-00142212c4b1
2005-01-12 18:53:25 +00:00

145 lines
3.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1.1.1 $ -->
<refentry id="function.maxdb-fetch-fields">
<refnamediv>
<refname>maxdb_fetch_fields</refname>
<refpurpose>Returns an array of resources representing the fields in a result set</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural Style:</para>
<methodsynopsis>
<type>mixed</type><methodname>maxdb_fetch_fields</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
This function serves an identical purpose to the <function>maxdb_fetch_field</function>
function with the single difference that, instead of returning one resource at a time for
each field, the columns are returned as an array of resources.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<para>
Returns an array of resources which contains field definition informations or &false; if no field information
is available.
</para>
<para>
<table>
<title>Object properties</title>
<tgroup cols='2'>
<thead>
<row>
<entry>Property</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>name</entry>
<entry>The name of the column</entry>
</row>
<row>
<entry>max_length</entry>
<entry>The maximum width of the field for the result set.</entry>
</row>
<row>
<entry>type</entry>
<entry>The data type used for this field</entry>
</row>
<row>
<entry>decimals</entry>
<entry>The number of decimals used (for integer fields)</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_num_fields</function>
<function>maxdb_fetch_field</function>
<function>maxdb_fetch_field_direct</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<example>
<title>Procedural style</title>
<programlisting role="php">
<![CDATA[
<?php
$link = maxdb_connect("localhost", "MONA", "RED");
/* check connection */
if (maxdb_connect_errno()) {
printf("Connect failed: %s\n", maxdb_connect_error());
exit();
}
$query = "SELECT name, cno from hotel.customer ORDER BY cno";
if ($result = maxdb_query($link, $query)) {
/* Get field information for all columns */
$finfo = maxdb_fetch_fields($result);
for ($i=0; $i < count($finfo); $i++) {
printf("Name: %s\n", $finfo[$i]->name);
printf("Table: %s\n", $finfo[$i]->table);
printf("max. Len: %d\n", $finfo[$i]->max_length);
printf("Flags: %d\n", $finfo[$i]->flags);
printf("Type: %d\n\n", $finfo[$i]->type);
}
maxdb_free_result($result);
}
/* close connection */
maxdb_close($link);
?>
]]>
</programlisting>
</example>
<para>
The above examples would produce the following output:
</para>
<screen>
<![CDATA[
Name: NAME
Table:
max. Len: 10
Flags: -1
Type: 2
Name: CNO
Table:
max. Len: 4
Flags: -1
Type: 0
]]>
</screen>
</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:"../../../../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
-->