aboutsummaryrefslogtreecommitdiff
path: root/pkg/xtools/catquery/doc/cqsqpar.hlp
blob: 57a8625568c5c67075a249c2566cab4d023e119d (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
.help cqsqpar Mar00 "Catquery Package"
.ih
NAME
cqsqpar -- set the value of a query parameter by name
.ih
SYNOPSIS

parno = cq_sqpar (cq, pname, value)

.nf
pointer	cq		# the configuration file descriptor
char	pname		# the query parameter name
char	value		# the query parameter value
.fi
.ih
ARGUMENTS
.ls cq     
The configuration file descriptor.
.le
.ls pname
The name of the query parameter to be set.
.le
.ls value
The new query parameter value.
.le
.ih
DESCRIPTION
Cq_sqpar sets the value of the named query parameter. Qq_sqpar is an integer 
function which returns the sequence number of the requested parameter
as its function value.  Zero is returned if the requested query parameter
is not found.
.ih
NOTES
Cq_setcat or cq_setcatn must be called before a query parameter value
can be changed.
.ih
SEE ALSO
cqnqpars, cqgpar, cqgqparn, cqsqparn
.endhelp