aboutsummaryrefslogtreecommitdiff
path: root/pkg/xtools/catquery/doc/cqsqparn.hlp
diff options
context:
space:
mode:
Diffstat (limited to 'pkg/xtools/catquery/doc/cqsqparn.hlp')
-rw-r--r--pkg/xtools/catquery/doc/cqsqparn.hlp39
1 files changed, 39 insertions, 0 deletions
diff --git a/pkg/xtools/catquery/doc/cqsqparn.hlp b/pkg/xtools/catquery/doc/cqsqparn.hlp
new file mode 100644
index 00000000..f0cc92fc
--- /dev/null
+++ b/pkg/xtools/catquery/doc/cqsqparn.hlp
@@ -0,0 +1,39 @@
+.help cqsqparn Mar00 "Catquery Package"
+.ih
+NAME
+cqsqparn -- set the value of a query parameter by number
+.ih
+SYNOPSIS
+
+parno = cq_sqparn (cq, parno, value)
+
+.nf
+pointer cq # the configuration file descriptor
+int parno # the sequence number of the query parameter
+char value # the query parameter value
+.fi
+.ih
+ARGUMENTS
+.ls cq
+The configuration file descriptor.
+.le
+.ls parno
+The sequence number 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, cqgqpar, cqgparn, cqsqpar
+.endhelp