diff options
Diffstat (limited to 'upstream/opensuse-tumbleweed/man3/getcchar.3ncurses')
| -rw-r--r-- | upstream/opensuse-tumbleweed/man3/getcchar.3ncurses | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/upstream/opensuse-tumbleweed/man3/getcchar.3ncurses b/upstream/opensuse-tumbleweed/man3/getcchar.3ncurses index 5be81554..18003b0b 100644 --- a/upstream/opensuse-tumbleweed/man3/getcchar.3ncurses +++ b/upstream/opensuse-tumbleweed/man3/getcchar.3ncurses @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" 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 * @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getcchar.3x,v 1.43 2023/12/16 21:07:24 tom Exp $ -.TH getcchar 3NCURSES 2023-12-16 "ncurses 6.4" "Library calls" +.\" $Id: curs_getcchar.3x,v 1.49 2024/04/20 18:55:09 tom Exp $ +.TH getcchar 3NCURSES 2024-04-20 "ncurses 6.5" "Library calls" .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 @@ -36,21 +36,21 @@ .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 <ncursesw/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. |