php-doc-en/reference/maxdb/functions/maxdb-stmt-result-metadata.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1.1.1 $ -->
  <refentry id="function.maxdb-stmt-result-metadata">
   <refnamediv>
    <refname>maxdb_stmt_result_metadata</refname>
    <refpurpose>Returns result set metadata from a prepared statement</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <para>Procedural style:</para>
    <methodsynopsis>
     <type>mixed</type><methodname>maxdb_stmt_result_metadata</methodname>
     <methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
    </methodsynopsis>
    <para>
     If a statement passed to <function>maxdb_prepare</function> is one that produces
     a result set, <function>maxdb_stmt_result_metadata</function> returns the result resource 
     that can be used to process the meta information such as total number of fields 
     and individual field information. 
    </para>
    <note>
     <para>This result set pointer can be passed as an argument to any of the 
      field-based functions that process result set metadata, such as: 
      <itemizedlist>
       <listitem><para><function>maxdb_num_fields</function></para></listitem>
       <listitem><para><function>maxdb_fetch_field</function></para></listitem>
       <listitem><para><function>maxdb_fetch_field_direct</function></para></listitem>
       <listitem><para><function>maxdb_fetch_fields</function></para></listitem>
       <listitem><para><function>maxdb_field_count</function></para></listitem>
       <listitem><para><function>maxdb_field_seek</function></para></listitem>
       <listitem><para><function>maxdb_field_tell</function></para></listitem>
       <listitem><para><function>maxdb_free_result</function></para></listitem>
      </itemizedlist>
     </para>
    </note>
    <para>
     The result set structure should be freed when you are done with it, 
     which you can do by passing it to <function>maxdb_free_result</function>
    </para>
    <note>
     <para>
      The result set returned by <function>maxdb_stmt_result_metadata</function> contains only 
      metadata. It does not contain any row results. The rows are obtained by using the
      statement handle with <function>maxdb_fetch</function>.
     </para> 
    </note>
   </refsect1>
   <refsect1>
    &reftitle.returnvalues;
    <para>
     <function>maxdb_stmt_result_metadata</function> returns a result resource or &false; if
     an error occured.
    </para>
   </refsect1>
   <refsect1>
    <title>See also:</title> 
    <para>
     <function>maxdb_prepare</function>,
     <function>maxdb_free_result</function>
    </para>
   </refsect1>
   <refsect1>
    <title>Example</title>
    <para>
     <example>
      <title>Procedural style</title>
      <programlisting role='php'>
<![CDATA[
<?php
$link = maxdb_connect("localhost", "MONA", "RED");

maxdb_query($link, "CREATE TABLE temp.friends (id int, name varchar(20))"); 
 
maxdb_query($link, "INSERT INTO temp.friends VALUES (1,'Hartmut')");
maxdb_query($link, "INSERT INTO temp.friends VALUES (2, 'Ulf')");

$stmt = maxdb_prepare($link, "SELECT id, name FROM temp.friends");
maxdb_stmt_execute($stmt);

/* get resultset for metadata */
$result = maxdb_stmt_result_metadata($stmt);

/* retrieve field information from metadata result set */
$field = maxdb_fetch_field($result);

printf("Fieldname: %s\n", $field->name);

/* close resultset */
maxdb_free_result($result);

/* close connection */
maxdb_close($link);
?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     The above examples would produce the following output:
    </para>
    <screen>
<![CDATA[
Fieldname: ID
]]>
    </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
-->