3 ZOOM_connection_errcode(c)
4 ZOOM_connection_errmsg(c)
5 ZOOM_connection_addinfo(c)
6 ZOOM_connection_addinfo(c)
7 ZOOM_connection_diagset(c);
9 ZOOM_resultset_record_immediate(s, pos)
10 ZOOM_resultset_cache_reset(r)
11 ZOOM_resultset_sort(r, sort_type, sort_spec)
12 ZOOM_resultset_sort1(r, sort_type, sort_spec)
13 ZOOM_options_set_callback(opt, function, handle)
14 ZOOM_options_create_with_parent2(parent1, parent2)
15 ZOOM_options_getl(opt, name, len)
16 ZOOM_options_setl(opt, name, value, len)
17 ZOOM_options_get_bool(opt, name, defa)
18 ZOOM_options_get_int(opt, name, defa)
19 ZOOM_options_set_int(opt, name, value)
20 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query startterm)
21 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
23 <chapter id="zoom"><title>ZOOM</title>
25 &zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is
26 an initiative started by Mike Taylor (Mike is from the UK, which
27 explains the peculiar name of the model). The goal of &zoom; is to
28 provide a common Z39.50 client API not bound to a particular
29 programming language or toolkit.
33 From YAZ version 2.1.12, <ulink url="&url.sru;">SRU</ulink> is supported.
34 You can make SRU ZOOM connections by specifying scheme
35 <literal>http://</literal> for the hostname for a connection.
36 The dialect of SRU used is specified by the value of the
37 connection's <literal>sru</literal> option, which may be SRU over
38 HTTP GET (<literal>get</literal>),
39 SRU over HTTP POST (<literal>post</literal>), (SRU over
40 SOAP) (<literal>soap</literal>) or <literal>SOLR</literal>
41 (<ulink url="&url.solr;">SOLR</ulink> Web Service).
42 Using the facility for embedding options in target strings, a
43 connection can be forced to use SRU rather the SRW (the default) by
44 prefixing the target string with <literal>sru=get,</literal>, like this:
45 <literal>sru=get,http://sru.miketaylor.org.uk:80/sru.pl</literal>
49 The lack of a simple Z39.50 client API for &yaz; has become more
50 and more apparent over time. So when the first &zoom; specification
52 an implementation for &yaz; was quickly developed. For the first time, it is
53 now as easy (or easier!) to develop clients than servers with &yaz;. This
54 chapter describes the &zoom; C binding. Before going further, please
55 reconsider whether C is the right programming language for the job.
56 There are other language bindings available for &yaz;, and still
58 are in active development. See the
59 <ulink url="&url.zoom;">ZOOM web-site</ulink> for
64 In order to fully understand this chapter you should read and
65 try the example programs <literal>zoomtst1.c</literal>,
66 <literal>zoomtst2.c</literal>, .. in the <literal>zoom</literal>
71 The C language misses features found in object oriented languages
72 such as C++, Java, etc. For example, you'll have to manually,
73 destroy all objects you create, even though you may think of them as
74 temporary. Most objects has a <literal>_create</literal> - and a
75 <literal>_destroy</literal> variant.
76 All objects are in fact pointers to internal stuff, but you don't see
77 that because of typedefs. All destroy methods should gracefully ignore a
78 <literal>NULL</literal> pointer.
81 In each of the sections below you'll find a sub section called
82 protocol behavior, that describes how the API maps to the Z39.50
85 <sect1 id="zoom-connections"><title>Connections</title>
87 <para>The Connection object is a session with a target.
90 #include <yaz/zoom.h>
92 ZOOM_connection ZOOM_connection_new (const char *host, int portnum);
94 ZOOM_connection ZOOM_connection_create (ZOOM_options options);
96 void ZOOM_connection_connect(ZOOM_connection c, const char *host,
98 void ZOOM_connection_destroy(ZOOM_connection c);
101 Connection objects are created with either function
102 <function>ZOOM_connection_new</function> or
103 <function>ZOOM_connection_create</function>.
104 The former creates and automatically attempts to establish a network
105 connection with the target. The latter doesn't establish
106 a connection immediately, thus allowing you to specify options
107 before establishing network connection using the function
108 <function>ZOOM_connection_connect</function>.
109 If the port number, <literal>portnum</literal>, is zero, the
110 <literal>host</literal> is consulted for a port specification.
111 If no port is given, 210 is used. A colon denotes the beginning of
112 a port number in the host string. If the host string includes a
113 slash, the following part specifies a database for the connection.
116 You can prefix the host with a scheme followed by colon. The
117 default scheme is <literal>tcp</literal> (Z39.50 protocol).
118 The scheme <literal>http</literal> selects SRU over HTTP.
121 You can prefix the scheme-qualified host-string with one or more
123 <literal><parameter>key</parameter>=<parameter>value</parameter></literal>
124 sequences, each of which represents an option to be set into the
125 connection structure <emphasis>before</emphasis> the
126 protocol-level connection is forged and the initialization
127 handshake takes place. This facility can be used to provide
128 authentication credentials, as in host-strings such as:
129 <literal>user=admin,password=halfAm4n,tcp:localhost:8017/db</literal>
132 Connection objects should be destroyed using the function
133 <function>ZOOM_connection_destroy</function>.
136 void ZOOM_connection_option_set(ZOOM_connection c,
137 const char *key, const char *val);
139 void ZOOM_connection_option_setl(ZOOM_connection c,
141 const char *val, int len);
143 const char *ZOOM_connection_option_get(ZOOM_connection c,
145 const char *ZOOM_connection_option_getl(ZOOM_connection c,
150 The functions <function>ZOOM_connection_option_set</function> and
151 <function>ZOOM_connection_option_setl</function> allows you to
152 set an option given by <parameter>key</parameter> to the value
153 <parameter>value</parameter> for the connection.
154 For <function>ZOOM_connection_option_set</function>, the
155 value is assumed to be a 0-terminated string. Function
156 <function>ZOOM_connection_option_setl</function> specifies a
157 value of a certain size (len).
160 Functions <function>ZOOM_connection_option_get</function> and
161 <function>ZOOM_connection_option_getl</function> returns
162 the value for an option given by <parameter>key</parameter>.
164 <table id="zoom-connection-options" frame="top">
165 <title>ZOOM Connection Options</title>
167 <colspec colwidth="4*" colname="name"></colspec>
168 <colspec colwidth="7*" colname="description"></colspec>
169 <colspec colwidth="3*" colname="default"></colspec>
172 <entry>Option</entry>
173 <entry>Description</entry>
174 <entry>Default</entry>
179 implementationName</entry><entry>Name of Your client
180 </entry><entry>none</entry></row>
182 user</entry><entry>Authentication user name
183 </entry><entry>none</entry></row>
185 group</entry><entry>Authentication group name
186 </entry><entry>none</entry></row>
188 password</entry><entry>Authentication password.
189 </entry><entry>none</entry></row>
191 host</entry><entry>Target host. This setting is "read-only".
192 It's automatically set internally when connecting to a target.
193 </entry><entry>none</entry></row>
195 proxy</entry><entry>Proxy host. If set, the logical host
196 is encoded in the otherInfo area of the Z39.50 Init PDU
197 with OID 1.2.840.10003.10.1000.81.1.
198 </entry><entry>none</entry></row>
200 clientIP</entry><entry>Client IP. If set, is
201 encoded in the otherInfo area of a Z39.50 PDU with OID
202 1.2.840.10003.10.1000.81.3. Holds the original IP addreses
203 of a client. Is used of ZOOM is used in a gateway of some sort.
204 </entry><entry>none</entry></row>
206 async</entry><entry>If true (1) the connection operates in
207 asynchronous operation which means that all calls are non-blocking
209 <link linkend="zoom.events"><function>ZOOM_event</function></link>.
210 </entry><entry>0</entry></row>
212 maximumRecordSize</entry><entry> Maximum size of single record.
213 </entry><entry>1 MB</entry></row>
215 preferredMessageSize</entry><entry> Maximum size of multiple records.
216 </entry><entry>1 MB</entry></row>
218 lang</entry><entry> Language for negotiation.
219 </entry><entry>none</entry></row>
221 charset</entry><entry> Character set for negotiation.
222 </entry><entry>none</entry></row>
224 serverImplementationId</entry><entry>
225 Implementation ID of server. (The old targetImplementationId
226 option is also supported for the benefit of old applications.)
227 </entry><entry>none</entry></row>
229 targetImplementationName</entry><entry>
230 Implementation Name of server. (The old
231 targetImplementationName option is also supported for the
232 benefit of old applications.)
233 </entry><entry>none</entry></row>
235 serverImplementationVersion</entry><entry>
236 Implementation Version of server. (the old
237 targetImplementationVersion option is also supported for the
238 benefit of old applications.)
239 </entry><entry>none</entry></row>
241 databaseName</entry><entry>One or more database names
242 separated by character plus (<literal>+</literal>), which to
243 be used by subsequent search requests on this Connection.
244 </entry><entry>Default</entry></row>
246 piggyback</entry><entry>True (1) if piggyback should be
247 used in searches; false (0) if not.
248 </entry><entry>1</entry></row>
250 smallSetUpperBound</entry><entry>If hits is less than or equal to this
251 value, then target will return all records using small element set name
252 </entry><entry>0</entry></row>
254 largeSetLowerBound</entry><entry>If hits is greater than this
255 value, the target will return no records.
256 </entry><entry>1</entry></row>
258 mediumSetPresentNumber</entry><entry>This value represents
259 the number of records to be returned as part of a search when when
260 hits is less than or equal to large set lower bound and if hits
261 is greater than small set upper bound.
262 </entry><entry>0</entry></row>
264 smallSetElementSetName</entry><entry>
265 The element set name to be used for small result sets.
266 </entry><entry>none</entry></row>
268 mediumSetElementSetName</entry><entry>
269 The element set name to be for medium-sized result sets.
270 </entry><entry>none</entry></row>
272 init_opt_search, init_opt_present, init_opt_delSet, etc.</entry><entry>
273 After a successful Init, these options may be interrogated to
274 discover whether the server claims to support the specified
276 </entry><entry>none</entry></row>
279 SRU transport type. Must be either <literal>soap</literal>,
280 <literal>get</literal>, <literal>post</literal>, or
281 <literal>solr</literal>.
282 </entry><entry>soap</entry></row>
284 sru_version</entry><entry>
285 SRU/SRW version. Should be <literal>1.1</literal>, or
286 <literal>1.2</literal>. This is , prior to connect, the version
287 to offer (highest version). And following connect (in fact
288 first operation), holds the negotiated version with the server
289 (same or lower version).
290 </entry><entry>1.2</entry></row>
292 facets</entry><entry>
293 A FacetList is comma-separated list of facet, which is defined
294 as <literal>AttributeList</literal> and a optional FacetTerm
295 (a Term and a frequency). On request the terms is missing.
296 On response the the list contains the terms that the target
298 </entry><entry>none</entry></row>
303 If either option <literal>lang</literal> or <literal>charset</literal>
305 <ulink url="&url.z39.50.charneg;">
306 Character Set and Language Negotiation</ulink> is in effect.
309 int ZOOM_connection_error(ZOOM_connection c, const char **cp,
310 const char **addinfo);
311 int ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
312 const char **addinfo, const char **dset);
315 Function <function>ZOOM_connection_error</function> checks for
316 errors for the last operation(s) performed. The function returns
317 zero if no errors occurred; non-zero otherwise indicating the error.
318 Pointers <parameter>cp</parameter> and <parameter>addinfo</parameter>
319 holds messages for the error and additional-info if passed as
320 non-<literal>NULL</literal>. Function
321 <function>ZOOM_connection_error_x</function> is an extended version
322 of <function>ZOOM_connection_error</function> that is capable of
323 returning name of diagnostic set in <parameter>dset</parameter>.
325 <sect2 id="zoom-connection-z39.50">
326 <title>Z39.50 Protocol behavior</title>
328 The calls <function>ZOOM_connection_new</function> and
329 <function>ZOOM_connection_connect</function> establishes a TCP/IP
330 connection and sends an Initialize Request to the target if
331 possible. In addition, the calls waits for an Initialize Response
332 from the target and the result is inspected (OK or rejected).
335 If <literal>proxy</literal> is set then the client will establish
336 a TCP/IP connection with the peer as specified by the
337 <literal>proxy</literal> host and the hostname as part of the
338 connect calls will be set as part of the Initialize Request.
339 The proxy server will then "forward" the PDU's transparently
340 to the target behind the proxy.
343 For the authentication parameters, if option <literal>user</literal>
344 is set and both options <literal>group</literal> and
345 <literal>pass</literal> are unset, then Open style
346 authentication is used (Version 2/3) in which case the username
347 is usually followed by a slash, then by a password.
348 If either <literal>group</literal>
349 or <literal>pass</literal> is set then idPass authentication
350 (Version 3 only) is used. If none of the options are set, no
351 authentication parameters are set as part of the Initialize Request
355 When option <literal>async</literal> is 1, it really means that
356 all network operations are postponed (and queued) until the
357 function <literal>ZOOM_event</literal> is invoked. When doing so
358 it doesn't make sense to check for errors after
359 <literal>ZOOM_connection_new</literal> is called since that
360 operation "connecting - and init" is still incomplete and the
361 API cannot tell the outcome (yet).
364 <sect2 id="zoom.sru.init.behavior">
365 <title>SRU Protocol behavior</title>
367 The SRU protocol doesn't feature an Inititialize Request, so
368 the connection phase merely establishes a TCP/IP connection
369 with the SOAP service.
371 <para>Most of the ZOOM connection options do not
372 affect SRU and they are ignored. However, future versions
373 of &yaz; might honor <literal>implementationName</literal> and
374 put that as part of User-Agent header for HTTP requests.
377 The <literal>charset</literal> is used in the Content-Type header
382 <sect1 id="zoom.query"><title>Queries</title>
384 Query objects represents queries.
387 ZOOM_query ZOOM_query_create(void);
389 void ZOOM_query_destroy(ZOOM_query q);
391 int ZOOM_query_prefix(ZOOM_query q, const char *str);
393 int ZOOM_query_cql(ZOOM_query s, const char *str);
395 int ZOOM_query_sortby(ZOOM_query q, const char *criteria);
398 Create query objects using <function>ZOOM_query_create</function>
399 and destroy them by calling <function>ZOOM_query_destroy</function>.
400 RPN-queries can be specified in <link linkend="PQF">PQF</link>
401 notation by using the
402 function <function>ZOOM_query_prefix</function>.
403 The <function>ZOOM_query_cql</function> specifies a CQL
404 query to be sent to the server/target.
405 More query types will be added in future versions of &yaz;, such as
406 <link linkend="CCL">CCL</link> to RPN-mapping, native CCL query,
407 etc. In addition to a search, a sort criteria may be set. Function
408 <function>ZOOM_query_sortby</function> specifies a
409 sort criteria using the same string notation for sort as offered by
410 the <link linkend="sortspec">YAZ client</link>.
412 <sect2 id="zoom.sort.behavior"><title>Protocol behavior</title>
414 The query object is just an interface for the member Query
415 in the SearchRequest. The sortby-function is an interface to the
416 sortSequence member of the SortRequest.
420 <sect1 id="zoom.resultsets"><title>Result sets</title>
422 The result set object is a container for records returned from
426 ZOOM_resultset ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
428 ZOOM_resultset ZOOM_connection_search_pqf(ZOOM_connection c,
430 void ZOOM_resultset_destroy(ZOOM_resultset r);
433 Function <function>ZOOM_connection_search</function> creates
434 a result set given a connection and query.
435 Destroy a result set by calling
436 <function>ZOOM_resultset_destroy</function>.
437 Simple clients may using PQF only may use function
438 <function>ZOOM_connection_search_pqf</function> in which case
439 creating query objects is not necessary.
442 void ZOOM_resultset_option_set(ZOOM_resultset r,
443 const char *key, const char *val);
445 const char *ZOOM_resultset_option_get(ZOOM_resultset r, const char *key);
447 size_t ZOOM_resultset_size(ZOOM_resultset r);
450 Functions <function>ZOOM_resultset_options_set</function> and
451 <function>ZOOM_resultset_get</function> sets and gets an option
452 for a result set similar to <function>ZOOM_connection_option_get</function>
453 and <function>ZOOM_connection_option_set</function>.
456 The number of hits also called result-count is returned by
457 function <function>ZOOM_resultset_size</function>.
459 <table id="zoom.resultset.options"
460 frame="top"><title>ZOOM Result set Options</title>
462 <colspec colwidth="4*" colname="name"></colspec>
463 <colspec colwidth="7*" colname="description"></colspec>
464 <colspec colwidth="2*" colname="default"></colspec>
467 <entry>Option</entry>
468 <entry>Description</entry>
469 <entry>Default</entry>
474 start</entry><entry>Offset of first record to be
475 retrieved from target. First record has offset 0 unlike the
476 protocol specifications where first record has position 1.
477 This option affects ZOOM_resultset_search and
478 ZOOM_resultset_search_pqf and must be set before any of
479 these functions are invoked. If a range of
480 records must be fetched manually after search,
481 function ZOOM_resultset_records should be used.
482 </entry><entry>0</entry></row>
484 count</entry><entry>Number of records to be retrieved.
485 This option affects ZOOM_resultset_search and
486 ZOOM_resultset_search_pqf and must be set before any of
487 these functions are invoked.
488 </entry><entry>0</entry></row>
490 presentChunk</entry><entry>The number of records to be
491 requested from the server in each chunk (present request). The
492 value 0 means to request all the records in a single chunk.
493 (The old <literal>step</literal>
494 option is also supported for the benefit of old applications.)
495 </entry><entry>0</entry></row>
497 elementSetName</entry><entry>Element-Set name of records.
498 Most targets should honor element set name <literal>B</literal>
499 and <literal>F</literal> for brief and full respectively.
500 </entry><entry>none</entry></row>
502 preferredRecordSyntax</entry><entry>Preferred Syntax, such as
503 <literal>USMARC</literal>, <literal>SUTRS</literal>, etc.
504 </entry><entry>none</entry></row>
506 schema</entry><entry>Schema for retrieval, such as
507 <literal>Gils-schema</literal>, <literal>Geo-schema</literal>, etc.
508 </entry><entry>none</entry></row>
510 setname</entry><entry>Name of Result Set (Result Set ID).
511 If this option isn't set, the ZOOM module will automatically
512 allocate a result set name.
513 </entry><entry>default</entry></row>
515 rpnCharset</entry><entry>Character set for RPN terms.
516 If this is set, ZOOM C will assume that the ZOOM application is
517 running UTF-8. Terms in RPN queries are then converted to the
518 rpnCharset. If this is unset, ZOOM C will not assume any encoding
519 of RPN terms and no conversion is performed.
520 </entry><entry>none</entry></row>
525 For servers that support Search Info report, the following
526 options may be read using <function>ZOOM_resultset_get</function>.
527 This detailed information is read after a successful search has
531 This information is a list of of items, where each item is
532 information about a term or subquery. All items in the list
534 <literal>SearchResult.</literal><replaceable>no</replaceable>
535 where no presents the item number (0=first, 1=second).
536 Read <literal>searchresult.size</literal> to determine the
539 <table id="zoom.search.info.report.options"
540 frame="top"><title>Search Info Report Options</title>
542 <colspec colwidth="4*" colname="name"></colspec>
543 <colspec colwidth="7*" colname="description"></colspec>
546 <entry>Option</entry>
547 <entry>Description</entry>
552 <entry>searchresult.size</entry>
554 number of search result entries. This option is-nonexistant
555 if no entries are returned by the server.
559 <entry>searchresult.<replaceable>no</replaceable>.id</entry>
560 <entry>sub query ID</entry>
563 <entry>searchresult.<replaceable>no</replaceable>.count</entry>
564 <entry>result count for item (number of hits)</entry>
567 <entry>searchresult.<replaceable>no</replaceable>.subquery.term</entry>
568 <entry>subquery term</entry>
572 searchresult.<replaceable>no</replaceable>.interpretation.term
574 <entry>interpretation term</entry>
578 searchresult.<replaceable>no</replaceable>.recommendation.term
580 <entry>recommendation term</entry>
585 <sect2 id="zoom.z3950.resultset.behavior">
586 <title>Z39.50 Protocol behavior</title>
588 The creation of a result set involves at least a SearchRequest
589 - SearchResponse protocol handshake. Following that, if a sort
590 criteria was specified as part of the query, a SortRequest -
591 SortResponse handshake takes place. Note that it is necessary to
592 perform sorting before any retrieval takes place, so no records will
593 be returned from the target as part of the SearchResponse because these
594 would be unsorted. Hence, piggyback is disabled when sort criteria
595 are set. Following Search - and a possible sort - Retrieval takes
596 place - as one or more Present Requests/Response pairs being
600 The API allows for two different modes for retrieval. A high level
601 mode which is somewhat more powerful and a low level one.
602 The low level is enabled when searching on a Connection object
603 for which the settings
604 <literal>smallSetUpperBound</literal>,
605 <literal>mediumSetPresentNumber</literal> and
606 <literal>largeSetLowerBound</literal> are set. The low level mode
607 thus allows you to precisely set how records are returned as part
608 of a search response as offered by the Z39.50 protocol.
609 Since the client may be retrieving records as part of the
610 search response, this mode doesn't work well if sorting is used.
613 The high-level mode allows you to fetch a range of records from
614 the result set with a given start offset. When you use this mode
615 the client will automatically use piggyback if that is possible
616 with the target and perform one or more present requests as needed.
617 Even if the target returns fewer records as part of a present response
618 because of a record size limit, etc. the client will repeat sending
619 present requests. As an example, if option <literal>start</literal>
620 is 0 (default) and <literal>count</literal> is 4, and
621 <literal>piggyback</literal> is 1 (default) and no sorting criteria
622 is specified, then the client will attempt to retrieve the 4
623 records as part the search response (using piggyback). On the other
624 hand, if either <literal>start</literal> is positive or if
625 a sorting criteria is set, or if <literal>piggyback</literal>
626 is 0, then the client will not perform piggyback but send Present
630 If either of the options <literal>mediumSetElementSetName</literal> and
631 <literal>smallSetElementSetName</literal> are unset, the value
632 of option <literal>elementSetName</literal> is used for piggyback
633 searches. This means that for the high-level mode you only have
634 to specify one elementSetName option rather than three.
637 <sect2 id="zoom.sru.resultset.behavior">
638 <title>SRU Protocol behavior</title>
640 Current version of &yaz; does not take advantage of a result set id
641 returned by the SRU server. Future versions might do, however.
642 Since, the ZOOM driver does not save result set IDs any
643 present (retrieval) is transformed to a SRU SearchRetrieveRequest
644 with same query but, possibly, different offsets.
647 Option <literal>schema</literal> specifies SRU schema
648 for retrieval. However, options <literal>elementSetName</literal> and
649 <literal>preferredRecordSyntax</literal> are ignored.
652 Options <literal>start</literal> and <literal>count</literal>
653 are supported by SRU.
654 The remaining options
655 <literal>piggyback</literal>,
656 <literal>smallSetUpperBound</literal>,
657 <literal>largeSetLowerBound</literal>,
658 <literal>mediumSetPresentNumber</literal>,
659 <literal>mediumSetElementSetName</literal>,
660 <literal>smallSetElementSetName</literal> are
664 SRU supports CQL queries, <emphasis>not</emphasis> PQF.
665 If PQF is used, however, the PQF query is transferred anyway
666 using non-standard element <literal>pQuery</literal> in
667 SRU SearchRetrieveRequest.
670 Unfortunately, SRU does not define a database setting. Hence,
671 <literal>databaseName</literal> is unsupported and ignored.
672 However, the path part in host parameter for functions
673 <function>ZOOM_connecton_new</function> and
674 <function>ZOOM_connection_connect</function> acts as a
675 database (at least for the &yaz; SRU server).
679 <sect1 id="zoom.records"><title>Records</title>
681 A record object is a retrieval record on the client side -
682 created from result sets.
685 void ZOOM_resultset_records(ZOOM_resultset r,
687 size_t start, size_t count);
688 ZOOM_record ZOOM_resultset_record(ZOOM_resultset s, size_t pos);
690 const char *ZOOM_record_get(ZOOM_record rec, const char *type,
693 int ZOOM_record_error(ZOOM_record rec, const char **msg,
694 const char **addinfo, const char **diagset);
696 ZOOM_record ZOOM_record_clone(ZOOM_record rec);
698 void ZOOM_record_destroy(ZOOM_record rec);
701 References to temporary records are returned by functions
702 <function>ZOOM_resultset_records</function> or
703 <function>ZOOM_resultset_record</function>.
706 If a persistent reference to a record is desired
707 <function>ZOOM_record_clone</function> should be used.
708 It returns a record reference that should be destroyed
709 by a call to <function>ZOOM_record_destroy</function>.
712 A single record is returned by function
713 <function>ZOOM_resultset_record</function> that takes a
714 position as argument. First record has position zero.
715 If no record could be obtained <literal>NULL</literal> is returned.
718 Error information for a record can be checked with
719 <function>ZOOM_record_error</function> which returns non-zero
720 (error code) if record is in error, called <emphasis>Surrogate
721 Diagnostics</emphasis> in Z39.50.
724 Function <function>ZOOM_resultset_records</function> retrieves
725 a number of records from a result set. Parameter <literal>start</literal>
726 and <literal>count</literal> specifies the range of records to
727 be returned. Upon completion array
728 <literal>recs[0], ..recs[count-1]</literal>
729 holds record objects for the records. The array of records
730 <literal>recs</literal> should be allocated prior the call
731 <function>ZOOM_resultset_records</function>. Note that for those
732 records that couldn't be retrieved from the target
733 <literal>recs[ ..]</literal> is set to <literal>NULL</literal>.
735 <para id="zoom.record.get">
736 In order to extract information about a single record,
737 <function>ZOOM_record_get</function> is provided. The
738 function returns a pointer to certain record information. The
739 nature (type) of the pointer depends on the parameter,
740 <parameter>type</parameter>.
743 The <parameter>type</parameter> is a string of the format:
746 <replaceable>form</replaceable>[;charset=<replaceable>from</replaceable>[,<replaceable>to</replaceable>]][;format=<replaceable>v</replaceable>]
749 where <replaceable>form</replaceable> specifies the format of the
750 returned record, <replaceable>from</replaceable>
751 specifies the character set of the record in its original form
752 (as returned by the server), <replaceable>to</replaceable> specifies
753 the output (returned)
754 character set encoding.
755 If charset is not given, then no character set conversion takes place.
756 If <replaceable>to</replaceable> is omitted UTF-8 is assumed.
759 The format argument controls whether record data should be XML
760 pretty-printed (post process operation).
761 It is enabled only if format value <replaceable>v</replaceable> is
762 <literal>1</literal> and the record content is XML well-formed.
765 In addition, for certain types, the length
766 <literal>len</literal> passed will be set to the size in bytes of
767 the returned information.
770 The following are the supported values for <replaceable>form</replaceable>.
772 <varlistentry><term><literal>database</literal></term>
773 <listitem><para>Database of record is returned
774 as a C null-terminated string. Return type
775 <literal>const char *</literal>.
778 <varlistentry><term><literal>syntax</literal></term>
779 <listitem><para>The transfer syntax of the record is returned
780 as a C null-terminated string containing the symbolic name of
781 the record syntax, e.g. <literal>Usmarc</literal>. Return type
783 <literal>const char *</literal>.
786 <varlistentry><term><literal>schema</literal></term>
787 <listitem><para>The schema of the record is returned
788 as a C null-terminated string. Return type is
789 <literal>const char *</literal>.
792 <varlistentry><term><literal>render</literal></term>
793 <listitem><para>The record is returned in a display friendly
794 format. Upon completion buffer is returned
795 (type <literal>const char *</literal>) and length is stored in
796 <literal>*len</literal>.
799 <varlistentry><term><literal>raw</literal></term>
800 <listitem><para>The record is returned in the internal
801 YAZ specific format. For GRS-1, Explain, and others, the
802 raw data is returned as type
803 <literal>Z_External *</literal> which is just the type for
804 the member <literal>retrievalRecord</literal> in
805 type <literal>NamePlusRecord</literal>.
806 For SUTRS and octet aligned record (including all MARCs) the
807 octet buffer is returned and the length of the buffer.
810 <varlistentry><term><literal>xml</literal></term>
811 <listitem><para>The record is returned in XML if possible.
812 SRU and Z39.50 records with transfer syntax XML are
813 returned verbatim. MARC records are returned in
814 <ulink url="&url.marcxml;">
817 (converted from ISO2709 to MARCXML by YAZ).
818 OPAC records are also converted to XML and the
819 bibliographic record is converted to MARCXML (when possible).
820 GRS-1 records are not supported for this form.
821 Upon completion, the XML buffer is returned
822 (type <literal>const char *</literal>) and length is stored in
823 <literal>*len</literal>.
826 <varlistentry><term><literal>opac</literal></term>
827 <listitem><para>OPAC information for record is returned in XML
828 if an OPAC record is present at the position given. If no
829 OPAC record is present, a NULL pointer is returned.
832 <varlistentry><term><literal>txml</literal></term>
833 <listitem><para>The record is returned in TurboMARC if possible.
834 SRU and Z39.50 records with transfer syntax XML are
835 returned verbatim. MARC records are returned in
836 <link linkend="tools.turbomarc">
839 (converted from ISO2709 to TurboMARC by YAZ).
840 Upon completion, the XML buffer is returned
841 (type <literal>const char *</literal>) and length is stored in
842 <literal>*len</literal>.
849 <ulink url="&url.marc21;">MARC21</ulink>
851 <ulink url="&url.marc8;">MARC-8</ulink>
852 character set encoding.
853 An application that wishes to display in Latin-1 would use
855 render; charset=marc8,iso-8859-1
858 <sect2 id="zoom.z3950.record.behavior">
859 <title>Z39.50 Protocol behavior</title>
861 The functions <function>ZOOM_resultset_record</function> and
862 <function>ZOOM_resultset_records</function> inspects the client-side
863 record cache. Records not found in cache are fetched using
865 The functions may block (and perform network I/O) - even though option
866 <literal>async</literal> is 1, because they return records objects.
867 (and there's no way to return records objects without retrieving them!).
870 There is a trick, however, in the usage of function
871 <function>ZOOM_resultset_records</function> that allows for
872 delayed retrieval (and makes it non-blocking). By using
873 a null pointer for <parameter>recs</parameter> you're indicating
874 you're not interested in getting records objects
875 <emphasis>now</emphasis>.
878 <sect2 id="zoom.sru.record.behavior">
879 <title>SRU Protocol behavior</title>
881 The ZOOM driver for SRU treats records returned by a SRU server
882 as if they where Z39.50 records with transfer syntax XML and
883 no element set name or database name.
887 <sect1 id="zoom.facets"><title>Facets</title>
889 In case the target can and is requested to return facets, using a result set the ZOOM client
890 can request one or all facet fields. Using a facet field the client can request the term count and
891 then interate over the terms.
894 ZOOM_facet_field *ZOOM_resultset_facets(ZOOM_resultset r);
895 const char ** ZOOM_resultset_facets_names(ZOOM_resultset r);
896 ZOOM_facet_field ZOOM_resultset_get_facet_field(ZOOM_resultset r, const char *facet_name);
897 ZOOM_facet_field ZOOM_resultset_get_facet_field_by_index(ZOOM_resultset r, int pos);
898 size_t ZOOM_resultset_facets_size(ZOOM_resultset r);
900 const char *ZOOM_facet_field_name(ZOOM_facet_field facet_field);
901 size_t ZOOM_facet_field_term_count(ZOOM_facet_field facet_field);
902 const char *ZOOM_facet_field_get_term(ZOOM_facet_field facet_field, size_t idx, int *freq);
905 References to temporary structures are returned by all functions. They are only valid as long the Result set is valid.
906 <function>ZOOM_resultset_get_facet_field</function> or
907 <function>ZOOM_resultset_get_facet_field_by_index</function>.
908 <function>ZOOM_resultset_facets</function>.
909 <function>ZOOM_resultset_facets_names</function>.
910 <function>ZOOM_facet_field_name</function>.
911 <function>ZOOM_facet_field_get_term</function>.
913 <para id="zoom.resultset.get_facet_field">
914 A single Facet field is returned by function
915 <function>ZOOM_resultset_get_facet_field</function> or <function>ZOOM_resultset_get_facet_field_by_index</function> that takes a
916 result set and facet name or positive index respectively. First facet has position zero.
917 If no facet could be obtained (invalid name or index out of bounds) <literal>NULL</literal> is returned.
919 <para id="zoom.resultset.facets">
920 An array of facets field can be returned by <function>ZOOM_resultset_facets</function>. The length of the array is
921 given by <function>ZOOM_resultset_facets_size</function>. The array is zero-based and last entry will be at
922 <function>ZOOM_resultset_facets_size(result_set)</function>-1.
924 <para id="zoom.resultset.facets_names">
925 It is possible to interate over facets by name, by calling <function>ZOOM_resultset_facets_names</function>.
926 This will return an const array of char * where each string can be used as parameter for
927 <function>ZOOM_resultset_get_facet_field</function>.
930 Function <function>ZOOM_facet_field_name</function> gets the request facet name from a returned facet field.
933 Function <function>ZOOM_facet_field_get_term</function> returns the idx'th term and term count for a facet field.
934 Idx must between 0 and <function>ZOOM_facet_field_term_count</function>-1, otherwise the returned reference will be
935 <literal>NULL</literal>. On a valid idx, the value of the freq reference will be the term count.
936 The *freq parameter must be valid pointer to integer.
939 <sect1 id="zoom.scan"><title>Scan</title>
941 This section describes an interface for Scan. Scan is not an
942 official part of the ZOOM model yet. The result of a scan operation
943 is the <literal>ZOOM_scanset</literal> which is a set of terms
944 returned by a target.
948 The Scan interface is supported for both Z39.50 and SRU.
952 ZOOM_scanset ZOOM_connection_scan(ZOOM_connection c,
953 const char *startpqf);
955 ZOOM_scanset ZOOM_connection_scan1(ZOOM_connection c,
958 size_t ZOOM_scanset_size(ZOOM_scanset scan);
960 const char *ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
961 size_t *occ, size_t *len);
963 const char *ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
964 size_t *occ, size_t *len);
966 void ZOOM_scanset_destroy(ZOOM_scanset scan);
968 const char *ZOOM_scanset_option_get(ZOOM_scanset scan,
971 void ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
975 The scan set is created by function
976 <function>ZOOM_connection_scan</function> which performs a scan
977 operation on the connection using the specified
978 <parameter>startpqf</parameter>.
979 If the operation was successful, the size of the scan set can be
980 retrieved by a call to <function>ZOOM_scanset_size</function>.
981 Like result sets, the items are numbered 0,..size-1.
982 To obtain information about a particular scan term, call function
983 <function>ZOOM_scanset_term</function>. This function takes
984 a scan set offset <literal>pos</literal> and returns a pointer
985 to a <emphasis>raw term</emphasis> or <literal>NULL</literal> if
987 If present, the <literal>occ</literal> and <literal>len</literal>
988 are set to the number of occurrences and the length
989 of the actual term respectively.
990 <function>ZOOM_scanset_display_term</function> is similar to
991 <function>ZOOM_scanset_term</function> except that it returns
992 the <emphasis>display term</emphasis> rather than the raw term.
993 In a few cases, the term is different from display term. Always
994 use the display term for display and the raw term for subsequent
995 scan operations (to get more terms, next scan result, etc).
998 A scan set may be freed by a call to function
999 <function>ZOOM_scanset_destroy</function>.
1000 Functions <function>ZOOM_scanset_option_get</function> and
1001 <function>ZOOM_scanset_option_set</function> retrieves and sets
1002 an option respectively.
1006 The <parameter>startpqf</parameter> is a subset of PQF, namely
1007 the Attributes+Term part. Multiple <literal>@attr</literal> can
1008 be used. For example to scan in title (complete) phrases:
1010 @attr 1=4 @attr 6=2 "science o"
1015 The <function>ZOOM_connecton_scan1</function> is a newer and
1016 more generic alternative to <function>ZOOM_connection_scan</function>
1017 which allows to use both CQL and PQF for Scan.
1020 <table frame="top" id="zoom.scanset.options">
1021 <title>ZOOM Scan Set Options</title>
1023 <colspec colwidth="4*" colname="name"></colspec>
1024 <colspec colwidth="7*" colname="description"></colspec>
1025 <colspec colwidth="2*" colname="default"></colspec>
1028 <entry>Option</entry>
1029 <entry>Description</entry>
1030 <entry>Default</entry>
1035 number</entry><entry>Number of Scan Terms requested in next scan.
1036 After scan it holds the actual number of terms returned.
1037 </entry><entry>20</entry></row>
1039 position</entry><entry>Preferred Position of term in response
1040 in next scan; actual position after completion of scan.
1041 </entry><entry>1</entry></row>
1043 stepSize</entry><entry>Step Size
1044 </entry><entry>0</entry></row>
1046 scanStatus</entry><entry>An integer indicating the Scan Status
1048 </entry><entry>0</entry></row>
1050 rpnCharset</entry><entry>Character set for RPN terms.
1051 If this is set, ZOOM C will assume that the ZOOM application is
1052 running UTF-8. Terms in RPN queries are then converted to the
1053 rpnCharset. If this is unset, ZOOM C will not assume any encoding
1054 of RPN terms and no conversion is performed.
1055 </entry><entry>none</entry></row>
1061 <sect1 id="zoom.extendedservices"><title>Extended Services</title>
1063 ZOOM offers an interface to a subset of the Z39.50 extended services
1064 as well as a few privately defined ones:
1069 Z39.50 Item Order (ILL).
1070 See <xref linkend="zoom.item.order"/>.
1075 Record Update. This allows a client to insert, modify or delete
1077 See <xref linkend="zoom.record.update"/>.
1082 Database Create. This a non-standard feature. Allows a client
1083 to create a database.
1084 See <xref linkend="zoom.database.create"/>.
1089 Database Drop. This a non-standard feature. Allows a client
1090 to delete/drop a database.
1091 See <xref linkend="zoom.database.drop"/>.
1096 Commit operation. This a non-standard feature. Allows a client
1097 to commit operations.
1098 See <xref linkend="zoom.commit"/>.
1101 <!-- all the ILL PDU options should go here too -->
1104 To create an extended service operation a <literal>ZOOM_package</literal>
1105 must be created. The operation is a five step operation. The
1106 package is created, package is configured by means of options,
1107 the package is send, result is inspected (by means of options),
1108 the package is destroyed.
1111 ZOOM_package ZOOM_connection_package(ZOOM_connection c,
1112 ZOOM_options options);
1114 const char *ZOOM_package_option_get(ZOOM_package p,
1116 void ZOOM_package_option_set(ZOOM_package p, const char *key,
1118 void ZOOM_package_send(ZOOM_package p, const char *type);
1120 void ZOOM_package_destroy(ZOOM_package p);
1123 The <function>ZOOM_connection_package</function> creates a
1124 package for the connection given using the options specified.
1127 Functions <function>ZOOM_package_option_get</function> and
1128 <function>ZOOM_package_option_set</function> gets and sets
1132 <function>ZOOM_package_send</function> sends
1133 the package the via connection specified in
1134 <function>ZOOM_connection_package</function>.
1135 The <parameter>type</parameter> specifies the actual extended service
1136 package type to be sent.
1139 <table frame="top" id="zoom.extendedservices.options">
1140 <title>Extended Service Common Options</title>
1142 <colspec colwidth="4*" colname="name"></colspec>
1143 <colspec colwidth="7*" colname="description"></colspec>
1144 <colspec colwidth="3*" colname="default"></colspec>
1147 <entry>Option</entry>
1148 <entry>Description</entry>
1149 <entry>Default</entry>
1154 <entry>package-name</entry>
1155 <entry>Extended Service Request package name. Must be specified
1156 as part of a request</entry>
1160 <entry>user-id</entry>
1161 <entry>User ID of Extended Service Package. Is a request option</entry>
1165 <entry>function</entry>
1167 Function of package - one of <literal>create</literal>,
1168 <literal>delete</literal>, <literal>modify</literal>. Is
1171 <entry><literal>create</literal></entry>
1174 <entry>waitAction</entry>
1176 Wait action for package. Possible values:
1177 <literal>wait</literal>, <literal>waitIfPossible</literal>,
1178 <literal>dontWait</literal> or <literal>dontReturnPackage</literal>.
1180 <entry><literal>waitIfPossible</literal></entry>
1183 <entry>targetReference</entry>
1185 Target Reference. This is part of the response as returned
1186 by the server. Read it after a successful operation.
1188 <entry><literal>none</literal></entry>
1194 <sect2 id="zoom.item.order"><title>Item Order</title>
1196 For Item Order, type must be set to <literal>itemorder</literal> in
1197 <function>ZOOM_package_send</function>.
1200 <table frame="top" id="zoom.item.order.options">
1201 <title>Item Order Options</title>
1203 <colspec colwidth="4*" colname="name"></colspec>
1204 <colspec colwidth="7*" colname="description"></colspec>
1205 <colspec colwidth="3*" colname="default"></colspec>
1208 <entry>Option</entry>
1209 <entry>Description</entry>
1210 <entry>Default</entry>
1215 <entry>contact-name</entry>
1216 <entry>ILL contact name</entry>
1220 <entry>contact-phone</entry>
1221 <entry>ILL contact phone</entry>
1225 <entry>contact-email</entry>
1226 <entry>ILL contact email</entry>
1230 <entry>itemorder-item</entry>
1231 <entry>Position for item (record) requested. An integer</entry>
1240 <sect2 id="zoom.record.update"><title>Record Update</title>
1242 For Record Update, type must be set to <literal>update</literal> in
1243 <function>ZOOM_package_send</function>.
1246 <table frame="top" id="zoom.record.update.options">
1247 <title>Record Update Options</title>
1249 <colspec colwidth="4*" colname="name"></colspec>
1250 <colspec colwidth="7*" colname="description"></colspec>
1251 <colspec colwidth="3*" colname="default"></colspec>
1254 <entry>Option</entry>
1255 <entry>Description</entry>
1256 <entry>Default</entry>
1261 <entry>action</entry>
1263 The update action. One of
1264 <literal>specialUpdate</literal>,
1265 <literal>recordInsert</literal>,
1266 <literal>recordReplace</literal>,
1267 <literal>recordDelete</literal>,
1268 <literal>elementUpdate</literal>.
1270 <entry><literal>specialUpdate (recordInsert for updateVersion=1 which does not support specialUpdate)</literal></entry>
1273 <entry>recordIdOpaque</entry>
1274 <entry>Opaque Record ID</entry>
1278 <entry>recordIdNumber</entry>
1279 <entry>Record ID number</entry>
1283 <entry>record</entry>
1284 <entry>The record itself</entry>
1288 <entry>recordOpaque</entry>
1289 <entry>Specifies an opaque record which is
1290 encoded as an ASN.1 ANY type with the OID as tiven by option
1291 <literal>syntax</literal> (see below).
1292 Option <literal>recordOpaque</literal> is an alternative
1293 to record - and <literal>record</literal> option (above) is
1294 ignored if recordOpaque is set. This option is only available in
1295 YAZ 3.0.35 and later and is meant to facilitate Updates with
1301 <entry>syntax</entry>
1302 <entry>The record syntax (transfer syntax). Is a string that
1303 is a known record syntax.
1305 <entry>no syntax</entry>
1308 <entry>databaseName</entry>
1309 <entry>Database from connection object</entry>
1310 <entry>Default</entry>
1313 <entry>correlationInfo.note</entry>
1314 <entry>Correlation Info Note (string)</entry>
1318 <entry>correlationInfo.id</entry>
1319 <entry>Correlation Info ID (integer)</entry>
1323 <entry>elementSetName</entry>
1324 <entry>Element Set for Record</entry>
1328 <entry>updateVersion</entry>
1329 <entry>Record Update version which holds one of the values
1330 1, 2 or 3. Each version has a distinct OID:
1332 (<ulink url="&url.z39.50.extupdate1;">first version</ulink>) ,
1334 (second version) and
1335 1.2.840.10003.9.5.1.1
1336 (<ulink url="&url.z39.50.extupdate3;">third and
1337 newest version</ulink>).
1347 <sect2 id="zoom.database.create"><title>Database Create</title>
1349 For Database Create, type must be set to <literal>create</literal> in
1350 <function>ZOOM_package_send</function>.
1353 <table frame="top" id="zoom.database.create.options">
1354 <title>Database Create Options</title>
1356 <colspec colwidth="4*" colname="name"></colspec>
1357 <colspec colwidth="7*" colname="description"></colspec>
1358 <colspec colwidth="3*" colname="default"></colspec>
1361 <entry>Option</entry>
1362 <entry>Description</entry>
1363 <entry>Default</entry>
1368 <entry>databaseName</entry>
1369 <entry>Database from connection object</entry>
1370 <entry>Default</entry>
1377 <sect2 id="zoom.database.drop"><title>Database Drop</title>
1379 For Database Drop, type must be set to <literal>drop</literal> in
1380 <function>ZOOM_package_send</function>.
1383 <table frame="top" id="zoom.database.drop.options">
1384 <title>Database Drop Options</title>
1386 <colspec colwidth="4*" colname="name"></colspec>
1387 <colspec colwidth="7*" colname="description"></colspec>
1388 <colspec colwidth="3*" colname="default"></colspec>
1391 <entry>Option</entry>
1392 <entry>Description</entry>
1393 <entry>Default</entry>
1398 <entry>databaseName</entry>
1399 <entry>Database from connection object</entry>
1400 <entry>Default</entry>
1407 <sect2 id="zoom.commit"><title>Commit Operation</title>
1409 For Commit, type must be set to <literal>commit</literal> in
1410 <function>ZOOM_package_send</function>.
1414 <sect2 id="zoom.extended.services.behavior">
1415 <title>Protocol behavior</title>
1417 All the extended services are Z39.50-only.
1421 The database create, drop and commit services are privately defined
1423 Refer to <filename>esadmin.asn</filename> in YAZ for the ASN.1
1430 <sect1 id="zoom.options"><title>Options</title>
1432 Most &zoom; objects provide a way to specify options to change behavior.
1433 From an implementation point of view a set of options is just like
1434 an associative array / hash.
1437 ZOOM_options ZOOM_options_create(void);
1439 ZOOM_options ZOOM_options_create_with_parent(ZOOM_options parent);
1441 void ZOOM_options_destroy(ZOOM_options opt);
1444 const char *ZOOM_options_get(ZOOM_options opt, const char *name);
1446 void ZOOM_options_set(ZOOM_options opt, const char *name,
1450 typedef const char *(*ZOOM_options_callback)
1451 (void *handle, const char *name);
1453 ZOOM_options_callback
1454 ZOOM_options_set_callback(ZOOM_options opt,
1455 ZOOM_options_callback c,
1459 <sect1 id="zoom.events"><title>Events</title>
1461 If you're developing non-blocking applications, you have to deal
1465 int ZOOM_event(int no, ZOOM_connection *cs);
1468 The <function>ZOOM_event</function> executes pending events for
1469 a number of connections. Supply the number of connections in
1470 <literal>no</literal> and an array of connections in
1471 <literal>cs</literal> (<literal>cs[0] ... cs[no-1]</literal>).
1472 A pending event could be a sending a search, receiving a response,
1474 When an event has occurred for one of the connections, this function
1475 returns a positive integer <literal>n</literal> denoting that an event
1476 occurred for connection <literal>cs[n-1]</literal>.
1477 When no events are pending for the connections, a value of zero is
1479 To ensure that all outstanding requests are performed call this function
1480 repeatedly until zero is returned.
1483 If <function>ZOOM_event</function> returns and returns non-zero, the
1484 last event that occurred can be expected.
1487 int ZOOM_connection_last_event(ZOOM_connection cs);
1490 <function>ZOOM_connection_last_event</function> returns an event type
1491 (integer) for the last event.
1494 <table frame="top" id="zoom.event.ids">
1495 <title>ZOOM Event IDs</title>
1497 <colspec colwidth="4*" colname="name"></colspec>
1498 <colspec colwidth="7*" colname="description"></colspec>
1501 <entry>Event</entry>
1502 <entry>Description</entry>
1507 <entry>ZOOM_EVENT_NONE</entry>
1508 <entry>No event has occurred</entry>
1511 <entry>ZOOM_EVENT_CONNECT</entry>
1512 <entry>TCP/IP connect has initiated</entry>
1515 <entry>ZOOM_EVENT_SEND_DATA</entry>
1516 <entry>Data has been transmitted (sending)</entry>
1519 <entry>ZOOM_EVENT_RECV_DATA</entry>
1520 <entry>Data has been received)</entry>
1523 <entry>ZOOM_EVENT_TIMEOUT</entry>
1524 <entry>Timeout</entry>
1527 <entry>ZOOM_EVENT_UNKNOWN</entry>
1528 <entry>Unknown event</entry>
1531 <entry>ZOOM_EVENT_SEND_APDU</entry>
1532 <entry>An APDU has been transmitted (sending)</entry>
1535 <entry>ZOOM_EVENT_RECV_APDU</entry>
1536 <entry>An APDU has been received</entry>
1539 <entry>ZOOM_EVENT_RECV_RECORD</entry>
1540 <entry>A result-set record has been received</entry>
1543 <entry>ZOOM_EVENT_RECV_SEARCH</entry>
1544 <entry>A search result been received</entry>
1552 <!-- Keep this comment at the end of the file
1557 sgml-minimize-attributes:nil
1558 sgml-always-quote-attributes:t
1561 sgml-parent-document: "yaz.xml"
1562 sgml-local-catalogs: nil
1563 sgml-namecase-general:t