php-doc-en/reference/yaz/functions/yaz-set-option.xml
Adam Dickmeiss d08f5a3e6e Documentation of yaz_set_option, yaz_get_option and yaz_schema.
More examples for searching as well as CCL. Pointers to
More Z39.50 related links. Connection ID is resource - rather than
integer.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@112077 c90b9560-bf6c-de11-be94-00142212c4b1
2003-01-16 09:44:49 +00:00

103 lines
3.3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.yaz-set-option">
<refnamediv>
<refname>yaz_set_option</refname>
<refpurpose>Sets one or more options for connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</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>
<para>
Sets option <parameter>name</parameter> to <parameter>value</parameter>.
</para>
<table>
<title>PYP/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 target</entry>
</row>
<row>
<entry>implementationVersion</entry>
<entry>implementation version of target</entry>
</row>
<row>
<entry>implementationId</entry>
<entry>implementation ID of target</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>.
Records are numbered from zero and upwards.
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>
</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
-->