From fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4 Mon Sep 17 00:00:00 2001 From: Joseph Hunkeler Date: Wed, 8 Jul 2015 20:46:52 -0400 Subject: Initial commit --- pkg/xtools/catquery/doc/cqgvalc.hlp | 42 +++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 pkg/xtools/catquery/doc/cqgvalc.hlp (limited to 'pkg/xtools/catquery/doc/cqgvalc.hlp') diff --git a/pkg/xtools/catquery/doc/cqgvalc.hlp b/pkg/xtools/catquery/doc/cqgvalc.hlp new file mode 100644 index 00000000..a6313556 --- /dev/null +++ b/pkg/xtools/catquery/doc/cqgvalc.hlp @@ -0,0 +1,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 -- cgit