aboutsummaryrefslogtreecommitdiff
path: root/pkg/xtools/catquery/doc/cqsetcatn.hlp
blob: dac93a0090a58731efcbb0f30c539bfe910b9bc4 (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
.help cqsetcatn Mar00 "Catquery Package"
.ih
NAME
cqsetcatn -- set the current catalog / survey  by number
.ih
SYNOPSIS

catno = cq_setcatn (cq, catno)

.nf
pointer	cq		# the configuration file descriptor
int	catno		# the sequence number of the catalog / survey to be set
.fi
.ih
ARGUMENTS
.ls cq     
The configuration file descriptor.
.le
.ls catno
The sequence number of the catalog / survey to be set.
.le
.ih
DESCRIPTION
Cq_setcatn sets the current catalog / survey by number. Cq_setcatn is an
integer function which returns the catalog / survey
record sequence number as its function value. Zero is returned if the catalog
record is not set.
.ih
NOTES
Cq_setcat or cq_setcatn must be called before any catalog or image
survey query can be made.
.ih
SEE ALSO
cqlocate, cqlocaten, cqsetcat
.endhelp