curs_getcchar(3) UNIX Programmer's Manual curs_getcchar(3)
getcchar, setcchar - Get a wide character string and rendi-
tion from a cchar_t or set a cchar_t from a wide-character
string
#include <curses.h>
int getcchar(
const cchar_t *wcval,
wchar_t *wch,
attr_t *attrs,
short *color_pair,
void *opts );
int setcchar(
cchar_t *wcval,
const wchar_t *wch,
const attr_t attrs,
short color_pair,
void *opts );
The getcchar function gets a wide-character string and ren-
dition from a cchar_t argument. When wch is not a null
pointer, the getcchar function does the following:
- Extracts information from a cchar_t value wcval
- Stores the character attributes in the location pointed
to by attrs
- Stores the color-pair in the location pointed to by
color_pair
- Stores the wide-character string, characters referenced
by wcval, into the array pointed to by wch.
When wch is a null pointer, the getcchar function does the
following:
- Obtains the number of wide characters pointed to by
wcval
- Does not change the data referenced by attrs or
color_pair
The setcchar function initializes the location pointed to by
wcval by using:
- The character attributes in attrs
MirOS BSD #10-current Printed 19.2.2012 1
curs_getcchar(3) UNIX Programmer's Manual curs_getcchar(3)
- The color pair in color_pair
- The wide-character string pointed to by wch. The string
must be L'\0' terminated, contain at most one character
with strictly positive width, which must be the first,
and contain no characters of negative width.
The opts argument is reserved for future use. Currently, an
application must provide a null pointer as opts.
The wcval argument may be a value generated by a call to
setcchar or by a function that has a cchar_t output argu-
ment. If wcval is constructed by any other means, the effect
is unspecified.
When wch is a null pointer, getcchar returns the number of
wide characters referenced by wcval, including the null ter-
minator.
When wch is not a null pointer, getcchar returns OK upon
successful completion, and ERR otherwise.
Upon successful completion, setcchar returns OK. Otherwise,
it returns ERR.
Functions: curses(3), wcwidth(3), curs_attr_get(3),
can_change_color(3).
MirOS BSD #10-current Printed 19.2.2012 2
Generated on 2012-02-20 02:47:02 by $MirOS: src/scripts/roff2htm,v 1.70 2011/12/03 18:21:12 tg Exp $
These manual pages and other documentation are copyrighted by their respective writers;
their source is available at our CVSweb,
AnonCVS, and other mirrors. The rest is Copyright © 2002‒2011 The MirOS Project, Germany.
This product includes material
provided by Thorsten Glaser.
This manual page’s HTML representation is supposed to be valid XHTML/1.1; if not, please send a bug report – diffs preferred.