]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - man/curs_getcchar.3x
ncurses 6.4 - patch 20240420
[ncurses.git] / man / curs_getcchar.3x
index 61b9f19ec61d202dd6e454aee902ba3e42e12f39..523cc99df92c9c73b7192c1cfe7243fd8fa51a10 100644 (file)
@@ -27,8 +27,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_getcchar.3x,v 1.45 2024/03/16 15:35:01 tom Exp $
-.TH curs_getcchar 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
+.\" $Id: curs_getcchar.3x,v 1.49 2024/04/20 18:55:09 tom Exp $
+.TH curs_getcchar 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 .SH NAME
 \fB\%getcchar\fP,
 \fB\%setcchar\fP \-
-convert between a wide-character string and a \fIcurses\fR complex character string
+convert between a wide-character string and a \fIcurses\fR complex character
 .SH SYNOPSIS
 .nf
 \fB#include <curses.h>
 .PP
 \fBint getcchar(
-.B "        const cchar_t *\fIwcval\fP,"
-.B "        wchar_t *\fIwch\fP,"
+.B "        const cchar_t *\fIwch\fP,"
+.B "        wchar_t *\fIwc\fP,"
 .B "        attr_t *\fIattrs\fP,"
 .B "        short *\fIcolor_pair\fP,"
 .B "        void *\fIopts\fP );"
 .PP
 .B "int setcchar("
-.B "        cchar_t *\fIwcval\fP,"
-.B "        const wchar_t *\fIwch\fP,"
+.B "        cchar_t *\fIwch\fP,"
+.B "        const wchar_t *\fIwc\fP,"
 .B "        const attr_t \fIattrs\fP,"
 .B "        short \fIcolor_pair\fP,"
 .B "        const void *\fIopts\fP );"
@@ -59,32 +59,32 @@ convert between a wide-character string and a \fIcurses\fR complex character str
 .SS getcchar
 The \fBgetcchar\fP function gets a wide-character string
 and rendition from a \fBcchar_t\fP argument.
-When \fIwch\fP is not a null pointer,
+When \fIwc\fP is not a null pointer,
 the \fBgetcchar\fP function does the following:
 .bP
-Extracts information from a \fBcchar_t\fP value \fIwcval\fP
+Extracts information from a \fBcchar_t\fP value \fIwch\fP
 .bP
 Stores the character attributes in the location pointed to by \fIattrs\fP
 .bP
 Stores the color pair in the location pointed to by \fIcolor_pair\fP
 .bP
 Stores the wide-character string,
-characters referenced by \fIwcval\fP, into the array pointed to by \fIwch\fP.
+characters referenced by \fIwch\fP, into the array pointed to by \fIwc\fP.
 .PP
 When
-\fIwch\fP
+\fIwc\fP
 is a null pointer, the
 \fBgetcchar\fP
 function does the following:
 .bP
-Obtains the number of wide characters pointed to by \fIwcval\fP
+Obtains the number of wide characters pointed to by \fIwch\fP
 .bP
 Does not change the data referenced by
 \fIattrs\fP
 or
 \fIcolor_pair\fP
 .SS setcchar
-The \fBsetcchar\fP function initializes the location pointed to by \fIwcval\fP
+The \fBsetcchar\fP function initializes the location pointed to by \fIwch\fP
 by using:
 .bP
 The character attributes in
@@ -93,7 +93,7 @@ The character attributes in
 The color pair in
 \fIcolor_pair\fP
 .bP
-The wide-character string pointed to by \fIwch\fP.
+The wide-character string pointed to by \fIwc\fP.
 The string must be L'\e0' terminated,
 contain at most one spacing character,
 which must be the first.
@@ -104,21 +104,21 @@ Additional non-spacing characters are ignored.
 The string may contain a single control character instead.
 In that case, no non-spacing characters are allowed.
 .SH RETURN VALUE
-When \fIwch\fP is a null pointer,
+When \fIwc\fP is a null pointer,
 \fBgetcchar\fP returns the number of wide characters referenced by
-\fIwcval\fP,
+\fIwch\fP,
 including one for a trailing null.
 .PP
-When \fIwch\fP is not a null pointer,
+When \fIwc\fP is not a null pointer,
 \fBgetcchar\fP returns \fBOK\fP upon successful completion,
 and \fBERR\fP otherwise.
 .PP
 Upon successful completion, \fBsetcchar\fP returns \fBOK\fP.
 Otherwise, it returns \fBERR\fP.
 .SH NOTES
-The \fIwcval\fP argument may be a value generated by a call to
+The \fIwch\fP argument may be a value generated by a call to
 \fBsetcchar\fP or by a function that has a \fBcchar_t\fP output argument.
-If \fIwcval\fP is constructed by any other means, the effect is unspecified.
+If \fIwch\fP is constructed by any other means, the effect is unspecified.
 .SH EXTENSIONS
 X/Open Curses documents the \fIopts\fP argument as reserved for future use,
 saying that it must be null.