yaz-scan.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.yaz-scan" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>yaz_scan</refname>
  <refpurpose>Prepares for a scan</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>yaz_scan</methodname>
   <methodparam><type>resource</type><parameter>id</parameter></methodparam>
   <methodparam><type>string</type><parameter>type</parameter></methodparam>
   <methodparam><type>string</type><parameter>startterm</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>flags</parameter></methodparam>
  </methodsynopsis>
  <para>
   This function prepares for a Z39.50 Scan Request on the specified 
   connection.
  </para>
  <para>
   To actually transfer the Scan Request to the server and receive the
   Scan Response, <function>yaz_wait</function> must be called. Upon
   completion of <function>yaz_wait</function> call
   <function>yaz_error</function> and <function>yaz_scan_result</function> to
   handle the response.
  </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>type</parameter></term>
     <listitem>
      <para>
       Currently only type <literal>rpn</literal> is supported.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>startterm</parameter></term>
     <listitem>
      <para>
       Starting term point for the scan.
      </para>
      <para>
       The form in which the starting term is specified is given by parameter
       <parameter>type</parameter>.
      </para>
      <para>
       The syntax this parameter is similar to the RPN query as described in
       <function>yaz_search</function>. It consists of zero or more 
       <literal>@attr</literal>-operator specifications, then followed by 
       exactly one token.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       This optional parameter specifies additional information to control 
       the behaviour of the scan request. Three indexes are currently read 
       from the flags array:
       <literal>number</literal> (number of terms requested),
       <literal>position</literal> (preferred position of term) and
       <literal>stepSize</literal> (preferred step size).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>PHP function that scans titles</title>
    <programlisting role="php">
<![CDATA[
<?php
function scan_titles($id, $startterm) 
{
  yaz_scan($id, "rpn", "@attr 1=4 " . $startterm);
  yaz_wait();
  $errno = yaz_errno($id);
  if ($errno == 0) {
    $ar = yaz_scan_result($id, $options);
    echo 'Scan ok; ';
    foreach ($options as $key => $val) {
      echo "$key = $val &nbsp;";
    }
    echo '<br /><table>';
    while (list($key, list($k, $term, $tcount)) = each($ar)) {
      if (empty($k)) continue;
      echo "<tr><td>$term</td><td>$tcount</td></tr>";
    }
    echo '</table>';
  } else {
    echo "Scan failed. Error: " . yaz_error($id) . "<br />";
  }
}
?>
]]>
    </programlisting>
   </example>
  </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
-->