aboutsummaryrefslogtreecommitdiff
path: root/pkg/xtools/catquery/doc/cqgrecord.hlp
blob: 732f43f573ddf2ca22a3eab837db0cd84bcbe98f (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
.help cqgrecord Mar00 "Catquery Package"
.ih
NAME
cqgrecord -- get a record from the catalog results
.ih
SYNOPSIS

stat = cq_grecord (res, buf, maxch, recno)

.nf
pointer	res		# the results descriptor
char	buf		# the output buffer
int	maxch		# the maximum size of the output buffer
int	recno		# the record to be fetched
.fi
.ih
ARGUMENTS
.ls res    
The results descriptor.
.le
.ls buf
The buffer containing the returned record.
.le
.ls maxch
The maximum size of the output buffer.
.le
.ls recptr
The sequence number of the record to be fetched. Recptr should be set to
to initialize sequential reading of all the catalog results.
.le
.ih
DESCRIPTION
Cq_grecord returns the requested record. Cq_grecord is an integer function
which returns BOF, the number of characters in the record, or EOF as
its function value.
.ih
NOTES
In most cases allocating a buffer size that is SZ_LINE chars long
will be adequate to hold the output record. If the integer results parameter
CQRECSIZE is defined, i.e. non-zero, then an output buffer  CQRECSIZE chars
long can be allocated.

.ih
SEE ALSO
cqgnrecord
.endhelp