From fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4 Mon Sep 17 00:00:00 2001
From: Joseph Hunkeler <jhunkeler@gmail.com>
Date: Wed, 8 Jul 2015 20:46:52 -0400
Subject: Initial commit

---
 pkg/xtools/catquery/doc/cqrstats.hlp | 54 ++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 pkg/xtools/catquery/doc/cqrstats.hlp

(limited to 'pkg/xtools/catquery/doc/cqrstats.hlp')

diff --git a/pkg/xtools/catquery/doc/cqrstats.hlp b/pkg/xtools/catquery/doc/cqrstats.hlp
new file mode 100644
index 00000000..45487dfd
--- /dev/null
+++ b/pkg/xtools/catquery/doc/cqrstats.hlp
@@ -0,0 +1,54 @@
+.help cqrstats Mar00 "Catquery Package"
+.ih
+NAME
+cqsrtats -- get a catalog results string parameter
+.ih
+SYNOPSIS
+include <cq.h>
+
+call cq_rstats (res, parameter, str, maxch)
+
+.nf
+pointer	res		# the results descriptor
+int	parameter	# the parameter to be returned
+char	str		# the returned string parameter
+int	maxch		# the maximum size of the returned string parameter
+.fi
+.ih
+ARGUMENTS
+.ls res     
+The results descriptor.
+.le
+.ls parameter
+The catalog results parameter to be returned.  The currently supported
+catalog results parameters defined in cq.h are:
+
+.nf
+CQRCATDB	# the name of the parent configuration file
+CQRCATNAME	# the name of the parent catalog
+CQRADDRESS	# the network address used to produce the results
+CQRQUERY	# the network query used to produce the results
+CQRQPNAMES	# the results query parameter dictionary
+CQRQPVALUES	# the results query parameter values dictionary
+CQRQPUNITS	# the results query parameter units dictionary
+.fi
+.le
+.ls str
+Array containing returned string parameter value.
+.le
+.ls maxch
+The maximum size in characters of the returned string parameter value.
+.le
+.ih
+DESCRIPTION
+Cq_rstats returns the values of catalog results string parameters.
+
+.ih
+NOTES
+More information about the catalog results parameters and their relationship
+to the parent catalog is available by typing "help catalogs".
+
+.ih
+SEE ALSO
+cqrstati, cqrstatt
+.endhelp
-- 
cgit 

