ZOOM_options_get_bool(opt, name, defa)
ZOOM_options_get_int(opt, name, defa)
ZOOM_options_set_int(opt, name, value)
-ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query startterm)
+ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query startterm)
ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
-->
<chapter id="zoom"><title>ZOOM</title>
void ZOOM_connection_connect(ZOOM_connection c, const char *host,
int portnum);
- void ZOOM_connection_destroy (ZOOM_connection c);
+ void ZOOM_connection_destroy(ZOOM_connection c);
</synopsis>
<para>
Connection objects are created with either function
operations.
</entry><entry>none</entry></row>
<row><entry>
+ sru</entry><entry>
+ SRU transport type. Must be either <literal>soap</literal>,
+ <literal>get</literal> or <literal>post</literal>.
+ </entry><entry>soap</entry></row>
+ <row><entry>
sru_version</entry><entry>
SRU/SRW version. Should be <literal>1.1</literal>, or
<literal>1.2</literal>. This is , prior to connect, the version
Character Set and Language Negotiation</ulink> is in effect.
</para>
<synopsis>
- int ZOOM_connection_error (ZOOM_connection c, const char **cp,
- const char **addinfo);
- int ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
- const char **addinfo, const char **dset);
+ int ZOOM_connection_error(ZOOM_connection c, const char **cp,
+ const char **addinfo);
+ int ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
+ const char **addinfo, const char **dset);
</synopsis>
<para>
Function <function>ZOOM_connection_error</function> checks for
a target.
</para>
<synopsis>
- ZOOM_resultset ZOOM_connection_search(ZOOM_connection,
- ZOOM_query q);
+ ZOOM_resultset ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
ZOOM_resultset ZOOM_connection_search_pqf(ZOOM_connection c,
const char *q);
-
void ZOOM_resultset_destroy(ZOOM_resultset r);
</synopsis>
<para>
Function <function>ZOOM_connection_search</function> creates
- a result set given a connection and query.
+ a result set given a connection and query.
Destroy a result set by calling
<function>ZOOM_resultset_destroy</function>.
Simple clients may using PQF only may use function
creating query objects is not necessary.
</para>
<synopsis>
- void ZOOM_resultset_option_set (ZOOM_resultset r,
- const char *key,
- const char *val);
+ void ZOOM_resultset_option_set(ZOOM_resultset r,
+ const char *key, const char *val);
- const char *ZOOM_resultset_option_get (ZOOM_resultset r,
- const char *key);
+ const char *ZOOM_resultset_option_get(ZOOM_resultset r, const char *key);
- size_t ZOOM_resultset_size (ZOOM_resultset r);
+ size_t ZOOM_resultset_size(ZOOM_resultset r);
</synopsis>
<para>
Functions <function>ZOOM_resultset_options_set</function> and
start</entry><entry>Offset of first record to be
retrieved from target. First record has offset 0 unlike the
protocol specifications where first record has position 1.
+ This option affects ZOOM_resultset_search and
+ ZOOM_resultset_search_pqf and must be set before any of
+ these functions are invoked. If a range of
+ records must be fetched manually after search,
+ function ZOOM_resultset_records should be used.
</entry><entry>0</entry></row>
<row><entry>
- count</entry><entry>Number of records to be retrieved.
+ count</entry><entry>Number of records to be retrieved.
+ This option affects ZOOM_resultset_search and
+ ZOOM_resultset_search_pqf and must be set before any of
+ these functions are invoked.
</entry><entry>0</entry></row>
<row><entry>
presentChunk</entry><entry>The number of records to be
- requested from the server in each chunk (present requst). The
+ requested from the server in each chunk (present request). The
value 0 means to request all the records in a single chunk.
(The old <literal>step</literal>
option is also supported for the benefit of old applications.)
int ZOOM_record_error(ZOOM_record rec, const char **msg,
const char **addinfo, const char **diagset);
- ZOOM_record ZOOM_record_clone (ZOOM_record rec);
+ ZOOM_record ZOOM_record_clone(ZOOM_record rec);
- void ZOOM_record_destroy (ZOOM_record rec);
+ void ZOOM_record_destroy(ZOOM_record rec);
</synopsis>
<para>
References to temporary records are returned by functions
MARCXML
</ulink>
(converted from ISO2709 to MARCXML by YAZ).
- GRS-1 and OPAC records are not supported for this form.
+ OPAC records are also converted to XML and the
+ bibliographic record is converted to MARCXML (when possible).
+ GRS-1 records are not supported for this form.
Upon completion, the XML buffer is returned
(type <literal>const char *</literal>) and length is stored in
<literal>*len</literal>.
</para></listitem>
</varlistentry>
<varlistentry><term><literal>opac</literal></term>
- <listitem><para>OPAC for record is returned in XML.
+ <listitem><para>OPAC information for record is returned in XML
+ if an OPAC record is present at the position given. If no
+ OPAC record is present, a NULL pointer is returned.
</para></listitem>
</varlistentry>
</variablelist>
const char * ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
int *occ, size_t *len);
- void ZOOM_scanset_destroy (ZOOM_scanset scan);
+ void ZOOM_scanset_destroy(ZOOM_scanset scan);
const char *ZOOM_scanset_option_get(ZOOM_scanset scan,
- const char *key);
+ const char *key);
void ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
const char *val);
<entry>none</entry>
</row>
<row>
+ <entry>recordOpaque</entry>
+ <entry>Specifies an opaque record which is
+ encoded as an ASN.1 ANY type with the OID as tiven by option
+ <literal>syntax</literal> (see below).
+ Option <literal>recordOpaque</literal> is an alternative
+ to record - and <literal>record</literal> option (above) is
+ ignored if recordOpaque is set. This option is only available in
+ YAZ 3.0.35 and later and is meant to facilitate Updates with
+ servers from OCLC.
+ </entry>
+ <entry>none</entry>
+ </row>
+ <row>
<entry>syntax</entry>
<entry>The record syntax (transfer syntax). Is a string that
is a known record syntax.
an associative array / hash.
</para>
<synopsis>
- ZOOM_options ZOOM_options_create (void);
+ ZOOM_options ZOOM_options_create(void);
- ZOOM_options ZOOM_options_create_with_parent (ZOOM_options parent);
+ ZOOM_options ZOOM_options_create_with_parent(ZOOM_options parent);
- void ZOOM_options_destroy (ZOOM_options opt);
+ void ZOOM_options_destroy(ZOOM_options opt);
</synopsis>
<synopsis>
- const char *ZOOM_options_get (ZOOM_options opt, const char *name);
+ const char *ZOOM_options_get(ZOOM_options opt, const char *name);
- void ZOOM_options_set (ZOOM_options opt, const char *name,
- const char *v);
+ void ZOOM_options_set(ZOOM_options opt, const char *name,
+ const char *v);
</synopsis>
<synopsis>
typedef const char *(*ZOOM_options_callback)
- (void *handle, const char *name);
+ (void *handle, const char *name);
ZOOM_options_callback
- ZOOM_options_set_callback (ZOOM_options opt,
- ZOOM_options_callback c,
- void *handle);
+ ZOOM_options_set_callback(ZOOM_options opt,
+ ZOOM_options_callback c,
+ void *handle);
</synopsis>
</sect1>
<sect1 id="zoom.events"><title>Events</title>
with events.
</para>
<synopsis>
- int ZOOM_event (int no, ZOOM_connection *cs);
+ int ZOOM_event(int no, ZOOM_connection *cs);
</synopsis>
<para>
The <function>ZOOM_event</function> executes pending events for