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

catno = cq_setcat (cq, catname)

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