From: Dennis Schafroth <dennis@indexdata.com>
Date: Thu, 7 Oct 2010 10:31:16 +0000 (+0200)
Subject: Describe ZOOM_facet_field_name
X-Git-Tag: v4.1.2~19^2
X-Git-Url: http://sru.miketaylor.org.uk/cgi-bin?a=commitdiff_plain;h=5b2fe23e1cffff1c658bdfe26fddc3f84256e7f4;p=yaz-moved-to-github.git

Describe ZOOM_facet_field_name
---

diff --git a/doc/zoom.xml b/doc/zoom.xml
index 897e556..7d043d2 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -926,6 +926,15 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
     This will return an const array of char * where each string can be used as parameter for 
     <function>ZOOM_resultset_get_facet_field</function>. 
    </para>
+   <para>
+   Function <function>ZOOM_facet_field_name</function> gets the request facet name from a returned facet field. 
+   </para>
+   <para>
+   Function <function>ZOOM_facet_field_get_term</function> returns the idx'th term and term count for a facet field. 
+   Idx must between 0 and <function>ZOOM_facet_field_term_count</function>-1, otherwise the returned reference will be 
+   <literal>NULL</literal>. On a valid idx, the value of the freq reference will be the term count. 
+   The *freq parameter must be valid pointer to integer.   
+   </para>
    </sect1>
   <sect1 id="zoom.scan"><title>Scan</title>
    <para>