php-doc-en/reference/yaz/functions/yaz-schema.xml
Nilgün Belma Bugüner 4520e770c8 fixed properties
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@283843 c90b9560-bf6c-de11-be94-00142212c4b1
2009-07-11 09:23:09 +00:00

78 lines
2.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry xml:id="function.yaz-schema" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>yaz_schema</refname>
<refpurpose>
Specifies schema for retrieval
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>yaz_schema</methodname>
<methodparam><type>resource</type><parameter>id</parameter></methodparam>
<methodparam><type>string</type><parameter>schema</parameter></methodparam>
</methodsynopsis>
<para>
<function>yaz_schema</function> specifies the schema for retrieval.
</para>
<para>
This function should be called before
<function>yaz_search</function> or <function>yaz_present</function>.
</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>schema</parameter></term>
<listitem>
<para>
Must be specified as an OID (Object Identifier) in a raw dot-notation
(like <literal>1.2.840.10003.13.4</literal>) or as one of the known
registered schemas: <literal>GILS-schema</literal>,
<literal>Holdings</literal>, <literal>Zthes</literal>, ...
</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:"../../../../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
-->