aboutsummaryrefslogtreecommitdiff
path: root/pkg/xtools/catquery/doc/cqfimquery.hlp
blob: d344c7eef8b5f08d010d95b47328f7cd1988f780 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
.help cqfimquery Mar00 "Catquery Package"
.ih
NAME
cqfimquery -- return the results of an image file query
.ih
SYNOPSIS

imres = cq_fimquery (cq, imname)

.nf
pointer	cq		# the configuration file descriptor
char	imname		# the input image file name 
.fi
.ih
ARGUMENTS
.ls cq     
The configuration file descriptor.
.le
.ls imname
The file name of the image being queried.
.le
.ih
DESCRIPTION
Cq_fimquery queries an existing image and returns a results descriptor.
Cq_fimquery is a pointer procedure which returns the results descriptor
as its function value. NULL is returned if an error occurs in the query
or the image does not exist.

Cq_fimquery is used to make an image emulate the results of an image
survey query.
.ih
NOTES
Cq_setcat with the image survey name set to the reserved record name
"imname@noao" must be called before any image survey query is made.

.ih
SEE ALSO
cqimquery, cqimclose
.endhelp