<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.yaz-scan-result" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>yaz_scan_result</refname>
  <refpurpose>Returns Scan Response result</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>yaz_scan_result</methodname>
   <methodparam><type>resource</type><parameter>id</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter role="reference">result</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>yaz_scan_result</function> returns terms and associated
   information as received from the server in the last performed
   <function>yaz_scan</function>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>id</parameter></term>
     <listitem>
      <para>
       The connection resource returned by <function>yaz_connect</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>result</parameter></term>
     <listitem>
      <para>
       If given, this array will be modified to hold additional information 
       taken from the Scan Response:
       <itemizedlist>
        <listitem>
         <para>
          <literal>number</literal> - Number of entries returned
         </para>
        </listitem> 
        <listitem>
         <para>
          <literal>stepsize</literal> - Step size
         </para>
        </listitem> 
        <listitem>
         <para>
          <literal>position</literal> - Position of term
         </para>
        </listitem> 
        <listitem>
         <para>
          <literal>status</literal> - Scan status
         </para>
        </listitem> 
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an array (0..n-1) where n is the number of terms returned. Each 
   value is a pair where the first item is the term, and the second item is 
   the result-count.
  </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
-->
