<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.yaz-set-option" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>yaz_set_option</refname>
  <refpurpose>Sets one or more options for connection</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>
   Sets one or more options on the given connection.
  </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>name</parameter> or <parameter>options</parameter></term>
     <listitem>
      <para>
       May be either a string or an array.
      </para>
      <para>
       If given as a string, this will be the name of the option to set. You'll
       need to give it's <parameter>value</parameter>.
      </para>
      <para>
       If given as an array, this will be an associative array (option name 
       => option value).
      </para>
      <table>
       <title>PHP/YAZ Connection Options</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>implementation name of server</entry>
         </row>
         <row>
          <entry>implementationVersion</entry>
          <entry>implementation version of server</entry>
         </row>
         <row>
          <entry>implementationId</entry>
          <entry>implementation ID of server</entry>
         </row>
         <row>
          <entry>schema</entry>
          <entry>
           schema for retrieval. By default, no schema is used. Setting this
           option is equivalent to using function 
           <function>yaz_schema</function>
          </entry>
         </row>
         <row>
          <entry>preferredRecordSyntax</entry>
          <entry>
           record syntax for retrieval. By default, no syntax is used. Setting
           this option is equivalent to using function 
           <function>yaz_syntax</function>
          </entry>
         </row>
         <row>
          <entry>start</entry>
          <entry>
           offset for first record to be retrieved via 
           <function>yaz_search</function> or <function>yaz_present</function>.
           First record is numbered has a start value of 0. Second record has
           start value 1.
           Setting this option in combination with option
           <literal>count</literal> has the same effect as calling
           <function>yaz_range</function> except that records are
           numbered from 1 in <function>yaz_range</function>
          </entry>
         </row>
         <row>
          <entry>count</entry>
          <entry>maximum number of records to be retrieved via
           <function>yaz_search</function> or <function>yaz_present</function>.
          </entry>
         </row>
         <row>
          <entry>elementSetName</entry>
          <entry>element-set-name for retrieval. Setting this option is
           equivalent to calling <function>yaz_element</function>.
          </entry>
         </row>
        </tbody>
       </tgroup>
      </table>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       The new value of the option. Use this only if the previous argument is
       a string.
      </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
-->
