diff --git a/reference/yaz/functions/yaz-hits.xml b/reference/yaz/functions/yaz-hits.xml index e371ff1a43..a1bd985db2 100644 --- a/reference/yaz/functions/yaz-hits.xml +++ b/reference/yaz/functions/yaz-hits.xml @@ -1,5 +1,5 @@ - + yaz_hits @@ -10,10 +10,11 @@ intyaz_hits resourceid + arraysearchresult yaz_hits returns the number of hits for the last - search. + search. @@ -28,6 +29,14 @@ + + searchresult + + + Result array for detailed search result information. + + + @@ -37,6 +46,62 @@ Returns the number of hits for the last search or 0 if no search was performed. + + The search result array (if supplied) holds information that + is returned by a Z39.50 server in the SearchResult-1 + format part of a search response. + The SearchResult-1 format can be used to obtain information + about hit counts for various parts of the query (subquery). + In particular, it is possible to obtain hit counts for the individual + search terms in a query. Information for first + subquery is in $array[0], second subquery in $array[1], and so forth. + + + searchresult members + + + + + + Element + Description + + + + + id + Sub query ID2 (string) + + + count + Result count / hits (integer) + + + subquery.term + Sub query term (string) + + + interpretation.term + Interpretated sub query term (string) + + + recommendation.term + Recommended sub query term (string) + + + +
+ + + The SearchResult facility requires PECL YAZ 1.0.5 + or later and YAZ 2.1.9 or later. + + + + + Very few Z39.50 implementations support the SearchResult facility. + +