yaz-set-option.xml

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

<refentry xml:id="function.yaz-set-option" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>yaz_set_option</refname>
  <refpurpose>Modifie une ou plusieurs options de connexion YAZ</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>yaz_set_option</methodname>
   <methodparam><type>resource</type><parameter>id</parameter></methodparam>
   <methodparam><type>string</type><parameter>name</parameter></methodparam>
   <methodparam><type>string</type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <methodsynopsis>
   <type>void</type><methodname>yaz_set_option</methodname>
   <methodparam><type>resource</type><parameter>id</parameter></methodparam>
   <methodparam><type>array</type><parameter>options</parameter></methodparam>
  </methodsynopsis>
  <para>
   Modifie une ou plusieurs options sur la connexion donnée.
  </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>name</parameter> ou <parameter>options</parameter></term>
     <listitem>
      <para>
       Peut être soit une chaîne de caractères ou un tableau.
      </para>
      <para>
       Si donné comme chaîne de caractères, cela sera le nom de l'option
       à spécifier. Vous devrez donner sa valeur <parameter>value</parameter>.
      </para>
      <para>
       Si donné comme tableau, cela sera un tableau associatif (nom de
       l'option => valeur de l'option).
      </para>
      <table>
       <title>Options de connexion PHP/YAZ</title>
       <tgroup cols="2">
        <colspec colwidth="2*" colname="name"/>
        <colspec colwidth="5*" colname="description"/>
        <thead>
         <row>
          <entry>&Name;</entry>
          <entry>&Description;</entry>
         </row>
        </thead>
        <tbody>
         <row>
          <entry>implementationName</entry>
          <entry>Nom de l'implémentation du serveur</entry>
         </row>
         <row>
          <entry>implementationVersion</entry>
          <entry>Version de l'implémentation du serveur</entry>
         </row>
         <row>
          <entry>implementationId</entry>
          <entry>ID de l'implémentation du serveur</entry>
         </row>
         <row>
          <entry>schema</entry>
          <entry>
           Schéma de lecture. Par défaut, aucun schéma n'est
           utilisé. Modifier cette option équivaut à
           utiliser la fonction <function>yaz_schema</function>
          </entry>
         </row>
         <row>
          <entry>preferredRecordSyntax</entry>
          <entry>
           Syntaxe des enregistrements en lecture. Par défaut, il
           n'y a pas de syntaxe. Modifier cette option équivaut à
           utiliser la fonction <function>yaz_syntax</function>
          </entry>
         </row>
         <row>
          <entry>start</entry>
          <entry>
           Décalage du premier enregistrement à lire,
           via la fonction <function>yaz_search</function> ou
           <function>yaz_present</function>. Les enregistrements
           sont numérotés à partir de 0. Modifier cette option,
           en combinaison avec l'option <literal>count</literal>,
           équivaut à utiliser la fonction
           <function>yaz_range</function>, hormis le fait que les
           enregistrements sont numérotés à partir de
           1 avec <function>yaz_range</function>
          </entry>
         </row>
         <row>
          <entry>count</entry>
          <entry>Nombre maximal d'enregistrements à lire via
           <function>yaz_search</function> et <function>yaz_present</function>.
          </entry>
         </row>
         <row>
          <entry>elementSetName</entry>
          <entry>element-set-name en lecture. Modifier cette option équivaut à
           utiliser la fonction <function>yaz_element</function>.
          </entry>
         </row>
        </tbody>
       </tgroup>
      </table>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       La nouvelle valeur de l'option. Utilisez cet argument seulement si
       l'argument précédent est une chaîne de caractères.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </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
-->