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

#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

With these routines, 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, is returned.  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 chstr [see curs_inch(3X)]. 

RETURN VALUE

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

NOTES

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

Note that all routines except winwchnstr may be macros. 

SEE ALSO

curses(3X), curs_inwch(3X).