diff options
| author | Joe Hunkeler <jhunkeler@gmail.com> | 2015-08-11 16:51:37 -0400 |
|---|---|---|
| committer | Joe Hunkeler <jhunkeler@gmail.com> | 2015-08-11 16:51:37 -0400 |
| commit | 40e5a5811c6ffce9b0974e93cdd927cbcf60c157 (patch) | |
| tree | 4464880c571602d54f6ae114729bf62a89518057 /pkg/xtools/catquery/doc/cqquery.hlp | |
| download | iraf-osx-40e5a5811c6ffce9b0974e93cdd927cbcf60c157.tar.gz | |
Repatch (from linux) of OSX IRAF
Diffstat (limited to 'pkg/xtools/catquery/doc/cqquery.hlp')
| -rw-r--r-- | pkg/xtools/catquery/doc/cqquery.hlp | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/pkg/xtools/catquery/doc/cqquery.hlp b/pkg/xtools/catquery/doc/cqquery.hlp new file mode 100644 index 00000000..797cd72c --- /dev/null +++ b/pkg/xtools/catquery/doc/cqquery.hlp @@ -0,0 +1,35 @@ +.help cqquery Mar00 "Catquery Package" +.ih +NAME +cqquery -- query a catalog and return the results +.ih +SYNOPSIS + +res = cq_query (cq) + +.nf +pointer cq # the configuration file descriptor +.fi +.ih +ARGUMENTS +.ls cq +The configuration file descriptor. +.le +.ih +DESCRIPTION +Cq_query is a pointer function which returns the catalog results descriptor +as its function value. NULL is returned if an error occurs in the catalog +query. +.ih +NOTES +Cq_setcat or cq_setcatn must be called before any catalog query can be made. + +Cq_nqpars and either cq_gqpar or cq_gqparn must be called to determine the +number of query parameters and get each query parameter description. + +Cq_sqpar or cq_sqparn must be called to replace the default query parameter +values with the calling program values. +.ih +SEE ALSO +cqfquery, cqrclose +.endhelp |