1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<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>yaz_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 administration etc.
</para>
<note>
<para>
Many Z39.50 Servers do not support Extended Services.
</para>
</note>
<para>
The <function>yaz_es</function> creates an Extended Service Request
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
-->
|
