<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mssql-result" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mssql_result</refname>
  <refpurpose>Get result data</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>mssql_result</methodname>
   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
   <methodparam><type>int</type><parameter>row</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>field</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>mssql_result</function> returns the contents of one cell from a
   MS SQL result set. 
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>result</parameter></term>
     <listitem>
      <para>
       The result resource that is being evaluated. This result comes from a
       call to <function>mssql_query</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>row</parameter></term>
     <listitem>
      <para>
       The row number.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>field</parameter></term>
     <listitem>
      <para>
       Can be the field's offset, the field's name or the field's table dot
       field's name (tablename.fieldname). If the column name has been
       aliased ('select foo as bar from...'), it uses the alias instead of
       the column name.
      </para>
      <note>
       <para>
        Specifying a numeric offset for the <parameter>field</parameter>
        argument is much quicker than specifying a 
        <literal>fieldname</literal> or 
        <literal>tablename.fieldname</literal> argument.
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the contents of the specified cell.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>mssql_result</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
// Send a select query to MSSQL
$query = mssql_query('SELECT [username] FROM [php].[dbo].[userlist]');

// Check if there were any records
if (!mssql_num_rows($query)) {
    echo 'No records found';
} else {
    for ($i = 0; $i < mssql_num_rows($query); ++$i) {
        echo mssql_result($query, $i, 'username'), PHP_EOL;
    }
}

// Free the query result
mssql_free_result($query);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Kalle
Felipe
Emil
Ross
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>Faster alternative to above example</title>
    <programlisting role="php">
<![CDATA[
<?php
// Send a select query to MSSQL
$query = mssql_query('SELECT [username] FROM [php].[dbo].[userlist]');

// Check if there were any records
if (!mssql_num_rows($query)) {
    echo 'No records found';
} else {
    while ($row = mssql_fetch_array($query)) {
        echo $row['username'], PHP_EOL;
    }
}

// Free the query result
mssql_free_result($query);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    When working on large result sets, you should consider using one of the
    functions that fetch an entire row (specified below).  As these functions
    return the contents of multiple cells in one function call, they're MUCH
    quicker than <function>mssql_result</function>.  
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   Recommended high-performance alternatives:
   <simplelist>
    <member><function>mssql_fetch_row</function></member>
    <member><function>mssql_fetch_array</function></member>
    <member><function>mssql_fetch_assoc</function></member>
    <member><function>mssql_fetch_object</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
-->