CURS_INWCHSTR(3CURSES) Curses Library Functions CURS_INWCHSTR(3CURSES)


NAME


curs_inwchstr, inwchstr, inwchnstr, winwchstr, winwchnstr, mvinwchstr,
mvinwchnstr, mvwinwchstr, mvwinwchnstr - get a string of wchar_t
characters (and attributes) from a curses window

SYNOPSIS


cc [ flag ... ] file ... -lcurses [ library .. ]
#include <curses.h>

int inwchstr(chtype *wchstr);


int inwchnstr(chtype *wchstr, int n);


int winwchstr(WINDOW *win, chtype *wchstr);


int winwchnstr(WINDOW *win, chtype *wchstr, int n);


int mvinwchstr(int y, int x, chtype *wchstr);


int mvinwchnstr(int y, int x, chtype *wchstr, int n);


int mvwinwchstr(WINDOW *win, int y, int x, chtype *wchstr);


int mvwinwchnstr(WINDOW *win, int y, int x, chtype *wchstr, int n);


DESCRIPTION


These routines return a string of type chtype, holding wchar_t
characters, starting at the current cursor position in the named window
and ending at the right margin of the window. The four functions with n
as the last argument, return the string at most n wchar_t characters
long. Constants defined in <curses.h> can be used with the logical AND
(&) operator to extract the wchar_t character or the attribute alone from
any position in the wchstr (see curs_inwch(3CURSES)).

RETURN VALUE


All routines return the integer ERR upon failure and an integer value
other than ERR upon successful completion.

ATTRIBUTES


See attributes(7) for a description of the following attributes:


+---------------+-----------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+-----------------+
|MT-Level | Unsafe |
+---------------+-----------------+

SEE ALSO


curs_inwch(3CURSES), curses(3CURSES), attributes(7)

NOTES


The header file <curses.h> automatically includes the header files
<stdio.h>, <unctrl.h> and <widec.h>.


Note that all routines except winwchnstr() may be macros.


None of these routines can use the color attribute in chtype.


December 31, 1996 CURS_INWCHSTR(3CURSES)