aboutsummaryrefslogtreecommitdiff
path: root/pkg/xtools/catquery/doc/cqgvalc.hlp
blob: a6313556fab256b48f363fd14e156fd4a3346d95 (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
.help cqgvalc Mar00 "Catquery Package"
.ih
NAME
cqgvalc -- get a catalog results field as a string value
.ih
SYNOPSIS
nchars = cq_gvalc (res, recno, fname, str, maxch)

.nf
pointer	res		# the results descriptor
int	recno		# the record number
char	fname		# the field name
char	str		# the returned string value
int	maxch		# the maximum size of the returned string value
.fi
.ih
ARGUMENTS
.ls res     
The results descriptor.
.le
.ls recno
The record number.
.le
.ls fname
The field name.
.le
.ls str
Array containing returned string value.
.le
.ls maxch
The maximum size in characters of the returned string value.
.le
.ih
DESCRIPTION
Cq_gvalc returns the requested field value as a string. Cq_gvalc is an
integer function which returns the number of decoded characters as its
function value. Zero is returned if the field could not be decoded.

.ih
SEE ALSO
cqgval[silrd]
.endhelp