sqlsrv-field-metadata.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.sqlsrv-field-metadata" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>sqlsrv_field_metadata</refname>
  <refpurpose>Retrieves metadata for the fields of a statement prepared by 
  <function>sqlsrv_prepare</function> or <function>sqlsrv_query</function>
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>sqlsrv_field_metadata</methodname>
   <methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
  </methodsynopsis>
  <para>
   Retrieves metadata for the fields of a statement prepared by 
   <function>sqlsrv_prepare</function> or <function>sqlsrv_query</function>. 
   <function>sqlsrv_field_metadata</function> can be called on a statement before 
   or after statement execution.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stmt</parameter></term>
     <listitem>
      <para>
       The statment resource for which metadata is returned.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an array of arrays is returned on success. Otherwise, &false; is returned. 
   Each returned array is described by the following table:
   <table>
   <title>Array returned by sqlsrv_field_metadata</title>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>Key</entry>
      <entry>Description</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>Name</entry>
      <entry>The name of the field.</entry>
     </row>
     <row>
      <entry>Type</entry>
      <entry>The numeric value for the SQL type.</entry>
     </row>
     <row>
      <entry>Size</entry>
      <entry>The number of characters for fields of character type, the number of 
      bytes for fields of binary type, or &null; for other types.</entry>
     </row>
     <row>
      <entry>Precision</entry>
      <entry>The precision for types of variable precision, &null; for other types.</entry>
     </row>
     <row>
      <entry>Scale</entry>
      <entry>The scale for types of variable scale, &null; for other types.</entry>
     </row>
     <row>
      <entry>Nullable</entry>
      <entry>An enumeration indicating whether the column is nullable, not nullable, 
      or if it is not known.</entry>
     </row>
    </tbody>
   </tgroup>
  </table>
  For more information, see <link xlink:href="&url.sqlsrv.field.metadata;">sqlsrv_field_metadata</link> 
  in the Microsoft SQLSRV documentation.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>sqlsrv_field_metadata</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$serverName = "serverName\sqlexpress";
$connectionInfo = array( "Database"=>"AdventureWorks", "UID"=>"username", "PWD"=>"password");
$conn = sqlsrv_connect( $serverName, $connectionInfo);
if( $conn === false ) {
   die( print_r( sqlsrv_errors(), true));
}

$sql = "SELECT * FROM Table_1";
$stmt = sqlsrv_prepare( $conn, $sql );

foreach( sqlsrv_field_metadata( $stmt ) as $fieldMetadata ) {
    foreach( $fieldMetadata as $name => $value) {
       echo "$name: $value<br />";
    }
      echo "<br />";
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>sqlsrv_client_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
-->