curs_inwchstr(3ocurses)

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 -locurses [library . . .]

#include <ocurses.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 ocurses.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_inwch(3ocurses)].

Return values

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

References

curses(3ocurses), curs_inwch(3ocurses)

Notices

The header file ocurses.h automatically includes the header files stdio.h and unctrl.h.

Note that all routines except winwchnstr may be macros.