blob: cbb13c444d394afb7875c0ee22472f6ecabbff02 (
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
|
.help cqrstatt Mar00 "Catquery Package"
.ih
NAME
cqrstatt -- get a catalog results text parameter
.ih
SYNOPSIS
include <cq.h>
nlines = cq_rstatt (res, parameter, text, maxch)
.nf
pointer res # the results descriptor
int parameter # the parameter to be returned
char text # the returned text parameter value
int maxch # the maximum size of the returned text parameter
.fi
.ih
ARGUMENTS
.ls res
The results descriptor.
.le
.ls parameter
The catalog results parameter to be returned. The currently supported
catalog results text parameters defined in cq.h are:
.nf
CQRQPNAMES # the list of catalog results query parameter names
CQRQPVALUES # the list of catalog results query parameter values
CQRQPUNITS # the list of catalog results query parameter units
.fi
.le
.ls text
String containing returned text parameter value. Text parameters differ
from string parameters only in that they contain embedded newline
characters.
.le
.ls maxch
The maximum size in characters of the returned text value.
.le
.ih
DESCRIPTION
Cq_rstatt returns the values of catalog results string parameters.
The buffer size for the returned text parameters can be estimated by getting
the value of the integer parameter CQRNQPARS, and multiplying it by the maximum
buffer sizes CQ_SZ_QPNAME, CQ_SZ_QPVALUE, CQ_SZ_QPUNITS respectively.
.ih
NOTES
More information about the catalog results parameters and their relationship
to the parent catalog is available by typing "help catalogs".
.ih
SEE ALSO
cq_rstati, cq_rstats
.endhelp
|
