dickmeiss Tue Apr 25 20:38:54 2006 UTC
Added files:
/phpdoc/en/reference/yaz/functions yaz-es.xml
Modified files:
/phpdoc/en/reference/yaz/functions yaz-es-result.xml
Log:
Document yaz_es_result, yaz_es
http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/yaz/functions/yaz-es-result.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/yaz/functions/yaz-es-result.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-es-result.xml:1.3
phpdoc/en/reference/yaz/functions/yaz-es-result.xml:1.4
--- phpdoc/en/reference/yaz/functions/yaz-es-result.xml:1.3 Tue Apr 5
16:18:39 2005
+++ phpdoc/en/reference/yaz/functions/yaz-es-result.xml Tue Apr 25 20:38:54 2006
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.yaz-es-result">
<refnamediv>
<refname>yaz_es_result</refname>
@@ -14,7 +14,12 @@
<methodparam><type>resource</type><parameter>id</parameter></methodparam>
</methodsynopsis>
- &warn.undocumented.func;
+ <para>
+ This function inspects the last returned Extended Service
+ result from a server. An Extended Service is initiated
+ by either <function>yaz_item_order</function> or
+ <function>yaz_es</function>.
+ </para>
</refsect1>
<refsect1 role="parameters">
@@ -32,6 +37,25 @@
</variablelist>
</para>
</refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns array with element <literal>targetReference</literal>
+ for the reference for the extended service operation (generated
+ and returned from the server).
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>yaz_es</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/yaz/functions/yaz-es.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/yaz/functions/yaz-es.xml
+++ phpdoc/en/reference/yaz/functions/yaz-es.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.yaz-es">
<refnamediv>
<refname>yaz_es</refname>
<refpurpose>
Prepares for an Extended Service Request
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>yes_es</methodname>
<methodparam>
<type>resource</type><parameter>id</parameter>
</methodparam>
<methodparam>
<type>string</type><parameter>type</parameter>
</methodparam>
<methodparam>
<type>array</type><parameter>args</parameter>
</methodparam>
</methodsynopsis>
<para>
This function prepares for an Extended Service Request.
Extended Services is family of various Z39.50 facilities, such
as Record Update, Item Order, Database administation etc.
</para>
<note>
<para>
Many Z39.50 Servers do not support Extended Services.
</para>
</note>
<para>
The <function>yes_es</function> creates an Extended Service Reuqest
packages and puts it into a queue of operations.
Use <function>yaz_wait</function> to send the request(s) to the server.
After completion of <function>yaz_wait</function> the result of
the Extended Service operation should be expected with
a call to <function>yaz_es_result</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>type</parameter></term>
<listitem>
<para>
A string which represents the type of the Extended Service:
<literal>itemorder</literal> (Item Order),
<literal>create</literal> (Create Database),
<literal>drop</literal> (Drop Database),
<literal>commit</literal> (Commit Operation),
<literal>update</literal> (Update Record),
<literal>xmlupdate</literal> (XML Update).
Each type is specified in the following section.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem>
<para>
An array with extended service options plus
package specific options. The options are identical to
those offered in the C API of ZOOM C. Refer to
the ZOOM <ulink url="&url.yaz.zoom.ext">Extended Services</ulink>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Record Update</title>
<programlisting role="php">
<![CDATA[
<?php
$con = yaz_connect("myhost/database");
$args = array (
"record" => "<gils><title>some title</title></gils>",
"syntax" => "xml",
"action" => "specialUpdate"
);
yaz_es($con, "update", $args);
yaz_wait();
$result = yaz_es_result($id);
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>yaz_es_result</function></member>
</simplelist>
</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
-->
