Add a list of the (surprisingly many) functions that still require
[yaz-moved-to-github.git] / doc / zoom.xml
index d625e58..86fa163 100644 (file)
@@ -1,4 +1,29 @@
-<!-- $Id: zoom.xml,v 1.39 2005-11-01 15:08:01 adam Exp $ -->
+<!--
+### Still to document:
+ZOOM_connection_option_getl(c, key, len)
+ZOOM_connection_option_setl(c, key, val, len)
+ZOOM_connection_errcode(c)
+ZOOM_connection_errmsg(c)
+ZOOM_connection_addinfo(c)
+ZOOM_diag_str(error)
+ZOOM_resultset_record_immediate(s, pos)
+ZOOM_resultset_cache_reset(r)
+ZOOM_connection_package(c, options)
+ZOOM_package_destroy(p)
+ZOOM_package_send(p, type)
+ZOOM_package_option_get(p, key)
+ZOOM_package_option_set(p, key, val)
+ZOOM_resultset_sort(r, sort_type, sort_spec)
+ZOOM_options_set_callback(opt, function, handle)
+ZOOM_options_create_with_parent2(parent1, parent2)
+ZOOM_options_getl(opt, name, len)
+ZOOM_options_setl(opt, name, value, len)
+ZOOM_options_get_bool(opt, name, defa)
+ZOOM_options_get_int(opt, name, defa)
+ZOOM_options_set_int(opt, name, value)
+ZOOM_event(no, cs)
+-->
+<!-- $Id: zoom.xml,v 1.41 2005-11-02 14:54:01 mike Exp $ -->
  <chapter id="zoom"><title>ZOOM</title>
   <para>
     &zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is
     are prefixed by 
     <literal>SearchResult.</literal><replaceable>no</replaceable>
     where no presents the item number (0=first, 1=second). 
-    Read <literal>SearchResult.size</literal> to determine the
+    Read <literal>searchresult.size</literal> to determine the
     number of items.
    </para>
    <table frame="top"><title>Search Info Report options</title>
      </thead>
      <tbody>
       <row>
-       <entry>SearchResult.size</entry>
+       <entry>searchresult.size</entry>
        <entry>
        number of search result entries. This option is-nonexistant
        if no entries are returned by the server.
        </entry>
       </row>
       <row>
-       <entry>SearchResult.<replaceable>no</replaceable>.subqueryId</entry>
+       <entry>searchresult.<replaceable>no</replaceable>.id</entry>
        <entry>sub query ID</entry>
       </row>
       <row>
-       <entry>SearchResult.<replaceable>no</replaceable>.subqueryCount</entry>
+       <entry>searchresult.<replaceable>no</replaceable>.count</entry>
        <entry>result count for item (number of hits)</entry>
       </row>
       <row>
-       <entry>SearchResult.<replaceable>no</replaceable>.subquery.term</entry>
+       <entry>searchresult.<replaceable>no</replaceable>.subquery.term</entry>
        <entry>subquery term</entry>
       </row>
       <row>
        <entry>
-       SearchResult.<replaceable>no</replaceable>.interpretation.term
+       searchresult.<replaceable>no</replaceable>.interpretation.term
        </entry>
        <entry>interpretation term</entry>
       </row>
       <row>
        <entry>
-       SearchResult.<replaceable>no</replaceable>.recommendation.term
+       searchresult.<replaceable>no</replaceable>.recommendation.term
        </entry>
        <entry>recommendation term</entry>
       </row>