aboutsummaryrefslogtreecommitdiff
path: root/pkg/xtools/catquery/doc/cqstati.hlp
blob: 15fe1d9ede103ab460cef4d8ae0af552bfe7a1d8 (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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
.help cqstati Mar00 "Catquery Package"
.ih
NAME
cqstati -- get a catalog / survey integer parameter
.ih
SYNOPSIS
include <cq.h>

ival = cq_stati (cq, parameter)

.nf
pointer	cq		# the configuration file descriptor
int	parameter	# the parameter to be returned
.fi
.ih
ARGUMENTS
.ls cq     
The configuration file descriptor.
.le
.ls parameter
The parameter to be returned.  The currently supported parameters defined
in cq.h are:
.nf
	CQNRECS		# the number of catalog / survey file records
	CQSZRECLIST	# the length of the record name list in chars
	CQCATNO		# the current catalog number
.fi
.le
.ih
DESCRIPTION
Cq_stati returns the values of catalog / survey integer parameters.
Cq_stati is an integer function which returns the value of the requested
parameter as its function value.

.ih
NOTES
The current catalog number CQCATNO is 0 if the current catalog has not been set
by a call to cq_setcat or cq_setcatn.

The length of the record list CQSZRECLIST can be used to preallocate the buffer
required to fetch the text parameter CQRECLIST.

.ih
EXAMPLES
.nf
	include <cq.h>

	int	cq_stati()

	....

	sz_buf = cq_stati (cq, CQSZRECLIST)
	call malloc (buf, sz_buf, TY_CHAR)
	nlines = cq_statt (cq, CQRECLIST, Memc[buf], sz_buf) 

	...
.fi
.ih
SEE ALSO
cq_stats, cq_statt
.endhelp