.\"***************************************************************************
-.\" Copyright 2019-2021,2023 Thomas E. Dickey *
+.\" Copyright 2019-2023,2024 Thomas E. Dickey *
.\" Copyright 2001-2015,2017 Free Software Foundation, Inc. *
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_getcchar.3x,v 1.42 2023/11/25 14:30:18 tom Exp $
-.TH curs_getcchar 3X 2023-11-25 "ncurses 6.4" "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 );"
.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
+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
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.
.IP
-Up to \fBCCHARW_MAX\fP\-1 nonspacing characters may follow.
-Additional nonspacing characters are ignored.
+Up to \fBCCHARW_MAX\fP\-1 non-spacing characters may follow.
+Additional non-spacing characters are ignored.
.IP
The string may contain a single control character instead.
-In that case, no nonspacing characters are allowed.
+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.
This implementation
-uses that parameter in ABI 6 for the functions which have a color-pair
+uses that parameter in ABI 6 for the functions which have a color pair
parameter to support extended color pairs:
.bP
For functions which modify the color, e.g., \fBsetcchar\fP,
and used to retrieve the color pair as an \fBint\fP value,
in addition retrieving it via the standard pointer to \fBshort\fP parameter.
.SH PORTABILITY
-The \fBCCHARW_MAX\fP symbol is specific to ncurses.
+The \fBCCHARW_MAX\fP symbol is specific to \fI\%ncurses\fP.
X/Open Curses does not provide details for the layout of the \fBcchar_t\fP
structure.
It tells what data are stored in it:
projects / ncurses.git / blobdiff