php-doc-en/reference/yaz/functions/yaz-scan-result.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/yaz.xml, last change in rev 1.8 -->
  <refentry id="function.yaz-scan-result">
   <refnamediv>
    <refname>yaz_scan_result</refname>
    <refpurpose>Returns Scan Response result</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>array</type><methodname>yaz_scan_result</methodname>
      <methodparam><type>resource</type><parameter>id</parameter></methodparam>
      <methodparam choice="opt"><type>array</type><parameter>&amp;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>.
     This function 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.
     If the optional parameter <parameter>result</parameter> is given it will be
     modified to hold additional information taken from the Scan Response:
     <literal>number</literal> (number of entries returned),
     <literal>stepsize</literal> (Step-size),
     <literal>position</literal> (position of term),
     <literal>status</literal> (Scan Status).
    </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
-->