dickmeiss Tue Mar 13 09:08:09 2001 EDT
Modified files:
/phpdoc/en/functions yaz.xml
Log:
Documentation for yaz_database.
Index: phpdoc/en/functions/yaz.xml
diff -u phpdoc/en/functions/yaz.xml:1.10 phpdoc/en/functions/yaz.xml:1.11
--- phpdoc/en/functions/yaz.xml:1.10 Thu Mar 8 02:47:17 2001
+++ phpdoc/en/functions/yaz.xml Tue Mar 13 09:08:09 2001
@@ -164,8 +164,7 @@
<refnamediv>
<refname>yaz_connect</refname>
<refpurpose>
- Prepares for a connection and Z-association with a target.
- Returns a positive association ID on success; zero on failure
+ Prepares for a connection and Z-association to a Z39.50 target.
</refpurpose>
</refnamediv>
<refsect1>
@@ -182,6 +181,10 @@
</funcprototype>
</funcsynopsis>
<para>
+ This function returns a positive ID on success; zero on
+ failure.
+ </para>
+ <para>
<function>Yaz_connect</function> prepares for a connection to a
Z39.50 target. The zurl argument takes the form
host[:port][/database]. If port is omitted 210 is used. If
@@ -210,8 +213,8 @@
Returns error for target (last request). A positive value is
returned if the target returned a diagnostic code; a value of
zero is returned if no errors occurred (success); negative value
- is returned for other errors targets didn't indicate the error in
- question.
+ is returned for other errors (such as when the target
+ closed connection, etc).
</para>
<para>
<function>yaz_errno</function> should be called after network
@@ -231,7 +234,7 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>yaz_error</function></funcdef>
+ <funcdef>string <function>yaz_error</function></funcdef>
<paramdef>int <parameter>id</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -289,6 +292,38 @@
to specify the element set name for records to be retrieved.
Most servers support <literal>F</literal> (full) and
<literal>B</literal> (brief).
+ </para>
+ <para>
+ Returns true on success; false on error.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.yaz-database">
+ <refnamediv>
+ <refname>yaz_database</refname>
+ <refpurpose>
+ Specifies the databases within a session
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>yaz_database</function></funcdef>
+ <paramdef>int <parameter>id</parameter></paramdef>
+ <paramdef>string <parameter>databases</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ This function specifies one or more databases to be used in search,
+ retrieval, etc. - overriding databases specified in call to
+ <function>yaz_connect</function>. Multiple databases are
+ separated by a plus sign <literal>+</literal>.
+ </para>
+ <para>
+ This function allows you to use different sets of databases within
+ a session.
</para>
<para>
Returns true on success; false on error.
