php-doc-en/reference/mssql/functions/mssql-fetch-field.xml
2003-07-03 12:38:23 +00:00

82 lines
2.3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mssql.xml, last change in rev 1.2 -->
<refentry id="function.mssql-fetch-field">
<refnamediv>
<refname>mssql_fetch_field</refname>
<refpurpose>Get field information</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>object</type><methodname>mssql_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>mssql_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
retrieved by <function>mssql_fetch_field</function> is retrieved.
</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 - the column type.
</simpara>
</listitem>
</itemizedlist>
<para>
See also <function>mssql_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
-->