doc-fr/reference/yaz/functions/yaz-scan.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: dams Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="function.yaz-scan" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>yaz_scan</refname>
  <refpurpose>Prépare un scan YAZ</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>
   <function>yaz_scan</function> prépare une requête 
   <literal>"Z39.50 Scan Request"</literal> sur la connexion YAZ spécifiée.
  </para>
  <para>
   Pour réellement transférer la requête <literal>"Scan Request"</literal>
   au serveur et recevoir le <literal>"Scan Response"</literal>, 
   la fonction <function>yaz_wait</function> doit être appelée. 
   Après la fin de <function>yaz_wait</function>, appelez
   <function>yaz_error</function> et <function>yaz_scan_result</function>
   pour connaître la réponse.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>id</parameter></term>
     <listitem>
      <para>
       La ressource de connexion retournée par
       <function>yaz_connect</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem>
      <para>
       Actuellement seulement le type <literal>rpn</literal> est supporté.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>startterm</parameter></term>
     <listitem>
      <para>
       Point de départ du scan.
      </para>
      <para>
       La forme dans laquelle le terme de départ est spécifié est donnée par
       le paramètre <parameter>type</parameter>.
      </para>
      <para>
       La syntaxe de ce paramètre est similaire à la requête RPN comme décrite
       dans <function>yaz_search</function>. Cela consiste à aucune ou
       plusieurs spécifications d'opérateur <literal>@attr</literal>, ensuite
       suivies par exactement une seule marque.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Ce paramètre optionnel spécifie des informations supplémentaires pour
       contrôler le comportement de la requête de scan. Trois index sont
       actuellement lus à partir du tableau d'options :
       <literal>number</literal> (nombre de termes demandés),
       <literal>position</literal> (position préférée du terme) et
       <literal>stepSize</literal> (grandeur de pas préférée).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Fonction PHP qui analyse les titres sur un serveur YAZ</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 ";
    }
    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 "Erreur de Scan. Erreur : " . 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
-->