X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fzoom.xml;h=3698ccffdadb731c244c40a447fcadbfe184457a;hb=66490c4cd60228c4036596003a8f24373cbd0fd8;hp=330a3e3c5d99ccf78668f9c8a9b4b5a4ce5904ce;hpb=55bc5787ba3e68ae7e130866f95e70af6b98c6d8;p=yaz-moved-to-github.git
diff --git a/doc/zoom.xml b/doc/zoom.xml
index 330a3e3..3698ccf 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -192,7 +192,15 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
It's automatically set internally when connecting to a target.
none
- proxyProxy host
+ proxyProxy host. If set, the logical host
+ is encoded in the otherInfo area of the Z39.50 Init PDU
+ with OID 1.2.840.10003.10.1000.81.1.
+ none
+
+ clientIPClient IP. If set, is
+ encoded in the otherInfo area of a Z39.50 PDU with OID
+ 1.2.840.10003.10.1000.81.3. Holds the original IP addreses
+ of a client. Is used of ZOOM is used in a gateway of some sort.
none
asyncIf true (1) the connection operates in
@@ -279,6 +287,12 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
first operation), holds the negotiated version with the server
(same or lower version).
1.2
+
+ facets
+ A FacetList is comma-separated list of facet, which is defined as AttributeList
+ and a optional FacetTerm (a Term and a frequency). On request the terms is missing.
+ On response the the list contains the terms that the target could collect.
+ none
@@ -726,7 +740,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
The type is a string of the format:
- form[; charset=from[,to]]
+ form[;charset=from[,to]][;format=v]
where form specifies the format of the
@@ -739,6 +753,12 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
If to is omitted UTF-8 is assumed.
+ The format argument controls whether record data should be XML
+ pretty-printed (post process operation).
+ It is enabled only if format value v is
+ 1 and the record content is XML well-formed.
+
+
In addition, for certain types, the length
len passed will be set to the size in bytes of
the returned information.
@@ -806,6 +826,19 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
OPAC record is present, a NULL pointer is returned.
+ txml
+ The record is returned in TurboMARC if possible.
+ SRU and Z39.50 records with transfer syntax XML are
+ returned verbatim. MARC records are returned in
+
+ TurboMARC
+
+ (converted from ISO2709 to TurboMARC by YAZ).
+ Upon completion, the XML buffer is returned
+ (type const char *) and length is stored in
+ *len.
+
+
@@ -869,11 +902,11 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
size_t ZOOM_scanset_size(ZOOM_scanset scan);
- const char * ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
- int *occ, size_t *len);
+ const char *ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
+ size_t *occ, size_t *len);
- const char * ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
- int *occ, size_t *len);
+ const char *ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
+ size_t *occ, size_t *len);
void ZOOM_scanset_destroy(ZOOM_scanset scan);
@@ -946,7 +979,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
numberNumber of Scan Terms requested in next scan.
After scan it holds the actual number of terms returned.
- 10
+ 20
positionPreferred Position of term in response
in next scan; actual position after completion of scan.