php-doc-en/reference/sybase/functions/sybase-fetch-field.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/sybase.xml, last change in rev 1.2 -->
  <refentry id="function.sybase-fetch-field">
   <refnamediv>
    <refname>sybase_fetch_field</refname>
    <refpurpose>Get field information from a result</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>object</type><methodname>sybase_fetch_field</methodname>
      <methodparam><type>resource</type><parameter>result</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>field_offset</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns an object containing field information.  
    </para>
    <para>
     <function>sybase_fetch_field</function> can be used in order to
     obtain information about fields in a certain query result.  If
     the field offset isn't specified, the next field that wasn't yet
     retreived by <function>sybase_fetch_field</function> is retreived.
    </para>
    <para>
     The properties of the object are:
    </para>
    <itemizedlist>
     <listitem>
      <simpara>
      	name - column name.  if the column is a result of a function, this
       property is set to computed#N,	where #N is a serial number.
      </simpara>
     </listitem>
     <listitem>
      <simpara>
      	column_source - the table from which the column was taken
      </simpara>
     </listitem>
     <listitem>
      <simpara>
      	max_length - maximum length of the column
      </simpara>
     </listitem>
     <listitem>
      <simpara>
      	numeric - 1 if the column is numeric
      </simpara>
     </listitem> 
     <listitem>
      <simpara>
       type - datatype of the column
      </simpara>
     </listitem>
    </itemizedlist>
    <para>
     See also <function>sybase_field_seek</function>.
    </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:"../../../../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
-->